@karmaniverous/entity-manager 6.2.3 → 6.3.0

package/dist/cjs/EntityManager.js

@@ -82,7 +82,7 @@ class EntityManager {
      *
      * @returns {@link QueryResult} object.
      *
-     * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.queryMap | `queryMap`} keys.
+     * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
      */
     async query(options) {
         return await query.query(this, options);

package/dist/cjs/{ShardQueryFunctionBuilder.js → ShardQueryMapBuilder.js}

@@ -5,10 +5,10 @@
  *
  * @category Query
  */
-class ShardQueryFunctionBuilder {
+class ShardQueryMapBuilder {
     constructor(options) {
         this.options = options;
     }
 }
 
-exports.ShardQueryFunctionBuilder = ShardQueryFunctionBuilder;
+exports.ShardQueryMapBuilder = ShardQueryMapBuilder;

package/dist/cjs/index.js

@@ -3,11 +3,11 @@
 var conditionalize = require('./conditionalize.js');
 var EntityManager = require('./EntityManager.js');
 var EntityManagerClient = require('./EntityManagerClient.js');
-var ShardQueryFunctionBuilder = require('./ShardQueryFunctionBuilder.js');
+var ShardQueryMapBuilder = require('./ShardQueryMapBuilder.js');
 
 
 
 exports.conditionalize = conditionalize.conditionalize;
 exports.EntityManager = EntityManager.EntityManager;
 exports.EntityManagerClient = EntityManagerClient.EntityManagerClient;
-exports.ShardQueryFunctionBuilder = ShardQueryFunctionBuilder.ShardQueryFunctionBuilder;
+exports.ShardQueryMapBuilder = ShardQueryMapBuilder.ShardQueryMapBuilder;

package/dist/cjs/query.js

@@ -25,9 +25,9 @@ const { compressToEncodedURIComponent, decompressFromEncodedURIComponent } = lzS
  *
  * @returns {@link QueryResult} object.
  *
- * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.queryMap | `queryMap`} keys.
+ * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
  */
-async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, pageSize, queryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
+async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, pageSize, shardQueryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
     try {
         // Get defaults.
         const { defaultLimit, defaultPageSize } = entityManager.config.entities[entityToken];
@@ -42,7 +42,7 @@ async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, p
         // Rehydrate pageKeyMap.
         const rehydratedPageKeyMap = rehydratePageKeyMap.rehydratePageKeyMap(entityManager, pageKeyMap
             ? JSON.parse(decompressFromEncodedURIComponent(pageKeyMap))
-            : undefined, entityToken, Object.keys(queryMap), timestampFrom, timestampTo);
+            : undefined, entityToken, Object.keys(shardQueryMap), timestampFrom, timestampTo);
         // Shortcut if pageKeyMap is empty.
         if (!Object.keys(rehydratedPageKeyMap).length)
             return {
@@ -67,7 +67,7 @@ async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, p
                 pageKey,
             ])), async ([index, hashKey, pageKey]) => ({
                 index,
-                queryResult: await queryMap[index](hashKey, pageKey, pageSize),
+                queryResult: await shardQueryMap[index](hashKey, pageKey, pageSize),
                 hashKey,
             }));
             // Reduce shardQueryResults & updateworkingRresult.

package/dist/index.d.ts

@@ -664,6 +664,8 @@ interface ShardQueryResult<Item extends ItemMap<M, HashKey, RangeKey>[EntityToke
  */
 type ShardQueryFunction<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string = 'hashKey', RangeKey extends string = 'rangeKey', T extends TranscodeMap = DefaultTranscodeMap> = (hashKey: string, pageKey?: PartialTranscodable<Item, T>, pageSize?: number) => Promise<ShardQueryResult<Item, EntityToken, M, HashKey, RangeKey, T>>;
 
+type ShardQueryMap<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> = Record<string, ShardQueryFunction<Item, EntityToken, M, HashKey, RangeKey, T>>;
+
 /**
  * Options passed to the {@link EntityManager.query | `EntityManager.query`} method.
  *
@@ -708,7 +710,7 @@ interface QueryOptions<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken],
      * page key, e.g. to match the same string against `firstName` and `lastName`
      * properties without performing a table scan for either.
      */
-    queryMap: Record<string, ShardQueryFunction<Item, EntityToken, M, HashKey, RangeKey, T>>;
+    shardQueryMap: ShardQueryMap<Item, EntityToken, M, HashKey, RangeKey, T>;
     /**
      * A {@link SortOrder | `SortOrder`} object specifying the sort order of the result set. Defaults to `[]`.
      */
@@ -824,7 +826,7 @@ declare class EntityManager<M extends EntityMap, HashKey extends string, RangeKe
      *
      * @returns {@link QueryResult} object.
      *
-     * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.queryMap | `queryMap`} keys.
+     * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
      */
     query<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(options: QueryOptions<Item, EntityToken, M, HashKey, RangeKey, T>): Promise<QueryResult<Item, EntityToken, M, HashKey, RangeKey>>;
 }
@@ -911,19 +913,17 @@ declare abstract class EntityManagerClient<Options extends EntityManagerClientOp
 }
 
 /**
- * {@link ShardQueryFunctionBuilder | `ShardQueryFunctionBuilder`} options.
+ * {@link ShardQueryMapBuilder | `ShardQueryMapBuilder`} options.
  *
  * @category Query
  */
