@karmaniverous/jsonmap 0.2.7 → 0.3.0

package/README.md

@@ -122,19 +122,20 @@ JsonMap class to apply transformations to a JSON object
 **Kind**: global class  
 
 * [JsonMap](#JsonMap)
-    * [new JsonMap([map], [lib])](#new_JsonMap_new)
+    * [new JsonMap([map], [lib], [ignore])](#new_JsonMap_new)
     * [.transform(input)](#JsonMap+transform) ⇒ <code>object</code>
 
 <a name="new_JsonMap_new"></a>
 
-### new JsonMap([map], [lib])
+### new JsonMap([map], [lib], [ignore])
 Creates an instance of JsonMap.
 
 
-| Param | Type | Description |
-| --- | --- | --- |
-| [map] | <code>object</code> | The data mapping configuration. |
-| [lib] | <code>object</code> | A collection of function libraries. |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [map] | <code>object</code> |  | The data mapping configuration. |
+| [lib] | <code>object</code> |  | A collection of function libraries. |
+| [ignore] | <code>string</code> | <code>&quot;^\\$&quot;</code> | Regex pattern of keys to ignore. Defaults to '^\\$'. |
 
 <a name="JsonMap+transform"></a>
 

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

@@ -8,17 +8,16 @@ 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.isarray"));
-var _lodash6 = _interopRequireDefault(require("lodash.isarraylikeobject"));
-var _lodash7 = _interopRequireDefault(require("lodash.isobject"));
-var _lodash8 = _interopRequireDefault(require("lodash.isplainobject"));
-var _lodash9 = _interopRequireDefault(require("lodash.isstring"));
-var _lodash10 = _interopRequireDefault(require("lodash.isundefined"));
-var _lodash11 = _interopRequireDefault(require("lodash.mapvalues"));
-var _lodash12 = _interopRequireDefault(require("lodash.pickby"));
-var _lodash13 = _interopRequireDefault(require("lodash.set"));
-var _lodash14 = _interopRequireDefault(require("lodash.size"));
-var _lodash15 = _interopRequireDefault(require("lodash.sortby"));
+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
@@ -32,12 +31,12 @@ const getJsonFns = () => {
         return 'CIRCULAR REFERENCE';
       }
       seen.add(value);
-      if (!(0, _lodash6.default)(value)) return Object.getOwnPropertyNames(value).reduce((v, p) => ({
+      if (!(0, _lodash5.default)(value)) return Object.getOwnPropertyNames(value).reduce((v, p) => ({
         ...v,
         [p]: value[p]
       }), {});
     }
-    return (0, _lodash10.default)(value) ? undefinedToken : value;
+    return (0, _lodash9.default)(value) ? undefinedToken : value;
   };
   const reviver = (key, value) => value === undefinedToken ? undefined : value;
   return {
@@ -55,12 +54,15 @@ class JsonMap {
    *
    * @param {object} [map] - The data mapping configuration.
    * @param {object} [lib] - A collection of function libraries.
+   * @param {string} [ignore] - Regex pattern of keys to ignore. Defaults to '^\\$'.
    */
   constructor() {
     let map = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
     let lib = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    let ignore = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '^\\$';
     this.map = map;
     this.lib = lib;
+    this.ignore = new RegExp(ignore);
   }
 
   /**
@@ -81,8 +83,8 @@ class JsonMap {
     } = 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 $.
-    const deep = value => (0, _lodash8.default)(value) ? (0, _lodash11.default)((0, _lodash12.default)(value, (v, k) => /^[^$]/.test(k)), value => (0, _lodash2.default)(value, deep)) : undefined;
+    // 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);
   }
 
@@ -101,7 +103,7 @@ class JsonMap {
     // console.debug('#transform params:\n', { node, input, output, path });
 
     // Checks if the current node is an object and has a '$' key
-    if ((0, _lodash8.default)(node) && (0, _lodash14.default)(node) === 1 && '$' in node) {
+    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['$']);
       // console.debug('transformations:\n', transformations);
@@ -139,19 +141,19 @@ class JsonMap {
       }
 
       // Sets the output at the specified path to the last result of the transformations & returns.
-      (0, _lodash13.default)(output, path, results[0]);
+      (0, _lodash12.default)(output, path, results[0]);
       // console.debug('updated output:\n', output);
 
       return results[0];
     }
 
     // Checks if the current node is an object
-    if ((0, _lodash7.default)(node)) {
+    if ((0, _lodash6.default)(node)) {
       // Creates an empty array or object based on whether the current node is an array or not
-      const transformedNode = (0, _lodash5.default)(node) ? [] : {};
+      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, _lodash15.default)(Object.entries(node), _ref => {
+      for (const [key, value] of (0, _lodash14.default)(Object.entries(node), _ref => {
         let [key] = _ref;
         return key;
       })) {
@@ -164,12 +166,12 @@ class JsonMap {
       }
 
       // Sets the output at the specified path to the transformedNode & returnsd.
-      (0, _lodash13.default)(output, path, transformedNode);
+      (0, _lodash12.default)(output, path, transformedNode);
       return transformedNode;
     }
 
     // Sets the output at the specified path to the current node & returns.
-    (0, _lodash13.default)(output, path, node);
+    (0, _lodash12.default)(output, path, node);
     return node;
   }
 
@@ -190,7 +192,7 @@ class JsonMap {
    */
   #resolvePath(path, results) {
     // If the path is not a string, return it as is
-    if (!(0, _lodash9.default)(path)) {
+    if (!(0, _lodash8.default)(path)) {
       return {
         path
       };

package/lib/JsonMap/JsonMap.js

@@ -3,7 +3,6 @@ import castArray from 'lodash.castarray';
 import cloneDeepWith from 'lodash.clonedeepwith';
 import get from 'lodash.get';
 import invoke from 'lodash.invoke';
-import isArray from 'lodash.isarray';
 import isArrayLikeObject from 'lodash.isarraylikeobject';
 import isObject from 'lodash.isobject';
 import isPlainObject from 'lodash.isplainobject';
@@ -51,10 +50,12 @@ class JsonMap {
    *
    * @param {object} [map] - The data mapping configuration.
    * @param {object} [lib] - A collection of function libraries.
+   * @param {string} [ignore] - Regex pattern of keys to ignore. Defaults to '^\\$'.
    */
-  constructor(map = {}, lib = {}) {
+  constructor(map = {}, lib = {}, ignore = '^\\$') {
     this.map = map;
     this.lib = lib;
+    this.ignore = new RegExp(ignore);
   }
 
   /**
@@ -78,11 +79,11 @@ class JsonMap {
       reviver
     );
 
-    // Recursively eliminate non-string keys & string keys starting with $.
+    // Recursively eliminate non-string keys & string keys starting with $ and not in ignoreExclusions.
     const deep = (value) =>
       isPlainObject(value)
         ? mapValues(
-            pickBy(value, (v, k) => /^[^$]/.test(k)),
+            pickBy(value, (v, k) => !this.ignore.test(k)),
             (value) => cloneDeepWith(value, deep)
           )
         : undefined;
@@ -155,7 +156,7 @@ class JsonMap {
     // 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 = isArray(node) ? [] : {};
+      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)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karmaniverous/jsonmap",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public"
   },