@matrix-widget-toolkit/api 3.0.1 → 3.2.0

package/build/cjs/index.js

@@ -1047,8 +1047,7 @@ var WidgetApiImpl = /** @class */ (function () {
         this.matrixWidgetApi = matrixWidgetApi$1;
         this.widgetId = widgetId;
         this.widgetParameters = widgetParameters;
-        var eventName = "action:".concat(matrixWidgetApi.WidgetApiToWidgetAction.SendEvent);
-        this.events$ = rxjs.fromEvent(this.matrixWidgetApi, eventName, function (event) {
+        this.events$ = rxjs.fromEvent(this.matrixWidgetApi, "action:".concat(matrixWidgetApi.WidgetApiToWidgetAction.SendEvent), function (event) {
             event.preventDefault();
             try {
                 _this.matrixWidgetApi.transport.reply(event.detail, {});
@@ -1058,6 +1057,16 @@ var WidgetApiImpl = /** @class */ (function () {
             }
             return event;
         }).pipe(rxjs.share());
+        this.toDeviceMessages$ = rxjs.fromEvent(this.matrixWidgetApi, 'action:send_to_device', function (event) {
+            event.preventDefault();
+            try {
+                matrixWidgetApi$1.transport.reply(event.detail, {});
+            }
+            catch (_) {
+                // Ignore errors while replying
+            }
+            return event;
+        }).pipe(rxjs.share());
         this.initialCapabilities = __spreadArray(__spreadArray([], capabilities, true), (supportStandalone ? [] : [matrixWidgetApi.MatrixCapabilities.RequiresClient]), true);
     }
     /**
@@ -1432,6 +1441,23 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritDoc WidgetApi.sendToDeviceMessage} */
+    WidgetApiImpl.prototype.sendToDeviceMessage = function (eventType, encrypted, content) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.sendToDevice(eventType, encrypted, content)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /** {@inheritDoc WidgetApi.observeToDeviceMessages} */
+    WidgetApiImpl.prototype.observeToDeviceMessages = function (eventType) {
+        return this.toDeviceMessages$.pipe(rxjs.map(function (e) { return e.detail.data; }), rxjs.filter(function (e) { return e.type === eventType; }));
+    };
     /** {@inheritDoc WidgetApi.openModal} */
     WidgetApiImpl.prototype.openModal = function (pathName, name, options) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1592,6 +1618,43 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritdoc WidgetApi.observeTurnServers} */
+    WidgetApiImpl.prototype.observeTurnServers = function () {
+        return rxjs.from(this.matrixWidgetApi.getTurnServers()).pipe(
+        // For some reason a different naming was chosen for the API, but
+        // we already convert them to the right type for WebRTC consumers.
+        rxjs.map(function (_a) {
+            var uris = _a.uris, username = _a.username, password = _a.password;
+            return ({
+                urls: uris,
+                username: username,
+                credential: password,
+            });
+        }));
+    };
+    /** {@inheritdoc WidgetApi.searchUserDirectory}  */
+    WidgetApiImpl.prototype.searchUserDirectory = function (searchTerm, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var results;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.searchUserDirectory(searchTerm, options === null || options === void 0 ? void 0 : options.limit)];
+                    case 1:
+                        results = (_a.sent()).results;
+                        return [2 /*return*/, {
+                                results: results.map(function (_a) {
+                                    var user_id = _a.user_id, display_name = _a.display_name, avatar_url = _a.avatar_url;
+                                    return ({
+                                        userId: user_id,
+                                        displayName: display_name,
+                                        avatarUrl: avatar_url,
+                                    });
+                                }),
+                            }];
+                }
+            });
+        });
+    };
     return WidgetApiImpl;
 }());
 

package/build/esm/index.js

