@matrix-widget-toolkit/api 3.4.2 → 4.0.0

package/build/esm/index.js

@@ -140,7 +140,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 +149,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 +190,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 +437,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 +446,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 +496,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:
@@ -763,7 +763,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 +772,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]); }; }
@@ -871,10 +871,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 +936,42 @@ function repairWidgetRegistration(widgetApi_1) {
  * 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 +998,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
@@ -1332,36 +1409,9 @@ var WidgetApiImpl = /** @class */ (function () {
         return concat(historyEvent$, futureEvent$);
     };
     /** {@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) {
@@ -1398,7 +1448,7 @@ var WidgetApiImpl = /** @class */ (function () {
     /** {@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 +1460,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*/];
@@ -1694,4 +1744,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, calculateUserPowerLevel, compareOriginServerTS, extractRawWidgetParameters, extractWidgetApiParameters, extractWidgetParameters, generateRoomTimelineCapabilities, generateWidgetRegistrationUrl, getContent, getOriginalEventId, getRoomMemberDisplayName, hasActionPower, hasRequiredWidgetParameters, hasRoomEventPower, hasStateEventPower, isRoomEvent, isStateEvent, isValidEventWithRelatesTo, isValidPowerLevelStateEvent, isValidRedactionEvent, isValidRoomMemberStateEvent, 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';
@@ -214,6 +215,13 @@ export declare function isValidRedactionEvent(event: RoomEvent<unknown>): event
  */
 export declare function isValidRoomMemberStateEvent(event: StateEvent<unknown>): event is StateEvent<RoomMemberStateEventContent>;
 
+/**
+ * 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 +388,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 +557,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 +873,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;

package/package.json

@@ -1,25 +1,34 @@
 {
   "name": "@matrix-widget-toolkit/api",
-  "version": "3.4.2",
+  "version": "4.0.0",
   "description": "A simplified layer on top of matrix-widget-api to use build widgets.",
   "author": "Nordeck IT + Consulting GmbH",
   "license": "Apache-2.0",
   "source": "./src/index.ts",
-  "types": "./build/index.d.ts",
+  "types": "./build/esm/index.d.ts",
   "exports": {
-    "import": "./build/esm/index.js",
-    "require": "./build/cjs/index.js",
-    "types": "./build/index.d.ts"
+    ".": {
+      "module": "./build/esm/index.js",
+      "import": {
+        "types": "./build/esm/index.d.ts",
+        "default": "./build/esm/index.js"
+      },
+      "require": {
+        "types": "./build/cjs/index.d.cts",
+        "default": "./build/cjs/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
   },
   "type": "module",
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.0",
-    "@types/node": "^22.7.5",
-    "@types/qs": "^6.9.16",
-    "@vitest/coverage-v8": "^2.1.3",
-    "typescript": "5.6.3",
-    "vite": "^5.4.8",
-    "vitest": "^2.1.3"
+    "@rollup/plugin-commonjs": "28.0.1",
+    "@types/node": "22.10.1",
+    "@types/qs": "6.9.17",
+    "@vitest/coverage-v8": "2.1.8",
+    "typescript": "5.7.2",
+    "vite": "5.4.11",
+    "vitest": "2.1.8"
   },
   "scripts": {
     "build": "tsc && rollup --config ../../rollup.config.mjs",
@@ -34,9 +43,9 @@
     "generate-api-report": "tsc && api-extractor run --verbose --local"
   },
   "dependencies": {
-    "matrix-widget-api": "^1.9.0",
-    "qs": "^6.13.0",
-    "rxjs": "^7.8.1"
+    "matrix-widget-api": "1.10.0",
+    "qs": "6.13.1",
+    "rxjs": "7.8.1"
   },
   "repository": {
     "type": "git",
@@ -52,5 +61,5 @@
     "matrix-widget-api"
   ],
   "module": "./build/esm/index.js",
-  "main": "./build/cjs/index.js"
+  "main": "./build/cjs/index.cjs"
 }