{"bugs":{"url":"https://github.com/textileio/js-threads/issues"},"dist":{"shasum":"296d0a239286a5b822aa031fc49251e66ceab8f0","tarball":"https://registry.npmjs.org/@textile/threads-client/-/threads-client-1.4.0-alpha.5.tgz","fileCount":24,"integrity":"sha512-feNrUBg4IiozNSe3YM3qreCQbksbvaBSg8RMYP8mhHqP4aI9fFiQ28H1Jb0C48LctlIMI9kWHJozeymL5PY7Sg==","signatures":[{"sig":"MEYCIQCEcwMe35u/pXZP238s5r8IEvfKnxG/oKWs5hvDgWBVSwIhALN9FeecY5i78UsitmQ3xjggw/5E3L8nsv4yt5UXOKYU","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1177404,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf0SybCRA9TVsSAnZWagAAWA0QAJYTI0ipNdkG8SXnFQPZ\nBbr3aMOaRfGEqjJbLZ/QQxxx4kiGp7YoBPTkrdIJ2t7sM2ww6SnYcRqH2Pr7\ntZohdC3DC5aQilum6x3jcZjpqPAA/4M9FIp6Unu6YCTPdumnRC6eV06t416t\nVED5EoOgl7NcMSQ8PIdq4QPVTyQXS1YcFpb9aYPBfdfumdj7qexqjBOT3agR\nF+ZzG9bBP4VzA4Pvc1jaxpSYWOIK1injTNRsa5Eo8wjzugSQEAfQFgDs3m4z\nu1EJiNkrVM1Oe00jhOxREGJ8c6Yh4PXlOg6e6ljYw94VCqnqD1qqG7k9WJ69\nZ55umWo8PSHtN7TPPQ+PIripd461+SuTKblA3JjAmuIoXC8lg1mgVPBsgSYL\n3EDgkBo8rIao7MR93aG+4vVXeBBom7ZRGQ4ajv5GLc64TzqqtdLXFlK56y8C\nVsm+2LSMy46ZWM0w5tBr739PsVmKmSA615cejWeeJ7kZC4MdWmc1TYMvut20\nsrl91ezC8Cp2wcogEYGc4qNll4A9VmTV2HlccCcyaQ1FQKp6tbUR20SXR1uY\n5b4mWDHnS8QHpAB5A0M/tmomFQkguXfxqSmshudQ8+XFOQSmTe2d2MKeXPuQ\nAIYDD62Kzh8QTbwttR+nOl/4U4S8/0bKv5JMRJ5c0HjfTL9hW99BOiqoV3+t\nG14g\r\n=Y9YM\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":"16a30e180da5e8622556a449abf89d8cc33f2e3c","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":"asutula","email":"aaron@textile.io"},{"name":"carsonfarmer","email":"carson@textile.io"},{"name":"andrewxhill","email":"andrew@textile.io"},{"name":"sanderpick","email":"sanderpick@gmail.com"},{"name":"textileio","email":"sander@textile.io"}],"_nodeVersion":"14.15.1","dependencies":{"to-json-schema":"^0.2.5","@textile/crypto":"^2.0.0","@textile/context":"^0.10.0-alpha.5","@textile/security":"^0.7.0-alpha.5","@textile/multiaddr":"^0.4.0-alpha.3","@textile/threads-id":"^0.4.0-alpha.3","@types/to-json-schema":"^0.2.0","@textile/grpc-transport":"^0.3.0-alpha.3","@improbable-eng/grpc-web":"^0.13.0","@textile/threads-client-grpc":"^1.0.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/threads-client_1.4.0-alpha.5_1607543962850_0.6967499210355634","host":"s3://npm-registry-packages"},"_id":"@textile/threads-client@1.4.0-alpha.5","version":"1.4.0-alpha.5"}