@karmaniverous/entity-manager 0.1.2-1 → 1.0.0

package/README.md

@@ -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>
             * [.getKeySpace(entityToken, keyToken, item, timestamp)](#module_entity-manager.EntityManager+getKeySpace) ⇒ <code>Array.&lt;string&gt;</code>
             * [.query(entityToken, keyToken, item, shardQuery, [pageKeys])](#module_entity-manager.EntityManager+query) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
+            * [.removeKeys(entityToken, item)](#module_entity-manager.EntityManager+removeKeys) ⇒ <code>object</code>
     * _inner_
         * [~ShardQueryResult](#module_entity-manager..ShardQueryResult) : <code>object</code>
         * [~ShardQueryFunction](#module_entity-manager..ShardQueryFunction) ⇒ <code>Promise.&lt;ShardQueryResult&gt;</code>
@@ -239,6 +240,7 @@ Manage DynamoDb entities.
     * [.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, [pageKeys])](#module_entity-manager.EntityManager+query) ⇒ <code>Promise.&lt;ShardedQueryResult&gt;</code>
+    * [.removeKeys(entityToken, item)](#module_entity-manager.EntityManager+removeKeys) ⇒ <code>object</code>
 
 <a name="new_module_entity-manager.EntityManager_new"></a>
 
@@ -261,7 +263,7 @@ Create an EntityManager instance.
 <a name="module_entity-manager.EntityManager+addKeys"></a>
 
 #### entityManager.addKeys(entityToken, item, [overwrite]) ⇒ <code>object</code>
-Decorate an entity item with keys.
+Add sharded keys to an entity item. Does not mutate original item.
 
 **Kind**: instance method of [<code>EntityManager</code>](#module_entity-manager.EntityManager)  
 **Returns**: <code>object</code> - Decorated entity item.  
@@ -315,6 +317,24 @@ Query an entity across shards.
 | shardQuery | <code>ShardQueryFunction</code> | Sharded query function. |
 | [pageKeys] | <code>object</code> | Map of shard page keys. |
 
+<a name="module_entity-manager.EntityManager+removeKeys"></a>
+
+#### entityManager.removeKeys(entityToken, item) ⇒ <code>object</code>
+Remove sharded keys from an entity item. Does not mutate original item.
+
+**Kind**: instance method of [<code>EntityManager</code>](#module_entity-manager.EntityManager)  
+**Returns**: <code>object</code> - Stripped entity item.  
+**Throws**:
+
+- <code>Error</code> If entityToken is invalid.
+- <code>Error</code> If item is invalid.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| entityToken | <code>string</code> | Entity token. |
+| item | <code>object</code> | Entity item. |
+
 <a name="module_entity-manager..ShardQueryResult"></a>
 
 ### entity-manager~ShardQueryResult : <code>object</code>

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

@@ -10,6 +10,7 @@ var _fromPairs2 = _interopRequireDefault(require("lodash/fromPairs"));
 var _sortedUniq2 = _interopRequireDefault(require("lodash/sortedUniq"));
 var _forEach2 = _interopRequireDefault(require("lodash/forEach"));
 var _isNil2 = _interopRequireDefault(require("lodash/isNil"));
+var _cloneDeep2 = _interopRequireDefault(require("lodash/cloneDeep"));
 var _PrivateEntityManager = require("./PrivateEntityManager.js");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _classPrivateFieldInitSpec(obj, privateMap, value) { _checkPrivateRedeclaration(obj, privateMap); privateMap.set(obj, value); }
@@ -52,7 +53,7 @@ class EntityManager {
   }
 
   /**
-   * Decorate an entity item with keys.
+   * Add sharded keys to an entity item. Does not mutate original item.
    *
    * @param {string} entityToken - Entity token.
    * @param {object} item - Entity item.
@@ -65,6 +66,12 @@ class EntityManager {
     let overwrite = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     _classPrivateFieldGet(this, _entityManager).logger.debug(`adding sharded index keys to ${entityToken}${overwrite ? ' with overwrite' : ''}...`, item);
 
+    // Validate item.
+    _classPrivateFieldGet(this, _entityManager).validateItem(item);
+
+    // Clone item.
+    const newItem = (0, _cloneDeep2.default)(item);
+
     // Get entity config.
     const {
       shardKeyToken
@@ -75,22 +82,21 @@ class EntityManager {
     } = _classPrivateFieldGet(this, _entityManager).getEntityConfig(entityToken);
 
     // Add shardKey.
-    _classPrivateFieldGet(this, _entityManager).validateItem(item);
-    if (overwrite || (0, _isNil2.default)(item[shardKeyToken])) {
-      const entityKey = sharding.entityKey(item);
-      const timestamp = sharding.timestamp(item);
-      item[shardKeyToken] = _classPrivateFieldGet(this, _entityManager).getShardKey(entityToken, entityKey, timestamp);
+    if (overwrite || (0, _isNil2.default)(newItem[shardKeyToken])) {
+      const entityKey = sharding.entityKey(newItem);
+      const timestamp = sharding.timestamp(newItem);
+      newItem[shardKeyToken] = _classPrivateFieldGet(this, _entityManager).getShardKey(entityToken, entityKey, timestamp);
     }
 
     // Add keys.
     (0, _forEach2.default)(keys, (getValue, key) => {
-      if (overwrite || (0, _isNil2.default)(item[key])) item[key] = getValue(item);
+      if (overwrite || (0, _isNil2.default)(newItem[key])) newItem[key] = getValue(newItem);
     });
-    _classPrivateFieldGet(this, _entityManager).logger.debug('done', item);
+    _classPrivateFieldGet(this, _entityManager).logger.debug('done', newItem);
 
     // Remove undefined shardKey.
-    if ((0, _isNil2.default)(item[shardKeyToken])) delete item[shardKeyToken];
-    return item;
+    if ((0, _isNil2.default)(newItem[shardKeyToken])) delete newItem[shardKeyToken];
+    return newItem;
   }
 
   /**
@@ -194,5 +200,42 @@ class EntityManager {
     });
     return result;
   }
+
+  /**
+   * Remove sharded keys from an entity item. Does not mutate original item.
+   *
+   * @param {string} entityToken - Entity token.
+   * @param {object} item - Entity item.
+   * @returns {object} Stripped entity item.
+   * @throws {Error} If entityToken is invalid.
+   * @throws {Error} If item is invalid.
+   */
+  removeKeys(entityToken, item) {
+    _classPrivateFieldGet(this, _entityManager).logger.debug(`removing sharded index keys from ${entityToken}...`, item);
+
+    // Validate item.
+    _classPrivateFieldGet(this, _entityManager).validateItem(item);
+
+    // Clone item.
+    const newItem = (0, _cloneDeep2.default)(item);
+
+    // Get entity config.
+    const {
+      shardKeyToken
+    } = _classPrivateFieldGet(this, _entityManager);
+    const {
+      keys
+    } = _classPrivateFieldGet(this, _entityManager).getEntityConfig(entityToken);
+
+    // Remove shardKey.
+    delete newItem[shardKeyToken];
+
+    // Remove keys.
+    (0, _forEach2.default)(keys, (getValue, key) => {
+      delete newItem[key];
+    });
+    _classPrivateFieldGet(this, _entityManager).logger.debug('done', newItem);
+    return newItem;
+  }
 }
 exports.EntityManager = EntityManager;

package/lib/EntityManager/EntityManager.js

@@ -29,7 +29,7 @@ export class EntityManager {
   }
 
   /**
-   * Decorate an entity item with keys.
+   * Add sharded keys to an entity item. Does not mutate original item.
    *
    * @param {string} entityToken - Entity token.
    * @param {object} item - Entity item.
@@ -46,16 +46,21 @@ export class EntityManager {
       item
     );
 
+    // Validate item.
+    this.#entityManager.validateItem(item);
+
+    // Clone item.
+    const newItem = _.cloneDeep(item);
+
     // Get entity config.
     const { shardKeyToken } = this.#entityManager;
     const { keys, sharding } = this.#entityManager.getEntityConfig(entityToken);
 
     // Add shardKey.
-    this.#entityManager.validateItem(item);
-    if (overwrite || _.isNil(item[shardKeyToken])) {
-      const entityKey = sharding.entityKey(item);
-      const timestamp = sharding.timestamp(item);
-      item[shardKeyToken] = this.#entityManager.getShardKey(
+    if (overwrite || _.isNil(newItem[shardKeyToken])) {
+      const entityKey = sharding.entityKey(newItem);
+      const timestamp = sharding.timestamp(newItem);
+      newItem[shardKeyToken] = this.#entityManager.getShardKey(
         entityToken,
         entityKey,
         timestamp
@@ -64,14 +69,14 @@ export class EntityManager {
 
     // Add keys.
     _.forEach(keys, (getValue, key) => {
-      if (overwrite || _.isNil(item[key])) item[key] = getValue(item);
+      if (overwrite || _.isNil(newItem[key])) newItem[key] = getValue(newItem);
     });
-    this.#entityManager.logger.debug('done', item);
+    this.#entityManager.logger.debug('done', newItem);
 
     // Remove undefined shardKey.
-    if (_.isNil(item[shardKeyToken])) delete item[shardKeyToken];
+    if (_.isNil(newItem[shardKeyToken])) delete newItem[shardKeyToken];
 
-    return item;
+    return newItem;
   }
 
   /**
@@ -184,4 +189,41 @@ export class EntityManager {
 
     return result;
   }
+
+  /**
+   * Remove sharded keys from an entity item. Does not mutate original item.
+   *
+   * @param {string} entityToken - Entity token.
+   * @param {object} item - Entity item.
+   * @returns {object} Stripped entity item.
+   * @throws {Error} If entityToken is invalid.
+   * @throws {Error} If item is invalid.
+   */
+  removeKeys(entityToken, item) {
+    this.#entityManager.logger.debug(
+      `removing sharded index keys from ${entityToken}...`,
+      item
+    );
+
+    // Validate item.
+    this.#entityManager.validateItem(item);
+
+    // Clone item.
+    const newItem = _.cloneDeep(item);
+
+    // Get entity config.
+    const { shardKeyToken } = this.#entityManager;
+    const { keys } = this.#entityManager.getEntityConfig(entityToken);
+
+    // Remove shardKey.
+    delete newItem[shardKeyToken];
+
+    // Remove keys.
+    _.forEach(keys, (getValue, key) => {
+      delete newItem[key];
+    });
+    this.#entityManager.logger.debug('done', newItem);
+
+    return newItem;
+  }
 }

package/package.json

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