node-pluginsmanager 2.3.9 → 2.4.0

package/lib/checkers/isOrchestrator.js

@@ -1,41 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-	const Events = require("events");
-
-	// locals
-	const isFunction = require(join(__dirname, "isFunction.js"));
-
-// module
-
-module.exports = function isOrchestrator (dataName, data) {
-
-	if ("undefined" === typeof data) {
-		return Promise.reject(new ReferenceError("\"" + dataName + "\" parameter is missing"));
-	}
-		else if ("object" !== typeof data || !(data instanceof Events)) {
-			return Promise.reject(new TypeError("\"" + dataName + "\" parameter is not an Event"));
-		}
-
-	else {
-
-		return isFunction("isOrchestrator/load", data.load).then(() => {
-			return isFunction("isOrchestrator/destroy", data.destroy);
-		}).then(() => {
-			return isFunction("isOrchestrator/init", data.init);
-		}).then(() => {
-			return isFunction("isOrchestrator/release", data.release);
-		}).then(() => {
-			return isFunction("isOrchestrator/install", data.install);
-		}).then(() => {
-			return isFunction("isOrchestrator/update", data.update);
-		}).then(() => {
-			return isFunction("isOrchestrator/uninstall", data.uninstall);
-		});
-
-	}
-
-};

package/lib/cmd/cmd.js

@@ -1,44 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-	const { spawn } = require("child_process");
-
-	// locals
-	const isDirectory = require(join(__dirname, "..", "checkers", "isDirectory.js"));
-	const isNonEmptyArray = require(join(__dirname, "..", "checkers", "isNonEmptyArray.js"));
-	const isNonEmptyString = require(join(__dirname, "..", "checkers", "isNonEmptyString.js"));
-	const stdToString = require(join(__dirname, "stdToString.js"));
-
-// module
-
-module.exports = function cmd (directory, command, params) {
-
-	return isDirectory("cmd/directory", directory).then(() => {
-		return isNonEmptyString("cmd/command", command);
-	}).then(() => {
-		return isNonEmptyArray("cmd/params", params);
-	}).then(() => {
-
-		return new Promise((resolve, reject) => {
-
-			let result = "";
-			const mySpawn = spawn(command, params, {
-				"cwd": directory
-			}).on("error", (err) => {
-				result += stdToString(err);
-			}).on("close", (code) => {
-				return code ? reject(new Error(result)) : resolve();
-			});
-
-			mySpawn.stderr.on("data", (msg) => {
-				result += stdToString(msg);
-			});
-
-		});
-
-	});
-
-};

package/lib/cmd/git/install.js

@@ -1,49 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join, dirname } = require("path");
-
-	// locals
-	const isDirectory = require(join(__dirname, "..", "..", "checkers", "isDirectory.js"));
-	const isNonEmptyString = require(join(__dirname, "..", "..", "checkers", "isNonEmptyString.js"));
-	const cmd = require(join(__dirname, "..", "cmd.js"));
-
-// module
-
-module.exports = function gitinstall (directory, user, repo) {
-
-	return isNonEmptyString("cmd/git/install/directory", directory).then(() => {
-
-		return new Promise((resolve, reject) => {
-
-			isDirectory("cmd/git/install/directory", directory).then(() => {
-				reject(new Error("\"" + directory + "\" aldready exists"));
-			}).catch(() => {
-				resolve();
-			});
-
-		});
-
-	}).then(() => {
-		return isNonEmptyString("cmd/git/install/user", user);
-	}).then(() => {
-		return isNonEmptyString("cmd/git/install/repo", repo);
-	}).then(() => {
-
-		// git clone
-		return cmd(dirname(directory), "git", [
-			"-c",
-			"core.quotepath=false",
-			"clone",
-			"--recursive",
-			"--depth",
-			"1",
-			"https://github.com/" + user + "/" + repo + "/",
-			directory
-		]);
-
-	});
-
-};

package/lib/cmd/git/update.js

@@ -1,23 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const isDirectory = require(join(__dirname, "..", "..", "checkers", "isDirectory.js"));
-	const cmd = require(join(__dirname, "..", "cmd.js"));
-
-// module
-
-module.exports = function gitupdate (directory) {
-
-	return isDirectory("cmd/git/update/directory", directory).then(() => {
-
-		// git update
-		return cmd(directory, "git", [ "pull" ]);
-
-	});
-
-};

package/lib/cmd/npm/cmd.js

