@serenityjs/plugins 0.2.3-beta-20240522190240 → 0.2.3-beta-20240522233103

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { Logger } from '@serenityjs/logger';
+import Emitter from '@serenityjs/emitter';
 
 /**
  * Represents a base plugin that can be loaded into the Serenity server.
@@ -29,17 +30,26 @@ declare abstract class BasePlugin<T = unknown> {
     shutdown(): void;
 }
 
+interface PluginPackage {
+    name: string;
+    version: string;
+    main: string;
+    development: boolean;
+    scripts: {
+        build: string;
+    };
+}
 interface Plugin {
     instance: BasePlugin;
-    package: Record<string, unknown>;
+    typescript: boolean;
+    package: PluginPackage;
+    path: string;
     plugin: unknown;
 }
-interface tsconfig {
-    compilerOptions: {
-        outDir: string;
-    };
+interface PluginEvents {
+    register: [Plugin];
 }
-declare class Plugins<T> {
+declare class Plugins<T> extends Emitter<PluginEvents> {
     /**
      * The serenity instance.
      */
@@ -53,18 +63,34 @@ declare class Plugins<T> {
      */
     readonly path: string;
     /**
-     * The plugins map.
+     * A collection registry of all plugins.
      */
-    readonly plugins: Map<string, Plugin>;
+    readonly entries: Map<string, Plugin>;
     /**
      * Constructs a new plugins instance.
      *
      * @param serenity - The serenity instance.
      */
     constructor(serenity: T, path: string, enabled?: boolean);
-    loadNew(): Promise<void>;
-    validatePackage(path: string, pack: Record<string, unknown>): boolean;
-    validateTsconfig(path: string, tsconfig: tsconfig): boolean;
+    /**
+     * Get a plugin from the plugins map.
+     *
+     * @param name - The name of the plugin.
+     * @param version - The version of the plugin.
+     * @returns The plugin instance.
+     */
+    get<T = BasePlugin>(name: string, version?: string): T;
+    /**
+     * Get all the plugins from the plugins map.
+     */
+    getAll(): Array<BasePlugin>;
+    reload(name: string): void;
+    /**
+     * Start loading the plugins.
+     */
+    private start;
+    private validatePackage;
+    private validateTsconfig;
 }
 
 export { BasePlugin, Plugins };

package/dist/index.js

@@ -74,7 +74,8 @@ var import_node_fs = require("fs");
 var import_node_path = require("path");
 var import_node_process = __toESM(require("process"));
 var import_logger = require("@serenityjs/logger");
