{"_id":"@elsikora/dapigate-sdk-nestjs","_rev":"4-b8eb0646d602e73b72f36c8caa95edb3","name":"@elsikora/dapigate-sdk-nestjs","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@elsikora/dapigate-sdk-nestjs","version":"1.0.0","keywords":["sdk","openapi","client","rest","api","nestjs"],"author":{"name":"ElsiKora"},"license":"MIT","_id":"@elsikora/dapigate-sdk-nestjs@1.0.0","maintainers":[{"name":"michail-elsikora","email":"michail.developer@elsikora.com"},{"name":"dmitry-elsikora","email":"dmitry.developer@elsikora.com"},{"name":"admin-elsikora","email":"admin@elsikora.com"}],"homepage":"https://github.com/ElsiKora/DApiGate-SDK-NestJS#readme","bugs":{"url":"https://github.com/ElsiKora/DApiGate-SDK-NestJS/issues"},"dist":{"shasum":"8744d5a5d4a05bbab4c277a3f8e918c7d730b54a","tarball":"https://registry.npmjs.org/@elsikora/dapigate-sdk-nestjs/-/dapigate-sdk-nestjs-1.0.0.tgz","fileCount":52,"integrity":"sha512-xTx8B1S7Deg0meoiQ7ubjqQYmoSVV1KAjL8tGm0kB9RERl3qEppTRHSqHLPvMf83HHTJFHmKIEW4IVcNAysLNA==","signatures":[{"sig":"MEYCIQDdk/vNilVe66hCiR86btjT2TjMviDdBiL2LnnTn3/2LgIhAKOWVYoqwZQ1aTvc1If8ClHpv4WaiGxx/E9EgWs7/a7r","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":153149},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"bbda9c9d9009d9e4ece53581918f3e0484f73614","scripts":{"lint":"eslint ./src --ext .ts,.tsx,.json,.yml --fix","build":"nest build","patch":"npx changeset","format":"prettier --write \"src/**/*.ts\" \"src/**/*.json\" \".github/**/*.yml\"","release":"npm install && npm run build && changeset publish","prebuild":"rimraf dist","patch:release":"npx changeset version"},"_npmUser":{"name":"admin-elsikora","email":"admin@elsikora.com"},"repository":{"url":"git+ssh://git@github.com/ElsiKora/DApiGate-SDK-NestJS.git","type":"git"},"_npmVersion":"10.2.4","description":"NestJS SDK for DApiGate","directories":{},"_nodeVersion":"20.11.1","dependencies":{"rxjs":"^7.8.1","rimraf":"^5.0.5","@nestjs/core":"^10.3.4","@nestjs/axios":"^3.0.2","@nestjs/common":"^10.3.4","@changesets/cli":"^2.27.1","reflect-metadata":"^0.2.1","@nestjs/platform-express":"^10.3.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"prettier":"^3.2.5","typescript":"^5.4.3","@nestjs/cli":"^10.3.2","@types/node":"^20.11.30","@types/express":"^4.17.21","@nestjs/testing":"~10.3.4","@elsikora/eslint-config":"^2.0.6"},"_npmOperationalInternal":{"tmp":"tmp/dapigate-sdk-nestjs_1.0.0_1711068933576_0.5125495275826528","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@elsikora/dapigate-sdk-nestjs","version":"1.0.1","keywords":["sdk","openapi","client","rest","api","nestjs"],"author":{"name":"ElsiKora"},"license":"MIT","_id":"@elsikora/dapigate-sdk-nestjs@1.0.1","maintainers":[{"name":"michail-elsikora","email":"michail.developer@elsikora.com"},{"name":"dmitry-elsikora","email":"dmitry.developer@elsikora.com"},{"name":"admin-elsikora","email":"admin@elsikora.com"}],"homepage":"https://github.com/ElsiKora/DApiGate-SDK-NestJS#readme","bugs":{"url":"https://github.com/ElsiKora/DApiGate-SDK-NestJS/issues"},"dist":{"shasum":"81952907c75839c29609f896e2764a0a484defb2","tarball":"https://registry.npmjs.org/@elsikora/dapigate-sdk-nestjs/-/dapigate-sdk-nestjs-1.0.1.tgz","fileCount":55,"integrity":"sha512-FbaexE3zjoDpbtm6Rm65DL0iz/316WcnubLmQaKPa0s1G2DKJqAQ6iGS+YPWr32KPxeQ0cLWsq3Ew5RhzbUCjQ==","signatures":[{"sig":"MEYCIQDPkbY00U4+chmcue/M1oNUG3eJhzVbn4BkpbtDi44gdwIhAO7kFImZlvmGLknJ2nLPI/IZBCdp1VtxGgR8aJuZ8UXw","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":154090},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"a6bec3d444b653a4949ddf6e0cd797fd904f9408","scripts":{"lint":"eslint ./src --ext .ts,.tsx,.json,.yml --fix","build":"nest build","patch":"npx changeset","format":"prettier --write \"src/**/*.ts\" \"src/**/*.json\" \".github/**/*.yml\"","release":"npm install && npm run build && changeset publish","prebuild":"rimraf dist","patch:release":"npx changeset version"},"_npmUser":{"name":"admin-elsikora","email":"admin@elsikora.com"},"repository":{"url":"git+ssh://git@github.com/ElsiKora/DApiGate-SDK-NestJS.git","type":"git"},"_npmVersion":"10.2.4","description":"NestJS SDK for DApiGate","directories":{},"_nodeVersion":"20.11.1","dependencies":{"rxjs":"^7.8.1","rimraf":"^5.0.5","@nestjs/core":"^10.3.4","@nestjs/axios":"^3.0.2","@nestjs/common":"^10.3.4","@changesets/cli":"^2.27.1","reflect-metadata":"^0.2.1","@nestjs/platform-express":"^10.3.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"prettier":"^3.2.5","typescript":"^5.4.3","@nestjs/cli":"^10.3.2","@types/node":"^20.11.30","@types/express":"^4.17.21","@nestjs/testing":"~10.3.4","@elsikora/eslint-config":"^2.0.6"},"_npmOperationalInternal":{"tmp":"tmp/dapigate-sdk-nestjs_1.0.1_1711072486879_0.1808486188690508","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@elsikora/dapigate-sdk-nestjs","version":"1.1.0","keywords":["sdk","openapi","client","rest","api","nestjs"],"author":{"name":"ElsiKora"},"license":"MIT","_id":"@elsikora/dapigate-sdk-nestjs@1.1.0","maintainers":[{"name":"michail-elsikora","email":"michail.developer@elsikora.com"},{"name":"dmitry-elsikora","email":"dmitry.developer@elsikora.com"},{"name":"admin-elsikora","email":"admin@elsikora.com"}],"homepage":"https://github.com/ElsiKora/DApiGate-SDK-NestJS#readme","bugs":{"url":"https://github.com/ElsiKora/DApiGate-SDK-NestJS/issues"},"dist":{"shasum":"bc2a3daad9da515faf47e97716e6c3fe4c00fbee","tarball":"https://registry.npmjs.org/@elsikora/dapigate-sdk-nestjs/-/dapigate-sdk-nestjs-1.1.0.tgz","fileCount":61,"integrity":"sha512-Ei61BxqvaP0POdYVF4l/dMn+Ds/6j3QmCAfry5xuxasQF4crg+n0Bnn6DM+GseDiIFJWEVyGE1MSoMI6WaNyFA==","signatures":[{"sig":"MEUCIGx6tN/lhQKRwig+8fGuTeLIRlKRyrNBE8OYIr2WKadbAiEAvM8ZRFbnrEhCpoG5JjbBj0ISxqv0P/45comE7+sB7rM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":160562},"main":"dist/index.js","types":"dist/index.d.ts","gitHead":"61474dc827aa1a176b6302273a2ea0214cd12063","scripts":{"lint":"eslint ./src --ext .ts,.tsx,.json,.yml --fix && eslint ./*.json --fix","build":"nest build","patch":"npx changeset","format":"prettier --write \"src/**/*.ts\" \"src/**/*.json\" \".github/**/*.yml\"","release":"npm install && npm run build && changeset publish","prebuild":"rimraf dist","patch:release":"npx changeset version"},"_npmUser":{"name":"admin-elsikora","email":"admin@elsikora.com"},"repository":{"url":"git+ssh://git@github.com/ElsiKora/DApiGate-SDK-NestJS.git","type":"git"},"_npmVersion":"10.2.4","description":"NestJS SDK for DApiGate","directories":{},"_nodeVersion":"20.11.1","dependencies":{"rxjs":"^7.8.1","rimraf":"^5.0.5","@nestjs/core":"^10.3.4","@nestjs/axios":"^3.0.2","@nestjs/common":"^10.3.4","@changesets/cli":"^2.27.1","reflect-metadata":"^0.2.1","@nestjs/platform-express":"^10.3.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"prettier":"^3.2.5","typescript":"^5.4.3","@nestjs/cli":"^10.3.2","@types/node":"^20.11.30","@types/express":"^4.17.21","@nestjs/testing":"~10.3.4","@elsikora/eslint-config":"^2.0.7"},"_npmOperationalInternal":{"tmp":"tmp/dapigate-sdk-nestjs_1.1.0_1711220314921_0.18382678510613437","host":"s3://npm-registry-packages"}}},"time":{"created":"2024-03-22T00:55:33.455Z","modified":"2024-12-20T12:12:09.993Z","1.0.0":"2024-03-22T00:55:33.729Z","1.0.1":"2024-03-22T01:54:47.036Z","1.1.0":"2024-03-23T18:58:35.107Z"},"bugs":{"url":"https://github.com/ElsiKora/DApiGate-SDK-NestJS/issues"},"author":{"name":"ElsiKora"},"license":"MIT","homepage":"https://github.com/ElsiKora/DApiGate-SDK-NestJS#readme","keywords":["sdk","openapi","client","rest","api","nestjs"],"repository":{"url":"git+ssh://git@github.com/ElsiKora/DApiGate-SDK-NestJS.git","type":"git"},"description":"NestJS SDK for DApiGate","maintainers":[{"email":"dmitry@elsikora.com","name":"dmitryv_devops"},{"email":"michail.developer@elsikora.com","name":"michail-elsikora"},{"email":"admin@elsikora.com","name":"admin-elsikora"},{"email":"dmitry.developer@elsikora.com","name":"dmitry-elsikora"},{"email":"alexander.frontend@elsikora.com","name":"aleksandr-elsikora"}],"readme":"## DApiGate SDK NestJS\n\n### Building\n\nTo install the required dependencies and to build the typescript sources run:\n```\nnpm install\nnpm run build\n```\n\n#### General usage\n\nIn your Nestjs project:\n\n\n```\n// without configuring providers\nimport { ApiModule } from 'dapigate-sdk-nestjs';\nimport { HttpModule } from '@nestjs/axios';\n\n@Module({\n    imports: [\n        ApiModule,\n        HttpModule\n    ],\n    providers: []\n})\nexport class AppModule {}\n```\n\n```\n// configuring providers\nimport { ApiModule, Configuration, ConfigurationParameters } from 'dapigate-sdk-nestjs';\n\nexport function apiConfigFactory (): Configuration => {\n  const params: ConfigurationParameters = {\n    // set configuration parameters here.\n  }\n  return new Configuration(params);\n}\n\n@Module({\n    imports: [ ApiModule.forRoot(apiConfigFactory) ],\n    declarations: [ AppComponent ],\n    providers: [],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n```\nimport { DefaultApi } from 'dapigate-sdk-nestjs';\n\nexport class AppComponent {\n    constructor(private apiGateway: DefaultApi) { }\n}\n```\n\nNote: The ApiModule a dynamic module and instantiated once app wide.\nThis is to ensure that all services are treated as singletons.\n\n#### Using multiple swagger files / APIs / ApiModules\nIn order to use multiple `ApiModules` generated from different swagger files,\nyou can create an alias name when importing the modules\nin order to avoid naming conflicts:\n```\nimport { ApiModule } from 'my-api-path';\nimport { ApiModule as OtherApiModule } from 'my-other-api-path';\nimport { HttpModule } from '@nestjs/axios';\n\n@Module({\n  imports: [\n    ApiModule,\n    OtherApiModule,\n    HttpModule\n  ]\n})\nexport class AppModule {\n\n}\n```\n\n\n### Set service base path\nIf different than the generated base path, during app bootstrap, you can provide the base path to your service.\n\n```\nimport { BASE_PATH } from 'dapigate-sdk-nestjs';\n\nbootstrap(AppComponent, [\n    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },\n]);\n```\nor\n\n```\nimport { BASE_PATH } from 'dapigate-sdk-nestjs';\n\n@Module({\n    imports: [],\n    declarations: [ AppComponent ],\n    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n### Configuring the module with `forRootAsync`\n\nYou can also use the Nestjs Config Module/Service to configure your app with `forRootAsync`.\n\n```\n@Module({\n    imports: [\n      ApiModule.forRootAsync({\n        imports: [ConfigModule],\n        inject: [ConfigService],\n        useFactory: (config: ConfigService): Configuration => {\n          const params: ConfigurationParameters = {\n            // set configuration parameters here.\n            basePath: config.get('API_URL'),\n          };\n          return new Configuration(params);\n        },\n      })\n    ],\n    declarations: [ AppComponent ],\n    providers: [],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n#### Using @nestjs/cli\nFirst extend your `src/environments/*.ts` files by adding the corresponding base path:\n\n```\nexport const environment = {\n  production: false,\n  API_BASE_PATH: 'http://127.0.0.1:8080'\n};\n```\n\nIn the src/app/app.module.ts:\n```\nimport { BASE_PATH } from 'dapigate-sdk-nestjs';\nimport { environment } from '../environments/environment';\n\n@Module({\n  declarations: [\n    AppComponent\n  ],\n  imports: [ ],\n  providers: [\n    {\n      provide: 'BASE_PATH',\n      useValue: environment.API_BASE_PATH\n    }\n  ]\n})\nexport class AppModule { }\n```\n","readmeFilename":"README.md"}