node-pluginsmanager 3.5.0 → 3.6.0

package/lib/cjs/PluginsManager.d.ts

@@ -31,6 +31,7 @@ export default class PluginsManager extends EventEmitter {
     beforeInitAll(callback: tBeforeAllMethodCallback): Promise<void>;
     initAll(...data: unknown[]): Promise<void>;
     releaseAll(...data: unknown[]): Promise<void>;
+    getLatestGithubTag(user: string, repo: string): Promise<string>;
     installViaGithub(user: string, repo: string, ...data: unknown[]): Promise<Orchestrator>;
     updateViaGithub(plugin: Orchestrator, ...data: unknown[]): Promise<Orchestrator>;
     uninstall(plugin: Orchestrator, ...data: unknown[]): Promise<string>;

package/lib/cjs/PluginsManager.js

@@ -12,6 +12,7 @@ const promises_1 = require("node:fs/promises");
 // externals
 const check_version_modules_1 = __importDefault(require("check-version-modules"));
 const check_node_engine_1 = __importDefault(require("check-node-engine"));
+const semver_1 = __importDefault(require("semver"));
 // locals
 const rmdirp_1 = __importDefault(require("./utils/rmdirp"));
 const checkAbsoluteDirectory_1 = __importDefault(require("./checkers/checkAbsoluteDirectory"));
@@ -24,7 +25,9 @@ const isFile_1 = __importDefault(require("./utils/isFile"));
 const createPluginByDirectory_1 = __importDefault(require("./createPluginByDirectory"));
 const loadSortedPlugins_1 = __importDefault(require("./loadSortedPlugins"));
 const initSortedPlugins_1 = __importDefault(require("./initSortedPlugins"));
-const extractGithub_1 = __importDefault(require("./extractGithub"));
+const extractGithub_1 = __importDefault(require("./utils/extractGithub"));
+const getLatestGithubTag_1 = __importDefault(require("./utils/getLatestGithubTag"));
+const parseGithubUserRepo_1 = __importDefault(require("./utils/parseGithubUserRepo"));
 // git
 const gitInstall_1 = __importDefault(require("./cmd/git/gitInstall"));
 const gitUpdate_1 = __importDefault(require("./cmd/git/gitUpdate"));
@@ -267,6 +270,11 @@ class PluginsManager extends node_events_1.default {
             this.emit("allreleased", ...data);
         });
     }
