Implement MSC3973: Search users in the user directory with the Widget API

src/stores/widgets/StopGapWidgetDriver.ts

@@ -31,6 +31,7 @@ import {
     WidgetDriver,
     WidgetEventCapability,
     WidgetKind,
+    ISearchUserDirectoryResult,
 } from "matrix-widget-api";
 import { ClientEvent, ITurnServer as IClientTurnServer } from "matrix-js-sdk/src/client";
 import { EventType } from "matrix-js-sdk/src/@types/event";
@@ -485,4 +486,19 @@ export class StopGapWidgetDriver extends WidgetDriver {
             prevBatch: prevBatch ?? undefined,
         };
     }
+
+    public async searchUserDirectory(searchTerm: string, limit?: number): Promise<ISearchUserDirectoryResult> {
+        const client = MatrixClientPeg.get();
+
+        const { limited, results } = await client.searchUserDirectory({ term: searchTerm, limit });
+
+        return {
+            limited,
+            results: results.map((r) => ({
+                userId: r.user_id,
+                displayName: r.display_name,
+                avatarUrl: r.avatar_url,
+            })),
+        };
+    }
 }

test/stores/widgets/StopGapWidgetDriver-test.ts

@@ -366,4 +366,40 @@ describe("StopGapWidgetDriver", () => {
             expect(dis.dispatch).not.toHaveBeenCalled();
         });
     });
+
+    describe("searchUserDirectory", () => {
+        let driver: WidgetDriver;
+
+        beforeEach(() => {
+            driver = mkDefaultDriver();
+        });
+
+        it("searches for users in the user directory", async () => {
+            client.searchUserDirectory.mockResolvedValue({
+                limited: false,
+                results: [],
+            });
+
+            await expect(driver.searchUserDirectory("foo")).resolves.toEqual({
+                limited: false,
+                results: [],
+            });
+
+            expect(client.searchUserDirectory).toBeCalledWith({ term: "foo", limit: undefined });
+        });
+
+        it("searches for users with a custom limit", async () => {
+            client.searchUserDirectory.mockResolvedValue({
+                limited: true,
+                results: [],
+            });
+
+            await expect(driver.searchUserDirectory("foo", 25)).resolves.toEqual({
+                limited: true,
+                results: [],
+            });
+
+            expect(client.searchUserDirectory).toBeCalledWith({ term: "foo", limit: 25 });
+        });
+    });
 });

test/test-utils/test-utils.ts

@@ -231,6 +231,8 @@ export function createTestClient(): MatrixClient {
                 room_id: roomId,
             });
         }),
+
+        searchUserDirectory: jest.fn().mockResolvedValue({ limited: false, results: [] }),
     } as unknown as MatrixClient;
 
     client.reEmitter = new ReEmitter(client);