node-pluginsmanager-plugin 4.8.8 → 5.0.0

package/lib/checkers/TypeError/checkObject.js

@@ -1,61 +0,0 @@
-"use strict";
-
-//  deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const checkExists = require(join(__dirname, "..", "ReferenceError", "checkExists.js"));
-
-// private
-
-	// methods
-
-		/**
-		* Execute an asynchronous check on data
-		* @param {string} dataName: data identifier
-		* @param {any} data: data to check
-		* @returns {Promise} check result
-		*/
-		function _async (dataName, data) {
-
-			return checkExists(dataName, data, true).then(() => {
-
-				return "object" !== typeof data || null === data ? Promise.reject(new TypeError(
-					"\"" + dataName + "\" is not an object"
-				)) : Promise.resolve();
-
-			});
-
-		}
-
-		/**
-		* Execute a synchronous check on data
-		* @param {string} dataName: data identifier
-		* @param {any} data: data to check
-		* @returns {ReferenceError|TypeError|null} check result
-		*/
-		function _sync (dataName, data) {
-
-			let err = checkExists(dataName, data, false);
-
-				if (!err && ("object" !== typeof data || null === data)) {
-
-					err = new TypeError(
-						"\"" + dataName + "\" is not an object"
-					);
-
-				}
-
-			return err;
-
-		}
-
-// module
-
-module.exports = function checkObject (dataName, data, async = true) {
-
-	return async ? _async(dataName, data) : _sync(dataName, data);
-
-};

package/lib/checkers/TypeError/checkString.js

@@ -1,61 +0,0 @@
-"use strict";
-
-//  deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const checkExists = require(join(__dirname, "..", "ReferenceError", "checkExists.js"));
-
-// private
-
-	// methods
-
-		/**
-		* Execute an asynchronous check on data
-		* @param {string} dataName: data identifier
-		* @param {any} data: data to check
-		* @returns {Promise} check result
-		*/
-		function _async (dataName, data) {
-
-			return checkExists(dataName, data, true).then(() => {
-
-				return "string" !== typeof data ? Promise.reject(new TypeError(
-					"\"" + dataName + "\" is not a string"
-				)) : Promise.resolve();
-
-			});
-
-		}
-
-		/**
-		* Execute a synchronous check on data
-		* @param {string} dataName: data identifier
-		* @param {any} data: data to check
-		* @returns {ReferenceError|TypeError|null} check result
-		*/
-		function _sync (dataName, data) {
-
-			let err = checkExists(dataName, data, false);
-
-				if (!err && "string" !== typeof data) {
-
-					err = new TypeError(
-						"\"" + dataName + "\" is not a string"
-					);
-
-				}
-
-			return err;
-
-		}
-
-// module
-
-module.exports = function checkString (dataName, data, async = true) {
-
-	return async ? _async(dataName, data) : _sync(dataName, data);
-
-};

package/lib/checkers/main.js

