@karmaniverous/entity-manager 2.2.0 → 3.0.0

package/README.md

@@ -56,7 +56,7 @@ export const config = {
         entityPK: ({ shardId }) => `transaction${sn2e`!${shardId}`}`,
 
         // Table RANGE key.
-        entitySK: ({ timestamp, transactionId }) =>
+        transactionSK: ({ timestamp, transactionId }) =>
           sn2u`timestamp#${timestamp}|transactionId#${transactionId}`,
 
         // merchants GSI HASH key. Note the optional shardId.
@@ -162,7 +162,7 @@ entityManager.addKeys(transaction);
 // debug:      "userId": "userIdValue",
 // debug:      "shardId": "7",
 // debug:      "entityPK": "transaction!7",
-// debug:      "entitySK": "timestamp#1676869312851|transactionId#transactionIdValue",
+// debug:      "transactionSK": "timestamp#1676869312851|transactionId#transactionIdValue",
 // debug:      "merchantPK": "merchantId#merchantIdValue|transaction!7",
 // debug:      "merchantSK": "timestamp#1676869312851|methodId#methodIdValue|transactionId#transactionIdValue",
 // debug:      "methodPK": "method#methodIdValue|transaction!7",
@@ -222,6 +222,7 @@ This change can be accomplished with no breaking changes to existing implementat
             * [.addKeys(entityToken, item, [overwrite])](#module_entity-manager.EntityManager+addKeys) ⇒ <code>object</code>
             * [.calcShardKey(entityToken, item)](#module_entity-manager.EntityManager+calcShardKey) ⇒ <code>string</code>
             * [.dehydrateIndex(entityToken, indexToken, index, [delimiter])](#module_entity-manager.EntityManager+dehydrateIndex) ⇒ <code>string</code>
+            * [.getKey(entityToken, keyToken)](#module_entity-manager.EntityManager+getKey) ⇒ <code>object</code>
             * [.getKeySpace(entityToken, keyToken, item, timestamp)](#module_entity-manager.EntityManager+getKeySpace) ⇒ <code>Array.&lt;string&gt;</code>
             * [.query(entityToken, keyToken, item, shardQuery, [options])](#module_entity-manager.EntityManager+query) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
             * [.rehydrateIndex(entityToken, indexToken, value, [delimiter])](#module_entity-manager.EntityManager+rehydrateIndex) ⇒ <code>object</code>
@@ -243,6 +244,7 @@ Manage DynamoDb entities.
     * [.addKeys(entityToken, item, [overwrite])](#module_entity-manager.EntityManager+addKeys) ⇒ <code>object</code>
     * [.calcShardKey(entityToken, item)](#module_entity-manager.EntityManager+calcShardKey) ⇒ <code>string</code>
     * [.dehydrateIndex(entityToken, indexToken, index, [delimiter])](#module_entity-manager.EntityManager+dehydrateIndex) ⇒ <code>string</code>
+    * [.getKey(entityToken, keyToken)](#module_entity-manager.EntityManager+getKey) ⇒ <code>object</code>
     * [.getKeySpace(entityToken, keyToken, item, timestamp)](#module_entity-manager.EntityManager+getKeySpace) ⇒ <code>Array.&lt;string&gt;</code>
     * [.query(entityToken, keyToken, item, shardQuery, [options])](#module_entity-manager.EntityManager+query) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
     * [.rehydrateIndex(entityToken, indexToken, value, [delimiter])](#module_entity-manager.EntityManager+rehydrateIndex) ⇒ <code>object</code>
@@ -315,10 +317,23 @@ Condense an index object into a delimited string.
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
 | entityToken | <code>string</code> |  | Entity token. |
-| indexToken | <code>string</code> |  | Index token. |
+| indexToken | <code>string</code> \| <code>Array.&lt;string&gt;</code> |  | Index token or array of key tokens. |
 | index | <code>object</code> |  | Index object. |
 | [delimiter] | <code>string</code> | <code>&quot;~&quot;</code> | Delimiter. |
 
+<a name="module_entity-manager.EntityManager+getKey"></a>
+
+#### entityManager.getKey(entityToken, keyToken) ⇒ <code>object</code>
+Return the config for a given entity key token.
+
+**Kind**: instance method of [<code>EntityManager</code>](#module_entity-manager.EntityManager)  
+**Returns**: <code>object</code> - Entity key config.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| entityToken | <code>string</code> | Entity token. |
+| keyToken | <code>string</code> | Key token. |
+
 <a name="module_entity-manager.EntityManager+getKeySpace"></a>
 
 #### entityManager.getKeySpace(entityToken, keyToken, item, timestamp) ⇒ <code>Array.&lt;string&gt;</code>

package/dist/default/lib/EntityManager/EntityManager.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.EntityManager = void 0;
 var _zipObject2 = _interopRequireDefault(require("lodash/zipObject"));
-var _isArray2 = _interopRequireDefault(require("lodash/isArray"));
 var _map2 = _interopRequireDefault(require("lodash/map"));
 var _size2 = _interopRequireDefault(require("lodash/size"));
 var _isEmpty2 = _interopRequireDefault(require("lodash/isEmpty"));
@@ -14,10 +13,12 @@ var _isPlainObject2 = _interopRequireDefault(require("lodash/isPlainObject"));
 var _isInteger2 = _interopRequireDefault(require("lodash/isInteger"));
 var _isUndefined2 = _interopRequireDefault(require("lodash/isUndefined"));
 var _sortedUniq2 = _interopRequireDefault(require("lodash/sortedUniq"));
+var _has2 = _interopRequireDefault(require("lodash/has"));
 var _entries2 = _interopRequireDefault(require("lodash/entries"));
 var _sortBy2 = _interopRequireDefault(require("lodash/sortBy"));
 var _sortedUniqBy2 = _interopRequireDefault(require("lodash/sortedUniqBy"));
 var _isFunction2 = _interopRequireDefault(require("lodash/isFunction"));
+var _isArray2 = _interopRequireDefault(require("lodash/isArray"));
 var _forEach2 = _interopRequireDefault(require("lodash/forEach"));
 var _isNil2 = _interopRequireDefault(require("lodash/isNil"));
 var _cloneDeep2 = _interopRequireDefault(require("lodash/cloneDeep"));
@@ -130,7 +131,7 @@ class EntityManager {
    * Condense an index object into a delimited string.
    *
    * @param {string} entityToken - Entity token.
-   * @param {string} indexToken - Index token.
+   * @param {string|string[]} indexToken - Index token or array of key tokens.
    * @param {object} index - Index object.
    * @param {string} [delimiter] - Delimiter.
    * @returns {string} Dehydrated index.
@@ -142,15 +143,15 @@ class EntityManager {
     let delimiter = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : '~';
     // Validate item.
     _classPrivateFieldGet(this, _entityManager).validateItem(index);
-    const indexComponents = _classPrivateFieldGet(this, _entityManager).getIndexComponents(entityToken, indexToken);
+    const indexComponents = (0, _isArray2.default)(indexToken) ? indexToken : _classPrivateFieldGet(this, _entityManager).getIndexComponents(entityToken, indexToken);
     const indexProperties = indexComponents.reduce((properties, component) => {
       const {
         decode
-      } = _classPrivateFieldGet(this, _entityManager).getKey(entityToken, component);
+      } = this.getKey(entityToken, component);
       if (!(0, _isFunction2.default)(decode)) throw new Error(`no decode function defined on ${entityToken} entity key '${component}'`);
       return {
         ...properties,
-        ...(decode(index[component] ?? '')?.groups ?? [])
+        ...(decode(index[component] ?? '') ?? {})
       };
     }, {});
     return (0, _sortedUniqBy2.default)((0, _sortBy2.default)((0, _entries2.default)(indexProperties), _ref3 => {
@@ -165,6 +166,21 @@ class EntityManager {
     }).join(delimiter);
   }
 
+  /**
+   * Return the config for a given entity key token.
+   *
+   * @param {string} entityToken - Entity token.
+   * @param {string} keyToken - Key token.
+   * @returns {object} Entity key config.
+   */
+  getKey(entityToken, keyToken) {
+    const {
+      keys
+    } = _classPrivateFieldGet(this, _entityManager).getEntityConfig(entityToken);
+    if (!(0, _has2.default)(keys, keyToken)) throw new Error(`Key '${keyToken}' does not exist for entity '${entityToken}'.`);
+    return keys[keyToken];
+  }
+
   /**
    * Return an array of sharded keys valid for a given entity token & timestamp.
    *
@@ -182,7 +198,7 @@ class EntityManager {
     let timestamp = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : Date.now();
     _classPrivateFieldGet(this, _entityManager).logger.debug(`getting shard key space for ${entityToken} on key '${keyToken}' at timestamp ${timestamp}...`, item);
     const shardKeySpace = _classPrivateFieldGet(this, _entityManager).getShardKeySpace(entityToken, timestamp);
-    const result = (0, _sortedUniq2.default)(shardKeySpace.map(shardKey => _classPrivateFieldGet(this, _entityManager).getKey(entityToken, keyToken).encode({
+    const result = (0, _sortedUniq2.default)(shardKeySpace.map(shardKey => this.getKey(entityToken, keyToken).encode({
       ...item,
       [_classPrivateFieldGet(this, _entityManager).shardKeyToken]: shardKey
     })));
@@ -306,14 +322,14 @@ class EntityManager {
     const indexKeys = (0, _sortBy2.default)(indexComponents.reduce((keys, component) => {
       const {
         encode
-      } = _classPrivateFieldGet(this, _entityManager).getKey(entityToken, component);
+      } = this.getKey(entityToken, component);
       return [...new Set([...keys, ...(0, _inspectParametersDeclaration.getParametersNames)(encode)]).values()];
     }, []));
     const indexProperies = (0, _zipObject2.default)(indexKeys, value.split(delimiter));
     return indexComponents.reduce((index, component) => {
       const {
         encode
-      } = _classPrivateFieldGet(this, _entityManager).getKey(entityToken, component);
+      } = this.getKey(entityToken, component);
       return {
         ...index,
         [component]: encode(indexProperies)

package/dist/default/lib/EntityManager/PrivateEntityManager.js

@@ -302,13 +302,6 @@ class PrivateEntityManager {
     if (!(0, _has2.default)(indexes, indexToken)) throw new Error(`Index '${indexToken}' does not exist for entity '${entityToken}'.`);
     return indexes[indexToken];
   }
-  getKey(entityToken, keyToken) {
-    const {
-      keys
-    } = this.getEntityConfig(entityToken);
-    if (!(0, _has2.default)(keys, keyToken)) throw new Error(`Key '${keyToken}' does not exist for entity '${entityToken}'.`);
-    return keys[keyToken];
-  }
 
   /**
    * Get the number of nibbles & nibbleBits for a given entityToken at a given timestamp.

package/lib/EntityManager/EntityManager.js

@@ -93,7 +93,7 @@ export class EntityManager {
    * Condense an index object into a delimited string.
    *
    * @param {string} entityToken - Entity token.
-   * @param {string} indexToken - Index token.
+   * @param {string|string[]} indexToken - Index token or array of key tokens.
    * @param {object} index - Index object.
    * @param {string} [delimiter] - Delimiter.
    * @returns {string} Dehydrated index.
@@ -105,13 +105,12 @@ export class EntityManager {
     // Validate item.
     this.#entityManager.validateItem(index);
 
-    const indexComponents = this.#entityManager.getIndexComponents(
-      entityToken,
-      indexToken
-    );
+    const indexComponents = _.isArray(indexToken)
+      ? indexToken
+      : this.#entityManager.getIndexComponents(entityToken, indexToken);
 
     const indexProperties = indexComponents.reduce((properties, component) => {
-      const { decode } = this.#entityManager.getKey(entityToken, component);
+      const { decode } = this.getKey(entityToken, component);
       if (!_.isFunction(decode))
         throw new Error(
           `no decode function defined on ${entityToken} entity key '${component}'`
@@ -119,7 +118,7 @@ export class EntityManager {
 
       return {
         ...properties,
-        ...(decode(index[component] ?? '')?.groups ?? []),
+        ...(decode(index[component] ?? '') ?? {}),
       };
     }, {});
 
@@ -131,6 +130,24 @@ export class EntityManager {
       .join(delimiter);
   }
 
+  /**
+   * Return the config for a given entity key token.
+   *
+   * @param {string} entityToken - Entity token.
+   * @param {string} keyToken - Key token.
+   * @returns {object} Entity key config.
+   */
+  getKey(entityToken, keyToken) {
+    const { keys } = this.#entityManager.getEntityConfig(entityToken);
+
+    if (!_.has(keys, keyToken))
+      throw new Error(
+        `Key '${keyToken}' does not exist for entity '${entityToken}'.`
+      );
+
+    return keys[keyToken];
+  }
+
   /**
    * Return an array of sharded keys valid for a given entity token & timestamp.
    *
@@ -157,7 +174,7 @@ export class EntityManager {
 
     const result = _.sortedUniq(
       shardKeySpace.map((shardKey) =>
-        this.#entityManager.getKey(entityToken, keyToken).encode({
+        this.getKey(entityToken, keyToken).encode({
           ...item,
           [this.#entityManager.shardKeyToken]: shardKey,
         })
@@ -282,7 +299,7 @@ export class EntityManager {
 
     const indexKeys = _.sortBy(
       indexComponents.reduce((keys, component) => {
-        const { encode } = this.#entityManager.getKey(entityToken, component);
+        const { encode } = this.getKey(entityToken, component);
         return [...new Set([...keys, ...getParametersNames(encode)]).values()];
       }, [])
     );
@@ -290,7 +307,7 @@ export class EntityManager {
     const indexProperies = _.zipObject(indexKeys, value.split(delimiter));
 
     return indexComponents.reduce((index, component) => {
-      const { encode } = this.#entityManager.getKey(entityToken, component);
+      const { encode } = this.getKey(entityToken, component);
       return { ...index, [component]: encode(indexProperies) };
     }, {});
   }

package/lib/EntityManager/PrivateEntityManager.js

@@ -281,17 +281,6 @@ export class PrivateEntityManager {
     return indexes[indexToken];
   }
 
-  getKey(entityToken, keyToken) {
-    const { keys } = this.getEntityConfig(entityToken);
-
-    if (!_.has(keys, keyToken))
-      throw new Error(
-        `Key '${keyToken}' does not exist for entity '${entityToken}'.`
-      );
-
-    return keys[keyToken];
-  }
-
   /**
    * Get the number of nibbles & nibbleBits for a given entityToken at a given timestamp.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karmaniverous/entity-manager",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "publishConfig": {
     "access": "public"
   },