node-pluginsmanager-plugin 6.4.3 → 6.4.5

package/LICENSE

@@ -1,13 +1,13 @@
-Copyright (c) 2024, Sébastien Vidal
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+Copyright (c) 2024, Sébastien Vidal
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,48 +1,48 @@
-# node-pluginsmanager-plugin
-An abstract parent plugin for node-pluginsmanager
-
-[![Build status](https://api.travis-ci.org/Psychopoulet/node-pluginsmanager-plugin.svg?branch=master)](https://travis-ci.org/Psychopoulet/node-pluginsmanager-plugin)
-[![Coverage status](https://coveralls.io/repos/github/Psychopoulet/node-pluginsmanager-plugin/badge.svg?branch=master)](https://coveralls.io/github/Psychopoulet/node-pluginsmanager-plugin)
-[![Dependency status](https://david-dm.org/Psychopoulet/node-pluginsmanager-plugin/status.svg)](https://david-dm.org/Psychopoulet/node-pluginsmanager-plugin)
-[![Dev dependency status](https://david-dm.org/Psychopoulet/node-pluginsmanager-plugin/dev-status.svg)](https://david-dm.org/Psychopoulet/node-pluginsmanager-plugin?type=dev)
-[![Issues](https://img.shields.io/github/issues/Psychopoulet/node-pluginsmanager-plugin.svg)](https://github.com/Psychopoulet/node-pluginsmanager-plugin/issues)
-[![Pull requests](https://img.shields.io/github/issues-pr/Psychopoulet/node-pluginsmanager-plugin.svg)](https://github.com/Psychopoulet/node-pluginsmanager-plugin/pulls)
-
-## Installation
-
-```bash
-$ npm install node-pluginsmanager-plugin
-```
-
-## Features
-
-  * inheritable parent for node-pluginsmanager's plugins
-  * proper architecture for simple plugin creation
-  * heritable classes for each usage
-  * multi-files support
-
-## Architecture
-
-![Functional](https://github.com/Psychopoulet/node-pluginsmanager-plugin/raw/master/documentation/pictures/functional.jpg)
-
-[=> See doc](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/architecture.md)
-
-### Resume
-
-* [Descriptor](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/Descriptor.md) : OpenAPI (v3) description for Server and Mediator endpoints (this is NOT a js file, but a json/xaml/whatever OpenAPI file)
-* [Mediator](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/Mediator.md) : contains the plugin's logic (communication with targeted device/api/whatever)
-* [Server](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/Server.md) : expose plugin's roots to external use (API)
-* [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/Orchestrator.md) : plugin's data (extracted from plugin's package.json) and Descriptor, Mediator & Server initializer
-
-## Tests
-
-```bash
-$ git clone git://github.com/Psychopoulet/node-pluginsmanager-plugin.git
-$ cd ./node-pluginsmanager-plugin
-$ npm install
-$ npm run-script tests
-```
-
-## License
-
-  [ISC](LICENSE)
+# node-pluginsmanager-plugin
+An abstract parent plugin for node-pluginsmanager
+
+[![Build status](https://api.travis-ci.org/Psychopoulet/node-pluginsmanager-plugin.svg?branch=master)](https://travis-ci.org/Psychopoulet/node-pluginsmanager-plugin)
+[![Coverage status](https://coveralls.io/repos/github/Psychopoulet/node-pluginsmanager-plugin/badge.svg?branch=master)](https://coveralls.io/github/Psychopoulet/node-pluginsmanager-plugin)
+[![Dependency status](https://david-dm.org/Psychopoulet/node-pluginsmanager-plugin/status.svg)](https://david-dm.org/Psychopoulet/node-pluginsmanager-plugin)
+[![Dev dependency status](https://david-dm.org/Psychopoulet/node-pluginsmanager-plugin/dev-status.svg)](https://david-dm.org/Psychopoulet/node-pluginsmanager-plugin?type=dev)
+[![Issues](https://img.shields.io/github/issues/Psychopoulet/node-pluginsmanager-plugin.svg)](https://github.com/Psychopoulet/node-pluginsmanager-plugin/issues)
+[![Pull requests](https://img.shields.io/github/issues-pr/Psychopoulet/node-pluginsmanager-plugin.svg)](https://github.com/Psychopoulet/node-pluginsmanager-plugin/pulls)
+
+## Installation
+
+```bash
+$ npm install node-pluginsmanager-plugin
+```
+
+## Features
+
+  * inheritable parent for node-pluginsmanager's plugins
+  * proper architecture for simple plugin creation
+  * heritable classes for each usage
+  * multi-files support
+
+## Architecture
+
+![Functional](https://github.com/Psychopoulet/node-pluginsmanager-plugin/raw/master/documentation/pictures/functional.jpg)
+
+[=> See doc](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/architecture.md)
+
+### Resume
+
+* [Descriptor](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/Descriptor.md) : OpenAPI (v3) description for Server and Mediator endpoints (this is NOT a js file, but a json/xaml/whatever OpenAPI file)
+* [Mediator](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/Mediator.md) : contains the plugin's logic (communication with targeted device/api/whatever)
+* [Server](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/Server.md) : expose plugin's roots to external use (API)
+* [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin/tree/master/documentation/Orchestrator.md) : plugin's data (extracted from plugin's package.json) and Descriptor, Mediator & Server initializer
+
+## Tests
+
+```bash
+$ git clone git://github.com/Psychopoulet/node-pluginsmanager-plugin.git
+$ cd ./node-pluginsmanager-plugin
+$ npm install
+$ npm run-script tests
+```
+
+## License
+
+  [ISC](LICENSE)

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

@@ -1,7 +1,9 @@
 import MediatorUser from "./MediatorUser";
-import Server, { type iIncomingMessage, type iServerResponse } from "./Server";
-import type { Server as WebSocketServer } from "ws";
+import Server from "./Server";
+import { IncomingMessage } from "node:http";
 import type { Server as SocketIOServer } from "socket.io";
+import type { Server as WebSocketServer } from "ws";
+import type { iServerResponse } from "./Server";
 import type { tLogger } from "./DescriptorUser";
 export interface iOrchestratorOptions {
     "externalRessourcesDirectory": string;
@@ -43,7 +45,7 @@ export default class Orchestrator extends MediatorUser {
     enableCheckResponse(): this;
     disableCors(): this;
     enableCors(): this;
-    appMiddleware(req: iIncomingMessage, res: iServerResponse, next: () => void): void;
+    appMiddleware(req: IncomingMessage, res: iServerResponse, next: () => void): void;
     socketMiddleware(server: WebSocketServer | SocketIOServer): void;
     load(...data: any): Promise<void>;
     destroy(...data: any): Promise<void>;

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

@@ -38,7 +38,7 @@ export default class Server extends MediatorUser {
     enableCheckResponse(): this;
     disableCors(): this;
     enableCors(): this;
-    appMiddleware(req: iIncomingMessage, res: iServerResponse, next: () => void): void;
+    appMiddleware(_req: IncomingMessage, res: iServerResponse, next: (err?: Error) => void): void;
     socketMiddleware(socketServer: WebSocketServer | SocketIOServer): void;
     push(command: string, data?: any, log?: boolean): this;
     getClients(): iClient[];

package/lib/cjs/components/Server.js

@@ -4,9 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// natives
-const node_url_1 = require("node:url");
 const node_os_1 = require("node:os");
+const node_url_1 = require("node:url");
 // externals
 const uniqid_1 = __importDefault(require("uniqid"));
 // locals
@@ -102,7 +101,7 @@ class Server extends MediatorUser_1.default {
         this._cors = true;
         return this;
     }
-    appMiddleware(req, res, next) {
+    appMiddleware(_req, res, next) {
         if (!this._Descriptor) {
             return next();
         }
@@ -111,31 +110,42 @@ class Server extends MediatorUser_1.default {
         }
         this.checkDescriptor().then(() => {
             var _a, _b, _c;
+            const req = Object.assign(_req);
             // parse
             const { pathname, query } = (0, node_url_1.parse)(req.url, true);
             req.method = req.method ? req.method.toLowerCase() : "get";
             req.pattern = null === (0, checkNonEmptyString_1.checkNonEmptyStringSync)("pattern", req.pattern) ? req.pattern : (0, extractPattern_1.default)(this._Descriptor.paths, pathname, req.method);
-            if (!req.pattern) {
+            if (0 >= req.pattern.length) {
                 return next();
             }
-            req.validatedIp = null === (0, checkNonEmptyString_1.checkNonEmptyStringSync)("ip", req.validatedIp) ? req.validatedIp : (0, extractIp_1.default)(req);
-            // url
-            req.params = null === (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("params", req.params) ? req.params : (0, extractParams_1.default)(req.pattern, pathname);
-            req.query = null === (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("query", req.query) ? req.query : query !== null && query !== void 0 ? query : {};
-            if (null !== (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("headers", req.headers)) {
-                req.headers = null === (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("header", req.header) ? req.header : {};
-            }
-            if (null !== (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("cookies", req.cookies)) {
-                req.cookies = null === (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("header", req.cookie) ? req.cookie : (0, extractCookies_1.default)(req);
-            }
-            // ensure content length formate
-            if ("undefined" === typeof req.headers["content-length"]) {
-                req.headers["content-length"] = 0;
+            // extract specific data
+            try {
+                // workaround for express 5
+                if (Object.getPrototypeOf(req).app) {
+                    Object.defineProperty(req, "query", Object.assign(Object.assign({}, Object.getOwnPropertyDescriptor(req, "query")), { "value": req.query, "writable": true }));
+                }
+                req.validatedIp = null === (0, checkNonEmptyString_1.checkNonEmptyStringSync)("ip", req.validatedIp) ? req.validatedIp : (0, extractIp_1.default)(req);
+                // url
+                req.params = null === (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("params", req.params) ? req.params : (0, extractParams_1.default)(req.pattern, pathname);
+                req.query = null === (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("query", req.query) ? req.query : query !== null && query !== void 0 ? query : {};
+                if (null !== (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("headers", req.headers)) {
+                    req.headers = null === (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("header", req.header) ? req.header : {};
+                }
+                if (null !== (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("cookies", req.cookies)) {
+                    req.cookies = null === (0, checkNonEmptyObject_1.checkNonEmptyObjectSync)("header", req.cookie) ? req.cookie : (0, extractCookies_1.default)(req);
+                }
+                // ensure content length formate
+                if ("undefined" === typeof req.headers["content-length"]) {
+                    req.headers["content-length"] = 0;
+                }
+                else if ("string" === typeof req.headers["content-length"]) {
+                    req.headers["content-length"] = parseInt(req.headers["content-length"], 10);
+                }
             }
-            else if ("string" === typeof req.headers["content-length"]) {
-                req.headers["content-length"] = parseInt(req.headers["content-length"], 10);
+            catch (e) {
+                return next(e);
             }
-            if (!req.pattern || !this._Descriptor.paths[req.pattern] || !this._Descriptor.paths[req.pattern][req.method]) {
+            if (!this._Descriptor.paths[req.pattern] || !this._Descriptor.paths[req.pattern][req.method]) {
                 return next();
             }
             const { operationId } = this._Descriptor.paths[req.pattern][req.method];

package/lib/cjs/main.d.cts

@@ -24,9 +24,9 @@ import DescriptorUser, { type iDescriptorUserOptions, type tLogType, type tLogge
 import Mediator, { type iUrlAllowedParameters } from "./components/Mediator";
 import MediatorUser, { type iMediatorUserOptions } from "./components/MediatorUser";
 import Orchestrator, { type iOrchestratorOptions } from "./components/Orchestrator";
-import Server, { type iClient, type iIncomingMessage, type iServerResponse } from "./components/Server";
+import Server, { type iClient, type iServerResponse } from "./components/Server";
 import UnauthorizedError from "./components/errors/UnauthorizedError";
 import NotFoundError from "./components/errors/NotFoundError";
 import LockedError from "./components/errors/LockedError";
-export type { tLogType, tLogger, iUrlAllowedParameters, iClient, iIncomingMessage, iServerResponse };
+export type { tLogType, tLogger, iUrlAllowedParameters, iClient, iServerResponse };
 export { DescriptorUser, type iDescriptorUserOptions, Mediator, MediatorUser, type iMediatorUserOptions, Orchestrator, type iOrchestratorOptions, Server, UnauthorizedError, NotFoundError, LockedError };

package/lib/cjs/utils/send.d.ts

@@ -1,5 +1,6 @@
-import type { iIncomingMessage, iServerResponse } from "../components/Server";
-export default function send(req: iIncomingMessage, res: iServerResponse, code: number, content: any, options: {
+import type { IncomingMessage } from "node:http";
+import type { iServerResponse } from "../components/Server";
+export default function send(req: IncomingMessage, res: iServerResponse, code: number, content: any, options: {
     "apiVersion": string;
     "cors": boolean;
     "mime": string;

package/package.json

@@ -1,97 +1,97 @@
-{
-
-  "name": "node-pluginsmanager-plugin",
-  "version": "6.4.3",
-  "description": "An abstract parent plugin for node-pluginsmanager",
-
-  "type": "commonjs",
-  "typings": "./lib/cjs/main.d.cts",
-  "main": "./lib/cjs/main.cjs",
-
-  "exports": {
-    ".": {
-      "require": {
-        "types": "./lib/cjs/main.d.cts",
-        "default": "./lib/cjs/main.cjs"
-      }
-    }
-  },
-
-  "scripts": {
-
-    "prepare": "npx husky",
-
-    "clean": "npx rimraf lib/cjs",
-    "build": "npm run-script clean && npx tsc --project \"./tsconfig.json\"",
-
-    "lint": "npx eslint --config .eslintrc-src.js --ext .cts,.ts ./lib/src/**/* && npx eslint --config .eslintrc-tests.js ./bin/*.js ./test/**/*.js",
-    "check-requires": "npx used-deps-analyzer \"./package.json\" \"./lib/src\" --no-dev --overkill \"fs-extra\" \"node-promfs\"",
-    "check-updates": "npx check-version-modules",
-    "unit-tests": "npm run-script build && npx nyc --reporter=html --reporter=text mocha",
-
-    "tests": "npm run-script lint && npm run-script check-requires && npm run-script check-updates && npm run-script unit-tests"
-
-  },
-
-  "files": [
-    "/bin",
-    "/lib/cjs",
-    "/public"
-  ],
-  "engines": {
-    "node": ">=16.0.0"
-  },
-
-  "dependencies": {
-    "@apidevtools/swagger-parser": "10.1.1",
-    "express-openapi-validate": "0.6.1",
-    "uniqid": "5.4.0"
-  },
-  "devDependencies": {
-    "@types/express": "4.17.21",
-    "@types/node": "22.10.10",
-    "@types/socket.io": "3.0.2",
-    "@types/uniqid": "5.3.4",
-    "@types/ws": "8.5.14",
-    "check-version-modules": "2.1.3",
-    "colors": "1.4.0",
-    "eslint-plugin-personnallinter": "git+ssh://git@github.com/Psychopoulet/eslint-plugin-personnallinter",
-    "express": "4.21.2",
-    "husky": "9.1.7",
-    "mocha": "11.1.0",
-    "nyc": "17.1.0",
-    "openapi-types": "12.1.3",
-    "rimraf": "6.0.1",
-    "socket.io": "4.8.1",
-    "socket.io-client": "4.8.1",
-    "typescript": "5.7.3",
-    "used-deps-analyzer": "0.1.8",
-    "ws": "8.18.0"
-  },
-  "optionalDependencies": {},
-
-  "husky": {
-    "hooks": {
-        "pre-commit": "npm run-script lint",
-        "pre-push": "npm run-script unit-tests",
-        "pre-receive": "npm run-script tests"
-    }
-  },
-  "keywords": [
-    "plugin",
-    "manage",
-    "gestion"
-  ],
-  "author": "Sébastien VIDAL",
-  "license": "ISC",
-
-  "homepage": "https://github.com/Psychopoulet/node-pluginsmanager-plugin#readme",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/Psychopoulet/node-pluginsmanager-plugin"
-  },
-  "bugs": {
-    "url": "https://github.com/Psychopoulet/node-pluginsmanager-plugin/issues"
-  }
-
-}
+{
+
+  "name": "node-pluginsmanager-plugin",
+  "version": "6.4.5",
+  "description": "An abstract parent plugin for node-pluginsmanager",
+
+  "type": "commonjs",
+  "typings": "./lib/cjs/main.d.cts",
+  "main": "./lib/cjs/main.cjs",
+
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./lib/cjs/main.d.cts",
+        "default": "./lib/cjs/main.cjs"
+      }
+    }
+  },
+
+  "scripts": {
+
+    "prepare": "npx husky",
+
+    "clean": "npx rimraf lib/cjs",
+    "build": "npm run-script clean && npx tsc --project \"./tsconfig.json\"",
+
+    "lint": "npx eslint --config .eslintrc-src.js --ext .cts,.ts ./lib/src/**/* && npx eslint --config .eslintrc-tests.js ./bin/*.js ./test/**/*.js",
+    "check-requires": "npx used-deps-analyzer \"./package.json\" \"./lib/src\" --no-dev --overkill \"fs-extra\" \"node-promfs\"",
+    "check-updates": "npx check-version-modules",
+    "unit-tests": "npm run-script build && npx nyc --reporter=html --reporter=text mocha",
+
+    "tests": "npm run-script lint && npm run-script check-requires && npm run-script check-updates && npm run-script unit-tests"
+
+  },
+
+  "files": [
+    "/bin",
+    "/lib/cjs",
+    "/public"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
+
+  "dependencies": {
+    "@apidevtools/swagger-parser": "12.0.0",
+    "express-openapi-validate": "0.6.1",
+    "uniqid": "5.4.0"
+  },
+  "devDependencies": {
+    "@types/express": "5.0.3",
+    "@types/node": "24.3.0",
+    "@types/socket.io": "3.0.2",
+    "@types/uniqid": "5.3.4",
+    "@types/ws": "8.18.1",
+    "check-version-modules": "2.1.3",
+    "colors": "1.4.0",
+    "eslint-plugin-personnallinter": "git+ssh://git@github.com/Psychopoulet/eslint-plugin-personnallinter",
+    "express": "5.1.0",
+    "husky": "9.1.7",
+    "mocha": "11.7.1",
+    "nyc": "17.1.0",
+    "openapi-types": "12.1.3",
+    "rimraf": "6.0.1",
+    "socket.io": "4.8.1",
+    "socket.io-client": "4.8.1",
+    "typescript": "5.9.2",
+    "used-deps-analyzer": "0.1.8",
+    "ws": "8.18.3"
+  },
+  "optionalDependencies": {},
+
+  "husky": {
+    "hooks": {
+        "pre-commit": "npm run-script lint",
+        "pre-push": "npm run-script unit-tests",
+        "pre-receive": "npm run-script tests"
+    }
+  },
+  "keywords": [
+    "plugin",
+    "manage",
+    "gestion"
+  ],
+  "author": "Sébastien VIDAL",
+  "license": "ISC",
+
+  "homepage": "https://github.com/Psychopoulet/node-pluginsmanager-plugin#readme",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Psychopoulet/node-pluginsmanager-plugin"
+  },
+  "bugs": {
+    "url": "https://github.com/Psychopoulet/node-pluginsmanager-plugin/issues"
+  }
+
+}