@sanity/document-store NPM

Document store

Sanity / gradient document store

Example

// If you are interested in everything that happens with document `lol42`
const subscription = documents.byId("lol42").subscribe(event => {
  console.log('Something happened with document lol42!', event)
})

// After a while, when you are no longer interested in updates fom document `lol42`:
subscription.unsubscribe()

How it works

When you add a subscriber to a document the first thing that happens is that the subscriber function is called with a snapshot of the document's current state. This happens as soon as the snapshot is retrieved. If there is a cached version of it on the client, the snapshot is received immediately (synchronously).

From that moment on, you will receive a new event every time something happens to the document, until you unsubscribe again.

API

createDocumentStore({serverConnection: ServerConnection}) : DocumentStore

ServerConnection must be an object with the following api:

byId(id : string) : Observable<DocumentEvent>
query(query : string) : Observable<QueryResultEvent> (todo, add more)

DocumentStore

Query methods

byId(id : string) : Observable<DocumentEvent>
byIds(ids : Array<string>) : Observable<QueryResultEvent>
query(query : string) : Observable<QueryResultEvent>

Mutation methods

update(id : string, spec : UpdateSpec) : Observable<OperationEvent>
create(document : Document) : Observable<OperationEvent>
replace(documentId : string, document : Document) : Observable<OperationEvent>
createOrReplace(document : Document) : Observable<OperationEvent>
delete(documentId : string) : : Observable<OperationEvent>

Document

_id : string
_type : string

DocumentEventType

DocumentEvent

type : string either one of snapshot, update
snapshot : Document

sanity cms headless realtime content document-store

rxjs lodash nano-pubsub @sanity/mutator

@infinitebrahmanuniverse/nolb-_san @everything-registry/sub-chunk-805 @zalastax/nolb-_san

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

0.147.0-handle-access-control-errors.38

6 years ago

0.146.4-hints-mode.156

6 years ago

0.147.0-block-tools-white-space-fix.2

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.144.4-cheesy-bites.132

6 years ago

0.144.4-cheesy-bites.121

6 years ago

0.146.0-alpha.1

6 years ago

0.145.0

6 years ago

0.144.3-cheesy-bites.110

6 years ago

0.144.3-cheesy-bites.106

6 years ago

0.144.3-cheesy-bites.94

6 years ago

0.144.3-cheesy-bites.84

6 years ago

0.145.0-alpha.32

6 years ago

0.144.3-cheesy-bites.80

6 years ago

0.144.0

6 years ago

0.143.0-initial-value-templates.55

6 years ago

0.143.0-initial-value-templates.73

6 years ago

0.143.0-initial-value-templates.72

6 years ago

0.142.9-initial-value-templates.60

6 years ago

0.142.8-initial-value-templates.64

6 years ago

0.142.8-initial-value-templates.59

6 years ago

0.142.8-initial-value-templates.55

6 years ago

0.142.8-initial-value-templates.45

6 years ago

0.142.8-initial-value-templates.41

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

0.138.0-realtime-block-editor.22

7 years ago

0.138.0-realtime-block-editor.25

7 years ago

0.138.0-realtime-block-editor.24

7 years ago

0.138.0-realtime-block-editor.21

7 years ago

0.138.0-alpha.20

7 years ago

0.138.0-alpha.14

7 years ago

0.138.0-realtime-block-editor.14

7 years ago

0.138.0-realtime-block-editor.16

7 years ago

0.136.1-canary.66

7 years ago

0.137.0

7 years ago

0.136.3-gql-rtb.417

7 years ago

0.137.0-realtime-block-editor.382

7 years ago

0.137.0-realtime-block-editor.380

7 years ago

0.137.0-realtime-block-editor.379

7 years ago

0.137.0-realtime-block-editor.378

7 years ago

0.137.0-realtime-block-editor.373

7 years ago

0.137.0-realtime-block-editor.372

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

0.137.0-realtime-block-editor.344

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

0.137.0-realtime-block-editor.343

7 years ago

0.137.0-realtime-block-editor.340

7 years ago

0.137.0-realtime-block-editor.326

7 years ago

0.137.0-realtime-block-editor.321

7 years ago

0.137.0-realtime-block-editor.319

7 years ago

0.137.0-realtime-block-editor.315

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

0.135.0-realtime-block-editor.250

7 years ago

0.135.0-realtime-block-editor.237

7 years ago

0.135.0-beta.0

7 years ago

0.135.0-realtime-block-editor.220

7 years ago

0.134.0

7 years ago

0.134.0-alpha.d19d4c0c

7 years ago

0.134.0-beta.cddc8121

7 years ago

0.133.2

7 years ago

0.133.1

7 years ago

0.133.0

7 years ago

0.133.0-realtime-block-editor.6916e3ac

7 years ago

0.133.0-alpha.62006080

7 years ago

0.133.0-realtime-block-editor.b65ceaaa

7 years ago

0.133.0-realtime-block-editor.3566387d

7 years ago

