{"bugs":{"url":"https://github.com/sanity-io/sanity/issues"},"dist":{"shasum":"3e6d2059800a98518fbcbf2c2d9648d911de8abd","tarball":"https://registry.npmjs.org/@sanity/document-store/-/document-store-0.135.0-next.1.tgz","fileCount":19,"integrity":"sha512-+JW427steJiEkDV9paKrwUubN/ffurNYgW28ur6FwvsrTnJQR7Dxp2xJSs/C5Ah1UEsMZ660gO3SRDMx5CuARg==","signatures":[{"sig":"MEUCIQCayZx2wOqDNIpPBEdAlNObHyJ0GKrHB3huoECcMZZxpgIgLAdSKBAV19pj8z1piqKDCyNZUHyTbY6VFpX5EYuhJSI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":29800,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbtiGMCRA9TVsSAnZWagAAkrMP/3MGSxBZaw1yxICVGQRZ\nJ1q4GhuyiTiIsdtazmGaV1B6z11QUVKgXuNfrFU/zoSNITvl6SxwbX050y55\nSGl8CVBlsU81SOJMtuakmTpONCFH98K+M2zKKl8FzkSQuLF8LHBhKTbCJ+ng\nm3ION0auod0ncGeiOok3aGEZGj7cfxMM2NZ7kUyQl4EU6ffjewPVnaccj+Qe\nf9mI8BxishKHzwsviIdMB54FqqobMeoZNFOVjRe15pjNrE1Qc/N3NTy0trNZ\n/O9lOgpiNlR+Bjgdqr7U0Rjs7K1dM0cB/6Zzronsc+XjJvzE7IKVy73FfFeS\ngIxBPH6HNiL6Jbo2F1F7dQDVTq6hJ1RXH6yC3SkDYww2e8Z1yndDGW9dSNH9\nOvFwFsLNK9hF+7Ngfn9G1TfxtSiPQuyVNueMeKyICh+LHeBdEoJsaPBGF5Nz\nau82codYWR7v2+q8y1KNumgs0OpeENa+fgFIf0wQ+LVfY6WCCwzQsNJ1vx8x\nocEeOjQXZaFuetZUCcdrign5m9IDPHk1GiR/wiY4qSw3/gSfClFHEG+3oUCu\nsIjSVd2J0uw+qRbgJ5429+yPouaybauVVDNrLu+lO6ZfquRaWkAO0MVp1nVF\n+HLiTdCoL9QAPi14K0VaA8M/xIxxgqy3eZXJwOCOe0JxW1AV2/+U2KKeIO8K\nZU3n\r\n=ajjd\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./lib/index.js","name":"@sanity/document-store","_from":"file:sanity-document-store-0.135.0-next.1.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":"1414615ceb43d8f164e807760d1307f6dd416cfd","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.1"},"_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.1_1538662795447_0.2441828147587275","host":"s3://npm-registry-packages"},"_id":"@sanity/document-store@0.135.0-next.1","version":"0.135.0-next.1"}