json-diff-ts 1.2.4 → 1.2.6

package/README.md

@@ -10,7 +10,7 @@ TypeScript diff tool with support for array keys instead of just indexes and com
 
 ### diff
 
-If a key is specified for an embedded array, the diff will be generated based on the objects have same keys.
+If a embedded key is specified for an array, the diff will be generated based on the objects with the same keys.
 
 #### Examples:
 
@@ -41,6 +41,8 @@ newObj = {
 // Assume children is an array of child object and the child object has 'name' as its primary key
 // keys can also be hierarchical e.g. {children: 'name', 'children.grandChildren', 'age'}
 // or use functions that return the key of an object e.g. {children: function(obj) { return obj.key; }}
+// when you use a function flatten can not generate the correct path.
+// to fix this, you can add an additional parameter e.g. (obj, getKeyNameFlag) => {...}. getKeyNameFlag will be true when the diff library try to resolve the key name instead of the key value. You can return a static string or use obj to check which key name you should return. obj will be the first object of the array!
 diffs = changesets.diff(oldObj, newObj, { children: 'name' });
 
 expect(diffs).to.eql([
@@ -279,7 +281,8 @@ Blog: https://blog.leitwolf.io
 Twitter: [@cglessner](https://twitter.com/cglessner)
 
 ## Changelog
-
+- v1.2.6 Improve handling of JSON Path segments that include periods (PR by [EdVinyard](https://github.com/EdVinyard))
+- v1.2.5 Patch all dependencies; add support for resolving a key name if a function is used to get the key value
 - v1.2.4 Fix readme (npm install); update TypeScript and Lodash
 - v1.2.3 Update outdated dependencies; update TypeScript version to 4.5.2
 - v1.2.2 Add support for functions to resove object keys (PR by [Abraxxa](https://github.com/abraxxa))

package/lib/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/jsonDiff.d.ts

@@ -1,5 +1,5 @@
 import { Dictionary } from 'lodash';
-declare type FunctionKey = (obj: any) => any;
+declare type FunctionKey = (obj: any, getKeyName?: boolean) => any;
 export declare const getTypeOfObj: (obj: any) => string;
 export declare const diff: (oldObj: any, newObj: any, embeddedObjKeys?: Dictionary<string | FunctionKey>) => IChange[];
 export declare const applyChangeset: (obj: any, changeset: Changeset) => any;

package/lib/jsonDiff.js

@@ -28,7 +28,7 @@ const compare = (oldObj, newObj, path, embeddedObjKeys, keyPath) => {
     }
     switch (typeOfOldObj) {
         case 'Date':
-            changes = changes.concat(comparePrimitives(oldObj.getTime(), newObj.getTime(), path).map(x => (Object.assign(Object.assign({}, x), { value: new Date(x.value), oldValue: new Date(x.oldValue) }))));
+            changes = changes.concat(comparePrimitives(oldObj.getTime(), newObj.getTime(), path).map((x) => (Object.assign(Object.assign({}, x), { value: new Date(x.value), oldValue: new Date(x.oldValue) }))));
             break;
         case 'Object':
             const diffs = compareObject(oldObj, newObj, path, embeddedObjKeys, keyPath);
@@ -108,7 +108,7 @@ const compareArray = (oldObj, newObj, path, embeddedObjKeys, keyPath) => {
             {
                 type: Operation.UPDATE,
                 key: getKey(path),
-                embeddedKey: uniqKey,
+                embeddedKey: typeof uniqKey === 'function' && uniqKey.length === 2 ? uniqKey(newObj[0], true) : uniqKey,
                 changes: diffs
             }
         ];
@@ -219,7 +219,7 @@ const applyArrayChange = (arr, change) => (() => {
                 element = arr[subchange.key];
             }
             else {
-                element = (0, lodash_1.find)(arr, el => el[change.embeddedKey].toString() === subchange.key.toString());
+                element = (0, lodash_1.find)(arr, (el) => el[change.embeddedKey].toString() === subchange.key.toString());
             }
             result.push((0, exports.applyChangeset)(element, subchange.changes));
         }
@@ -257,7 +257,7 @@ const revertArrayChange = (arr, change) => (() => {
                 element = arr[+subchange.key];
             }
             else {
-                element = (0, lodash_1.find)(arr, el => el[change.embeddedKey].toString() === subchange.key);
+                element = (0, lodash_1.find)(arr, (el) => el[change.embeddedKey].toString() === subchange.key);
             }
             result.push((0, exports.revertChangeset)(element, subchange.changes));
         }
@@ -276,7 +276,7 @@ const diff = (oldObj, newObj, embeddedObjKeys) => compare(oldObj, newObj, [], em
 exports.diff = diff;
 const applyChangeset = (obj, changeset) => {
     if (changeset) {
-        changeset.forEach(change => (change.value !== null && change.value !== undefined) || change.type === Operation.REMOVE
+        changeset.forEach((change) => (change.value !== null && change.value !== undefined) || change.type === Operation.REMOVE
             ? applyLeafChange(obj, change, change.embeddedKey)
             : applyBranchChange(obj[change.key], change));
     }
@@ -309,14 +309,16 @@ const flattenChangeset = (obj, path = '$', embeddedKey) => {
                     ? `${path}[${obj.key}]`
                     : obj.type === Operation.ADD
                         ? path
-                        : `${path}[?(@.${embeddedKey}='${obj.key}')]`
-                : (path = `${path}.${obj.key}`);
+                        : filterExpression(path, embeddedKey, obj.key)
+                : (path = append(path, obj.key));
             return (0, exports.flattenChangeset)(obj.changes || obj, path, obj.embeddedKey);
         }
         else {
             const valueType = (0, exports.getTypeOfObj)(obj.value);
             return [
-                Object.assign(Object.assign({}, obj), { path: valueType === 'Object' || path.endsWith(`[${obj.key}]`) ? path : `${path}.${obj.key}`, valueType })
+                Object.assign(Object.assign({}, obj), { path: valueType === 'Object' || path.endsWith(`[${obj.key}]`)
+                        ? path
+                        : append(path, obj.key), valueType })
             ];
         }
     }
@@ -327,7 +329,7 @@ const unflattenChanges = (changes) => {
         changes = [changes];
     }
     const changesArr = [];
-    changes.forEach(change => {
+    changes.forEach((change) => {
         const obj = {};
         let ptr = obj;
         const segments = change.path.split(/([^@])\./).reduce((acc, curr, i) => {
@@ -438,3 +440,15 @@ const unflattenChanges = (changes) => {
     return changesArr;
 };
 exports.unflattenChanges = unflattenChanges;
+/** combine a base JSON Path with a subsequent segment */
+function append(basePath, nextSegment) {
+    return nextSegment.includes('.')
+        ? `${basePath}[${nextSegment}]`
+        : `${basePath}.${nextSegment}`;
+}
+/** returns a JSON Path filter expression; e.g., `$.pet[(?name='spot')]` */
+function filterExpression(basePath, filterKey, filterValue) {
+    return typeof filterKey === 'string' && filterKey.includes('.')
+        ? `${basePath}[?(@[${filterKey}]='${filterValue}')]`
+        : `${basePath}[?(@.${filterKey}='${filterValue}')]`;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-diff-ts",
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "A diff tool for JavaScript based on https://www.npmjs.com/package/diff-json written in TypeScript.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -37,7 +37,7 @@
   },
   "homepage": "https://github.com/ltwlf/json-diff-ts#readme",
   "devDependencies": {
-    "@types/jest": "^27.0.3",
+    "@types/jest": "^29.1.1",
     "@types/lodash": "^4.14.149",
     "jest": "^24.9.0",
     "prettier": "^2.5.1",