@expo/entity 0.39.0 → 0.41.0

package/src/EnforcingEntityDeleter.ts

@@ -0,0 +1,44 @@
+import { enforceAsyncResult } from '@expo/results';
+
+import { AuthorizationResultBasedDeleteMutator } from './AuthorizationResultBasedEntityMutator';
+import EntityPrivacyPolicy from './EntityPrivacyPolicy';
+import ReadonlyEntity from './ReadonlyEntity';
+import ViewerContext from './ViewerContext';
+
+/**
+ * Enforcing entity deleter. All deletes
+ * through this deleter will throw if authorization is not successful.
+ */
+export default class EnforcingEntityDeleter<
+  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 entityDeleter: AuthorizationResultBasedDeleteMutator<
+      TFields,
+      TID,
+      TViewerContext,
+      TEntity,
+      TPrivacyPolicy,
+      TSelectedFields
+    >,
+  ) {}
+
+  /**
+   * Delete the entity after authorizing against delete privacy rules. The entity is invalidated in all caches.
+   * Throws when delete is not successful.
+   */
+  async deleteAsync(): Promise<void> {
+    await enforceAsyncResult(this.entityDeleter.deleteAsync());
+  }
+}

package/src/EnforcingEntityUpdater.ts

@@ -0,0 +1,55 @@
+import { enforceAsyncResult } from '@expo/results';
+
+import { AuthorizationResultBasedUpdateMutator } from './AuthorizationResultBasedEntityMutator';
+import EntityPrivacyPolicy from './EntityPrivacyPolicy';
+import ReadonlyEntity from './ReadonlyEntity';
+import ViewerContext from './ViewerContext';
+
+/**
+ * Enforcing entity updater. All updates
+ * through this updater will throw if authorization is not successful.
+ */
+export default class EnforcingEntityUpdater<
+  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 entityUpdater: AuthorizationResultBasedUpdateMutator<
+      TFields,
+      TID,
+      TViewerContext,
+      TEntity,
+      TPrivacyPolicy,
+      TSelectedFields
+    >,
+  ) {}
+
+  /**
+   * Set the value for entity field.
+   * @param fieldName - entity field being updated
+   * @param value - value for entity field
+   */
+  setField<K extends keyof Pick<TFields, TSelectedFields>>(fieldName: K, value: TFields[K]): this {
+    this.entityUpdater.setField(fieldName, value);
+    return this;
+  }
+
+  /**
+   * Commit the changes to the entity after authorizing against update privacy rules.
+   * Invalidates all caches for pre-update entity.
+   * @returns authorized updated entity, throws upon update failure
+   */
+  async updateAsync(): Promise<TEntity> {
+    return await enforceAsyncResult(this.entityUpdater.updateAsync());
+  }
+}

package/src/Entity.ts

@@ -1,9 +1,17 @@
-import { Result } from '@expo/results';
-
+import {
+  AuthorizationResultBasedCreateMutator,
+  AuthorizationResultBasedDeleteMutator,
+  AuthorizationResultBasedUpdateMutator,
+} from './AuthorizationResultBasedEntityMutator';
+import EnforcingEntityCreator from './EnforcingEntityCreator';
+import EnforcingEntityDeleter from './EnforcingEntityDeleter';
+import EnforcingEntityUpdater from './EnforcingEntityUpdater';
 import { EntityCompanionDefinition } from './EntityCompanionProvider';
-import { CreateMutator, UpdateMutator } from './EntityMutator';
+import EntityCreator from './EntityCreator';
+import EntityDeleter from './EntityDeleter';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
+import EntityUpdater from './EntityUpdater';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
 
@@ -65,11 +73,60 @@ export default abstract class Entity<
       .getViewerScopedEntityCompanionForClass(this)
       .getQueryContextProvider()
       .getQueryContext(),
