Merge pull request #534 from oxixes/mac-v2

Add v2-web components based widgets and get rid of iframes in operators.

.github/workflows/tests.yml

@@ -93,7 +93,7 @@ jobs:
           pip install -r requirements.txt
           pip install -r requirements-dev.txt
           python manage.py collectstatic -v 0 -c --noinput
-          coverage run -a --branch --source wirecloud --omit="*/wirecloud/semanticwiring/*,*/wirecloud/guidebuilder/*,*/tests/*,*/tests.py" manage.py test --noinput --nologcapture -v 2 -a tags='wirecloud-noselenium'
+          coverage run -a --branch --source wirecloud --omit="*/wirecloud/semanticwiring/*,*/wirecloud/guidebuilder/*,*/tests/*,*/tests.py,*/wirecloud/commons/utils/remote.py" manage.py test --noinput --nologcapture -v 2 -a tags='wirecloud-noselenium'
       - name: Coveralls Parallel
         uses: AndreMiras/coveralls-python-action@develop
         with:
@@ -170,7 +170,7 @@ jobs:
   django-selenium-tests:
 
     runs-on: ubuntu-20.04
-    
+
     steps:
       - name: Setup PostgreSQL
         run: |
@@ -216,9 +216,9 @@ jobs:
       - django-search-indexes-tests
       - django-selenium-tests
       - js-unit-tests
-    
+
     runs-on: ubuntu-20.04
-    
+
     steps:
       - name: Coveralls Finished
         uses: coverallsapp/github-action@master

docs.ja/development/macdl_rdf.md

@@ -35,8 +35,8 @@ Application Mashup GE は、MAC 情報を RDF として表現する手段を提
 
 -   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/widget#Widget`
 
--   **Properties include**: `dcterms:title`, `dcterms:description`, `dcterms:creator`, `usdl:hasProvider`, 
-    `usdl:utilizedResource`, `foaf:page`, `wire:hasPlatformPreference`, `wire:hasPlatformWiring`,
+-   **Properties include**: `wire:macVersion`, `dcterms:title`, `dcterms:description`, `dcterms:creator`, 
+    `usdl:hasProvider`, `usdl:utilizedResource`, `foaf:page`, `wire:hasPlatformPreference`, `wire:hasPlatformWiring`,
     `wire:hasPlatformRendering`, `wire:hasPlatformStateProperty`, `usdl:versionInfo`, `wire:hasImageUri`,
     `wire.hasiPhoneImageUri`, `wire:displayName`, `vcard:addr`
 
@@ -49,8 +49,8 @@ Application Mashup GE は、MAC 情報を RDF として表現する手段を提
 
 -   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/widget#Operator`
 
--   **Properties include**: `dcterms:title`, `dcterms:description`, `dcterms:creator`, `usdl:hasProvider`,
-    `usdl:utilizedResource`, `foaf: page`, `wire:hasPlatformPreference`, `wire:hasPlatformWiring`,
+-   **Properties include**: `wire:macVersion`, `dcterms:title`, `dcterms:description`, `dcterms:creator`,     
+    `usdl:hasProvider`, `usdl:utilizedResource`, `foaf: page`, `wire:hasPlatformPreference`, `wire:hasPlatformWiring`,
     `wire:hasPlatformRendering`, `wire:hasPlatformStateProperty`, `usdl:versionInfo`, `wire:hasImageUri`,
     `wire.hasiPhoneImageUri`, `wire:displayName`, `vcard:addr`
 
@@ -140,6 +140,13 @@ Application Mashup GE は、MAC 情報を RDF として表現する手段を提
 
 ### プロパティ
 
+#### `wire:macVersion` プロパティ
+
+このプロパティは、ウィジェットまたはオペレータを記述するために使用されるMACDLのバージョンを示す。 現在、サポートされているのはの値は`1`である。 このプロパティは必須ではないが、使用すべきである。 このプロパティがない場合、バージョン`1`はを想定している。
+
+-   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/Widget#macVersion`
+-   **Domain**: `wire:Widget` と `wire:Operator`
+-   **Range**: `rdfs:Literal`
 
 #### `wire:hasPlatformPreference` プロパティ
 
