json-patch-to-crdt 0.2.0 → 0.3.0

package/README.md

@@ -31,10 +31,7 @@ Node.js `>=18`.
 ```ts
 import { applyPatch, createState, toJson, type JsonPatchOp } from "json-patch-to-crdt";
 
-const state = createState(
-  { todos: ["write docs"], done: false },
-  { actor: "client-A" },
-);
+const state = createState({ todos: ["write docs"], done: false }, { actor: "client-A" });
 
 const patch: JsonPatchOp[] = [
   { op: "add", path: "/todos/-", value: "ship package" },
@@ -88,8 +85,29 @@ console.log(delta);
 //   { op: "add", path: "/profile/active", value: true },
 //   { op: "add", path: "/tags/1", value: "b" }
 // ]
+
+const reordered = diffJsonPatch(
+  { tags: ["a", "b", "c"] },
+  { tags: ["b", "a", "c"] },
+  { arrayStrategy: "lcs", emitMoves: true },
+);
+
+console.log(reordered);
+// [{ op: "move", from: "/tags/0", path: "/tags/1" }]
 ```
 
+For array-heavy snapshots, `diffJsonPatch` and `crdtToJsonPatch` support:
+
+- `arrayStrategy: "lcs"`: deterministic index-level array edits using the classic LCS matrix. This is the default.
+- `arrayStrategy: "lcs-linear"`: deterministic index-level array edits using a lower-memory linear-space LCS traversal.
+- `arrayStrategy: "atomic"`: replace the whole array with a single patch operation.
+
+`lcsMaxCells` only applies to `arrayStrategy: "lcs"`. If the classic LCS matrix would exceed the configured cap, the diff falls back to an atomic array `replace`. Use `lcs-linear` when you want index-level patches for larger arrays without allocating the full matrix, but note that it still has `O(n * m)` time complexity and does not automatically fall back for very large unmatched windows.
+
+`diffJsonPatch` keeps the existing `add`/`remove`/`replace` output by default. Set
+`emitMoves` and/or `emitCopies` to opt into deterministic RFC 6902 `move`/`copy`
+rewrites.
+
 ## Serialize / Restore State
 
 ```ts