0.133.0-babel-7.06032ac5

7 years ago

0.133.0-babel-7.fc481eec

7 years ago

0.133.0-babel-7.c9b85eeb

7 years ago

0.133.0-next.0119dcd9

7 years ago

0.133.0-next.9c72956b

7 years ago

0.133.0-alpha.6c26291e

7 years ago

0.133.0-alpha.2998219b

7 years ago

0.133.0-realtime-block-editor.9839d7be

7 years ago

0.133.0-vega.cb3cdeee

7 years ago

0.133.0-realtime-block-editor.6a0cdbe8

7 years ago

0.132.5

7 years ago

0.133.0-realtime-block-editor.5fcc290f

7 years ago

0.133.0-realtime-block-editor.33c2edde

7 years ago

0.133.0-realtime-block-editor.6334c043

7 years ago

0.133.0-realtime-block-editor.6696d11c

7 years ago

0.133.0-realtime-block-editor.410b182f

7 years ago

0.133.0-realtime-block-editor.e0a05fd0

7 years ago

0.133.0-realtime-block-editor.8efe50ed

7 years ago

0.133.0-realtime-block-editor.b0c02255

7 years ago

0.133.0-realtime-block-editor.72c3aa98

7 years ago

0.132.4-next.0

7 years ago

0.132.2

7 years ago

0.133.0-next.0fc5a66d

7 years ago

0.133.0-next.ddda7af6

7 years ago

0.132.0

7 years ago

0.132.0-alpha.7fcf9a39

7 years ago

0.132.0-next.d060f6dc

7 years ago

0.132.0-next.d3b8c54c

7 years ago

0.132.0-next.f8f265d4

7 years ago

0.131.0-alpha.7b4bcb14

7 years ago

0.130.0-alpha.7e3ea3ad

7 years ago

0.130.0-realtime-block-editor.e9285437

7 years ago

0.129.0-realtime-block-editor.3bcf6473

7 years ago

0.129.0-alpha.298b96b5

7 years ago

0.128.3

7 years ago

0.128.1

7 years ago

0.128.0

7 years ago

0.128.0-next.3c762f83

7 years ago

0.128.0-next.124ce231

7 years ago

0.127.1

7 years ago

0.127.0-next.2eed79ff

7 years ago

0.127.0-next.39c2be50

7 years ago

0.127.0-next.f6814493

7 years ago

0.126.2

7 years ago

0.126.0

7 years ago

0.126.0-next.536d8adf

7 years ago

0.126.0-next.febffa69

7 years ago

0.126.0-alpha.8a1ee38f

7 years ago

0.126.0-next.a249ae9f

7 years ago

0.125.8

7 years ago

0.126.0-fix-span-keys.12d2645d

7 years ago

0.125.6

7 years ago

0.126.0-alpha.74ae7fc1

7 years ago

0.125.4

7 years ago

0.125.0

7 years ago

0.125.0-rc.4

7 years ago

0.125.0-next.d323ee1a

7 years ago

0.125.0-next.c0a1c26b

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

0.125.0-alpha.593130df

7 years ago

0.125.0-next.7f27340d

7 years ago

0.125.0-next.e8a95940

7 years ago

0.125.0-next.90bb7dbc

7 years ago

0.125.0-next.509884e7

7 years ago

0.125.0-next.e3503829

7 years ago

0.125.0-next.f0a45fc8

7 years ago

0.125.0-next.f7d2f004

7 years ago

0.125.0-next.b1f0d4fa

7 years ago

0.125.0-vega.1bc71a10

7 years ago

0.125.0-vega.c48b34cc

7 years ago

0.124.0

7 years ago

0.124.0-default-login.063643d2

7 years ago

0.124.0-next.a6431d11

7 years ago

0.124.0-next.6c328976

7 years ago

0.124.0-next.71deafdf

7 years ago

0.124.0-alpha.831a5eca

7 years ago

0.124.0-alpha.803a5e05

7 years ago

0.124.0-alpha.56833000

7 years ago

0.124.0-alpha.f0625b40

7 years ago

0.124.0-alpha.d5ac0a90

8 years ago

0.124.0-alpha.35b4b49a

8 years ago

0.123.0-beta.ce219b27

8 years ago

0.123.0-alpha.ce219b27

8 years ago

0.122.0-cli-next.76de446a

8 years ago

0.122.0-focus.5d5f8af0

8 years ago

0.122.0-focus.f9133963

8 years ago

0.122.0-focus.a3c7e9a7

8 years ago

0.122.0-focus.5bb0e7f8

8 years ago

0.122.0-spaces.bc70a23d

8 years ago

0.122.0-spaces.69b340a1

8 years ago

0.122.0-spaces.731315ac

8 years ago

0.122.0-weakrefs.962100b2

8 years ago

0.122.0-weakrefs.bc3b5c11

8 years ago

0.121.0

8 years ago

0.120.0

8 years ago

0.120.0-next.941943a9

8 years ago

0.120.0-next.a0d96db3

