@arcanejs/diff 0.3.0 → 0.3.2

package/README.md

@@ -0,0 +1,43 @@
+# `@arcanejs/diff`
+
+[![NPM Version](https://img.shields.io/npm/v/%40arcanejs%2Fdiff)](https://www.npmjs.com/package/@arcanejs/diff)
+
+This package provides an easy way to:
+
+- Create diffs by comparing objects
+- Update objects by applying diffs
+
+This library is written in TypeScript,
+and produces diffs that are type-safe,
+and can only be applied to objects that match the type
+of the objects being compared.
+
+This package is part of the
+[`arcanejs` project](https://github.com/arcanejs/arcanejs#arcanejs),
+and is used to maintain a copy of a JSON tree in downstream clients in real-time
+via websockets.
+
+## Usage
+
+```ts
+import { diffJson, Diff } from '@arcanejs/diff/diff';
+import { patchJson } from '@arcanejs/diff/patch';
+
+type E = {
+  foo: string;
+  bar?: number[];
+};
+
+const a: E = { foo: 'bar' };
+const b: E = { foo: 'baz', bar: [1] };
+
+const diffA: Diff<E> = diffJson(a, b);
+
+const resultA = patchJson(a, diffA);
+
+console.log(resultB); // { foo: 'baz', bar: [1] }
+
+const c = { baz: 'foo' };
+
+const resultB = patchJson(c, diffA); // TypeScript Type Error: Property 'baz' is missing in type '{ foo: string; bar?: number[] | undefined; }' but required in type '{ baz: string; }'
+```

package/dist/chunk-6R7Z62HK.js

@@ -0,0 +1,81 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/diff.ts
+var jsonTypeMatches = (a, b) => typeof a === typeof b && Array.isArray(a) === Array.isArray(b) && a === null === (b === null);
+var diffJson = (a, b) => {
+  if (a === b) {
+    return { type: "match" };
+  }
+  if (!jsonTypeMatches(a, b)) {
+    throw new Error("Types don't match, unable to diff");
+  }
+  if (Array.isArray(a) && Array.isArray(b)) {
+    if (a.length === b.length) {
+      const changes = [];
+      for (let i = 0; i < a.length; i++) {
+        const d = diffJson(a[i], b[i]);
+        if (d.type !== "match") {
+          changes.push({ i, diff: d });
+        }
+      }
+      if (changes.length === 0) {
+        return { type: "match" };
+      }
+      return { type: "modified-a", changes };
+    } else {
+      let start = 0;
+      while (start < a.length && start < b.length && diffJson(a[start], b[start]).type === "match") {
+        start++;
+      }
+      let endIndexA = a.length - 1;
+      let endIndexB = b.length - 1;
+      while (endIndexA >= start && endIndexB >= start && diffJson(a[endIndexA], b[endIndexB]).type === "match") {
+        endIndexA--;
+        endIndexB--;
+      }
+      const count = endIndexA - start + 1;
+      const items = b.slice(start, endIndexB + 1);
+      return { type: "splice", start, count, items };
+    }
+  }
+  if (a === null || b === null) {
+    return { type: "value", before: a, after: b };
+  }
+  if (Array.isArray(a) || Array.isArray(b)) {
+    return { type: "value", before: a, after: b };
+  }
+  if (typeof a === "object" && typeof b === "object") {
+    const keys = /* @__PURE__ */ new Set([...Object.keys(a), ...Object.keys(b)]);
+    const changes = {};
+    const additions = {};
+    const deletions = {};
+    for (const key of keys) {
+      const valueA = a[key];
+      const valueB = b[key];
+      if (valueA === void 0 && valueB !== void 0) {
+        additions[key] = valueB;
+      } else if (valueB === void 0 && valueA !== void 0) {
+        deletions[key] = valueA;
+      } else if (valueA !== void 0 && valueB !== void 0) {
+        const d = diffJson(valueA, valueB);
+        if (d.type !== "match") {
+          changes[key] = d;
+        }
+      }
+    }
+    const result = {
+      type: "modified-o",
+      ...Object.keys(changes).length === 0 ? {} : { changes },
+      ...Object.keys(additions).length === 0 ? {} : { additions },
+      ...Object.keys(deletions).length === 0 ? {} : { deletions }
+    };
+    if (result.changes || result.additions || result.deletions) {
+      return result;
+    } else {
+      return { type: "match" };
+    }
+  }
+  return { type: "value", before: a, after: b };
+};
+
+
+
+exports.diffJson = diffJson;

package/dist/chunk-HLUKTMHV.js

@@ -0,0 +1,52 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }// src/patch.ts
+var patchJson = (old, diff) => {
+  if (diff.type === "match") {
+    return old;
+  }
+  if (diff.type === "value") {
+    return diff.after;
+  }
+  if (diff.type === "splice") {
+    if (!Array.isArray(old)) {
+      throw new Error("Cannot apply splice diff to non-array value");
+    }
+    const result = [...old];
+    result.splice(diff.start, diff.count, ...diff.items);
+    return result;
+  }
+  if (diff.type === "modified-a") {
+    if (!Array.isArray(old)) {
+      throw new Error("Cannot apply changes diff to non-array value");
+    }
+    const result = [...old];
+    for (const { i, diff: d } of diff.changes) {
+      result[i] = patchJson(old[i], d);
+    }
+    return result;
+  }
+  if (Array.isArray(old)) {
+    throw new Error("Unexpected array type");
+  }
+  if (diff.type === "modified-o") {
+    if (typeof old !== "object" || old === null) {
+      throw new Error("Cannot apply modified diff to non-object value");
+    }
+    const result = { ...old, ...diff.additions };
+    for (const key of Object.keys(diff.changes || {})) {
+      const changes = _optionalChain([diff, 'access', _ => _.changes, 'optionalAccess', _2 => _2[key]]);
+      if (changes) {
+        result[key] = patchJson(old[key], changes);
+      }
+    }
+    for (const keu of Object.keys(diff.deletions || {})) {
+      delete result[keu];
+    }
+    return result;
+  }
+  const _n = diff;
+  throw new Error(`Unknown diff type: ${_n}`);
+};
+
+
+
+exports.patchJson = patchJson;

package/dist/diff.d.mts

@@ -6,22 +6,22 @@ type JSONArray = JSONValue[];
 type JSONValue = JSONPrimitive | JSONObject | JSONArray;
 type PossibleRecursiveDiff<V extends JSONValue | undefined> = V extends JSONValue ? NestedDiff<V> : never;
 type NestedDiff<V extends JSONValue> = (V extends JSONPrimitive ? {
-    type: "value";
+    type: 'value';
     before: V;
     after: V;
 } : never) | (V extends JSONArray ? {
-    type: "splice";
+    type: 'splice';
     start: number;
     count: number;
     items: V;
 } : never) | (V extends JSONArray ? {
-    type: "modified-a";
+    type: 'modified-a';
     changes: Array<{
         i: number;
         diff: PossibleRecursiveDiff<V[number]>;
     }>;
 } : never) | (V extends JSONObject ? {
-    type: "modified-o";
+    type: 'modified-o';
     additions?: {
         [K in keyof V]: V[K];
     };
@@ -33,7 +33,7 @@ type NestedDiff<V extends JSONValue> = (V extends JSONPrimitive ? {
     };
 } : never);
 type Diff<V extends JSONValue> = NestedDiff<V> | {
-    type: "match";
+    type: 'match';
 };
 declare const diffJson: <V extends JSONValue>(a: V | undefined, b: V | undefined) => Diff<V>;
 

package/dist/diff.d.ts

@@ -6,22 +6,22 @@ type JSONArray = JSONValue[];
 type JSONValue = JSONPrimitive | JSONObject | JSONArray;
 type PossibleRecursiveDiff<V extends JSONValue | undefined> = V extends JSONValue ? NestedDiff<V> : never;
 type NestedDiff<V extends JSONValue> = (V extends JSONPrimitive ? {
-    type: "value";
+    type: 'value';
     before: V;
     after: V;
 } : never) | (V extends JSONArray ? {
-    type: "splice";
+    type: 'splice';
     start: number;
     count: number;
     items: V;
 } : never) | (V extends JSONArray ? {
-    type: "modified-a";
+    type: 'modified-a';
     changes: Array<{
         i: number;
         diff: PossibleRecursiveDiff<V[number]>;
     }>;
 } : never) | (V extends JSONObject ? {
-    type: "modified-o";
+    type: 'modified-o';
     additions?: {
         [K in keyof V]: V[K];
     };
@@ -33,7 +33,7 @@ type NestedDiff<V extends JSONValue> = (V extends JSONPrimitive ? {
     };
 } : never);
 type Diff<V extends JSONValue> = NestedDiff<V> | {
-    type: "match";
+    type: 'match';
 };
 declare const diffJson: <V extends JSONValue>(a: V | undefined, b: V | undefined) => Diff<V>;
 

package/dist/diff.js

@@ -1,105 +1,6 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-// src/diff.ts
-var diff_exports = {};
-__export(diff_exports, {
-  diffJson: () => diffJson
-});
-module.exports = __toCommonJS(diff_exports);
-var jsonTypeMatches = (a, b) => typeof a === typeof b && Array.isArray(a) === Array.isArray(b) && a === null === (b === null);
-var diffJson = (a, b) => {
-  if (a === b) {
-    return { type: "match" };
-  }
-  if (!jsonTypeMatches(a, b)) {
-    throw new Error("Types don't match, unable to diff");
-  }
-  if (Array.isArray(a) && Array.isArray(b)) {
-    if (a.length === b.length) {
-      const changes = [];
-      for (let i = 0; i < a.length; i++) {
-        const d = diffJson(a[i], b[i]);
-        if (d.type !== "match") {
-          changes.push({ i, diff: d });
-        }
-      }
-      if (changes.length === 0) {
-        return { type: "match" };
-      }
-      return { type: "modified-a", changes };
-    } else {
-      let start = 0;
-      while (start < a.length && start < b.length && diffJson(a[start], b[start]).type === "match") {
-        start++;
-      }
-      let endIndexA = a.length - 1;
-      let endIndexB = b.length - 1;
-      while (endIndexA >= start && endIndexB >= start && diffJson(a[endIndexA], b[endIndexB]).type === "match") {
-        endIndexA--;
-        endIndexB--;
-      }
-      const count = endIndexA - start + 1;
-      const items = b.slice(start, endIndexB + 1);
-      return { type: "splice", start, count, items };
-    }
-  }
-  if (a === null || b === null) {
-    return { type: "value", before: a, after: b };
-  }
-  if (Array.isArray(a) || Array.isArray(b)) {
-    return { type: "value", before: a, after: b };
-  }
-  if (typeof a === "object" && typeof b === "object") {
-    const keys = /* @__PURE__ */ new Set([...Object.keys(a), ...Object.keys(b)]);
-    const changes = {};
-    const additions = {};
-    const deletions = {};
-    for (const key of keys) {
-      const valueA = a[key];
-      const valueB = b[key];
-      if (valueA === void 0 && valueB !== void 0) {
-        additions[key] = valueB;
-      } else if (valueB === void 0 && valueA !== void 0) {
-        deletions[key] = valueA;
-      } else if (valueA !== void 0 && valueB !== void 0) {
-        const d = diffJson(valueA, valueB);
-        if (d.type !== "match") {
-          changes[key] = d;
-        }
-      }
-    }
-    const result = {
-      type: "modified-o",
-      ...Object.keys(changes).length === 0 ? {} : { changes },
-      ...Object.keys(additions).length === 0 ? {} : { additions },
-      ...Object.keys(deletions).length === 0 ? {} : { deletions }
-    };
-    if (result.changes || result.additions || result.deletions) {
-      return result;
-    } else {
-      return { type: "match" };
-    }
-  }
-  return { type: "value", before: a, after: b };
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  diffJson
-});
+var _chunk6R7Z62HKjs = require('./chunk-6R7Z62HK.js');
+
+
+exports.diffJson = _chunk6R7Z62HKjs.diffJson;

package/dist/index.js

@@ -1,158 +1,10 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  diffJson: () => diffJson,
-  patchJson: () => patchJson
-});
-module.exports = __toCommonJS(src_exports);
+var _chunk6R7Z62HKjs = require('./chunk-6R7Z62HK.js');
 
-// src/diff.ts
-var jsonTypeMatches = (a, b) => typeof a === typeof b && Array.isArray(a) === Array.isArray(b) && a === null === (b === null);
-var diffJson = (a, b) => {
-  if (a === b) {
-    return { type: "match" };
-  }
-  if (!jsonTypeMatches(a, b)) {
-    throw new Error("Types don't match, unable to diff");
-  }
-  if (Array.isArray(a) && Array.isArray(b)) {
-    if (a.length === b.length) {
-      const changes = [];
-      for (let i = 0; i < a.length; i++) {
-        const d = diffJson(a[i], b[i]);
-        if (d.type !== "match") {
-          changes.push({ i, diff: d });
-        }
-      }
-      if (changes.length === 0) {
-        return { type: "match" };
-      }
-      return { type: "modified-a", changes };
-    } else {
-      let start = 0;
-      while (start < a.length && start < b.length && diffJson(a[start], b[start]).type === "match") {
-        start++;
-      }
-      let endIndexA = a.length - 1;
-      let endIndexB = b.length - 1;
-      while (endIndexA >= start && endIndexB >= start && diffJson(a[endIndexA], b[endIndexB]).type === "match") {
-        endIndexA--;
-        endIndexB--;
-      }
-      const count = endIndexA - start + 1;
-      const items = b.slice(start, endIndexB + 1);
-      return { type: "splice", start, count, items };
-    }
-  }
-  if (a === null || b === null) {
-    return { type: "value", before: a, after: b };
-  }
-  if (Array.isArray(a) || Array.isArray(b)) {
-    return { type: "value", before: a, after: b };
-  }
-  if (typeof a === "object" && typeof b === "object") {
-    const keys = /* @__PURE__ */ new Set([...Object.keys(a), ...Object.keys(b)]);
-    const changes = {};
-    const additions = {};
-    const deletions = {};
-    for (const key of keys) {
-      const valueA = a[key];
-      const valueB = b[key];
-      if (valueA === void 0 && valueB !== void 0) {
-        additions[key] = valueB;
-      } else if (valueB === void 0 && valueA !== void 0) {
-        deletions[key] = valueA;
-      } else if (valueA !== void 0 && valueB !== void 0) {
-        const d = diffJson(valueA, valueB);
-        if (d.type !== "match") {
-          changes[key] = d;
-        }
-      }
-    }
-    const result = {
-      type: "modified-o",
-      ...Object.keys(changes).length === 0 ? {} : { changes },
-      ...Object.keys(additions).length === 0 ? {} : { additions },
-      ...Object.keys(deletions).length === 0 ? {} : { deletions }
-    };
-    if (result.changes || result.additions || result.deletions) {
-      return result;
-    } else {
-      return { type: "match" };
-    }
-  }
-  return { type: "value", before: a, after: b };
-};
 
-// src/patch.ts
-var patchJson = (old, diff) => {
-  if (diff.type === "match") {
-    return old;
-  }
-  if (diff.type === "value") {
-    return diff.after;
-  }
-  if (diff.type === "splice") {
-    if (!Array.isArray(old)) {
-      throw new Error("Cannot apply splice diff to non-array value");
-    }
-    const result = [...old];
-    result.splice(diff.start, diff.count, ...diff.items);
-    return result;
-  }
-  if (diff.type === "modified-a") {
-    if (!Array.isArray(old)) {
-      throw new Error("Cannot apply changes diff to non-array value");
-    }
-    const result = [...old];
-    for (const { i, diff: d } of diff.changes) {
-      result[i] = patchJson(old[i], d);
-    }
-    return result;
-  }
-  if (Array.isArray(old)) {
-    throw new Error("Unexpected array type");
-  }
-  if (diff.type === "modified-o") {
-    if (typeof old !== "object" || old === null) {
-      throw new Error("Cannot apply modified diff to non-object value");
-    }
-    const result = { ...old, ...diff.additions };
-    for (const key of Object.keys(diff.changes || {})) {
-      const changes = diff.changes?.[key];
-      if (changes) {
-        result[key] = patchJson(old[key], changes);
-      }
-    }
-    for (const keu of Object.keys(diff.deletions || {})) {
-      delete result[keu];
-    }
-    return result;
-  }
-  const _n = diff;
-  throw new Error(`Unknown diff type: ${_n}`);
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  diffJson,
-  patchJson
-});
+var _chunkHLUKTMHVjs = require('./chunk-HLUKTMHV.js');
+
+
+
+exports.diffJson = _chunk6R7Z62HKjs.diffJson; exports.patchJson = _chunkHLUKTMHVjs.patchJson;

