@expo/entity 0.41.0 → 0.42.0

package/build/internal/CompositeFieldHolder.js

@@ -0,0 +1,116 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompositeFieldValueHolderMap = exports.CompositeFieldValueHolder = exports.CompositeFieldHolder = void 0;
+const invariant_1 = __importDefault(require("invariant"));
+const entityUtils_1 = require("../entityUtils");
+const EntityFieldTransformationUtils_1 = require("./EntityFieldTransformationUtils");
+const EntityLoadInterfaces_1 = require("../internal/EntityLoadInterfaces");
+/**
+ * A load key that represents a composite field (set of fieldName) on an entity.
+ * Must be defined in the entity configuration composite field definition.
+ */
+class CompositeFieldHolder {
+    compositeField;
+    constructor(compositeFieldInput) {
+        this.compositeField = [...compositeFieldInput].sort();
+    }
+    toString() {
+        return `CompositeField(${this.compositeField.join(',')})`;
+    }
+    getFieldSet() {
+        return new Set(this.compositeField);
+    }
+    extractCompositeFieldValueHolderFromObjectFields(objectFields) {
+        const selection = (0, entityUtils_1.pick)(objectFields, this.compositeField);
+        if (Object.values(selection).some((value) => value === undefined || value === null)) {
+            return null;
+        }
+        return new CompositeFieldValueHolder(selection);
+    }
+    serialize() {
+        return JSON.stringify(this.compositeField);
+    }
+    isCacheable(entityConfiguration) {
+        return entityConfiguration.compositeFieldInfo.canCacheCompositeField(this.compositeField);
+    }
+    getDatabaseColumns(entityConfiguration) {
+        return this.compositeField.map((fieldName) => (0, EntityFieldTransformationUtils_1.getDatabaseFieldForEntityField)(entityConfiguration, fieldName));
+    }
+    getDatabaseValues(value) {
+        return this.compositeField.map((fieldName) => value.compositeFieldValue[fieldName]);
+    }
+    getLoadValueForObject(object) {
+        return this.extractCompositeFieldValueHolderFromObjectFields(object);
+    }
+    createCacheKeyPartsForLoadValue(entityConfiguration, value) {
+        const columnNames = this.compositeField.map((fieldName) => {
+            const columnName = entityConfiguration.entityToDBFieldsKeyMapping.get(fieldName);
+            (0, invariant_1.default)(columnName, `database field mapping missing for ${String(fieldName)}`);
+            return columnName;
+        });
+        const compositeFieldValues = this.compositeField.map((fieldName) => value.compositeFieldValue[fieldName]);
+        return [...columnNames, ...compositeFieldValues.map((value) => String(value))];
+    }
+    getLoadMethodType() {
+        return EntityLoadInterfaces_1.EntityLoadMethodType.COMPOSITE;
+    }
+    getDataManagerDataLoaderKey() {
+        return this.serialize();
+    }
+    serializeLoadValue(value) {
+        return value.serialize();
+    }
+    deserializeLoadValue(value) {
+        return CompositeFieldValueHolder.deserialize(value);
+    }
+    validateRuntimeLoadValuesForDataManagerDataLoader(values, entityClassName) {
+        const isInvalidRuntimeCompositeFieldValue = (value) => Object.values(value.compositeFieldValue).some((fieldValue) => fieldValue === undefined || fieldValue === null);
+        const invalidValueIndex = values.findIndex(isInvalidRuntimeCompositeFieldValue);
+        if (invalidValueIndex >= 0) {
+            throw new Error(`Invalid load: ${entityClassName} (${String(this.compositeField)} = ${values[invalidValueIndex]})`);
+        }
+    }
+    vendNewLoadValueMap() {
+        return new CompositeFieldValueHolderMap();
+    }
+}
+exports.CompositeFieldHolder = CompositeFieldHolder;
+/**
+ * A load value for a CompositeFieldHolder.
+ */
+class CompositeFieldValueHolder {
+    compositeFieldValue;
+    constructor(compositeFieldValue) {
+        this.compositeFieldValue = compositeFieldValue;
+    }
+    toString() {
+        return `CompositeFieldValue(${Object.entries(this.compositeFieldValue)
+            .map(([fieldName, fieldValue]) => `${fieldName}=${fieldValue}`)
+            .join(',')})`;
+    }
+    getFieldSet() {
+        return new Set(Object.keys(this.compositeFieldValue));
+    }
+    static deserialize(serialized) {
+        return new CompositeFieldValueHolder(JSON.parse(serialized));
+    }
+    serialize() {
+        // Specify the ordered keys to serialize in a sorted manner to ensure consistent serialization
+        // between two objects of the same keys/values but different order.
+        // The replacer argument is "An array of strings and numbers that acts as an approved list
+        // for selecting the object properties that will be stringified."
+        // but it is a secondary effect of specifying the order of keys in the stringified object.
+        return JSON.stringify(this.compositeFieldValue, Object.keys(this.compositeFieldValue).sort());
+    }
+}
+exports.CompositeFieldValueHolder = CompositeFieldValueHolder;
+class CompositeFieldValueHolderMap extends EntityLoadInterfaces_1.LoadValueMap {
+    deserializeKey(serializedKey) {
+        return CompositeFieldValueHolder.deserialize(serializedKey);
+    }
+}
+exports.CompositeFieldValueHolderMap = CompositeFieldValueHolderMap;
+//# sourceMappingURL=CompositeFieldHolder.js.map

