@karmaniverous/entity-manager 6.9.2 → 6.10.1

package/dist/cjs/BaseEntityClient.js

@@ -3,6 +3,8 @@
 /**
  * Base EntityClient class. Integrates {@link EntityManager | `EntityManager`} with injected logging & enhanced batch processing.
  *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
  * @category EntityClient
  */
 class BaseEntityClient {
@@ -11,7 +13,8 @@ class BaseEntityClient {
      *
      * @param options - {@link BaseEntityClientOptions | `BaseEntityClientOptions`} object.
      */
-    constructor(options) {
+    constructor(entityManager, options = {}) {
+        this.entityManager = entityManager;
         const { batchProcessOptions = {}, logger = console } = options;
         this.batchProcessOptions = batchProcessOptions;
         this.logger = logger;

package/dist/cjs/BaseQueryBuilder.js

@@ -20,9 +20,8 @@ class BaseQueryBuilder {
          * @protected
          */
         this.indexParamsMap = {};
-        const { entityClient, entityManager, entityToken, hashKeyToken, pageKeyMap, } = options;
+        const { entityClient, entityToken, hashKeyToken, pageKeyMap } = options;
         this.entityClient = entityClient;
-        this.entityManager = entityManager;
         this.entityToken = entityToken;
         this.hashKeyToken = hashKeyToken;
         this.pageKeyMap = pageKeyMap;
@@ -36,7 +35,7 @@ class BaseQueryBuilder {
         return radash.mapValues(this.indexParamsMap, (indexConfig, indexToken) => this.getShardQueryFunction(indexToken));
     }
     async query(options) {
-        const { entityManager, entityToken, pageKeyMap } = this;
+        const { entityClient: { entityManager }, entityToken, pageKeyMap, } = this;
         const shardQueryMap = this.build();
         return await entityManager.query({
             ...options,

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { EntityMap, TranscodeMap, FlattenEntityMap, ConditionalProperty, Exactify, PropertiesOfType, TranscodableProperties, Transcodes, SortOrder, MutuallyExclusive, NotNever, DefaultTranscodeMap } from '@karmaniverous/entity-tools';
+import { EntityMap, TranscodeMap, ConditionalProperty, Exactify, PropertiesOfType, TranscodableProperties, FlattenEntityMap, Transcodes, SortOrder, MutuallyExclusive, NotNever, DefaultTranscodeMap } from '@karmaniverous/entity-tools';
 import { BatchProcessOptions } from '@karmaniverous/batch-process';
 import { z } from 'zod';
 
@@ -20,6 +20,8 @@ interface BaseConfigMap {
 /**
  * Base EntityClient options.
  *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
  * @category EntityClient
  */
 interface BaseEntityClientOptions {
@@ -29,52 +31,6 @@ interface BaseEntityClientOptions {
     logger?: Pick<Console, 'debug' | 'error'>;
 }
 
-/**
- * Base EntityClient class. Integrates {@link EntityManager | `EntityManager`} with injected logging & enhanced batch processing.
- *
- * @category EntityClient
- */
-declare abstract class BaseEntityClient {
-    readonly batchProcessOptions: NonNullable<BaseEntityClientOptions['batchProcessOptions']>;
-    readonly logger: NonNullable<BaseEntityClientOptions['logger']>;
-    /**
-     * DynamoDB EntityClient constructor.
-     *
-     * @param options - {@link BaseEntityClientOptions | `BaseEntityClientOptions`} object.
-     */
-    constructor(options: BaseEntityClientOptions);
-}
-
-/**
- * Extracts a database-facing partial item type from a {@link BaseConfigMap | `ConfigMap`}.
- *
- * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
- *
- * @category EntityManager
- * @protected
- */
-type EntityItem<C extends BaseConfigMap> = Partial<FlattenEntityMap<C['EntityMap']> & Record<C['HashKey'] | C['RangeKey'] | C['ShardedKeys'] | C['UnshardedKeys'], string>> & Record<string, unknown>;
-
-/**
- * A result returned by a query across multiple shards, where each shard may receive multiple page queries via a dynamically-generated {@link ShardQueryFunction | `ShardQueryFunction`}.
- *
- * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
- *
- * @category EntityManager
- * @protected
- */
-interface QueryResult<C extends BaseConfigMap> {
-    /** Total number of records returned across all shards. */
-    count: number;
-    /** The returned records. */
-    items: EntityItem<C>[];
-    /**
-     * 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;
-}
-
 /**
  * Defines a single time period in an entity sharding strategy.
  *
@@ -134,6 +90,16 @@ type Config<C extends BaseConfigMap = BaseConfigMap> = ConditionalProperty<'enti
     throttle?: number;
 };
 
+/**
+ * Extracts a database-facing partial item type from a {@link BaseConfigMap | `ConfigMap`}.
+ *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
+ */
+type EntityItem<C extends BaseConfigMap> = Partial<FlattenEntityMap<C['EntityMap']> & Record<C['HashKey'] | C['RangeKey'] | C['ShardedKeys'] | C['UnshardedKeys'], string>> & Record<string, unknown>;
+
 /**
  * Extracts entity tokens from a {@link ConfigMap | `ConfigMap`}.
  *
@@ -516,6 +482,26 @@ interface QueryOptions<C extends BaseConfigMap> {
     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`}.
+ *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ * @protected
+ */
+interface QueryResult<C extends BaseConfigMap> {
+    /** Total number of records returned across all shards. */
+    count: number;
+    /** The returned records. */
+    items: EntityItem<C>[];
+    /**
+     * 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.
@@ -597,6 +583,25 @@ declare class EntityManager<C extends BaseConfigMap> {
     query(options: QueryOptions<C>): Promise<QueryResult<C>>;
 }
 
+/**
+ * Base EntityClient class. Integrates {@link EntityManager | `EntityManager`} with injected logging & enhanced batch processing.
+ *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityClient
+ */
+declare abstract class BaseEntityClient<C extends BaseConfigMap> {
+    readonly entityManager: EntityManager<C>;
+    readonly batchProcessOptions: NonNullable<BaseEntityClientOptions['batchProcessOptions']>;
+    readonly logger: NonNullable<BaseEntityClientOptions['logger']>;
+    /**
+     * DynamoDB EntityClient constructor.
+     *
+     * @param options - {@link BaseEntityClientOptions | `BaseEntityClientOptions`} object.
+     */
+    constructor(entityManager: EntityManager<C>, options?: BaseEntityClientOptions);
+}
+
 /**
  * Constructor options for {@link BaseQueryBuilder | `BaseQueryBuilder`}.
  *
@@ -605,11 +610,9 @@ declare class EntityManager<C extends BaseConfigMap> {
  *
  * @category QueryBuilder
  */
-interface BaseQueryBuilderOptions<C extends BaseConfigMap, EntityClient extends BaseEntityClient> {
+interface BaseQueryBuilderOptions<C extends BaseConfigMap, EntityClient extends BaseEntityClient<C>> {
     /** {@link BaseEntityClient | `EntityClient`} instance. */
     entityClient: EntityClient;
-    /** {@link EntityManager | `EntityManager`} instance. */
-    entityManager: EntityManager<C>;
     /** Entity token. */
     entityToken: EntityToken<C>;
     /** Hash key token. */
@@ -638,11 +641,9 @@ type QueryBuilderQueryOptions<C extends BaseConfigMap> = Omit<QueryOptions<C>, '
  *
  * @category QueryBuilder
  */
-declare abstract class BaseQueryBuilder<C extends BaseConfigMap, EntityClient extends BaseEntityClient, IndexParams> {
+declare abstract class BaseQueryBuilder<C extends BaseConfigMap, EntityClient extends BaseEntityClient<C>, IndexParams> {
     /** {@link BaseEntityClient | `EntityClient`} instance. */
     readonly entityClient: EntityClient;
-    /** {@link EntityManager | `EntityManager`} instance. */
-    readonly entityManager: EntityManager<C>;
     /** Entity token. */
     readonly entityToken: EntityToken<C>;
     /** Hash key token. */

package/dist/mjs/BaseEntityClient.js

@@ -1,6 +1,8 @@
 /**
  * Base EntityClient class. Integrates {@link EntityManager | `EntityManager`} with injected logging & enhanced batch processing.
  *
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines an {@link Config | `EntityManager configuration`}'s {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
  * @category EntityClient
  */
 class BaseEntityClient {
@@ -9,7 +11,8 @@ class BaseEntityClient {
      *
      * @param options - {@link BaseEntityClientOptions | `BaseEntityClientOptions`} object.
      */
-    constructor(options) {
+    constructor(entityManager, options = {}) {
+        this.entityManager = entityManager;
         const { batchProcessOptions = {}, logger = console } = options;
         this.batchProcessOptions = batchProcessOptions;
         this.logger = logger;

package/dist/mjs/BaseQueryBuilder.js

@@ -18,9 +18,8 @@ class BaseQueryBuilder {
          * @protected
          */
         this.indexParamsMap = {};
-        const { entityClient, entityManager, entityToken, hashKeyToken, pageKeyMap, } = options;
+        const { entityClient, entityToken, hashKeyToken, pageKeyMap } = options;
         this.entityClient = entityClient;
-        this.entityManager = entityManager;
         this.entityToken = entityToken;
         this.hashKeyToken = hashKeyToken;
         this.pageKeyMap = pageKeyMap;
@@ -34,7 +33,7 @@ class BaseQueryBuilder {
         return mapValues(this.indexParamsMap, (indexConfig, indexToken) => this.getShardQueryFunction(indexToken));
     }
     async query(options) {
-        const { entityManager, entityToken, pageKeyMap } = this;
+        const { entityClient: { entityManager }, entityToken, pageKeyMap, } = this;
         const shardQueryMap = this.build();
         return await entityManager.query({
             ...options,

package/package.json

@@ -5,7 +5,7 @@
   },
   "dependencies": {
     "@karmaniverous/batch-process": "^0.1.0",
-    "@karmaniverous/entity-tools": "^0.6.1",
+    "@karmaniverous/entity-tools": "^0.6.2",
     "@karmaniverous/string-utilities": "^0.2.1",
     "lz-string": "^1.5.0",
     "radash": "^12.1.0",
@@ -39,7 +39,7 @@
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-tsdoc": "^0.3.0",
     "jsdom-global": "^3.0.2",
-    "knip": "^5.36.5",
+    "knip": "^5.36.7",
     "lefthook": "^1.8.2",
     "mocha": "^10.8.2",
     "nyc": "^17.1.0",
@@ -56,7 +56,7 @@
     "typedoc-plugin-replace-text": "^4.0.0",
     "typedoc-plugin-zod": "^1.2.1",
     "typescript": "^5.6.3",
-    "typescript-eslint": "^8.13.0"
+    "typescript-eslint": "^8.14.0"
   },
   "exports": {
     ".": {
@@ -132,5 +132,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.9.2"
+  "version": "6.10.1"
 }