8 years ago

0.120.0-next.1b01c53f

8 years ago

0.120.0-next.347ee9ef

8 years ago

0.119.0

8 years ago

0.119.0-next.ccb2d795

8 years ago

0.119.0-next.38cbd236

8 years ago

0.119.0-next.7d247810

8 years ago

0.118.4

8 years ago

0.118.4-alpha.fd54a0f6

8 years ago

0.118.4-alpha.baa65f38

8 years ago

0.118.4-alpha.a8d33d33

8 years ago

0.118.0

8 years ago

0.118.0-alpha.3044306e

8 years ago

0.118.0-alpha.f5bc6d66

8 years ago

0.118.0-alpha.63c2ec04

8 years ago

0.118.0-alpha.6148a864

8 years ago

0.118.0-alpha.3ba6b138

8 years ago

0.118.0-alpha.4b319452

8 years ago

0.118.0-alpha.4667d5d9

8 years ago

0.118.0-alpha.e582840f

8 years ago

0.118.0-alpha.5c1e893f

8 years ago

0.118.0-alpha.738fd8f9

8 years ago

0.117.0

8 years ago

0.117.0-alpha.d541a205

8 years ago

0.117.0-alpha.a447401b

8 years ago

0.117.0-alpha.ccd15003

8 years ago

0.117.0-alpha.4d694edd

8 years ago

0.117.0-alpha.36cb4c94

8 years ago

0.117.0-alpha.68229f63

8 years ago

0.117.0-alpha.63392a14

8 years ago

0.117.0-alpha.46ea7fb7

8 years ago

0.117.0-alpha.3d19d198

8 years ago

0.117.0-alpha.c32e5de9

8 years ago

0.116.0

8 years ago

0.116.0-rc.0

8 years ago

0.116.0-alpha.01c9dcc3

8 years ago

0.116.0-alpha.d4d85928

8 years ago

0.116.0-alpha.afa81e66

8 years ago

0.116.0-alpha.617e9488

8 years ago

0.116.0-alpha.f618ada7

8 years ago

0.116.0-alpha.97324943

8 years ago

0.116.0-alpha.1e8ff1b4

8 years ago

0.116.0-alpha.f676a05d

8 years ago

0.116.0-alpha.9ae03f98

8 years ago

0.116.0-alpha.0e1e5b77

8 years ago

0.115.2

8 years ago

0.116.0-alpha.18b2a421

8 years ago

0.116.0-alpha.98a84961

8 years ago

0.116.0-alpha.b997a667

8 years ago

0.116.0-alpha.b71a8dfe

8 years ago

0.116.0-alpha.b98ad418

8 years ago

0.116.0-alpha.e2d07b9d

8 years ago

0.116.0-alpha.5bbff73d

8 years ago

0.115.1

8 years ago

0.116.0-alpha.d87df7bd

8 years ago

0.115.0

8 years ago

0.115.0-alpha.d2d05de5

8 years ago

0.115.0-next.06b9dcc2

8 years ago

0.115.0-next.46b477e5

8 years ago

0.115.0-next.0cd795cf

8 years ago

0.115.0-next.10401d0e

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

0.113.0-alpha.023b1989

8 years ago

0.113.0-alpha.f6d0f98d

8 years ago

0.112.0

8 years ago

0.111.6-beta.0

8 years ago

0.112.0-next.269a50ce

8 years ago

0.112.0-next.95d3c914

8 years ago

0.112.0-next.d745a58c

8 years ago

0.112.0-next.9525798e

8 years ago

0.111.5

8 years ago

0.112.0-alpha.42c69838

8 years ago

0.112.0-alpha.fcc45c9d

8 years ago

0.112.0-alpha.c03acae3

8 years ago

0.111.2

8 years ago

0.110.0

8 years ago

0.110.0-next.266637f7

8 years ago

0.109.0

8 years ago

0.109.0-next.46baa731

8 years ago

0.109.0-next.ee186f4b

8 years ago

0.109.0-next.03e4bf11

8 years ago

0.109.0-beta.0

8 years ago

0.109.0-alpha.1862fd4f

8 years ago

0.109.0-alpha.4a764d83

8 years ago

0.109.0-alpha.17fcc625

8 years ago

0.108.0

8 years ago

0.108.0-beta.2

8 years ago

0.108.0-beta.1

8 years ago

0.108.0-alpha.922a7874

8 years ago

0.108.0-alpha.6e9e335c

8 years ago

0.107.28-alpha.1a5051bd

8 years ago

0.108.0-alpha.32abe08e

8 years ago

0.108.0-alpha.d5efed6d

8 years ago

0.107.27

8 years ago

0.108.0-alpha.dca88d40

8 years ago

0.107.25-alpha.a5f5b872

8 years ago

0.107.25-alpha.6ea8df80

8 years ago

0.107.25-alpha.77296ffd

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

0.104.34-alpha.bddee3b4

8 years ago

0.104.34-alpha.136d385a

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago