@karmaniverous/entity-manager 6.1.2 → 6.2.0

package/dist/cjs/EntityManagerClient.js

@@ -9,9 +9,15 @@ var _EntityManagerClient_options;
 /**
  * EntityManagerClient base class.
  *
+ * @typeParam Options - Options type extended from {@link EntityManagerClientOptions | `EntityManagerClientOptions`}.
+ *
  * @category Client
  */
 class EntityManagerClient {
+    /**
+     * EntityManagerClient base constructor.
+     * @param options - Options object extended from {@link EntityManagerClientOptions | `EntityManagerClientOptions`}.
+     */
     constructor({ batchSize = 25, delayIncrement = 100, maxRetries = 5, throttle = 10, logger = console, logInternals = false, ...childOptions }) {
         _EntityManagerClient_options.set(this, void 0);
         if (!radash.isFunction(logger.debug))

package/dist/cjs/ShardQueryFunctionBuilder.js

@@ -0,0 +1,14 @@
+'use strict';
+
+/**
+ * Entity Manager shard query builder base class.
+ *
+ * @category Query
+ */
+class ShardQueryFunctionBuilder {
+    constructor(options) {
+        this.options = options;
+    }
+}
+
+exports.ShardQueryFunctionBuilder = ShardQueryFunctionBuilder;

package/dist/cjs/index.js

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

package/dist/cjs/query.js

@@ -27,7 +27,7 @@ const { compressToEncodedURIComponent, decompressFromEncodedURIComponent } = lzS
  *
  * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.queryMap | `queryMap`} keys.
  */
-async function query(entityManager, { entityToken, hashKey, item, limit, pageKeyMap, pageSize, queryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
+async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, pageSize, queryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
     try {
         // Get defaults.
         const { defaultLimit, defaultPageSize } = entityManager.config.entities[entityToken];

package/dist/index.d.ts

@@ -677,13 +677,6 @@ interface QueryOptions<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken],
      * {@link Config | `EntityManager.config.entities.<entityToken>.keys`}.
      */
     hashKey: string;
-    /**
-     * A partial {@link ItemMap | `ItemMap`} object containing at least the properties specified in
-     * {@link Config | `EntityManager.config.entities.<entityToken>.keys.<keyToken>.elements`}, except for the properties specified in {@link Config | `EntityManager.config.tokens`}.
-     *
-     * This data will be used to generate query keys across all shards.
-     */
-    item?: Item;
     /**
      * The target maximum number of records to be returned by the query across
      * all shards.
@@ -886,15 +879,21 @@ type EntityManagerClientOptions = EntityManagerClientBatchOptions & LoggerOption
 /**
  * EntityManagerClient base class.
  *
+ * @typeParam Options - Options type extended from {@link EntityManagerClientOptions | `EntityManagerClientOptions`}.
+ *
  * @category Client
  */
-declare abstract class EntityManagerClient<O extends EntityManagerClientOptions> {
+declare abstract class EntityManagerClient<Options extends EntityManagerClientOptions> {
     #private;
-    constructor({ batchSize, delayIncrement, maxRetries, throttle, logger, logInternals, ...childOptions }: O);
+    /**
+     * EntityManagerClient base constructor.
+     * @param options - Options object extended from {@link EntityManagerClientOptions | `EntityManagerClientOptions`}.
+     */
+    constructor({ batchSize, delayIncrement, maxRetries, throttle, logger, logInternals, ...childOptions }: Options);
     /**
      * Returns the options used to create the EntityManagerClient instance.
      */
-    get options(): Required<O>;
+    get options(): Required<Options>;
     /**
      * Executes a batch operation.
      *
@@ -911,6 +910,37 @@ declare abstract class EntityManagerClient<O extends EntityManagerClientOptions>
     protected batchExecute<Item, Output>(items: Item[], executeBatch: (items: Item[]) => Promise<Output>, getUnprocessedItems?: (output: Output) => Item[] | undefined, { batchSize, delayIncrement, maxRetries, throttle, }?: EntityManagerClientBatchOptions): Promise<Output[]>;
 }
 
+/**
+ * {@link ShardQueryFunctionBuilder | `ShardQueryFunctionBuilder`} 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> {
+    /** {@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;
+    /** 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. */
+    pageKey?: string;
+}
+
+/**
+ * Entity Manager shard query builder base class.
+ *
+ * @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>> {
+    private readonly options;
+    constructor(options: Options);
+    abstract getShardQueryFunction(): ShardQueryFunction<Item, EntityToken, M, HashKey, RangeKey, T>;
+}
+
 /**
  * Returns an object type with specific properties rendered required and non-nullable.
  *
@@ -921,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, 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, ShardQueryFunctionBuilder, type ShardQueryFunctionBuilderOptions, type ShardQueryResult, type Unwrap, type WithRequiredAndNonNullable, conditionalize };

package/dist/mjs/EntityManagerClient.js

@@ -7,9 +7,15 @@ var _EntityManagerClient_options;
 /**
  * EntityManagerClient base class.
  *
+ * @typeParam Options - Options type extended from {@link EntityManagerClientOptions | `EntityManagerClientOptions`}.
+ *
  * @category Client
  */
 class EntityManagerClient {
+    /**
+     * EntityManagerClient base constructor.
+     * @param options - Options object extended from {@link EntityManagerClientOptions | `EntityManagerClientOptions`}.
+     */
     constructor({ batchSize = 25, delayIncrement = 100, maxRetries = 5, throttle = 10, logger = console, logInternals = false, ...childOptions }) {
         _EntityManagerClient_options.set(this, void 0);
         if (!isFunction(logger.debug))

package/dist/mjs/ShardQueryFunctionBuilder.js

@@ -0,0 +1,12 @@
+/**
+ * Entity Manager shard query builder base class.
+ *
+ * @category Query
+ */
+class ShardQueryFunctionBuilder {
+    constructor(options) {
+        this.options = options;
+    }
+}
+
+export { ShardQueryFunctionBuilder };

package/dist/mjs/index.js

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

package/dist/mjs/query.js

@@ -25,7 +25,7 @@ const { compressToEncodedURIComponent, decompressFromEncodedURIComponent } = lzS
  *
  * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.queryMap | `queryMap`} keys.
  */
-async function query(entityManager, { entityToken, hashKey, item, limit, pageKeyMap, pageSize, queryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
+async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, pageSize, queryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
     try {
         // Get defaults.
         const { defaultLimit, defaultPageSize } = entityManager.config.entities[entityToken];

package/package.json

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