node-pluginsmanager 2.3.7 → 2.4.0

package/lib/cjs/cmd/git/gitInstall.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// natives
+const path_1 = require("path");
+// locals
+const checkDirectory_1 = __importDefault(require("../../checkers/checkDirectory"));
+const checkNonEmptyString_1 = __importDefault(require("../../checkers/checkNonEmptyString"));
+const cmd_1 = __importDefault(require("../cmd"));
+// module
+function gitInstall(directory, user, repo) {
+    return (0, checkNonEmptyString_1.default)("cmd/git/install/directory", directory).then(() => {
+        return new Promise((resolve, reject) => {
+            (0, checkDirectory_1.default)("cmd/git/install/directory", directory).then(() => {
+                reject(new Error("\"" + directory + "\" aldready exists"));
+            }).catch(() => {
+                resolve();
+            });
+        });
+    }).then(() => {
+        return (0, checkNonEmptyString_1.default)("cmd/git/install/user", user);
+    }).then(() => {
+        return (0, checkNonEmptyString_1.default)("cmd/git/install/repo", repo);
+    }).then(() => {
+        // git clone
+        return (0, cmd_1.default)((0, path_1.dirname)(directory), "git", [
+            "-c",
+            "core.quotepath=false",
+            "clone",
+            "--recursive",
+            "--depth",
+            "1",
+            "https://github.com/" + user + "/" + repo + "/",
+            directory
+        ]);
+    });
+}
+exports.default = gitInstall;
+;

package/lib/cjs/cmd/git/gitUpdate.d.ts

@@ -0,0 +1 @@
+export default function gitUpdate(directory: string): Promise<void>;

package/lib/cjs/cmd/git/gitUpdate.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// locals
+const checkDirectory_1 = __importDefault(require("../../checkers/checkDirectory"));
+const cmd_1 = __importDefault(require("../cmd"));
+// module
+function gitUpdate(directory) {
+    return (0, checkDirectory_1.default)("cmd/git/update/directory", directory).then(() => {
+        // git update
+        return (0, cmd_1.default)(directory, "git", ["pull"]);
+    });
+}
+exports.default = gitUpdate;
+;

package/lib/cjs/cmd/npm/npmCmd.d.ts

@@ -0,0 +1 @@
+export default function npmCmd(directory: string, params: Array<string>): Promise<void>;

package/lib/cjs/cmd/npm/npmCmd.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// locals
+const checkDirectory_1 = __importDefault(require("../../checkers/checkDirectory"));
+const cmd_1 = __importDefault(require("../cmd"));
+// module
+function npmCmd(directory, params) {
+    return (0, checkDirectory_1.default)("cmd/npm/cmd/directory", directory).then(() => {
+        // npm install
+        return (0, cmd_1.default)(directory, (/^win/).test(process.platform) ? "npm.cmd" : "npm", params);
+    });
+}
+exports.default = npmCmd;
+;

package/lib/cjs/cmd/npm/npmInstall.d.ts

@@ -0,0 +1 @@
+export default function npmInstall(directory: string): Promise<void>;

package/lib/cjs/cmd/npm/npmInstall.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// locals
+const npmCmd_1 = __importDefault(require("./npmCmd"));
+// module
+function npmInstall(directory) {
+    return (0, npmCmd_1.default)(directory, ["install", "--prod"]);
+}
+exports.default = npmInstall;
+;

package/lib/cjs/cmd/npm/npmUpdate.d.ts

@@ -0,0 +1 @@
+export default function npmUpdate(directory: string): Promise<void>;

package/lib/cjs/cmd/npm/npmUpdate.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// locals
+const npmCmd_1 = __importDefault(require("./npmCmd"));
+// module
+function npmUpdate(directory) {
+    return (0, npmCmd_1.default)(directory, ["update", "--prod"]);
+}
+exports.default = npmUpdate;
+;

package/lib/cjs/cmd/stdToString.d.ts

@@ -0,0 +1 @@
+export default function stdToString(msg: any): string;

