@expo/entity 0.54.0 → 0.57.0

package/src/utils/__testfixtures__/StubDatabaseAdapter.ts

@@ -2,13 +2,7 @@ import invariant from 'invariant';
 import { v7 as uuidv7 } from 'uuid';
 
 import { EntityConfiguration } from '../../EntityConfiguration';
-import {
-  EntityDatabaseAdapter,
-  OrderByOrdering,
-  TableFieldMultiValueEqualityCondition,
-  TableFieldSingleValueEqualityCondition,
-  TableQuerySelectionModifiers,
-} from '../../EntityDatabaseAdapter';
+import { EntityDatabaseAdapter } from '../../EntityDatabaseAdapter';
 import { IntField, StringField } from '../../EntityFields';
 import {
   FieldTransformerMap,
@@ -84,101 +78,19 @@ export class StubDatabaseAdapter<
     return [...results];
   }
 
-  private static compareByOrderBys(
-    orderBys: {
-      columnName: string;
-      order: OrderByOrdering;
-    }[],
-    objectA: { [key: string]: any },
-    objectB: { [key: string]: any },
-  ): 0 | 1 | -1 {
-    if (orderBys.length === 0) {
-      return 0;
-    }
-
-    const currentOrderBy = orderBys[0]!;
-    const aField = objectA[currentOrderBy.columnName];
-    const bField = objectB[currentOrderBy.columnName];
-    switch (currentOrderBy.order) {
-      case OrderByOrdering.DESCENDING: {
-        // simulate NULLS FIRST for DESC
-        if (aField === null && bField === null) {
-          return 0;
-        } else if (aField === null) {
-          return -1;
-        } else if (bField === null) {
-          return 1;
-        }
-
-        return aField > bField
-          ? -1
-          : aField < bField
-            ? 1
-            : this.compareByOrderBys(orderBys.slice(1), objectA, objectB);
-      }
-      case OrderByOrdering.ASCENDING: {
-        // simulate NULLS LAST for ASC
-        if (aField === null && bField === null) {
-          return 0;
-        } else if (bField === null) {
-          return -1;
-        } else if (aField === null) {
-          return 1;
-        }
-
-        return bField > aField
-          ? -1
-          : bField < aField
-            ? 1
-            : this.compareByOrderBys(orderBys.slice(1), objectA, objectB);
-      }
-    }
-  }
-
-  protected async fetchManyByFieldEqualityConjunctionInternalAsync(
-    _queryInterface: any,
+  protected async fetchOneWhereInternalAsync(
+    queryInterface: any,
     tableName: string,
-    tableFieldSingleValueEqualityOperands: TableFieldSingleValueEqualityCondition[],
-    tableFieldMultiValueEqualityOperands: TableFieldMultiValueEqualityCondition[],
-    querySelectionModifiers: TableQuerySelectionModifiers,
-  ): Promise<object[]> {
-    let filteredObjects = this.getObjectCollectionForTable(tableName);
-    for (const { tableField, tableValue } of tableFieldSingleValueEqualityOperands) {
-      filteredObjects = filteredObjects.filter((obj) => obj[tableField] === tableValue);
-    }
-
-    for (const { tableField, tableValues } of tableFieldMultiValueEqualityOperands) {
-      filteredObjects = filteredObjects.filter((obj) => tableValues.includes(obj[tableField]));
-    }
-
-    const orderBy = querySelectionModifiers.orderBy;
-    if (orderBy !== undefined) {
-      filteredObjects = filteredObjects.sort((a, b) =>
-        StubDatabaseAdapter.compareByOrderBys(orderBy, a, b),
-      );
-    }
-
-    const offset = querySelectionModifiers.offset;
-    if (offset !== undefined) {
-      filteredObjects = filteredObjects.slice(offset);
-    }
-
-    const limit = querySelectionModifiers.limit;
-    if (limit !== undefined) {
-      filteredObjects = filteredObjects.slice(0, 0 + limit);
-    }
-
-    return filteredObjects;
-  }
-
-  protected fetchManyByRawWhereClauseInternalAsync(
-    _queryInterface: any,
-    _tableName: string,
-    _rawWhereClause: string,
-    _bindings: object | any[],
-    _querySelectionModifiers: TableQuerySelectionModifiers,
-  ): Promise<object[]> {
-    throw new Error('Raw WHERE clauses not supported for StubDatabaseAdapter');
+    tableColumns: readonly string[],
+    tableTuple: readonly any[],
+  ): Promise<object | null> {
+    const results = await this.fetchManyWhereInternalAsync(
+      queryInterface,
+      tableName,
+      tableColumns,
+      [tableTuple],
+    );
+    return results[0] ?? null;
   }
 
   private generateRandomID(): any {

package/src/utils/__tests__/EntityCreationUtils-test.ts

@@ -40,7 +40,7 @@ describe.each([true, false])('in transaction %p', (inTransaction) => {
       );
 
       if (inTransaction) {
-        await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+        await viewerContext.runInTransactionForDatabaseAdapterFlavorAsync(
           'postgres',
           async (queryContext) => {
             await createOrGetExistingAsync(
@@ -92,7 +92,7 @@ describe.each([true, false])('in transaction %p', (inTransaction) => {
       );
 
       if (inTransaction) {
-        await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+        await viewerContext.runInTransactionForDatabaseAdapterFlavorAsync(
           'postgres',
           async (queryContext) => {
             await createOrGetExistingAsync(
@@ -146,7 +146,7 @@ describe.each([true, false])('in transaction %p', (inTransaction) => {
       );
 
       if (inTransaction) {
-        await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+        await viewerContext.runInTransactionForDatabaseAdapterFlavorAsync(
           'postgres',
           async (queryContext) => {
             await createWithUniqueConstraintRecoveryAsync(
@@ -204,7 +204,7 @@ describe.each([true, false])('in transaction %p', (inTransaction) => {
       );
 
       if (inTransaction) {
-        await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+        await viewerContext.runInTransactionForDatabaseAdapterFlavorAsync(
           'postgres',
           async (queryContext) => {
             await createWithUniqueConstraintRecoveryAsync(
@@ -261,7 +261,7 @@ describe.each([true, false])('in transaction %p', (inTransaction) => {
 
       if (inTransaction) {
         await expect(
-          viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+          viewerContext.runInTransactionForDatabaseAdapterFlavorAsync(
             'postgres',
             async (queryContext) => {
               return await createWithUniqueConstraintRecoveryAsync(
@@ -321,7 +321,7 @@ describe.each([true, false])('in transaction %p', (inTransaction) => {
 
       if (inTransaction) {
         await expect(
-          viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+          viewerContext.runInTransactionForDatabaseAdapterFlavorAsync(
             'postgres',
             async (queryContext) => {
               return await createWithUniqueConstraintRecoveryAsync(

package/src/utils/__tests__/EntityPrivacyUtils-test.ts

@@ -232,7 +232,7 @@ describe(canViewerDeleteAsync, () => {
   it('supports running within a transaction', async () => {
     const companionProvider = createUnitTestEntityCompanionProvider();
     const viewerContext = new ViewerContext(companionProvider);
-    const canViewerDelete = await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+    const canViewerDelete = await viewerContext.runInTransactionForDatabaseAdapterFlavorAsync(
       'postgres',
       async (queryContext) => {
         const testEntity = await SimpleTestDenyUpdateEntity.creator(
@@ -248,7 +248,7 @@ describe(canViewerDeleteAsync, () => {
     );
     expect(canViewerDelete).toBe(true);
 
-    const canViewerDeleteResult = await viewerContext.runInTransactionForDatabaseAdaptorFlavorAsync(
+    const canViewerDeleteResult = await viewerContext.runInTransactionForDatabaseAdapterFlavorAsync(
       'postgres',
       async (queryContext) => {
         const testEntity = await SimpleTestDenyUpdateEntity.creator(

package/src/utils/collections/maps.ts

@@ -1,8 +1,8 @@
 import invariant from 'invariant';
 
 /**
- * If the specified key is not already associated with a value in this map, attempts to compute
- * its value using the given mapping function and enters it into this map unless null.
+ * If the specified key is not already associated with a value in this map, computes
+ * its value using the given mapping function and enters it into this map.
  *
  * @param map - map from which to get the key's value or compute and associate
  * @param key - key for which to get the value or with which the computed value is to be associated

package/build/src/EntityLoaderUtils.js

@@ -1,147 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityLoaderUtils = void 0;
-const results_1 = require("@expo/results");
-const nullthrows_1 = __importDefault(require("nullthrows"));
-const entityUtils_1 = require("./entityUtils");
-const SingleFieldHolder_1 = require("./internal/SingleFieldHolder");
-const maps_1 = require("./utils/collections/maps");
-/**
- * Entity loader utilities for things like invalidation, entity construction, and authorization.
- * Methods are exposed publicly since in rare cases they may need to be called manually.
- */
-class EntityLoaderUtils {
-    viewerContext;
-    queryContext;
-    privacyPolicyEvaluationContext;
-    entityConfiguration;
-    entityClass;
-    entitySelectedFields;
-    privacyPolicy;
-    dataManager;
-    metricsAdapter;
-    constructor(viewerContext, queryContext, privacyPolicyEvaluationContext, entityConfiguration, entityClass, entitySelectedFields, privacyPolicy, dataManager, metricsAdapter) {
-        this.viewerContext = viewerContext;
-        this.queryContext = queryContext;
-        this.privacyPolicyEvaluationContext = privacyPolicyEvaluationContext;
-        this.entityConfiguration = entityConfiguration;
-        this.entityClass = entityClass;
-        this.entitySelectedFields = entitySelectedFields;
-        this.privacyPolicy = privacyPolicy;
-        this.dataManager = dataManager;
-        this.metricsAdapter = metricsAdapter;
-    }
-    getKeyValuePairsFromObjectFields(objectFields) {
-        const keys = Object.keys(objectFields);
-        const singleFieldKeyValues = [];
-        for (const fieldName of keys) {
-            const value = objectFields[fieldName];
-            if (value !== undefined && value !== null) {
-                singleFieldKeyValues.push([
-                    new SingleFieldHolder_1.SingleFieldHolder(fieldName),
-                    new SingleFieldHolder_1.SingleFieldValueHolder(value),
-                ]);
-            }
-        }
-        const compositeFieldKeyValues = [];
-        for (const compositeFieldHolder of this.entityConfiguration.compositeFieldInfo.getAllCompositeFieldHolders()) {
-            const compositeFieldValueHolder = compositeFieldHolder.extractCompositeFieldValueHolderFromObjectFields(objectFields);
-            if (compositeFieldValueHolder) {
-                compositeFieldKeyValues.push([compositeFieldHolder, compositeFieldValueHolder]);
-            }
-        }
-        return [...singleFieldKeyValues, ...compositeFieldKeyValues];
-    }
-    /**
-     * Invalidate all caches and local dataloaders for an entity's fields. Exposed primarily for internal use by EntityMutator.
-     * @param objectFields - entity data object to be invalidated
-     */
-    async invalidateFieldsAsync(objectFields) {
-        await this.dataManager.invalidateKeyValuePairsAsync(this.getKeyValuePairsFromObjectFields(objectFields));
-    }
-    /**
-     * Invalidate all local dataloaders specific to a transaction for an entity's fields. Exposed primarily for internal use by EntityMutator.
-     * @param objectFields - entity data object to be invalidated
-     */
-    invalidateFieldsForTransaction(queryContext, objectFields) {
-        this.dataManager.invalidateKeyValuePairsForTransaction(queryContext, this.getKeyValuePairsFromObjectFields(objectFields));
-    }
-    /**
-     * Invalidate all caches and local dataloaders for an entity. One potential use case would be to keep the entity
-     * framework in sync with changes made to data outside of the framework.
-     * @param entity - entity to be invalidated
-     */
-    async invalidateEntityAsync(entity) {
-        await this.invalidateFieldsAsync(entity.getAllDatabaseFields());
-    }
-    /**
-     * Invalidate all local dataloaders specific to a transaction for an entity. One potential use case would be to keep the entity
-     * framework in sync with changes made to data outside of the framework.
-     * @param entity - entity to be invalidated
-     */
-    invalidateEntityForTransaction(queryContext, entity) {
-        this.invalidateFieldsForTransaction(queryContext, entity.getAllDatabaseFields());
-    }
-    /**
-     * Construct an entity from a fields object (applying field selection if applicable),
-     * checking that the ID field is specified.
-     *
-     * @param fieldsObject - fields object
-     */
-    constructEntity(fieldsObject) {
-        const idField = this.entityConfiguration.idField;
-        const id = (0, nullthrows_1.default)(fieldsObject[idField], 'must provide ID to create an entity');
-        const entitySelectedFields = this.entitySelectedFields ?? Array.from(this.entityConfiguration.schema.keys());
-        const selectedFields = (0, entityUtils_1.pick)(fieldsObject, entitySelectedFields);
-        return new this.entityClass({
-            viewerContext: this.viewerContext,
-            id: id,
-            databaseFields: fieldsObject,
-            selectedFields,
-        });
-    }
-    /**
-     * Construct and authorize entities from fields map, returning error results for entities that fail
-     * to construct or fail to authorize.
-     *
-     * @param map - map from an arbitrary key type to an array of entity field objects
-     */
-    async constructAndAuthorizeEntitiesAsync(map) {
-        return await (0, maps_1.mapMapAsync)(map, async (fieldObjects) => {
-            return await this.constructAndAuthorizeEntitiesArrayAsync(fieldObjects);
-        });
-    }
-    /**
-     * Construct and authorize entities from field objects array, returning error results for entities that fail
-     * to construct or fail to authorize.
-     *
-     * @param fieldObjects - array of field objects
-     */
-    async constructAndAuthorizeEntitiesArrayAsync(fieldObjects) {
-        const uncheckedEntityResults = this.tryConstructEntities(fieldObjects);
-        return await Promise.all(uncheckedEntityResults.map(async (uncheckedEntityResult) => {
-            if (!uncheckedEntityResult.ok) {
-                return uncheckedEntityResult;
-            }
-            return await (0, results_1.asyncResult)(this.privacyPolicy.authorizeReadAsync(this.viewerContext, this.queryContext, this.privacyPolicyEvaluationContext, uncheckedEntityResult.value, this.metricsAdapter));
-        }));
-    }
-    tryConstructEntities(fieldsObjects) {
-        return fieldsObjects.map((fieldsObject) => {
-            try {
-                return (0, results_1.result)(this.constructEntity(fieldsObject));
-            }
-            catch (e) {
-                if (!(e instanceof Error)) {
-                    throw e;
-                }
-                return (0, results_1.result)(e);
-            }
-        });
-    }
-}
-exports.EntityLoaderUtils = EntityLoaderUtils;
-//# sourceMappingURL=EntityLoaderUtils.js.map

package/build/src/EntityLoaderUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EntityLoaderUtils.js","sourceRoot":"","sources":["../../src/EntityLoaderUtils.ts"],"names":[],"mappings":";;;;;;AAAA,2CAA4D;AAC5D,4DAAoC;AAQpC,+CAAqC;AAGrC,oEAAyF;AAEzF,mDAAuD;AAEvD;;;GAGG;AACH,MAAa,iBAAiB;IAeT;IACA;IACA;IAOA;IACA;IAQA;IACA;IACA;IACE;IAtBrB,YACmB,aAA6B,EAC7B,YAAgC,EAChC,8BAMhB,EACgB,mBAA2D,EAC3D,WAOhB,EACgB,oBAAmD,EACnD,aAA6B,EAC7B,WAAiD,EAC/C,cAAqC;QArBvC,kBAAa,GAAb,aAAa,CAAgB;QAC7B,iBAAY,GAAZ,YAAY,CAAoB;QAChC,mCAA8B,GAA9B,8BAA8B,CAM9C;QACgB,wBAAmB,GAAnB,mBAAmB,CAAwC;QAC3D,gBAAW,GAAX,WAAW,CAO3B;QACgB,yBAAoB,GAApB,oBAAoB,CAA+B;QACnD,kBAAa,GAAb,aAAa,CAAgB;QAC7B,gBAAW,GAAX,WAAW,CAAsC;QAC/C,mBAAc,GAAd,cAAc,CAAuB;IACvD,CAAC;IAEI,gCAAgC,CACtC,YAA+B;QAE/B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAsB,CAAC;QAC5D,MAAM,oBAAoB,GAAiD,EAAE,CAAC;QAC9E,KAAK,MAAM,SAAS,IAAI,IAAI,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;YACtC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBAC1C,oBAAoB,CAAC,IAAI,CAAC;oBACxB,IAAI,qCAAiB,CAAsC,SAAS,CAAC;oBACrE,IAAI,0CAAsB,CAAC,KAAK,CAAC;iBAClC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,MAAM,uBAAuB,GAAiD,EAAE,CAAC;QACjF,KAAK,MAAM,oBAAoB,IAAI,IAAI,CAAC,mBAAmB,CAAC,kBAAkB,CAAC,2BAA2B,EAAE,EAAE,CAAC;YAC7G,MAAM,yBAAyB,GAC7B,oBAAoB,CAAC,gDAAgD,CAAC,YAAY,CAAC,CAAC;YACtF,IAAI,yBAAyB,EAAE,CAAC;gBAC9B,uBAAuB,CAAC,IAAI,CAAC,CAAC,oBAAoB,EAAE,yBAAyB,CAAC,CAAC,CAAC;YAClF,CAAC;QACH,CAAC;QAED,OAAO,CAAC,GAAG,oBAAoB,EAAE,GAAG,uBAAuB,CAAC,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,qBAAqB,CAAC,YAA+B;QAChE,MAAM,IAAI,CAAC,WAAW,CAAC,4BAA4B,CACjD,IAAI,CAAC,gCAAgC,CAAC,YAAY,CAAC,CACpD,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,8BAA8B,CACnC,YAA6C,EAC7C,YAA+B;QAE/B,IAAI,CAAC,WAAW,CAAC,qCAAqC,CACpD,YAAY,EACZ,IAAI,CAAC,gCAAgC,CAAC,YAAY,CAAC,CACpD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,qBAAqB,CAAC,MAAe;QAChD,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACI,8BAA8B,CACnC,YAA6C,EAC7C,MAAe;QAEf,IAAI,CAAC,8BAA8B,CAAC,YAAY,EAAE,MAAM,CAAC,oBAAoB,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;OAKG;IACI,eAAe,CAAC,YAAqB;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;QACjD,MAAM,EAAE,GAAG,IAAA,oBAAU,EAAC,YAAY,CAAC,OAAO,CAAC,EAAE,qCAAqC,CAAC,CAAC;QACpF,MAAM,oBAAoB,GACxB,IAAI,CAAC,oBAAoB,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAClF,MAAM,cAAc,GAAG,IAAA,kBAAI,EAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;QAChE,OAAO,IAAI,IAAI,CAAC,WAAW,CAAC;YAC1B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,EAAE,EAAE,EAAuB;YAC3B,cAAc,EAAE,YAAY;YAC5B,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,kCAAkC,CAC7C,GAAiD;QAEjD,OAAO,MAAM,IAAA,kBAAW,EAAC,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;YACnD,OAAO,MAAM,IAAI,CAAC,uCAAuC,CAAC,YAAY,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,uCAAuC,CAClD,YAA0C;QAE1C,MAAM,sBAAsB,GAAG,IAAI,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QACvE,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,sBAAsB,CAAC,GAAG,CAAC,KAAK,EAAE,qBAAqB,EAAE,EAAE;YACzD,IAAI,CAAC,qBAAqB,CAAC,EAAE,EAAE,CAAC;gBAC9B,OAAO,qBAAqB,CAAC;YAC/B,CAAC;YACD,OAAO,MAAM,IAAA,qBAAW,EACtB,IAAI,CAAC,aAAa,CAAC,kBAAkB,CACnC,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,8BAA8B,EACnC,qBAAqB,CAAC,KAAK,EAC3B,IAAI,CAAC,cAAc,CACpB,CACF,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;IAEO,oBAAoB,CAAC,aAAiC;QAC5D,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE;YACxC,IAAI,CAAC;gBACH,OAAO,IAAA,gBAAM,EAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC;YACpD,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,EAAE,CAAC;oBAC1B,MAAM,CAAC,CAAC;gBACV,CAAC;gBACD,OAAO,IAAA,gBAAM,EAAC,CAAC,CAAC,CAAC;YACnB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAzLD,8CAyLC"}