{"_id":"@dapore/sok","_rev":"1-ca04d9a9a7bd5c79cdde84ce4b38be01","name":"@dapore/sok","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@dapore/sok","version":"1.0.0","description":"Turn data into a searchable database on the AWS S3 service","main":"src/index.js","module":"src/index.js","author":{"name":"Rubin Apore"},"license":"MIT","publishConfig":{"access":"public"},"scripts":{"lint":"standard","test":"yarn run lint; ava","report":"yarn run lint;nyc --reporter=html --reporter=text ava"},"husky":{"hooks":{"pre-commit":"npm test","post-checkout":"echo \"Changed branch\""}},"devDependencies":{"@babel/preset-env":"^7.14.8","ava":"^3.15.0","babel-core":"^6.26.3","babel-loader":"^8.2.2","esm":"^3.2.25","husky":"^7.0.1","nyc":"^15.1.0","standard":"^16.0.3"},"dependencies":{"@meltwater/phi":"^4.0.0","awaiting":"^3.0.0","aws-sdk":"^2.958.0","debug":"^4.3.2","uuid":"^8.3.2"},"repository":{"type":"git","url":"git+https://github.com/dapore/sok.git"},"keywords":["Search","AWS","S3","Indexes"],"bugs":{"url":"https://github.com/dapore/sok/issues"},"homepage":"https://github.com/dapore/sok#readme","gitHead":"2e4b2d54ee74372bac584f3554d26662a1f6e976","_id":"@dapore/sok@1.0.0","_nodeVersion":"14.9.0","_npmVersion":"7.9.0","dist":{"integrity":"sha512-CDTpnaWo78QzoQpVtL+sDgPJj9QC4pQ0KFugeln6W1WV4OvSXOrI0lB/k/Bmu9+HQcuw24pIlf8XbeeW98yVUA==","shasum":"0883eb383474d188f7704209b5cf82f2059ec4f6","tarball":"https://registry.npmjs.org/@dapore/sok/-/sok-1.0.0.tgz","fileCount":15,"unpackedSize":254860,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhCUyhCRA9TVsSAnZWagAAY/wP/j20ifAPJELG3KDqoGK+\nUqRhgn9p/97UDGjUs7VTjIh27KeyFnAzy2dLX5qQQ0/9/mbR+FF54mmUFwWx\n3fnTcu05xpfrQNrkPeP0nzdgJnC7R6mdcj+dX/0fx43mEp9Au5LIBgjRiADf\nSoEmsJPsEsEeQJ2Kje2ZsZ2HXfU71YKSMB1SRNN0wKLS7imLaBCd/zpXA64S\nyJQrLnv8VXEoBUpH7cnWjYBqmmftXAmlZTBmeAUjboGgXy9gBD09mzLIclal\nFR/lf6bRLvgwsfZc+pLGf7Xm+yB+YbE2rj5VrgH9xvae59f80QKPGe/BOYdN\nAijBottonZCMwoLNos65WJ6J3sNbPLxCqARffapNY+WrJZxBGyaBLtEdPAbq\nq8sE225C6ZeGTxmKGlqWM2c1P1bpMUf1iK7U4AZqEzQWz/0qAkzl6SSotB/j\nzMlTh+WB7KxgTrWFC3vcWMVSJ4/A2VAROYro/8RS6oKk3hpQExT/qcmgWxh2\nfqQnIrj3I3Ax9U9ztotTkdTilru1h5u/iRc1R0cVst20IFFd94xV0J90aZFA\nKfgYz6TyC40b8aEgXzgu8bGv96drenLlVvY+vQ1XimZNABou4WhtkEXUF3nA\n481ri0EoYIe5ombq5XPsPabcX8lQkSxXK6DY8Gb6/FbO0+gzx5PC5NfGT94Y\nEAes\r\n=HqZh\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIB2xOi/nukyXlLw7xmfducR7byI3SJVsWKDtBja3HwriAiEAsB7C4HgP10Kturla0rhpXsLJZk+ICy1XhukwvLagmeM="}]},"_npmUser":{"name":"dapore","email":"rubin.apore@gmail.com"},"directories":{},"maintainers":[{"name":"dapore","email":"rubin.apore@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sok_1.0.0_1627999393404_0.8292303966213284"},"_hasShrinkwrap":false}},"time":{"created":"2021-08-03T14:03:13.326Z","1.0.0":"2021-08-03T14:03:13.771Z","modified":"2022-04-05T02:43:50.964Z"},"maintainers":[{"name":"dapore","email":"rubin.apore@gmail.com"}],"description":"Turn data into a searchable database on the AWS S3 service","homepage":"https://github.com/dapore/sok#readme","keywords":["Search","AWS","S3","Indexes"],"repository":{"type":"git","url":"git+https://github.com/dapore/sok.git"},"author":{"name":"Rubin Apore"},"bugs":{"url":"https://github.com/dapore/sok/issues"},"license":"MIT","readme":"# Search Engine powered by AWS S3\n\n## Description\n\nThis library will automatically build an index for your data on AWS S3\n\n### Usage\n\n```js\nimport createSearchClient from '@dapore/sok'\n\nconst s3Config = {\n  credential: {\n    accessKeyId: '*********', // AWS access key id with S3 read and write access\n    secretAccessKey: '*******' // AWS secret key\n  },\n  bucket: 'find-service-data', // a bucket accessible by the IAM user whose credentials have been provided above. You will have to create this bucket manually.\n  region: 'us-east-1' // The region of the s3 bucket\n}\n\nconst searchOptions = {\n  rawPath: 'raw',\n  variant: 'variant',\n  caseSensitive: true,\n}\nconst searchClient = createSearchClient({ s3: s3Config, searchOptions })\n\nconst indexName = 'student-index' // This is the index a\n\nconst sampleItemToBeIndexed = {\n  symbol: 'AED',\n  name: 'United Arab Emirates Dirham',\n  rounding: 0,\n  code: 'AED',\n  name_plural: 'UAE dirhams'\n}\n// Async/Await is supported out of the box\nawait index.addObjects(sampleItemToBeIndexed) // Add an item to the index\nawait index.search('united') // this will return matches results in an acceptable amount of time\nawait index.clean() // This will delete all items on the index\n\n```\n### Tasks\n\nPrimary development tasks are defined under `scripts` in `package.json`\nand available via `yarn run`.\nView them with\n\n```\n$ yarn run\n```\n## License\n\nThis npm package is Copyright (c) 2016-2017 Dapore Global.\n\n## Warranty\n\nThis software is provided by the copyright holders and contributors 'as is' and\nany express or implied warranties, including, but not limited to, the implied\nwarranties of merchantability and fitness for a particular purpose are\ndisclaimed. In no event shall the copyright holder or contributors be liable for\nany direct, indirect, incidental, special, exemplary, or consequential damages\n(including, but not limited to, procurement of substitute goods or services;\nloss of use, data, or profits; or business interruption) however caused and on\nany theory of liability, whether in contract, strict liability, or tort\n(including negligence or otherwise) arising in any way out of the use of this\nsoftware, even if advised of the possibility of such damage.\n","readmeFilename":"README.md"}