@expo/entity 0.39.0 → 0.41.0

package/src/EntityLoader.ts

@@ -1,14 +1,11 @@
 import AuthorizationResultBasedEntityLoader from './AuthorizationResultBasedEntityLoader';
 import EnforcingEntityLoader from './EnforcingEntityLoader';
 import { IEntityClass } from './Entity';
-import EntityConfiguration from './EntityConfiguration';
 import EntityLoaderUtils from './EntityLoaderUtils';
-import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
+import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
-import EntityDataManager from './internal/EntityDataManager';
-import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
 
 /**
  * The primary interface for loading entities. All normal loads are batched,
@@ -18,6 +15,7 @@ export default class EntityLoader<
   TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
+  TViewerContext2 extends TViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
     TFields,
@@ -28,26 +26,9 @@ export default class EntityLoader<
   >,
   TSelectedFields extends keyof TFields,
 > {
-  private readonly utilsPrivate: EntityLoaderUtils<
-    TFields,
-    TID,
-    TViewerContext,
-    TEntity,
-    TPrivacyPolicy,
-    TSelectedFields
-  >;
-
   constructor(
-    private readonly viewerContext: TViewerContext,
+    private readonly viewerContext: TViewerContext2,
     private readonly queryContext: EntityQueryContext,
-    private readonly privacyPolicyEvaluationContext: EntityPrivacyPolicyEvaluationContext<
-      TFields,
-      TID,
-      TViewerContext,
-      TEntity,
-      TSelectedFields
-    >,
-    private readonly entityConfiguration: EntityConfiguration<TFields>,
     private readonly entityClass: IEntityClass<
       TFields,
       TID,
@@ -56,23 +37,7 @@ export default class EntityLoader<
       TPrivacyPolicy,
       TSelectedFields
     >,
-    private readonly entitySelectedFields: TSelectedFields[] | undefined,
-    private readonly privacyPolicy: TPrivacyPolicy,
-    private readonly dataManager: EntityDataManager<TFields>,
-    protected readonly metricsAdapter: IEntityMetricsAdapter,
-  ) {
-    this.utilsPrivate = new EntityLoaderUtils(
-      this.viewerContext,
-      this.queryContext,
-      this.privacyPolicyEvaluationContext,
-      this.entityConfiguration,
-      this.entityClass,
-      this.entitySelectedFields,
-      this.privacyPolicy,
-      this.dataManager,
-      this.metricsAdapter,
-    );
-  }
+  ) {}
 
   /**
    * Enforcing entity loader. All loads through this loader are
@@ -92,7 +57,7 @@ export default class EntityLoader<
 
   /**
    * Authorization-result-based entity loader. All loads through this
-   * loader are are results (or null for some loader methods), where an unsuccessful result
+   * loader are results (or null for some loader methods), where an unsuccessful result
    * means an authorization error or entity construction error occurred. Other errors are thrown.
    */
   withAuthorizationResults(): AuthorizationResultBasedEntityLoader<
