@karmaniverous/jsonmap 1.0.1 → 2.0.1

package/dist/default/lib/JsonMap/JsonMap.js

@@ -1,247 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.JsonMap = void 0;
-var _lodash = _interopRequireDefault(require("lodash.castarray"));
-var _lodash2 = _interopRequireDefault(require("lodash.clonedeepwith"));
-var _lodash3 = _interopRequireDefault(require("lodash.get"));
-var _lodash4 = _interopRequireDefault(require("lodash.invoke"));
-var _lodash5 = _interopRequireDefault(require("lodash.isarraylikeobject"));
-var _lodash6 = _interopRequireDefault(require("lodash.isobject"));
-var _lodash7 = _interopRequireDefault(require("lodash.isplainobject"));
-var _lodash8 = _interopRequireDefault(require("lodash.isstring"));
-var _lodash9 = _interopRequireDefault(require("lodash.isundefined"));
-var _lodash10 = _interopRequireDefault(require("lodash.mapvalues"));
-var _lodash11 = _interopRequireDefault(require("lodash.pickby"));
-var _lodash12 = _interopRequireDefault(require("lodash.set"));
-var _lodash13 = _interopRequireDefault(require("lodash.size"));
-var _lodash14 = _interopRequireDefault(require("lodash.sortby"));
-var _nanoid = require("nanoid");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// npm imports
-
-const getJsonFns = () => {
-  const seen = new WeakSet();
-  const undefinedToken = (0, _nanoid.nanoid)();
-  const replacer = (key, value) => {
-    if (typeof value === 'object' && value !== null) {
-      if (seen.has(value)) {
-        return 'CIRCULAR REFERENCE';
-      }
-      seen.add(value);
-      if (!(0, _lodash5.default)(value)) return Object.getOwnPropertyNames(value).reduce((v, p) => ({
-        ...v,
-        [p]: value[p]
-      }), {});
-    }
-    return (0, _lodash9.default)(value) ? undefinedToken : value;
-  };
-  const reviver = (key, value) => value === undefinedToken ? undefined : value;
-  return {
-    replacer,
-    reviver
-  };
-};
-
-/**
- * JsonMap class to apply transformations to a JSON object
- */
-class JsonMap {
-  /**
-   * Creates an instance of JsonMap.
-   *
-   * @param {object} [map] - The data mapping configuration.
-   * @param {object} [lib] - A collection of function libraries.
-   * @param {object} [options] - Options object
-   * @param {string} [options.ignore] - Regex pattern of keys to ignore. Defaults to '^\\$'.
-   * @param {string} [options.logger] - Logger object
-   */
-  constructor() {
-    let map = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    let lib = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    let {
-      ignore = '^\\$',
-      logger = console
-    } = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-    this.map = map;
-    this.lib = lib;
-    this.ignore = new RegExp(ignore);
-    this.logger = logger;
-  }
-
-  /**
-   * Transforms the input data according to the map configuration.
-   *
-   * @param {object} input - The input data to be transformed.
-   * @return {object} - The transformed data.
-   */
-  async transform(input) {
-    // Sets the input data and initializes an empty output object
-    this.input = input;
-    this.output = {};
-
-    // Perform transformation & eliminate recursion from result.
-    const {
-      replacer,
-      reviver
-    } = getJsonFns();
-    const result = JSON.parse(JSON.stringify(await this.#transform(this.map, this.input, this.output), replacer), reviver);
-
-    // Recursively eliminate non-string keys & string keys starting with $ and not in ignoreExclusions.
-    const deep = value => (0, _lodash7.default)(value) ? (0, _lodash10.default)((0, _lodash11.default)(value, (v, k) => !this.ignore.test(k)), value => (0, _lodash2.default)(value, deep)) : undefined;
-    return (0, _lodash2.default)(result, deep);
-  }
-
-  /**
-   * Recursive function to handle transformations.
-   *
-   * @param {object} node - The current map node.
-   * @param {object} input - The current input node.
-   * @param {object} output - The current output node.
-   * @param {string} path - The path to the current node.
-   * @return {object} - The transformed node.
-   * @private
-   */
-  async #transform(node, input, output) {
-    let path = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : '';
-    this.logger.debug('#transform params:\n', {
-      node,
-      input,
-      output,
-      path
-    });
-
-    // Checks if the current node is an object and has a '$' key
-    if ((0, _lodash7.default)(node) && (0, _lodash13.default)(node) === 1 && '$' in node) {
-      // Retrieves the transformations to be applied (can be an array or a single object)
-      const transformations = (0, _lodash.default)(node['$']);
-      this.logger.debug('transformations:\n', transformations);
-
-      // Array to store the results of the transformations
-      let results = [];
-
-      // Iterates over each transformation
-      for (const transformation of transformations) {
-        this.logger.debug('processing transformation:\n', transformation);
-
-        // Resolves the object path for the transformation
-        const {
-          obj: methodObj,
-          path: methodPath
-        } = this.#resolvePath(transformation.method, results);
-
-        // Resolves the parameter paths for the transformation
-        const params = (0, _lodash.default)(transformation.params).map(param => {
-          const {
-            obj: paramObj,
-            path: paramPath
-          } = this.#resolvePath(param, results);
-          return paramObj ? paramPath ? (0, _lodash3.default)(paramObj, paramPath) : paramObj : paramPath;
-        });
-        this.logger.debug('resolved transformation params:\n', params);
-
-        // Calls the specified method on the resolved object with the resolved parameters
-        const result = await (0, _lodash4.default)(methodObj, methodPath, ...params);
-        this.logger.debug('transformation result:\n', result);
-
-        // Stores the result of the transformation
-        results.unshift(result);
-      }
-
-      // Sets the output at the specified path to the last result of the transformations & returns.
-      (0, _lodash12.default)(output, path, results[0]);
-      this.logger.debug('updated output:\n', output);
-      return results[0];
-    }
-
-    // Checks if the current node is an object
-    if ((0, _lodash6.default)(node)) {
-      // Creates an empty array or object based on whether the current node is an array or not
-      const transformedNode = Array.isArray(node) ? [] : {};
-
-      // Iterates over each key-value pair in the current node in ascending order by key
-      for (const [key, value] of (0, _lodash14.default)(Object.entries(node), _ref => {
-        let [key] = _ref;
-        return key;
-      })) {
-        // Constructs the current path by appending the current key to the previous path (if any)
-        const currentPath = path ? `${path}.${key}` : key;
-
-        // Recursively calls #transform with the current value, input, output, and path
-        // Assigns the transformed value to the corresponding key in the transformedNode
-        transformedNode[key] = await this.#transform(value, input, output, currentPath);
-      }
-
-      // Sets the output at the specified path to the transformedNode & returnsd.
-      (0, _lodash12.default)(output, path, transformedNode);
-      return transformedNode;
-    }
-
-    // Sets the output at the specified path to the current node & returns.
-    (0, _lodash12.default)(output, path, node);
-    return node;
-  }
-
-  /**
-   * @typedef {object} PathResolution
-   * @property {object} obj - The object to be used for the transformation.
-   * @property {string} path - The path to the value to be used for the transformation.
-   * @private
-   */
-
-  /**
-   * Resolves the method/params path for a transformation
-   *
-   * @param {string} path - The path to be resolved.
-   * @param {Array} results - The results from previous transformations.
-   * @return {PathResolution} - The resolved path.
-   * @private
-   */
-  #resolvePath(path, results) {
-    // If the path is not a string, return it as is
-    if (!(0, _lodash8.default)(path)) {
-      return {
-        path
-      };
-    }
-
-    // Defines special patterns and their corresponding resolution functions
-    const patterns = {
-      '^\\$\\.(?<obj>lib|input|output)\\.?(?<path>.*)': _ref2 => {
-        let {
-          obj,
-          path
-        } = _ref2;
-        return {
-          obj: this[obj],
-          path
-        };
-      },
-      '^\\$(?<path>\\[\\d+\\].*)': _ref3 => {
-        let {
-          path
-        } = _ref3;
-        return {
-          obj: results,
-          path
-        };
-      }
-    };
-
-    // Iterates over the special patterns
-    for (const [pattern, resolve] of Object.entries(patterns)) {
-      const match = path.match(pattern);
-      if (match) return resolve(match.groups);
-    }
-
-    // Returns the path as is if it does not match any special patterns
-    return {
-      path
-    };
-  }
-}
-
-// Exports the JsonMap class as the default export of this module
-exports.JsonMap = JsonMap;

