iobroker.vis-jsontemplate 4.1.3 → 4.2.0

package/README.md

@@ -68,9 +68,39 @@ JSONTemplate now supports async calls with await.
 
 For details on the template system, see chapter Template based on examples
 
-The JSON data is passed to the template with the prefix data. In addition,
-the current widgetID is also available as a variable so that it can be
-specified in individual CSS instructions.
+Available data objects in the template:
+
+| object/variable | description                                                              |
+| --------------- | ------------------------------------------------------------------------ |
+| widgetID        | widgetID of the widget.                                                  |
+| data            | JSON object referenced by the datapoint in json_oid.                     |
+| dp              | Array of the datapoint data, referenced by the additional datapoints     |
+| widget          | internal widget data. object with all available widget settings          |
+| style           | internal style data. object with all available widget style informations |
+
+The additional datapoints can be accessed by
+A) the name of the datapoint
+
+```javascript
+<%- dp["0_userdata.0.test"] %>
+<%- dp["0_userdata.0.abc"] %>
+```
+
+B) Indexnumber of the datapoint (the number always start with 0)
+
+```javascript
+<%- dp[Object.keys(dp)[0]] %>
+<%- dp[Object.keys(dp)[1]] %>
+```
+
+Example output of data, widget and style in the template
+
+```ejs
+<%- JSON
+    .stringify(style, null, 4)
+    .replace(/\n/g, '<br>')
+    .replace(/ /g, '&nbsp;'); %>
+```
 
 #### Advanced use case
 
