npm - json-diff-ts - Versions diffs - 1.2.6 → 2.0.0 - Mend

json-diff-ts 1.2.6 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md CHANGED Viewed

@@ -4,315 +4,253 @@
 [![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)
-TypeScript diff tool with support for array keys instead of just indexes and compatible with JSONPath.
+`json-diff-ts` is a TypeScript library that calculates and applies differences between JSON objects. A standout feature is its ability to identify elements in arrays using keys instead of indices, which offers a more intuitive way to handle arrays. It also supports JSONPath, a query language for JSON, which enables you to target specific parts of a JSON document with precision.
-## Features
+Another significant feature of this library is its ability to transform changesets into atomic changes. This means that each change in the data can be isolated and applied independently, providing a granular level of control over the data manipulation process.
-### diff
+This library is particularly valuable for applications where tracking changes in JSON data is crucial. It simplifies the process of comparing JSON objects and applying changes. The support for key-based array identification can be especially useful in complex JSON structures where tracking by index is not efficient or intuitive. JSONPath support further enhances its capabilities by allowing precise targeting of specific parts in a JSON document, making it a versatile tool for handling JSON data.
-If a embedded key is specified for an array, the diff will be generated based on the objects with the same keys.
+## Installation
-#### Examples:
+```sh
+npm install json-diff-ts
+```
+## Capabilities
+### `diff`
+Generates a difference set for JSON objects. When comparing arrays, if a specific key is provided, differences are determined by matching elements via this key rather than array indices.
+#### Examples using Star Wars data:
 ```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 }
+import { diff } from 'json-diff-ts';
+const oldData = {
+  planet: 'Tatooine',
+  faction: 'Jedi',
+  characters: [
+    { id: 'LUK', name: 'Luke Skywalker', force: true },
+    { id: 'LEI', name: 'Leia Organa', force: true }
   ]
 };
-newObj = {
-  name: 'smith',
-  coins: [2, 5, 1],
-  children: [
-    { name: 'kid3', age: 3 },
-    { name: 'kid1', age: 0 },
-    { name: 'kid2', age: 2 }
+const newData = {
+  planet: 'Alderaan',
+  faction: 'Rebel Alliance',
+  characters: [
+    { id: 'LUK', name: 'Luke Skywalker', force: true, rank: 'Commander' },
+    { id: 'HAN', name: 'Han Solo', force: false }
   ]
 };
-// 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' });
+const diffs = diff(oldData, newData, { characters: 'id' });
-expect(diffs).to.eql([
+const expectedDiffs = [
   {
-    type: 'update',
-    key: 'name',
-    value: 'smith',
-    oldValue: 'joe'
+    type: 'UPDATE',
+    key: 'planet',
+    value: 'Alderaan',
+    oldValue: 'Tatooine'
   },
   {
-    type: 'update',
-    key: 'coins',
-    embededKey: '$index',
-    changes: [{ type: 'add', key: '2', value: 1 }]
+    type: 'UPDATE',
+    key: 'faction',
+    value: 'Rebel Alliance',
+    oldValue: 'Jedi'
   },
   {
-    type: 'update',
-    key: 'children',
-    embededKey: 'name',
+    type: 'UPDATE',
+    key: 'characters',
+    embeddedKey: 'id',
     changes: [
       {
-        type: 'update',
-        key: 'kid1',
-        changes: [{ type: 'update', key: 'age', value: 0, oldValue: 1 }]
+        type: 'UPDATE',
+        key: 'LUK',
+        changes: [
+          {
+            type: 'ADD',
+            key: 'rank',
+            value: 'Commander'
+          }
+        ]
       },
       {
-        type: 'add',
-        key: 'kid3',
-        value: { name: 'kid3', age: 3 }
+        type: 'ADD',
+        key: 'HAN',
+        value: {
+          id: 'HAN',
+          name: 'Han Solo',
+          force: false
+        }
+      },
+      {
+        type: 'REMOVE',
+        key: 'LEI',
+        value: {
+          id: 'LEI',
+          name: 'Leia Organa',
+          force: true
+        }
       }
     ]
   },
   {
-    type: 'remove',
-    key: 'age',
-    value: 55
+    type: 'UPDATE',
+    key: 'weapons',
+    embeddedKey: '$index',
+    changes: [
+      {
+        type: 'ADD',
+        key: '2',
+        value: 'Bowcaster'
+      }
+    ]
   }
-]);
+];
 ```
-### flattenChangeset
+#### Advanced
-Converts the changeset into a flat atomic change list compatible with JSONPath.
+Paths can be utilized to identify keys within nested arrays.
+```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
+```javascript
+const diffs = diff(oldData, newData, {
+  characters: (obj, shouldReturnKeyName) => (shouldReturnKeyName ? 'id' : obj.id)
+});
+```
+If you're using the Map type, you can employ regular expressions for path identification.
+```javascript
+const embeddedObjKeys: EmbeddedObjKeysMapType = new Map();
+embeddedObjKeys.set(/^char\w+$/, 'id'); // instead of 'id' you can specify a function
+const diffs = diff(oldObj, newObj, embeddedObjKeys);
+```
+### `flattenChangeset`
+Transforms a complex changeset into a flat list of atomic changes, each describable by a JSONPath.
 #### Examples:
 ```javascript
 const flatChanges = flattenChangeset(diffs);
-// convert changes back to changeset format
-const changeset = unflattenChanges(flatChanges.slice(1, 5));
-// or use a JSONPath library to apply the patches
+// Restore the changeset from a selection of flat changes
+const changeset = unflattenChanges(flatChanges.slice(0, 3));
+// Alternatively, apply the changes using a JSONPath-capable library
 // ...
 ```
-The **flatChange** format will look like this:
+A **flatChange** will have the following structure:
 ```javascript
 [
-  { type: 'UPDATE', key: 'name', value: 'smith', oldValue: 'joe', path: '$.name', valueType: 'String' },
-  { type: 'REMOVE', key: 'mixed', value: 10, path: '$.mixed', valueType: 'Number' },
-  { type: 'UPDATE', key: 'inner', value: 2, oldValue: 1, path: '$.nested.inner', valueType: 'Number' },
-  {
-    type: 'UPDATE',
-    key: 'date',
-    value: '2014-10-12T09:13:00.000Z',
-    oldValue: '2014-10-13T09:13:00.000Z',
-    path: '$.date',
-    valueType: 'Date'
-  },
-  { type: 'ADD', key: '2', value: 1, path: '$.coins[2]', valueType: 'Number' },
-  { type: 'REMOVE', key: '0', value: 'car', path: '$.toys[0]', valueType: 'String' },
-  { type: 'REMOVE', key: '1', value: 'doll', path: '$.toys[1]', valueType: 'String' },
-  { type: 'REMOVE', key: '0', path: '$.pets[0]', valueType: 'undefined' },
-  { type: 'REMOVE', key: '1', value: null, path: '$.pets[1]', valueType: null },
-  { type: 'UPDATE', key: 'age', value: 0, oldValue: 1, path: "$.children[?(@.name='kid1')].age", valueType: 'Number' },
-  {
-    type: 'UPDATE',
-    key: 'value',
-    value: 'heihei',
-    oldValue: 'haha',
-    path: "$.children[?(@.name='kid1')].subset[?(@.id='1')].value",
-    valueType: 'String'
-  },
-  {
-    type: 'REMOVE',
-    key: '2',
-    value: { id: 2, value: 'hehe' },
-    path: "$.children[?(@.name='kid1')].subset[?(@.id='2')]",
-    valueType: 'Object'
-  },
-  { type: 'ADD', key: 'kid3', value: { name: 'kid3', age: 3 }, path: '$.children', valueType: 'Object' }
+  { type: 'UPDATE', key: 'planet', value: 'Alderaan', oldValue: 'Tatooine', path: '$.planet', valueType: 'String' },
+  // ... Additional flat changes here
+  { type: 'ADD', key: 'rank', value: 'Commander', path: "$.characters[?(@.id=='LUK')].rank", valueType: 'String' }
 ];
 ```
-### applyChange
+### `applyChange`
 #### Examples:
 ```javascript
-var changesets = require('json-diff-ts');
-var oldObj = {
-  name: 'joe',
-  age: 55,
-  coins: [2, 5],
-  children: [
-    { name: 'kid1', age: 1 },
-    { name: 'kid2', age: 2 }
-  ]
+const oldData = {
+  // ... Initial data here
 };
-// 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
-  }
+// Sample diffs array, similar to the one generated in the diff example
+const diffs = [
+  // ... Diff objects here
 ];
-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 }
-  ]
+changesets.applyChanges(oldData, diffs);
+expect(oldData).to.eql({
+  // ... Updated data here
 });
 ```
-### revertChange
+### `revertChange`
 #### Examples:
 ```javascript