@@ -1,23 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const isDirectory = require(join(__dirname, "..", "..", "checkers", "isDirectory.js"));
-	const cmd = require(join(__dirname, "..", "cmd.js"));
-
-// module
-
-module.exports = function npmcmd (directory, params) {
-
-	return isDirectory("cmd/npm/cmd/directory", directory).then(() => {
-
-		// npm install
-		return cmd(directory, (/^win/).test((0, process).platform) ? "npm.cmd" : "npm", params);
-
-	});
-
-};

package/lib/cmd/npm/install.js

@@ -1,15 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const cmd = require(join(__dirname, "cmd.js"));
-
-// module
-
-module.exports = function npminstall (directory) {
-	return cmd(directory, [ "install", "--prod" ]);
-};

package/lib/cmd/npm/update.js

@@ -1,15 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const cmd = require(join(__dirname, "cmd.js"));
-
-// module
-
-module.exports = function npmupdate (directory) {
-	return cmd(directory, [ "update", "--prod" ]);
-};

package/lib/cmd/stdToString.js

@@ -1,17 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = (msg) => {
-
-	if ("object" !== typeof msg) {
-		return String(msg);
-	}
-	else if (msg instanceof Buffer) {
-		return msg.toString("utf8");
-	}
-	else {
-		return msg.message ? msg.message : String(msg);
-	}
-
-};

package/lib/createPluginByDirectory.js

@@ -1,70 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join, basename } = require("path");
-
-	// locals
-	const isAbsoluteDirectory = require(join(__dirname, "checkers", "isAbsoluteDirectory.js"));
-	const isFunction = require(join(__dirname, "checkers", "isFunction.js"));
-	const isOrchestrator = require(join(__dirname, "checkers", "isOrchestrator.js"));
-
-// module
-
-module.exports = function createPluginByDirectory (directory, externalRessourcesDirectory, logger, data) {
-
-	return isAbsoluteDirectory("createPluginByDirectory/directory", directory).then(() => {
-
-		return isAbsoluteDirectory("createPluginByDirectory/externalRessourcesDirectory", externalRessourcesDirectory);
-
-	}).then(() => {
-
-		let Plugin = null;
-		let plugin = null;
-
-		const pluginBaseNameDirectory = basename(directory);
-
-		return Promise.resolve().then(() => {
-
-			Plugin = require(directory);
-
-			if (Plugin.Orchestrator) {
-				Plugin = Plugin.Orchestrator;
-			}
-			else if (Plugin.default) {
-				Plugin = Plugin.default;
-			}
-
-			return isFunction("createPluginByDirectory/function", Plugin);
-
-		}).then(() => {
-
-			plugin = new Plugin({
-				"externalRessourcesDirectory": join(externalRessourcesDirectory, pluginBaseNameDirectory),
-				"logger": logger
-			});
-
-			return isOrchestrator("createPluginByDirectory/orchestrator", plugin);
-
-		}).then(() => {
-
-			plugin.name = pluginBaseNameDirectory;
-
-			return plugin.load(data).then(() => {
-
-				return plugin.name === pluginBaseNameDirectory ? Promise.resolve() : Promise.reject(new Error(
-					"Plugin's name (\"" + plugin.name + "\") does not fit with plugin's directory basename (\"" + pluginBaseNameDirectory + "\")"
-				));
-
-			});
-
-		}).then(() => {
-
-			return Promise.resolve(plugin);
-
-		});
-
-	});
-
-};

package/lib/index.d.ts

