@scalar/json-magic 0.8.1 → 0.8.3

package/src/diff/diff.ts

@@ -1,93 +0,0 @@
-/**
- * Represents the possible types of changes that can be made to a document.
- * - 'add': A new property is added
- * - 'update': An existing property's value is changed
- * - 'delete': A property is removed
- */
-type ChangeType = 'add' | 'update' | 'delete'
-
-/**
- * Represents a single difference between two documents.
- * @property path - Array of strings representing the path to the changed property
- * @property changes - The new value for the property (for add/update) or the old value (for delete)
- * @property type - The type of change that occurred
- */
-export type Difference<_T> = { path: string[]; changes: any; type: ChangeType }
-
-/**
- * Get the difference between two objects.
- *
- * This function performs a breadth-first comparison between two objects and returns
- * a list of operations needed to transform the first object into the second.
- *
- * @param doc1 - The source object to compare from
- * @param doc2 - The target object to compare to
- * @returns A list of operations (add/update/delete) with their paths and changes
- *
- * @example
- * // Compare two simple objects
- * const original = { name: 'John', age: 30 }
- * const updated = { name: 'John', age: 31, city: 'New York' }
- * const differences = diff(original, updated)
- * // Returns:
- * // [
- * //   { path: ['age'], changes: 31, type: 'update' },
- * //   { path: ['city'], changes: 'New York', type: 'add' }
- * // ]
- *
- * @example
- * // Compare nested objects
- * const original = {
- *   user: { name: 'John', settings: { theme: 'light' } }
- * }
- * const updated = {
- *   user: { name: 'John', settings: { theme: 'dark' } }
- * }
- * const differences = diff(original, updated)
- * // Returns:
- * // [
- * //   { path: ['user', 'settings', 'theme'], changes: 'dark', type: 'update' }
- * // ]
- */
-export const diff = <T extends Record<string, unknown>>(doc1: Record<string, unknown>, doc2: T) => {
-  const diff: Difference<T>[] = []
-
-  const bfs = (el1: unknown, el2: unknown, prefix = []) => {
-    // If the types are different, we know that the property has been added, deleted or updated
-    if (typeof el1 !== typeof el2) {
-      if (typeof el1 === 'undefined') {
-        diff.push({ path: prefix, changes: el2, type: 'add' })
-        return
-      }
-
-      if (typeof el2 === 'undefined') {
-        diff.push({ path: prefix, changes: el1, type: 'delete' })
-        return
-      }
-
-      diff.push({ path: prefix, changes: el2, type: 'update' })
-      return
-    }
-
-    // We now can assume that el1 and el2 are of the same type
-
-    // For nested objects, we need to recursively check the properties
-    if (typeof el1 === 'object' && typeof el2 === 'object' && el1 !== null && el2 !== null) {
-      const keys = new Set([...Object.keys(el1), ...Object.keys(el2)])
-
-      for (const key of keys) {
-        bfs(el1[key], el2[key], [...prefix, key])
-      }
-      return
-    }
-
-    // For primitives, we can just compare the values
-    if (el1 !== el2) {
-      diff.push({ path: prefix, changes: el2, type: 'update' })
-    }
-  }
-
-  // Run breadth-first search
-  bfs(doc1, doc2)
-  return diff
-}

package/src/diff/index.test.ts

@@ -1,150 +0,0 @@
-import { apply } from '@/diff/apply'
-import { diff } from '@/diff/diff'
-import { describe, expect, test } from 'vitest'
-
-describe('if we get list of operations we need to perform A -> B, when we apply them on A it should give us B', () => {
-  test.each([
-    [
-      { name: 'John', age: 25 },
-      { name: 'Jeremy', age: 25 },
-    ],
-    [
-      {
-        name: 'John',
-        age: 25,
-        interest: {
-          cars: { classics: ['Ferrari 250 GTO', 'Chevrolet Camaro'] },
-          music: { pop: ['Bruno Mars', 'Justin Bieber'] },
-        },
-      },
-      {
-        name: 'John',
-        age: 25,
-        interest: {
-          cars: { classics: ['Ferrari 250 GTO'] },
-          music: { rock: ['Eagles', 'AC/DC'] },
-        },
-      },
-    ],
-    [{ version: '1.1.0', name: '@scalar/json-diff' }, {}],
-    [
-      {
-        openapi: '3.0.0',
-        info: {
-          title: 'Simple API',
-          description: 'A small OpenAPI specification example',
-          version: '1.0.0',
-        },
-        paths: {
-          '/users': {
-            get: {
-              summary: 'Get a list of users',
-              operationId: 'getUsers',
-              responses: {
-                '200': {
-                  description: 'A list of users',
-                  content: {
-                    'application/json': {
-                      schema: {
-                        type: 'array',
-                        items: {
-                          type: 'object',
-                          properties: {
-                            id: { type: 'integer' },
-                            name: { type: 'string' },
-                          },
-                        },
-                      },
-                    },
-                  },
-                },
-              },
-            },
-          },
-          '/users/{id}': {
-            get: {
-              summary: 'Get a user by ID',
-              operationId: 'getUserById',
-              parameters: [
-                {
-                  name: 'id',
-                  in: 'path',
-                  required: true,
-                  schema: { type: 'integer' },
-                },
-              ],
-              responses: {
-                '200': {
-                  description: 'User details',
-                  content: {
-                    'application/json': {
-                      schema: {
-                        type: 'object',
-                        properties: {
-                          id: { type: 'integer' },
-                          name: { type: 'string' },
-                        },
-                      },
-                    },
-                  },
-                },
-                '404': {
-                  description: 'User not found',
-                },
-              },
-            },
-          },
-        },
-      },
-      {
-        openapi: '3.0.0',
-        info: {
-          title: 'Simple API',
-          description: 'A big OpenAPI specification example',
-          version: '1.0.0',
-        },
-        paths: {
-          '/users': {
-            get: {
-              summary: 'Get a list of users',
-              operationId: 'getUsers',
-              responses: {
-                '200': {
-                  description: 'A list of users',
-                  content: {
-                    'application/json': {
-                      schema: {
-                        type: 'array',
-                        items: {
-                          type: 'object',
-                          properties: {
-                            id: { type: 'integer' },
-                            name: { type: 'string' },
-                          },
-                        },
-                      },
-                    },
-                  },
-                },
-              },
-            },
-          },
-        },
-      },
-    ],
-    [{}, {}],
-    [
-      {},
-      {
-        openapi: '3.0.0',
-        info: {
-          title: 'Simple API',
-          description: 'A big OpenAPI specification example',
-          version: '1.0.0',
-        },
-      },
-    ],
-  ])('apply(a, diff(a, b)) === b', (a, b) => {
-    expect(apply(a, diff(a, b))).toEqual(b)
-  })
-})

package/src/diff/index.ts

@@ -1,5 +0,0 @@
-import { diff, type Difference } from '@/diff/diff'
-import { apply } from '@/diff/apply'
-import { merge } from '@/diff/merge'
-
-export { diff, apply, merge, type Difference }