@karmaniverous/entity-manager 0.1.0 → 0.1.1

package/README.md

@@ -221,7 +221,7 @@ This change can be accomplished with no breaking changes to existing implementat
             * [new exports.EntityManager(options)](#new_module_entity-manager.EntityManager_new)
             * [.addKeys(entityToken, item, [overwrite])](#module_entity-manager.EntityManager+addKeys) ⇒ <code>object</code>
             * [.getKeySpace(entityToken, keyToken, item, timestamp)](#module_entity-manager.EntityManager+getKeySpace) ⇒ <code>Array.&lt;string&gt;</code>
-            * [.query(entityToken, keyToken, item, shardQuery, [shardPageKeys])](#module_entity-manager.EntityManager+query) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
+            * [.query(entityToken, keyToken, item, shardQuery, [pageKeys])](#module_entity-manager.EntityManager+query) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
     * _inner_
         * [~ShardQueryResult](#module_entity-manager..ShardQueryResult) : <code>object</code>
         * [~ShardQueryFunction](#module_entity-manager..ShardQueryFunction) ⇒ <code>Promise.&lt;ShardQueryResult&gt;</code>
@@ -238,7 +238,7 @@ Manage DynamoDb entities.
     * [new exports.EntityManager(options)](#new_module_entity-manager.EntityManager_new)
     * [.addKeys(entityToken, item, [overwrite])](#module_entity-manager.EntityManager+addKeys) ⇒ <code>object</code>
     * [.getKeySpace(entityToken, keyToken, item, timestamp)](#module_entity-manager.EntityManager+getKeySpace) ⇒ <code>Array.&lt;string&gt;</code>
-    * [.query(entityToken, keyToken, item, shardQuery, [shardPageKeys])](#module_entity-manager.EntityManager+query) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
+    * [.query(entityToken, keyToken, item, shardQuery, [pageKeys])](#module_entity-manager.EntityManager+query) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
 
 <a name="new_module_entity-manager.EntityManager_new"></a>
 
@@ -301,7 +301,7 @@ 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, [shardPageKeys]) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
+#### entityManager.query(entityToken, keyToken, item, shardQuery, [pageKeys]) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
 Query an entity across shards.
 
 **Kind**: instance method of [<code>EntityManager</code>](#module_entity-manager.EntityManager)  
@@ -313,7 +313,7 @@ Query an entity across shards.
 | 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. |
-| [shardPageKeys] | <code>object</code> | Map of shard page keys. |
+| [pageKeys] | <code>object</code> | Map of shard page keys. |
 
 <a name="module_entity-manager..ShardQueryResult"></a>
 
@@ -348,7 +348,7 @@ Shard query function
 | Name | Type | Description |
 | --- | --- | --- |
 | items | <code>Array.&lt;any&gt;</code> | Query result array. |
-| shardPageKeys | <code>object</code> | Shard page keys. |
+| pageKeys | <code>object</code> | Shard page keys. |
 
 
 ---

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

@@ -136,7 +136,7 @@ class EntityManager {
   /**
    * @typedef {object} ShardedQueryResult
    * @property {any[]} items - Query result array.
-   * @property {object} shardPageKeys - Shard page keys.
+   * @property {object} pageKeys - Shard page keys.
    */
 
   /**
@@ -146,15 +146,15 @@ class EntityManager {
    * @param {string} keyToken - Key token.
    * @param {object} item - Entity item sufficiently populated to generate property keyToken.
    * @param {ShardQueryFunction} shardQuery - Sharded query function.
-   * @param {object} [shardPageKeys] - Map of shard page keys.
+   * @param {object} [pageKeys] - Map of shard page keys.
    * @returns {Promise<ShardedQueryResult>} Sharded query result.
    */
-  async query(entityToken, keyToken, item, shardQuery, shardPageKeys) {
-    // Generate default shardPageKeys if not provided
-    shardPageKeys ??= (0, _fromPairs2.default)(this.getKeySpace(entityToken, keyToken, item).map(shardedKey => [shardedKey, undefined]));
+  async query(entityToken, keyToken, item, shardQuery, pageKeys) {
+    // Generate default pageKeys if not provided
+    pageKeys ??= (0, _fromPairs2.default)(this.getKeySpace(entityToken, keyToken, item).map(shardedKey => [shardedKey, undefined]));
 
-    // Query every shard in shardPageKeys.
-    const shardQueryResults = await Promise.all((0, _map2.default)(shardPageKeys, (pageKey, shardedKey) => new Promise(resolve => shardQuery(shardedKey, pageKey).then(_ref2 => {
+    // Query every shard in pageKeys.
+    const shardQueryResults = await Promise.all((0, _map2.default)(pageKeys, (pageKey, shardedKey) => new Promise(resolve => shardQuery(shardedKey, pageKey).then(_ref2 => {
       let {
         items,
         pageKey
@@ -175,8 +175,8 @@ class EntityManager {
       } = _ref3;
       return {
         items: [...shardedQueryResult.items, ...items],
-        shardPageKeys: {
-          ...shardedQueryResult.shardPageKeys,
+        pageKeys: {
+          ...shardedQueryResult.pageKeys,
           ...((0, _isUndefined2.default)(pageKey) ? {} : {
             [shardedKey]: pageKey
           })
@@ -184,7 +184,7 @@ class EntityManager {
       };
     }, {
       items: [],
-      shardPageKeys: {}
+      pageKeys: {}
     });
     return result;
   }

package/lib/EntityManager/EntityManager.js

@@ -132,7 +132,7 @@ export class EntityManager {
   /**
    * @typedef {object} ShardedQueryResult
    * @property {any[]} items - Query result array.
-   * @property {object} shardPageKeys - Shard page keys.
+   * @property {object} pageKeys - Shard page keys.
    */
 
   /**
@@ -142,22 +142,22 @@ export class EntityManager {
    * @param {string} keyToken - Key token.
    * @param {object} item - Entity item sufficiently populated to generate property keyToken.
    * @param {ShardQueryFunction} shardQuery - Sharded query function.
-   * @param {object} [shardPageKeys] - Map of shard page keys.
+   * @param {object} [pageKeys] - Map of shard page keys.
    * @returns {Promise<ShardedQueryResult>} Sharded query result.
    */
-  async query(entityToken, keyToken, item, shardQuery, shardPageKeys) {
-    // Generate default shardPageKeys if not provided
-    shardPageKeys ??= _.fromPairs(
+  async query(entityToken, keyToken, item, shardQuery, pageKeys) {
+    // Generate default pageKeys if not provided
+    pageKeys ??= _.fromPairs(
       this.getKeySpace(entityToken, keyToken, item).map((shardedKey) => [
         shardedKey,
         undefined,
       ])
     );
 
-    // Query every shard in shardPageKeys.
+    // Query every shard in pageKeys.
     const shardQueryResults = await Promise.all(
       _.map(
-        shardPageKeys,
+        pageKeys,
         (pageKey, shardedKey) =>
           new Promise((resolve) =>
             shardQuery(shardedKey, pageKey).then(({ items, pageKey }) =>
@@ -171,12 +171,12 @@ export class EntityManager {
     const result = shardQueryResults.reduce(
       (shardedQueryResult, { shardedKey, items, pageKey }) => ({
         items: [...shardedQueryResult.items, ...items],
-        shardPageKeys: {
-          ...shardedQueryResult.shardPageKeys,
+        pageKeys: {
+          ...shardedQueryResult.pageKeys,
           ...(_.isUndefined(pageKey) ? {} : { [shardedKey]: pageKey }),
         },
       }),
-      { items: [], shardPageKeys: {} }
+      { items: [], pageKeys: {} }
     );
 
     return result;

package/package.json

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