@emilgroup/tenant-sdk 1.5.0 → 1.7.0

package/.openapi-generator/FILES

@@ -6,6 +6,7 @@ api.ts
 api/custom-schema-api.ts
 api/data-report-api.ts
 api/data-report-executor-api.ts
+api/default-api.ts
 api/invite-organizations-api.ts
 api/invite-users-api.ts
 api/list-organization-invitations-api.ts
@@ -51,6 +52,8 @@ models/get-organization-response-class.ts
 models/get-settings-response-class.ts
 models/get-user-response-class.ts
 models/index.ts
+models/inline-response200.ts
+models/inline-response503.ts
 models/invite-class.ts
 models/invite-org-request-dto.ts
 models/invite-user-request-dto.ts

package/README.md

@@ -1,6 +1,6 @@
 # Emil Tenant SDK
 
-This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated Node module can be used with Nodejs based applications.
+This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated module can be used with client-based applications (i.e. React).
 
 Language level
 * ES5 - you must have a Promises/A+ library installed
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/tenant-sdk@1.5.0 --save
+npm install @emilgroup/tenant-sdk@1.7.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/tenant-sdk@1.5.0
+yarn add @emilgroup/tenant-sdk@1.7.0
 ```
 
 And then you can import `UsersApi`.
@@ -31,32 +31,15 @@ import { UsersApi } from '@emilgroup/tenant-sdk'
 
 const usersApi = new UsersApi();
 ```
