{"_id":"@claudiobogossian/sigweb-lite-front-end","name":"@claudiobogossian/sigweb-lite-front-end","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@claudiobogossian/sigweb-lite-front-end","version":"1.0.0","description":"swagger client for @claudiobogossian/sigweb-lite-front-end","author":{"name":"Swagger Codegen Contributors"},"keywords":["swagger-client"],"license":"Unlicense","peerDependencies":{"@angular/core":"^10.2.3","@angular/common":"^10.2.3","@angular/compiler":"^10.2.3","core-js":"^2.4.0","reflect-metadata":"^0.1.3","rxjs":"^6.5.0"},"devDependencies":{"@angular/compiler-cli":"^10.2.3","@angular/core":"^10.2.3","@angular/common":"^10.2.3","@angular/compiler":"^10.2.3","@angular/platform-browser":"^10.2.3","ng-packagr":"^5.4.0","reflect-metadata":"^0.1.3","rxjs":"^6.5.0","tsickle":"^0.35.0","typescript":"^3.9.2","zone.js":"^0.9.1"},"main":"bundles/claudiobogossian-sigweb-lite-front-end.umd.js","module":"fesm5/claudiobogossian-sigweb-lite-front-end.js","es2015":"fesm2015/claudiobogossian-sigweb-lite-front-end.js","esm5":"esm5/claudiobogossian-sigweb-lite-front-end.js","esm2015":"esm2015/claudiobogossian-sigweb-lite-front-end.js","fesm5":"fesm5/claudiobogossian-sigweb-lite-front-end.js","fesm2015":"fesm2015/claudiobogossian-sigweb-lite-front-end.js","typings":"claudiobogossian-sigweb-lite-front-end.d.ts","metadata":"claudiobogossian-sigweb-lite-front-end.metadata.json","sideEffects":false,"dependencies":{"tslib":"^2.0.0"},"_id":"@claudiobogossian/sigweb-lite-front-end@1.0.0","_nodeVersion":"12.22.12","_npmVersion":"6.14.16","dist":{"integrity":"sha512-LG1Mc5TIKyjZmrk+y9Ypg7QmhIm1cafz3ZlrllEyb5Hr84CPILy/Dy7iLQe4jmoFVzoo8WPxUOHM+LR60j1BuQ==","shasum":"1a44a9992273ea5cdb1e4fbe9fee6bbc2ee5e2f4","tarball":"https://registry.npmjs.org/@claudiobogossian/sigweb-lite-front-end/-/sigweb-lite-front-end-1.0.0.tgz","fileCount":71,"unpackedSize":336728,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGr22yWubUY65wbHpcCHvuh+hRoa20kUfLzUcvV1T06xAiEA9LjgymKd0au9CxNkPUMak4tgBtdsZbVLxw63g39d5eQ="}]},"_npmUser":{"name":"claudiobogossian","email":"claudio.bogossian@gmail.com"},"directories":{},"maintainers":[{"name":"claudiobogossian","email":"claudio.bogossian@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sigweb-lite-front-end_1.0.0_1728595828602_0.03972606189556194"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-10T21:30:28.517Z","1.0.0":"2024-10-10T21:30:28.873Z","modified":"2024-10-10T21:30:29.131Z"},"maintainers":[{"name":"claudiobogossian","email":"claudio.bogossian@gmail.com"}],"description":"swagger client for @claudiobogossian/sigweb-lite-front-end","keywords":["swagger-client"],"author":{"name":"Swagger Codegen Contributors"},"license":"Unlicense","readme":"## @claudiobogossian/sigweb-lite-front-end@1.0.0\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### publishing\n\nFirst build the package than run ```npm publish dist``` (don't forget to specify the `dist` folder!)\n\n### consuming\n\nNavigate to the folder of your consuming project and run one of next commands.\n\n_published:_\n\n```\nnpm install @claudiobogossian/sigweb-lite-front-end@1.0.0 --save\n```\n\n_without publishing (not recommended):_\n\n```\nnpm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save\n```\n\nIt's important to take the tgz file, otherwise you'll get trouble with links on windows.  \n\n_using `npm link`:_\n\nIn PATH_TO_GENERATED_PACKAGE/dist:\n```\nnpm link\n```\n\nIn your project:\n```\nnpm link @claudiobogossian/sigweb-lite-front-end\n```\n\n__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.\nPlease refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround.\nPublished packages are not effected by this issue.\n\n\n#### General usage\n\nIn your Angular project:\n\n\n```\n// without configuring providers\nimport { ApiModule } from '@claudiobogossian/sigweb-lite-front-end';\nimport { HttpClientModule } from '@angular/common/http';\n\n\n@NgModule({\n    imports: [\n        ApiModule,\n        // make sure to import the HttpClientModule in the AppModule only,\n        // see https://github.com/angular/angular/issues/20575\n        HttpClientModule\n    ],\n    declarations: [ AppComponent ],\n    providers: [],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n```\n// configuring providers\nimport { ApiModule, Configuration, ConfigurationParameters } from '@claudiobogossian/sigweb-lite-front-end';\n\nexport function apiConfigFactory (): Configuration => {\n  const params: ConfigurationParameters = {\n    // set configuration parameters here.\n  }\n  return new Configuration(params);\n}\n\n@NgModule({\n    imports: [ ApiModule.forRoot(apiConfigFactory) ],\n    declarations: [ AppComponent ],\n    providers: [],\n    bootstrap: [ AppComponent ]\n})\nexport class AppModule {}\n```\n\n```\nimport { DefaultApi } from '@claudiobogossian/sigweb-lite-front-end';\n\nexport class AppComponent {\n\t constructor(private apiGateway: DefaultApi) { }\n}\n```\n\nNote: The ApiModule is restricted to being 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 { HttpClientModule } from '@angular/common/http';\n\n\n@NgModule({\n  imports: [\n    ApiModule,\n    OtherApiModule,\n    // make sure to import the HttpClientModule in the AppModule only,\n    // see https://github.com/angular/angular/issues/20575\n    HttpClientModule\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 '@claudiobogossian/sigweb-lite-front-end';\n\nbootstrap(AppComponent, [\n    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },\n]);\n```\nor\n\n```\nimport { BASE_PATH } from '@claudiobogossian/sigweb-lite-front-end';\n\n@NgModule({\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\n#### Using @angular/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 '@claudiobogossian/sigweb-lite-front-end';\nimport { environment } from '../environments/environment';\n\n@NgModule({\n  declarations: [\n    AppComponent\n  ],\n  imports: [ ],\n  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],\n  bootstrap: [ AppComponent ]\n})\nexport class AppModule { }\n```  \n","readmeFilename":"README.md"}