@sanity/mutateToolkit for Sanity mutations

Mutation creators, an in-memory apply engine, and an optimistic local store.

Mutation creators

Build mutations from creator functions. Mutations are plain values; pass them around, transform them, compose them across documents.

Typed paths and operations

Paths and operations keep their literal types end to end. Apply a patch to a typed document and the result type reflects the change.

Apply in memory

Pure functions for applying mutations to in-memory documents. Sub-trees the mutation doesn't touch keep their object identity.

Optimistic store

In-memory dataset replica with rebase semantics on top of the Sanity listener endpoint.

Example

import {
  at
,
  create
,
  createIfNotExists
,
  patch
,
  SanityEncoder
,
  set
,
  setIfMissing
,
} from '@sanity/mutate'

const patches
 = [
  at
('published', set
(true)),
  at
('address', setIfMissing
({_type
: 'address'})),
  at
('address.city', set
('Oslo')),
]
const mutations
 = [
  create
({_type
: 'dog', name
: 'Fido'}),
  createIfNotExists
({_id
: 'document-1', _type
: 'someType'}),
  patch
('other-document', patches
),
]
const payload
 = SanityEncoder
.encodeAll
(mutations
)

NOTE