@matrix-widget-toolkit/api 3.2.2 → 3.3.1

package/build/cjs/index.js

@@ -81,6 +81,7 @@ function extractWidgetParameters() {
         theme: params['theme'],
         clientId: params['matrix_client_id'],
         clientLanguage: params['matrix_client_language'],
+        baseUrl: params['matrix_base_url'],
         isOpenedByClient: isOpenedByClient,
     };
 }
@@ -193,7 +194,8 @@ function hasRequiredWidgetParameters(widgetApi) {
         typeof widgetApi.widgetParameters.roomId === 'string' &&
         typeof widgetApi.widgetParameters.theme === 'string' &&
         typeof widgetApi.widgetParameters.clientId === 'string' &&
-        typeof widgetApi.widgetParameters.clientLanguage === 'string');
+        typeof widgetApi.widgetParameters.clientLanguage === 'string' &&
+        typeof widgetApi.widgetParameters.baseUrl === 'string');
 }
 /**
  * Generate a registration URL for the widget based on the current URL and
@@ -205,12 +207,12 @@ function hasRequiredWidgetParameters(widgetApi) {
  * @returns The generated URL.
  */
 function generateWidgetRegistrationUrl(options) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f, _g, _h;
     if (options === void 0) { options = {}; }
-    var pathName = options.pathName, _h = options.includeParameters, includeParameters = _h === void 0 ? true : _h, widgetParameters = options.widgetParameters;
+    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
-    var _j = extractRawWidgetParameters(); _j.widgetId; _j.parentUrl; var rawWidgetParameters = __rest(_j, ["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' }))
+    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) {
         var k = _a[0], v = _a[1];
         return "".concat(k, "=").concat(v);
@@ -1024,6 +1026,28 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritdoc WidgetApi.getMediaConfig}  */
+    WidgetApiImpl.prototype.getMediaConfig = function () {
+        return __awaiter$2(this, void 0, void 0, function () {
+            return __generator$2(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.getMediaConfig()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /** {@inheritdoc WidgetApi.uploadFile}  */
+    WidgetApiImpl.prototype.uploadFile = function (file) {
+        return __awaiter$2(this, void 0, void 0, function () {
+            return __generator$2(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.uploadFile(file)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return WidgetApiImpl;
 }());
 

package/build/esm/index.js

@@ -79,6 +79,7 @@ function extractWidgetParameters() {
         theme: params['theme'],
         clientId: params['matrix_client_id'],
         clientLanguage: params['matrix_client_language'],
+        baseUrl: params['matrix_base_url'],
         isOpenedByClient: isOpenedByClient,
     };
 }
@@ -191,7 +192,8 @@ function hasRequiredWidgetParameters(widgetApi) {
         typeof widgetApi.widgetParameters.roomId === 'string' &&
         typeof widgetApi.widgetParameters.theme === 'string' &&
         typeof widgetApi.widgetParameters.clientId === 'string' &&
-        typeof widgetApi.widgetParameters.clientLanguage === 'string');
+        typeof widgetApi.widgetParameters.clientLanguage === 'string' &&
+        typeof widgetApi.widgetParameters.baseUrl === 'string');
 }
 /**
  * Generate a registration URL for the widget based on the current URL and
@@ -203,12 +205,12 @@ function hasRequiredWidgetParameters(widgetApi) {
  * @returns The generated URL.
  */
 function generateWidgetRegistrationUrl(options) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f, _g, _h;
     if (options === void 0) { options = {}; }
-    var pathName = options.pathName, _h = options.includeParameters, includeParameters = _h === void 0 ? true : _h, widgetParameters = options.widgetParameters;
+    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
-    var _j = extractRawWidgetParameters(); _j.widgetId; _j.parentUrl; var rawWidgetParameters = __rest(_j, ["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' }))
+    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) {
         var k = _a[0], v = _a[1];
         return "".concat(k, "=").concat(v);
@@ -1022,6 +1024,28 @@ var WidgetApiImpl = /** @class */ (function () {
             });
         });
     };
+    /** {@inheritdoc WidgetApi.getMediaConfig}  */
+    WidgetApiImpl.prototype.getMediaConfig = function () {
+        return __awaiter$2(this, void 0, void 0, function () {
+            return __generator$2(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.getMediaConfig()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /** {@inheritdoc WidgetApi.uploadFile}  */
+    WidgetApiImpl.prototype.uploadFile = function (file) {
+        return __awaiter$2(this, void 0, void 0, function () {
+            return __generator$2(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.matrixWidgetApi.uploadFile(file)];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     return WidgetApiImpl;
 }());
 

package/build/index.d.ts

@@ -4,11 +4,13 @@
  */
 
 import { Capability } from 'matrix-widget-api';
+import { IGetMediaConfigActionFromWidgetResponseData } from 'matrix-widget-api';
 import { IModalWidgetCreateData } from 'matrix-widget-api';
 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 { IUploadFileActionFromWidgetResponseData } from 'matrix-widget-api';
 import { IWidget } from 'matrix-widget-api';
 import { IWidgetApiRequest } from 'matrix-widget-api';
 import { IWidgetApiRequestData } from 'matrix-widget-api';
@@ -744,6 +746,18 @@ export declare type WidgetApi = {
             avatarUrl?: string;
         }>;
     }>;
+    /**
+     * Get the config for the media repository.
+     * @returns Promise which resolves with an object containing the config.
+     */
+    getMediaConfig(): Promise<IGetMediaConfigActionFromWidgetResponseData>;
+    /**
+     * Upload a file to the media repository on the homeserver.
+     * @param file - The object to upload. Something that can be sent to
+     *               XMLHttpRequest.send (typically a File).
+     * @returns Resolves to the location of the uploaded file.
+     */
+    uploadFile(file: XMLHttpRequestBodyInit): Promise<IUploadFileActionFromWidgetResponseData>;
 };
 
 /**
@@ -900,6 +914,10 @@ export declare class WidgetApiImpl implements WidgetApi {
             avatarUrl?: string;
         }>;
     }>;
+    /** {@inheritdoc WidgetApi.getMediaConfig}  */
+    getMediaConfig(): Promise<IGetMediaConfigActionFromWidgetResponseData>;
+    /** {@inheritdoc WidgetApi.uploadFile}  */
+    uploadFile(file: XMLHttpRequestBodyInit): Promise<IUploadFileActionFromWidgetResponseData>;
 }
 
 /**
@@ -1001,6 +1019,10 @@ export declare type WidgetParameters = {
      * The current selected language in the client.
      */
     clientLanguage?: string;
+    /**
+     * The homeserver base URL.
+     */
+    baseUrl?: string;
     /**
      * Whether the widget was opened by a client or not.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matrix-widget-toolkit/api",
-  "version": "3.2.2",
+  "version": "3.3.1",
   "description": "A simplified layer on top of matrix-widget-api to use build widgets.",
   "author": "Nordeck IT + Consulting GmbH",
   "license": "Apache-2.0",