node-pluginsmanager-plugin 4.8.5 → 4.8.8

package/lib/index.d.ts

@@ -8,204 +8,272 @@ declare module "node-pluginsmanager-plugin" {
 	import { Server as WebSocketServer } from "ws";
 	import { Server as SocketIOServer } from "socket.io";
 
-	// options
+	// checkers
 
-	type tLogType = "log" | "info" | "warning" | "error";
+		// undefined
+		export function checkExists (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkExists (dataName: string, data: any, async: boolean): null | ReferenceError;
 
-	interface iDescriptorUserOptions {
-		"descriptor": object | null;
-		"externalRessourcesDirectory": string;
-		"logger": Function | null;
-	}
+		// native
+		export function checkBoolean (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkBoolean (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
 
-		interface iMediatorUserOptions extends iDescriptorUserOptions {
-			"mediator": Mediator | null;
-		}
+		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;
 
-	interface iUrlParameters {
-		"url": {
-			"path": object;
-			"query": object;
-			"headers": object;
-			"cookies": object;
-		};
-	}
+		export function checkObject (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkObject (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
 
-	interface iOrchestratorOptions {
-		"externalRessourcesDirectory": string;
-		"packageFile": string;
-		"descriptorFile": string;
-		"mediatorFile": string;
-		"serverFile": string;
-	}
+		export function checkString (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkString (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
 
-	// classes
+		// abstract
+		export function checkArray (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkArray (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
 
-	class DescriptorUser extends EventEmitter {
+		export function checkInteger (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkInteger (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError;
 
-		// attributes
+		// 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;
 
-			// public
+		export function checkNonEmptyInteger (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkNonEmptyInteger (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
 
-				public initialized: boolean;
+		export function checkNonEmptyNumber (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkNonEmptyNumber (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
 
-			// protected
+		export function checkNonEmptyObject (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkNonEmptyObject (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
 
-				protected _descriptorValidated: boolean;
+		export function checkNonEmptyString (dataName: string, data: any, async?: boolean): Promise<void>;
+		export function checkNonEmptyString (dataName: string, data: any, async: boolean): null | ReferenceError | TypeError | RangeError;
 
-				protected _externalRessourcesDirectory: string;
+		// 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;
 
-				protected _Descriptor: object | null;
-				protected _Logger: Function | null;
+		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;
 
-		// constructor
+		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;
 
-			constructor (options: iDescriptorUserOptions);
+		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;
 
-		// methods
+		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;
 
-			// protected
+		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;
 
-				protected _initWorkSpace(data?: any): Promise<void>;
-				protected _releaseWorkSpace(data?: any): Promise<void>;
-				protected _log(type: tLogType, message: string, bold?: boolean): this;
+		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;
 
-			// public
+		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;
 
-				public checkDescriptor(): Promise<void>;
-				public init(data?: any): Promise<void>;
-				public release(data?: any): Promise<void>;
+	// 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 class Mediator extends DescriptorUser {
+		export interface iMediatorUserOptions extends iDescriptorUserOptions {
+				"mediator": Mediator | null;
+			}
+
+		export interface iUrlParameters {
+			"url": {
+				"path": object;
+				"query": object;
+				"headers": object;
+				"cookies": object;
+			};
+		}
 
-		// attributes
+		export interface iOrchestratorOptions {
+			"externalRessourcesDirectory": string;
+			"packageFile": string;
+			"descriptorFile": string;
+			"mediatorFile": string;
+			"serverFile": string;
+		}
 
-			public _validator: null | object;
+		export class DescriptorUser extends EventEmitter {
 
-		// methods
+			// attributes
 
-			public checkParameters(operationId: string, urlParams: iUrlParameters, bodyParams: object): Promise<void>;
-			public checkResponse(operationId: string, res: Response): Promise<void>;
+				// public
 
-	}
+					public initialized: boolean;
 
-	class MediatorUser extends DescriptorUser {
+				// protected
 
-		// attributes
+					protected _descriptorValidated: boolean;
 
-			protected _Mediator: Mediator | null;
+					protected _externalRessourcesDirectory: string;
 
-		// constructor
+					protected _Descriptor: object | null;
+					protected _Logger: Function | null;
 
-			constructor (options: iMediatorUserOptions);
+			// constructor
 
-		// methods
+				constructor (options: iDescriptorUserOptions);
 
-			public checkMediator(): Promise<void>;
+			// methods
 
-	}
+				// protected
 
-	export class Server extends MediatorUser {
+					protected _initWorkSpace(data?: any): Promise<void>;
+					protected _releaseWorkSpace(data?: any): Promise<void>;
+					protected _log(type: tLogType, message: string, bold?: boolean): this;
 
-		// attributes
+				// public
 
-			protected _socketServer: WebSocketServer | SocketIOServer | null;
-			protected _checkParameters: boolean;
-			protected _checkResponse: boolean;
-			protected _cors: boolean;
+					public checkDescriptor(): Promise<void>;
+					public init(data?: any): Promise<void>;
+					public release(data?: any): Promise<void>;
 
-		// methods
+		}
 
-			public disableCheckParameters(): this;
-			public enableCheckParameters(): this;
-			public disableCheckResponse(): this;
-			public enableCheckResponse(): this;
+		export class Mediator extends DescriptorUser {
 
-			public disableCors(): this;
-			public enableCors(): this;
+			// attributes
 
-			public appMiddleware(req: Request, res: Response, next: Function): void;
-			public socketMiddleware(server: WebSocketServer | SocketIOServer): void;
-			public push(command: string, data?: any): this;
+				public _validator: null | object;
 
-	}
+			// methods
 
-	export class Orchestrator extends MediatorUser {
+				public checkParameters(operationId: string, urlParams: iUrlParameters, bodyParams: object): Promise<void>;
+				public checkResponse(operationId: string, res: Response): Promise<void>;
 
-		// attributes
+		}
 
-			// protected
+		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 _Server: Server | null;
 				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;
 
-				// params
-				protected _packageFile: string;
-				protected _descriptorFile: string;
-				protected _mediatorFile: string;
-				protected _serverFile: string;
+		}
+
+		export class Orchestrator extends MediatorUser {
+
+			// attributes
+
+				// protected
 
-				protected _extended: Array<string>;
+					protected _Server: Server | null;
+					protected _socketServer: WebSocketServer | SocketIOServer | null;
+					protected _checkParameters: boolean;
+					protected _checkResponse: boolean;
 
-			// public
+					// params
+					protected _packageFile: string;
+					protected _descriptorFile: string;
+					protected _mediatorFile: string;
+					protected _serverFile: string;
 
-				public enabled: boolean;
+					protected _extended: Array<string>;
 
-				// 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;
+				// public
 
-		// constructor
+					public enabled: boolean;
 
-			constructor (options: iOrchestratorOptions);
+					// 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;
 
-		// methods
+			// constructor
 
-			// checkers
+				constructor (options: iOrchestratorOptions);
 
-			public checkConf(): Promise<void>;
-			public isEnable(): Promise<void>;
-			public checkFiles(): Promise<void>;
-			public checkServer(): Promise<void>;
+			// methods
 
-			// middleware
+				// checkers
 
-			public disableCheckParameters(): this;
-			public enableCheckParameters(): this;
-			public disableCheckResponse(): this;
-			public enableCheckResponse(): this;
+				public checkConf(): Promise<void>;
+				public isEnable(): Promise<void>;
+				public checkFiles(): Promise<void>;
+				public checkServer(): Promise<void>;
 
-			public disableCors(): this;
-			public enableCors(): this;
+				// middleware
 
-			public appMiddleware(req: Request, res: Response, next: Function): void;
-			public socketMiddleware(server: WebSocketServer | SocketIOServer): void;
+				public disableCheckParameters(): this;
+				public enableCheckParameters(): this;
+				public disableCheckResponse(): this;
+				public enableCheckResponse(): this;
 
-			// init / release
+				public disableCors(): this;
+				public enableCors(): this;
 
-			public load(data?: any): Promise<void>;
-			public destroy(data?: any): Promise<void>;
+				public appMiddleware(req: Request, res: Response, next: Function): void;
+				public socketMiddleware(server: WebSocketServer | SocketIOServer): void;
 
-			// write
+				// init / release
 
-			public install(data?: any): Promise<void>;
-			public update(data?: any): Promise<void>;
-			public uninstall(data?: any): Promise<void>;
+				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 {}
+		export class NotFoundError extends Error {}
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-pluginsmanager-plugin",
-  "version": "4.8.5",
+  "version": "4.8.8",
   "description": "An abstract parent plugin for node-pluginsmanager",
   "main": "lib/main.js",
   "typings": "lib/index.d.ts",
@@ -39,21 +39,21 @@
     "express-openapi-validate": "0.6.1"
   },
   "devDependencies": {
-    "@types/node": "17.0.34",
+    "@types/node": "17.0.36",
     "@types/socket.io": "3.0.2",
     "@types/ws": "8.5.3",
     "check-version-modules": "1.3.5",
     "coveralls": "3.1.1",
     "colors": "1.4.0",
-    "eslint": "8.15.0",
+    "eslint": "8.16.0",
     "express": "4.18.1",
     "husky": "8.0.1",
     "mocha": "10.0.0",
     "nyc": "15.1.0",
     "socket.io": "4.5.1",
     "socket.io-client": "4.5.1",
-    "typescript": "4.6.4",
-    "ws": "8.6.0"
+    "typescript": "4.7.2",
+    "ws": "8.7.0"
   },
   "homepage": "https://github.com/Psychopoulet/node-pluginsmanager-plugin#readme",
   "engines": {