Support a module API surface for custom functionality (#8246)

* Early implementation of module API surface + functions for ILAG module

* Wire up dialog functions and ILAG-needed surface

* Ensure component renders for modules get overridden

* Respond to changes from module API interface

* Use a real module-api dependency

* Update for new Dialogs interface

* Add support for getConfigValue from module API

* Update the remainder of the module API interface

* Docs & cleanup

* Add some unit tests around module stuff

Needs end-to-end tests still.

* Appease early linters

* Break import cycles by not directly depending on Lifecycle

* Appease the linter

* Fix bad merge

src/components/views/dialogs/ModuleUiDialog.tsx

@@ -0,0 +1,66 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import React, { createRef } from "react";
+import { DialogContent, DialogProps } from "@matrix-org/react-sdk-module-api/lib/components/DialogContent";
+import { logger } from "matrix-js-sdk/src/logger";
+
+import ScrollableBaseModal, { IScrollableBaseState } from "./ScrollableBaseModal";
+import { IDialogProps } from "./IDialogProps";
+import { _t } from "../../../languageHandler";
+
+interface IProps extends IDialogProps {
+    contentFactory: (props: DialogProps, ref: React.Ref<DialogContent>) => React.ReactNode;
+    contentProps: DialogProps;
+    title: string;
+}
+
+interface IState extends IScrollableBaseState {
+    // nothing special
+}
+
+export class ModuleUiDialog extends ScrollableBaseModal<IProps, IState> {
+    private contentRef = createRef<DialogContent>();
+
+    public constructor(props: IProps) {
+        super(props);
+
+        this.state = {
+            title: this.props.title,
+            canSubmit: true,
+            actionLabel: _t("OK"),
+        };
+    }
+
+    protected async submit() {
+        try {
+            const model = await this.contentRef.current.trySubmit();
+            this.props.onFinished(true, model);
+        } catch (e) {
+            logger.error("Error during submission of module dialog:", e);
+        }
+    }
+
+    protected cancel(): void {
+        this.props.onFinished(false);
+    }
+
+    protected renderContent(): React.ReactNode {
+        return <div className="mx_ModuleUiDialog">
+            { this.props.contentFactory(this.props.contentProps, this.contentRef) }
+        </div>;
+    }
+}

src/components/views/rooms/RoomPreviewBar.tsx

@@ -21,6 +21,10 @@ import { EventType, RoomType } from "matrix-js-sdk/src/@types/event";
 import { IJoinRuleEventContent, JoinRule } from "matrix-js-sdk/src/@types/partials";
 import { RoomMember } from "matrix-js-sdk/src/models/room-member";
 import classNames from 'classnames';
+import {
+    RoomPreviewOpts,
+    RoomViewLifecycle,
+} from "@matrix-org/react-sdk-module-api/lib/lifecycles/RoomViewLifecycle";
 
 import { MatrixClientPeg } from '../../../MatrixClientPeg';
 import dis from '../../../dispatcher/dispatcher';
@@ -34,6 +38,7 @@ import AccessibleButton from "../elements/AccessibleButton";
 import RoomAvatar from "../avatars/RoomAvatar";
 import SettingsStore from "../../../settings/SettingsStore";
 import { UIFeature } from "../../../settings/UIFeature";
+import { ModuleRunner } from "../../../modules/ModuleRunner";
 
 const MemberEventHtmlReasonField = "io.element.html_reason";
 
@@ -313,13 +318,26 @@ export default class RoomPreviewBar extends React.Component<IProps, IState> {
                 break;
             }
             case MessageCase.NotLoggedIn: {
-                title = _t("Join the conversation with an account");
-                if (SettingsStore.getValue(UIFeature.Registration)) {
-                    primaryActionLabel = _t("Sign Up");
-                    primaryActionHandler = this.onRegisterClick;
+                const opts: RoomPreviewOpts = { canJoin: false };
+                if (this.props.room?.roomId) {
+                    ModuleRunner.instance
+                        .invoke(RoomViewLifecycle.PreviewRoomNotLoggedIn, opts, this.props.room.roomId);
+                }
+                if (opts.canJoin) {
+                    title = _t("Join the room to participate");
+                    primaryActionLabel = _t("Join");
+                    primaryActionHandler = () => {
+                        ModuleRunner.instance.invoke(RoomViewLifecycle.JoinFromRoomPreview, this.props.room.roomId);
+                    };
+                } else {
+                    title = _t("Join the conversation with an account");
+                    if (SettingsStore.getValue(UIFeature.Registration)) {
+                        primaryActionLabel = _t("Sign Up");
+                        primaryActionHandler = this.onRegisterClick;
+                    }
+                    secondaryActionLabel = _t("Sign In");
+                    secondaryActionHandler = this.onLoginClick;
                 }
-                secondaryActionLabel = _t("Sign In");
-                secondaryActionHandler = this.onLoginClick;
                 if (this.props.previewLoading) {
                     footer = (
                         <div>