@@ -103,14 +68,10 @@ export default class EntityLoader<
     TPrivacyPolicy,
     TSelectedFields
   > {
-    return new AuthorizationResultBasedEntityLoader(
-      this.queryContext,
-      this.entityConfiguration,
-      this.entityClass,
-      this.dataManager,
-      this.metricsAdapter,
-      this.utilsPrivate,
-    );
+    return this.viewerContext
+      .getViewerScopedEntityCompanionForClass(this.entityClass)
+      .getLoaderFactory()
+      .forLoad(this.queryContext, { previousValue: null, cascadingDeleteCause: null });
   }
 
   /**
@@ -125,6 +86,6 @@ export default class EntityLoader<
     TPrivacyPolicy,
     TSelectedFields
   > {
-    return this.utilsPrivate;
+    return this.withAuthorizationResults().utils;
   }
 }

package/src/EntityLoaderFactory.ts

@@ -1,5 +1,6 @@
+import AuthorizationResultBasedEntityLoader from './AuthorizationResultBasedEntityLoader';
 import EntityCompanion from './EntityCompanion';
-import EntityLoader from './EntityLoader';
+import EntityLoaderUtils from './EntityLoaderUtils';
 import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
@@ -52,8 +53,15 @@ export default class EntityLoaderFactory<
       TEntity,
       TSelectedFields
     >,
-  ): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
-    return new EntityLoader(
+  ): AuthorizationResultBasedEntityLoader<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
+    const utils = new EntityLoaderUtils(
       viewerContext,
       queryContext,
       privacyPolicyEvaluationContext,
@@ -64,5 +72,14 @@ export default class EntityLoaderFactory<
       this.dataManager,
       this.metricsAdapter,
     );
+
+    return new AuthorizationResultBasedEntityLoader(
+      queryContext,
+      this.entityCompanion.entityCompanionDefinition.entityConfiguration,
+      this.entityCompanion.entityCompanionDefinition.entityClass,
+      this.dataManager,
+      this.metricsAdapter,
+      utils,
+    );
   }
 }

package/src/EntityMutatorFactory.ts

@@ -1,3 +1,8 @@
+import {
+  AuthorizationResultBasedCreateMutator,
+  AuthorizationResultBasedUpdateMutator,
+  AuthorizationResultBasedDeleteMutator,
+} from './AuthorizationResultBasedEntityMutator';
 import Entity, { IEntityClass } from './Entity';
 import EntityCompanionProvider from './EntityCompanionProvider';
 import EntityConfiguration from './EntityConfiguration';
@@ -5,7 +10,6 @@ import EntityDatabaseAdapter from './EntityDatabaseAdapter';
 import EntityLoaderFactory from './EntityLoaderFactory';
 import EntityMutationTriggerConfiguration from './EntityMutationTriggerConfiguration';
 import EntityMutationValidator from './EntityMutationValidator';
-import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
 import ViewerContext from './ViewerContext';
@@ -75,8 +79,15 @@ export default class EntityMutatorFactory<
   forCreate(
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
-  ): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
-    return new CreateMutator(
+  ): AuthorizationResultBasedCreateMutator<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
+    return new AuthorizationResultBasedCreateMutator(
       this.entityCompanionProvider,
       viewerContext,
       queryContext,
@@ -100,8 +111,15 @@ export default class EntityMutatorFactory<
   forUpdate(
     existingEntity: TEntity,
     queryContext: EntityQueryContext,
-  ): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
-    return new UpdateMutator(
+  ): AuthorizationResultBasedUpdateMutator<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
+    return new AuthorizationResultBasedUpdateMutator(
       this.entityCompanionProvider,
       existingEntity.getViewerContext(),
       queryContext,
@@ -125,8 +143,15 @@ export default class EntityMutatorFactory<
   forDelete(
     existingEntity: TEntity,
     queryContext: EntityQueryContext,
-  ): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
-    return new DeleteMutator(
+  ): AuthorizationResultBasedDeleteMutator<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
+    return new AuthorizationResultBasedDeleteMutator(
       this.entityCompanionProvider,
       existingEntity.getViewerContext(),
       queryContext,

package/src/EntitySecondaryCacheLoader.ts

@@ -1,6 +1,6 @@
 import { Result } from '@expo/results';
 
-import EntityLoader from './EntityLoader';
+import AuthorizationResultBasedEntityLoader from './AuthorizationResultBasedEntityLoader';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
@@ -60,7 +60,7 @@ export default abstract class EntitySecondaryCacheLoader<
 > {
   constructor(
     private readonly secondaryEntityCache: ISecondaryEntityCache<TFields, TLoadParams>,
-    protected readonly entityLoader: EntityLoader<
+    protected readonly entityLoader: AuthorizationResultBasedEntityLoader<
       TFields,
       TID,
       TViewerContext,
@@ -84,11 +84,9 @@ export default abstract class EntitySecondaryCacheLoader<
     );
 
     // convert value to and from array to reuse complex code
-    const entitiesMap = await this.entityLoader
-      .utils()
-      .constructAndAuthorizeEntitiesAsync(
-        mapMap(loadParamsToFieldObjects, (fieldObject) => (fieldObject ? [fieldObject] : [])),
-      );
+    const entitiesMap = await this.entityLoader.utils.constructAndAuthorizeEntitiesAsync(
+      mapMap(loadParamsToFieldObjects, (fieldObject) => (fieldObject ? [fieldObject] : [])),
+    );
     return mapMap(entitiesMap, (fieldObjects) => fieldObjects[0] ?? null);
   }
 

package/src/EntityUpdater.ts

@@ -0,0 +1,73 @@
+import { AuthorizationResultBasedUpdateMutator } from './AuthorizationResultBasedEntityMutator';
+import EnforcingEntityUpdater from './EnforcingEntityUpdater';
+import { IEntityClass } from './Entity';
+import EntityPrivacyPolicy from './EntityPrivacyPolicy';
+import { EntityQueryContext } from './EntityQueryContext';
+import ReadonlyEntity from './ReadonlyEntity';
+import ViewerContext from './ViewerContext';
+
+/**
+ * The primary interface for updating entities.
+ */
+export default class EntityUpdater<
+  TFields extends object,
+  TID extends NonNullable<TFields[TSelectedFields]>,
+  TViewerContext extends ViewerContext,
+  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
+  TPrivacyPolicy extends EntityPrivacyPolicy<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TSelectedFields
+  >,
+  TSelectedFields extends keyof TFields,
+> {
+  constructor(
+    private readonly existingEntity: TEntity,
+    private readonly queryContext: EntityQueryContext,
+    private readonly entityClass: IEntityClass<
+      TFields,
+      TID,
+      TViewerContext,
+      TEntity,
+      TPrivacyPolicy,
+      TSelectedFields
+    >,
+  ) {}
+
+  /**
+   * Enforcing entity updater. All updates through this updater are
+   * guaranteed to be successful and will throw otherwise.
+   */
+  enforcing(): EnforcingEntityUpdater<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
+    return new EnforcingEntityUpdater(this.withAuthorizationResults());
+  }
+
+  /**
+   * Authorization-result-based entity updater. All updates through this
+   * updater are results, where an unsuccessful result means an authorization
+   * error or entity construction error occurred. Other errors are thrown.
+   */
+  withAuthorizationResults(): AuthorizationResultBasedUpdateMutator<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
+    return this.existingEntity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(this.entityClass)
+      .getMutatorFactory()
+      .forUpdate(this.existingEntity, this.queryContext);
+  }
+}

