node-pluginsmanager-plugin 6.5.0 → 7.0.1

package/lib/cjs/components/Orchestrator.js

@@ -1,9 +1,16 @@
 "use strict";
-// deps
+/*
+    eslint-disable @typescript-eslint/no-unused-vars, @typescript-eslint/no-dynamic-delete, @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
+*/
+// => @typescript-eslint/no-unused-vars is disabled to allow inheritance with proper signature
+// => @typescript-eslint/no-dynamic-delete is disabled to allow data release
+// => @typescript-eslint/no-require-imports is disabled to allow dynamic Mediator import on plugin load
+// => @typescript-eslint/no-var-requires is disabled for the same reason as @typescript-eslint/no-require-imports
 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
@@ -14,6 +21,31 @@ const checkFile_1 = __importDefault(require("../utils/file/checkFile"));
 const readJSONFile_1 = __importDefault(require("../utils/file/readJSONFile"));
 // module
 class Orchestrator extends MediatorUser_1.default {
+    // attributes
+    // protected
+    _Server;
+    _socketServer;
+    _checkParameters;
+    _checkResponse;
+    // params
+    _packageFile;
+    _descriptorFile;
+    _mediatorFile;
+    _serverFile;
+    _extended;
+    // public
+    enabled;
+    // native
+    authors;
+    description;
+    dependencies;
+    devDependencies;
+    engines;
+    license;
+    main;
+    name;
+    scripts;
+    version;
     // constructor
     constructor(options) {
         super(options);
@@ -22,11 +54,23 @@ class Orchestrator extends MediatorUser_1.default {
         this._socketServer = null; // to delay socketMiddleware if necessary
         this._checkParameters = true; // to delay checkParameters if necessary
         this._checkResponse = true; // to delay checkResponse if necessary
-        // params
-        this._packageFile = options && "string" === typeof options.packageFile ? options.packageFile : "";
-        this._descriptorFile = options && "string" === typeof options.descriptorFile ? options.descriptorFile : "";
-        this._mediatorFile = options && "string" === typeof options.mediatorFile ? options.mediatorFile : "";
-        this._serverFile = options && "string" === typeof options.serverFile ? options.serverFile : "";
+        // mandatory props
+        if ("string" !== typeof options.packageFile) {
+            throw new ReferenceError("\"options.packageFile\" must be a string");
+        }
+        if ("string" !== typeof options.descriptorFile) {
+            throw new ReferenceError("\"options.descriptorFile\" must be a string");
+        }
+        if ("string" !== typeof options.mediatorFile) {
+            throw new ReferenceError("\"options.mediatorFile\" must be a string");
+        }
+        if ("string" !== typeof options.serverFile) {
+            throw new ReferenceError("\"options.serverFile\" must be a string");
+        }
+        this._packageFile = options.packageFile;
+        this._descriptorFile = options.descriptorFile;
+        this._mediatorFile = options.mediatorFile;
+        this._serverFile = options.serverFile;
         // extended
         this._extended = [];
         // public
@@ -121,7 +165,7 @@ class Orchestrator extends MediatorUser_1.default {
         this.checkServer().then(() => {
             this._Server.disableCors();
         }).catch((err) => {
-            this._emitEventGenericForTSPurposeDONOTUSE("error", err);
+            this.emit("error", err);
         });
         return this;
     }
@@ -129,24 +173,24 @@ class Orchestrator extends MediatorUser_1.default {
         this.checkServer().then(() => {
             this._Server.enableCors();
         }).catch((err) => {
-            this._emitEventGenericForTSPurposeDONOTUSE("error", err);
+            this.emit("error", err);
         });
         return this;
     }
     appMiddleware(req, res, next) {
         if (!this.enabled) {
             next();
+            return;
         }
         else if (!this.initialized) {
             next();
+            return;
         }
-        else {
-            this.checkServer().then(() => {
-                this._Server.appMiddleware(req, res, next);
-            }).catch(() => {
-                next();
-            });
-        }
+        this.checkServer().then(() => {
+            this._Server.appMiddleware(req, res, next);
+        }).catch(() => {
+            next();
+        });
     }
     socketMiddleware(server) {
         if (!this.enabled) {
@@ -163,7 +207,7 @@ class Orchestrator extends MediatorUser_1.default {
     // load / destroy
     load(...data) {
         return this.checkFiles().then(() => {
-            return (0, readJSONFile_1.default)((0, node_path_1.join)(__dirname, "..", "..", "..", "package.json"));
+            return (0, readJSONFile_1.default)((0, node_path_1.join)(__dirname, "..", "..", "..", "package.json")); // enforce current core engine version
         }).then(({ engines }) => {
             // native
             this.authors = [];
@@ -178,32 +222,39 @@ class Orchestrator extends MediatorUser_1.default {
             this.version = "";
             return (0, readJSONFile_1.default)(this._packageFile);
             // formate authors
-        }).then((data) => {
-            if (data.authors) {
-                this.authors = data.authors;
-                delete data.authors;
-                if (data.author) {
-                    if (!this.authors.includes(data.author)) {
-                        this.authors.push(data.author);
+        }).then((packageData) => {
+            if ("undefined" !== typeof packageData.authors) {
+                if (Array.isArray(packageData.authors)) {
+                    this.authors = packageData.authors;
+                    delete packageData.authors;
+                    if ("string" === typeof packageData.author) {
+                        const { author } = packageData;
+                        if (!this.authors.includes(author)) {
+                            this.authors.push(author);
+                        }
+                        delete packageData.author;
                     }
-                    delete data.author;
                 }
+                delete packageData.authors;
             }
-            else if (data.author) {
-                this.authors = [data.author];
-                delete data.author;
+            else if ("string" === typeof packageData.author) {
+                this.authors = [packageData.author];
+                delete packageData.author;
             }
-            return Promise.resolve(data);
+            return packageData;
             // formate other data
-        }).then((data) => {
-            const self = this;
-            Object.keys(data).forEach((key) => {
-                if ("function" !== typeof self[key]) {
-                    if ("undefined" === typeof self[key]) {
-                        this._extended.push(key);
-                    }
-                    self[key] = data[key];
+        }).then((packageData) => {
+            Object.keys(packageData).forEach((key) => {
+                if ("__proto__" === key || "constructor" === key || "prototype" === key) {
+                    return;
+                }
+                if ("function" === typeof this[key]) {
+                    return;
+                }
+                if ("undefined" === typeof this[key]) {
+                    this._extended.push(key);
                 }
+                this[key] = packageData[key];
             });
         });
     }
@@ -245,32 +296,35 @@ class Orchestrator extends MediatorUser_1.default {
         }).then(() => {
             return this.isEnable();
         }).then(() => {
-            return !this.enabled ? Promise.resolve() : Promise.resolve().then(() => {
-                const SwaggerParser = require("@apidevtools/swagger-parser");
-                // generate descriptor
-                return SwaggerParser.bundle(this._descriptorFile).then((bundledDescriptor) => {
-                    // force validate because of stupid malformatted references
-                    return SwaggerParser.validate(bundledDescriptor).then((validatedDescriptor) => {
-                        this._Descriptor = validatedDescriptor;
-                        if (!this._Descriptor.servers) {
-                            this._Descriptor.servers = [];
-                        }
-                    });
-                }).then(() => {
-                    return this.checkDescriptor().catch((err) => {
-                        this._Descriptor = null;
-                        return Promise.reject(err);
-                    });
-                    // 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();
+            if (!this.enabled) {
+                return Promise.resolve();
+            }
+            const SwaggerParser = require("@apidevtools/swagger-parser");
+            // generate descriptor
+            return SwaggerParser.bundle(this._descriptorFile).then((bundledDescriptor) => {
+                // force validate because of stupid malformatted references
+                return SwaggerParser.validate(bundledDescriptor).then((validatedDescriptor) => {
+                    this._Descriptor = validatedDescriptor;
+                    this._Descriptor.servers ??= [];
+                });
+            }).then(() => {
+                return this.checkDescriptor().then(() => {
+                    const { info } = this._Descriptor;
+                    // check title
+                    if (info.title !== this.name) {
+                        throw new Error("The descriptor's title (\"" + info.title + "\") "
+                            + "is not equals to "
+                            + "the package's name (\"" + this.name + "\")");
+                    }
                     // 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();
+                    if (info.version !== this.version) {
+                        throw new Error("The descriptor's version (\"" + info.version + "\") "
+                            + "is not equals to "
+                            + "the package's version (\"" + this.version + "\")");
+                    }
+                }).catch((err) => {
+                    this._Descriptor = null;
+                    return Promise.reject(err);
                 });
                 // create Mediator
             }).then(() => {
@@ -289,13 +343,13 @@ class Orchestrator extends MediatorUser_1.default {
                         }
                     }
                     catch (e) {
-                        reject(e);
+                        reject(e instanceof Error ? e : new Error(String(e)));
                     }
                     // init
                 }).then((PluginMediator) => {
                     this._Mediator = new PluginMediator({
                         "descriptor": this._Descriptor,
-                        "externalRessourcesDirectory": this._externalRessourcesDirectory,
+                        "externalResourcesDirectory": this._externalResourcesDirectory,
                         "logger": this._Logger
                     });
                     // check
@@ -303,7 +357,7 @@ class Orchestrator extends MediatorUser_1.default {
                     return this.checkMediator().then(() => {
                         // intercept errors to avoid non-catched ones
                         this._Mediator.on("error", (err) => {
-                            this._emitEventGenericForTSPurposeDONOTUSE("error", err);
+                            this.emit("error", err);
                         });
                     });
                 });
@@ -324,14 +378,14 @@ class Orchestrator extends MediatorUser_1.default {
                         }
                     }
                     catch (e) {
-                        reject(e);
+                        reject(e instanceof Error ? e : new Error(String(e)));
                     }
                     // init
                 }).then((PluginServer) => {
                     this._Server = new PluginServer({
                         "descriptor": this._Descriptor,
                         "mediator": this._Mediator,
-                        "externalRessourcesDirectory": this._externalRessourcesDirectory,
+                        "externalResourcesDirectory": this._externalResourcesDirectory,
                         "logger": this._Logger
                     });
                     // check
@@ -339,7 +393,7 @@ class Orchestrator extends MediatorUser_1.default {
                     return this.checkServer().then(() => {
                         // intercept errors to avoid non-catched ones
                         this._Server.on("error", (err) => {
-                            this._emitEventGenericForTSPurposeDONOTUSE("error", err);
+                            this.emit("error", err);
                         });
                     });
                 });
@@ -363,7 +417,7 @@ class Orchestrator extends MediatorUser_1.default {
                 return this._Mediator.init(...data);
             }).then(() => {
                 this.initialized = true;
-                this._emitEventGenericForTSPurposeDONOTUSE("initialized", ...data);
+                this.emit("initialized", ...data);
             });
         });
     }
@@ -381,7 +435,7 @@ class Orchestrator extends MediatorUser_1.default {
         }).then(() => {
             this._Descriptor = null;
             this.initialized = false;
-            this._emitEventGenericForTSPurposeDONOTUSE("released", ...data);
+            this.emit("released", ...data);
         });
     }
     // write

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

@@ -2,36 +2,39 @@ 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";
+import type { Server as SocketIOServerV2 } from "../../@types/socket.io-v2";
+import type { tMethod } from "../openAPITypes";
 import type { tEventMap, iEventsMinimal } from "./DescriptorUser";
 export interface iClient {
     "id": string;
     "status": "CONNECTED" | "DISCONNECTED";
 }
 export interface iIncomingMessage extends IncomingMessage {
-    "method": string;
+    "method": tMethod;
     "pattern": string;
     "validatedIp": string;
-    "params": Record<string, any>;
-    "query": Record<string, any>;
-    "headers": Record<string, any>;
-    "header"?: Record<string, any>;
-    "cookies": Record<string, any>;
-    "cookie"?: Record<string, any>;
-    "body": string;
+    "params": Record<string, string | number | boolean>;
+    "query": Record<string, unknown>;
+    "header"?: Record<string, unknown>;
+    "cookies": Record<string, unknown>;
+    "cookie"?: Record<string, unknown>;
+    "body": unknown;
+    "ip": string;
 }
-export interface iServerResponse extends ServerResponse {
+export interface iFormatedServerResponseForValidation extends ServerResponse {
     "body": string;
-    "headers": Record<string, any>;
+    "headers": Record<string, unknown>;
 }
 export default class Server<T extends tEventMap<T> = iEventsMinimal> extends MediatorUser<T> {
-    protected _socketServer: WebSocketServer | SocketIOServer | null;
+    protected _socketServer: WebSocketServer | SocketIOServer | SocketIOServerV2 | null;
     protected _checkParameters: boolean;
     protected _checkResponse: boolean;
     protected _cors: boolean;
     constructor(opt: iMediatorUserOptions);
-    protected _serverType(): "NO_SERVER" | "WEBSOCKET" | "SOCKETIO" | "UNKNOWN";
+    protected _getServerType(): "NO_SERVER" | "WEBSOCKET" | "SOCKETIO" | "UNKNOWN";
+    protected _getSocketIOVersion(): "NO_SERVER" | "V2" | "V3-V4" | "UNKNOWN";
     protected _getUsableSocketIOClient(clientId: string): {
-        "emit": (event: string, data: any) => void;
+        "emit": (event: string, ...data: unknown[]) => void;
     } | undefined;
     disableCheckParameters(): this;
     enableCheckParameters(): this;
@@ -39,11 +42,11 @@ export default class Server<T extends tEventMap<T> = iEventsMinimal> extends Med
     enableCheckResponse(): this;
     disableCors(): this;
     enableCors(): this;
-    appMiddleware(_req: IncomingMessage, res: iServerResponse, next: (err?: Error) => void): void;
-    socketMiddleware(socketServer: WebSocketServer | SocketIOServer): void;
-    push(command: string, data?: any, log?: boolean): this;
+    appMiddleware(_req: IncomingMessage, res: ServerResponse, next: (err?: Error) => void): void;
+    socketMiddleware(socketServer: WebSocketServer | SocketIOServer | SocketIOServerV2): void;
+    push(command: string, data?: unknown, log?: boolean): this;
     getClients(): iClient[];
-    pushClient(clientId: string, command: string, data?: any, log?: boolean): this;
-    init(...data: any): Promise<void>;
-    release(...data: any): Promise<void>;
+    pushClient(clientId: string, command: string, data?: unknown, log?: boolean): this;
+    init(...data: unknown[]): Promise<void>;
+    release(...data: unknown[]): Promise<void>;
 }