Diff and Apply
Problem
You have two versions of a JSON document — before and after an edit — and need to ship only what changed, apply changes without mutating shared state, and read fields by path.
Solution
diff computes the patch, apply replays it, getIn reads through pointers:
ts
import { apply, diff, getIn } from '@vielzeug/patchwork';
const before = { address: { city: 'Vienna', zip: '1010' }, items: ['a'], rev: 1 };
const after = { address: { city: 'Vienna', zip: '1020' }, items: ['a', 'b'], rev: 2 };
const patch = diff(before, after);
// [{ op: 'replace', path: '/address/zip', value: '1020' },
// { op: 'add', path: '/items/-', value: 'b' },
// { op: 'replace', path: '/rev', value: 2 }]
const next = apply(before, patch); // `before` is still the old document, unchanged
getIn(next, '/address/zip'); // '1020'
next.address !== before.address; // the branch that changed is new…
next.items !== before.items; // …and untouched branches (none here) keep identityPatches are plain JSON, so they can be sent as-is and logged verbatim:
ts
JSON.parse(JSON.stringify(patch)); // survives the wire unchangedPitfalls
- Pointers start with
/(or are empty for the whole document);getIn(doc, 'address')is a malformed pointer and throws. replacerequires the target to exist — to upsert, useadd, which sets-or-overwrites on objects.- The patch returned by
diffreferences values insideto; if you keep mutatingto, serialize or clone the patch first.