@matrix-widget-toolkit/api 3.4.2 → 4.1.0

package/build/esm/index.js

@@ -1,4 +1,5 @@
 import { Symbols, WidgetEventCapability, EventDirection, WidgetApi, WidgetApiToWidgetAction, MatrixCapabilities } from 'matrix-widget-api';
+import Joi from 'joi';
 import { stringify, parse } from 'qs';
 import { filter, fromEvent, firstValueFrom, map, first, throwError, from, mergeAll, concat, ReplaySubject, share } from 'rxjs';
 
@@ -106,6 +107,17 @@ function getRoomMemberDisplayName(member, allRoomMembers) {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __assign$2 = (undefined && undefined.__assign) || function () {
+    __assign$2 = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign$2.apply(this, arguments);
+};
 /**
  * Check if the given event is a {@link StateEvent}.
  *
@@ -124,6 +136,58 @@ function isStateEvent(event) {
 function isRoomEvent(event) {
     return !('state_key' in event);
 }
+/**
+ * Check if the given value is a valid {@link RoomEvent}.
+ *
+ * @param event - The value to check
+ * @returns true if value is a valid room event, else false.
+ */
+// Allow any here, so that the validation works for every event
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isValidRoomEvent(event) {
+    return roomEventSchema.validate(event).error === undefined;
+}
+/**
+ * Check if the given value is a valid {@link StateEvent}.
+ *
+ * @param event - The value to check
+ * @returns true if value is a valid state event, else false.
+ */
+// Allow any here, so that the validation works for every event
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function isValidStateEvent(event) {
+    return stateEventSchema.validate(event).error === undefined;
+}
+/**
+ * Check if the given value is a valid {@link ToDeviceMessageEvent}.
+ *
+ * @param event - The value to check
+ * @returns true if value is a valid to device message, else false.
+ */
+function isValidToDeviceMessageEvent(event) {
+    return toDeviceMessageSchema.validate(event).error === undefined;
+}
+/**
+ * Base properties to validate for all events.
+ */
+var eventSchemaProps = {
+    type: Joi.string().required(),
+    // Do roughly check against the format
+    // https://spec.matrix.org/v1.13/appendices/#common-identifier-format
+    sender: Joi.string().pattern(new RegExp('^@[^\\s:]*:\\S*$')).required(),
+    event_id: Joi.string().pattern(new RegExp('^\\$.*')).required(),
+    room_id: Joi.string().pattern(new RegExp('^![^:]*:\\S*')).required(),
+    origin_server_ts: Joi.date().timestamp('javascript').required(),
+    content: Joi.object().required(),
+};
+var roomEventSchema = Joi.object(__assign$2({}, eventSchemaProps)).unknown();
+var stateEventSchema = Joi.object(__assign$2(__assign$2({}, eventSchemaProps), { state_key: Joi.string().allow('').required() })).unknown();
+var toDeviceMessageSchema = Joi.object({
+    type: Joi.string().required(),
+    sender: Joi.string().required(),
+    encrypted: Joi.boolean().required(),
+    content: Joi.object().required(),
+}).unknown();
 
 /*
  * Copyright 2022 Nordeck IT + Consulting GmbH
@@ -140,7 +204,7 @@ function isRoomEvent(event) {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __awaiter$3 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+var __awaiter$4 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
@@ -149,7 +213,7 @@ var __awaiter$3 = (undefined && undefined.__awaiter) || function (thisArg, _argu
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator$3 = (undefined && undefined.__generator) || function (thisArg, body) {
+var __generator$4 = (undefined && undefined.__generator) || function (thisArg, body) {
     var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
     return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
@@ -190,10 +254,10 @@ var WIDGET_CAPABILITY_NAVIGATE = 'org.matrix.msc2931.navigate';
  * @param opts - {@link NavigateToRoomOptions}
  */
 function navigateToRoom(widgetApi_1, roomId_1) {
-    return __awaiter$3(this, arguments, void 0, function (widgetApi, roomId, opts) {
+    return __awaiter$4(this, arguments, void 0, function (widgetApi, roomId, opts) {
         var _a, via, params, url;
         if (opts === void 0) { opts = {}; }
-        return __generator$3(this, function (_b) {
+        return __generator$4(this, function (_b) {
             switch (_b.label) {
                 case 0:
                     _a = opts.via, via = _a === void 0 ? [] : _a;
@@ -437,7 +501,7 @@ function calculateActionPowerLevel(powerLevelStateEvent, action) {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __awaiter$2 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+var __awaiter$3 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
@@ -446,7 +510,7 @@ var __awaiter$2 = (undefined && undefined.__awaiter) || function (thisArg, _argu
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator$2 = (undefined && undefined.__generator) || function (thisArg, body) {
+var __generator$3 = (undefined && undefined.__generator) || function (thisArg, body) {
     var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
     return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
@@ -496,9 +560,9 @@ function isValidRedactionEvent(event) {
  * @returns The redaction event that was send to the room.
  */
 function redactEvent(widgetApi, eventId) {
-    return __awaiter$2(this, void 0, void 0, function () {
+    return __awaiter$3(this, void 0, void 0, function () {
         var result;
-        return __generator$2(this, function (_a) {
+        return __generator$3(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, widgetApi.sendRoomEvent(ROOM_EVENT_REDACTION, { redacts: eventId })];
                 case 1:
@@ -711,6 +775,7 @@ function extractWidgetParameters() {
         clientId: params['matrix_client_id'],
         clientLanguage: params['matrix_client_language'],
         baseUrl: params['matrix_base_url'],
+        deviceId: params['matrix_device_id'],
         isOpenedByClient: isOpenedByClient,
     };
 }
@@ -763,7 +828,7 @@ var __assign = (undefined && undefined.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-var __awaiter$1 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+var __awaiter$2 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
@@ -772,7 +837,7 @@ var __awaiter$1 = (undefined && undefined.__awaiter) || function (thisArg, _argu
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator$1 = (undefined && undefined.__generator) || function (thisArg, body) {
+var __generator$2 = (undefined && undefined.__generator) || function (thisArg, body) {
     var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
     return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
@@ -811,12 +876,12 @@ var __rest = (undefined && undefined.__rest) || function (s, e) {
     return t;
 };
 /**
- * Checks whether all widget parameters were provided to the widget.
+ * Checks whether the necessary widget parameters were provided to the widget.
  *
  * @param widgetApi - The widget api to read the parameters from
  * @returns True, if all parameters were provided.
  */
-function hasRequiredWidgetParameters(widgetApi) {
+function hasWidgetParameters(widgetApi) {
     return (typeof widgetApi.widgetParameters.userId === 'string' &&
         typeof widgetApi.widgetParameters.displayName === 'string' &&
         typeof widgetApi.widgetParameters.avatarUrl === 'string' &&
@@ -836,13 +901,13 @@ function hasRequiredWidgetParameters(widgetApi) {
  * @returns The generated URL.
  */
 function generateWidgetRegistrationUrl(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     if (options === void 0) { options = {}; }
-    var pathName = options.pathName, _j = options.includeParameters, includeParameters = _j === void 0 ? true : _j, widgetParameters = options.widgetParameters;
+    var pathName = options.pathName, _k = options.includeParameters, includeParameters = _k === void 0 ? true : _k, widgetParameters = options.widgetParameters;
     // don't forward widgetId and parentUrl as they will be generated by the client
     // eslint-disable-next-line
-    var _k = extractRawWidgetParameters(); _k.widgetId; _k.parentUrl; var rawWidgetParameters = __rest(_k, ["widgetId", "parentUrl"]);
-    var parameters = Object.entries(__assign(__assign({}, rawWidgetParameters), { theme: (_a = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.theme) !== null && _a !== void 0 ? _a : '$org.matrix.msc2873.client_theme', matrix_user_id: (_b = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.userId) !== null && _b !== void 0 ? _b : '$matrix_user_id', matrix_display_name: (_c = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.displayName) !== null && _c !== void 0 ? _c : '$matrix_display_name', matrix_avatar_url: (_d = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.avatarUrl) !== null && _d !== void 0 ? _d : '$matrix_avatar_url', matrix_room_id: (_e = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.roomId) !== null && _e !== void 0 ? _e : '$matrix_room_id', matrix_client_id: (_f = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.clientId) !== null && _f !== void 0 ? _f : '$org.matrix.msc2873.client_id', matrix_client_language: (_g = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.clientLanguage) !== null && _g !== void 0 ? _g : '$org.matrix.msc2873.client_language', matrix_base_url: (_h = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.baseUrl) !== null && _h !== void 0 ? _h : '$org.matrix.msc4039.matrix_base_url' }))
+    var _l = extractRawWidgetParameters(); _l.widgetId; _l.parentUrl; var rawWidgetParameters = __rest(_l, ["widgetId", "parentUrl"]);
+    var parameters = Object.entries(__assign(__assign({}, rawWidgetParameters), { theme: (_a = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.theme) !== null && _a !== void 0 ? _a : '$org.matrix.msc2873.client_theme', matrix_user_id: (_b = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.userId) !== null && _b !== void 0 ? _b : '$matrix_user_id', matrix_display_name: (_c = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.displayName) !== null && _c !== void 0 ? _c : '$matrix_display_name', matrix_avatar_url: (_d = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.avatarUrl) !== null && _d !== void 0 ? _d : '$matrix_avatar_url', matrix_room_id: (_e = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.roomId) !== null && _e !== void 0 ? _e : '$matrix_room_id', matrix_client_id: (_f = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.clientId) !== null && _f !== void 0 ? _f : '$org.matrix.msc2873.client_id', matrix_client_language: (_g = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.clientLanguage) !== null && _g !== void 0 ? _g : '$org.matrix.msc2873.client_language', matrix_device_id: (_h = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.deviceId) !== null && _h !== void 0 ? _h : '$org.matrix.msc3819.matrix_device_id', matrix_base_url: (_j = widgetParameters === null || widgetParameters === void 0 ? void 0 : widgetParameters.baseUrl) !== null && _j !== void 0 ? _j : '$org.matrix.msc4039.matrix_base_url' }))
         .map(function (_a) {
         var k = _a[0], v = _a[1];
         return "".concat(k, "=").concat(v);
@@ -871,10 +936,10 @@ var STATE_EVENT_WIDGETS = 'im.vector.modular.widgets';
  *                       registration, like the display name of the widget.
  */
 function repairWidgetRegistration(widgetApi_1) {
-    return __awaiter$1(this, arguments, void 0, function (widgetApi, registration) {
+    return __awaiter$2(this, arguments, void 0, function (widgetApi, registration) {
         var readResult, url, name, type, data;
         if (registration === void 0) { registration = {}; }
-        return __generator$1(this, function (_a) {
+        return __generator$2(this, function (_a) {
             switch (_a.label) {
                 case 0: return [4 /*yield*/, widgetApi.requestCapabilities([
                         WidgetEventCapability.forStateEvent(EventDirection.Send, STATE_EVENT_WIDGETS, widgetApi.widgetId),
@@ -936,6 +1001,73 @@ function repairWidgetRegistration(widgetApi_1) {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * Enumeration of widget parameters that can be checked if they are available upon registration.
+ */
+var WidgetParameter;
+(function (WidgetParameter) {
+    WidgetParameter["UserId"] = "userId";
+    WidgetParameter["DisplayName"] = "displayName";
+    WidgetParameter["AvatarUrl"] = "avatarUrl";
+    WidgetParameter["RoomId"] = "roomId";
+    WidgetParameter["Theme"] = "theme";
+    WidgetParameter["ClientId"] = "clientId";
+    WidgetParameter["ClientLanguage"] = "clientLanguage";
+    WidgetParameter["DeviceId"] = "deviceId";
+    WidgetParameter["BaseUrl"] = "baseUrl";
+})(WidgetParameter || (WidgetParameter = {}));
+
+/*
+ * Copyright 2022 Nordeck IT + Consulting GmbH
+ *
+ * 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.
+ */
+var __awaiter$1 = (undefined && undefined.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator$1 = (undefined && undefined.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 function convertToRawCapabilities(rawCapabilities) {
     return rawCapabilities.map(function (c) { return (typeof c === 'string' ? c : c.raw); });
 }
@@ -962,6 +1094,47 @@ function isInRoom(matrixEvent, currentRoomId, roomIds) {
     }
     return roomIds.includes(matrixEvent.room_id);
 }
+/**
+ * Create a state event from the arguments.
+ *
+ * @returns A state event with current timestamp origin_server_ts.
+ */
+function makeEventFromSendStateEventResult(type, stateKey, content, sender, sendResult) {
+    if (sendResult.event_id === undefined) {
+        throw new Error('Send state event did not return an event ID');
+    }
+    return {
+        content: content,
+        event_id: sendResult.event_id,
+        origin_server_ts: Date.now(),
+        room_id: sendResult.room_id,
+        sender: sender,
+        state_key: stateKey,
+        type: type,
+    };
+}
+/**
+ * Send a state event and resolve to a "virtual" state event.
+ *
+ * @returns Promise, that resolves to a state event with current timestamp origin_server_ts.
+ */
+function sendStateEventWithEventResult(widgetApi, type, stateKey, content) {
+    return __awaiter$1(this, void 0, void 0, function () {
+        var response;
+        return __generator$1(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (widgetApi.widgetParameters.userId === undefined) {
+                        throw new Error('Own user ID is undefined');
+                    }
+                    return [4 /*yield*/, widgetApi.sendStateEvent(type, content, { stateKey: stateKey })];
+                case 1:
+                    response = _a.sent();
+                    return [2 /*return*/, makeEventFromSendStateEventResult(type, stateKey, content, widgetApi.widgetParameters.userId, response)];
+            }
+        });
+    });
+}
 
 /*
  * Copyright 2022 Nordeck IT + Consulting GmbH
@@ -1067,7 +1240,9 @@ var WidgetApiImpl = /** @class */ (function () {
                 // Ignore errors while replying
             }
             return event;
-        }).pipe(share());
+        })
+            .pipe(filter(function (event) { return isValidToDeviceMessageEvent(event.detail.data); }))
+            .pipe(share());
         this.initialCapabilities = __spreadArray(__spreadArray([], capabilities, true), (supportStandalone ? [] : [MatrixCapabilities.RequiresClient]), true);
     }
     /**
@@ -1302,11 +1477,15 @@ var WidgetApiImpl = /** @class */ (function () {
     /** {@inheritDoc WidgetApi.receiveStateEvents} */
     WidgetApiImpl.prototype.receiveStateEvents = function (eventType_1) {
         return __awaiter(this, arguments, void 0, function (eventType, _a) {
+            var unvalidatedEvents, validatedEvents;
             var _b = _a === void 0 ? {} : _a, stateKey = _b.stateKey, roomIds = _b.roomIds;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0: return [4 /*yield*/, this.matrixWidgetApi.readStateEvents(eventType, Number.MAX_SAFE_INTEGER, stateKey, typeof roomIds === 'string' ? [Symbols.AnyRoom] : roomIds)];
-                    case 1: return [2 /*return*/, (_c.sent())];
+                    case 1:
+                        unvalidatedEvents = (_c.sent());
+                        validatedEvents = unvalidatedEvents.filter(isValidStateEvent);
+                        return [2 /*return*/, validatedEvents];
                 }
             });
         });
@@ -1329,48 +1508,25 @@ var WidgetApiImpl = /** @class */ (function () {
             }
             return undefined;
         }), filter(isDefined));
-        return concat(historyEvent$, futureEvent$);
+        return concat(historyEvent$, futureEvent$).pipe(filter(isValidStateEvent));
     };
     /** {@inheritDoc WidgetApi.sendStateEvent} */
-    WidgetApiImpl.prototype.sendStateEvent = function (eventType_1, content_1) {
-        return __awaiter(this, arguments, void 0, function (eventType, content, _a) {
-            var subject, subscription, _b, event_id_1, room_id_1, event_1;
-            var _c = _a === void 0 ? {} : _a, roomId = _c.roomId, _d = _c.stateKey, stateKey = _d === void 0 ? '' : _d;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
-                    case 0:
-                        subject = new ReplaySubject();
-                        subscription = this.events$.subscribe(function (e) { return subject.next(e); });
-                        _e.label = 1;
-                    case 1:
-                        _e.trys.push([1, , 4, 5]);
-                        return [4 /*yield*/, this.matrixWidgetApi.sendStateEvent(eventType, stateKey, content, roomId)];
-                    case 2:
-                        _b = _e.sent(), event_id_1 = _b.event_id, room_id_1 = _b.room_id;
-                        return [4 /*yield*/, firstValueFrom(subject.pipe(filter(function (event) {
-                                var matrixEvent = event.detail.data;
-                                return (matrixEvent.event_id === event_id_1 &&
-                                    matrixEvent.room_id === room_id_1);
-                            }), map(function (event) { return event.detail.data; })))];
-                    case 3:
-                        event_1 = _e.sent();
-                        return [2 /*return*/, event_1];
-                    case 4:
-                        subscription.unsubscribe();
-                        return [7 /*endfinally*/];
-                    case 5: return [2 /*return*/];
-                }
-            });
-        });
+    WidgetApiImpl.prototype.sendStateEvent = function (eventType, content, _a) {
+        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.receiveRoomEvents} */
     WidgetApiImpl.prototype.receiveRoomEvents = function (eventType_1) {
         return __awaiter(this, arguments, void 0, function (eventType, _a) {
+            var unvalidatedEvents, validatedEvents;
             var _b = _a === void 0 ? {} : _a, messageType = _b.messageType, roomIds = _b.roomIds;
             return __generator(this, function (_c) {
                 switch (_c.label) {
                     case 0: return [4 /*yield*/, this.matrixWidgetApi.readRoomEvents(eventType, Number.MAX_SAFE_INTEGER, messageType, typeof roomIds === 'string' ? [Symbols.AnyRoom] : roomIds)];
-                    case 1: return [2 /*return*/, (_c.sent())];
+                    case 1:
+                        unvalidatedEvents = (_c.sent());
+                        validatedEvents = unvalidatedEvents.filter(isValidRoomEvent);
+                        return [2 /*return*/, validatedEvents];
                 }
             });
         });
@@ -1393,12 +1549,12 @@ var WidgetApiImpl = /** @class */ (function () {
             }
             return undefined;
         }), filter(isDefined));
-        return concat(historyEvent$, futureEvent$);
+        return concat(historyEvent$, futureEvent$).pipe(filter(isValidRoomEvent));
     };
     /** {@inheritDoc WidgetApi.sendRoomEvent} */
     WidgetApiImpl.prototype.sendRoomEvent = function (eventType_1, content_1) {
         return __awaiter(this, arguments, void 0, function (eventType, content, _a) {
-            var subject, subscription, _b, event_id_2, room_id_2, event_2;
+            var subject, subscription, _b, event_id_1, room_id_1, event_1;
             var _c = _a === void 0 ? {} : _a, roomId = _c.roomId;
             return __generator(this, function (_d) {
                 switch (_d.label) {
@@ -1410,15 +1566,15 @@ var WidgetApiImpl = /** @class */ (function () {
                         _d.trys.push([1, , 4, 5]);
                         return [4 /*yield*/, this.matrixWidgetApi.sendRoomEvent(eventType, content, roomId)];
                     case 2:
-                        _b = _d.sent(), event_id_2 = _b.event_id, room_id_2 = _b.room_id;
+                        _b = _d.sent(), event_id_1 = _b.event_id, room_id_1 = _b.room_id;
                         return [4 /*yield*/, firstValueFrom(subject.pipe(filter(function (event) {
                                 var matrixEvent = event.detail.data;
-                                return (matrixEvent.event_id === event_id_2 &&
-                                    matrixEvent.room_id === room_id_2);
+                                return (matrixEvent.event_id === event_id_1 &&
+                                    matrixEvent.room_id === room_id_1);
                             }), map(function (event) { return event.detail.data; })))];
                     case 3:
-                        event_2 = _d.sent();
-                        return [2 /*return*/, event_2];
+                        event_1 = _d.sent();
+                        return [2 /*return*/, event_1];
                     case 4:
                         subscription.unsubscribe();
                         return [7 /*endfinally*/];
@@ -1459,7 +1615,7 @@ var WidgetApiImpl = /** @class */ (function () {
     };
     /** {@inheritDoc WidgetApi.observeToDeviceMessages} */
     WidgetApiImpl.prototype.observeToDeviceMessages = function (eventType) {
-        return this.toDeviceMessages$.pipe(map(function (e) { return e.detail.data; }), filter(function (e) { return e.type === eventType; }));
+        return this.toDeviceMessages$.pipe(map(function (e) { return e.detail.data; }), filter(isValidToDeviceMessageEvent), filter(function (e) { return e.type === eventType; }));
     };
     /** {@inheritDoc WidgetApi.openModal} */
     WidgetApiImpl.prototype.openModal = function (pathName, name, options) {
@@ -1694,4 +1850,4 @@ var WidgetApiImpl = /** @class */ (function () {
     return WidgetApiImpl;
 }());
 
-export { ROOM_EVENT_REDACTION, STATE_EVENT_POWER_LEVELS, STATE_EVENT_ROOM_MEMBER, WIDGET_CAPABILITY_NAVIGATE, WidgetApiImpl, calculateUserPowerLevel, compareOriginServerTS, extractRawWidgetParameters, extractWidgetApiParameters, extractWidgetParameters, generateRoomTimelineCapabilities, generateWidgetRegistrationUrl, getContent, getOriginalEventId, getRoomMemberDisplayName, hasActionPower, hasRequiredWidgetParameters, hasRoomEventPower, hasStateEventPower, isRoomEvent, isStateEvent, isValidEventWithRelatesTo, isValidPowerLevelStateEvent, isValidRedactionEvent, isValidRoomMemberStateEvent, navigateToRoom, observeRedactionEvents, parseWidgetId, redactEvent, repairWidgetRegistration };
+export { ROOM_EVENT_REDACTION, STATE_EVENT_POWER_LEVELS, STATE_EVENT_ROOM_MEMBER, WIDGET_CAPABILITY_NAVIGATE, WidgetApiImpl, WidgetParameter, calculateUserPowerLevel, compareOriginServerTS, extractRawWidgetParameters, extractWidgetApiParameters, extractWidgetParameters, generateRoomTimelineCapabilities, generateWidgetRegistrationUrl, getContent, getOriginalEventId, getRoomMemberDisplayName, hasActionPower, hasRoomEventPower, hasStateEventPower, hasWidgetParameters, isRoomEvent, isStateEvent, isValidEventWithRelatesTo, isValidPowerLevelStateEvent, isValidRedactionEvent, isValidRoomEvent, isValidRoomMemberStateEvent, isValidStateEvent as isValidStateEVent, isValidToDeviceMessageEvent, makeEventFromSendStateEventResult, navigateToRoom, observeRedactionEvents, parseWidgetId, redactEvent, repairWidgetRegistration, sendStateEventWithEventResult };

package/build/index.d.ts

@@ -11,6 +11,7 @@ import { IModalWidgetOpenRequestDataButton } from 'matrix-widget-api';
 import { IModalWidgetReturnData } from 'matrix-widget-api';
 import { IOpenIDCredentials } from 'matrix-widget-api';
 import { IRoomEvent } from 'matrix-widget-api';
+import { ISendEventFromWidgetResponseData } from 'matrix-widget-api';
 import { IUploadFileActionFromWidgetResponseData } from 'matrix-widget-api';
 import { IWidget } from 'matrix-widget-api';
 import { IWidgetApiRequest } from 'matrix-widget-api';
@@ -139,14 +140,6 @@ export declare function getRoomMemberDisplayName(member: StateEvent<RoomMemberSt
  */
 export declare function hasActionPower(powerLevelStateEvent: PowerLevelsStateEvent | undefined, userId: string | undefined, action: PowerLevelsActions): boolean;
 
-/**
- * Checks whether all widget parameters were provided to the widget.
- *
- * @param widgetApi - The widget api to read the parameters from
- * @returns True, if all parameters were provided.
- */
-export declare function hasRequiredWidgetParameters(widgetApi: WidgetApi): boolean;
-
 /**
  * Check if a user has the power to send a specific room event.
  *
@@ -167,6 +160,14 @@ export declare function hasRoomEventPower(powerLevelStateEvent: PowerLevelsState
  */
 export declare function hasStateEventPower(powerLevelStateEvent: PowerLevelsStateEvent | undefined, userId: string | undefined, eventType: string): boolean;
 
+/**
+ * Checks whether the necessary widget parameters were provided to the widget.
+ *
+ * @param widgetApi - The widget api to read the parameters from
+ * @returns True, if all parameters were provided.
+ */
+export declare function hasWidgetParameters(widgetApi: WidgetApi): boolean;
+
 /**
  * Check if the given event is a {@link RoomEvent}.
  *
@@ -206,6 +207,14 @@ export declare function isValidPowerLevelStateEvent(event: StateEvent<unknown>):
  */
 export declare function isValidRedactionEvent(event: RoomEvent<unknown>): event is RedactionRoomEvent;
 
+/**
+ * Check if the given value is a valid {@link RoomEvent}.
+ *
+ * @param event - The value to check
+ * @returns true if value is a valid room event, else false.
+ */
+export declare function isValidRoomEvent(event: unknown): event is RoomEvent<any>;
+
 /**
  * Validates that `event` is has a valid structure for a
  * {@link RoomMemberStateEventContent}.
@@ -214,6 +223,29 @@ export declare function isValidRedactionEvent(event: RoomEvent<unknown>): event
  */
 export declare function isValidRoomMemberStateEvent(event: StateEvent<unknown>): event is StateEvent<RoomMemberStateEventContent>;
 
+/**
+ * Check if the given value is a valid {@link StateEvent}.
+ *
+ * @param event - The value to check
+ * @returns true if value is a valid state event, else false.
+ */
+export declare function isValidStateEVent(event: unknown): event is StateEvent<any>;
+
+/**
+ * Check if the given value is a valid {@link ToDeviceMessageEvent}.
+ *
+ * @param event - The value to check
+ * @returns true if value is a valid to device message, else false.
+ */
+export declare function isValidToDeviceMessageEvent(event: unknown): event is ToDeviceMessageEvent<any>;
+
+/**
+ * Create a state event from the arguments.
+ *
+ * @returns A state event with current timestamp origin_server_ts.
+ */
+export declare function makeEventFromSendStateEventResult<T>(type: string, stateKey: string, content: T, sender: string, sendResult: ISendEventFromWidgetResponseData): StateEvent<T>;
+
 /**
  * The membership state of a user.
  */
@@ -380,6 +412,13 @@ export declare type RoomMemberStateEventContent = {
     avatar_url?: string | null;
 };
 
+/**
+ * Send a state event and resolve to a "virtual" state event.
+ *
+ * @returns Promise, that resolves to a state event with current timestamp origin_server_ts.
+ */
+export declare function sendStateEventWithEventResult<T>(widgetApi: WidgetApi, type: string, stateKey: string, content: T): Promise<StateEvent<T>>;
+
 /**
  * The name of the power levels state event.
  */
@@ -542,7 +581,7 @@ export declare type WidgetApi = {
     sendStateEvent<T>(eventType: string, content: T, options?: {
         roomId?: string;
         stateKey?: string;
-    }): Promise<StateEvent<T>>;
+    }): Promise<ISendEventFromWidgetResponseData>;
     /**
      * Receive all room events of a given type from the current room.
      *
@@ -858,7 +897,7 @@ export declare class WidgetApiImpl implements WidgetApi {
     sendStateEvent<T>(eventType: string, content: T, { roomId, stateKey }?: {
         roomId?: string;
         stateKey?: string;
-    }): Promise<StateEvent<T>>;
+    }): Promise<ISendEventFromWidgetResponseData>;
     /** {@inheritDoc WidgetApi.receiveRoomEvents} */
     receiveRoomEvents<T>(eventType: string, { messageType, roomIds, }?: {
         messageType?: string;
@@ -989,6 +1028,21 @@ export declare type WidgetId = {
     isModal: boolean;
 };
 
+/**
+ * Enumeration of widget parameters that can be checked if they are available upon registration.
+ */
+export declare enum WidgetParameter {
+    UserId = "userId",
+    DisplayName = "displayName",
+    AvatarUrl = "avatarUrl",
+    RoomId = "roomId",
+    Theme = "theme",
+    ClientId = "clientId",
+    ClientLanguage = "clientLanguage",
+    DeviceId = "deviceId",
+    BaseUrl = "baseUrl"
+}
+
 /**
  * Parameters passed from the client to the widget during initialization.
  */
@@ -1028,6 +1082,10 @@ export declare type WidgetParameters = {
      * The current selected language in the client.
      */
     clientLanguage?: string;
+    /**
+     * The device id of the current client session..
+     */
+    deviceId?: string;
     /**
      * The homeserver base URL.
      */
@@ -1057,6 +1115,12 @@ export declare type WidgetRegistration = {
      * The display name of the widget.
      */
     name?: string;
+    /**
+     * Checks for custom widget-specific registration parameters that might be required.
+     *
+     * Added for backwards compatibility with old widget registrations.
+     */
+    requiredParameters?: WidgetParameter[];
     /**
      * The avatar URL used to display an icon on the widget.
      *