-## 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
-
-Here is a basic functionning example:
+To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in `UsersApi`:
 
 ```ts
 async function listUsers(): Promise<Void> {
     try {
         const usersApi = new UsersApi();
 
-        await usersApi.initialize(); // should be called only once per Api.
+        await usersApi.authorize('username', 'password');
 
         const { data: { items } } = await usersApi.listUsers();
 

package/api/custom-schema-api.ts

@@ -32,10 +32,6 @@ import { ListCustomSchemasResponseClass } from '../models';
 import { UpdateCustomSchemaRequestDto } from '../models';
 // @ts-ignore
 import { UpdateCustomSchemaResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * CustomSchemaApi - axios parameter creator
  * @export

package/api/data-report-api.ts

@@ -32,10 +32,6 @@ import { ListDataReportsResponseClass } from '../models';
 import { UpdateDataReportRequestDto } from '../models';
 // @ts-ignore
 import { UpdateDataReportResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * DataReportApi - axios parameter creator
  * @export

package/api/data-report-executor-api.ts

@@ -24,10 +24,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 import { RunDataReportRequestDto } from '../models';
 // @ts-ignore
 import { RunDataReportResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * DataReportExecutorApi - axios parameter creator
  * @export

package/api/default-api.ts

@@ -0,0 +1,120 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Tenant Service
+ * The EMIL TenantService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { InlineResponse200 } from '../models';
+// @ts-ignore
+import { InlineResponse503 } from '../models';
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/tenantservice/health`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DefaultApi - functional programming interface
+ * @export
+ */
+export const DefaultApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async check(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.check(options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * DefaultApi - factory interface
+ * @export
+ */
+export const DefaultApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DefaultApiFp(configuration)
+    return {
+        /**
+         * 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check(options?: any): AxiosPromise<InlineResponse200> {
+            return localVarFp.check(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DefaultApi - object-oriented interface
+ * @export
+ * @class DefaultApi
+ * @extends {BaseAPI}
+ */
+export class DefaultApi extends BaseAPI {
+    /**
+     * 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DefaultApi
+     */
+    public check(options?: AxiosRequestConfig) {
+        return DefaultApiFp(this.configuration).check(options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/api/invite-organizations-api.ts

@@ -24,10 +24,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 import { InviteOrgRequestDto } from '../models';
 // @ts-ignore
 import { OrgInvitationResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * InviteOrganizationsApi - axios parameter creator
  * @export

package/api/invite-users-api.ts

@@ -36,10 +36,6 @@ import { InviteUsersRequestDto } from '../models';
 import { InviteUsersResponseClass } from '../models';
 // @ts-ignore
 import { ListInvitesResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * InviteUsersApi - axios parameter creator
  * @export

package/api/list-organization-invitations-api.ts

@@ -22,10 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
 import { ListOrgInvitationsResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * ListOrganizationInvitationsApi - axios parameter creator
  * @export

package/api/organizations-api.ts

@@ -28,10 +28,6 @@ import { ListOrganizationsResponseClass } from '../models';
 import { UpdateOrganizationRequestDtoRest } from '../models';
 // @ts-ignore
 import { UpdateOrganizationResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * OrganizationsApi - axios parameter creator
  * @export

package/api/re-invite-an-organization-api.ts

@@ -24,10 +24,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 import { OrgInvitationResponseClass } from '../models';
 // @ts-ignore
 import { ReInviteOrgRequestDto } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * ReInviteAnOrganizationApi - axios parameter creator
  * @export

package/api/roles-api.ts

@@ -22,10 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
 import { ListRolesResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * RolesApi - axios parameter creator
  * @export

package/api/settings-api.ts

@@ -22,10 +22,6 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
 import { GetSettingsResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * SettingsApi - axios parameter creator
  * @export

package/api/users-api.ts

@@ -46,10 +46,6 @@ import { EnableUsersResponseClass } from '../models';
 import { GetUserResponseClass } from '../models';
 // @ts-ignore
 import { ListUsersResponseClass } from '../models';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-const FormData = require('form-data');
 /**
  * UsersApi - axios parameter creator
  * @export

package/api.ts

@@ -15,10 +15,6 @@
 
 import { Configuration } from './configuration';
 import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-// URLSearchParams not necessarily used
-// @ts-ignore
-import { URL, URLSearchParams } from 'url';
-import FormData from 'form-data'
 // Some imports not used depending on template conditions
 // @ts-ignore
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
@@ -27,6 +23,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 import { CustomSchemaApi } from './api';
 import { DataReportApi } from './api';
 import { DataReportExecutorApi } from './api';
+import { DefaultApi } from './api';
 import { InviteOrganizationsApi } from './api';
 import { InviteUsersApi } from './api';
 import { ListOrganizationInvitationsApi } from './api';
@@ -40,6 +37,7 @@ import { UsersApi } from './api';
 export * from './api/custom-schema-api';
 export * from './api/data-report-api';
 export * from './api/data-report-executor-api';
+export * from './api/default-api';
 export * from './api/invite-organizations-api';
 export * from './api/invite-users-api';
 export * from './api/list-organization-invitations-api';

package/base.ts

@@ -14,20 +14,13 @@
 
 
 import { Configuration } from "./configuration";
+import { defaultStorage } from "./common";
 // 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 = "https://apiv2.emil.de".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 const BASE_PATH = "https://apiv2.emil.de".replace(/\/+$/, "");
 /**
  *
  * @export
@@ -67,7 +60,13 @@ export interface RequestArgs {
     options: AxiosRequestConfig;
 }
 
+interface TokenData {
+    accessToken?: string;
+    username?: string;
+}
+
 const NETWORK_ERROR_MESSAGE = "Network Error";
+const TOKEN_DATA = 'APP_TOKEN';
 
 /**
  *
@@ -75,75 +74,31 @@ const NETWORK_ERROR_MESSAGE = "Network Error";
  * @class BaseAPI
  */
 export class BaseAPI {
-    protected configuration: Configuration;
-    private username?: string;
-    private password?: string;
+    protected configuration: Configuration | undefined;
+    private tokenData?: TokenData;
+
+    constructor(configuration?: Configuration,
+        protected basePath: string = BASE_PATH, 
+        protected axios: AxiosInstance = globalAxios) {
+        
+        this.loadTokenData();
 
-    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
         if (configuration) {
             this.configuration = configuration;
             this.basePath = configuration.basePath || this.basePath;
         } else {
+            const { accessToken, username } = this.tokenData;
+
             this.configuration = new Configuration({
                 basePath: this.basePath,
+                accessToken: accessToken ? `Bearer ${accessToken}` : '',
+                username,
             });
         }
 
         this.attachInterceptor(axios);
     }
 
-    async initialize(env: Environment = Environment.Production) {
-        this.configuration.basePath = env;
-
-        await this.loadCredentials();
-
-        if (this.username) {
-            await this.authorize(this.username, this.password);
-            this.password = null; // to avoid keeping password loaded in memory.
-        }
-    }
-
-    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.`);
-        }
-    }
-
-    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;
     }
@@ -163,18 +118,21 @@ export class BaseAPI {
         const response = await globalAxios.request<LoginClass>(options);
 
         const { data: { accessToken } } = response;
+
         this.configuration.username = username;
         this.configuration.accessToken = `Bearer ${accessToken}`;
+        this.tokenData.username = username;
+        this.tokenData.accessToken = accessToken;
 
-        const refreshToken = this.extractRefreshToken(response)
-        this.configuration.refreshToken = refreshToken;
+        this.storeTokenData({
+            ...this.tokenData
+        });
     }
 
     async refreshTokenInternal(): Promise<string> {
-        const { username, refreshToken } = this.configuration;
-        
+        const { username } = this.configuration;
 
-        if (!username || !refreshToken) {
+        if (!username) {
             return '';
         }
 
@@ -183,7 +141,6 @@ export class BaseAPI {
             url: `${this.configuration.basePath}/authservice/v1/refresh-token`,
             headers: {
                 'Content-Type': 'application/json',
-                Cookie: refreshToken,
             },
             data: { username: username },
             withCredentials: true,
@@ -194,18 +151,22 @@ export class BaseAPI {
         return accessToken;
     }
 
-    private extractRefreshToken(response: AxiosResponse): string {
-        if (response.headers && response.headers['set-cookie']
-            && response.headers['set-cookie'].length > 0) {
-
-            return `${response.headers['set-cookie'][0].split(';')[0]};`;
+    private storeTokenData(tokenData?: TokenData) {
+        if (typeof window !== 'undefined') {
+            defaultStorage().set<TokenData>(TOKEN_DATA, tokenData);
         }
+    }
 
-        return '';
+    public loadTokenData() {
+        if (typeof window !== 'undefined') {
+            this.tokenData = defaultStorage().get<TokenData>(TOKEN_DATA) || {};
+        } else {
+            this.tokenData = {};
+        }
     }
 
-    getConfiguration(): Configuration {
-        return this.configuration;
+    public cleanTokenData() {
+        this.storeTokenData(null);
     }
 
     private attachInterceptor(axios: AxiosInstance) {
@@ -215,19 +176,25 @@ export class BaseAPI {
             },
             async (err) => {
                 let originalConfig = err.config;
-                if (err.response) {
+                if (err.response && !(err.response instanceof XMLHttpRequest)) { // sometimes buggy and is of type request
                     // Access Token was expired
-                    if (err.response.status === 401 && !originalConfig._retry) {
+                    if ((err.response.status === 401 || err.response.status === 403)
+                        && !originalConfig._retry) {
                         originalConfig._retry = true;
                         try {
-                            const tokenString = await this.refreshTokenInternal();
+                            let tokenString = await this.refreshTokenInternal();
                             const accessToken = `Bearer ${tokenString}`;
 
-                            originalConfig.headers['Authorization'] = `Bearer ${accessToken}`
+                            delete originalConfig.headers['Authorization']
+
+                            originalConfig.headers['Authorization'] = accessToken;
 
                             this.configuration.accessToken = accessToken;
+                            this.tokenData.accessToken = tokenString;
+
+                            this.storeTokenData(this.tokenData);
 
-                            return axios.request(originalConfig);
+                            return axios(originalConfig);
                         } catch (_error) {
                             if (_error.response && _error.response.data) {
                                 return Promise.reject(_error.response.data);
@@ -235,23 +202,22 @@ export class BaseAPI {
                             return Promise.reject(_error);
                         }
                     }
-                    if (err.response.status === 403 && err.response.data) {
-                        return Promise.reject(err.response.data);
-                    }
-                } else if(err.message === NETWORK_ERROR_MESSAGE 
-                    && err.isAxiosError
+                } else if (err.message === NETWORK_ERROR_MESSAGE
                     && originalConfig.headers.hasOwnProperty('Authorization')
                     && _retry_count < 4
-                ){ 
+                ) {
                     _retry_count++;
                     try {
-                        const tokenString = await this.refreshTokenInternal();
+                        let tokenString = await this.refreshTokenInternal();
                         const accessToken = `Bearer ${tokenString}`;
 
                         _retry = true;
-                        originalConfig.headers['Authorization'] = accessToken; 
+                        originalConfig.headers['Authorization'] = accessToken;
 
                         this.configuration.accessToken = accessToken;
+                        this.tokenData.accessToken = tokenString;
+
+                        this.storeTokenData(this.tokenData);
 
                         return axios.request({
                             ...originalConfig,
@@ -261,7 +227,7 @@ export class BaseAPI {
                             return Promise.reject(_error.response.data);
                         }
                         return Promise.reject(_error);
-                    }                    
+                    }
                 }
                 return Promise.reject(err);
             }

package/common.ts

@@ -16,7 +16,6 @@
 import { Configuration } from "./configuration";
 import { RequiredError, RequestArgs } from "./base";
 import { AxiosInstance, AxiosResponse } from 'axios';
-import { URL, URLSearchParams } from 'url';
 /**
  *
  * @export

package/configuration.ts

@@ -74,14 +74,6 @@ export class Configuration {
      */
     formDataCtor?: new () => any;
 
-    /**
-     * parameter for automatically refreshing access token for oauth2 security
-     *
-     * @type {string}
-     * @memberof Configuration
-     */
-    refreshToken?: string;
-
     constructor(param: ConfigurationParameters = {}) {
         this.apiKey = param.apiKey;
         this.username = param.username;