package/dist/patch.js

@@ -1,76 +1,6 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-// src/patch.ts
-var patch_exports = {};
-__export(patch_exports, {
-  patchJson: () => patchJson
-});
-module.exports = __toCommonJS(patch_exports);
-var patchJson = (old, diff) => {
-  if (diff.type === "match") {
-    return old;
-  }
-  if (diff.type === "value") {
-    return diff.after;
-  }
-  if (diff.type === "splice") {
-    if (!Array.isArray(old)) {
-      throw new Error("Cannot apply splice diff to non-array value");
-    }
-    const result = [...old];
-    result.splice(diff.start, diff.count, ...diff.items);
-    return result;
-  }
-  if (diff.type === "modified-a") {
-    if (!Array.isArray(old)) {
-      throw new Error("Cannot apply changes diff to non-array value");
-    }
-    const result = [...old];
-    for (const { i, diff: d } of diff.changes) {
-      result[i] = patchJson(old[i], d);
-    }
-    return result;
-  }
-  if (Array.isArray(old)) {
-    throw new Error("Unexpected array type");
-  }
-  if (diff.type === "modified-o") {
-    if (typeof old !== "object" || old === null) {
-      throw new Error("Cannot apply modified diff to non-object value");
-    }
-    const result = { ...old, ...diff.additions };
-    for (const key of Object.keys(diff.changes || {})) {
-      const changes = diff.changes?.[key];
-      if (changes) {
-        result[key] = patchJson(old[key], changes);
-      }
-    }
-    for (const keu of Object.keys(diff.deletions || {})) {
-      delete result[keu];
-    }
-    return result;
-  }
-  const _n = diff;
-  throw new Error(`Unknown diff type: ${_n}`);
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  patchJson
-});
+var _chunkHLUKTMHVjs = require('./chunk-HLUKTMHV.js');
+
+
+exports.patchJson = _chunkHLUKTMHVjs.patchJson;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcanejs/diff",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "private": false,
   "description": "Create and apply JSON diffs of JSON objects",
   "keywords": [
@@ -22,16 +22,19 @@
   },
   "exports": {
     ".": {
+      "@arcanejs/source": "./src/index.ts",
       "import": "./dist/index.mjs",
       "require": "./dist/index.js",
       "types": "./dist/index.d.ts"
     },
     "./diff": {
+      "@arcanejs/source": "./src/diff.ts",
       "import": "./dist/diff.mjs",
       "require": "./dist/diff.js",
       "types": "./dist/diff.d.ts"
     },
     "./patch": {
+      "@arcanejs/source": "./src/patch.ts",
       "import": "./dist/patch.mjs",
       "require": "./dist/patch.js",
       "types": "./dist/patch.d.ts"
@@ -46,8 +49,8 @@
     "ts-jest": "^29.2.0",
     "tsup": "^8.1.0",
     "typescript": "^5.3.3",
-    "@arcanejs/eslint-config": "0.0.0",
-    "@arcanejs/typescript-config": "0.0.0"
+    "@arcanejs/eslint-config": "^0.0.0",
+    "@arcanejs/typescript-config": "^0.0.0"
   },
   "files": [
     "dist"
@@ -58,7 +61,6 @@
   "scripts": {
     "lint": "eslint . --max-warnings 0",
     "build": "tsup",
-    "dev": "tsup --watch",
     "test": "jest",
     "test:watch": "jest --watch"
   }