@qoretechnologies/ts-toolkit 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Qore Technologies, s.r.o.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+<div align="center">
+  <br><br><br>
+  <img src="./public/logo.png" alt="Unstated Logo" width="350">
+  <br><br><br>
+</div>
+
+# @qoretechnologies/qorus-toolkit
+
+> Currently in beta, more features and integrations yet to be added
+
+A modern TypeScript utility library for enhancing QoreTechnologies no-code infrastructure solutions.
+
+![](./coverage/badge-functions.svg) ![](./coverage/badge-lines.svg) ![](./coverage/badge-statements.svg)
+
+## Installation
+
+Before installing, [download and install Node.js](https://nodejs.org/en/download/).
+Latest stable Node.js is required.
+
+Installation is done using the
+[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
+
+```console
+$ yarn add @qoretechnologies/qorus-toolkit
+```
+
+Alternatively you can also use npm
+
+```console
+$ npm install @qoretechnologies/qorus-toolkit
+```
+
+## Current Features
+
+- QorusAuthenticator
+
+  An authenticator for Qorus Integration Engine(R), allows users to create multiple connections as endpoints and manage authentication to them.
+
+- QorusDataProvider
+
+  Provides an API to interact with Qorus Integration Engine(R) data providers, and allows the user to fetch, add and edit Data Providers.
+
+- QorusRequest
+
+  An HTTPS request handler to manage API requests to Qorus Integration Engine(R)
+
+- QorusOptions
+  A Qorus Integration Engine(R) API options manager
+
+## Docs & Community
+
+- [Documentation](https://toolkit.qoretechnologies.com)
+- [GitHub Organization](https://github.com/qoretechnologies) for Official open-source projects
+- [Discord](https://discord.gg/T7vgS6nh) for support, discussion, news and latest release updates
+
+## Philosophy
+
+The Qorus-Toolkit philosophy is to provide a fast and modular API wrapper to connect with Qore Technologies server API which enables it to be utilized in any node project with ease.
+
+Qorus-Toolkit will be used with Qorus-Toolkit-React to provide a complete solution with modular components to our enterprise clients.
+
+## Contributing
+
+The Qorus Toolkit project welcomes all constructive contributions. Contributions can be of many forms including bug fixes, enhancements, fixes to documentation, additional tests and more!
+
+See the [Contributing Guide](CONTRIBUTING.MD) for more technical details on contributing.
+
+### Security Issues
+
+If you discover a security vulnerability in Qorus Toolkit, please see [Security Policies and Procedures](SECURITY.md).
+
+## License
+
+[MIT](LICENSE)

package/dist/QorusAuthenticator.d.ts

@@ -0,0 +1,181 @@
+import { IApiPaths, IAuthenticatorApiPaths, IWithEndpointVersion, TVersion } from './utils/apiPaths';
+export interface IValidateEndpointData extends IAddEndpoint, ILoginParams {
+}
+/**
+ * Endpoint id for a Qorus server endpoint
+ */
+export type TQorusEndpointId = string;
+/**
+ * Authentication token for a Qorus server endpoint
+ */
+export type TQorusAuthToken = string;
+/**
+ * Url for a Qorus server endpoint
+ */
+export type TQorusEndpointURL = string;
+export interface IWithQorusEndpointId {
+    /**
+     * Id for a endpoint provided by the user, unique for every endpoint
+     */
+    endpointId: TQorusEndpointId;
+}
+export interface IWithQorusAuthToken {
+    /**
+     * Authentication token for the user provided endpoint
+     */
+    authToken?: TQorusAuthToken;
+}
+export interface IWithQorusURL {
+    /**
+     * URL to Qorus server for the provided endpoint
+     */
+    url: TQorusEndpointURL;
+}
+export interface ILoginParams {
+    /**
+     * Username for the authentication to Qorus server
+     */
+    user?: string;
+    /**
+     * Password for the authentication to Qorus server
+     */
+    pass?: string;
+}
+export interface IAddEndpoint extends IWithQorusURL, IWithEndpointVersion, IWithQorusEndpointId {
+}
+export interface IEndpoint extends IWithQorusURL, IWithEndpointVersion, IWithQorusAuthToken, IWithQorusEndpointId {
+}
+/**
+ * Authentication token for a Qorus Endpoint
+ */
+export type TToken = string;
+/**
+ * QorusAuthenticator class provides methods to authenticate a user for a Qorus server endpoint
+ * - Add Multiple endpoint for different versions of Qorus apis
+ * - Supports no-auth for the Qorus server api
+ * - Uses locally stored token or user and password for authentication
+ * @returns QorusAuthenticator class object
+ * @Category QorusAuthenticator
+ */
+export declare class QorusAuthenticator {
+    #private;
+    /**
+     * Array of user defined endpoints
+     */
+    endpoints: IEndpoint[];
+    /** Object of Api paths for the selected endpoint */
+    allApiPaths: IApiPaths;
+    /** Api paths for the QorusAuthenticator */
+    apiPathsAuthenticator: IAuthenticatorApiPaths;
+    /** Selected endpoint from the endpoints array */
+    selectedEndpoint: IEndpoint | undefined;
+    /** No auth identifier to identify if the no-auth is enabled for the user */
+    noauth: boolean;
+    reset(): void;
+    /**
+     * A getter to get the endpoint if it exist in the Endpoints array
+     * @param id ID of the endpoint ex: "rippy"
+     * @returns Endpoint object if the endpoint with the provided id exist in the endpoints array, undefined otherwise.
+     */
+    getEndpointById(endpointId: string): IEndpoint | undefined;
+    /**
+     * Logs out the current user from the selected endpoint
+     * @returns True if the operation is successful, False otherwise
+     */
+    logout(): Promise<boolean>;
+    /**
+     * Select an endpoint from the available Endpoints array
+     * @param id Id of the endpoint
+     * @returns Endpoint if the operation is successful, undefined otherwise.
+     */
+    selectEndpoint(id: string): Promise<IEndpoint | undefined>;
+    /**
+     * Checks if the Qorus endpoint supports no-auth
+     * @param endpoint Endpoint config to add the data
+     * @returns True if the no-auth is enabled for the user, False otherwise
+     */
+    checkNoAuth(endpoint?: IEndpoint): Promise<boolean>;
+    /**
+     * A getter to get selected Endpoint
+     * @returns Selected Endpoint if the endpoint exists, undefined otherwise
+     */
+    getSelectedEndpoint(): IEndpoint | undefined;
+    /**
+     * Checks the validity of the selected endpoint
+     * @param data Endpoint data to be checked
+     * @param withCredentials boolean to check if the endpoint has credentials
+     * @returns True if the Endpoint data is valid, False otherwise
+     */
+    validateEndpointData(data: IValidateEndpointData, withCredentials?: boolean): boolean;
+    /**
+     * Validates the local stored authentication token for the Endpoint
+     * @param endpointId Id of the endpoint
+     * @returns Authentication token, if the authentication is successful, null otherwise
+     */
+    validateLocalUserToken(endpointId: string): Promise<string | null>;
+    /**
+     * Authenticates the user to interact with the Qorus api.
+     * If the username and password is not provided it tries to authenticate the user using the locally stored token from the selected Endpoint
+     * @param loginParams LoginParams, user and pass is required to authenticate the user.
+     * @returns Authentication token if the authentication is successful, undefined otherwise.
+     */
+    login(loginParams?: ILoginParams): Promise<string | undefined>;
+    /**
+     * Add a new Qorus Endpoint to interact with the qorus api
+     * @param endpointConfig Endpoint configuration required to add a new endpoint
+     * @returns Newly added endpoint
+     */
+    addEndpoint(endpointConfig: IAddEndpoint): IEndpoint;
+    /**
+     * Allows the user to renew the selected endpoint authentication token
+     * @param loginParams LoginParams optional username and password can be provided
+     * @returns Token if the authentication is successful, undefined otherwise
+     */
+    renewSelectedEndpointToken(loginParams: ILoginParams): Promise<string | undefined>;
+    /**
+     * A getter to return the auth token of the selected Endpoint
+     * @returns token if the the selected endpoint exists and the user is authenticated, otherwise returns undefined
+     */
+    getAuthToken(): string | undefined;
+    /**
+     * A getter to get the api Version of a Endpoint
+     * @param endpointId Optional id parameter to get the version of a particular endpoint
+     * @returns Version of the selected endpoint or version of the the endpoint found by id,
+     * if the endpoint doesn't exists it returns undefined
+     */
+    getEndpointVersion(endpointId?: string): TVersion | undefined;
+    /**
+     * Validates if the provided version is an accepted api version
+     * @param version Version of the endpoint
+     * @returns True if the version is valid, False otherwise
+     */
+    private validateVersion;
+    /**
+     * A setter to set the Version of a Endpoint
+     * @param version Version of the qorus api
+     * @param endpointId Optional parameter to change the url of a particular endpoint from the endpoints array
+     * @returns Version of the endpoint if the operation is successful, undefined otherwise
+     *
+     */
+    setEndpointVersion(version: TVersion, endpointId?: string): Promise<TVersion | undefined>;
+    /**
+     * A setter to set the url of the selected Endpoint
+     * @param url Base url for the endpoint
+     * @param id Optional id parameter to change the url of a particular endpoint
+     * @returns Url of the endpoint if the operation is successful, undefined otherwise
+     */
+    setEndpointUrl(url: string, endpointId?: string): Promise<string | undefined>;
+    /**
+     * A getter to return the api paths for the selected Endpoint
+     * @returns ApiPaths for the selected endpoint if exists, otherwise returns default api paths
+     */
+    getApiPaths(): IApiPaths;
+    /**
+     * A getter to get all the available Endpoints
+     * @returns Endpoints array with all the available endpoints
+     */
+    getAllEndpoints(): IEndpoint[];
+}
+declare const _default: QorusAuthenticator;
+export default _default;
+//# sourceMappingURL=QorusAuthenticator.d.ts.map

package/dist/QorusAuthenticator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QorusAuthenticator.d.ts","sourceRoot":"","sources":["../src/QorusAuthenticator.ts"],"names":[],"mappings":"AAMA,OAAO,EAGL,SAAS,EACT,sBAAsB,EACtB,oBAAoB,EACpB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAE1B,MAAM,WAAW,qBAAsB,SAAQ,YAAY,EAAE,YAAY;CAAG;AAE5E;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,gBAAgB,CAAC;CAC9B;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,EAAE,iBAAiB,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,YAAa,SAAQ,aAAa,EAAE,oBAAoB,EAAE,oBAAoB;CAAG;AAElG,MAAM,WAAW,SAAU,SAAQ,aAAa,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,oBAAoB;CAAG;AAEpH;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAE5B;;;;;;;GAOG;AACH,qBAAa,kBAAkB;;IAC7B;;OAEG;IACH,SAAS,EAAE,SAAS,EAAE,CAAM;IAE5B,oDAAoD;IACpD,WAAW,EAAE,SAAS,CAAmB;IAEzC,2CAA2C;IAC3C,qBAAqB,EAAE,sBAAsB,CAAiC;IAE9E,iDAAiD;IACjD,gBAAgB,EAAE,SAAS,GAAG,SAAS,CAAC;IAExC,4EAA4E;IAC5E,MAAM,UAAS;IAEf,KAAK;IAQL;;;;OAIG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS;IAI1D;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAkBhC;;;;OAIG;IACG,cAAc,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAqBhE;;;;OAIG;IACG,WAAW,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC;IAsCzD;;;OAGG;IACH,mBAAmB,IAAI,SAAS,GAAG,SAAS;IAmB5C;;;;;OAKG;IACH,oBAAoB,CAAC,IAAI,EAAE,qBAAqB,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,OAAO;IAwBrF;;;;OAIG;IACG,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAuBxE;;;;;OAKG;IACG,KAAK,CAAC,WAAW,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA6CpE;;;;OAIG;IACH,WAAW,CAAC,cAAc,EAAE,YAAY,GAAG,SAAS;IAuBpD;;;;OAIG;IACG,0BAA0B,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAoBxF;;;OAGG;IACH,YAAY,IAAI,MAAM,GAAG,SAAS;IAIlC;;;;;OAKG;IACH,kBAAkB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS;IAY7D;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAKvB;;;;;;OAMG;IACG,kBAAkB,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC;IAyB/F;;;;;OAKG;IACG,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAyBnF;;;OAGG;IACH,WAAW,IAAI,SAAS;IAIxB;;;OAGG;IACH,eAAe,IAAI,SAAS,EAAE;CAG/B;;AAED,wBAAwC"}

package/dist/QorusAuthenticator.js

@@ -0,0 +1,386 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _QorusAuthenticator_instances, _QorusAuthenticator_fixEndpointData;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QorusAuthenticator = void 0;
+const ErrorInternal_1 = __importDefault(require("./managers/error/ErrorInternal"));
+const LocalStorage_1 = require("./managers/LocalStorage");
+const logger_1 = __importDefault(require("./managers/logger"));
+const QorusRequest_1 = __importDefault(require("./QorusRequest"));
+const QorusValidator_1 = __importDefault(require("./QorusValidator"));
+const utils_1 = require("./utils");
+const apiPaths_1 = require("./utils/apiPaths");
+/**
+ * QorusAuthenticator class provides methods to authenticate a user for a Qorus server endpoint
+ * - Add Multiple endpoint for different versions of Qorus apis
+ * - Supports no-auth for the Qorus server api
+ * - Uses locally stored token or user and password for authentication
+ * @returns QorusAuthenticator class object
+ * @Category QorusAuthenticator
+ */
+class QorusAuthenticator {
+    constructor() {
+        _QorusAuthenticator_instances.add(this);
+        /**
+         * Array of user defined endpoints
+         */
+        this.endpoints = [];
+        /** Object of Api paths for the selected endpoint */
+        this.allApiPaths = apiPaths_1.apiPathsInitial;
+        /** Api paths for the QorusAuthenticator */
+        this.apiPathsAuthenticator = apiPaths_1.apiPathsInitial.authenticator;
+        /** No auth identifier to identify if the no-auth is enabled for the user */
+        this.noauth = false;
+    }
+    reset() {
+        this.endpoints = [];
+        this.allApiPaths = apiPaths_1.apiPathsInitial;
+        this.apiPathsAuthenticator = apiPaths_1.apiPathsInitial.authenticator;
+        this.selectedEndpoint = undefined;
+        this.noauth = false;
+    }
+    /**
+     * A getter to get the endpoint if it exist in the Endpoints array
+     * @param id ID of the endpoint ex: "rippy"
+     * @returns Endpoint object if the endpoint with the provided id exist in the endpoints array, undefined otherwise.
+     */
+    getEndpointById(endpointId) {
+        return this.endpoints.find((endpoint) => endpoint.endpointId === endpointId);
+    }
+    /**
+     * Logs out the current user from the selected endpoint
+     * @returns True if the operation is successful, False otherwise
+     */
+    async logout() {
+        if (!this.selectedEndpoint || !(0, utils_1.isValidString)(this.selectedEndpoint.authToken)) {
+            return true;
+        }
+        try {
+            await QorusRequest_1.default.post({ path: `${this.apiPathsAuthenticator.logout}` });
+            return true;
+        }
+        catch (error) {
+            throw new ErrorInternal_1.default(`Unable to logout user from the endpoint ${this.selectedEndpoint}`);
+        }
+        finally {
+            this.selectedEndpoint.authToken = undefined;
+            this.allApiPaths = apiPaths_1.apiPathsInitial;
+            this.apiPathsAuthenticator = apiPaths_1.apiPathsInitial.authenticator;
+            this.noauth = false;
+        }
+    }
+    /**
+     * Select an endpoint from the available Endpoints array
+     * @param id Id of the endpoint
+     * @returns Endpoint if the operation is successful, undefined otherwise.
+     */
+    async selectEndpoint(id) {
+        var _a;
+        if (!(0, utils_1.isValidString)(id)) {
+            throw new ErrorInternal_1.default('Id is not valid, please provide a valid id or initialize a new endpoint.');
+        }
+        const endpoint = this.getEndpointById(id);
+        if (!endpoint || !(0, utils_1.isValidString)(endpoint.url)) {
+            throw new ErrorInternal_1.default('Selected endpoint is not valid, please create a new endpoint.');
+        }
+        if ((_a = this.selectedEndpoint) === null || _a === void 0 ? void 0 : _a.authToken) {
+            await this.logout();
+        }
+        this.selectedEndpoint = endpoint;
+        this.allApiPaths = (0, apiPaths_1.createApiPaths)({ version: endpoint.version });
+        this.apiPathsAuthenticator = this.allApiPaths.authenticator;
+        return endpoint;
+    }
+    /**
+     * Checks if the Qorus endpoint supports no-auth
+     * @param endpoint Endpoint config to add the data
+     * @returns True if the no-auth is enabled for the user, False otherwise
+     */
+    async checkNoAuth(endpoint) {
+        var _a, _b;
+        const actualEndpoint = endpoint !== null && endpoint !== void 0 ? endpoint : this.selectedEndpoint;
+        /* Throwing an error if the actualEndpoint is not defined. */
+        if (!actualEndpoint) {
+            throw new ErrorInternal_1.default('No endpoint selected, please select an endpoint.');
+        }
+        /* Trying to connect to the endpoint and check if the endpoint is using noauth. */
+        try {
+            const resp = await QorusRequest_1.default.get({ path: `${this.apiPathsAuthenticator.validateNoAuth}` }, endpoint);
+            if (!(resp === null || resp === void 0 ? void 0 : resp.data)) {
+                throw new ErrorInternal_1.default(`Cannot verify no-auth please check your url "${(_a = endpoint === null || endpoint === void 0 ? void 0 : endpoint.url) !== null && _a !== void 0 ? _a : (_b = this.selectedEndpoint) === null || _b === void 0 ? void 0 : _b.url}" and try again`);
+            }
+            if (!resp.data.noauth) {
+                this.noauth = false;
+                console.log('No auth disabled, authentication is required with username and password');
+                return false;
+            }
+            this.noauth = resp.data.noauth;
+            console.log('No auth enabled, authentication not required');
+            return true;
+        }
+        catch (error) {
+            throw new ErrorInternal_1.default(`Unable to connect to ${actualEndpoint.url}, please check the url / connection and try again. ${error ? JSON.stringify(error) : ''}`);
+        }
+    }
+    /**
+     * A getter to get selected Endpoint
+     * @returns Selected Endpoint if the endpoint exists, undefined otherwise
+     */
+    getSelectedEndpoint() {
+        return this.selectedEndpoint;
+    }
+    /**
+     * Checks the validity of the selected endpoint
+     * @param data Endpoint data to be checked
+     * @param withCredentials boolean to check if the endpoint has credentials
+     * @returns True if the Endpoint data is valid, False otherwise
+     */
+    validateEndpointData(data, withCredentials) {
+        let valid = true;
+        const fixedData = __classPrivateFieldGet(this, _QorusAuthenticator_instances, "m", _QorusAuthenticator_fixEndpointData).call(this, data);
+        if (!(QorusValidator_1.default.validate('string', fixedData.endpointId) &&
+            QorusValidator_1.default.validate('string', fixedData.url) &&
+            QorusValidator_1.default.validate('version', fixedData.version))) {
+            valid = false;
+        }
+        if (withCredentials &&
+            !(QorusValidator_1.default.validate('string', fixedData.user) && QorusValidator_1.default.validate('string', fixedData.pass))) {
+            valid = false;
+        }
+        return valid;
+    }
+    /**
+     * Validates the local stored authentication token for the Endpoint
+     * @param endpointId Id of the endpoint
+     * @returns Authentication token, if the authentication is successful, null otherwise
+     */
+    async validateLocalUserToken(endpointId) {
+        const authToken = (0, LocalStorage_1.getKeyValLocal)(`auth-token-${endpointId}`);
+        if (!(0, utils_1.isValidString)(authToken)) {
+            return null;
+        }
+        try {
+            const resp = await QorusRequest_1.default.get({
+                path: `${this.apiPathsAuthenticator.validateToken}`,
+                data: { token: authToken },
+            });
+            if (typeof resp === 'string') {
+                return authToken;
+            }
+            else {
+                return null;
+            }
+        }
+        catch (error) {
+            return null;
+        }
+    }
+    /**
+     * Authenticates the user to interact with the Qorus api.
+     * If the username and password is not provided it tries to authenticate the user using the locally stored token from the selected Endpoint
+     * @param loginParams LoginParams, user and pass is required to authenticate the user.
+     * @returns Authentication token if the authentication is successful, undefined otherwise.
+     */
+    async login(loginParams) {
+        var _a, _b, _c;
+        await this.checkNoAuth();
+        if (this.noauth) {
+            logger_1.default.log('No-auth enabled authentication not required.');
+            return undefined;
+        }
+        if (!this.selectedEndpoint || !(0, utils_1.isValidString)(this.selectedEndpoint.url)) {
+            throw new ErrorInternal_1.default('Endpoint must be initialized before authentication.');
+        }
+        if (!(0, utils_1.isValidStringArray)([loginParams === null || loginParams === void 0 ? void 0 : loginParams.user, loginParams === null || loginParams === void 0 ? void 0 : loginParams.pass])) {
+            throw new ErrorInternal_1.default('Username and password is required for authentication');
+        }
+        const user = (_a = loginParams === null || loginParams === void 0 ? void 0 : loginParams.user) !== null && _a !== void 0 ? _a : undefined;
+        const pass = (_b = loginParams === null || loginParams === void 0 ? void 0 : loginParams.pass) !== null && _b !== void 0 ? _b : undefined;
+        const { endpointId } = this.selectedEndpoint;
+        const currentUserToken = await this.validateLocalUserToken(endpointId);
+        if (currentUserToken && currentUserToken !== 'invalid' && this.selectedEndpoint) {
+            this.selectedEndpoint.authToken = currentUserToken;
+            return currentUserToken;
+        }
+        const resp = await QorusRequest_1.default.post({
+            path: `${this.apiPathsAuthenticator.login}`,
+            data: { user, pass },
+        });
+        const responseData = resp;
+        if (typeof (responseData === null || responseData === void 0 ? void 0 : responseData.data) === 'undefined') {
+            throw new ErrorInternal_1.default(`${responseData !== null && responseData !== void 0 ? responseData : ''}`);
+        }
+        if ((_c = responseData === null || responseData === void 0 ? void 0 : responseData.data) === null || _c === void 0 ? void 0 : _c.token) {
+            const { token } = responseData === null || responseData === void 0 ? void 0 : responseData.data;
+            if (!token) {
+                throw new Error('There was an error authenticating user, token is invalid, please try again.');
+            }
+            this.selectedEndpoint.authToken = token;
+            (0, LocalStorage_1.setKeyValLocal)({ key: `auth-token-${endpointId}`, value: token });
+            return token;
+        }
+        return undefined;
+    }
+    /**
+     * Add a new Qorus Endpoint to interact with the qorus api
+     * @param endpointConfig Endpoint configuration required to add a new endpoint
+     * @returns Newly added endpoint
+     */
+    addEndpoint(endpointConfig) {
+        const { endpointId, url } = endpointConfig;
+        const newEndpoint = __classPrivateFieldGet(this, _QorusAuthenticator_instances, "m", _QorusAuthenticator_fixEndpointData).call(this, endpointConfig);
+        /* Checking if the id and url are valid strings. */
+        if (!(0, utils_1.isValidStringArray)([endpointId, url])) {
+            throw new ErrorInternal_1.default('Id and url is required to initialize an endpoint');
+        }
+        /* Checking if the endpoint already exists. */
+        if (this.getEndpointById(endpointId)) {
+            throw new ErrorInternal_1.default(`Endpoint with the id "${endpointId}" already exists, please try again with a different id`);
+        }
+        /* Adding a new endpoint to the endpoints array. */
+        this.endpoints.push(newEndpoint);
+        this.selectedEndpoint = newEndpoint;
+        return this.selectedEndpoint;
+    }
+    /**
+     * Allows the user to renew the selected endpoint authentication token
+     * @param loginParams LoginParams optional username and password can be provided
+     * @returns Token if the authentication is successful, undefined otherwise
+     */
+    async renewSelectedEndpointToken(loginParams) {
+        const { user, pass } = loginParams;
+        if (!this.selectedEndpoint || !(0, utils_1.isValidString)(this.selectedEndpoint.url)) {
+            console.error(new ErrorInternal_1.default('Endpoint is not selected, please initialize an endpoint to renew token'));
+            return undefined;
+        }
+        if (!(0, utils_1.isValidStringArray)([user, pass])) {
+            throw new ErrorInternal_1.default('Username and password is required to revalidate endpoint token.');
+        }
+        const token = await this.login({ user, pass });
+        if ((0, utils_1.isValidString)(token)) {
+            this.selectedEndpoint.authToken = token;
+            return token;
+        }
+        console.error(new ErrorInternal_1.default('Username and password are not valid, please try again'));
+        return undefined;
+    }
+    /**
+     * A getter to return the auth token of the selected Endpoint
+     * @returns token if the the selected endpoint exists and the user is authenticated, otherwise returns undefined
+     */
+    getAuthToken() {
+        var _a;
+        return (_a = this.selectedEndpoint) === null || _a === void 0 ? void 0 : _a.authToken;
+    }
+    /**
+     * A getter to get the api Version of a Endpoint
+     * @param endpointId Optional id parameter to get the version of a particular endpoint
+     * @returns Version of the selected endpoint or version of the the endpoint found by id,
+     * if the endpoint doesn't exists it returns undefined
+     */
+    getEndpointVersion(endpointId) {
+        var _a;
+        if ((0, utils_1.isValidString)(endpointId)) {
+            return (_a = this.getEndpointById(endpointId)) === null || _a === void 0 ? void 0 : _a.version;
+        }
+        else {
+            if (this.selectedEndpoint) {
+                return this.selectedEndpoint.version;
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Validates if the provided version is an accepted api version
+     * @param version Version of the endpoint
+     * @returns True if the version is valid, False otherwise
+     */
+    validateVersion(version) {
+        const versions = [1, 2, 3, 4, 5, 6, 'latest'];
+        return versions.includes(version);
+    }
+    /**
+     * A setter to set the Version of a Endpoint
+     * @param version Version of the qorus api
+     * @param endpointId Optional parameter to change the url of a particular endpoint from the endpoints array
+     * @returns Version of the endpoint if the operation is successful, undefined otherwise
+     *
+     */
+    async setEndpointVersion(version, endpointId) {
+        var _a;
+        if (!endpointId)
+            endpointId = (_a = this.selectedEndpoint) === null || _a === void 0 ? void 0 : _a.endpointId;
+        if ((0, utils_1.isValidString)(endpointId) && this.validateVersion(version)) {
+            const endpoint = this.getEndpointById(endpointId);
+            await this.logout();
+            if (endpoint && (0, utils_1.isValidString)(endpoint.url)) {
+                this.endpoints[this.endpoints.indexOf(endpoint)].version = version;
+                if (this.selectedEndpoint && this.selectedEndpoint.endpointId === endpoint.endpointId) {
+                    this.selectedEndpoint.version = version;
+                    this.allApiPaths = (0, apiPaths_1.createApiPaths)({ version });
+                    this.apiPathsAuthenticator = this.allApiPaths.authenticator;
+                }
+                logger_1.default.log('Changed endpoint version successfully.');
+                return version;
+            }
+            throw new ErrorInternal_1.default('Endpoint does not exist, please initialize an endpoint and try again.');
+        }
+        throw new ErrorInternal_1.default('Id and a valid version is required to change the version of a endpoint.');
+    }
+    /**
+     * A setter to set the url of the selected Endpoint
+     * @param url Base url for the endpoint
+     * @param id Optional id parameter to change the url of a particular endpoint
+     * @returns Url of the endpoint if the operation is successful, undefined otherwise
+     */
+    async setEndpointUrl(url, endpointId) {
+        var _a;
+        if (!(0, utils_1.isValidString)(endpointId))
+            endpointId = (_a = this.selectedEndpoint) === null || _a === void 0 ? void 0 : _a.endpointId;
+        if ((0, utils_1.isValidStringArray)([endpointId, url])) {
+            const endpoint = this.getEndpointById(endpointId);
+            await this.logout();
+            if (endpoint && (0, utils_1.isValidString)(endpoint.url)) {
+                this.endpoints[this.endpoints.indexOf(endpoint)].url = url;
+                if (this.selectedEndpoint && this.selectedEndpoint.endpointId === endpoint.endpointId) {
+                    this.selectedEndpoint.url = url;
+                }
+                logger_1.default.log('Changed endpoint url successfully.');
+                return url;
+            }
+            throw new ErrorInternal_1.default('Endpoint does not exist, please initialize an endpoint and try again.');
+        }
+        throw new ErrorInternal_1.default('Id and url is required to change the version of a endpoint.');
+    }
+    /**
+     * A getter to return the api paths for the selected Endpoint
+     * @returns ApiPaths for the selected endpoint if exists, otherwise returns default api paths
+     */
+    getApiPaths() {
+        return this.allApiPaths;
+    }
+    /**
+     * A getter to get all the available Endpoints
+     * @returns Endpoints array with all the available endpoints
+     */
+    getAllEndpoints() {
+        return this.endpoints;
+    }
+}
+exports.QorusAuthenticator = QorusAuthenticator;
+_QorusAuthenticator_instances = new WeakSet(), _QorusAuthenticator_fixEndpointData = function _QorusAuthenticator_fixEndpointData(data) {
+    const newData = Object.assign({}, data);
+    if (!newData.version) {
+        newData.version = 'latest';
+    }
+    return newData;
+};
+exports.default = new QorusAuthenticator();
+//# sourceMappingURL=QorusAuthenticator.js.map