@@ -340,7 +347,7 @@ Application Mashup GE は、MAC 情報を RDF として表現する手段を提
 
 -   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/mashup#Mashup`
 
--   **Properties include**: `wire-m:hasMashupPreference`, `wire-m:hasMashupParam`, `wire-m:hasTab`,
+-   **Properties include**: `wire:macVersion`, `wire-m:hasMashupPreference`, `wire-m:hasMashupParam`, `wire-m:hasTab`,
     `wire-m:hasMashupWiring`, `wire:hasImageUri`, `wire:hasiPhoneImageUri`, `wire:version`
 
 -   **subClassOf**: `usdl:CompositeService`

docs.ja/development/macdl_xml.md

@@ -26,6 +26,12 @@
 
 ## 共通のメタデータ
 
+### `macversion` 要素
+
+`macversion`要素はMACが使用するApplication Mashup GE仕様のバージョンを宣言するために使用される。 この要素は、Application Mashup GE仕様の古いバージョンと互換性を保つために必須では ないが、すべての新しいMACsに含めるべきである。
+
+現在、この要素でサポートされている値は`1`だけである。 この要素がない場合、値`1`が仮定される。
+
 ### `details` 要素
 
 ![](../../docs/images/mac_description_details_element.png)

docs/development/macdl_rdf.md

@@ -34,10 +34,8 @@ This class represents a widget. This is, jointly with `wire:Operator`, one of th
 
 -   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/widget#Widget`
 
--   **Properties include**: `dcterms:title`, `dcterms:description`, `dcterms:creator`, `usdl:hasProvider`,
-    `usdl:utilizedResource`, `foaf:page`, `wire:hasPlatformPreference`, `wire:hasPlatformWiring`,
-    `wire:hasPlatformRendering`, `wire:hasPlatformStateProperty`, `usdl:versionInfo`, `wire:hasImageUri`,
-    `wire.hasiPhoneImageUri`, `wire:displayName`, `vcard:addr`
+-   **Properties include**: `wire:macVersion`, `dcterms:title`, `dcterms:description`, `dcterms:creator`, 
+    `usdl:hasProvider`, `usdl:utilizedResource`, `wire:entryPoint`, `foaf:page`, `wire:hasPlatformPreference`, `wire:hasPlatformWiring`, `wire:hasPlatformRendering`, `wire:hasPlatformStateProperty`, `usdl:versionInfo`, `wire:hasImageUri`, `wire.hasiPhoneImageUri`, `wire:displayName`, `vcard:addr`
 
 -   **Subclassof**: `usdl-core:Service`
 
@@ -47,10 +45,8 @@ This class represents a operator. This is, jointly with `wire:Widget`, one of th
 
 -   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/widget#Operator`
 
--   **Properties include**: `dcterms:title`, `dcterms:description`, `dcterms:creator`, `usdl:hasProvider`,
-    `usdl:utilizedResource`, `foaf: page`, `wire:hasPlatformPreference`, `wire:hasPlatformWiring`,
-    `wire:hasPlatformRendering`, `wire:hasPlatformStateProperty`, `usdl:versionInfo`, `wire:hasImageUri`,
-    `wire.hasiPhoneImageUri`, `wire:displayName`, `vcard:addr`
+-   **Properties include**: `wire:macVersion`, `dcterms:title`, `dcterms:description`, `dcterms:creator`, 
+    `usdl:hasProvider`, `usdl:utilizedResource`, `wire:entryPoint`, `foaf:page`, `wire:hasPlatformPreference`, `wire:hasPlatformWiring`, `wire:hasPlatformRendering`, `wire:hasPlatformStateProperty`, `usdl:versionInfo`, `wire:hasImageUri`, `wire.hasiPhoneImageUri`, `wire:displayName`, `vcard:addr`
 
 -   **Subclassof**: `usdl-core:Service`
 
