json-diff-ts 1.2.6 → 1.2.8

package/README.md

@@ -281,7 +281,7 @@ 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

package/lib/jsonCompare.js

@@ -27,7 +27,7 @@ const enrich = (object) => {
             }, (0, exports.createContainer)({}));
         case 'Array':
             return (0, lodash_1.chain)(object)
-                .map(value => (0, exports.enrich)(value))
+                .map((value) => (0, exports.enrich)(value))
                 .reduce((accumulator, value) => {
                 accumulator.value.push(value);
                 return accumulator;
@@ -44,14 +44,14 @@ const enrich = (object) => {
 exports.enrich = enrich;
 const applyChangelist = (object, changelist) => {
     (0, lodash_1.chain)(changelist)
-        .map(entry => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, '$.', '.') })))
-        .map(entry => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /(\[(?<array>\d)\]\.)/g, 'ARRVAL_START$<array>ARRVAL_END') })))
-        .map(entry => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /(?<dot>\.)/g, '.value$<dot>') })))
-        .map(entry => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /\./, '') })))
-        .map(entry => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /ARRVAL_START/g, '.value[') })))
-        .map(entry => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /ARRVAL_END/g, '].value.') })))
+        .map((entry) => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, '$.', '.') })))
+        .map((entry) => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /(\[(?<array>\d)\]\.)/g, 'ARRVAL_START$<array>ARRVAL_END') })))
+        .map((entry) => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /(?<dot>\.)/g, '.value$<dot>') })))
+        .map((entry) => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /\./, '') })))
+        .map((entry) => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /ARRVAL_START/g, '.value[') })))
+        .map((entry) => (Object.assign(Object.assign({}, entry), { path: (0, lodash_1.replace)(entry.path, /ARRVAL_END/g, '].value.') })))
         .value()
-        .forEach(entry => {
+        .forEach((entry) => {
         switch (entry.type) {
             case jsonDiff_1.Operation.ADD:
             case jsonDiff_1.Operation.UPDATE:

package/lib/jsonDiff.d.ts

@@ -1,7 +1,6 @@
-import { Dictionary } from 'lodash';
-declare type FunctionKey = (obj: any, getKeyName?: boolean) => any;
+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 diff: (oldObj: any, newObj: any, embeddedObjKeys?: Record<string, string | FunctionKey>) => IChange[];
 export declare const applyChangeset: (obj: any, changeset: Changeset) => any;
 export declare const revertChangeset: (obj: any, changeset: Changeset) => any;
 export declare enum Operation {
@@ -17,7 +16,7 @@ export interface IChange {
     oldValue?: any;
     changes?: IChange[];
 }
-export declare type Changeset = IChange[];
+export type Changeset = IChange[];
 export interface IFlatChange {
     type: Operation;
     key: string;

package/lib/jsonDiff.js

@@ -134,7 +134,12 @@ const getObjectKey = (embeddedObjKeys, keyPath) => {
 };
 const convertArrayToObj = (arr, uniqKey) => {
     let obj = {};
-    if (uniqKey !== '$index') {
+    if (uniqKey === '$value') {
+        arr.forEach((value) => {
+            obj[value] = value;
+        });
+    }
+    else if (uniqKey !== '$index') {
         obj = (0, lodash_1.keyBy)(arr, uniqKey);
     }
     else {
@@ -179,6 +184,9 @@ const removeKey = (obj, key, embeddedKey) => {
     }
 };
 const indexOfItemInArray = (arr, key, value) => {
+    if (key === '$value') {
+        return arr.indexOf(value);
+    }
     for (let i = 0; i < arr.length; i++) {
         const item = arr[i];
         if (item && item[key] ? item[key].toString() === value.toString() : undefined) {
@@ -218,6 +226,12 @@ const applyArrayChange = (arr, change) => (() => {
             if (change.embeddedKey === '$index') {
                 element = arr[subchange.key];
             }
+            else if (change.embeddedKey === '$value') {
+                const index = arr.indexOf(subchange.key);
+                if (index !== -1) {
+                    element = arr[index];
+                }
+            }
             else {
                 element = (0, lodash_1.find)(arr, (el) => el[change.embeddedKey].toString() === subchange.key.toString());
             }
@@ -304,21 +318,31 @@ const flattenChangeset = (obj, path = '$', embeddedKey) => {
     }
     else {
         if (obj.changes || embeddedKey) {
-            path = embeddedKey
-                ? embeddedKey === '$index'
-                    ? `${path}[${obj.key}]`
-                    : obj.type === Operation.ADD
-                        ? path
-                        : filterExpression(path, embeddedKey, obj.key)
-                : (path = append(path, obj.key));
+            if (embeddedKey) {
+                if (embeddedKey === '$index') {
+                    path = `${path}[${obj.key}]`;
+                }
+                else if (embeddedKey === '$value') {
+                    path = `${path}[?(@='${obj.key}')]`;
+                    const valueType = (0, exports.getTypeOfObj)(obj.value);
+                    return [
+                        Object.assign(Object.assign({}, obj), { path,
+                            valueType })
+                    ];
+                }
+                else if (obj.type !== Operation.ADD) {
+                    path = `${path}[?(@.${embeddedKey}='${obj.key}')]`;
+                }
+            }
+            else {
+                path = `${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
-                        : append(path, obj.key), valueType })
+                Object.assign(Object.assign({}, obj), { path: valueType === 'Object' || path.endsWith(`[${obj.key}]`) ? path : `${path}.${obj.key}`, valueType })
             ];
         }
     }
@@ -356,7 +380,7 @@ const unflattenChanges = (changes) => {
             for (let i = 1; i < segments.length; i++) {
                 const segment = segments[i];
                 // check for array
-                const result = /^(.+)\[\?\(@\.(.+)='(.+)'\)]$|^(.+)\[(\d+)\]/.exec(segment);
+                const result = /^(.+)\[\?\(@\.?(.{0,})='(.+)'\)]$|^(.+)\[(\d+)\]/.exec(segment);
                 // array
                 if (result) {
                     let key;
@@ -364,7 +388,7 @@ const unflattenChanges = (changes) => {
                     let arrKey;
                     if (result[1]) {
                         key = result[1];
-                        embeddedKey = result[2];
+                        embeddedKey = result[2] || '$value';
                         arrKey = result[3];
                     }
                     else {
@@ -440,15 +464,3 @@ 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,12 +1,12 @@
 {
   "name": "json-diff-ts",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "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",
   "scripts": {
     "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "format": "prettier --write \"src/**/*.ts\"",
     "lint": "tslint -p tsconfig.json",
     "test": "jest --config jest.config.json",
     "test:watch": "jest --watch --config jest.config.json",
@@ -38,15 +38,15 @@
   "homepage": "https://github.com/ltwlf/json-diff-ts#readme",
   "devDependencies": {
     "@types/jest": "^29.1.1",
-    "@types/lodash": "^4.14.149",
-    "jest": "^24.9.0",
+    "@types/lodash-es": "^4.14.149",
+    "jest": "^29.5.0",
     "prettier": "^2.5.1",
-    "ts-jest": "^24.2.0",
+    "ts-jest": "^29.0.5",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
     "typescript": "^4.5.2"
   },
-  "peerDependencies": {
-    "lodash": "^4.x"
+  "dependencies": {
+    "lodash": "^4.17.21"
   }
-}
+}