init

node_modules/matrix-widget-api/lib/models/Widget.js

@@ -0,0 +1,142 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Widget = void 0;
+var _ = require("..");
+var _utils = require("./validation/utils");
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
+ * 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.
+ */
+/**
+ * Represents the barest form of widget.
+ */
+var Widget = /*#__PURE__*/function () {
+  function Widget(definition) {
+    _classCallCheck(this, Widget);
+    this.definition = definition;
+    if (!this.definition) throw new Error("Definition is required");
+    (0, _utils.assertPresent)(definition, "id");
+    (0, _utils.assertPresent)(definition, "creatorUserId");
+    (0, _utils.assertPresent)(definition, "type");
+    (0, _utils.assertPresent)(definition, "url");
+  }
+
+  /**
+   * The user ID who created the widget.
+   */
+  _createClass(Widget, [{
+    key: "creatorUserId",
+    get: function get() {
+      return this.definition.creatorUserId;
+    }
+
+    /**
+     * The type of widget.
+     */
+  }, {
+    key: "type",
+    get: function get() {
+      return this.definition.type;
+    }
+
+    /**
+     * The ID of the widget.
+     */
+  }, {
+    key: "id",
+    get: function get() {
+      return this.definition.id;
+    }
+
+    /**
+     * The name of the widget, or null if not set.
+     */
+  }, {
+    key: "name",
+    get: function get() {
+      return this.definition.name || null;
+    }
+
+    /**
+     * The title for the widget, or null if not set.
+     */
+  }, {
+    key: "title",
+    get: function get() {
+      return this.rawData.title || null;
+    }
+
+    /**
+     * The templated URL for the widget.
+     */
+  }, {
+    key: "templateUrl",
+    get: function get() {
+      return this.definition.url;
+    }
+
+    /**
+     * The origin for this widget.
+     */
+  }, {
+    key: "origin",
+    get: function get() {
+      return new URL(this.templateUrl).origin;
+    }
+
+    /**
+     * Whether or not the client should wait for the iframe to load. Defaults
+     * to true.
+     */
+  }, {
+    key: "waitForIframeLoad",
+    get: function get() {
+      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.
+     */
+  }, {
+    key: "rawData",
+    get: function get() {
+      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.
+     */
+  }, {
+    key: "getCompleteUrl",
+    value: function getCompleteUrl(params) {
+      return (0, _.runTemplate)(this.templateUrl, this.definition, params);
+    }
+  }]);
+  return Widget;
+}();
+exports.Widget = Widget;
+//# sourceMappingURL=Widget.js.map