@karmaniverous/entity-manager 6.7.3 → 6.7.5

package/dist/cjs/BaseEntityClient.js

@@ -0,0 +1,21 @@
+'use strict';
+
+/**
+ * Base EntityClient class. Integrates {@link EntityManager | `EntityManager`} with injected logging & enhanced batch processing.
+ *
+ * @category EntityClient
+ */
+class BaseEntityClient {
+    /**
+     * DynamoDB EntityClient constructor.
+     *
+     * @param options - {@link EntityClientOptions | `EntityClientOptions`} object.
+     */
+    constructor(options) {
+        const { batchProcessOptions = {}, logger = console } = options;
+        this.batchProcessOptions = batchProcessOptions;
+        this.logger = logger;
+    }
+}
+
+exports.BaseEntityClient = BaseEntityClient;

package/dist/cjs/{BaseShardQueryMapBuilder.js → BaseQueryBuilder.js}

@@ -7,8 +7,8 @@ var radash = require('radash');
  *
  * @category ShardQueryMapBuilder
  */
-class BaseShardQueryMapBuilder {
-    /** BaseShardQueryMapBuilder constructor. */
+class BaseQueryBuilder {
+    /** BaseQueryBuilder constructor. */
     constructor(options) {
         /**
          * Maps `indexToken` values to database platform-specific query parameters.
@@ -16,7 +16,8 @@ class BaseShardQueryMapBuilder {
          * @protected
          */
         this.indexParamsMap = {};
-        const { entityManager, entityToken, hashKeyToken, pageKeyMap } = options;
+        const { entityClient, entityManager, entityToken, hashKeyToken, pageKeyMap, } = options;
+        this.entityClient = entityClient;
         this.entityManager = entityManager;
         this.entityToken = entityToken;
         this.hashKeyToken = hashKeyToken;
@@ -42,4 +43,4 @@ class BaseShardQueryMapBuilder {
     }
 }
 
-exports.BaseShardQueryMapBuilder = BaseShardQueryMapBuilder;
+exports.BaseQueryBuilder = BaseQueryBuilder;

package/dist/cjs/index.js

@@ -1,11 +1,13 @@
 'use strict';
 
-var BaseShardQueryMapBuilder = require('./BaseShardQueryMapBuilder.js');
+var BaseEntityClient = require('./BaseEntityClient.js');
+var BaseQueryBuilder = require('./BaseQueryBuilder.js');
 var conditionalize = require('./conditionalize.js');
 var EntityManager = require('./EntityManager.js');
 
 
 
-exports.BaseShardQueryMapBuilder = BaseShardQueryMapBuilder.BaseShardQueryMapBuilder;
+exports.BaseEntityClient = BaseEntityClient.BaseEntityClient;
+exports.BaseQueryBuilder = BaseQueryBuilder.BaseQueryBuilder;
 exports.conditionalize = conditionalize.conditionalize;
 exports.EntityManager = EntityManager.EntityManager;

package/dist/index.d.ts

@@ -1,6 +1,35 @@
+import { BatchProcessOptions } from '@karmaniverous/batch-process';
 import { Entity, Exactify, TranscodeMap, PropertiesOfType, TranscodableProperties, Transcodes, DefaultTranscodeMap, SortOrder } from '@karmaniverous/entity-tools';
 import { z } from 'zod';
 
+/**
+ * Base EntityClient options.
+ *
+ * @category EntityClient
+ */
+interface BaseEntityClientOptions {
+    /** Default batch process options. */
+    batchProcessOptions?: Omit<BatchProcessOptions<unknown, unknown>, 'batchHandler' | 'unprocessedItemExtractor'>;
+    /** Injected logger object. Must support `debug` and `error` methods. Default: `console` */
+    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 EntityClientOptions | `EntityClientOptions`} object.
+     */
+    constructor(options: BaseEntityClientOptions);
+}
+
 /**
  * The base EntityMap type. All EntityMaps should extend this type.
  *
@@ -553,6 +582,7 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         decode: (args_0: string, ...args: unknown[]) => any;
     }>>>>;
 }, "strict", z.ZodTypeAny, {
+    throttle: number;
     hashKey: string;
     rangeKey: string;
     entities: Record<string, {
@@ -580,12 +610,12 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     generatedKeyDelimiter: string;
     generatedValueDelimiter: string;
     shardKeyDelimiter: string;
-    throttle: number;
     transcodes: Record<string, {
         encode: (args_0: any, ...args: unknown[]) => string;
         decode: (args_0: string, ...args: unknown[]) => any;
     }>;
 }, {
+    throttle?: number | undefined;
     hashKey?: string | undefined;
     rangeKey?: string | undefined;
     entities?: Record<string, {
@@ -613,12 +643,12 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     generatedKeyDelimiter?: string | undefined;
     generatedValueDelimiter?: string | undefined;
     shardKeyDelimiter?: string | undefined;
-    throttle?: number | undefined;
     transcodes?: Record<string, {
         encode: (args_0: any, ...args: unknown[]) => string;
         decode: (args_0: string, ...args: unknown[]) => any;
     }> | undefined;
 }>, {
+    throttle: number;
     hashKey: string;
     rangeKey: string;
     entities: Record<string, {
@@ -646,12 +676,12 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     generatedKeyDelimiter: string;
     generatedValueDelimiter: string;
     shardKeyDelimiter: string;
-    throttle: number;
     transcodes: Record<string, {
         encode: (args_0: any, ...args: unknown[]) => string;
         decode: (args_0: string, ...args: unknown[]) => any;
     }>;
 }, {
+    throttle?: number | undefined;
     hashKey?: string | undefined;
     rangeKey?: string | undefined;
     entities?: Record<string, {
@@ -679,7 +709,6 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     generatedKeyDelimiter?: string | undefined;
     generatedValueDelimiter?: string | undefined;
     shardKeyDelimiter?: string | undefined;
-    throttle?: number | undefined;
     transcodes?: Record<string, {
         encode: (args_0: any, ...args: unknown[]) => string;
         decode: (args_0: string, ...args: unknown[]) => any;
@@ -876,9 +905,13 @@ declare class EntityManager<M extends EntityMap, HashKey extends string, RangeKe
 }
 
 /**
- * Constructor options for {@link BaseShardQueryMapBuilder | `BaseShardQueryMapBuilder`}.
+ * Constructor options for {@link BaseQueryBuilder | `BaseQueryBuilder`}.
+ *
+ * @category ShardQueryMapBuilder
  */
-interface BaseShardQueryMapBuilderOptions<EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> {
+interface BaseQueryBuilderOptions<EntityClient extends BaseEntityClient, EntityToken extends keyof Exactify<M> & string, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> {
+    /** {@link BaseEntityClient | `EntityClient`} instance. */
+    entityClient: EntityClient;
     /** {@link EntityManager | `EntityManager`} instance. */
     entityManager: EntityManager<M, HashKey, RangeKey, T>;
     /** Entity token. */
@@ -889,14 +922,16 @@ interface BaseShardQueryMapBuilderOptions<EntityToken extends keyof Exactify<M>
     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'>;
+type QueryBuilderQueryOptions<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> {
+declare abstract class BaseQueryBuilder<IndexParams, EntityClient extends BaseEntityClient, 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 BaseEntityClient | `EntityClient`} instance. */
+    readonly entityClient: EntityClient;
     /** {@link EntityManager | `EntityManager`} instance. */
     readonly entityManager: EntityManager<M, HashKey, RangeKey, T>;
     /** Entity token. */
@@ -911,8 +946,8 @@ declare abstract class BaseShardQueryMapBuilder<IndexParams, Item extends ItemMa
      * @protected
      */
     readonly indexParamsMap: Record<string, IndexParams>;
-    /** BaseShardQueryMapBuilder constructor. */
-    constructor(options: BaseShardQueryMapBuilderOptions<EntityToken, M, HashKey, RangeKey, T>);
+    /** BaseQueryBuilder constructor. */
+    constructor(options: BaseQueryBuilderOptions<EntityClient, EntityToken, M, HashKey, RangeKey, T>);
     protected abstract getShardQueryFunction(indexToken: string): ShardQueryFunction<Item>;
     /**
      * Builds a {@link ShardQueryMap | `ShardQueryMap`} object.
@@ -920,7 +955,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>>;
+    query(options: QueryBuilderQueryOptions<Item, EntityToken, M, HashKey, RangeKey>): Promise<QueryResult<Item, EntityToken, M, HashKey, RangeKey>>;
 }
 
 /**
@@ -936,4 +971,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 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 };
+export { BaseEntityClient, type BaseEntityClientOptions, BaseQueryBuilder, type BaseQueryBuilderOptions, type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigEntityIndexComponent, type ConfigKeys, type ConfigTranscodes, EntityManager, type EntityMap, type ExclusiveKey, type ItemMap, type ParsedConfig, type QueryBuilderQueryOptions, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryResult, type Unwrap, conditionalize };

package/dist/mjs/BaseEntityClient.js

@@ -0,0 +1,19 @@
+/**
+ * Base EntityClient class. Integrates {@link EntityManager | `EntityManager`} with injected logging & enhanced batch processing.
+ *
+ * @category EntityClient
+ */
+class BaseEntityClient {
+    /**
+     * DynamoDB EntityClient constructor.
+     *
+     * @param options - {@link EntityClientOptions | `EntityClientOptions`} object.
+     */
+    constructor(options) {
+        const { batchProcessOptions = {}, logger = console } = options;
+        this.batchProcessOptions = batchProcessOptions;
+        this.logger = logger;
+    }
+}
+
+export { BaseEntityClient };

package/dist/mjs/{BaseShardQueryMapBuilder.js → BaseQueryBuilder.js}

@@ -5,8 +5,8 @@ import { mapValues } from 'radash';
  *
  * @category ShardQueryMapBuilder
  */
-class BaseShardQueryMapBuilder {
-    /** BaseShardQueryMapBuilder constructor. */
+class BaseQueryBuilder {
+    /** BaseQueryBuilder constructor. */
     constructor(options) {
         /**
          * Maps `indexToken` values to database platform-specific query parameters.
@@ -14,7 +14,8 @@ class BaseShardQueryMapBuilder {
          * @protected
          */
         this.indexParamsMap = {};
-        const { entityManager, entityToken, hashKeyToken, pageKeyMap } = options;
+        const { entityClient, entityManager, entityToken, hashKeyToken, pageKeyMap, } = options;
+        this.entityClient = entityClient;
         this.entityManager = entityManager;
         this.entityToken = entityToken;
         this.hashKeyToken = hashKeyToken;
@@ -40,4 +41,4 @@ class BaseShardQueryMapBuilder {
     }
 }
 
-export { BaseShardQueryMapBuilder };
+export { BaseQueryBuilder };

package/dist/mjs/index.js

@@ -1,3 +1,4 @@
-export { BaseShardQueryMapBuilder } from './BaseShardQueryMapBuilder.js';
+export { BaseEntityClient } from './BaseEntityClient.js';
+export { BaseQueryBuilder } from './BaseQueryBuilder.js';
 export { conditionalize } from './conditionalize.js';
 export { EntityManager } from './EntityManager.js';

package/package.json

@@ -4,6 +4,7 @@
     "url": "https://github.com/karmaniverous/entity-manager/issues"
   },
   "dependencies": {
+    "@karmaniverous/batch-process": "^0.1.0",
     "@karmaniverous/entity-tools": "^0.4.4",
     "@karmaniverous/string-utilities": "^0.2.1",
     "lz-string": "^1.5.0",
@@ -131,5 +132,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.7.3"
+  "version": "6.7.5"
 }