@karmaniverous/jsonmap 0.0.4 → 0.0.6

package/README.md

@@ -48,7 +48,8 @@ const map = {
       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.
+      // necessary. The output of the last transformation step is returned as
+      // the mapped value.
       dynamic: {
         $: [
           // Each transformation object uses a special syntax to reference an

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

@@ -4,15 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.JsonMap = void 0;
-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"));
+var _lodash = _interopRequireDefault(require("lodash.castarray"));
+var _lodash2 = _interopRequireDefault(require("lodash.get"));
+var _lodash3 = _interopRequireDefault(require("lodash.isnil"));
+var _lodash4 = _interopRequireDefault(require("lodash.isarray"));
+var _lodash5 = _interopRequireDefault(require("lodash.isobject"));
+var _lodash6 = _interopRequireDefault(require("lodash.isstring"));
+var _lodash7 = _interopRequireDefault(require("lodash.last"));
+var _lodash8 = _interopRequireDefault(require("lodash.parseint"));
+var _lodash9 = _interopRequireDefault(require("lodash.set"));
 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, _isObject.default)(node) && '$' in node) {
+  if ((0, _lodash5.default)(node) && '$' in node) {
     // Retrieves the transformations to be applied (can be an array or a single object)
-    const transformations = (0, _isArray.default)(node['$']) ? node['$'] : [node['$']];
+    const transformations = (0, _lodash4.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, _castArray.default)(transformation.params).map(param => _classPrivateMethodGet(this, _resolvePath, _resolvePath2).call(this, param, results)));
+      const params = await Promise.all((0, _lodash.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 lastResult = (0, _last.default)(results);
-    (0, _set.default)(output, path, lastResult);
+    const lastResult = (0, _lodash7.default)(results);
+    (0, _lodash9.default)(output, path, lastResult);
     return lastResult;
   }
 
   // Checks if the current node is an object
-  if ((0, _isObject.default)(node)) {
+  if ((0, _lodash5.default)(node)) {
     // Creates an empty array or object based on whether the current node is an array or not
-    const transformedNode = (0, _isArray.default)(node) ? [] : {};
+    const transformedNode = (0, _lodash4.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, _set.default)(output, path, transformedNode);
+    (0, _lodash9.default)(output, path, transformedNode);
     return transformedNode;
   }
 
   // Sets the output at the specified path to the current node & returns.
-  (0, _set.default)(output, path, node);
+  (0, _lodash9.default)(output, path, node);
   return node;
 }
 function _resolvePath2(path, results) {
   // If the path is not a string, return it as is
-  if (!(0, _isString.default)(path)) {
+  if (!(0, _lodash6.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, _get.default)(results, [results.length - 1 - (0, _parseInt.default)(index), ...(rest.length ? rest.split('.') : [])]);
+    const value = (0, _lodash2.default)(results, [results.length - 1 - (0, _lodash8.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, _get.default)(replacement, p) : replacement;
+    const value = p.length ? (0, _lodash2.default)(replacement, p) : replacement;
 
     // Returns the value if it exists, otherwise returns the original path
-    return (0, _isNil.default)(value) ? path : value;
+    return (0, _lodash3.default)(value) ? path : value;
   }
 
   // Returns the path as is if it does not match any special patterns

package/lib/JsonMap/JsonMap.js

@@ -1,13 +1,13 @@
 // 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';
+import castArray from 'lodash.castarray';
+import get from 'lodash.get';
+import isNil from 'lodash.isnil';
+import isArray from 'lodash.isarray';
+import isObject from 'lodash.isobject';
+import isString from 'lodash.isstring';
+import last from 'lodash.last';
+import parseInt from 'lodash.parseint';
+import set from 'lodash.set';
 
 /**
  * JsonMap class to apply transformations to a JSON object

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karmaniverous/jsonmap",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "publishConfig": {
     "access": "public"
   },
@@ -22,7 +22,15 @@
   ],
   "license": "BSD-3-Clause",
   "dependencies": {
-    "lodash": "^4.17.21"
+    "lodash.castarray": "^4.4.0",
+    "lodash.get": "^4.4.2",
+    "lodash.isarray": "^4.0.0",
+    "lodash.isnil": "^4.0.0",
+    "lodash.isobject": "^3.0.2",
+    "lodash.isstring": "^4.0.1",
+    "lodash.last": "^3.0.0",
+    "lodash.parseint": "^4.0.2",
+    "lodash.set": "^4.3.2"
   },
   "devDependencies": {
     "@babel/cli": "^7.21.0",
@@ -33,7 +41,6 @@
     "@babel/register": "^7.21.0",
     "@karmaniverous/get-dotenv": "^1.0.0",
     "@types/node": "^18.15.5",
-    "babel-plugin-lodash": "^3.3.4",
     "chai": "^4.3.7",
     "concat-md": "^0.5.1",
     "eslint": "^8.36.0",
@@ -41,6 +48,7 @@
     "eslint-plugin-jsdoc": "^40.1.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.5",

package/prompt.md

@@ -1,227 +0,0 @@
-Here is a usage example of a Javascript class called JsonMap that applies transformations to a JSON object. The class should exploit the lodash library where relevant.
-
-```js
-import _ from 'lodash';
-import numeral from 'numeral';
-import { JsonMap } from 'json-map';
-
-const fetchData = async (entityToken, entityId) => {
-  // This async code fetches data from an API.
-};
-
-// This object is a collection of function libraries.
-const lib = { _, fetchData, numeral, String };
-
-// This is the data mapping configuration.
-// The output will have the same structure as this object.
-const map = {
-  txn: {
-    txnId: {
-      /*
-      An object value with a single key of $ indicates a transformation.
-
-      A transformation is composed of steps. Each step is an object with 3 keys: object, method, and params. Each transformation step runs a method of an object, optionally passing it a parameter array.
-
-      If the $ value is an object, there is a single transformation step. Multiple steps can be collected into an array.
-      */
-      $: {
-        /*
-        The object property itentifies the object whose method will be run. The object is resolved using a special syntax:
-
-        $.lib refers to the JsonMap instance lib property.
-
-        $.input refers to the input data object. 
-        
-        $.output refers to the output object. The transformation is progressive, so the value currently being processed can refer to previously processed values.
-
-        $[i], where i is an integer, refers to the ith previous transformation step, so $[0] is the last step, $[1] is the one before that, and so on. This syntax should account for the fact that a previous step might return an object, in which case $[i] might be followed by path information, e.g. $[0].path.
-
-        Beyond these base objects, lodash-style path syntax applies. If none of the patterns above fits, then object should be treated as a string.
-        */
-        object: '$.lib._',
-
-        /*
-        The method property identifies the method that will be executed on object. It should be a string.
-        */
-        method: 'get',
-
-        /*
-        The params property is an array of values to be passed to method. These values should be resolved using the same syntax as object. If none of the special patterns fits, then the value should be treated as a string.
-        */
-        params: ['$.input', 'dynamodb.NewImage.txnId.S'],
-      },
-    },
-    roundup: {
-      $: [
-        {
-          object: '$.lib._',
-          method: 'get',
-          params: ['$.input', 'dynamodb.NewImage.roundup.N'],
-        },
-        {
-          object: '$.lib',
-          method: 'numeral',
-          // If there is only a single param, no array is necessary.
-          params: '$[0]',
-        },
-        {
-          object: '$[0]',
-          method: 'format',
-          params: ['$0,0.00'],
-        },
-      ],
-    },
-    // Static values & structures will simply be passed through to the output.
-    foo: 'bar',
-    baz: {
-      object: '$.lib.String',
-      method: 'toUpperCase',
-      params: '$.foo',
-    },
-    fetch: {
-      object: '$.lib',
-      // This is an async function that returns an object!
-      method: 'fetchData',
-      // The second parameter leverages a previously processed value.
-      params: ['txn', '$.output.txn.txnId'],
-    },
-  },
-};
-
-// This is some sample input data to be transformed.
-const input = {
-  eventID: 'e560bbcaee919e16a6a8ce8dc3fe97ab',
-  eventName: 'MODIFY',
-  eventVersion: '1.1',
-  eventSource: 'aws:dynamodb',
-  awsRegion: 'us-east-1',
-  dynamodb: {
-    ApproximateCreationDateTime: 1685071094,
-    Keys: {
-      entityPK: {
-        S: 'txn!',
-      },
-      entitySK: {
-        S: 'txnId#_tQ72mu5Iy2PYJ33c497g',
-      },
-    },
-    NewImage: {
-      txnUserIdPK: {
-        S: 'txn!|userId#Xmv51c7lYiiTIU22_UlCD',
-      },
-      created: {
-        N: '1685071087846',
-      },
-      netValue: {
-        N: '365.3',
-      },
-      methodId: {
-        S: 'KDvC6leEzkAAf8-akh_vO',
-      },
-      entityPK: {
-        S: 'txn!',
-      },
-      userId: {
-        S: 'Xmv51c7lYiiTIU22_UlCD',
-      },
-      entitySK: {
-        S: 'txnId#_tQ72mu5Iy2PYJ33c497g',
-      },
-      updater: {
-        S: 'api-txn-v0-bali',
-      },
-      merchantId: {
-        S: 'eQMZ2ikPmUd3cqrptbpna',
-      },
-      roundup: {
-        N: '0.7',
-      },
-      txnMerchantIdPK: {
-        S: 'txn!|merchantId#eQMZ2ikPmUd3cqrptbpna',
-      },
-      updated: {
-        N: '1685071094685',
-      },
-      txnId: {
-        S: '_tQ72mu5Iy2PYJ33c497g',
-      },
-      txnMethodIdPK: {
-        S: 'txn!|methodId#KDvC6leEzkAAf8-akh_vO',
-      },
-    },
-    OldImage: {
-      txnUserIdPK: {
-        S: 'txn!|userId#Xmv51c7lYiiTIU22_UlCD',
-      },
-      created: {
-        N: '1685071087846',
-      },
-      netValue: {
-        N: '429.74',
-      },
-      methodId: {
-        S: 'KDvC6leEzkAAf8-akh_vO',
-      },
-      entityPK: {
-        S: 'txn!',
-      },
-      userId: {
-        S: 'Xmv51c7lYiiTIU22_UlCD',
-      },
-      entitySK: {
-        S: 'txnId#_tQ72mu5Iy2PYJ33c497g',
-      },
-      updater: {
-        S: 'api-txn-v0-bali',
-      },
-      merchantId: {
-        S: 'eQMZ2ikPmUd3cqrptbpna',
-      },
-      roundup: {
-        N: '0.26',
-      },
-      txnMerchantIdPK: {
-        S: 'txn!|merchantId#eQMZ2ikPmUd3cqrptbpna',
-      },
-      updated: {
-        N: '1685071087846',
-      },
-      txnId: {
-        S: '_tQ72mu5Iy2PYJ33c497g',
-      },
-      txnMethodIdPK: {
-        S: 'txn!|methodId#KDvC6leEzkAAf8-akh_vO',
-      },
-    },
-    SequenceNumber: '31120900000000039175922358',
-    SizeBytes: 801,
-    StreamViewType: 'NEW_AND_OLD_IMAGES',
-  },
-  eventSourceARN:
-    'arn:aws:dynamodb:us-east-1:546652796775:table/api-txn-v0-bali/stream/2023-05-19T12:57:41.682',
-};
-
-// This initializes a JsonMap instance.
-const jsonMap = new JsonMap(lib, map);
-
-// This transforms the sample input data.
-const result = jsonMap.transform(input);
-
-// This is the result!
-// {
-//   txn: {
-//     txnId: '_tQ72mu5Iy2PYJ33c497g',
-//     roundup: '$0.70',
-//   },
-//   foo: 'bar',
-//   baz: 'BAR',
-//   fetch: {
-//     statusCode: 200,
-//     message: 'asynchronously fetched data!'
-//   }
-// }
-```
-
-The class should accommodate deep placement of transformations within the map object. It should also recursively account for transformation objects that resolve into transformation objects.
-
-Fully implement the JsonMap class with jsdoc comments.