@@ -1,76 +0,0 @@
-"use strict";
-
-//  deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-
-		// undefined
-		const checkExists = require(join(__dirname, "ReferenceError", "checkExists.js"));
-
-		// native
-		const checkBoolean = require(join(__dirname, "TypeError", "checkBoolean.js"));
-		const checkFunction = require(join(__dirname, "TypeError", "checkFunction.js"));
-		const checkNumber = require(join(__dirname, "TypeError", "checkNumber.js"));
-		const checkObject = require(join(__dirname, "TypeError", "checkObject.js"));
-		const checkString = require(join(__dirname, "TypeError", "checkString.js"));
-
-		// abstract
-		const checkArray = require(join(__dirname, "TypeError", "checkArray.js"));
-		const checkInteger = require(join(__dirname, "TypeError", "checkInteger.js"));
-
-		// empty
-		const checkNonEmptyArray = require(join(__dirname, "RangeError", "checkNonEmptyArray.js"));
-		const checkNonEmptyInteger = require(join(__dirname, "RangeError", "checkNonEmptyInteger.js"));
-		const checkNonEmptyNumber = require(join(__dirname, "RangeError", "checkNonEmptyNumber.js"));
-		const checkNonEmptyObject = require(join(__dirname, "RangeError", "checkNonEmptyObject.js"));
-		const checkNonEmptyString = require(join(__dirname, "RangeError", "checkNonEmptyString.js"));
-
-		// range
-		const checkArrayLength = require(join(__dirname, "RangeError", "checkArrayLength.js"));
-		const checkArrayLengthBetween = require(join(__dirname, "RangeError", "checkArrayLengthBetween.js"));
-		const checkIntegerBetween = require(join(__dirname, "RangeError", "checkIntegerBetween.js"));
-		const checkNumberBetween = require(join(__dirname, "RangeError", "checkNumberBetween.js"));
-		const checkObjectLength = require(join(__dirname, "RangeError", "checkObjectLength.js"));
-		const checkObjectLengthBetween = require(join(__dirname, "RangeError", "checkObjectLengthBetween.js"));
-		const checkStringLength = require(join(__dirname, "RangeError", "checkStringLength.js"));
-		const checkStringLengthBetween = require(join(__dirname, "RangeError", "checkStringLengthBetween.js"));
-
-// module
-
-module.exports = {
-
-	// undefined
-	checkExists,
-
-	// native
-	checkBoolean,
-	checkFunction,
-	checkNumber,
-	checkObject,
-	checkString,
-
-	// abstract
-	checkArray,
-	checkInteger,
-
-	// empty
-	checkNonEmptyArray,
-	checkNonEmptyInteger,
-	checkNonEmptyNumber,
-	checkNonEmptyObject,
-	checkNonEmptyString,
-
-	// range
-	checkArrayLength,
-	checkArrayLengthBetween,
-	checkIntegerBetween,
-	checkNumberBetween,
-	checkObjectLength,
-	checkObjectLengthBetween,
-	checkStringLength,
-	checkStringLengthBetween
-
-};

package/lib/components/DescriptorUser.js