package/build/internal/CompositeFieldHolder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompositeFieldHolder.js","sourceRoot":"","sources":["../../src/internal/CompositeFieldHolder.ts"],"names":[],"mappings":";;;;;;AAAA,0DAAkC;AAMlC,gDAAsC;AACtC,qFAAkF;AAClF,2EAK0C;AAO1C;;;GAGG;AACH,MAAa,oBAAoB;IAWf,cAAc,CAAgC;IAE9D,YAAY,mBAAkD;QAC5D,IAAI,CAAC,cAAc,GAAG,CAAC,GAAG,mBAAmB,CAAC,CAAC,IAAI,EAAE,CAAC;IACxD,CAAC;IAED,QAAQ;QACN,OAAO,kBAAkB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAC5D,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC;IAEM,gDAAgD,CACrD,YAAqB;QAErB,MAAM,SAAS,GAAG,IAAA,kBAAI,EAAC,YAAY,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1D,IAAI,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,EAAE,CAAC;YACpF,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,IAAI,yBAAyB,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAmC,CAAC;IAC/E,CAAC;IAED,WAAW,CAAC,mBAA2D;QACrE,OAAO,mBAAmB,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5F,CAAC;IAED,kBAAkB,CAChB,mBAA2D;QAE3D,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAC3C,IAAA,+DAA8B,EAAC,mBAAmB,EAAE,SAAS,CAAC,CAC/D,CAAC;IACJ,CAAC;IAED,iBAAiB,CACf,KAAwE;QAExE,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,qBAAqB,CACnB,MAAyB;QAEzB,OAAO,IAAI,CAAC,gDAAgD,CAAC,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,+BAA+B,CAC7B,mBAA2D,EAC3D,KAAwE;QAExE,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;YACxD,MAAM,UAAU,GAAG,mBAAmB,CAAC,0BAA0B,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YACjF,IAAA,mBAAS,EAAC,UAAU,EAAE,sCAAsC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YACjF,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC,CAAC;QACH,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAClD,CAAC,SAAS,EAAE,EAAE,CAAC,KAAK,CAAC,mBAAmB,CAAC,SAAS,CAAC,CACpD,CAAC;QACF,OAAO,CAAC,GAAG,WAAW,EAAE,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjF,CAAC;IAED,iBAAiB;QACf,OAAO,2CAAoB,CAAC,SAAS,CAAC;IACxC,CAAC;IAED,2BAA2B;QACzB,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC;IAED,kBAAkB,CAChB,KAAwE;QAExE,OAAO,KAAK,CAAC,SAAS,EAAE,CAAC;IAC3B,CAAC;IAED,oBAAoB,CAClB,KAA0C;QAE1C,OAAO,yBAAyB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACtD,CAAC;IAED,iDAAiD,CAC/C,MAAoF,EACpF,eAAuB;QAEvB,MAAM,mCAAmC,GAAG,CAC1C,KAAwE,EAC/D,EAAE,CACX,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAC3C,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,KAAK,SAAS,IAAI,UAAU,KAAK,IAAI,CAChE,CAAC;QAEJ,MAAM,iBAAiB,GAAG,MAAM,CAAC,SAAS,CAAC,mCAAmC,CAAC,CAAC;QAChF,IAAI,iBAAiB,IAAI,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CACb,iBAAiB,eAAe,KAAK,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAC9D,MAAM,CAAC,iBAAiB,CAC1B,GAAG,CACJ,CAAC;QACJ,CAAC;IACH,CAAC;IAED,mBAAmB;QAKjB,OAAO,IAAI,4BAA4B,EAAE,CAAC;IAC5C,CAAC;CACF;AA9HD,oDA8HC;AAOD;;GAEG;AACH,MAAa,yBAAyB;IAMlB;IADlB,YACkB,mBAAwE;QAAxE,wBAAmB,GAAnB,mBAAmB,CAAqD;IACvF,CAAC;IAEJ,QAAQ;QACN,OAAO,uBAAuB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC;aACnE,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG,SAAS,IAAI,UAAU,EAAE,CAAC;aAC9D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAClB,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAsB,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,WAAW,CAIvB,UAA+C;QAE/C,OAAO,IAAI,yBAAyB,CAClC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAwD,CAC9E,CAAC;IACJ,CAAC;IAEM,SAAS;QACd,8FAA8F;QAC9F,mEAAmE;QACnE,0FAA0F;QAC1F,iEAAiE;QACjE,0FAA0F;QAC1F,OAAO,IAAI,CAAC,SAAS,CACnB,IAAI,CAAC,mBAAmB,EACxB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,IAAI,EAAE,CACN,CAAC;IAC3C,CAAC;CACF;AAzCD,8DAyCC;AAED,MAAa,4BAIX,SAAQ,mCAIT;IACoB,cAAc,CAC/B,aAAkD;QAElD,OAAO,yBAAyB,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;IAC9D,CAAC;CACF;AAdD,oEAcC"}

package/build/internal/CompositeFieldValueMap.d.ts

@@ -0,0 +1,15 @@
+import { EntityCompositeField, EntityCompositeFieldValue } from '../EntityConfiguration';
+import { CompositeFieldValueHolder } from './CompositeFieldHolder';
+export declare class CompositeFieldValueMap<TFields extends Record<string, any>, N extends EntityCompositeField<TFields>, TOutput> implements ReadonlyMap<EntityCompositeFieldValue<TFields, N>, TOutput> {
+    private readonly map;
+    constructor(entries: [CompositeFieldValueHolder<TFields, N>, TOutput][]);
+    get(compositeFieldValue: EntityCompositeFieldValue<TFields, N>): TOutput | undefined;
+    has(compositeFieldValue: EntityCompositeFieldValue<TFields, N>): boolean;
+    forEach(callbackfn: (value: TOutput, key: EntityCompositeFieldValue<TFields, N>, map: CompositeFieldValueMap<TFields, N, TOutput>) => void, thisArg?: any): void;
+    get size(): number;
+    entries(): MapIterator<[EntityCompositeFieldValue<TFields, N>, TOutput]>;
+    keys(): MapIterator<EntityCompositeFieldValue<TFields, N>>;
+    values(): MapIterator<TOutput>;
+    [Symbol.iterator](): MapIterator<[EntityCompositeFieldValue<TFields, N>, TOutput]>;
+    get [Symbol.toStringTag](): string;
+}

package/build/internal/CompositeFieldValueMap.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CompositeFieldValueMap = void 0;
+const CompositeFieldHolder_1 = require("./CompositeFieldHolder");
+class CompositeFieldValueMap {
+    map;
+    constructor(entries) {
+        const map = new Map();
+        for (const [key, value] of entries) {
+            map.set(key.serialize(), value);
+        }
+        this.map = map;
+    }
+    get(compositeFieldValue) {
+        return this.map.get(new CompositeFieldHolder_1.CompositeFieldValueHolder(compositeFieldValue).serialize());
+    }
+    has(compositeFieldValue) {
+        return this.map.has(new CompositeFieldHolder_1.CompositeFieldValueHolder(compositeFieldValue).serialize());
+    }
+    forEach(callbackfn, thisArg) {
+        this.map.forEach((value, key) => {
+            callbackfn.call(thisArg, value, CompositeFieldHolder_1.CompositeFieldValueHolder.deserialize(key).compositeFieldValue, this);
+        });
+    }
+    get size() {
+        return this.map.size;
+    }
+    *entries() {
+        for (const [key, value] of this.map.entries()) {
+            yield [CompositeFieldHolder_1.CompositeFieldValueHolder.deserialize(key).compositeFieldValue, value];
+        }
+    }
+    *keys() {
+        for (const key of this.map.keys()) {
+            yield CompositeFieldHolder_1.CompositeFieldValueHolder.deserialize(key).compositeFieldValue;
+        }
+    }
+    *values() {
+        for (const value of this.map.values()) {
+            yield value;
+        }
+    }
+    [Symbol.iterator]() {
+        return this.entries();
+    }
+    get [Symbol.toStringTag]() {
+        return 'CompositeFieldValueMap';
+    }
+}
+exports.CompositeFieldValueMap = CompositeFieldValueMap;
+//# sourceMappingURL=CompositeFieldValueMap.js.map

package/build/internal/CompositeFieldValueMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CompositeFieldValueMap.js","sourceRoot":"","sources":["../../src/internal/CompositeFieldValueMap.ts"],"names":[],"mappings":";;;AACA,iEAGgC;AAEhC,MAAa,sBAAsB;IAMhB,GAAG,CAAoD;IAExE,YAAY,OAA2D;QACrE,MAAM,GAAG,GAAG,IAAI,GAAG,EAAgD,CAAC;QACpE,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,OAAO,EAAE,CAAC;YACnC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED,GAAG,CAAC,mBAA0D;QAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,gDAAyB,CAAC,mBAAmB,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,GAAG,CAAC,mBAA0D;QAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,gDAAyB,CAAC,mBAAmB,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,OAAO,CACL,UAIS,EACT,OAAa;QAEb,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;YAC9B,UAAU,CAAC,IAAI,CACb,OAAO,EACP,KAAK,EACL,gDAAyB,CAAC,WAAW,CAAa,GAAG,CAAC,CAAC,mBAAmB,EAC1E,IAAI,CACL,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;IACvB,CAAC;IAED,CAAC,OAAO;QACN,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;YAC9C,MAAM,CAAC,gDAAyB,CAAC,WAAW,CAAa,GAAG,CAAC,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;QAC5F,CAAC;IACH,CAAC;IAED,CAAC,IAAI;QACH,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;YAClC,MAAM,gDAAyB,CAAC,WAAW,CAAa,GAAG,CAAC,CAAC,mBAAmB,CAAC;QACnF,CAAC;IACH,CAAC;IAED,CAAC,MAAM;QACL,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC;YACtC,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,CAAC,MAAM,CAAC,QAAQ,CAAC;QACf,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;QACtB,OAAO,wBAAwB,CAAC;IAClC,CAAC;CACF;AAvED,wDAuEC"}

