{"_id":"@curo__/nestjs-algolia","_rev":"4-c35d787dab455f49c4486b8b795ed705","name":"@curo__/nestjs-algolia","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.0":{"name":"@curo__/nestjs-algolia","version":"1.0.0","description":"The algolia NestJS module based on the official algolia package","main":"index.js","scripts":{"precommit":"lint-staged","build":"shx rm -rf dist && tsc -p tsconfig.json","prepare":"npm run build","test":"jest"},"repository":{"type":"git","url":"git://github.com/Curo-Dev/nestjs-algolia.git"},"keywords":["nestjs","nest","nodejs","typescript","algolia","algolia-search"],"author":{"name":"Fabian Vilers","email":"fabian.vilers@dev-one.com","url":"https://www.dev-one.com/"},"license":"MIT","bugs":{"url":"https://github.com/fvilers/nestjs-algolia/issues"},"homepage":"https://github.com/fvilers/nestjs-algolia#readme","dependencies":{"algoliasearch":"3.32.0"},"publishConfig":{"access":"public"},"devDependencies":{"@nestjs/common":"^10.2.8","@nestjs/core":"^10.2.8","@nestjs/testing":"^10.2.8","@types/algoliasearch":"3.30.5","@types/jest":"^27.0.2","@types/node":"^14.0.0","husky":"1.3.1","jest":"^27.2.5","lint-staged":"13.2.1","prettier":"1.16.4","reflect-metadata":"0.1.12","rxjs":"^7.1.0","shx":"0.3.3","ts-jest":"^27.0.5","typescript":"^4.0.0"},"peerDependencies":{"@nestjs/common":"^10.2.8"},"lint-staged":{"*.ts":["prettier --write"]},"jest":{"preset":"ts-jest","collectCoverage":true,"testEnvironment":"node"},"_id":"@curo__/nestjs-algolia@1.0.0","gitHead":"b9d741711c3a6edd60b36ad0dafff05defd9a77e","types":"./index.d.ts","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-mVUVmSDdsbH9ZtTt/9KzQx1D2O2KBEaD1Tt4LrW8xg374+EIs+Z7vCxymI07gpk98taerNMBi/r8vmeIeDCGHw==","shasum":"4c8361cc73207d5c14f648cf955321fb36694798","tarball":"https://registry.npmjs.org/@curo__/nestjs-algolia/-/nestjs-algolia-1.0.0.tgz","fileCount":24,"unpackedSize":25733,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAf12qPi5lhFsNgfh9BDK6MnIRNkBpnLumkRNS4mFEqvAiBHIR59eoKFnJBCSFkbclu4w5uH0vDZCVnDyVgcrorv/g=="}]},"_npmUser":{"name":"curo-dev","email":"admin@curo.xyz"},"directories":{},"maintainers":[{"name":"curo-dev","email":"admin@curo.xyz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestjs-algolia_1.0.0_1699777473642_0.464941490044374"},"_hasShrinkwrap":false},"1.0.1":{"name":"@curo__/nestjs-algolia","version":"1.0.1","description":"The algolia NestJS module based on the official algolia package","main":"index.js","scripts":{"precommit":"lint-staged","build":"shx rm -rf dist && tsc -p tsconfig.json","prepare":"npm run build","test":"jest"},"repository":{"type":"git","url":"git://github.com/Curo-Dev/nestjs-algolia.git"},"keywords":["nestjs","nest","nodejs","typescript","algolia","algolia-search"],"author":{"name":"Fabian Vilers","email":"fabian.vilers@dev-one.com","url":"https://www.dev-one.com/"},"license":"MIT","bugs":{"url":"https://github.com/fvilers/nestjs-algolia/issues"},"homepage":"https://github.com/fvilers/nestjs-algolia#readme","dependencies":{"algoliasearch":"3.32.0"},"publishConfig":{"access":"public"},"devDependencies":{"@nestjs/common":"^10.2.8","@nestjs/core":"^10.2.8","@nestjs/testing":"^10.2.8","@types/algoliasearch":"3.30.5","@types/jest":"^27.0.2","@types/node":"^14.0.0","husky":"1.3.1","jest":"^27.2.5","lint-staged":"13.2.1","prettier":"1.16.4","reflect-metadata":"0.1.12","rxjs":"^7.1.0","shx":"0.3.3","ts-jest":"^27.0.5","typescript":"^4.0.0"},"peerDependencies":{"@nestjs/common":"^10.2.8"},"lint-staged":{"*.ts":["prettier --write"]},"jest":{"preset":"ts-jest","collectCoverage":true,"testEnvironment":"node"},"_id":"@curo__/nestjs-algolia@1.0.1","gitHead":"b9d741711c3a6edd60b36ad0dafff05defd9a77e","types":"./index.d.ts","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-HdjtfwWkWaykPV0KRZ2HpQOnCCtAiongt4FqIukCoKeI4sE+hwk1p4zUn0AhVfy9NopL7OtOhmdIm81Wv7XTLw==","shasum":"90d02259fcbf923c963bb905410111f4c346a27e","tarball":"https://registry.npmjs.org/@curo__/nestjs-algolia/-/nestjs-algolia-1.0.1.tgz","fileCount":24,"unpackedSize":25359,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDG12tTlbK2CfJDLD2rCcS4jGW4z71+NNsyTavtsYC1CQIhAJIMHKx5296A2kpJeloEQX/xW8+Lc/8BA1EKSLh0Y9b+"}]},"_npmUser":{"name":"curo-dev","email":"admin@curo.xyz"},"directories":{},"maintainers":[{"name":"curo-dev","email":"admin@curo.xyz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestjs-algolia_1.0.1_1699835460294_0.7602890078096061"},"_hasShrinkwrap":false},"1.0.2":{"name":"@curo__/nestjs-algolia","version":"1.0.2","description":"The algolia NestJS module based on the official algolia package","main":"index.js","scripts":{"precommit":"lint-staged","build":"shx rm -rf dist && tsc -p tsconfig.json","prepare":"npm run build","test":"jest"},"repository":{"type":"git","url":"git://github.com/Curo-Dev/nestjs-algolia.git"},"keywords":["nestjs","nest","nodejs","typescript","algolia","algolia-search"],"author":{"name":"Fabian Vilers","email":"fabian.vilers@dev-one.com","url":"https://www.dev-one.com/"},"license":"MIT","bugs":{"url":"https://github.com/curo-dev/nestjs-algolia/issues"},"homepage":"https://github.com/curo-dev/nestjs-algolia#readme","dependencies":{"algoliasearch":"3.32.0"},"publishConfig":{"access":"public"},"devDependencies":{"@nestjs/common":"^10.2.8","@nestjs/core":"^10.2.8","@nestjs/testing":"^10.2.8","@types/algoliasearch":"3.30.5","@types/jest":"^27.0.2","@types/node":"^14.0.0","husky":"1.3.1","jest":"^27.2.5","lint-staged":"13.2.1","prettier":"1.16.4","reflect-metadata":"0.1.12","rxjs":"^7.1.0","shx":"0.3.3","ts-jest":"^27.0.5","typescript":"^4.0.0"},"peerDependencies":{"@nestjs/common":"^10.2.8"},"lint-staged":{"*.ts":["prettier --write"]},"jest":{"preset":"ts-jest","collectCoverage":true,"testEnvironment":"node"},"_id":"@curo__/nestjs-algolia@1.0.2","gitHead":"b9d741711c3a6edd60b36ad0dafff05defd9a77e","types":"./index.d.ts","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-OLAUVnwVR12qb0/fG5skRWkOvo3Wb9INJZGvarxcPr32DWKraBIfgcn//6rrgmnD9Ey7/rUhYKMm1xVWxpKLlg==","shasum":"5558baf2f190edc7661dace6b52dd9afa3fefa34","tarball":"https://registry.npmjs.org/@curo__/nestjs-algolia/-/nestjs-algolia-1.0.2.tgz","fileCount":24,"unpackedSize":25361,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICbyeTDDHAEByDT1hLKUWMLd9+kHi+d7I6nbgoGoUsfmAiApKIeCYabt3bDxqdMlebiNTU6qfP5318Rlswvnxsqoug=="}]},"_npmUser":{"name":"curo-dev","email":"admin@curo.xyz"},"directories":{},"maintainers":[{"name":"curo-dev","email":"admin@curo.xyz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestjs-algolia_1.0.2_1699835551131_0.0925923014042409"},"_hasShrinkwrap":false},"1.0.3":{"name":"@curo__/nestjs-algolia","version":"1.0.3","description":"The algolia NestJS module based on the official algolia package","main":"index.js","scripts":{"precommit":"lint-staged","build":"shx rm -rf dist && tsc -p tsconfig.json","prepare":"npm run build","test":"jest"},"repository":{"type":"git","url":"git://github.com/Curo-Dev/nestjs-algolia.git"},"keywords":["nestjs","nest","nodejs","typescript","algolia","algolia-search"],"author":{"name":"Fabian Vilers","email":"fabian.vilers@dev-one.com","url":"https://www.dev-one.com/"},"license":"MIT","bugs":{"url":"https://github.com/Curo-Dev/nestjs-algolia/issues"},"homepage":"https://github.com/Curo-Dsev/nestjs-algolia#readme","dependencies":{"algoliasearch":"3.32.0"},"publishConfig":{"access":"public"},"devDependencies":{"@nestjs/common":"^10.2.8","@nestjs/core":"^10.2.8","@nestjs/testing":"^10.2.8","@types/algoliasearch":"3.30.5","@types/jest":"^27.0.2","@types/node":"^14.0.0","husky":"1.3.1","jest":"^27.2.5","lint-staged":"13.2.1","prettier":"1.16.4","reflect-metadata":"0.1.12","rxjs":"^7.1.0","shx":"0.3.3","ts-jest":"^27.0.5","typescript":"^4.0.0"},"peerDependencies":{"@nestjs/common":"^10.2.8"},"lint-staged":{"*.ts":["prettier --write"]},"jest":{"preset":"ts-jest","collectCoverage":true,"testEnvironment":"node"},"_id":"@curo__/nestjs-algolia@1.0.3","gitHead":"ed526ebbc7a34e207a797df47e300557b6f4646a","types":"./index.d.ts","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-8bSnScs2KiHjrrRiE98aGgFN5moxArEEzbktnR1WokdYMHbRboHMOgNflLPsATM8dh1pLKxZj+sX8FcTx+Ssvw==","shasum":"a750c93741e8ac921ece968006ed0158b9daebd3","tarball":"https://registry.npmjs.org/@curo__/nestjs-algolia/-/nestjs-algolia-1.0.3.tgz","fileCount":24,"unpackedSize":25362,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDdMIZORTif+L+JcYiKvtmriR5PiKwaqxexbErq5OX0yQIhAMZiL/ZVIaN6/BcTyZ9eQJW//VDM3mfwwEvnovu3evMj"}]},"_npmUser":{"name":"curo-dev","email":"admin@curo.xyz"},"directories":{},"maintainers":[{"name":"curo-dev","email":"admin@curo.xyz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestjs-algolia_1.0.3_1699835614591_0.623931983690347"},"_hasShrinkwrap":false},"1.0.4":{"name":"@curo__/nestjs-algolia","version":"1.0.4","description":"The algolia NestJS module based on the official algolia package","main":"index.js","scripts":{"precommit":"lint-staged","build":"shx rm -rf dist && tsc -p tsconfig.json","prepare":"npm run build","test":"jest"},"repository":{"type":"git","url":"git://github.com/Curo-Dev/nestjs-algolia.git"},"keywords":["nestjs","nest","nodejs","typescript","algolia","algolia-search"],"author":{"name":"Fabian Vilers","email":"fabian.vilers@dev-one.com","url":"https://www.dev-one.com/"},"license":"MIT","bugs":{"url":"https://github.com/Curo-Dev/nestjs-algolia/issues"},"homepage":"https://github.com/Curo-Dev/nestjs-algolia#readme","dependencies":{"algoliasearch":"3.32.0"},"publishConfig":{"access":"public"},"devDependencies":{"@nestjs/common":"^10.2.8","@nestjs/core":"^10.2.8","@nestjs/testing":"^10.2.8","@types/algoliasearch":"3.30.5","@types/jest":"^27.0.2","@types/node":"^14.0.0","husky":"1.3.1","jest":"^27.2.5","lint-staged":"13.2.1","prettier":"1.16.4","reflect-metadata":"0.1.12","rxjs":"^7.1.0","shx":"0.3.3","ts-jest":"^27.0.5","typescript":"^4.0.0"},"peerDependencies":{"@nestjs/common":"^10.2.8"},"lint-staged":{"*.ts":["prettier --write"]},"jest":{"preset":"ts-jest","collectCoverage":true,"testEnvironment":"node"},"_id":"@curo__/nestjs-algolia@1.0.4","gitHead":"ed526ebbc7a34e207a797df47e300557b6f4646a","types":"./index.d.ts","_nodeVersion":"20.9.0","_npmVersion":"10.1.0","dist":{"integrity":"sha512-P+zdjQ6iZJaU/BrMA6tMHHPCrZ2fleHRjnBYKiiWByAFDDfImK0ycjmPO6EeQVkkBgGhW5T5ozEnhULC2kH7/Q==","shasum":"58d2f5fcccc343a0a8e03277cb92069660f1ac1f","tarball":"https://registry.npmjs.org/@curo__/nestjs-algolia/-/nestjs-algolia-1.0.4.tgz","fileCount":24,"unpackedSize":25361,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFFGE3HWdc1fmtEb9KXH/Pojs/k3f9l7MysXY8JCnFpcAiBdIcBpgSCEP+vS1kfLJwxOUmkJtvuhK6nxunamHjR5Pg=="}]},"_npmUser":{"name":"curo-dev","email":"admin@curo.xyz"},"directories":{},"maintainers":[{"name":"curo-dev","email":"admin@curo.xyz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nestjs-algolia_1.0.4_1699835638177_0.006078426540661486"},"_hasShrinkwrap":false}},"time":{"created":"2023-11-12T08:24:33.551Z","1.0.0":"2023-11-12T08:24:33.841Z","modified":"2023-11-13T00:33:58.590Z","1.0.1":"2023-11-13T00:31:00.458Z","1.0.2":"2023-11-13T00:32:31.343Z","1.0.3":"2023-11-13T00:33:34.818Z","1.0.4":"2023-11-13T00:33:58.398Z"},"maintainers":[{"name":"curo-dev","email":"admin@curo.xyz"}],"description":"The algolia NestJS module based on the official algolia package","homepage":"https://github.com/Curo-Dev/nestjs-algolia#readme","keywords":["nestjs","nest","nodejs","typescript","algolia","algolia-search"],"repository":{"type":"git","url":"git://github.com/Curo-Dev/nestjs-algolia.git"},"author":{"name":"Fabian Vilers","email":"fabian.vilers@dev-one.com","url":"https://www.dev-one.com/"},"bugs":{"url":"https://github.com/Curo-Dev/nestjs-algolia/issues"},"license":"MIT","readme":"# nestjs-algolia\n\nThe algolia NestJS module based on the official algolia package by <a href=\"https://github.com/fvilers\">@fvilers</a>\n\n## How to install\n\n```\nnpm install @curo__/nestjs-algolia\n```\n\n## How to use\n\n**Register the module**\n\n```\nimport { AlgoliaModule } from 'nestjs-algolia';\n\n@Module({\n  imports: [\n    AlgoliaModule.register({\n      applicationId: 'YOUR_APPLICATION_ID',\n      apiKey: 'YOUR_API_KEY',\n    }),\n  ],\n})\nexport class AppModule {}\n```\n\n**Inject the service**\n\n```\nimport { AlgoliaService } from 'nestjs-algolia';\n\n@Injectable()\nexport class AppService {\n  constructor(private readonly algoliaService: AlgoliaService) {}\n\n  addRecordToIndex(\n    indexName: string,\n    record: any,\n  ): Promise<algoliasearch.Task> {\n    const index = this.algoliaService.initIndex(indexName);\n\n    return index.addObject(record);\n  }\n}\n```\n\n## Async options\n\nQuite often you might want to asynchronously pass your module options instead of passing them beforehand. In such case, use `registerAsync()` method, that provides a couple of various ways to deal with async data.\n\n### Use factory\n\n```\nAlgoliaModule.registerAsync({\n  useFactory: () => ({\n    applicationId: 'YOUR_APPLICATION_ID',\n    apiKey: 'YOUR_API_KEY',\n  }),\n});\n```\n\nObviously, our factory behaves like every other one (might be `async` and is able to inject dependencies through `inject`).\n\n```\nAlgoliaModule.registerAsync({\n  imports: [ConfigModule],\n  useFactory: async (configService: ConfigService) => ({\n    applicationId: configService.getString('ALGOLIA_APPLICATION_ID'),\n    apiKey: configService.getString('ALGOLIA_API_KEY'),\n  }),\n  inject: [ConfigService],\n}),\n```\n\n### Use class\n\n```\nAlgoliaModule.registerAsync({\n  useClass: AlgoliaConfigService,\n});\n```\n\nAbove construction will instantiate `AlgoliaConfigService` inside `AlgoliaModule` and will leverage it to create options object.\n\n```\nclass AlgoliaConfigService implements AlgoliaOptionsFactory {\n  createAlgoliaOptions(): AlgoliaModuleOptions {\n    return {\n      applicationId: 'YOUR_APPLICATION_ID',\n      apiKey: 'YOUR_API_KEY',\n    };\n  }\n}\n```\n\n### Use existing\n\n```\nAlgoliaModule.registerAsync({\n  imports: [ConfigModule],\n  useExisting: ConfigService,\n}),\n```\n\nIt works the same as `useClass` with one critical difference - `AlgoliaModule` will lookup imported modules to reuse already created `ConfigService`, instead of instantiating it on its own.\n\n## Versions\n\nUse the following table to match this module with the NestJS version\n\n| @curo\\_\\_/nestjs-algolia | nestjs |\n| ------------------------ | ------ |\n| 1.x                      | 10.x   |\n","readmeFilename":"README.md"}