node-pluginsmanager-plugin 6.0.3 → 6.1.0

package/lib/cjs/components/Mediator.js

@@ -1,147 +1,144 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const checkExists_1 = require("../checkers/ReferenceError/checkExists");
-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"));
-// types & interfaces
-// externals
-const express_openapi_validate_1 = require("express-openapi-validate");
-;
-;
-;
-// 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, checkExists_1.checkExists)("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 {
-                        const mutedRes = Object.assign({}, res);
-                        mutedRes.headers = res.getHeaders();
-                        if ("undefined" === typeof mutedRes.body || "" === mutedRes.body) {
-                            mutedRes.body = {};
-                        }
-                        const validateResponse = this._validator.validateResponse(foundPathMethod.method, foundPathMethod.path);
-                        validateResponse(mutedRes);
-                        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;
-;
+"use strict";
+// deps
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// externals
+const express_openapi_validate_1 = require("express-openapi-validate");
+// locals
+const checkExists_1 = require("../checkers/ReferenceError/checkExists");
+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, checkExists_1.checkExists)("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 {
+                        const mutedRes = Object.assign({}, res);
+                        mutedRes.headers = res.getHeaders();
+                        if ("undefined" === typeof mutedRes.body || "" === mutedRes.body) {
+                            mutedRes.body = {};
+                        }
+                        const validateResponse = this._validator.validateResponse(foundPathMethod.method, foundPathMethod.path);
+                        validateResponse(mutedRes);
+                        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

@@ -1,4 +1,4 @@
-import DescriptorUser, { iDescriptorUserOptions } from "./DescriptorUser";
+import DescriptorUser, { type iDescriptorUserOptions } from "./DescriptorUser";
 import Mediator from "./Mediator";
 export interface iMediatorUserOptions extends iDescriptorUserOptions {
     "mediator"?: Mediator;

package/lib/cjs/components/MediatorUser.js

@@ -1,9 +1,9 @@
 "use strict";
+//  deps
 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"));
@@ -13,8 +13,9 @@ class MediatorUser extends DescriptorUser_1.default {
     // constructor
     constructor(options) {
         super(options);
-        this._Mediator = options && "undefined" !== typeof options.mediator ?
-            options.mediator : null;
+        this._Mediator = options && "undefined" !== typeof options.mediator
+            ? options.mediator
+            : null;
     }
     // protected
     _initWorkSpace(...data) {
@@ -37,4 +38,3 @@ class MediatorUser extends DescriptorUser_1.default {
     }
 }
 exports.default = MediatorUser;
-;

package/lib/cjs/components/NotFoundError.js

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

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

@@ -1,9 +1,8 @@
 import MediatorUser from "./MediatorUser";
-import Server from "./Server";
-import { Server as WebSocketServer } from "ws";
-import { Server as SocketIOServer } from "socket.io";
-import { tLogger } from "./DescriptorUser";
-import { iIncomingMessage, iServerResponse } from "./Server";
+import Server, { type iIncomingMessage, type iServerResponse } from "./Server";
+import type { Server as WebSocketServer } from "ws";
+import type { Server as SocketIOServer } from "socket.io";
+import type { tLogger } from "./DescriptorUser";
 export interface iOrchestratorOptions {
     "externalRessourcesDirectory": string;
     "packageFile": string;
@@ -21,9 +20,9 @@ export default class Orchestrator extends MediatorUser {
     protected _descriptorFile: string;
     protected _mediatorFile: string;
     protected _serverFile: string;
-    protected _extended: Array<string>;
+    protected _extended: string[];
     enabled: boolean;
-    authors: Array<string>;
+    authors: string[];
     description: string;
     dependencies: object | null;
     devDependencies: object | null;
@@ -44,7 +43,7 @@ export default class Orchestrator extends MediatorUser {
     enableCheckResponse(): this;
     disableCors(): this;
     enableCors(): this;
-    appMiddleware(req: iIncomingMessage, res: iServerResponse, next: Function): void;
+    appMiddleware(req: iIncomingMessage, res: iServerResponse, next: () => void): void;
     socketMiddleware(server: WebSocketServer | SocketIOServer): void;
     load(...data: any): Promise<void>;
     destroy(...data: any): Promise<void>;

package/lib/cjs/components/Orchestrator.js

@@ -1,9 +1,9 @@
 "use strict";
+// deps
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// deps
 // natives
 const node_path_1 = require("node:path");
 // locals
@@ -12,7 +12,6 @@ const MediatorUser_1 = __importDefault(require("./MediatorUser"));
 const Server_1 = __importDefault(require("./Server"));
 const checkFile_1 = __importDefault(require("../utils/file/checkFile"));
 const readJSONFile_1 = __importDefault(require("../utils/file/readJSONFile"));
-;
 // module
 class Orchestrator extends MediatorUser_1.default {
     // constructor
@@ -264,14 +263,14 @@ class Orchestrator extends MediatorUser_1.default {
                     });
                     // compare title to package name
                 }).then(() => {
-                    return this._Descriptor.info.title !== this.name ? Promise.reject(new Error("The descriptor's title (\"" + this._Descriptor.info.title + "\") " +
-                        "is not equals to " +
-                        "the package's name (\"" + this.name + "\")")) : Promise.resolve();
+                    return this._Descriptor.info.title !== this.name ? Promise.reject(new Error("The descriptor's title (\"" + this._Descriptor.info.title + "\") "
+                        + "is not equals to "
+                        + "the package's name (\"" + this.name + "\")")) : Promise.resolve();
                     // compare version to package version
                 }).then(() => {
-                    return this._Descriptor.info.version !== this.version ? Promise.reject(new Error("The descriptor's version (\"" + this._Descriptor.info.version + "\") " +
-                        "is not equals to " +
-                        "the package's version (\"" + this.version + "\")")) : Promise.resolve();
+                    return this._Descriptor.info.version !== this.version ? Promise.reject(new Error("The descriptor's version (\"" + this._Descriptor.info.version + "\") "
+                        + "is not equals to "
+                        + "the package's version (\"" + this.version + "\")")) : Promise.resolve();
                 });
                 // create Mediator
             }).then(() => {
@@ -397,4 +396,3 @@ class Orchestrator extends MediatorUser_1.default {
     }
 }
 exports.default = Orchestrator;
-;

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

@@ -1,9 +1,8 @@
 /// <reference types="node" />
-import MediatorUser from "./MediatorUser";
-import { IncomingMessage, ServerResponse } from "node:http";
-import { Server as WebSocketServer } from "ws";
-import { Server as SocketIOServer } from "socket.io";
-import { iMediatorUserOptions } from "./MediatorUser";
+import MediatorUser, { type iMediatorUserOptions } from "./MediatorUser";
+import type { IncomingMessage, ServerResponse } from "node:http";
+import type { Server as WebSocketServer } from "ws";
+import type { Server as SocketIOServer } from "socket.io";
 export interface iClient {
     "id": string;
     "status": "CONNECTED" | "DISCONNECTED";
@@ -12,25 +11,15 @@ export interface iIncomingMessage extends IncomingMessage {
     "method": string;
     "pattern": string;
     "validatedIp": string;
-    "headers": {
-        [key: string]: any;
-    };
-    "cookies": {
-        [key: string]: any;
-    };
-    "query": {
-        [key: string]: any;
-    };
-    "params": {
-        [key: string]: any;
-    };
+    "headers": Record<string, any>;
+    "cookies": Record<string, any>;
+    "query": Record<string, any>;
+    "params": Record<string, any>;
     "body": string;
 }
 export interface iServerResponse extends ServerResponse {
     "body": string;
-    "headers": {
-        [key: string]: any;
-    };
+    "headers": Record<string, any>;
 }
 export default class Server extends MediatorUser {
     protected _socketServer: WebSocketServer | SocketIOServer | null;
@@ -39,16 +28,19 @@ export default class Server extends MediatorUser {
     protected _cors: boolean;
     constructor(opt: iMediatorUserOptions);
     protected _serverType(): "NO_SERVER" | "WEBSOCKET" | "SOCKETIO" | "UNKNOWN";
+    protected _getUsableSocketIOClient(clientId: string): {
+        "emit": (event: string, data: any) => void;
+    } | undefined;
     disableCheckParameters(): this;
     enableCheckParameters(): this;
     disableCheckResponse(): this;
     enableCheckResponse(): this;
     disableCors(): this;
     enableCors(): this;
-    appMiddleware(req: iIncomingMessage, res: iServerResponse, next: Function): void;
+    appMiddleware(req: iIncomingMessage, res: iServerResponse, next: () => void): void;
     socketMiddleware(socketServer: WebSocketServer | SocketIOServer): void;
     push(command: string, data?: any, log?: boolean): this;
-    getClients(): Array<iClient>;
+    getClients(): iClient[];
     pushClient(clientId: string, command: string, data: any, log?: boolean): this;
     init(...data: any): Promise<void>;
     release(...data: any): Promise<void>;