package/build/internal/EntityDataManager.d.ts

@@ -2,6 +2,7 @@ import ReadThroughEntityCache from './ReadThroughEntityCache';
 import EntityDatabaseAdapter, { FieldEqualityCondition, QuerySelectionModifiers, QuerySelectionModifiersWithOrderByRaw } from '../EntityDatabaseAdapter';
 import { EntityQueryContext } from '../EntityQueryContext';
 import EntityQueryContextProvider from '../EntityQueryContextProvider';
+import { IEntityLoadKey, IEntityLoadValue, LoadPair } from './EntityLoadInterfaces';
 import IEntityMetricsAdapter from '../metrics/IEntityMetricsAdapter';
 /**
  * A data manager is responsible for orchestrating multiple sources of entity
@@ -9,26 +10,26 @@ import IEntityMetricsAdapter from '../metrics/IEntityMetricsAdapter';
  *
  * It is also responsible for invalidating all sources of data when mutated using EntityMutator.
  */
-export default class EntityDataManager<TFields extends Record<string, any>> {
+export default class EntityDataManager<TFields extends Record<string, any>, TIDField extends keyof TFields> {
     private readonly databaseAdapter;
     private readonly entityCache;
     private readonly queryContextProvider;
     private readonly metricsAdapter;
     private readonly entityClassName;
-    private readonly fieldDataLoaders;
-    constructor(databaseAdapter: EntityDatabaseAdapter<TFields>, entityCache: ReadThroughEntityCache<TFields>, queryContextProvider: EntityQueryContextProvider, metricsAdapter: IEntityMetricsAdapter, entityClassName: string);
-    private getFieldDataLoaderForFieldName;
-    private loadManyForDataLoaderByFieldEqualingAsync;
+    private readonly dataloaders;
+    constructor(databaseAdapter: EntityDatabaseAdapter<TFields, TIDField>, entityCache: ReadThroughEntityCache<TFields, TIDField>, queryContextProvider: EntityQueryContextProvider, metricsAdapter: IEntityMetricsAdapter, entityClassName: string);
+    private getDataLoaderForLoadKey;
+    private loadManyForDataLoaderAsync;
     /**
-     * Load many objects where fieldName is one of fieldValues.
+     * Load many objects through read-through dataloader (batcher) and cache (optional).
      *
      * @param queryContext - query context in which to perform the load
-     * @param fieldName - object field being queried
-     * @param fieldValues - fieldName field values being queried
-     * @returns map from fieldValue to objects that match the query for that fieldValue
+     * @param key - load key being queried
+     * @param values - load values being queried for the key
+     * @returns map from load value to objects that match the query for that load value
      */
-    loadManyByFieldEqualingAsync<N extends keyof TFields>(queryContext: EntityQueryContext, fieldName: N, fieldValues: readonly NonNullable<TFields[N]>[]): Promise<ReadonlyMap<NonNullable<TFields[N]>, readonly Readonly<TFields>[]>>;
-    private loadManyByFieldEqualingInternalAsync;
+    loadManyEqualingAsync<TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>, TSerializedLoadValue, TLoadValue extends IEntityLoadValue<TSerializedLoadValue>>(queryContext: EntityQueryContext, key: TLoadKey, values: readonly TLoadValue[]): Promise<ReadonlyMap<TLoadValue, readonly Readonly<TFields>[]>>;
+    private loadManyEqualingInternalAsync;
     /**
      * Loads many objects matching the conjunction of where clauses constructed from
      * specified field equality operands.
@@ -49,11 +50,10 @@ export default class EntityDataManager<TFields extends Record<string, any>> {
      * @returns array of objects matching the query
      */
     loadManyByRawWhereClauseAsync(queryContext: EntityQueryContext, rawWhereClause: string, bindings: any[] | object, querySelectionModifiers: QuerySelectionModifiersWithOrderByRaw<TFields>): Promise<readonly Readonly<TFields>[]>;
-    private invalidateManyByFieldEqualingAsync;
+    private invalidateOneAsync;
     /**
-     * Invalidate all caches, in-memory or otherwise, for an object.
-     *
-     * @param objectFields - object to invalidate from all applicable caches
+     * Invalidate all caches, in-memory or otherwise, for sets of key-value pairs.
+     * @param pairs - key-value pairs to invalidate
      */
-    invalidateObjectFieldsAsync(objectFields: Readonly<TFields>): Promise<void>;
+    invalidateKeyValuePairsAsync(pairs: readonly LoadPair<TFields, TIDField, any, any, any>[]): Promise<void>;
 }

package/build/internal/EntityDataManager.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const dataloader_1 = __importDefault(require("dataloader"));
+const invariant_1 = __importDefault(require("invariant"));
 const entityUtils_1 = require("../entityUtils");
 const EntityMetricsUtils_1 = require("../metrics/EntityMetricsUtils");
 const IEntityMetricsAdapter_1 = require("../metrics/IEntityMetricsAdapter");
@@ -20,7 +21,7 @@ class EntityDataManager {
     queryContextProvider;
     metricsAdapter;
     entityClassName;
-    fieldDataLoaders = new Map();
+    dataloaders = new Map();
     constructor(databaseAdapter, entityCache, queryContextProvider, metricsAdapter, entityClassName) {
         this.databaseAdapter = databaseAdapter;
         this.entityCache = entityCache;
@@ -28,62 +29,68 @@ class EntityDataManager {
         this.metricsAdapter = metricsAdapter;
         this.entityClassName = entityClassName;
     }
-    getFieldDataLoaderForFieldName(fieldName) {
-        return (0, maps_1.computeIfAbsent)(this.fieldDataLoaders, fieldName, () => {
-            return new dataloader_1.default(async (fieldValues) => {
-                const objectMap = await this.loadManyForDataLoaderByFieldEqualingAsync(fieldName, fieldValues);
-                return fieldValues.map((fv) => objectMap.get(fv) ?? []);
+    getDataLoaderForLoadKey(key) {
+        return (0, maps_1.computeIfAbsent)(this.dataloaders, key.getLoadMethodType() + key.getDataManagerDataLoaderKey(), () => {
+            return new dataloader_1.default(async (serializedLoadValues) => {
+                const values = serializedLoadValues.map((serializedLoadValue) => key.deserializeLoadValue(serializedLoadValue));
+                const objectMap = await this.loadManyForDataLoaderAsync(key, values);
+                return values.map((value) => objectMap.get(value) ?? []);
             });
         });
     }
-    async loadManyForDataLoaderByFieldEqualingAsync(fieldName, fieldValues) {
+    async loadManyForDataLoaderAsync(key, values) {
         this.metricsAdapter.incrementDataManagerLoadCount({
             type: IEntityMetricsAdapter_1.IncrementLoadCountEventType.CACHE,
-            fieldValueCount: fieldValues.length,
+            fieldValueCount: values.length,
             entityClassName: this.entityClassName,
+            loadType: key.getLoadMethodType(),
         });
-        return await this.entityCache.readManyThroughAsync(fieldName, fieldValues, async (fetcherValues) => {
+        return await this.entityCache.readManyThroughAsync(key, values, async (fetcherValues) => {
             this.metricsAdapter.incrementDataManagerLoadCount({
                 type: IEntityMetricsAdapter_1.IncrementLoadCountEventType.DATABASE,
-                fieldValueCount: fieldValues.length,
+                fieldValueCount: fetcherValues.length,
                 entityClassName: this.entityClassName,
+                loadType: key.getLoadMethodType(),
             });
-            return await this.databaseAdapter.fetchManyWhereAsync(this.queryContextProvider.getQueryContext(), fieldName, fetcherValues);
+            return await this.databaseAdapter.fetchManyWhereAsync(this.queryContextProvider.getQueryContext(), key, fetcherValues);
         });
     }
     /**
-     * Load many objects where fieldName is one of fieldValues.
+     * Load many objects through read-through dataloader (batcher) and cache (optional).
      *
      * @param queryContext - query context in which to perform the load
-     * @param fieldName - object field being queried
-     * @param fieldValues - fieldName field values being queried
-     * @returns map from fieldValue to objects that match the query for that fieldValue
+     * @param key - load key being queried
+     * @param values - load values being queried for the key
+     * @returns map from load value to objects that match the query for that load value
      */
-    async loadManyByFieldEqualingAsync(queryContext, fieldName, fieldValues) {
-        return await (0, EntityMetricsUtils_1.timeAndLogLoadMapEventAsync)(this.metricsAdapter, IEntityMetricsAdapter_1.EntityMetricsLoadType.LOAD_MANY, this.entityClassName)(this.loadManyByFieldEqualingInternalAsync(queryContext, fieldName, fieldValues));
+    async loadManyEqualingAsync(queryContext, key, values) {
+        return await (0, EntityMetricsUtils_1.timeAndLogLoadMapEventAsync)(this.metricsAdapter, IEntityMetricsAdapter_1.EntityMetricsLoadType.LOAD_MANY, this.entityClassName)(this.loadManyEqualingInternalAsync(queryContext, key, values));
     }
-    async loadManyByFieldEqualingInternalAsync(queryContext, fieldName, fieldValues) {
-        const nullOrUndefinedValueIndex = fieldValues.findIndex((value) => value === null || value === undefined);
-        if (nullOrUndefinedValueIndex >= 0) {
-            throw new Error(`Invalid load: ${this.entityClassName} (${String(fieldName)} = ${fieldValues[nullOrUndefinedValueIndex]})`);
-        }
+    async loadManyEqualingInternalAsync(queryContext, key, values) {
+        key.validateRuntimeLoadValuesForDataManagerDataLoader(values, this.entityClassName);
         // don't cache when in transaction, as rollbacks complicate things significantly
         if (queryContext.isInTransaction()) {
-            return await this.databaseAdapter.fetchManyWhereAsync(queryContext, fieldName, fieldValues);
+            return await this.databaseAdapter.fetchManyWhereAsync(queryContext, key, values);
         }
         this.metricsAdapter.incrementDataManagerLoadCount({
             type: IEntityMetricsAdapter_1.IncrementLoadCountEventType.DATALOADER,
-            fieldValueCount: fieldValues.length,
+            fieldValueCount: values.length,
             entityClassName: this.entityClassName,
+            loadType: key.getLoadMethodType(),
         });
-        const dataLoader = this.getFieldDataLoaderForFieldName(fieldName);
-        const results = await dataLoader.loadMany(fieldValues);
-        const [values, errors] = (0, entityUtils_1.partitionErrors)(results);
+        const dataLoader = this.getDataLoaderForLoadKey(key);
+        const results = await dataLoader.loadMany(values.map((v) => key.serializeLoadValue(v)));
+        const [successfulValues, errors] = (0, entityUtils_1.partitionErrors)(results);
         if (errors.length > 0) {
             const error = errors[0];
             throw error;
         }
-        return (0, maps_1.zipToMap)(fieldValues, values);
+        (0, invariant_1.default)(values.length === successfulValues.length, `length mismatch between values (${values.length}) and successful values (${successfulValues.length})`);
+        const mapToReturn = key.vendNewLoadValueMap();
+        for (let i = 0; i < successfulValues.length; i++) {
+            mapToReturn.set(values[i], successfulValues[i]);
+        }
+        return mapToReturn;
     }
     /**
      * Loads many objects matching the conjunction of where clauses constructed from
@@ -109,27 +116,17 @@ class EntityDataManager {
     async loadManyByRawWhereClauseAsync(queryContext, rawWhereClause, bindings, querySelectionModifiers) {
         return await (0, EntityMetricsUtils_1.timeAndLogLoadEventAsync)(this.metricsAdapter, IEntityMetricsAdapter_1.EntityMetricsLoadType.LOAD_MANY_RAW, this.entityClassName)(this.databaseAdapter.fetchManyByRawWhereClauseAsync(queryContext, rawWhereClause, bindings, querySelectionModifiers));
     }
-    async invalidateManyByFieldEqualingAsync(fieldName, fieldValues) {
-        await this.entityCache.invalidateManyAsync(fieldName, fieldValues);
-        const dataLoader = this.getFieldDataLoaderForFieldName(fieldName);
-        fieldValues.forEach((fieldValue) => dataLoader.clear(fieldValue));
+    async invalidateOneAsync(key, value) {
+        await this.entityCache.invalidateManyAsync(key, [value]);
+        this.getDataLoaderForLoadKey(key).clear(key.serializeLoadValue(value));
     }
     /**
-     * Invalidate all caches, in-memory or otherwise, for an object.
-     *
-     * @param objectFields - object to invalidate from all applicable caches
+     * Invalidate all caches, in-memory or otherwise, for sets of key-value pairs.
+     * @param pairs - key-value pairs to invalidate
      */
-    async invalidateObjectFieldsAsync(objectFields) {
+    async invalidateKeyValuePairsAsync(pairs) {
         // TODO(wschurman): check for races with load
-        const keys = Object.keys(objectFields);
-        await Promise.all(keys.map(async (fieldName) => {
-            const value = objectFields[fieldName];
-            if (value !== undefined) {
-                await this.invalidateManyByFieldEqualingAsync(fieldName, [
-                    value,
-                ]);
-            }
-        }));
+        await Promise.all(pairs.map(([key, value]) => this.invalidateOneAsync(key, value)));
     }
 }
 exports.default = EntityDataManager;

package/build/internal/EntityDataManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityDataManager.js","sourceRoot":"","sources":["../../src/internal/EntityDataManager.ts"],"names":[],"mappings":";;;;;AAAA,4DAAoC;AAUpC,gDAAiD;AACjD,sEAGuC;AACvC,4EAG0C;AAC1C,oDAAsE;AAEtE;;;;;GAKG;AACH,MAAqB,iBAAiB;IAOjB;IACA;IACA;IACA;IACA;IAVF,gBAAgB,GAG7B,IAAI,GAAG,EAAE,CAAC;IAEd,YACmB,eAA+C,EAC/C,WAA4C,EAC5C,oBAAgD,EAChD,cAAqC,EACrC,eAAuB;QAJvB,oBAAe,GAAf,eAAe,CAAgC;QAC/C,gBAAW,GAAX,WAAW,CAAiC;QAC5C,yBAAoB,GAApB,oBAAoB,CAA4B;QAChD,mBAAc,GAAd,cAAc,CAAuB;QACrC,oBAAe,GAAf,eAAe,CAAQ;IACvC,CAAC;IAEI,8BAA8B,CACpC,SAAY;QAEZ,OAAO,IAAA,sBAAe,EAAC,IAAI,CAAC,gBAAgB,EAAE,SAAS,EAAE,GAAG,EAAE;YAC5D,OAAO,IAAI,oBAAU,CACnB,KAAK,EACH,WAA+C,EACL,EAAE;gBAC5C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,yCAAyC,CACpE,SAAS,EACT,WAAW,CACZ,CAAC;gBACF,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;YAC1D,CAAC,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,yCAAyC,CACrD,SAAY,EACZ,WAA+C;QAE/C,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAAC;YAChD,IAAI,EAAE,mDAA2B,CAAC,KAAK;YACvC,eAAe,EAAE,WAAW,CAAC,MAAM;YACnC,eAAe,EAAE,IAAI,CAAC,eAAe;SACtC,CAAC,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAChD,SAAS,EACT,WAAW,EACX,KAAK,EAAE,aAAa,EAAE,EAAE;YACtB,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAAC;gBAChD,IAAI,EAAE,mDAA2B,CAAC,QAAQ;gBAC1C,eAAe,EAAE,WAAW,CAAC,MAAM;gBACnC,eAAe,EAAE,IAAI,CAAC,eAAe;aACtC,CAAC,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,mBAAmB,CACnD,IAAI,CAAC,oBAAoB,CAAC,eAAe,EAAE,EAC3C,SAAS,EACT,aAAa,CACd,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,4BAA4B,CAChC,YAAgC,EAChC,SAAY,EACZ,WAA+C;QAE/C,OAAO,MAAM,IAAA,gDAA2B,EACtC,IAAI,CAAC,cAAc,EACnB,6CAAqB,CAAC,SAAS,EAC/B,IAAI,CAAC,eAAe,CACrB,CAAC,IAAI,CAAC,oCAAoC,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IACrF,CAAC;IAEO,KAAK,CAAC,oCAAoC,CAChD,YAAgC,EAChC,SAAY,EACZ,WAA+C;QAE/C,MAAM,yBAAyB,GAAG,WAAW,CAAC,SAAS,CACrD,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CACjD,CAAC;QACF,IAAI,yBAAyB,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,iBAAiB,IAAI,CAAC,eAAe,KAAK,MAAM,CAAC,SAAS,CAAC,MACzD,WAAW,CAAC,yBAAyB,CACvC,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,gFAAgF;QAChF,IAAI,YAAY,CAAC,eAAe,EAAE,EAAE,CAAC;YACnC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,YAAY,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QAC9F,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAAC;YAChD,IAAI,EAAE,mDAA2B,CAAC,UAAU;YAC5C,eAAe,EAAE,WAAW,CAAC,MAAM;YACnC,eAAe,EAAE,IAAI,CAAC,eAAe;SACtC,CAAC,CAAC;QACH,MAAM,UAAU,GAAG,IAAI,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;QAClE,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACvD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAA,6BAAe,EAAC,OAAO,CAAC,CAAC;QAClD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;YACzB,MAAM,KAAK,CAAC;QACd,CAAC;QAED,OAAO,IAAA,eAAQ,EAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uCAAuC,CAC3C,YAAgC,EAChC,qBAA2D,EAC3D,uBAAyD;QAEzD,OAAO,MAAM,IAAA,6CAAwB,EACnC,IAAI,CAAC,cAAc,EACnB,6CAAqB,CAAC,8BAA8B,EACpD,IAAI,CAAC,eAAe,CACrB,CACC,IAAI,CAAC,eAAe,CAAC,wCAAwC,CAC3D,YAAY,EACZ,qBAAqB,EACrB,uBAAuB,CACxB,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,6BAA6B,CACjC,YAAgC,EAChC,cAAsB,EACtB,QAAwB,EACxB,uBAAuE;QAEvE,OAAO,MAAM,IAAA,6CAAwB,EACnC,IAAI,CAAC,cAAc,EACnB,6CAAqB,CAAC,aAAa,EACnC,IAAI,CAAC,eAAe,CACrB,CACC,IAAI,CAAC,eAAe,CAAC,8BAA8B,CACjD,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,uBAAuB,CACxB,CACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,kCAAkC,CAC9C,SAAY,EACZ,WAA+C;QAE/C,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,IAAI,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;QAClE,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,2BAA2B,CAAC,YAA+B;QAC/D,6CAA6C;QAC7C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAsB,CAAC;QAC5D,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,SAAwB,EAAE,EAAE;YAC1C,MAAM,KAAK,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC;YACtC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,IAAI,CAAC,kCAAkC,CAAC,SAAS,EAAE;oBACvD,KAA4C;iBAC7C,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC,CACH,CAAC;IACJ,CAAC;CACF;AAxMD,oCAwMC"}
+{"version":3,"file":"EntityDataManager.js","sourceRoot":"","sources":["../../src/internal/EntityDataManager.ts"],"names":[],"mappings":";;;;;AAAA,4DAAoC;AACpC,0DAAkC;AAUlC,gDAAiD;AAEjD,sEAGuC;AACvC,4EAG0C;AAC1C,oDAA4D;AAE5D;;;;;GAKG;AACH,MAAqB,iBAAiB;IAQjB;IACA;IACA;IACA;IACA;IARF,WAAW,GAC1B,IAAI,GAAG,EAAE,CAAC;IAEZ,YACmB,eAAyD,EACzD,WAAsD,EACtD,oBAAgD,EAChD,cAAqC,EACrC,eAAuB;QAJvB,oBAAe,GAAf,eAAe,CAA0C;QACzD,gBAAW,GAAX,WAAW,CAA2C;QACtD,yBAAoB,GAApB,oBAAoB,CAA4B;QAChD,mBAAc,GAAd,cAAc,CAAuB;QACrC,oBAAe,GAAf,eAAe,CAAQ;IACvC,CAAC;IAEI,uBAAuB,CAI7B,GAAa;QACb,OAAO,IAAA,sBAAe,EACpB,IAAI,CAAC,WAAW,EAChB,GAAG,CAAC,iBAAiB,EAAE,GAAG,GAAG,CAAC,2BAA2B,EAAE,EAC3D,GAAG,EAAE;YACH,OAAO,IAAI,oBAAU,CACnB,KAAK,EACH,oBAAqD,EACX,EAAE;gBAC5C,MAAM,MAAM,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC,mBAAmB,EAAE,EAAE,CAC9D,GAAG,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAC9C,CAAC;gBACF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;gBACrE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YAC3D,CAAC,CACF,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAKtC,GAAa,EACb,MAA6B;QAE7B,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAAC;YAChD,IAAI,EAAE,mDAA2B,CAAC,KAAK;YACvC,eAAe,EAAE,MAAM,CAAC,MAAM;YAC9B,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,QAAQ,EAAE,GAAG,CAAC,iBAAiB,EAAE;SAClC,CAAC,CAAC;QAEH,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE;YACtF,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAAC;gBAChD,IAAI,EAAE,mDAA2B,CAAC,QAAQ;gBAC1C,eAAe,EAAE,aAAa,CAAC,MAAM;gBACrC,eAAe,EAAE,IAAI,CAAC,eAAe;gBACrC,QAAQ,EAAE,GAAG,CAAC,iBAAiB,EAAE;aAClC,CAAC,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,mBAAmB,CACnD,IAAI,CAAC,oBAAoB,CAAC,eAAe,EAAE,EAC3C,GAAG,EACH,aAAa,CACd,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,qBAAqB,CAKzB,YAAgC,EAChC,GAAa,EACb,MAA6B;QAE7B,OAAO,MAAM,IAAA,gDAA2B,EACtC,IAAI,CAAC,cAAc,EACnB,6CAAqB,CAAC,SAAS,EAC/B,IAAI,CAAC,eAAe,CACrB,CAAC,IAAI,CAAC,6BAA6B,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;IACnE,CAAC;IAEO,KAAK,CAAC,6BAA6B,CAKzC,YAAgC,EAChC,GAAa,EACb,MAA6B;QAE7B,GAAG,CAAC,iDAAiD,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAEpF,gFAAgF;QAChF,IAAI,YAAY,CAAC,eAAe,EAAE,EAAE,CAAC;YACnC,OAAO,MAAM,IAAI,CAAC,eAAe,CAAC,mBAAmB,CAAC,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,6BAA6B,CAAC;YAChD,IAAI,EAAE,mDAA2B,CAAC,UAAU;YAC5C,eAAe,EAAE,MAAM,CAAC,MAAM;YAC9B,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,QAAQ,EAAE,GAAG,CAAC,iBAAiB,EAAE;SAClC,CAAC,CAAC;QACH,MAAM,UAAU,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxF,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,GAAG,IAAA,6BAAe,EAAC,OAAO,CAAC,CAAC;QAC5D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;YACzB,MAAM,KAAK,CAAC;QACd,CAAC;QAED,IAAA,mBAAS,EACP,MAAM,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EACzC,mCAAmC,MAAM,CAAC,MAAM,4BAA4B,gBAAgB,CAAC,MAAM,GAAG,CACvG,CAAC;QACF,MAAM,WAAW,GAAG,GAAG,CAAC,mBAAmB,EAAgC,CAAC;QAC5E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACjD,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAE,EAAE,gBAAgB,CAAC,CAAC,CAAE,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,uCAAuC,CAC3C,YAAgC,EAChC,qBAA2D,EAC3D,uBAAyD;QAEzD,OAAO,MAAM,IAAA,6CAAwB,EACnC,IAAI,CAAC,cAAc,EACnB,6CAAqB,CAAC,8BAA8B,EACpD,IAAI,CAAC,eAAe,CACrB,CACC,IAAI,CAAC,eAAe,CAAC,wCAAwC,CAC3D,YAAY,EACZ,qBAAqB,EACrB,uBAAuB,CACxB,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,6BAA6B,CACjC,YAAgC,EAChC,cAAsB,EACtB,QAAwB,EACxB,uBAAuE;QAEvE,OAAO,MAAM,IAAA,6CAAwB,EACnC,IAAI,CAAC,cAAc,EACnB,6CAAqB,CAAC,aAAa,EACnC,IAAI,CAAC,eAAe,CACrB,CACC,IAAI,CAAC,eAAe,CAAC,8BAA8B,CACjD,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,uBAAuB,CACxB,CACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAI9B,GAAa,EAAE,KAAiB;QAChC,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,4BAA4B,CACvC,KAA4D;QAE5D,6CAA6C;QAC7C,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACtF,CAAC;CACF;AAjND,oCAiNC"}

package/build/internal/EntityFieldTransformationUtils.d.ts

@@ -13,12 +13,12 @@ export interface FieldTransformer<T> {
  * Map from concrete EntityFieldDefinition implementation class name to field transformer.
  */
 export type FieldTransformerMap = Map<string, FieldTransformer<any>>;
-export declare const getDatabaseFieldForEntityField: <TFields extends Record<string, any>>(entityConfiguration: EntityConfiguration<TFields>, entityField: keyof TFields) => string;
-export declare const transformDatabaseObjectToFields: <TFields extends Record<string, any>>(entityConfiguration: EntityConfiguration<TFields>, fieldTransformerMap: FieldTransformerMap, databaseObject: {
+export declare const getDatabaseFieldForEntityField: <TFields extends Record<string, any>, TIDField extends keyof TFields>(entityConfiguration: EntityConfiguration<TFields, TIDField>, entityField: keyof TFields) => string;
+export declare const transformDatabaseObjectToFields: <TFields extends Record<string, any>, TIDField extends keyof TFields>(entityConfiguration: EntityConfiguration<TFields, TIDField>, fieldTransformerMap: FieldTransformerMap, databaseObject: {
     [key: string]: any;
 }) => Readonly<TFields>;
-export declare const transformFieldsToDatabaseObject: <TFields extends Record<string, any>>(entityConfiguration: EntityConfiguration<TFields>, fieldTransformerMap: FieldTransformerMap, fields: Readonly<Partial<TFields>>) => object;
-export declare const transformCacheObjectToFields: <TFields extends Record<string, any>>(entityConfiguration: EntityConfiguration<TFields>, fieldTransformerMap: FieldTransformerMap, cacheObject: {
+export declare const transformFieldsToDatabaseObject: <TFields extends Record<string, any>, TIDField extends keyof TFields>(entityConfiguration: EntityConfiguration<TFields, TIDField>, fieldTransformerMap: FieldTransformerMap, fields: Readonly<Partial<TFields>>) => object;
+export declare const transformCacheObjectToFields: <TFields extends Record<string, any>, TIDField extends keyof TFields>(entityConfiguration: EntityConfiguration<TFields, TIDField>, fieldTransformerMap: FieldTransformerMap, cacheObject: {
     [key: string]: any;
 }) => Readonly<TFields>;
-export declare const transformFieldsToCacheObject: <TFields extends Record<string, any>>(entityConfiguration: EntityConfiguration<TFields>, fieldTransformerMap: FieldTransformerMap, fields: Readonly<Partial<TFields>>) => object;
+export declare const transformFieldsToCacheObject: <TFields extends Record<string, any>, TIDField extends keyof TFields>(entityConfiguration: EntityConfiguration<TFields, TIDField>, fieldTransformerMap: FieldTransformerMap, fields: Readonly<Partial<TFields>>) => object;

package/build/internal/EntityFieldTransformationUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityFieldTransformationUtils.js","sourceRoot":"","sources":["../../src/internal/EntityFieldTransformationUtils.ts"],"names":[],"mappings":";;;;;;AAAA,0DAAkC;AAClC,4DAAoC;AAqB7B,MAAM,8BAA8B,GAAG,CAC5C,mBAAiD,EACjD,WAA0B,EAClB,EAAE;IACV,MAAM,aAAa,GAAG,mBAAmB,CAAC,0BAA0B,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACtF,IAAA,mBAAS,EAAC,aAAa,EAAE,sCAAsC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACtF,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAPW,QAAA,8BAA8B,kCAOzC;AAEK,MAAM,+BAA+B,GAAG,CAC7C,mBAAiD,EACjD,mBAAwC,EACxC,cAAsC,EACnB,EAAE;IACrB,MAAM,MAAM,GAAY,EAAS,CAAC;IAClC,KAAK,MAAM,CAAC,IAAI,cAAc,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,SAAS,GAAG,mBAAmB,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACxE,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,SAAS,CAAC,GAAG,uCAAuC,CACzD,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,EACT,GAAG,CACJ,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAnBW,QAAA,+BAA+B,mCAmB1C;AAEK,MAAM,+BAA+B,GAAG,CAC7C,mBAAiD,EACjD,mBAAwC,EACxC,MAAkC,EAC1B,EAAE;IACV,MAAM,cAAc,GAA2B,EAAE,CAAC;IAClD,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QACvB,MAAM,WAAW,GAAG,mBAAmB,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAQ,CAAC,CAAC;QACjF,IAAA,mBAAS,EAAC,WAAW,EAAE,mCAAmC,CAAC,EAAE,CAAC,CAAC;QAC/D,cAAc,CAAC,WAAW,CAAC,GAAG,uCAAuC,CACnE,mBAAmB,EACnB,mBAAmB,EACnB,CAAC,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAlBW,QAAA,+BAA+B,mCAkB1C;AAEK,MAAM,4BAA4B,GAAG,CAC1C,mBAAiD,EACjD,mBAAwC,EACxC,WAAmC,EAChB,EAAE;IACrB,MAAM,MAAM,GAAY,EAAS,CAAC;IAClC,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,WAAW,CAAC,SAAS,CAAE,CAAC;QACpC,MAAM,CAAC,SAA0B,CAAC,GAAG,oCAAoC,CACvE,mBAAmB,EACnB,mBAAmB,EACnB,SAA0B,EAC1B,GAAG,CACJ,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAhBW,QAAA,4BAA4B,gCAgBvC;AAEK,MAAM,4BAA4B,GAAG,CAC1C,mBAAiD,EACjD,mBAAwC,EACxC,MAAkC,EAC1B,EAAE;IACV,MAAM,WAAW,GAA2B,EAAE,CAAC;IAC/C,KAAK,MAAM,SAAS,IAAI,MAAM,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAE,CAAC;QAC/B,WAAW,CAAC,SAAS,CAAC,GAAG,oCAAoC,CAC3D,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,EACT,GAAG,CACJ,CAAC;IACJ,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAhBW,QAAA,4BAA4B,gCAgBvC;AAEF,MAAM,uCAAuC,GAAG,CAI9C,mBAAiD,EACjD,mBAAwC,EACxC,SAAY,EACZ,KAAU,EACE,EAAE;IACd,kGAAkG;IAClG,mCAAmC;IACnC,MAAM,eAAe,GAAG,IAAA,oBAAU,EAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9E,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,eAAe,GAAG,WAAW,EAAE,IAAI,CAAC;IAC1C,OAAO,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,uCAAuC,GAAG,CAI9C,mBAAiD,EACjD,mBAAwC,EACxC,SAAY,EACZ,KAAiB,EACZ,EAAE;IACP,MAAM,eAAe,GAAG,IAAA,oBAAU,EAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9E,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,gBAAgB,GAAG,WAAW,EAAE,KAAK,CAAC;IAC5C,OAAO,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,oCAAoC,GAAG,CAI3C,mBAAiD,EACjD,mBAAwC,EACxC,SAAY,EACZ,KAAU,EACE,EAAE;IACd,MAAM,eAAe,GAAG,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,eAAe,GAAG,WAAW,EAAE,IAAI,CAAC;IAC1C,OAAO,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,oCAAoC,GAAG,CAI3C,mBAAiD,EACjD,mBAAwC,EACxC,SAAY,EACZ,KAAiB,EACZ,EAAE;IACP,MAAM,eAAe,GAAG,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,gBAAgB,GAAG,WAAW,EAAE,KAAK,CAAC;IAC5C,OAAO,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC5D,CAAC,CAAC"}
+{"version":3,"file":"EntityFieldTransformationUtils.js","sourceRoot":"","sources":["../../src/internal/EntityFieldTransformationUtils.ts"],"names":[],"mappings":";;;;;;AAAA,0DAAkC;AAClC,4DAAoC;AAqB7B,MAAM,8BAA8B,GAAG,CAI5C,mBAA2D,EAC3D,WAA0B,EAClB,EAAE;IACV,MAAM,aAAa,GAAG,mBAAmB,CAAC,0BAA0B,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACtF,IAAA,mBAAS,EAAC,aAAa,EAAE,sCAAsC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACtF,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAVW,QAAA,8BAA8B,kCAUzC;AAEK,MAAM,+BAA+B,GAAG,CAI7C,mBAA2D,EAC3D,mBAAwC,EACxC,cAAsC,EACnB,EAAE;IACrB,MAAM,MAAM,GAAY,EAAS,CAAC;IAClC,KAAK,MAAM,CAAC,IAAI,cAAc,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QAC9B,MAAM,SAAS,GAAG,mBAAmB,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACxE,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,SAAS,CAAC,GAAG,uCAAuC,CACzD,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,EACT,GAAG,CACJ,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAtBW,QAAA,+BAA+B,mCAsB1C;AAEK,MAAM,+BAA+B,GAAG,CAI7C,mBAA2D,EAC3D,mBAAwC,EACxC,MAAkC,EAC1B,EAAE;IACV,MAAM,cAAc,GAA2B,EAAE,CAAC;IAClD,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAE,CAAC;QACvB,MAAM,WAAW,GAAG,mBAAmB,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAQ,CAAC,CAAC;QACjF,IAAA,mBAAS,EAAC,WAAW,EAAE,mCAAmC,CAAC,EAAE,CAAC,CAAC;QAC/D,cAAc,CAAC,WAAW,CAAC,GAAG,uCAAuC,CACnE,mBAAmB,EACnB,mBAAmB,EACnB,CAAC,EACD,GAAG,CACJ,CAAC;IACJ,CAAC;IACD,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AArBW,QAAA,+BAA+B,mCAqB1C;AAEK,MAAM,4BAA4B,GAAG,CAI1C,mBAA2D,EAC3D,mBAAwC,EACxC,WAAmC,EAChB,EAAE;IACrB,MAAM,MAAM,GAAY,EAAS,CAAC;IAClC,KAAK,MAAM,SAAS,IAAI,WAAW,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,WAAW,CAAC,SAAS,CAAE,CAAC;QACpC,MAAM,CAAC,SAA0B,CAAC,GAAG,oCAAoC,CACvE,mBAAmB,EACnB,mBAAmB,EACnB,SAA0B,EAC1B,GAAG,CACJ,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAnBW,QAAA,4BAA4B,gCAmBvC;AAEK,MAAM,4BAA4B,GAAG,CAI1C,mBAA2D,EAC3D,mBAAwC,EACxC,MAAkC,EAC1B,EAAE;IACV,MAAM,WAAW,GAA2B,EAAE,CAAC;IAC/C,KAAK,MAAM,SAAS,IAAI,MAAM,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAE,CAAC;QAC/B,WAAW,CAAC,SAAS,CAAC,GAAG,oCAAoC,CAC3D,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,EACT,GAAG,CACJ,CAAC;IACJ,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAnBW,QAAA,4BAA4B,gCAmBvC;AAEF,MAAM,uCAAuC,GAAG,CAK9C,mBAA2D,EAC3D,mBAAwC,EACxC,SAAY,EACZ,KAAU,EACE,EAAE;IACd,kGAAkG;IAClG,mCAAmC;IACnC,MAAM,eAAe,GAAG,IAAA,oBAAU,EAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9E,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,eAAe,GAAG,WAAW,EAAE,IAAI,CAAC;IAC1C,OAAO,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,uCAAuC,GAAG,CAK9C,mBAA2D,EAC3D,mBAAwC,EACxC,SAAY,EACZ,KAAiB,EACZ,EAAE;IACP,MAAM,eAAe,GAAG,IAAA,oBAAU,EAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9E,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,gBAAgB,GAAG,WAAW,EAAE,KAAK,CAAC;IAC5C,OAAO,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,oCAAoC,GAAG,CAK3C,mBAA2D,EAC3D,mBAAwC,EACxC,SAAY,EACZ,KAAU,EACE,EAAE;IACd,MAAM,eAAe,GAAG,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,eAAe,GAAG,WAAW,EAAE,IAAI,CAAC;IAC1C,OAAO,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC1D,CAAC,CAAC;AAEF,MAAM,oCAAoC,GAAG,CAK3C,mBAA2D,EAC3D,mBAAwC,EACxC,SAAY,EACZ,KAAiB,EACZ,EAAE;IACP,MAAM,eAAe,GAAG,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9E,MAAM,gBAAgB,GAAG,WAAW,EAAE,KAAK,CAAC;IAC5C,OAAO,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAC5D,CAAC,CAAC"}

package/build/internal/EntityLoadInterfaces.d.ts

@@ -0,0 +1,104 @@
+import EntityConfiguration from '../EntityConfiguration';
+import { ISerializable, SerializableKeyMap } from '../utils/collections/SerializableKeyMap';
+/**
+ * Load method type identifier of a load key. Used for keying data loaders and identification in metrics.
+ */
+export declare enum EntityLoadMethodType {
+    /**
+     * Load method type for loading entities by single fieldName and fieldValue(s).
+     */
+    SINGLE = "single",
+    /**
+     * Load method type for loading entities by composite field.
+     */
+    COMPOSITE = "composite"
+}
+/**
+ * Interface responsible for defining how the key and corresponding load values behave in the data manager, cache adapter,
+ * and database adapter during entity field loading.
+ */
+export interface IEntityLoadKey<TFields extends Record<string, any>, TIDField extends keyof TFields, TSerializedLoadValue, TLoadValue extends IEntityLoadValue<TSerializedLoadValue>> {
+    toString(): string;
+    /**
+     * Vends a new empty load value map with a key type corresponding to the load value type of this load key.
+     *
+     * @returns A new empty load value map.
+     */
+    vendNewLoadValueMap<V>(): LoadValueMap<TSerializedLoadValue, TLoadValue, V>;
+    /**
+     * Determines if this key is cacheable in cache adapters according to the entity configuration.
+     *
+     * @param entityConfiguration - The entity configuration to check.
+     * @returns Boolean indicating whether this key is cacheable.
+     */
+    isCacheable(entityConfiguration: EntityConfiguration<TFields, TIDField>): boolean;
+    /**
+     * Creates cache key parts for this key and a load value given an entity configuration.
+     * These parts will be included as part of the cache key.
+     *
+     * @param entityConfiguration - The entity configuration used to derive cache key parts.
+     * @param value - The load value for which to create cache key parts for.
+     * @returns An object containing the cache key type and parts.
+     */
+    createCacheKeyPartsForLoadValue(entityConfiguration: EntityConfiguration<TFields, TIDField>, value: TLoadValue): readonly string[];
+    /**
+     * Gets the load method type of this key. Used as part of cache keys and data loader keys.
+     */
+    getLoadMethodType(): EntityLoadMethodType;
+    /**
+     * Gets the data loader key for this key. For single field keys, this is the field name. For composite keys, this is a
+     * unique identifier for the composite key.
+     */
+    getDataManagerDataLoaderKey(): string;
+    /**
+     * Serialize a load value for use in the data manager data loader as the dataloader value key.
+     */
+    serializeLoadValue(value: TLoadValue): TSerializedLoadValue;
+    /**
+     * Deserialize a load value for use in the data manager data loader as the dataloader value key.
+     */
+    deserializeLoadValue(value: TSerializedLoadValue): TLoadValue;
+    /**
+     * Validate that that the load values adhere to the typescript types at runtime in order to
+     * prevent inadvertently passing invalid values to the data loader, cache adapter, or database adapter.
+     * @param values - The load values to validate.
+     * @param entityClassName - The name of the entity class to which the load values belong (for error message only).
+     */
+    validateRuntimeLoadValuesForDataManagerDataLoader(values: readonly TLoadValue[], entityClassName: string): void;
+    /**
+     * Get the database columns for this key given an entity configuration.
+     *
+     * @param entityConfiguration - The entity configuration.
+     * @returns An array of database column names.
+     */
+    getDatabaseColumns(entityConfiguration: EntityConfiguration<TFields, TIDField>): readonly string[];
+    /**
+     * Get the database values corresponding to the database columns for this key for a load value.
+     *
+     * @param value - The load value.
+     * @returns An array of database values.
+     */
+    getDatabaseValues(value: TLoadValue): readonly any[];
+    /**
+     * Get the load value for an entity fields object from the database.
+     *
+     * @param object - The entity fields object.
+     * @returns The load value for the object or null if the load value would be invalid for the object (for example, if the value is null).
+     */
+    getLoadValueForObject(object: Readonly<TFields>): TLoadValue | null;
+}
+/**
+ * Interface for a load value corresponding to a load key.
+ */
+export interface IEntityLoadValue<TSerialized> extends ISerializable<TSerialized> {
+    toString(): string;
+}
+/**
+ * Map from load value interface to value.
+ */
+export declare abstract class LoadValueMap<TSerialized, TLoadValue extends IEntityLoadValue<TSerialized>, V> extends SerializableKeyMap<TSerialized, TLoadValue, V> {
+}
+/**
+ * Load pair type for a load key and load value.
+ */
+export type LoadPair<TFields extends Record<string, any>, TIDField extends keyof TFields, TLoadKey extends IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>, TSerializedLoadValue, TLoadValue extends IEntityLoadValue<TSerializedLoadValue>> = readonly [TLoadKey, TLoadValue];

package/build/internal/EntityLoadInterfaces.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LoadValueMap = exports.EntityLoadMethodType = void 0;
+const SerializableKeyMap_1 = require("../utils/collections/SerializableKeyMap");
+/**
+ * Load method type identifier of a load key. Used for keying data loaders and identification in metrics.
+ */
+var EntityLoadMethodType;
+(function (EntityLoadMethodType) {
+    /**
+     * Load method type for loading entities by single fieldName and fieldValue(s).
+     */
+    EntityLoadMethodType["SINGLE"] = "single";
+    /**
+     * Load method type for loading entities by composite field.
+     */
+    EntityLoadMethodType["COMPOSITE"] = "composite";
+})(EntityLoadMethodType || (exports.EntityLoadMethodType = EntityLoadMethodType = {}));
+/**
+ * Map from load value interface to value.
+ */
+class LoadValueMap extends SerializableKeyMap_1.SerializableKeyMap {
+}
+exports.LoadValueMap = LoadValueMap;
+//# sourceMappingURL=EntityLoadInterfaces.js.map

package/build/internal/EntityLoadInterfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityLoadInterfaces.js","sourceRoot":"","sources":["../../src/internal/EntityLoadInterfaces.ts"],"names":[],"mappings":";;;AACA,gFAA4F;AAE5F;;GAEG;AACH,IAAY,oBAUX;AAVD,WAAY,oBAAoB;IAC9B;;OAEG;IACH,yCAAiB,CAAA;IAEjB;;OAEG;IACH,+CAAuB,CAAA;AACzB,CAAC,EAVW,oBAAoB,oCAApB,oBAAoB,QAU/B;AA4GD;;GAEG;AACH,MAAsB,YAIpB,SAAQ,uCAA8C;CAAG;AAJ3D,oCAI2D"}