@karmaniverous/entity-manager 3.0.0 → 4.0.0

package/README.md

@@ -224,7 +224,7 @@ This change can be accomplished with no breaking changes to existing implementat
             * [.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_
@@ -246,7 +246,7 @@ Manage DynamoDb entities.
     * [.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>
 
@@ -358,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>
 
@@ -434,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

@@ -217,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.
    */
 
@@ -232,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);
@@ -266,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

package/lib/EntityManager/EntityManager.js

@@ -196,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.
    */
 
@@ -211,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);
@@ -259,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 })
             )
           )

package/package.json

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