node-pluginsmanager-plugin 4.8.8 → 5.0.0

package/lib/cjs/checkers/TypeError/checkString.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkString = exports.checkStringSync = void 0;
+//  deps
+// locals
+const checkExists_1 = require("../ReferenceError/checkExists");
+// module
+function checkStringSync(dataName, data) {
+    let err = (0, checkExists_1.checkExistsSync)(dataName, data);
+    if (!err && "string" !== typeof data) {
+        err = new TypeError("\"" + dataName + "\" is not a string");
+    }
+    return err;
+}
+exports.checkStringSync = checkStringSync;
+;
+function checkString(dataName, data) {
+    const err = checkStringSync(dataName, data);
+    return err ? Promise.reject(err) : Promise.resolve();
+}
+exports.checkString = checkString;
+;

package/lib/cjs/components/DescriptorUser.d.ts

@@ -0,0 +1,27 @@
+/// <reference types="node" />
+import Events from "events";
+import { OpenApiDocument } from "express-openapi-validate";
+export declare type tLogType = "log" | "info" | "success" | "warning" | "error";
+export declare type tLogger = (type: tLogType, message: string | Error, bold?: boolean, pluginName?: string) => void;
+export interface iDescriptorUserOptions {
+    "externalRessourcesDirectory": string;
+    "descriptor"?: OpenApiDocument;
+    "logger"?: tLogger;
+}
+export default class DescriptorUser extends Events {
+    initialized: boolean;
+    protected _descriptorValidated: boolean;
+    protected _externalRessourcesDirectory: string;
+    protected _Descriptor: OpenApiDocument | null;
+    protected _Logger: tLogger | null;
+    constructor(options: iDescriptorUserOptions);
+    protected _initWorkSpace(...data: Array<any>): Promise<void>;
+    protected _releaseWorkSpace(...data: Array<any>): Promise<void>;
+    protected _log(type: tLogType, message: string | Error, bold?: boolean): this;
+    getPluginName(): string;
+    getPluginVersion(): string;
+    getPluginDescription(): string;
+    init(...data: Array<any>): Promise<void>;
+    release(...data: Array<any>): Promise<void>;
+    checkDescriptor(): Promise<void>;
+}

package/lib/cjs/components/DescriptorUser.js

