json-diff-ts 2.0.0 → 2.1.0

package/README.md

@@ -119,6 +119,18 @@ Paths can be utilized to identify keys within nested arrays.
 const diffs = diff(oldData, newData, { characters.subarray: 'id' });
 ```
 
+Alternative Syntax
+
+```javascript
+const diffs = diff(oldData, newData, { 'characters.subarray': 'id' });
+```
+
+You can also designate the root by using '.' instead of an empty string ('').
+
+```javascript
+const diffs = diff(oldData, newData, { '.characters.subarray': 'id' });
+```
+
 You can use a function to dynamically resolve the key of the object.
 The first parameter is the object and the second is to signal if the function should return the key name instead of the value. This is needed to flatten the changeset
 
@@ -238,6 +250,7 @@ Discover more about the company behind this project: [hololux](https://hololux.c
 
 ## Release Notes
 
+- **v2.1.0:** Resolves a problem related to JSON Path filters by replacing the single equal sign (=) with a double equal sign (==). This update maintains compatibility with existing flat changes. Allows to use either '' or '.' as root in the path.
 - **v2.0.0:** json-diff-ts has been upgraded to an ECMAScript module! This major update brings optimizations and enhanced documentation. Additionally, a previously existing issue where all paths were treated as regex has been fixed. In this new version, you'll need to use a Map instead of a Record for regex paths. Please note that this is a breaking change if you were using regex paths in the previous versions.
 - **v1.2.6:** Enhanced JSON Path handling for period-inclusive segments.
 - **v1.2.5:** Patched dependencies; added key name resolution support for key functions.

package/lib/jsonDiff.d.ts

@@ -23,6 +23,14 @@ export interface IFlatChange {
     value?: any;
     oldValue?: any;
 }
+/**
+ * Computes the difference between two objects.
+ *
+ * @param {any} oldObj - The original object.
+ * @param {any} newObj - The updated object.
+ * @param {EmbeddedObjKeysType | EmbeddedObjKeysMapType} embeddedObjKeys - An optional parameter specifying keys of embedded objects.
+ * @returns {IChange[]} - An array of changes that transform the old object into the new object.
+ */
 export declare function diff(oldObj: any, newObj: any, embeddedObjKeys?: EmbeddedObjKeysType | EmbeddedObjKeysMapType): IChange[];
 /**
  * Applies all changes in the changeset to the object.

package/lib/jsonDiff.js

@@ -5,7 +5,26 @@ export var Operation;
     Operation["ADD"] = "ADD";
     Operation["UPDATE"] = "UPDATE";
 })(Operation || (Operation = {}));
+/**
+ * Computes the difference between two objects.
+ *
+ * @param {any} oldObj - The original object.
+ * @param {any} newObj - The updated object.
+ * @param {EmbeddedObjKeysType | EmbeddedObjKeysMapType} embeddedObjKeys - An optional parameter specifying keys of embedded objects.
+ * @returns {IChange[]} - An array of changes that transform the old object into the new object.
+ */
 export function diff(oldObj, newObj, embeddedObjKeys) {
+    // Trim leading '.' from keys in embeddedObjKeys
+    if (embeddedObjKeys instanceof Map) {
+        embeddedObjKeys = new Map(Array.from(embeddedObjKeys.entries()).map(([key, value]) => [
+            key instanceof RegExp ? key : key.replace(/^\./, ''),
+            value
+        ]));
+    }
+    else if (embeddedObjKeys) {
+        embeddedObjKeys = Object.fromEntries(Object.entries(embeddedObjKeys).map(([key, value]) => [key.replace(/^\./, ''), value]));
+    }
+    // Compare old and new objects to generate a list of changes
     return compare(oldObj, newObj, [], embeddedObjKeys, []);
 }
 /**
@@ -115,14 +134,7 @@ export const unflattenChanges = (changes) => {
     changes.forEach((change) => {
         const obj = {};
         let ptr = obj;
-        const segments = change.path.split(/([^@])\./).reduce((acc, curr, i) => {
-            const x = Math.floor(i / 2);
-            if (!acc[x]) {
-                acc[x] = '';
-            }
-            acc[x] += curr;
-            return acc;
-        }, []);
+        const segments = change.path.split(/(?<=[^@])\.(?=[^@])/);
         if (segments.length === 1) {
             ptr.key = change.key;
             ptr.type = change.type;
@@ -133,8 +145,8 @@ export const unflattenChanges = (changes) => {
         else {
             for (let i = 1; i < segments.length; i++) {
                 const segment = segments[i];
-                // Matches JSONPath segments: "items[?(@.id='123')]" or "items[2]"
-                const result = /^(.+)\[\?\(@\.(.+)='(.+)'\)]$|^(.+)\[(\d+)\]/.exec(segment);
+                // Matches JSONPath segments: "items[?(@.id=='123')]", items[?(@.id==123)], "items[2]"
+                const result = /^(.+)\[\?\(@\.([^=]+)={1,2}(?:'(.*)'|(\d+))\)\]$|^(.+)\[(\d+)\]$/.exec(segment);
                 // array
                 if (result) {
                     let key;
@@ -146,9 +158,9 @@ export const unflattenChanges = (changes) => {
                         arrKey = result[3];
                     }
                     else {
-                        key = result[4];
+                        key = result[5];
                         embeddedKey = '$index';
-                        arrKey = Number(result[5]);
+                        arrKey = Number(result[6]);
                     }
                     // leaf
                     if (i === segments.length - 1) {
@@ -454,7 +466,7 @@ const applyArrayChange = (arr, change) => (() => {
                 element = arr[subchange.key];
             }
             else {
-                element = find(arr, (el) => el[change.embeddedKey].toString() === subchange.key.toString());
+                element = find(arr, (el) => el[change.embeddedKey]?.toString() === subchange.key.toString());
             }
             result.push(applyChangeset(element, subchange.changes));
         }
@@ -513,7 +525,8 @@ function append(basePath, nextSegment) {
 }
 /** returns a JSON Path filter expression; e.g., `$.pet[(?name='spot')]` */
 function filterExpression(basePath, filterKey, filterValue) {
+    const value = typeof filterValue === 'number' ? filterValue : `'${filterValue}'`;
     return typeof filterKey === 'string' && filterKey.includes('.')
-        ? `${basePath}[?(@[${filterKey}]='${filterValue}')]`
-        : `${basePath}[?(@.${filterKey}='${filterValue}')]`;
+        ? `${basePath}[?(@[${filterKey}]==${value})]`
+        : `${basePath}[?(@.${filterKey}==${value})]`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-diff-ts",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A JSON diff tool for JavaScript written in TypeScript.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",