Merge pull request #3 from oxixes/mac-v2

Handle v2 widgets
Wirecloud · Mar 14, 2024 · 42adeeb · 42adeeb
2 parents c56acc0 + 781d9d1
commit 42adeeb
Show file tree

Hide file tree

Showing 11 changed files with 57 additions and 58 deletions.
diff --git a/root/Gruntfile.js b/root/Gruntfile.js
@@ -6,7 +6,6 @@
  * Licensed under the {%= licenses.join(', ') %} license{%= licenses.length === 1 ? '' : 's' %}.
  */
 
-const { json } = require('stream/consumers');
 var ConfigParser = require('wirecloud-config-parser');
 var parser = new ConfigParser('src/{% if (json) { %}config.json{% } else { %}config.xml{% } %}');
 
@@ -109,7 +108,7 @@ module.exports = function (grunt) {
                             'index.html',{% if (!js) { %}
                             "ts/**/*",{% }%}{% if (json) { %}
                             "config.json",{% } else { %}
-                            "config.xml", {% } %}
+                            "config.xml",{% } %}
                         ]
                     },
                     {

diff --git a/root/src/config.json b/root/src/config.json
@@ -5,6 +5,7 @@
             "name": "{%= author_name %}"
         }
     ],
+    "macversion": 2,
     "changelog": "doc/changelog.md",
     "contents": {
         "cacheable": true,
@@ -33,6 +34,10 @@
         }
         {% } %}
     ],
+    "js_files": [
+        "js/{%= jsname %}.js"
+    ],
+    "entrypoint": "js/{%= entrypoint %}.js",
     "title": "{%= project_name %}",
     "translations": {},
     "type": "widget",

diff --git a/root/src/config.xml b/root/src/config.xml
@@ -1,6 +1,8 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <widget xmlns="http://wirecloud.conwet.fi.upm.es/ns/macdescription/1" vendor="{%= vendor %}" name="{%= name %}" version="{%= version %}">
 
+    <macversion>2</macversion>
+
     <details>
         <title>{%= project_name %}</title>
         <homepage>{%= homepage %}</homepage>
@@ -27,6 +29,10 @@
     </wiring>
 
     <contents src="index.html"/>
+    <scripts>
+        <script src="js/{%= jsname %}.js"/>
+    </scripts>
+    <entrypoint name="{%= entrypoint %}"/>
     <rendering height="300px" width="30%"/>
 
 </widget>
diff --git a/root/src/index.html b/root/src/index.html
@@ -1,15 +1,3 @@
-<!DOCTYPE html>
-<html>
-    <head>
-        <meta charset="utf-8" />
-        <link rel="stylesheet" type="text/css" href="css/styles.css" />
-        <title>Empty {%= name %} widget</title>
-    </head>
-    <body>
+<link rel="stylesheet" type="text/css" href="css/styles.css" />
 
-        <div>Empty {%= name %} widget</div>
-
-        <script src="js/{%= jsname %}.js"></script>
-        <script src="js/main.js"></script>
-    </body>
-</html>
+<div>Empty {%= name %} widget</div>
diff --git a/root/src/js/main.js b/root/src/js/main.js
diff --git a/root/src/js/name.js b/root/src/js/name.js
@@ -6,32 +6,32 @@
  * Licensed under the {%= licenses.join(', ') %} license{%= licenses.length === 1 ? '' : 's' %}.
  */
 
-/* exported {%= jsname %} */
+/* exported {%= entrypoint %} */
 
