@karmaniverous/entity-manager 2.1.0 → 2.1.2

package/README.md

@@ -221,10 +221,10 @@ 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>
             * [.calcShardKey(entityToken, item)](#module_entity-manager.EntityManager+calcShardKey) ⇒ <code>string</code>
-            * [.dehydrateIndex(entityToken, indexToken, item, [delimiter])](#module_entity-manager.EntityManager+dehydrateIndex) ⇒ <code>string</code>
-            * [.rehydrateIndex(entityToken, indexToken, value, [delimiter])](#module_entity-manager.EntityManager+rehydrateIndex) ⇒ <code>object</code>
+            * [.dehydrateIndex(entityToken, indexToken, index, [delimiter])](#module_entity-manager.EntityManager+dehydrateIndex) ⇒ <code>string</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>
             * [.removeKeys(entityToken, item)](#module_entity-manager.EntityManager+removeKeys) ⇒ <code>object</code>
     * _inner_
         * [~ShardQueryResult](#module_entity-manager..ShardQueryResult) : <code>object</code>
@@ -242,10 +242,10 @@ 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>
     * [.calcShardKey(entityToken, item)](#module_entity-manager.EntityManager+calcShardKey) ⇒ <code>string</code>
-    * [.dehydrateIndex(entityToken, indexToken, item, [delimiter])](#module_entity-manager.EntityManager+dehydrateIndex) ⇒ <code>string</code>
-    * [.rehydrateIndex(entityToken, indexToken, value, [delimiter])](#module_entity-manager.EntityManager+rehydrateIndex) ⇒ <code>object</code>
+    * [.dehydrateIndex(entityToken, indexToken, index, [delimiter])](#module_entity-manager.EntityManager+dehydrateIndex) ⇒ <code>string</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>
     * [.removeKeys(entityToken, item)](#module_entity-manager.EntityManager+removeKeys) ⇒ <code>object</code>
 
 <a name="new_module_entity-manager.EntityManager_new"></a>
@@ -300,8 +300,8 @@ Calculated the shard key for an entity item.
 
 <a name="module_entity-manager.EntityManager+dehydrateIndex"></a>
 
-#### entityManager.dehydrateIndex(entityToken, indexToken, item, [delimiter]) ⇒ <code>string</code>
-Convert a item into a delimited string containing the properties of a named index.
+#### entityManager.dehydrateIndex(entityToken, indexToken, index, [delimiter]) ⇒ <code>string</code>
+Condense an index object into a delimited string.
 
 **Kind**: instance method of [<code>EntityManager</code>](#module_entity-manager.EntityManager)  
 **Returns**: <code>string</code> - Dehydrated index.  
@@ -316,27 +316,7 @@ Convert a item into a delimited string containing the properties of a named inde
 | --- | --- | --- | --- |
 | entityToken | <code>string</code> |  | Entity token. |
 | indexToken | <code>string</code> |  | Index token. |
-| item | <code>object</code> |  | Entity item. |
-| [delimiter] | <code>string</code> | <code>&quot;~&quot;</code> | Delimiter. |
-
-<a name="module_entity-manager.EntityManager+rehydrateIndex"></a>
-
-#### entityManager.rehydrateIndex(entityToken, indexToken, value, [delimiter]) ⇒ <code>object</code>
-Convert a delimited string into a named index key.
-
-**Kind**: instance method of [<code>EntityManager</code>](#module_entity-manager.EntityManager)  
-**Returns**: <code>object</code> - Rehydrated index key.  
-**Throws**:
-
-- <code>Error</code> If entityToken is invalid.
-- <code>Error</code> If indexToken is invalid.
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| entityToken | <code>string</code> |  | Entity token. |
-| indexToken | <code>string</code> |  | Index token. |
-| value | <code>string</code> |  | Dehydrated index value. |
+| index | <code>object</code> |  | Index object. |
 | [delimiter] | <code>string</code> | <code>&quot;~&quot;</code> | Delimiter. |
 
 <a name="module_entity-manager.EntityManager+getKeySpace"></a>
@@ -379,6 +359,26 @@ Query an entity across shards.
 | [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>
+
+#### entityManager.rehydrateIndex(entityToken, indexToken, value, [delimiter]) ⇒ <code>object</code>
+Convert a delimited string into a named index key.
+
+**Kind**: instance method of [<code>EntityManager</code>](#module_entity-manager.EntityManager)  
+**Returns**: <code>object</code> - Rehydrated index key.  
+**Throws**:
+
+- <code>Error</code> If entityToken is invalid.
+- <code>Error</code> If indexToken is invalid.
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| entityToken | <code>string</code> |  | Entity token. |
+| indexToken | <code>string</code> |  | Index token. |
+| value | <code>string</code> |  | Dehydrated index value. |
+| [delimiter] | <code>string</code> | <code>&quot;~&quot;</code> | Delimiter. |
+
 <a name="module_entity-manager.EntityManager+removeKeys"></a>
 
 #### entityManager.removeKeys(entityToken, item) ⇒ <code>object</code>

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

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.EntityManager = void 0;
+var _zipObject2 = _interopRequireDefault(require("lodash/zipObject"));
 var _map2 = _interopRequireDefault(require("lodash/map"));
 var _size2 = _interopRequireDefault(require("lodash/size"));
 var _isEmpty2 = _interopRequireDefault(require("lodash/isEmpty"));
@@ -11,14 +12,11 @@ var _fromPairs2 = _interopRequireDefault(require("lodash/fromPairs"));
 var _isPlainObject2 = _interopRequireDefault(require("lodash/isPlainObject"));
 var _isInteger2 = _interopRequireDefault(require("lodash/isInteger"));
 var _isUndefined2 = _interopRequireDefault(require("lodash/isUndefined"));
-var _isFunction2 = _interopRequireDefault(require("lodash/isFunction"));
 var _sortedUniq2 = _interopRequireDefault(require("lodash/sortedUniq"));
-var _zipObject2 = _interopRequireDefault(require("lodash/zipObject"));
-var _flatten2 = _interopRequireDefault(require("lodash/flatten"));
-var _uniq2 = _interopRequireDefault(require("lodash/uniq"));
+var _entries2 = _interopRequireDefault(require("lodash/entries"));
 var _sortBy2 = _interopRequireDefault(require("lodash/sortBy"));
-var _pick2 = _interopRequireDefault(require("lodash/pick"));
-var _values2 = _interopRequireDefault(require("lodash/values"));
+var _sortedUniqBy2 = _interopRequireDefault(require("lodash/sortedUniqBy"));
+var _isFunction2 = _interopRequireDefault(require("lodash/isFunction"));
 var _forEach2 = _interopRequireDefault(require("lodash/forEach"));
 var _isNil2 = _interopRequireDefault(require("lodash/isNil"));
 var _cloneDeep2 = _interopRequireDefault(require("lodash/cloneDeep"));
@@ -33,7 +31,6 @@ function _classPrivateFieldSet(receiver, privateMap, value) { var descriptor = _
 function _classExtractFieldDescriptor(receiver, privateMap, action) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to " + action + " private field on non-instance"); } return privateMap.get(receiver); }
 function _classApplyDescriptorSet(receiver, descriptor, value) { if (descriptor.set) { descriptor.set.call(receiver, value); } else { if (!descriptor.writable) { throw new TypeError("attempted to set read only private field"); } descriptor.value = value; } }
 var _entityManager = /*#__PURE__*/new WeakMap();
-var _getIndexProperties = /*#__PURE__*/new WeakMap();
 /**
  * Manage DynamoDb entities.
  *
@@ -59,10 +56,6 @@ class EntityManager {
       writable: true,
       value: void 0
     });
-    _classPrivateFieldInitSpec(this, _getIndexProperties, {
-      writable: true,
-      value: (entityToken, indexComponents) => (0, _sortBy2.default)((0, _uniq2.default)((0, _flatten2.default)(indexComponents.map(keyToken => (0, _inspectParametersDeclaration.getParametersNames)(_classPrivateFieldGet(this, _entityManager).getKeyGenerator(entityToken, keyToken))))))
-    });
     _classPrivateFieldSet(this, _entityManager, new _PrivateEntityManager.PrivateEntityManager({
       config,
       logger
@@ -103,8 +96,11 @@ class EntityManager {
     }
 
     // Add keys.
-    (0, _forEach2.default)(keys, (getValue, key) => {
-      if (overwrite || (0, _isNil2.default)(newItem[key])) newItem[key] = getValue(newItem);
+    (0, _forEach2.default)(keys, (_ref2, key) => {
+      let {
+        encode
+      } = _ref2;
+      if (overwrite || (0, _isNil2.default)(newItem[key])) newItem[key] = encode(newItem);
     });
     _classPrivateFieldGet(this, _entityManager).logger.debug('done', newItem);
 
@@ -130,52 +126,42 @@ class EntityManager {
   }
 
   /**
-   * Convert a item into a delimited string containing the properties of a named index.
+   * Condense an index object into a delimited string.
    *
    * @param {string} entityToken - Entity token.
    * @param {string} indexToken - Index token.
-   * @param {object} item - Entity item.
+   * @param {object} index - Index object.
    * @param {string} [delimiter] - Delimiter.
    * @returns {string} Dehydrated index.
    * @throws {Error} If entityToken is invalid.
    * @throws {Error} If indexToken is invalid.
    * @throws {Error} If item is invalid.
    */
-  dehydrateIndex(entityToken, indexToken, item) {
+  dehydrateIndex(entityToken, indexToken, index) {
     let delimiter = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : '~';
     // Validate item.
-    _classPrivateFieldGet(this, _entityManager).validateItem(item);
+    _classPrivateFieldGet(this, _entityManager).validateItem(index);
     const indexComponents = _classPrivateFieldGet(this, _entityManager).getIndexComponents(entityToken, indexToken);
-    const indexProperties = _classPrivateFieldGet(this, _getIndexProperties).call(this, entityToken, indexComponents);
-    const {
-      shardKeyToken
-    } = _classPrivateFieldGet(this, _entityManager);
-    return (0, _values2.default)((0, _pick2.default)({
-      ...item,
-      [shardKeyToken]: this.calcShardKey(entityToken, item)
-    }, indexProperties)).join(delimiter);
-  }
-  /**
-   * Convert a delimited string into a named index key.
-   *
-   * @param {string} entityToken - Entity token.
-   * @param {string} indexToken - Index token.
-   * @param {string} value - Dehydrated index value.
-   * @param {string} [delimiter] - Delimiter.
-   * @returns {object} Rehydrated index key.
-   * @throws {Error} If entityToken is invalid.
-   * @throws {Error} If indexToken is invalid.
-   */
-  rehydrateIndex(entityToken, indexToken) {
-    let value = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
-    let delimiter = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : '~';
-    const indexComponents = _classPrivateFieldGet(this, _entityManager).getIndexComponents(entityToken, indexToken);
-    const indexProperties = _classPrivateFieldGet(this, _getIndexProperties).call(this, entityToken, indexComponents);
-    const item = (0, _zipObject2.default)(indexProperties, value.split(delimiter));
-    return indexComponents.reduce((index, component) => ({
-      ...index,
-      [component]: _classPrivateFieldGet(this, _entityManager).getKeyGenerator(entityToken, component)(item)
-    }), {});
+    const indexProperties = indexComponents.reduce((properties, component) => {
+      const {
+        decode
+      } = _classPrivateFieldGet(this, _entityManager).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 ?? [])
+      };
+    }, {});
+    return (0, _sortedUniqBy2.default)((0, _sortBy2.default)((0, _entries2.default)(indexProperties), _ref3 => {
+      let [key] = _ref3;
+      return key;
+    }), _ref4 => {
+      let [key] = _ref4;
+      return key;
+    }).map(_ref5 => {
+      let [, value] = _ref5;
+      return value;
+    }).join(delimiter);
   }
 
   /**
@@ -195,7 +181,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).getKeyGenerator(entityToken, keyToken)({
+    const result = (0, _sortedUniq2.default)(shardKeySpace.map(shardKey => _classPrivateFieldGet(this, _entityManager).getKey(entityToken, keyToken).encode({
       ...item,
       [_classPrivateFieldGet(this, _entityManager).shardKeyToken]: shardKey
     })));
@@ -266,11 +252,11 @@ class EntityManager {
     const shardQueryResults = await Promise.all((0, _map2.default)(pageKeys, (pageKey, shardedKey) => new Promise(resolve => shardQuery(shardedKey, {
       pageKey,
       limit: shardLimit
-    }).then(_ref2 => {
+    }).then(_ref6 => {
       let {
         items,
         pageKey
-      } = _ref2;
+      } = _ref6;
       return resolve({
         shardedKey,
         items,
@@ -279,12 +265,12 @@ class EntityManager {
     }))));
 
     // Reduce shardQueryResults into a single result.
-    const result = shardQueryResults.reduce((shardedQueryResult, _ref3) => {
+    const result = shardQueryResults.reduce((shardedQueryResult, _ref7) => {
       let {
         shardedKey,
         items,
         pageKey
-      } = _ref3;
+      } = _ref7;
       return {
         items: [...shardedQueryResult.items, ...items],
         pageKeys: {
@@ -301,6 +287,39 @@ class EntityManager {
     return result;
   }
 
+  /**
+   * Convert a delimited string into a named index key.
+   *
+   * @param {string} entityToken - Entity token.
+   * @param {string} indexToken - Index token.
+   * @param {string} value - Dehydrated index value.
+   * @param {string} [delimiter] - Delimiter.
+   * @returns {object} Rehydrated index key.
+   * @throws {Error} If entityToken is invalid.
+   * @throws {Error} If indexToken is invalid.
+   */
+  rehydrateIndex(entityToken, indexToken) {
+    let value = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
+    let delimiter = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : '~';
+    const indexComponents = _classPrivateFieldGet(this, _entityManager).getIndexComponents(entityToken, indexToken);
+    const indexKeys = (0, _sortBy2.default)(indexComponents.reduce((keys, component) => {
+      const {
+        encode
+      } = _classPrivateFieldGet(this, _entityManager).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);
+      return {
+        ...index,
+        [component]: encode(indexProperies)
+      };
+    }, {});
+  }
+
   /**
    * Remove sharded keys from an entity item. Does not mutate original item.
    *

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

@@ -12,8 +12,10 @@ var _filter2 = _interopRequireDefault(require("lodash/filter"));
 var _findLast2 = _interopRequireDefault(require("lodash/findLast"));
 var _has2 = _interopRequireDefault(require("lodash/has"));
 var _map2 = _interopRequireDefault(require("lodash/map"));
-var _isFunction2 = _interopRequireDefault(require("lodash/isFunction"));
 var _isNil2 = _interopRequireDefault(require("lodash/isNil"));
+var _isUndefined2 = _interopRequireDefault(require("lodash/isUndefined"));
+var _isFunction2 = _interopRequireDefault(require("lodash/isFunction"));
+var _forEach2 = _interopRequireDefault(require("lodash/forEach"));
 var _keys2 = _interopRequireDefault(require("lodash/keys"));
 var _difference2 = _interopRequireDefault(require("lodash/difference"));
 var _some2 = _interopRequireDefault(require("lodash/some"));
@@ -102,6 +104,15 @@ const configSchema = {
   },
   additionalProperties: false
 };
+const keySchema = {
+  type: 'object',
+  properties: {
+    encode: {},
+    decode: {}
+  },
+  additionalProperties: false,
+  required: ['encode']
+};
 
 /**
  * Private EntityManager implementation.
@@ -159,10 +170,7 @@ class PrivateEntityManager {
   set config(value) {
     // Validate config against schema.
     const validatorResult = (0, _jsonschema.validate)(value, configSchema);
-    if (!validatorResult.valid) {
-      validatorResult.errors.forEach(error => this.logger.error(error.message));
-      throw new Error(validatorResult.errors);
-    }
+    if (!validatorResult.valid) throw new Error(validatorResult.errors);
 
     // Conform config.
     const {
@@ -197,7 +205,7 @@ class PrivateEntityManager {
       shardKeyToken
     };
 
-    // Validate entity properties.
+    // Conform & validate entity properties.
     (0, _some2.default)(conformedConfig.entities, (_ref2, entityToken) => {
       let {
         indexes,
@@ -213,69 +221,47 @@ class PrivateEntityManager {
       // Validate entity index components are entity keys.
       (0, _some2.default)(indexes, (index, indexToken) => {
         const invalidIndexComponents = (0, _difference2.default)(index, (0, _keys2.default)(keys));
-        if (invalidIndexComponents.length) {
-          const message = `${entityToken} index '${indexToken}' components '${invalidIndexComponents}' are not entity keys.`;
-          this.logger.error(message);
-          throw new Error(message);
-        } else return false;
+        if (invalidIndexComponents.length) throw new Error(`${entityToken} index '${indexToken}' components '${invalidIndexComponents}' are not entity keys.`);else return false;
       });
 
-      // Validate entity keys are functions or undefined.
-      (0, _some2.default)(keys, (value, key) => {
-        if (!(0, _isNil2.default)(value) && !(0, _isFunction2.default)(value)) {
-          const message = `${entityToken} key '${key}' must be a function or nil.`;
-          this.logger.error(message);
-          throw new Error(message);
-        } else return false;
+      // Conform & validate entity keys.
+      (0, _forEach2.default)(keys, (value, key) => {
+        keys[key] = (0, _isFunction2.default)(value) ? {
+          encode: value
+        } : value;
+
+        // Validate key against schema.
+        const validatorResult = (0, _jsonschema.validate)(keys[key], keySchema);
+        if (!validatorResult.valid) throw new Error(validatorResult.errors);
+        const {
+          decode
+        } = keys[key];
+        if (!(0, _isUndefined2.default)(decode) && !(0, _isFunction2.default)(decode)) throw new Error(`entity ${entityKey} key '${key}' decode must be a function or undefined.`);
       });
 
       // Validate sharding bump values increase monotonically with keys.
       (0, _some2.default)((0, _toPairs2.default)(bumps), (_ref3, i, c) => {
         let [bump, value] = _ref3;
         const [lastBump, lastValue] = i ? c[i - 1] : [];
-        if (value <= lastValue) {
-          const message = `${entityToken} sharding bumps do not monotonically increase from '${lastBump}: ${lastValue}' to '${bump}: ${value}'.)`;
-          this.logger.error(message);
-          throw new Error(message);
-        } else return false;
+        if (value <= lastValue) throw new Error(`${entityToken} sharding bumps do not monotonically increase from '${lastBump}: ${lastValue}' to '${bump}: ${value}'.)`);else return false;
       });
 
       // Validate sharding entityKey is a function or undefined.
-      if (!(0, _isNil2.default)(entityKey) && !(0, _isFunction2.default)(entityKey)) {
-        const message = `${entityToken} sharding entityKey must be a function or nil`;
-        this.logger.error(message);
-        throw new Error(message);
-      }
+      if (!(0, _isNil2.default)(entityKey) && !(0, _isFunction2.default)(entityKey)) throw new Error(`${entityToken} sharding entityKey must be a function or nil`);
 
       // Validate sharding nibbles do not exceed 32 bits.
-      if (nibbles * nibbleBits > 32) {
-        const message = `${entityToken} nibbles (${nibbles} nibbles at ${nibbleBits} nibbleBits) exceed 32 bits`;
-        this.logger.error(message);
-        throw new Error(message);
-      }
+      if (nibbles * nibbleBits > 32) throw new Error(`${entityToken} nibbles (${nibbles} nibbles at ${nibbleBits} nibbleBits) exceed 32 bits`);
 
       // Validate sharding nibbles are less than first bump value.
       const firstBumpValue = (0, _map2.default)(bumps)[0];
-      if (nibbles >= firstBumpValue) {
-        const message = `${entityToken} nibbles (${nibbles}) not less than minimum bump value (${firstBumpValue})`;
-        this.logger.error(message);
-        throw new Error(message);
-      }
+      if (nibbles >= firstBumpValue) throw new Error(`${entityToken} nibbles (${nibbles}) not less than minimum bump value (${firstBumpValue})`);
 
       // Validate last bump value does not exceed 32 bits.
       const lastBumpValue = (0, _map2.default)(bumps).slice(-1);
-      if (lastBumpValue * nibbleBits > 32) {
-        const message = `${entityToken} maximum bump value (${lastBumpValue} nibbles at ${nibbleBits} nibbleBits) exceed 32 bits`;
-        this.logger.error(message);
-        throw new Error(message);
-      }
+      if (lastBumpValue * nibbleBits > 32) throw new Error(`${entityToken} maximum bump value (${lastBumpValue} nibbles at ${nibbleBits} nibbleBits) exceed 32 bits`);
 
       // Validate sharding timestamp is a function or undefined.
-      if (!(0, _isNil2.default)(timestamp) && !(0, _isFunction2.default)(timestamp)) {
-        const message = `${entityToken} sharding timestamp must be a function or nil.`;
-        this.logger.error(message);
-        throw new Error(message);
-      } else return false;
+      if (!(0, _isNil2.default)(timestamp) && !(0, _isFunction2.default)(timestamp)) throw new Error(`${entityToken} sharding timestamp must be a function or nil.`);else return false;
     });
     _classPrivateFieldSet(this, _config, conformedConfig);
   }
@@ -313,22 +299,14 @@ class PrivateEntityManager {
     const {
       indexes
     } = this.getEntityConfig(entityToken);
-    if (!(0, _has2.default)(indexes, indexToken)) {
-      const message = `Index '${indexToken}' does not exist for entity '${entityToken}'.`;
-      this.logger.error(message);
-      throw new Error(message);
-    }
+    if (!(0, _has2.default)(indexes, indexToken)) throw new Error(`Index '${indexToken}' does not exist for entity '${entityToken}'.`);
     return indexes[indexToken];
   }
-  getKeyGenerator(entityToken, keyToken) {
+  getKey(entityToken, keyToken) {
     const {
       keys
     } = this.getEntityConfig(entityToken);
-    if (!(0, _has2.default)(keys, keyToken)) {
-      const message = `Key '${keyToken}' does not exist for entity '${entityToken}'.`;
-      this.logger.error(message);
-      throw new Error(message);
-    }
+    if (!(0, _has2.default)(keys, keyToken)) throw new Error(`Key '${keyToken}' does not exist for entity '${entityToken}'.`);
     return keys[keyToken];
   }
 
@@ -408,11 +386,17 @@ class PrivateEntityManager {
    * @returns {boolean} true if entityToken is valid.
    */
   validateEntityToken(entityToken) {
-    if (!this.config.entities[entityToken]) {
-      const message = `Invalid entityToken: ${entityToken}`;
-      this.logger.error(message);
-      throw new Error(message);
-    } else return true;
+    if (!this.config.entities[entityToken]) throw new Error(`Invalid entityToken: ${entityToken}`);else return true;
+  }
+
+  /**
+   * Tests whether an item is valid.
+   *
+   * @param {string} item - Entity token.
+   * @returns {boolean} true if entityToken is valid.
+   */
+  validateItem(item) {
+    if (!(0, _isPlainObject2.default)(item)) throw new Error(`Invalid item: ${item}`);else return true;
   }
 
   /**
@@ -424,25 +408,7 @@ class PrivateEntityManager {
    */
   validateKeyToken(entityToken, keyToken) {
     this.validateEntityToken(entityToken);
-    if (!this.config.entities[entityToken].keys[keyToken]) {
-      const message = `Invalid entity ${entityToken} keyToken: ${keyToken}`;
-      this.logger.error(message);
-      throw new Error(message);
-    } else return true;
-  }
-
-  /**
-   * Tests whether an item is valid.
-   *
-   * @param {string} item - Entity token.
-   * @returns {boolean} true if entityToken is valid.
-   */
-  validateItem(item) {
-    if (!(0, _isPlainObject2.default)(item)) {
-      const message = `Invalid item: ${item}`;
-      this.logger.error(message);
-      throw new Error(message);
-    } else return true;
+    if (!this.config.entities[entityToken].keys[keyToken]) throw new Error(`Invalid entity ${entityToken} keyToken: ${keyToken}`);else return true;
   }
 
   /**

package/lib/EntityManager/EntityManager.js

@@ -63,8 +63,8 @@ export class EntityManager {
     }
 
     // Add keys.
-    _.forEach(keys, (getValue, key) => {
-      if (overwrite || _.isNil(newItem[key])) newItem[key] = getValue(newItem);
+    _.forEach(keys, ({ encode }, key) => {
+      if (overwrite || _.isNil(newItem[key])) newItem[key] = encode(newItem);
     });
     this.#entityManager.logger.debug('done', newItem);
 
@@ -90,90 +90,42 @@ export class EntityManager {
   }
 
   /**
-   * Convert a item into a delimited string containing the properties of a named index.
+   * Condense an index object into a delimited string.
    *
    * @param {string} entityToken - Entity token.
    * @param {string} indexToken - Index token.
-   * @param {object} item - Entity item.
+   * @param {object} index - Index object.
    * @param {string} [delimiter] - Delimiter.
    * @returns {string} Dehydrated index.
    * @throws {Error} If entityToken is invalid.
    * @throws {Error} If indexToken is invalid.
    * @throws {Error} If item is invalid.
    */
-  dehydrateIndex(entityToken, indexToken, item, delimiter = '~') {
+  dehydrateIndex(entityToken, indexToken, index, delimiter = '~') {
     // Validate item.
-    this.#entityManager.validateItem(item);
-
-    const indexComponents = this.#entityManager.getIndexComponents(
-      entityToken,
-      indexToken
-    );
+    this.#entityManager.validateItem(index);
 
-    const indexProperties = this.#getIndexProperties(
-      entityToken,
-      indexComponents
-    );
-
-    const { shardKeyToken } = this.#entityManager;
-    return _.values(
-      _.pick(
-        {
-          ...item,
-          [shardKeyToken]: this.calcShardKey(entityToken, item),
-        },
-        indexProperties
-      )
-    ).join(delimiter);
-  }
-
-  #getIndexProperties = (entityToken, indexComponents) =>
-    _.sortBy(
-      _.uniq(
-        _.flatten(
-          indexComponents.map((keyToken) =>
-            getParametersNames(
-              this.#entityManager.getKeyGenerator(entityToken, keyToken)
-            )
-          )
-        )
-      )
-    );
-
-  /**
-   * Convert a delimited string into a named index key.
-   *
-   * @param {string} entityToken - Entity token.
-   * @param {string} indexToken - Index token.
-   * @param {string} value - Dehydrated index value.
-   * @param {string} [delimiter] - Delimiter.
-   * @returns {object} Rehydrated index key.
-   * @throws {Error} If entityToken is invalid.
-   * @throws {Error} If indexToken is invalid.
-   */
-  rehydrateIndex(entityToken, indexToken, value = '', delimiter = '~') {
     const indexComponents = this.#entityManager.getIndexComponents(
       entityToken,
       indexToken
     );
 
-    const indexProperties = this.#getIndexProperties(
-      entityToken,
-      indexComponents
-    );
-
-    const item = _.zipObject(indexProperties, value.split(delimiter));
-
-    return indexComponents.reduce(
-      (index, component) => ({
-        ...index,
-        [component]: this.#entityManager.getKeyGenerator(
-          entityToken,
-          component
-        )(item),
-      }),
-      {}
-    );
+    const indexProperties = indexComponents.reduce((properties, component) => {
+      const { decode } = this.#entityManager.getKey(entityToken, component);
+      if (!_.isFunction(decode))
+        throw new Error(
+          `no decode function defined on ${entityToken} entity key '${component}'`
+        );
+
+      return { ...properties, ...(decode(index[component])?.groups ?? []) };
+    }, {});
+
+    return _.sortedUniqBy(
+      _.sortBy(_.entries(indexProperties), ([key]) => key),
+      ([key]) => key
+    )
+      .map(([, value]) => value)
+      .join(delimiter);
   }
 
   /**
@@ -202,10 +154,7 @@ export class EntityManager {
 
     const result = _.sortedUniq(
       shardKeySpace.map((shardKey) =>
-        this.#entityManager.getKeyGenerator(
-          entityToken,
-          keyToken
-        )({
+        this.#entityManager.getKey(entityToken, keyToken).encode({
           ...item,
           [this.#entityManager.shardKeyToken]: shardKey,
         })
@@ -312,6 +261,38 @@ export class EntityManager {
     return result;
   }
 
+  /**
+   * Convert a delimited string into a named index key.
+   *
+   * @param {string} entityToken - Entity token.
+   * @param {string} indexToken - Index token.
+   * @param {string} value - Dehydrated index value.
+   * @param {string} [delimiter] - Delimiter.
+   * @returns {object} Rehydrated index key.
+   * @throws {Error} If entityToken is invalid.
+   * @throws {Error} If indexToken is invalid.
+   */
+  rehydrateIndex(entityToken, indexToken, value = '', delimiter = '~') {
+    const indexComponents = this.#entityManager.getIndexComponents(
+      entityToken,
+      indexToken
+    );
+
+    const indexKeys = _.sortBy(
+      indexComponents.reduce((keys, component) => {
+        const { encode } = this.#entityManager.getKey(entityToken, component);
+        return [...new Set([...keys, ...getParametersNames(encode)]).values()];
+      }, [])
+    );
+
+    const indexProperies = _.zipObject(indexKeys, value.split(delimiter));
+
+    return indexComponents.reduce((index, component) => {
+      const { encode } = this.#entityManager.getKey(entityToken, component);
+      return { ...index, [component]: encode(indexProperies) };
+    }, {});
+  }
+
   /**
    * Remove sharded keys from an entity item. Does not mutate original item.
    *

package/lib/EntityManager/PrivateEntityManager.js

@@ -67,6 +67,16 @@ const configSchema = {
   additionalProperties: false,
 };
 
+const keySchema = {
+  type: 'object',
+  properties: {
+    encode: {},
+    decode: {},
+  },
+  additionalProperties: false,
+  required: ['encode'],
+};
+
 /**
  * Private EntityManager implementation.
  *
@@ -114,12 +124,7 @@ export class PrivateEntityManager {
   set config(value) {
     // Validate config against schema.
     const validatorResult = validate(value, configSchema);
-    if (!validatorResult.valid) {
-      validatorResult.errors.forEach((error) =>
-        this.logger.error(error.message)
-      );
-      throw new Error(validatorResult.errors);
-    }
+    if (!validatorResult.valid) throw new Error(validatorResult.errors);
 
     // Conform config.
     const { entities = {}, shardKeyToken = 'shardId' } = value;
@@ -151,7 +156,7 @@ export class PrivateEntityManager {
       shardKeyToken,
     };
 
-    // Validate entity properties.
+    // Conform & validate entity properties.
     _.some(
       conformedConfig.entities,
       (
@@ -165,68 +170,70 @@ export class PrivateEntityManager {
         // Validate entity index components are entity keys.
         _.some(indexes, (index, indexToken) => {
           const invalidIndexComponents = _.difference(index, _.keys(keys));
-          if (invalidIndexComponents.length) {
-            const message = `${entityToken} index '${indexToken}' components '${invalidIndexComponents}' are not entity keys.`;
-            this.logger.error(message);
-            throw new Error(message);
-          } else return false;
+          if (invalidIndexComponents.length)
+            throw new Error(
+              `${entityToken} index '${indexToken}' components '${invalidIndexComponents}' are not entity keys.`
+            );
+          else return false;
         });
 
-        // Validate entity keys are functions or undefined.
-        _.some(keys, (value, key) => {
-          if (!_.isNil(value) && !_.isFunction(value)) {
-            const message = `${entityToken} key '${key}' must be a function or nil.`;
-            this.logger.error(message);
-            throw new Error(message);
-          } else return false;
+        // Conform & validate entity keys.
+        _.forEach(keys, (value, key) => {
+          keys[key] = _.isFunction(value) ? { encode: value } : value;
+
+          // Validate key against schema.
+          const validatorResult = validate(keys[key], keySchema);
+          if (!validatorResult.valid) throw new Error(validatorResult.errors);
+
+          const { decode } = keys[key];
+          if (!_.isUndefined(decode) && !_.isFunction(decode))
+            throw new Error(
+              `entity ${entityKey} key '${key}' decode must be a function or undefined.`
+            );
         });
 
         // Validate sharding bump values increase monotonically with keys.
         _.some(_.toPairs(bumps), ([bump, value], i, c) => {
           const [lastBump, lastValue] = i ? c[i - 1] : [];
-          if (value <= lastValue) {
-            const message = `${entityToken} sharding bumps do not monotonically increase from '${lastBump}: ${lastValue}' to '${bump}: ${value}'.)`;
-            this.logger.error(message);
-            throw new Error(message);
-          } else return false;
+          if (value <= lastValue)
+            throw new Error(
+              `${entityToken} sharding bumps do not monotonically increase from '${lastBump}: ${lastValue}' to '${bump}: ${value}'.)`
+            );
+          else return false;
         });
 
         // Validate sharding entityKey is a function or undefined.
-        if (!_.isNil(entityKey) && !_.isFunction(entityKey)) {
-          const message = `${entityToken} sharding entityKey must be a function or nil`;
-          this.logger.error(message);
-          throw new Error(message);
-        }
+        if (!_.isNil(entityKey) && !_.isFunction(entityKey))
+          throw new Error(
+            `${entityToken} sharding entityKey must be a function or nil`
+          );
 
         // Validate sharding nibbles do not exceed 32 bits.
-        if (nibbles * nibbleBits > 32) {
-          const message = `${entityToken} nibbles (${nibbles} nibbles at ${nibbleBits} nibbleBits) exceed 32 bits`;
-          this.logger.error(message);
-          throw new Error(message);
-        }
+        if (nibbles * nibbleBits > 32)
+          throw new Error(
+            `${entityToken} nibbles (${nibbles} nibbles at ${nibbleBits} nibbleBits) exceed 32 bits`
+          );
 
         // Validate sharding nibbles are less than first bump value.
         const firstBumpValue = _.map(bumps)[0];
-        if (nibbles >= firstBumpValue) {
-          const message = `${entityToken} nibbles (${nibbles}) not less than minimum bump value (${firstBumpValue})`;
-          this.logger.error(message);
-          throw new Error(message);
-        }
+        if (nibbles >= firstBumpValue)
+          throw new Error(
+            `${entityToken} nibbles (${nibbles}) not less than minimum bump value (${firstBumpValue})`
+          );
 
         // Validate last bump value does not exceed 32 bits.
         const lastBumpValue = _.map(bumps).slice(-1);
-        if (lastBumpValue * nibbleBits > 32) {
-          const message = `${entityToken} maximum bump value (${lastBumpValue} nibbles at ${nibbleBits} nibbleBits) exceed 32 bits`;
-          this.logger.error(message);
-          throw new Error(message);
-        }
+        if (lastBumpValue * nibbleBits > 32)
+          throw new Error(
+            `${entityToken} maximum bump value (${lastBumpValue} nibbles at ${nibbleBits} nibbleBits) exceed 32 bits`
+          );
 
         // Validate sharding timestamp is a function or undefined.
-        if (!_.isNil(timestamp) && !_.isFunction(timestamp)) {
-          const message = `${entityToken} sharding timestamp must be a function or nil.`;
-          this.logger.error(message);
-          throw new Error(message);
-        } else return false;
+        if (!_.isNil(timestamp) && !_.isFunction(timestamp))
+          throw new Error(
+            `${entityToken} sharding timestamp must be a function or nil.`
+          );
+        else return false;
       }
     );
 
@@ -266,23 +273,21 @@ export class PrivateEntityManager {
   getIndexComponents(entityToken, indexToken) {
     const { indexes } = this.getEntityConfig(entityToken);
 
-    if (!_.has(indexes, indexToken)) {
-      const message = `Index '${indexToken}' does not exist for entity '${entityToken}'.`;
-      this.logger.error(message);
-      throw new Error(message);
-    }
+    if (!_.has(indexes, indexToken))
+      throw new Error(
+        `Index '${indexToken}' does not exist for entity '${entityToken}'.`
+      );
 
     return indexes[indexToken];
   }
 
-  getKeyGenerator(entityToken, keyToken) {
+  getKey(entityToken, keyToken) {
     const { keys } = this.getEntityConfig(entityToken);
 
-    if (!_.has(keys, keyToken)) {
-      const message = `Key '${keyToken}' does not exist for entity '${entityToken}'.`;
-      this.logger.error(message);
-      throw new Error(message);
-    }
+    if (!_.has(keys, keyToken))
+      throw new Error(
+        `Key '${keyToken}' does not exist for entity '${entityToken}'.`
+      );
 
     return keys[keyToken];
   }
@@ -376,11 +381,20 @@ export class PrivateEntityManager {
    * @returns {boolean} true if entityToken is valid.
    */
   validateEntityToken(entityToken) {
-    if (!this.config.entities[entityToken]) {
-      const message = `Invalid entityToken: ${entityToken}`;
-      this.logger.error(message);
-      throw new Error(message);
-    } else return true;
+    if (!this.config.entities[entityToken])
+      throw new Error(`Invalid entityToken: ${entityToken}`);
+    else return true;
+  }
+
+  /**
+   * Tests whether an item is valid.
+   *
+   * @param {string} item - Entity token.
+   * @returns {boolean} true if entityToken is valid.
+   */
+  validateItem(item) {
+    if (!_.isPlainObject(item)) throw new Error(`Invalid item: ${item}`);
+    else return true;
   }
 
   /**
@@ -393,25 +407,9 @@ export class PrivateEntityManager {
   validateKeyToken(entityToken, keyToken) {
     this.validateEntityToken(entityToken);
 
-    if (!this.config.entities[entityToken].keys[keyToken]) {
-      const message = `Invalid entity ${entityToken} keyToken: ${keyToken}`;
-      this.logger.error(message);
-      throw new Error(message);
-    } else return true;
-  }
-
-  /**
-   * Tests whether an item is valid.
-   *
-   * @param {string} item - Entity token.
-   * @returns {boolean} true if entityToken is valid.
-   */
-  validateItem(item) {
-    if (!_.isPlainObject(item)) {
-      const message = `Invalid item: ${item}`;
-      this.logger.error(message);
-      throw new Error(message);
-    } else return true;
+    if (!this.config.entities[entityToken].keys[keyToken])
+      throw new Error(`Invalid entity ${entityToken} keyToken: ${keyToken}`);
+    else return true;
   }
 
   /**

package/package.json

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