@karmaniverous/entity-manager 6.7.1 → 6.7.3

package/dist/cjs/BaseShardQueryMapBuilder.js

@@ -9,17 +9,18 @@ var radash = require('radash');
  */
 class BaseShardQueryMapBuilder {
     /** BaseShardQueryMapBuilder constructor. */
-    constructor(entityManager, entityToken, hashKeyToken, pageKeyMap) {
-        this.entityManager = entityManager;
-        this.entityToken = entityToken;
-        this.hashKeyToken = hashKeyToken;
-        this.pageKeyMap = pageKeyMap;
+    constructor(options) {
         /**
-         * Maps `indexToken` values to database platform-specific parameters.
+         * Maps `indexToken` values to database platform-specific query parameters.
          *
          * @protected
          */
         this.indexParamsMap = {};
+        const { entityManager, entityToken, hashKeyToken, pageKeyMap } = options;
+        this.entityManager = entityManager;
+        this.entityToken = entityToken;
+        this.hashKeyToken = hashKeyToken;
+        this.pageKeyMap = pageKeyMap;
     }
     /**
      * Builds a {@link ShardQueryMap | `ShardQueryMap`} object.
@@ -29,6 +30,16 @@ class BaseShardQueryMapBuilder {
     build() {
         return radash.mapValues(this.indexParamsMap, (indexConfig, indexToken) => this.getShardQueryFunction(indexToken));
     }
+    async query(options) {
+        const { entityManager, entityToken, pageKeyMap } = this;
+        const shardQueryMap = this.build();
+        return await entityManager.query({
+            ...options,
+            entityToken,
+            pageKeyMap,
+            shardQueryMap,
+        });
+    }
 }
 
 exports.BaseShardQueryMapBuilder = BaseShardQueryMapBuilder;

package/dist/index.d.ts

@@ -363,6 +363,24 @@ type ItemMap<M extends EntityMap, HashKey extends string = 'hashKey', RangeKey e
     } & Partial<Record<HashKey | RangeKey, string>>>;
 };
 
+/**
+ * A result returned by a query across multiple shards, where each shard may
+ * receive multiple page queries via a dynamically-generated {@link ShardQueryFunction | `ShardQueryFunction`}.
+ *
+ * @category Query
+ */
+interface QueryResult<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string> {
+    /** Total number of records returned across all shards. */
+    count: number;
+    /** The returned records. */
+    items: Item[];
+    /**
+     * A compressed, two-layer map of page keys, used to query the next page of
+     * data for a given sort key on each shard of a given hash key.
+     */
+    pageKeyMap: string;
+}
+
 declare const configSchema: z.ZodEffects<z.ZodObject<{
     entities: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodObject<{
         defaultLimit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
@@ -785,24 +803,6 @@ interface QueryOptions<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken],
     throttle?: number;
 }
 
-/**
- * A result returned by a query across multiple shards, where each shard may
- * receive multiple page queries via a dynamically-generated {@link ShardQueryFunction | `ShardQueryFunction`}.
- *
- * @category Query
- */
-interface QueryResult<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string> {
-    /** Total number of records returned across all shards. */
-    count: number;
-    /** The returned records. */
-    items: Item[];
-    /**
-     * A compressed, two-layer map of page keys, used to query the next page of
-     * data for a given sort key on each shard of a given hash key.
-     */
-    pageKeyMap: string;
-}
-
 /**
  * The EntityManager class applies a configuration-driven sharded data model &
  * query strategy to NoSql data.
@@ -875,24 +875,44 @@ declare class EntityManager<M extends EntityMap, HashKey extends string, RangeKe
     query<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(options: QueryOptions<Item, EntityToken, M, HashKey, RangeKey>): Promise<QueryResult<Item, EntityToken, M, HashKey, RangeKey>>;
 }
 
+/**
+ * Constructor options for {@link BaseShardQueryMapBuilder | `BaseShardQueryMapBuilder`}.
+ */
+interface BaseShardQueryMapBuilderOptions<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>;
+    /** Entity token. */
+    entityToken: EntityToken;
+    /** Hash key token. */
+    hashKeyToken: PropertiesOfType<M[EntityToken], never> | HashKey;
+    /** Dehydrated page key map. */
+    pageKeyMap?: string;
+}
+
+type ShardQueryMapBuilderQueryOptions<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string> = Omit<QueryOptions<Item, EntityToken, M, HashKey, RangeKey>, 'entityToken' | 'pageKeyMap' | 'shardQueryMap'>;
+
 /**
  * Abstract base class supporting a fluent API for building a {@link ShardQueryMap | `ShardQueryMap`} using a database client.
  *
  * @category ShardQueryMapBuilder
  */
 declare abstract class BaseShardQueryMapBuilder<IndexParams, 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. */
     readonly entityManager: EntityManager<M, HashKey, RangeKey, T>;
+    /** Entity token. */
     readonly entityToken: EntityToken;
+    /** Hash key token. */
     readonly hashKeyToken: PropertiesOfType<M[EntityToken], never> | HashKey;
-    readonly pageKeyMap?: string | undefined;
+    /** Dehydrated page key map. */
+    readonly pageKeyMap?: string;
     /**
-     * Maps `indexToken` values to database platform-specific parameters.
+     * Maps `indexToken` values to database platform-specific query parameters.
      *
      * @protected
      */
     readonly indexParamsMap: Record<string, IndexParams>;
     /** BaseShardQueryMapBuilder constructor. */
-    constructor(entityManager: EntityManager<M, HashKey, RangeKey, T>, entityToken: EntityToken, hashKeyToken: PropertiesOfType<M[EntityToken], never> | HashKey, pageKeyMap?: string | undefined);
+    constructor(options: BaseShardQueryMapBuilderOptions<EntityToken, M, HashKey, RangeKey, T>);
     protected abstract getShardQueryFunction(indexToken: string): ShardQueryFunction<Item>;
     /**
      * Builds a {@link ShardQueryMap | `ShardQueryMap`} object.
@@ -900,6 +920,7 @@ declare abstract class BaseShardQueryMapBuilder<IndexParams, Item extends ItemMa
      * @returns - The {@link ShardQueryMap | `ShardQueryMap`} object.
      */
     build(): ShardQueryMap<Item>;
+    query(options: ShardQueryMapBuilderQueryOptions<Item, EntityToken, M, HashKey, RangeKey>): Promise<QueryResult<Item, EntityToken, M, HashKey, RangeKey>>;
 }
 
 /**
@@ -915,4 +936,4 @@ declare abstract class BaseShardQueryMapBuilder<IndexParams, Item extends ItemMa
  */
 declare function conditionalize<F extends (...args: Parameters<F>) => ReturnType<F>>(fn: F, condition?: unknown): (...args: Parameters<F>) => ReturnType<F> | undefined;
 
