mv element-web-module-api module-api

2026-04-13 09:18:23 +01:00
parent ec8b7bf109
commit ad2e6d37bc
34 changed files with 546 additions and 546 deletions
@@ -0,0 +1,55 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+
+import { satisfies } from "semver";
+
+import { type Api, isModule, type Module, type ModuleExport } from "./api";
+
+/**
+ * Error thrown when a module is incompatible with the engine version.
+ * @public
+ */
+export class ModuleIncompatibleError extends Error {
+    public constructor(pluginVersion: string) {
+        super(`Plugin version ${pluginVersion} is incompatible with engine version ${__VERSION__}`);
+    }
+}
+
+/**
+ * A module loader for loading and starting modules.
+ * @public
+ */
+export class ModuleLoader {
+    private modules: Module[] = [];
+    private started = false;
+
+    public constructor(private api: Api) {}
+
+    public async load(moduleExport: ModuleExport): Promise<void> {
+        if (this.started) {
+            throw new Error("PluginEngine.start() has already been called");
+        }
+
+        if (!isModule(moduleExport)) {
+            throw new Error("Invalid plugin");
+        }
+        if (!satisfies(__VERSION__, moduleExport.default.moduleApiVersion)) {
+            throw new ModuleIncompatibleError(moduleExport.default.moduleApiVersion);
+        }
+        const { default: Module } = moduleExport;
+        this.modules.push(new Module(this.api));
+    }
+
+    public async start(): Promise<void> {
+        if (this.started) {
+            throw new Error("PluginEngine.start() has already been called");
+        }
+        this.started = true;
+
+        await Promise.all(this.modules.map((plugin) => plugin.load()));
+    }
+}