@karmaniverous/entity-manager 6.7.5 → 6.8.1

package/README.md

@@ -8,7 +8,7 @@
 
 **EntityManager implements rational indexing & cross-shard querying at scale in your NoSQL database so you can focus on your application logic.**
 
-I've just released a full Typescript refactor. Everything works beautifully, but I'm still fleshing out [the documentation](https://karmanivero.us/projects/entity-manager/intro/).
+> The Typescript refactor is still in flux, but stabilizing! Still fleshing out the [demo](https://github.com/karmaniverous/entity-manager-demo) & [documentation](https://karmanivero.us/projects/entity-manager/intro/).
 
 If you have any questions, please [start a discussion](https://github.com/karmaniverous/entity-manager/discussions). Otherwise stay tuned!
 

package/dist/cjs/BaseEntityClient.js

@@ -9,7 +9,7 @@ class BaseEntityClient {
     /**
      * DynamoDB EntityClient constructor.
      *
-     * @param options - {@link EntityClientOptions | `EntityClientOptions`} object.
+     * @param options - {@link BaseEntityClientOptions | `BaseEntityClientOptions`} object.
      */
     constructor(options) {
         const { batchProcessOptions = {}, logger = console } = options;

package/dist/cjs/BaseQueryBuilder.js

@@ -5,7 +5,11 @@ var radash = require('radash');
 /**
  * Abstract base class supporting a fluent API for building a {@link ShardQueryMap | `ShardQueryMap`} using a database client.
  *
- * @category ShardQueryMapBuilder
+ * @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`}.
+ * @typeParam EntityClient - {@link BaseEntityClient | `BaseEntityClient`} derived class instance.
+ * @typeParam IndexParams - Database platform-specific, index-specific query parameters.
+ *
+ * @category QueryBuilder
  */
 class BaseQueryBuilder {
     /** BaseQueryBuilder constructor. */

package/dist/cjs/EntityManager.js

@@ -11,7 +11,12 @@ var _EntityManager_config;
  * The EntityManager class applies a configuration-driven sharded data model &
  * query strategy to NoSql data.
  *
- * @category Entity Manager
+ * @typeParam C - {@link ConfigMap | `ConfigMap`} that defines the configuration's {@link EntityMap | `EntityMap`}, key properties, and {@link TranscodeMap | `TranscodeMap`}. If omitted, defaults to {@link BaseConfigMap | `BaseConfigMap`}.
+ *
+ * @remarks
+ * While the {@link EntityManager.query | `query`} method is `public`, normally it should not be called directly. The `query` method is used by a platform-specific {@link BaseQueryBuilder.query | `QueryBuilder.query`} method to provide a fluent query API.
+ *
+ * @category EntityManager
  */
 class EntityManager {
     /**
@@ -42,10 +47,10 @@ class EntityManager {
         tslib.__classPrivateFieldSet(this, _EntityManager_config, ParsedConfig.configSchema.parse(value), "f");
     }
     /**
-     * Update generated properties, hash key, and range key on an {@link ItemMap | `ItemMap`} object.
+     * Update generated properties, hash key, and range key on an {@link EntityItem | `EntityItem`} object.
      *
-     * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
-     * @param item - {@link ItemMap | `ItemMap`} object.
+     * @param entityToken - {@link Config | `Config`} `entities` key.
+     * @param item - {@link EntityItem | `EntityItem`} object.
      * @param overwrite - Overwrite existing properties (default `false`).
      *
      * @returns Shallow clone of `item` with updated properties.
@@ -56,10 +61,10 @@ class EntityManager {
         return addKeys.addKeys(this, entityToken, item, overwrite);
     }
     /**
-     * Strips generated properties, hash key, and range key from an {@link ItemMap | `ItemMap`} object.
+     * Strips generated properties, hash key, and range key from an {@link EntityItem | `EntityItem`} object.
      *
-     * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
-     * @param item - {@link ItemMap | `ItemMap`} object.
+     * @param entityToken - {@link Config | `Config`} `entities` key.
+     * @param item - {@link EntityItem | `EntityItem`} object.
      *
      * @returns Shallow clone of `item` without generated properties, hash key or range key.
      *
@@ -74,17 +79,21 @@ class EntityManager {
      * @remarks
      * The provided `shardQueryMap` performs the actual query of individual data pages on individual index/shard combinations.
      *
-     * Individual shard query results will be combined, deduped by {@link ConfigEntity.uniqueProperty} property value, and sorted by {@link QueryOptions.sortOrder | `sortOrder`}.
+     * Individual shard query results will be combined, deduped by {@link Config | `Config`} `uniqueProperty` value, and sorted by {@link QueryOptions.sortOrder | `sortOrder`}.
      *
      * In queries on sharded data, expect the leading and trailing edges of returned data pages to interleave somewhat with preceding & following pages.
      *
      * Unsharded query results should sort & page as expected.
      *
+     * **Normally this method should not be called directly!** It is used by a platform-specific {@link BaseQueryBuilder.query | `QueryBuilder.query`} method to provide a fluent query API.
+     *
      * @param options - {@link QueryOptions | `QueryOptions`} object.
      *
      * @returns {@link QueryResult} object.
      *
-     * @throws Error if {@link QueryOptions.shardQueryMapBuilder | `shardQueryMapBuilder`} `pageKeyMap` keys do not match its `shardQueryMap` keys.
+     * @throws Error if `options` {@link QueryOptions.pageKeyMap | `pageKeyMap`} `pageKeyMap` keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
+     *
+     * @protected
      */
     async query(options) {
         return await query.query(this, options);

package/dist/cjs/ParsedConfig.js

@@ -11,16 +11,18 @@ const validateArrayUnique = (arr, ctx, identity = (item) => item, path = []) =>
         if (count > 1)
             ctx.addIssue({
                 code: zod.z.ZodIssueCode.custom,
-                message: `duplicate array element '${element}'`,
+                message: `duplicate array element`,
+                params: { element },
                 path,
             });
     }
 };
-const validateKeyExclusive = (key, label, ref, ctx) => {
-    if (ref.includes(key))
+const validateKeysExclusive = (keys, label, ref, ctx) => {
+    const intersection = keys.filter((key) => ref.includes(key));
+    if (intersection.length)
         ctx.addIssue({
             code: zod.z.ZodIssueCode.custom,
-            message: `${label} '${key}' is not exclusive`,
+            message: `${label} key collision: ${intersection.toString()}`,
         });
 };
 const componentArray = zod.z
@@ -46,25 +48,6 @@ const configSchema = zod.z
             .safe()
             .optional()
             .default(10),
-        generated: zod.z
-            .record(zod.z
-            .object({
-            atomic: zod.z.boolean().optional().default(false),
-            elements: componentArray,
-            sharded: zod.z.boolean().optional().default(false),
-        })
-            .optional())
-            .optional()
-            .default({}),
-        elementTranscodes: zod.z.record(zod.z.string()).optional().default({}),
-        indexes: zod.z
-            .record(zod.z.object({
-            hashKey: zod.z.string().min(1),
-            rangeKey: zod.z.string().min(1),
-            projections: componentArray.optional(),
-        }))
-            .optional()
-            .default({}),
         shardBumps: zod.z
             .array(zod.z
             .object({
@@ -105,21 +88,30 @@ const configSchema = zod.z
         timestampProperty: zod.z.string().min(1),
         uniqueProperty: zod.z.string().min(1),
     })
-        .strict()
-        .superRefine((data, ctx) => {
-        const generatedKeys = Object.keys(data.generated);
-        // validate timestampProperty is not a generated key.
-        validateKeyExclusive(data.timestampProperty, 'timestampProperty', generatedKeys, ctx);
-        // validate uniqueProperty is not a generated key.
-        validateKeyExclusive(data.uniqueProperty, 'uniqueProperty', generatedKeys, ctx);
+        .strict())
+        .optional()
+        .default({}),
+    generatedProperties: zod.z
+        .object({
+        sharded: zod.z.record(componentArray).optional().default({}),
+        unsharded: zod.z.record(componentArray).optional().default({}),
+    })
+        .optional()
+        .default({ sharded: {}, unsharded: {} }),
+    hashKey: zod.z.string(),
+    indexes: zod.z
+        .record(zod.z.object({
+        hashKey: zod.z.string().min(1),
+        rangeKey: zod.z.string().min(1),
+        projections: componentArray.optional(),
     }))
         .optional()
         .default({}),
     generatedKeyDelimiter: zod.z.string().regex(/\W+/).optional().default('|'),
     generatedValueDelimiter: zod.z.string().regex(/\W+/).optional().default('#'),
+    propertyTranscodes: zod.z.record(zod.z.string()).optional().default({}),
+    rangeKey: zod.z.string(),
     shardKeyDelimiter: zod.z.string().regex(/\W+/).optional().default('!'),
-    hashKey: zod.z.string().optional().default('hashKey'),
-    rangeKey: zod.z.string().optional().default('rangeKey'),
     throttle: zod.z.number().int().positive().safe().optional().default(10),
     transcodes: zod.z
         .record(zod.z
@@ -138,12 +130,20 @@ const configSchema = zod.z
         ctx.addIssue({
             code: zod.z.ZodIssueCode.custom,
             message: 'generatedKeyDelimiter contains generatedValueDelimiter',
+            params: {
+                generatedKeyDelimiter: data.generatedKeyDelimiter,
+                generatedValueDelimiter: data.generatedValueDelimiter,
+            },
             path: ['generatedKeyDelimiter'],
         });
     if (data.generatedKeyDelimiter.includes(data.shardKeyDelimiter))
         ctx.addIssue({
             code: zod.z.ZodIssueCode.custom,
             message: 'generatedKeyDelimiter contains shardKeyDelimiter',
+            params: {
+                generatedKeyDelimiter: data.generatedKeyDelimiter,
+                shardKeyDelimiter: data.shardKeyDelimiter,
+            },
             path: ['generatedKeyDelimiter'],
         });
     // validate no generated value delimiter collision
@@ -151,12 +151,20 @@ const configSchema = zod.z
         ctx.addIssue({
             code: zod.z.ZodIssueCode.custom,
             message: 'generatedValueDelimiter contains generatedKeyDelimiter',
+            params: {
+                generatedValueDelimiter: data.generatedValueDelimiter,
+                generatedKeyDelimiter: data.generatedKeyDelimiter,
+            },
             path: ['generatedValueDelimiter'],
         });
     if (data.generatedValueDelimiter.includes(data.shardKeyDelimiter))
         ctx.addIssue({
             code: zod.z.ZodIssueCode.custom,
             message: 'generatedValueDelimiter contains shardKeyDelimiter',
+            params: {
+                generatedValueDelimiter: data.generatedValueDelimiter,
+                shardKeyDelimiter: data.shardKeyDelimiter,
+            },
             path: ['generatedValueDelimiter'],
         });
     // validate no shard key delimiter collision
@@ -164,103 +172,125 @@ const configSchema = zod.z
         ctx.addIssue({
             code: zod.z.ZodIssueCode.custom,
             message: 'shardKeyDelimiter contains generatedKeyDelimiter',
+            params: {
+                generatedKeyDelimiter: data.generatedKeyDelimiter,
+                shardKeyDelimiter: data.shardKeyDelimiter,
+            },
             path: ['shardKeyDelimiter'],
         });
     if (data.shardKeyDelimiter.includes(data.generatedValueDelimiter))
         ctx.addIssue({
             code: zod.z.ZodIssueCode.custom,
             message: 'shardKeyDelimiter contains generatedValueDelimiter',
+            params: {
+                generatedValueDelimiter: data.generatedValueDelimiter,
+                shardKeyDelimiter: data.shardKeyDelimiter,
+            },
             path: ['shardKeyDelimiter'],
         });
-    const reservedKeys = Object.values(data.entities).reduce((reserved, { generated, timestampProperty, uniqueProperty }) => new Set([
-        ...reserved,
-        ...Object.keys(generated),
-        timestampProperty,
-        uniqueProperty,
-    ]), new Set());
-    // validate hashKey is not a reserved key.
-    validateKeyExclusive(data.hashKey, 'hashKey', [...reservedKeys, data.rangeKey], ctx);
-    // validate rangeKey is not a reserved key.
-    validateKeyExclusive(data.rangeKey, 'rangeKey', [...reservedKeys, data.hashKey], ctx);
-    // validate entities
+    // get reserved keys
+    const shardedKeys = Object.keys(data.generatedProperties.sharded);
+    const unshardedKeys = Object.keys(data.generatedProperties.unsharded);
+    const transcodedProperties = Object.keys(data.propertyTranscodes);
+    // validate hashKey exclusive.
+    validateKeysExclusive([data.hashKey], 'hashKey', [
+        data.rangeKey,
+        ...shardedKeys,
+        ...unshardedKeys,
+        ...transcodedProperties,
+    ], ctx);
+    // validate rangeKey exclusive.
+    validateKeysExclusive([data.rangeKey], 'rangeKey', [...shardedKeys, ...unshardedKeys, ...transcodedProperties], ctx);
+    // validate shardedKeys exclusive.
+    validateKeysExclusive(shardedKeys, 'shardedKeys', [...unshardedKeys, ...transcodedProperties], ctx);
+    // validate unshardedKeys exclusive.
+    validateKeysExclusive(unshardedKeys, 'unshardedKeys', transcodedProperties, ctx);
+    // validate all propertyTranscode values are transcode keys.
     const transcodes = Object.keys(data.transcodes);
-    for (const [entityToken, entity] of Object.entries(data.entities)) {
-        // validate all entity generated element type values are transcode keys.
-        for (const [element, generatedElementType] of Object.entries(entity.elementTranscodes))
-            if (!transcodes.includes(generatedElementType))
+    for (const [property, transcode] of Object.entries(data.propertyTranscodes))
+        if (!transcodes.includes(transcode))
+            ctx.addIssue({
+                code: zod.z.ZodIssueCode.invalid_enum_value,
+                options: transcodes,
+                path: ['propertyTranscodes', property],
+                received: transcode,
+            });
+    // Validate all sharded property elements are transcoded properties.
+    for (const [property, elements] of Object.entries(data.generatedProperties.sharded))
+        for (const element of elements)
+            if (!transcodedProperties.includes(element))
                 ctx.addIssue({
                     code: zod.z.ZodIssueCode.invalid_enum_value,
-                    options: transcodes,
-                    path: ['entities', entityToken, 'elementTranscodes', element],
-                    received: generatedElementType,
-                });
-        // validate all entity generated property elements have a corresponding entity element type.
-        const typedElements = Object.keys(entity.elementTranscodes);
-        for (const [generatedKey, generated] of Object.entries(entity.generated))
-            for (const element of generated?.elements ?? [])
-                if (!typedElements.includes(element))
-                    ctx.addIssue({
-                        code: zod.z.ZodIssueCode.invalid_enum_value,
-                        options: typedElements,
-                        path: [
-                            'entities',
-                            entityToken,
-                            'generated',
-                            generatedKey,
-                            'elements',
-                        ],
-                        received: element,
-                    });
-        // validate indexes.
-        const generatedProperties = Object.keys(entity.generated);
-        for (const [indexKey, { hashKey, rangeKey, projections },] of Object.entries(entity.indexes)) {
-            // validate index hash key is sharded
-            if (hashKey !== data.hashKey && !entity.generated[hashKey]?.sharded)
-                ctx.addIssue({
-                    code: zod.z.ZodIssueCode.custom,
-                    message: 'index hash key is not sharded',
-                    path: ['entities', entityToken, 'indexes', indexKey, 'hashKey'],
+                    options: transcodedProperties,
+                    received: element,
+                    path: ['generatedProperties', 'sharded', property],
                 });
-            // validate index range key is unsharded
-            if (rangeKey !== data.rangeKey && entity.generated[rangeKey]?.sharded)
+    // Validate all unsharded property elements are transcoded properties.
+    for (const [property, elements] of Object.entries(data.generatedProperties.unsharded))
+        for (const element of elements)
+            if (!transcodedProperties.includes(element))
                 ctx.addIssue({
-                    code: zod.z.ZodIssueCode.custom,
-                    message: 'index range key is sharded',
-                    path: ['entities', entityToken, 'indexes', indexKey, 'rangeKey'],
+                    code: zod.z.ZodIssueCode.invalid_enum_value,
+                    options: transcodedProperties,
+                    received: element,
+                    path: ['generatedProperties', 'unsharded', property],
                 });
-            // validate all ungenerated entity index components have a corresponding entity element type
-            for (const component of [hashKey, rangeKey])
-                if (![data.hashKey, data.rangeKey, ...generatedProperties].includes(component) &&
-                    !typedElements.includes(component))
+    // Validate indexes.
+    for (const [indexKey, { hashKey, rangeKey, projections }] of Object.entries(data.indexes)) {
+        // Validate hash key is sharded.
+        if (![data.hashKey, ...shardedKeys].includes(hashKey)) {
+            ctx.addIssue({
+                code: zod.z.ZodIssueCode.invalid_enum_value,
+                options: [data.hashKey, ...shardedKeys],
+                path: ['indexes', indexKey, 'hashKey'],
+                received: hashKey,
+            });
+        }
+        // Validate range key is unsharded or transcodable.
+        if (![data.rangeKey, ...unshardedKeys, ...transcodedProperties].includes(rangeKey)) {
+            ctx.addIssue({
+                code: zod.z.ZodIssueCode.invalid_enum_value,
+                options: [data.rangeKey, ...unshardedKeys],
+                path: ['indexes', indexKey, 'rangeKey'],
+                received: rangeKey,
+            });
+        }
+        // Validate no index projections are keys.
+        if (projections)
+            for (const projection of projections)
+                if ([
+                    data.hashKey,
+                    data.rangeKey,
+                    hashKey,
+                    rangeKey,
+                    ...shardedKeys,
+                    ...unshardedKeys,
+                ].includes(projection))
                     ctx.addIssue({
-                        code: zod.z.ZodIssueCode.invalid_enum_value,
-                        options: typedElements,
-                        path: [
-                            'entities',
-                            entityToken,
-                            'indexes',
-                            indexKey,
-                            'components',
-                        ],
-                        received: component,
+                        code: zod.z.ZodIssueCode.custom,
+                        message: 'index projection is a key',
+                        params: { projection },
+                        path: ['indexes', indexKey, 'projections'],
                     });
-            // validate no index projections are index components, hashKey, or rangeKey
-            if (projections)
-                for (const projection of projections) {
-                    if ([data.hashKey, data.rangeKey, hashKey, rangeKey].includes(projection))
-                        ctx.addIssue({
-                            code: zod.z.ZodIssueCode.custom,
-                            message: 'index projection is an index component, hash key, or range key',
-                            path: [
-                                'entities',
-                                entityToken,
-                                'indexes',
-                                indexKey,
-                                'projections',
-                            ],
-                        });
-                }
-        }
+    }
+    // validate entities
+    for (const [entityToken, { timestampProperty, uniqueProperty },] of Object.entries(data.entities)) {
+        // validate timestampProperty is a transcoded property.
+        if (!transcodedProperties.includes(timestampProperty))
+            ctx.addIssue({
+                code: zod.z.ZodIssueCode.invalid_enum_value,
+                options: transcodedProperties,
+                path: ['entities', entityToken, 'timestampProperty'],
+                received: timestampProperty,
+            });
+        // validate uniqueProperty is a transcoded property.
+        if (!transcodedProperties.includes(uniqueProperty))
+            ctx.addIssue({
+                code: zod.z.ZodIssueCode.invalid_enum_value,
+                options: transcodedProperties,
+                path: ['entities', entityToken, 'uniqueProperty'],
+                received: uniqueProperty,
+            });
     }
 });
 

package/dist/cjs/addKeys.js

@@ -7,11 +7,11 @@ var updateItemRangeKey = require('./updateItemRangeKey.js');
 var validateEntityToken = require('./validateEntityToken.js');
 
 /**
- * Update generated properties, hash key, and range key on an {@link ItemMap | `ItemMap`} object.
+ * Update generated properties, hash key, and range key on an {@link EntityItem | `EntityItem`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
- * @param item - {@link ItemMap | `ItemMap`} object.
+ * @param entityToken - {@link ConfigEntity.uniqueProperty | `this.config.entities`} key.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  * @param overwrite - Overwrite existing properties (default `false`).
  *
  * @returns Shallow clone of `item` with updated properties.
@@ -27,10 +27,10 @@ function addKeys(entityManager, entityToken, item, overwrite = false) {
         // Update range key.
         newItem = updateItemRangeKey.updateItemRangeKey(entityManager, entityToken, newItem, overwrite);
         // Update generated properties.
-        for (const property in entityManager.config.entities[entityToken]
-            .generated) {
+        const { sharded, unsharded } = entityManager.config.generatedProperties;
+        for (const property in { ...sharded, ...unsharded }) {
             if (overwrite || entityTools.isNil(item[property])) {
-                const encoded = encodeGeneratedProperty.encodeGeneratedProperty(entityManager, entityToken, property, newItem);
+                const encoded = encodeGeneratedProperty.encodeGeneratedProperty(entityManager, property, newItem);
                 if (encoded)
                     Object.assign(newItem, { [property]: encoded });
                 else

package/dist/{mjs/decodeEntityElement.js → cjs/decodeElement.js}

@@ -1,14 +1,15 @@
-import { validateEntityToken } from './validateEntityToken.js';
+'use strict';
+
+var validateTranscodedProperty = require('./validateTranscodedProperty.js');
 
 /**
- * Decode an {@link Entity | `Entity`} generated property element or ungenerated index component using the associated {@link Transcodes | Transcodes} `encode` function.
+ * Decode an {@link EntityItem | `EntityItem`} generated property element or ungenerated index component using the associated {@link Transcodes | Transcodes} `encode` function.
  *
  * Returns all `undefined` values.
  *
  * If `element` is the {@link Config.hashKey | `hashKey`} or {@link Config.rangeKey | `rangeKey`}, returns the value as-is.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param entityToken - {@link ConfigKeys.entities | `entityManager.config.entities`} key.
  * @param element - The {@link Entity | `Entity`} generated property element or ungenerated index component to encode.
  * @param value - Encoded entity element.
  *
@@ -16,17 +17,15 @@ import { validateEntityToken } from './validateEntityToken.js';
  *
  * @throws `Error` if `entityToken` is invalid.
  */
-function decodeEntityElement(entityManager, entityToken, element, value) {
+function decodeElement(entityManager, element, value) {
     try {
-        validateEntityToken(entityManager, entityToken);
-        const { entities, hashKey, rangeKey, transcodes } = entityManager.config;
+        // Validate params.
+        validateTranscodedProperty.validateTranscodedProperty(entityManager, element);
         if (!value)
             return;
-        if ([hashKey, rangeKey].includes(element))
-            return value;
-        const decoded = transcodes[entities[entityToken].elementTranscodes[element]].decode(value);
+        const { propertyTranscodes, transcodes } = entityManager.config;
+        const decoded = transcodes[propertyTranscodes[element]].decode(value);
         entityManager.logger.debug('decoded entity element', {
-            entityToken,
             element,
             value,
             decoded,
@@ -36,7 +35,6 @@ function decodeEntityElement(entityManager, entityToken, element, value) {
     catch (error) {
         if (error instanceof Error)
             entityManager.logger.error(error.message, {
-                entityToken,
                 element,
                 value,
             });
@@ -44,4 +42,4 @@ function decodeEntityElement(entityManager, entityToken, element, value) {
     }
 }
 
-export { decodeEntityElement };
+exports.decodeElement = decodeElement;

package/dist/cjs/decodeGeneratedProperty.js

@@ -1,25 +1,22 @@
 'use strict';
 
 var radash = require('radash');
-var decodeEntityElement = require('./decodeEntityElement.js');
-var validateEntityToken = require('./validateEntityToken.js');
+var decodeElement = require('./decodeElement.js');
 
 /**
- * Decode a generated property value. Returns a partial ItemMap.
+ * Decode a generated property value. Returns an {@link EntityItem | `EntityItem`}.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
  * @param entityToken - `entityManager.config.entities` key.
  * @param encoded - Encoded generated property value.
  *
- * @returns Partial {@link ItemMap | `ItemMap`} object with updated properties decoded from `encoded`.
+ * @returns {@link EntityItem | `EntityItem`} object with updated properties decoded from `encoded`.
  *
  * @throws `Error` if `entityToken` is invalid.
  */
-function decodeGeneratedProperty(entityManager, entityToken, encoded) {
+function decodeGeneratedProperty(entityManager, encoded) {
     try {
         const { generatedKeyDelimiter, generatedValueDelimiter, hashKey, shardKeyDelimiter, } = entityManager.config;
-        // Validate params.
-        validateEntityToken.validateEntityToken(entityManager, entityToken);
         // Handle degenerate case.
         if (!encoded)
             return {};
@@ -37,9 +34,8 @@ function decodeGeneratedProperty(entityManager, entityToken, encoded) {
             return pair;
         });
         // Assign decoded properties.
-        Object.assign(decoded, radash.objectify(values, ([key]) => key, ([key, value]) => decodeEntityElement.decodeEntityElement(entityManager, entityToken, key, value)));
+        Object.assign(decoded, radash.objectify(values, ([key]) => key, ([key, value]) => decodeElement.decodeElement(entityManager, key, value)));
         entityManager.logger.debug('decoded generated property', {
-            entityToken,
             encoded,
             decoded,
         });
@@ -47,7 +43,7 @@ function decodeGeneratedProperty(entityManager, entityToken, encoded) {
     }
     catch (error) {
         if (error instanceof Error)
-            entityManager.logger.error(error.message, { entityToken, encoded });
+            entityManager.logger.error(error.message, { encoded });
         throw error;
     }
 }

package/dist/cjs/dehydrateIndexItem.js

@@ -1,11 +1,12 @@
 'use strict';
 
-var encodeEntityElement = require('./encodeEntityElement.js');
+var encodeElement = require('./encodeElement.js');
 var unwrapIndex = require('./unwrapIndex.js');
-var validateEntityIndexToken = require('./validateEntityIndexToken.js');
+var validateEntityToken = require('./validateEntityToken.js');
+var validateIndexToken = require('./validateIndexToken.js');
 
 /**
- * Condense a partial {@link ItemMap | `ItemMap`} object into a delimited string representing the deduped, sorted, ungenerated component elements of an {@link ConfigEntity.indexes | Entity index}.
+ * Condense an {@link EntityItem | `EntityItem`} into a delimited string representing the deduped, sorted, ungenerated component elements of an {@link Config.indexes | index}, leaving out those of the index hash key.
  *
  * @remarks
  * Reverses {@link EntityManager.rehydrateIndexItem | `rehydrateIndexItem`}.
@@ -18,31 +19,31 @@ var validateEntityIndexToken = require('./validateEntityIndexToken.js');
  * `item` must be populated with all required index component elements!
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param entityToken - {@link ConfigKeys.entities | `entityManager.config.entities`} key.
- * @param indexToken - {@link ConfigEntity.indexes | `entityManager.config.entities.<entityToken>.indexes`} key.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
+ * @param entityToken - {@link Config.entities | `entityManager.config.entities`} key.
+ * @param indexToken - {@link ConfigEntity.indexes | `entityManager.config.indexes`} key.
+ * @param item - {@link EntityItem | `EntityItem`} object.
  *
  * @returns Dehydrated index value.
  *
- * @throws `Error` if `entityToken` is invalid.
  * @throws `Error` if `indexToken` is invalid.
  */
 function dehydrateIndexItem(entityManager, entityToken, indexToken, item) {
     try {
-        const { generatedKeyDelimiter } = entityManager.config;
         // Validate params.
-        validateEntityIndexToken.validateEntityIndexToken(entityManager, entityToken, indexToken);
+        validateEntityToken.validateEntityToken(entityManager, entityToken);
+        validateIndexToken.validateIndexToken(entityManager, indexToken);
         // Handle degenerate case.
         if (!item)
             return '';
         // Unwrap index elements.
-        const { hashKey } = entityManager.config.entities[entityToken].indexes[indexToken];
+        const { hashKey } = entityManager.config.indexes[indexToken];
         const elements = unwrapIndex.unwrapIndex(entityManager, entityToken, indexToken, [
             hashKey,
         ]);
         // Join index element values.
+        const { generatedKeyDelimiter } = entityManager.config;
         const dehydrated = elements
-            .map((element) => encodeEntityElement.encodeEntityElement(entityManager, entityToken, element, item))
+            .map((element) => encodeElement.encodeElement(entityManager, element, item))
             .join(generatedKeyDelimiter);
         entityManager.logger.debug('dehydrated index', {
             item,