@emilgroup/insurance-sdk-node 1.0.0 → 1.1.0

package/README.md

@@ -1,11 +1,6 @@
-## @emilgroup/insurance-sdk-node@1.0.0
+# Emil Insurance SDK for Nodejs
 
-This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
-
-Environment
-* Node.js
-* Webpack
-* Browserify
+This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated Node module can be used with Nodejs based applications.
 
 Language level
 * ES5 - you must have a Promises/A+ library installed
@@ -15,15 +10,20 @@ Module system
 * CommonJS
 * ES6 module system
 
-It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
+Although this package can be used in both TypeScript and JavaScript, it is intended to be used with TypeScript. The definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))
 
-### Consuming
+## Consuming
 
-navigate to the folder of your consuming project and run one of the following commands.
+Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/insurance-sdk-node@1.0.0 --save
+npm install @emilgroup/insurance-sdk-node@1.1.0 --save
+```
+or 
+```
+yarn add @emilgroup/insurance-sdk-node@1.1.0
 ```
+
 And then you can import `PoliciesApi`.
 
 ```ts
@@ -31,15 +31,32 @@ import { PoliciesApi } from '@emilgroup/insurance-sdk-node'
 
 const policiesApi = new PoliciesApi();
 ```
+## Credentials
+
+To use authentication protected endpoints, you have to first authorize. To do so, the easiest way is to provide a configuration file under `~/.emil/credentials` with the following content:
+
+```shell
+emil_username=XXXXX@XXXX.XXX
+emil_password=XXXXXXXXXXXXXX
+```
+
+It is also possible to provide environment variables instead:
+
+```shell
+export EMIL_USERNAME=XXXXX@XXXX.XXX
+export EMIL_PASSWORD=XXXXXXXXXXXXXX
+```
+
+## Example
 
-To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `PoliciesApi`:
+Here is a basic functionning example:
 
 ```ts
 async function listPolicies(): Promise<Void> {
     try {
         const policiesApi = new PoliciesApi();
 
-        await policiesApi.authorize('username', 'password');
+        await policiesApi.initialize(); // should be called only once per Api.
 
         const { data: { items } } = await policiesApi.listPolicies();
 

package/base.ts

@@ -17,9 +17,17 @@ import { Configuration } from "./configuration";
 // Some imports not used depending on template conditions
 // @ts-ignore
 import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
 
 export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
+const CONFIG_DIRECTORY = '.emil';
+const CONFIG_FILENAME = 'credentials';
+const KEY_USERNAME = 'emil_username';
+const KEY_PASSWORD = 'emil_password';
 
+const filePath = os.homedir() + path.sep + CONFIG_DIRECTORY + path.sep + CONFIG_FILENAME;
 /**
  *
  * @export
@@ -59,6 +67,8 @@ export interface RequestArgs {
  */
 export class BaseAPI {
     protected configuration: Configuration;
+    private username?: string;
+    private password?: string;
 
     constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
         if (configuration) {
@@ -70,51 +80,61 @@ export class BaseAPI {
             });
         }
 
-        axios.interceptors.response.use(
-            (res) => {
-                return res;
-            },
-            async (err) => {
-                const originalConfig = err.config;
-                if (err.response) {
-                    // Access Token was expired
-                    if (err.response.status === 401 && !originalConfig._retry) {
-                        originalConfig._retry = true;
-                        try {
-                            const tokenString = await this.refreshToken();
-                            const accessToken = `Bearer ${tokenString}`;
+        this.attachInterceptor(axios);
+    }
 
-                            const localVarHeaderParameter = {} as any;
-                            localVarHeaderParameter['Authorization'] = accessToken;
+    async initialize(env: Environment = Environment.Production) {
+        this.configuration.basePath = env;
 
-                            originalConfig.headers = {
-                                ...originalConfig.headers,
-                                ...localVarHeaderParameter,
-                            };
+        await this.loadCredentials();
 
-                            this.configuration.accessToken = accessToken;
+        if (this.username) {
+            await this.authorize(this.username, this.password);
+            this.password = null; // to avoid keeping password loaded in memory.
+        }
+    }
 
-                            return axios(originalConfig);
-                        } catch (_error) {
-                            if (_error.response && _error.response.data) {
-                                return Promise.reject(_error.response.data);
-                            }
-                            return Promise.reject(_error);
-                        }
-                    }
-                    if (err.response.status === 403 && err.response.data) {
-                        return Promise.reject(err.response.data);
-                    }
-                }
-                return Promise.reject(err);
-            }
-        );
+    private async loadCredentials() {
+        try {
+            await this.readConfigFile();
+        } catch (error) {
+            console.warn(`No credentials file found. Check that ${filePath} exists.`);
+        }
+
+        this.readEnvVariables();
+
+        if (!this.username) {
+            console.info(`No credentials found in credentials file or environment variables. Either provide some or use 
+                authorize() function.`);
+        }
     }
 
-    getConfiguration(): Configuration {
-        return this.configuration;
+    private async readConfigFile() {
+        const file = await fs.promises.readFile(filePath, 'utf-8');
+
+        const lines = file.split(os.EOL)
+            .filter(Boolean);
+
+        lines.forEach((line: string) => {
+            if (line.startsWith(KEY_USERNAME)) {
+                this.username = line.length > KEY_USERNAME.length + 1 ? line.substring(KEY_USERNAME.length + 1) : '';
+            } else if (line.startsWith(KEY_PASSWORD)) {
+                this.password = line.length > KEY_PASSWORD.length + 1 ? line.substring(KEY_PASSWORD.length + 1) : '';
+            }
+        });
     }
 
+    private readEnvVariables(): boolean {
+        if (process.env.EMIL_USERNAME) {
+            this.username = process.env.EMIL_USERNAME;
+            this.password = process.env.EMIL_PASSWORD || '';
+
+            return true;
+        }
+
+        return false;
+    }
+    
     selectEnvironment(env: Environment) {
         this.configuration.basePath = env;
     }
@@ -123,16 +143,16 @@ export class BaseAPI {
         const options: AxiosRequestConfig = {
             method: 'POST',
             url: `${this.configuration.basePath}/authservice/v1/login`,
-            headers: {'Content-Type': 'application/json'},
+            headers: { 'Content-Type': 'application/json' },
             data: {
-                username, 
+                username,
                 password,
             },
             withCredentials: true,
         };
 
         const response = await globalAxios.request<LoginClass>(options);
-        
+
         const { data: { accessToken } } = response;
         const refreshToken = this.extractRefreshToken(response)
 
@@ -152,10 +172,10 @@ export class BaseAPI {
             method: 'POST',
             url: `${this.configuration.basePath}/authservice/v1/refresh-token`,
             headers: {
-                'Content-Type': 'application/json', 
+                'Content-Type': 'application/json',
                 Cookie: refreshToken,
             },
-            data: {username: username},
+            data: { username: username },
             withCredentials: true,
         };
 
@@ -165,14 +185,60 @@ export class BaseAPI {
     }
 
     private extractRefreshToken(response: AxiosResponse): string {
-        if (response.headers && response.headers['set-cookie'] 
-                && response.headers['set-cookie'].length > 0) {
+        if (response.headers && response.headers['set-cookie']
+            && response.headers['set-cookie'].length > 0) {
 
             return `${response.headers['set-cookie'][0].split(';')[0]};`;
         }
 
         return '';
     }
+
+    getConfiguration(): Configuration {
+        return this.configuration;
+    }
+
+    private attachInterceptor(axios: AxiosInstance) {
+        axios.interceptors.response.use(
+            (res) => {
+                return res;
+            },
+            async (err) => {
+                const originalConfig = err.config;
+                if (err.response) {
+                    // Access Token was expired
+                    if (err.response.status === 401 && !originalConfig._retry) {
+                        originalConfig._retry = true;
+                        try {
+                            const tokenString = await this.refreshToken();
+                            const accessToken = `Bearer ${tokenString}`;
+
+                            const localVarHeaderParameter = {} as any;
+                            localVarHeaderParameter['Authorization'] = accessToken;
+
+                            originalConfig.headers = {
+                                ...originalConfig.headers,
+                                ...localVarHeaderParameter,
+                            };
+
+                            this.configuration.accessToken = accessToken;
+
+                            return axios(originalConfig);
+                        } catch (_error) {
+                            if (_error.response && _error.response.data) {
+                                return Promise.reject(_error.response.data);
+                            }
+                            return Promise.reject(_error);
+                        }
+                    }
+                    if (err.response.status === 403 && err.response.data) {
+                        return Promise.reject(err.response.data);
+                    }
+                }
+                return Promise.reject(err);
+            }
+        );
+    }
 };
 
 /**

package/dist/base.d.ts

@@ -49,12 +49,19 @@ export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration;
+    private username?;
+    private password?;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
-    getConfiguration(): Configuration;
+    initialize(env?: Environment): Promise<void>;
+    private loadCredentials;
+    private readConfigFile;
+    private readEnvVariables;
     selectEnvironment(env: Environment): void;
     authorize(username: string, password: string): Promise<void>;
     refreshToken(): Promise<string>;
     private extractRefreshToken;
+    getConfiguration(): Configuration;
+    private attachInterceptor;
 }
 /**
  *

package/dist/base.js

@@ -38,6 +38,29 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -83,7 +106,15 @@ var configuration_1 = require("./configuration");
 // Some imports not used depending on template conditions
 // @ts-ignore
 var axios_1 = __importDefault(require("axios"));
+var fs = __importStar(require("fs"));
+var path = __importStar(require("path"));
+var os = __importStar(require("os"));
 exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
+var CONFIG_DIRECTORY = '.emil';
+var CONFIG_FILENAME = 'credentials';
+var KEY_USERNAME = 'emil_username';
+var KEY_PASSWORD = 'emil_password';
+var filePath = os.homedir() + path.sep + CONFIG_DIRECTORY + path.sep + CONFIG_FILENAME;
 /**
  *
  * @export
@@ -108,7 +139,6 @@ var BaseAPI = /** @class */ (function () {
     function BaseAPI(configuration, basePath, axios) {
         if (basePath === void 0) { basePath = exports.BASE_PATH; }
         if (axios === void 0) { axios = axios_1.default; }
-        var _this = this;
         this.basePath = basePath;
         this.axios = axios;
         if (configuration) {
@@ -120,47 +150,85 @@ var BaseAPI = /** @class */ (function () {
                 basePath: this.basePath,
             });
         }
-        axios.interceptors.response.use(function (res) {
-            return res;
-        }, function (err) { return __awaiter(_this, void 0, void 0, function () {
-            var originalConfig, tokenString, accessToken, localVarHeaderParameter, _error_1;
+        this.attachInterceptor(axios);
+    }
+    BaseAPI.prototype.initialize = function (env) {
+        if (env === void 0) { env = Environment.Production; }
+        return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        originalConfig = err.config;
-                        if (!err.response) return [3 /*break*/, 5];
-                        if (!(err.response.status === 401 && !originalConfig._retry)) return [3 /*break*/, 4];
-                        originalConfig._retry = true;
-                        _a.label = 1;
+                        this.configuration.basePath = env;
+                        return [4 /*yield*/, this.loadCredentials()];
                     case 1:
-                        _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.refreshToken()];
+                        _a.sent();
+                        if (!this.username) return [3 /*break*/, 3];
+                        return [4 /*yield*/, this.authorize(this.username, this.password)];
                     case 2:
-                        tokenString = _a.sent();
-                        accessToken = "Bearer ".concat(tokenString);
-                        localVarHeaderParameter = {};
-                        localVarHeaderParameter['Authorization'] = accessToken;
-                        originalConfig.headers = __assign(__assign({}, originalConfig.headers), localVarHeaderParameter);
-                        this.configuration.accessToken = accessToken;
-                        return [2 /*return*/, axios(originalConfig)];
+                        _a.sent();
+                        this.password = null; // to avoid keeping password loaded in memory.
+                        _a.label = 3;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    BaseAPI.prototype.loadCredentials = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, this.readConfigFile()];
+                    case 1:
+                        _a.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        error_1 = _a.sent();
+                        console.warn("No credentials file found. Check that ".concat(filePath, " exists."));
+                        return [3 /*break*/, 3];
                     case 3:
-                        _error_1 = _a.sent();
-                        if (_error_1.response && _error_1.response.data) {
-                            return [2 /*return*/, Promise.reject(_error_1.response.data)];
-                        }
-                        return [2 /*return*/, Promise.reject(_error_1)];
-                    case 4:
-                        if (err.response.status === 403 && err.response.data) {
-                            return [2 /*return*/, Promise.reject(err.response.data)];
+                        this.readEnvVariables();
+                        if (!this.username) {
+                            console.info("No credentials found in credentials file or environment variables. Either provide some or use \n                authorize() function.");
                         }
-                        _a.label = 5;
-                    case 5: return [2 /*return*/, Promise.reject(err)];
+                        return [2 /*return*/];
                 }
             });
-        }); });
-    }
-    BaseAPI.prototype.getConfiguration = function () {
-        return this.configuration;
+        });
+    };
+    BaseAPI.prototype.readConfigFile = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var file, lines;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, fs.promises.readFile(filePath, 'utf-8')];
+                    case 1:
+                        file = _a.sent();
+                        lines = file.split(os.EOL)
+                            .filter(Boolean);
+                        lines.forEach(function (line) {
+                            if (line.startsWith(KEY_USERNAME)) {
+                                _this.username = line.length > KEY_USERNAME.length + 1 ? line.substring(KEY_USERNAME.length + 1) : '';
+                            }
+                            else if (line.startsWith(KEY_PASSWORD)) {
+                                _this.password = line.length > KEY_PASSWORD.length + 1 ? line.substring(KEY_PASSWORD.length + 1) : '';
+                            }
+                        });
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    BaseAPI.prototype.readEnvVariables = function () {
+        if (process.env.EMIL_USERNAME) {
+            this.username = process.env.EMIL_USERNAME;
+            this.password = process.env.EMIL_PASSWORD || '';
+            return true;
+        }
+        return false;
     };
     BaseAPI.prototype.selectEnvironment = function (env) {
         this.configuration.basePath = env;
@@ -229,6 +297,50 @@ var BaseAPI = /** @class */ (function () {
         }
         return '';
     };
+    BaseAPI.prototype.getConfiguration = function () {
+        return this.configuration;
+    };
+    BaseAPI.prototype.attachInterceptor = function (axios) {
+        var _this = this;
+        axios.interceptors.response.use(function (res) {
+            return res;
+        }, function (err) { return __awaiter(_this, void 0, void 0, function () {
+            var originalConfig, tokenString, accessToken, localVarHeaderParameter, _error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        originalConfig = err.config;
+                        if (!err.response) return [3 /*break*/, 5];
+                        if (!(err.response.status === 401 && !originalConfig._retry)) return [3 /*break*/, 4];
+                        originalConfig._retry = true;
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, this.refreshToken()];
+                    case 2:
+                        tokenString = _a.sent();
+                        accessToken = "Bearer ".concat(tokenString);
+                        localVarHeaderParameter = {};
+                        localVarHeaderParameter['Authorization'] = accessToken;
+                        originalConfig.headers = __assign(__assign({}, originalConfig.headers), localVarHeaderParameter);
+                        this.configuration.accessToken = accessToken;
+                        return [2 /*return*/, axios(originalConfig)];
+                    case 3:
+                        _error_1 = _a.sent();
+                        if (_error_1.response && _error_1.response.data) {
+                            return [2 /*return*/, Promise.reject(_error_1.response.data)];
+                        }
+                        return [2 /*return*/, Promise.reject(_error_1)];
+                    case 4:
+                        if (err.response.status === 403 && err.response.data) {
+                            return [2 /*return*/, Promise.reject(err.response.data)];
+                        }
+                        _a.label = 5;
+                    case 5: return [2 /*return*/, Promise.reject(err)];
+                }
+            });
+        }); });
+    };
     return BaseAPI;
 }());
 exports.BaseAPI = BaseAPI;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emilgroup/insurance-sdk-node",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "OpenAPI client for @emilgroup/insurance-sdk-node",
   "author": "OpenAPI-Generator Contributors",
   "keywords": [