@expo/entity 0.40.0 → 0.42.0

package/src/__tests__/EntityPrivacyPolicy-test.ts

@@ -25,22 +25,23 @@ type BlahFields = {
   id: string;
 };
 
-class BlahEntity extends Entity<BlahFields, string, ViewerContext> {
+class BlahEntity extends Entity<BlahFields, 'id', ViewerContext> {
   static defineCompanionDefinition(): EntityCompanionDefinition<
     BlahFields,
-    string,
+    'id',
     ViewerContext,
     BlahEntity,
     any
   > {
     return {
       entityClass: BlahEntity,
-      entityConfiguration: new EntityConfiguration<BlahFields>({
+      entityConfiguration: new EntityConfiguration<BlahFields, 'id'>({
         idField: 'id',
         tableName: 'blah_table',
         schema: {
           id: new UUIDField({
             columnName: 'id',
+            cache: false,
           }),
         },
         databaseAdapterFlavor: 'postgres',
@@ -51,30 +52,30 @@ class BlahEntity extends Entity<BlahFields, string, ViewerContext> {
   }
 }
 
-class AlwaysDenyPolicy extends EntityPrivacyPolicy<BlahFields, string, ViewerContext, BlahEntity> {
+class AlwaysDenyPolicy extends EntityPrivacyPolicy<BlahFields, 'id', ViewerContext, BlahEntity> {
   protected override readonly createRules = [
-    new AlwaysDenyPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysDenyPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly readRules = [
-    new AlwaysDenyPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysDenyPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly updateRules = [
-    new AlwaysDenyPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysDenyPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly deleteRules = [
-    new AlwaysDenyPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysDenyPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
 }
 
 class DryRunAlwaysDenyPolicy extends AlwaysDenyPolicy {
   // public method for test spying
   public denyHandler(
-    _error: EntityNotAuthorizedError<BlahFields, string, ViewerContext, BlahEntity>,
+    _error: EntityNotAuthorizedError<BlahFields, 'id', ViewerContext, BlahEntity>,
   ): void {}
 
   protected override getPrivacyPolicyEvaluator(): EntityPrivacyPolicyEvaluator<
     BlahFields,
-    string,
+    'id',
     ViewerContext,
     BlahEntity
   > {
@@ -88,12 +89,12 @@ class DryRunAlwaysDenyPolicy extends AlwaysDenyPolicy {
 class LoggingEnforceAlwaysDenyPolicy extends AlwaysDenyPolicy {
   // public method for test spying
   public denyHandler(
-    _error: EntityNotAuthorizedError<BlahFields, string, ViewerContext, BlahEntity>,
+    _error: EntityNotAuthorizedError<BlahFields, 'id', ViewerContext, BlahEntity>,
   ): void {}
 
   protected override getPrivacyPolicyEvaluator(): EntityPrivacyPolicyEvaluator<
     BlahFields,
-    string,
+    'id',
     ViewerContext,
     BlahEntity
   > {
@@ -104,30 +105,30 @@ class LoggingEnforceAlwaysDenyPolicy extends AlwaysDenyPolicy {
   }
 }
 
-class AlwaysAllowPolicy extends EntityPrivacyPolicy<BlahFields, string, ViewerContext, BlahEntity> {
+class AlwaysAllowPolicy extends EntityPrivacyPolicy<BlahFields, 'id', ViewerContext, BlahEntity> {
   protected override readonly createRules = [
-    new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysAllowPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly readRules = [
-    new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysAllowPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly updateRules = [
-    new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysAllowPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly deleteRules = [
-    new AlwaysAllowPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysAllowPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
 }
 
 class DryRunAlwaysAllowPolicy extends AlwaysAllowPolicy {
   // public method for test spying
   public denyHandler(
-    _error: EntityNotAuthorizedError<BlahFields, string, ViewerContext, BlahEntity>,
+    _error: EntityNotAuthorizedError<BlahFields, 'id', ViewerContext, BlahEntity>,
   ): void {}
 
   protected override getPrivacyPolicyEvaluator(): EntityPrivacyPolicyEvaluator<
     BlahFields,
-    string,
+    'id',
     ViewerContext,
     BlahEntity
   > {
@@ -141,12 +142,12 @@ class DryRunAlwaysAllowPolicy extends AlwaysAllowPolicy {
 class LoggingEnforceAlwaysAllowPolicy extends AlwaysAllowPolicy {
   // public method for test spying
   public denyHandler(
-    _error: EntityNotAuthorizedError<BlahFields, string, ViewerContext, BlahEntity>,
+    _error: EntityNotAuthorizedError<BlahFields, 'id', ViewerContext, BlahEntity>,
   ): void {}
 
   protected override getPrivacyPolicyEvaluator(): EntityPrivacyPolicyEvaluator<
     BlahFields,
-    string,
+    'id',
     ViewerContext,
     BlahEntity
   > {
@@ -157,24 +158,24 @@ class LoggingEnforceAlwaysAllowPolicy extends AlwaysAllowPolicy {
   }
 }
 
-class SkipAllPolicy extends EntityPrivacyPolicy<BlahFields, string, ViewerContext, BlahEntity> {
+class SkipAllPolicy extends EntityPrivacyPolicy<BlahFields, 'id', ViewerContext, BlahEntity> {
   protected override readonly createRules = [
-    new AlwaysSkipPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysSkipPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly readRules = [
-    new AlwaysSkipPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysSkipPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly updateRules = [
-    new AlwaysSkipPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysSkipPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly deleteRules = [
-    new AlwaysSkipPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysSkipPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
 }
 
 class InvalidCreateRuleResultPolicy extends EntityPrivacyPolicy<
   BlahFields,
-  string,
+  'id',
   ViewerContext,
   BlahEntity
 > {
@@ -186,19 +187,19 @@ class InvalidCreateRuleResultPolicy extends EntityPrivacyPolicy<
     },
   ];
   protected override readonly readRules = [
-    new AlwaysSkipPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysSkipPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly updateRules = [
-    new AlwaysSkipPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysSkipPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
   protected override readonly deleteRules = [
-    new AlwaysSkipPrivacyPolicyRule<BlahFields, string, ViewerContext, BlahEntity>(),
+    new AlwaysSkipPrivacyPolicyRule<BlahFields, 'id', ViewerContext, BlahEntity>(),
   ];
 }
 
 class AlwaysThrowPrivacyPolicyRule extends PrivacyPolicyRule<
   BlahFields,
-  string,
+  'id',
   ViewerContext,
   BlahEntity
 > {
@@ -207,7 +208,7 @@ class AlwaysThrowPrivacyPolicyRule extends PrivacyPolicyRule<
     _queryContext: EntityQueryContext,
     _evaluationContext: EntityPrivacyPolicyEvaluationContext<
       BlahFields,
-      string,
+      'id',
       ViewerContext,
       BlahEntity
     >,
@@ -217,7 +218,7 @@ class AlwaysThrowPrivacyPolicyRule extends PrivacyPolicyRule<
   }
 }
 
-class ThrowAllPolicy extends EntityPrivacyPolicy<BlahFields, string, ViewerContext, BlahEntity> {
+class ThrowAllPolicy extends EntityPrivacyPolicy<BlahFields, 'id', ViewerContext, BlahEntity> {
   protected override readonly createRules = [new AlwaysThrowPrivacyPolicyRule()];
   protected override readonly readRules = [new AlwaysThrowPrivacyPolicyRule()];
   protected override readonly updateRules = [new AlwaysThrowPrivacyPolicyRule()];
@@ -227,12 +228,12 @@ class ThrowAllPolicy extends EntityPrivacyPolicy<BlahFields, string, ViewerConte
 class DryRunThrowAllPolicy extends ThrowAllPolicy {
   // public method for test spying
   public denyHandler(
-    _error: EntityNotAuthorizedError<BlahFields, string, ViewerContext, BlahEntity>,
+    _error: EntityNotAuthorizedError<BlahFields, 'id', ViewerContext, BlahEntity>,
   ): void {}
 
   protected override getPrivacyPolicyEvaluator(): EntityPrivacyPolicyEvaluator<
     BlahFields,
-    string,
+    'id',
     ViewerContext,
     BlahEntity
   > {
@@ -246,12 +247,12 @@ class DryRunThrowAllPolicy extends ThrowAllPolicy {
 class LoggingEnforceThrowAllPolicy extends ThrowAllPolicy {
   // public method for test spying
   public denyHandler(
-    _error: EntityNotAuthorizedError<BlahFields, string, ViewerContext, BlahEntity>,
+    _error: EntityNotAuthorizedError<BlahFields, 'id', ViewerContext, BlahEntity>,
   ): void {}
 
   protected override getPrivacyPolicyEvaluator(): EntityPrivacyPolicyEvaluator<
     BlahFields,
-    string,
+    'id',
     ViewerContext,
     BlahEntity
   > {
@@ -262,7 +263,7 @@ class LoggingEnforceThrowAllPolicy extends ThrowAllPolicy {
   }
 }
 
-class EmptyPolicy extends EntityPrivacyPolicy<BlahFields, string, ViewerContext, BlahEntity> {
+class EmptyPolicy extends EntityPrivacyPolicy<BlahFields, 'id', ViewerContext, BlahEntity> {
   protected override readonly createRules = [];
   protected override readonly readRules = [];
   protected override readonly updateRules = [];
@@ -276,9 +277,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -315,9 +314,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -353,9 +350,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -392,9 +387,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -421,9 +414,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -460,9 +451,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -492,9 +481,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -536,9 +523,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -580,9 +565,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -618,9 +601,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -663,9 +644,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);
@@ -707,9 +686,7 @@ describe(EntityPrivacyPolicy, () => {
       const queryContext = instance(mock(EntityQueryContext));
       const privacyPolicyEvaluationContext =
         instance(
-          mock<
-            EntityPrivacyPolicyEvaluationContext<BlahFields, string, ViewerContext, BlahEntity>
-          >(),
+          mock<EntityPrivacyPolicyEvaluationContext<BlahFields, 'id', ViewerContext, BlahEntity>>(),
         );
       const metricsAdapterMock = mock<IEntityMetricsAdapter>();
       const metricsAdapter = instance(metricsAdapterMock);

package/src/__tests__/EntityQueryContext-test.ts

@@ -2,7 +2,7 @@ import invariant from 'invariant';
 
 import { EntityQueryContext, TransactionIsolationLevel } from '../EntityQueryContext';
 import ViewerContext from '../ViewerContext';
-import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
+import { createUnitTestEntityCompanionProvider } from '../utils/__testfixtures__/createUnitTestEntityCompanionProvider';
 
 describe(EntityQueryContext, () => {
   describe('callbacks', () => {

package/src/__tests__/EntitySecondaryCacheLoader-test.ts

@@ -6,15 +6,15 @@ import ViewerContext from '../ViewerContext';
 import SimpleTestEntity, {
   SimpleTestEntityPrivacyPolicy,
   SimpleTestFields,
-} from '../testfixtures/SimpleTestEntity';
-import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
+} from '../utils/__testfixtures__/SimpleTestEntity';
+import { createUnitTestEntityCompanionProvider } from '../utils/__testfixtures__/createUnitTestEntityCompanionProvider';
 
 type TestLoadParams = { id: string };
 
 class TestSecondaryRedisCacheLoader extends EntitySecondaryCacheLoader<
   TestLoadParams,
   SimpleTestFields,
-  string,
+  'id',
   ViewerContext,
   SimpleTestEntity,
   SimpleTestEntityPrivacyPolicy
@@ -32,7 +32,7 @@ describe(EntitySecondaryCacheLoader, () => {
     it('calls into secondary cache with correct params', async () => {
       const vc1 = new ViewerContext(createUnitTestEntityCompanionProvider());
 
-      const createdEntity = await SimpleTestEntity.creator(vc1).enforcing().createAsync();
+      const createdEntity = await SimpleTestEntity.creator(vc1).createAsync();
       const loadParams = { id: createdEntity.getID() };
 
       const secondaryEntityCacheMock =
@@ -44,7 +44,7 @@ describe(EntitySecondaryCacheLoader, () => {
 
       const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(
         secondaryEntityCache,
-        SimpleTestEntity.loader(vc1).withAuthorizationResults(),
+        SimpleTestEntity.loaderWithAuthorizationResults(vc1),
       );
 
       await secondaryCacheLoader.loadManyAsync([loadParams]);
@@ -57,7 +57,7 @@ describe(EntitySecondaryCacheLoader, () => {
     it('constructs and authorizes entities', async () => {
       const vc1 = new ViewerContext(createUnitTestEntityCompanionProvider());
 
-      const createdEntity = await SimpleTestEntity.creator(vc1).enforcing().createAsync();
+      const createdEntity = await SimpleTestEntity.creator(vc1).createAsync();
       const loadParams = { id: createdEntity.getID() };
 
       const secondaryEntityCacheMock =
@@ -67,7 +67,7 @@ describe(EntitySecondaryCacheLoader, () => {
       ).thenResolve(new Map([[loadParams, createdEntity.getAllFields()]]));
       const secondaryEntityCache = instance(secondaryEntityCacheMock);
 
-      const loader = SimpleTestEntity.loader(vc1).withAuthorizationResults();
+      const loader = SimpleTestEntity.loaderWithAuthorizationResults(vc1);
       const spiedPrivacyPolicy = spy(loader.utils['privacyPolicy']);
       const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(secondaryEntityCache, loader);
 
@@ -90,13 +90,13 @@ describe(EntitySecondaryCacheLoader, () => {
     it('calls invalidate on the secondary cache', async () => {
       const vc1 = new ViewerContext(createUnitTestEntityCompanionProvider());
 
-      const createdEntity = await SimpleTestEntity.creator(vc1).enforcing().createAsync();
+      const createdEntity = await SimpleTestEntity.creator(vc1).createAsync();
       const loadParams = { id: createdEntity.getID() };
 
       const secondaryEntityCacheMock =
         mock<ISecondaryEntityCache<SimpleTestFields, TestLoadParams>>();
       const secondaryEntityCache = instance(secondaryEntityCacheMock);
-      const loader = SimpleTestEntity.loader(vc1).withAuthorizationResults();
+      const loader = SimpleTestEntity.loaderWithAuthorizationResults(vc1);
       const secondaryCacheLoader = new TestSecondaryRedisCacheLoader(secondaryEntityCache, loader);
       await secondaryCacheLoader.invalidateManyAsync([loadParams]);