diff options
author | RaindropsSys <contact@minteck.org> | 2023-04-24 14:03:36 +0200 |
---|---|---|
committer | RaindropsSys <contact@minteck.org> | 2023-04-24 14:03:36 +0200 |
commit | 633c92eae865e957121e08de634aeee11a8b3992 (patch) | |
tree | 09d881bee1dae0b6eee49db1dfaf0f500240606c /includes/external/matrix/node_modules/matrix-widget-api/src/models/Widget.ts | |
parent | c4657e4509733699c0f26a3c900bab47e915d5a0 (diff) | |
download | pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.tar.gz pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.tar.bz2 pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.zip |
Updated 18 files, added 1692 files and deleted includes/system/compare.inc (automated)
Diffstat (limited to 'includes/external/matrix/node_modules/matrix-widget-api/src/models/Widget.ts')
-rw-r--r-- | includes/external/matrix/node_modules/matrix-widget-api/src/models/Widget.ts | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/includes/external/matrix/node_modules/matrix-widget-api/src/models/Widget.ts b/includes/external/matrix/node_modules/matrix-widget-api/src/models/Widget.ts new file mode 100644 index 0000000..0b66452 --- /dev/null +++ b/includes/external/matrix/node_modules/matrix-widget-api/src/models/Widget.ts @@ -0,0 +1,109 @@ +/* + * Copyright 2020 The Matrix.org Foundation C.I.C. + * + * 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. + */ + +import { IWidget, IWidgetData, WidgetType } from ".."; +import { assertPresent } from "./validation/utils"; +import { ITemplateParams, runTemplate } from ".."; + +/** + * Represents the barest form of widget. + */ +export class Widget { + public constructor(private definition: IWidget) { + if (!this.definition) throw new Error("Definition is required"); + + assertPresent(definition, "id"); + assertPresent(definition, "creatorUserId"); + assertPresent(definition, "type"); + assertPresent(definition, "url"); + } + + /** + * The user ID who created the widget. + */ + public get creatorUserId(): string { + return this.definition.creatorUserId; + } + + /** + * The type of widget. + */ + public get type(): WidgetType { + return this.definition.type; + } + + /** + * The ID of the widget. + */ + public get id(): string { + return this.definition.id; + } + + /** + * The name of the widget, or null if not set. + */ + public get name(): string | null { + return this.definition.name || null; + } + + /** + * The title for the widget, or null if not set. + */ + public get title(): string | null { + return this.rawData.title || null; + } + + /** + * The templated URL for the widget. + */ + public get templateUrl(): string { + return this.definition.url; + } + + /** + * The origin for this widget. + */ + public get origin(): string { + return new URL(this.templateUrl).origin; + } + + /** + * Whether or not the client should wait for the iframe to load. Defaults + * to true. + */ + public get waitForIframeLoad(): boolean { + if (this.definition.waitForIframeLoad === false) return false; + if (this.definition.waitForIframeLoad === true) return true; + return true; // default true + } + + /** + * The raw data for the widget. This will always be defined, though + * may be empty. + */ + public get rawData(): IWidgetData { + return this.definition.data || {}; + } + + /** + * Gets a complete widget URL for the client to render. + * @param {ITemplateParams} params The template parameters. + * @returns {string} A templated URL. + */ + public getCompleteUrl(params: ITemplateParams): string { + return runTemplate(this.templateUrl, this.definition, params); + } +} |