package/lib/cjs/cmd/stdToString.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// module
+function stdToString(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);
+    }
+}
+exports.default = stdToString;
+;

package/lib/cjs/createPluginByDirectory.d.ts

@@ -0,0 +1,2 @@
+import { Orchestrator, tLogger } from "node-pluginsmanager-plugin";
+export default function createPluginByDirectory(directory: string, externalRessourcesDirectory: string, logger: tLogger | null): Promise<Orchestrator>;

package/lib/cjs/createPluginByDirectory.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// natives
+const path_1 = require("path");
+const node_pluginsmanager_plugin_1 = require("node-pluginsmanager-plugin");
+// locals
+const checkOrchestrator_1 = __importDefault(require("./checkers/checkOrchestrator"));
+const checkAbsoluteDirectory_1 = __importDefault(require("./checkers/checkAbsoluteDirectory"));
+// module
+function createPluginByDirectory(directory, externalRessourcesDirectory, logger) {
+    return (0, checkAbsoluteDirectory_1.default)("createPluginByDirectory/directory", directory).then(() => {
+        return (0, checkAbsoluteDirectory_1.default)("createPluginByDirectory/externalRessourcesDirectory", externalRessourcesDirectory);
+    }).then(() => {
+        return new Promise((resolve, reject) => {
+            try {
+                resolve(require(directory));
+            }
+            catch (e) {
+                reject(e);
+            }
+        }).then((Plugin) => {
+            if (Plugin.Orchestrator) {
+                return Promise.resolve(Plugin.Orchestrator);
+            }
+            else if (Plugin.default) {
+                return Promise.resolve(Plugin.default);
+            }
+            else {
+                return Promise.resolve(Plugin);
+            }
+        }).then((Plugin) => {
+            return (0, node_pluginsmanager_plugin_1.checkFunction)("createPluginByDirectory/function", Plugin).then(() => {
+                const pluginBaseNameDirectory = (0, path_1.basename)(directory);
+                const plugin = new Plugin({
+                    // usefull for inherited Orchestrators
+                    "externalRessourcesDirectory": (0, path_1.join)(externalRessourcesDirectory, pluginBaseNameDirectory),
+                    "logger": logger,
+                    // useless, setted in inherited Orchestrators
+                    "packageFile": "",
+                    "descriptorFile": "",
+                    "mediatorFile": "",
+                    "serverFile": ""
+                });
+                return (0, checkOrchestrator_1.default)("createPluginByDirectory/orchestrator", plugin).then(() => {
+                    plugin.name = pluginBaseNameDirectory;
+                    return plugin.load().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);
+                });
+            });
+        });
+    });
+}
+exports.default = createPluginByDirectory;
+;

package/lib/cjs/extractGithub.d.ts

@@ -0,0 +1 @@
+export default function extractGithub(plugin: any): string;

package/lib/cjs/extractGithub.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// module
+function extractGithub(plugin) {
+    let github = "";
+    if ("object" === typeof plugin) {
+        if ("string" === typeof plugin.github) {
+            github = plugin.github;
+        }
+        else if ("string" === typeof plugin.repository) {
+            github = plugin.repository;
+        }
+        else if (plugin.repository && "string" === typeof plugin.repository.url) {
+            github = plugin.repository.url;
+        }
+    }
+    return github;
+}
+exports.default = extractGithub;
+;

package/lib/cjs/initSortedPlugins.d.ts

@@ -0,0 +1,2 @@
+import { Orchestrator } from "node-pluginsmanager-plugin";
+export default function initSortedPlugins(plugins: Array<Orchestrator>, orderedPluginsNames: Array<string>, emit: (eventName: string, ...subdata: any) => void, ...data: any): Promise<void>;

