@karmaniverous/entity-manager 5.0.8 → 6.0.0

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

@@ -1,421 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.PrivateEntityManager = exports.DEFAULT_PAGE_SIZE = exports.DEFAULT_LIMIT = void 0;
-var _isInteger2 = _interopRequireDefault(require("lodash/isInteger"));
-var _isPlainObject2 = _interopRequireDefault(require("lodash/isPlainObject"));
-var _range2 = _interopRequireDefault(require("lodash/range"));
-var _flatten2 = _interopRequireDefault(require("lodash/flatten"));
-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 _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"));
-var _toPairs2 = _interopRequireDefault(require("lodash/toPairs"));
-var _sortBy2 = _interopRequireDefault(require("lodash/sortBy"));
-var _fromPairs2 = _interopRequireDefault(require("lodash/fromPairs"));
-var _mapValues2 = _interopRequireDefault(require("lodash/mapValues"));
-var _jsonschema = require("jsonschema");
-var _stringHash = _interopRequireDefault(require("string-hash"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const DEFAULT_LIMIT = exports.DEFAULT_LIMIT = 10;
-const DEFAULT_PAGE_SIZE = exports.DEFAULT_PAGE_SIZE = 10;
-
-/**
- * EntityManager config validation schema.
- *
- * @private
- */
-const configSchema = {
-  type: 'object',
-  properties: {
-    entities: {
-      type: 'object',
-      patternProperties: {
-        '^\\w+$': {
-          type: 'object',
-          properties: {
-            defaultLimit: {
-              type: 'integer'
-            },
-            defaultPageSize: {
-              type: 'integer'
-            },
-            indexes: {
-              type: 'object',
-              additionalProperties: {
-                type: 'array',
-                items: {
-                  type: 'string'
-                },
-                minItems: 1
-              }
-            },
-            keys: {
-              type: 'object'
-            },
-            sharding: {
-              type: 'object',
-              properties: {
-                bumps: {
-                  type: 'object',
-                  patternProperties: {
-                    '^\\d+$': {
-                      type: 'integer',
-                      minimum: 0
-                    }
-                  },
-                  additionalProperties: false
-                },
-                entityKey: {
-                  type: 'function'
-                },
-                nibbleBits: {
-                  type: 'integer',
-                  minimum: 1,
-                  maximum: 5
-                },
-                nibbles: {
-                  type: 'integer',
-                  minimum: 0
-                },
-                timestamp: {
-                  type: 'function'
-                }
-              },
-              additionalProperties: false
-            }
-          },
-          additionalProperties: false
-        }
-      },
-      additionalProperties: false
-    },
-    shardKeyToken: {
-      type: 'string',
-      pattern: '^\\w+$'
-    }
-  },
-  additionalProperties: false
-};
-const keySchema = {
-  type: 'object',
-  properties: {
-    encode: {},
-    decode: {},
-    retain: {
-      type: 'boolean'
-    }
-  },
-  additionalProperties: false,
-  required: ['encode']
-};
-
-/**
- * Private EntityManager implementation.
- *
- * @private
- */
-class PrivateEntityManager {
-  #config;
-  #logger;
-
-  /**
-   * Create a PrivateEntityManager instance.
-   *
-   * @param {object} options - Options object.
-   * @param {object} [options.config] - EntityManager configuration object.
-   * @param {object} [options.logger] - Logger instance (defaults to console, must support error & debug methods).
-   * @throws {Error} If config is invalid.
-   * @throws {Error} If logger is invalid.
-   */
-  constructor() {
-    let {
-      config = {},
-      logger = console
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    // Validate logger.
-    if (!logger.error || !logger.debug) throw new Error('logger must implement error & debug methods.');
-    this.#logger = logger;
-    this.config = config;
-  }
-
-  /**
-   * Get the current config.
-   *
-   * @returns {object} Current config.
-   */
-  get config() {
-    return this.#config;
-  }
-
-  /**
-   * Set the current config.
-   *
-   * @param {object} value - Config object.
-   * @throws {Error} If config is invalid.
-   * @throws {Error} If entity bumps do not monotonically increase.
-   * @throws {Error} If entity nibbles are greater than minimum bump value.
-   */
-  set config(value) {
-    // Validate config against schema.
-    const validatorResult = (0, _jsonschema.validate)(value, configSchema);
-    if (!validatorResult.valid) throw new Error(validatorResult.errors);
-
-    // Conform config.
-    const {
-      entities = {},
-      shardKeyToken = 'shardId'
-    } = value;
-    const conformedConfig = {
-      entities: (0, _mapValues2.default)(entities, _ref => {
-        let {
-          defaultLimit = DEFAULT_LIMIT,
-          defaultPageSize = DEFAULT_PAGE_SIZE,
-          indexes = {},
-          keys = {},
-          sharding: {
-            bumps = {},
-            entityKey,
-            nibbleBits = 1,
-            nibbles = 0,
-            timestamp
-          } = {}
-        } = _ref;
-        return {
-          defaultLimit,
-          defaultPageSize,
-          indexes,
-          keys,
-          sharding: {
-            bumps: (0, _fromPairs2.default)((0, _sortBy2.default)((0, _toPairs2.default)(bumps), 0)),
-            entityKey,
-            nibbleBits,
-            nibbles,
-            timestamp
-          }
-        };
-      }),
-      shardKeyToken
-    };
-
-    // Conform & validate entity properties.
-    (0, _some2.default)(conformedConfig.entities, (_ref2, entityToken) => {
-      let {
-        indexes,
-        keys,
-        sharding: {
-          bumps,
-          entityKey,
-          nibbleBits,
-          nibbles,
-          timestamp
-        }
-      } = _ref2;
-      // 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) throw new Error(`${entityToken} index '${indexToken}' components '${invalidIndexComponents}' are not entity keys.`);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) 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)) throw new Error(`${entityToken} sharding entityKey must be a function or nil`);
-
-      // Validate sharding nibbles do not exceed 32 bits.
-      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) 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) 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)) throw new Error(`${entityToken} sharding timestamp must be a function or nil.`);else return false;
-    });
-    this.#config = conformedConfig;
-  }
-
-  /**
-   * Get logger instance.
-   *
-   * @returns {object} Logger instance.
-   */
-  get logger() {
-    return this.#logger;
-  }
-
-  /**
-   * Get shard key token.
-   *
-   * @returns {string} Shard key token.
-   */
-  get shardKeyToken() {
-    return this.#config.shardKeyToken;
-  }
-
-  /**
-   * Get entity config.
-   *
-   * @param {string} entityToken - Entity token.
-   * @returns {object} Entity config.
-   * @throws {Error} If entityToken is invalid.
-   */
-  getEntityConfig(entityToken) {
-    this.validateEntityToken(entityToken);
-    return this.config.entities[entityToken];
-  }
-  getIndexComponents(entityToken, indexToken) {
-    const {
-      indexes
-    } = this.getEntityConfig(entityToken);
-    if (!(0, _has2.default)(indexes, indexToken)) throw new Error(`Index '${indexToken}' does not exist for entity '${entityToken}'.`);
-    return indexes[indexToken];
-  }
-
-  /**
-   * Get the number of nibbles & nibbleBits for a given entityToken at a given timestamp.
-   *
-   * @param {string} entityToken - Entity token.
-   * @param {number} [timestamp] - Timestamp in milliseconds (defaults to current time).
-   * @returns {{nibbleBits: number, nibbles: number}} Result object.
-   */
-  getNibbles(entityToken) {
-    let timestamp = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : Date.now();
-    const {
-      nibbleBits,
-      nibbles,
-      bumps
-    } = this.getEntityConfig(entityToken).sharding;
-    this.validateTimestamp(timestamp);
-    return {
-      nibbleBits,
-      nibbles: (0, _findLast2.default)(bumps, (value, key) => key <= timestamp) ?? nibbles
-    };
-  }
-
-  /**
-   * Return a shard key for a given entity token, entity id & timestamp.
-   *
-   * @param {string} entityToken - Entity token.
-   * @param {string} entityKey - Entity id.
-   * @param {number} [timestamp] - Timestamp in milliseconds (defaults to current time).
-   * @returns {string} shard key.
-   */
-  getShardKey(entityToken, entityKey) {
-    let timestamp = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : Date.now();
-    // Get nibbles for entityToken at timestamp (validates entityToken)
-    const {
-      nibbleBits,
-      nibbles
-    } = this.getNibbles(entityToken, timestamp);
-
-    // Calculate shardKey.
-    const radix = 2 ** nibbleBits;
-    const shardKey = nibbles ? ((0, _stringHash.default)(entityKey) % (nibbles * radix)).toString(radix).padStart(nibbles, '0') : undefined;
-    if ((0, _isNil2.default)(shardKey)) this.logger.debug(`no shard key generated for ${entityToken} id '${entityKey}' at timestamp ${timestamp}.`);else this.logger.debug(`generated shard key '${shardKey}' for ${entityToken} id '${entityKey}' at timestamp ${timestamp}.`);
-    return shardKey;
-  }
-
-  /**
-   * Return an array of shard keys valid for a given entity token & timestamp.
-   *
-   * @param {string} entityToken - Entity token.
-   * @param {number} [timestamp] - Timestamp in milliseconds (defaults to current time).
-   * @returns {string[]} shard key space.
-   */
-  getShardKeySpace(entityToken) {
-    let timestamp = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : Date.now();
-    const {
-      nibbleBits,
-      nibbles,
-      bumps
-    } = this.getEntityConfig(entityToken).sharding;
-    // if (!nibbles && !_.size(bumps)) return [''];
-
-    this.validateTimestamp(timestamp);
-    const nibbleSpace = [nibbles, ...(0, _map2.default)((0, _filter2.default)(bumps, (value, key) => key <= timestamp))];
-    const radix = 2 ** nibbleBits;
-    const shardKeySpace = (0, _flatten2.default)((0, _map2.default)(nibbleSpace, nibbles => {
-      return nibbles ? (0, _range2.default)(0, radix ** nibbles).map(nibble => nibble.toString(radix).padStart(nibbles, '0')) : undefined;
-    }));
-    return shardKeySpace;
-  }
-
-  /**
-   * Tests whether an entityToken is valid.
-   *
-   * @param {string} entityToken - Entity token.
-   * @returns {boolean} true if entityToken is valid.
-   */
-  validateEntityToken(entityToken) {
-    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;
-  }
-
-  /**
-   * Tests whether a key token is valid.
-   *
-   * @param {string} entityToken - Entity token.
-   * @param {string} keyToken - Key token.
-   * @returns {boolean} true if keyToken is valid.
-   */
-  validateKeyToken(entityToken, keyToken) {
-    this.validateEntityToken(entityToken);
-    if (!this.config.entities[entityToken].keys[keyToken]) throw new Error(`Invalid entity ${entityToken} keyToken: ${keyToken}`);else return true;
-  }
-
-  /**
-   * Tests whether a timestamp is valid.
-   *
-   * @param {number} timestamp - timestamp.
-   * @param {boolean} [future] - true if timestamp must be in the future.
-   * @returns {boolean} true if timestamp is valid.
-   */
-  validateTimestamp(timestamp) {
-    let future = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-    if (!(0, _isInteger2.default)(timestamp) || future && timestamp <= Date.now()) throw new Error(`invalid timestamp (must be an integer${future ? ' in the future' : ''})`);else return true;
-  }
-}
-exports.PrivateEntityManager = PrivateEntityManager;

package/dist/default/lib/index.js

@@ -1,12 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "EntityManager", {
-  enumerable: true,
-  get: function () {
-    return _EntityManager.EntityManager;
-  }
-});
-var _EntityManager = require("./EntityManager/EntityManager.js");

package/dist/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}