node-pluginsmanager 2.3.7 → 2.4.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021, Sébastien Vidal
+Copyright (c) 2022, Sébastien Vidal
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/README.md

@@ -35,211 +35,35 @@ $ npm install node-pluginsmanager
 
 ![Routes](./documentation/routes.jpg)
 
-## Interfaces
+## Content
 
-```typescript
-interface iPluginManagerOptions {
-  "directory": string; // plugins location. default : join(homedir(), "node-pluginsmanager-plugins")
-  "externalRessourcesDirectory": string; // external resources locations (sqlite, files, cache, etc...). default : join(homedir(), "node-pluginsmanager-resources")
-}
-```
-
-## Classes
-
-### PluginManagerOptions (extends "Object")
-
-  > can set optionnal options for "events" constructor
-
-  -- Attributes --
-
-  * ``` directory: string ``` used to set PluginsManager directory value
-
-### PluginsManager (extends "events")
-
-  -- Attributes --
-
-  * ``` directory: string ``` plugins' directory path (must be writable, you can use [homedir](https://nodejs.org/api/os.html#os_os_homedir) for create specific directory)
-  * ``` externalRessourcesDirectory: string ``` external resources locations (sqlite, files, cache, etc...) (must be writable, you can use [homedir](https://nodejs.org/api/os.html#os_os_homedir) for create specific directory)
-  * ``` Array plugins: Array<[Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser)> ``` plugins' orchestrators
-
-  -- Constructor --
-
-  * ``` constructor(options? : iPluginManagerOptions) ```
-
-  -- Methods --
-
-  > Please note that the "httpMiddleware" method was removed, you juste have to use "appMiddleware" with basic http request, and use "next" parameter as a callback to execute some stuff with the request if it is not managed by the plugins
+[check the TypeScript definition file](https://github.com/Psychopoulet/node-pluginsmanager/blob/master/lib/index.d.ts)
 
-  * ``` getPluginsNames(): Array<string> ``` return plugins' names
-  * ``` setOrder(pluginsNames: Array<string>): Promise<void> ``` create a forced order to synchronously initialize plugins. not ordered plugins are asynchronously initialized after.
-
-  * ``` checkAllModules(): Promise<void> ``` check all modules' versions for all plugins
-  * ``` checkModules(plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser)): Promise<void> ``` check all modules' versions for a specific plugin
-
-  * ``` appMiddleware(req: Request, res: Response, next: Function): void ``` used for execute all plugins' middlewares in app (express or other)
-  * ``` socketMiddleware(server: WebSocketServer): void ``` middleware for socket to add bilateral push events
-
-  * ``` beforeInitAll(callback: () => Promise<any>): Promise<void> ``` add a function executed before initializing all plugins
-  * ``` initAll(data?: any): Promise<void> ``` initialize all plugins asynchronously, using "data" in arguments for "init" plugin's Orchestrator method
-
-  * ``` releaseAll(data?: any): Promise<void> ``` release a plugin (keep package but destroy [Mediator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#mediator-extends-bootable) & [Server](https://github.com/Psychopoulet/node-pluginsmanager-plugin#server-extends-mediatoruser)), using "data" in arguments for "release" plugin's [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser) method
-  * ``` destroyAll(data?: any): Promise<void> ``` after releasing, destroy packages data & free "plugins" list, using "data" in arguments for "destroy" plugin's [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser) method
-
-  * ``` installViaGithub(user: string, repo: string, data?: any): Promise<void> ``` install a plugin via github repo, using "data" in arguments for "install" and "init" plugin's [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser) methods
-  * ``` updateViaGithub(plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any): Promise<void> ``` update a plugin via its github repo, using "data" in arguments for "release", "update" and "init" plugin's methods
-  * ``` uninstall(plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any): Promise<string> ``` uninstall a plugin, using "data" in arguments for "release" and "uninstall" plugin's methods
-
-  -- Events --
+## Events
 
   * ``` on("error", (err: Error) => void) : this ``` fires if an error occurs
 
-  * ``` on("loading", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin starts load
-  * ``` on("loaded", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin ends load
+  * ``` on("loading", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin starts load
+  * ``` on("loaded", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin ends load
   * ``` on("allloaded", (data?: any) => void) : this ``` fires if all the plugins are loaded
 
-  * ``` on("initializing", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin starts init
-  * ``` on("initialized", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin ends init
+  * ``` on("initializing", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin starts init
+  * ``` on("initialized", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin ends init
   * ``` on("allinitialized", (data?: any) => void) : this ``` fires if all the plugins are initialized
 
-  * ``` on("released", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin is released
+  * ``` on("released", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin is released
   * ``` on("allreleased", (data?: any) => void) : this ``` fires if all the plugins are released
 
   * ``` on("destroyed", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is destroyed
   * ``` on("alldestroyed", (data?: any) => void) : this ``` fires if all the plugins are destroyed
 
   * ``` on("installed", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is installed
-  * ``` on("updated", (plugin: [Orchestrator](https://github.com/Psychopoulet/node-pluginsmanager-plugin#orchestrator-extends-mediatoruser), data?: any) => void) : this ``` fires if a plugin is updated
+  * ``` on("updated", (plugin: Orchestrator, data?: any) => void) : this ``` fires if a plugin is updated
   * ``` on("uninstalled", (pluginName: string, data?: any) => void) : this ``` fires if a plugin is uninstalled
 
 ## Examples
 
-### Use PluginsManager
-
-```javascript
-"use strict";
-
-const { join } = require("path");
-const { homedir } = require("os");
-const PluginManager = require("node-pluginsmanager");
-
-const manager = new PluginManager({
-  "directory": join(homedir(), "MySoftware", "plugins")
-});
-
-manager
-
-  .on("error", (msg) => {
-      console.log("--- [event/error] '" + msg.error + "' ---");
-  })
-
-  // load
-
-    .on("loading", (pluginName) => {
-      console.log("--- [event/loading] '" + pluginName + "' loading ---");
-    }).on("loaded", (plugin) => {
-      console.log("--- [event/loaded] '" + plugin.name + "' (v" + plugin.version + ") loaded ---");
-    })
-    .on("allloaded", () => {
-      console.log("--- [event/allloaded] all plugins allloaded ---");
-    })
-
-  // init
-
-    .on("initializing", (plugin) => {
-      console.log("--- [event/initializing] '" + plugin.name + "' (v" + plugin.version + ") initialized ---");
-    }).on("initialized", (plugin) => {
-      console.log("--- [event/initialized] '" + plugin.name + "' (v" + plugin.version + ") initialized ---");
-    })
-    .on("allinitialized", () => {
-      console.log("--- [event/initialized] all plugins initialized ---");
-    })
-
-  // release
-
-    .on("released", (pluginName) => {
-      console.log("--- [event/released] '" + pluginName + " released ---");
-    })
-    .on("allreleased", () => {
-      console.log("--- [event/released] all plugins released ---");
-    })
-
-  // destroy
-
-    .on("destroyed", (pluginName) => {
-      console.log("--- [event/destroyed] '" + pluginName + " destroyed ---");
-    })
-    .on("alldestroyed", () => {
-      console.log("--- [event/destroyed] all plugins destroyed ---");
-    })
-
-  // write
-
-    .on("installed", (plugin) => {
-      console.log("--- [event/installed] '" + plugin.name + "' (v" + plugin.version + ") installed ---");
-    })
-    .on("updated", (plugin) => {
-      console.log("--- [event/updated] '" + plugin.name + "' (v" + plugin.version + ") updated ---");
-    })
-    .on("uninstalled", (pluginName) => {
-      console.log("--- [event/uninstalled] '" + pluginName + "' uninstalled ---");
-    })
-
-.beforeInitAll(() => { // optionnal
-    return Promise.resolve();
-})
-
-.initAll(<optional data to pass to the 'init' plugins methods>).then(() => {
-
-  console.log('all plugins initialized');
-  console.log(manager.getPluginsNames());
-
-  manager.installViaGithub(
-    <account>,
-    <plugin>,
-    <optional data to pass to the 'install' && 'init' plugins methods>
-  ).then((plugin) => {
-    console.log(plugin.name + ' installed & initialized');
-  }).catch((err) => {
-    console.log(err);
-  });
-
-  manager.updateViaGithub( // use "github"'s plugin data if exists
-    <plugin>,
-    <optional data to pass to the 'release', 'update', && 'init' plugins methods>
-  ).then((plugin) => {
-    console.log(plugin.name + ' updated & initialized');
-  }).catch((err) => {
-    console.log(err);
-  });
-
-  manager.uninstall(
-    <plugin>,
-    <optional data to pass to the 'release' && 'uninstall' plugins methods>
-  ).then((pluginName) => {
-    console.log(pluginName + ' removed');
-  }).catch((err) => {
-    console.log(err);
-  });
-
-}).catch((err) => {
-  console.log(err);
-});
-```
-
-### Typescript
-
-```typescript
-"use strict";
-
-import join from "path";
-import homedir from "os";
-import PluginManager = require('node-pluginsmanager');
-
-const manager = new PluginManager({
-  "directory": join(homedir(), "MySoftware", "plugins")
-});
-// then, use it like before
-```
+[check the TypeScript compilation tests](https://github.com/Psychopoulet/node-pluginsmanager/blob/master/test/typescript/compilation.ts)
 
 ## Tests
 

package/lib/cjs/PluginsManager.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+import EventEmitter from "events";
+import { Orchestrator, tLogger, iIncomingMessage, iServerResponse } from "node-pluginsmanager-plugin";
+import { Server as WebSocketServer } from "ws";
+import { Server as SocketIOServer } from "socket.io";
+interface iPluginManagerOptions {
+    "directory"?: string;
+    "externalRessourcesDirectory"?: string;
+    "logger"?: tLogger | null;
+}
+declare type tBeforeAllMethodCallback = (...data: any) => Promise<void> | void;
+export default class PluginsManager extends EventEmitter {
+    protected _beforeLoadAll: tBeforeAllMethodCallback | null;
+    protected _beforeInitAll: tBeforeAllMethodCallback | null;
+    protected _logger: tLogger | null;
+    protected _orderedPluginsNames: Array<string>;
+    directory: string;
+    externalRessourcesDirectory: string;
+    plugins: Array<Orchestrator>;
+    constructor(options: iPluginManagerOptions);
+    getPluginsNames(): Array<string>;
+    setOrder(pluginsNames: Array<string>): Promise<void>;
+    getOrder(): Array<string>;
+    checkAllModules(): Promise<void>;
+    checkModules(plugin: Orchestrator): Promise<void>;
+    appMiddleware(req: iIncomingMessage, res: iServerResponse, next: Function): void;
+    socketMiddleware(server: WebSocketServer | SocketIOServer): void;
+    beforeLoadAll(callback: tBeforeAllMethodCallback): Promise<void>;
+    loadAll(...data: any): Promise<void>;
+    destroyAll(...data: any): Promise<void>;
+    beforeInitAll(callback: tBeforeAllMethodCallback): Promise<void>;
+    initAll(...data: any): Promise<void>;
+    releaseAll(...data: any): Promise<void>;
+    installViaGithub(user: string, repo: string, ...data: any): Promise<Orchestrator>;
+    updateViaGithub(plugin: Orchestrator, ...data: any): Promise<Orchestrator>;
+    uninstall(plugin: Orchestrator, ...data: any): Promise<string>;
+}
+export {};