json-diff-ts 1.0.12 → 1.2.2

package/README.md

@@ -1,12 +1,10 @@
 # json-diff-ts
 
-![Master CI/Publish](https://github.com/ltwlf/json-diff-ts/workflows/Master%20CI/Publish/badge.svg) 
+![Master CI/Publish](https://github.com/ltwlf/json-diff-ts/workflows/Master%20CI/Publish/badge.svg)
 [![Known Vulnerabilities](https://snyk.io/test/github/ltwlf/json-diff-ts/badge.svg?targetFile=package.json)](https://snyk.io/test/github/ltwlf/json-diff-ts?targetFile=package.json)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ltwlf_json-diff-ts&metric=alert_status)](https://sonarcloud.io/dashboard?id=ltwlf_json-diff-ts)
 
-A diff tool for JavaScript based on https://www.npmjs.com/package/diff-json (viruschidai@gmail.com) rewritten in TypeScript.
-
-The most compelling feature of this diff library is the support for array keys instead of just indexes and is compatible with JSONPath.
+TypeScript diff tool with support for array keys instead of just indexes and compatible with JSONPath.
 
 ## Features
 
@@ -17,60 +15,70 @@ If a key is specified for an embedded array, the diff will be generated based on
 #### Examples:
 
 ```javascript
+var changesets = require('json-diff-ts');
+var newObj, oldObj;
+
+oldObj = {
+  name: 'joe',
+  age: 55,
+  coins: [2, 5],
+  children: [
+    { name: 'kid1', age: 1 },
+    { name: 'kid2', age: 2 }
+  ]
+};
+
+newObj = {
+  name: 'smith',
+  coins: [2, 5, 1],
+  children: [
+    { name: 'kid3', age: 3 },
+    { name: 'kid1', age: 0 },
+    { name: 'kid2', age: 2 }
+  ]
+};
 
-  var changesets = require('diff-json-ts');
-  var newObj, oldObj;
-
-  oldObj = {
-    name: 'joe',
-    age: 55,
-    coins: [2, 5],
-    children: [
-      {name: 'kid1', age: 1},
-      {name: 'kid2', age: 2}
-    ]};
-
-  newObj = {
-    name: 'smith',
-    coins: [2, 5, 1],
-    children: [
-      {name: 'kid3', age: 3},
-      {name: 'kid1', age: 0},
-      {name: 'kid2', age: 2}
-    ]};
-
-
-  # Assume children is an array of child object and the child object has 'name' as its primary key
-  diffs = changesets.diff(oldObj, newObj, {children: 'name'}); // keys can also be hierarchical e.g. {children: 'name', 'children.grandChildren', 'age'}
+// 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; }}
+diffs = changesets.diff(oldObj, newObj, { children: 'name' });
 
-  expect(diffs).to.eql([
-    {
-      type: 'update', key: 'name', value: 'smith', oldValue: 'joe'
-    },
-    {
-      type: 'update', key: 'coins', embededKey: '$index', changes: [
-          {type: 'add', key: '2', value: 1 }
-        ]
-    },
-    {
-      type: 'update',
-      key: 'children',
-      embededKey: 'name',
-      changes: [
-        {
-          type: 'update', key: 'kid1', changes: [
-            {type: 'update', key: 'age', value: 0, oldValue: 1 }
-          ]
-        },
-        {
-          type: 'add', key: 'kid3', value: {name: 'kid3', age: 3 }
-        }
-      ]
-    },
-    {
-      type: 'remove', key: 'age', value: 55
-    }
-  ]);
+expect(diffs).to.eql([
+  {
+    type: 'update',
+    key: 'name',
+    value: 'smith',
+    oldValue: 'joe'
+  },
+  {
+    type: 'update',
+    key: 'coins',
+    embededKey: '$index',
+    changes: [{ type: 'add', key: '2', value: 1 }]
+  },
+  {
+    type: 'update',
+    key: 'children',
+    embededKey: 'name',
+    changes: [
+      {
+        type: 'update',
+        key: 'kid1',
+        changes: [{ type: 'update', key: 'age', value: 0, oldValue: 1 }]
+      },
+      {
+        type: 'add',
+        key: 'kid3',
+        value: { name: 'kid3', age: 3 }
+      }
+    ]
+  },
+  {
+    type: 'remove',
+    key: 'age',
+    value: 55
+  }
+]);
 ```
 
 ### flattenChangeset
@@ -87,7 +95,7 @@ const changeset = unflattenChanges(flatChanges.slice(1, 5));
 // ...
 ```
 
-The **flatChange** formant will look like this:
+The **flatChange** format will look like this:
 
 ```javascript
 [
@@ -132,58 +140,65 @@ The **flatChange** formant will look like this:
 #### Examples:
 
 ```javascript
-
-  var changesets = require('diff-json-ts');
-  var oldObj = {
-    name: 'joe',
-    age: 55,
-    coins: [2, 5],
-    children: [
-      {name: 'kid1', age: 1},
-      {name: 'kid2', age: 2}
-    ]};
-
-
-  # Assume children is an array of child object and the child object has 'name' as its primary key
-  diffs = [
-    {
-      type: 'update', key: 'name', value: 'smith', oldValue: 'joe'
-    },
-    {
-      type: 'update', key: 'coins', embededKey: '$index', changes: [
-          {type: 'add', key: '2', value: 1 }
-        ]
-    },
-    {
-      type: 'update',
-      key: 'children',
-      embededKey: 'name', // The key property name of the elements in an array
-      changes: [
-        {
-          type: 'update', key: 'kid1', changes: [
-            {type: 'update', key: 'age', value: 0, oldValue: 1 }
-          ]
-        },
-        {
-          type: 'add', key: 'kid3', value: {name: 'kid3', age: 3 }
-        }
-      ]
-    },
-    {
-      type: 'remove', key: 'age', value: 55
-    }
+var changesets = require('json-diff-ts');
+var oldObj = {
+  name: 'joe',
+  age: 55,
+  coins: [2, 5],
+  children: [
+    { name: 'kid1', age: 1 },
+    { name: 'kid2', age: 2 }
   ]
+};
 
-  changesets.applyChanges(oldObj, diffs)
-  expect(oldObj).to.eql({
-    name: 'smith',
-    coins: [2, 5, 1],
-    children: [
-      {name: 'kid3', age: 3},
-      {name: 'kid1', age: 0},
-      {name: 'kid2', age: 2}
-    ]});
+// Assume children is an array of child object and the child object has 'name' as its primary key
+diffs = [
+  {
+    type: 'update',
+    key: 'name',
+    value: 'smith',
+    oldValue: 'joe'
+  },
+  {
+    type: 'update',
+    key: 'coins',
+    embededKey: '$index',
+    changes: [{ type: 'add', key: '2', value: 1 }]
+  },
+  {
+    type: 'update',
+    key: 'children',
+    embededKey: 'name', // The key property name of the elements in an array
+    changes: [
+      {
+        type: 'update',
+        key: 'kid1',
+        changes: [{ type: 'update', key: 'age', value: 0, oldValue: 1 }]
+      },
+      {
+        type: 'add',
+        key: 'kid3',
+        value: { name: 'kid3', age: 3 }
+      }
+    ]
+  },
+  {
+    type: 'remove',
+    key: 'age',
+    value: 55
+  }
+];
 
+changesets.applyChanges(oldObj, diffs);
+expect(oldObj).to.eql({
+  name: 'smith',
+  coins: [2, 5, 1],
+  children: [
+    { name: 'kid3', age: 3 },
+    { name: 'kid1', age: 0 },
+    { name: 'kid2', age: 2 }
+  ]
+});
 ```
 
 ### revertChange
@@ -192,7 +207,7 @@ The **flatChange** formant will look like this:
 
 ```javascript
 
-  var changesets = require('diff-json-ts');
+  var changesets = require('json-diff-ts');
 
   var newObj = {
     name: 'smith',
@@ -203,7 +218,7 @@ The **flatChange** formant will look like this:
       {name: 'kid2', age: 2}
    ]};
 
-  # Assume children is an array of child object and the child object has 'name' as its primary key
+  // Assume children is an array of child object and the child object has 'name' as its primary key
   diffs =  [
     {
       type: 'update', key: 'name', value: 'smith', oldValue: 'joe'
@@ -258,10 +273,18 @@ npm run test
 ```
 
 ## Contact
+
 Blog: https://blog.leitwolf.io
 
 Twitter: [@cglessner](https://twitter.com/cglessner)
 
+## Changelog
+
+- v1.2.2 Add support for functions to resove object keys (PR by [Abraxxa](https://github.com/abraxxa))
+
+## Credits
+
+This project was based on https://www.npmjs.com/package/diff-json (viruschidai@gmail.com)
 
 ## Licence
 
@@ -275,7 +298,7 @@ The above copyright notice and this permission notice shall be included in all c
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-The project is based on diff-json (https://www.npmjs.com/package/diff-json). Copyright 2013 viruschidai@gmail.com. for additional details. 
+The project is based on diff-json (https://www.npmjs.com/package/diff-json). Copyright 2013 viruschidai@gmail.com. for additional details.
 
 **Original License**
 

package/lib/index.d.ts

@@ -1 +1,2 @@
 export * from './jsonDiff';
+export * from './jsonCompare';

package/lib/index.js

@@ -4,3 +4,4 @@ function __export(m) {
 }
 Object.defineProperty(exports, "__esModule", { value: true });
 __export(require("./jsonDiff"));
+__export(require("./jsonCompare"));

package/lib/jsonCompare.d.ts

@@ -0,0 +1,15 @@
+import { IFlatChange, Operation } from './jsonDiff';
+export declare enum CompareOperation {
+    CONTAINER = "CONTAINER",
+    UNCHANGED = "UNCHANGED"
+}
+export interface IComparisonEnrichedNode {
+    type: Operation | CompareOperation;
+    value: IComparisonEnrichedNode | IComparisonEnrichedNode[] | any | any[];
+    oldValue?: any;
+}
+export declare const createValue: (value: any) => IComparisonEnrichedNode;
+export declare const createContainer: (value: object | []) => IComparisonEnrichedNode;
+export declare const enrich: (object: any) => IComparisonEnrichedNode;
+export declare const applyChangelist: (object: IComparisonEnrichedNode, changelist: IFlatChange[]) => IComparisonEnrichedNode;
+export declare const compare: (oldObject: any, newObject: any) => IComparisonEnrichedNode;

package/lib/jsonCompare.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const jsonDiff_1 = require("./jsonDiff");
+var CompareOperation;
+(function (CompareOperation) {
+    CompareOperation["CONTAINER"] = "CONTAINER";
+    CompareOperation["UNCHANGED"] = "UNCHANGED";
+})(CompareOperation = exports.CompareOperation || (exports.CompareOperation = {}));
+exports.createValue = (value) => ({ type: CompareOperation.UNCHANGED, value });
+exports.createContainer = (value) => ({
+    type: CompareOperation.CONTAINER,
+    value
+});
+exports.enrich = (object) => {
+    const objectType = jsonDiff_1.getTypeOfObj(object);
+    switch (objectType) {
+        case 'Object':
+            return lodash_1.keys(object)
+                .map((key) => ({ key, value: exports.enrich(object[key]) }))
+                .reduce((accumulator, entry) => {
+                accumulator.value[entry.key] = entry.value;
+                return accumulator;
+            }, exports.createContainer({}));
+        case 'Array':
+            return lodash_1.chain(object)
+                .map(value => exports.enrich(value))
+                .reduce((accumulator, value) => {
+                accumulator.value.push(value);
+                return accumulator;
+            }, exports.createContainer([]))
+                .value();
+        case 'Function':
+            return undefined;
+        case 'Date':
+        default:
+            // Primitive value
+            return exports.createValue(object);
+    }
+};
+exports.applyChangelist = (object, changelist) => {
+    lodash_1.chain(changelist)
+        .map(entry => (Object.assign(Object.assign({}, entry), { path: lodash_1.replace(entry.path, '$.', '.') })))
+        .map(entry => (Object.assign(Object.assign({}, entry), { path: lodash_1.replace(entry.path, /(\[(?<array>\d)\]\.)/g, 'ARRVAL_START$<array>ARRVAL_END') })))
+        .map(entry => (Object.assign(Object.assign({}, entry), { path: lodash_1.replace(entry.path, /(?<dot>\.)/g, '.value$<dot>') })))
+        .map(entry => (Object.assign(Object.assign({}, entry), { path: lodash_1.replace(entry.path, /\./, '') })))
+        .map(entry => (Object.assign(Object.assign({}, entry), { path: lodash_1.replace(entry.path, /ARRVAL_START/g, '.value[') })))
+        .map(entry => (Object.assign(Object.assign({}, entry), { path: lodash_1.replace(entry.path, /ARRVAL_END/g, '].value.') })))
+        .value()
+        .forEach(entry => {
+        switch (entry.type) {
+            case jsonDiff_1.Operation.ADD:
+            case jsonDiff_1.Operation.UPDATE:
+                lodash_1.set(object, entry.path, { type: entry.type, value: entry.value, oldValue: entry.oldValue });
+                break;
+            case jsonDiff_1.Operation.REMOVE:
+                lodash_1.set(object, entry.path, { type: entry.type, value: undefined, oldValue: entry.value });
+                break;
+            default:
+                throw new Error();
+        }
+    });
+    return object;
+};
+exports.compare = (oldObject, newObject) => {
+    return exports.applyChangelist(exports.enrich(oldObject), jsonDiff_1.flattenChangeset(jsonDiff_1.diff(oldObject, newObject)));
+};

package/lib/jsonDiff.d.ts

@@ -1,6 +1,7 @@
 import { Dictionary } from 'lodash';
+declare type FunctionKey = (obj: any) => any;
 export declare const getTypeOfObj: (obj: any) => string;
-export declare const diff: (oldObj: any, newObj: any, embeddedObjKeys?: Dictionary<string>) => IChange[];
+export declare const diff: (oldObj: any, newObj: any, embeddedObjKeys?: Dictionary<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 {
@@ -11,7 +12,7 @@ export declare enum Operation {
 export interface IChange {
     type: Operation;
     key: string;
-    embeddedKey?: string;
+    embeddedKey?: string | FunctionKey;
     value?: any | any[];
     oldValue?: any;
     changes?: IChange[];
@@ -25,5 +26,6 @@ export interface IFlatChange {
     value?: any;
     oldValue?: any;
 }
-export declare const flattenChangeset: (obj: IChange | Changeset, path?: string, embeddedKey?: string) => IFlatChange[];
+export declare const flattenChangeset: (obj: IChange | Changeset, path?: string, embeddedKey?: string | FunctionKey) => IFlatChange[];
 export declare const unflattenChanges: (changes: IFlatChange | IFlatChange[]) => IChange[];
+export {};

package/lib/jsonDiff.js

@@ -96,7 +96,7 @@ const compareObject = (oldObj, newObj, path, embeddedObjKeys, keyPath, skipPath
     return changes;
 };
 const compareArray = (oldObj, newObj, path, embeddedObjKeys, keyPath) => {
-    const left = embeddedObjKeys != null ? embeddedObjKeys[keyPath.join('.')] : undefined;
+    const left = getObjectKey(embeddedObjKeys, keyPath);
     const uniqKey = left != null ? left : '$index';
     const indexedOldObj = convertArrayToObj(oldObj, uniqKey);
     const indexedNewObj = convertArrayToObj(newObj, uniqKey);
@@ -115,6 +115,21 @@ const compareArray = (oldObj, newObj, path, embeddedObjKeys, keyPath) => {
         return [];
     }
 };
+const getObjectKey = (embeddedObjKeys, keyPath) => {
+    if (embeddedObjKeys != null) {
+        const path = keyPath.join('.');
+        const key = embeddedObjKeys[path];
+        if (key != null) {
+            return key;
+        }
+        for (const regex in embeddedObjKeys) {
+            if (path.match(new RegExp(regex))) {
+                return embeddedObjKeys[regex];
+            }
+        }
+    }
+    return undefined;
+};
 const convertArrayToObj = (arr, uniqKey) => {
     let obj = {};
     if (uniqKey !== '$index') {
@@ -309,7 +324,14 @@ exports.unflattenChanges = (changes) => {
     changes.forEach(change => {
         const obj = {};
         let ptr = obj;
-        const segments = change.path.split(/((?<!@)\.)/).filter(x => x !== '.');
+        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;
+        }, []);
         // $.childern[@.name='chris'].age
         // =>
         // $

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-diff-ts",
-  "version": "1.0.12",
+  "version": "1.2.2",
   "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",