package/src/ReadonlyEntity.ts

@@ -1,8 +1,13 @@
 import invariant from 'invariant';
 
+import AuthorizationResultBasedEntityAssociationLoader from './AuthorizationResultBasedEntityAssociationLoader';
+import AuthorizationResultBasedEntityLoader from './AuthorizationResultBasedEntityLoader';
+import EnforcingEntityAssociationLoader from './EnforcingEntityAssociationLoader';
+import EnforcingEntityLoader from './EnforcingEntityLoader';
 import { IEntityClass } from './Entity';
 import EntityAssociationLoader from './EntityAssociationLoader';
 import EntityLoader from './EntityLoader';
+import EntityLoaderUtils from './EntityLoaderUtils';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
 import ViewerContext from './ViewerContext';
@@ -82,16 +87,33 @@ export default abstract class ReadonlyEntity<
   }
 
   /**
-   * @returns EntityAssociationLoader for this entity
+   * @returns EnforcingEntityAssociationLoader for this entity
    */
-  associationLoader(): EntityAssociationLoader<
+  associationLoader(
+    queryContext?: EntityQueryContext,
+  ): EnforcingEntityAssociationLoader<TFields, TID, TViewerContext, this, TSelectedFields> {
+    return new EntityAssociationLoader<TFields, TID, TViewerContext, this, TSelectedFields>(
+      this,
+      queryContext,
+    ).enforcing();
+  }
+
+  /**
+   * @returns AuthorizationResultBasedEntityAssociationLoader for this entity
+   */
+  associationLoaderWithAuthorizationResults(
+    queryContext?: EntityQueryContext,
+  ): AuthorizationResultBasedEntityAssociationLoader<
     TFields,
     TID,
     TViewerContext,
     this,
     TSelectedFields
   > {
-    return new EntityAssociationLoader(this);
+    return new EntityAssociationLoader<TFields, TID, TViewerContext, this, TSelectedFields>(
+      this,
+      queryContext,
+    ).withAuthorizationResults();
   }
 
   /**
@@ -152,10 +174,102 @@ export default abstract class ReadonlyEntity<
       .getViewerScopedEntityCompanionForClass(this)
       .getQueryContextProvider()
       .getQueryContext(),
-  ): EntityLoader<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
-    return viewerContext
+  ): EnforcingEntityLoader<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityLoader(viewerContext, queryContext, this).enforcing();
+  }
+
+  /**
+   * Vend loader for loading an entity in a given query context.
+   * @param viewerContext - viewer context of loading user
+   * @param queryContext - query context in which to perform the load
+   */
+  static loaderWithAuthorizationResults<
+    TMFields extends object,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMViewerContext extends ViewerContext,
+    TMViewerContext2 extends TMViewerContext,
+    TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
+    TMPrivacyPolicy extends EntityPrivacyPolicy<
+      TMFields,
+      TMID,
+      TMViewerContext,
+      TMEntity,
+      TMSelectedFields
+    >,
+    TMSelectedFields extends keyof TMFields = keyof TMFields,
+  >(
+    this: IEntityClass<
+      TMFields,
+      TMID,
+      TMViewerContext,
+      TMEntity,
+      TMPrivacyPolicy,
+      TMSelectedFields
+    >,
+    viewerContext: TMViewerContext2,
+    queryContext: EntityQueryContext = viewerContext
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext(),
+  ): AuthorizationResultBasedEntityLoader<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityLoader(viewerContext, queryContext, this).withAuthorizationResults();
+  }
+
+  /**
+   * Vend loader for loading an entity in a given query context.
+   * @param viewerContext - viewer context of loading user
+   * @param queryContext - query context in which to perform the load
+   */
+  static loaderUtils<
+    TMFields extends object,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMViewerContext extends ViewerContext,
+    TMViewerContext2 extends TMViewerContext,
+    TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
+    TMPrivacyPolicy extends EntityPrivacyPolicy<
+      TMFields,
+      TMID,
+      TMViewerContext,
+      TMEntity,
+      TMSelectedFields
+    >,
+    TMSelectedFields extends keyof TMFields = keyof TMFields,
+  >(
+    this: IEntityClass<
+      TMFields,
+      TMID,
+      TMViewerContext,
+      TMEntity,
+      TMPrivacyPolicy,
+      TMSelectedFields
+    >,
+    viewerContext: TMViewerContext2,
+    queryContext: EntityQueryContext = viewerContext
       .getViewerScopedEntityCompanionForClass(this)
-      .getLoaderFactory()
-      .forLoad(queryContext, { previousValue: null, cascadingDeleteCause: null });
+      .getQueryContextProvider()
+      .getQueryContext(),
+  ): EntityLoaderUtils<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityLoader(viewerContext, queryContext, this).utils();
   }
 }