@@ -1,81 +0,0 @@
-/// <reference types="node" />
-
-declare module "node-pluginsmanager" {
-
-	import { EventEmitter } from "events";
-	import { Orchestrator } from "node-pluginsmanager-plugin";
-	import { Server as WebSocketServer } from "ws";
-	import { Server as SocketIOServer } from "socket.io";
-
-	interface iPluginManagerOptions {
-		"directory"?: string;
-		"externalRessourcesDirectory"?: string;
-		"logger"?: Function | null;
-	}
-
-	class PluginManager extends EventEmitter {
-
-		// attributes
-
-			// protected
-
-				protected _beforeLoadAll: (data?: any) => Promise<void> | void | null;
-				protected _beforeInitAll: (data?: any) => Promise<void> | void | null;
-
-				protected _orderedPluginsNames: Array<string>;
-
-			// public
-
-				public directory: string; // plugins location (must be writable). default : join(homedir(), "node-pluginsmanager-plugins")
-				public externalRessourcesDirectory: string; // external resources locations (sqlite, files, cache, etc...) (must be writable). default : join(homedir(), "node-pluginsmanager-resources")
-				public plugins: Array<Orchestrator>; // plugins' Orchestrators
-
-		// constructor
-
-			constructor (options?: iPluginManagerOptions);
-
-		// methods
-
-			// public
-
-				// getters
-
-				public getPluginsNames(): Array<string>;
-
-				// setters
-
-				public setOrder(pluginsNames: Array<string>): Promise<void>; // create a forced order to synchronously initialize plugins. not ordered plugins are asynchronously initialized after.
-
-				// checkers
-
-				public checkAllModules(): Promise<void>;
-				public checkModules(plugin: Orchestrator): Promise<void>;
-
-				// network
-
-				public appMiddleware(req: Request, res: Response, next: Function): void; // used for execute all plugins' middlewares in app (express or other)
-				public socketMiddleware(server: WebSocketServer | SocketIOServer): void; // middleware for socket to add bilateral push events
-
-				// load / destroy
-
-				public beforeLoadAll(callback: (data?: any) => Promise<void> | void): Promise<void>; // add a function executed before loading all plugins
-				public loadAll(data?: any): Promise<void>; // load all plugins asynchronously, using "data" in arguments for "load" plugin's Orchestrator method
-				public destroyAll(data?: any): Promise<void>; // after releasing, destroy packages data & free "plugins" list, using "data" in arguments for "destroy" plugin's Orchestrator method
-
-				// init / release
-
-				public beforeInitAll(callback: (data?: any) => Promise<void> | void): Promise<void>; // add a function executed before initializing all plugins
-				public initAll(data?: any): Promise<void>; // initialize all plugins asynchronously, using "data" in arguments for "init" plugin's Orchestrator method
-				public releaseAll(data?: any): Promise<void>; // release a plugin (keep package but destroy Mediator & Server), using "data" in arguments for "release" plugin's Orchestrator method
-
-				// write
-
-				public installViaGithub(user: string, repo: string, data?: any): Promise<Orchestrator>; // install a plugin via github repo, using "data" in arguments for "install" and "init" plugin's Orchestrator methods
-				public updateViaGithub(plugin: Orchestrator, data?: any): Promise<Orchestrator>; // update a plugin via its github repo, using "data" in arguments for "release", "update" and "init" plugin's methods
-				public uninstall(plugin: Orchestrator, data?: any): Promise<string>; // uninstall a plugin, using "data" in arguments for "release" and "uninstall" plugin's methods
-
-	}
-
-	export = PluginManager;
-
-}

package/lib/initSortedPlugins.js

@@ -1,96 +0,0 @@
-"use strict";
-
-// private
-
-	// methods
-
-		/**
-		* Load plugins with sort conditions
-		* @param {object} plugin : plugin to init
-		* @param {function} emit : emit data function
-		* @param {object} data : data to send
-		* @return {Promise} : result operation
-		*/
-		function _initPlugin (plugin, emit, data) {
-
-			emit("initializing", plugin, data);
-
-			return plugin.init(data).then(() => {
-
-				emit("initialized", plugin, data);
-
-				return Promise.resolve();
-
-			});
-
-		}
-
-		/**
-		* Load plugins with sort conditions
-		* @param {object} pluginsToInit : plugins to init
-		* @param {function} emit : emit data function
-		* @param {object} data : data to send
-		* @param {number} i : stepper
-		* @return {Promise} : result operation
-		*/
-		function _initPlugins (pluginsToInit, emit, data, i = 0) {
-
-			return i < pluginsToInit.length ? Promise.resolve().then(() => {
-
-				return _initPlugin(pluginsToInit[i], emit, data);
-
-			// loop
-			}).then(() => {
-
-				return _initPlugins(pluginsToInit, emit, data, i + 1);
-
-			}) : Promise.resolve();
-
-		}
-
-// module
-
-module.exports = function initSortedPlugins (plugins, orderedPluginsNames, emit, data) {
-
-	// if no plugins, does not run
-	return !plugins.length ? Promise.resolve() : Promise.resolve().then(() => {
-
-		const sortedPlugins = [
-			...plugins.filter((plugin) => {
-				return orderedPluginsNames.includes(plugin.name);
-			})
-		];
-
-		// first, sorted plugins
-		return sortedPlugins.length ?
-			_initPlugins(sortedPlugins, emit, data) :
-			Promise.resolve();
-
-	}).then(() => {
-
-		const unsortedPlugin = [
-			...plugins.filter((plugin) => {
-				return !orderedPluginsNames.includes(plugin.name);
-			}).sort((a, b) => {
-
-				if (a < b) {
-					return -1;
-				}
-				else if (a > b) {
-					return 1;
-				}
-				else {
-					return 0;
-				}
-
-			})
-		];
-
-		// then, all other plugins, asynchronously
-		return unsortedPlugin.length ?
-			_initPlugins(unsortedPlugin, emit, data) :
-			Promise.resolve();
-
-	});
-
-};

