Tidy up

2026-03-13 16:19:27 +00:00
parent 610a9494d1
commit c058c187c4
6 changed files with 22 additions and 19 deletions
@@ -61,14 +61,3 @@ This is useful when widgets have multiple routes or capabilities include variabl
    }
 }
 ```
-
-## Copyright & License
-
-Copyright (c) 2025 New Vector Ltd
-
-This software is multi licensed by New Vector Ltd (Element). It can be used either:
-
-(1) for free under the terms of the GNU Affero General Public License (as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version); OR
-
-(2) under the terms of a paid-for Element Commercial License agreement between you and Element (the terms of which may vary depending on what you and Element have agreed to).
-Unless required by applicable law or agreed to in writing, software distributed under the Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses.
@@ -1,4 +1,13 @@
-<!-- Based on element-modules/modules/opendesk/element-web/tests/fixture/widget.html -->
+<!--
+    Minimal fixture widget used by e2e tests to exercise the Matrix Widget API lifecycle:
+      1. Element requests capabilities  → widget declares what it needs
+      2. Element notifies approval      → widget requests an OpenID token
+      3. Element grants the token       → widget resolves the user's Matrix ID and displays it
+
+    The `caps` query parameter controls which capabilities the widget requests (comma-separated).
+    Pass `caps=none` to request none. Defaults to m.room.topic if omitted.
+    The `hsUrl` query parameter is required for the OpenID userinfo lookup in step 3.
+-->
 <!doctype html>
 <html lang="en">
    <head>
@@ -19,6 +28,7 @@
            let sendEventCount = 0;
            window.onmessage = async (ev) => {
                if (ev.data.action === "capabilities") {
+                    // Step 1: Element is asking what capabilities this widget needs.
                    window.parent.postMessage(
                        Object.assign(
                            {
@@ -31,6 +41,8 @@
                        "*",
                    );
                } else if (ev.data.action === "notify_capabilities") {
+                    // Step 2: Capabilities have been approved. Request an OpenID token
+                    // so we can identify the current user in step 3.
                    window.parent.postMessage(
                        {
                            api: "fromWidget",
@@ -42,6 +54,8 @@
                        "*",
                    );
                } else if (ev.data.action === "get_openid" && ev.data.response?.state === "allowed") {
+                    // Step 3: Token granted — exchange it for the user's Matrix ID and display it.
+                    // Tests assert on this heading to verify identity was passed through correctly.
                    const { access_token } = ev.data.response;

                    const hsUrl = new URLSearchParams(window.location.search).get("hsUrl");
@@ -30,7 +30,7 @@ export default class WidgetLifecycleModule implements Module {
    public constructor(private api: ModuleApi) {}

    public async load(): Promise<void> {
-        if (!this.api.widgetLifecycle?.registerPreloadApprover) {
+        if (!this.api.widgetLifecycle) {
            throw new Error(
                "Widget lifecycle API is not available. Update Element Web to a build that provides widget lifecycle module support.",
            );
@@ -32,16 +32,16 @@ const ModuleConfigSchema = z.partial(
 /** Map from URL patterns to their widget approval configuration. */
 export type WidgetLifecycleModuleConfig = Record<string, WidgetConfiguration>;

-/**
- * Parse and validate the widget lifecycle module configuration.
- * Returns an empty config if the input is falsy; throws on schema violations.
- */
 declare module "@element-hq/element-web-module-api" {
    export interface Config {
        [CONFIG_KEY]: z.input<typeof ModuleConfigSchema>;
    }
 }

+/**
+ * Parse and validate the widget lifecycle module configuration.
+ * Returns an empty config if the input is falsy; throws on schema violations.
+ */
 export const parseWidgetLifecycleConfig = (value: unknown): WidgetLifecycleModuleConfig => {
    if (!value) return {};

@@ -1,5 +1,5 @@
 /*
-Copyright 2025 New Vector Ltd.
+Copyright 2026 Element Creations Ltd.

 SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
 Please see LICENSE files in the repository root for full details.
@@ -1,5 +1,5 @@
 /*
-Copyright 2025 New Vector Ltd.
+Copyright 2026 Element Creations Ltd.

 SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial
 Please see LICENSE files in the repository root for full details.