Implement updated open dialog method of the Module API #11395

dhenneke · 2023-08-10T09:24:13Z

Implements the changes of matrix-org/matrix-react-sdk-module-api#14
Replaces the outdated PR #10536

Companion PR: element-hq/element-web#25986

Checklist

Tests written for new code (and old code if feasible)
Linter and other CI checks pass
Sign-off given on the changes (see CONTRIBUTING.md)

Type: enhancement

Here's what your changelog entry will look like:

✨ Features

Implement updated open dialog method of the Module API (#11395). Contributed by @dhenneke.

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

src/modules/ProxiedModuleApi.ts

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

andybalaam

Looks good to me but I'll leave @richvdh to tick in case he has more context.

richvdh

Looks great otherwise!

richvdh · 2023-08-18T11:27:17Z

src/components/views/dialogs/ModuleUiDialog.tsx

@@ -61,11 +65,23 @@ export class ModuleUiDialog<P extends DialogProps, C extends DialogContent<P>> e
        this.props.onFinished(false);
    }

+    protected setOptions(options: ModuleUiDialogOptions): void {


could this be private?

richvdh · 2023-08-18T11:37:28Z

src/components/views/dialogs/ModuleUiDialog.tsx

-    contentProps: P;
-    title: string;
-    onFinished(ok?: boolean, model?: Awaited<ReturnType<DialogContent<P>["trySubmit"]>>): void;
+    contentProps: Omit<P, keyof DialogProps> | undefined;


wonder if this should be called additionalContentProps to distinguish it from the actual contentProps

richvdh · 2023-08-18T11:37:50Z

src/components/views/dialogs/ModuleUiDialog.tsx

+            cancel: this.cancel.bind(this),
+        };
+
+        // Typescript isn't very happy understanding that `contentProps` satisfies `Omit<P, keyof DialogProps>`


Suggested change

// Typescript isn't very happy understanding that `contentProps` satisfies `Omit<P, keyof DialogProps>`

// Typescript isn't very happy understanding that `contentProps` satisfies `P`

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

richvdh

thank you!

dhenneke · 2023-08-18T12:29:50Z

Does GitHub has issues?

richvdh · 2023-08-18T14:53:10Z

No, it needs a review from someone on @matrix-org/element-web-app-team due to the changes in package.json.

dhenneke · 2023-08-21T09:01:29Z

I resolved the merge conflict.

* Implement updated open dialog method Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net> * Apply the review comments Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net> * Add unit tests for the module system dialog Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net> * Bump @matrix-org/react-sdk-module-api from 1.0.0 to 2.0.0 Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net> * Run prettier Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net> * Apply review comments Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net> --------- Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

@kerryarchibald