-  ): CreateMutator<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
-    return viewerContext
+  ): EnforcingEntityCreator<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityCreator(viewerContext, queryContext, this).enforcing();
+  }
+
+  /**
+   * Vend mutator for creating a new entity in given query context.
+   * @param viewerContext - viewer context of creating user
+   * @param queryContext - query context in which to perform the create
+   * @returns mutator for creating an entity
+   */
+  static creatorWithAuthorizationResults<
+    TMFields extends object,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMViewerContext extends ViewerContext,
+    TMViewerContext2 extends TMViewerContext,
+    TMEntity extends Entity<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)
-      .getMutatorFactory()
-      .forCreate(queryContext);
+      .getQueryContextProvider()
+      .getQueryContext(),
+  ): AuthorizationResultBasedCreateMutator<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityCreator(viewerContext, queryContext, this).withAuthorizationResults();
   }
 
   /**
@@ -106,20 +163,69 @@ export default abstract class Entity<
       .getViewerScopedEntityCompanionForClass(this)
       .getQueryContextProvider()
       .getQueryContext(),
-  ): UpdateMutator<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
-    return existingEntity
+  ): EnforcingEntityUpdater<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityUpdater(existingEntity, queryContext, this).enforcing();
+  }
+
+  /**
+   * Vend mutator for updating an existing entity in given query context.
+   * @param existingEntity - entity to update
+   * @param queryContext - query context in which to perform the update
+   * @returns mutator for updating existingEntity
+   */
+  static updaterWithAuthorizationResults<
+    TMFields extends object,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
+    TMViewerContext extends ViewerContext,
+    TMEntity extends Entity<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
+    >,
+    existingEntity: TMEntity,
+    queryContext: EntityQueryContext = existingEntity
       .getViewerContext()
       .getViewerScopedEntityCompanionForClass(this)
-      .getMutatorFactory()
-      .forUpdate(existingEntity, queryContext);
+      .getQueryContextProvider()
+      .getQueryContext(),
+  ): AuthorizationResultBasedUpdateMutator<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityUpdater(existingEntity, queryContext, this).withAuthorizationResults();
   }
 
   /**
-   * Delete an existing entity in given query context.
+   * Vend mutator for deleting an existing entity in given query context.
    * @param existingEntity - entity to delete
    * @param queryContext - query context in which to perform the delete
+   * @returns mutator for deleting existingEntity
    */
-  static deleteAsync<
+  static deleter<
     TMFields extends object,
     TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
@@ -147,21 +253,24 @@ export default abstract class Entity<
       .getViewerScopedEntityCompanionForClass(this)
       .getQueryContextProvider()
       .getQueryContext(),
-  ): Promise<Result<void>> {
-    return existingEntity
-      .getViewerContext()
-      .getViewerScopedEntityCompanionForClass(this)
-      .getMutatorFactory()
-      .forDelete(existingEntity, queryContext)
-      .deleteAsync();
+  ): EnforcingEntityDeleter<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityDeleter(existingEntity, queryContext, this).enforcing();
   }
 
   /**
-   * Delete an existing entity in given query context, throwing if deletion is unsuccessful.
+   * Vend mutator for deleting an existing entity in given query context.
    * @param existingEntity - entity to delete
    * @param queryContext - query context in which to perform the delete
+   * @returns mutator for deleting existingEntity
    */
-  static enforceDeleteAsync<
+  static deleterWithAuthorizationResults<
     TMFields extends object,
     TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
@@ -189,13 +298,15 @@ export default abstract class Entity<
       .getViewerScopedEntityCompanionForClass(this)
       .getQueryContextProvider()
       .getQueryContext(),
-  ): Promise<void> {
-    return existingEntity
-      .getViewerContext()
-      .getViewerScopedEntityCompanionForClass(this)
-      .getMutatorFactory()
-      .forDelete(existingEntity, queryContext)
-      .enforceDeleteAsync();
+  ): AuthorizationResultBasedDeleteMutator<
+    TMFields,
+    TMID,
+    TMViewerContext,
+    TMEntity,
+    TMPrivacyPolicy,
+    TMSelectedFields
+  > {
+    return new EntityDeleter(existingEntity, queryContext, this).withAuthorizationResults();
   }
 }