{"bugs":{"url":"https://github.com/sanity-io/sanity/issues"},"dist":{"shasum":"f1245e8e7643116c4fd77cd94e612afbe805f892","tarball":"https://registry.npmjs.org/@sanity/document-store/-/document-store-0.138.0-alpha.21.tgz","fileCount":22,"integrity":"sha512-qmCK0oog+g9+ihc3WLaDKbCmly10ALFMDZq9qpMUDiyId5dBpKRQMkTLwY7LFMjg5e6VLaN5jTjKnfZpKayGKw==","signatures":[{"sig":"MEUCIQDskNvQ8vPhenacwkN2X4Wzh7tabOQc1oINGN2PXUgy6wIgHa594Pox69SQItoQB+AGgNqbQANz1qPK0qFRV9KT8pU=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":94906,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcGCSsCRA9TVsSAnZWagAAGh0QAKN59gZsNpl4m41q7On9\nKmm+kB2ZhmPGAwG0lzY7b9k5kLQX0Jo4R0jAbchqcY/KTnt6rraO8YNX/vzD\nfx9EsKgJO7l+5lDjOfBS2R3h9FvDGxjb2Pieba2vV9d9/A6rLdQeRG3Gk5WI\npKA4jQnjCBDTZdxOAPwLh0b1UpriVM0rxPbjHWhJ4RnZETeZ9Y9gldzEqKaY\nFY9bR1hcD0oV5z+pp3CbP50vtmquiUR2zJN76z7hmecJjJXvXrPVXpXf5Cuq\n3oNvGo0r7g+38o7tUjdZ/Epmc9okFrnY+5fsB0ZnC2qAlJX+uevytOGLtIJc\nQ1USFdycDRE6xAGjbSqJwHL9guilOPlnfBkt3YutvE2apctofp11Dvkr6lN1\n8SaG5Nm9t6/FdmxKJG8gMlOSxflOIqyN1xefpWLEiDYlWLKMgdtWKUOGEHPM\nvCU2wTXZZqH0LtgqyyrZZd4T5bMy4S1Vy5QGtmzSUMBUIWuufGsmllVYliI2\nUZAvmU/SdU7YA+foVjaS3TaqyxMd9ohXvDxN7ebRntZpQN0WaIZ7nfofHXEr\nriT5ui+uxjV9J+yBI8bAg2ABrp3IMS5srbl3GpMSj5um98H/bT8ZzMhgXBfq\nJZ1M1fnUvDZDczc7e2E4wcIuIpJLnS9gunfhvk/pFePPdBrN0TU+4y6bXtH+\nnwSA\r\n=NFd7\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./lib/index.js","name":"@sanity/document-store","_from":"file:sanity-document-store-0.138.0-alpha.21.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":"3488195618d5da375ef479efed82090bc4bca424","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":"skogsmaskin","email":"per.kristian.nordnes@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@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.12.0","dependencies":{"rxjs":"^6.1.0","lodash":"^4.17.4","nano-pubsub":"^1.0.2","@sanity/mutator":"0.138.0-alpha.21+348819561"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/document-store_0.138.0-alpha.21_1545086124116_0.9695913190478673","host":"s3://npm-registry-packages"},"_id":"@sanity/document-store@0.138.0-alpha.21","version":"0.138.0-alpha.21"}