@karmaniverous/jsonmap 0.1.0 → 0.2.1

package/README.md

@@ -56,10 +56,9 @@ const map = {
       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.
+          // a method to run and an array of parameters to pass to it.
           {
-            object: '$.lib._',
-            method: 'get',
+            method: '$.lib._.get',
             params: ['$.input', 'dynamodb.NewImage.roundup.N'],
           },
           // The special syntax uses lodash-style paths. Its root object can
@@ -67,14 +66,12 @@ const map = {
           // ($.input...), the output generated so far ($.output...), or the
           // outputs of previous transformation steps ($.[0]..., $.[1]...).
           {
-            object: '$.lib',
-            method: 'numeral',
+            method: '$.lib.numeral',
             // If there is only a single param, no array is necessary.
             params: '$[0]',
           },
           {
-            object: '$[0]',
-            method: 'format',
+            method: '$[0].format',
             params: '$0,0.00',
           },
         ],
@@ -85,8 +82,7 @@ const map = {
   // previous output of the same mapping object.
   progressive: {
     $: {
-      object: '$.lib._',
-      method: 'toUpper',
+      method: '$.lib._.toUpper',
       params: '$.output.bar[0].static',
     },
   },
@@ -115,44 +111,44 @@ 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
 
-<a name="JsonMap"></a>
-
-## JsonMap
-JsonMap class to apply transformations to a JSON object
-
-**Kind**: global class  
-
-* [JsonMap](#JsonMap)
-    * [new JsonMap([map], [lib])](#new_JsonMap_new)
-    * [.transform(input)](#JsonMap+transform) ⇒ <code>object</code>
-
-<a name="new_JsonMap_new"></a>
-
-### new JsonMap([map], [lib])
-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. |
-
-<a name="JsonMap+transform"></a>
-
-### jsonMap.transform(input) ⇒ <code>object</code>
-Transforms the input data according to the map configuration.
-
-**Kind**: instance method of [<code>JsonMap</code>](#JsonMap)  
-**Returns**: <code>object</code> - - The transformed data.  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| input | <code>object</code> | The input data to be transformed. |
-
-
+<a name="JsonMap"></a>
+
+## JsonMap
+JsonMap class to apply transformations to a JSON object
+
+**Kind**: global class  
+
+* [JsonMap](#JsonMap)
+    * [new JsonMap([map], [lib])](#new_JsonMap_new)
+    * [.transform(input)](#JsonMap+transform) ⇒ <code>object</code>
+
+<a name="new_JsonMap_new"></a>
+
+### new JsonMap([map], [lib])
+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. |
+
+<a name="JsonMap+transform"></a>
+
+### jsonMap.transform(input) ⇒ <code>object</code>
+Transforms the input data according to the map configuration.
+
+**Kind**: instance method of [<code>JsonMap</code>](#JsonMap)  
+**Returns**: <code>object</code> - - The transformed data.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| input | <code>object</code> | The input data to be transformed. |
+
+
 ---
 
 See more great templates and other tools on

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

@@ -7,14 +7,15 @@ 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.isarray"));
-var _lodash5 = _interopRequireDefault(require("lodash.isobject"));
-var _lodash6 = _interopRequireDefault(require("lodash.isplainobject"));
-var _lodash7 = _interopRequireDefault(require("lodash.isstring"));
-var _lodash8 = _interopRequireDefault(require("lodash.mapvalues"));
-var _lodash9 = _interopRequireDefault(require("lodash.pickby"));
-var _lodash10 = _interopRequireDefault(require("lodash.set"));
-var _lodash11 = _interopRequireDefault(require("lodash.size"));
+var _lodash4 = _interopRequireDefault(require("lodash.invoke"));
+var _lodash5 = _interopRequireDefault(require("lodash.isarray"));
+var _lodash6 = _interopRequireDefault(require("lodash.isobject"));
+var _lodash7 = _interopRequireDefault(require("lodash.isplainobject"));
+var _lodash8 = _interopRequireDefault(require("lodash.isstring"));
+var _lodash9 = _interopRequireDefault(require("lodash.mapvalues"));
+var _lodash10 = _interopRequireDefault(require("lodash.pickby"));
+var _lodash11 = _interopRequireDefault(require("lodash.set"));
+var _lodash12 = _interopRequireDefault(require("lodash.size"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // npm imports
 
@@ -49,8 +50,8 @@ class JsonMap {
     // Calls the #transform method to perform the transformation
     const result = await this.#transform(this.map, this.input, this.output);
 
-    // Recursively eliminate keys starting with $.
-    const deep = value => (0, _lodash6.default)(value) ? (0, _lodash8.default)((0, _lodash9.default)(value, (v, k) => /^[^$]/.test(k)), value => (0, _lodash2.default)(value, deep)) : undefined;
+    // Recursively eliminate string keys starting with $.
+    const deep = value => (0, _lodash7.default)(value) ? (0, _lodash9.default)((0, _lodash10.default)(value, (v, k) => !(0, _lodash8.default)(k) || /^[^$]/.test(k)), value => (0, _lodash2.default)(value, deep)) : undefined;
     return (0, _lodash2.default)(result, deep);
   }
 
@@ -67,7 +68,7 @@ class JsonMap {
   async #transform(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, _lodash6.default)(node) && (0, _lodash11.default)(node) === 1 && '$' in node) {
+    if ((0, _lodash7.default)(node) && (0, _lodash12.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['$']);
 
@@ -77,27 +78,36 @@ class JsonMap {
       // Iterates over each transformation
       for (const transformation of transformations) {
         // Resolves the object path for the transformation
-        const object = this.#resolvePath(transformation.object, results);
+        const {
+          obj: methodObj,
+          path: methodPath
+        } = this.#resolvePath(transformation.method, results);
 
         // Resolves the parameter paths for the transformation
-        const params = await Promise.all((0, _lodash.default)(transformation.params).map(param => this.#resolvePath(param, results)));
+        const params = await Promise.all((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;
+        }));
 
         // Calls the specified method on the resolved object with the resolved parameters
-        const result = await object[transformation.method](...params);
+        const result = await (0, _lodash4.default)(methodObj, methodPath, ...params);
 
         // 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, _lodash10.default)(output, path, results[0]);
+      (0, _lodash11.default)(output, path, results[0]);
       return results[0];
     }
 
     // Checks if the current node is an object
-    if ((0, _lodash5.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, _lodash4.default)(node) ? [] : {};
+      const transformedNode = (0, _lodash5.default)(node) ? [] : {};
 
       // Iterates over each key-value pair in the current node
       for (const [key, value] of Object.entries(node)) {
@@ -110,26 +120,33 @@ class JsonMap {
       }
 
       // Sets the output at the specified path to the transformedNode & returnsd.
-      (0, _lodash10.default)(output, path, transformedNode);
+      (0, _lodash11.default)(output, path, transformedNode);
       return transformedNode;
     }
 
     // Sets the output at the specified path to the current node & returns.
-    (0, _lodash10.default)(output, path, node);
+    (0, _lodash11.default)(output, path, node);
     return node;
   }
 
   /**
-   * Resolves the object/method/params path for a transformation
+   * @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 {string} - The resolved path.
+   * @return {PathResolution} - The resolved path.
    * @private
    */
   #resolvePath(path, results) {
     // If the path is not a string, return it as is
-    if (!(0, _lodash7.default)(path)) {
+    if (!(0, _lodash8.default)(path)) {
       return path;
     }
 
@@ -140,13 +157,19 @@ class JsonMap {
           obj,
           path
         } = _ref;
-        return path.length ? (0, _lodash3.default)(this[obj], path) : this[obj];
+        return {
+          obj: this[obj],
+          path
+        };
       },
       '^\\$(?<path>\\[\\d+\\].*)': _ref2 => {
         let {
           path
         } = _ref2;
-        return (0, _lodash3.default)(results, path);
+        return {
+          obj: results,
+          path
+        };
       }
     };
 
@@ -157,7 +180,9 @@ class JsonMap {
     }
 
     // Returns the path as is if it does not match any special patterns
-    return path;
+    return {
+      path
+    };
   }
 }
 

package/lib/JsonMap/JsonMap.js

@@ -2,6 +2,7 @@
 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 isObject from 'lodash.isobject';
 import isPlainObject from 'lodash.isplainobject';
@@ -40,11 +41,11 @@ class JsonMap {
     // Calls the #transform method to perform the transformation
     const result = await this.#transform(this.map, this.input, this.output);
 
-    // Recursively eliminate keys starting with $.
+    // Recursively eliminate string keys starting with $.
     const deep = (value) =>
       isPlainObject(value)
         ? mapValues(
-            pickBy(value, (v, k) => /^[^$]/.test(k)),
+            pickBy(value, (v, k) => !isString(k) || /^[^$]/.test(k)),
             (value) => cloneDeepWith(value, deep)
           )
         : undefined;
@@ -74,17 +75,28 @@ class JsonMap {
       // Iterates over each transformation
       for (const transformation of transformations) {
         // Resolves the object path for the transformation
-        const object = this.#resolvePath(transformation.object, results);
+        const { obj: methodObj, path: methodPath } = this.#resolvePath(
+          transformation.method,
+          results
+        );
 
         // Resolves the parameter paths for the transformation
         const params = await Promise.all(
-          castArray(transformation.params).map((param) =>
-            this.#resolvePath(param, results)
-          )
+          castArray(transformation.params).map((param) => {
+            const { obj: paramObj, path: paramPath } = this.#resolvePath(
+              param,
+              results
+            );
+            return paramObj
+              ? paramPath
+                ? get(paramObj, paramPath)
+                : paramObj
+              : paramPath;
+          })
         );
 
         // Calls the specified method on the resolved object with the resolved parameters
-        const result = await object[transformation.method](...params);
+        const result = await invoke(methodObj, methodPath, ...params);
 
         // Stores the result of the transformation
         results.unshift(result);
@@ -126,11 +138,18 @@ class JsonMap {
   }
 
   /**
-   * Resolves the object/method/params path for a transformation
+   * @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 {string} - The resolved path.
+   * @return {PathResolution} - The resolved path.
    * @private
    */
   #resolvePath(path, results) {
@@ -141,9 +160,14 @@ class JsonMap {
 
     // Defines special patterns and their corresponding resolution functions
     const patterns = {
-      '^\\$\\.(?<obj>lib|input|output)\\.?(?<path>.*)': ({ obj, path }) =>
-        path.length ? get(this[obj], path) : this[obj],
-      '^\\$(?<path>\\[\\d+\\].*)': ({ path }) => get(results, path),
+      '^\\$\\.(?<obj>lib|input|output)\\.?(?<path>.*)': ({ obj, path }) => ({
+        obj: this[obj],
+        path,
+      }),
+      '^\\$(?<path>\\[\\d+\\].*)': ({ path }) => ({
+        obj: results,
+        path,
+      }),
     };
 
     // Iterates over the special patterns
@@ -153,7 +177,7 @@ class JsonMap {
     }
 
     // Returns the path as is if it does not match any special patterns
-    return path;
+    return { path };
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karmaniverous/jsonmap",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "publishConfig": {
     "access": "public"
   },
@@ -25,6 +25,7 @@
     "lodash.castarray": "^4.4.0",
     "lodash.clonedeepwith": "^4.5.0",
     "lodash.get": "^4.4.2",
+    "lodash.invoke": "^4.5.2",
     "lodash.isarray": "^4.0.0",
     "lodash.isobject": "^3.0.2",
     "lodash.isplainobject": "^4.0.6",
@@ -35,26 +36,27 @@
     "lodash.size": "^4.2.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.21.5",
-    "@babel/core": "^7.22.1",
-    "@babel/eslint-parser": "^7.21.8",
-    "@babel/plugin-syntax-import-assertions": "^7.20.0",
-    "@babel/preset-env": "^7.22.4",
-    "@babel/register": "^7.21.0",
-    "@karmaniverous/get-dotenv": "^2.4.1",
-    "@types/node": "^20.2.5",
+    "@babel/cli": "^7.22.10",
+    "@babel/core": "^7.22.10",
+    "@babel/eslint-parser": "^7.22.10",
+    "@babel/plugin-syntax-import-assertions": "^7.22.5",
+    "@babel/preset-env": "^7.22.10",
+    "@babel/register": "^7.22.5",
+    "@karmaniverous/get-dotenv": "^3.1.13",
+    "@types/node": "^20.5.3",
+    "auto-changelog": "^2.4.0",
     "chai": "^4.3.7",
     "concat-md": "^0.5.1",
-    "eslint": "^8.41.0",
+    "eslint": "^8.47.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-jsdoc": "^46.1.0",
+    "eslint-plugin-jsdoc": "^46.5.0",
     "eslint-plugin-mocha": "^10.1.0",
     "jsdoc-to-markdown": "^8.0.0",
     "lodash": "^4.17.21",
     "mocha": "^10.2.0",
     "numeral": "^2.0.6",
-    "prettier": "^2.8.8",
-    "release-it": "^15.10.3"
+    "prettier": "^3.0.2",
+    "release-it": "^16.1.5"
   },
   "exports": {
     ".": {
@@ -75,9 +77,27 @@
     "spec": "./**/*.test.!(*.*)"
   },
   "release-it": {
+    "git": {
+      "changelog": "npx auto-changelog --stdout --commit-limit false -u --template https://raw.githubusercontent.com/release-it/release-it/main/templates/changelog-compact.hbs",
+      "requireBranch": "main",
+      "commitMessage": "chore: release v${version}"
+    },
     "github": {
       "release": true
     },
+    "hooks": {
+      "after:init": [
+        "nr lint",
+        "nr test",
+        "nr build",
+        "nr doc"
+      ],
+      "after:release": [
+        "git switch -c release/${version}",
+        "git push -u origin release/${version}",
+        "git switch main"
+      ]
+    },
     "npm": {
       "publish": true
     }
@@ -87,8 +107,8 @@
     "doc": "jsdoc2md -c doc/jsdoc.config.json -f lib/**/*.* -t doc/api-template.hbs > doc/2-api.jsdoc2.md && concat-md doc --hide-anchor-links > README.md",
     "lint": "eslint lib/**",
     "prerelease": "npm run lint && npm run test && npm run build && npm run doc",
-    "release": "release-it",
-    "test": "getdotenv -c \"mocha\" -p ./ ./env -d dev -y ./env/dynamic.js"
+    "release": "getdotenv -c \"release-it\"",
+    "test": "getdotenv -c \"mocha\""
   },
   "type": "module"
 }