AbstractInternalConstructs an instance of an Entity.
data needed to construct an instance of an entity viewerContext - the ViewerContext reading this entity id - the ID of this entity databaseFields - all underlying fields for this entity's data selectedFields - selected fields for this entity from TSelectedFields type
This should only be overridden in cases where additional data validation is needed. The params should not be modified when calling super during constructions.
OptionalqueryContext: EntityQueryContextEnforcingEntityAssociationLoader for this entity
OptionalqueryContext: EntityQueryContextAuthorizationResultBasedEntityAssociationLoader for this entity
all underlying fields from this entity's database data
all underlying fields from this entity's data
Get a underlying field from this entity's data
the field to get
the value of the field or undefined if not loaded with that field
the ViewerContext authorized to read this entity
StaticcreatorVend mutator for creating a new entity in given query context.
viewer context of creating user
query context in which to perform the create
mutator for creating an entity
StaticcreatorVend mutator for creating a new entity in given query context.
viewer context of creating user
query context in which to perform the create
mutator for creating an entity
StaticdeleterVend mutator for deleting an existing entity in given query context.
entity to delete
query context in which to perform the delete
mutator for deleting existingEntity
StaticdeleterVend mutator for deleting an existing entity in given query context.
entity to delete
query context in which to perform the delete
mutator for deleting existingEntity
StaticloaderVend loader for loading an entity in a given query context.
viewer context of loading user
query context in which to perform the load
StaticloaderVend loader for loading an entity in a given query context.
viewer context of loading user
query context in which to perform the load
StaticloaderVend loader for loading an entity in a given query context.
viewer context of loading user
query context in which to perform the load
StaticupdaterVend mutator for updating an existing entity in given query context.
entity to update
query context in which to perform the update
mutator for updating existingEntity
StaticupdaterVend mutator for updating an existing entity in given query context.
entity to update
query context in which to perform the update
mutator for updating existingEntity
Entity is a privacy-first data model.
A instance of an entity represents a single "row" of persisted data in a database that a viewer, represented by the corresponding ViewerContext, has permission to read.
Create, read, update, and delete permissions for an entity are declaratively defined using an EntityPrivacyPolicy.
Entites are loaded through an EntityLoader, which is responsible for orchestrating fetching, caching, and authorization of reading "rows".
Entities are mutated and deleted through an EntityMutator, which is responsible for orchestrating database writes, cache invalidation, and authorization of writing "rows".
All concrete entity implementations should extend this class and provide their own EntityCompanionDefinition.