-var Plugins = class {
+var import_emitter = __toESM(require("@serenityjs/emitter"));
+var Plugins = class extends import_emitter.default {
   /**
    * The serenity instance.
    */
@@ -88,28 +89,100 @@ var Plugins = class {
    */
   path;
   /**
-   * The plugins map.
+   * A collection registry of all plugins.
    */
-  plugins;
+  entries;
   /**
    * Constructs a new plugins instance.
    *
    * @param serenity - The serenity instance.
    */
   constructor(serenity, path, enabled = true) {
+    super();
     this.serenity = serenity;
     this.logger = new import_logger.Logger("Plugins", import_logger.LoggerColors.CyanBright);
     this.path = (0, import_node_path.resolve)(import_node_process.default.cwd(), path);
-    this.plugins = /* @__PURE__ */ new Map();
+    this.entries = /* @__PURE__ */ new Map();
     if (enabled) {
       if (!(0, import_node_fs.existsSync)(this.path)) {
         (0, import_node_fs.mkdirSync)(this.path);
         this.logger.success(`Created plugins folder at "${this.path}"`);
       }
-      void this.loadNew();
+      this.logger.info(`Attempting to load plugins from "${this.path}"`);
+      void this.start();
     }
   }
-  async loadNew() {
+  /**
+   * Get a plugin from the plugins map.
+   *
+   * @param name - The name of the plugin.
+   * @param version - The version of the plugin.
+   * @returns The plugin instance.
+   */
+  get(name, version) {
+    const filtered = [...this.entries.values()].filter((plugin2) => {
+      return plugin2.package.name === name;
+    });
+    const plugin = filtered.find((plugin2) => {
+      return version ? plugin2.package.version === version : filtered[0];
+    });
+    if (!plugin) {
+      throw new Error(
+        `Plugin "${name}" with version "${version}" does not exist.`
+      );
+    }
+    return plugin.instance;
+  }
+  /**
+   * Get all the plugins from the plugins map.
+   */
+  getAll() {
+    const plugins = [...this.entries.values()].map((plugin) => {
+      return plugin.instance;
+    });
+    return plugins;
+  }
+  reload(name) {
+    const plugin = this.entries.get(name);
+    if (!plugin) {
+      throw new Error(`Plugin "${name}" does not exist.`);
+    }
+    plugin.instance.shutdown();
+    if (plugin.typescript) {
+      try {
+        if (plugin.package.scripts.build) {
+          (0, import_node_child_process.execSync)("npm run build", { cwd: plugin.path });
+        } else {
+          (0, import_node_child_process.execSync)("tsc", { cwd: plugin.path });
+        }
+      } catch (reason) {
+        this.logger.error(
+          `Failed to compile plugin "${name}" before reloading.`,
+          reason
+        );
+        return;
+      }
+    }
+    const path = require.resolve(plugin.path);
+    if (path) {
+      delete require.cache[path];
+    }
+    const pluginMain = require(`${(0, import_node_path.resolve)(plugin.path, plugin.package.main)}`);
+    if (!pluginMain.default) {
+      throw new Error(`Plugin "${name}" does not have a default export.`);
+    }
+    const pluginInstance = new pluginMain.default(
+      this.serenity,
+      new import_logger.Logger(`${name}@${plugin.package.version}`, import_logger.LoggerColors.Blue)
+    );
+    plugin.instance = pluginInstance;
+    this.emit("register", plugin);
+    this.logger.success(`Reloaded plugin "${name}".`);
+  }
+  /**
+   * Start loading the plugins.
+   */
+  async start() {
     const files = (0, import_node_fs.readdirSync)(this.path, { withFileTypes: true });
     for (const file of files) {
       if (!file.isDirectory())
@@ -134,7 +207,7 @@ var Plugins = class {
       );
       if (!needModules) {
         try {
-          (0, import_node_child_process.execSync)("npm install", { cwd: (0, import_node_path.resolve)(file.path, file.name) });
+          (0, import_node_child_process.execSync)("npm install", { cwd: import_node_process.default.cwd() });
         } catch (reason) {
           this.logger.error(
             `Failed to install node_modules for plugin "${file.name}".`,
@@ -171,14 +244,22 @@ var Plugins = class {
         }
       }
       try {
-        const plugin = await import(`file://${(0, import_node_path.resolve)(file.path, file.name, pack.main)}`);
+        const plugin = require(`${(0, import_node_path.resolve)(file.path, file.name, pack.main)}`);
         if (!plugin.default)
           continue;
         const instance = new plugin.default(
           this.serenity,
           new import_logger.Logger(`${file.name}@${pack.version}`, import_logger.LoggerColors.Blue)
         );
-        this.plugins.set(file.name, { instance, package: pack, plugin });
+        const pluginEntry = {
+          instance,
+          typescript: Boolean(typescript),
+          package: pack,
+          path: (0, import_node_path.resolve)(file.path, file.name),
+          plugin
+        };
+        this.entries.set(file.name, pluginEntry);
+        this.emit("register", pluginEntry);
       } catch (reason) {
         this.logger.error(`Failed to import plugin "${file.name}".`, reason);
         continue;
@@ -203,9 +284,9 @@ var Plugins = class {
         `Plugin package.json "${path}" does not contain a "type" property.`
       );
       return false;
-    } else if (pack.type !== "module") {
+    } else if (pack.type !== "commonjs") {
       this.logger.error(
-        `Plugin package.json "${path}" type is not set to "module".`
+        `Plugin package.json "${path}" type is not set to "commonjs".`
       );
       return false;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@serenityjs/plugins",
-	"version": "0.2.3-beta-20240522190240",
+	"version": "0.2.3-beta-20240522233103",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",
 	"repository": "https://github.com/SerenityJS/serenity",
@@ -18,9 +18,9 @@
 		"preset": "@serenityjs/jest-presets/jest/node"
 	},
 	"devDependencies": {
-		"@serenityjs/eslint-config": "0.2.3-beta-20240522190240",
-		"@serenityjs/jest-presets": "0.2.3-beta-20240522190240",
-		"@serenityjs/typescript-config": "0.2.3-beta-20240522190240",
+		"@serenityjs/eslint-config": "0.2.3-beta-20240522233103",
+		"@serenityjs/jest-presets": "0.2.3-beta-20240522233103",
+		"@serenityjs/typescript-config": "0.2.3-beta-20240522233103",
 		"@types/jest": "^29.5.12",
 		"@types/node": "^20.11.24",
 		"jest": "^29.7.0",
@@ -28,6 +28,7 @@
 		"typescript": "^5.4.2"
 	},
 	"dependencies": {
-		"@serenityjs/logger": "0.2.3-beta-20240522190240"
+		"@serenityjs/emitter": "0.2.3-beta-20240522233103",
+		"@serenityjs/logger": "0.2.3-beta-20240522233103"
 	}
 }