Initial support for runtime modules (#29104)

* Initial runtime Modules work Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Iterate Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> * Comments Signed-off-by: Michael Telatynski <7t3chguy@gmail.com> --------- Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2025-02-06 23:54:18 +00:00
parent 3c690e685a
commit 4a231c6450
22 changed files with 209 additions and 191 deletions
--- a/src/modules/Api.ts
+++ b/src/modules/Api.ts
@@ -0,0 +1,75 @@
+/*
+Copyright 2025 New Vector Ltd.
+
+SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only OR LicenseRef-Element-Commercial
+Please see LICENSE files in the repository root for full details.
+*/
+
+import type { Api, RuntimeModuleConstructor, Config } from "@element-hq/element-web-module-api";
+import { ModuleRunner } from "./ModuleRunner.ts";
+import AliasCustomisations from "../customisations/Alias.ts";
+import { RoomListCustomisations } from "../customisations/RoomList.ts";
+import ChatExportCustomisations from "../customisations/ChatExport.ts";
+import { ComponentVisibilityCustomisations } from "../customisations/ComponentVisibility.ts";
+import DirectoryCustomisations from "../customisations/Directory.ts";
+import LifecycleCustomisations from "../customisations/Lifecycle.ts";
+import * as MediaCustomisations from "../customisations/Media.ts";
+import UserIdentifierCustomisations from "../customisations/UserIdentifier.ts";
+import { WidgetPermissionCustomisations } from "../customisations/WidgetPermissions.ts";
+import { WidgetVariableCustomisations } from "../customisations/WidgetVariables.ts";
+import SdkConfig from "../SdkConfig.ts";
+
+const legacyCustomisationsFactory = <T extends object>(baseCustomisations: T) => {
+    let used = false;
+    return (customisations: T) => {
+        if (used) throw new Error("Legacy customisations can only be registered by one module");
+        Object.assign(baseCustomisations, customisations);
+        used = true;
+    };
+};
+
+class ConfigApi {
+    public get(): Config;
+    public get<K extends keyof Config>(key: K): Config[K];
+    public get<K extends keyof Config = never>(key?: K): Config | Config[K] {
+        if (key === undefined) {
+            return SdkConfig.get() as Config;
+        }
+        return SdkConfig.get(key);
+    }
+}
+
+/**
+ * Implementation of the @element-hq/element-web-module-api runtime module API.
+ */
+class ModuleApi implements Api {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    public async _registerLegacyModule(LegacyModule: RuntimeModuleConstructor): Promise<void> {
+        ModuleRunner.instance.registerModule((api) => new LegacyModule(api));
+    }
+    public readonly _registerLegacyAliasCustomisations = legacyCustomisationsFactory(AliasCustomisations);
+    public readonly _registerLegacyChatExportCustomisations = legacyCustomisationsFactory(ChatExportCustomisations);
+    public readonly _registerLegacyComponentVisibilityCustomisations = legacyCustomisationsFactory(
+        ComponentVisibilityCustomisations,
+    );
+    public readonly _registerLegacyDirectoryCustomisations = legacyCustomisationsFactory(DirectoryCustomisations);
+    public readonly _registerLegacyLifecycleCustomisations = legacyCustomisationsFactory(LifecycleCustomisations);
+    public readonly _registerLegacyMediaCustomisations = legacyCustomisationsFactory(MediaCustomisations);
+    public readonly _registerLegacyRoomListCustomisations = legacyCustomisationsFactory(RoomListCustomisations);
+    public readonly _registerLegacyUserIdentifierCustomisations =
+        legacyCustomisationsFactory(UserIdentifierCustomisations);
+    public readonly _registerLegacyWidgetPermissionsCustomisations =
+        legacyCustomisationsFactory(WidgetPermissionCustomisations);
+    public readonly _registerLegacyWidgetVariablesCustomisations =
+        legacyCustomisationsFactory(WidgetVariableCustomisations);
+    /* eslint-enable @typescript-eslint/naming-convention */
+
+    public readonly config = new ConfigApi();
+}
+
+export type ModuleApiType = ModuleApi;
+
+if (!window.mxModuleApi) {
+    window.mxModuleApi = new ModuleApi();
+}
+export default window.mxModuleApi;