@karmaniverous/entity-manager 6.10.1 → 6.10.3

package/dist/cjs/BaseEntityClient.js

@@ -13,10 +13,10 @@ class BaseEntityClient {
      *
      * @param options - {@link BaseEntityClientOptions | `BaseEntityClientOptions`} object.
      */
-    constructor(entityManager, options = {}) {
-        this.entityManager = entityManager;
-        const { batchProcessOptions = {}, logger = console } = options;
+    constructor(options) {
+        const { batchProcessOptions = {}, entityManager, logger = console, } = options;
         this.batchProcessOptions = batchProcessOptions;
+        this.entityManager = entityManager;
         this.logger = logger;
     }
 }

package/dist/index.d.ts

@@ -17,20 +17,6 @@ interface BaseConfigMap {
     TranscodeMap: TranscodeMap;
 }
 
-/**
- * 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 {
-    /** 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'>;
-}
-
 /**
  * Defines a single time period in an entity sharding strategy.
  *
@@ -217,7 +203,6 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
 }, "strict", z.ZodTypeAny, {
     hashKey: string;
     rangeKey: string;
-    throttle: number;
     entities: Record<string, {
         defaultLimit: number;
         defaultPageSize: number;
@@ -242,6 +227,7 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     generatedValueDelimiter: string;
     propertyTranscodes: Record<string, string>;
     shardKeyDelimiter: string;
+    throttle: number;
     transcodes: Record<string, {
         encode: (args_0: any, ...args: unknown[]) => string;
         decode: (args_0: string, ...args: unknown[]) => any;
@@ -249,7 +235,6 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
 }, {
     hashKey: string;
     rangeKey: string;
-    throttle?: number | undefined;
     entities?: Record<string, {
         timestampProperty: string;
         uniqueProperty: string;
@@ -274,6 +259,7 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     generatedValueDelimiter?: string | undefined;
     propertyTranscodes?: Record<string, 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;
@@ -281,7 +267,6 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
 }>, {
     hashKey: string;
     rangeKey: string;
-    throttle: number;
     entities: Record<string, {
         defaultLimit: number;
         defaultPageSize: number;
@@ -306,6 +291,7 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     generatedValueDelimiter: string;
     propertyTranscodes: Record<string, string>;
     shardKeyDelimiter: string;
+    throttle: number;
     transcodes: Record<string, {
         encode: (args_0: any, ...args: unknown[]) => string;
         decode: (args_0: string, ...args: unknown[]) => any;
@@ -313,7 +299,6 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
 }, {
     hashKey: string;
     rangeKey: string;
-    throttle?: number | undefined;
     entities?: Record<string, {
         timestampProperty: string;
         uniqueProperty: string;
@@ -338,6 +323,7 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     generatedValueDelimiter?: string | undefined;
     propertyTranscodes?: Record<string, 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;
@@ -583,6 +569,22 @@ declare class EntityManager<C extends BaseConfigMap> {
     query(options: QueryOptions<C>): Promise<QueryResult<C>>;
 }
 
+/**
+ * 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<C extends BaseConfigMap> {
+    /** Default batch process options. */
+    batchProcessOptions?: Omit<BatchProcessOptions<unknown, unknown>, 'batchHandler' | 'unprocessedItemExtractor'>;
+    /** {@link EntityManager | `EntityManager`} instance. */
+    entityManager: EntityManager<C>;
+    /** 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.
  *
@@ -591,15 +593,18 @@ declare class EntityManager<C extends BaseConfigMap> {
  * @category EntityClient
  */
 declare abstract class BaseEntityClient<C extends BaseConfigMap> {
+    /** Default batch process options. */
+    readonly batchProcessOptions: NonNullable<BaseEntityClientOptions<C>['batchProcessOptions']>;
+    /** {@link EntityManager | `EntityManager`} instance. */
     readonly entityManager: EntityManager<C>;
-    readonly batchProcessOptions: NonNullable<BaseEntityClientOptions['batchProcessOptions']>;
-    readonly logger: NonNullable<BaseEntityClientOptions['logger']>;
+    /** Injected logger object. Must support `debug` and `error` methods. Default: `console` */
+    readonly logger: NonNullable<BaseEntityClientOptions<C>['logger']>;
     /**
      * DynamoDB EntityClient constructor.
      *
      * @param options - {@link BaseEntityClientOptions | `BaseEntityClientOptions`} object.
      */
-    constructor(entityManager: EntityManager<C>, options?: BaseEntityClientOptions);
+    constructor(options: BaseEntityClientOptions<C>);
 }
 
 /**
@@ -709,4 +714,24 @@ type ConfigMap<M extends Partial<BaseConfigMap> = Partial<BaseConfigMap>> = Vali
     TranscodeMap: 'TranscodeMap' extends keyof M ? NonNullable<M['TranscodeMap']> : DefaultTranscodeMap;
 }>;
 
-export { type BaseConfigMap, BaseEntityClient, type BaseEntityClientOptions, BaseQueryBuilder, type BaseQueryBuilderOptions, type Config, type ConfigMap, type EntityItem, EntityManager, type EntityToken, type PageKey, type ParsedConfig, type QueryBuilderQueryOptions, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryResult, type ValidateConfigMap };
+/**
+ * Database-facing record key type from a {@link BaseConfigMap | `ConfigMap`} with required hash & range keys.
+ *
+ * @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
+ * @protected
+ */
+type EntityKey<C extends BaseConfigMap> = Record<C['HashKey'] | C['RangeKey'], string>;
+
+/**
+ * Database-facing record type from a {@link BaseConfigMap | `ConfigMap`} with required hash & range keys.
+ *
+ * @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 EntityRecord<C extends BaseConfigMap> = EntityItem<C> & EntityKey<C>;
+
+export { type BaseConfigMap, BaseEntityClient, type BaseEntityClientOptions, BaseQueryBuilder, type BaseQueryBuilderOptions, type Config, type ConfigMap, type EntityItem, type EntityKey, EntityManager, type EntityRecord, type EntityToken, type PageKey, type ParsedConfig, type QueryBuilderQueryOptions, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryResult, type ValidateConfigMap };

package/dist/mjs/BaseEntityClient.js

@@ -11,10 +11,10 @@ class BaseEntityClient {
      *
      * @param options - {@link BaseEntityClientOptions | `BaseEntityClientOptions`} object.
      */
-    constructor(entityManager, options = {}) {
-        this.entityManager = entityManager;
-        const { batchProcessOptions = {}, logger = console } = options;
+    constructor(options) {
+        const { batchProcessOptions = {}, entityManager, logger = console, } = options;
         this.batchProcessOptions = batchProcessOptions;
+        this.entityManager = entityManager;
         this.logger = logger;
     }
 }

package/package.json

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