package/lib/loadSortedPlugins.js

@@ -1,132 +0,0 @@
-/*
-	eslint max-params: 0
-*/
-
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-
-	// locals
-	const createPluginByDirectory = require(join(__dirname, "createPluginByDirectory.js"));
-
-// private
-
-	// methods
-
-		/**
-		* Load plugins with sort conditions
-		* @param {string} globalDirectory : get plugins directory
-		* @param {string} externalRessourcesDirectory : get ressources directory
-		* @param {string} pluginFileName : get ressources directory
-		* @param {object} loadedPlugins : already loaded plugins
-		* @param {function} emit : emit data function
-		* @param {function|null} logger : if logger, send it to plugin
-		* @param {object} data : data to send
-		* @return {Promise} : result operation
-		*/
-		function _loadPlugin (globalDirectory, externalRessourcesDirectory, pluginFileName, loadedPlugins, emit, logger, data) {
-
-			// is already loaded ?
-			const plugin = loadedPlugins.find((p) => {
-				return pluginFileName === p.name;
-			});
-
-			// is already exists ?
-			return plugin ? Promise.resolve() : Promise.resolve().then(() => {
-
-				emit("loading", pluginFileName, data);
-
-				const directory = join(globalDirectory, pluginFileName);
-
-				return createPluginByDirectory(directory, externalRessourcesDirectory, logger, data);
-
-			// emit event
-			}).then((createdPlugin) => {
-
-				emit("loaded", createdPlugin, data);
-				loadedPlugins.push(createdPlugin);
-
-				return Promise.resolve();
-
-			});
-
-		}
-
-		/**
-		* Load plugins with sort conditions
-		* @param {string} globalDirectory : get plugins directory
-		* @param {string} externalRessourcesDirectory : get ressources directory
-		* @param {Array} pluginsToLoad : plugins to load
-		* @param {object} loadedPlugins : already loaded plugins
-		* @param {function} emit : emit data function
-		* @param {function|null} logger : if logger, send it to plugin
-		* @param {object} data : data to send
-		* @param {number} i : stepper
-		* @return {Promise} : result operation
-		*/
-		function _loadPlugins (globalDirectory, externalRessourcesDirectory, pluginsToLoad, loadedPlugins, emit, logger, data, i = 0) {
-
-			return i < pluginsToLoad.length ? Promise.resolve().then(() => {
-
-				return _loadPlugin(globalDirectory, externalRessourcesDirectory, pluginsToLoad[i], loadedPlugins, emit, logger, data);
-
-			// loop
-			}).then(() => {
-
-				return _loadPlugins(globalDirectory, externalRessourcesDirectory, pluginsToLoad, loadedPlugins, emit, logger, data, i + 1);
-
-			}) : Promise.resolve();
-
-		}
-
-// module
-
-module.exports = function loadSortedPlugins (
-	globalDirectory, externalRessourcesDirectory, files, loadedPlugins, orderedPluginsNames, emit, logger, data
-) {
-
-	// if no files, does not run
-	return !files.length ? Promise.resolve() : Promise.resolve().then(() => {
-
-		const sortedPluginsNames = [
-			...files.filter((pluginName) => {
-				return orderedPluginsNames.includes(pluginName);
-			})
-		];
-
-		// first, sorted plugins
-		return sortedPluginsNames.length ?
-			_loadPlugins(globalDirectory, externalRessourcesDirectory, sortedPluginsNames, loadedPlugins, emit, logger, data) :
-			Promise.resolve();
-
-	}).then(() => {
-
-		const unsortedPluginsNames = [
-			...files.filter((pluginName) => {
-				return !orderedPluginsNames.includes(pluginName);
-			}).sort((a, b) => {
-
-				if (a < b) {
-					return -1;
-				}
-				else if (a > b) {
-					return 1;
-				}
-				else {
-					return 0;
-				}
-
-			})
-		];
-
-		// then, all other plugins, asynchronously
-		return unsortedPluginsNames.length ?
-		_loadPlugins(globalDirectory, externalRessourcesDirectory, unsortedPluginsNames, loadedPlugins, emit, logger, data) :
-			Promise.resolve();
-
-	});
-
-};