-interface ShardQueryFunctionBuilderOptions<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> {
+interface ShardQueryMapBuilderOptions<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> {
     /** {@link EntityManager | `EntityManager`} instance. */
     entityManager: EntityManager<M, HashKey, RangeKey, T>;
     /** `entityManager.config.entities` key. */
     entityToken: EntityToken;
     /** Either the designated entity hash key or a generated property with `sharded === true`. */
-    hashKeyToken: HashKey | PropertiesOfType<M[EntityToken], void>;
-    /** `entityManager.config.entities.<entityToken>.indexes` key. */
-    indexToken: string;
+    hashKeyToken: HashKey | (PropertiesOfType<M[EntityToken], void> & string);
     /** A partial `Item` sufficiently populated to generate the query hash key & index values. */
     item: Partial<Item>;
     /** Dehydrated page key from the previous query data page. */
@@ -935,10 +935,10 @@ interface ShardQueryFunctionBuilderOptions<Item extends ItemMap<M, HashKey, Rang
  *
  * @category Query
  */
-declare abstract class ShardQueryFunctionBuilder<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap, Options extends ShardQueryFunctionBuilderOptions<Item, EntityToken, M, HashKey, RangeKey, T>> {
-    protected options: Options;
+declare abstract class ShardQueryMapBuilder<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap, Options extends ShardQueryMapBuilderOptions<Item, EntityToken, M, HashKey, RangeKey, T>> {
+    protected readonly options: Options;
     constructor(options: Options);
-    abstract getShardQueryFunction(): ShardQueryFunction<Item, EntityToken, M, HashKey, RangeKey, T>;
+    abstract getShardQueryMap(): ShardQueryMap<Item, EntityToken, M, HashKey, RangeKey, T>;
 }
 
 /**
@@ -951,4 +951,4 @@ type WithRequiredAndNonNullable<T, K extends keyof T> = T & {
     [P in K]-?: NonNullable<T[P]>;
 };
 
-export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, EntityManagerClient, type EntityManagerClientBatchOptions, type EntityManagerClientOptions, type EntityMap, type ExclusiveKey, type ItemMap, type Logger, type LoggerEndpoint, type LoggerOptions, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, ShardQueryFunctionBuilder, type ShardQueryFunctionBuilderOptions, type ShardQueryResult, type Unwrap, type WithRequiredAndNonNullable, conditionalize };
+export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigKeys, type ConfigTranscodes, EntityManager, EntityManagerClient, type EntityManagerClientBatchOptions, type EntityManagerClientOptions, type EntityMap, type ExclusiveKey, type ItemMap, type Logger, type LoggerEndpoint, type LoggerOptions, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, ShardQueryMapBuilder, type ShardQueryMapBuilderOptions, type ShardQueryResult, type Unwrap, type WithRequiredAndNonNullable, conditionalize };

package/dist/mjs/EntityManager.js

@@ -80,7 +80,7 @@ class EntityManager {
      *
      * @returns {@link QueryResult} object.
      *
-     * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.queryMap | `queryMap`} keys.
+     * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
      */
     async query(options) {
         return await query(this, options);

package/dist/mjs/{ShardQueryFunctionBuilder.js → ShardQueryMapBuilder.js}

@@ -3,10 +3,10 @@
  *
  * @category Query
  */
-class ShardQueryFunctionBuilder {
+class ShardQueryMapBuilder {
     constructor(options) {
         this.options = options;
     }
 }
 
-export { ShardQueryFunctionBuilder };
+export { ShardQueryMapBuilder };

package/dist/mjs/index.js

@@ -1,4 +1,4 @@
 export { conditionalize } from './conditionalize.js';
 export { EntityManager } from './EntityManager.js';
 export { EntityManagerClient } from './EntityManagerClient.js';
-export { ShardQueryFunctionBuilder } from './ShardQueryFunctionBuilder.js';
+export { ShardQueryMapBuilder } from './ShardQueryMapBuilder.js';

package/dist/mjs/query.js

@@ -23,9 +23,9 @@ const { compressToEncodedURIComponent, decompressFromEncodedURIComponent } = lzS
  *
  * @returns {@link QueryResult} object.
  *
- * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.queryMap | `queryMap`} keys.
+ * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
  */
-async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, pageSize, queryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
+async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, pageSize, shardQueryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
     try {
         // Get defaults.
         const { defaultLimit, defaultPageSize } = entityManager.config.entities[entityToken];
@@ -40,7 +40,7 @@ async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, p
         // Rehydrate pageKeyMap.
         const rehydratedPageKeyMap = rehydratePageKeyMap(entityManager, pageKeyMap
             ? JSON.parse(decompressFromEncodedURIComponent(pageKeyMap))
-            : undefined, entityToken, Object.keys(queryMap), timestampFrom, timestampTo);
+            : undefined, entityToken, Object.keys(shardQueryMap), timestampFrom, timestampTo);
         // Shortcut if pageKeyMap is empty.
         if (!Object.keys(rehydratedPageKeyMap).length)
             return {
@@ -65,7 +65,7 @@ async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, p
                 pageKey,
             ])), async ([index, hashKey, pageKey]) => ({
                 index,
-                queryResult: await queryMap[index](hashKey, pageKey, pageSize),
+                queryResult: await shardQueryMap[index](hashKey, pageKey, pageSize),
                 hashKey,
             }));
             // Reduce shardQueryResults & updateworkingRresult.

package/package.json

@@ -132,5 +132,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.2.3"
+  "version": "6.3.0"
 }