@@ -1045,8 +1045,7 @@ var WidgetApiImpl = /** @class */ (function () {
         this.matrixWidgetApi = matrixWidgetApi;
         this.widgetId = widgetId;
         this.widgetParameters = widgetParameters;
-        var eventName = "action:".concat(WidgetApiToWidgetAction.SendEvent);
-        this.events$ = fromEvent(this.matrixWidgetApi, eventName, function (event) {
+        this.events$ = fromEvent(this.matrixWidgetApi, "action:".concat(WidgetApiToWidgetAction.SendEvent), function (event) {
             event.preventDefault();
             try {
                 _this.matrixWidgetApi.transport.reply(event.detail, {});
@@ -1056,6 +1055,16 @@ var WidgetApiImpl = /** @class */ (function () {
             }
             return event;
         }).pipe(share());
+        this.toDeviceMessages$ = fromEvent(this.matrixWidgetApi, 'action:send_to_device', function (event) {
+            event.preventDefault();
+            try {
+                matrixWidgetApi.transport.reply(event.detail, {});
+            }
+            catch (_) {
+                // Ignore errors while replying
+            }
+            return event;
+        }).pipe(share());
         this.initialCapabilities = __spreadArray(__spreadArray([], capabilities, true), (supportStandalone ? [] : [MatrixCapabilities.RequiresClient]), true);
     }
     /**
@@ -1430,6 +1439,23 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritDoc WidgetApi.sendToDeviceMessage} */
+    WidgetApiImpl.prototype.sendToDeviceMessage = function (eventType, encrypted, content) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.sendToDevice(eventType, encrypted, content)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /** {@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; }));
+    };
     /** {@inheritDoc WidgetApi.openModal} */
     WidgetApiImpl.prototype.openModal = function (pathName, name, options) {
         return __awaiter(this, void 0, void 0, function () {
@@ -1590,6 +1616,43 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritdoc WidgetApi.observeTurnServers} */
+    WidgetApiImpl.prototype.observeTurnServers = function () {
+        return from(this.matrixWidgetApi.getTurnServers()).pipe(
+        // For some reason a different naming was chosen for the API, but
+        // we already convert them to the right type for WebRTC consumers.
+        map(function (_a) {
+            var uris = _a.uris, username = _a.username, password = _a.password;
+            return ({
+                urls: uris,
+                username: username,
+                credential: password,
+            });
+        }));
+    };
+    /** {@inheritdoc WidgetApi.searchUserDirectory}  */
+    WidgetApiImpl.prototype.searchUserDirectory = function (searchTerm, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var results;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.searchUserDirectory(searchTerm, options === null || options === void 0 ? void 0 : options.limit)];
+                    case 1:
+                        results = (_a.sent()).results;
+                        return [2 /*return*/, {
+                                results: results.map(function (_a) {
+                                    var user_id = _a.user_id, display_name = _a.display_name, avatar_url = _a.avatar_url;
+                                    return ({
+                                        userId: user_id,
+                                        displayName: display_name,
+                                        avatarUrl: avatar_url,
+                                    });
+                                }),
+                            }];
+                }
+            });
+        });
+    };
     return WidgetApiImpl;
 }());
 

package/build/index.d.ts

@@ -395,6 +395,29 @@ export declare type StateEvent<T = unknown> = Omit<IRoomEvent, 'content' | 'unsi
     content: T;
 };
 
+/**
+ * Generic type for to device message events.
+ */
+export declare type ToDeviceMessageEvent<T = unknown> = {
+    type: string;
+    sender: string;
+    encrypted: boolean;
+    content: T;
+};
+
+/**
+ * WebRTC Ice server credentials like turn servers, type is compatible to
+ * `RTCIceServer` from WebRTC.
+ */
+export declare type TurnServer = {
+    /** One or more URLs for this turn server. */
+    urls: string[];
+    /** Username for this turn server. */
+    username: string;
+    /** Credentials for this turn server. */
+    credential: string;
+};
+
 /**
  * The capability that needs to be requested in order to navigate to another room.
  */