-var {%= jsname %} = (function () {
+(function () {
 
     "use strict";
 
     // =========================================================================
     // CLASS DEFINITION
     // =========================================================================
 
-    var {%= jsname %} = function {%= jsname %}() {
-        MashupPlatform.prefs.registerCallback(function (new_preferences) {
+    class {%= entrypoint %} {
+        constructor(MashupPlatform, shadowDOM, extra) {
+            this.MashupPlatform = MashupPlatform;
+            this.shadowDOM = shadowDOM;
 
-        }.bind(this));
-    };
+            MashupPlatform.prefs.registerCallback(function (new_preferences) {
 
-    // =========================================================================
-    // PRIVATE MEMBERS
-    // =========================================================================
+            }.bind(this));
+        }
+    }
+
+    // We define the class as part of the window object so that it can be instantiated by Wirecloud
+    window.{%= entrypoint %} = {%= entrypoint %};
 
     /* test-code */
-    {%= jsname %}.prototype = {
-    };
 
     /* end-test-code */
 
-    return {%= jsname %};
-
 })();
diff --git a/root/src/ts/main.ts b/root/src/ts/main.ts
diff --git a/root/src/ts/name.ts b/root/src/ts/name.ts
@@ -9,8 +9,23 @@ import MashupPlatform = require("MashupPlatform");
 {% if (ngsi) { %}import NGSI = require("NGSI");{% }%}
 /* end-import-block */
 
-export class {%= jsname %} {
+export class {%= entrypoint %} {
+    private MashupPlatform: MashupPlatform;
+    private shadowDOM: any;
+    {% if (ngsi) { %}private NGSI: NGSI;{% }%}
+
+    constructor(MashupPlatform: MashupPlatform, shadowDOM: any, extra: any) {
+        this.MashupPlatform = MashupPlatform;
+        this.shadowDOM = shadowDOM;
+        {% if (ngsi) { %}this.NGSI = NGSI;{% }%}
+
+        this.init();
+    }
+
     init() {
         console.log("Loaded!!");
     }
 }
+
+// We define the class as part of the window object so that it can be instantiated by Wirecloud
+(<any>window)["{%= entrypoint %}"] = {%= entrypoint %};
diff --git a/root/tests/js/nameSpec.js b/root/tests/js/nameSpec.js
@@ -6,7 +6,7 @@
  * Licensed under the {%= licenses.join(', ') %} license{%= licenses.length === 1 ? '' : 's' %}.
  */
 
-/* globals $, MashupPlatform, MockMP, {%= jsname %} */
+/* globals $, MashupPlatform, MockMP, {%= entrypoint %} */
 
 (function () {
 
@@ -15,16 +15,17 @@
     describe("{%= jsname %}", function () {
 
         var widget;
+        var MashupPlatform;
 
         beforeAll(function () {
-            window.MashupPlatform = new MockMP({
+            MashupPlatform = new MockMP({
                 type: 'widget'
             });
         });
 
         beforeEach(function () {
             MashupPlatform.reset();
-            widget = new {%= jsname %}();
+            widget = new {%= entrypoint %}(MashupPlatform, undefined, {});
         });
 
         it("Dummy test", function () {

diff --git a/root/typings/MashupPlatform/MashupPlatform.d.ts b/root/typings/MashupPlatform/MashupPlatform.d.ts
@@ -115,4 +115,6 @@ declare module "MashupPlatform" {
     interface onExceptionCB {
         (response: Object, exception: Error): void;
     }
+
+    var location: string;
 }
diff --git a/template.js b/template.js
@@ -51,6 +51,13 @@ var capitalizeAndRemoveUnderscore = function capitalizeAndRemoveUnderscore(old)
     return t.charAt(0).toUpperCase() + t.slice(1);
 };
 
+var getEntrypointName = function getEntrypointName(vendor, name) {
+    // Remove all non-alphanumeric characters. Replace spaces with underscores.
+    vendor = vendor.replace(/[^a-zA-Z0-9]/g, '').replace(/\s/g, '_');
+    name = name.replace(/[^a-zA-Z0-9]/g, '').replace(/\s/g, '_');
+    return vendor + '_' + name;
+}
+
 // The actual init template.
 exports.template = function(grunt, init, done) {
     init.process([
@@ -123,6 +130,7 @@ exports.template = function(grunt, init, done) {
     ], function(err, props){
         var exportsOverride = {};
         props.jsname = capitalizeAndRemoveUnderscore(props.name);
+        props.entrypoint = getEntrypointName(props.vendor, props.name);
         props.bower = true; // Change way to determine bower?
         props.ngsi = false; // ??
         var bowerdeps = {};