+const newData = {
+  // ... Updated data here
+};
-  var changesets = require('json-diff-ts');
-  var 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 =  [
-    {
-      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.revertChanges(newObj, diffs)
-  expect(newObj).to.eql {
-    name: 'joe',
-    age: 55,
-    coins: [2, 5],
-    children: [
-      {name: 'kid1', age: 1},
-      {name: 'kid2', age: 2}
-    ]};
-```
+// Sample diffs array
+const diffs = [
+  // ... Diff objects here
+];
-## Get started
+changesets.revertChanges(newData, diffs);
-```
-npm install json-diff-ts
+expect(newData).to.eql({
+  // ... Original data restored here
+});
 ```
-## Run the test
+### `jsonPath`
-```
-npm run test
-```
+The `json-diff-ts` library uses JSONPath to address specific parts of a JSON document in both the changeset and the application/reversion of changes.
-## Contact
+#### Examples:
-Blog: https://blog.leitwolf.io
+```javascript
-Twitter: [@cglessner](https://twitter.com/cglessner)
+const jsonPath = changesets.jsonPath;
-## 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))
+cost data = {
+  // ... Some JSON data
+};
-## Credits
+const value = jsonPath.query(data, '$.characters[?(@.id=="LUK")].name');
-This project was based on https://www.npmjs.com/package/diff-json (viruschidai@gmail.com)
+expect(value).to.eql(['Luke Skywalker']);
+```
-## Licence
+## Contributing
-**The MIT License (MIT)**
+Contributions are welcome! Please follow the provided issue templates and code of conduct.
-Copyright (c) 2019 Christian Glessner
+## Contact
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Reach out to the maintainer via LinkedIn or Twitter:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+- LinkedIn: [Christian Glessner](https://www.linkedin.com/in/christian-glessner/)
+- Twitter: [@leitwolf_io](https://twitter.com/leitwolf_io)
-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.
+Discover more about the company behind this project: [hololux](https://hololux.com)
-The project is based on diff-json (https://www.npmjs.com/package/diff-json). Copyright 2013 viruschidai@gmail.com. for additional details.
+## Release Notes
-**Original License**
+- **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.
+- **v1.2.4:** Documentation updates; upgraded TypeScript and Lodash.
+- **v1.2.3:** Dependency updates; switched to TypeScript 4.5.2.
+- **v1.2.2:** Implemented object key resolution functions support.
-The MIT License (MIT)
+## Acknowledgments
-Copyright (c) 2013 viruschidai@gmail.com
+This project takes inspiration and code from [diff-json](https://www.npmjs.com/package/diff-json) by viruschidai@gmail.com.
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+## License
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+json-diff-ts is open-sourced software licensed under the [MIT license](LICENSE).
-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 original diff-json project is also under the MIT License. For more information, refer to its [license details](https://www.npmjs.com/package/diff-json#license).

package/lib/index.d.ts CHANGED Viewed

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

package/lib/index.js CHANGED Viewed

@@ -1,18 +1,2 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./jsonDiff"), exports);
-__exportStar(require("./jsonCompare"), exports);
+export * from './jsonDiff.js';
+export * from './jsonCompare.js';

package/lib/jsonCompare.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import { IFlatChange, Operation } from './jsonDiff';
+import { IFlatChange, Operation } from './jsonDiff.js';
 export declare enum CompareOperation {
     CONTAINER = "CONTAINER",
     UNCHANGED = "UNCHANGED"

package/lib/jsonCompare.js CHANGED Viewed

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

package/lib/jsonDiff.d.ts CHANGED Viewed

@@ -1,9 +1,6 @@
-import { Dictionary } from 'lodash';
-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;
-export declare const revertChangeset: (obj: any, changeset: Changeset) => any;
+type FunctionKey = (obj: any, shouldReturnKeyName?: boolean) => any;
+export type EmbeddedObjKeysType = Record<string, string | FunctionKey>;
+export type EmbeddedObjKeysMapType = Map<string | RegExp, string | FunctionKey>;
 export declare enum Operation {
     REMOVE = "REMOVE",
     ADD = "ADD",
@@ -17,7 +14,7 @@ export interface IChange {
     oldValue?: any;
     changes?: IChange[];
 }
-export declare type Changeset = IChange[];
+export type Changeset = IChange[];
 export interface IFlatChange {
     type: Operation;
     key: string;
@@ -26,6 +23,68 @@ export interface IFlatChange {
     value?: any;
     oldValue?: any;
 }
+export declare function diff(oldObj: any, newObj: any, embeddedObjKeys?: EmbeddedObjKeysType | EmbeddedObjKeysMapType): IChange[];
+/**
+ * Applies all changes in the changeset to the object.
+ *
+ * @param {any} obj - The object to apply changes to.
+ * @param {Changeset} changeset - The changeset to apply.
+ * @returns {any} - The object after the changes from the changeset have been applied.
+ *
+ * The function first checks if a changeset is provided. If so, it iterates over each change in the changeset.
+ * If the change value is not null or undefined, or if the change type is REMOVE, it applies the change to the object directly.
+ * Otherwise, it applies the change to the corresponding branch of the object.
+ */
+export declare const applyChangeset: (obj: any, changeset: Changeset) => any;
+/**
+ * Reverts the changes made to an object based on a given changeset.
+ *
+ * @param {any} obj - The object on which to revert changes.
+ * @param {Changeset} changeset - The changeset to revert.
+ * @returns {any} - The object after the changes from the changeset have been reverted.
+ *
+ * The function first checks if a changeset is provided. If so, it reverses the changeset to start reverting from the last change.
+ * It then iterates over each change in the changeset. If the change does not have any nested changes, it reverts the change on the object directly.
+ * If the change does have nested changes, it reverts the changes on the corresponding branch of the object.
+ */
+export declare const revertChangeset: (obj: any, changeset: Changeset) => any;
+/**
+ * Flattens a changeset into an array of flat changes.
+ *
+ * @param {Changeset | IChange} obj - The changeset or change to flatten.
+ * @param {string} [path='$'] - The current path in the changeset.
+ * @param {string | FunctionKey} [embeddedKey] - The key to use for embedded objects.
+ * @returns {IFlatChange[]} - An array of flat changes.
+ *
+ * The function first checks if the input is an array. If so, it recursively flattens each change in the array.
+ * If the input is not an array, it checks if the change has nested changes or an embedded key.
+ * If so, it updates the path and recursively flattens the nested changes or the embedded object.
+ * If the change does not have nested changes or an embedded key, it creates a flat change and returns it in an array.
+ */
 export declare const flattenChangeset: (obj: Changeset | IChange, path?: string, embeddedKey?: string | FunctionKey) => IFlatChange[];
+/**
+ * Transforms a flat changeset into a nested changeset.
+ *
+ * @param {IFlatChange | IFlatChange[]} changes - The flat changeset to unflatten.
+ * @returns {IChange[]} - The unflattened changeset.
+ *
+ * The function first checks if the input is a single change or an array of changes.
+ * It then iterates over each change and splits its path into segments.
+ * For each segment, it checks if it represents an array or a leaf node.
+ * If it represents an array, it creates a new change object and updates the pointer to this new object.
+ * If it represents a leaf node, it sets the key, type, value, and oldValue of the current change object.
+ * Finally, it pushes the unflattened change object into the changes array.
+ */
 export declare const unflattenChanges: (changes: IFlatChange | IFlatChange[]) => IChange[];
+/**
+ * Determines the type of a given object.
+ *
+ * @param {any} obj - The object whose type is to be determined.
+ * @returns {string | null} - The type of the object, or null if the object is null.
+ *
+ * This function first checks if the object is undefined or null, and returns 'undefined' or null respectively.
+ * If the object is neither undefined nor null, it uses Object.prototype.toString to get the object's type.
+ * The type is extracted from the string returned by Object.prototype.toString using a regular expression.
+ */
+export declare const getTypeOfObj: (obj: any) => string;
 export {};

package/lib/jsonDiff.js CHANGED Viewed

@@ -1,25 +1,250 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.unflattenChanges = exports.flattenChangeset = exports.Operation = exports.revertChangeset = exports.applyChangeset = exports.diff = exports.getTypeOfObj = void 0;
-const lodash_1 = require("lodash");
-const getTypeOfObj = (obj) => {
+import { difference, find, intersection, keyBy } from 'lodash-es';
+export var Operation;
+(function (Operation) {
+    Operation["REMOVE"] = "REMOVE";
+    Operation["ADD"] = "ADD";
+    Operation["UPDATE"] = "UPDATE";
+})(Operation || (Operation = {}));
+export function diff(oldObj, newObj, embeddedObjKeys) {
+    return compare(oldObj, newObj, [], embeddedObjKeys, []);
+}
+/**
+ * Applies all changes in the changeset to the object.
+ *
+ * @param {any} obj - The object to apply changes to.
+ * @param {Changeset} changeset - The changeset to apply.
+ * @returns {any} - The object after the changes from the changeset have been applied.
+ *
+ * The function first checks if a changeset is provided. If so, it iterates over each change in the changeset.
+ * If the change value is not null or undefined, or if the change type is REMOVE, it applies the change to the object directly.
+ * Otherwise, it applies the change to the corresponding branch of the object.
+ */
+export const applyChangeset = (obj, changeset) => {
+    if (changeset) {
+        changeset.forEach((change) => {
+            const { type, key, value, embeddedKey } = change;
+            if ((value !== null && value !== undefined) || type === Operation.REMOVE) {
+                // Apply the change to the object
+                applyLeafChange(obj, change, embeddedKey);
+            }
+            else {
+                // Apply the change to the branch
+                applyBranchChange(obj[key], change);
+            }
+        });
+    }
+    return obj;
+};
+/**
+ * Reverts the changes made to an object based on a given changeset.
+ *
+ * @param {any} obj - The object on which to revert changes.
+ * @param {Changeset} changeset - The changeset to revert.
+ * @returns {any} - The object after the changes from the changeset have been reverted.
+ *
+ * The function first checks if a changeset is provided. If so, it reverses the changeset to start reverting from the last change.
+ * It then iterates over each change in the changeset. If the change does not have any nested changes, it reverts the change on the object directly.
+ * If the change does have nested changes, it reverts the changes on the corresponding branch of the object.
+ */
+export const revertChangeset = (obj, changeset) => {
+    if (changeset) {
+        changeset
+            .reverse()
+            .forEach((change) => !change.changes ? revertLeafChange(obj, change) : revertBranchChange(obj[change.key], change));
+    }
+    return obj;
+};
+/**
+ * Flattens a changeset into an array of flat changes.
+ *
+ * @param {Changeset | IChange} obj - The changeset or change to flatten.
+ * @param {string} [path='$'] - The current path in the changeset.
+ * @param {string | FunctionKey} [embeddedKey] - The key to use for embedded objects.
+ * @returns {IFlatChange[]} - An array of flat changes.
+ *
+ * The function first checks if the input is an array. If so, it recursively flattens each change in the array.
+ * If the input is not an array, it checks if the change has nested changes or an embedded key.
+ * If so, it updates the path and recursively flattens the nested changes or the embedded object.
+ * If the change does not have nested changes or an embedded key, it creates a flat change and returns it in an array.
+ */
+export const flattenChangeset = (obj, path = '$', embeddedKey) => {
+    if (Array.isArray(obj)) {
+        return obj.reduce((memo, change) => [...memo, ...flattenChangeset(change, 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));
+            return flattenChangeset(obj.changes || obj, path, obj.embeddedKey);
+        }
+        else {
+            const valueType = getTypeOfObj(obj.value);
+            return [
+                {
+                    ...obj,
+                    path: valueType === 'Object' || path.endsWith(`[${obj.key}]`) ? path : append(path, obj.key),
+                    valueType
+                }
+            ];
+        }
+    }
+};
+/**
+ * Transforms a flat changeset into a nested changeset.
+ *
+ * @param {IFlatChange | IFlatChange[]} changes - The flat changeset to unflatten.
+ * @returns {IChange[]} - The unflattened changeset.
+ *
+ * The function first checks if the input is a single change or an array of changes.
+ * It then iterates over each change and splits its path into segments.
+ * For each segment, it checks if it represents an array or a leaf node.
+ * If it represents an array, it creates a new change object and updates the pointer to this new object.
+ * If it represents a leaf node, it sets the key, type, value, and oldValue of the current change object.
+ * Finally, it pushes the unflattened change object into the changes array.
+ */
+export const unflattenChanges = (changes) => {
+    if (!Array.isArray(changes)) {
+        changes = [changes];
+    }
+    const changesArr = [];
+    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;
+        }, []);
+        if (segments.length === 1) {
+            ptr.key = change.key;
+            ptr.type = change.type;
+            ptr.value = change.value;
+            ptr.oldValue = change.oldValue;
+            changesArr.push(ptr);
+        }
+        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);
+                // array
+                if (result) {
+                    let key;
+                    let embeddedKey;
+                    let arrKey;
+                    if (result[1]) {
+                        key = result[1];
+                        embeddedKey = result[2];
+                        arrKey = result[3];
+                    }
+                    else {
+                        key = result[4];
+                        embeddedKey = '$index';
+                        arrKey = Number(result[5]);
+                    }
+                    // leaf
+                    if (i === segments.length - 1) {
+                        ptr.key = key;
+                        ptr.embeddedKey = embeddedKey;
+                        ptr.type = Operation.UPDATE;
+                        ptr.changes = [
+                            {
+                                type: change.type,
+                                key: arrKey,
+                                value: change.value,
+                                oldValue: change.oldValue
+                            }
+                        ];
+                    }
+                    else {
+                        // object
+                        ptr.key = key;
+                        ptr.embeddedKey = embeddedKey;
+                        ptr.type = Operation.UPDATE;
+                        const newPtr = {};
+                        ptr.changes = [
+                            {
+                                type: Operation.UPDATE,
+                                key: arrKey,
+                                changes: [newPtr]
+                            }
+                        ];
+                        ptr = newPtr;
+                    }
+                }
+                else {
+                    // leaf
+                    if (i === segments.length - 1) {
+                        // check if value is a primitive or object
+                        if (change.value !== null && change.valueType === 'Object') {
+                            ptr.key = segment;
+                            ptr.type = Operation.UPDATE;
+                            ptr.changes = [
+                                {
+                                    key: change.key,
+                                    type: change.type,
+                                    value: change.value
+                                }
+                            ];
+                        }
+                        else {
+                            ptr.key = change.key;
+                            ptr.type = change.type;
+                            ptr.value = change.value;
+                            ptr.oldValue = change.oldValue;
+                        }
+                    }
+                    else {
+                        // branch
+                        ptr.key = segment;
+                        ptr.type = Operation.UPDATE;
+                        const newPtr = {};
+                        ptr.changes = [newPtr];
+                        ptr = newPtr;
+                    }
+                }
+            }
+            changesArr.push(obj);
+        }
+    });
+    return changesArr;
+};
+/**
+ * Determines the type of a given object.
+ *
+ * @param {any} obj - The object whose type is to be determined.
+ * @returns {string | null} - The type of the object, or null if the object is null.
+ *
+ * This function first checks if the object is undefined or null, and returns 'undefined' or null respectively.
+ * If the object is neither undefined nor null, it uses Object.prototype.toString to get the object's type.
+ * The type is extracted from the string returned by Object.prototype.toString using a regular expression.
+ */
+export const getTypeOfObj = (obj) => {
     if (typeof obj === 'undefined') {
         return 'undefined';
     }
     if (obj === null) {
         return null;
     }
+    // Extracts the "Type" from "[object Type]" string.
     return Object.prototype.toString.call(obj).match(/^\[object\s(.*)\]$/)[1];
 };
-exports.getTypeOfObj = getTypeOfObj;
 const getKey = (path) => {
     const left = path[path.length - 1];
     return left != null ? left : '$root';
 };
 const compare = (oldObj, newObj, path, embeddedObjKeys, keyPath) => {
     let changes = [];
-    const typeOfOldObj = (0, exports.getTypeOfObj)(oldObj);
-    const typeOfNewObj = (0, exports.getTypeOfObj)(newObj);
+    const typeOfOldObj = getTypeOfObj(oldObj);
+    const typeOfNewObj = getTypeOfObj(newObj);
     // if type of object changes, consider it as old obj has been deleted and a new object has been added
     if (typeOfOldObj !== typeOfNewObj) {
         changes.push({ type: Operation.REMOVE, key: getKey(path), value: oldObj });
@@ -28,7 +253,11 @@ 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) => ({
+                ...x,
+                value: new Date(x.value),
+                oldValue: new Date(x.oldValue)
+            })));
             break;
         case 'Object':
             const diffs = compareObject(oldObj, newObj, path, embeddedObjKeys, keyPath);
@@ -66,7 +295,7 @@ const compareObject = (oldObj, newObj, path, embeddedObjKeys, keyPath, skipPath
     let changes = [];
     const oldObjKeys = Object.keys(oldObj);
     const newObjKeys = Object.keys(newObj);
-    const intersectionKeys = (0, lodash_1.intersection)(oldObjKeys, newObjKeys);
+    const intersectionKeys = intersection(oldObjKeys, newObjKeys);
     for (k of intersectionKeys) {
         newPath = path.concat([k]);
         newKeyPath = skipPath ? keyPath : keyPath.concat([k]);
@@ -75,7 +304,7 @@ const compareObject = (oldObj, newObj, path, embeddedObjKeys, keyPath, skipPath
             changes = changes.concat(diffs);
         }
     }
-    const addedKeys = (0, lodash_1.difference)(newObjKeys, oldObjKeys);
+    const addedKeys = difference(newObjKeys, oldObjKeys);
     for (k of addedKeys) {
         newPath = path.concat([k]);
         newKeyPath = skipPath ? keyPath : keyPath.concat([k]);
@@ -85,7 +314,7 @@ const compareObject = (oldObj, newObj, path, embeddedObjKeys, keyPath, skipPath
             value: newObj[k]
         });
     }
-    const deletedKeys = (0, lodash_1.difference)(oldObjKeys, newObjKeys);
+    const deletedKeys = difference(oldObjKeys, newObjKeys);
     for (k of deletedKeys) {
         newPath = path.concat([k]);
         newKeyPath = skipPath ? keyPath : keyPath.concat([k]);
@@ -120,22 +349,29 @@ const compareArray = (oldObj, newObj, path, embeddedObjKeys, keyPath) => {
 const getObjectKey = (embeddedObjKeys, keyPath) => {
     if (embeddedObjKeys != null) {
         const path = keyPath.join('.');
+        if (embeddedObjKeys instanceof Map) {
+            for (const [key, value] of embeddedObjKeys.entries()) {
+                if (key instanceof RegExp) {
+                    if (path.match(key)) {
+                        return value;
+                    }
+                }
+                else if (path === key) {
+                    return value;
+                }
+            }
+        }
         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') {
-        obj = (0, lodash_1.keyBy)(arr, uniqKey);
+        obj = keyBy(arr, uniqKey);
     }
     else {
         for (let i = 0; i < arr.length; i++) {
@@ -157,7 +393,6 @@ const comparePrimitives = (oldObj, newObj, path) => {
     }
     return changes;
 };
-// const isEmbeddedKey = key => /\$.*=/gi.test(key)
 const removeKey = (obj, key, embeddedKey) => {
     if (Array.isArray(obj)) {
         if (embeddedKey === '$index') {
@@ -219,9 +454,9 @@ const applyArrayChange = (arr, change) => (() => {
                 element = arr[subchange.key];
             }
             else {
-                element = (0, lodash_1.find)(arr, (el) => el[change.embeddedKey].toString() === subchange.key.toString());
+                element = find(arr, (el) => el[change.embeddedKey].toString() === subchange.key.toString());
             }
-            result.push((0, exports.applyChangeset)(element, subchange.changes));
+            result.push(applyChangeset(element, subchange.changes));
         }
     }
     return result;
@@ -231,7 +466,7 @@ const applyBranchChange = (obj, change) => {
         return applyArrayChange(obj, change);
     }
     else {
-        return (0, exports.applyChangeset)(obj, change.changes);
+        return applyChangeset(obj, change.changes);
     }
 };
 const revertLeafChange = (obj, change, embeddedKey = '$index') => {
@@ -257,9 +492,9 @@ const revertArrayChange = (arr, change) => (() => {
                 element = arr[+subchange.key];
             }
             else {
-                element = (0, lodash_1.find)(arr, (el) => el[change.embeddedKey].toString() === subchange.key);
+                element = find(arr, (el) => el[change.embeddedKey].toString() === subchange.key);
             }
-            result.push((0, exports.revertChangeset)(element, subchange.changes));
+            result.push(revertChangeset(element, subchange.changes));
         }
     }
     return result;
@@ -269,182 +504,12 @@ const revertBranchChange = (obj, change) => {
         return revertArrayChange(obj, change);
     }
     else {
-        return (0, exports.revertChangeset)(obj, change.changes);
-    }
-};
-const diff = (oldObj, newObj, embeddedObjKeys) => compare(oldObj, newObj, [], embeddedObjKeys, []);
-exports.diff = diff;
-const applyChangeset = (obj, changeset) => {
-    if (changeset) {
-        changeset.forEach((change) => (change.value !== null && change.value !== undefined) || change.type === Operation.REMOVE
-            ? applyLeafChange(obj, change, change.embeddedKey)
-            : applyBranchChange(obj[change.key], change));
-    }
-    return obj;
-};
-exports.applyChangeset = applyChangeset;
-const revertChangeset = (obj, changeset) => {
-    if (changeset) {
-        changeset
-            .reverse()
-            .forEach((change) => !change.changes ? revertLeafChange(obj, change) : revertBranchChange(obj[change.key], change));
-    }
-    return obj;
-};
-exports.revertChangeset = revertChangeset;
-var Operation;
-(function (Operation) {
-    Operation["REMOVE"] = "REMOVE";
-    Operation["ADD"] = "ADD";
-    Operation["UPDATE"] = "UPDATE";
-})(Operation = exports.Operation || (exports.Operation = {}));
-const flattenChangeset = (obj, path = '$', embeddedKey) => {
-    if (Array.isArray(obj)) {
-        return obj.reduce((memo, change) => [...memo, ...(0, exports.flattenChangeset)(change, 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));
-            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 })
-            ];
-        }
-    }
-};
-exports.flattenChangeset = flattenChangeset;
-const unflattenChanges = (changes) => {
-    if (!Array.isArray(changes)) {
-        changes = [changes];
+        return revertChangeset(obj, change.changes);
     }
-    const changesArr = [];
-    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;
-        }, []);
-        // $.childern[@.name='chris'].age
-        // =>
-        // $
-        // childern[@.name='chris']
-        // age
-        if (segments.length === 1) {
-            ptr.key = change.key;
-            ptr.type = change.type;
-            ptr.value = change.value;
-            ptr.oldValue = change.oldValue;
-            changesArr.push(ptr);
-        }
-        else {
-            for (let i = 1; i < segments.length; i++) {
-                const segment = segments[i];
-                // check for array
-                const result = /^(.+)\[\?\(@\.(.+)='(.+)'\)]$|^(.+)\[(\d+)\]/.exec(segment);
-                // array
-                if (result) {
-                    let key;
-                    let embeddedKey;
-                    let arrKey;
-                    if (result[1]) {
-                        key = result[1];
-                        embeddedKey = result[2];
-                        arrKey = result[3];
-                    }
-                    else {
-                        key = result[4];
-                        embeddedKey = '$index';
-                        arrKey = Number(result[5]);
-                    }
-                    // leaf
-                    if (i === segments.length - 1) {
-                        ptr.key = key;
-                        ptr.embeddedKey = embeddedKey;
-                        ptr.type = Operation.UPDATE;
-                        ptr.changes = [
-                            {
-                                type: change.type,
-                                key: arrKey,
-                                value: change.value,
-                                oldValue: change.oldValue
-                            }
-                        ];
-                    }
-                    else {
-                        // object
-                        ptr.key = key;
-                        ptr.embeddedKey = embeddedKey;
-                        ptr.type = Operation.UPDATE;
-                        const newPtr = {};
-                        ptr.changes = [
-                            {
-                                type: Operation.UPDATE,
-                                key: arrKey,
-                                changes: [newPtr]
-                            }
-                        ];
-                        ptr = newPtr;
-                    }
-                }
-                else {
-                    // leaf
-                    if (i === segments.length - 1) {
-                        // check if value is a primitive or object
-                        if (change.value !== null && change.valueType === 'Object') {
-                            ptr.key = segment;
-                            ptr.type = Operation.UPDATE;
-                            ptr.changes = [
-                                {
-                                    key: change.key,
-                                    type: change.type,
-                                    value: change.value
-                                }
-                            ];
-                        }
-                        else {
-                            ptr.key = change.key;
-                            ptr.type = change.type;
-                            ptr.value = change.value;
-                            ptr.oldValue = change.oldValue;
-                        }
-                    }
-                    else {
-                        // branch
-                        ptr.key = segment;
-                        ptr.type = Operation.UPDATE;
-                        const newPtr = {};
-                        ptr.changes = [newPtr];
-                        ptr = newPtr;
-                    }
-                }
-            }
-            changesArr.push(obj);
-        }
-    });
-    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}`;
+    return nextSegment.includes('.') ? `${basePath}[${nextSegment}]` : `${basePath}.${nextSegment}`;
 }
 /** returns a JSON Path filter expression; e.g., `$.pet[(?name='spot')]` */
 function filterExpression(basePath, filterKey, filterValue) {

package/package.json CHANGED Viewed

@@ -1,15 +1,16 @@
 {
   "name": "json-diff-ts",
-  "version": "1.2.6",
-  "description": "A diff tool for JavaScript based on https://www.npmjs.com/package/diff-json written in TypeScript.",
+  "version": "2.0.0",
+  "description": "A JSON diff tool for JavaScript written in TypeScript.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "type": "module",
   "scripts": {
     "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-    "lint": "tslint -p tsconfig.json",
-    "test": "jest --config jest.config.json",
-    "test:watch": "jest --watch --config jest.config.json",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint 'src/**/*.ts'",
+    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest --config jest.config.mjs",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules npx jest --watch --config jest.config.mjs",
     "prepare": "npm run build",
     "prepublishOnly": "npm test && npm run lint",
     "preversion": "npm run lint",
@@ -37,16 +38,14 @@
   },
   "homepage": "https://github.com/ltwlf/json-diff-ts#readme",
   "devDependencies": {
-    "@types/jest": "^29.1.1",
-    "@types/lodash": "^4.14.149",
-    "jest": "^24.9.0",
-    "prettier": "^2.5.1",
-    "ts-jest": "^24.2.0",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^4.5.2"
-  },
-  "peerDependencies": {
-    "lodash": "^4.x"
+    "@jest/globals": "^29.7.0",
+    "@types/jest": "^29.5.7",
+    "@types/lodash-es": "^4.17.10",
+    "eslint": "^8.53.0",
+    "jest": "^29.5.0",
+    "lodash-es": "^4.17.21",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
   }
-}
+}