@expo/entity 0.31.1 → 0.33.0

package/src/internal/__tests__/ReadThroughEntityCache-test.ts

@@ -1,8 +1,8 @@
 import { verify, deepEqual, mock, instance, when, anything } from 'ts-mockito';
 
-import EntityCacheAdapter from '../../EntityCacheAdapter';
 import EntityConfiguration from '../../EntityConfiguration';
 import { UUIDField } from '../../EntityFields';
+import IEntityCacheAdapter from '../../IEntityCacheAdapter';
 import ReadThroughEntityCache, { CacheStatus } from '../ReadThroughEntityCache';
 
 type BlahFields = {
@@ -39,7 +39,7 @@ const createIdFetcher =
 describe(ReadThroughEntityCache, () => {
   describe('readManyThroughAsync', () => {
     it('fetches from DB upon cache miss and caches the result', async () => {
-      const cacheAdapterMock = mock<EntityCacheAdapter<BlahFields>>();
+      const cacheAdapterMock = mock<IEntityCacheAdapter<BlahFields>>();
       const cacheAdapter = instance(cacheAdapterMock);
       const entityCache = new ReadThroughEntityCache(makeEntityConfiguration(true), cacheAdapter);
       const fetcher = createIdFetcher(['wat', 'who']);
@@ -75,7 +75,7 @@ describe(ReadThroughEntityCache, () => {
     });
 
     it('does not fetch from the DB or cache results when all cache fetches are hits', async () => {
-      const cacheAdapterMock = mock<EntityCacheAdapter<BlahFields>>();
+      const cacheAdapterMock = mock<IEntityCacheAdapter<BlahFields>>();
       const cacheAdapter = instance(cacheAdapterMock);
       const entityCache = new ReadThroughEntityCache(makeEntityConfiguration(true), cacheAdapter);
       const fetcher = createIdFetcher(['wat', 'who']);
@@ -111,7 +111,7 @@ describe(ReadThroughEntityCache, () => {
     });
 
     it('negatively caches db misses', async () => {
-      const cacheAdapterMock = mock<EntityCacheAdapter<BlahFields>>();
+      const cacheAdapterMock = mock<IEntityCacheAdapter<BlahFields>>();
       const cacheAdapter = instance(cacheAdapterMock);
       const entityCache = new ReadThroughEntityCache(makeEntityConfiguration(true), cacheAdapter);
 
@@ -131,7 +131,7 @@ describe(ReadThroughEntityCache, () => {
     });
 
     it('does not return or fetch negatively cached results from DB', async () => {
-      const cacheAdapterMock = mock<EntityCacheAdapter<BlahFields>>();
+      const cacheAdapterMock = mock<IEntityCacheAdapter<BlahFields>>();
       const cacheAdapter = instance(cacheAdapterMock);
       const entityCache = new ReadThroughEntityCache(makeEntityConfiguration(true), cacheAdapter);
       const fetcher = createIdFetcher([]);
@@ -148,7 +148,7 @@ describe(ReadThroughEntityCache, () => {
     });
 
     it('does a mix and match of hit, miss, and negative', async () => {
-      const cacheAdapterMock = mock<EntityCacheAdapter<BlahFields>>();
+      const cacheAdapterMock = mock<IEntityCacheAdapter<BlahFields>>();
       const cacheAdapter = instance(cacheAdapterMock);
       const entityCache = new ReadThroughEntityCache(makeEntityConfiguration(true), cacheAdapter);
       const fetcher = createIdFetcher(['wat', 'who', 'why']);
@@ -183,7 +183,7 @@ describe(ReadThroughEntityCache, () => {
     });
 
     it('does not call into cache for field that is not cacheable', async () => {
-      const cacheAdapterMock = mock<EntityCacheAdapter<BlahFields>>();
+      const cacheAdapterMock = mock<IEntityCacheAdapter<BlahFields>>();
       const cacheAdapter = instance(cacheAdapterMock);
       const entityCache = new ReadThroughEntityCache(makeEntityConfiguration(false), cacheAdapter);
       const fetcher = createIdFetcher(['wat']);
@@ -195,7 +195,7 @@ describe(ReadThroughEntityCache, () => {
 
   describe('invalidateManyAsync', () => {
     it('calls cache adapter invalidate', async () => {
-      const cacheAdapterMock = mock<EntityCacheAdapter<BlahFields>>();
+      const cacheAdapterMock = mock<IEntityCacheAdapter<BlahFields>>();
       const cacheAdapter = instance(cacheAdapterMock);
       const entityCache = new ReadThroughEntityCache(makeEntityConfiguration(true), cacheAdapter);
       await entityCache.invalidateManyAsync('id', ['wat']);

package/src/metrics/EntityMetricsUtils.ts

@@ -1,8 +1,8 @@
-import { reduceMap } from '../utils/collections/maps';
 import IEntityMetricsAdapter, {
   EntityMetricsLoadType,
   EntityMetricsMutationType,
 } from './IEntityMetricsAdapter';
+import { reduceMap } from '../utils/collections/maps';
 
 export const timeAndLogLoadEventAsync =
   (

package/src/rules/AlwaysAllowPrivacyPolicyRule.ts

@@ -1,14 +1,14 @@
+import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
 import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
 import { EntityQueryContext } from '../EntityQueryContext';
 import ReadonlyEntity from '../ReadonlyEntity';
 import ViewerContext from '../ViewerContext';
-import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
 
 /**
  * Privacy policy rule that always allows.
  */
 export default class AlwaysAllowPrivacyPolicyRule<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,

package/src/rules/AlwaysDenyPrivacyPolicyRule.ts

@@ -1,14 +1,14 @@
+import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
 import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
 import { EntityQueryContext } from '../EntityQueryContext';
 import ReadonlyEntity from '../ReadonlyEntity';
 import ViewerContext from '../ViewerContext';
-import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
 
 /**
  * Privacy policy rule that always denies.
  */
 export default class AlwaysDenyPrivacyPolicyRule<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,

package/src/rules/AlwaysSkipPrivacyPolicyRule.ts

@@ -1,14 +1,14 @@
+import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
 import { EntityPrivacyPolicyEvaluationContext } from '../EntityPrivacyPolicy';
 import { EntityQueryContext } from '../EntityQueryContext';
 import ReadonlyEntity from '../ReadonlyEntity';
 import ViewerContext from '../ViewerContext';
-import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
 
 /**
  * A no-op policy rule that always skips.
  */
 export default class AlwaysSkipPrivacyPolicyRule<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,

package/src/rules/PrivacyPolicyRule.ts

@@ -37,7 +37,7 @@ export enum RuleEvaluationResult {
  *   would be named something like `DenyIfViewerHasBeenBlockedPrivacyPolicyRule`.
  */
 export default abstract class PrivacyPolicyRule<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,

package/src/testfixtures/DateIDTestEntity.ts

@@ -43,19 +43,17 @@ export class DateIDTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
 }
 
 export default class DateIDTestEntity extends Entity<DateIDTestFields, Date, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     DateIDTestFields,
     Date,
     ViewerContext,
     DateIDTestEntity,
     DateIDTestEntityPrivacyPolicy
   > {
-    return dateIDTestEntityCompanion;
+    return {
+      entityClass: DateIDTestEntity,
+      entityConfiguration: dateIDTestEntityConfiguration,
+      privacyPolicyClass: DateIDTestEntityPrivacyPolicy,
+    };
   }
 }
-
-export const dateIDTestEntityCompanion = new EntityCompanionDefinition({
-  entityClass: DateIDTestEntity,
-  entityConfiguration: dateIDTestEntityConfiguration,
-  privacyPolicyClass: DateIDTestEntityPrivacyPolicy,
-});

package/src/testfixtures/SimpleTestEntity.ts

@@ -75,7 +75,7 @@ export default class SimpleTestEntity extends Entity<
   ViewerContext,
   SimpleTestFieldSelection
 > {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     SimpleTestFields,
     string,
     ViewerContext,
@@ -83,12 +83,10 @@ export default class SimpleTestEntity extends Entity<
     SimpleTestEntityPrivacyPolicy,
     SimpleTestFieldSelection
   > {
-    return testEntityCompanion;
+    return {
+      entityClass: SimpleTestEntity,
+      entityConfiguration: simpleTestEntityConfiguration,
+      privacyPolicyClass: SimpleTestEntityPrivacyPolicy,
+    };
   }
 }
-
-export const testEntityCompanion = new EntityCompanionDefinition({
-  entityClass: SimpleTestEntity,
-  entityConfiguration: simpleTestEntityConfiguration,
-  privacyPolicyClass: SimpleTestEntityPrivacyPolicy,
-});

package/src/testfixtures/TestEntity.ts

@@ -66,14 +66,18 @@ export class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
 }
 
 export default class TestEntity extends Entity<TestFields, string, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     TestFields,
     string,
     ViewerContext,
     TestEntity,
     TestEntityPrivacyPolicy
   > {
-    return testEntityCompanion;
+    return {
+      entityClass: TestEntity,
+      entityConfiguration: testEntityConfiguration,
+      privacyPolicyClass: TestEntityPrivacyPolicy,
+    };
   }
 
   getBlah(): string {
@@ -81,14 +85,20 @@ export default class TestEntity extends Entity<TestFields, string, ViewerContext
   }
 
   static async hello(viewerContext: ViewerContext, testValue: string): Promise<Result<TestEntity>> {
+    const fields = {
+      customIdField: testValue,
+      testIndexedField: 'hello',
+      stringField: 'hello',
+      intField: 1,
+      dateField: new Date(),
+      nullableField: null,
+    };
     return result(
-      new TestEntity(viewerContext, {
-        customIdField: testValue,
-        testIndexedField: 'hello',
-        stringField: 'hello',
-        intField: 1,
-        dateField: new Date(),
-        nullableField: null,
+      new TestEntity({
+        viewerContext,
+        id: testValue,
+        databaseFields: fields,
+        selectedFields: fields,
       })
     );
   }
@@ -105,9 +115,3 @@ export default class TestEntity extends Entity<TestFields, string, ViewerContext
     return testValue;
   }
 }
-
-export const testEntityCompanion = new EntityCompanionDefinition({
-  entityClass: TestEntity,
-  entityConfiguration: testEntityConfiguration,
-  privacyPolicyClass: TestEntityPrivacyPolicy,
-});

package/src/testfixtures/TestEntity2.ts

@@ -47,19 +47,17 @@ export class TestEntity2PrivacyPolicy extends EntityPrivacyPolicy<
 }
 
 export default class TestEntity2 extends Entity<Test2Fields, string, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     Test2Fields,
     string,
     ViewerContext,
     TestEntity2,
     TestEntity2PrivacyPolicy
   > {
-    return testEntity2Companion;
+    return {
+      entityClass: TestEntity2,
+      entityConfiguration: testEntity2Configuration,
+      privacyPolicyClass: TestEntity2PrivacyPolicy,
+    };
   }
 }
-
-export const testEntity2Companion = new EntityCompanionDefinition({
-  entityClass: TestEntity2,
-  entityConfiguration: testEntity2Configuration,
-  privacyPolicyClass: TestEntity2PrivacyPolicy,
-});

package/src/testfixtures/TestEntityNumberKey.ts

@@ -43,19 +43,17 @@ export class NumberKeyPrivacyPolicy extends EntityPrivacyPolicy<
 }
 
 export default class NumberKeyEntity extends Entity<NumberKeyFields, number, ViewerContext> {
-  static getCompanionDefinition(): EntityCompanionDefinition<
+  static defineCompanionDefinition(): EntityCompanionDefinition<
     NumberKeyFields,
     number,
     ViewerContext,
     NumberKeyEntity,
     NumberKeyPrivacyPolicy
   > {
-    return numberKeyEntityCompanion;
+    return {
+      entityClass: NumberKeyEntity,
+      entityConfiguration: numberKeyEntityConfiguration,
+      privacyPolicyClass: NumberKeyPrivacyPolicy,
+    };
   }
 }
-
-export const numberKeyEntityCompanion = new EntityCompanionDefinition({
-  entityClass: NumberKeyEntity,
-  entityConfiguration: numberKeyEntityConfiguration,
-  privacyPolicyClass: NumberKeyPrivacyPolicy,
-});

package/src/utils/testing/PrivacyPolicyRuleTestUtils.ts

@@ -5,7 +5,7 @@ import ViewerContext from '../../ViewerContext';
 import PrivacyPolicyRule, { RuleEvaluationResult } from '../../rules/PrivacyPolicyRule';
 
 export interface Case<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -18,7 +18,7 @@ export interface Case<
 }
 
 export type CaseMap<
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -29,7 +29,7 @@ export type CaseMap<
  * Useful for defining test cases that have async preconditions.
  */
 export const describePrivacyPolicyRuleWithAsyncTestCase = <
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
@@ -92,7 +92,7 @@ export const describePrivacyPolicyRuleWithAsyncTestCase = <
  * For test simple privacy rules that don't have complex async preconditions.
  */
 export const describePrivacyPolicyRule = <
-  TFields,
+  TFields extends object,
   TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,

package/src/utils/testing/StubCacheAdapter.ts

@@ -1,19 +1,19 @@
 import invariant from 'invariant';
 
-import EntityCacheAdapter from '../../EntityCacheAdapter';
 import EntityConfiguration from '../../EntityConfiguration';
+import IEntityCacheAdapter from '../../IEntityCacheAdapter';
 import IEntityCacheAdapterProvider from '../../IEntityCacheAdapterProvider';
 import { CacheStatus, CacheLoadResult } from '../../internal/ReadThroughEntityCache';
 
 export class NoCacheStubCacheAdapterProvider implements IEntityCacheAdapterProvider {
   getCacheAdapter<TFields>(
-    entityConfiguration: EntityConfiguration<TFields>
-  ): EntityCacheAdapter<TFields> {
-    return new NoCacheStubCacheAdapter(entityConfiguration);
+    _entityConfiguration: EntityConfiguration<TFields>
+  ): IEntityCacheAdapter<TFields> {
+    return new NoCacheStubCacheAdapter();
   }
 }
 
-export class NoCacheStubCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
+export class NoCacheStubCacheAdapter<TFields> implements IEntityCacheAdapter<TFields> {
   public async loadManyAsync<N extends keyof TFields>(
     _fieldName: N,
     fieldValues: readonly NonNullable<TFields[N]>[]
@@ -47,7 +47,7 @@ export class InMemoryFullCacheStubCacheAdapterProvider implements IEntityCacheAd
 
   getCacheAdapter<TFields>(
     entityConfiguration: EntityConfiguration<TFields>
-  ): EntityCacheAdapter<TFields> {
+  ): IEntityCacheAdapter<TFields> {
     return new InMemoryFullCacheStubCacheAdapter(
       entityConfiguration,
       this.cache as Map<string, Readonly<TFields>>
@@ -55,13 +55,11 @@ export class InMemoryFullCacheStubCacheAdapterProvider implements IEntityCacheAd
   }
 }
 
-export class InMemoryFullCacheStubCacheAdapter<TFields> extends EntityCacheAdapter<TFields> {
+export class InMemoryFullCacheStubCacheAdapter<TFields> implements IEntityCacheAdapter<TFields> {
   constructor(
-    entityConfiguration: EntityConfiguration<TFields>,
+    private readonly entityConfiguration: EntityConfiguration<TFields>,
     readonly cache: Map<string, Readonly<TFields>>
-  ) {
-    super(entityConfiguration);
-  }
+  ) {}
 
   public async loadManyAsync<N extends keyof TFields>(
     fieldName: N,

package/src/utils/testing/StubDatabaseAdapterProvider.ts

@@ -1,7 +1,7 @@
+import StubDatabaseAdapter from './StubDatabaseAdapter';
 import EntityConfiguration from '../../EntityConfiguration';
 import EntityDatabaseAdapter from '../../EntityDatabaseAdapter';
 import IEntityDatabaseAdapterProvider from '../../IEntityDatabaseAdapterProvider';
-import StubDatabaseAdapter from './StubDatabaseAdapter';
 
 export default class StubDatabaseAdapterProvider implements IEntityDatabaseAdapterProvider {
   private readonly objectCollection = new Map();

package/src/utils/testing/StubQueryContextProvider.ts

@@ -1,3 +1,4 @@
+import { TransactionConfig } from '../../EntityQueryContext';
 import EntityQueryContextProvider from '../../EntityQueryContextProvider';
 
 export class StubQueryContextProvider extends EntityQueryContextProvider {
@@ -5,9 +6,9 @@ export class StubQueryContextProvider extends EntityQueryContextProvider {
     return {};
   }
 
-  protected createTransactionRunner<T>(): (
-    transactionScope: (queryInterface: any) => Promise<T>
-  ) => Promise<T> {
+  protected createTransactionRunner<T>(
+    _transactionConfig?: TransactionConfig
+  ): (transactionScope: (queryInterface: any) => Promise<T>) => Promise<T> {
     return (transactionScope) => Promise.resolve(transactionScope({}));
   }
 

package/src/utils/testing/createUnitTestEntityCompanionProvider.ts

@@ -1,9 +1,9 @@
-import EntityCompanionProvider from '../../EntityCompanionProvider';
-import IEntityMetricsAdapter from '../../metrics/IEntityMetricsAdapter';
-import NoOpEntityMetricsAdapter from '../../metrics/NoOpEntityMetricsAdapter';
 import { InMemoryFullCacheStubCacheAdapterProvider } from './StubCacheAdapter';
 import StubDatabaseAdapterProvider from './StubDatabaseAdapterProvider';
 import StubQueryContextProvider from './StubQueryContextProvider';
+import EntityCompanionProvider from '../../EntityCompanionProvider';
+import IEntityMetricsAdapter from '../../metrics/IEntityMetricsAdapter';
+import NoOpEntityMetricsAdapter from '../../metrics/NoOpEntityMetricsAdapter';
 
 /**
  * Entity companion provider for use in unit tests. All database and cache implementations

package/build/EntityCacheAdapter.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * A cache adapter is an interface by which objects can be
- * cached, fetched from cache, and removed from cache (invalidated).
- */
-class EntityCacheAdapter {
-    constructor(entityConfiguration) {
-        this.entityConfiguration = entityConfiguration;
-    }
-}
-exports.default = EntityCacheAdapter;
-//# sourceMappingURL=EntityCacheAdapter.js.map

package/build/EntityCacheAdapter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EntityCacheAdapter.js","sourceRoot":"","sources":["../src/EntityCacheAdapter.ts"],"names":[],"mappings":";;AAGA;;;GAGG;AACH,MAA8B,kBAAkB;IAC9C,YAA+B,mBAAiD;QAAjD,wBAAmB,GAAnB,mBAAmB,CAA8B;IAAG,CAAC;CA2CrF;AA5CD,qCA4CC"}