@rexxars/sanity-diff-patch

Generates a set of Sanity patches needed to change an item from shape to another.

Getting started

npm install --save @rexxars/sanity-diff-patch

Usage

1import {diffPatch} from '@rexxars/sanity-diff-patch'
2
3const patch = diffPatch(itemA, itemB)
4/*
5[
6  {patch: {id: 'docId', set: {...}}},
7  {patch: {id: 'docId', unset: [...]}},
8  {patch: {id: 'docId', insert: {...}}}
9]
10*/

Example usage

1import {diffPatch} from '@rexxars/sanity-diff-patch'
2import sanityClient from './myConfiguredSanityClient'
3
4const itemA = {
5  _id: 'die-hard-iii',
6  _type: 'movie',
7  name: 'Die Hard 3',
8  year: 1995,
9  characters: [
10    {
11      _key: 'ma4sg31',
12      name: 'John McClane'
13    },
14    {
15      _key: 'l13ma92',
16      name: 'Simon Gruber'
17    }
18  ]
19}
20
21const itemB = {
22  _id: 'drafts.die-hard-iii',
23  _type: 'movie',
24  name: 'Die Hard with a Vengeance',
25  characters: [
26    {
27      _key: 'ma4sg31',
28      name: 'John McClane'
29    },
30    {
31      _key: 'l13ma92',
32      name: 'Simon Grüber'
33    }
34  ]
35}
36
37// Specify id if the two documents do not match
38const operations = diffPatch(itemA, itemB, {id: itemA._id})
39await sanityClient.transaction(operations).commit()
40
41// Patches generated:
42const generatedPatches = [
43  {
44    patch: {
45      id: 'die-hard-iii',
46      set: {
47        'name': 'Die Hard with a Vengeance',
48        'characters[_key=="l13ma92"].name': 'Simon Grüber'
49      },
50    }
51  },
52  {
53    patch: {
54      id: 'die-hard-iii',
55      unset: ['year']
56    }
57  }
58}

Needs improvement

• Improve patch on array item move
• Improve patch on array item delete