@@ -130,6 +126,16 @@ This class represents an input endpoint.
 
 ### Properties
 
+#### The `wire:macVersion` property
+
+This property states the version of the MACDL used to describe the widget or operator. Currently, the only supported
+value is `1`. This property is NOT mandatory but SHOULD be used. In absence of this property, the version `1` is
+assumed.
+
+-   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/Widget#macVersion`
+-   **Domain**: `wire:Widget` and `wire:Operator`
+-   **Range**: `rdfs:Literal`
+
 #### The `wire:hasPlatformPreference` property
 
 This property states a user widget preference.
@@ -285,6 +291,15 @@ This property states whether or not the widget code is cacheable.
 -   **Domain**: `usdl-core:Resource`
 -   **Range**: `rdfs:Literal`
 
+#### The `wire:entryPoint` property
+
+v2 widgets and operators need to define the entry point of the component. This property states the entry point of the
+widget or operator. The entrypoint is the name of a class that the MAC scripts will define in the `window` object that will be instantiated whenever the MAC is loaded, receiving as parameters the objects neccessary for the MAC to work correctly ([more info here](./widget_and_operators.md)). Therefore, it must be unique in the global scope.
+
+-   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/Widget#entryPoint`
+-   **Domain**: `wire:Widget` and `wire:Operator`
+-   **Range**: `rdfs:Literal`
+
 ## WIRE-M vocabulary
 
 The diagram below shows the WIRE-M vocabulary.
@@ -304,7 +319,7 @@ This class represents a mashup. It will be implemented as a workspace.
 
 -   **URI**: `http://wirecloud.conwet.fi.upm.es/ns/mashup#Mashup`
 
--   **Properties include**: `wire-m:hasMashupPreference`, `wire-m:hasMashupParam`, `wire-m:hasTab`,
+-   **Properties include**: `wire:macVersion`, `wire-m:hasMashupPreference`, `wire-m:hasMashupParam`, `wire-m:hasTab`,
     `wire-m:hasMashupWiring`, `wire:hasImageUri`, `wire:hasiPhoneImageUri`, `wire:version`
 
 -   **subClassOf**: `usdl:CompositeService`

docs/development/macdl_xml.md

@@ -26,6 +26,14 @@ operators, ...).
 
 ## Common metadata
 
+### macversion element
+
+The `macversion` element is used for declaring the version of the Application Mashup GE specification used by the
+mashable application component. This element is NOT required in order to be compatible with older versions of the
+Application Mashup GE specification, but it SHOULD be included in all new mashable application components.
+
+Currently, the only supported values for this element are `1` and `2`. In absence of this element, the value `1` is assumed.
+
 ### details element
 
 ![](../images/mac_description_details_element.png)
@@ -234,13 +242,17 @@ operator descriptions):
 
 ### The `scripts` element
 
-While in widgets define it code entry point, in general, through an HTML file, operators, as they do not provide an user
-interface, need to declare directly the list of javascript files to use. This script list is declared using the
-`scripts` element that is composed of one or more `script` sub-elements. `script` elements supports the following
+Widgets (v2 onwards) and operators need to define the list of scripts they need to use, so that they are included when loading the MAC. This script list is declared using the `scripts` element that is composed of one or more `script` sub-elements. `script` elements supports the following
 attributes:
 
 -   `src`: description-file-relative URL of the JavaScript file.
 