package/lib/cjs/initSortedPlugins.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// private
+// methods
+function _initPlugin(plugin, emit, ...data) {
+    emit("initializing", plugin, ...data);
+    return plugin.init(data).then(() => {
+        emit("initialized", plugin, ...data);
+        return Promise.resolve();
+    });
+}
+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
+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.name < b.name) {
+                    return -1;
+                }
+                else if (a.name > b.name) {
+                    return 1;
+                }
+                else {
+                    return 0;
+                }
+            })
+        ];
+        // then, all other plugins, asynchronously
+        return unsortedPlugin.length ?
+            _initPlugins(unsortedPlugin, emit, data) :
+            Promise.resolve();
+    });
+}
+exports.default = initSortedPlugins;
+;

package/lib/cjs/loadSortedPlugins.d.ts

@@ -0,0 +1,2 @@
+import { Orchestrator, tLogger } from "node-pluginsmanager-plugin";
+export default function loadSortedPlugins(globalDirectory: string, externalRessourcesDirectory: string, files: Array<string>, loadedPlugins: Array<Orchestrator>, orderedPluginsNames: Array<string>, emit: (eventName: string, ...subdata: any) => void, logger: tLogger | null, ...data: any): Promise<void>;

package/lib/cjs/loadSortedPlugins.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// deps
+// natives
+const path_1 = require("path");
+// locals
+const createPluginByDirectory_1 = __importDefault(require("./createPluginByDirectory"));
+// private
+// methods
+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 = (0, path_1.join)(globalDirectory, pluginFileName);
+        return (0, createPluginByDirectory_1.default)(directory, externalRessourcesDirectory, logger);
+        // emit event
+    }).then((createdPlugin) => {
+        emit("loaded", createdPlugin, ...data);
+        loadedPlugins.push(createdPlugin);
+        return Promise.resolve();
+    });
+}
+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
+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();
+    });
+}
+exports.default = loadSortedPlugins;
+;

package/lib/cjs/main.cjs

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+// deps
+// locals
+const PluginsManager_1 = __importDefault(require("./PluginsManager"));
+module.exports = PluginsManager_1.default;

package/lib/cjs/main.d.cts

@@ -0,0 +1,2 @@
+import PluginsManager from "./PluginsManager";
+export = PluginsManager;

package/package.json

@@ -1,22 +1,39 @@
 {
   "name": "node-pluginsmanager",
-  "version": "2.3.7",
+  "version": "2.4.0",
   "description": "A plugins manager",
-  "main": "lib/main.js",
-  "typings": "lib/index.d.ts",
+
+  "type": "commonjs",
+  "typings": "./lib/cjs/main.d.cts",
+  "main": "./lib/cjs/main.cjs",
+
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./lib/cjs/main.d.cts",
+        "default": "./lib/cjs/main.cjs"
+      }
+    }
+  },
+
   "scripts": {
-    "lint": "npx eslint ./lib/**/*.js ./test/**/*.js",
+
     "check-updates": "npx check-version-modules",
-    "unit-tests": "npx nyc --reporter=html --reporter=text mocha",
-    "tests": "npm run-script lint && npm run-script check-updates && npm run-script unit-tests",
+
+    "compile": "npx tsc --project \"./tsconfig.json\"",
+
+    "unit-tests": "npm run compile && npx nyc --reporter=html --reporter=text mocha",
+    "tests": "npm run-script check-updates && npm run-script unit-tests",
     "ci": "npm run-script tests && npx nyc report --reporter=text-lcov | coveralls"
+
   },
+
   "files": [
     "/lib"
   ],
+
   "husky": {
     "hooks": {
-      "pre-commit": "npm run-script lint",
       "pre-push": "npm run-script tests"
     }
   },
