✨ feat: enhance PluginManager interface with additional loading methods

Author: xiangechen

packages/chili-core/src/plugin/manager.ts

@@ -1,10 +1,27 @@
 // Part of the Chili3d Project, under the AGPL-3.0 License.
 // See LICENSE file in the project root for full license information.
 
-import type { Plugin } from "../plugin";
+import type { Plugin } from "./plugin";
 
 export interface IPluginManager {
+    /**
+     * Load plugins from a file, the plugin file must be a zip file
+     * @param pluginFile the plugin file, must be a zip file.
+     * It must have a manifest.json file inside,
+     * manifest.json must be a valid plugin manifest see PluginManifest for more details
+     */
     loadFromFile(pluginFile: File): Promise<void>;
+    /**
+     * Load plugins from a url, the plugin file must be a zip file
+     * @param pluginUrl the plugin url
+     */
+    loadFromUrl(pluginUrl: string): Promise<void>;
+    /**
+     * Load plugins from a folder, the index file is optional, if not specified, the default plugins.json will be used
+     * @param folderUrl the folder url
+     * @param indexName the index file name, default is plugins.json
+     */
+    loadFromFolder(folderUrl: string, indexName?: string): Promise<void>;
     unload(pluginName: string): Promise<void>;
     unloadAll(): void;
     getPlugins(): Plugin[];

packages/chili/src/application.ts

@@ -79,6 +79,11 @@ export class Application implements IApplication {
         this.services.forEach((x) => x.start());
 
         this.initWindowEvents();
+        this.loadPluginsFromPublic();
+    }
+
+    private async loadPluginsFromPublic() {
+        await this.pluginManager.loadFromFolder("./plugins/");
     }
 
     private initWindowEvents() {

packages/chili/src/pluginManager.ts

@@ -35,6 +35,37 @@ export class PluginManager implements IPluginManager {
         }
     }
 
+    async loadFromUrl(url: string) {
+        const response = await fetch(url);
+        if (!response.ok) {
+            alert(`Failed to fetch plugin from ${url}: ${response.statusText}`);
+            return;
+        }
+
+        const arrayBuffer = await response.arrayBuffer();
+        const blob = new Blob([arrayBuffer], { type: "application/zip" });
+        const file = new File([blob], "plugin.chiliplugin");
+
+        await this.loadFromFile(file);
+    }
+
+    async loadFromFolder(folderUrl: string, indexName: string = "plugins.json") {
+        try {
+            const response = await fetch(folderUrl + indexName);
+            if (!response.ok) {
+                return;
+            }
+            const config = await response.json();
+            const plugins = config.plugins as string[];
+            const baseUrl = folderUrl.endsWith("/") ? folderUrl : folderUrl + "/";
+            for (const plugin of plugins ?? []) {
+                await this.loadFromUrl(baseUrl + plugin);
+            }
+        } catch {
+            Logger.warn(`Failed to load plugins from folder: ${folderUrl}`);
+        }
+    }
+
     private async readManifest(zip: JSZip) {
         const manifestFile = zip.file("manifest.json");
         if (!manifestFile) {

public/plugins/helloworld-ts.chiliplugin

@@ -0,0 +1,5 @@
+{
+    "plugins": [
+        "helloworld-ts.chiliplugin"
+    ]
+}