package/src/ViewerScopedEntityLoaderFactory.ts

@@ -1,4 +1,4 @@
-import EntityLoader from './EntityLoader';
+import AuthorizationResultBasedEntityLoader from './AuthorizationResultBasedEntityLoader';
 import EntityLoaderFactory from './EntityLoaderFactory';
 import EntityPrivacyPolicy, { EntityPrivacyPolicyEvaluationContext } from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
@@ -43,7 +43,14 @@ export default class ViewerScopedEntityLoaderFactory<
       TEntity,
       TSelectedFields
     >,
-  ): EntityLoader<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
+  ): AuthorizationResultBasedEntityLoader<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
     return this.entityLoaderFactory.forLoad(
       this.viewerContext,
       queryContext,

package/src/ViewerScopedEntityMutatorFactory.ts

@@ -1,4 +1,8 @@
-import { CreateMutator, UpdateMutator, DeleteMutator } from './EntityMutator';
+import {
+  AuthorizationResultBasedCreateMutator,
+  AuthorizationResultBasedUpdateMutator,
+  AuthorizationResultBasedDeleteMutator,
+} from './AuthorizationResultBasedEntityMutator';
 import EntityMutatorFactory from './EntityMutatorFactory';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
@@ -36,21 +40,42 @@ export default class ViewerScopedEntityMutatorFactory<
 
   forCreate(
     queryContext: EntityQueryContext,
-  ): CreateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
+  ): AuthorizationResultBasedCreateMutator<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
     return this.entityMutatorFactory.forCreate(this.viewerContext, queryContext);
   }
 
   forUpdate(
     existingEntity: TEntity,
     queryContext: EntityQueryContext,
-  ): UpdateMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
+  ): AuthorizationResultBasedUpdateMutator<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
     return this.entityMutatorFactory.forUpdate(existingEntity, queryContext);
   }
 
   forDelete(
     existingEntity: TEntity,
     queryContext: EntityQueryContext,
-  ): DeleteMutator<TFields, TID, TViewerContext, TEntity, TPrivacyPolicy, TSelectedFields> {
+  ): AuthorizationResultBasedDeleteMutator<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TPrivacyPolicy,
+    TSelectedFields
+  > {
     return this.entityMutatorFactory.forDelete(existingEntity, queryContext);
   }
 }