-export { BaseShardQueryMapBuilder, type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigEntityIndexComponent, type ConfigKeys, type ConfigTranscodes, EntityManager, type EntityMap, type ExclusiveKey, type ItemMap, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryResult, type Unwrap, conditionalize };
+export { BaseShardQueryMapBuilder, type BaseShardQueryMapBuilderOptions, type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigEntityIndexComponent, type ConfigKeys, type ConfigTranscodes, EntityManager, type EntityMap, type ExclusiveKey, type ItemMap, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryMapBuilderQueryOptions, type ShardQueryResult, type Unwrap, conditionalize };

package/dist/mjs/BaseShardQueryMapBuilder.js

@@ -7,17 +7,18 @@ import { mapValues } from 'radash';
  */
 class BaseShardQueryMapBuilder {
     /** BaseShardQueryMapBuilder constructor. */
-    constructor(entityManager, entityToken, hashKeyToken, pageKeyMap) {
-        this.entityManager = entityManager;
-        this.entityToken = entityToken;
-        this.hashKeyToken = hashKeyToken;
-        this.pageKeyMap = pageKeyMap;
+    constructor(options) {
         /**
-         * Maps `indexToken` values to database platform-specific parameters.
+         * Maps `indexToken` values to database platform-specific query parameters.
          *
          * @protected
          */
         this.indexParamsMap = {};
+        const { entityManager, entityToken, hashKeyToken, pageKeyMap } = options;
+        this.entityManager = entityManager;
+        this.entityToken = entityToken;
+        this.hashKeyToken = hashKeyToken;
+        this.pageKeyMap = pageKeyMap;
     }
     /**
      * Builds a {@link ShardQueryMap | `ShardQueryMap`} object.
@@ -27,6 +28,16 @@ class BaseShardQueryMapBuilder {
     build() {
         return mapValues(this.indexParamsMap, (indexConfig, indexToken) => this.getShardQueryFunction(indexToken));
     }
+    async query(options) {
+        const { entityManager, entityToken, pageKeyMap } = this;
+        const shardQueryMap = this.build();
+        return await entityManager.query({
+            ...options,
+            entityToken,
+            pageKeyMap,
+            shardQueryMap,
+        });
+    }
 }
 
 export { BaseShardQueryMapBuilder };

package/package.json

@@ -131,5 +131,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.7.1"
+  "version": "6.7.3"
 }