node-pluginsmanager-plugin 4.8.8 → 5.0.0

package/lib/components/main.js

@@ -1,25 +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"));
-	const MediatorUser = require(join(__dirname, "MediatorUser.js"));
-	const Orchestrator = require(join(__dirname, "Orchestrator.js"));
-	const Server = require(join(__dirname, "Server.js"));
-	const NotFoundError = require(join(__dirname, "NotFoundError.js"));
-
-// module
-
-module.exports = {
-	DescriptorUser,
-	Mediator,
-	MediatorUser,
-	Orchestrator,
-	Server,
-	NotFoundError
-};

package/lib/index.d.ts

@@ -1,279 +0,0 @@
-/// <reference types="node" />
-/// <reference types="ws" />
-/// <reference types="socket.io" />
-
-declare module "node-pluginsmanager-plugin" {
-
-	import { EventEmitter } from "events";
-	import { Server as WebSocketServer } from "ws";
-	import { Server as SocketIOServer } from "socket.io";
-
-	// checkers
-
-		// undefined
-		export function checkExists (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkExists (dataName: string, data: any, async: boolean): null | ReferenceError;
-
-		// native
-		export function checkBoolean (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkBoolean (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
-
-		export function checkFunction (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkFunction (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
-
-		export function checkNumber (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkNumber (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
-
-		export function checkObject (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkObject (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
-
-		export function checkString (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkString (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
-
-		// abstract
-		export function checkArray (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkArray (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
-
-		export function checkInteger (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkInteger (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
-
-		// empty
-		export function checkNonEmptyArray (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkNonEmptyArray (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkNonEmptyInteger (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkNonEmptyInteger (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkNonEmptyNumber (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkNonEmptyNumber (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkNonEmptyObject (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkNonEmptyObject (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkNonEmptyString (dataName: string, data: any, async?: boolean): Promise<void>;
-		export function checkNonEmptyString (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		// range
-		export function checkArrayLength (dataName: string, data: any, length: number, async?: boolean): Promise<void>;
-		export function checkArrayLength (dataName: string, data: any, length: number, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkArrayLengthBetween (dataName: string, data: any, min: number, max: number, async?: boolean): Promise<void>;
-		export function checkArrayLengthBetween (dataName: string, data: any, min: number, max: number, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkIntegerBetween (dataName: string, data: any, min: number, max: number, async?: boolean): Promise<void>;
-		export function checkIntegerBetween (dataName: string, data: any, min: number, max: number, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkNumberBetween (dataName: string, data: any, min: number, max: number, async?: boolean): Promise<void>;
-		export function checkNumberBetween (dataName: string, data: any, min: number, max: number, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkObjectLength (dataName: string, data: any, length: number, async?: boolean): Promise<void>;
-		export function checkObjectLength (dataName: string, data: any, length: number, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkObjectLengthBetween (dataName: string, data: any, min: number, max: number, async?: boolean): Promise<void>;
-		export function checkObjectLengthBetween (dataName: string, data: any, min: number, max: number, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkStringLength (dataName: string, data: any, length: number, async?: boolean): Promise<void>;
-		export function checkStringLength (dataName: string, data: any, length: number, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-		export function checkStringLengthBetween (dataName: string, data: any, min: number, max: number, async?: boolean): Promise<void>;
-		export function checkStringLengthBetween (dataName: string, data: any, min: number, max: number, async: boolean): null | ReferenceError | TypeError | RangeError;
-
-	// components
-
-		export type tLogType = "log" | "info" | "warning" | "error" | "debug";
-
-		export interface iDescriptorUserOptions {
-			"descriptor": { [key:string]: any };
-			"externalRessourcesDirectory": string;
-			"logger"?: (type: tLogType, message: string, bold?: boolean) => void;
-		}
-
-		export interface iMediatorUserOptions extends iDescriptorUserOptions {
-				"mediator": Mediator | null;
-			}
-
-		export interface iUrlParameters {
-			"url": {
-				"path": object;
-				"query": object;
-				"headers": object;
-				"cookies": object;
-			};
-		}
-
-		export interface iOrchestratorOptions {
-			"externalRessourcesDirectory": string;
-			"packageFile": string;
-			"descriptorFile": string;
-			"mediatorFile": string;
-			"serverFile": string;
-		}
-
-		export class DescriptorUser extends EventEmitter {
-
-			// attributes
-
-				// public
-
-					public initialized: boolean;
-
-				// protected
-
-					protected _descriptorValidated: boolean;
-
-					protected _externalRessourcesDirectory: string;
-
-					protected _Descriptor: object | null;
-					protected _Logger: Function | null;
-
-			// constructor
-
-				constructor (options: iDescriptorUserOptions);
-
-			// methods
-
-				// protected
-
-					protected _initWorkSpace(data?: any): Promise<void>;
-					protected _releaseWorkSpace(data?: any): Promise<void>;
-					protected _log(type: tLogType, message: string, bold?: boolean): this;
-
-				// public
-
-					public checkDescriptor(): Promise<void>;
-					public init(data?: any): Promise<void>;
-					public release(data?: any): Promise<void>;
-
-		}
-
-		export class Mediator extends DescriptorUser {
-
-			// attributes
-
-				public _validator: null | object;
-
-			// methods
-
-				public checkParameters(operationId: string, urlParams: iUrlParameters, bodyParams: object): Promise<void>;
-				public checkResponse(operationId: string, res: Response): Promise<void>;
-
-		}
-
-		export class MediatorUser extends DescriptorUser {
-
-			// attributes
-
-				protected _Mediator: Mediator | null;
-
-			// constructor
-
-				constructor (options: iMediatorUserOptions);
-
-			// methods
-
-				public checkMediator(): Promise<void>;
-
-		}
-
-		export class Server extends MediatorUser {
-
-			// attributes
-
-				protected _socketServer: WebSocketServer | SocketIOServer | null;
-				protected _checkParameters: boolean;
-				protected _checkResponse: boolean;
-				protected _cors: boolean;
-
-			// methods
-
-				public disableCheckParameters(): this;
-				public enableCheckParameters(): this;
-				public disableCheckResponse(): this;
-				public enableCheckResponse(): this;
-
-				public disableCors(): this;
-				public enableCors(): this;
-
-				public appMiddleware(req: Request, res: Response, next: Function): void;
-				public socketMiddleware(server: WebSocketServer | SocketIOServer): void;
-				public push(command: string, data?: any): this;
-
-		}
-
-		export class Orchestrator extends MediatorUser {
-
-			// attributes
-
-				// protected
-
-					protected _Server: Server | null;
-					protected _socketServer: WebSocketServer | SocketIOServer | null;
-					protected _checkParameters: boolean;
-					protected _checkResponse: boolean;
-
-					// params
-					protected _packageFile: string;
-					protected _descriptorFile: string;
-					protected _mediatorFile: string;
-					protected _serverFile: string;
-
-					protected _extended: Array<string>;
-
-				// public
-
-					public enabled: boolean;
-
-					// native
-					public authors: Array<string> | null;
-					public description: string;
-					public dependencies: object | null;
-					public devDependencies: object | null;
-					public engines: object | null;
-					public license: string;
-					public main: string;
-					public name: string;
-					public scripts: object | null;
-					public version: string;
-
-			// constructor
-
-				constructor (options: iOrchestratorOptions);
-
-			// methods
-
-				// checkers
-
-				public checkConf(): Promise<void>;
-				public isEnable(): Promise<void>;
-				public checkFiles(): Promise<void>;
-				public checkServer(): Promise<void>;
-
-				// middleware
-
-				public disableCheckParameters(): this;
-				public enableCheckParameters(): this;
-				public disableCheckResponse(): this;
-				public enableCheckResponse(): this;
-
-				public disableCors(): this;
-				public enableCors(): this;
-
-				public appMiddleware(req: Request, res: Response, next: Function): void;
-				public socketMiddleware(server: WebSocketServer | SocketIOServer): void;
-
-				// init / release
-
-				public load(data?: any): Promise<void>;
-				public destroy(data?: any): Promise<void>;
-
-				// write
-
-				public install(data?: any): Promise<void>;
-				public update(data?: any): Promise<void>;
-				public uninstall(data?: any): Promise<void>;
-
-		}
-
-		export class NotFoundError extends Error {}
-
-}

package/lib/main.js

@@ -1,17 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const checkers = require(join(__dirname, "checkers", "main.js"));
-	const components = require(join(__dirname, "components", "main.js"));
-
-// module
-
-module.exports = {
-	...checkers,
-	...components
-};

package/lib/utils/cleanSendedError.js

@@ -1,47 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = function cleanSendedError (data) {
-
-	if ("object" === typeof data) {
-
-		if (data instanceof Error) {
-			return data.message ? data.message : data;
-		}
-		else if (data.message && data.message instanceof Error) {
-
-			data.message = data.message.message ? data.message.message : data.message;
-
-			return data;
-
-		}
-		else if (data.error) { // 1 level recursive for "error" data (avoid too deep recursive analyse)
-
-			if (data.error instanceof Error) {
-				data.error = data.error.message ? data.error.message : data.error;
-			}
-			else if (data.error.message && data.error.message instanceof Error) {
-				data.error.message = data.error.message.message ? data.error.message.message : data.error.message;
-			}
-
-			return data;
-
-		}
-		else if (data.err && data.err instanceof Error) { // 1 level recursive for "err" data (avoid too deep recursive analyse)
-
-			data.err = data.err.message ? data.err.message : data.err;
-
-			return data;
-
-		}
-		else {
-			return data;
-		}
-
-	}
-	else {
-		return data;
-	}
-
-};

package/lib/utils/descriptor/extractParams.js

@@ -1,29 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const removeFirstSlash = require(join(__dirname, "..", "removeFirstSlash.js"));
-
-// module
-
-module.exports = function extractParams (patternPath, realPath) {
-
-	const params = {};
-
-		const patternPathSplitted = removeFirstSlash(patternPath).split("/");
-
-		removeFirstSlash(realPath).split("/").forEach((p, i) => {
-
-			if ("{" === patternPathSplitted[i][0]) {
-				params[patternPathSplitted[i].replace("{", "").replace("}", "")] = decodeURI(p);
-			}
-
-		});
-
-	return params;
-
-};

package/lib/utils/descriptor/extractPathMethodByOperationId.js

@@ -1,47 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = function extractPathMethodByOperationId (paths, operationId) {
-
-	// no paths in this Descriptor
-	if ("object" !== typeof paths || null === paths) {
-		return null;
-	}
-
-	// no operationId given
-	else if ("string" !== typeof operationId || "" === operationId.trim()) {
-		return null;
-	}
-
-	else {
-
-		let result = null;
-
-			for (let i = 0, pathnames = Object.keys(paths); i < pathnames.length; ++i) {
-
-				const pathname = pathnames[i];
-
-				const method = Object.keys(paths[pathname]).find((m) => {
-					return paths[pathname][m].operationId === operationId;
-				});
-
-				if ("undefined" !== typeof method) {
-
-					result = {
-						"path": pathname,
-						method,
-						operationId
-					};
-
-					break;
-
-				}
-
-			}
-
-		return result;
-
-	}
-
-};

package/lib/utils/descriptor/extractPattern.js

@@ -1,38 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const removeFirstSlash = require(join(__dirname, "..", "removeFirstSlash.js"));
-
-// module
-
-module.exports = function extractPattern (paths, pathname, method) {
-
-	return "object" !== typeof paths ? "" : Object.keys(paths).filter((p) => {
-		return "undefined" !== typeof paths[p][method];
-	}).find((p) => {
-
-		const pathnameSplitted = removeFirstSlash(pathname).split("/");
-		const pathSplitted = removeFirstSlash(p).split("/");
-
-		if (pathnameSplitted.length !== pathSplitted.length) {
-			return false;
-		}
-
-		for (let i = 0; i < pathnameSplitted.length; ++i) {
-
-			if ("{" !== pathSplitted[i][0] && pathSplitted[i] !== pathnameSplitted[i]) {
-				return false;
-			}
-
-		}
-
-		return true;
-
-	}) || "";
-
-};

package/lib/utils/descriptor/extractSchemaType.js

@@ -1,24 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = function extractSchemaType (schema, schemas) {
-
-	let result = "string";
-
-		if (schema.type) {
-			result = schema.type;
-		}
-		else if (schema.$ref) {
-
-			const ref = schema.$ref.replace("#/components/schemas/", "");
-
-			if (schemas[ref] && schemas[ref].type) {
-				result = schemas[ref].type;
-			}
-
-		}
-
-	return result;
-
-};

package/lib/utils/descriptor/main.js

@@ -1,21 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const extractParams = require(join(__dirname, "extractParams.js"));
-	const extractPattern = require(join(__dirname, "extractPattern.js"));
-	const extractPathMethodByOperationId = require(join(__dirname, "extractPathMethodByOperationId.js"));
-	const extractSchemaType = require(join(__dirname, "extractSchemaType.js"));
-
-// module
-
-module.exports = {
-	extractParams,
-	extractPattern,
-	extractPathMethodByOperationId,
-	extractSchemaType
-};

package/lib/utils/file/checkFile.js

@@ -1,22 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const isFile = require(join(__dirname, "isFile.js"));
-
-// module
-
-module.exports = function checkFile (file) {
-
-	return isFile(file).then((exists) => {
-
-		return exists ? Promise.resolve() :
-			Promise.reject(new Error("\"" + file + "\" does not exist."));
-
-	});
-
-};

package/lib/utils/file/isFile.js

@@ -1,29 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-	const { lstat } = require("fs");
-
-	// locals
-
-	const { checkNonEmptyString } = require(join(__dirname, "..", "..", "checkers", "main.js"));
-
-// module
-
-module.exports = function isFile (file) {
-
-	return checkNonEmptyString("file", file).then(() => {
-
-		return new Promise((resolve) => {
-
-			lstat(file, (err, stats) => {
-				return resolve(Boolean(!err && stats.isFile()));
-			});
-
-		});
-
-	});
-
-};

package/lib/utils/file/main.js

@@ -1,19 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const checkFile = require(join(__dirname, "checkFile.js"));
-	const isFile = require(join(__dirname, "isFile.js"));
-	const readJSONFile = require(join(__dirname, "readJSONFile.js"));
-
-// module
-
-module.exports = {
-	checkFile,
-	isFile,
-	readJSONFile
-};

package/lib/utils/file/readJSONFile.js

@@ -1,30 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-	const { readFile } = require("fs");
-
-	// locals
-	const checkFile = require(join(__dirname, "checkFile.js"));
-
-// module
-
-module.exports = function readJSONFile (file) {
-
-	return checkFile(file).then(() => {
-
-		return new Promise((resolve, reject) => {
-
-			readFile(file, "utf8", (err, content) => {
-				return err ? reject(err) : resolve(content);
-			});
-
-		});
-
-	}).then((content) => {
-		return Promise.resolve(JSON.parse(content));
-	});
-
-};

package/lib/utils/getUniqueID.js

@@ -1,20 +0,0 @@
-"use strict";
-
-// private
-
-	// methods
-
-		/**
-		* @return {string} formated random id fragment
-		*/
-		function _s4 () {
-			return Math.floor((1 + Math.random()) * 0x10000).toString(16).substring(1);
-		}
-
-// module
-
-module.exports = function getUniqueID () {
-
-	return _s4() + _s4() + "-" + _s4();
-
-};

package/lib/utils/removeFirstSlash.js

@@ -1,7 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = function removeFirstSlash (path) {
-	return "string" === typeof path && "/" === path[0] ? path.substring(1, path.length) : String(path);
-};