@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

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

0.147.0-handle-access-control-errors.38

7 years ago

0.146.4-hints-mode.156

7 years ago

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

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

0.144.4-cheesy-bites.132

7 years ago

0.144.4-cheesy-bites.121

7 years ago

0.146.0-alpha.1

7 years ago

0.145.0

7 years ago

0.144.3-cheesy-bites.110

7 years ago

0.144.3-cheesy-bites.106

7 years ago

0.144.3-cheesy-bites.94

7 years ago

0.144.3-cheesy-bites.84

7 years ago

0.145.0-alpha.32

7 years ago

0.144.3-cheesy-bites.80

7 years ago

0.144.0

7 years ago

0.143.0-initial-value-templates.55

7 years ago

0.143.0-initial-value-templates.73

7 years ago

0.143.0-initial-value-templates.72

7 years ago

0.142.9-initial-value-templates.60

7 years ago

0.142.8-initial-value-templates.64

7 years ago

0.142.8-initial-value-templates.59

7 years ago

0.142.8-initial-value-templates.55

7 years ago

0.142.8-initial-value-templates.45

7 years ago

0.142.8-initial-value-templates.41

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

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.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

8 years ago

0.138.0-realtime-block-editor.14

8 years ago

0.138.0-realtime-block-editor.16

8 years ago

0.136.1-canary.66

8 years ago

0.137.0

8 years ago

0.136.3-gql-rtb.417

8 years ago

0.137.0-realtime-block-editor.382

8 years ago

0.137.0-realtime-block-editor.380

8 years ago

0.137.0-realtime-block-editor.379

8 years ago

0.137.0-realtime-block-editor.378

8 years ago

0.137.0-realtime-block-editor.373

8 years ago

0.137.0-realtime-block-editor.372

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

0.137.0-realtime-block-editor.344

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

0.137.0-realtime-block-editor.343

8 years ago

0.137.0-realtime-block-editor.340

8 years ago

0.137.0-realtime-block-editor.326

8 years ago

0.137.0-realtime-block-editor.321

8 years ago

0.137.0-realtime-block-editor.319

8 years ago

0.137.0-realtime-block-editor.315

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.135.0-realtime-block-editor.250

8 years ago

0.135.0-realtime-block-editor.237

8 years ago

0.135.0-beta.0

8 years ago

0.135.0-realtime-block-editor.220

8 years ago

0.134.0

8 years ago

0.134.0-alpha.d19d4c0c

8 years ago

0.134.0-beta.cddc8121

8 years ago

0.133.2

8 years ago

0.133.1

8 years ago

0.133.0

8 years ago

0.133.0-realtime-block-editor.6916e3ac

8 years ago

0.133.0-alpha.62006080

8 years ago

0.133.0-realtime-block-editor.b65ceaaa

8 years ago

0.133.0-realtime-block-editor.3566387d

8 years ago

0.133.0-babel-7.06032ac5

8 years ago

0.133.0-babel-7.fc481eec

8 years ago

0.133.0-babel-7.c9b85eeb

8 years ago

0.133.0-next.0119dcd9

8 years ago

0.133.0-next.9c72956b

8 years ago

0.133.0-alpha.6c26291e

8 years ago

0.133.0-alpha.2998219b

8 years ago

0.133.0-realtime-block-editor.9839d7be

8 years ago

0.133.0-vega.cb3cdeee

8 years ago

0.133.0-realtime-block-editor.6a0cdbe8

8 years ago

0.132.5

8 years ago

0.133.0-realtime-block-editor.5fcc290f

8 years ago

0.133.0-realtime-block-editor.33c2edde

8 years ago

0.133.0-realtime-block-editor.6334c043

8 years ago

0.133.0-realtime-block-editor.6696d11c

8 years ago

0.133.0-realtime-block-editor.410b182f

8 years ago

0.133.0-realtime-block-editor.e0a05fd0

8 years ago

0.133.0-realtime-block-editor.8efe50ed

8 years ago

0.133.0-realtime-block-editor.b0c02255

8 years ago

0.133.0-realtime-block-editor.72c3aa98

8 years ago

0.132.4-next.0

8 years ago

0.132.2

8 years ago

0.133.0-next.0fc5a66d

8 years ago

0.133.0-next.ddda7af6

8 years ago

0.132.0

8 years ago

