@karmaniverous/entity-manager 6.5.0 → 6.6.0

package/dist/index.d.ts

@@ -81,7 +81,7 @@ interface ShardBump {
     chars: number;
 }
 /**
- * Returns a Config entity index components type.
+ * Returns a Config entity index component type.
  *
  * @typeParam EntityToken - The {@link Entity | `Entity`} token.
  * @typeParam M - The {@link EntityMap | `EntityMap`}.
@@ -92,7 +92,7 @@ interface ShardBump {
  * @category Config
  * @protected
  */
-type ConfigEntityIndexComponents<EntityToken extends keyof Exactify<M>, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> = (TranscodableProperties<M[EntityToken], T> | PropertiesOfType<M[EntityToken], never> | HashKey | RangeKey)[];
+type ConfigEntityIndexComponent<EntityToken extends keyof Exactify<M>, M extends EntityMap, HashKey extends string, RangeKey extends string, T extends TranscodeMap> = TranscodableProperties<M[EntityToken], T> | PropertiesOfType<M[EntityToken], never> | HashKey | RangeKey;
 /**
  * Returns a Config entity type.
  *
@@ -184,12 +184,13 @@ type ConfigEntity<EntityToken extends keyof Exactify<M>, M extends EntityMap, Ha
     /**
      * Indexes defined for the {@link Entity | `Entity`}. Should reflect the underlying database table indexes.
      *
-     * Each key is the name of an index, and each value is a non-empty array of {@link Entity | `Entity`} property names that define the index.
+     * Each key is the name of an index, and each value defines the hash key, range key, and projected properties of the index.
      *
-     * Related property types must be align with the {@link Config | `Config`} `T` type parameter. Note tha all {@link ConfigEntityGenerated | generated property} types are transcodable by definition.
+     * hashKey and rangeKey types must align with the {@link Config | `Config`} `T` type parameter. Note that all {@link ConfigEntityGenerated | generated property} types are transcodable by definition.
      */
     indexes?: Record<string, {
-        components: ConfigEntityIndexComponents<EntityToken, M, HashKey, RangeKey, T>;
+        hashKey: ConfigEntityIndexComponent<EntityToken, M, HashKey, RangeKey, T>;
+        rangeKey: ConfigEntityIndexComponent<EntityToken, M, HashKey, RangeKey, T>;
         projections?: (keyof M[EntityToken])[];
     }>;
     /**
@@ -394,13 +395,16 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         }>>>>>;
         elementTranscodes: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
         indexes: z.ZodDefault<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-            components: z.ZodEffects<z.ZodArray<z.ZodString, "atleastone">, [string, ...string[]], [string, ...string[]]>;
+            hashKey: z.ZodString;
+            rangeKey: z.ZodString;
             projections: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodString, "atleastone">, [string, ...string[]], [string, ...string[]]>>;
         }, "strip", z.ZodTypeAny, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }>>>>;
         shardBumps: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -447,7 +451,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         defaultPageSize: number;
         elementTranscodes: Record<string, string>;
         indexes: Record<string, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }>;
         shardBumps: {
@@ -469,7 +474,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         defaultPageSize?: number | undefined;
         elementTranscodes?: Record<string, string> | undefined;
         indexes?: Record<string, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }> | undefined;
         shardBumps?: {
@@ -487,7 +493,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         defaultPageSize: number;
         elementTranscodes: Record<string, string>;
         indexes: Record<string, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }>;
         shardBumps: {
@@ -509,7 +516,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         defaultPageSize?: number | undefined;
         elementTranscodes?: Record<string, string> | undefined;
         indexes?: Record<string, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }> | undefined;
         shardBumps?: {
@@ -547,7 +555,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         defaultPageSize: number;
         elementTranscodes: Record<string, string>;
         indexes: Record<string, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }>;
         shardBumps: {
@@ -581,7 +590,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         defaultPageSize?: number | undefined;
         elementTranscodes?: Record<string, string> | undefined;
         indexes?: Record<string, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }> | undefined;
         shardBumps?: {
@@ -611,7 +621,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         defaultPageSize: number;
         elementTranscodes: Record<string, string>;
         indexes: Record<string, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }>;
         shardBumps: {
@@ -645,7 +656,8 @@ declare const configSchema: z.ZodEffects<z.ZodObject<{
         defaultPageSize?: number | undefined;
         elementTranscodes?: Record<string, string> | undefined;
         indexes?: Record<string, {
-            components: [string, ...string[]];
+            hashKey: string;
+            rangeKey: string;
             projections?: [string, ...string[]] | undefined;
         }> | undefined;
         shardBumps?: {
@@ -836,26 +848,26 @@ declare class EntityManager<M extends EntityMap, HashKey extends string, RangeKe
     /**
      * Update generated properties, hash key, and range key on an {@link ItemMap | `ItemMap`} object.
      *
-     * @param item - {@link ItemMap | `ItemMap`} object.
      * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
+     * @param item - {@link ItemMap | `ItemMap`} object.
      * @param overwrite - Overwrite existing properties (default `false`).
      *
      * @returns Shallow clone of `item` with updated properties.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
-    addKeys<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(item: Partial<Item>, entityToken: EntityToken, overwrite?: boolean): Partial<Item>;
+    addKeys<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(entityToken: EntityToken, item: Partial<Item>, overwrite?: boolean): Partial<Item>;
     /**
      * Strips generated properties, hash key, and range key from an {@link ItemMap | `ItemMap`} object.
      *
-     * @param item - {@link ItemMap | `ItemMap`} object.
      * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
+     * @param item - {@link ItemMap | `ItemMap`} object.
      *
      * @returns Shallow clone of `item` without generated properties, hash key or range key.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
-    removeKeys<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(item: Partial<Item>, entityToken: EntityToken): Partial<Item>;
+    removeKeys<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(entityToken: EntityToken, item: Partial<Item>): Partial<Item>;
     /**
      * Query a database entity across shards in a provider-generic fashion.
      *
@@ -877,4 +889,4 @@ declare class EntityManager<M extends EntityMap, HashKey extends string, RangeKe
     query<Item extends ItemMap<M, HashKey, RangeKey>[EntityToken], EntityToken extends keyof Exactify<M> & string>(options: QueryOptions<Item, EntityToken, M, HashKey, RangeKey>): Promise<QueryResult<Item, EntityToken, M, HashKey, RangeKey>>;
 }
 
-export { type Config, type ConfigEntities, type ConfigEntity, type ConfigEntityGenerated, type ConfigEntityIndexComponents, type ConfigKeys, type ConfigTranscodes, EntityManager, type EntityMap, type ExclusiveKey, type ItemMap, type ParsedConfig, type QueryOptions, type QueryResult, type ShardBump, type ShardQueryFunction, type ShardQueryMap, type ShardQueryResult, type Unwrap, conditionalize };
+export { 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 ShardQueryResult, type Unwrap, conditionalize };

package/dist/mjs/EntityManager.js

@@ -42,29 +42,29 @@ class EntityManager {
     /**
      * Update generated properties, hash key, and range key on an {@link ItemMap | `ItemMap`} object.
      *
-     * @param item - {@link ItemMap | `ItemMap`} object.
      * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
+     * @param item - {@link ItemMap | `ItemMap`} object.
      * @param overwrite - Overwrite existing properties (default `false`).
      *
      * @returns Shallow clone of `item` with updated properties.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
-    addKeys(item, entityToken, overwrite = false) {
-        return addKeys(this, item, entityToken, overwrite);
+    addKeys(entityToken, item, overwrite = false) {
+        return addKeys(this, entityToken, item, overwrite);
     }
     /**
      * Strips generated properties, hash key, and range key from an {@link ItemMap | `ItemMap`} object.
      *
-     * @param item - {@link ItemMap | `ItemMap`} object.
      * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
+     * @param item - {@link ItemMap | `ItemMap`} object.
      *
      * @returns Shallow clone of `item` without generated properties, hash key or range key.
      *
      * @throws `Error` if `entityToken` is invalid.
      */