@@ -1,179 +0,0 @@
-"use strict";
-
-//  deps
-
-	// natives
-	const Events = require("events");
-	const { join } = require("path");
-
-	// locals
-	const {
-		checkObject,
-		checkNonEmptyObject,
-		checkNonEmptyString
-	} = require(join(__dirname, "..", "checkers", "main.js"));
-
-// consts
-
-	const LOG_TYPES_ALLOWED = [ "log", "info", "success", "warning", "error" ];
-
-// module
-
-module.exports = class DescriptorUser extends Events {
-
-	constructor (options) {
-
-		super(options);
-
-		// public
-
-			this.initialized = false;
-
-		// protected
-
-			this._descriptorValidated = false;
-
-			this._externalRessourcesDirectory = options && "string" === typeof options.externalRessourcesDirectory ?
-				options.externalRessourcesDirectory : "";
-
-			this._Descriptor = options && "undefined" !== typeof options.descriptor ?
-				options.descriptor : null;
-
-			this._Logger = options && "undefined" !== typeof options.logger ?
-				options.logger : null;
-
-	}
-
-	// protected
-
-		// must be inherited
-		_initWorkSpace () {
-
-			return Promise.reject(new Error("\"_initWorkSpace\" method must be inherited"));
-
-		}
-
-		// must be inherited
-		_releaseWorkSpace () {
-
-			return Promise.reject(new Error("\"_releaseWorkSpace\" method must be inherited"));
-
-		}
-
-		_log (type, message, bold = false) {
-
-			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 () {
-
-			return Promise.reject(new Error("\"init\" method must be inherited"));
-
-		}
-
-		// must be inherited
-		release () {
-
-			return Promise.reject(new Error("\"release\" method must be inherited"));
-
-		}
-
-		// must be inherited
-		checkDescriptor () {
-
-			// check Descriptor object
-			return this._descriptorValidated ? Promise.resolve() :
-			checkNonEmptyObject("Descriptor", this._Descriptor).then(() => {
-
-				// check info object
-				return checkNonEmptyObject("Descriptor.info", this._Descriptor.info).then(() => {
-
-					// check title
-					return 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 checkNonEmptyString("Descriptor.info.version", this._Descriptor.info.version);
-					});
-
-				});
-
-			}).then(() => {
-
-				// check paths object
-				return 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) => {
-
-								if (this._Descriptor.paths[p][m].operationId) {
-									operationIds.push(this._Descriptor.paths[p][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;
-			});
-
-		}
-
-};

package/lib/components/Mediator.js

@@ -1,220 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// externals
-	const { OpenApiValidator, ValidationError } = require("express-openapi-validate");
-
-	// locals
-	const {
-		checkNonEmptyString,
-		checkObject,
-		checkNonEmptyObject
-	} = require(join(__dirname, "..", "checkers", "main.js"));
-	const { extractPathMethodByOperationId } = require(join(__dirname, "..", "utils", "descriptor", "main.js"));
-	const DescriptorUser = require(join(__dirname, "DescriptorUser.js"));
-
-// module
-
-module.exports = class Mediator extends DescriptorUser {
-
-	constructor (options) {
-
-		super(options);
-
-		this._validator = null;
-
-	}
-
-	// public
-
-		checkParameters (operationId, urlParams, bodyParams) {
-
-			// parameters validation
-			return this.checkDescriptor().then(() => {
-				return checkNonEmptyString("operationId", operationId);
-			}).then(() => {
-
-				return checkNonEmptyObject("urlParams", urlParams).then(() => {
-					return checkObject("urlParams.path", urlParams.path);
-				}).then(() => {
-					return checkObject("urlParams.query", urlParams.query);
-				}).then(() => {
-					return checkObject("urlParams.headers", urlParams.headers);
-				}).then(() => {
-					return checkObject("urlParams.cookies", urlParams.cookies);
-				});
-
-			}).then(() => {
-				return checkObject("bodyParams", bodyParams);
-			}).then(() => {
-
-				// search wanted operation
-				const foundPathMethod = extractPathMethodByOperationId(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);
-
-					validateRequest(req, null, (err) => {
-						return err ? reject(err) : resolve();
-					});
-
-				}).catch((err) => {
-
-					return err instanceof 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);
-
-				});
-
-			});
-
-		}
-
-		checkResponse (operationId, res) {
-
-			// parameters validation
-			return this.checkDescriptor().then(() => {
-				return checkNonEmptyString("operationId", operationId);
-			}).then(() => {
-
-				// search wanted operation
-				const foundPathMethod = extractPathMethodByOperationId(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 {
-
-						const validateResponse = this._validator.validateResponse(foundPathMethod.method, foundPathMethod.path);
-
-						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;
-							}
-
-							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 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();
-
-			});
-
-		}
-
-};

package/lib/components/MediatorUser.js

@@ -1,63 +0,0 @@
-"use strict";
-
-//  deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const DescriptorUser = require(join(__dirname, "DescriptorUser.js"));
-	const Mediator = require(join(__dirname, "Mediator.js"));
-
-// module
-
-module.exports = class MediatorUser extends DescriptorUser {
-
-	constructor (options) {
-
-		super(options);
-
-		this._Mediator = options && "undefined" !== typeof options.mediator ?
-			options.mediator : null;
-
-	}
-
-	// protected
-
-		_initWorkSpace () {
-
-			return Promise.resolve();
-
-		}
-
-		_releaseWorkSpace () {
-
-			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)) {
-
-				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();
-
-			}
-
-		}
-
-};

package/lib/components/NotFoundError.js

@@ -1,5 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = class NotFoundError extends Error {};