0.132.0-alpha.7fcf9a39

8 years ago

0.132.0-next.d060f6dc

8 years ago

0.132.0-next.d3b8c54c

8 years ago

0.132.0-next.f8f265d4

8 years ago

0.131.0-alpha.7b4bcb14

8 years ago

0.130.0-alpha.7e3ea3ad

8 years ago

0.130.0-realtime-block-editor.e9285437

8 years ago

0.129.0-realtime-block-editor.3bcf6473

8 years ago

0.129.0-alpha.298b96b5

8 years ago

0.128.3

8 years ago

0.128.1

8 years ago

0.128.0

8 years ago

0.128.0-next.3c762f83

8 years ago

0.128.0-next.124ce231

8 years ago

0.127.1

8 years ago

0.127.0-next.2eed79ff

8 years ago

0.127.0-next.39c2be50

8 years ago

0.127.0-next.f6814493

8 years ago

0.126.2

8 years ago

0.126.0

8 years ago

0.126.0-next.536d8adf

8 years ago

0.126.0-next.febffa69

8 years ago

0.126.0-alpha.8a1ee38f

8 years ago

0.126.0-next.a249ae9f

8 years ago

0.125.8

8 years ago

0.126.0-fix-span-keys.12d2645d

8 years ago

0.125.6

8 years ago

0.126.0-alpha.74ae7fc1

8 years ago

0.125.4

8 years ago

0.125.0

8 years ago

0.125.0-rc.4

8 years ago

0.125.0-next.d323ee1a

8 years ago

0.125.0-next.c0a1c26b

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

0.125.0-alpha.593130df

8 years ago

0.125.0-next.7f27340d

8 years ago

0.125.0-next.e8a95940

8 years ago

0.125.0-next.90bb7dbc

8 years ago

0.125.0-next.509884e7

8 years ago

0.125.0-next.e3503829

8 years ago

0.125.0-next.f0a45fc8

8 years ago

0.125.0-next.f7d2f004

8 years ago

0.125.0-next.b1f0d4fa

8 years ago

0.125.0-vega.1bc71a10

8 years ago

0.125.0-vega.c48b34cc

8 years ago

0.124.0

8 years ago

0.124.0-default-login.063643d2

8 years ago

0.124.0-next.a6431d11

8 years ago

0.124.0-next.6c328976

8 years ago

0.124.0-next.71deafdf

8 years ago

0.124.0-alpha.831a5eca

8 years ago

0.124.0-alpha.803a5e05

8 years ago

0.124.0-alpha.56833000

8 years ago

0.124.0-alpha.f0625b40

8 years ago

0.124.0-alpha.d5ac0a90

8 years ago

0.124.0-alpha.35b4b49a

9 years ago

0.123.0-beta.ce219b27

9 years ago

0.123.0-alpha.ce219b27

9 years ago

0.122.0-cli-next.76de446a

9 years ago

0.122.0-focus.5d5f8af0

9 years ago

0.122.0-focus.f9133963

9 years ago

0.122.0-focus.a3c7e9a7

9 years ago

0.122.0-focus.5bb0e7f8

9 years ago

0.122.0-spaces.bc70a23d

9 years ago

0.122.0-spaces.69b340a1

9 years ago

0.122.0-spaces.731315ac

9 years ago

0.122.0-weakrefs.962100b2

9 years ago

0.122.0-weakrefs.bc3b5c11

9 years ago

0.121.0

9 years ago

0.120.0

9 years ago

0.120.0-next.941943a9

9 years ago

0.120.0-next.a0d96db3

9 years ago

0.120.0-next.1b01c53f

9 years ago

0.120.0-next.347ee9ef

9 years ago

0.119.0

9 years ago

0.119.0-next.ccb2d795

9 years ago

0.119.0-next.38cbd236

9 years ago

0.119.0-next.7d247810

9 years ago

0.118.4

9 years ago

0.118.4-alpha.fd54a0f6

9 years ago

0.118.4-alpha.baa65f38

9 years ago

0.118.4-alpha.a8d33d33

9 years ago

0.118.0

9 years ago

0.118.0-alpha.3044306e

9 years ago

0.118.0-alpha.f5bc6d66

9 years ago

0.118.0-alpha.63c2ec04

9 years ago

0.118.0-alpha.6148a864

9 years ago

