@karmaniverous/entity-manager 6.5.1 → 6.7.0

package/dist/mjs/query.js

@@ -25,22 +25,22 @@ const { compressToEncodedURIComponent, decompressFromEncodedURIComponent } = lzS
  *
  * @throws Error if {@link QueryOptions.pageKeyMap | `pageKeyMap`} keys do not match {@link QueryOptions.shardQueryMap | `shardQueryMap`} keys.
  */
-async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, pageSize, shardQueryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
+async function query(entityManager, { entityToken, hashKeyToken, limit, pageKeyMap, pageSize, shardQueryMap, sortOrder = [], timestampFrom = 0, timestampTo = Date.now(), throttle = entityManager.config.throttle, }) {
     try {
         // Get defaults.
         const { defaultLimit, defaultPageSize } = entityManager.config.entities[entityToken];
         limit ?? (limit = defaultLimit);
         pageSize ?? (pageSize = defaultPageSize);
         // Validate params.
-        validateEntityGeneratedProperty(entityManager, entityToken, hashKey, true);
+        validateEntityGeneratedProperty(entityManager, entityToken, hashKeyToken, true);
         if (!(limit === Infinity || (isInt(limit) && limit >= 1)))
             throw new Error('limit must be a positive integer or Infinity.');
         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,11 +88,11 @@ 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,
-            hashKey,
+            hashKeyToken,
             limit,
             pageKeyMap,
             pageSize,
@@ -110,7 +110,7 @@ async function query(entityManager, { entityToken, hashKey, limit, pageKeyMap, p
         if (error instanceof Error)
             entityManager.logger.error(error.message, {
                 entityToken,
-                hashKey,
+                hashKeyToken,
                 limit,
                 pageKeyMap,
                 pageSize,

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;
     }

package/dist/mjs/rehydratePageKeyMap.js

@@ -12,9 +12,9 @@ import { validateEntityIndexToken } from './validateEntityIndexToken.js';
  * Reverses the {@link EntityManager.dehydratePageKeyMap | `dehydratePageKeyMap`} method.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param dehydrated - Array of dehydrated page keys or undefined if new query.
  * @param entityToken - {@link ConfigKeys.entities | `entityManager.config.entities`} key.
  * @param indexTokens - Array of {@link ConfigEntity.indexes | `entityManager.config.entities.<entityToken>.indexes`} keys used as keys of the original {@link PageKeyMap | `PageKeyMap`}.
+ * @param dehydrated - Array of dehydrated page keys or undefined if new query.
  * @param timestampFrom - Lower timestanp limit used to generate the original {@link PageKeyMap | `PageKeyMap`}. Defaults to `0`.
  * @param timestampTo - Upper timestamp limit used to generate the original {@link PageKeyMap | `PageKeyMap`}. Defaults to `Date.now()`.
  *
@@ -25,7 +25,7 @@ import { validateEntityIndexToken } from './validateEntityIndexToken.js';
  * @throws `Error` if any `indexTokens` are invalid.
  * @throws `Error` if `dehydrated` has invalid length.
  */
-function rehydratePageKeyMap(entityManager, dehydrated, entityToken, indexTokens, timestampFrom = 0, timestampTo = Date.now()) {
+function rehydratePageKeyMap(entityManager, entityToken, indexTokens, dehydrated, timestampFrom = 0, timestampTo = Date.now()) {
     try {
         // Validate params.
         if (!indexTokens.length)
@@ -47,17 +47,17 @@ function rehydratePageKeyMap(entityManager, dehydrated, entityToken, indexTokens
                 return;
             let item = {
                 [entityManager.config.hashKey]: hashKey,
-                ...rehydrateIndexItem(entityManager, dehydratedIndexPageKeyMaps[i], entityToken, index, [entityManager.config.hashKey]),
+                ...rehydrateIndexItem(entityManager, entityToken, index, dehydratedIndexPageKeyMaps[i], [entityManager.config.hashKey]),
             };
-            item = updateItemRangeKey(entityManager, item, entityToken);
+            item = updateItemRangeKey(entityManager, entityToken, item);
             return zipToObject(getIndexComponents(entityManager, entityToken, index), (component) => entityManager.config.entities[entityToken].generated[component]
-                ? encodeGeneratedProperty(entityManager, item, entityToken, component)
+                ? encodeGeneratedProperty(entityManager, entityToken, component, item)
                 : item[component]);
         }));
         entityManager.logger.debug('rehydrated page key map', {
-            dehydrated,
             entityToken,
             indexTokens,
+            dehydrated,
             rehydrated,
         });
         return rehydrated;
@@ -65,9 +65,9 @@ function rehydratePageKeyMap(entityManager, dehydrated, entityToken, indexTokens
     catch (error) {
         if (error instanceof Error)
             entityManager.logger.error(error.message, {
-                dehydrated,
                 entityToken,
                 indexTokens,
+                dehydrated,
             });
         throw error;
     }

package/dist/mjs/removeKeys.js

@@ -4,14 +4,14 @@ import { validateEntityToken } from './validateEntityToken.js';
  * Strips generated properties, hash key, and range key from an {@link ItemMap | `ItemMap`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param item - {@link ItemMap | `ItemMap`} object.
  * @param entityToken - {@link ConfigKeys.entities | `entityManager.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.
  */
-function removeKeys(entityManager, item, entityToken) {
+function removeKeys(entityManager, entityToken, item) {
     try {
         // Validate params.
         validateEntityToken(entityManager, entityToken);
@@ -23,15 +23,15 @@ function removeKeys(entityManager, item, entityToken) {
         for (const property in entityManager.config.entities[entityToken].generated)
             delete newItem[property];
         entityManager.logger.debug('stripped entity item generated properties', {
-            item,
             entityToken,
+            item,
             newItem,
         });
         return newItem;
     }
     catch (error) {
         if (error instanceof Error)
-            entityManager.logger.error(error.message, { item, entityToken });
+            entityManager.logger.error(error.message, { entityToken, item });
         throw error;
     }
 }

package/dist/mjs/updateItemHashKey.js

@@ -7,15 +7,15 @@ import { validateEntityToken } from './validateEntityToken.js';
  * Update the hash key on a partial {@link ItemMap | `ItemMap`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
  * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
+ * @param item - Partial {@link ItemMap | `ItemMap`} object.
  * @param overwrite - Overwrite existing {@link ConfigKeys.hashKey | `this.config.hashKey`} property value (default `false`).
  *
  * @returns Shallow clone of `item` with updated hash key.
  *
  * @throws `Error` if `entityToken` is invalid.
  */
-function updateItemHashKey(entityManager, item, entityToken, overwrite = false) {
+function updateItemHashKey(entityManager, entityToken, item, overwrite = false) {
     try {
         // Validate params.
         validateEntityToken(entityManager, entityToken);
@@ -59,8 +59,8 @@ function updateItemHashKey(entityManager, item, entityToken, overwrite = false)
     catch (error) {
         if (error instanceof Error)
             entityManager.logger.error(error.message, {
-                item,
                 entityToken,
+                item,
                 overwrite,
             });
         throw error;

package/dist/mjs/updateItemRangeKey.js

@@ -5,8 +5,8 @@ import { validateEntityToken } from './validateEntityToken.js';
  * Update the range key on a partial {@link ItemMap | `ItemMap`} object.
  *
  * @param entityManager - {@link EntityManager | `EntityManager`} instance.
- * @param item - Partial {@link ItemMap | `ItemMap`} object.
  * @param entityToken - {@link ConfigKeys.entities | `this.config.entities`} key.
+ * @param item - Partial {@link ItemMap | `ItemMap`} object.
  * @param overwrite - Overwrite existing {@link ConfigKeys.rangeKey | `this.config.rangeKey`} property value (default `false`).
  *
  * @returns Shallow clone of `item` with updated range key.
@@ -14,15 +14,15 @@ import { validateEntityToken } from './validateEntityToken.js';
  * @throws `Error` if `entityToken` is invalid.
  * @throws `Error` if `item` {@link ConfigEntity.uniqueProperty | `this.config.entities<entityToken>.uniqueProperty`} property value is missing.
  */
-function updateItemRangeKey(entityManager, item, entityToken, overwrite = false) {
+function updateItemRangeKey(entityManager, entityToken, item, overwrite = false) {
     try {
         // Validate params.
         validateEntityToken(entityManager, entityToken);
         // Return current item if rangeKey exists and overwrite is false.
         if (item[entityManager.config.rangeKey] && !overwrite) {
             entityManager.logger.debug('did not overwrite existing entity item range key', {
-                item,
                 entityToken,
+                item,
                 overwrite,
             });
             return { ...item };
@@ -49,8 +49,8 @@ function updateItemRangeKey(entityManager, item, entityToken, overwrite = false)
     catch (error) {
         if (error instanceof Error)
             entityManager.logger.error(error.message, {
-                item,
                 entityToken,
+                item,
                 overwrite,
             });
         throw error;

package/package.json

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