node-pluginsmanager

A plugins manager

please note that this version is only usable with node-pluginsmanager-plugin 3.x.x && 4.x.x

Installation

$ npm install node-pluginsmanager

Features

• simply manage plugins (extended from node-pluginsmanager-plugin) to interact with specifics hardwares / API / whatever
• install plugins manually or via github & initialize them
• load external plugins from absolute directories (outside the plugins directory)
• update plugins via github
• uninstall plugins and release there resources
• run plugins' middlewares for server, to create specifics rules
• check plugins' modules' versions

Architecture

Plugin

Routes

Content

check the TypeScript definition file

Events

• on("error", (err: Error) => void) : this fires if an error occurs

• on("loading", (pluginName: string, ...unknown[]) => void) : this fires if a plugin starts load

• on("loaded", (plugin: Orchestrator, ...unknown[]) => void) : this fires if a plugin ends load

• on("allloaded", (...unknown[]) => void) : this fires if all the plugins are loaded

• on("initializing", (plugin: Orchestrator, ...unknown[]) => void) : this fires if a plugin starts init

• on("initialized", (plugin: Orchestrator, ...unknown[]) => void) : this fires if a plugin ends init

• on("allinitialized", (...unknown[]) => void) : this fires if all the plugins are initialized

• on("released", (plugin: Orchestrator, ...unknown[]) => void) : this fires if a plugin is released

• on("allreleased", (...unknown[]) => void) : this fires if all the plugins are released

• on("destroyed", (pluginName: string, ...unknown[]) => void) : this fires if a plugin is destroyed

• on("alldestroyed", (...unknown[]) => void) : this fires if all the plugins are destroyed

• on("installing", (pluginName: string, currentStep: number, maxSteps: number, stepDescription: string, ...unknown[]) => void) : this fires with plugin installation progress

• on("installed", (plugin: Orchestrator, ...unknown[]) => void) : this fires if a plugin is installed

• on("updating", (pluginName: string, currentStep: number, maxSteps: number, stepDescription: string, ...unknown[]) => void) : this fires with plugin update progress

• on("updated", (plugin: Orchestrator, ...unknown[]) => void) : this fires if a plugin is updated

• on("uninstalled", (pluginName: string, ...unknown[]) => void) : this fires if a plugin is uninstalled

External plugins

External plugins are loaded from absolute directories registered before loadAll(). They are added to plugins and initialized like local plugins, but cannot be updated or uninstalled by the manager.

import { join } from "node:path";
import PluginsManager from "node-pluginsmanager";

const manager = new PluginsManager({
  "directory": "/path/to/local/plugins",
  "externalResourcesDirectory": "/path/to/resources"
});

await manager.addExternalPluginDirectory("/path/to/external/my-plugin");
await manager.setOrder([ "my-plugin", "other-plugin" ]); // optional
await manager.loadAll();
await manager.initAll();

Rules:

• each path must be an absolute directory pointing to a plugin root
• registration must happen before loadAll()
• a plugin name cannot exist both locally and externally
• external plugins cannot be updated (updateViaGithub) or uninstalled (uninstall)
• releaseAll() and destroyAll() still apply to external plugins

Examples

check the TypeScript compilation tests

Tests

$ git clone git://github.com/Psychopoulet/node-pluginsmanager.git
$ cd ./node-pluginsmanager
$ npm install
$ npm run-script tests

License

ISC