v0.13.0 (#115)

.eslintrc

@@ -10,7 +10,8 @@
   "rules": {
     "no-restricted-imports": ["error",{ "paths": [".", "..", "../.."] }],
     "tsdoc/syntax": "warn",
-    "no-console": "warn"
+    "no-console": "warn",
+    "handle-callback-err": "off"
   },
   "overrides": [
     {

CHANGELOG.md

@@ -3,6 +3,58 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
+
+
+### Bug Fixes
+
+* allow undefined value for all fields ([#114](https://github.com/expo/entity/issues/114)) ([022e0e9](https://github.com/expo/entity/commit/022e0e9b88a5e84e0c1bc6c8810c850beb05f0cf))
+
+
+### Features
+
+* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
+
+
+
+
+
+# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
+
+
+### Bug Fixes
+
+* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
+* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
+
+
+### Features
+
+* better typing on filterMap for use with predicates ([#106](https://github.com/expo/entity/issues/106)) ([01b3bfe](https://github.com/expo/entity/commit/01b3bfef7c6da55e7d89d8cccb52a0050187aee8))
+
+
+
+
+
+# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
+
+
+### Bug Fixes
+
+* add type generic default in test utils ([#104](https://github.com/expo/entity/issues/104)) ([fe2917e](https://github.com/expo/entity/commit/fe2917e6b5af808f166aa354d476e168c41e6d21))
+* maps utils invariants for collections containing undefined values ([#103](https://github.com/expo/entity/issues/103)) ([29c1a43](https://github.com/expo/entity/commit/29c1a434ab6cd8d30e9f0e7c742065c8d46d8d8a))
+* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
+
+
+### Features
+
+* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
+* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
+
+
+
+
+
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 

lerna.json

@@ -4,5 +4,5 @@
   ],
   "npmClient": "yarn",
   "useWorkspaces": true,
-  "version": "0.10.0"
+  "version": "0.13.0"
 }

package.json

@@ -20,21 +20,21 @@
     "@types/jest": "^26.0.10",
     "@types/node": "^14.6.0",
     "@types/uuid": "^8.3.0",
-    "@typescript-eslint/eslint-plugin": "^3.10.1",
-    "@typescript-eslint/parser": "^3.10.1",
+    "@typescript-eslint/eslint-plugin": "^4.14.0",
+    "@typescript-eslint/parser": "^4.14.0",
     "barrelsby": "^2.2.0",
     "eslint": "^7.7.0",
-    "eslint-config-universe": "^4.0.0",
+    "eslint-config-universe": "^7.0.0",
     "eslint-plugin-tsdoc": "^0.2.6",
-    "jest": "^26.4.2",
+    "jest": "^26.6.3",
     "lerna": "^3.22.1",
     "pg": "^8.3.2",
     "prettier": "^2.1.0",
-    "ts-jest": "~26.2.0",
+    "ts-jest": "~26.4.4",
     "ts-mockito": "^2.6.1",
     "typedoc": "^0.17.6",
-    "typedoc-plugin-lerna-packages": "^0.3.0",
-    "typescript": "^4.0.2",
+    "typedoc-plugin-lerna-packages": "^0.3.1",
+    "typescript": "^4.1.3",
     "uuid": "^8.3.0"
   },
   "dependencies": {

packages/entity-cache-adapter-redis/CHANGELOG.md

@@ -3,6 +3,36 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
+
+**Note:** Version bump only for package @expo/entity-cache-adapter-redis
+
+
+
+
+
+# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
+
+
+### Bug Fixes
+
+* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
+
+
+
+
+
+# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
+
+
+### Features
+
+* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
+
+
+
+
+
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 **Note:** Version bump only for package @expo/entity-cache-adapter-redis

packages/entity-cache-adapter-redis/README.md

@@ -35,7 +35,7 @@ export const createDefaultEntityCompanionProvider = (
       ...
     },
     {
-      [CacheAdapterFlavor.REDIS]: {
+      ['redis']: {
         cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
       },
     }

packages/entity-cache-adapter-redis/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expo/entity-cache-adapter-redis",
-  "version": "0.10.0",
+  "version": "0.13.0",
   "description": "Redis cache adapter for @expo/entity",
   "files": [
     "build",
@@ -32,6 +32,6 @@
     "ioredis": "^4.17.3"
   },
   "devDependencies": {
-    "@expo/entity": "^0.10.0"
+    "@expo/entity": "^0.13.0"
   }
 }

packages/entity-cache-adapter-redis/src/RedisCacheAdapter.ts

@@ -8,6 +8,7 @@ import {
 import { Redis } from 'ioredis';
 
 import { redisTransformerMap } from './RedisCommon';
+import wrapNativeRedisCall from './errors/wrapNativeRedisCall';
 
 // Sentinel value we store in Redis to negatively cache a database miss.
 // The sentinel value is distinct from any (positively) cached value.
@@ -71,7 +72,9 @@ export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFiel
     }
 
     const redisKeys = fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue));
-    const redisResults = await this.context.redisClient.mget(...redisKeys);
+    const redisResults = await wrapNativeRedisCall(() =>
+      this.context.redisClient.mget(...redisKeys)
+    );
 
     const results = new Map<NonNullable<TFields[N]>, CacheLoadResult>();
     for (let i = 0; i < fieldValues.length; i++) {
@@ -114,7 +117,7 @@ export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFiel
         this.context.ttlSecondsPositive
       );
     });
-    await redisTransaction.exec();
+    await wrapNativeRedisCall(() => redisTransaction.exec());
   }
 
   public async cacheDBMissesAsync<N extends keyof TFields>(
@@ -135,7 +138,7 @@ export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFiel
         this.context.ttlSecondsNegative
       );
     });
-    await redisTransaction.exec();
+    await wrapNativeRedisCall(() => redisTransaction.exec());
   }
 
   public async invalidateManyAsync<N extends keyof TFields>(
@@ -147,7 +150,7 @@ export default class RedisCacheAdapter<TFields> extends EntityCacheAdapter<TFiel
     }
 
     const redisKeys = fieldValues.map((fieldValue) => this.makeCacheKey(fieldName, fieldValue));
-    await this.context.redisClient.del(...redisKeys);
+    await wrapNativeRedisCall(() => this.context.redisClient.del(...redisKeys));
   }
 
   private makeCacheKey<N extends keyof TFields>(

packages/entity-cache-adapter-redis/src/__integration-tests__/errors-test.ts

@@ -0,0 +1,46 @@
+import { EntityCacheAdapterTransientError, ViewerContext } from '@expo/entity';
+import Redis from 'ioredis';
+import { URL } from 'url';
+
+import RedisCacheAdapter, { RedisCacheAdapterContext } from '../RedisCacheAdapter';
+import RedisTestEntity from '../testfixtures/RedisTestEntity';
+import { createRedisIntegrationTestEntityCompanionProvider } from '../testfixtures/createRedisIntegrationTestEntityCompanionProvider';
+
+class TestViewerContext extends ViewerContext {}
+
+describe(RedisCacheAdapter, () => {
+  let redisCacheAdapterContext: RedisCacheAdapterContext;
+
+  beforeAll(() => {
+    redisCacheAdapterContext = {
+      redisClient: new Redis(new URL(process.env.REDIS_URL!).toString()),
+      makeKeyFn(...parts: string[]): string {
+        const delimiter = ':';
+        const escapedParts = parts.map((part) =>
+          part.replace('\\', '\\\\').replace(delimiter, `\\${delimiter}`)
+        );
+        return escapedParts.join(delimiter);
+      },
+      cacheKeyPrefix: 'test-',
+      cacheKeyVersion: 1,
+      ttlSecondsPositive: 86400, // 1 day
+      ttlSecondsNegative: 600, // 10 minutes
+    };
+  });
+
+  beforeEach(async () => {
+    await redisCacheAdapterContext.redisClient.flushdb();
+  });
+
+  it('throws when redis is disconnected', async () => {
+    redisCacheAdapterContext.redisClient.disconnect();
+
+    const vc1 = new TestViewerContext(
+      createRedisIntegrationTestEntityCompanionProvider(redisCacheAdapterContext)
+    );
+
+    await expect(
+      RedisTestEntity.creator(vc1).setField('name', 'blah').enforceCreateAsync()
+    ).rejects.toThrow(EntityCacheAdapterTransientError);
+  });
+});

packages/entity-cache-adapter-redis/src/__tests__/RedisCacheAdapter-test.ts

@@ -1,10 +1,4 @@
-import {
-  CacheStatus,
-  UUIDField,
-  EntityConfiguration,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-} from '@expo/entity';
+import { CacheStatus, UUIDField, EntityConfiguration } from '@expo/entity';
 import { Redis, Pipeline } from 'ioredis';
 import { mock, when, instance, anything, verify } from 'ts-mockito';
 
@@ -20,8 +14,8 @@ const entityConfiguration = new EntityConfiguration<BlahFields>({
   schema: {
     id: new UUIDField({ columnName: 'id', cache: true }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 describe(RedisCacheAdapter, () => {

packages/entity-cache-adapter-redis/src/errors/wrapNativeRedisCall.ts

@@ -0,0 +1,11 @@
+import { EntityCacheAdapterTransientError } from '@expo/entity';
+
+export default async function wrapNativeRedisCall<T>(fn: () => Promise<T>): Promise<T> {
+  try {
+    return await fn();
+  } catch (e) {
+    const error = new EntityCacheAdapterTransientError(e.message, e);
+    error.stack = e.stack;
+    throw error;
+  }
+}

packages/entity-cache-adapter-redis/src/testfixtures/RedisTestEntity.ts

@@ -6,8 +6,6 @@ import {
   DateField,
   StringField,
   EntityConfiguration,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
 } from '@expo/entity';
@@ -85,8 +83,8 @@ export const redisTestEntityConfiguration = new EntityConfiguration<RedisTestEnt
       columnName: 'date_field',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 const redisTestEntityCompanionDefinition = new EntityCompanionDefinition({

packages/entity-cache-adapter-redis/src/testfixtures/createRedisIntegrationTestEntityCompanionProvider.ts

@@ -2,8 +2,6 @@ import {
   NoOpEntityMetricsAdapter,
   IEntityMetricsAdapter,
   EntityCompanionProvider,
-  CacheAdapterFlavor,
-  DatabaseAdapterFlavor,
   StubQueryContextProvider,
   StubDatabaseAdapterProvider,
 } from '@expo/entity';
@@ -17,16 +15,22 @@ export const createRedisIntegrationTestEntityCompanionProvider = (
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
-    {
-      [DatabaseAdapterFlavor.POSTGRES]: {
-        adapterProvider: new StubDatabaseAdapterProvider(),
-        queryContextProvider: StubQueryContextProvider,
-      },
-    },
-    {
-      [CacheAdapterFlavor.REDIS]: {
-        cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
-      },
-    }
+    new Map([
+      [
+        'postgres',
+        {
+          adapterProvider: new StubDatabaseAdapterProvider(),
+          queryContextProvider: StubQueryContextProvider,
+        },
+      ],
+    ]),
+    new Map([
+      [
+        'redis',
+        {
+          cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
+        },
+      ],
+    ])
   );
 };

packages/entity-database-adapter-knex/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
+
+
+### Features
+
+* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
+
+
+
+
+
+# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
+
+
+### Bug Fixes
+
+* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
+* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
+
+
+
+
+
+# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
+
+
+### Features
+
+* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
+* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
+
+
+
+
+
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 **Note:** Version bump only for package @expo/entity-database-adapter-knex

packages/entity-database-adapter-knex/README.md

@@ -29,7 +29,7 @@ export const createDefaultEntityCompanionProvider = (
     metricsAdapter,
     {
       // add the knex database adapter flavor
-      [DatabaseAdapterFlavor.POSTGRES]: {
+      ['postgres']: {
         adapter: PostgresEntityDatabaseAdapter,
         queryContextProvider: new PostgresEntityQueryContextProvider(knexInstance),
       },

packages/entity-database-adapter-knex/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expo/entity-database-adapter-knex",
-  "version": "0.10.0",
+  "version": "0.13.0",
   "description": "Knex database adapter for @expo/entity",
   "files": [
     "build",
@@ -32,6 +32,6 @@
     "knex": "^0.21.5"
   },
   "devDependencies": {
-    "@expo/entity": "^0.10.0"
+    "@expo/entity": "^0.13.0"
   }
 }

packages/entity-database-adapter-knex/src/PostgresEntityDatabaseAdapter.ts

@@ -10,6 +10,8 @@ import {
 } from '@expo/entity';
 import Knex from 'knex';
 
+import wrapNativePostgresCall from './errors/wrapNativePostgresCall';
+
 export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDatabaseAdapter<TFields> {
   protected getFieldTransformerMap(): FieldTransformerMap {
     return new Map<string, FieldTransformer<any>>([
@@ -43,10 +45,12 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
     tableField: string,
     tableValues: readonly any[]
   ): Promise<object[]> {
-    return await queryInterface
-      .select()
-      .from(tableName)
-      .whereRaw('?? = ANY(?)', [tableField, tableValues as any[]]);
+    return await wrapNativePostgresCall(() =>
+      queryInterface
+        .select()
+        .from(tableName)
+        .whereRaw('?? = ANY(?)', [tableField, tableValues as any[]])
+    );
   }
 
   private applyQueryModifiersToQuery(
@@ -93,12 +97,12 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
 
     if (tableFieldMultiValueEqualityOperands.length > 0) {
       for (const { tableField, tableValues } of tableFieldMultiValueEqualityOperands) {
-        query = query.whereRaw('?? = ANY(?)', [tableField, tableValues]);
+        query = query.whereRaw('?? = ANY(?)', [tableField, [...tableValues]]);
       }
     }
 
     query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
-    return await query;
+    return await wrapNativePostgresCall(() => query);
   }
 
   protected async fetchManyByRawWhereClauseInternalAsync(
@@ -113,7 +117,7 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
       .from(tableName)
       .whereRaw(rawWhereClause, bindings as any);
     query = this.applyQueryModifiersToQuery(query, querySelectionModifiers);
-    return await query;
+    return await wrapNativePostgresCall(() => query);
   }
 
   protected async insertInternalAsync(
@@ -121,7 +125,9 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
     tableName: string,
     object: object
   ): Promise<object[]> {
-    return await queryInterface.insert(object).into(tableName).returning('*');
+    return await wrapNativePostgresCall(() =>
+      queryInterface.insert(object).into(tableName).returning('*')
+    );
   }
 
   protected async updateInternalAsync(
@@ -131,11 +137,9 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
     id: any,
     object: object
   ): Promise<object[]> {
-    return await queryInterface
-      .update(object)
-      .into(tableName)
-      .where(tableIdField, id)
-      .returning('*');
+    return await wrapNativePostgresCall(() =>
+      queryInterface.update(object).into(tableName).where(tableIdField, id).returning('*')
+    );
   }
 
   protected async deleteInternalAsync(
@@ -144,6 +148,8 @@ export default class PostgresEntityDatabaseAdapter<TFields> extends EntityDataba
     tableIdField: string,
     id: any
   ): Promise<number> {
-    return await queryInterface.into(tableName).where(tableIdField, id).del();
+    return await wrapNativePostgresCall(() =>
+      queryInterface.into(tableName).where(tableIdField, id).del()
+    );
   }
 }

packages/entity-database-adapter-knex/src/__integration-tests__/PostgresEntityIntegration-test.ts

@@ -94,7 +94,7 @@ describe('postgres entity integration', () => {
     const errorToThrow = new Error('Intentional error');
 
     await expect(
-      PostgresTestEntity.runInTransactionAsync(vc1, async (queryContext) => {
+      vc1.runInTransactionForDatabaseAdaptorFlavorAsync('postgres', async (queryContext) => {
         // put another in the DB that will be rolled back due to error thrown
         await enforceAsyncResult(
           PostgresTestEntity.creator(vc1, queryContext).setField('name', 'hello').createAsync()

packages/entity-database-adapter-knex/src/__integration-tests__/errors-test.ts

@@ -0,0 +1,170 @@
+import { ViewerContext } from '@expo/entity';
+import {
+  EntityDatabaseAdapterCheckConstraintError,
+  EntityDatabaseAdapterExclusionConstraintError,
+  EntityDatabaseAdapterForeignKeyConstraintError,
+  EntityDatabaseAdapterNotNullConstraintError,
+  EntityDatabaseAdapterTransientError,
+  EntityDatabaseAdapterUniqueConstraintError,
+  EntityDatabaseAdapterUnknownError,
+} from '@expo/entity/build/errors/EntityDatabaseAdapterError';
+import Knex from 'knex';
+
+import ErrorsTestEntity from '../testfixtures/ErrorsTestEntity';
+import { createKnexIntegrationTestEntityCompanionProvider } from '../testfixtures/createKnexIntegrationTestEntityCompanionProvider';
+
+describe('postgres errors', () => {
+  let knexInstance: Knex;
+
+  beforeAll(() => {
+    knexInstance = Knex({
+      client: 'pg',
+      connection: {
+        user: process.env.PGUSER,
+        password: process.env.PGPASSWORD,
+        host: 'localhost',
+        port: parseInt(process.env.PGPORT!, 10),
+        database: process.env.PGDATABASE,
+      },
+    });
+  });
+
+  beforeEach(async () => {
+    await ErrorsTestEntity.createOrTruncatePostgresTable(knexInstance);
+  });
+
+  afterAll(async () => {
+    await ErrorsTestEntity.dropPostgresTable(knexInstance);
+    await knexInstance.destroy();
+  });
+
+  it('throws EntityDatabaseAdapterTransientError on Knex timeout', async () => {
+    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
+    await ErrorsTestEntity.creator(vc)
+      .setField('id', 1)
+      .setField('fieldNonNull', 'hello')
+      .enforceCreateAsync();
+
+    const shortTimeoutKnexInstance = Knex({
+      client: 'pg',
+      connection: {
+        user: process.env.PGUSER,
+        password: process.env.PGPASSWORD,
+        host: 'localhost',
+        port: parseInt(process.env.PGPORT!, 10),
+        database: process.env.PGDATABASE,
+      },
+      acquireConnectionTimeout: 1,
+    });
+    const vc2 = new ViewerContext(
+      createKnexIntegrationTestEntityCompanionProvider(shortTimeoutKnexInstance)
+    );
+    await expect(ErrorsTestEntity.loader(vc2).enforcing().loadByIDAsync(1)).rejects.toThrow(
+      EntityDatabaseAdapterTransientError
+    );
+    await shortTimeoutKnexInstance.destroy();
+  });
+
+  it('throws EntityDatabaseAdapterNotNullConstraintError when not null is violated', async () => {
+    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 1)
+        .setField('fieldNonNull', null as any)
+        .enforceCreateAsync()
+    ).rejects.toThrow(EntityDatabaseAdapterNotNullConstraintError);
+  });
+
+  it('throws EntityDatabaseAdapterForeignKeyConstraintError when foreign key is violated', async () => {
+    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 1)
+        .setField('fieldNonNull', 'hello')
+        .setField('fieldForeignKey', 2)
+        .enforceCreateAsync()
+    ).rejects.toThrow(EntityDatabaseAdapterForeignKeyConstraintError);
+  });
+
+  it('throws EntityDatabaseAdapterUniqueConstraintError when primary key unique constraint is violated', async () => {
+    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
+
+    await ErrorsTestEntity.creator(vc)
+      .setField('id', 1)
+      .setField('fieldNonNull', 'hello')
+      .enforceCreateAsync();
+
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 1)
+        .setField('fieldNonNull', 'hello')
+        .enforceCreateAsync()
+    ).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
+  });
+
+  it('throws EntityDatabaseAdapterUniqueConstraintError when unique constraint is violated', async () => {
+    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
+    await ErrorsTestEntity.creator(vc)
+      .setField('id', 2)
+      .setField('fieldNonNull', 'hello')
+      .setField('fieldUnique', 'hello')
+      .enforceCreateAsync();
+
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 1)
+        .setField('fieldNonNull', 'hello')
+        .setField('fieldUnique', 'hello')
+        .enforceCreateAsync()
+    ).rejects.toThrow(EntityDatabaseAdapterUniqueConstraintError);
+  });
+
+  it('throws EntityDatabaseAdapterCheckConstraintError when check constraint is violated', async () => {
+    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 1)
+        .setField('fieldNonNull', 'hello')
+        .setField('checkLessThan5', 2)
+        .enforceCreateAsync()
+    ).resolves.toBeTruthy();
+
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 2)
+        .setField('fieldNonNull', 'hello')
+        .setField('checkLessThan5', 10)
+        .enforceCreateAsync()
+    ).rejects.toThrow(EntityDatabaseAdapterCheckConstraintError);
+  });
+
+  it('throws EntityDatabaseAdapterExclusionConstraintError when exclusion constraint is violated', async () => {
+    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 1)
+        .setField('fieldNonNull', 'hello')
+        .setField('fieldExclusion', 'what')
+        .enforceCreateAsync()
+    ).resolves.toBeTruthy();
+
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 2)
+        .setField('fieldNonNull', 'hello')
+        .setField('fieldExclusion', 'what')
+        .enforceCreateAsync()
+    ).rejects.toThrow(EntityDatabaseAdapterExclusionConstraintError);
+  });
+
+  it('throws EntityDatabaseAdapterUnknownError otherwise', async () => {
+    const vc = new ViewerContext(createKnexIntegrationTestEntityCompanionProvider(knexInstance));
+    await expect(
+      ErrorsTestEntity.creator(vc)
+        .setField('id', 1)
+        .setField('fieldNonNull', 'hello')
+        .setField('nonExistentColumn', 'what')
+        .enforceCreateAsync()
+    ).rejects.toThrow(EntityDatabaseAdapterUnknownError);
+  });
+});

packages/entity-database-adapter-knex/src/errors/wrapNativePostgresCall.ts

@@ -0,0 +1,50 @@
+import {
+  EntityDatabaseAdapterError,
+  EntityDatabaseAdapterCheckConstraintError,
+  EntityDatabaseAdapterExclusionConstraintError,
+  EntityDatabaseAdapterForeignKeyConstraintError,
+  EntityDatabaseAdapterNotNullConstraintError,
+  EntityDatabaseAdapterTransientError,
+  EntityDatabaseAdapterUniqueConstraintError,
+  EntityDatabaseAdapterUnknownError,
+} from '@expo/entity';
+import { KnexTimeoutError } from 'knex';
+
+function wrapNativePostgresError(
+  error: Error & { code: string | undefined }
+): EntityDatabaseAdapterError & Error {
+  const ret = translatePostgresError(error);
+  ret.stack = error.stack;
+  return ret;
+}
+
+function translatePostgresError(
+  error: Error & { code: string | undefined }
+): EntityDatabaseAdapterError & Error {
+  if (error instanceof KnexTimeoutError) {
+    return new EntityDatabaseAdapterTransientError(error.message, error);
+  }
+
+  switch (error.code) {
+    case '23502':
+      return new EntityDatabaseAdapterNotNullConstraintError(error.message, error);
+    case '23503':
+      return new EntityDatabaseAdapterForeignKeyConstraintError(error.message, error);
+    case '23505':
+      return new EntityDatabaseAdapterUniqueConstraintError(error.message, error);
+    case '23514':
+      return new EntityDatabaseAdapterCheckConstraintError(error.message, error);
+    case '23P01':
+      return new EntityDatabaseAdapterExclusionConstraintError(error.message, error);
+    default:
+      return new EntityDatabaseAdapterUnknownError(error.message, error);
+  }
+}
+
+export default async function wrapNativePostgresCall<T>(fn: () => Promise<T>): Promise<T> {
+  try {
+    return await fn();
+  } catch (e) {
+    throw wrapNativePostgresError(e);
+  }
+}

packages/entity-database-adapter-knex/src/testfixtures/ErrorsTestEntity.ts

@@ -0,0 +1,177 @@
+import {
+  AlwaysAllowPrivacyPolicyRule,
+  EntityPrivacyPolicy,
+  ViewerContext,
+  StringField,
+  EntityConfiguration,
+  EntityCompanionDefinition,
+  Entity,
+  NumberField,
+} from '@expo/entity';
+import Knex from 'knex';
+
+type ErrorsTestEntityFields = {
+  id: number;
+  fieldNonNull: string;
+  fieldForeignKey: number | null;
+  fieldUnique: string | null;
+  checkLessThan5: number | null;
+  fieldExclusion: string | null;
+  nonExistentColumn: string | null;
+};
+
+const foreignTableName = 'foreign_table';
+
+export default class ErrorsTestEntity extends Entity<
+  ErrorsTestEntityFields,
+  number,
+  ViewerContext
+> {
+  static getCompanionDefinition(): EntityCompanionDefinition<
+    ErrorsTestEntityFields,
+    number,
+    ViewerContext,
+    ErrorsTestEntity,
+    ErrorsTestEntityPrivacyPolicy
+  > {
+    return errorsTestEntityCompanionDefinition;
+  }
+
+  public static async createOrTruncatePostgresTable(knex: Knex): Promise<void> {
+    await knex.raw('CREATE EXTENSION IF NOT EXISTS "btree_gist"'); // for gist exclusion on varchar
+
+    const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
+
+    const hasForeignTable = await knex.schema.hasTable(foreignTableName);
+    if (!hasForeignTable) {
+      await knex.schema.createTable(foreignTableName, (table) => {
+        table.integer('id').primary();
+      });
+    }
+
+    const hasTable = await knex.schema.hasTable(tableName);
+    if (!hasTable) {
+      await knex.schema.createTable(tableName, (table) => {
+        table.integer('id').primary();
+        table.string('field_non_null').notNullable();
+        table.integer('field_foreign_key').references(`${foreignTableName}.id`);
+        table.string('field_unique').unique();
+        table.integer('check_less_than_5');
+        table.string('field_exclusion');
+      });
+
+      await knex.raw(
+        `
+        ALTER TABLE :tableName:
+        ADD CONSTRAINT check_less_than_5_check_constraint
+        CHECK (check_less_than_5 IS NULL OR check_less_than_5 < 5);`,
+        {
+          tableName,
+        }
+      );
+
+      await knex.raw(
+        `
+        ALTER TABLE :tableName:
+        ADD CONSTRAINT field_exclusion_exclusion_constraint
+        EXCLUDE USING gist (field_exclusion WITH =);
+        `,
+        {
+          tableName,
+        }
+      );
+    }
+
+    await knex(tableName).delete();
+    await knex(foreignTableName).delete();
+  }
+
+  public static async dropPostgresTable(knex: Knex): Promise<void> {
+    const tableName = this.getCompanionDefinition().entityConfiguration.tableName;
+    const hasTable = await knex.schema.hasTable(tableName);
+    if (hasTable) {
+      await knex.schema.dropTable(tableName);
+    }
+
+    const hasForeignTable = await knex.schema.hasTable(foreignTableName);
+    if (hasForeignTable) {
+      await knex.schema.dropTable(foreignTableName);
+    }
+  }
+}
+
+class ErrorsTestEntityPrivacyPolicy extends EntityPrivacyPolicy<
+  ErrorsTestEntityFields,
+  number,
+  ViewerContext,
+  ErrorsTestEntity
+> {
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      ErrorsTestEntityFields,
+      number,
+      ViewerContext,
+      ErrorsTestEntity
+    >(),
+  ];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      ErrorsTestEntityFields,
+      number,
+      ViewerContext,
+      ErrorsTestEntity
+    >(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      ErrorsTestEntityFields,
+      number,
+      ViewerContext,
+      ErrorsTestEntity
+    >(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      ErrorsTestEntityFields,
+      number,
+      ViewerContext,
+      ErrorsTestEntity
+    >(),
+  ];
+}
+
+export const ErrorsTestEntityConfiguration = new EntityConfiguration<ErrorsTestEntityFields>({
+  idField: 'id',
+  tableName: 'postgres_test_entities',
+  schema: {
+    id: new NumberField({
+      columnName: 'id',
+    }),
+    fieldNonNull: new StringField({
+      columnName: 'field_non_null',
+    }),
+    fieldForeignKey: new NumberField({
+      columnName: 'field_foreign_key',
+    }),
+    fieldUnique: new StringField({
+      columnName: 'field_unique',
+    }),
+    checkLessThan5: new NumberField({
+      columnName: 'check_less_than_5',
+    }),
+    fieldExclusion: new StringField({
+      columnName: 'field_exclusion',
+    }),
+    nonExistentColumn: new StringField({
+      columnName: 'non_existent_column',
+    }),
+  },
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
+});
+
+const errorsTestEntityCompanionDefinition = new EntityCompanionDefinition({
+  entityClass: ErrorsTestEntity,
+  entityConfiguration: ErrorsTestEntityConfiguration,
+  privacyPolicyClass: ErrorsTestEntityPrivacyPolicy,
+});

packages/entity-database-adapter-knex/src/testfixtures/InvalidTestEntity.ts

@@ -4,8 +4,6 @@ import {
   ViewerContext,
   StringField,
   EntityConfiguration,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
   NumberField,
@@ -104,8 +102,8 @@ export const invalidTestEntityConfiguration = new EntityConfiguration<InvalidTes
       columnName: 'name',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 const invalidTestEntityCompanionDefinition = new EntityCompanionDefinition({

packages/entity-database-adapter-knex/src/testfixtures/PostgresTestEntity.ts

@@ -11,8 +11,6 @@ import {
   DateField,
   MaybeJSONArrayField,
   EntityConfiguration,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
 } from '@expo/entity';
@@ -150,8 +148,8 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<PostgresT
       columnName: 'maybe_json_array_field',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({

packages/entity-database-adapter-knex/src/testfixtures/PostgresTriggerTestEntity.ts

@@ -5,8 +5,6 @@ import {
   UUIDField,
   StringField,
   EntityConfiguration,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
   EntityMutationTrigger,
@@ -153,8 +151,8 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<
       columnName: 'name',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({

packages/entity-database-adapter-knex/src/testfixtures/PostgresValidatorTestEntity.ts

@@ -5,8 +5,6 @@ import {
   UUIDField,
   StringField,
   EntityConfiguration,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
   EntityCompanionDefinition,
   Entity,
   EntityMutationTrigger,
@@ -135,8 +133,8 @@ export const postgresTestEntityConfiguration = new EntityConfiguration<
       columnName: 'name',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 const postgresTestEntityCompanionDefinition = new EntityCompanionDefinition({

packages/entity-database-adapter-knex/src/testfixtures/createKnexIntegrationTestEntityCompanionProvider.ts

@@ -2,8 +2,6 @@ import {
   NoOpEntityMetricsAdapter,
   IEntityMetricsAdapter,
   EntityCompanionProvider,
-  CacheAdapterFlavor,
-  DatabaseAdapterFlavor,
   InMemoryFullCacheStubCacheAdapterProvider,
 } from '@expo/entity';
 import Knex from 'knex';
@@ -17,16 +15,22 @@ export const createKnexIntegrationTestEntityCompanionProvider = (
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
-    {
-      [DatabaseAdapterFlavor.POSTGRES]: {
-        adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
-        queryContextProvider: new PostgresEntityQueryContextProvider(knex),
-      },
-    },
-    {
-      [CacheAdapterFlavor.REDIS]: {
-        cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
-      },
-    }
+    new Map([
+      [
+        'postgres',
+        {
+          adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
+          queryContextProvider: new PostgresEntityQueryContextProvider(knex),
+        },
+      ],
+    ]),
+    new Map([
+      [
+        'redis',
+        {
+          cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
+        },
+      ],
+    ])
   );
 };

packages/entity-example/CHANGELOG.md

@@ -3,6 +3,39 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
+
+
+### Features
+
+* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
+
+
+
+
+
+# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
+
+
+### Bug Fixes
+
+* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
+
+
+
+
+
+# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
+
+
+### Bug Fixes
+
+* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
+
+
+
+
+
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 **Note:** Version bump only for package @expo/entity-example

packages/entity-example/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@expo/entity-example",
   "private": true,
-  "version": "0.10.0",
+  "version": "0.13.0",
   "description": "An example integration of the @expo/entity framework",
   "scripts": {
     "tsc": "tsc",
@@ -22,7 +22,7 @@
   "author": "Expo",
   "license": "MIT",
   "dependencies": {
-    "@expo/entity": "^0.10.0",
+    "@expo/entity": "^0.13.0",
     "apollo-server-koa": "^2.16.1",
     "graphql": "^15.3.0",
     "koa": "^2.13.0",

packages/entity-example/src/__tests__/NoteEntity-test.ts

@@ -1,4 +1,5 @@
 import { createUnitTestEntityCompanionProvider } from '@expo/entity';
+import { v4 as uuidv4 } from 'uuid';
 
 import NoteEntity from '../entities/NoteEntity';
 import { UserViewerContext } from '../viewerContexts';
@@ -6,17 +7,18 @@ import { UserViewerContext } from '../viewerContexts';
 describe(NoteEntity, () => {
   test('demonstrate usage of business logic test utilities', async () => {
     const companionProvider = createUnitTestEntityCompanionProvider();
-    const viewerContext = new UserViewerContext(companionProvider, '4');
+    const userId = uuidv4();
+    const viewerContext = new UserViewerContext(companionProvider, userId);
 
     const createdEntityResult = await NoteEntity.creator(viewerContext)
-      .setField('userID', '4')
+      .setField('userID', userId)
       .setField('body', 'image')
       .setField('title', 'page')
       .createAsync();
     expect(createdEntityResult.ok).toBe(true);
 
     const createdEntityResultImpersonate = await NoteEntity.creator(viewerContext)
-      .setField('userID', '5')
+      .setField('userID', uuidv4()) // a different user
       .setField('body', 'image')
       .setField('title', 'page')
       .createAsync();

packages/entity-example/src/__tests__/graphql-integration-test.ts

@@ -1,5 +1,6 @@
 import http from 'http';
 import request from 'supertest';
+import { v4 as uuidv4 } from 'uuid';
 
 import app from '../app';
 
@@ -7,14 +8,15 @@ describe('graphql', () => {
   it('allows CRUD of user notes', async () => {
     const server = request(http.createServer(app.callback()));
 
-    const responseEmpty = await server.post('/graphql').set('totally-secure-user-id', '4').send({
+    const userId = uuidv4();
+    const responseEmpty = await server.post('/graphql').set('totally-secure-user-id', userId).send({
       query: `query { me { notes { id } } }`,
     });
     expect(responseEmpty.body.data.me.notes).toEqual([]);
 
     const createResponse1 = await server
       .post('/graphql')
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send({
         query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
         variables: {
@@ -31,7 +33,7 @@ describe('graphql', () => {
 
     const createResponse2 = await server
       .post('/graphql')
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send({
         query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
         variables: {
@@ -42,14 +44,17 @@ describe('graphql', () => {
         },
       });
 
-    const responseLength2 = await server.post('/graphql').set('totally-secure-user-id', '4').send({
-      query: `query { me { notes { id } } }`,
-    });
+    const responseLength2 = await server
+      .post('/graphql')
+      .set('totally-secure-user-id', userId)
+      .send({
+        query: `query { me { notes { id } } }`,
+      });
     expect(responseLength2.body.data.me.notes).toHaveLength(2);
 
     const responseGetSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send({
         query: `query($id: ID!) { noteByID(id: $id) { id, title, body } }`,
         variables: {
@@ -64,7 +69,7 @@ describe('graphql', () => {
 
     const responseUpdateSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send({
         query: `mutation($id: ID!, $note: NoteInput!) { updateNote(id: $id, note: $note) { id, title, body } }`,
         variables: {
@@ -84,7 +89,7 @@ describe('graphql', () => {
 
     const responseDeleteSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send({
         query: `mutation($id: ID!) { deleteNote(id: $id) { id, title, body } }`,
         variables: {
@@ -102,9 +107,12 @@ describe('graphql', () => {
       body: 'boarding',
     });
 
-    const responseLength1 = await server.post('/graphql').set('totally-secure-user-id', '4').send({
-      query: `query { me { notes { id } } }`,
-    });
+    const responseLength1 = await server
+      .post('/graphql')
+      .set('totally-secure-user-id', userId)
+      .send({
+        query: `query { me { notes { id } } }`,
+      });
     expect(responseLength1.body.data.me.notes).toHaveLength(1);
   });
 
@@ -127,9 +135,11 @@ describe('graphql', () => {
   it('disallows cross-user note impersonation', async () => {
     const server = request(http.createServer(app.callback()));
 
+    const userId = uuidv4();
+    const userId2 = uuidv4();
     const createResponse1 = await server
       .post('/graphql')
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send({
         query: `mutation($note: NoteInput!) { addNote(note: $note) { id, title, body } }`,
         variables: {
@@ -143,7 +153,7 @@ describe('graphql', () => {
     // notes are public
     const responseGetSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', '5')
+      .set('totally-secure-user-id', userId2)
       .send({
         query: `query($id: ID!) { noteByID(id: $id) { id, title, body } }`,
         variables: {
@@ -159,7 +169,7 @@ describe('graphql', () => {
     // but can only be updated by the owner
     const responseUpdateSingle = await server
       .post('/graphql')
-      .set('totally-secure-user-id', '5')
+      .set('totally-secure-user-id', userId2)
       .send({
         query: `mutation($id: ID!, $note: NoteInput!) { updateNote(id: $id, note: $note) { id, title, body } }`,
         variables: {

packages/entity-example/src/__tests__/notesRouter-integration-test.ts

@@ -1,5 +1,6 @@
 import http from 'http';
 import request from 'supertest';
+import { v4 as uuidv4 } from 'uuid';
 
 import app from '../app';
 
@@ -11,59 +12,74 @@ describe('notesRouter', () => {
 
   it('allows CRUD of user notes', async () => {
     const server = request(http.createServer(app.callback()));
-    const responseEmpty = await server.get('/notes/').set('totally-secure-user-id', '4').send();
+
+    const userId = uuidv4();
+
+    const responseEmpty = await server.get('/notes/').set('totally-secure-user-id', userId).send();
     expect(responseEmpty.body.notes).toEqual([]);
 
-    const createResponse1 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
-      title: 'track',
-      body: 'language',
-    });
+    const createResponse1 = await server
+      .post('/notes/')
+      .set('totally-secure-user-id', userId)
+      .send({
+        title: 'track',
+        body: 'language',
+      });
     expect(createResponse1.body.note).toMatchObject({
-      userID: '4',
+      userID: userId,
       title: 'track',
       body: 'language',
     });
 
-    const createResponse2 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
-      title: 'nine',
-      body: 'lotion',
-    });
+    const createResponse2 = await server
+      .post('/notes/')
+      .set('totally-secure-user-id', userId)
+      .send({
+        title: 'nine',
+        body: 'lotion',
+      });
 
-    const responseLength2 = await server.get('/notes/').set('totally-secure-user-id', '4').send();
+    const responseLength2 = await server
+      .get('/notes/')
+      .set('totally-secure-user-id', userId)
+      .send();
     expect(responseLength2.body.notes).toHaveLength(2);
 
     const responseGetSingle = await server
       .get(`/notes/${createResponse2.body.note.id}`)
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send();
     expect(responseGetSingle.body.note).toMatchObject({
       id: createResponse2.body.note.id,
-      userID: '4',
+      userID: userId,
       title: 'nine',
       body: 'lotion',
     });
 
     const responseUpdateSingle = await server
       .put(`/notes/${createResponse2.body.note.id}`)
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send({
         title: 'wave',
         body: 'boarding',
       });
     expect(responseUpdateSingle.body.note).toMatchObject({
       id: responseGetSingle.body.note.id,
-      userID: '4',
+      userID: userId,
       title: 'wave',
       body: 'boarding',
     });
 
     const responseDeleteSingle = await server
       .delete(`/notes/${createResponse2.body.note.id}`)
-      .set('totally-secure-user-id', '4')
+      .set('totally-secure-user-id', userId)
       .send();
     expect(responseDeleteSingle.body.status).toEqual('ok');
 
-    const responseLength1 = await server.get('/notes/').set('totally-secure-user-id', '4').send();
+    const responseLength1 = await server
+      .get('/notes/')
+      .set('totally-secure-user-id', userId)
+      .send();
     expect(responseLength1.body.notes).toHaveLength(1);
   });
 
@@ -79,23 +95,28 @@ describe('notesRouter', () => {
 
   it('disallows cross-user note impersonation', async () => {
     const server = request(http.createServer(app.callback()));
-    const createResponse1 = await server.post('/notes/').set('totally-secure-user-id', '4').send({
-      title: 'track',
-      body: 'language',
-    });
+    const userId = uuidv4();
+    const userId2 = uuidv4();
+    const createResponse1 = await server
+      .post('/notes/')
+      .set('totally-secure-user-id', userId)
+      .send({
+        title: 'track',
+        body: 'language',
+      });
     expect(createResponse1.ok).toBe(true);
 
     // notes are public
     const responseGetSingleOtherUser = await server
       .get(`/notes/${createResponse1.body.note.id}`)
-      .set('totally-secure-user-id', '5')
+      .set('totally-secure-user-id', userId2)
       .send();
     expect(responseGetSingleOtherUser.ok).toBe(true);
 
     // but can only be updated by the owner
     const responseUpdateSingle = await server
       .put(`/notes/${createResponse1.body.note.id}`)
-      .set('totally-secure-user-id', '5')
+      .set('totally-secure-user-id', userId2)
       .send({
         title: 'wave',
         body: 'boarding',

packages/entity-example/src/data.ts

@@ -3,8 +3,6 @@ import {
   NoOpEntityMetricsAdapter,
   EntityCompanionProvider,
   InMemoryFullCacheStubCacheAdapterProvider,
-  CacheAdapterFlavor,
-  DatabaseAdapterFlavor,
 } from '@expo/entity';
 
 import { InMemoryDatabaseAdapterProvider } from './adapters/InMemoryDatabaseAdapter';
@@ -21,20 +19,26 @@ export const createEntityCompanionProvider = (
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
-    {
-      // An in-memory DB is used for demonstration purposes, but generally this would be
-      // instantiated with PostgresEntityDatabaseAdapter and PostgresEntityQueryContextProvider
-      [DatabaseAdapterFlavor.POSTGRES]: {
-        adapterProvider: new InMemoryDatabaseAdapterProvider(),
-        queryContextProvider: new InMemoryQueryContextProvider(),
-      },
-    },
-    {
-      // An in-memory cache is used for demonstration purposes, but generally this would be
-      // instantiated with a RedisCacheAdapterProvider
-      [CacheAdapterFlavor.REDIS]: {
-        cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
-      },
-    }
+    new Map([
+      [
+        'postgres',
+        // An in-memory DB is used for demonstration purposes, but generally this would be
+        // instantiated with PostgresEntityDatabaseAdapter and PostgresEntityQueryContextProvider
+        {
+          adapterProvider: new InMemoryDatabaseAdapterProvider(),
+          queryContextProvider: new InMemoryQueryContextProvider(),
+        },
+      ],
+    ]),
+    new Map([
+      [
+        'redis',
+        // An in-memory cache is used for demonstration purposes, but generally this would be
+        // instantiated with a RedisCacheAdapterProvider
+        {
+          cacheAdapterProvider: new InMemoryFullCacheStubCacheAdapterProvider(),
+        },
+      ],
+    ])
   );
 };

packages/entity-example/src/entities/AllowIfUserOwnerPrivacyRule.ts

@@ -23,8 +23,9 @@ import { ExampleViewerContext } from '../viewerContexts';
  */
 export default class AllowIfUserOwnerPrivacyRule<
   TFields,
-  TID,
-  TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>
+  TID extends NonNullable<TFields[TSelectedFields]>,
+  TEntity extends ReadonlyEntity<TFields, TID, ExampleViewerContext>,
+  TSelectedFields extends keyof TFields = keyof TFields
 > extends PrivacyPolicyRule<TFields, TID, ExampleViewerContext, TEntity> {
   constructor(private readonly entityOwnerField: keyof TFields) {
     super();

packages/entity-example/src/entities/NoteEntity.ts

@@ -3,8 +3,6 @@ import {
   EntityCompanionDefinition,
   EntityConfiguration,
   UUIDField,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
   StringField,
 } from '@expo/entity';
 
@@ -57,8 +55,8 @@ export const noteEntityCompanion = new EntityCompanionDefinition({
         columnName: 'body',
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   }),
   privacyPolicyClass: NotePrivacyPolicy,
 });

packages/entity-full-integration-tests/CHANGELOG.md

@@ -3,6 +3,40 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
+
+
+### Features
+
+* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
+
+
+
+
+
+# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
+
+
+### Bug Fixes
+
+* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
+* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
+
+
+
+
+
+# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
+
+
+### Bug Fixes
+
+* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
+
+
+
+
+
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 **Note:** Version bump only for package @expo/entity-full-integration-tests

packages/entity-full-integration-tests/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@expo/entity-full-integration-tests",
   "private": true,
-  "version": "0.10.0",
+  "version": "0.13.0",
   "description": "Full redis and knex integration tests for the entity framework",
   "scripts": {
     "tsc": "tsc",
@@ -26,8 +26,8 @@
     "@expo/entity-database-adapter-knex": "*"
   },
   "devDependencies": {
-    "@expo/entity": "^0.10.0",
-    "@expo/entity-cache-adapter-redis": "^0.10.0",
-    "@expo/entity-database-adapter-knex": "^0.10.0"
+    "@expo/entity": "^0.13.0",
+    "@expo/entity-cache-adapter-redis": "^0.13.0",
+    "@expo/entity-database-adapter-knex": "^0.13.0"
   }
 }

packages/entity-full-integration-tests/src/__integration-tests__/EntityCacheInconsistency-test.ts

@@ -5,9 +5,8 @@ import {
   Entity,
   EntityCompanionDefinition,
   EntityConfiguration,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
   UUIDField,
+  StringField,
 } from '@expo/entity';
 import { RedisCacheAdapterContext } from '@expo/entity-cache-adapter-redis';
 import Redis from 'ioredis';
@@ -28,10 +27,18 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ViewerContext,
   TestEntity
 > {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<TestFields, string, ViewerContext, TestEntity>(),
+  ];
 }
 
 class TestEntity extends Entity<TestFields, string, ViewerContext> {
@@ -54,16 +61,16 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
       columnName: 'id',
       cache: true,
     }),
-    other_string: new UUIDField({
+    other_string: new StringField({
       columnName: 'other_string',
       cache: true,
     }),
-    third_string: new UUIDField({
+    third_string: new StringField({
       columnName: 'third_string',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 const testEntityCompanion = new EntityCompanionDefinition({
@@ -151,12 +158,12 @@ describe('Entity cache inconsistency', () => {
       .loadByFieldEqualingAsync('other_string', 'hello');
 
     let openBarrier1: () => void;
-    const barrier1 = new Promise((resolve) => {
+    const barrier1 = new Promise<void>((resolve) => {
       openBarrier1 = resolve;
     });
 
     let openBarrier2: () => void;
-    const barrier2 = new Promise((resolve) => {
+    const barrier2 = new Promise<void>((resolve) => {
       openBarrier2 = resolve;
     });
 
@@ -175,16 +182,19 @@ describe('Entity cache inconsistency', () => {
 
         openBarrier2!();
       })(),
-      TestEntity.runInTransactionAsync(viewerContext, async (queryContext) => {
-        await TestEntity.updater(entity1, queryContext)
-          .setField('third_string', 'updated')
-          .enforceUpdateAsync();
+      viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+        'postgres',
+        async (queryContext) => {
+          await TestEntity.updater(entity1, queryContext)
+            .setField('third_string', 'updated')
+            .enforceUpdateAsync();
 
-        openBarrier1();
+          openBarrier1();
 
-        // wait for to ensure the transaction isn't committed until after load above occurs
-        await barrier2;
-      }),
+          // wait for to ensure the transaction isn't committed until after load above occurs
+          await barrier2;
+        }
+      ),
     ]);
 
     // ensure cache consistency

packages/entity-full-integration-tests/src/__integration-tests__/EntitySelfReferentialEdgesIntegration-test.ts

@@ -5,8 +5,6 @@ import {
   Entity,
   EntityCompanionDefinition,
   EntityConfiguration,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
   UUIDField,
   EntityEdgeDeletionBehavior,
 } from '@expo/entity';
@@ -29,10 +27,18 @@ interface OtherFields {
 }
 
 class PrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any> {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any>(),
+  ];
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -82,8 +88,8 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
         },
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   });
 
   const categoryEntityCompanion = new EntityCompanionDefinition({
@@ -110,8 +116,8 @@ const makeEntityClasses = async (knex: Knex, edgeDeletionBehavior: EntityEdgeDel
         },
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   });
 
   const otherEntityCompanion = new EntityCompanionDefinition({

packages/entity-full-integration-tests/src/__integration-tests__/entities/ChildEntity.ts

@@ -1,7 +1,5 @@
 import {
   AlwaysAllowPrivacyPolicyRule,
-  CacheAdapterFlavor,
-  DatabaseAdapterFlavor,
   Entity,
   EntityCompanionDefinition,
   EntityConfiguration,
@@ -19,10 +17,18 @@ interface ChildFields {
 }
 
 class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
 }
 
 export default class ChildEntity extends Entity<ChildFields, string, ViewerContext> {
@@ -54,8 +60,8 @@ const childEntityConfiguration = new EntityConfiguration<ChildFields>({
       },
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 const childEntityCompanion = new EntityCompanionDefinition({

packages/entity-full-integration-tests/src/__integration-tests__/entities/ParentEntity.ts

@@ -1,7 +1,5 @@
 import {
   AlwaysAllowPrivacyPolicyRule,
-  CacheAdapterFlavor,
-  DatabaseAdapterFlavor,
   Entity,
   EntityCompanionDefinition,
   EntityConfiguration,
@@ -17,10 +15,18 @@ interface ParentFields {
 }
 
 class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
 }
 
 export default class ParentEntity extends Entity<ParentFields, string, ViewerContext> {
@@ -45,8 +51,8 @@ const parentEntityConfiguration = new EntityConfiguration<ParentFields>({
       cache: true,
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 const parentEntityCompanion = new EntityCompanionDefinition({

packages/entity-full-integration-tests/src/testfixtures/createFullIntegrationTestEntityCompanionProvider.ts

@@ -2,8 +2,6 @@ import {
   NoOpEntityMetricsAdapter,
   IEntityMetricsAdapter,
   EntityCompanionProvider,
-  CacheAdapterFlavor,
-  DatabaseAdapterFlavor,
 } from '@expo/entity';
 import {
   RedisCacheAdapterContext,
@@ -22,16 +20,22 @@ export const createFullIntegrationTestEntityCompanionProvider = (
 ): EntityCompanionProvider => {
   return new EntityCompanionProvider(
     metricsAdapter,
-    {
-      [DatabaseAdapterFlavor.POSTGRES]: {
-        adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
-        queryContextProvider: new PostgresEntityQueryContextProvider(knex),
-      },
-    },
-    {
-      [CacheAdapterFlavor.REDIS]: {
-        cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
-      },
-    }
+    new Map([
+      [
+        'postgres',
+        {
+          adapterProvider: new PostgresEntityDatabaseAdapterProvider(),
+          queryContextProvider: new PostgresEntityQueryContextProvider(knex),
+        },
+      ],
+    ]),
+    new Map([
+      [
+        'redis',
+        {
+          cacheAdapterProvider: new RedisCacheAdapterProvider(redisCacheAdapterContext),
+        },
+      ],
+    ])
   );
 };

packages/entity/CHANGELOG.md

@@ -3,6 +3,58 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.13.0](https://github.com/expo/entity/compare/v0.12.0...v0.13.0) (2021-02-12)
+
+
+### Bug Fixes
+
+* allow undefined value for all fields ([#114](https://github.com/expo/entity/issues/114)) ([022e0e9](https://github.com/expo/entity/commit/022e0e9b88a5e84e0c1bc6c8810c850beb05f0cf))
+
+
+### Features
+
+* add basic field type runtime validators ([#113](https://github.com/expo/entity/issues/113)) ([6c4d4b0](https://github.com/expo/entity/commit/6c4d4b03b5404dd776a12c5eb6f0af77a8c964f8))
+
+
+
+
+
+# [0.12.0](https://github.com/expo/entity/compare/v0.11.0...v0.12.0) (2021-01-22)
+
+
+### Bug Fixes
+
+* move runInTransaction to ViewerContext ([#108](https://github.com/expo/entity/issues/108)) ([b7309e1](https://github.com/expo/entity/commit/b7309e18a2dd780b64cd306d566de1f12bf8df3a))
+* remove cache and database adaptor flavor enums ([#109](https://github.com/expo/entity/issues/109)) ([72a77f8](https://github.com/expo/entity/commit/72a77f8b6893a4b76d3b1cce16659bdf3ce473ee))
+
+
+### Features
+
+* better typing on filterMap for use with predicates ([#106](https://github.com/expo/entity/issues/106)) ([01b3bfe](https://github.com/expo/entity/commit/01b3bfef7c6da55e7d89d8cccb52a0050187aee8))
+
+
+
+
+
+# [0.11.0](https://github.com/expo/entity/compare/v0.10.0...v0.11.0) (2020-12-24)
+
+
+### Bug Fixes
+
+* add type generic default in test utils ([#104](https://github.com/expo/entity/issues/104)) ([fe2917e](https://github.com/expo/entity/commit/fe2917e6b5af808f166aa354d476e168c41e6d21))
+* maps utils invariants for collections containing undefined values ([#103](https://github.com/expo/entity/issues/103)) ([29c1a43](https://github.com/expo/entity/commit/29c1a434ab6cd8d30e9f0e7c742065c8d46d8d8a))
+* remove any cast from EntityLoader ([#100](https://github.com/expo/entity/issues/100)) ([b8e07f9](https://github.com/expo/entity/commit/b8e07f9ddc4077768980c000d61f5ddcc824e2e3))
+
+
+### Features
+
+* better cache adapter error handling ([#102](https://github.com/expo/entity/issues/102)) ([15546aa](https://github.com/expo/entity/commit/15546aad97734ab9ac67f1c012485f096a0e94f1))
+* better database adapter error handling ([#101](https://github.com/expo/entity/issues/101)) ([5208aee](https://github.com/expo/entity/commit/5208aeedb0192f0460ba3d575770a04175f5c3aa))
+
+
+
+
+
 # [0.10.0](https://github.com/expo/entity/compare/v0.9.1...v0.10.0) (2020-11-17)
 
 

packages/entity/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@expo/entity",
-  "version": "0.10.0",
+  "version": "0.13.0",
   "description": "A privacy-first data model",
   "files": [
     "build",

packages/entity/src/EnforcingEntityLoader.ts

@@ -11,7 +11,7 @@ import { mapMap } from './utils/collections/maps';
  */
 export default class EnforcingEntityLoader<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/Entity.ts

@@ -27,7 +27,7 @@ import ViewerContext from './ViewerContext';
  */
 export default abstract class Entity<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TSelectedFields extends keyof TFields = keyof TFields
 > extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields> {
@@ -39,7 +39,7 @@ export default abstract class Entity<
    */
   static creator<
     TMFields,
-    TMID,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMViewerContext2 extends TMViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
@@ -80,7 +80,7 @@ export default abstract class Entity<
    */
   static updater<
     TMFields,
-    TMID,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -121,7 +121,7 @@ export default abstract class Entity<
    */
   static deleteAsync<
     TMFields,
-    TMID,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -163,7 +163,7 @@ export default abstract class Entity<
    */
   static enforceDeleteAsync<
     TMFields,
-    TMID,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -216,7 +216,7 @@ export default abstract class Entity<
    */
   static async canViewerUpdateAsync<
     TMFields,
-    TMID,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -265,7 +265,7 @@ export default abstract class Entity<
    */
   static async canViewerDeleteAsync<
     TMFields,
-    TMID,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -309,7 +309,7 @@ export default abstract class Entity<
  */
 export interface IEntityClass<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/EntityAssociationLoader.ts

@@ -8,7 +8,7 @@ import ViewerContext from './ViewerContext';
 
 export default class EntityAssociationLoader<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields
@@ -25,7 +25,7 @@ export default class EntityAssociationLoader<
   async loadAssociatedEntityAsync<
     TIdentifyingField extends keyof Pick<TFields, TSelectedFields>,
     TAssociatedFields,
-    TAssociatedID,
+    TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
     TAssociatedEntity extends ReadonlyEntity<
       TAssociatedFields,
       TAssociatedID,
@@ -87,7 +87,7 @@ export default class EntityAssociationLoader<
    */
   async loadManyAssociatedEntitiesAsync<
     TAssociatedFields,
-    TAssociatedID,
+    TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
     TAssociatedEntity extends ReadonlyEntity<
       TAssociatedFields,
       TAssociatedID,
@@ -140,7 +140,7 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityByFieldEqualingAsync<
     TAssociatedFields,
-    TAssociatedID,
+    TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
     TAssociatedEntity extends ReadonlyEntity<
       TAssociatedFields,
       TAssociatedID,
@@ -197,7 +197,7 @@ export default class EntityAssociationLoader<
    */
   async loadManyAssociatedEntitiesByFieldEqualingAsync<
     TAssociatedFields,
-    TAssociatedID,
+    TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
     TAssociatedEntity extends ReadonlyEntity<
       TAssociatedFields,
       TAssociatedID,
@@ -253,7 +253,7 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityThroughAsync<
     TFields2,
-    TID2,
+    TID2 extends NonNullable<TFields2[TSelectedFields2]>,
     TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
     TPrivacyPolicy2 extends EntityPrivacyPolicy<
       TFields2,
@@ -287,7 +287,7 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityThroughAsync<
     TFields2,
-    TID2,
+    TID2 extends NonNullable<TFields2[TSelectedFields2]>,
     TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
     TPrivacyPolicy2 extends EntityPrivacyPolicy<
       TFields2,
@@ -297,7 +297,7 @@ export default class EntityAssociationLoader<
       TSelectedFields2
     >,
     TFields3,
-    TID3,
+    TID3 extends NonNullable<TFields3[TSelectedFields3]>,
     TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
     TPrivacyPolicy3 extends EntityPrivacyPolicy<
       TFields3,
@@ -342,7 +342,7 @@ export default class EntityAssociationLoader<
    */
   async loadAssociatedEntityThroughAsync<
     TFields2,
-    TID2,
+    TID2 extends NonNullable<TFields2[TSelectedFields2]>,
     TEntity2 extends ReadonlyEntity<TFields2, TID2, TViewerContext, TSelectedFields2>,
     TPrivacyPolicy2 extends EntityPrivacyPolicy<
       TFields2,
@@ -352,7 +352,7 @@ export default class EntityAssociationLoader<
       TSelectedFields2
     >,
     TFields3,
-    TID3,
+    TID3 extends NonNullable<TFields3[TSelectedFields3]>,
     TEntity3 extends ReadonlyEntity<TFields3, TID3, TViewerContext, TSelectedFields3>,
     TPrivacyPolicy3 extends EntityPrivacyPolicy<
       TFields3,
@@ -362,7 +362,7 @@ export default class EntityAssociationLoader<
       TSelectedFields3
     >,
     TFields4,
-    TID4,
+    TID4 extends NonNullable<TFields4[TSelectedFields4]>,
     TEntity4 extends ReadonlyEntity<TFields4, TID4, TViewerContext, TSelectedFields4>,
     TPrivacyPolicy4 extends EntityPrivacyPolicy<
       TFields4,
@@ -478,7 +478,7 @@ export interface EntityLoadThroughDirective<
   TViewerContext extends ViewerContext,
   TFields,
   TAssociatedFields,
-  TAssociatedID,
+  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
   TAssociatedEntity extends ReadonlyEntity<
     TAssociatedFields,
     TAssociatedID,

packages/entity/src/EntityCompanion.ts

@@ -19,7 +19,7 @@ export interface IPrivacyPolicyClass<TPrivacyPolicy> {
  */
 export default class EntityCompanion<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -84,7 +84,7 @@ export default class EntityCompanion<
       TPrivacyPolicy,
       TSelectedFields
     >(
-      tableDataCoordinator.entityConfiguration.idField as keyof Pick<TFields, TSelectedFields>,
+      tableDataCoordinator.entityConfiguration,
       entityClass,
       privacyPolicy,
       tableDataCoordinator.dataManager

packages/entity/src/EntityCompanionProvider.ts

@@ -1,3 +1,5 @@
+import invariant from 'invariant';
+
 import { IEntityClass } from './Entity';
 import EntityCompanion, { IPrivacyPolicyClass } from './EntityCompanion';
 import EntityConfiguration from './EntityConfiguration';
@@ -16,25 +18,14 @@ import { computeIfAbsent } from './utils/collections/maps';
 /**
  * Backing database and transaction type for an entity. The definitions and implementations
  * are provided by injection in the root EntityCompanionProvider to allow for mocking and sharing.
- *
- * Note: this enum will likely be modified soon to be more flexible.
  */
-export enum DatabaseAdapterFlavor {
-  /**
-   * Knex postgres adapter, using postgres table and postgres transactions.
-   */
-  POSTGRES = 'postgres',
-}
+export type DatabaseAdapterFlavor = string;
 
 /**
  * Cache system for an entity. The definitions and implementations are provided by injection
  * in the root EntityCompanionProvider to allow for mocking and sharing.
- *
- * Note: this enum will likely be modified soon to be more flexible.
  */
-export enum CacheAdapterFlavor {
-  REDIS = 'redis',
-}
+export type CacheAdapterFlavor = string;
 
 /**
  * Defines a set interfaces for a entity database adapter flavor. An entity that uses a flavor
@@ -60,7 +51,7 @@ export interface CacheAdapterFlavorDefinition {
  */
 export class EntityCompanionDefinition<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -168,8 +159,11 @@ export default class EntityCompanionProvider {
    */
   constructor(
     private metricsAdapter: IEntityMetricsAdapter,
-    private databaseAdapterFlavors: Record<DatabaseAdapterFlavor, DatabaseAdapterFlavorDefinition>,
-    private cacheAdapterFlavors: Record<CacheAdapterFlavor, CacheAdapterFlavorDefinition>
+    private databaseAdapterFlavors: ReadonlyMap<
+      DatabaseAdapterFlavor,
+      DatabaseAdapterFlavorDefinition
+    >,
+    private cacheAdapterFlavors: ReadonlyMap<CacheAdapterFlavor, CacheAdapterFlavorDefinition>
   ) {}
 
   /**
@@ -181,7 +175,7 @@ export default class EntityCompanionProvider {
    */
   getCompanionForEntity<
     TFields,
-    TID,
+    TID extends NonNullable<TFields[TSelectedFields]>,
     TViewerContext extends ViewerContext,
     TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
     TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -226,17 +220,39 @@ export default class EntityCompanionProvider {
     });
   }
 
+  getQueryContextProviderForDatabaseAdaptorFlavor(
+    databaseAdapterFlavor: DatabaseAdapterFlavor
+  ): EntityQueryContextProvider {
+    const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors.get(databaseAdapterFlavor);
+    invariant(
+      entityDatabaseAdapterFlavor,
+      `No database adaptor configuration found for flavor: ${databaseAdapterFlavor}`
+    );
+
+    return entityDatabaseAdapterFlavor.queryContextProvider;
+  }
+
   private getTableDataCoordinatorForEntity<TFields>(
     entityConfiguration: EntityConfiguration<TFields>,
     entityClassName: string
   ): EntityTableDataCoordinator<TFields> {
     return computeIfAbsent(this.tableDataCoordinatorMap, entityConfiguration.tableName, () => {
-      const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors[
+      const entityDatabaseAdapterFlavor = this.databaseAdapterFlavors.get(
         entityConfiguration.databaseAdapterFlavor
-      ];
-      const entityCacheAdapterFlavor = this.cacheAdapterFlavors[
+      );
+      invariant(
+        entityDatabaseAdapterFlavor,
+        `No database adaptor configuration found for flavor: ${entityConfiguration.databaseAdapterFlavor}`
+      );
+
+      const entityCacheAdapterFlavor = this.cacheAdapterFlavors.get(
         entityConfiguration.cacheAdapterFlavor
-      ];
+      );
+      invariant(
+        entityCacheAdapterFlavor,
+        `No cache adaptor configuration found for flavor: ${entityConfiguration.cacheAdapterFlavor}`
+      );
+
       return new EntityTableDataCoordinator(
         entityConfiguration,
         entityDatabaseAdapterFlavor.adapterProvider,

packages/entity/src/EntityConfiguration.ts

@@ -14,7 +14,7 @@ export default class EntityConfiguration<TFields> {
   readonly cacheKeyVersion: number;
 
   readonly getInboundEdges: () => IEntityClass<any, any, any, any, any, any>[];
-  readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>;
+  readonly schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>;
   readonly entityToDBFieldsKeyMapping: ReadonlyMap<keyof TFields, string>;
   readonly dbToEntityFieldsKeyMapping: ReadonlyMap<string, keyof TFields>;
 
@@ -32,7 +32,7 @@ export default class EntityConfiguration<TFields> {
   }: {
     idField: keyof TFields;
     tableName: string;
-    schema: Record<keyof TFields, EntityFieldDefinition>;
+    schema: Record<keyof TFields, EntityFieldDefinition<any>>;
     getInboundEdges?: () => IEntityClass<any, any, any, any, any, any>[];
     cacheKeyVersion?: number;
     databaseAdapterFlavor: DatabaseAdapterFlavor;
@@ -59,7 +59,7 @@ export default class EntityConfiguration<TFields> {
   }
 
   private static computeCacheableKeys<TFields>(
-    schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>
+    schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>
   ): ReadonlySet<keyof TFields> {
     return reduceMap(
       schema,
@@ -74,7 +74,7 @@ export default class EntityConfiguration<TFields> {
   }
 
   private static computeEntityToDBFieldsKeyMapping<TFields>(
-    schema: ReadonlyMap<keyof TFields, EntityFieldDefinition>
+    schema: ReadonlyMap<keyof TFields, EntityFieldDefinition<any>>
   ): ReadonlyMap<keyof TFields, string> {
     return mapMap(schema, (v) => v.columnName);
   }

packages/entity/src/EntityDatabaseAdapter.ts

@@ -9,19 +9,22 @@ import {
 
 interface SingleValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
   fieldName: N;
-  fieldValue: TFields[N];
+  fieldValue: NonNullable<TFields[N]>;
 }
 
 interface MultiValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> {
   fieldName: N;
-  fieldValues: TFields[N][];
+  fieldValues: readonly NonNullable<TFields[N]>[];
 }
 
 export type FieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields> =
   | SingleValueFieldEqualityCondition<TFields, N>
   | MultiValueFieldEqualityCondition<TFields, N>;
 
-function isSingleValueFieldEqualityCondition<TFields, N extends keyof TFields = keyof TFields>(
+export function isSingleValueFieldEqualityCondition<
+  TFields,
+  N extends keyof TFields = keyof TFields
+>(
   condition: FieldEqualityCondition<TFields, N>
 ): condition is SingleValueFieldEqualityCondition<TFields, N> {
   return (condition as SingleValueFieldEqualityCondition<TFields, N>).fieldValue !== undefined;
@@ -34,7 +37,7 @@ export interface TableFieldSingleValueEqualityCondition {
 
 export interface TableFieldMultiValueEqualityCondition {
   tableField: string;
-  tableValues: any[];
+  tableValues: readonly any[];
 }
 
 export enum OrderByOrdering {

packages/entity/src/EntityErrors.ts

@@ -1,61 +0,0 @@
-import ES6Error from 'es6-error';
-
-import { IEntityClass } from './Entity';
-import EntityPrivacyPolicy, { EntityAuthorizationAction } from './EntityPrivacyPolicy';
-import ReadonlyEntity from './ReadonlyEntity';
-import ViewerContext from './ViewerContext';
-
-export abstract class EntityError extends ES6Error {}
-
-export class EntityNotFoundError<
-  TFields,
-  TID,
-  TViewerContext extends ViewerContext,
-  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
-  TPrivacyPolicy extends EntityPrivacyPolicy<
-    TFields,
-    TID,
-    TViewerContext,
-    TEntity,
-    TSelectedFields
-  >,
-  N extends keyof TFields,
-  TSelectedFields extends keyof TFields = keyof TFields
-> extends EntityError {
-  constructor(
-    entityClass: IEntityClass<
-      TFields,
-      TID,
-      TViewerContext,
-      TEntity,
-      TPrivacyPolicy,
-      TSelectedFields
-    >,
-    fieldName: N,
-    fieldValue: TFields[N]
-  ) {
-    super(`Entity not found: ${entityClass.name} (${fieldName} = ${fieldValue})`);
-  }
-}
-
-export class EntityNotAuthorizedError<
-  TFields,
-  TID,
-  TViewerContext extends ViewerContext,
-  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
-  TSelectedFields extends keyof TFields = keyof TFields
-> extends EntityError {
-  public readonly entityClassName: string;
-
-  constructor(
-    entity: TEntity,
-    viewerContext: TViewerContext,
-    action: EntityAuthorizationAction,
-    ruleIndex: number
-  ) {
-    super(
-      `Entity not authorized: ${entity} (viewer = ${viewerContext}, action = ${EntityAuthorizationAction[action]}, ruleIndex = ${ruleIndex})`
-    );
-    this.entityClassName = entity.constructor.name;
-  }
-}

packages/entity/src/EntityFields.ts

@@ -1,3 +1,5 @@
+import { validate as validateUUID } from 'uuid';
+
 import { IEntityClass } from './Entity';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import ReadonlyEntity from './ReadonlyEntity';
@@ -31,7 +33,7 @@ export enum EntityEdgeDeletionBehavior {
 export interface EntityAssociationDefinition<
   TViewerContext extends ViewerContext,
   TAssociatedFields,
-  TAssociatedID,
+  TAssociatedID extends NonNullable<TAssociatedFields[TAssociatedSelectedFields]>,
   TAssociatedEntity extends ReadonlyEntity<
     TAssociatedFields,
     TAssociatedID,
@@ -83,7 +85,7 @@ export interface EntityAssociationDefinition<
   edgeDeletionBehavior?: EntityEdgeDeletionBehavior;
 }
 
-export abstract class EntityFieldDefinition {
+export abstract class EntityFieldDefinition<T> {
   readonly columnName: string;
   readonly cache: boolean;
   readonly association?: EntityAssociationDefinition<any, any, any, any, any, any>;
@@ -107,15 +109,69 @@ export abstract class EntityFieldDefinition {
     this.cache = cache;
     this.association = association;
   }
+
+  /**
+   * Validates input value for a field of this type. Null and undefined are considered valid by default. This is used for things like:
+   * - EntityLoader.loadByFieldValue - to ensure the value being loaded by is a valid value
+   * - EntityMutator.setField - to ensure the value being set is a valid value
+   */
+  public validateInputValue(value: T | null | undefined): boolean {
+    if (value === null || value === undefined) {
+      return true;
+    }
+
+    return this.validateInputValueInternal(value);
+  }
+  protected abstract validateInputValueInternal(value: T): boolean;
 }
 
-export class StringField extends EntityFieldDefinition {}
-export class UUIDField extends StringField {}
-export class DateField extends EntityFieldDefinition {}
-export class BooleanField extends EntityFieldDefinition {}
-export class NumberField extends EntityFieldDefinition {}
-export class StringArrayField extends EntityFieldDefinition {}
-export class JSONObjectField extends EntityFieldDefinition {}
-export class EnumField extends EntityFieldDefinition {}
-export class JSONArrayField extends EntityFieldDefinition {}
-export class MaybeJSONArrayField extends EntityFieldDefinition {}
+export class StringField extends EntityFieldDefinition<string> {
+  protected validateInputValueInternal(value: string): boolean {
+    return typeof value === 'string';
+  }
+}
+export class UUIDField extends StringField {
+  protected validateInputValueInternal(value: string): boolean {
+    return validateUUID(value);
+  }
+}
+export class DateField extends EntityFieldDefinition<Date> {
+  protected validateInputValueInternal(value: Date): boolean {
+    return value instanceof Date;
+  }
+}
+export class BooleanField extends EntityFieldDefinition<boolean> {
+  protected validateInputValueInternal(value: boolean): boolean {
+    return typeof value === 'boolean';
+  }
+}
+export class NumberField extends EntityFieldDefinition<number> {
+  protected validateInputValueInternal(value: number): boolean {
+    return typeof value === 'number';
+  }
+}
+export class StringArrayField extends EntityFieldDefinition<string[]> {
+  protected validateInputValueInternal(value: string[]): boolean {
+    return Array.isArray(value) && value.every((subValue) => typeof subValue === 'string');
+  }
+}
+export class JSONObjectField extends EntityFieldDefinition<object> {
+  protected validateInputValueInternal(value: object): boolean {
+    return typeof value === 'object' && !Array.isArray(value);
+  }
+}
+export class EnumField extends EntityFieldDefinition<string | number> {
+  protected validateInputValueInternal(value: string | number): boolean {
+    return typeof value === 'number' || typeof value === 'string';
+  }
+}
+export class JSONArrayField extends EntityFieldDefinition<any[]> {
+  protected validateInputValueInternal(value: any[]): boolean {
+    return Array.isArray(value);
+  }
+}
+export class MaybeJSONArrayField extends EntityFieldDefinition<any | any[]> {
+  protected validateInputValueInternal(_value: any): boolean {
+    return true;
+  }
+}

packages/entity/src/EntityLoader.ts

@@ -3,12 +3,18 @@ import invariant from 'invariant';
 
 import EnforcingEntityLoader from './EnforcingEntityLoader';
 import { IEntityClass } from './Entity';
-import { FieldEqualityCondition, QuerySelectionModifiers } from './EntityDatabaseAdapter';
-import { EntityNotFoundError } from './EntityErrors';
+import EntityConfiguration from './EntityConfiguration';
+import {
+  FieldEqualityCondition,
+  QuerySelectionModifiers,
+  isSingleValueFieldEqualityCondition,
+} from './EntityDatabaseAdapter';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
+import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
+import EntityNotFoundError from './errors/EntityNotFoundError';
 import EntityDataManager from './internal/EntityDataManager';
 import { mapMap, mapMapAsync } from './utils/collections/maps';
 
@@ -18,7 +24,7 @@ import { mapMap, mapMapAsync } from './utils/collections/maps';
  */
 export default class EntityLoader<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -33,7 +39,7 @@ export default class EntityLoader<
   constructor(
     private readonly viewerContext: TViewerContext,
     private readonly queryContext: EntityQueryContext,
-    private readonly idField: keyof Pick<TFields, TSelectedFields>,
+    private readonly entityConfiguration: EntityConfiguration<TFields>,
     private readonly entityClass: IEntityClass<
       TFields,
       TID,
@@ -73,6 +79,8 @@ export default class EntityLoader<
     fieldName: N,
     fieldValues: readonly NonNullable<TFields[N]>[]
   ): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Result<TEntity>[]>> {
+    this.validateFieldValues(fieldName, fieldValues);
+
     const fieldValuesToFieldObjects = await this.dataManager.loadManyByFieldEqualingAsync(
       this.queryContext,
       fieldName,
@@ -150,7 +158,9 @@ export default class EntityLoader<
     const entityResults = await this.loadManyByIDsAsync([id]);
     const entityResult = entityResults.get(id);
     if (entityResult === undefined) {
-      return result(new EntityNotFoundError(this.entityClass, this.idField, id as any));
+      return result(
+        new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id)
+      );
     }
     return entityResult;
   }
@@ -161,7 +171,10 @@ export default class EntityLoader<
    * @returns entity result for matching ID, or null if no entity exists for ID.
    */
   async loadByIDNullableAsync(id: TID): Promise<Result<TEntity> | null> {
-    return await this.loadByFieldEqualingAsync(this.idField, id as any);
+    return await this.loadByFieldEqualingAsync(
+      this.entityConfiguration.idField as TSelectedFields,
+      id
+    );
   }
 
   /**
@@ -171,14 +184,15 @@ export default class EntityLoader<
    * @returns map from ID to corresponding entity result, where result error can be UnauthorizedError or EntityNotFoundError.
    */
   async loadManyByIDsAsync(ids: readonly TID[]): Promise<ReadonlyMap<TID, Result<TEntity>>> {
-    const entityResults = ((await this.loadManyByFieldEqualingManyAsync(
-      this.idField,
-      ids as any
-    )) as any) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
+    const entityResults = (await this.loadManyByFieldEqualingManyAsync(
+      this.entityConfiguration.idField as TSelectedFields,
+      ids
+    )) as ReadonlyMap<TID, readonly Result<TEntity>[]>;
     return mapMap(entityResults, (entityResultsForId, id) => {
       const entityResult = entityResultsForId[0];
       return (
-        entityResult ?? result(new EntityNotFoundError(this.entityClass, this.idField, id as any))
+        entityResult ??
+        result(new EntityNotFoundError(this.entityClass, this.entityConfiguration.idField, id))
       );
     });
   }
@@ -201,6 +215,13 @@ export default class EntityLoader<
     fieldEqualityOperands: FieldEqualityCondition<TFields, N>[],
     querySelectionModifiers: QuerySelectionModifiers<TFields> = {}
   ): Promise<readonly Result<TEntity>[]> {
+    for (const fieldEqualityOperand of fieldEqualityOperands) {
+      const fieldValues = isSingleValueFieldEqualityCondition(fieldEqualityOperand)
+        ? [fieldEqualityOperand.fieldValue]
+        : fieldEqualityOperand.fieldValues;
+      this.validateFieldValues(fieldEqualityOperand.fieldName, fieldValues);
+    }
+
     const fieldObjects = await this.dataManager.loadManyByFieldEqualityConjunctionAsync(
       this.queryContext,
       fieldEqualityOperands,
@@ -307,4 +328,18 @@ export default class EntityLoader<
       }
     });
   }
+
+  private validateFieldValues<N extends keyof Pick<TFields, TSelectedFields>>(
+    fieldName: N,
+    fieldValues: readonly NonNullable<TFields[N]>[]
+  ): void {
+    const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
+    invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
+    for (const fieldValue of fieldValues) {
+      const isInputValid = fieldDefinition.validateInputValue(fieldValue);
+      if (!isInputValid) {
+        throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
+      }
+    }
+  }
 }

packages/entity/src/EntityLoaderFactory.ts

@@ -1,4 +1,5 @@
 import { IEntityClass } from './Entity';
+import EntityConfiguration from './EntityConfiguration';
 import EntityLoader from './EntityLoader';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext } from './EntityQueryContext';
@@ -11,7 +12,7 @@ import EntityDataManager from './internal/EntityDataManager';
  */
 export default class EntityLoaderFactory<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -24,7 +25,7 @@ export default class EntityLoaderFactory<
   TSelectedFields extends keyof TFields
 > {
   constructor(
-    private readonly idField: keyof Pick<TFields, TSelectedFields>,
+    private readonly entityConfiguration: EntityConfiguration<TFields>,
     private readonly entityClass: IEntityClass<
       TFields,
       TID,
@@ -49,7 +50,7 @@ export default class EntityLoaderFactory<
     return new EntityLoader(
       viewerContext,
       queryContext,
-      this.idField,
+      this.entityConfiguration,
       this.entityClass,
       this.privacyPolicyClass,
       this.dataManager

packages/entity/src/EntityMutationTriggerConfiguration.ts

@@ -7,7 +7,7 @@ import ViewerContext from './ViewerContext';
  */
 export default interface EntityMutationTriggerConfiguration<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
@@ -70,12 +70,12 @@ export default interface EntityMutationTriggerConfiguration<
  */
 export abstract class EntityMutationTrigger<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
-  abstract async executeAsync(
+  abstract executeAsync(
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
     entity: TEntity
@@ -88,10 +88,10 @@ export abstract class EntityMutationTrigger<
  */
 export abstract class EntityNonTransactionalMutationTrigger<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
-  abstract async executeAsync(viewerContext: TViewerContext, entity: TEntity): Promise<void>;
+  abstract executeAsync(viewerContext: TViewerContext, entity: TEntity): Promise<void>;
 }

packages/entity/src/EntityMutationValidator.ts

@@ -8,12 +8,12 @@ import ViewerContext from './ViewerContext';
  */
 export default abstract class EntityMutationValidator<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
-  abstract async executeAsync(
+  abstract executeAsync(
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
     entity: TEntity

packages/entity/src/EntityMutator.ts

@@ -1,4 +1,5 @@
 import { Result, asyncResult, result, enforceAsyncResult } from '@expo/results';
+import invariant from 'invariant';
 
 import Entity, { IEntityClass } from './Entity';
 import { EntityCompanionDefinition } from './EntityCompanionProvider';
@@ -15,13 +16,14 @@ import EntityPrivacyPolicy from './EntityPrivacyPolicy';
 import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
+import EntityInvalidFieldValueError from './errors/EntityInvalidFieldValueError';
 import { timeAndLogMutationEventAsync } from './metrics/EntityMetricsUtils';
 import IEntityMetricsAdapter, { EntityMetricsMutationType } from './metrics/IEntityMetricsAdapter';
 import { mapMapAsync } from './utils/collections/maps';
 
 abstract class BaseMutator<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -72,6 +74,18 @@ abstract class BaseMutator<
     protected readonly metricsAdapter: IEntityMetricsAdapter
   ) {}
 
+  protected validateFields(fields: Partial<TFields>): void {
+    for (const fieldName in fields) {
+      const fieldValue = fields[fieldName];
+      const fieldDefinition = this.entityConfiguration.schema.get(fieldName);
+      invariant(fieldDefinition, `must have field definition for field = ${fieldName}`);
+      const isInputValid = fieldDefinition.validateInputValue(fieldValue);
+      if (!isInputValid) {
+        throw new EntityInvalidFieldValueError(this.entityClass, fieldName, fieldValue);
+      }
+    }
+  }
+
   protected async executeMutationTriggersOrValidatorsAsync(
     triggersOrValidators:
       | EntityMutationTrigger<TFields, TID, TViewerContext, TEntity, TSelectedFields>[]
@@ -114,7 +128,7 @@ abstract class BaseMutator<
  */
 export class CreateMutator<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -167,6 +181,8 @@ export class CreateMutator<
   private async createInternalAsync(
     queryContext: EntityTransactionalQueryContext
   ): Promise<Result<TEntity>> {
+    this.validateFields(this.fieldsForEntity);
+
     const temporaryEntityForPrivacyCheck = new this.entityClass(this.viewerContext, ({
       [this.entityConfiguration.idField]: '00000000-0000-0000-0000-000000000000', // zero UUID
       ...this.fieldsForEntity,
@@ -239,7 +255,7 @@ export class CreateMutator<
  */
 export class UpdateMutator<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -351,6 +367,8 @@ export class UpdateMutator<
   private async updateInternalAsync(
     queryContext: EntityTransactionalQueryContext
   ): Promise<Result<TEntity>> {
+    this.validateFields(this.updatedFields);
+
     const entityAboutToBeUpdated = new this.entityClass(this.viewerContext, this.fieldsForEntity);
     const authorizeUpdateResult = await asyncResult(
       this.privacyPolicy.authorizeUpdateAsync(
@@ -428,7 +446,7 @@ export class UpdateMutator<
  */
 export class DeleteMutator<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<
@@ -537,7 +555,7 @@ export class DeleteMutator<
       return authorizeDeleteResult;
     }
 
-    await DeleteMutator.processEntityDeletionForInboundEdgesAsync(
+    await this.processEntityDeletionForInboundEdgesAsync(
       this.entity,
       queryContext,
       processedEntityIdentifiersFromTransitiveDeletions
@@ -603,14 +621,8 @@ export class DeleteMutator<
    *
    * @param entity - entity to find all references to
    */
-  private static async processEntityDeletionForInboundEdgesAsync<
-    TMFields,
-    TMID,
-    TMViewerContext extends ViewerContext,
-    TMEntity extends Entity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
-    TMSelectedFields extends keyof TMFields
-  >(
-    entity: TMEntity,
+  private async processEntityDeletionForInboundEdgesAsync(
+    entity: TEntity,
     queryContext: EntityTransactionalQueryContext,
     processedEntityIdentifiers: Set<string>
   ): Promise<void> {
@@ -621,12 +633,12 @@ export class DeleteMutator<
     processedEntityIdentifiers.add(entity.getUniqueIdentifier());
 
     const companionDefinition = (entity.constructor as any).getCompanionDefinition() as EntityCompanionDefinition<
-      TMFields,
-      TMID,
-      TMViewerContext,
-      TMEntity,
-      EntityPrivacyPolicy<TMFields, TMID, TMViewerContext, TMEntity, TMSelectedFields>,
-      TMSelectedFields
+      TFields,
+      TID,
+      TViewerContext,
+      TEntity,
+      TPrivacyPolicy,
+      TSelectedFields
     >;
     const entityConfiguration = companionDefinition.entityConfiguration;
     const inboundEdges = entityConfiguration.getInboundEdges();

packages/entity/src/EntityMutatorFactory.ts

@@ -15,7 +15,7 @@ import IEntityMetricsAdapter from './metrics/IEntityMetricsAdapter';
  */
 export default class EntityMutatorFactory<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends Entity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/EntityPrivacyPolicy.ts

@@ -1,7 +1,7 @@
-import { EntityNotAuthorizedError } from './EntityErrors';
 import { EntityQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerContext from './ViewerContext';
+import EntityNotAuthorizedError from './errors/EntityNotAuthorizedError';
 import PrivacyPolicyRule, { RuleEvaluationResult } from './rules/PrivacyPolicyRule';
 
 export enum EntityPrivacyPolicyEvaluationMode {
@@ -12,7 +12,7 @@ export enum EntityPrivacyPolicyEvaluationMode {
 
 export type EntityPrivacyPolicyEvaluator<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
@@ -63,7 +63,7 @@ export enum EntityAuthorizationAction {
  */
 export default abstract class EntityPrivacyPolicy<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
@@ -265,7 +265,13 @@ export default abstract class EntityPrivacyPolicy<
       const ruleEvaluationResult = await rule.evaluateAsync(viewerContext, queryContext, entity);
       switch (ruleEvaluationResult) {
         case RuleEvaluationResult.DENY:
-          throw new EntityNotAuthorizedError(entity, viewerContext, action, i);
+          throw new EntityNotAuthorizedError<
+            TFields,
+            TID,
+            TViewerContext,
+            TEntity,
+            TSelectedFields
+          >(entity, viewerContext, action, i);
         case RuleEvaluationResult.SKIP:
           continue;
         case RuleEvaluationResult.ALLOW:
@@ -275,6 +281,11 @@ export default abstract class EntityPrivacyPolicy<
       }
     }
 
-    throw new EntityNotAuthorizedError(entity, viewerContext, action, -1);
+    throw new EntityNotAuthorizedError<TFields, TID, TViewerContext, TEntity, TSelectedFields>(
+      entity,
+      viewerContext,
+      action,
+      -1
+    );
   }
 }

packages/entity/src/EntityQueryContext.ts

@@ -18,7 +18,7 @@ export abstract class EntityQueryContext {
     return this.queryInterface;
   }
 
-  abstract async runInTransactionIfNotInTransactionAsync<T>(
+  abstract runInTransactionIfNotInTransactionAsync<T>(
     transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<T>
   ): Promise<T>;
 }

packages/entity/src/ReadonlyEntity.ts

@@ -5,7 +5,7 @@ import EntityAssociationLoader from './EntityAssociationLoader';
 import { EntityCompanionDefinition } from './EntityCompanionProvider';
 import EntityLoader from './EntityLoader';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
-import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
+import { EntityQueryContext } from './EntityQueryContext';
 import ViewerContext from './ViewerContext';
 import { pick } from './entityUtils';
 
@@ -19,7 +19,7 @@ import { pick } from './entityUtils';
  */
 export default abstract class ReadonlyEntity<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
@@ -118,80 +118,6 @@ export default abstract class ReadonlyEntity<
     return { ...this.databaseFields };
   }
 
-  /**
-   * Get the regular (non-transactional) query context for this entity.
-   * @param viewerContext - viewer context of calling user
-   */
-  static getQueryContext<
-    TMFields,
-    TMID,
-    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
-  ): EntityQueryContext {
-    return viewerContext
-      .getViewerScopedEntityCompanionForClass(this)
-      .getQueryContextProvider()
-      .getQueryContext();
-  }
-
-  /**
-   * Start a transaction and execute the provided transaction-scoped closure within the transaction.
-   * @param viewerContext - viewer context of calling user
-   * @param transactionScope - async callback to execute within the transaction
-   */
-  static async runInTransactionAsync<
-    TResult,
-    TMFields,
-    TMID,
-    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,
-    transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
-  ): Promise<TResult> {
-    return await viewerContext
-      .getViewerScopedEntityCompanionForClass(this)
-      .getQueryContextProvider()
-      .getQueryContext()
-      .runInTransactionIfNotInTransactionAsync(transactionScope);
-  }
-
   /**
    * Vend loader for loading an entity in a given query context.
    * @param viewerContext - viewer context of loading user
@@ -199,7 +125,7 @@ export default abstract class ReadonlyEntity<
    */
   static loader<
     TMFields,
-    TMID,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMViewerContext2 extends TMViewerContext,
     TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,

packages/entity/src/ViewerContext.ts

@@ -1,6 +1,7 @@
 import { IEntityClass } from './Entity';
-import EntityCompanionProvider from './EntityCompanionProvider';
+import EntityCompanionProvider, { DatabaseAdapterFlavor } from './EntityCompanionProvider';
 import EntityPrivacyPolicy from './EntityPrivacyPolicy';
+import { EntityQueryContext, EntityTransactionalQueryContext } from './EntityQueryContext';
 import ReadonlyEntity from './ReadonlyEntity';
 import ViewerScopedEntityCompanion from './ViewerScopedEntityCompanion';
 import ViewerScopedEntityCompanionProvider from './ViewerScopedEntityCompanionProvider';
@@ -27,7 +28,7 @@ export default class ViewerContext {
 
   getViewerScopedEntityCompanionForClass<
     TMFields,
-    TMID,
+    TMID extends NonNullable<TMFields[TMSelectedFields]>,
     TMViewerContext extends ViewerContext,
     TMEntity extends ReadonlyEntity<TMFields, TMID, TMViewerContext, TMSelectedFields>,
     TMPrivacyPolicy extends EntityPrivacyPolicy<
@@ -60,4 +61,32 @@ export default class ViewerContext {
       entityClass.getCompanionDefinition()
     );
   }
+
+  /**
+   * Get the regular (non-transactional) query context for a database adaptor flavor.
+   * @param databaseAdaptorFlavor - database adaptor flavor
+   */
+  getQueryContextForDatabaseAdaptorFlavor(
+    databaseAdaptorFlavor: DatabaseAdapterFlavor
+  ): EntityQueryContext {
+    return this.entityCompanionProvider
+      .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
+      .getQueryContext();
+  }
+
+  /**
+   * Run a transaction of specified database adaptor flavor and execute the provided
+   * transaction-scoped closure within the transaction.
+   * @param databaseAdaptorFlavor - databaseAdaptorFlavor
+   * @param transactionScope - async callback to execute within the transaction
+   */
+  async runInTransactionForDatabaseAdaptorFlavorAsync<TResult>(
+    databaseAdaptorFlavor: DatabaseAdapterFlavor,
+    transactionScope: (queryContext: EntityTransactionalQueryContext) => Promise<TResult>
+  ): Promise<TResult> {
+    return await this.entityCompanionProvider
+      .getQueryContextProviderForDatabaseAdaptorFlavor(databaseAdaptorFlavor)
+      .getQueryContext()
+      .runInTransactionIfNotInTransactionAsync(transactionScope);
+  }
 }

packages/entity/src/ViewerScopedEntityCompanion.ts

@@ -12,7 +12,7 @@ import ViewerScopedEntityMutatorFactory from './ViewerScopedEntityMutatorFactory
  */
 export default class ViewerScopedEntityCompanion<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/ViewerScopedEntityCompanionProvider.ts

@@ -23,7 +23,7 @@ export default class ViewerScopedEntityCompanionProvider {
    */
   getViewerScopedCompanionForEntity<
     TFields,
-    TID,
+    TID extends NonNullable<TFields[TSelectedFields]>,
     TViewerContext extends ViewerContext,
     TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
     TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/ViewerScopedEntityLoaderFactory.ts

@@ -10,7 +10,7 @@ import ViewerContext from './ViewerContext';
  */
 export default class ViewerScopedEntityLoaderFactory<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/ViewerScopedEntityMutatorFactory.ts

@@ -10,7 +10,7 @@ import ViewerContext from './ViewerContext';
  */
 export default class ViewerScopedEntityMutatorFactory<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/__tests__/EnforcingEntityLoader-test.ts

@@ -288,6 +288,7 @@ describe(EnforcingEntityLoader, () => {
       'invalidateFieldsAsync',
       'invalidateEntityAsync',
       'tryConstructEntities',
+      'validateFieldValues',
     ];
     expect(loaderProperties).toEqual(expect.arrayContaining(knownLoaderOnlyDifferences));
 

packages/entity/src/__tests__/Entity-test.ts

@@ -1,9 +1,5 @@
 import Entity from '../Entity';
-import {
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-  EntityCompanionDefinition,
-} from '../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField } from '../EntityFields';
 import { CreateMutator, UpdateMutator } from '../EntityMutator';
@@ -96,8 +92,8 @@ const testEntityConfiguration = new EntityConfiguration<TestEntityFields>({
       columnName: 'custom_id',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
@@ -106,10 +102,38 @@ class SimpleTestDenyUpdateEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ViewerContext,
   SimpleTestDenyUpdateEntity
 > {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysDenyPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      TestEntityFields,
+      string,
+      ViewerContext,
+      SimpleTestDenyUpdateEntity
+    >(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      TestEntityFields,
+      string,
+      ViewerContext,
+      SimpleTestDenyUpdateEntity
+    >(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysDenyPrivacyPolicyRule<
+      TestEntityFields,
+      string,
+      ViewerContext,
+      SimpleTestDenyUpdateEntity
+    >(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      TestEntityFields,
+      string,
+      ViewerContext,
+      SimpleTestDenyUpdateEntity
+    >(),
+  ];
 }
 
 class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
@@ -118,10 +142,38 @@ class SimpleTestDenyDeleteEntityPrivacyPolicy extends EntityPrivacyPolicy<
   ViewerContext,
   SimpleTestDenyDeleteEntity
 > {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysDenyPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      TestEntityFields,
+      string,
+      ViewerContext,
+      SimpleTestDenyDeleteEntity
+    >(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      TestEntityFields,
+      string,
+      ViewerContext,
+      SimpleTestDenyDeleteEntity
+    >(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<
+      TestEntityFields,
+      string,
+      ViewerContext,
+      SimpleTestDenyDeleteEntity
+    >(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysDenyPrivacyPolicyRule<
+      TestEntityFields,
+      string,
+      ViewerContext,
+      SimpleTestDenyDeleteEntity
+    >(),
+  ];
 }
 
 class SimpleTestDenyUpdateEntity extends Entity<TestEntityFields, string, ViewerContext> {

packages/entity/src/__tests__/EntityAssociationLoader-test.ts

@@ -1,4 +1,5 @@
 import { enforceAsyncResult } from '@expo/results';
+import { v4 as uuidv4 } from 'uuid';
 
 import EntityAssociationLoader from '../EntityAssociationLoader';
 import { enforceResultsAsync } from '../entityUtils';
@@ -74,7 +75,7 @@ describe(EntityAssociationLoader, () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
       const viewerContext = new TestViewerContext(companionProvider);
       const testEntity = await enforceAsyncResult(
-        TestEntity.creator(viewerContext).setField('stringField', 'blah').createAsync()
+        TestEntity.creator(viewerContext).setField('stringField', uuidv4()).createAsync()
       );
       const loadedOtherResult = await testEntity
         .associationLoader()
@@ -196,7 +197,7 @@ describe(EntityAssociationLoader, () => {
       const viewerContext = new TestViewerContext(companionProvider);
 
       const testEntity = await enforceAsyncResult(
-        TestEntity2.creator(viewerContext).setField('foreignKey', 'fake').createAsync()
+        TestEntity2.creator(viewerContext).setField('foreignKey', uuidv4()).createAsync()
       );
 
       const loadResult = await testEntity.associationLoader().loadAssociatedEntityThroughAsync([
@@ -212,11 +213,12 @@ describe(EntityAssociationLoader, () => {
       const companionProvider = createUnitTestEntityCompanionProvider();
       const viewerContext = new TestViewerContext(companionProvider);
 
+      const fieldValue = uuidv4();
       const testEntity2 = await enforceAsyncResult(
-        TestEntity.creator(viewerContext).setField('stringField', 'blah').createAsync()
+        TestEntity.creator(viewerContext).setField('stringField', fieldValue).createAsync()
       );
       const testEntity = await enforceAsyncResult(
-        TestEntity2.creator(viewerContext).setField('foreignKey', 'blah').createAsync()
+        TestEntity2.creator(viewerContext).setField('foreignKey', fieldValue).createAsync()
       );
 
       const loaded2Result = await testEntity.associationLoader().loadAssociatedEntityThroughAsync([
@@ -234,7 +236,7 @@ describe(EntityAssociationLoader, () => {
       const viewerContext = new TestViewerContext(companionProvider);
 
       const testEntity = await enforceAsyncResult(
-        TestEntity2.creator(viewerContext).setField('foreignKey', 'blah').createAsync()
+        TestEntity2.creator(viewerContext).setField('foreignKey', uuidv4()).createAsync()
       );
 
       const loaded2Result = await testEntity.associationLoader().loadAssociatedEntityThroughAsync([

packages/entity/src/__tests__/EntityCommonUseCases-test.ts

@@ -1,18 +1,15 @@
 import { enforceAsyncResult } from '@expo/results';
+import { v4 as uuidv4 } from 'uuid';
 
 import Entity from '../Entity';
-import EntityCompanionProvider, {
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-  EntityCompanionDefinition,
-} from '../EntityCompanionProvider';
+import EntityCompanionProvider, { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
-import { EntityNotAuthorizedError } from '../EntityErrors';
 import { UUIDField } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
 import { EntityQueryContext } from '../EntityQueryContext';
 import ViewerContext from '../ViewerContext';
 import { enforceResultsAsync } from '../entityUtils';
+import EntityNotAuthorizedError from '../errors/EntityNotAuthorizedError';
 import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
 import AlwaysDenyPrivacyPolicyRule from '../rules/AlwaysDenyPrivacyPolicyRule';
 import PrivacyPolicyRule, { RuleEvaluationResult } from '../rules/PrivacyPolicyRule';
@@ -100,8 +97,8 @@ const blahCompanion = new EntityCompanionDefinition({
         columnName: 'owner_id',
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   }),
   privacyPolicyClass: BlahEntityPrivacyPolicy,
 });
@@ -110,8 +107,8 @@ it('runs through a common workflow', async () => {
   // will be one entity companion provider for each request, so
   // share amongst all VCs created in that request
   const entityCompanionProvider = createUnitTestEntityCompanionProvider();
-  const vc1 = new TestUserViewerContext(entityCompanionProvider, '1');
-  const vc2 = new TestUserViewerContext(entityCompanionProvider, '2');
+  const vc1 = new TestUserViewerContext(entityCompanionProvider, uuidv4());
+  const vc2 = new TestUserViewerContext(entityCompanionProvider, uuidv4());
 
   const blahOwner1 = await enforceAsyncResult(
     BlahEntity.creator(vc1).setField('ownerID', vc1.getUserID()!).createAsync()

packages/entity/src/__tests__/EntityCompanion-test.ts

@@ -8,11 +8,12 @@ import IEntityMetricsAdapter from '../metrics/IEntityMetricsAdapter';
 import TestEntity, {
   TestEntityPrivacyPolicy,
   testEntityConfiguration,
+  TestFields,
 } from '../testfixtures/TestEntity';
 
 describe(EntityCompanion, () => {
   it('correctly instantiates mutator and loader factories', () => {
-    const tableDataCoordinatorMock = mock(EntityTableDataCoordinator);
+    const tableDataCoordinatorMock = mock<EntityTableDataCoordinator<TestFields>>();
     when(tableDataCoordinatorMock.entityConfiguration).thenReturn(testEntityConfiguration);
 
     const companion = new EntityCompanion(

packages/entity/src/__tests__/EntityCompanionProvider-test.ts

@@ -1,9 +1,5 @@
 import Entity from '../Entity';
-import EntityCompanionProvider, {
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-  EntityCompanionDefinition,
-} from '../EntityCompanionProvider';
+import EntityCompanionProvider, { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { StringField } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
@@ -22,8 +18,8 @@ const blahConfiguration = new EntityConfiguration<BlahFields>({
       columnName: 'hello',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 class Blah1Entity extends Entity<BlahFields, string, ViewerContext> {

packages/entity/src/__tests__/EntityDataConfiguration-test.ts

@@ -1,4 +1,3 @@
-import { DatabaseAdapterFlavor, CacheAdapterFlavor } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField, StringField } from '../EntityFields';
 
@@ -28,15 +27,15 @@ describe(EntityConfiguration, () => {
         columnName: 'unique_but_not_cacheable',
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   });
 
   it('returns correct fields', () => {
     expect(blahEntityConfiguration.idField).toEqual('id');
     expect(blahEntityConfiguration.tableName).toEqual('blah_table');
-    expect(blahEntityConfiguration.databaseAdapterFlavor).toEqual(DatabaseAdapterFlavor.POSTGRES);
-    expect(blahEntityConfiguration.cacheAdapterFlavor).toEqual(CacheAdapterFlavor.REDIS);
+    expect(blahEntityConfiguration.databaseAdapterFlavor).toEqual('postgres');
+    expect(blahEntityConfiguration.cacheAdapterFlavor).toEqual('redis');
   });
 
   it('filters cacheable fields', () => {
@@ -53,8 +52,8 @@ describe(EntityConfiguration, () => {
             columnName: 'id',
           }),
         },
-        databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-        cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+        databaseAdapterFlavor: 'postgres',
+        cacheAdapterFlavor: 'redis',
       });
       expect(entityConfiguration.cacheKeyVersion).toEqual(0);
     });
@@ -68,8 +67,8 @@ describe(EntityConfiguration, () => {
             columnName: 'id',
           }),
         },
-        databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-        cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+        databaseAdapterFlavor: 'postgres',
+        cacheAdapterFlavor: 'redis',
         cacheKeyVersion: 100,
       });
       expect(entityConfiguration.cacheKeyVersion).toEqual(100);

packages/entity/src/__tests__/EntityEdges-test.ts

@@ -1,9 +1,5 @@
 import Entity from '../Entity';
-import {
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-  EntityCompanionDefinition,
-} from '../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField, EntityEdgeDeletionBehavior } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
@@ -34,10 +30,18 @@ class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<
   any,
   any
 > {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, TestViewerContext, any, any>(),
+  ];
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -88,8 +92,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
         cache: true,
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   });
 
   const childEntityConfiguration = new EntityConfiguration<ChildFields>({
@@ -110,8 +114,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
         },
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   });
 
   const grandChildEntityConfiguration = new EntityConfiguration<GrandChildFields>({
@@ -131,8 +135,8 @@ const makeEntityClasses = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) =>
         },
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   });
 
   const parentEntityCompanion = new EntityCompanionDefinition({

packages/entity/src/__tests__/EntityFields-test.ts

@@ -1,6 +1,24 @@
-import { EntityFieldDefinition } from '../EntityFields';
+import { v1 as uuidv1, v3 as uuidv3, v4 as uuidv4, v5 as uuidv5 } from 'uuid';
 
-class TestFieldDefinition extends EntityFieldDefinition {}
+import {
+  EntityFieldDefinition,
+  StringField,
+  UUIDField,
+  DateField,
+  BooleanField,
+  NumberField,
+  StringArrayField,
+  JSONObjectField,
+  EnumField,
+  JSONArrayField,
+  MaybeJSONArrayField,
+} from '../EntityFields';
+
+class TestFieldDefinition extends EntityFieldDefinition<string> {
+  protected validateInputValueInternal(value: string): boolean {
+    return value === 'helloworld';
+  }
+}
 
 describe(EntityFieldDefinition, () => {
   it('returns correct column name and defaults cache to false', () => {
@@ -12,4 +30,71 @@ describe(EntityFieldDefinition, () => {
     expect(fieldDefinition2.columnName).toEqual('wat');
     expect(fieldDefinition2.cache).toEqual(true);
   });
+
+  test('validator returns true when value is null', () => {
+    const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
+    expect(fieldDefinition.validateInputValue(null)).toBe(true);
+  });
+
+  test('validator returns true when value is undefined', () => {
+    const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
+    expect(fieldDefinition.validateInputValue(undefined)).toBe(true);
+  });
+
+  test('validator returns false when value is invalid', () => {
+    const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
+    expect(fieldDefinition.validateInputValue('nothelloworld')).toBe(false);
+  });
+
+  test('validator returns true when value is valid', () => {
+    const fieldDefinition = new TestFieldDefinition({ columnName: 'wat', cache: true });
+    expect(fieldDefinition.validateInputValue('helloworld')).toBe(true);
+  });
 });
+
+const describeFieldTestCase = <T>(
+  fieldDefinition: EntityFieldDefinition<T>,
+  validValues: T[],
+  invalidValues: any[]
+): void => {
+  describe(fieldDefinition.constructor.name, () => {
+    if (validValues.length > 0) {
+      test.each(validValues)(`${fieldDefinition.constructor.name}.valid %p`, (value) => {
+        expect(fieldDefinition.validateInputValue(value)).toBe(true);
+      });
+    }
+
+    if (invalidValues.length > 0) {
+      test.each(invalidValues)(`${fieldDefinition.constructor.name}.invalid %p`, (value) => {
+        expect(fieldDefinition.validateInputValue(value)).toBe(false);
+      });
+    }
+  });
+};
+
+describeFieldTestCase(new StringField({ columnName: 'wat' }), ['hello', ''], [1, true, {}, [[]]]);
+describeFieldTestCase(
+  new UUIDField({ columnName: 'wat' }),
+  [uuidv1(), uuidv3('wat', uuidv3.DNS), uuidv4(), uuidv5('wat', uuidv5.DNS)],
+  [uuidv4().replace('-', ''), '', 'hello']
+);
+describeFieldTestCase(new DateField({ columnName: 'wat' }), [new Date()], [Date.now()]);
+describeFieldTestCase(new BooleanField({ columnName: 'wat' }), [true, false], [0, 1, '']);
+describeFieldTestCase(new NumberField({ columnName: 'wat' }), [1, 0.5, -0.5], ['1']);
+describeFieldTestCase(
+  new StringArrayField({ columnName: 'wat' }),
+  [[['what']] as any, [[]] as any], // jest test cases need extra wrapping array
+  ['hello']
+);
+describeFieldTestCase(new JSONObjectField({ columnName: 'wat' }), [{}], [true, 'hello']);
+describeFieldTestCase(new EnumField({ columnName: 'wat' }), ['hello', 1], [true]);
+describeFieldTestCase(
+  new JSONArrayField({ columnName: 'wat' }),
+  [[[1, 2]] as any, [['hello']] as any], // jest test cases need extra wrapping array
+  [1, 'hello']
+);
+describeFieldTestCase(
+  new MaybeJSONArrayField({ columnName: 'wat' }),
+  [1, 'hello', [['hello']]], // jest test cases need extra wrapping array
+  []
+);

packages/entity/src/__tests__/EntityLoader-test.ts

@@ -1,5 +1,6 @@
 import { enforceAsyncResult } from '@expo/results';
 import { mock, instance, verify, spy, deepEqual, anyOfClass, anything, when } from 'ts-mockito';
+import { v4 as uuidv4 } from 'uuid';
 
 import EntityLoader from '../EntityLoader';
 import ViewerContext from '../ViewerContext';
@@ -22,6 +23,8 @@ describe(EntityLoader, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
 
+    const id1 = uuidv4();
+    const id2 = uuidv4();
     const databaseAdapter = new StubDatabaseAdapter<TestFields>(
       testEntityConfiguration,
       StubDatabaseAdapter.convertFieldObjectsToDataStore(
@@ -31,7 +34,7 @@ describe(EntityLoader, () => {
             testEntityConfiguration.tableName,
             [
               {
-                customIdField: 'hello',
+                customIdField: id1,
                 testIndexedField: 'h1',
                 numberField: 5,
                 stringField: 'huh',
@@ -39,7 +42,7 @@ describe(EntityLoader, () => {
                 nullableField: null,
               },
               {
-                customIdField: 'world',
+                customIdField: id2,
                 testIndexedField: 'h2',
                 numberField: 3,
                 stringField: 'huh',
@@ -65,23 +68,23 @@ describe(EntityLoader, () => {
     const entityLoader = new EntityLoader(
       viewerContext,
       queryContext,
-      testEntityConfiguration.idField,
+      testEntityConfiguration,
       TestEntity,
       privacyPolicy,
       dataManager
     );
-    const entity = await enforceAsyncResult(entityLoader.loadByIDAsync('hello'));
-    expect(entity.getID()).toEqual('hello');
+    const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
+    expect(entity.getID()).toEqual(id1);
     expect(entity.getField('dateField')).toEqual(dateToInsert);
 
     const entities = await enforceResultsAsync(
       entityLoader.loadManyByFieldEqualingAsync('stringField', 'huh')
     );
-    expect(entities.map((m) => m.getID())).toEqual(['hello', 'world']);
+    expect(entities.map((m) => m.getID())).toEqual([id1, id2]);
 
     const entityResultNumber3 = await entityLoader.loadByFieldEqualingAsync('numberField', 3);
     expect(entityResultNumber3).not.toBeNull();
-    expect(entityResultNumber3!.enforceValue().getID()).toEqual('world');
+    expect(entityResultNumber3!.enforceValue().getID()).toEqual(id2);
 
     const entityResultNumber4 = await entityLoader.loadByFieldEqualingAsync('numberField', 4);
     expect(entityResultNumber4).toBeNull();
@@ -90,8 +93,12 @@ describe(EntityLoader, () => {
       'loadByFieldEqualing: Multiple entities of type TestEntity found for stringField=huh'
     );
 
-    await expect(entityLoader.loadByIDNullableAsync('fake')).resolves.toBeNull();
-    await expect(entityLoader.loadByIDNullableAsync('hello')).resolves.not.toBeNull();
+    await expect(entityLoader.loadByIDNullableAsync(uuidv4())).resolves.toBeNull();
+    await expect(entityLoader.loadByIDNullableAsync(id1)).resolves.not.toBeNull();
+
+    await expect(entityLoader.loadByIDAsync('not-a-uuid')).rejects.toThrowError(
+      'Entity field not valid: TestEntity (customIdField = not-a-uuid)'
+    );
   });
 
   it('loads entities with loadManyByFieldEqualityConjunction', async () => {
@@ -100,6 +107,9 @@ describe(EntityLoader, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
 
+    const id1 = uuidv4();
+    const id2 = uuidv4();
+    const id3 = uuidv4();
     const databaseAdapter = new StubDatabaseAdapter<TestFields>(
       testEntityConfiguration,
       StubDatabaseAdapter.convertFieldObjectsToDataStore(
@@ -109,7 +119,7 @@ describe(EntityLoader, () => {
             testEntityConfiguration.tableName,
             [
               {
-                customIdField: 'hello',
+                customIdField: id1,
                 stringField: 'huh',
                 numberField: 4,
                 testIndexedField: '4',
@@ -117,7 +127,7 @@ describe(EntityLoader, () => {
                 nullableField: null,
               },
               {
-                customIdField: 'world',
+                customIdField: id2,
                 stringField: 'huh',
                 numberField: 4,
                 testIndexedField: '5',
@@ -125,7 +135,7 @@ describe(EntityLoader, () => {
                 nullableField: null,
               },
               {
-                customIdField: 'blah',
+                customIdField: id3,
                 stringField: 'huh2',
                 numberField: 4,
                 testIndexedField: '6',
@@ -150,7 +160,7 @@ describe(EntityLoader, () => {
     const entityLoader = new EntityLoader(
       viewerContext,
       queryContext,
-      testEntityConfiguration.idField,
+      testEntityConfiguration,
       TestEntity,
       privacyPolicy,
       dataManager
@@ -171,6 +181,12 @@ describe(EntityLoader, () => {
     verify(
       spiedPrivacyPolicy.authorizeReadAsync(viewerContext, queryContext, anyOfClass(TestEntity))
     ).twice();
+
+    await expect(
+      entityLoader.loadManyByFieldEqualityConjunctionAsync([
+        { fieldName: 'customIdField', fieldValue: 'not-a-uuid' },
+      ])
+    ).rejects.toThrowError('Entity field not valid: TestEntity (customIdField = not-a-uuid)');
   });
 
   it('authorizes loaded entities', async () => {
@@ -180,6 +196,7 @@ describe(EntityLoader, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
 
+    const id1 = uuidv4();
     const databaseAdapter = new StubDatabaseAdapter<TestFields>(
       testEntityConfiguration,
       StubDatabaseAdapter.convertFieldObjectsToDataStore(
@@ -189,7 +206,7 @@ describe(EntityLoader, () => {
             testEntityConfiguration.tableName,
             [
               {
-                customIdField: 'hello',
+                customIdField: id1,
                 stringField: 'huh',
                 testIndexedField: '1',
                 numberField: 3,
@@ -214,12 +231,12 @@ describe(EntityLoader, () => {
     const entityLoader = new EntityLoader(
       viewerContext,
       queryContext,
-      testEntityConfiguration.idField,
+      testEntityConfiguration,
       TestEntity,
       privacyPolicy,
       dataManager
     );
-    const entity = await enforceAsyncResult(entityLoader.loadByIDAsync('hello'));
+    const entity = await enforceAsyncResult(entityLoader.loadByIDAsync(id1));
     verify(spiedPrivacyPolicy.authorizeReadAsync(viewerContext, queryContext, entity)).once();
   });
 
@@ -227,21 +244,22 @@ describe(EntityLoader, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
     const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
-    const dataManagerMock = mock(EntityDataManager);
+    const dataManagerMock = mock<EntityDataManager<TestFields>>();
     const dataManagerInstance = instance(dataManagerMock);
 
+    const id1 = uuidv4();
     const entityLoader = new EntityLoader(
       viewerContext,
       queryContext,
-      testEntityConfiguration.idField,
+      testEntityConfiguration,
       TestEntity,
       privacyPolicy,
       dataManagerInstance
     );
-    await entityLoader.invalidateFieldsAsync({ customIdField: 'hello' } as any);
+    await entityLoader.invalidateFieldsAsync({ customIdField: id1 } as any);
 
     verify(
-      dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: 'hello' }))
+      dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: id1 } as any))
     ).once();
   });
 
@@ -249,20 +267,21 @@ describe(EntityLoader, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
     const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
-    const dataManagerMock = mock(EntityDataManager);
+    const dataManagerMock = mock<EntityDataManager<TestFields>>();
     const dataManagerInstance = instance(dataManagerMock);
 
+    const id1 = uuidv4();
     const entityLoader = new EntityLoader(
       viewerContext,
       queryContext,
-      testEntityConfiguration.idField,
+      testEntityConfiguration,
       TestEntity,
       privacyPolicy,
       dataManagerInstance
     );
-    await entityLoader.invalidateFieldsAsync({ customIdField: 'hello' } as any);
+    await entityLoader.invalidateFieldsAsync({ customIdField: id1 } as any);
     verify(
-      dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: 'hello' }))
+      dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: id1 } as any))
     ).once();
   });
 
@@ -270,24 +289,25 @@ describe(EntityLoader, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
     const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
-    const dataManagerMock = mock(EntityDataManager);
+    const dataManagerMock = mock<EntityDataManager<TestFields>>();
     const dataManagerInstance = instance(dataManagerMock);
 
+    const id1 = uuidv4();
     const entityMock = mock(TestEntity);
-    when(entityMock.getAllDatabaseFields()).thenReturn({ customIdField: 'hello' } as any);
+    when(entityMock.getAllDatabaseFields()).thenReturn({ customIdField: id1 } as any);
     const entityInstance = instance(entityMock);
 
     const entityLoader = new EntityLoader(
       viewerContext,
       queryContext,
-      testEntityConfiguration.idField,
+      testEntityConfiguration,
       TestEntity,
       privacyPolicy,
       dataManagerInstance
     );
     await entityLoader.invalidateEntityAsync(entityInstance);
     verify(
-      dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: 'hello' }))
+      dataManagerMock.invalidateObjectFieldsAsync(deepEqual({ customIdField: id1 } as any))
     ).once();
   });
 
@@ -295,11 +315,12 @@ describe(EntityLoader, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
     const privacyPolicyMock = mock(TestEntityPrivacyPolicy);
-    const dataManagerMock = mock(EntityDataManager);
+    const dataManagerMock = mock<EntityDataManager<TestFields>>();
 
+    const id1 = uuidv4();
     when(
       dataManagerMock.loadManyByFieldEqualingAsync(anything(), anything(), anything())
-    ).thenResolve(new Map().set('hello', [{ customIdField: 'hello' }]));
+    ).thenResolve(new Map().set(id1, [{ customIdField: id1 }]));
 
     const rejectionError = new Error();
 
@@ -313,13 +334,13 @@ describe(EntityLoader, () => {
     const entityLoader = new EntityLoader(
       viewerContext,
       queryContext,
-      testEntityConfiguration.idField,
+      testEntityConfiguration,
       TestEntity,
       privacyPolicy,
       dataManagerInstance
     );
 
-    const entityResult = await entityLoader.loadByIDAsync('hello');
+    const entityResult = await entityLoader.loadByIDAsync(id1);
     expect(entityResult.ok).toBe(false);
     expect(entityResult.reason).toEqual(rejectionError);
     expect(entityResult.value).toBe(undefined);
@@ -329,7 +350,7 @@ describe(EntityLoader, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
     const privacyPolicy = instance(mock(TestEntityPrivacyPolicy));
-    const dataManagerMock = mock(EntityDataManager);
+    const dataManagerMock = mock<EntityDataManager<TestFields>>();
 
     const error = new Error();
 
@@ -342,27 +363,29 @@ describe(EntityLoader, () => {
     const entityLoader = new EntityLoader(
       viewerContext,
       queryContext,
-      testEntityConfiguration.idField,
+      testEntityConfiguration,
       TestEntity,
       privacyPolicy,
       dataManagerInstance
     );
 
-    await expect(entityLoader.loadByIDAsync('hello')).rejects.toEqual(error);
-    await expect(entityLoader.enforcing().loadByIDAsync('hello')).rejects.toEqual(error);
-    await expect(entityLoader.loadManyByIDsAsync(['hello'])).rejects.toEqual(error);
-    await expect(entityLoader.loadManyByIDsAsync(['hello'])).rejects.toEqual(error);
+    const loadByValue = uuidv4();
+
+    await expect(entityLoader.loadByIDAsync(loadByValue)).rejects.toEqual(error);
+    await expect(entityLoader.enforcing().loadByIDAsync(loadByValue)).rejects.toEqual(error);
+    await expect(entityLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
+    await expect(entityLoader.loadManyByIDsAsync([loadByValue])).rejects.toEqual(error);
     await expect(
-      entityLoader.loadManyByFieldEqualingAsync('customIdField', 'hello')
+      entityLoader.loadManyByFieldEqualingAsync('customIdField', loadByValue)
     ).rejects.toEqual(error);
     await expect(
-      entityLoader.enforcing().loadManyByFieldEqualingAsync('customIdField', 'hello')
+      entityLoader.enforcing().loadManyByFieldEqualingAsync('customIdField', loadByValue)
     ).rejects.toEqual(error);
     await expect(
-      entityLoader.loadManyByFieldEqualingManyAsync('customIdField', ['hello'])
+      entityLoader.loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
     ).rejects.toEqual(error);
     await expect(
-      entityLoader.enforcing().loadManyByFieldEqualingManyAsync('customIdField', ['hello'])
+      entityLoader.enforcing().loadManyByFieldEqualingManyAsync('customIdField', [loadByValue])
     ).rejects.toEqual(error);
   });
 });

packages/entity/src/__tests__/EntityMutator-test.ts

@@ -9,6 +9,7 @@ import {
   anything,
   objectContaining,
 } from 'ts-mockito';
+import { v4 as uuidv4 } from 'uuid';
 
 import EntityDatabaseAdapter from '../EntityDatabaseAdapter';
 import EntityLoaderFactory from '../EntityLoaderFactory';
@@ -273,7 +274,7 @@ const createEntityMutatorFactory = (
     TestEntity.name
   );
   const entityLoaderFactory = new EntityLoaderFactory(
-    testEntityConfiguration.idField,
+    testEntityConfiguration,
     TestEntity,
     privacyPolicy,
     dataManager
@@ -303,9 +304,12 @@ describe(EntityMutatorFactory, () => {
     it('creates entities', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
+      const id2 = uuidv4();
       const { entityMutatorFactory } = createEntityMutatorFactory([
         {
-          customIdField: 'hello',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '4',
           numberField: 1,
@@ -313,7 +317,7 @@ describe(EntityMutatorFactory, () => {
           nullableField: null,
         },
         {
-          customIdField: 'world',
+          customIdField: id2,
           stringField: 'huh',
           testIndexedField: '5',
           numberField: 1,
@@ -331,9 +335,12 @@ describe(EntityMutatorFactory, () => {
     it('checks privacy', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
+      const id2 = uuidv4();
       const { privacyPolicy, entityMutatorFactory } = createEntityMutatorFactory([
         {
-          customIdField: 'hello',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '4',
           numberField: 1,
@@ -341,7 +348,7 @@ describe(EntityMutatorFactory, () => {
           nullableField: null,
         },
         {
-          customIdField: 'world',
+          customIdField: id2,
           stringField: 'huh',
           testIndexedField: '5',
           numberField: 1,
@@ -369,9 +376,12 @@ describe(EntityMutatorFactory, () => {
     it('executes triggers', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
+      const id2 = uuidv4();
       const { mutationTriggers, entityMutatorFactory } = createEntityMutatorFactory([
         {
-          customIdField: 'hello',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '4',
           numberField: 1,
@@ -379,7 +389,7 @@ describe(EntityMutatorFactory, () => {
           nullableField: null,
         },
         {
-          customIdField: 'world',
+          customIdField: id2,
           stringField: 'huh',
           testIndexedField: '5',
           numberField: 1,
@@ -408,9 +418,12 @@ describe(EntityMutatorFactory, () => {
     it('executes validators', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
+      const id2 = uuidv4();
       const { mutationValidators, entityMutatorFactory } = createEntityMutatorFactory([
         {
-          customIdField: 'hello',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '4',
           numberField: 1,
@@ -418,7 +431,7 @@ describe(EntityMutatorFactory, () => {
           nullableField: null,
         },
         {
-          customIdField: 'world',
+          customIdField: id2,
           stringField: 'huh',
           testIndexedField: '5',
           numberField: 1,
@@ -442,9 +455,12 @@ describe(EntityMutatorFactory, () => {
     it('updates entities', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
+      const id2 = uuidv4();
       const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
         {
-          customIdField: 'hello',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '3',
           numberField: 3,
@@ -452,7 +468,7 @@ describe(EntityMutatorFactory, () => {
           nullableField: null,
         },
         {
-          customIdField: 'world',
+          customIdField: id2,
           stringField: 'huh',
           testIndexedField: '4',
           numberField: 3,
@@ -462,7 +478,7 @@ describe(EntityMutatorFactory, () => {
       ]);
 
       const existingEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
       );
 
       const updatedEntity = await entityMutatorFactory
@@ -475,7 +491,7 @@ describe(EntityMutatorFactory, () => {
       expect(updatedEntity.getField('stringField')).toEqual('huh2');
 
       const reloadedEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
       );
       expect(reloadedEntity.getAllFields()).toMatchObject(updatedEntity.getAllFields());
     });
@@ -483,13 +499,16 @@ describe(EntityMutatorFactory, () => {
     it('checks privacy', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
+      const id2 = uuidv4();
       const {
         privacyPolicy,
         entityMutatorFactory,
         entityLoaderFactory,
       } = createEntityMutatorFactory([
         {
-          customIdField: 'hello',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '3',
           numberField: 3,
@@ -497,7 +516,7 @@ describe(EntityMutatorFactory, () => {
           nullableField: null,
         },
         {
-          customIdField: 'world',
+          customIdField: id2,
           stringField: 'huh',
           testIndexedField: '4',
           numberField: 3,
@@ -509,7 +528,7 @@ describe(EntityMutatorFactory, () => {
       const spiedPrivacyPolicy = spy(privacyPolicy);
 
       const existingEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
       );
 
       await entityMutatorFactory
@@ -529,13 +548,16 @@ describe(EntityMutatorFactory, () => {
     it('executes triggers', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
+      const id2 = uuidv4();
       const {
         mutationTriggers,
         entityMutatorFactory,
         entityLoaderFactory,
       } = createEntityMutatorFactory([
         {
-          customIdField: 'hello',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '3',
           numberField: 3,
@@ -543,7 +565,7 @@ describe(EntityMutatorFactory, () => {
           nullableField: null,
         },
         {
-          customIdField: 'world',
+          customIdField: id2,
           stringField: 'huh',
           testIndexedField: '4',
           numberField: 3,
@@ -555,7 +577,7 @@ describe(EntityMutatorFactory, () => {
       const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
 
       const existingEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
       );
 
       await entityMutatorFactory
@@ -576,13 +598,15 @@ describe(EntityMutatorFactory, () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
 
+      const id1 = uuidv4();
+      const id2 = uuidv4();
       const {
         mutationValidators,
         entityMutatorFactory,
         entityLoaderFactory,
       } = createEntityMutatorFactory([
         {
-          customIdField: 'hello',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '3',
           numberField: 3,
@@ -590,7 +614,7 @@ describe(EntityMutatorFactory, () => {
           nullableField: null,
         },
         {
-          customIdField: 'world',
+          customIdField: id2,
           stringField: 'huh',
           testIndexedField: '4',
           numberField: 3,
@@ -602,7 +626,7 @@ describe(EntityMutatorFactory, () => {
       const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
 
       const existingEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id2)
       );
 
       await entityMutatorFactory
@@ -618,9 +642,11 @@ describe(EntityMutatorFactory, () => {
     it('deletes entities', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
       const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
         {
-          customIdField: 'world',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '3',
           numberField: 3,
@@ -630,7 +656,7 @@ describe(EntityMutatorFactory, () => {
       ]);
 
       const existingEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
       );
       expect(existingEntity).toBeTruthy();
 
@@ -638,7 +664,7 @@ describe(EntityMutatorFactory, () => {
 
       await expect(
         enforceAsyncResult(
-          entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+          entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
         )
       ).rejects.toBeInstanceOf(Error);
     });
@@ -646,13 +672,15 @@ describe(EntityMutatorFactory, () => {
     it('checks privacy', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
       const {
         privacyPolicy,
         entityMutatorFactory,
         entityLoaderFactory,
       } = createEntityMutatorFactory([
         {
-          customIdField: 'world',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '3',
           numberField: 3,
@@ -664,7 +692,7 @@ describe(EntityMutatorFactory, () => {
       const spiedPrivacyPolicy = spy(privacyPolicy);
 
       const existingEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
       );
 
       await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
@@ -681,13 +709,15 @@ describe(EntityMutatorFactory, () => {
     it('executes triggers', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
       const {
         mutationTriggers,
         entityMutatorFactory,
         entityLoaderFactory,
       } = createEntityMutatorFactory([
         {
-          customIdField: 'world',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '3',
           numberField: 3,
@@ -699,7 +729,7 @@ describe(EntityMutatorFactory, () => {
       const triggerSpies = setUpMutationTriggerSpies(mutationTriggers);
 
       const existingEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
       );
 
       await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
@@ -717,13 +747,15 @@ describe(EntityMutatorFactory, () => {
     it('does not execute validators', async () => {
       const viewerContext = mock<ViewerContext>();
       const queryContext = StubQueryContextProvider.getQueryContext();
+
+      const id1 = uuidv4();
       const {
         mutationValidators,
         entityMutatorFactory,
         entityLoaderFactory,
       } = createEntityMutatorFactory([
         {
-          customIdField: 'world',
+          customIdField: id1,
           stringField: 'huh',
           testIndexedField: '3',
           numberField: 3,
@@ -735,7 +767,7 @@ describe(EntityMutatorFactory, () => {
       const validatorSpies = setUpMutationValidatorSpies(mutationValidators);
 
       const existingEntity = await enforceAsyncResult(
-        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync('world')
+        entityLoaderFactory.forLoad(viewerContext, queryContext).loadByIDAsync(id1)
       );
 
       await entityMutatorFactory.forDelete(existingEntity, queryContext).enforceDeleteAsync();
@@ -747,9 +779,11 @@ describe(EntityMutatorFactory, () => {
   it('invalidates cache for fields upon create', async () => {
     const viewerContext = mock<ViewerContext>();
     const queryContext = StubQueryContextProvider.getQueryContext();
+
+    const id1 = uuidv4();
     const { entityMutatorFactory, entityLoaderFactory } = createEntityMutatorFactory([
       {
-        customIdField: 'world',
+        customIdField: id1,
         stringField: 'huh',
         testIndexedField: '3',
         numberField: 3,
@@ -780,11 +814,46 @@ describe(EntityMutatorFactory, () => {
     expect(entities2).toHaveLength(2);
   });
 
+  it('throws error when field not valid', async () => {
+    const viewerContext = mock<ViewerContext>();
+    const queryContext = StubQueryContextProvider.getQueryContext();
+    const id1 = uuidv4();
+    const { entityMutatorFactory } = createEntityMutatorFactory([
+      {
+        customIdField: id1,
+        stringField: 'huh',
+        testIndexedField: '3',
+        numberField: 3,
+        dateField: new Date(),
+        nullableField: null,
+      },
+    ]);
+
+    await expect(
+      entityMutatorFactory
+        .forCreate(viewerContext, queryContext)
+        .setField('stringField', 10 as any)
+        .createAsync()
+    ).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
+
+    const createdEntity = await entityMutatorFactory
+      .forCreate(viewerContext, queryContext)
+      .setField('stringField', 'hello')
+      .enforceCreateAsync();
+
+    await expect(
+      entityMutatorFactory
+        .forUpdate(createdEntity, queryContext)
+        .setField('stringField', 10 as any)
+        .updateAsync()
+    ).rejects.toThrowError('Entity field not valid: TestEntity (stringField = 10)');
+  });
+
   it('returns error result when not authorized to create', async () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
     const privacyPolicyMock = mock(SimpleTestEntityPrivacyPolicy);
-    const databaseAdapter = instance(mock(EntityDatabaseAdapter));
+    const databaseAdapter = instance(mock<EntityDatabaseAdapter<SimpleTestFields>>());
     const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
     const entityLoaderFactory = instance(
       mock<
@@ -841,8 +910,9 @@ describe(EntityMutatorFactory, () => {
     expect(entityCreateResult.reason).toEqual(rejectionError);
     expect(entityCreateResult.value).toBe(undefined);
 
+    const id1 = uuidv4();
     const fakeEntity = new SimpleTestEntity(viewerContext, {
-      id: 'hello',
+      id: id1,
     });
 
     const entityUpdateResult = await entityMutatorFactory
@@ -864,7 +934,7 @@ describe(EntityMutatorFactory, () => {
     const viewerContext = instance(mock(ViewerContext));
     const queryContext = StubQueryContextProvider.getQueryContext();
     const privacyPolicy = instance(mock(SimpleTestEntityPrivacyPolicy));
-    const databaseAdapterMock = mock(EntityDatabaseAdapter);
+    const databaseAdapterMock = mock<EntityDatabaseAdapter<SimpleTestFields>>();
     const metricsAdapter = instance(mock<IEntityMetricsAdapter>());
     const entityLoaderFactory = instance(
       mock<
@@ -911,8 +981,9 @@ describe(EntityMutatorFactory, () => {
       metricsAdapter
     );
 
+    const id1 = uuidv4();
     const fakeEntity = new SimpleTestEntity(viewerContext, {
-      id: 'hello',
+      id: id1,
     });
 
     await expect(

packages/entity/src/__tests__/EntityPrivacyPolicy-test.ts

@@ -1,13 +1,8 @@
 import { mock, instance, spy, verify, anyOfClass } from 'ts-mockito';
 
 import Entity from '../Entity';
-import {
-  EntityCompanionDefinition,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-} from '../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
-import { EntityNotAuthorizedError } from '../EntityErrors';
 import { UUIDField } from '../EntityFields';
 import EntityPrivacyPolicy, {
   EntityPrivacyPolicyEvaluator,
@@ -15,6 +10,7 @@ import EntityPrivacyPolicy, {
 } from '../EntityPrivacyPolicy';
 import { EntityQueryContext } from '../EntityQueryContext';
 import ViewerContext from '../ViewerContext';
+import EntityNotAuthorizedError from '../errors/EntityNotAuthorizedError';
 import AlwaysAllowPrivacyPolicyRule from '../rules/AlwaysAllowPrivacyPolicyRule';
 import AlwaysDenyPrivacyPolicyRule from '../rules/AlwaysDenyPrivacyPolicyRule';
 import AlwaysSkipPrivacyPolicyRule from '../rules/AlwaysSkipPrivacyPolicyRule';
@@ -234,8 +230,8 @@ const blahEntityCompanionDefinition = new EntityCompanionDefinition({
         columnName: 'id',
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   }),
   privacyPolicyClass: AlwaysDenyPolicy,
 });

packages/entity/src/__tests__/EntitySelfReferentialEdges-test.ts

@@ -1,9 +1,5 @@
 import Entity from '../Entity';
-import {
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-  EntityCompanionDefinition,
-} from '../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField, EntityEdgeDeletionBehavior } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
@@ -25,10 +21,18 @@ class CategoryPrivacyPolicy extends EntityPrivacyPolicy<
   any,
   any
 > {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<CategoryFields, string, TestViewerContext, any, any>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<CategoryFields, string, TestViewerContext, any, any>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<CategoryFields, string, TestViewerContext, any, any>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<CategoryFields, string, TestViewerContext, any, any>(),
+  ];
 }
 
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
@@ -63,8 +67,8 @@ const makeEntityClass = (edgeDeletionBehavior: EntityEdgeDeletionBehavior) => {
         },
       }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   });
 
   const categoryEntityCompanion = new EntityCompanionDefinition({

packages/entity/src/__tests__/ReadonlyEntity-test.ts

@@ -2,7 +2,6 @@ import { instance, mock } from 'ts-mockito';
 
 import EntityAssociationLoader from '../EntityAssociationLoader';
 import EntityLoader from '../EntityLoader';
-import { EntityQueryContext } from '../EntityQueryContext';
 import ReadonlyEntity from '../ReadonlyEntity';
 import ViewerContext from '../ViewerContext';
 import SimpleTestEntity from '../testfixtures/SimpleTestEntity';
@@ -108,30 +107,6 @@ describe(ReadonlyEntity, () => {
     });
   });
 
-  describe('getRegularEntityQueryContext', () => {
-    it('creates a new regular query context', () => {
-      const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new ViewerContext(companionProvider);
-      const queryContext = SimpleTestEntity.getQueryContext(viewerContext);
-      expect(queryContext).toBeInstanceOf(EntityQueryContext);
-      expect(queryContext.isInTransaction()).toBe(false);
-    });
-  });
-
-  describe('runInTransactionAsync', () => {
-    it('creates a new transactional query context', async () => {
-      const companionProvider = createUnitTestEntityCompanionProvider();
-      const viewerContext = new ViewerContext(companionProvider);
-      const didCreateTransaction = await SimpleTestEntity.runInTransactionAsync(
-        viewerContext,
-        async (queryContext) => {
-          return queryContext.isInTransaction();
-        }
-      );
-      expect(didCreateTransaction).toBe(true);
-    });
-  });
-
   describe('loader', () => {
     it('creates a new EntityLoader', async () => {
       const companionProvider = createUnitTestEntityCompanionProvider();

packages/entity/src/__tests__/ViewerContext-test.ts

@@ -0,0 +1,29 @@
+import { EntityQueryContext } from '../EntityQueryContext';
+import ViewerContext from '../ViewerContext';
+import { createUnitTestEntityCompanionProvider } from '../utils/testing/createUnitTestEntityCompanionProvider';
+
+describe(ViewerContext, () => {
+  describe('getQueryContextForDatabaseAdaptorFlavor', () => {
+    it('creates a new regular query context', () => {
+      const companionProvider = createUnitTestEntityCompanionProvider();
+      const viewerContext = new ViewerContext(companionProvider);
+      const queryContext = viewerContext.getQueryContextForDatabaseAdaptorFlavor('postgres');
+      expect(queryContext).toBeInstanceOf(EntityQueryContext);
+      expect(queryContext.isInTransaction()).toBe(false);
+    });
+  });
+
+  describe('runInTransactionForDatabaseAdaptorFlavorAsync', () => {
+    it('creates a new transactional query context', async () => {
+      const companionProvider = createUnitTestEntityCompanionProvider();
+      const viewerContext = new ViewerContext(companionProvider);
+      const didCreateTransaction = await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+        'postgres',
+        async (queryContext) => {
+          return queryContext.isInTransaction();
+        }
+      );
+      expect(didCreateTransaction).toBe(true);
+    });
+  });
+});

packages/entity/src/__tests__/cases/TwoEntitySameTableDisjointRows-test.ts

@@ -1,9 +1,5 @@
 import Entity from '../../Entity';
-import {
-  EntityCompanionDefinition,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-} from '../../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../../EntityCompanionProvider';
 import EntityConfiguration from '../../EntityConfiguration';
 import { UUIDField, EnumField, StringField } from '../../EntityFields';
 import EntityPrivacyPolicy from '../../EntityPrivacyPolicy';
@@ -106,15 +102,23 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
       columnName: 'entity_type',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
 }
 
 class OneTestEntity extends Entity<TestFields, string, ViewerContext, OneTestFields> {

packages/entity/src/__tests__/cases/TwoEntitySameTableOverlappingRows-test.ts

@@ -1,9 +1,5 @@
 import Entity from '../../Entity';
-import {
-  EntityCompanionDefinition,
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-} from '../../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../../EntityCompanionProvider';
 import EntityConfiguration from '../../EntityConfiguration';
 import { UUIDField, StringField } from '../../EntityFields';
 import EntityPrivacyPolicy from '../../EntityPrivacyPolicy';
@@ -114,15 +110,23 @@ const testEntityConfiguration = new EntityConfiguration<TestFields>({
       cache: true,
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<any, string, ViewerContext, any, any> {
-  protected readonly readRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly createRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly updateRules = [new AlwaysAllowPrivacyPolicyRule()];
-  protected readonly deleteRules = [new AlwaysAllowPrivacyPolicyRule()];
+  protected readonly readRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly createRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly updateRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
+  protected readonly deleteRules = [
+    new AlwaysAllowPrivacyPolicyRule<any, string, ViewerContext, any, any>(),
+  ];
 }
 
 class OneTestEntity extends Entity<TestFields, string, ViewerContext, OneTestFields> {

packages/entity/src/errors/EntityCacheAdapterError.ts

@@ -0,0 +1,8 @@
+import EntityError, { EntityErrorCode, EntityErrorState } from './EntityError';
+
+export default abstract class EntityCacheAdapterError extends EntityError {}
+
+export class EntityCacheAdapterTransientError extends EntityCacheAdapterError {
+  public readonly state = EntityErrorState.TRANSIENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_CACHE_ADAPTER_TRANSIENT;
+}

packages/entity/src/errors/EntityDatabaseAdapterError.ts

@@ -0,0 +1,38 @@
+import EntityError, { EntityErrorCode, EntityErrorState } from './EntityError';
+
+export default abstract class EntityDatabaseAdapterError extends EntityError {}
+
+export class EntityDatabaseAdapterTransientError extends EntityDatabaseAdapterError {
+  public readonly state = EntityErrorState.TRANSIENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_DATABASE_ADAPTER_TRANSIENT;
+}
+
+export class EntityDatabaseAdapterUnknownError extends EntityDatabaseAdapterError {
+  public readonly state = EntityErrorState.UNKNOWN;
+  public readonly code = EntityErrorCode.ERR_ENTITY_DATABASE_ADAPTER_UNKNOWN;
+}
+
+export class EntityDatabaseAdapterCheckConstraintError extends EntityDatabaseAdapterError {
+  public readonly state = EntityErrorState.PERMANENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_DATABASE_ADAPTER_CHECK_CONSTRAINT;
+}
+
+export class EntityDatabaseAdapterExclusionConstraintError extends EntityDatabaseAdapterError {
+  public readonly state = EntityErrorState.PERMANENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_DATABASE_ADAPTER_EXCLUSION_CONSTRAINT;
+}
+
+export class EntityDatabaseAdapterForeignKeyConstraintError extends EntityDatabaseAdapterError {
+  public readonly state = EntityErrorState.PERMANENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_DATABASE_ADAPTER_FOREIGN_KEY_CONSTRAINT;
+}
+
+export class EntityDatabaseAdapterNotNullConstraintError extends EntityDatabaseAdapterError {
+  public readonly state = EntityErrorState.PERMANENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_DATABASE_ADAPTER_NOT_NULL_CONSTRAINT;
+}
+
+export class EntityDatabaseAdapterUniqueConstraintError extends EntityDatabaseAdapterError {
+  public readonly state = EntityErrorState.PERMANENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_DATABASE_ADAPTER_UNIQUE_CONSTRAINT;
+}

packages/entity/src/errors/EntityError.ts

@@ -0,0 +1,30 @@
+import ES6Error from 'es6-error';
+
+export enum EntityErrorState {
+  UNKNOWN,
+  TRANSIENT,
+  PERMANENT,
+}
+
+export enum EntityErrorCode {
+  ERR_ENTITY_NOT_AUTHORIZED = 'ERR_ENTITY_NOT_AUTHORIZED',
+  ERR_ENTITY_NOT_FOUND = 'ERR_ENTITY_NOT_FOUND',
+  ERR_ENTITY_INVALID_FIELD_VALUE = 'ERR_ENTITY_INVALID_FIELD_VALUE',
+  ERR_ENTITY_DATABASE_ADAPTER_TRANSIENT = 'ERR_ENTITY_DATABASE_ADAPTER_TRANSIENT',
+  ERR_ENTITY_DATABASE_ADAPTER_UNKNOWN = 'ERR_ENTITY_DATABASE_ADAPTER_UNKNOWN',
+  ERR_ENTITY_DATABASE_ADAPTER_CHECK_CONSTRAINT = 'ERR_ENTITY_DATABASE_ADAPTER_CHECK_CONSTRAINT',
+  ERR_ENTITY_DATABASE_ADAPTER_EXCLUSION_CONSTRAINT = 'ERR_ENTITY_DATABASE_ADAPTER_EXCLUSION_CONSTRAINT',
+  ERR_ENTITY_DATABASE_ADAPTER_FOREIGN_KEY_CONSTRAINT = 'ERR_ENTITY_DATABASE_ADAPTER_FOREIGN_KEY_CONSTRAINT',
+  ERR_ENTITY_DATABASE_ADAPTER_NOT_NULL_CONSTRAINT = 'ERR_ENTITY_DATABASE_ADAPTER_NOT_NULL_CONSTRAINT',
+  ERR_ENTITY_DATABASE_ADAPTER_UNIQUE_CONSTRAINT = 'ERR_ENTITY_DATABASE_ADAPTER_UNIQUE_CONSTRAINT',
+  ERR_ENTITY_CACHE_ADAPTER_TRANSIENT = 'ERR_ENTITY_CACHE_ADAPTER_TRANSIENT',
+}
+
+export default abstract class EntityError extends ES6Error {
+  public abstract readonly state: EntityErrorState;
+  public abstract readonly code: EntityErrorCode;
+
+  constructor(message: string, public readonly cause?: Error) {
+    super(message);
+  }
+}

packages/entity/src/errors/EntityInvalidFieldValueError.ts

@@ -0,0 +1,39 @@
+import { IEntityClass } from '../Entity';
+import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
+import ReadonlyEntity from '../ReadonlyEntity';
+import ViewerContext from '../ViewerContext';
+import EntityError, { EntityErrorCode, EntityErrorState } from './EntityError';
+
+export default class EntityInvalidFieldValueError<
+  TFields,
+  TID extends NonNullable<TFields[TSelectedFields]>,
+  TViewerContext extends ViewerContext,
+  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
+  TPrivacyPolicy extends EntityPrivacyPolicy<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TSelectedFields
+  >,
+  N extends keyof TFields,
+  TSelectedFields extends keyof TFields = keyof TFields
+> extends EntityError {
+  public readonly state = EntityErrorState.PERMANENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_INVALID_FIELD_VALUE;
+
+  constructor(
+    entityClass: IEntityClass<
+      TFields,
+      TID,
+      TViewerContext,
+      TEntity,
+      TPrivacyPolicy,
+      TSelectedFields
+    >,
+    fieldName: N,
+    fieldValue?: TFields[N]
+  ) {
+    super(`Entity field not valid: ${entityClass.name} (${fieldName} = ${fieldValue})`);
+  }
+}

packages/entity/src/errors/EntityNotAuthorizedError.ts

@@ -0,0 +1,29 @@
+import { EntityAuthorizationAction } from '../EntityPrivacyPolicy';
+import ReadonlyEntity from '../ReadonlyEntity';
+import ViewerContext from '../ViewerContext';
+import EntityError, { EntityErrorCode, EntityErrorState } from './EntityError';
+
+export default class EntityNotAuthorizedError<
+  TFields,
+  TID extends NonNullable<TFields[TSelectedFields]>,
+  TViewerContext extends ViewerContext,
+  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
+  TSelectedFields extends keyof TFields = keyof TFields
+> extends EntityError {
+  public readonly state = EntityErrorState.PERMANENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_NOT_AUTHORIZED;
+
+  public readonly entityClassName: string;
+
+  constructor(
+    entity: TEntity,
+    viewerContext: TViewerContext,
+    action: EntityAuthorizationAction,
+    ruleIndex: number
+  ) {
+    super(
+      `Entity not authorized: ${entity} (viewer = ${viewerContext}, action = ${EntityAuthorizationAction[action]}, ruleIndex = ${ruleIndex})`
+    );
+    this.entityClassName = entity.constructor.name;
+  }
+}

packages/entity/src/errors/EntityNotFoundError.ts

@@ -0,0 +1,39 @@
+import { IEntityClass } from '../Entity';
+import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
+import ReadonlyEntity from '../ReadonlyEntity';
+import ViewerContext from '../ViewerContext';
+import EntityError, { EntityErrorCode, EntityErrorState } from './EntityError';
+
+export default class EntityNotFoundError<
+  TFields,
+  TID extends NonNullable<TFields[TSelectedFields]>,
+  TViewerContext extends ViewerContext,
+  TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
+  TPrivacyPolicy extends EntityPrivacyPolicy<
+    TFields,
+    TID,
+    TViewerContext,
+    TEntity,
+    TSelectedFields
+  >,
+  N extends keyof TFields,
+  TSelectedFields extends keyof TFields = keyof TFields
+> extends EntityError {
+  public readonly state = EntityErrorState.PERMANENT;
+  public readonly code = EntityErrorCode.ERR_ENTITY_NOT_FOUND;
+
+  constructor(
+    entityClass: IEntityClass<
+      TFields,
+      TID,
+      TViewerContext,
+      TEntity,
+      TPrivacyPolicy,
+      TSelectedFields
+    >,
+    fieldName: N,
+    fieldValue: TFields[N]
+  ) {
+    super(`Entity not found: ${entityClass.name} (${fieldName} = ${fieldValue})`);
+  }
+}

packages/entity/src/index.ts

@@ -11,7 +11,14 @@ export * from './EntityCompanionProvider';
 export { default as EntityConfiguration } from './EntityConfiguration';
 export { default as EntityDatabaseAdapter } from './EntityDatabaseAdapter';
 export * from './EntityDatabaseAdapter';
-export * from './EntityErrors';
+export { default as EntityDatabaseAdapterError } from './errors/EntityDatabaseAdapterError';
+export * from './errors/EntityDatabaseAdapterError';
+export { default as EntityCacheAdapterError } from './errors/EntityCacheAdapterError';
+export * from './errors/EntityCacheAdapterError';
+export * from './errors/EntityError';
+export { default as EntityError } from './errors/EntityError';
+export { default as EntityNotAuthorizedError } from './errors/EntityNotAuthorizedError';
+export { default as EntityNotFoundError } from './errors/EntityNotFoundError';
 export * from './EntityFields';
 export { default as EntityLoader } from './EntityLoader';
 export { default as EntityLoaderFactory } from './EntityLoaderFactory';

packages/entity/src/internal/__tests__/EntityDataManager-test.ts

@@ -442,12 +442,12 @@ describe(EntityDataManager, () => {
   });
 
   it('handles DB errors as expected', async () => {
-    const databaseAdapterMock = mock(EntityDatabaseAdapter);
+    const databaseAdapterMock = mock<EntityDatabaseAdapter<TestFields>>();
     when(databaseAdapterMock.fetchManyWhereAsync(anything(), anything(), anything())).thenReject(
       new Error('DB query failed')
     );
 
-    const databaseAdapter: EntityDatabaseAdapter<TestFields> = instance(databaseAdapterMock);
+    const databaseAdapter = instance(databaseAdapterMock);
     const cacheAdapterProvider = new NoCacheStubCacheAdapterProvider();
     const cacheAdapter = cacheAdapterProvider.getCacheAdapter(testEntityConfiguration);
     const entityCache = new ReadThroughEntityCache(testEntityConfiguration, cacheAdapter);

packages/entity/src/internal/__tests__/EntityFieldTransformationUtils-test.ts

@@ -1,4 +1,3 @@
-import { DatabaseAdapterFlavor, CacheAdapterFlavor } from '../../EntityCompanionProvider';
 import EntityConfiguration from '../../EntityConfiguration';
 import { UUIDField, StringField } from '../../EntityFields';
 import {
@@ -38,8 +37,8 @@ const blahEntityConfiguration = new EntityConfiguration<BlahT>({
       columnName: 'transform_write',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 describe(getDatabaseFieldForEntityField, () => {

packages/entity/src/internal/__tests__/ReadThroughEntityCache-test.ts

@@ -1,7 +1,6 @@
 import { verify, deepEqual, mock, instance, when, anything } from 'ts-mockito';
 
 import EntityCacheAdapter from '../../EntityCacheAdapter';
-import { DatabaseAdapterFlavor, CacheAdapterFlavor } from '../../EntityCompanionProvider';
 import EntityConfiguration from '../../EntityConfiguration';
 import { UUIDField } from '../../EntityFields';
 import ReadThroughEntityCache, { CacheStatus } from '../ReadThroughEntityCache';
@@ -17,8 +16,8 @@ const makeEntityConfiguration = (cacheIdField: boolean): EntityConfiguration<Bla
     schema: {
       id: new UUIDField({ columnName: 'id', cache: cacheIdField }),
     },
-    databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-    cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+    databaseAdapterFlavor: 'postgres',
+    cacheAdapterFlavor: 'redis',
   });
 
 const createIdFetcher = (ids: string[]) => async <N extends keyof BlahFields>(

packages/entity/src/rules/AlwaysAllowPrivacyPolicyRule.ts

@@ -8,7 +8,7 @@ import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
  */
 export default class AlwaysAllowPrivacyPolicyRule<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields

packages/entity/src/rules/AlwaysDenyPrivacyPolicyRule.ts

@@ -8,7 +8,7 @@ import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
  */
 export default class AlwaysDenyPrivacyPolicyRule<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields

packages/entity/src/rules/AlwaysSkipPrivacyPolicyRule.ts

@@ -8,7 +8,7 @@ import PrivacyPolicyRule, { RuleEvaluationResult } from './PrivacyPolicyRule';
  */
 export default class AlwaysSkipPrivacyPolicyRule<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields

packages/entity/src/rules/PrivacyPolicyRule.ts

@@ -37,12 +37,12 @@ export enum RuleEvaluationResult {
  */
 export default abstract class PrivacyPolicyRule<
   TFields,
-  TID,
+  TID extends NonNullable<TFields[TSelectedFields]>,
   TViewerContext extends ViewerContext,
   TEntity extends ReadonlyEntity<TFields, TID, TViewerContext, TSelectedFields>,
   TSelectedFields extends keyof TFields = keyof TFields
 > {
-  abstract async evaluateAsync(
+  abstract evaluateAsync(
     viewerContext: TViewerContext,
     queryContext: EntityQueryContext,
     entity: TEntity

packages/entity/src/testfixtures/DateIDTestEntity.ts

@@ -1,9 +1,5 @@
 import Entity from '../Entity';
-import {
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-  EntityCompanionDefinition,
-} from '../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { DateField } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
@@ -22,8 +18,8 @@ export const dateIDTestEntityConfiguration = new EntityConfiguration<DateIDTestF
       columnName: 'custom_id',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 export class DateIDTestEntityPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/testfixtures/SimpleTestEntity.ts

@@ -1,9 +1,5 @@
 import Entity from '../Entity';
-import {
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-  EntityCompanionDefinition,
-} from '../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
@@ -24,8 +20,8 @@ export const simpleTestEntityConfiguration = new EntityConfiguration<SimpleTestF
       columnName: 'custom_id',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 export class SimpleTestEntityPrivacyPolicy extends EntityPrivacyPolicy<

packages/entity/src/testfixtures/TestEntity.ts

@@ -1,11 +1,7 @@
 import { result, Result } from '@expo/results';
 
 import Entity from '../Entity';
-import {
-  DatabaseAdapterFlavor,
-  CacheAdapterFlavor,
-  EntityCompanionDefinition,
-} from '../EntityCompanionProvider';
+import { EntityCompanionDefinition } from '../EntityCompanionProvider';
 import EntityConfiguration from '../EntityConfiguration';
 import { UUIDField, StringField, DateField, NumberField } from '../EntityFields';
 import EntityPrivacyPolicy from '../EntityPrivacyPolicy';
@@ -45,8 +41,8 @@ export const testEntityConfiguration = new EntityConfiguration<TestFields>({
       columnName: 'nullable_field',
     }),
   },
-  databaseAdapterFlavor: DatabaseAdapterFlavor.POSTGRES,
-  cacheAdapterFlavor: CacheAdapterFlavor.REDIS,
+  databaseAdapterFlavor: 'postgres',
+  cacheAdapterFlavor: 'redis',
 });
 
 export class TestEntityPrivacyPolicy extends EntityPrivacyPolicy<