@@ -0,0 +1,120 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+//  deps
+// natives
+const events_1 = __importDefault(require("events"));
+// locals
+const checkObject_1 = require("../checkers/TypeError/checkObject");
+const checkNonEmptyObject_1 = require("../checkers/RangeError/checkNonEmptyObject");
+const checkNonEmptyString_1 = require("../checkers/RangeError/checkNonEmptyString");
+;
+// consts
+const LOG_TYPES_ALLOWED = ["log", "info", "success", "warning", "error"];
+// module
+// Please note the fact that "_initWorkSpace" and "_releaseWorkSpace" method MUST be re-writted in Mediator class, and not in MediatorUser childs.
+// Please note the fact that "init" and "release" method MUST NOT be re-writted. Each child has is own init logic.
+class DescriptorUser extends events_1.default {
+    // constructor
+    constructor(options) {
+        super();
+        // public
+        this.initialized = false;
+        // protected
+        this._descriptorValidated = false;
+        this._externalRessourcesDirectory = options && "string" === typeof options.externalRessourcesDirectory ?
+            options.externalRessourcesDirectory : "";
+        this._Descriptor = options && "object" === typeof options.descriptor ?
+            options.descriptor : null;
+        this._Logger = options && "function" === typeof options.logger ?
+            options.logger : null;
+    }
+    // protected
+    // must be inherited
+    _initWorkSpace(...data) {
+        return Promise.reject(new Error("\"_initWorkSpace\" method must be inherited"));
+    }
+    // must be inherited
+    _releaseWorkSpace(...data) {
+        return Promise.reject(new Error("\"_releaseWorkSpace\" method must be inherited"));
+    }
+    _log(type, message, bold) {
+        if (message && "function" === typeof this._Logger && LOG_TYPES_ALLOWED.includes(type)) {
+            this._Logger(type, message, bold, this.getPluginName());
+        }
+        return this;
+    }
+    // public
+    getPluginName() {
+        return this._Descriptor && this._Descriptor.info && this._Descriptor.info.title ? this._Descriptor.info.title : "";
+    }
+    getPluginVersion() {
+        return this._Descriptor && this._Descriptor.info && this._Descriptor.info.version ? this._Descriptor.info.version : "";
+    }
+    getPluginDescription() {
+        return this._Descriptor && this._Descriptor.info && this._Descriptor.info.description ? this._Descriptor.info.description : "";
+    }
+    // must be inherited
+    init(...data) {
+        console.log("DescriptorUser", "init", ...data);
+        return Promise.reject(new Error("\"init\" method must be inherited"));
+    }
+    // must be inherited
+    release(...data) {
+        console.log("DescriptorUser", "release", ...data);
+        return Promise.reject(new Error("\"release\" method must be inherited"));
+    }
+    // must be inherited
+    checkDescriptor() {
+        // check Descriptor object
+        return this._descriptorValidated ? Promise.resolve() : (0, checkNonEmptyObject_1.checkNonEmptyObject)("Descriptor", this._Descriptor).then(() => {
+            // check info object
+            return (0, checkNonEmptyObject_1.checkNonEmptyObject)("Descriptor.info", this._Descriptor.info).then(() => {
+                // check title
+                return (0, checkNonEmptyString_1.checkNonEmptyString)("Descriptor.info.title", this._Descriptor.info.title).then(() => {
+                    return this._Descriptor.info.title !== this._Descriptor.info.title.toLowerCase() ?
+                        Promise.reject(new Error("The descriptor's title (\"" + this._Descriptor.info.title + "\") " +
+                            "is not equals in lower case (package.json convention)")) : Promise.resolve();
+                    // check version
+                }).then(() => {
+                    return (0, checkNonEmptyString_1.checkNonEmptyString)("Descriptor.info.version", this._Descriptor.info.version);
+                });
+            });
+        }).then(() => {
+            // check paths object
+            return ((0, checkObject_1.checkObject)("Descriptor.paths", this._Descriptor.paths)).then(() => {
+                // check multiple operationIds
+                return Promise.resolve().then(() => {
+                    const operationIds = [];
+                    Object.keys(this._Descriptor.paths).forEach((p) => {
+                        Object.keys(this._Descriptor.paths[p]).forEach((m) => {
+                            const path = this._Descriptor.paths[p];
+                            if (path[m].operationId) {
+                                operationIds.push(path[m].operationId);
+                            }
+                        });
+                    });
+                    let multiple = false;
+                    for (let i = 0; i < operationIds.length - 1; ++i) {
+                        for (let j = i + 1; j < operationIds.length; ++j) {
+                            if (operationIds[i] === operationIds[j]) {
+                                multiple = true;
+                                break;
+                            }
+                        }
+                        if (multiple) {
+                            break;
+                        }
+                    }
+                    return multiple ? Promise.reject(new Error("There is multiple operationIds in [\" " + operationIds.join("\", ") + " \"]")) : Promise.resolve();
+                });
+            });
+        }).then(() => {
+            this._descriptorValidated = true;
+        });
+    }
+}
+exports.default = DescriptorUser;
+;

package/lib/cjs/components/Mediator.d.ts

@@ -0,0 +1,19 @@
+import { OpenApiValidator } from "express-openapi-validate";
+import { iServerResponse } from "./Server";
+import DescriptorUser, { iDescriptorUserOptions } from "./DescriptorUser";
+export interface iUrlParameters {
+    "path": object;
+    "query": object;
+    "headers": object;
+    "cookies": object;
+}
+export default class Mediator extends DescriptorUser {
+    protected _validator: OpenApiValidator | null;
+    constructor(options: iDescriptorUserOptions);
+    checkParameters(operationId: string, urlParams: iUrlParameters, bodyParams: {
+        [key: string]: any;
+    }): Promise<void>;
+    checkResponse(operationId: string, res: iServerResponse): Promise<void>;
+    init(...data: Array<any>): Promise<void>;
+    release(...data: Array<any>): Promise<void>;
+}

package/lib/cjs/components/Mediator.js