@@ -317,6 +347,27 @@ as `local_?` data points are processed internally within VIS (see `vis` document
 
 ## Templatesystem
 
+## Important note for the template system in vis
+
+In vis, all object notations in the following form are recognized and replaced as bindings.
+
+Therefore, the opening and closing brackets of all object notations must be placed on separate lines:
+
+Incorrect:
+
+```json
+{ "a": 1, "b": 2 }
+```
+
+Correct
+
+```json
+{
+    "a": 1,
+    "b": 2
+}
+```
+
 ## Tags
 
 The template system works with certain tags.
@@ -507,6 +558,15 @@ Loop over the attributes of an object
   Placeholder for the next version (at the beginning of the line):
   ### **WORK IN PROGRESS**
 -->
+### 4.2.0 (2025-11-14)
+
+- Improve documentation for the object notation in a template
+- fix some translations
+- align attribute name to vis1
+- add widget data to the available template objects in vis2
+- add style and widget object to the available template objects in vis1
+- improve documentation
+
 ### 4.1.3 (2025-11-03)
 
 - fix race condition if more than one widget use the same datapoint

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "vis-jsontemplate",
-    "version": "4.1.3",
+    "version": "4.2.0",
     "news": {
+      "4.2.0": {
+        "en": "Improve documentation for the object notation in a template\nfix some translations\nalign attribute name to vis1\nadd widget data to the available template objects in vis2\nadd style and widget object to the available template objects in vis1\nimprove documentation",
+        "de": "Verbessern Sie die Dokumentation der Objektnotation in einer Vorlage\neinige übersetzungen beheben\nattributname auf vis1 ausrichten\nwidget-daten zu den verfügbaren vorlagenobjekten in vis2 hinzufügen\nstyle und widget-objekt zu den verfügbaren vorlagenobjekten in vis1 hinzufügen\nverbesserung der dokumentation",
+        "ru": "Улучшить документацию для обозначения объекта в шаблоне\nисправить некоторые переводы\nвыравнивание имени атрибута для vis1\nдобавить данные виджета в доступные объекты шаблона в vis2\nдобавить стиль и объект виджета к доступным объектам шаблона в vis1\nулучшить документацию",
+        "pt": "Melhorar a documentação para a notação do objeto em um modelo\ncorrigir algumas traduções\nalinhar o nome do atributo para vis1\nadicionar dados de widget aos objetos de modelo disponíveis em vis2\nadicionar estilo e objeto widget aos objetos de modelo disponíveis em vis1\nmelhorar a documentação",
+        "nl": "De documentatie voor de objectnotatie in een sjabloon verbeteren\nsommige vertalingen te herstellen\nuitlijnen attribuutnaam naar vis1\nwidgetgegevens toevoegen aan de beschikbare sjabloonobjecten in vis2\ntoevoegen van stijl en widget object aan de beschikbare sjabloon objecten in vis1\nde documentatie verbeteren",
+        "fr": "Améliorer la documentation pour la notation d'objet dans un modèle\ncorriger certaines traductions\naligner le nom d'attribut sur vis1\najouter des données de widget aux objets de gabarit disponibles dans vis2\najouter style et objet widget aux objets template disponibles dans vis1\naméliorer la documentation",
+        "it": "Migliorare la documentazione per la notazione degli oggetti in un modello\nfissare alcune traduzioni\nalign attributo name a vis1\naggiungere i dati dei widget agli oggetti di modello disponibili in vis2\naggiungere oggetto stile e widget agli oggetti template disponibili in vis1\nmigliorare la documentazione",
+        "es": "Mejorar la documentación para la notación de objetos en una plantilla\narreglar algunas traducciones\nnombre de atributo alineado a vis1\nañadir datos de widget a los objetos de plantilla disponibles en vis2\nañadir estilo y objeto widget a los objetos de plantilla disponibles en vis1\nmejorar la documentación",
+        "pl": "Popraw dokumentację zapisu obiektu w szablonie\nnaprawić niektóre tłumaczenia\nwyrównać nazwę atrybutu do vis1\ndodaj dane widget do dostępnych obiektów szablonu w vis2\ndodaj styl i obiekt widget do dostępnych obiektów szablonu w vis1\npoprawić dokumentację",
+        "uk": "Покращити документацію для позначення об'єкта в шаблоні\nвиправити деякі переклади\nalign name атрибута в vis1\nдодати дані віджету на доступні шаблонні об'єкти в vis2\nдодати стиль і віджет об'єкта в доступні шаблони об'єктів в vis1\nвдосконалення документації",
+        "zh-cn": "改进模板中对象标记的文档\n修复一些翻译\n将属性名称与 vis1 对齐\n在 vis2 中将部件数据添加到可用的模板对象\n在 vis1 中将样式和部件对象添加到可用的模板对象\n改进文件编制"
+      },
       "4.1.3": {
         "en": "fix race condition if more than one widget use the same datapoint\nswitch to trusted publishing",
         "de": "fixe rassenbedingung, wenn mehr als ein widget den gleichen datenpunkt verwenden\nauf vertrauenswürdige veröffentlichung wechseln",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.vis-jsontemplate",
-  "version": "4.1.3",
+  "version": "4.2.0",
   "description": "vis-jsontemplate",
   "author": {
     "name": "oweitman",
@@ -30,7 +30,7 @@
     "@iobroker/vis-2-widgets-react-dev": "^4.0.4",
     "@iobroker/vis-2-widgets-testing": "^1.0.6",
     "@iobroker/adapter-dev": "^1.5.0",
-    "@iobroker/testing": "^5.1.1",
+    "@iobroker/testing": "^5.2.2",
     "@types/gulp": "^4.0.18",
     "@types/node": "^24.10.0"
   },

package/widgets/vis-jsontemplate/dist/jsontemplate-dist.js

@@ -58,7 +58,7 @@
   var version;
   var init_package = __esm({
     "../package.json"() {
-      version = "4.1.3";
+      version = "4.2.0";
     }
   });
 
@@ -153,7 +153,7 @@
                   );
                 }
               }
-              yield this.render(widgetID, view, data);
+              yield this.render(widgetID, view, data, style);
             });
           },
           /**
@@ -178,7 +178,7 @@
            * It then uses EJS to render the template with the provided data and updates the widget's HTML content.
            * In case of an error during rendering, it escapes and formats the error message to display it in the widget.
            */
-          render: function(widgetID, view, data) {
+          render: function(widgetID, view, data, style) {
             return __async(this, null, function* () {
               const oiddata = data.json_oid ? JSON.parse(vis.states.attr(`${data.json_oid}.val`)) : {};
               const dpCount = data.json_dpCount ? data.json_dpCount : 1;
@@ -193,7 +193,7 @@
               try {
                 text = yield ejs.render(
                   template,
-                  { widgetID, data: oiddata, dp: datapoints },
+                  { widgetID, data: oiddata, dp: datapoints, widget: data, style },
                   { async: true }
                 );
               } catch (e) {