@karmaniverous/jsonmap 0.0.2 → 0.0.4

package/README.md

@@ -41,14 +41,15 @@ The transformation output will reflect the structure of your `map` object and in
 
 ```js
 const map = {
-  key1: 'static value passed directly to output',
+  foo: 'static value passed directly to output',
   // Structure passed directly to output.
-  key2: [
+  bar: [
     {
-      key2a: 'another static value',
-      // Value defined by mapping rule with an array of transformation objects.
-      // If there is only a single transformation object, no array is necessary.
-      key2b: {
+      static: 'another static value',
+      // Value defined by a mapping rule expressing an array of transformation
+      // objects. If there is only a single transformation object, no array is
+      // necessary.
+      dynamic: {
         $: [
           // Each transformation object uses a special syntax to reference an
           // object, a method to run on it, and an array of parameters to pass.
@@ -76,6 +77,15 @@ const map = {
       },
     },
   ],
+  // Value defined by a single mapping rule executing a method against a
+  // previous output of the same mapping object.
+  progressive: {
+    $: {
+      object: '$.lib._',
+      method: 'toUpper',
+      params: '$.output.bar[0].static',
+    },
+  },
 };
 ```
 
@@ -98,6 +108,8 @@ const jsonMap = new JsonMap(lib, map);
 // Assumes some input data object is already defined.
 const output = await jsonMap.transform(input);
 ```
+
+The [unit tests](https://github.com/karmaniverous/jsonmap/blob/main/lib/JsonMap/JsonMap.test.js) demonstrate this example in action.
 
 # API Documentation
 

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

@@ -4,15 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.JsonMap = void 0;
-var _isNil2 = _interopRequireDefault(require("lodash/isNil"));
-var _parseInt2 = _interopRequireDefault(require("lodash/parseInt"));
-var _get2 = _interopRequireDefault(require("lodash/get"));
-var _isString2 = _interopRequireDefault(require("lodash/isString"));
-var _set2 = _interopRequireDefault(require("lodash/set"));
-var _last2 = _interopRequireDefault(require("lodash/last"));
-var _castArray2 = _interopRequireDefault(require("lodash/castArray"));
-var _isArray2 = _interopRequireDefault(require("lodash/isArray"));
-var _isObject2 = _interopRequireDefault(require("lodash/isObject"));
+var _castArray = _interopRequireDefault(require("lodash/castArray.js"));
+var _get = _interopRequireDefault(require("lodash/get.js"));
+var _isArray = _interopRequireDefault(require("lodash/isArray.js"));
+var _isNil = _interopRequireDefault(require("lodash/isNil.js"));
+var _isObject = _interopRequireDefault(require("lodash/isObject.js"));
+var _isString = _interopRequireDefault(require("lodash/isString.js"));
+var _last = _interopRequireDefault(require("lodash/last.js"));
+var _parseInt = _interopRequireDefault(require("lodash/parseInt.js"));
+var _set = _interopRequireDefault(require("lodash/set.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
 function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } }
@@ -68,9 +68,9 @@ exports.JsonMap = JsonMap;
 async function _transform2(node, input, output) {
   let path = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : '';
   // Checks if the current node is an object and has a '$' key
-  if ((0, _isObject2.default)(node) && '$' in node) {
+  if ((0, _isObject.default)(node) && '$' in node) {
     // Retrieves the transformations to be applied (can be an array or a single object)
-    const transformations = (0, _isArray2.default)(node['$']) ? node['$'] : [node['$']];
+    const transformations = (0, _isArray.default)(node['$']) ? node['$'] : [node['$']];
 
     // Array to store the results of the transformations
     let results = [];
@@ -81,7 +81,7 @@ async function _transform2(node, input, output) {
       const object = _classPrivateMethodGet(this, _resolvePath, _resolvePath2).call(this, transformation.object, results);
 
       // Resolves the parameter paths for the transformation
-      const params = await Promise.all((0, _castArray2.default)(transformation.params).map(param => _classPrivateMethodGet(this, _resolvePath, _resolvePath2).call(this, param, results)));
+      const params = await Promise.all((0, _castArray.default)(transformation.params).map(param => _classPrivateMethodGet(this, _resolvePath, _resolvePath2).call(this, param, results)));
 
       // Calls the specified method on the resolved object with the resolved parameters
       const result = await object[transformation.method](...params);
@@ -91,15 +91,15 @@ async function _transform2(node, input, output) {
     }
 
     // Sets the output at the specified path to the last result of the transformations & returns.
-    const last = (0, _last2.default)(results);
-    (0, _set2.default)(output, path, last);
-    return last;
+    const lastResult = (0, _last.default)(results);
+    (0, _set.default)(output, path, lastResult);
+    return lastResult;
   }
 
   // Checks if the current node is an object
-  if ((0, _isObject2.default)(node)) {
+  if ((0, _isObject.default)(node)) {
     // Creates an empty array or object based on whether the current node is an array or not
-    const transformedNode = (0, _isArray2.default)(node) ? [] : {};
+    const transformedNode = (0, _isArray.default)(node) ? [] : {};
 
     // Iterates over each key-value pair in the current node
     for (const [key, value] of Object.entries(node)) {
@@ -112,17 +112,17 @@ async function _transform2(node, input, output) {
     }
 
     // Sets the output at the specified path to the transformedNode & returnsd.
-    (0, _set2.default)(output, path, transformedNode);
+    (0, _set.default)(output, path, transformedNode);
     return transformedNode;
   }
 
   // Sets the output at the specified path to the current node & returns.
-  (0, _set2.default)(output, path, node);
+  (0, _set.default)(output, path, node);
   return node;
 }
 function _resolvePath2(path, results) {
   // If the path is not a string, return it as is
-  if (!(0, _isString2.default)(path)) {
+  if (!(0, _isString.default)(path)) {
     return path;
   }
 
@@ -139,7 +139,7 @@ function _resolvePath2(path, results) {
   // Retrieves the value from the previous results based on the index and any remaining path
   if (match) {
     const [, index, rest] = match;
-    const value = (0, _get2.default)(results, [results.length - 1 - (0, _parseInt2.default)(index), ...(rest.length ? rest.split('.') : [])]);
+    const value = (0, _get.default)(results, [results.length - 1 - (0, _parseInt.default)(index), ...(rest.length ? rest.split('.') : [])]);
 
     // Returns the value if it exists, otherwise returns the original path
     return value != null ? value : path;
@@ -151,10 +151,10 @@ function _resolvePath2(path, results) {
     const p = path.slice(pattern.length + 1);
 
     // Retrieves the value from the replacement object based on the remaining path
-    const value = p.length ? (0, _get2.default)(replacement, p.split('.')) : replacement;
+    const value = p.length ? (0, _get.default)(replacement, p) : replacement;
 
     // Returns the value if it exists, otherwise returns the original path
-    return (0, _isNil2.default)(value) ? path : value;
+    return (0, _isNil.default)(value) ? path : value;
   }
 
   // Returns the path as is if it does not match any special patterns

package/lib/JsonMap/JsonMap.js

@@ -1,4 +1,13 @@
-import _ from 'lodash';
+// npm imports
+import castArray from 'lodash/castArray.js';
+import get from 'lodash/get.js';
+import isArray from 'lodash/isArray.js';
+import isNil from 'lodash/isNil.js';
+import isObject from 'lodash/isObject.js';
+import isString from 'lodash/isString.js';
+import last from 'lodash/last.js';
+import parseInt from 'lodash/parseInt.js';
+import set from 'lodash/set.js';
 
 /**
  * JsonMap class to apply transformations to a JSON object
@@ -42,9 +51,9 @@ class JsonMap {
    */
   async #transform(node, input, output, path = '') {
     // Checks if the current node is an object and has a '$' key
-    if (_.isObject(node) && '$' in node) {
+    if (isObject(node) && '$' in node) {
       // Retrieves the transformations to be applied (can be an array or a single object)
-      const transformations = _.isArray(node['$']) ? node['$'] : [node['$']];
+      const transformations = isArray(node['$']) ? node['$'] : [node['$']];
 
       // Array to store the results of the transformations
       let results = [];
@@ -56,7 +65,7 @@ class JsonMap {
 
         // Resolves the parameter paths for the transformation
         const params = await Promise.all(
-          _.castArray(transformation.params).map((param) =>
+          castArray(transformation.params).map((param) =>
             this.#resolvePath(param, results)
           )
         );
@@ -69,15 +78,15 @@ class JsonMap {
       }
 
       // Sets the output at the specified path to the last result of the transformations & returns.
-      const last = _.last(results);
-      _.set(output, path, last);
-      return last;
+      const lastResult = last(results);
+      set(output, path, lastResult);
+      return lastResult;
     }
 
     // Checks if the current node is an object
-    if (_.isObject(node)) {
+    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 = isArray(node) ? [] : {};
 
       // Iterates over each key-value pair in the current node
       for (const [key, value] of Object.entries(node)) {
@@ -95,12 +104,12 @@ class JsonMap {
       }
 
       // Sets the output at the specified path to the transformedNode & returnsd.
-      _.set(output, path, transformedNode);
+      set(output, path, transformedNode);
       return transformedNode;
     }
 
     // Sets the output at the specified path to the current node & returns.
-    _.set(output, path, node);
+    set(output, path, node);
     return node;
   }
 
@@ -114,7 +123,7 @@ class JsonMap {
    */
   #resolvePath(path, results) {
     // If the path is not a string, return it as is
-    if (!_.isString(path)) {
+    if (!isString(path)) {
       return path;
     }
 
@@ -131,8 +140,8 @@ class JsonMap {
     // Retrieves the value from the previous results based on the index and any remaining path
     if (match) {
       const [, index, rest] = match;
-      const value = _.get(results, [
-        results.length - 1 - _.parseInt(index),
+      const value = get(results, [
+        results.length - 1 - parseInt(index),
         ...(rest.length ? rest.split('.') : []),
       ]);
 
@@ -147,10 +156,10 @@ class JsonMap {
         const p = path.slice(pattern.length + 1);
 
         // Retrieves the value from the replacement object based on the remaining path
-        const value = p.length ? _.get(replacement, p.split('.')) : replacement;
+        const value = p.length ? get(replacement, p) : replacement;
 
         // Returns the value if it exists, otherwise returns the original path
-        return _.isNil(value) ? path : value;
+        return isNil(value) ? path : value;
       }
 
     // Returns the path as is if it does not match any special patterns

package/package.json

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