@expo/entity 0.34.0 → 0.35.0

package/src/Entity.ts

@@ -61,7 +61,10 @@ export default abstract class Entity<
       TMSelectedFields
     >,
     viewerContext: TMViewerContext2,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = viewerContext
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): CreateMutator<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
     return viewerContext
       .getViewerScopedEntityCompanionForClass(this)
@@ -98,7 +101,11 @@ export default abstract class Entity<
       TMSelectedFields
     >,
     existingEntity: TMEntity,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = existingEntity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): UpdateMutator<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
     return existingEntity
       .getViewerContext()
@@ -135,7 +142,11 @@ export default abstract class Entity<
       TMSelectedFields
     >,
     existingEntity: TMEntity,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = existingEntity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): Promise<Result<void>> {
     return existingEntity
       .getViewerContext()
@@ -173,7 +184,11 @@ export default abstract class Entity<
       TMSelectedFields
     >,
     existingEntity: TMEntity,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = existingEntity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): Promise<void> {
     return existingEntity
       .getViewerContext()
@@ -222,7 +237,11 @@ export default abstract class Entity<
       TMSelectedFields
     >,
     existingEntity: TMEntity,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = existingEntity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): Promise<boolean> {
     const companion = existingEntity
       .getViewerContext()
@@ -272,7 +291,11 @@ export default abstract class Entity<
       TMSelectedFields
     >,
     existingEntity: TMEntity,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = existingEntity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): Promise<boolean> {
     const companion = existingEntity
       .getViewerContext()

package/src/EntityAssociationLoader.ts

@@ -55,7 +55,11 @@ export default class EntityAssociationLoader<
       TAssociatedPrivacyPolicy,
       TAssociatedSelectedFields
     >,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = this.entity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(associatedEntityClass)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): Promise<
     Result<null extends TFields[TIdentifyingField] ? TAssociatedEntity | null : TAssociatedEntity>
   > {
@@ -113,7 +117,11 @@ export default class EntityAssociationLoader<
       TAssociatedSelectedFields
     >,
     associatedEntityFieldContainingThisID: keyof Pick<TAssociatedFields, TAssociatedSelectedFields>,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = this.entity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(associatedEntityClass)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): Promise<readonly Result<TAssociatedEntity>[]> {
     const thisID = this.entity.getID();
     const loader = this.entity
@@ -163,7 +171,11 @@ export default class EntityAssociationLoader<
       TAssociatedSelectedFields
     >,
     associatedEntityLookupByField: keyof Pick<TAssociatedFields, TAssociatedSelectedFields>,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = this.entity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(associatedEntityClass)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): Promise<Result<TAssociatedEntity> | null> {
     const associatedFieldValue = this.entity.getField(fieldIdentifyingAssociatedEntity);
     if (!associatedFieldValue) {
@@ -216,7 +228,11 @@ export default class EntityAssociationLoader<
       TAssociatedSelectedFields
     >,
     associatedEntityLookupByField: keyof Pick<TAssociatedFields, TAssociatedSelectedFields>,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = this.entity
+      .getViewerContext()
+      .getViewerScopedEntityCompanionForClass(associatedEntityClass)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): Promise<readonly Result<TAssociatedEntity>[]> {
     const associatedFieldValue = this.entity.getField(fieldIdentifyingAssociatedEntity);
     if (!associatedFieldValue) {
@@ -265,7 +281,7 @@ export default class EntityAssociationLoader<
         TSelectedFields2
       >
     ],
-    queryContext: EntityQueryContext
+    queryContext?: EntityQueryContext
   ): Promise<Result<TEntity2> | null>;
 
   /**
@@ -320,7 +336,7 @@ export default class EntityAssociationLoader<
         TSelectedFields3
       >
     ],
-    queryContext: EntityQueryContext
+    queryContext?: EntityQueryContext
   ): Promise<Result<TEntity3> | null>;
 
   /**
@@ -396,7 +412,7 @@ export default class EntityAssociationLoader<
         TSelectedFields4
       >
     ],
-    queryContext: EntityQueryContext
+    queryContext?: EntityQueryContext
   ): Promise<Result<TEntity4> | null>;
 
   /**
@@ -407,12 +423,12 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityThroughAsync(
     loadDirectives: EntityLoadThroughDirective<TViewerContext, any, any, any, any, any, any, any>[],
-    queryContext: EntityQueryContext
+    queryContext?: EntityQueryContext
   ): Promise<Result<ReadonlyEntity<any, any, any, any>> | null>;
 
   async loadAssociatedEntityThroughAsync(
     loadDirectives: EntityLoadThroughDirective<TViewerContext, any, any, any, any, any, any, any>[],
-    queryContext: EntityQueryContext
+    queryContext?: EntityQueryContext
   ): Promise<Result<ReadonlyEntity<any, any, any, any>> | null> {
     let currentEntity: ReadonlyEntity<any, any, any, any> = this.entity;
     for (const loadDirective of loadDirectives) {

package/src/EntityQueryContextProvider.ts

@@ -12,7 +12,7 @@ export default abstract class EntityQueryContextProvider {
   /**
    * Vend a regular (non-transactional) entity query context.
    */
-  public getNonTransactionalQueryContext(): EntityNonTransactionalQueryContext {
+  public getQueryContext(): EntityNonTransactionalQueryContext {
     return new EntityNonTransactionalQueryContext(this.getQueryInterface(), this);
   }
 

package/src/ReadonlyEntity.ts

@@ -148,7 +148,10 @@ export default abstract class ReadonlyEntity<
       TMSelectedFields
     >,
     viewerContext: TMViewerContext2,
-    queryContext: EntityQueryContext
+    queryContext: EntityQueryContext = viewerContext
+      .getViewerScopedEntityCompanionForClass(this)
+      .getQueryContextProvider()
+      .getQueryContext()
   ): EntityLoader<TMFields, TMID, TMViewerContext, TMEntity, TMPrivacyPolicy, TMSelectedFields> {
     return viewerContext
       .getViewerScopedEntityCompanionForClass(this)

package/src/ViewerContext.ts

@@ -2,7 +2,7 @@ import { IEntityClass } from './Entity';
 import EntityCompanionProvider, { DatabaseAdapterFlavor } from './EntityCompanionProvider';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import {
-  EntityNonTransactionalQueryContext,
+  EntityQueryContext,
   EntityTransactionalQueryContext,
   TransactionConfig,
 } from './EntityQueryContext';
@@ -67,12 +67,12 @@ export default class ViewerContext {
    * Get the regular (non-transactional) query context for a database adaptor flavor.
    * @param databaseAdaptorFlavor - database adaptor flavor
    */
-  getNonTransactionalQueryContextForDatabaseAdaptorFlavor(
+  getQueryContextForDatabaseAdaptorFlavor(
     databaseAdaptorFlavor: DatabaseAdapterFlavor
-  ): EntityNonTransactionalQueryContext {
+  ): EntityQueryContext {
     return this.entityCompanionProvider
       .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
-      .getNonTransactionalQueryContext();
+      .getQueryContext();
   }
 
   /**
@@ -88,7 +88,7 @@ export default class ViewerContext {
   ): Promise<TResult> {
     return await this.entityCompanionProvider
       .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
-      .getNonTransactionalQueryContext()
+      .getQueryContext()
       .runInTransactionIfNotInTransactionAsync(transactionScope, transactionConfig);
   }
 }

package/src/__tests__/Entity-test.ts

@@ -4,27 +4,25 @@ import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField } from '../EntityFields';
 import { CreateMutator, UpdateMutator } from '../EntityMutator';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
+import ViewerContext from '../ViewerContext';
 import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
 import AlwaysDenyPrivacyPolicyRule from '../rules/AlwaysDenyPrivacyPolicyRule';
 import SimpleTestEntity from '../testfixtures/SimpleTestEntity';
-import TestViewerContext from '../testfixtures/TestViewerContext';
 import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
 
 describe(Entity, () => {
   describe('creator', () => {
     it('creates a new CreateMutator', () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new TestViewerContext(companionProvider);
-      expect(
-        SimpleTestEntity.creator(viewerContext, viewerContext.getQueryContext())
-      ).toBeInstanceOf(CreateMutator);
+      const viewerContext = new ViewerContext(companionProvider);
+      expect(SimpleTestEntity.creator(viewerContext)).toBeInstanceOf(CreateMutator);
     });
   });
 
   describe('updater', () => {
     it('creates a new UpdateMutator', () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new TestViewerContext(companionProvider);
+      const viewerContext = new ViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -34,16 +32,14 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      expect(SimpleTestEntity.updater(testEntity, viewerContext.getQueryContext())).toBeInstanceOf(
-        UpdateMutator
-      );
+      expect(SimpleTestEntity.updater(testEntity)).toBeInstanceOf(UpdateMutator);
     });
   });
 
   describe('canViewerUpdateAsync', () => {
     it('appropriately executes update privacy policy', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new TestViewerContext(companionProvider);
+      const viewerContext = new ViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -53,16 +49,13 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      const canViewerUpdate = await SimpleTestDenyDeleteEntity.canViewerUpdateAsync(
-        testEntity,
-        viewerContext.getQueryContext()
-      );
+      const canViewerUpdate = await SimpleTestDenyDeleteEntity.canViewerUpdateAsync(testEntity);
       expect(canViewerUpdate).toBe(true);
     });
 
     it('denies when policy denies', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new TestViewerContext(companionProvider);
+      const viewerContext = new ViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -72,10 +65,7 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      const canViewerUpdate = await SimpleTestDenyUpdateEntity.canViewerUpdateAsync(
-        testEntity,
-        viewerContext.getQueryContext()
-      );
+      const canViewerUpdate = await SimpleTestDenyUpdateEntity.canViewerUpdateAsync(testEntity);
       expect(canViewerUpdate).toBe(false);
     });
   });
@@ -83,7 +73,7 @@ describe(Entity, () => {
   describe('canViewerDeleteAsync', () => {
     it('appropriately executes update privacy policy', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new TestViewerContext(companionProvider);
+      const viewerContext = new ViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -93,16 +83,13 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      const canViewerDelete = await SimpleTestDenyUpdateEntity.canViewerDeleteAsync(
-        testEntity,
-        viewerContext.getQueryContext()
-      );
+      const canViewerDelete = await SimpleTestDenyUpdateEntity.canViewerDeleteAsync(testEntity);
       expect(canViewerDelete).toBe(true);
     });
 
     it('denies when policy denies', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new TestViewerContext(companionProvider);
+      const viewerContext = new ViewerContext(companionProvider);
       const data = {
         id: 'what',
       };
@@ -112,10 +99,7 @@ describe(Entity, () => {
         databaseFields: data,
         selectedFields: data,
       });
-      const canViewerDelete = await SimpleTestDenyDeleteEntity.canViewerDeleteAsync(
-        testEntity,
-        viewerContext.getQueryContext()
-      );
+      const canViewerDelete = await SimpleTestDenyDeleteEntity.canViewerDeleteAsync(testEntity);
       expect(canViewerDelete).toBe(false);
     });
   });
@@ -140,14 +124,14 @@ const testEntityConfiguration = new EntityConfiguration<TestEntityFields>({
 class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
   TestEntityFields,
   string,
-  TestViewerContext,
+  ViewerContext,
   SimpleTestDenyUpdateEntity
 > {
   protected override readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      TestViewerContext,
+      ViewerContext,
       SimpleTestDenyUpdateEntity
     >(),
   ];
@@ -155,7 +139,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      TestViewerContext,
+      ViewerContext,
       SimpleTestDenyUpdateEntity
     >(),
   ];
@@ -163,7 +147,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysDenyPrivacyPolicyRule<
       TestEntityFields,
       string,
-      TestViewerContext,
+      ViewerContext,
       SimpleTestDenyUpdateEntity
     >(),
   ];
@@ -171,7 +155,7 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      TestViewerContext,
+      ViewerContext,
       SimpleTestDenyUpdateEntity
     >(),
   ];
@@ -180,14 +164,14 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
 class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
   TestEntityFields,
   string,
-  TestViewerContext,
+  ViewerContext,
   SimpleTestDenyDeleteEntity
 > {
   protected override readonly readRules = [
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      TestViewerContext,
+      ViewerContext,
       SimpleTestDenyDeleteEntity
     >(),
   ];
@@ -195,7 +179,7 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      TestViewerContext,
+      ViewerContext,
       SimpleTestDenyDeleteEntity
     >(),
   ];
@@ -203,7 +187,7 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysAllowPrivacyPolicyRule<
       TestEntityFields,
       string,
-      TestViewerContext,
+      ViewerContext,
       SimpleTestDenyDeleteEntity
     >(),
   ];
@@ -211,17 +195,17 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
     new AlwaysDenyPrivacyPolicyRule<
       TestEntityFields,
       string,
-      TestViewerContext,
+      ViewerContext,
       SimpleTestDenyDeleteEntity
     >(),
   ];
 }
 
-class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, TestViewerContext> {
+class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, ViewerContext> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     TestEntityFields,
     string,
-    TestViewerContext,
+    ViewerContext,
     SimpleTestDenyUpdateEntity,
     SimpleTestDenyUpdateEntityPrivacyPolicy
   > {
@@ -233,11 +217,11 @@ class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, TestVi
   }
 }
 
-class SimpleTestDenyDeleteEntity extends Entity<TestEntityFields, string, TestViewerContext> {
+class SimpleTestDenyDeleteEntity extends Entity<TestEntityFields, string, ViewerContext> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     TestEntityFields,
     string,
-    TestViewerContext,
+    ViewerContext,
     SimpleTestDenyDeleteEntity,
     SimpleTestDenyDeleteEntityPrivacyPolicy
   > {