0.118.0-alpha.3ba6b138

9 years ago

0.118.0-alpha.4b319452

9 years ago

0.118.0-alpha.4667d5d9

9 years ago

0.118.0-alpha.e582840f

9 years ago

0.118.0-alpha.5c1e893f

9 years ago

0.118.0-alpha.738fd8f9

9 years ago

0.117.0

9 years ago

0.117.0-alpha.d541a205

9 years ago

0.117.0-alpha.a447401b

9 years ago

0.117.0-alpha.ccd15003

9 years ago

0.117.0-alpha.4d694edd

9 years ago

0.117.0-alpha.36cb4c94

9 years ago

0.117.0-alpha.68229f63

9 years ago

0.117.0-alpha.63392a14

9 years ago

0.117.0-alpha.46ea7fb7

9 years ago

0.117.0-alpha.3d19d198

9 years ago

0.117.0-alpha.c32e5de9

9 years ago

0.116.0

9 years ago

0.116.0-rc.0

9 years ago

0.116.0-alpha.01c9dcc3

9 years ago

0.116.0-alpha.d4d85928

9 years ago

0.116.0-alpha.afa81e66

9 years ago

0.116.0-alpha.617e9488

9 years ago

0.116.0-alpha.f618ada7

9 years ago

0.116.0-alpha.97324943

9 years ago

0.116.0-alpha.1e8ff1b4

9 years ago

0.116.0-alpha.f676a05d

9 years ago

0.116.0-alpha.9ae03f98

9 years ago

0.116.0-alpha.0e1e5b77

9 years ago

0.115.2

9 years ago

0.116.0-alpha.18b2a421

9 years ago

0.116.0-alpha.98a84961

9 years ago

0.116.0-alpha.b997a667

9 years ago

0.116.0-alpha.b71a8dfe

9 years ago

0.116.0-alpha.b98ad418

9 years ago

0.116.0-alpha.e2d07b9d

9 years ago

0.116.0-alpha.5bbff73d

9 years ago

0.115.1

9 years ago

0.116.0-alpha.d87df7bd

9 years ago

0.115.0

9 years ago

0.115.0-alpha.d2d05de5

9 years ago

0.115.0-next.06b9dcc2

9 years ago

0.115.0-next.46b477e5

9 years ago

0.115.0-next.0cd795cf

9 years ago

0.115.0-next.10401d0e

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

0.113.0-alpha.023b1989

9 years ago

0.113.0-alpha.f6d0f98d

9 years ago

0.112.0

9 years ago

0.111.6-beta.0

9 years ago

0.112.0-next.269a50ce

9 years ago

0.112.0-next.95d3c914

9 years ago

0.112.0-next.d745a58c

9 years ago

0.112.0-next.9525798e

9 years ago

0.111.5

9 years ago

0.112.0-alpha.42c69838

9 years ago

0.112.0-alpha.fcc45c9d

9 years ago

0.112.0-alpha.c03acae3

9 years ago

0.111.2

9 years ago

0.110.0

9 years ago

0.110.0-next.266637f7

9 years ago

0.109.0

9 years ago

0.109.0-next.46baa731

9 years ago

0.109.0-next.ee186f4b

9 years ago

0.109.0-next.03e4bf11

9 years ago

0.109.0-beta.0

9 years ago

0.109.0-alpha.1862fd4f

9 years ago

0.109.0-alpha.4a764d83

9 years ago

0.109.0-alpha.17fcc625

9 years ago

0.108.0

9 years ago

0.108.0-beta.2

9 years ago

0.108.0-beta.1

9 years ago

0.108.0-alpha.922a7874

9 years ago

0.108.0-alpha.6e9e335c

9 years ago

0.107.28-alpha.1a5051bd

9 years ago

0.108.0-alpha.32abe08e

9 years ago

0.108.0-alpha.d5efed6d

9 years ago

0.107.27

9 years ago

0.108.0-alpha.dca88d40

9 years ago

0.107.25-alpha.a5f5b872

9 years ago

0.107.25-alpha.6ea8df80

9 years ago

0.107.25-alpha.77296ffd

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

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

9 years ago

0.104.34-alpha.bddee3b4

9 years ago

0.104.34-alpha.136d385a

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

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

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

9 years ago

9 years ago

9 years ago

9 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago

10 years ago