+    getLatestGithubTag(user, repo) {
+        return (0, getLatestGithubTag_1.default)(user, repo).then((tag) => {
+            return tag.name;
+        });
+    }
     // install a plugin via github repo, using "data" in arguments for "install" and "init" plugin's Orchestrator methods
     installViaGithub(user, repo, ...data) {
         return (0, checkAbsoluteDirectory_1.default)("installViaGithub/directory", this.directory).then(() => {
@@ -285,7 +293,10 @@ class PluginsManager extends node_events_1.default {
         }).then((directory) => {
             // download plugin
             return Promise.resolve().then(() => {
-                return (0, gitInstall_1.default)(directory, user, repo);
+                this._logger?.("info", "Downloading plugin...", false, repo);
+                return (0, gitInstall_1.default)(directory, user, repo).then(() => {
+                    this._logger?.("success", "Download success", false, repo);
+                });
                 // check if plugin directory is created
             }).then(() => {
                 return (0, isDirectory_1.default)(directory).then((isPluginADirectory) => {
@@ -307,6 +318,11 @@ class PluginsManager extends node_events_1.default {
                         return JSON.parse(content);
                     });
                 }).then((packageData) => {
+                    // check if the plugin has a valid name
+                    if ("string" !== typeof packageData.name || "" === packageData.name.trim()) {
+                        throw new Error("\"" + repo + "\" plugin has no valid name");
+                    }
+                    const pluginName = packageData.name;
                     // check if the plugin has a valid entry point
                     if ("string" !== typeof packageData.main || "" === packageData.main.trim()) {
                         throw new Error("\"" + repo + "\" plugin has no valid entry point");
@@ -326,18 +342,27 @@ class PluginsManager extends node_events_1.default {
                         if ("string" !== typeof scripts.build || "" === scripts.build.trim()) {
                             throw new Error("\"" + repo + "\" plugin has no build script registered");
                         }
+                        this._logger?.("info", "Installing dev dependencies...", false, pluginName);
                         // install plugin with dependencies
                         return (0, npmInstall_1.default)(directory, true).then(() => {
+                            this._logger?.("success", "Plugin installed successfully", false, pluginName);
+                            this._logger?.("info", "Building plugin...", false, pluginName);
                             return (0, npmBuild_1.default)(directory);
                             // remove dev dependencies
                         }).then(() => {
-                            return (0, rmdirp_1.default)((0, node_path_1.join)(directory, "node_modules"));
+                            this._logger?.("debug", "Removing dev dependencies...", false, pluginName);
+                            return (0, rmdirp_1.default)((0, node_path_1.join)(directory, "node_modules")).then(() => {
+                                this._logger?.("success", "Dev dependencies removed successfully", false, pluginName);
+                            });
                         });
                     }).then(() => {
                         if ("object" !== typeof packageData.dependencies || null === packageData.dependencies || 0 >= Object.keys(packageData.dependencies).length) {
                             return Promise.resolve();
                         }
-                        return (0, npmInstall_1.default)(directory);
+                        this._logger?.("debug", "Installing dependencies...", false, pluginName);
+                        return (0, npmInstall_1.default)(directory).then(() => {
+                            this._logger?.("success", "Dependencies installed successfully", false, pluginName);
+                        });
                     });
                 });
                 // create plugin
@@ -383,24 +408,52 @@ class PluginsManager extends node_events_1.default {
     updateViaGithub(plugin, ...data) {
         let directory = "";
         let key = -1;
+        let githubUrl = "";
+        let latestTag = "";
         // check plugin
-        return Promise.resolve().then(() => {
-            return (0, checkOrchestrator_1.default)("updateViaGithub/plugin", plugin).then(() => {
-                return (0, checkNonEmptyString_1.default)("updateViaGithub/github", (0, extractGithub_1.default)(plugin)).catch(() => {
-                    return Promise.reject(new ReferenceError("Plugin \"" + plugin.name + "\" must be linked in the package to a github project to be updated"));
-                });
+        return (0, checkOrchestrator_1.default)("updateViaGithub/plugin", plugin).then(() => {
+            const github = (0, extractGithub_1.default)(plugin);
+            return (0, checkNonEmptyString_1.default)("updateViaGithub/github", github).catch(() => {
+                return Promise.reject(new ReferenceError("Plugin \"" + plugin.name + "\" must be linked in the package to a github project to be updated"));
             }).then(() => {
-                key = this.getPluginsNames().findIndex((pluginName) => {
-                    return pluginName === plugin.name;
-                });
-                return -1 < key ? Promise.resolve() : Promise.reject(new Error("Plugin \"" + plugin.name + "\" is not registered"));
+                githubUrl = github;
             });
+        }).then(() => {
+            key = this.getPluginsNames().findIndex((pluginName) => {
+                return pluginName === plugin.name;
+            });
+            if (-1 >= key) {
+                throw new Error("Plugin \"" + plugin.name + "\" is not registered");
+            }
             // check plugin directory
         }).then(() => {
             return (0, checkAbsoluteDirectory_1.default)("updateViaGithub/directory", this.directory).then(() => {
                 directory = (0, node_path_1.join)(this.directory, plugin.name);
                 return (0, checkAbsoluteDirectory_1.default)("updateViaGithub/plugindirectory", directory);
             });
+            // check remote version
+        }).then(() => {
+            const githubUserRepo = (0, parseGithubUserRepo_1.default)(githubUrl);
+            if (!githubUserRepo) {
+                throw new Error("Plugin \"" + plugin.name + "\" has an invalid github project link");
+            }
+            const currentVersion = semver_1.default.coerce(plugin.version);
+            if (!currentVersion) {
+                throw new Error("Plugin \"" + plugin.name + "\" has no valid version (\"" + plugin.version + "\")");
+            }
+            this._logger?.("debug", "Get github latest tag", false, plugin.name);
+            return (0, getLatestGithubTag_1.default)(githubUserRepo.user, githubUserRepo.repo).then((tag) => {
+                const latestVersion = semver_1.default.coerce(tag.name);
+                if (!latestVersion) {
+                    throw new Error("No valid version found for plugin \"" + plugin.name + "\" on github");
+                }
+                this._logger?.("debug", "Compare local version with github lastest tag", false, plugin.name);
+                if (!semver_1.default.gt(latestVersion, currentVersion)) {
+                    throw new Error("Plugin \"" + plugin.name + "\" is already up to date (v" + plugin.version + ")");
+                }
+                latestTag = tag.name;
+                this._logger?.("success", "New version available", false, plugin.name);
+            });
             // release plugin
         }).then(() => {
             const pluginName = plugin.name;
@@ -411,15 +464,17 @@ class PluginsManager extends node_events_1.default {
                 this.emit("destroyed", pluginName, ...data);
                 this.plugins.splice(key, 1);
             });
-            // download plugin
+            // update plugin
         }).then(() => {
-            return (0, gitUpdate_1.default)(directory).then(() => {
+            this._logger?.("debug", "Update with new plugin version", false, plugin.name);
+            return (0, gitUpdate_1.default)(directory, latestTag).then(() => {
                 return (0, createPluginByDirectory_1.default)(directory, this.externalResourcesDirectory, this._logger, ...data);
             });
             // check plugin modules versions
         }).then((_plugin) => {
+            this._logger?.("debug", "Check modules", false, plugin.name);
             return this.checkModules(_plugin).then(() => {
-                return Promise.resolve(_plugin);
+                return _plugin;
             });
         }).then((_plugin) => {
             // update dependencies & execute update script
@@ -434,7 +489,7 @@ class PluginsManager extends node_events_1.default {
             }).then(() => {
                 this.emit("initialized", _plugin, ...data);
                 this.plugins[key] = _plugin;
-                return Promise.resolve(_plugin);
+                return _plugin;
             });
         });
     }

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

@@ -9,6 +9,7 @@ exports.default = gitInstall;
 const node_path_1 = require("node:path");
 // locals
 const checkDirectory_1 = __importDefault(require("../../checkers/checkDirectory"));
+const getLatestGithubTag_1 = __importDefault(require("../../utils/getLatestGithubTag"));
 const checkNonEmptyString_1 = __importDefault(require("../../checkers/checkNonEmptyString"));
 const cmd_1 = __importDefault(require("../cmd"));
 // module
@@ -26,16 +27,20 @@ function gitInstall(directory, user, repo) {
     }).then(() => {
         return (0, checkNonEmptyString_1.default)("cmd/git/install/repo", repo);
     }).then(() => {
-        // git clone
-        return (0, cmd_1.default)((0, node_path_1.dirname)(directory), "git", [
-            "-c",
-            "core.quotepath=false",
-            "clone",
-            "--recursive",
-            "--depth",
-            "1",
-            "https://github.com/" + user + "/" + repo + "/",
-            directory
-        ]);
+        return (0, getLatestGithubTag_1.default)(user, repo).then((tag) => {
+            // git clone
+            return (0, cmd_1.default)((0, node_path_1.dirname)(directory), "git", [
+                "-c",
+                "core.quotepath=false",
+                "clone",
+                "--recursive",
+                "--depth",
+                "1",
+                "--branch",
+                tag.name,
+                "https://github.com/" + user + "/" + repo + "/",
+                directory
+            ]);
+        });
     });
 }

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

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

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

@@ -7,11 +7,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = gitUpdate;
 // locals
 const checkDirectory_1 = __importDefault(require("../../checkers/checkDirectory"));
+const checkNonEmptyString_1 = __importDefault(require("../../checkers/checkNonEmptyString"));
 const cmd_1 = __importDefault(require("../cmd"));
 // module
-function gitUpdate(directory) {
+function gitUpdate(directory, tag) {
     return (0, checkDirectory_1.default)("cmd/git/update/directory", directory).then(() => {
-        // git update
-        return (0, cmd_1.default)(directory, "git", ["pull"]);
+        // pull latest changes from remote repository
+        if ("string" !== typeof tag) {
+            return (0, cmd_1.default)(directory, "git", ["pull"]);
+        }
+        // OR fetch specific tag from remote repository
+        return (0, checkNonEmptyString_1.default)("cmd/git/update/tag", tag).then(() => {
+            return (0, cmd_1.default)(directory, "git", [
+                "fetch",
+                "origin",
+                "tag",
+                tag,
+                "--depth",
+                "1"
+            ]).then(() => {
+                return (0, cmd_1.default)(directory, "git", ["checkout", tag]);
+            });
+        });
     });
 }

package/lib/cjs/utils/getLatestGithubTag.d.ts

@@ -0,0 +1,11 @@
+export interface GithubTag {
+    "name": string;
+    "commit": {
+        "sha": string;
+        "url": string;
+    };
+    "tarball_url": string;
+    "zipball_url": string;
+    "node_id": string;
+}
+export default function getLatestGithubTag(user: string, repo: string): Promise<GithubTag>;

package/lib/cjs/utils/getLatestGithubTag.js

@@ -0,0 +1,36 @@
+"use strict";
+// deps
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getLatestGithubTag;
+// locals
+const checkNonEmptyString_1 = __importDefault(require("../checkers/checkNonEmptyString"));
+// module
+function getLatestGithubTag(user, repo) {
+    return (0, checkNonEmptyString_1.default)("utils/getLatestGithubTag/user", user).then(() => {
+        return (0, checkNonEmptyString_1.default)("utils/getLatestGithubTag/repo", repo);
+    }).then(() => {
+        const url = "https://api.github.com/repos/" + user + "/" + repo + "/tags";
+        const method = "GET";
+        return fetch(url, {
+            "method": method,
+            "headers": {
+                "Content-Type": "application/json"
+            }
+        }).then((res) => {
+            if (res.ok) {
+                return res.json();
+            }
+            else {
+                throw new Error("Failed to fetch '" + url + "': " + res.statusText);
+            }
+        }).then((data) => {
+            if (0 >= data.length) {
+                throw new Error("No tags found for '" + url + "'");
+            }
+            return data[0];
+        });
+    });
+}

package/lib/cjs/utils/parseGithubUserRepo.d.ts

@@ -0,0 +1,5 @@
+export interface GithubUserRepo {
+    "user": string;
+    "repo": string;
+}
+export default function parseGithubUserRepo(github: string): GithubUserRepo | null;

package/lib/cjs/utils/parseGithubUserRepo.js

@@ -0,0 +1,21 @@
+"use strict";
+// types & interfaces
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseGithubUserRepo;
+// module
+function parseGithubUserRepo(github) {
+    if ("string" !== typeof github) {
+        return null;
+    }
+    const githubUrlPattern = /(?:github\.com[/:]|@github\.com:)([^/]+)\/([^/.]+)/i;
+    const userRepoPattern = /^([^/]+)\/([^/]+)$/;
+    let match = githubUrlPattern.exec(github);
+    match ??= userRepoPattern.exec(github);
+    if (!match) {
+        return null;
+    }
+    return {
+        "user": match[1],
+        "repo": match[2].replace(/\.git$/i, "")
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 
   "name": "node-pluginsmanager",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "A plugins manager.",
 
   "type": "commonjs",
@@ -43,23 +43,25 @@
     "/lib/cjs"
   ],
   "engines": {
-    "node": ">=22.22.3"
+    "node": ">=22.23.1"
   },
 
   "dependencies": {
     "check-node-engine": "1.1.0",
-    "check-version-modules": "2.5.0"
+    "check-version-modules": "2.5.0",
+    "semver": "7.8.5"
   },
   "devDependencies": {
     "@types/express": "5.0.6",
-    "@types/node": "25.9.2",
+    "@types/node": "26.0.1",
+    "@types/semver": "7.7.1",
     "@types/socket.io": "3.0.2",
     "@types/ws": "8.18.1",
     "eslint-plugin-personnallinter": "git+ssh://git@github.com/Psychopoulet/eslint-plugin-personnallinter",
     "express": "5.2.1",
     "husky": "9.1.7",
     "mocha": "11.7.6",
-    "node-pluginsmanager-plugin": "7.3.2",
+    "node-pluginsmanager-plugin": "7.4.0",
     "nyc": "18.0.0",
     "proxyquire": "2.1.3",
     "rimraf": "6.1.3",