package/dist/default/lib/index.js

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

package/dist/package.json

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

package/env/.env.dev

@@ -1,2 +0,0 @@
-# These are ENV-specific values. A version of this file should exist for 
-# every ENV supported by the project, named .env.ENV

package/env/dynamic.js

@@ -1 +0,0 @@
-() => ({});

package/lib/JsonMap/JsonMap.js

@@ -1,233 +0,0 @@
-// npm imports
-import castArray from 'lodash.castarray';
-import cloneDeepWith from 'lodash.clonedeepwith';
-import get from 'lodash.get';
-import invoke from 'lodash.invoke';
-import isArrayLikeObject from 'lodash.isarraylikeobject';
-import isObject from 'lodash.isobject';
-import isPlainObject from 'lodash.isplainobject';
-import isString from 'lodash.isstring';
-import isUndefined from 'lodash.isundefined';
-import mapValues from 'lodash.mapvalues';
-import pickBy from 'lodash.pickby';
-import set from 'lodash.set';
-import size from 'lodash.size';
-import sortBy from 'lodash.sortby';
-import { nanoid } from 'nanoid';
-
-const getJsonFns = () => {
-  const seen = new WeakSet();
-  const undefinedToken = nanoid();
-
-  const replacer = (key, value) => {
-    if (typeof value === 'object' && value !== null) {
-      if (seen.has(value)) {
-        return 'CIRCULAR REFERENCE';
-      }
-      seen.add(value);
-
-      if (!isArrayLikeObject(value))
-        return Object.getOwnPropertyNames(value).reduce(
-          (v, p) => ({ ...v, [p]: value[p] }),
-          {}
-        );
-    }
-    return isUndefined(value) ? undefinedToken : value;
-  };
-
-  const reviver = (key, value) =>
-    value === undefinedToken ? undefined : value;
-
-  return { replacer, reviver };
-};
-
-/**
- * JsonMap class to apply transformations to a JSON object
- */
-class JsonMap {
-  /**
-   * Creates an instance of JsonMap.
-   *
-   * @param {object} [map] - The data mapping configuration.
-   * @param {object} [lib] - A collection of function libraries.
-   * @param {object} [options] - Options object
-   * @param {string} [options.ignore] - Regex pattern of keys to ignore. Defaults to '^\\$'.
-   * @param {string} [options.logger] - Logger object
-   */
-  constructor(map = {}, lib = {}, { ignore = '^\\$', logger = console } = {}) {
-    this.map = map;
-    this.lib = lib;
-    this.ignore = new RegExp(ignore);
-    this.logger = logger;
-  }
-
-  /**
-   * Transforms the input data according to the map configuration.
-   *
-   * @param {object} input - The input data to be transformed.
-   * @return {object} - The transformed data.
-   */
-  async transform(input) {
-    // Sets the input data and initializes an empty output object
-    this.input = input;
-    this.output = {};
-
-    // Perform transformation & eliminate recursion from result.
-    const { replacer, reviver } = getJsonFns();
-    const result = JSON.parse(
-      JSON.stringify(
-        await this.#transform(this.map, this.input, this.output),
-        replacer
-      ),
-      reviver
-    );
-
-    // Recursively eliminate non-string keys & string keys starting with $ and not in ignoreExclusions.
-    const deep = (value) =>
-      isPlainObject(value)
-        ? mapValues(
-            pickBy(value, (v, k) => !this.ignore.test(k)),
-            (value) => cloneDeepWith(value, deep)
-          )
-        : undefined;
-
-    return cloneDeepWith(result, deep);
-  }
-
-  /**
-   * Recursive function to handle transformations.
-   *
-   * @param {object} node - The current map node.
-   * @param {object} input - The current input node.
-   * @param {object} output - The current output node.
-   * @param {string} path - The path to the current node.
-   * @return {object} - The transformed node.
-   * @private
-   */
-  async #transform(node, input, output, path = '') {
-    this.logger.debug('#transform params:\n', { node, input, output, path });
-
-    // Checks if the current node is an object and has a '$' key
-    if (isPlainObject(node) && size(node) === 1 && '$' in node) {
-      // Retrieves the transformations to be applied (can be an array or a single object)
-      const transformations = castArray(node['$']);
-      this.logger.debug('transformations:\n', transformations);
-
-      // Array to store the results of the transformations
-      let results = [];
-
-      // Iterates over each transformation
-      for (const transformation of transformations) {
-        this.logger.debug('processing transformation:\n', transformation);
-
-        // Resolves the object path for the transformation
-        const { obj: methodObj, path: methodPath } = this.#resolvePath(
-          transformation.method,
-          results
-        );
-
-        // Resolves the parameter paths for the transformation
-        const params = castArray(transformation.params).map((param) => {
-          const { obj: paramObj, path: paramPath } = this.#resolvePath(
-            param,
-            results
-          );
-          return paramObj
-            ? paramPath
-              ? get(paramObj, paramPath)
-              : paramObj
-            : paramPath;
-        });
-        this.logger.debug('resolved transformation params:\n', params);
-
-        // Calls the specified method on the resolved object with the resolved parameters
-        const result = await invoke(methodObj, methodPath, ...params);
-        this.logger.debug('transformation result:\n', result);
-
-        // Stores the result of the transformation
-        results.unshift(result);
-      }
-
-      // Sets the output at the specified path to the last result of the transformations & returns.
-      set(output, path, results[0]);
-      this.logger.debug('updated output:\n', output);
-
-      return results[0];
-    }
-
-    // Checks if the current node is an object
-    if (isObject(node)) {
-      // Creates an empty array or object based on whether the current node is an array or not
-      const transformedNode = Array.isArray(node) ? [] : {};
-
-      // Iterates over each key-value pair in the current node in ascending order by key
-      for (const [key, value] of sortBy(Object.entries(node), ([key]) => key)) {
-        // Constructs the current path by appending the current key to the previous path (if any)
-        const currentPath = path ? `${path}.${key}` : key;
-
-        // Recursively calls #transform with the current value, input, output, and path
-        // Assigns the transformed value to the corresponding key in the transformedNode
-        transformedNode[key] = await this.#transform(
-          value,
-          input,
-          output,
-          currentPath
-        );
-      }
-
-      // Sets the output at the specified path to the transformedNode & returnsd.
-      set(output, path, transformedNode);
-      return transformedNode;
-    }
-
-    // Sets the output at the specified path to the current node & returns.
-    set(output, path, node);
-    return node;
-  }
-
-  /**
-   * @typedef {object} PathResolution
-   * @property {object} obj - The object to be used for the transformation.
-   * @property {string} path - The path to the value to be used for the transformation.
-   * @private
-   */
-
-  /**
-   * Resolves the method/params path for a transformation
-   *
-   * @param {string} path - The path to be resolved.
-   * @param {Array} results - The results from previous transformations.
-   * @return {PathResolution} - The resolved path.
-   * @private
-   */
-  #resolvePath(path, results) {
-    // If the path is not a string, return it as is
-    if (!isString(path)) {
-      return { path };
-    }
-
-    // Defines special patterns and their corresponding resolution functions
-    const patterns = {
-      '^\\$\\.(?<obj>lib|input|output)\\.?(?<path>.*)': ({ obj, path }) => ({
-        obj: this[obj],
-        path,
-      }),
-      '^\\$(?<path>\\[\\d+\\].*)': ({ path }) => ({
-        obj: results,
-        path,
-      }),
-    };
-
-    // Iterates over the special patterns
-    for (const [pattern, resolve] of Object.entries(patterns)) {
-      const match = path.match(pattern);
-      if (match) return resolve(match.groups);
-    }
-
-    // Returns the path as is if it does not match any special patterns
-    return { path };
-  }
-}
-
-// Exports the JsonMap class as the default export of this module
-export { JsonMap };

package/lib/index.js

@@ -1 +0,0 @@
-export { JsonMap } from './JsonMap/JsonMap.js';