@@ -0,0 +1,145 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// externals
+const express_openapi_validate_1 = require("express-openapi-validate");
+const checkObject_1 = require("../checkers/TypeError/checkObject");
+const checkNonEmptyString_1 = require("../checkers/RangeError/checkNonEmptyString");
+const checkNonEmptyObject_1 = require("../checkers/RangeError/checkNonEmptyObject");
+const extractPathMethodByOperationId_1 = __importDefault(require("../utils/descriptor/extractPathMethodByOperationId"));
+const DescriptorUser_1 = __importDefault(require("./DescriptorUser"));
+// module
+class Mediator extends DescriptorUser_1.default {
+    // constructor
+    constructor(options) {
+        super(options);
+        this._validator = null;
+    }
+    // public
+    // Check sended parameters by method name (used by the Server)
+    checkParameters(operationId, urlParams, bodyParams) {
+        // parameters validation
+        return this.checkDescriptor().then(() => {
+            return (0, checkNonEmptyString_1.checkNonEmptyString)("operationId", operationId);
+        }).then(() => {
+            return (0, checkNonEmptyObject_1.checkNonEmptyObject)("urlParams", urlParams).then(() => {
+                return (0, checkObject_1.checkObject)("urlParams.path", urlParams.path);
+            }).then(() => {
+                return (0, checkObject_1.checkObject)("urlParams.query", urlParams.query);
+            }).then(() => {
+                return (0, checkObject_1.checkObject)("urlParams.headers", urlParams.headers);
+            }).then(() => {
+                return (0, checkObject_1.checkObject)("urlParams.cookies", urlParams.cookies);
+            });
+        }).then(() => {
+            return (0, checkObject_1.checkObject)("bodyParams", bodyParams);
+        }).then(() => {
+            // search wanted operation
+            const foundPathMethod = (0, extractPathMethodByOperationId_1.default)(this._Descriptor.paths, operationId);
+            return !foundPathMethod ? Promise.reject(new ReferenceError("Unknown operationId \"" + operationId + "\"")) : new Promise((resolve, reject) => {
+                const req = {
+                    "path": foundPathMethod.path,
+                    "method": foundPathMethod.method,
+                    "params": urlParams.path,
+                    "query": urlParams.query,
+                    "headers": urlParams.headers,
+                    "cookies": urlParams.cookies,
+                    "body": bodyParams
+                };
+                const validateRequest = this._validator.validate(req.method, req.path); // set to "any" for ts validation
+                validateRequest(req, null, (err) => {
+                    return err ? reject(err) : resolve();
+                });
+            });
+        }).catch((err) => {
+            return err instanceof express_openapi_validate_1.ValidationError ? Promise.resolve().then(() => {
+                switch (err.data[0].keyword) { // extract first Error
+                    case "required":
+                        return Promise.reject(new ReferenceError(err.message));
+                    case "type":
+                        return Promise.reject(new TypeError(err.message));
+                    case "minimum":
+                    case "maximum":
+                    case "minLength":
+                    case "maxLength":
+                    case "minItems":
+                    case "maxItems":
+                    case "enum":
+                        return Promise.reject(new RangeError(err.message));
+                    default:
+                        return Promise.reject(new Error(err.message));
+                }
+            }) : Promise.reject(err);
+        });
+    }
+    // Check sended parameters by method name (used by the Server)
+    checkResponse(operationId, res) {
+        // parameters validation
+        return this.checkDescriptor().then(() => {
+            return (0, checkNonEmptyString_1.checkNonEmptyString)("operationId", operationId);
+        }).then(() => {
+            // search wanted operation
+            const foundPathMethod = (0, extractPathMethodByOperationId_1.default)(this._Descriptor.paths, operationId);
+            return !foundPathMethod ? Promise.reject(new ReferenceError("Unknown operationId \"" + operationId + "\"")) : new Promise((resolve, reject) => {
+                // no content, no validation
+                if (204 === res.statusCode) {
+                    return "undefined" !== typeof res.body ? reject(new ReferenceError("You should not have content data with 204 statusCode")) : resolve();
+                }
+                // no content, no validation (put requests)
+                else if (201 === res.statusCode && "undefined" === typeof res.body) {
+                    return resolve();
+                }
+                // validator cannot correctly check pure boolean return
+                else if ("undefined" !== typeof res.body && ["true", "false"].includes(res.body)) {
+                    return resolve();
+                }
+                else {
+                    try {
+                        res.headers = res.getHeaders();
+                        if ("undefined" === typeof res.body) {
+                            res.body = null;
+                        }
+                        else {
+                            res.body = "string" === typeof res.body ? JSON.parse(res.body) : res.body;
+                        }
+                        const validateResponse = this._validator.validateResponse(foundPathMethod.method, foundPathMethod.path);
+                        validateResponse(res);
+                        return resolve();
+                    }
+                    catch (e) {
+                        return reject(new Error("[" + foundPathMethod.method + "]" +
+                            foundPathMethod.path +
+                            " (" + foundPathMethod.operationId + ") => " +
+                            res.statusCode +
+                            "\r\n" +
+                            (e.message ? e.message : e)));
+                    }
+                }
+            });
+        });
+    }
+    // init / release
+    init(...data) {
+        return this._initWorkSpace(...data).then(() => {
+            this._validator = new express_openapi_validate_1.OpenApiValidator(this._Descriptor);
+            this.initialized = true;
+            this.emit("initialized", ...data);
+        });
+    }
+    release(...data) {
+        return this._releaseWorkSpace(...data).then(() => {
+            // can only be released by Orchestrator
+            this._Descriptor = null;
+            this._validator = null;
+            this.initialized = false;
+            this.emit("released", ...data);
+        }).then(() => {
+            this.removeAllListeners();
+        });
+    }
+}
+exports.default = Mediator;
+;