+### The `entrypoint` element
+
+v2 widgets and operators need to define the entry point of the component. This is done using the `entrypoint` element.
+The entrypoint is the name of a class that the MAC scripts will define in the `window` object that will be instantiated whenever the MAC is loaded, receiving as parameters the objects neccessary for the MAC to work correctly ([more info here](./widget_and_operators.md)). Therefore, it must be unique in the global scope. The `entrypoint` element supports the following attributes:
+-  `name`: name of the entrypoint class.
+
 ## Specific Mashup metadata
 
 The figure below depicts the structure followed by `mashup` elements (and therefore, the structure followed by mashup

docs/development/widget_and_operators.md

@@ -46,8 +46,15 @@ figure shows one possible structure of files for a widget:
 > `config.xml` file MUST be at the root of the zip file.
 
 Operators are created in the same way as widgets, the only difference is that the descriptor file (`config.xml`) does
-not link to an initial HTML document (as operators doesn't have a visual component). Instead, you will have to link the
-list of used JavaScript files from the `config.xml` file.
+not link to an initial HTML document (as operators don't have a visual component).
+
+Both widgets and operators need to specify a list of scripts that will be executed when the widget/operator is loaded.
+These scripts must define a class in the window object that will be instantiated by the WireCloud platform. This class
+receives 3 parameters in the case of widgets and 2 in the case of operators:
+    -  The first parameter is the MashupPlatform object.
+    -  The second parameter is a reference to a shadowDOM that contains the widget code (not present on operators).
+    -  The third parameter is an object containing any extra objects as defined by the descriptor file (such as
+       the NGSI API, the ContextManager API...).
 
 Operators can be classified using three types:
 

docs/widgetapi/widgetapi.md

@@ -57,6 +57,10 @@ This specification is licensed under the
 
 ## Widget API
 
+### MashupPlatform.location
+
+Allows to retrieve the current loaded location of the widget/operator.
+
 ### MashupPlatform.http
 
 This module provides some methods for handling HTTP requests including support for using the cross domain proxy.

src/GruntFile.js

@@ -138,6 +138,7 @@ var WirecloudFiles = [
     'wirecloud/platform/static/js/wirecloud/ui/WidgetViewDraggable.js',
     'wirecloud/platform/static/js/wirecloud/ui/WidgetViewResizeHandle.js',
     'wirecloud/platform/static/js/wirecloud/ui/WidgetView.js',
+    'wirecloud/platform/static/js/wirecloud/ui/WidgetElement.js',
     'wirecloud/platform/static/js/wirecloud/ui/WidgetViewMenuItems.js',
     'wirecloud/platform/static/js/wirecloud/ui/WiringEditor.js',
     'wirecloud/platform/static/js/wirecloud/ui/WiringEditor/Behaviour.js',
@@ -171,6 +172,18 @@ var WirecloudFiles = [
     'wirecloud/platform/static/js/wirecloud/wiring/Connection.js'
 ];
 
+var WirecloudAPIFiles = [
+    'wirecloud/platform/static/js/WirecloudAPI/WirecloudAPIBootstrap.js',
+    'wirecloud/platform/static/js/WirecloudAPI/WirecloudWidgetAPI.js',
+    'wirecloud/platform/static/js/WirecloudAPI/WirecloudOperatorAPI.js',
+    'wirecloud/platform/static/js/WirecloudAPI/WirecloudAPICommon.js',
+    'wirecloud/platform/static/js/WirecloudAPI/StyledElements.js',
+    'wirecloud/platform/static/js/WirecloudAPI/ComponentManagementAPI.js',
+    'wirecloud/platform/static/js/WirecloudAPI/DashboardManagementAPI.js',
+    'wirecloud/platform/static/js/WirecloudAPI/WirecloudAPIClosure.js',
+    'wirecloud/platform/static/js/WirecloudAPI/WirecloudAPIV2Bootstrap.js'
+];
+
 module.exports = function (grunt) {
 
     'use strict';
@@ -182,7 +195,7 @@ module.exports = function (grunt) {
                 src: styledElementsFiles
             },
             wirecloud: {
-                src: WirecloudFiles
+                src: WirecloudFiles.concat(WirecloudAPIFiles)
             },
             specs: {
                 options: {