Changes in [1.11.40](https://github.com/vector-im/element-web/releases/tag/v1.11.40) (2023-08-29) ================================================================================================= ## ✨ Features * Hide account deactivation for externally managed accounts ([\#11445](matrix-org/matrix-react-sdk#11445)). Fixes #26022. Contributed by @kerryarchibald. * OIDC: Redirect to delegated auth provider when signing out ([\#11432](matrix-org/matrix-react-sdk#11432)). Fixes #26000. Contributed by @kerryarchibald. * Disable 3pid fields in settings when `m.3pid_changes` capability is disabled ([\#11430](matrix-org/matrix-react-sdk#11430)). Fixes #25995. Contributed by @kerryarchibald. * OIDC: disable multi session signout for OIDC-aware servers in session manager ([\#11431](matrix-org/matrix-react-sdk#11431)). Contributed by @kerryarchibald. * Implement updated open dialog method of the Module API ([\#11395](matrix-org/matrix-react-sdk#11395)). Contributed by @dhenneke. * Polish & delabs `Exploring public spaces` feature ([\#11423](matrix-org/matrix-react-sdk#11423)). * Treat lists with a single empty item as plain text, not Markdown. ([\#6833](matrix-org/matrix-react-sdk#6833)). Fixes element-hq/element-meta#1265. * Allow managing room knocks ([\#11404](matrix-org/matrix-react-sdk#11404)). Contributed by @charlynguyen. * Pin the action buttons to the bottom of the scrollable dialogs ([\#11407](matrix-org/matrix-react-sdk#11407)). Contributed by @dhenneke. * Support Matrix 1.1 (drop legacy r0 versions) ([\#9819](matrix-org/matrix-react-sdk#9819)). ## 🐛 Bug Fixes * Fix path separator for Windows based systems ([\#25997](element-hq/element-web#25997)). * Fix instances of double translation and guard translation calls using typescript ([\#11443](matrix-org/matrix-react-sdk#11443)). * Fix export type "Current timeline" to match its behaviour to its name ([\#11426](matrix-org/matrix-react-sdk#11426)). Fixes #25988. * Fix Room Settings > Notifications file upload input being shown superfluously ([\#11415](matrix-org/matrix-react-sdk#11415)). Fixes #18392. * Simplify registration with email validation ([\#11398](matrix-org/matrix-react-sdk#11398)). Fixes #25832 #23601 and #22297. * correct home server URL ([\#11391](matrix-org/matrix-react-sdk#11391)). Fixes #25931. Contributed by @NSV1991. * Include non-matching DMs in Spotlight recent conversations when the DM's userId is part of the search API results ([\#11374](matrix-org/matrix-react-sdk#11374)). Contributed by @mgcm. * Fix useRoomMembers missing updates causing incorrect membership counts ([\#11392](matrix-org/matrix-react-sdk#11392)). Fixes #17096. * Show error when searching public rooms fails ([\#11378](matrix-org/matrix-react-sdk#11378)).

Implement updated open dialog method

823c631

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

github-actions bot added the Z-Community-PR Issue is solved by a community member's PR label Aug 10, 2023

dhenneke mentioned this pull request Aug 10, 2023

Implement updated open dialog method using module API #10536

Closed

3 tasks

github-actions bot added the T-Enhancement New features, changes in functionality, performance boosts, user-facing improvements label Aug 10, 2023

github-actions bot deployed to Netlify August 10, 2023 09:28 View deployment

richvdh mentioned this pull request Aug 14, 2023

Update the open dialog API with more options. matrix-org/matrix-react-sdk-module-api#14

Merged

richvdh reviewed Aug 14, 2023

View reviewed changes

src/modules/ProxiedModuleApi.ts Outdated Show resolved Hide resolved

Apply the review comments

739794e

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

github-actions bot deployed to Netlify August 14, 2023 13:10 View deployment

Add unit tests for the module system dialog

39beba0

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

github-actions bot deployed to Netlify August 14, 2023 15:08 View deployment

dhenneke added 2 commits August 17, 2023 12:22

Merge branch 'develop' into nic/feat/module-api-dialog-improvements

95cb998

Bump @matrix-org/react-sdk-module-api from 1.0.0 to 2.0.0

e4b999a

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

github-actions bot deployed to Netlify August 17, 2023 10:29 View deployment

Run prettier

1a8e65b

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

github-actions bot deployed to Netlify August 17, 2023 10:49 View deployment

dhenneke mentioned this pull request Aug 17, 2023

Bump @matrix-org/react-sdk-module-api from 1.0.0 to 2.0.0 element-hq/element-web#25986

Merged

3 tasks

dhenneke marked this pull request as ready for review August 17, 2023 11:17

dhenneke requested review from a team as code owners August 17, 2023 11:17

dhenneke requested review from andybalaam and richvdh August 17, 2023 11:17

andybalaam reviewed Aug 17, 2023

View reviewed changes

richvdh reviewed Aug 18, 2023

View reviewed changes

Apply review comments

2c7c0ed

Signed-off-by: Dominik Henneke <dominik.henneke@nordeck.net>

dhenneke requested a review from richvdh August 18, 2023 11:54

github-actions bot deployed to Netlify August 18, 2023 12:00 View deployment

richvdh approved these changes Aug 18, 2023

View reviewed changes

richvdh enabled auto-merge August 18, 2023 12:02

richvdh requested a review from a team August 18, 2023 15:57

andybalaam approved these changes Aug 21, 2023

View reviewed changes

richvdh added this pull request to the merge queue Aug 21, 2023

github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Aug 21, 2023

Merge branch 'develop' into nic/feat/module-api-dialog-improvements

289c70c

github-actions bot deployed to Netlify August 21, 2023 09:06 View deployment

richvdh enabled auto-merge August 21, 2023 09:27

dhenneke requested a review from richvdh August 21, 2023 10:17

richvdh added this pull request to the merge queue Aug 21, 2023

Merged via the queue into matrix-org:develop with commit 5c43054 Aug 21, 2023
73 checks passed

dhenneke deleted the nic/feat/module-api-dialog-improvements branch August 21, 2023 12:57

Johennes added A-Timesheet-1 Log any time spent on this into the A-Timesheet-1 project and removed Z-Community-PR Issue is solved by a community member's PR labels Aug 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement updated open dialog method of the Module API #11395

Implement updated open dialog method of the Module API #11395

dhenneke commented Aug 10, 2023 •

edited by github-actions bot

Loading

andybalaam left a comment

richvdh left a comment

richvdh Aug 18, 2023

richvdh Aug 18, 2023

richvdh Aug 18, 2023

richvdh left a comment

dhenneke commented Aug 18, 2023

richvdh commented Aug 18, 2023

dhenneke commented Aug 21, 2023

	// Typescript isn't very happy understanding that `contentProps` satisfies `Omit<P, keyof DialogProps>`
	// Typescript isn't very happy understanding that `contentProps` satisfies `P`

Implement updated open dialog method of the Module API #11395

Implement updated open dialog method of the Module API #11395

Conversation

dhenneke commented Aug 10, 2023 • edited by github-actions bot Loading

Checklist

✨ Features

andybalaam left a comment

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

richvdh Aug 18, 2023

Choose a reason for hiding this comment

richvdh Aug 18, 2023

Choose a reason for hiding this comment

richvdh Aug 18, 2023

Choose a reason for hiding this comment

richvdh left a comment

Choose a reason for hiding this comment

dhenneke commented Aug 18, 2023

richvdh commented Aug 18, 2023

dhenneke commented Aug 21, 2023

dhenneke commented Aug 10, 2023 •

edited by github-actions bot

Loading