@avs/go 0.13.71891 → 0.14.71999

package/src/avs-go-dynamic-html.js

@@ -18,126 +18,134 @@
  * Advanced Visual Systems Inc. (http://www.avs.com)
  */
 
-import {PolymerElement, html} from '@polymer/polymer/polymer-element.js';
-import '@polymer/polymer/lib/elements/dom-repeat.js';
-import {afterNextRender} from '@polymer/polymer/lib/utils/render-status.js';
-import {AvsHttpMixin} from './avs-http-mixin.js';
-import {AvsDataSourceMixin} from './avs-data-source-mixin.js';
+import { AvsElementBase } from './avs-element-base.js';
+import { html } from 'lit';
+import { unsafeHTML } from 'lit/directives/unsafe-html.js';
+import DOMPurify from 'dompurify';
 
 /**
- * `avs-go-dynamic-html` is a Polymer 3.0 element which requests HTML by instancing
+ * `avs-go-dynamic-html` is a Lit element which requests HTML by instancing
  * the `dynamicHtmlName` class on the AVS/Go server application running at `url`.
  * The HTML response is inserted into this element's shadow DOM.
  *
  * @customElement
- * @polymer
- * @appliesMixin AvsHttpMixin
- * @appliesMixin AvsDataSourceMixin
+ * @lit
  */
-export class AvsGoDynamicHtml extends AvsDataSourceMixin(AvsHttpMixin(PolymerElement)) {
+export class AvsGoDynamicHtml extends AvsElementBase {
+  static properties = {
+    /**
+     * The URL to an instance of AVS/Go server application.
+     */
+    url: {
+      type: String
+    },
 
-  static get template() {
-    return html`
-      <template is="dom-repeat" items="{{linkCss}}">
-        <link rel="stylesheet" href="[[item]]">
-      </template>
-      <style>
-        #htmlDiv {
-          width: 100%;
-          height: 100%;
-          position: relative;
-        }   
-      </style>
-      <div id="htmlDiv"></div>
-    `;
-  }
+    /**
+     * Name of the data source registered in the library map on the server.
+     */
+    dataSourceName: {
+      type: String,
+      attribute: 'data-source-name'
+    },
 
-  static get properties() {
-    return {
-      /**
-       * The URL to an instance of AVS/Go server application.
-       */
-      url: {
-        type: String
-      },
-      /**
-       * An array of strings specifying CSS files for use in the dynamic html.
-       */
-      linkCss: {
-        type: Array,
-        value: function () {
-          return [];
-        }
-      },
-      /**
-       * The name of the dynamic html registered in the library map on the server.
-       */
-      dynamicHtmlName: {
-        type: String
-      },
-      /**
-       * User properties passed directly to the server.
-       */
-      dynamicHtmlUserProperties: {
-        type: Object,
-        value: {}
-      }
-    }
-  }
+    /**
+     * User properties as JSON passed directly to the data source on the server.
+     */
+    dataSourceUserProperties: {
+      type: String,
+      attribute: 'data-source-user-properties'
+    },
 
-  /**
-   * Assemble the model from our properties to send to the server.
-   */
-  _assembleModel() {
-    if (this.dynamicHtmlName === undefined) {
-      this._logError( JSON.stringify( {"GoType":1, "error":"\'dynamic-html-name\' property must be set to the name of the dynamic html registered in the library map on the server."} ) );
-      return undefined;
-    }
+    /**
+     * The name of the dynamic html registered in the library map on the server.
+     */
+    dynamicHtmlName: {
+      type: String,
+      attribute: 'dynamic-html-name'
+    },
 
-    var model = {dynamicHtmlProperties:{}};
+    /**
+     * User properties as JSON passed directly to the dynamic html on the server.
+     */
+    dynamicHtmlUserProperties: {
+      type: String,
+      attribute: 'dynamic-html-user-properties'
+    },
 
-    model.dynamicHtmlProperties.name = this.dynamicHtmlName;
-    if (this.dynamicHtmlUserProperties !== undefined) {
-      model.dynamicHtmlProperties.userProperties = this.dynamicHtmlUserProperties;
+    _html: {
+      state: true
     }
-    
-    this._addDataSourceProperties(model);
-
-    return model;
   }
 
-  /**
-   * HTTP error handler.
-   * @param event
-   */
-  _handleHttpError(event) {
-
+  render() {
+    return html`${unsafeHTML(this._html)}`;
   }
 
-  /**
-   * HTTP response handler.
-   * @param json JSON parsed from HTTP response.
-   */
-  _handleHttpResponse(json) {
-	if (json.html !== undefined) {
-	  this.$.htmlDiv.innerHTML = decodeURIComponent(json.html.replace(/\+/g, '%20'));
-	}
-  }
+  willUpdate(changedProperties) {
+    if (!this.url) {
+      if (changedProperties.has('url')) {
+        this._dispatchErrorEvent("'url' property must be set to an instance of AVS/Go server.");
+      }
+      return;
+    }
+    if (!this.dynamicHtmlName) {
+      if (changedProperties.has('dynamicHtmlName')) {
+        this._dispatchErrorEvent("'dynamic-html-name' property must be set to the name of the dynamicHtml registered in the library map on the AVS/Go server.");
+      }
+      return;
+    }
 
-  /**
-   * 
-   */
-  connectedCallback() {
-    super.connectedCallback();
+    // Assemble the model
+    const model = {
+      dynamicHtmlProperties: {
+        name: this.dynamicHtmlName
+      }
+    };
+    if (this.dynamicHtmlUserProperties) {
+      let dynamicHtmlUserProperties;
+      try {
+        dynamicHtmlUserProperties = JSON.parse(this.dynamicHtmlUserProperties);
+      }
+      catch (error) {
+        this._dispatchErrorEvent("Can't parse 'dynamic-html-user-properties'. " + error.message);
+        return;
+      }
+      model.dynamicHtmlProperties.userProperties = dynamicHtmlUserProperties;
+    }
 
-    // Make sure all CSS and layout has been processed 
-    afterNextRender(this, function() {
-      if (this.__initialized != true) {
-        this._httpRequest(this.url, this._handleHttpResponse.bind(this), undefined, this._handleHttpError.bind(this), this._assembleModel());
-        this.__initialized = true;
+    // Data source properties
+    if (this.dataSourceName) {
+      model.dataSourceProperties = {
+        name: this.dataSourceName
+      }
+      if (this.dataSourceUserProperties) {
+        let dataSourceUserProperties;
+        try {
+          dataSourceUserProperties = JSON.parse(this.dataSourceUserProperties);
+        }
+        catch (error) {
+          this._dispatchErrorEvent("Can't parse 'data-source-user-properties'. " + error.message);
+          return;
+        }
+        model.dataSourceProperties.userProperties = dataSourceUserProperties;
       }
-    }); 
+    }
+
+    // Send the request
+    this._httpRequest(this.url,
+      (response) => {
+        if (response.html) {
+          const html = decodeURIComponent(response.html.replace(/\+/g, '%20'));
+          this._html = DOMPurify.sanitize(html);
+        }
+        else {
+          this._dispatchErrorEvent("Empty response from AVS/Go server.");
+        }
+      },
+      null,
+      model
+    );
   }
 }
 
-window.customElements.define('avs-go-dynamic-html', AvsGoDynamicHtml);
+customElements.define('avs-go-dynamic-html', AvsGoDynamicHtml);

package/src/avs-go-info.js

@@ -18,107 +18,135 @@
  * Advanced Visual Systems Inc. (http://www.avs.com)
  */
 
-import {PolymerElement} from '@polymer/polymer/polymer-element.js';
-import {AvsHttpMixin} from './avs-http-mixin.js';
-import {AvsDataSourceMixin} from './avs-data-source-mixin.js';
+import { AvsElementBase } from './avs-element-base.js';
 
 /**
- * `avs-go-info` is a Polymer 3.0 element which requests JSON data by instancing
+ * `avs-go-info` is a Lit element which requests data by instancing
  * the `infoName` class on the AVS/Go server application running at `url`.
  * After setting both these properties call the `updateInfo()` method to send the request.
- * Attach a listener for the `avs-go-info-response` event to receive the JSON response.
+ * Attach a listener for the `avs-go-info-response` event to receive the response.
  *
  * Special case: use an `infoName` of `GetServerInfo` to request a listing of
  * data sources, themes, scenes, info and dynamic HTML available at `url`.
  *
  * @customElement
- * @polymer
- * @appliesMixin AvsHttpMixin
- * @appliesMixin AvsDataSourceMixin
+ * @lit
  */
-export class AvsGoInfo extends AvsDataSourceMixin(AvsHttpMixin(PolymerElement)) {
+export class AvsGoInfo extends AvsElementBase {
+  static properties = {
+    /**
+     * The URL to an instance of AVS/Go server application.
+     */
+    url: {
+      type: String
+    },
 
-  static get properties() {
-    return {
-      /**
-       * The URL to an instance of AVS/Go server application.
-       */
-      url: {
-        type: String
-      },
-      /**
-       * The name of the info registered in the library map on the server.
-       */
-      infoName: {
-        type: String
-      },
-      /**
-       * User properties passed directly to the server.
-       */
-      infoUserProperties: {
-        type: Object,
-        value: {}
-      }
+    /**
+     * Name of the data source registered in the library map on the server.
+     */
+    dataSourceName: {
+      type: String,
+      attribute: 'data-source-name'
+    },
+
+    /**
+     * User properties as JSON passed directly to the data source on the server.
+     */
+    dataSourceUserProperties: {
+      type: String,
+      attribute: 'data-source-user-properties'
+    },
+
+    /**
+     * The name of the info registered in the library map on the server.
+     */
+    infoName: {
+      type: String,
+      attribute: 'info-name'
+    },
+
+    /**
+     * User properties as JSON passed directly to the info on the server.
+     */
+    infoUserProperties: {
+      type: String,
+      attribute: 'info-user-properties'
     }
   }
-
     
   /**
    * Send the request to the server.
    */
   updateInfo() {
-    // Use avs-http-mixin to send the model to the server
-    var model = this._assembleModel();
-    if (model !== undefined) {
-      this._httpRequest(this.url, this._handleHttpResponse.bind(this), undefined, this._handleHttpError.bind(this), model);
+    if (!this.url) {
+      this._dispatchErrorEvent("'url' property must be set to an instance of AVS/Go server.");
+      return;
     }
-  }
-
-  /**
-   * Assemble the model from our properties to send to the server.
-   */
-  _assembleModel() {
-    if (this.infoName === undefined) {
-      this._logError( JSON.stringify( {"GoType":1, "error":"\'info-name\' property must be set to the name of the info registered in the library map on the server."} ) );
-      return undefined;
+    if (!this.infoName) {
+      this._dispatchErrorEvent("'info-name' property must be set to the name of the info registered in the library map on the AVS/Go server.");
+      return;
     }
 
-    var model = {infoProperties:{}};
-
-    model.infoProperties.name = this.infoName;
-    if (this.infoUserProperties !== undefined) {
-      model.infoProperties.userProperties = this.infoUserProperties;
+    // Assemble the model
+    const model = {
+      infoProperties: {
+        name: this.infoName
+      }
+    };
+    if (this.infoUserProperties) {
+      let infoUserProperties;
+      try {
+        infoUserProperties = JSON.parse(this.infoUserProperties);
+      }
+      catch (error) {
+        this._dispatchErrorEvent("Can't parse 'info-user-properties'. " + error.message);
+        return;
+      }
+      model.infoProperties.userProperties = infoUserProperties;
     }
-    
-    this._addDataSourceProperties(model);
-
-    return model;
-  }
-
-  /**
-   * HTTP error handler.
-   * @param event
-   */
-  _handleHttpError(event) {
 
-  }
+    // Data source properties
+    if (this.dataSourceName) {
+      model.dataSourceProperties = {
+        name: this.dataSourceName
+      }
+      if (this.dataSourceUserProperties) {
+        let dataSourceUserProperties;
+        try {
+          dataSourceUserProperties = JSON.parse(this.dataSourceUserProperties);
+        }
+        catch (error) {
+          this._dispatchErrorEvent("Can't parse 'data-source-user-properties'. " + error.message);
+          return;
+        }
+        model.dataSourceProperties.userProperties = dataSourceUserProperties;
+      }
+    }
 
-  /**
-   * HTTP response handler.
-   * @param json JSON parsed from HTTP response.
-   */
-  _handleHttpResponse(json) {
-	if (json.info !== undefined) {
-	  var infoJSON = JSON.parse(decodeURIComponent(json.info.replace(/\+/g, '%20')));
-	  var infoEvent = {detail: infoJSON};
+    // Send the request
+    this._httpRequest(this.url,
+      (response) => {
+        if (response.info) {
+          const info = JSON.parse(decodeURIComponent(response.info.replace(/\+/g, '%20')));
 
-      /**
-       * JSON response from server.
-       * @event avs-go-info-response
-       */
-	  this.dispatchEvent(new CustomEvent('avs-go-info-response', infoEvent));
-	}
+          /**
+           * Info response from server.
+           * @event avs-go-info-response
+           */
+          this.dispatchEvent(new CustomEvent('avs-go-info-response', {
+            bubbles: true,
+            composed: true,
+            detail: info
+          }));
+        }
+        else {
+          this._dispatchErrorEvent("Empty response from AVS/Go server.");
+        }
+      },
+      null,
+      model
+    );
   }
 }
 
-window.customElements.define('avs-go-info', AvsGoInfo);
+customElements.define('avs-go-info', AvsGoInfo);

package/src/avs-go.js

@@ -0,0 +1,23 @@
+/**
+ * @license
+ * Copyright 2018 Advanced Visual Systems Inc.
+ * 
+ * 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.
+ * 
+ * This product includes software developed at
+ * Advanced Visual Systems Inc. (http://www.avs.com)
+ */
+
+import { AvsGoDataViz } from './avs-go-dataviz.js'
+import { AvsGoInfo } from './avs-go-info.js'
+import { AvsGoDynamicHtml } from './avs-go-dynamic-html.js'

package/src/constants.js

@@ -18,4 +18,4 @@
  * Advanced Visual Systems Inc. (http://www.avs.com)
  */
 
-export var VERSION = '0.13.71891';
+export var VERSION = '0.14.71999';

package/src/avs-data-source-mixin.js

@@ -1,61 +0,0 @@
-/**
- * @license
- * Copyright 2018 Advanced Visual Systems Inc.
- * 
- * 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.
- * 
- * This product includes software developed at
- * Advanced Visual Systems Inc. (http://www.avs.com)
- */
-
-import {dedupingMixin} from '@polymer/polymer/lib/utils/mixin.js';
-
-/**
- * Mixin to add data source properties functionality.
- *
- * @polymer
- * @mixinFunction
- */
-export const AvsDataSourceMixin = dedupingMixin((superClass) => class extends superClass {
-
-  static get properties() {
-    return {
-      /**
-       * Name of the data source registered in the library map on the server.
-       */
-      dataSourceName: {
-        type: String
-      },
-      /**
-       * User properties for the data source passed directly to the server.
-       */
-      dataSourceUserProperties: {
-        type: Object,
-        value: {}
-      }
-    }
-  }
-
-  /**
-   * Add data-source-name and data-source-user-properties to model.
-   * @param model Model to add to.
-   */
-  _addDataSourceProperties(model) {
-    if (this.dataSourceName !== undefined) {
-      model.dataSourceProperties = {"name":this.dataSourceName};
-      if (this.dataSourceUserProperties !== undefined) {
-        model.dataSourceProperties.userProperties = this.dataSourceUserProperties;
-      }
-    }
-  }
-});