{"bugs":{"url":"https://github.com/textileio/js-threads/issues"},"dist":{"shasum":"3413cbea234c2d6df3e3b529146823b2b66173e3","tarball":"https://registry.npmjs.org/@textile/threads-client/-/threads-client-2.1.0.tgz","fileCount":24,"integrity":"sha512-gY355Ns4KDExk3/PUTH/y3gI4lCUFizPpMT/FiU6ThVTp5IoCPBK7hjoGxuZXrhsW4x7AiEWYTJyXf0yoC0Hdg==","signatures":[{"sig":"MEUCIQCdOump567Gb0aR9p+tbjdeFe5SARZGZF+x31geDnql1gIgWXtWJl56j4M64lmj6g5xqiWQjcoen1RQi2lnCXPCuwQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1180173,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf3O4ICRA9TVsSAnZWagAAWygP/2rrISOCXK6RXIFojvil\nM4yWJ9JNRsuwp7tXvbozTVuwbXPyF2ohyO96rYNSiBitisy0hbuSfq4tTmAC\nzMEnKnx3C6X/hJLlo7f+urtPFVJegNz6m8Te6I20qo1NRn6/ZPS2QZRqaFDL\nk/QzeU3aUpx07I3znEMTa1KowIlqsNewRy30O3a/PLja1a5uK6fh5So1bKWD\nU5v7jijjGvcYyJyIOF3Q53hoFhVLrDeFZvhj7GO8NnP560QJiQlL9uaH4/oY\n+CrjDuqhDa6uPBDnJHJK7cSx5oDsFkK9CjRG0n7W00A5AdTLciQNMdKE3Imq\nTNhlYK0c44WFVyRtuBXZAeRZJedepZZU/wWq5rgcr6NXJozVop1DBLc0F0aY\nPLbqqiSrg+5c0PopkdsXPIHDLBnGk3utOy/WqnRcVhN82WDzEd7h0s9xqpe4\nOqKS8qCAKDPy6YBHsuD9E9fZLn9gOTaakUKw9zJZT6jQJac6PevYvpJfTDwD\nmAAgNuWqBY4YFkMpdr/BQp10TkDVjziO3zorHkQKYrlYRlivfsihXxY1GojD\nYlTgVafXxRFY7iFdFzjLfZyp2N1bndF4xjPBteViDLHm+1zZR1CqTLdMjE68\nZNNTvyea3+75178kSJomFGWzXtiDP18s1GASBlsgTtYRuG4QsYIsYDB3VNxb\nM4Pk\r\n=L7r7\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/cjs/index.js","name":"@textile/threads-client","types":"dist/cjs/index.d.ts","module":"dist/esm/index.js","readme":"# Threads Client _(threads-client)_\n\nServer-side (remote) event sourced storage layer for Textile's Threads protocol & database\n\n[![Textile](https://img.shields.io/badge/made%20by-Textile-informational.svg)](https://textile.io)\n[![License](https://img.shields.io/github/license/textileio/js-threads.svg)](../../LICENSE)\n[![npm (scoped)](https://img.shields.io/npm/v/@textile/threads-client.svg)](https://www.npmjs.com/package/@textile/threads-client)\n\nThis sub-package is part of [`js-threads`](https://github.com/textileio/js-threads). See the [top-level documentation](https://textileio.github.io/js-threads) for details.\n\n## Install\n\n```\nnpm install @textile/threads-client\n```\n\n## Usage\n\n**create a threads client**\n\n```typescript\nimport {Client} from '@textile/threads'\n\nconst client = new Client()\n```\n\n**create a threads client using Textile Hub APIs**\n\n[Read the full Hub API documentation](https://textileio.github.io/js-hub/docs).\n\n**create a store**\n\n```typescript\nimport {Client, Identity, ThreadID, UserAuth, PrivateKey} from '@textile/threads'\n\nasync function newToken (client: Client, user: Identity) {\n  const token = await client.getToken(user)\n  return token\n}\n\nasync function createDB (client: Client) {\n  const thread: ThreadID = await client.newDB()\n  return thread\n}\n\nasync function collectionFromObject (client: Client, thread: ThreadID, name: string, obj: any) {\n  await client.newCollectionFromObject(thread, obj, { name })\n  return\n}\n\nasync function setup (auth: UserAuth) {\n  const user = PrivateKey.fromRandom()\n\n  const client = await Client.withUserAuth(auth)\n\n  const token = await newToken(client, user)\n\n  const thread = await createDB(client)\n\n  const astronaut = {name: 'Buzz', missions: 3}\n  await collectionFromObject(client, thread, 'astronauts', astronaut)\n}\n```\n\n**get all instances**\n\n```typescript\nimport {Client, ThreadID} from '@textile/threads'\nasync function findEntity (client: Client, threadId: ThreadID, collection: string) {\n  const found = await client.find(threadId, collection, {})\n  console.debug('found:', found.length)\n}\n```\n\n**add an instance**\n\n```typescript\nimport {Client, ThreadID} from '@textile/threads'\n// matches YourModel and schema\nasync function create (client: Client, threadId: ThreadID, collection: string) {\n  const created = await client.create(threadId, collection, [{\n    some: 'data',\n    numbers: [1, 2, 3]\n  }])\n}\n```\n\n## React Native\n\nThe following has been tested on **Android Only**.\n\n`js-thread-client` should be compatible with React Native. Here are some helpful pointers if you find issues testing it out.\n\n### Connecting to the threads daemon\n\nYou can run the daemon released as part of the early preview. To do so,\n\n```sh\ngit clone git@github.com:textileio/go-threads.git\ncd go-threads\ngo run threadsd/main.go\n```\n\n**Make daemon available to RN**\n\nYou can make the daemon API port available to your app with,\n\n```sh\nadb reverse tcp:6007 tcp:6007\n```\n\nAltenatively, you can ensure this is run whenever you run your app by modifying your `package.json` as follows.\n\n```json\n{\n  ...\n  \"scripts\": {\n    ...\n    \"bind\": \"adb reverse tcp:6007 tcp:6007\",\n    \"android\": \"npm run bind && npx react-native run-android\",\n    ...\n  },\n  ...\n}\n```\n\nThen, run your app with,\n\n```sh\nnpm run android\n```\n","gitHead":"7dede0c34b48f0a77773c221d8c0a841b176efd3","license":"MIT","scripts":{"build":"npm run build:cjs","clean":"npx rimraf ./dist","build:cjs":"npx tsc -b ./tsconfig.json","test:browser":"polendina --cleanup --timeout 60 src/**/*.spec.ts --webpack-config ../../webpack.test.js"},"_npmUser":{"name":"carsonfarmer","email":"carson@textile.io"},"homepage":"https://github.com/textileio/js-threads#readme","repository":{"url":"git+https://github.com/textileio/js-threads.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v14.15.1+x64 (darwin)","description":"Server-side (remote) event sourced storage layer for Textile's Threads protocol & database","directories":{},"maintainers":[{"name":"sanderpick","email":"sanderpick@gmail.com"},{"name":"textileio","email":"sander@textile.io"},{"name":"andrewxhill","email":"andrew@textile.io"},{"name":"carsonfarmer","email":"carson@textile.io"},{"name":"asutula","email":"aaron@textile.io"}],"_nodeVersion":"14.15.1","dependencies":{"to-json-schema":"^0.2.5","@textile/crypto":"^2.0.0","@textile/context":"^0.10.0","@textile/security":"^0.7.0","@textile/multiaddr":"^0.4.0","@textile/threads-id":"^0.4.0","@types/to-json-schema":"^0.2.0","@textile/grpc-transport":"^0.3.0","@improbable-eng/grpc-web":"^0.13.0","@textile/threads-client-grpc":"^1.0.2","fastestsmallesttextencoderdecoder":"^1.0.22"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/threads-client_2.1.0_1608314376031_0.6958123811734378","host":"s3://npm-registry-packages"},"_id":"@textile/threads-client@2.1.0","version":"2.1.0"}