@karmaniverous/entity-manager 6.13.2 → 6.14.0

package/dist/cjs/{EntityManager.js → EntityManager/EntityManager.js}

@@ -1,10 +1,10 @@
 'use strict';
 
 var tslib = require('tslib');
-var radash = require('radash');
 var addKeys = require('./addKeys.js');
 var encodeGeneratedProperty = require('./encodeGeneratedProperty.js');
 var findIndexToken = require('./findIndexToken.js');
+var getPrimaryKey = require('./getPrimaryKey.js');
 var ParsedConfig = require('./ParsedConfig.js');
 var query = require('./query.js');
 var removeKeys = require('./removeKeys.js');
@@ -52,59 +52,33 @@ class EntityManager {
     /**
      * Encode a generated property value. Returns a string or undefined if atomicity requirement of sharded properties not met.
      *
-     * @param property - {@link Config.generatedProperties | Generated property} key.
-     * @param item - Partial {@link ItemMap | `ItemMap`} object.
+     * @param property - {@link Config | Config} `generatedProperties` key.
+     * @param item - {@link EntityItem | `EntityItem`} object.
      *
      * @returns Encoded generated property value.
      *
-     * @throws `Error` if `property` is not a {@link Config.generatedProperties | generated property}.
+     * @throws `Error` if `property` is not a {@link Config | Config} `generatedProperties` key.
      */
     encodeGeneratedProperty(property, item) {
         return encodeGeneratedProperty.encodeGeneratedProperty(this, property, item);
     }
-    /**
-     * Update generated properties, hash key, and range key on an {@link EntityItem | `EntityItem`} object.
-     *
-     * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityItem | `EntityItem`} object.
-     * @param overwrite - Overwrite existing properties (default `false`).
-     *
-     * @returns {@link EntityRecord | `EntityRecord`} object with updated properties.
-     *
-     * @throws `Error` if `entityToken` is invalid.
-     */
-    addKeys(entityToken, item, overwrite = false) {
-        return addKeys.addKeys(this, entityToken, item, overwrite);
+    addKeys(entityToken, i, overwrite = false) {
+        if (Array.isArray(i)) {
+            return i.map((item) => addKeys.addKeys(this, entityToken, item, overwrite));
+        }
+        return addKeys.addKeys(this, entityToken, i, overwrite);
     }
-    /**
-     * Convert an {@link EntityItem | `EntityItem`} into an {@link EntityKey | `EntityKey`}.
-     *
-     * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityItem | `EntityItem`} object.
-     * @param overwrite - Overwrite existing properties (default `false`).
-     *
-     * @returns {@link EntityKey | `EntityKey`} extracted from shallow clone of `item` with updated properties.
-     *
-     * @throws `Error` if `entityToken` is invalid.
-     */
-    getPrimaryKey(entityToken, item, overwrite = false) {
-        const { hashKey, rangeKey } = this.config;
-        return radash.pick(!overwrite && item[hashKey] && item[rangeKey]
-            ? item
-            : addKeys.addKeys(this, entityToken, item, overwrite), [this.config.hashKey, this.config.rangeKey]);
+    getPrimaryKey(entityToken, i, overwrite = false) {
+        if (Array.isArray(i)) {
+            return i.map((item) => getPrimaryKey.getPrimaryKey(this, entityToken, item, overwrite));
+        }
+        return getPrimaryKey.getPrimaryKey(this, entityToken, i, overwrite);
     }
-    /**
-     * Strips generated properties, hash key, and range key from an {@link EntityRecord | `EntityRecord`} object.
-     *
-     * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityRecord | `EntityRecord`} object.
-     *
-     * @returns {@link EntityItem | `EntityItem`} with generated properties, hash key & range key removed.
-     *
-     * @throws `Error` if `entityToken` is invalid.
-     */
-    removeKeys(entityToken, item) {
-        return removeKeys.removeKeys(this, entityToken, item);
+    removeKeys(entityToken, i) {
+        if (Array.isArray(i)) {
+            return i.map((item) => removeKeys.removeKeys(this, entityToken, item));
+        }
+        return removeKeys.removeKeys(this, entityToken, i);
     }
     /**
      * Find an index token in a {@link Config | `Config`} object based on the index `hashKey` and `rangeKey`.

package/dist/cjs/{encodeElement.js → EntityManager/encodeElement.js}

@@ -9,7 +9,7 @@
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param element - The {@link Entity | `Entity`} generated property element or ungenerated index component to encode.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  *
  * @returns Encoded value.
  *

package/dist/cjs/{encodeGeneratedProperty.js → EntityManager/encodeGeneratedProperty.js}

@@ -8,7 +8,7 @@ var validateGeneratedProperty = require('./validateGeneratedProperty.js');
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param property - {@link Config.generatedProperties | Generated property} key.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  *
  * @returns Encoded generated property value.
  *

package/dist/cjs/EntityManager/getPrimaryKey.js

@@ -0,0 +1,25 @@
+'use strict';
+
+var radash = require('radash');
+var addKeys = require('./addKeys.js');
+
+/**
+ * Convert an {@link EntityItem | `EntityItem`} into an {@link EntityKey | `EntityKey`}.
+ *
+ * @param entityManager - {@link EntityManager | `EntityManager`} instance.
+ * @param entityToken - {@link Config | `Config`} `entities` key.
+ * @param item - {@link EntityItem | `EntityItem`} object.
+ * @param overwrite - Overwrite existing properties (default `false`).
+ *
+ * @returns {@link EntityKey | `EntityKey`} extracted from shallow clone of `item` with updated properties.
+ *
+ * @throws `Error` if `entityToken` is invalid.
+ */
+function getPrimaryKey(entityManager, entityToken, item, overwrite = false) {
+    const { hashKey, rangeKey } = entityManager.config;
+    return radash.pick(!overwrite && item[hashKey] && item[rangeKey]
+        ? item
+        : addKeys.addKeys(entityManager, entityToken, item, overwrite), [entityManager.config.hashKey, entityManager.config.rangeKey]);
+}
+
+exports.getPrimaryKey = getPrimaryKey;

package/dist/cjs/{updateItemHashKey.js → EntityManager/updateItemHashKey.js}

@@ -6,11 +6,11 @@ var getShardBump = require('./getShardBump.js');
 var validateEntityToken = require('./validateEntityToken.js');
 
 /**
- * Update the hash key on a partial {@link ItemMap | `ItemMap`} object.
+ * Update the hash key on an partial {@link EntityItem | `EntityItem`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param entityToken - {@link Config.entities | `this.config.entities`} key.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  * @param overwrite - Overwrite existing {@link ConfigKeys.hashKey | `this.config.hashKey`} property value (default `false`).
  *
  * @returns Shallow clone of `item` with updated hash key.

package/dist/cjs/{updateItemRangeKey.js → EntityManager/updateItemRangeKey.js}

@@ -4,11 +4,11 @@ var entityTools = require('@karmaniverous/entity-tools');
 var validateEntityToken = require('./validateEntityToken.js');
 
 /**
- * Update the range key on a partial {@link ItemMap | `ItemMap`} object.
+ * Update the range key on an {@link EntityItem | `EntityItem`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param entityToken - {@link Config.entities | `this.config.entities`} key.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  * @param overwrite - Overwrite existing {@link ConfigKeys.rangeKey | `this.config.rangeKey`} property value (default `false`).
  *
  * @returns Shallow clone of `item` with updated range key.

package/dist/cjs/index.js

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

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { EntityMap, TranscodeMap, ConditionalProperty, Exactify, PropertiesOfType, TranscodableProperties, FlattenEntityMap, Transcodes, SortOrder, MutuallyExclusive, NotNever, DefaultTranscodeMap } from '@karmaniverous/entity-tools';
-import { BatchProcessOptions } from '@karmaniverous/batch-process';
+import { EntityMap, TranscodeMap, ConditionalProperty, Exactify, PropertiesOfType, TranscodableProperties, FlattenEntityMap, Transcodes, MutuallyExclusive, NotNever, DefaultTranscodeMap, SortOrder } from '@karmaniverous/entity-tools';
 import { z } from 'zod';
+import { BatchProcessOptions } from '@karmaniverous/batch-process';
 
 /**
  * Default type parameter for {@link ConfigMap | `ConfigMap`}.
@@ -76,6 +76,47 @@ type Config<C extends BaseConfigMap = BaseConfigMap> = ConditionalProperty<'enti
     throttle?: number;
 };
 
+/**
+ * Validates a type derived from {@link BaseConfigMap | `BaseConfigMap`} to ensure HashKey and RangeKey are both defined and that all sets of special keys are mutually exclusive.
+ *
+ * @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 ValidateConfigMap<C extends BaseConfigMap> = MutuallyExclusive<[
+    C['HashKey'],
+    C['RangeKey'],
+    C['ShardedKeys'],
+    C['UnshardedKeys'],
+    keyof FlattenEntityMap<C['EntityMap']>
+]> extends true ? NotNever<C, ['HashKey' | 'RangeKey']> extends true ? C : Exclude<NotNever<C, ['HashKey' | 'RangeKey']>, true> : Exclude<MutuallyExclusive<[
+    C['HashKey'],
+    C['RangeKey'],
+    C['ShardedKeys'],
+    C['UnshardedKeys'],
+    keyof FlattenEntityMap<C['EntityMap']>
+]>, true>;
+
+/**
+ * Generates & validates the map defining defines an {@link EntityManager | `EntityManager`} configuration's {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}.
+ *
+ * Unspecified properties will default to those defined in {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @typeParam M - {@link BaseConfigMap | `BaseConfigMap`} extension. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @category EntityManager
+ */
+type ConfigMap<M extends Partial<BaseConfigMap> = Partial<BaseConfigMap>> = ValidateConfigMap<{
+    EntityMap: 'EntityMap' extends keyof M ? NonNullable<M['EntityMap']> : Record<string, never>;
+    HashKey: 'HashKey' extends keyof M ? NonNullable<M['HashKey']> : 'hashKey';
+    RangeKey: 'RangeKey' extends keyof M ? NonNullable<M['RangeKey']> : 'rangeKey';
+    ShardedKeys: 'ShardedKeys' extends keyof M ? NonNullable<M['ShardedKeys']> : never;
+    UnshardedKeys: 'UnshardedKeys' extends keyof M ? NonNullable<M['UnshardedKeys']> : never;
+    TranscodedProperties: 'TranscodedProperties' extends keyof M ? NonNullable<M['TranscodedProperties']> : never;
+    TranscodeMap: 'TranscodeMap' extends keyof M ? NonNullable<M['TranscodeMap']> : DefaultTranscodeMap;
+}>;
+
 /**
  * Extracts a database-facing partial item type from a {@link BaseConfigMap | `ConfigMap`}.
  *
@@ -238,6 +279,11 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         sharded: Record<string, [string, ...string[]]>;
         unsharded: Record<string, [string, ...string[]]>;
     };
+    propertyTranscodes: Record<string, string>;
+    transcodes: Record<string, {
+        encode: (args_0: any, ...args: unknown[]) => string;
+        decode: (args_0: string, ...args: unknown[]) => any;
+    }>;
     indexes: Record<string, {
         hashKey: string;
         rangeKey: string;
@@ -245,13 +291,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     }>;
     generatedKeyDelimiter: string;
     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;
-    }>;
 }, {
     hashKey: string;
     rangeKey: string;
@@ -270,6 +311,11 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         sharded?: Record<string, [string, ...string[]]> | undefined;
         unsharded?: Record<string, [string, ...string[]]> | undefined;
     } | undefined;
+    propertyTranscodes?: Record<string, string> | undefined;
+    transcodes?: Record<string, {
+        encode: (args_0: any, ...args: unknown[]) => string;
+        decode: (args_0: string, ...args: unknown[]) => any;
+    }> | undefined;
     indexes?: Record<string, {
         hashKey: string;
         rangeKey: string;
@@ -277,13 +323,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     }> | undefined;
     generatedKeyDelimiter?: string | undefined;
     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;
-    }> | undefined;
 }>, {
     hashKey: string;
     rangeKey: string;
@@ -302,6 +343,11 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         sharded: Record<string, [string, ...string[]]>;
         unsharded: Record<string, [string, ...string[]]>;
     };
+    propertyTranscodes: Record<string, string>;
+    transcodes: Record<string, {
+        encode: (args_0: any, ...args: unknown[]) => string;
+        decode: (args_0: string, ...args: unknown[]) => any;
+    }>;
     indexes: Record<string, {
         hashKey: string;
         rangeKey: string;
@@ -309,13 +355,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     }>;
     generatedKeyDelimiter: string;
     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;
-    }>;
 }, {
     hashKey: string;
     rangeKey: string;
@@ -334,6 +375,11 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         sharded?: Record<string, [string, ...string[]]> | undefined;
         unsharded?: Record<string, [string, ...string[]]> | undefined;
     } | undefined;
+    propertyTranscodes?: Record<string, string> | undefined;
+    transcodes?: Record<string, {
+        encode: (args_0: any, ...args: unknown[]) => string;
+        decode: (args_0: string, ...args: unknown[]) => any;
+    }> | undefined;
     indexes?: Record<string, {
         hashKey: string;
         rangeKey: string;
@@ -341,13 +387,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
     }> | undefined;
     generatedKeyDelimiter?: string | undefined;
     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;
-    }> | undefined;
 }>;
 /**
  * Simplified type taken on by a {@link Config | `Config`} object after parsing in the {@link EntityManager | `EntityManager`} constructor.
@@ -521,6 +562,7 @@ interface QueryResult<C extends BaseConfigMap> {
  */
 declare class EntityManager<C extends BaseConfigMap> {
     #private;
+    /** Logger object (defaults to `console`, must support `debug` & `error` methods). */
     readonly logger: Pick<Console, 'debug' | 'error'>;
     /**
      * Create an EntityManager instance.
@@ -544,12 +586,12 @@ declare class EntityManager<C extends BaseConfigMap> {
     /**
      * Encode a generated property value. Returns a string or undefined if atomicity requirement of sharded properties not met.
      *
-     * @param property - {@link Config.generatedProperties | Generated property} key.
-     * @param item - Partial {@link ItemMap | `ItemMap`} object.
+     * @param property - {@link Config | Config} `generatedProperties` key.
+     * @param item - {@link EntityItem | `EntityItem`} object.
      *
      * @returns Encoded generated property value.
      *
-     * @throws `Error` if `property` is not a {@link Config.generatedProperties | generated property}.
+     * @throws `Error` if `property` is not a {@link Config | Config} `generatedProperties` key.
      */
     encodeGeneratedProperty<C extends BaseConfigMap>(property: C['ShardedKeys'] | C['UnshardedKeys'], item: EntityItem<C>): string | undefined;
     /**
@@ -562,8 +604,24 @@ declare class EntityManager<C extends BaseConfigMap> {
      * @returns {@link EntityRecord | `EntityRecord`} object with updated properties.
      *
      * @throws `Error` if `entityToken` is invalid.
+     *
+     * @overload
      */
     addKeys(entityToken: EntityToken<C>, item: EntityItem<C>, overwrite?: boolean): EntityRecord<C>;
+    /**
+     * Update generated properties, hash key, and range key on an array of {@link EntityItem | `EntityItem`} objects.
+     *
+     * @param entityToken - {@link Config | `Config`} `entities` key.
+     * @param items - Array of {@link EntityItem | `EntityItem`} objects.
+     * @param overwrite - Overwrite existing properties (default `false`).
+     *
+     * @returns An array of {@link EntityRecord | `EntityRecord`} objects with updated properties.
+     *
+     * @throws `Error` if `entityToken` is invalid.
+     *
+     * @overload
+     */
+    addKeys(entityToken: EntityToken<C>, item: EntityItem<C>[], overwrite?: boolean): EntityRecord<C>[];
     /**
      * Convert an {@link EntityItem | `EntityItem`} into an {@link EntityKey | `EntityKey`}.
      *
@@ -574,8 +632,24 @@ declare class EntityManager<C extends BaseConfigMap> {
      * @returns {@link EntityKey | `EntityKey`} extracted from shallow clone of `item` with updated properties.
      *
      * @throws `Error` if `entityToken` is invalid.
+     *
+     * @overload
      */
     getPrimaryKey(entityToken: EntityToken<C>, item: EntityItem<C>, overwrite?: boolean): EntityKey<C>;
+    /**
+     * Convert an array of {@link EntityItem | `EntityItem`} objects into {@link EntityKey | `EntityKey`} objects.
+     *
+     * @param entityToken - {@link Config | `Config`} `entities` key.
+     * @param items - Array of {@link EntityItem | `EntityItem`} objects.
+     * @param overwrite - Overwrite existing properties (default `false`).
+     *
+     * @returns An array of {@link EntityKey | `EntityKey`} objects extracted from shallow clone of each `item` with updated properties.
+     *
+     * @throws `Error` if `entityToken` is invalid.
+     *
+     * @overload
+     */
+    getPrimaryKey(entityToken: EntityToken<C>, items: EntityItem<C>[], overwrite?: boolean): EntityKey<C>[];
     /**
      * Strips generated properties, hash key, and range key from an {@link EntityRecord | `EntityRecord`} object.
      *
@@ -585,8 +659,23 @@ declare class EntityManager<C extends BaseConfigMap> {
      * @returns {@link EntityItem | `EntityItem`} with generated properties, hash key & range key removed.
      *
      * @throws `Error` if `entityToken` is invalid.
+     *
+     * @overload
      */
     removeKeys(entityToken: EntityToken<C>, item: EntityRecord<C>): EntityItem<C>;
+    /**
+     * Strips generated properties, hash key, and range key from an array of {@link EntityRecord | `EntityRecord`} objects.
+     *
+     * @param entityToken - {@link Config | `Config`} `entities` key.
+     * @param items - Array of {@link EntityRecord | `EntityRecord`} objects.
+     *
+     * @returns Array of {@link EntityItem | `EntityItem`} objects with generated properties, hash key & range key removed.
+     *
+     * @throws `Error` if `entityToken` is invalid.
+     *
+     * @overload
+     */
+    removeKeys(entityToken: EntityToken<C>, items: EntityRecord<C>[]): EntityItem<C>[];
     /**
      * Find an index token in a {@link Config | `Config`} object based on the index `hashKey` and `rangeKey`.
      *
@@ -728,45 +817,4 @@ declare abstract class BaseQueryBuilder<C extends BaseConfigMap, EntityClient ex
     query(options: QueryBuilderQueryOptions<C>): Promise<QueryResult<C>>;
 }
 
-/**
- * Validates a type derived from {@link BaseConfigMap | `BaseConfigMap`} to ensure HashKey and RangeKey are both defined and that all sets of special keys are mutually exclusive.
- *
- * @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 ValidateConfigMap<C extends BaseConfigMap> = MutuallyExclusive<[
-    C['HashKey'],
-    C['RangeKey'],
-    C['ShardedKeys'],
-    C['UnshardedKeys'],
-    keyof FlattenEntityMap<C['EntityMap']>
-]> extends true ? NotNever<C, ['HashKey' | 'RangeKey']> extends true ? C : Exclude<NotNever<C, ['HashKey' | 'RangeKey']>, true> : Exclude<MutuallyExclusive<[
-    C['HashKey'],
-    C['RangeKey'],
-    C['ShardedKeys'],
-    C['UnshardedKeys'],
-    keyof FlattenEntityMap<C['EntityMap']>
-]>, true>;
-
-/**
- * Generates & validates the map defining defines an {@link EntityManager | `EntityManager`} configuration's {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}.
- *
- * Unspecified properties will default to those defined in {@link BaseConfigMap | `BaseConfigMap`}.
- *
- * @typeParam M - {@link BaseConfigMap | `BaseConfigMap`} extension. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
- *
- * @category EntityManager
- */
-type ConfigMap<M extends Partial<BaseConfigMap> = Partial<BaseConfigMap>> = ValidateConfigMap<{
-    EntityMap: 'EntityMap' extends keyof M ? NonNullable<M['EntityMap']> : Record<string, never>;
-    HashKey: 'HashKey' extends keyof M ? NonNullable<M['HashKey']> : 'hashKey';
-    RangeKey: 'RangeKey' extends keyof M ? NonNullable<M['RangeKey']> : 'rangeKey';
-    ShardedKeys: 'ShardedKeys' extends keyof M ? NonNullable<M['ShardedKeys']> : never;
-    UnshardedKeys: 'UnshardedKeys' extends keyof M ? NonNullable<M['UnshardedKeys']> : never;
-    TranscodedProperties: 'TranscodedProperties' extends keyof M ? NonNullable<M['TranscodedProperties']> : never;
-    TranscodeMap: 'TranscodeMap' extends keyof M ? NonNullable<M['TranscodeMap']> : DefaultTranscodeMap;
-}>;
-
-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 };
+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, configSchema };

package/dist/mjs/{EntityManager.js → EntityManager/EntityManager.js}

@@ -1,8 +1,8 @@
 import { __classPrivateFieldSet, __classPrivateFieldGet } from 'tslib';
-import { pick } from 'radash';
 import { addKeys } from './addKeys.js';
 import { encodeGeneratedProperty } from './encodeGeneratedProperty.js';
 import { findIndexToken } from './findIndexToken.js';
+import { getPrimaryKey } from './getPrimaryKey.js';
 import { configSchema } from './ParsedConfig.js';
 import { query } from './query.js';
 import { removeKeys } from './removeKeys.js';
@@ -50,59 +50,33 @@ class EntityManager {
     /**
      * Encode a generated property value. Returns a string or undefined if atomicity requirement of sharded properties not met.
      *
-     * @param property - {@link Config.generatedProperties | Generated property} key.
-     * @param item - Partial {@link ItemMap | `ItemMap`} object.
+     * @param property - {@link Config | Config} `generatedProperties` key.
+     * @param item - {@link EntityItem | `EntityItem`} object.
      *
      * @returns Encoded generated property value.
      *
-     * @throws `Error` if `property` is not a {@link Config.generatedProperties | generated property}.
+     * @throws `Error` if `property` is not a {@link Config | Config} `generatedProperties` key.
      */
     encodeGeneratedProperty(property, item) {
         return encodeGeneratedProperty(this, property, item);
     }
-    /**
-     * Update generated properties, hash key, and range key on an {@link EntityItem | `EntityItem`} object.
-     *
-     * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityItem | `EntityItem`} object.
-     * @param overwrite - Overwrite existing properties (default `false`).
-     *
-     * @returns {@link EntityRecord | `EntityRecord`} object with updated properties.
-     *
-     * @throws `Error` if `entityToken` is invalid.
-     */
-    addKeys(entityToken, item, overwrite = false) {
-        return addKeys(this, entityToken, item, overwrite);
+    addKeys(entityToken, i, overwrite = false) {
+        if (Array.isArray(i)) {
+            return i.map((item) => addKeys(this, entityToken, item, overwrite));
+        }
+        return addKeys(this, entityToken, i, overwrite);
     }
-    /**
-     * Convert an {@link EntityItem | `EntityItem`} into an {@link EntityKey | `EntityKey`}.
-     *
-     * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityItem | `EntityItem`} object.
-     * @param overwrite - Overwrite existing properties (default `false`).
-     *
-     * @returns {@link EntityKey | `EntityKey`} extracted from shallow clone of `item` with updated properties.
-     *
-     * @throws `Error` if `entityToken` is invalid.
-     */
-    getPrimaryKey(entityToken, item, overwrite = false) {
-        const { hashKey, rangeKey } = this.config;
-        return pick(!overwrite && item[hashKey] && item[rangeKey]
-            ? item
-            : addKeys(this, entityToken, item, overwrite), [this.config.hashKey, this.config.rangeKey]);
+    getPrimaryKey(entityToken, i, overwrite = false) {
+        if (Array.isArray(i)) {
+            return i.map((item) => getPrimaryKey(this, entityToken, item, overwrite));
+        }
+        return getPrimaryKey(this, entityToken, i, overwrite);
     }
-    /**
-     * Strips generated properties, hash key, and range key from an {@link EntityRecord | `EntityRecord`} object.
-     *
-     * @param entityToken - {@link Config | `Config`} `entities` key.
-     * @param item - {@link EntityRecord | `EntityRecord`} object.
-     *
-     * @returns {@link EntityItem | `EntityItem`} with generated properties, hash key & range key removed.
-     *
-     * @throws `Error` if `entityToken` is invalid.
-     */
-    removeKeys(entityToken, item) {
-        return removeKeys(this, entityToken, item);
+    removeKeys(entityToken, i) {
+        if (Array.isArray(i)) {
+            return i.map((item) => removeKeys(this, entityToken, item));
+        }
+        return removeKeys(this, entityToken, i);
     }
     /**
      * Find an index token in a {@link Config | `Config`} object based on the index `hashKey` and `rangeKey`.

package/dist/mjs/{encodeElement.js → EntityManager/encodeElement.js}

@@ -7,7 +7,7 @@
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param element - The {@link Entity | `Entity`} generated property element or ungenerated index component to encode.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  *
  * @returns Encoded value.
  *

package/dist/mjs/{encodeGeneratedProperty.js → EntityManager/encodeGeneratedProperty.js}

@@ -6,7 +6,7 @@ import { validateGeneratedProperty } from './validateGeneratedProperty.js';
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param property - {@link Config.generatedProperties | Generated property} key.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  *
  * @returns Encoded generated property value.
  *

package/dist/mjs/EntityManager/getPrimaryKey.js

@@ -0,0 +1,23 @@
+import { pick } from 'radash';
+import { addKeys } from './addKeys.js';
+
+/**
+ * Convert an {@link EntityItem | `EntityItem`} into an {@link EntityKey | `EntityKey`}.
+ *
+ * @param entityManager - {@link EntityManager | `EntityManager`} instance.
+ * @param entityToken - {@link Config | `Config`} `entities` key.
+ * @param item - {@link EntityItem | `EntityItem`} object.
+ * @param overwrite - Overwrite existing properties (default `false`).
+ *
+ * @returns {@link EntityKey | `EntityKey`} extracted from shallow clone of `item` with updated properties.
+ *
+ * @throws `Error` if `entityToken` is invalid.
+ */
+function getPrimaryKey(entityManager, entityToken, item, overwrite = false) {
+    const { hashKey, rangeKey } = entityManager.config;
+    return pick(!overwrite && item[hashKey] && item[rangeKey]
+        ? item
+        : addKeys(entityManager, entityToken, item, overwrite), [entityManager.config.hashKey, entityManager.config.rangeKey]);
+}
+
+export { getPrimaryKey };

package/dist/mjs/{updateItemHashKey.js → EntityManager/updateItemHashKey.js}

@@ -4,11 +4,11 @@ import { getShardBump } from './getShardBump.js';
 import { validateEntityToken } from './validateEntityToken.js';
 
 /**
- * Update the hash key on a partial {@link ItemMap | `ItemMap`} object.
+ * Update the hash key on an partial {@link EntityItem | `EntityItem`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param entityToken - {@link Config.entities | `this.config.entities`} key.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  * @param overwrite - Overwrite existing {@link ConfigKeys.hashKey | `this.config.hashKey`} property value (default `false`).
  *
  * @returns Shallow clone of `item` with updated hash key.

package/dist/mjs/{updateItemRangeKey.js → EntityManager/updateItemRangeKey.js}

@@ -2,11 +2,11 @@ import { isNil } from '@karmaniverous/entity-tools';
 import { validateEntityToken } from './validateEntityToken.js';
 
 /**
- * Update the range key on a partial {@link ItemMap | `ItemMap`} object.
+ * Update the range key on an {@link EntityItem | `EntityItem`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param entityToken - {@link Config.entities | `this.config.entities`} key.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  * @param overwrite - Overwrite existing {@link ConfigKeys.rangeKey | `this.config.rangeKey`} property value (default `false`).
  *
  * @returns Shallow clone of `item` with updated range key.

package/dist/mjs/index.js

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

package/package.json

@@ -5,7 +5,7 @@
   },
   "dependencies": {
     "@karmaniverous/batch-process": "^0.1.0",
-    "@karmaniverous/entity-tools": "^0.6.5",
+    "@karmaniverous/entity-tools": "^0.6.8",
     "@karmaniverous/string-utilities": "^0.2.1",
     "lz-string": "^1.5.0",
     "radash": "^12.1.0",
@@ -14,7 +14,7 @@
   },
   "description": "Rational indexing & cross-shard querying at scale in your NoSQL database so you can focus on your application logic.",
   "devDependencies": {
-    "@dotenvx/dotenvx": "^1.22.1",
+    "@dotenvx/dotenvx": "^1.23.0",
     "@eslint/js": "^9.14.0",
     "@faker-js/faker": "^9.2.0",
     "@karmaniverous/mock-db": "^0.3.4",
@@ -39,14 +39,14 @@
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-tsdoc": "^0.3.0",
     "jsdom-global": "^3.0.2",
-    "knip": "^5.36.7",
+    "knip": "^5.37.0",
     "lefthook": "^1.8.2",
     "mocha": "^10.8.2",
     "nyc": "^17.1.0",
     "prettier": "^3.3.3",
     "release-it": "^17.10.0",
     "rimraf": "^6.0.1",
-    "rollup": "^4.25.0",
+    "rollup": "^4.26.0",
     "rollup-plugin-dts": "^6.1.1",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.2",
@@ -132,5 +132,5 @@
   },
   "type": "module",
   "types": "dist/index.d.ts",
-  "version": "6.13.2"
+  "version": "6.14.0"
 }