1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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);
}
}
|
