@karmaniverous/entity-manager 2.2.1 → 4.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,8 +222,9 @@ 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>
+            * [.query(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>
             * [.removeKeys(entityToken, item)](#module_entity-manager.EntityManager+removeKeys) ⇒ <code>object</code>
     * _inner_
@@ -243,8 +244,9 @@ 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>
+    * [.query(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>
     * [.removeKeys(entityToken, item)](#module_entity-manager.EntityManager+removeKeys) ⇒ <code>object</code>
 
@@ -319,6 +321,19 @@ Condense an index object into a delimited string.
 | 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>
@@ -343,21 +358,21 @@ Return an array of sharded keys valid for a given entity token & timestamp.
 
 <a name="module_entity-manager.EntityManager+query"></a>
 
-#### entityManager.query(entityToken, keyToken, item, shardQuery, [options]) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
+#### entityManager.query(options) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
 Query an entity across shards.
 
 **Kind**: instance method of [<code>EntityManager</code>](#module_entity-manager.EntityManager)  
 **Returns**: <code>Promise.&lt;ShardedQueryResult&gt;</code> - Sharded query result.  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| entityToken | <code>string</code> | Entity token. |
-| keyToken | <code>string</code> | Key token. |
-| item | <code>object</code> | Entity item sufficiently populated to generate property keyToken. |
-| shardQuery | <code>ShardQueryFunction</code> | Sharded query function. |
-| [options] | <code>object</code> | Options object. |
-| [options.limit] | <code>number</code> | Request limit. |
-| [options.pageKeys] | <code>object</code> | Map of shard page keys. |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| options | <code>object</code> |  | Query options. |
+| options.entityToken | <code>string</code> |  | Entity token. |
+| [options.keyToken] | <code>string</code> | <code>&quot;entityPK&quot;</code> | Key token. |
+| [options.item] | <code>object</code> | <code>{}</code> | Entity item sufficiently populated to generate property keyToken. |
+| options.shardQuery | <code>ShardQueryFunction</code> |  | Sharded query function. |
+| [options.limit] | <code>number</code> |  | Request limit. |
+| [options.pageKeys] | <code>object</code> |  | Map of shard page keys. |
 
 <a name="module_entity-manager.EntityManager+rehydrateIndex"></a>
 
@@ -419,9 +434,8 @@ Shard query function
 | Param | Type | Description |
 | --- | --- | --- |
 | shardedKey | <code>string</code> | Sharded key. |
-| [options] | <code>object</code> | Options object. |
-| [options.limit] | <code>number</code> | Request limit. |
-| [options.pageKey] | <code>\*</code> | Page key. |
+| [limit] | <code>number</code> | Request limit. |
+| [pageKey] | <code>\*</code> | Page key. |
 
 <a name="module_entity-manager..ShardedQueryResult"></a>
 

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

@@ -13,6 +13,7 @@ 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"));
@@ -146,11 +147,11 @@ class EntityManager {
     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
     })));
@@ -201,9 +217,8 @@ class EntityManager {
    *
    * @callback ShardQueryFunction
    * @param {string} shardedKey - Sharded key.
-   * @param {object} [options] - Options object.
-   * @param {number} [options.limit] - Request limit.
-   * @param {*} [options.pageKey] - Page key.
+   * @param {number} [limit] - Request limit.
+   * @param {*} [pageKey] - Page key.
    * @returns {Promise<ShardQueryResult>} Sharded query result.
    */
 
@@ -216,20 +231,24 @@ class EntityManager {
   /**
    * Query an entity across shards.
    *
-   * @param {string} entityToken - Entity token.
-   * @param {string} keyToken - Key token.
-   * @param {object} item - Entity item sufficiently populated to generate property keyToken.
-   * @param {ShardQueryFunction} shardQuery - Sharded query function.
-   * @param {object} [options] - Options object.
+   * @param {object} options - Query options.
+   * @param {string} options.entityToken - Entity token.
+   * @param {string} [options.keyToken=entityPK] - Key token.
+   * @param {object} [options.item={}] - Entity item sufficiently populated to generate property keyToken.
+   * @param {ShardQueryFunction} options.shardQuery - Sharded query function.
    * @param {number} [options.limit] - Request limit.
    * @param {object} [options.pageKeys] - Map of shard page keys.
    * @returns {Promise<ShardedQueryResult>} Sharded query result.
    */
-  async query(entityToken, keyToken, item, shardQuery) {
+  async query() {
     let {
+      entityToken,
+      keyToken = 'entityPK',
+      item = {},
+      shardQuery,
       limit,
       pageKeys
-    } = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
+    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     // Validate params.
     _classPrivateFieldGet(this, _entityManager).validateKeyToken(entityToken, keyToken);
     _classPrivateFieldGet(this, _entityManager).validateItem(item);
@@ -250,10 +269,7 @@ class EntityManager {
     const shardLimit = (0, _isUndefined2.default)(limit) ? undefined : Math.ceil(limit / (0, _size2.default)(pageKeys));
 
     // Query every shard in pageKeys.
-    const shardQueryResults = await Promise.all((0, _map2.default)(pageKeys, (pageKey, shardedKey) => new Promise(resolve => shardQuery(shardedKey, {
-      pageKey,
-      limit: shardLimit
-    }).then(_ref6 => {
+    const shardQueryResults = await Promise.all((0, _map2.default)(pageKeys, (pageKey, shardedKey) => new Promise(resolve => shardQuery(shardedKey, pageKey, shardLimit).then(_ref6 => {
       let {
         items,
         pageKey
@@ -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

@@ -110,7 +110,7 @@ export class EntityManager {
       : 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}'`
@@ -118,7 +118,7 @@ export class EntityManager {
 
       return {
         ...properties,
-        ...(decode(index[component] ?? '')?.groups ?? []),
+        ...(decode(index[component] ?? '') ?? {}),
       };
     }, {});
 
@@ -130,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.
    *
@@ -156,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,
         })
@@ -178,9 +196,8 @@ export class EntityManager {
    *
    * @callback ShardQueryFunction
    * @param {string} shardedKey - Sharded key.
-   * @param {object} [options] - Options object.
-   * @param {number} [options.limit] - Request limit.
-   * @param {*} [options.pageKey] - Page key.
+   * @param {number} [limit] - Request limit.
+   * @param {*} [pageKey] - Page key.
    * @returns {Promise<ShardQueryResult>} Sharded query result.
    */
 
@@ -193,22 +210,23 @@ export class EntityManager {
   /**
    * Query an entity across shards.
    *
-   * @param {string} entityToken - Entity token.
-   * @param {string} keyToken - Key token.
-   * @param {object} item - Entity item sufficiently populated to generate property keyToken.
-   * @param {ShardQueryFunction} shardQuery - Sharded query function.
-   * @param {object} [options] - Options object.
+   * @param {object} options - Query options.
+   * @param {string} options.entityToken - Entity token.
+   * @param {string} [options.keyToken=entityPK] - Key token.
+   * @param {object} [options.item={}] - Entity item sufficiently populated to generate property keyToken.
+   * @param {ShardQueryFunction} options.shardQuery - Sharded query function.
    * @param {number} [options.limit] - Request limit.
    * @param {object} [options.pageKeys] - Map of shard page keys.
    * @returns {Promise<ShardedQueryResult>} Sharded query result.
    */
-  async query(
+  async query({
     entityToken,
-    keyToken,
-    item,
+    keyToken = 'entityPK',
+    item = {},
     shardQuery,
-    { limit, pageKeys } = {}
-  ) {
+    limit,
+    pageKeys,
+  } = {}) {
     // Validate params.
     this.#entityManager.validateKeyToken(entityToken, keyToken);
     this.#entityManager.validateItem(item);
@@ -241,7 +259,7 @@ export class EntityManager {
         pageKeys,
         (pageKey, shardedKey) =>
           new Promise((resolve) =>
-            shardQuery(shardedKey, { pageKey, limit: shardLimit }).then(
+            shardQuery(shardedKey, pageKey, shardLimit).then(
               ({ items, pageKey }) => resolve({ shardedKey, items, pageKey })
             )
           )
@@ -281,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()];
       }, [])
     );
@@ -289,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.1",
+  "version": "4.0.0",
   "publishConfig": {
     "access": "public"
   },