@@ -420,13 +443,13 @@ export declare type WidgetApi = {
      */
     getWidgetConfig<T extends IWidgetApiRequestData>(): Readonly<WidgetConfig<T> | undefined>;
     /**
-     * Rerequests the initialy in the constructor passed capabilities.
+     * Rerequests capabilities initially passed in the constructor.
      *
      * This is useful in case the user denied one or all of them.
      */
     rerequestInitialCapabilities(): Promise<void>;
     /**
-     * True, if the initial capabilties passed via the constructor were granted.
+     * True, if the initial capabilities passed via the constructor were granted.
      */
     hasInitialCapabilities(): boolean;
     /**
@@ -526,7 +549,7 @@ export declare type WidgetApi = {
      *
      * @param eventType - The type of the event to receive.
      * @param options - Options for receiving the room event.
-     *                  Use `messageType` to receive events with a specifc
+     *                  Use `messageType` to receive events with a specific
      *                  message type.
      *                  Use `roomIds` to receive the state events from other
      *                  rooms.
@@ -548,7 +571,7 @@ export declare type WidgetApi = {
      *
      * @param eventType - The type of the event to receive.
      * @param options - Options for receiving the room event.
-     *                  Use `messageType` to receive events with a specifc
+     *                  Use `messageType` to receive events with a specific
      *                  message type.
      *                  Use `roomIds` to receive the state events from other
      *                  rooms.
@@ -605,6 +628,27 @@ export declare type WidgetApi = {
         chunk: Array<RoomEvent | StateEvent>;
         nextToken?: string;
     }>;
+    /**
+     * Send a message to a device of a user (or multiple users / devices).
+     *
+     * @param eventType - The type of the event.
+     * @param encrypted - Whether the event should be encrypted.
+     * @param content - The content to send. This is a map of user ids, to device
+     *                  ids, to the content that should be send. It is possible to
+     *                  specify a `'*'` device, to send the content to all devices
+     *                  of a user.
+     */
+    sendToDeviceMessage<T>(eventType: string, encrypted: boolean, content: {
+        [userId: string]: {
+            [deviceId: string | '*']: T;
+        };
+    }): Promise<void>;
+    /**
+     * Observes all to device messages send to the current device.
+     *
+     * @param eventType - The type of the event.
+     */
+    observeToDeviceMessages<T>(eventType: string): Observable<ToDeviceMessageEvent<T>>;
     /**
      * Open a new modal, wait until the modal closes, and return the result.
      *
@@ -678,6 +722,28 @@ export declare type WidgetApi = {
      *          old one expired.
      */
     requestOpenIDConnectToken(): Promise<IOpenIDCredentials>;
+    /**
+     * Returns an observable containing WebRTC Ice server credentials, like turn
+     * servers, if available.
+     */
+    observeTurnServers(): Observable<TurnServer>;
+    /**
+     * Search for users in the user directory.
+     *
+     * @param searchTerm - The term to search for.
+     * @param options - Options for searching.
+     *                  Use `limit` to limit the number of results to return.
+     * @returns The search results.
+     */
+    searchUserDirectory(searchTerm: string, options?: {
+        limit?: number;
+    }): Promise<{
+        results: Array<{
+            userId: string;
+            displayName?: string;
+            avatarUrl?: string;
+        }>;
+    }>;
 };
 
 /**
@@ -717,6 +783,7 @@ export declare class WidgetApiImpl implements WidgetApi {
     private outstandingOpenIDConnectTokenRequest;
     private cachedOpenIdToken;
     private readonly events$;
+    private readonly toDeviceMessages$;
     private readonly initialCapabilities;
     constructor(
     /**
@@ -797,6 +864,14 @@ export declare class WidgetApiImpl implements WidgetApi {
         chunk: Array<RoomEvent | StateEvent>;
         nextToken?: string;
     }>;
+    /** {@inheritDoc WidgetApi.sendToDeviceMessage} */
+    sendToDeviceMessage<T>(eventType: string, encrypted: boolean, content: {
+        [userId: string]: {
+            [deviceId: string | '*']: T;
+        };
+    }): Promise<void>;
+    /** {@inheritDoc WidgetApi.observeToDeviceMessages} */
+    observeToDeviceMessages<T>(eventType: string): Observable<ToDeviceMessageEvent<T>>;
     /** {@inheritDoc WidgetApi.openModal} */
     openModal<T extends Record<string, unknown> = Record<string, unknown>, U extends IModalWidgetCreateData = IModalWidgetCreateData>(pathName: string, name: string, options?: {
         buttons?: IModalWidgetOpenRequestDataButton[];
@@ -813,6 +888,18 @@ export declare class WidgetApiImpl implements WidgetApi {
     /** {@inheritdoc WidgetApi.requestOpenIDConnectToken} */
     requestOpenIDConnectToken(): Promise<IOpenIDCredentials>;
     private requestOpenIDConnectTokenInternal;
+    /** {@inheritdoc WidgetApi.observeTurnServers} */
+    observeTurnServers(): Observable<TurnServer>;
+    /** {@inheritdoc WidgetApi.searchUserDirectory}  */
+    searchUserDirectory(searchTerm: string, options?: {
+        limit?: number | undefined;
+    } | undefined): Promise<{
+        results: Array<{
+            userId: string;
+            displayName?: string;
+            avatarUrl?: string;
+        }>;
+    }>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matrix-widget-toolkit/api",
-  "version": "3.0.1",
+  "version": "3.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",
@@ -10,7 +10,7 @@
   "devDependencies": {
     "@craco/craco": "^6.4.5",
     "@types/jest": "^27.5.2",
-    "@types/node": "^16.18.11",
+    "@types/node": "^16.18.23",
     "@types/qs": "^6.9.7",
     "typescript": "^4.8.4"
   },
@@ -27,7 +27,7 @@
     "generate-api-report": "tsc && api-extractor run --verbose --local"
   },
   "dependencies": {
-    "matrix-widget-api": "^1.1.1",
+    "matrix-widget-api": "^1.3.1",
     "qs": "^6.11.0",
     "rxjs": "^7.8.0"
   },