feat: add json patch generator RFC 6902 support

libs/json-difference/src/core/generate-json-patch.spec.ts

@@ -0,0 +1,59 @@
+// Packages
+import { getDiff } from '.'
+
+// Models
+import { JsonPatch } from '../models/json-difference.model'
+import { generateJsonPatch } from './generate-json-patch'
+
+describe('GenerateJsonPatch function', () => {
+  test('Should generate JSON Patch operations from delta', () => {
+    const struct1 = { '0': [{ '0': 1 }] }
+    const struct2 = { '0': { '0': [1] } }
+    const expectedResult: Array<JsonPatch> = [
+      { op: 'remove', path: '0/0' },
+      { op: 'remove', path: '0/0/0[]' },
+      { op: 'replace', path: '0', value: [] },
+      { op: 'add', path: '0/0[]', value: {} },
+      { op: 'add', path: '0/0[]/0', value: 1 }
+    ]
+    const delta = getDiff(struct1, struct2)
+    const result = generateJsonPatch(delta)
+
+    expect(result).toEqual(expectedResult)
+  })
+
+  test('Should generate JSON Patch operations from delta', () => {
+    const struct1 = {
+      baz: 'qux',
+      foo: 'bar'
+    }
+    const struct2 = {
+      baz: 'boo',
+      hello: ['world']
+    }
+    const expectedResult: Array<JsonPatch> = [
+      {
+        op: 'remove',
+        path: 'hello'
+      },
+      {
+        op: 'remove',
+        path: 'hello/0[]'
+      },
+      {
+        op: 'replace',
+        path: 'baz',
+        value: 'qux'
+      },
+      {
+        op: 'add',
+        path: 'foo',
+        value: 'bar'
+      }
+    ]
+    const delta = getDiff(struct1, struct2)
+    const result = generateJsonPatch(delta)
+
+    expect(result).toEqual(expectedResult)
+  })
+})

libs/json-difference/src/core/generate-json-patch.ts

@@ -0,0 +1,31 @@
+// Models
+import { Delta, JsonPatch } from '../models/json-difference.model'
+
+export const generateJsonPatch = (delta: Delta): Array<JsonPatch> => {
+  const operations: Array<JsonPatch> = []
+
+  delta.added.forEach((path) => {
+    operations.push({
+      op: 'remove',
+      path: path[0]
+    })
+  })
+
+  delta.edited.forEach((path) => {
+    operations.push({
+      op: 'replace',
+      path: path[0],
+      value: path[1]
+    })
+  })
+
+  delta.removed.forEach((path) => {
+    operations.push({
+      op: 'add',
+      path: path[0],
+      value: path[1]
+    })
+  })
+
+  return operations
+}

libs/json-difference/src/core/get-diff.spec.ts

@@ -2,7 +2,7 @@
 import { getDiff } from '.'
 
 // Models
-import { Delta } from '../models/jsondiffer.model'
+import { Delta } from '../models/json-difference.model'
 
 describe('GetDiff function', () => {
   test('Should return the difference between two basic structures', () => {

libs/json-difference/src/core/get-diff.ts

@@ -4,8 +4,8 @@ import { getPathsDiff } from './get-paths-diff'
 import { getStructPaths } from './get-struct-paths'
 
 // Models
-import { Delta, JsonDiffOptions } from '../models/jsondiffer.model'
 import sanitizeDelta from '../helpers/sanitize-delta'
+import { Delta, JsonDiffOptions } from '../models/json-difference.model'
 
 const defaultOptions: JsonDiffOptions = {
   isLodashLike: false

libs/json-difference/src/core/get-edited-paths.spec.ts

@@ -1,5 +1,5 @@
 import { getEditedPaths } from '.'
-import { EditedPath } from '../models/jsondiffer.model'
+import { EditedPath } from '../models/json-difference.model'
 
 describe('GetEditedPaths function', () => {
   test('Should return empty when there is no edited value', () => {

libs/json-difference/src/core/get-edited-paths.ts

@@ -1,5 +1,5 @@
 // Models
-import { EditedPath, StructPaths } from '../models/jsondiffer.model'
+import { EditedPath, StructPaths } from '../models/json-difference.model'
 
 /**
  * This method returns all paths whose leaf value has changed

libs/json-difference/src/core/get-paths-diff.spec.ts

@@ -1,6 +1,6 @@
 // Packages
 import { getPathsDiff } from '.'
-import { PathsDiff } from '../models/jsondiffer.model'
+import { PathsDiff } from '../models/json-difference.model'
 
 describe('GetPathsDiff function', () => {
   test('Should return empty when there is no key difference', () => {

libs/json-difference/src/core/get-paths-diff.ts

@@ -1,5 +1,5 @@
 // Models
-import { PathsDiff, StructPaths } from '../models/jsondiffer.model'
+import { PathsDiff, StructPaths } from '../models/json-difference.model'
 
 /**
  * This method returns all paths whose leaf value has changed

libs/json-difference/src/core/get-struct-paths.ts

@@ -1,5 +1,5 @@
 // Models
-import { StructPaths } from '../models/jsondiffer.model'
+import { StructPaths } from '../models/json-difference.model'
 
 const generatePath = (isArray: boolean, currentPath: string, newPath: string, lodashLike: boolean): string => {
   const prefix = lodashLike ? (isArray ? '[' : '.') : '/'

libs/json-difference/src/helpers/sanitize-delta.spec.ts

@@ -2,7 +2,7 @@
 import sanitizeDelta from './sanitize-delta'
 
 // Models
-import { Delta } from '../models/jsondiffer.model'
+import { Delta } from '../models/json-difference.model'
 
 describe('sanitizeDelta helper', () => {
   test.only('Should remove unnecessary @{}', () => {

libs/json-difference/src/models/index.ts

@@ -1 +1 @@
-export * from './jsondiffer.model'
+export * from './json-difference.model'

libs/json-difference/src/models/jsondiffer.model.ts → libs/json-difference/src/models/json-difference.model.ts

@@ -13,3 +13,22 @@ export interface Delta {
 export interface JsonDiffOptions {
   isLodashLike?: boolean
 }
+
+export interface JsonPatchRemove {
+  op: 'remove'
+  path: string
+}
+
+export interface JsonPatchReplace {
+  op: 'replace'
+  path: string
+  value: any
+}
+
+export interface JsonPatchAdd {
+  op: 'add'
+  path: string
+  value: any
+}
+
+export type JsonPatch = JsonPatchRemove | JsonPatchReplace | JsonPatchAdd