@matrix-widget-toolkit/api 3.3.2 → 3.4.0

package/build/cjs/index.js

@@ -842,6 +842,7 @@ function generateWidgetRegistrationUrl(options) {
     if (options === void 0) { options = {}; }
     var pathName = options.pathName, _j = options.includeParameters, includeParameters = _j === void 0 ? true : _j, 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' }))
         .map(function (_a) {
@@ -1244,6 +1245,7 @@ var WidgetApiImpl = /** @class */ (function () {
                                 throw new Error("Capabilities rejected: ".concat(Array.from(missingSet).join(', ')));
                             }
                         }), rxjs.first());
+                        // eslint-disable-next-line no-async-promise-executor
                         return [4 /*yield*/, new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
                                 var subscription, err_1;
                                 return __generator(this, function (_a) {
@@ -1271,6 +1273,7 @@ var WidgetApiImpl = /** @class */ (function () {
                                 });
                             }); })];
                     case 1:
+                        // eslint-disable-next-line no-async-promise-executor
                         _a.sent();
                         return [2 /*return*/];
                 }
@@ -1679,6 +1682,17 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritdoc WidgetApi.downloadFile}  */
+    WidgetApiImpl.prototype.downloadFile = function (contentUrl) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.downloadFile(contentUrl)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return WidgetApiImpl;
 }());
 

package/build/esm/index.js

@@ -840,6 +840,7 @@ function generateWidgetRegistrationUrl(options) {
     if (options === void 0) { options = {}; }
     var pathName = options.pathName, _j = options.includeParameters, includeParameters = _j === void 0 ? true : _j, 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' }))
         .map(function (_a) {
@@ -1242,6 +1243,7 @@ var WidgetApiImpl = /** @class */ (function () {
                                 throw new Error("Capabilities rejected: ".concat(Array.from(missingSet).join(', ')));
                             }
                         }), first());
+                        // eslint-disable-next-line no-async-promise-executor
                         return [4 /*yield*/, new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
                                 var subscription, err_1;
                                 return __generator(this, function (_a) {
@@ -1269,6 +1271,7 @@ var WidgetApiImpl = /** @class */ (function () {
                                 });
                             }); })];
                     case 1:
+                        // eslint-disable-next-line no-async-promise-executor
                         _a.sent();
                         return [2 /*return*/];
                 }
@@ -1677,6 +1680,17 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritdoc WidgetApi.downloadFile}  */
+    WidgetApiImpl.prototype.downloadFile = function (contentUrl) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.downloadFile(contentUrl)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return WidgetApiImpl;
 }());
 

package/build/index.d.ts

@@ -4,6 +4,7 @@
  */
 
 import { Capability } from 'matrix-widget-api';
+import { IDownloadFileActionFromWidgetResponseData } from 'matrix-widget-api';
 import { IGetMediaConfigActionFromWidgetResponseData } from 'matrix-widget-api';
 import { IModalWidgetCreateData } from 'matrix-widget-api';
 import { IModalWidgetOpenRequestDataButton } from 'matrix-widget-api';
@@ -758,6 +759,12 @@ export declare type WidgetApi = {
      * @returns Resolves to the location of the uploaded file.
      */
     uploadFile(file: XMLHttpRequestBodyInit): Promise<IUploadFileActionFromWidgetResponseData>;
+    /**
+     * Download a file to the media repository on the homeserver.
+     * @param contentUrl - MXC URI of the file to download
+     * @returns resolves to an object with: file - the file contents
+     */
+    downloadFile(contentUrl: string): Promise<IDownloadFileActionFromWidgetResponseData>;
 };
 
 /**
@@ -918,6 +925,8 @@ export declare class WidgetApiImpl implements WidgetApi {
     getMediaConfig(): Promise<IGetMediaConfigActionFromWidgetResponseData>;
     /** {@inheritdoc WidgetApi.uploadFile}  */
     uploadFile(file: XMLHttpRequestBodyInit): Promise<IUploadFileActionFromWidgetResponseData>;
+    /** {@inheritdoc WidgetApi.downloadFile}  */
+    downloadFile(contentUrl: string): Promise<IDownloadFileActionFromWidgetResponseData>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matrix-widget-toolkit/api",
-  "version": "3.3.2",
+  "version": "3.4.0",
   "description": "A simplified layer on top of matrix-widget-api to use build widgets.",
   "author": "Nordeck IT + Consulting GmbH",
   "license": "Apache-2.0",
@@ -28,8 +28,8 @@
     "generate-api-report": "tsc && api-extractor run --verbose --local"
   },
   "dependencies": {
-    "matrix-widget-api": "^1.6.0",
-    "qs": "^6.12.3",
+    "matrix-widget-api": "^1.9.0",
+    "qs": "^6.13.0",
     "rxjs": "^7.8.1"
   },
   "repository": {