{"bugs":{"url":"https://github.com/sanity-io/sanity/issues"},"dist":{"shasum":"0bf8221e37c662ab6cfcd12f0e275a888b1bac73","tarball":"https://registry.npmjs.org/@sanity/document-store/-/document-store-0.139.3-canary.0.tgz","fileCount":21,"integrity":"sha512-wfcAq4n7W7vmDwJqY685WRjp6i5ZiI73UqrqzRoLPmhPvwoJITJjsUTwASTy+90tPxHvo2hlB9pt7NXmPmMNhg==","signatures":[{"sig":"MEYCIQDLQpHdpnipSIHg5SUSMsFP1jT3DU+teFRCDT/ctjILtgIhAOcTRlHWC1mGtGL73cXI6KZUgh9mZhxNLRql1w/QoyzG","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":33062,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcIrG/CRA9TVsSAnZWagAAF/sP/1lpcY6uKwAjC5LQvuaL\nQr/v9MiiUL14Bq7RKUKi/h1P221nH4wMkxXjmba+zN5SbLod47+4QGFb0tJ4\nW32OoT0Zlmi3lmhoA7Q+kO4pB9OQ59GCAGKwCafs0J08mzMPAIfp67yh16Bo\n+vZYPQMzm67Vh6v+XsikyCoBWufMNViZeDmd3C5Wf5T8iVmDVWsKPXx0vx90\nMDYxgMN1DG7add7Hl8gN8WHFZgt1CamchnxyIspCdJYebjBBdViIlY8RpA2N\n31LxwnJc3krrrEJg/CyocRdSC9JphuVw9j1OrKqekZKTRNiopjp8TElzkeU0\nwlklI3nqdkR/IMhpS74kT0YzjbF/rEW3Pdgxot+Zi9pbvvuTjDBf7409lSUJ\n5HDyTbfYzJcrobIZoyxO9jzNWe0CdXOvkKNFVDW2qxAQoq7uLCtKQnS4wAS/\nQ8wJux80kWXwQNd5UM0yD+TDanB9hKoIU551SH3HMtTTHQP+2NehKxIAGCvz\nVKLvPXL3IBwDXSfPzAXFNMBpZwFzp1iuimhLhSNVj8gG6X281BS5ShrEQiG0\n3T/0978+ry8VXuQAVpc3wFqHrbr1LUQI8roUI3m5uV0//kkX1CgMEIF72wWS\nGOLf2oOPC8IO9lETOdS6EAN5M1ALfFwan8ITdyOIOpm6g8Z+BUxJsaBZ1Kqz\nWtIJ\r\n=blp/\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./lib/index.js","name":"@sanity/document-store","_from":"file:sanity-document-store-0.139.3-canary.0.tgz","author":{"name":"Sanity.io","email":"hello@sanity.io"},"readme":"# Document store\n\nSanity / gradient document store\n\n## Example\n```js\n// If you are interested in everything that happens with document `lol42`\nconst subscription = documents.byId(\"lol42\").subscribe(event => {\n  console.log('Something happened with document lol42!', event)\n})\n\n// After a while, when you are no longer interested in updates fom document `lol42`:\nsubscription.unsubscribe()\n```\n\n## How it works\nWhen 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).\n\nFrom that moment on, you will receive a new event every time something happens to the document, until you unsubscribe again.\n\n## API\n\n- `createDocumentStore({serverConnection: ServerConnection}) : DocumentStore`\n\nServerConnection must be an object with the following api:\n- `byId(id : string) : Observable<DocumentEvent>`\n- `query(query : string) : Observable<QueryResultEvent>`\n(todo, add more)\n\n### DocumentStore\n\n### Query methods\n- `byId(id : string) : Observable<DocumentEvent>`\n- `byIds(ids : Array<string>) : Observable<QueryResultEvent>`\n- `query(query : string) : Observable<QueryResultEvent>`\n\n### Mutation methods\n- `update(id : string, spec : UpdateSpec) : Observable<OperationEvent>`\n- `create(document : Document) : Observable<OperationEvent>`\n- `replace(documentId : string, document : Document) : Observable<OperationEvent>`\n- `createOrReplace(document : Document) : Observable<OperationEvent>`\n- `delete(documentId : string) :  : Observable<OperationEvent>`\n\n### Document\n- `_id : string`\n- `_type : string`\n\n### DocumentEventType\n\n### DocumentEvent\n- `type : string` either one of `snapshot`, `update`\n- `snapshot : Document`\n","gitHead":"da4ffcb6f86812862262b95eb362953ebf38ba2a","license":"MIT","scripts":{"clean":"rimraf lib","examples":"echo 'Running examples'; for i in examples/*.js; do echo '\n## '$i' ----\n' && node $i; done"},"_npmUser":{"name":"rexxars","email":"espen@hovlandsdal.com"},"homepage":"https://www.sanity.io/","keywords":["sanity","cms","headless","realtime","content","document-store"],"_resolved":"","_integrity":"","repository":{"url":"git+https://github.com/sanity-io/sanity.git","type":"git"},"_npmVersion":"6.4.1","description":"Sanity / gradient document store","directories":{},"maintainers":[{"name":"bjoerge","email":"bjoerge@gmail.com"},{"name":"kmelve","email":"knut.melvaer@gmail.com"},{"name":"kristofferj","email":"kristoffer@sanity.io"},{"name":"mariuslundgard","email":"studio@mariuslundgard.com"},{"name":"rexxars","email":"espen@hovlandsdal.com"},{"name":"sanity-io","email":"developers@sanity.io"},{"name":"simenss","email":"simen@bengler.no"},{"name":"skogsmaskin","email":"per.kristian.nordnes@gmail.com"},{"name":"thomax","email":"thomas@sanity.io"}],"_nodeVersion":"10.8.0","dependencies":{"rxjs":"^6.1.0","lodash":"^4.17.4","nano-pubsub":"^1.0.2","@sanity/mutator":"0.139.3-canary.0+da4ffcb6f"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/document-store_0.139.3-canary.0_1545777599106_0.027258536588077975","host":"s3://npm-registry-packages"},"_id":"@sanity/document-store@0.139.3-canary.0","version":"0.139.3-canary.0"}