@emilgroup/action-sdk-node 1.0.1-beta.20

package/.openapi-generator/FILES

@@ -0,0 +1,16 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+api.ts
+api/default-api.ts
+base.ts
+common.ts
+configuration.ts
+git_push.sh
+index.ts
+models/index.ts
+models/inline-response200.ts
+models/inline-response503.ts
+package.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+5.4.0

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -0,0 +1,84 @@
+# Emil Action SDK for Nodejs
+
+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
+* ES6
+
+Module system
+* CommonJS
+* ES6 module system
+
+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)). For more information, you can go to [Emil Api documentation](https://emil.stoplight.io/docs/emil-api/).
+
+## Consuming
+
+Navigate to the folder of your consuming project and run one of the following commands:
+
+```
+npm install @emilgroup/action-sdk-node@1.0.1-beta.20 --save
+```
+or 
+```
+yarn add @emilgroup/action-sdk-node@1.0.1-beta.20
+```
+
+And then you can import `ActionsApi`.
+
+```ts
+import { ActionsApi } from '@emilgroup/action-sdk-node'
+
+const actionsApi = new ActionsApi();
+```
+## 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
+```
+
+## Base path
+
+To select the basic path for using the API, we can use two approaches. The first is to use one of the predefined environments, and the second is to specify the domain as a string.
+
+```ts
+import { ActionsApi, Environment } from '@emilgroup/action-sdk-node'
+
+const actionsApi = new ActionsApi();
+
+// Allows you to simply choose environment. It will usually be Environment.Production.
+actionsApi.selectEnvironment(Environment.Production);
+
+// For advanced users, use the custom baseUrl of the website you need to connect to.
+actionsApi.selectBasePath('https://my-custom-domain.com');
+```
+
+## Example
+
+Here is a basic functionning example:
+
+```ts
+async function listActions(): Promise<Void> {
+    try {
+        const actionsApi = new ActionsApi();
+
+        await actionsApi.initialize(); // should be called only once per Api.
+
+        const { data: { items } } = await actionsApi.listActions();
+
+        console.log(items);
+    } catch(error) {
+      // process error
+  }
+}
+```

package/api/default-api.ts

@@ -0,0 +1,128 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ActionService
+ * The EMIL ActionService 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';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * DefaultApi - axios parameter creator
+ * @export
+ */
+export const DefaultApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Returns the health status of the ActionService service.        This endpoint is used to monitor the operational status of the ActionService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        check: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/actionservice/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 {
+        /**
+         * Returns the health status of the ActionService service.        This endpoint is used to monitor the operational status of the ActionService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @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 {
+        /**
+         * Returns the health status of the ActionService service.        This endpoint is used to monitor the operational status of the ActionService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
+         * @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 {
+    /**
+     * Returns the health status of the ActionService service.        This endpoint is used to monitor the operational status of the ActionService service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * @summary Health Check
+     * @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.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ActionService
+ * The EMIL ActionService 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 { 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';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
+import { DefaultApi } from './api';
+
+
+export * from './api/default-api';
+

package/base.ts

@@ -0,0 +1,327 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL ActionService
+ * The EMIL ActionService 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 { 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 = "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
+ */
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+export interface LoginClass {
+    accessToken: string;
+    permissions: string;
+}
+
+export interface SwitchWorkspaceRequest {
+    username: string;
+    targetWorkspace: string;
+}
+
+export interface SwitchWorkspaceResponseClass {
+    accessToken: string;
+    permissions: string;
+}
+
+export enum Environment {
+    Production = 'https://apiv2.emil.de',
+    Test = 'https://apiv2-test.emil.de',
+    Staging = 'https://apiv2-staging.emil.de',
+    Development = 'https://apiv2-dev.emil.de',
+    ProductionZurich = 'https://eu-central-2.apiv2.emil.de',
+}
+
+let _retry_count = 0
+let _retry = null
+
+export function resetRetry() {
+    _retry_count = 0
+}
+
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: AxiosRequestConfig;
+}
+
+const NETWORK_ERROR_MESSAGE = "Network Error";
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+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) {
+            this.configuration = configuration;
+            this.basePath = configuration.basePath || this.basePath;
+        } else {
+            this.configuration = new Configuration({
+                basePath: this.basePath,
+            });
+        }
+
+        this.attachInterceptor(axios);
+    }
+
+    async initialize(env: Environment = Environment.Production, targetWorkspace?: string) {
+        this.configuration.basePath = env;
+
+        await this.loadCredentials();
+
+        if (this.username) {
+            await this.authorize(this.username, this.password, targetWorkspace);
+            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;
+    }
+
+    async authorize(username: string, password: string, targetWorkspace?: string): Promise<void> {
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/authservice/v1/login`,
+            headers: { 'Content-Type': 'application/json' },
+            data: {
+                username,
+                password,
+            },
+            withCredentials: true,
+        };
+
+        const response = await globalAxios.request<LoginClass>(options);
+
+        const { data: { accessToken } } = response;
+        this.configuration.username = username;
+        this.configuration.accessToken = `Bearer ${accessToken}`;
+
+        const refreshToken = this.extractRefreshToken(response)
+        this.configuration.refreshToken = refreshToken;
+
+        // Switch workspace if provided
+        if (targetWorkspace) {
+            await this.switchWorkspace(targetWorkspace);
+        }
+    }
+    async switchWorkspace(targetWorkspace: string): Promise<void> {
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/authservice/v1/workspaces/switch`,
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': `Bearer ${this.configuration.accessToken}`,
+                'Cookie': this.configuration.refreshToken,
+            },
+            data: {
+                username: this.configuration.username,
+                targetWorkspace,
+            } as SwitchWorkspaceRequest,
+            withCredentials: true,
+        };
+
+        const response = await globalAxios.request<SwitchWorkspaceResponseClass>(options);
+
+        const { data: { accessToken } } = response;
+        this.configuration.accessToken = `Bearer ${accessToken}`;
+
+        const refreshToken = this.extractRefreshToken(response);
+        if (refreshToken) {
+            this.configuration.refreshToken = refreshToken;
+        }
+    }
+
+    async refreshTokenInternal(): Promise<string> {
+        const { username, refreshToken } = this.configuration;
+        
+
+        if (!username || !refreshToken) {
+            return '';
+        }
+
+        const options: AxiosRequestConfig = {
+            method: 'POST',
+            url: `${this.configuration.basePath}/authservice/v1/refresh-token`,
+            headers: {
+                'Content-Type': 'application/json',
+                Cookie: refreshToken,
+            },
+            data: { username: username },
+            withCredentials: true,
+        };
+
+        const { data: { accessToken } } = await globalAxios.request<LoginClass>(options);
+
+        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]};`;
+        }
+
+        return '';
+    }
+
+    getConfiguration(): Configuration {
+        return this.configuration;
+    }
+
+    private attachInterceptor(axios: AxiosInstance) {
+        axios.interceptors.response.use(
+            (res) => {
+                return res;
+            },
+            async (err) => {
+                let 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.refreshTokenInternal();
+                            const accessToken = `Bearer ${tokenString}`;
+
+                            originalConfig.headers['Authorization'] = accessToken;
+
+                            this.configuration.accessToken = accessToken;
+
+                            return axios.request(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);
+                    }
+                } else if(err.message === NETWORK_ERROR_MESSAGE 
+                    && err.isAxiosError
+                    && originalConfig.headers.hasOwnProperty('Authorization')
+                    && _retry_count < 4
+                ){ 
+                    _retry_count++;
+                    try {
+                        const tokenString = await this.refreshTokenInternal();
+                        const accessToken = `Bearer ${tokenString}`;
+
+                        _retry = true;
+                        originalConfig.headers['Authorization'] = accessToken; 
+
+                        this.configuration.accessToken = accessToken;
+
+                        return axios.request({
+                            ...originalConfig,
+                        });
+                    } catch (_error) {
+                        if (_error.response && _error.response.data) {
+                            return Promise.reject(_error.response.data);
+                        }
+                        return Promise.reject(_error);
+                    }                    
+                }
+                return Promise.reject(err);
+            }
+        );
+    }
+};
+
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export class RequiredError extends Error {
+    override name: "RequiredError" = "RequiredError";
+    constructor(public field: string, msg?: string) {
+        super(msg);
+    }
+}
+