{"bugs":{"url":"https://github.com/sanity-io/sanity/issues"},"dist":{"shasum":"ada717588ae319c937728f60158ee8982a04419b","tarball":"https://registry.npmjs.org/@sanity/document-store/-/document-store-0.135.0-next.2.tgz","fileCount":21,"integrity":"sha512-+HxfD25MEs8MZSdXH3O6lrvURrkg6ASXyWuCpwF5e/xcDrKOt0nftVbZmZIqJf5ecwhz5xTaZAvqniHzXhcJ3w==","signatures":[{"sig":"MEQCIBxiXcF1dfi+biQf7T9YDxjQTKKJeTSVH5sH6Xx46uQtAiAhpvuXR1f923fav9FAtOI2GULPoUPVNGR2boC4NfxDDw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":31788,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbvhWCCRA9TVsSAnZWagAAoaAP/1b7BgF3qTWLtZYz8chz\naKK4FWoS5x30yOmiPbBfVOfGEeXy4q24l7IufYE8zap/H8beR5f23cDsrB19\nalQoVKx9XcS7+tWOQp4sDWKAOt6Ym3wnBh8LLQtbfjfe9cc96eK8RTEF5kTV\n4yohjdCK9oyooKbV2Bnm40+mPL7DhfJtW3G8ZqUp1HNJxTaFSW7k2nBsiK3L\nyc0T1GjRcPQWMOmxDFguL9mlUzOidP6EXmNZUtlkSb84XscPyjWBCfmzRgfd\nPX259f+X/ze3wxXfLv3dujz8+NIC0HvKyW74GxRz7K6GCpzVAPs/SkBcV0CN\niLuBtqhAifjh7xKdf1l5EI3JQOs4XVuHaoc+q5HQL0J8vZq/bHxW+uwseHr0\njL+I0KDIh1nIjSvgkgAH+IaBjDrXwVVcsybCW4mKlOT6XZBFmo6Uy3rkXkRj\nf3qBAtpRTZX4Big5LC68fetJi5KgahqfLpBjkLZEcXVR6clVwzdEwtXuJkFV\nNSWgittZBwcAyBzIPZxErofrBsayMqZxqGGqTesEFFG+dFslHgPf/14qulsS\nWv+Ti+6+Se8IqtTzibZ6G7TOlWZcHIEjpbc9NQK0GVqJeKZmRByACbV7ab+q\nLOCiAyBMuYaQxw0DZD3n/cjAQ+n4jj6bP+OWsw9rcetMAQrLR2b00sLLqlJ4\nEicR\r\n=xGtV\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./lib/index.js","name":"@sanity/document-store","_from":"file:sanity-document-store-0.135.0-next.2.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":"2b6cd606ac7de42d57da01ebcb09af57f265b82d","license":"MIT","scripts":{"tap":"tap --node-arg=--require --node-arg=babel-register test/*.test.js","test":"npm run tap && npm run examples","clean":"rimraf lib","examples":"echo 'Running examples'; for i in examples/*.js; do echo '\n## '$i' ----\n' && node $i; done"},"_npmUser":{"name":"bjoerge","email":"bjoerge@gmail.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@bengler.no"},{"name":"rexxars","email":"espen@hovlandsdal.com"},{"name":"simenss","email":"simen@bengler.no"},{"name":"skogsmaskin","email":"per.kristian.nordnes@gmail.com"},{"name":"thomax","email":"thomas@bengler.no"}],"_nodeVersion":"8.12.0","dependencies":{"rxjs":"^6.1.0","lodash":"^4.17.4","nano-pubsub":"^1.0.2","@sanity/mutator":"0.135.0-next.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"tap":"^12.0.1","rimraf":"^2.6.2","in-publish":"^2.0.0","get-random-values":"^1.2.0"},"_npmOperationalInternal":{"tmp":"tmp/document-store_0.135.0-next.2_1539184001197_0.0524522775557954","host":"s3://npm-registry-packages"},"_id":"@sanity/document-store@0.135.0-next.2","version":"0.135.0-next.2"}