@@ -36,21 +53,22 @@
   },
   "dependencies": {
     "check-version-modules": "1.3.5",
-    "node-promfs": "3.7.0"
+    "fs-extra": "10.1.0"
   },
   "devDependencies": {
-    "@types/node": "17.0.31",
+    "@types/express": "4.17.13",
+    "@types/fs-extra": "9.0.13",
+    "@types/node": "18.0.0",
     "@types/socket.io": "3.0.2",
     "@types/ws": "8.5.3",
     "coveralls": "3.1.1",
-    "eslint": "8.15.0",
     "express": "4.18.1",
     "husky": "8.0.1",
     "mocha": "10.0.0",
-    "node-pluginsmanager-plugin": "4.8.4",
+    "node-pluginsmanager-plugin": "5.0.4",
     "nyc": "15.1.0",
-    "typescript": "4.6.4",
-    "ws": "8.6.0"
+    "typescript": "4.7.4",
+    "ws": "8.8.0"
   },
   "homepage": "https://github.com/Psychopoulet/node-pluginsmanager#readme",
   "engines": {

package/lib/checkers/isAbsoluteDirectory.js

@@ -1,27 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join, isAbsolute } = require("path");
-
-	// locals
-	const isDirectory = require(join(__dirname, "isDirectory.js"));
-
-// module
-
-module.exports = function isAbsoluteDirectory (dataName, directory) {
-
-	return isDirectory(dataName, directory).then(() => {
-
-		return new Promise((resolve, reject) => {
-
-			return isAbsolute(directory) ? resolve() : reject(new Error(
-				"\"" + dataName + "\" (" + directory + ") is not an absolute path"
-			));
-
-		});
-
-	});
-
-};

package/lib/checkers/isDirectory.js

@@ -1,34 +0,0 @@
-"use strict";
-
-// deps
-
-	// natives
-	const { join } = require("path");
-	const { lstat } = require("fs");
-
-	// locals
-	const isNonEmptyString = require(join(__dirname, "isNonEmptyString.js"));
-
-// module
-
-module.exports = function isDirectory (dataName, directory) {
-
-	return isNonEmptyString(dataName, directory).then(() => {
-
-		return new Promise((resolve) => {
-
-			lstat(directory, (err, stats) => {
-				return resolve(Boolean(!err && stats.isDirectory()));
-			});
-
-		});
-
-	}).then((exists) => {
-
-		return exists ? Promise.resolve() : Promise.reject(new Error(
-			"\"" + dataName + "\" (" + directory + ") is not a valid directory"
-		));
-
-	});
-
-};

package/lib/checkers/isFunction.js

@@ -1,18 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = function isFunction (dataName, data) {
-
-	if ("undefined" === typeof data) {
-		return Promise.reject(new ReferenceError("\"" + dataName + "\" parameter is missing"));
-	}
-		else if ("function" !== typeof data) {
-			return Promise.reject(new TypeError("\"" + dataName + "\" parameter is not a function"));
-		}
-
-	else {
-		return Promise.resolve();
-	}
-
-};

package/lib/checkers/isNonEmptyArray.js

@@ -1,21 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = function isNonEmptyArray (dataName, data) {
-
-	if ("undefined" === typeof data) {
-		return Promise.reject(new ReferenceError("\"" + dataName + "\" parameter is missing"));
-	}
-		else if ("object" !== typeof data || !(data instanceof Array)) {
-			return Promise.reject(new TypeError("\"" + dataName + "\" parameter is not an Array"));
-		}
-		else if (!data.length) {
-			return Promise.reject(new RangeError("\"" + dataName + "\" parameter is empty"));
-		}
-
-	else {
-		return Promise.resolve();
-	}
-
-};

package/lib/checkers/isNonEmptyString.js

@@ -1,21 +0,0 @@
-"use strict";
-
-// module
-
-module.exports = function isNonEmptyString (dataName, data) {
-
-	if ("undefined" === typeof data) {
-		return Promise.reject(new ReferenceError("\"" + dataName + "\" parameter is missing"));
-	}
-		else if ("string" !== typeof data) {
-			return Promise.reject(new TypeError("\"" + dataName + "\" parameter is not a string"));
-		}
-		else if ("" === data.trim()) {
-			return Promise.reject(new RangeError("\"" + dataName + "\" parameter is empty"));
-		}
-
-	else {
-		return Promise.resolve();
-	}
-
-};

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);
-		});
-
-	}
-
-};