node-pluginsmanager-plugin 6.0.2 → 6.0.3

package/lib/cjs/components/Mediator.js

@@ -1,151 +1,147 @@
-"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 jsonParser_1 = __importDefault(require("../utils/jsonParser"));
-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 = {};
-                        }
-                        else {
-                            mutedRes.body = (0, jsonParser_1.default)(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";
+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;
+;

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

@@ -1,6 +1,6 @@
-import { iIncomingMessage, iServerResponse } from "../components/Server";
-export default function send(req: iIncomingMessage, res: iServerResponse, code: number, content: string, options: {
-    "apiVersion": string;
-    "cors": boolean;
-    "mime": string;
-}): Promise<void>;
+import { iIncomingMessage, iServerResponse } from "../components/Server";
+export default function send(req: iIncomingMessage, res: iServerResponse, code: number, content: any, options: {
+    "apiVersion": string;
+    "cors": boolean;
+    "mime": string;
+}): Promise<void>;

package/lib/cjs/utils/send.js

@@ -1,54 +1,84 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// module
-function send(req, res, code, content, options) {
-    return new Promise((resolve) => {
-        // force data for checking
-        res.statusCode = code;
-        res.headers = Object.assign({
-            "Content-Type": options.mime,
-            "Content-Length": content ? Buffer.byteLength(content) : 0,
-            "Status-Code-Url-Cat": "https://http.cat/" + code,
-            "API-Version": options.apiVersion
-        }, options.cors ? {
-            "Access-Control-Allow-Origin": "*",
-            "Access-Control-Allow-Credentials": true,
-            "Access-Control-Allow-Methods": req.headers["access-control-request-method"] ? req.headers["access-control-request-method"] : [
-                "GET",
-                "POST",
-                "PUT",
-                "DELETE",
-                "PATCH",
-                "OPTIONS"
-            ].join(", "),
-            "Access-Control-Allow-Headers": req.headers["access-control-request-headers"] ? req.headers["access-control-request-headers"] : [
-                "Origin",
-                "Accept",
-                "Accept-Version",
-                "Content-Length",
-                "Content-MD5",
-                "Content-Type",
-                "Date",
-                "X-Api-Version",
-                "X-File-Name",
-                "X-CSRF-Token",
-                "X-Requested-With"
-            ].join(", ")
-        } : {});
-        // send data
-        res.writeHead(res.statusCode, res.headers);
-        if (content) {
-            res.body = content; // for Mediator response validator
-            res.end(content, "utf-8", () => {
-                resolve();
-            });
-        }
-        else {
-            res.end(() => {
-                resolve();
-            });
-        }
-    });
-}
-exports.default = send;
-;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// module
+function send(req, res, code, content, options) {
+    return Promise.resolve().then(() => {
+        if (!content) {
+            return "";
+        }
+        else {
+            let result = "";
+            if (options.mime.includes("application/json")) {
+                if ("string" === typeof content) {
+                    try {
+                        JSON.parse(content); // is content json & parseable ?
+                        result = content; // yes => valid JSON string, send it as it is
+                    }
+                    catch (e) {
+                        result = JSON.stringify(content); // no => not JSON string, send formatted one
+                    }
+                }
+                else {
+                    const stringified = JSON.stringify(content);
+                    if (stringified !== content) {
+                        result = stringified;
+                    }
+                }
+            }
+            else {
+                result = content;
+            }
+            return result;
+        }
+    }).then((stringifiedContent) => {
+        return new Promise((resolve) => {
+            // force data for checking
+            res.statusCode = code;
+            res.headers = Object.assign({
+                "Content-Type": options.mime,
+                "Content-Length": stringifiedContent ? Buffer.byteLength(stringifiedContent) : 0,
+                "Status-Code-Url-Cat": "https://http.cat/" + code,
+                "API-Version": options.apiVersion
+            }, options.cors ? {
+                "Access-Control-Allow-Origin": "*",
+                "Access-Control-Allow-Credentials": true,
+                "Access-Control-Allow-Methods": req.headers["access-control-request-method"] ? req.headers["access-control-request-method"] : [
+                    "GET",
+                    "POST",
+                    "PUT",
+                    "DELETE",
+                    "PATCH",
+                    "OPTIONS"
+                ].join(", "),
+                "Access-Control-Allow-Headers": req.headers["access-control-request-headers"] ? req.headers["access-control-request-headers"] : [
+                    "Origin",
+                    "Accept",
+                    "Accept-Version",
+                    "Content-Length",
+                    "Content-MD5",
+                    "Content-Type",
+                    "Date",
+                    "X-Api-Version",
+                    "X-File-Name",
+                    "X-CSRF-Token",
+                    "X-Requested-With"
+                ].join(", ")
+            } : {});
+            // send data
+            res.writeHead(res.statusCode, res.headers);
+            if ("" !== stringifiedContent) {
+                res.body = content; // for Mediator response validator
+                res.end(stringifiedContent, "utf-8", () => {
+                    resolve();
+                });
+            }
+            else {
+                res.end(() => {
+                    resolve();
+                });
+            }
+        });
+    });
+}
+exports.default = send;
+;

package/package.json

@@ -1,7 +1,7 @@
 {
 
   "name": "node-pluginsmanager-plugin",
-  "version": "6.0.2",
+  "version": "6.0.3",
   "description": "An abstract parent plugin for node-pluginsmanager",
 
   "type": "commonjs",
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@types/express": "4.17.21",
-    "@types/node": "20.10.2",
+    "@types/node": "20.10.3",
     "@types/socket.io": "3.0.2",
     "@types/uniqid": "5.3.4",
     "@types/ws": "8.5.10",