-    removeKeys(item, entityToken) {
-        return removeKeys(this, item, entityToken);
+    removeKeys(entityToken, item) {
+        return removeKeys(this, entityToken, item);
     }
     /**
      * Query a database entity across shards in a provider-generic fashion.

package/dist/mjs/ParsedConfig.js

@@ -57,7 +57,8 @@ const configSchema = z
         elementTranscodes: z.record(z.string()).optional().default({}),
         indexes: z
             .record(z.object({
-            components: componentArray,
+            hashKey: z.string().min(1),
+            rangeKey: z.string().min(1),
             projections: componentArray.optional(),
         }))
             .optional()
@@ -210,9 +211,23 @@ const configSchema = z
                     });
         // validate indexes.
         const generatedProperties = Object.keys(entity.generated);
-        for (const [indexKey, index] of Object.entries(entity.indexes)) {
+        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: z.ZodIssueCode.custom,
+                    message: 'index hash key is not sharded',
+                    path: ['entities', entityToken, 'indexes', indexKey, 'hashKey'],
+                });
+            // validate index range key is unsharded
+            if (rangeKey !== data.rangeKey && entity.generated[rangeKey]?.sharded)
+                ctx.addIssue({
+                    code: z.ZodIssueCode.custom,
+                    message: 'index range key is sharded',
+                    path: ['entities', entityToken, 'indexes', indexKey, 'rangeKey'],
+                });
             // validate all ungenerated entity index components have a corresponding entity element type
-            for (const component of index.components)
+            for (const component of [hashKey, rangeKey])
                 if (![data.hashKey, data.rangeKey, ...generatedProperties].includes(component) &&
                     !typedElements.includes(component))
                     ctx.addIssue({
@@ -228,9 +243,9 @@ const configSchema = z
                         received: component,
                     });
             // validate no index projections are index components, hashKey, or rangeKey
-            if (index.projections)
-                for (const projection of index.projections) {
-                    if ([data.hashKey, data.rangeKey, ...index.components].includes(projection))
+            if (projections)
+                for (const projection of projections) {
+                    if ([data.hashKey, data.rangeKey, hashKey, rangeKey].includes(projection))
                         ctx.addIssue({
                             code: z.ZodIssueCode.custom,
                             message: 'index projection is an index component, hash key, or range key',

package/dist/mjs/addKeys.js

@@ -8,27 +8,27 @@ import { validateEntityToken } from './validateEntityToken.js';
  * Update generated properties, hash key, and range key on an {@link ItemMap | `ItemMap`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param item - {@link ItemMap | `ItemMap`} object.
  * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
+ * @param item - {@link ItemMap | `ItemMap`} object.
  * @param overwrite - Overwrite existing properties (default `false`).
  *
  * @returns Shallow clone of `item` with updated properties.
  *
  * @throws `Error` if `entityToken` is invalid.
  */
-function addKeys(entityManager, item, entityToken, overwrite = false) {
+function addKeys(entityManager, entityToken, item, overwrite = false) {
     try {
         // Validate params.
         validateEntityToken(entityManager, entityToken);
         // Update hash key.
-        let newItem = updateItemHashKey(entityManager, item, entityToken, overwrite);
+        let newItem = updateItemHashKey(entityManager, entityToken, item, overwrite);
         // Update range key.
-        newItem = updateItemRangeKey(entityManager, newItem, entityToken, overwrite);
+        newItem = updateItemRangeKey(entityManager, entityToken, newItem, overwrite);
         // Update generated properties.
         for (const property in entityManager.config.entities[entityToken]
             .generated) {
             if (overwrite || isNil(item[property])) {
-                const encoded = encodeGeneratedProperty(entityManager, newItem, entityToken, property);
+                const encoded = encodeGeneratedProperty(entityManager, entityToken, property, newItem);
                 if (encoded)
                     Object.assign(newItem, { [property]: encoded });
                 else

package/dist/mjs/decodeEntityElement.js

@@ -8,15 +8,15 @@ import { validateEntityToken } from './validateEntityToken.js';
  * 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 item - Partial {@link ItemMap | `ItemMap`} object.
  * @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.
  *
  * @returns Decoded value.
  *
  * @throws `Error` if `entityToken` is invalid.
  */
-function decodeEntityElement(entityManager, value, entityToken, element) {
+function decodeEntityElement(entityManager, entityToken, element, value) {
     try {
         validateEntityToken(entityManager, entityToken);
         const { entities, hashKey, rangeKey, transcodes } = entityManager.config;
@@ -26,9 +26,9 @@ function decodeEntityElement(entityManager, value, entityToken, element) {
             return value;
         const decoded = transcodes[entities[entityToken].elementTranscodes[element]].decode(value);
         entityManager.logger.debug('decoded entity element', {
-            value,
             entityToken,
             element,
+            value,
             decoded,
         });
         return decoded;
@@ -36,9 +36,9 @@ function decodeEntityElement(entityManager, value, entityToken, element) {
     catch (error) {
         if (error instanceof Error)
             entityManager.logger.error(error.message, {
-                value,
                 entityToken,
                 element,
+                value,
             });
         throw error;
     }

package/dist/mjs/decodeGeneratedProperty.js

@@ -6,14 +6,14 @@ import { validateEntityToken } from './validateEntityToken.js';
  * Decode a generated property value. Returns a partial ItemMap.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param encoded - Encoded generated property value.
  * @param entityToken - `entityManager.config.entities` key.
+ * @param encoded - Encoded generated property value.
  *
  * @returns Partial {@link ItemMap | `ItemMap`} object with updated properties decoded from `encoded`.
  *
  * @throws `Error` if `entityToken` is invalid.
  */
-function decodeGeneratedProperty(entityManager, encoded, entityToken) {
+function decodeGeneratedProperty(entityManager, entityToken, encoded) {
     try {
         const { generatedKeyDelimiter, generatedValueDelimiter, hashKey, shardKeyDelimiter, } = entityManager.config;
         // Validate params.
@@ -35,17 +35,17 @@ function decodeGeneratedProperty(entityManager, encoded, entityToken) {
             return pair;
         });
         // Assign decoded properties.
-        Object.assign(decoded, objectify(values, ([key]) => key, ([key, value]) => decodeEntityElement(entityManager, value, entityToken, key)));
+        Object.assign(decoded, objectify(values, ([key]) => key, ([key, value]) => decodeEntityElement(entityManager, entityToken, key, value)));
         entityManager.logger.debug('decoded generated property', {
-            encoded,
             entityToken,
+            encoded,
             decoded,
         });
         return decoded;
     }
     catch (error) {
         if (error instanceof Error)
-            entityManager.logger.error(error.message, { encoded, entityToken });
+            entityManager.logger.error(error.message, { entityToken, encoded });
         throw error;
     }
 }

package/dist/mjs/dehydrateIndexItem.js

@@ -16,9 +16,9 @@ import { validateEntityIndexToken } from './validateEntityIndexToken.js';
  * `item` must be populated with all required index component elements!
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
  * @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 omit - Array of index components to omit from the output value.
  *
  * @returns Dehydrated index value.
@@ -26,7 +26,7 @@ import { validateEntityIndexToken } from './validateEntityIndexToken.js';
  * @throws `Error` if `entityToken` is invalid.
  * @throws `Error` if `indexToken` is invalid.
  */
-function dehydrateIndexItem(entityManager, item, entityToken, indexToken, omit = []) {
+function dehydrateIndexItem(entityManager, entityToken, indexToken, item, omit = []) {
     try {
         const { generatedKeyDelimiter } = entityManager.config;
         // Validate params.
@@ -38,7 +38,7 @@ function dehydrateIndexItem(entityManager, item, entityToken, indexToken, omit =
         const elements = unwrapIndex(entityManager, entityToken, indexToken).filter((element) => !omit.includes(element));
         // Join index element values.
         const dehydrated = elements
-            .map((element) => encodeEntityElement(entityManager, item, entityToken, element))
+            .map((element) => encodeEntityElement(entityManager, entityToken, element, item))
             .join(generatedKeyDelimiter);
         entityManager.logger.debug('dehydrated index', {
             item,

package/dist/mjs/dehydratePageKeyMap.js

@@ -9,8 +9,8 @@ import { validateEntityToken } from './validateEntityToken.js';
  * Reverses {@link EntityManager.rehydratePageKeyMap | `rehydratePageKeyMap`}.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param pageKeyMap - {@link PageKeyMap | `PageKeyMap`} object to dehydrate.
  * @param entityToken - {@link ConfigKeys.entities | `entityManager.config.entities`} key.
+ * @param pageKeyMap - {@link PageKeyMap | `PageKeyMap`} object to dehydrate.
  *
  * @returns  Array of dehydrated page keys.
  *
@@ -22,7 +22,7 @@ import { validateEntityToken } from './validateEntityToken.js';
  *
  * An empty returned array indicates all page keys are `undefined`.
  */
-function dehydratePageKeyMap(entityManager, pageKeyMap, entityToken) {
+function dehydratePageKeyMap(entityManager, entityToken, pageKeyMap) {
     try {
         // Validate params.
         validateEntityToken(entityManager, entityToken);
@@ -30,8 +30,8 @@ function dehydratePageKeyMap(entityManager, pageKeyMap, entityToken) {
         if (!Object.keys(pageKeyMap).length) {
             const dehydrated = [];
             entityManager.logger.debug('dehydrated empty page key map', {
-                pageKeyMap,
                 entityToken,
+                pageKeyMap,
                 dehydrated,
             });
             return dehydrated;
@@ -54,13 +54,13 @@ function dehydratePageKeyMap(entityManager, pageKeyMap, entityToken) {
                 const item = Object.entries(pageKeyMap[index][hashKey]).reduce((item, [property, value]) => {
                     if (property in entityManager.config.entities[entityToken].generated ||
                         property === entityManager.config.rangeKey)
-                        Object.assign(item, decodeGeneratedProperty(entityManager, value, entityToken));
+                        Object.assign(item, decodeGeneratedProperty(entityManager, entityToken, value));
                     else
                         Object.assign(item, { [property]: value });
                     return item;
                 }, {});
                 // Dehydrate index from item.
-                dehydrated.push(dehydrateIndexItem(entityManager, item, entityToken, index, [
+                dehydrated.push(dehydrateIndexItem(entityManager, entityToken, index, item, [
                     entityManager.config.hashKey,
                 ]));
             }
@@ -69,8 +69,8 @@ function dehydratePageKeyMap(entityManager, pageKeyMap, entityToken) {
         if (dehydrated.every((pageKey) => pageKey === ''))
             dehydrated = [];
         entityManager.logger.debug('dehydrated page key map', {
-            pageKeyMap,
             entityToken,
+            pageKeyMap,
             indexes,
             hashKeys,
             dehydrated,

package/dist/mjs/encodeEntityElement.js

@@ -8,15 +8,15 @@ import { validateEntityToken } from './validateEntityToken.js';
  * 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 item - Partial {@link ItemMap | `ItemMap`} object.
  * @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 item - Partial {@link ItemMap | `ItemMap`} object.
  *
  * @returns Encoded value.
  *
  * @throws `Error` if `entityToken` is invalid.
  */
-function encodeEntityElement(entityManager, item, entityToken, element) {
+function encodeEntityElement(entityManager, entityToken, element, item) {
     try {
         validateEntityToken(entityManager, entityToken);
         const { entities, hashKey, rangeKey, transcodes } = entityManager.config;
@@ -25,16 +25,16 @@ function encodeEntityElement(entityManager, item, entityToken, element) {
             return value;
         const encoded = transcodes[entities[entityToken].elementTranscodes[element]].encode(item[element]) || undefined;
         entityManager.logger.debug('encoded entity element', {
-            item,
             entityToken,
             element,
+            item,
             encoded,
         });
         return encoded;
     }
     catch (error) {
         if (error instanceof Error)
-            entityManager.logger.error(error.message, { item, entityToken, element });
+            entityManager.logger.error(error.message, { entityToken, element, item });
         throw error;
     }
 }

package/dist/mjs/encodeGeneratedProperty.js

@@ -5,16 +5,16 @@ import { validateEntityGeneratedProperty } from './validateEntityGeneratedProper
  * Encode a generated property value. Returns a string or undefined if atomicity requirement not met.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
  * @param entityToken - `entityManager.config.entities` key.
  * @param property - {@link ConfigEntityGenerated | `entityManager.config.entities.<entityToken>.generated`} key.
+ * @param item - Partial {@link ItemMap | `ItemMap`} object.
  *
  * @returns Encoded generated property value.
  *
  * @throws `Error` if `entityToken` is invalid.
  * @throws `Error` if `property` is invalid.
  */
-function encodeGeneratedProperty(entityManager, item, entityToken, property) {
+function encodeGeneratedProperty(entityManager, entityToken, property, item) {
     try {
         // Validate params.
         validateEntityGeneratedProperty(entityManager, entityToken, property);
@@ -33,9 +33,9 @@ function encodeGeneratedProperty(entityManager, item, entityToken, property) {
             ...elementMap.map(([element, value]) => [element, (value ?? '').toString()].join(entityManager.config.generatedValueDelimiter)),
         ].join(entityManager.config.generatedKeyDelimiter);
         entityManager.logger.debug('encoded generated property', {
-            item,
             entityToken,
             property,
+            item,
             encoded,
         });
         return encoded;
@@ -43,9 +43,9 @@ function encodeGeneratedProperty(entityManager, item, entityToken, property) {
     catch (error) {
         if (error instanceof Error)
             entityManager.logger.error(error.message, {
-                item,
                 entityToken,
                 property,
+                item,
             });
         throw error;
     }

package/dist/mjs/getIndexComponents.js

@@ -0,0 +1,23 @@
+import { unique } from 'radash';
+import { validateEntityIndexToken } from './validateEntityIndexToken.js';
+
+/**
+ * Get the index components of an entity index. Adds the hash and range keys to the index components.
+ *
+ * @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.
+ *
+ * @returns Array of index components.
+ *
+ * @throws `Error` if `entityToken` is invalid.
+ * @throws `Error` if `indexToken` is invalid.
+ */
+function getIndexComponents(entityManager, entityToken, indexToken) {
+    validateEntityIndexToken(entityManager, entityToken, indexToken);
+    const { hashKey, rangeKey, entities } = entityManager.config;
+    const { hashKey: indexHashKey, rangeKey: indexRangeKey } = entities[entityToken].indexes[indexToken];
+    return unique([hashKey, rangeKey, indexHashKey, indexRangeKey]);
+}
+
+export { getIndexComponents };

package/dist/mjs/query.js

@@ -38,9 +38,9 @@ async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, p
         if (!(isInt(pageSize) && pageSize >= 1))
             throw new Error('pageSize must be a positive integer');
         // Rehydrate pageKeyMap.
-        const rehydratedPageKeyMap = rehydratePageKeyMap(entityManager, pageKeyMap
+        const rehydratedPageKeyMap = rehydratePageKeyMap(entityManager, entityToken, Object.keys(shardQueryMap), pageKeyMap
             ? JSON.parse(decompressFromEncodedURIComponent(pageKeyMap))
-            : undefined, entityToken, Object.keys(shardQueryMap), timestampFrom, timestampTo);
+            : undefined, timestampFrom, timestampTo);
         // Shortcut if pageKeyMap is empty.
         if (!Object.keys(rehydratedPageKeyMap).length)
             return {
@@ -88,7 +88,7 @@ async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, p
         const result = {
             count: workingResult.items.length,
             items: workingResult.items,
-            pageKeyMap: compressToEncodedURIComponent(JSON.stringify(dehydratePageKeyMap(entityManager, workingResult.pageKeyMap, entityToken))),
+            pageKeyMap: compressToEncodedURIComponent(JSON.stringify(dehydratePageKeyMap(entityManager, entityToken, workingResult.pageKeyMap))),
         };
         entityManager.logger.debug('queried entityToken across shards', {
             entityToken,

package/dist/mjs/rehydrateIndexItem.js

@@ -12,9 +12,9 @@ import { validateEntityIndexToken } from './validateEntityIndexToken.js';
  * {@link EntityManager.dehydrateIndexItem | `dehydrateIndexItem`} alphebetically sorts unwrapped index elements during the dehydration process. This method assumes delimited element values are presented in the same order.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param dehydrated - Dehydrated index value.
  * @param entityToken - {@link ConfigKeys.entities | `entityManager.config.entities`} key.
  * @param indexToken - {@link ConfigEntity.indexes | `entityManager.config.entities.<entityToken>.indexes`} key.
+ * @param dehydrated - Dehydrated index value.
  * @param omit - Array of index components omitted from `dehydrated`.
  *
  * @returns Partial {@link ItemMap | `ItemMap`} object containing rehydrated index component elements.
@@ -22,7 +22,7 @@ import { validateEntityIndexToken } from './validateEntityIndexToken.js';
  * @throws `Error` if `entityToken` is invalid.
  * @throws `Error` if `indexToken` is invalid.
  */
-function rehydrateIndexItem(entityManager, dehydrated, entityToken, indexToken, omit = []) {
+function rehydrateIndexItem(entityManager, entityToken, indexToken, dehydrated, omit = []) {
     try {
         const { generatedKeyDelimiter } = entityManager.config;
         // Validate params.
@@ -34,11 +34,11 @@ function rehydrateIndexItem(entityManager, dehydrated, entityToken, indexToken,
         if (elements.length !== values.length)
             throw new Error('index rehydration key-value mismatch');
         // Assign values to elements.
-        const rehydrated = shake(zipToObject(elements, values.map((value, i) => decodeEntityElement(entityManager, value, entityToken, elements[i]))));
+        const rehydrated = shake(zipToObject(elements, values.map((value, i) => decodeEntityElement(entityManager, entityToken, elements[i], value))));
         entityManager.logger.debug('rehydrated index', {
-            dehydrated,
             entityToken,
             indexToken,
+            dehydrated,
             elements,
             values,
             rehydrated,
@@ -48,9 +48,9 @@ function rehydrateIndexItem(entityManager, dehydrated, entityToken, indexToken,
     catch (error) {
         if (error instanceof Error)
             entityManager.logger.error(error.message, {
-                dehydrated,
                 entityToken,
                 indexToken,
+                dehydrated,
             });
         throw error;
     }