@matrix-widget-toolkit/api 4.1.2 → 4.2.0

package/README.md

@@ -148,3 +148,12 @@ It returns a promise that resolves with the result of the modal.
 Inside the modal widget, you can use `observeModalButtons()` to listen to clicks on the bottom buttons of the modal.
 You can use `setModalButtonEnabled()` to disable buttons from within the widget.
 Once you are done, you can call `closeModal()` to close the modal and pass the results back to the main widget.
+
+### Delayed events
+
+You can send and update delayed events (MSC4140). The configuration for delayed events on the homeserver
+needs to be applied, for example:
+
+```
+max_event_delay_duration: 24h
+```

package/build/cjs/api/WidgetApiImpl.d.cts

@@ -1,4 +1,4 @@
-import { Capability, IDownloadFileActionFromWidgetResponseData, IGetMediaConfigActionFromWidgetResponseData, IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, IOpenIDCredentials, ISendEventFromWidgetResponseData, IUploadFileActionFromWidgetResponseData, IWidgetApiRequestData, WidgetApi as MatrixWidgetApi, ModalButtonID, Symbols, WidgetEventCapability } from 'matrix-widget-api';
+import { Capability, IDownloadFileActionFromWidgetResponseData, IGetMediaConfigActionFromWidgetResponseData, IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, IOpenIDCredentials, ISendEventFromWidgetResponseData, IUploadFileActionFromWidgetResponseData, IWidgetApiRequestData, WidgetApi as MatrixWidgetApi, ModalButtonID, Symbols, UpdateDelayedEventAction, WidgetEventCapability } from 'matrix-widget-api';
 import { Observable } from 'rxjs';
 import { RoomEvent, StateEvent, ToDeviceMessageEvent, TurnServer, WidgetApi, WidgetConfig, WidgetParameters } from './types';
 /**
@@ -108,6 +108,13 @@ export declare class WidgetApiImpl implements WidgetApi {
         roomId?: string;
         stateKey?: string;
     }): Promise<ISendEventFromWidgetResponseData>;
+    /** {@inheritDoc WidgetApi.sendDelayedStateEvent} */
+    sendDelayedStateEvent<T>(eventType: string, content: T, delay: number, { roomId, stateKey }?: {
+        roomId?: string;
+        stateKey?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
     /** {@inheritDoc WidgetApi.receiveRoomEvents} */
     receiveRoomEvents<T>(eventType: string, { messageType, roomIds, }?: {
         messageType?: string;
@@ -122,6 +129,14 @@ export declare class WidgetApiImpl implements WidgetApi {
     sendRoomEvent<T>(eventType: string, content: T, { roomId }?: {
         roomId?: string;
     }): Promise<RoomEvent<T>>;
+    /** {@inheritDoc WidgetApi.sendDelayedRoomEvent} */
+    sendDelayedRoomEvent<T>(eventType: string, content: T, delay: number, { roomId }?: {
+        roomId?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
+    /** {@inheritDoc WidgetApi.updateDelayedEvent} */
+    updateDelayedEvent(delayId: string, action: UpdateDelayedEventAction): Promise<void>;
     /** {@inheritDoc WidgetApi.readEventRelations} */
     readEventRelations(eventId: string, options?: {
         roomId?: string;

package/build/cjs/api/types.d.cts

@@ -1,4 +1,4 @@
-import { Capability, IDownloadFileActionFromWidgetResponseData, IGetMediaConfigActionFromWidgetResponseData, IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, IOpenIDCredentials, IRoomEvent, ISendEventFromWidgetResponseData, IUploadFileActionFromWidgetResponseData, IWidget, IWidgetApiRequest, IWidgetApiRequestData, ModalButtonID, Symbols, WidgetEventCapability } from 'matrix-widget-api';
+import { Capability, IDownloadFileActionFromWidgetResponseData, IGetMediaConfigActionFromWidgetResponseData, IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, IOpenIDCredentials, IRoomEvent, ISendEventFromWidgetResponseData, IUploadFileActionFromWidgetResponseData, IWidget, IWidgetApiRequest, IWidgetApiRequestData, ModalButtonID, Symbols, UpdateDelayedEventAction, WidgetEventCapability } from 'matrix-widget-api';
 import { Observable } from 'rxjs';
 /**
  * Enumeration of widget parameters that can be checked if they are available upon registration.
@@ -265,6 +265,23 @@ export type WidgetApi = {
         roomId?: string;
         stateKey?: string;
     }): Promise<ISendEventFromWidgetResponseData>;
+    /**
+     * Send a delayed state event with a given type to the current room.
+     * @param eventType - The type of the event to send.
+     * @param content - The content of the event.
+     * @param delay - The delay of the event in milliseconds.
+     * @param options - Options for sending the state event.
+     *                  Use `roomId` to send the state event to another room.
+     *                  Use `stateKey` to send a state event with a custom state
+     *                  key.
+     * @returns The result data of delayed event with delay_id.
+     */
+    sendDelayedStateEvent<T>(eventType: string, content: T, delay: number, options?: {
+        roomId?: string;
+        stateKey?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
     /**
      * Receive all room events of a given type from the current room.
      *
@@ -318,6 +335,28 @@ export type WidgetApi = {
     sendRoomEvent<T>(eventType: string, content: T, options?: {
         roomId?: string;
     }): Promise<RoomEvent<T>>;
+    /**
+     * Send a delayed room event with a given type to the current room.
+     * @param eventType - The type of the event to send.
+     * @param content - The content of the event.
+     * @param delay - The delay of the event in milliseconds.
+     * @param options - Options for sending the state event.
+     *                  Use `roomId` to send the state event to another room.
+     *                  Use `stateKey` to send a state event with a custom state
+     *                  key.
+     * @returns The result data of delayed event with delay_id.
+     */
+    sendDelayedRoomEvent<T>(eventType: string, content: T, delay: number, options?: {
+        roomId?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
+    /**
+     * Update a delayed event by delay id
+     * @param delayId - The delay id of the event
+     * @param action - The action to update
+     */
+    updateDelayedEvent(delayId: string, action: UpdateDelayedEventAction): Promise<void>;
     /**
      * Receive all events that relate to a given `eventId` by means of MSC2674.
      * `chunk` can include state events or room events.

package/build/cjs/index.cjs

@@ -1529,6 +1529,24 @@ var WidgetApiImpl = /** @class */ (function () {
         var _b = _a === void 0 ? {} : _a, roomId = _b.roomId, _c = _b.stateKey, stateKey = _c === void 0 ? '' : _c;
         return this.matrixWidgetApi.sendStateEvent(eventType, stateKey, content, roomId);
     };
+    /** {@inheritDoc WidgetApi.sendDelayedStateEvent} */
+    WidgetApiImpl.prototype.sendDelayedStateEvent = function (eventType_1, content_1, delay_1) {
+        return __awaiter(this, arguments, void 0, function (eventType, content, delay, _a) {
+            var delay_id;
+            var _b = _a === void 0 ? {} : _a, roomId = _b.roomId, _c = _b.stateKey, stateKey = _c === void 0 ? '' : _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.sendStateEvent(eventType, stateKey, content, roomId, delay)];
+                    case 1:
+                        delay_id = (_d.sent()).delay_id;
+                        if (!delay_id) {
+                            throw new Error('Delayed event must have a delay_id');
+                        }
+                        return [2 /*return*/, { delay_id: delay_id }];
+                }
+            });
+        });
+    };
     /** {@inheritDoc WidgetApi.receiveRoomEvents} */
     WidgetApiImpl.prototype.receiveRoomEvents = function (eventType_1) {
         return __awaiter(this, arguments, void 0, function (eventType, _a) {
@@ -1597,6 +1615,37 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritDoc WidgetApi.sendDelayedRoomEvent} */
+    WidgetApiImpl.prototype.sendDelayedRoomEvent = function (eventType_1, content_1, delay_1) {
+        return __awaiter(this, arguments, void 0, function (eventType, content, delay, _a) {
+            var delay_id;
+            var _b = _a === void 0 ? {} : _a, roomId = _b.roomId;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.sendRoomEvent(eventType, content, roomId, delay)];
+                    case 1:
+                        delay_id = (_c.sent()).delay_id;
+                        if (!delay_id) {
+                            throw new Error('Delayed event must have a delay_id');
+                        }
+                        return [2 /*return*/, { delay_id: delay_id }];
+                }
+            });
+        });
+    };
+    /** {@inheritDoc WidgetApi.updateDelayedEvent} */
+    WidgetApiImpl.prototype.updateDelayedEvent = function (delayId, action) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.updateDelayedEvent(delayId, action)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /** {@inheritDoc WidgetApi.readEventRelations} */
     WidgetApiImpl.prototype.readEventRelations = function (eventId, options) {
         return __awaiter(this, void 0, void 0, function () {

package/build/esm/api/WidgetApiImpl.d.ts

@@ -1,4 +1,4 @@
-import { Capability, IDownloadFileActionFromWidgetResponseData, IGetMediaConfigActionFromWidgetResponseData, IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, IOpenIDCredentials, ISendEventFromWidgetResponseData, IUploadFileActionFromWidgetResponseData, IWidgetApiRequestData, WidgetApi as MatrixWidgetApi, ModalButtonID, Symbols, WidgetEventCapability } from 'matrix-widget-api';
+import { Capability, IDownloadFileActionFromWidgetResponseData, IGetMediaConfigActionFromWidgetResponseData, IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, IOpenIDCredentials, ISendEventFromWidgetResponseData, IUploadFileActionFromWidgetResponseData, IWidgetApiRequestData, WidgetApi as MatrixWidgetApi, ModalButtonID, Symbols, UpdateDelayedEventAction, WidgetEventCapability } from 'matrix-widget-api';
 import { Observable } from 'rxjs';
 import { RoomEvent, StateEvent, ToDeviceMessageEvent, TurnServer, WidgetApi, WidgetConfig, WidgetParameters } from './types';
 /**
@@ -108,6 +108,13 @@ export declare class WidgetApiImpl implements WidgetApi {
         roomId?: string;
         stateKey?: string;
     }): Promise<ISendEventFromWidgetResponseData>;
+    /** {@inheritDoc WidgetApi.sendDelayedStateEvent} */
+    sendDelayedStateEvent<T>(eventType: string, content: T, delay: number, { roomId, stateKey }?: {
+        roomId?: string;
+        stateKey?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
     /** {@inheritDoc WidgetApi.receiveRoomEvents} */
     receiveRoomEvents<T>(eventType: string, { messageType, roomIds, }?: {
         messageType?: string;
@@ -122,6 +129,14 @@ export declare class WidgetApiImpl implements WidgetApi {
     sendRoomEvent<T>(eventType: string, content: T, { roomId }?: {
         roomId?: string;
     }): Promise<RoomEvent<T>>;
+    /** {@inheritDoc WidgetApi.sendDelayedRoomEvent} */
+    sendDelayedRoomEvent<T>(eventType: string, content: T, delay: number, { roomId }?: {
+        roomId?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
+    /** {@inheritDoc WidgetApi.updateDelayedEvent} */
+    updateDelayedEvent(delayId: string, action: UpdateDelayedEventAction): Promise<void>;
     /** {@inheritDoc WidgetApi.readEventRelations} */
     readEventRelations(eventId: string, options?: {
         roomId?: string;

package/build/esm/api/types.d.ts

@@ -1,4 +1,4 @@
-import { Capability, IDownloadFileActionFromWidgetResponseData, IGetMediaConfigActionFromWidgetResponseData, IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, IOpenIDCredentials, IRoomEvent, ISendEventFromWidgetResponseData, IUploadFileActionFromWidgetResponseData, IWidget, IWidgetApiRequest, IWidgetApiRequestData, ModalButtonID, Symbols, WidgetEventCapability } from 'matrix-widget-api';
+import { Capability, IDownloadFileActionFromWidgetResponseData, IGetMediaConfigActionFromWidgetResponseData, IModalWidgetCreateData, IModalWidgetOpenRequestDataButton, IModalWidgetReturnData, IOpenIDCredentials, IRoomEvent, ISendEventFromWidgetResponseData, IUploadFileActionFromWidgetResponseData, IWidget, IWidgetApiRequest, IWidgetApiRequestData, ModalButtonID, Symbols, UpdateDelayedEventAction, WidgetEventCapability } from 'matrix-widget-api';
 import { Observable } from 'rxjs';
 /**
  * Enumeration of widget parameters that can be checked if they are available upon registration.
@@ -265,6 +265,23 @@ export type WidgetApi = {
         roomId?: string;
         stateKey?: string;
     }): Promise<ISendEventFromWidgetResponseData>;
+    /**
+     * Send a delayed state event with a given type to the current room.
+     * @param eventType - The type of the event to send.
+     * @param content - The content of the event.
+     * @param delay - The delay of the event in milliseconds.
+     * @param options - Options for sending the state event.
+     *                  Use `roomId` to send the state event to another room.
+     *                  Use `stateKey` to send a state event with a custom state
+     *                  key.
+     * @returns The result data of delayed event with delay_id.
+     */
+    sendDelayedStateEvent<T>(eventType: string, content: T, delay: number, options?: {
+        roomId?: string;
+        stateKey?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
     /**
      * Receive all room events of a given type from the current room.
      *
@@ -318,6 +335,28 @@ export type WidgetApi = {
     sendRoomEvent<T>(eventType: string, content: T, options?: {
         roomId?: string;
     }): Promise<RoomEvent<T>>;
+    /**
+     * Send a delayed room event with a given type to the current room.
+     * @param eventType - The type of the event to send.
+     * @param content - The content of the event.
+     * @param delay - The delay of the event in milliseconds.
+     * @param options - Options for sending the state event.
+     *                  Use `roomId` to send the state event to another room.
+     *                  Use `stateKey` to send a state event with a custom state
+     *                  key.
+     * @returns The result data of delayed event with delay_id.
+     */
+    sendDelayedRoomEvent<T>(eventType: string, content: T, delay: number, options?: {
+        roomId?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
+    /**
+     * Update a delayed event by delay id
+     * @param delayId - The delay id of the event
+     * @param action - The action to update
+     */
+    updateDelayedEvent(delayId: string, action: UpdateDelayedEventAction): Promise<void>;
     /**
      * Receive all events that relate to a given `eventId` by means of MSC2674.
      * `chunk` can include state events or room events.

package/build/esm/index.js

@@ -1523,6 +1523,24 @@ var WidgetApiImpl = /** @class */ (function () {
         var _b = _a === void 0 ? {} : _a, roomId = _b.roomId, _c = _b.stateKey, stateKey = _c === void 0 ? '' : _c;
         return this.matrixWidgetApi.sendStateEvent(eventType, stateKey, content, roomId);
     };
+    /** {@inheritDoc WidgetApi.sendDelayedStateEvent} */
+    WidgetApiImpl.prototype.sendDelayedStateEvent = function (eventType_1, content_1, delay_1) {
+        return __awaiter(this, arguments, void 0, function (eventType, content, delay, _a) {
+            var delay_id;
+            var _b = _a === void 0 ? {} : _a, roomId = _b.roomId, _c = _b.stateKey, stateKey = _c === void 0 ? '' : _c;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.sendStateEvent(eventType, stateKey, content, roomId, delay)];
+                    case 1:
+                        delay_id = (_d.sent()).delay_id;
+                        if (!delay_id) {
+                            throw new Error('Delayed event must have a delay_id');
+                        }
+                        return [2 /*return*/, { delay_id: delay_id }];
+                }
+            });
+        });
+    };
     /** {@inheritDoc WidgetApi.receiveRoomEvents} */
     WidgetApiImpl.prototype.receiveRoomEvents = function (eventType_1) {
         return __awaiter(this, arguments, void 0, function (eventType, _a) {
@@ -1591,6 +1609,37 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritDoc WidgetApi.sendDelayedRoomEvent} */
+    WidgetApiImpl.prototype.sendDelayedRoomEvent = function (eventType_1, content_1, delay_1) {
+        return __awaiter(this, arguments, void 0, function (eventType, content, delay, _a) {
+            var delay_id;
+            var _b = _a === void 0 ? {} : _a, roomId = _b.roomId;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.sendRoomEvent(eventType, content, roomId, delay)];
+                    case 1:
+                        delay_id = (_c.sent()).delay_id;
+                        if (!delay_id) {
+                            throw new Error('Delayed event must have a delay_id');
+                        }
+                        return [2 /*return*/, { delay_id: delay_id }];
+                }
+            });
+        });
+    };
+    /** {@inheritDoc WidgetApi.updateDelayedEvent} */
+    WidgetApiImpl.prototype.updateDelayedEvent = function (delayId, action) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.updateDelayedEvent(delayId, action)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /** {@inheritDoc WidgetApi.readEventRelations} */
     WidgetApiImpl.prototype.readEventRelations = function (eventId, options) {
         return __awaiter(this, void 0, void 0, function () {

package/build/index.d.ts

@@ -19,6 +19,7 @@ import { IWidgetApiRequestData } from 'matrix-widget-api';
 import { ModalButtonID } from 'matrix-widget-api';
 import { Observable } from 'rxjs';
 import { Symbols } from 'matrix-widget-api';
+import { UpdateDelayedEventAction } from 'matrix-widget-api';
 import { WidgetApi as WidgetApi_2 } from 'matrix-widget-api';
 import { WidgetEventCapability } from 'matrix-widget-api';
 
@@ -582,6 +583,23 @@ export declare type WidgetApi = {
         roomId?: string;
         stateKey?: string;
     }): Promise<ISendEventFromWidgetResponseData>;
+    /**
+     * Send a delayed state event with a given type to the current room.
+     * @param eventType - The type of the event to send.
+     * @param content - The content of the event.
+     * @param delay - The delay of the event in milliseconds.
+     * @param options - Options for sending the state event.
+     *                  Use `roomId` to send the state event to another room.
+     *                  Use `stateKey` to send a state event with a custom state
+     *                  key.
+     * @returns The result data of delayed event with delay_id.
+     */
+    sendDelayedStateEvent<T>(eventType: string, content: T, delay: number, options?: {
+        roomId?: string;
+        stateKey?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
     /**
      * Receive all room events of a given type from the current room.
      *
@@ -635,6 +653,28 @@ export declare type WidgetApi = {
     sendRoomEvent<T>(eventType: string, content: T, options?: {
         roomId?: string;
     }): Promise<RoomEvent<T>>;
+    /**
+     * Send a delayed room event with a given type to the current room.
+     * @param eventType - The type of the event to send.
+     * @param content - The content of the event.
+     * @param delay - The delay of the event in milliseconds.
+     * @param options - Options for sending the state event.
+     *                  Use `roomId` to send the state event to another room.
+     *                  Use `stateKey` to send a state event with a custom state
+     *                  key.
+     * @returns The result data of delayed event with delay_id.
+     */
+    sendDelayedRoomEvent<T>(eventType: string, content: T, delay: number, options?: {
+        roomId?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
+    /**
+     * Update a delayed event by delay id
+     * @param delayId - The delay id of the event
+     * @param action - The action to update
+     */
+    updateDelayedEvent(delayId: string, action: UpdateDelayedEventAction): Promise<void>;
     /**
      * Receive all events that relate to a given `eventId` by means of MSC2674.
      * `chunk` can include state events or room events.
@@ -898,6 +938,13 @@ export declare class WidgetApiImpl implements WidgetApi {
         roomId?: string;
         stateKey?: string;
     }): Promise<ISendEventFromWidgetResponseData>;
+    /** {@inheritDoc WidgetApi.sendDelayedStateEvent} */
+    sendDelayedStateEvent<T>(eventType: string, content: T, delay: number, { roomId, stateKey }?: {
+        roomId?: string;
+        stateKey?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
     /** {@inheritDoc WidgetApi.receiveRoomEvents} */
     receiveRoomEvents<T>(eventType: string, { messageType, roomIds, }?: {
         messageType?: string;
@@ -912,6 +959,14 @@ export declare class WidgetApiImpl implements WidgetApi {
     sendRoomEvent<T>(eventType: string, content: T, { roomId }?: {
         roomId?: string;
     }): Promise<RoomEvent<T>>;
+    /** {@inheritDoc WidgetApi.sendDelayedRoomEvent} */
+    sendDelayedRoomEvent<T>(eventType: string, content: T, delay: number, { roomId }?: {
+        roomId?: string;
+    }): Promise<{
+        delay_id: string;
+    }>;
+    /** {@inheritDoc WidgetApi.updateDelayedEvent} */
+    updateDelayedEvent(delayId: string, action: UpdateDelayedEventAction): Promise<void>;
     /** {@inheritDoc WidgetApi.readEventRelations} */
     readEventRelations(eventId: string, options?: {
         roomId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matrix-widget-toolkit/api",
-  "version": "4.1.2",
+  "version": "4.2.0",
   "description": "A simplified layer on top of matrix-widget-api to use build widgets.",
   "author": "Nordeck IT + Consulting GmbH",
   "license": "Apache-2.0",
@@ -22,13 +22,13 @@
   },
   "type": "module",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "28.0.2",
-    "@types/node": "22.13.5",
-    "@types/qs": "6.9.18",
-    "@vitest/coverage-v8": "3.0.7",
-    "typescript": "5.7.3",
-    "vite": "6.2.0",
-    "vitest": "3.0.7"
+    "@rollup/plugin-commonjs": "28.0.3",
+    "@types/node": "22.15.30",
+    "@types/qs": "6.14.0",
+    "@vitest/coverage-v8": "3.2.2",
+    "typescript": "5.8.3",
+    "vite": "6.3.5",
+    "vitest": "3.2.2"
   },
   "scripts": {
     "build": "tsc && rollup --config ../../rollup.config.mjs",