Updates

Author: JakobVogelsang

json-difference/dist/core/get-diff.d.ts

@@ -0,0 +1,21 @@
+import { Delta, JsonDiffOptions } from '../models/jsondiffer.model';
+/**
+ * This method returns a delta object containing all the information needed to understand what happened during
+ * the transition from the original object to the modified one.
+ *
+ * @param oldStruct Original structure to be investigated
+ * @param newStruct Modified structure to be investigated
+ * @param options Options for changing result behavior
+ * @returns returns a JSON diference delta
+ *
+ *
+ * @example
+ *  const oldStruct = { 1: null }
+ *  const newStruct = { 1: "coffee" }
+ *
+ *  const result = getDiff(oldStruct, newStruct)
+ *
+ *  console.log(result)
+ *  // Output: {"edited": [["1", null, "coffee"]], added: [], removed: []}
+ */
+export declare const getDiff: (oldStruct: Record<string, any> | string, newStruct: Record<string, any> | string, options?: JsonDiffOptions) => Delta;

json-difference/dist/core/get-edited-paths.d.ts

@@ -0,0 +1,19 @@
+import { EditedPath, StructPaths } from '../models/jsondiffer.model';
+/**
+ * This method returns all paths whose leaf value has changed
+ *
+ * @param oldStructPaths Original paths to be investigated
+ * @param newStructPaths Modified paths to be investigated
+ * @returns returns an object with all edited paths
+ *
+ *
+ * @example
+ * const oldStruct = { 1: null  }
+ * const newStruct = { 1: "coffee" }
+ *
+ * const result = getEditedPaths(oldStruct, newStruct)
+ *
+ *  // Output: [1, null ,"coffee"]
+ *  console.log(result)
+ */
+export declare const getEditedPaths: (oldStructPaths: StructPaths, newStructPaths: StructPaths) => Array<EditedPath>;

json-difference/dist/core/get-paths-diff.d.ts

@@ -0,0 +1,19 @@
+import { PathsDiff, StructPaths } from '../models/jsondiffer.model';
+/**
+ * This method returns all paths whose leaf value has changed
+ *
+ * @param oldStructPaths Original paths to be investigated
+ * @param newStructPaths Modified paths to be investigated
+ * @returns returns an object with all edited paths
+ *
+ *
+ * @example
+ * const oldStruct = { 1: null, 2: "tea"  }
+ * const newStruct = { 1: "coffee" }
+ *
+ * const result = getPathsDiff(oldStruct, newStruct)
+ *
+ *  console.log(result)
+ *  // Output: ["2": "tea"]
+ */
+export declare const getPathsDiff: (oldStructPaths: StructPaths, newStructPaths: StructPaths) => Array<PathsDiff>;

json-difference/dist/core/get-struct-paths.d.ts

@@ -0,0 +1,29 @@
+import { StructPaths } from '../models/jsondiffer.model';
+/**
+ * This method returns all possible paths to leaf nodes and objects other than null
+ *
+ * @param struct A structure to be processed
+ * @param isLodashLike Boolean to change the path generation behavior
+ * @returns returns a list of all paths
+ *
+ *
+ * @example
+ * const struct = { 1: { 2: null }  }
+ *
+ * const result1 = getStructPaths(struct)
+ * const result2 = getStructPaths(struct, { isLodashLike: true }})
+ *
+ *
+ * The values "@{}" and "@[]" are used internally to represent objects and arrays respectively.
+ * But they have a particular meaning, where the key is parent, that is, it must have children.
+ * ("@{}" !== "{}" && "@[]" !== "[]") => true
+ *
+ *  console.log(result)
+ *  // Output: {"1": "@{}","1/2": null}
+ *
+ * console.log(result)
+ *  // Output: {"1": "@{}","1.2": null}
+ */
+export declare const getStructPaths: (struct: any, isLodashLike?: boolean, paths?: {
+    [key: string]: any;
+} | undefined, currentPath?: string) => StructPaths;

json-difference/dist/core/index.d.ts

@@ -0,0 +1,4 @@
+export * from './get-diff';
+export * from './get-paths-diff';
+export * from './get-struct-paths';
+export * from './get-edited-paths';

json-difference/dist/helpers/sanitize-delta.d.ts

@@ -0,0 +1,10 @@
+import { Delta } from '../models';
+/**
+ * This method returns the sanitized delta.
+ * Some paths returned by getStructPaths() may not make much sense and be redundant to the end user.
+ *
+ * @param delta Delta to be sanitized
+ * @returns Sanitized Delta
+ */
+declare const sanitizeDelta: (delta: Delta) => Delta;
+export default sanitizeDelta;

json-difference/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './core';
+export * from './models';

json-difference/dist/index.js

@@ -0,0 +1,48 @@
+const O = (e, n) => {
+  const o = [];
+  for (const f in e)
+    if (n.hasOwnProperty(f)) {
+      if (typeof e[f] == "object" && typeof n[f] == "object" && JSON.stringify(e[f]) === JSON.stringify(n[f]) || e[f] === n[f])
+        continue;
+      if (e[f] === "@{}" || e[f] === "@[]") {
+        const i = n[f] === "@{}" ? {} : n[f] === "@[]" ? [] : n[f];
+        e[f] === "@{}" ? JSON.stringify(n[f]) !== "{}" && o.push([f, {}, i]) : JSON.stringify(n[f]) !== "[]" && o.push([f, [], i]);
+      } else
+        o.push([f, e[f], n[f]]);
+    }
+  return o;
+}, g = (e, n) => {
+  const o = [];
+  let f = 0;
+  for (const i in e)
+    if (!(i in n)) {
+      const r = e[i] === "@{}" ? {} : e[i] === "@[]" ? [] : e[i];
+      o[f] = [i, r], f++;
+    }
+  return o;
+}, c = (e, n, o, f) => {
+  const i = f ? e ? "[" : "." : "/", r = f ? e ? "]" : "" : e ? "[]" : "";
+  return n === "__start__" ? `${f && e ? "[" : ""}${o}${r}` : `${n}${i}${o}${r}`;
+}, p = (e, n = !1, o, f = "__start__") => {
+  o === void 0 && (o = Array.isArray(e) ? { __root__: "@[]" } : { __root__: "@{}" });
+  for (const i of Object.keys(e)) {
+    const r = c(Array.isArray(e), f, i, n);
+    typeof e[i] == "object" && e[i] !== null ? (Object.keys(e[i]).length === 0 ? o[r] = e[i] : o[r] = Array.isArray(e[i]) ? "@[]" : "@{}", p(e[i], n, o, r)) : o[r] = e[i];
+  }
+  return o;
+}, N = (e) => (e.edited = e.edited.filter((n) => !(typeof n[1] == "object" && n[2] === "@{}")).map((n) => n[2] === "@{}" ? [n[0], n[1], {}] : n[2] === "@[]" ? [n[0], n[1], []] : n), e), $ = {
+  isLodashLike: !1
+}, j = (e, n, o) => {
+  const { isLodashLike: f } = o ?? $, i = {
+    added: [],
+    removed: [],
+    edited: []
+  }, r = typeof e == "string" ? JSON.parse(e) : e, _ = typeof n == "string" ? JSON.parse(n) : n, s = p(r, f), y = p(_, f);
+  return i.removed = g(s, y), i.added = g(y, s), i.edited = O(s, y), N(i);
+};
+export {
+  j as getDiff,
+  O as getEditedPaths,
+  g as getPathsDiff,
+  p as getStructPaths
+};