Support future sending via Widget API (MSC4157)

Depends on matrix-org/matrix-widget-api#90

Author: AndrewFerr

src/embedded.ts

@@ -26,8 +26,14 @@ import {
 } from "matrix-widget-api";
 
 import { MatrixEvent, IEvent, IContent, EventStatus } from "./models/event";
-import { ISendEventResponse, SendFutureRequestOpts, SendFutureResponse } from "./@types/requests";
-import { EventType } from "./@types/event";
+import {
+    ISendEventResponse,
+    SendActionFutureResponse,
+    SendFutureRequestOpts,
+    SendFutureResponse,
+    SendTimeoutFutureResponse,
+} from "./@types/requests";
+import { EventType, StateEvents } from "./@types/event";
 import { logger } from "./logger";
 import {
     MatrixClient,
@@ -254,14 +260,37 @@ export class RoomWidgetClient extends MatrixClient {
         event: MatrixEvent,
         futureOpts: F,
     ): Promise<SendFutureResponse<F>>;
-    protected async encryptAndSendEvent<F extends SendFutureRequestOpts>(
+    protected async encryptAndSendEvent(
         room: Room,
         event: MatrixEvent,
-        futureOpts?: F,
-    ): Promise<ISendEventResponse | SendFutureResponse<F>> {
+        futureOpts?: SendFutureRequestOpts,
+    ): Promise<ISendEventResponse | SendTimeoutFutureResponse | SendActionFutureResponse> {
         if (futureOpts) {
-            throw new Error("Future sending via widgets is not implemented");
+            // TODO: updatePendingEvent for futures?
+            const response = await this.widgetApi.sendRoomEvent(
+                event.getType(),
+                event.getContent(),
+                room.roomId,
+                "future_timeout" in futureOpts ? futureOpts.future_timeout : undefined,
+                "future_group_id" in futureOpts ? futureOpts.future_group_id : undefined,
+            );
+            if (!response.future_group_id) {
+                throw new Error("'future_group_id' absent from response to a futures request");
+            }
+            if (!response.send_token) {
+                throw new Error("'send_token' absent from response to a futures request");
+            }
+            if (!response.cancel_token) {
+                throw new Error("'cancel_token' absent from response to a futures request");
+            }
+            return {
+                future_group_id: response.future_group_id,
+                send_token: response.send_token,
+                cancel_token: response.cancel_token,
+                ...(response.refresh_token && { refresh_token: response.refresh_token }),
+            };
         }
+
         let response: ISendEventFromWidgetResponseData;
         try {
             response = await this.widgetApi.sendRoomEvent(event.getType(), event.getContent(), room.roomId);
@@ -271,6 +300,9 @@ export class RoomWidgetClient extends MatrixClient {
         }
 
         room.updatePendingEvent(event, EventStatus.SENT, response.event_id);
+        if (!response.event_id) {
+            throw new Error("'event_id' absent from response to an event request");
+        }
         return { event_id: response.event_id };
     }
 
@@ -280,7 +312,33 @@ export class RoomWidgetClient extends MatrixClient {
         content: any,
         stateKey = "",
     ): Promise<ISendEventResponse> {
-        return await this.widgetApi.sendStateEvent(eventType, stateKey, content, roomId);
+        const response = await this.widgetApi.sendStateEvent(eventType, stateKey, content, roomId);
+        if (response.event_id === undefined) {
+            throw new Error("'event_id' absent from response to an event request");
+        }
+        return { event_id: response.event_id };
+    }
+
+    /**
+     * @experimental This currently relies on an unstable MSC (MSC4140).
+     */
+    // eslint-disable-next-line
+    public async _unstable_sendStateFuture<K extends keyof StateEvents, F extends SendFutureRequestOpts>(
+        roomId: string,
+        futureOpts: F,
+        eventType: K,
+        content: StateEvents[K],
+        stateKey = "",
+    ): Promise<SendFutureResponse<F>> {
+        // TODO: better type checking
+        return (await this.widgetApi.sendStateEvent(
+            eventType,
+            stateKey,
+            content,
+            roomId,
+            "future_timeout" in futureOpts ? futureOpts.future_timeout : undefined,
+            "future_group_id" in futureOpts ? futureOpts.future_group_id : undefined,
+        )) as unknown as SendFutureResponse<F>;
     }
 
     public async sendToDevice(eventType: string, contentMap: SendToDeviceContentMap): Promise<{}> {