package/lib/cjs/components/MediatorUser.d.ts

@@ -0,0 +1,12 @@
+import DescriptorUser, { iDescriptorUserOptions } from "./DescriptorUser";
+import Mediator from "./Mediator";
+export interface iMediatorUserOptions extends iDescriptorUserOptions {
+    "mediator"?: Mediator;
+}
+export default class MediatorUser extends DescriptorUser {
+    protected _Mediator: Mediator | null;
+    constructor(options: iMediatorUserOptions);
+    _initWorkSpace(...data: Array<any>): Promise<void>;
+    _releaseWorkSpace(...data: Array<any>): Promise<void>;
+    checkMediator(): Promise<void>;
+}

package/lib/cjs/components/MediatorUser.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+//  deps
+// locals
+const DescriptorUser_1 = __importDefault(require("./DescriptorUser"));
+const Mediator_1 = __importDefault(require("./Mediator"));
+// module
+// Please note the fact that "init" and "release" method MUST NOT be re-writted. Each child has is own init logic
+class MediatorUser extends DescriptorUser_1.default {
+    // constructor
+    constructor(options) {
+        super(options);
+        this._Mediator = options && "undefined" !== typeof options.mediator ?
+            options.mediator : null;
+    }
+    // protected
+    _initWorkSpace(...data) {
+        return Promise.resolve();
+    }
+    _releaseWorkSpace(...data) {
+        return Promise.resolve();
+    }
+    // public
+    checkMediator() {
+        if ("undefined" === typeof this._Mediator || null === this._Mediator) {
+            return Promise.reject(new ReferenceError("Mediator not registered"));
+        }
+        else if ("object" !== typeof this._Mediator || !(this._Mediator instanceof Mediator_1.default)) {
+            return Promise.reject(new TypeError("The plugin has an invalid Mediator which is not an instance (or a child) of the official Mediator class"));
+        }
+        else {
+            return Promise.resolve();
+        }
+    }
+}
+exports.default = MediatorUser;
+;

package/lib/cjs/components/NotFoundError.d.ts

@@ -0,0 +1,2 @@
+export default class NotFoundError extends Error {
+}

package/lib/cjs/components/NotFoundError.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// module
+class NotFoundError extends Error {
+}
+exports.default = NotFoundError;
+;

package/lib/cjs/components/Orchestrator.d.ts

@@ -0,0 +1,54 @@
+import { Server as WebSocketServer } from "ws";
+import { Server as SocketIOServer } from "socket.io";
+import MediatorUser from "./MediatorUser";
+import Server, { iIncomingMessage, iServerResponse } from "./Server";
+export interface iOrchestratorOptions {
+    "externalRessourcesDirectory": string;
+    "packageFile": string;
+    "descriptorFile": string;
+    "mediatorFile": string;
+    "serverFile": string;
+}
+export default class Orchestrator extends MediatorUser {
+    protected _Server: Server | null;
+    protected _socketServer: WebSocketServer | SocketIOServer | null;
+    protected _checkParameters: boolean;
+    protected _checkResponse: boolean;
+    protected _packageFile: string;
+    protected _descriptorFile: string;
+    protected _mediatorFile: string;
+    protected _serverFile: string;
+    protected _extended: Array<string>;
+    enabled: boolean;
+    authors: Array<string>;
+    description: string;
+    dependencies: object | null;
+    devDependencies: object | null;
+    engines: object | null;
+    license: string;
+    main: string;
+    name: string;
+    scripts: object | null;
+    version: string;
+    constructor(options: iOrchestratorOptions);
+    checkDescriptor(): Promise<void>;
+    checkConf(): Promise<void>;
+    isEnable(): Promise<void>;
+    checkFiles(): Promise<void>;
+    checkServer(): Promise<void>;
+    disableCheckParameters(): this;
+    enableCheckParameters(): this;
+    disableCheckResponse(): this;
+    enableCheckResponse(): this;
+    disableCors(): this;
+    enableCors(): this;
+    appMiddleware(req: iIncomingMessage, res: iServerResponse, next: Function): void;
+    socketMiddleware(server: WebSocketServer | SocketIOServer): void;
+    load(): Promise<void>;
+    destroy(): Promise<void>;
+    init(...data: Array<any>): Promise<void>;
+    release(...data: Array<any>): Promise<void>;
+    install(): Promise<void>;
+    update(): Promise<void>;
+    uninstall(): Promise<void>;
+}