iobroker.rest-api 1.0.5 → 2.0.1

package/README.md

@@ -9,11 +9,11 @@
 
 **This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.** For more details and for information how to disable the error reporting see [Sentry-Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reporting is used starting with js-controller 3.0.
 
-This is RESTFul interface to read the objects and states from ioBroker and to write/control the states over HTTP Get/Post requests.
+This is a RESTFul interface to read the objects and states from ioBroker and to write/control the states over HTTP Get/Post requests.
 
 The purpose of this adapter is similar to simple-api. But this adapter supports long-polling and URL hooks for subscribes.
 
-It has very useful web interface to play with the requests:
+It has a beneficial web interface to play with the requests:
 
 ![Screenshot](img/screen.png)
 
@@ -24,22 +24,22 @@ Some request examples:
 - `http://ipaddress:8093/v1/state/system.adapter.rest-api.0.memHeapTotal` - read state as JSON
 - `http://ipaddress:8093/v1/state/system.adapter.rest-api.0.memHeapTotal/plain` - read state as string (only value)
 - `http://ipaddress:8093/v1/state/system.adapter.rest-api.0.memHeapTotal?value=5` - write state with GET (only for back compatibility with simple-api)
-- `http://ipaddress:8093/v1/sendto/javascript.0?message=toScript&data={"message":"MESSAGE","data":"FROM REST-API"}` - send message to javascript.0 in script `scriptName`
+- `http://ipaddress:8093/v1/sendto/javascript.0?message=toScript&data={"message":"MESSAGE","data":"FROM REST-API"}` - send a message to javascript.0 in script `scriptName`
 
-## Subscribe on state or object changes
+## Subscribe to the state's or object's changes
 Your application could get notifications by every change of the state or object.
 
-For that your application must provide an HTTP(S) end-point to accept the updates.
+For that, your application must provide an HTTP(S) end-point to accept the updates.
 
 Example in node.js see here [demoNodeClient.js](examples/demoNodeClient.js)
 
 ## Long polling
-This adapter supports subscribe on data changes via long polling. 
+This adapter supports a subscribing on data changes via long polling. 
 
 Example for browser could be found here: [demoNodeClient.js](examples/demoBrowserClient.html)  
 
 ## Web extension
-This adapter can run as web-extension. In this case the path is available under http://iipaddress:8082/rest
+This adapter can run as a web extension. In this case, the path is available under http://iipaddress:8082/rest
 
 ## Notice
 - `POST` is always for creating a resource (does not matter if it was duplicated)
@@ -57,7 +57,7 @@ E.g.
 - `http://ipaddress:8093/v1/command/readFile?adapter=admin.admin&fileName=admin.png?binary` - to read the file `admin.admin/admin.png` as file
 - `http://ipaddress:8093/v1/command/extendObject?id=system.adapter.admin.0?obj={"common":{"enabled":true}}` - to restart admin
 
-You can request all commands with POST method too. As body must be an object with parameters. E.g:
+You can request all commands with POST method too. As body must be an object with parameters. E.g.:
 ```
 curl --location --request POST 'http://ipaddress:8093/v1/command/sendTo' \
 --header 'Content-Type: application/json' \
@@ -81,7 +81,7 @@ You cannot send POST request to commands via GUI.
 
 ### Objects
 - `getObject(id)` - get object by ID
-- `getObjects()` - get all states and rooms. GUI can have problems by visualization of answer.
+- `getObjects(list)` - get all states and rooms. GUI can have problems by visualization of answer.
 - `getObjectView(design, search, params)` - get specific objects, e.g. design=system, search=state, params=`{"startkey": "system.adapter.admin.", "endkey": "system.adapter.admin.\u9999"}`
 - `setObject(id, obj)` - set object with JSON object (e.g. `{"common": {"type": "boolean"}, "native": {}, "type": "state"}`)
 - `delObject(id, options)` - delete object by ID
@@ -107,7 +107,6 @@ You cannot send POST request to commands via GUI.
 - `delState(id)` - delete state and object. Same as delObject
 - `getRatings(update)` - read adapter ratings (as in admin)
 - `getCurrentInstance()` - read adapter namespace (always rest-api.0)
-- `checkFeatureSupported(feature)` - check if feature is supported by js-controller.
 - `decrypt(encryptedText)` - decrypt string with system secret
 - `encrypt(plainText)` - encrypt string with system secret
 - `getAdapters(adapterName)` - get objects of type "adapter". You can define optionally adapterName
@@ -131,6 +130,7 @@ You cannot send POST request to commands via GUI.
 
 ### Others
 - `log(text, level[info])` - no answer - add log entry to ioBroker log
+- `checkFeatureSupported(feature)` - check if feature is supported by js-controller.
 - `getHistory(id, options)` - read history. See for options: https://github.com/ioBroker/ioBroker.history/blob/master/docs/en/README.md#access-values-from-javascript-adapter
 - `httpGet(url)` - read URL from server. You can set binary=true to get answer as file
 - `sendTo(adapterInstance, command, message)` - send command to instance. E.g. adapterInstance=history.0, command=getHistory, message=`{"id": "system.adapter.admin.0.memRss","options": {"aggregate": "onchange", "addId": true}}`
@@ -138,19 +138,26 @@ You cannot send POST request to commands via GUI.
 - `getUserPermissions()` - read object with user permissions
 - `getVersion()` - read adapter name and version
 - `getAdapterName()` - read adapter name (always rest-api)
+- `clientSubscribe(targetInstance, messageType, data)`
 - `getAdapterInstances(adapterName)` - get objects of type "instance". You can define optionally adapterName
 
 <!-- END -->
 
-## Todo
-- [ ] Implement GET,PATCH,POST,DELETE file operations
-
 <!--
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
 
 ## Changelog
+### 2.0.1 (2024-05-23)
+* (foxriver76) ported to `@iobroker/webserver`
+* (theshengfui) Fixed history requests
+* (bluefox) Minimum required node.js version is 16
+
+### 1.1.0 (2023-05-03)
+* (bluefox) Converting of the setState values to the according type
+* (bluefox) Implemented file operations
+
 ### 1.0.5 (2023-03-27)
 * (Apollon77) Prepare for future js-controller versions
 
@@ -193,4 +200,4 @@ You cannot send POST request to commands via GUI.
 ## License
 Apache 2.0
 
-Copyright (c) 2017-2023 bluefox <dogafox@gmail.com>
+Copyright (c) 2017-2024 bluefox <dogafox@gmail.com>

package/admin/jsonConfig.json

@@ -162,7 +162,7 @@
     "leTab": {
       "type": "panel",
       "label": "Let's Encrypt SSL",
-      "disabled": "!data.secure || !!data.webInstance",
+      "disabled": "!data.secure",
       "items": {
         "_image": {
           "type": "staticImage",
@@ -174,38 +174,9 @@
             "height": 59
           }
         },
-        "_link": {
-          "newLine": true,
-          "type": "staticLink",
-          "href": "https://github.com/ioBroker/ioBroker.admin/blob/master/README.md#lets-encrypt-certificates",
-          "text": "Read about Let's Encrypt certificates",
-          "style": {
-            "fontSize": 16,
-            "marginBottom": 20
-          }
-        },
-        "leEnabled": {
-          "newLine": true,
-          "type": "checkbox",
-          "label": "Use Lets Encrypt certificates"
-        },
-        "leUpdate": {
-          "newLine": true,
-          "type": "checkbox",
-          "hidden": "!data.leEnabled",
-          "label": "Use this instance for automatic update"
-        },
-        "lePort": {
-          "newLine": true,
-          "sm": 11,
-          "lg": 4,
-          "type": "number",
-          "hidden": "!data.leEnabled || !data.leUpdate",
-          "label": "Port to check the domain",
-          "style": {
-            "marginTop": 15,
-            "maxWidth": 200
-          }
+        "_staticText": {
+          "type": "staticText",
+          "text": "ra_Use iobroker.acme adapter for letsencrypt certificates"
         }
       }
     }

package/io-package.json

@@ -1,8 +1,47 @@
 {
   "common": {
     "name": "rest-api",
-    "version": "1.0.5",
+    "version": "2.0.1",
     "news": {
+      "2.0.1": {
+        "en": "ported to `@iobroker/webserver`\nFixed history requests\nMinimum required node.js version is 16",
+        "de": "an `@iobroker/webserver `\nGeschichtsanfragen behoben\nMinimum erforderlich node.js Version ist 16",
+        "ru": "в порту `@iobroker/webserver \"\nИсправленные просьбы об истории\nМинимальная требуемая версия node.js - 16",
+        "pt": "portado para `@iobroker/webserver \"\nPedidos de histórico fixo\nA versão mínima necessária do node.js é 16",
+        "nl": "geporteerd naar .@iobroker/webserver wat\nVaste historische verzoeken\nMinimum vereiste node.js versie is 16",
+        "fr": "porté à `@iobroker/webserver \"\nDemande d'historique fixe\nLa version minimum requise node.js est 16",
+        "it": "inviato a `@iobroker/webserver #\nRisolte richieste di storia\nVersione minima richiesta node.js è 16",
+        "es": "portada a `@iobroker/webserver `\nSolicitudes de historia fija\nLa versión mínima requerida node.js es 16",
+        "pl": "wysłany do '@ iobroker / webserver'\nPoprawione żądania dotyczące historii\nMinimalna wymagana node.js wersja jest 16",
+        "uk": "сайт: www.iobroker.com й\nВиправлені запити історії\nМінімальний необхідний вузол.js версія 16",
+        "zh-cn": "移植到 xqio 经纪人/网络服务器 `\n固定历史请求\n最低要求的节点.js版本为16"
+      },
+      "2.0.0": {
+        "en": "Fixed history requests\nMinimum required node.js version is 16",
+        "de": "Geschichtsanfragen behoben\nMinimum erforderlich node.js Version ist 16",
+        "ru": "Исправленные просьбы об истории\nМинимальная требуемая версия node.js - 16",
+        "pt": "Pedidos de histórico fixo\nA versão mínima necessária do node.js é 16",
+        "nl": "Vaste historische verzoeken\nMinimum vereiste node.js versie is 16",
+        "fr": "Demande d'historique fixe\nLa version minimum requise node.js est 16",
+        "it": "Risolte richieste di storia\nVersione minima richiesta node.js è 16",
+        "es": "Solicitudes de historia fija\nLa versión mínima requerida node.js es 16",
+        "pl": "Poprawione żądania dotyczące historii\nMinimalna wymagana node.js wersja jest 16",
+        "uk": "Виправлені запити історії\nМінімальний необхідний вузол.js версія 16",
+        "zh-cn": "固定历史请求\n最低要求的节点.js版本为16"
+      },
+      "1.1.0": {
+        "en": "Converting of the setState values to the according type\nImplemented file operations",
+        "de": "Umrechnung der setState-Werte in den entsprechenden Typ\nImplementierung von Dateioperationen",
+        "ru": "Преобразование значений setState в согласно типу\nРеализованные файловые операции",
+        "pt": "Convertendo dos valores setState para o tipo de acordo\nOperações de arquivo implementadas",
+        "nl": "Omkeren van de setstate waarden naar het type\nGeïmplementeerde bestand operaties",
+        "fr": "Conversion des valeurs déterminées de l'état dans le type suivant\nOpérations de fichiers mises en œuvre",
+        "it": "Convertizione dei valori setState secondo il tipo\nOperazioni di file implementate",
+        "es": "Convertir los valores establecidos en el tipo\nOperaciones de archivo aplicadas",
+        "pl": "Przetłumaczył wartości zbioru zgodnie z typem\nImplementacja",
+        "uk": "Перетворення значень setState до за типом\nРеалізовані операції файлів",
+        "zh-cn": "避免按类型划分国家数值\n执行档案业务"
+      },
       "1.0.5": {
         "en": "Prepare for future js-controller versions",
         "de": "Bereiten Sie sich auf zukünftige js-Controller-Versionen",
@@ -51,42 +90,6 @@
         "es": "Aumento del tamaño máximo del cuerpo a 100Mb",
         "pl": "Zwiększono maksymalną wielkość ciała do 100 Mb",
         "zh-cn": "提高机构规模,使之达到100千兆瓦"
-      },
-      "1.0.0": {
-        "en": "Final release",
-        "de": "Endgültige Veröffentlichung",
-        "ru": "Окончательный релиз",
-        "pt": "Último lançamento",
-        "nl": "Laatste versie",
-        "fr": "Version finale",
-        "it": "Rilascio finale",
-        "es": "Lanzamiento final",
-        "pl": "Ostateczne wydanie",
-        "zh-cn": "最终版本"
-      },
-      "0.6.0": {
-        "en": "Added sendTo path",
-        "de": "sendTo-Pfad hinzugefügt",
-        "ru": "Добавлен путь отправки",
-        "pt": "Adicionado caminho sendTo",
-        "nl": "SendTo-pad toegevoegd",
-        "fr": "Ajout du chemin sendTo",
-        "it": "Aggiunto il percorso sendTo",
-        "es": "Ruta de envío agregada",
-        "pl": "Dodano ścieżkę sendTo",
-        "zh-cn": "添加了 sendTo 路径"
-      },
-      "0.5.0": {
-        "en": "Some access errors were corrected",
-        "de": "Einige Zugriffsfehler wurden behoben",
-        "ru": "Исправлены некоторые ошибки доступа",
-        "pt": "Alguns erros de acesso foram corrigidos",
-        "nl": "Sommige toegangsfouten zijn gecorrigeerd",
-        "fr": "Certaines erreurs d'accès ont été corrigées",
-        "it": "Alcuni errori di accesso sono stati corretti",
-        "es": "Se corrigieron algunos errores de acceso",
-        "pl": "Poprawiono niektóre błędy dostępu",
-        "zh-cn": "一些访问错误已得到纠正"
       }
     },
     "title": "REST API",
@@ -108,7 +111,6 @@
     "authors": [
       "bluefox <dogafox@gmail.com>"
     ],
-    "license": "Apache-2.0",
     "platform": "Javascript/Node.js",
     "mode": "daemon",
     "connectionType": "local",
@@ -134,6 +136,11 @@
     "adminUI": {
       "config": "json"
     },
+    "licenseInformation": {
+      "type": "free",
+      "license": "Apache-2.0"
+    },
+    "tier": 3,
     "dependencies": [
       {
         "js-controller": ">=4.0.0"

package/lib/api/controllers/file.js

@@ -0,0 +1,74 @@
+'use strict';
+const commonLib = require('./common.js');
+
+module.exports = {
+    readFile: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'file', operation: 'read'}],  async error => {
+            if (error) {
+                commonLib.errorResponse(req, res, error);
+            } else {
+                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
+                try {
+                    const data = await req._adapter.readFileAsync(params.objectId, params.fileName, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
+                    if (data && data.mimeType) {
+                        res.set('Content-Type', data.mimeType);
+                        res.send(data.file);
+                    } else {
+                        res.status(404).send(Buffer.from(''));
+                    }
+                } catch (error) {
+                    commonLib.errorResponse(req, res, error);
+                }
+            }
+        });
+    },
+    deleteFile: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'file', operation: 'delete'}],  async error => {
+                if (error) {
+                    commonLib.errorResponse(req, res, error);
+                } else {
+                    const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
+                    try {
+                        await req._adapter.delFileAsync(params.objectId, params.fileName, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
+                        res.json({success: true});
+                    } catch (err) {
+                        if (err.toString().includes('Not exists')) {
+                            res.status(404).json({error: err.toString()});
+                        } else {
+                            commonLib.errorResponse(req, res, err);
+                        }
+                    }
+                }
+        });
+    },
+    writeFile: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'file', operation: 'write'}],  async error => {
+            if (error) {
+                commonLib.errorResponse(req, res, error);
+            } else {
+                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
+                try {
+                    await req._adapter.writeFileAsync(params.objectId, params.fileName, req.files.file[0].buffer, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
+                    res.json({success: true});
+                } catch (err) {
+                    commonLib.errorResponse(req, res, err);
+                }
+            }
+        });
+    },
+    readDir: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'file', operation: 'list'}],  async error => {
+            if (error) {
+                commonLib.errorResponse(req, res, error);
+            } else {
+                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
+                try {
+                    const response = await req._adapter.readDirAsync(params.objectId, params.dirName || '', {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
+                    res.json(response);
+                } catch (err) {
+                    commonLib.errorResponse(req, res, err);
+                }
+            }
+        });
+    },
+};

package/lib/api/controllers/history.js

@@ -96,17 +96,17 @@ module.exports = {
                             Object.keys(PARAMETERS).forEach(attr => {
                                 if (Object.hasOwnProperty.call(req.body.options, attr)) {
                                     if (PARAMETERS[attr] === 'boolean') {
-                                        options[attr] = req.body.options[attr] === 'true';
+                                        options.options[attr] = req.body.options[attr] === 'true';
                                     } else if (PARAMETERS[attr] === 'number') {
-                                        options[attr] = parseFloat(req.body.options[attr]);
+                                        options.options[attr] = parseFloat(req.body.options[attr]);
                                     } else if (Array.isArray(PARAMETERS[attr])) {
                                         if (PARAMETERS[attr].includes(req.body.options[attr])) {
-                                            options[attr] = req.body.options[attr];
+                                            options.options[attr] = req.body.options[attr];
                                         } else {
                                             req._adapter.log.warn(`Unknown value ${req.body.options[attr]} for attribute ${attr}. Allowed: ${PARAMETERS[attr].join(', ')}`);
                                         }
                                     } else if (PARAMETERS[attr] === 'string') {
-                                        options[attr] = req.body.options[attr];
+                                        options.options[attr] = req.body.options[attr];
                                     }
                                 }
                             });
@@ -204,11 +204,11 @@ module.exports = {
                             Object.keys(PARAMETERS_ADD).forEach(attr => {
                                 if (Object.hasOwnProperty.call(req.body.state, attr)) {
                                     if (PARAMETERS_ADD[attr] === 'boolean') {
-                                        options[attr] = req.body.state[attr] === 'true';
+                                        options.state[attr] = req.body.state[attr] === 'true';
                                     } else if (PARAMETERS_ADD[attr] === 'number') {
-                                        options[attr] = parseFloat(req.body.state[attr]);
+                                        options.state[attr] = parseFloat(req.body.state[attr]);
                                     } else if (PARAMETERS_ADD[attr] === 'string') {
-                                        options[attr] = req.body.state[attr];
+                                        options.state[attr] = req.body.state[attr];
                                     }
                                 }
                             });
@@ -236,4 +236,4 @@ module.exports = {
             }
         });
     },
-};
+};

package/lib/api/swagger/swagger.yaml

@@ -2,7 +2,7 @@
 swagger: "2.0"
 info:
   description: "This is a REST server for ioBroker."
-  version: "1.0.5"
+  version: "2.0.1"
   title: "ioBroker Swagger UI"
   contact:
     email: "admin@iobroker.net"
@@ -28,6 +28,8 @@ tags:
     description: "Socket commands"
   - name: "sendTo"
     description: "Send message to instance"
+  - name: "file"
+    description: "Read/Write files and directories"
 securityDefinitions:
   basicAuth:
     type: basic
@@ -995,8 +997,136 @@ paths:
           description: "Invalid state ID supplied"
         500:
           description: "instance is offline"
+  /file/{objectId}/{fileName}:
+    x-swagger-router-controller: file
+    get:
+      tags:
+        - "file"
+      summary: "Reads file"
+      operationId: "readFile"
+      produces:
+        - "application/octet-stream"
+      parameters:
+        - name: "objectId"
+          in: "path"
+          description: "Object ID, like vis.0"
+          type: "string"
+          required: true
+        - name: "fileName"
+          in: "path"
+          description: "File name, like main/vis-views.json"
+          type: "string"
+          required: true
+      responses:
+        200:
+          description: "successful operation"
+        404:
+          description: "File not found"
+    post:
+      tags:
+        - "file"
+      summary: "Writes file"
+      operationId: "writeFile"
+      produces:
+        - "application/json"
+      consumes:
+        - "multipart/form-data"
+      parameters:
+        - name: "objectId"
+          in: "path"
+          description: "Object ID, like vis.0"
+          type: "string"
+          required: true
+        - name: "fileName"
+          in: "path"
+          description: "File name, like main/vis-views.json"
+          type: "string"
+          required: true
+        - name: "file"
+          in: "formData"
+          description: "File content"
+          required: true
+          type: "file"
+      responses:
+        200:
+          description: "successful operation"
+        404:
+          description: "File not found"
+    delete:
+      tags:
+        - "file"
+      summary: "deletes file"
+      operationId: "deleteFile"
+      produces:
+        - "application/json"
+      parameters:
+        - name: "objectId"
+          in: "path"
+          description: "Object ID, like vis.0"
+          type: "string"
+          required: true
+        - name: "fileName"
+          in: "path"
+          description: "File name, like main/vis-views.json"
+          type: "string"
+          required: true
+      responses:
+        200:
+          description: "successful operation"
+        404:
+          description: "File not found"
+  /dir/{objectId}/{dirName}:
+    x-swagger-router-controller: file
+    get:
+      tags:
+        - "file"
+      summary: "List directory"
+      operationId: "readDir"
+      produces:
+        - "application/json"
+      parameters:
+        - name: "objectId"
+          in: "path"
+          description: "Object ID, like vis.0"
+          type: "string"
+          required: true
+        - name: "dirName"
+          in: "path"
+          description: "File name, like main/vis-views.json"
+          type: "string"
+          required: true
+      responses:
+        200:
+          description: "successful operation"
+          schema:
+            $ref: "#/definitions/DirResponse"
+        404:
+          description: "File not found"
+  /dir/{objectId}:
+    x-swagger-router-controller: file
+    get:
+      tags:
+        - "file"
+      summary: "List directory"
+      operationId: "readDir"
+      produces:
+        - "application/json"
+      parameters:
+        - name: "objectId"
+          in: "path"
+          description: "Object ID, like vis.0"
+          type: "string"
+          required: true
+      responses:
+        200:
+          description: "successful operation"
+          schema:
+            $ref: "#/definitions/DirResponse"
+        404:
+          description: "File not found"
 
-# commands start
+
+  # commands start
   /command/getStates:
     get:
       tags:
@@ -1134,7 +1264,14 @@ paths:
         - "commands"
       summary: "get all states and rooms. GUI can have problems by visualization of answer."
       produces:
-        - "application/json"        
+        - "application/json"
+      parameters:
+
+        - name: "list"            
+          in: "query"
+          description: ""
+          type: "string"
+          required: true        
       responses:
         200:
           description: "successful operation"
@@ -1633,24 +1770,6 @@ paths:
       responses:
         200:
           description: "successful operation"
-  /command/checkFeatureSupported:
-    get:
-      tags:
-        - "commands"
-      summary: "check if feature is supported by js-controller."
-      produces:
-        - "application/json"
-      parameters:
-
-        - name: "feature"            
-          in: "query"
-          description: ""
-          type: "string"
-          required: true
-          enum: [ALIAS, ALIAS_SEPARATE_READ_WRITE_ID, ADAPTER_GETPORT_BIND, ADAPTER_DEL_OBJECT_RECURSIVE, ADAPTER_SET_OBJECT_SETS_DEFAULT_VALUE, ADAPTER_AUTO_DECRYPT_NATIVE, PLUGINS, CONTROLLER_NPM_AUTO_REBUILD, CONTROLLER_READWRITE_BASE_SETTINGS, CONTROLLER_MULTI_REPO, CONTROLLER_LICENSE_MANAGER, DEL_INSTANCE_CUSTOM]        
-      responses:
-        200:
-          description: "successful operation"
   /command/decrypt:
     get:
       tags:
@@ -2021,6 +2140,24 @@ paths:
       responses:
         200:
           description: "successful operation"
+  /command/checkFeatureSupported:
+    get:
+      tags:
+        - "commands"
+      summary: "check if feature is supported by js-controller."
+      produces:
+        - "application/json"
+      parameters:
+
+        - name: "feature"            
+          in: "query"
+          description: ""
+          type: "string"
+          required: true
+          enum: [ALIAS, ALIAS_SEPARATE_READ_WRITE_ID, ADAPTER_GETPORT_BIND, ADAPTER_DEL_OBJECT_RECURSIVE, ADAPTER_SET_OBJECT_SETS_DEFAULT_VALUE, ADAPTER_AUTO_DECRYPT_NATIVE, PLUGINS, CONTROLLER_NPM_AUTO_REBUILD, CONTROLLER_READWRITE_BASE_SETTINGS, CONTROLLER_MULTI_REPO, CONTROLLER_LICENSE_MANAGER, DEL_INSTANCE_CUSTOM]        
+      responses:
+        200:
+          description: "successful operation"
   /command/getHistory:
     get:
       tags:
@@ -2130,6 +2267,35 @@ paths:
       responses:
         200:
           description: "successful operation"
+  /command/clientSubscribe:
+    get:
+      tags:
+        - "commands"
+      summary: ""
+      produces:
+        - "application/json"
+      parameters:
+
+        - name: "targetInstance"            
+          in: "query"
+          description: ""
+          type: "string"
+          required: true
+
+        - name: "messageType"            
+          in: "query"
+          description: ""
+          type: "string"
+          required: true
+
+        - name: "data"            
+          in: "query"
+          description: ""
+          type: "string"
+          required: true        
+      responses:
+        200:
+          description: "successful operation"
   /command/getAdapterInstances:
     get:
       tags:
@@ -2410,6 +2576,33 @@ definitions:
     type: "array"
     items:
       $ref: "#/definitions/EnumEntry"
+  FileEntry:
+    type: "object"
+    properties:
+      file:
+        type: "string"
+        description: "File name"
+      stats:
+        type: "object"
+        description: "File size"
+        properties:
+          size:
+            type: "number"
+            description: "File size in bytes"
+      isDir:
+        type: "boolean"
+        description: "Is directory"
+      modifiedAt:
+        type: "number"
+        description: "Modification time in ms"
+      createdAt:
+        type: "number"
+        description: "Creation time in ms"
+  DirResponse:
+    type: "array"
+    items:
+      $ref: "#/definitions/FileEntry"
+
   SendToData:
     type: "object"
     properties:

package/lib/rest-api.js

@@ -13,6 +13,7 @@ const axios         = require('axios');
 const cors          = require('cors');
 const fs            = require('fs');
 const path          = require('path');
+const multer = require('multer');
 const utils         = require('@iobroker/adapter-core'); // Get common adapter utils
 const pattern2RegEx = utils.commonTools.pattern2RegEx;
 const CommandsAdmin = require('@iobroker/socket-classes').SocketCommandsAdmin;
@@ -23,6 +24,26 @@ process.env.SUPPRESS_NO_CONFIG_WARNING = 'true';
 
 const WEB_EXTENSION_PREFIX = 'rest-api/';
 
+/*const memStore = { };
+
+// Writable memory stream
+class WMStrm extends Writable {
+    constructor(key, options) {
+        super(options); // init super
+        this.key = key; // save key
+        this.data = Buffer.from(''); // empty
+    }
+
+    _write(chunk, enc, cb) {
+        // our memory store stores things in buffers
+        const buffer = (Buffer.isBuffer(chunk)) ? chunk : Buffer.from(chunk, enc);
+
+        // concat to the buffer already there
+        this.data = Buffer.concat([this.data, buffer]);
+        cb();
+    }
+}
+*/
 function parseQuery(_url) {
     let url = decodeURI(_url);
     const pos = url.indexOf('?');
@@ -286,17 +307,17 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
     };
 
     // prepare yaml
-    _options.swaggerFile = __dirname + '/api/swagger/swagger.yaml';
+    _options.swaggerFile = `${__dirname}/api/swagger/swagger.yaml`;
     if (this.adapter.config.noCommands) {
         const newText = removeTextFromFile(_options.swaggerFile, '# commands start', '# commands stop');
 
-        _options.swaggerFile = __dirname + '/api/swagger/swaggerEdited.yaml';
+        _options.swaggerFile = `${__dirname}/api/swagger/swaggerEdited.yaml`;
         if (!fs.existsSync(_options.swaggerFile) || fs.readFileSync(_options.swaggerFile).toString('utf8') !== newText) {
             fs.writeFileSync(_options.swaggerFile, newText);
         }
     } else if (this.adapter.config.noAdminCommands) {
         const newText = removeTextFromFile(_options.swaggerFile, '# admin commands start', '# admin commands end');
-        _options.swaggerFile = __dirname + '/api/swagger/swaggerEdited.yaml';
+        _options.swaggerFile = `${__dirname}/api/swagger/swaggerEdited.yaml`;
         if (!fs.existsSync(_options.swaggerFile) || fs.readFileSync(_options.swaggerFile).toString('utf8') !== newText) {
             fs.writeFileSync(_options.swaggerFile, newText);
         }
@@ -307,7 +328,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
         let file = fs.readFileSync(_options.swaggerFile).toString('utf8')
         file = file.replace('basePath: "/v1"', `basePath: "/${WEB_EXTENSION_PREFIX}v1"`);
 
-        _options.swaggerFile = __dirname + '/api/swagger/swagger_extension.yaml';
+        _options.swaggerFile = `${__dirname}/api/swagger/swagger_extension.yaml`;
 
         if (!fs.existsSync(_options.swaggerFile) || fs.readFileSync(_options.swaggerFile).toString('utf8') !== file) {
             fs.writeFileSync(_options.swaggerFile, file);
@@ -322,16 +343,16 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
 
 
     if (!this.config.noUI) {
-        this.app.get(this.routerPrefix + 'api-docs/swagger.json', (req, res) =>
+        this.app.get(`${this.routerPrefix}api-docs/swagger.json`, (req, res) =>
             res.json(swaggerDocument));
 
         const options = {
             customCss: '.swagger-ui .topbar { background-color: #4dabf5; }',
         };
         // show WEB CSS and so on
-        this.app.use(this.routerPrefix + 'api-doc/', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));
+        this.app.use(`${this.routerPrefix}api-doc/`, swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));
         this.app.get(this.routerPrefix, (req, res) =>
-            res.redirect(this.routerPrefix + 'api-doc/'));
+            res.redirect(`${this.routerPrefix}api-doc/`));
     }
 
     function isAuthenticated(req, res, callback) {
@@ -354,7 +375,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
                 }
             }
             if (!values.user.match(/^system\.user\./)) {
-                values.user = 'system.user.' + values.user;
+                values.user = `system.user.${values.user}`;
             }
 
             that.adapter.checkPassword(values.user, values.pass, result => {
@@ -686,7 +707,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
         }
 
         task.timer = setTimeout(_task => {
-            // remove this task from list
+            // remove this task from the list
             const pos = this._waitFor.indexOf(_task);
             if (pos !== -1) {
                 this._waitFor.splice(pos, 1);
@@ -702,11 +723,11 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
 
     this.app.get('/favicon.ico', (req, res) => {
         res.set('Content-Type', 'image/x-icon');
-        res.send(fs.readFileSync(__dirname + '/../img/favicon.ico'));
+        res.send(fs.readFileSync(`${__dirname}/../img/favicon.ico`));
     });
 
     // authenticate
-    this.app.use(this.routerPrefix + 'v1/*', (req, res, next) => {
+    this.app.use(`${this.routerPrefix}v1/*`, (req, res, next) => {
         isAuthenticated(req, res, () => {
             req._adapter = this.adapter;
             req._swaggerObject = this;
@@ -714,7 +735,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
         });
     });
 
-    this.app.get(this.routerPrefix + 'v1/polling', (req, res, next) => {
+    this.app.get(`${this.routerPrefix}v1/polling`, (req, res, next) => {
         res.writeHead(200, {'Content-Type': 'text/plain'});
         const ip = req.query.sid || req.headers['x-forwarded-for'] || req.socket.remoteAddress;
         const urlHash = crypto.createHash('md5').update(ip).digest('hex');
@@ -799,13 +820,13 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
         });
     });
 
-    this.app.use(this.routerPrefix + 'v1/command/*', (req, res) => {
+    this.app.use(`${this.routerPrefix}v1/command/*`, async (req, res) => {
         if (this.adapter.config.noCommands) {
             res.status(404).json({error: `Commands are disabled`});
             return;
         }
 
-        let command = req.originalUrl.startsWith('/' + WEB_EXTENSION_PREFIX) ? req.originalUrl.split('/')[4] : req.originalUrl.split('/')[3];
+        let command = req.originalUrl.startsWith(`/${WEB_EXTENSION_PREFIX}`) ? req.originalUrl.split('/')[4] : req.originalUrl.split('/')[3];
         command = command.split('?')[0];
 
         const handler = this.commands.getCommandHandler(command);
@@ -813,7 +834,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
             const args = common.getParamNames(handler).map(item => item[0] === '_' ? item.substring(1) : item);
 
             args.shift(); // remove socket
-            // try to parse query or body
+            // try to parse a query or body
             let params = parseQuery(req.originalUrl);
             if (req.body) {
                 Object.assign(params, req.body);
@@ -837,7 +858,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
             }
 
             const _acl = {
-                user: req._user
+                user: req._user,
             };
 
             const _arguments = [{_acl}];
@@ -846,7 +867,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
                 if (name !== 'callback') {
                     if (name === 'options' || name === 'params' || name === 'obj' || name === 'message') {
                         // try to convert
-                        if (typeof params[name] == 'string' && params[name].startsWith('{') && params[name].endsWith('}')) {
+                        if (typeof params[name] === 'string' && params[name].startsWith('{') && params[name].endsWith('}')) {
                             try {
                                 params[name] = JSON.parse(params[name]);
                             } catch (_error) {
@@ -869,6 +890,26 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
                 }
             });
 
+            // try to convert arguments for setState and setForeignState
+            if (command === 'setState' || command === 'setForeignState') {
+                // read object
+                try {
+                    const obj = await adapter.getForeignObjectAsync(_arguments[1], {user: req._user});
+                    if (obj && obj.common && obj.common.type) {
+                        if (obj.common.type === 'number') {
+                            _arguments[2] = parseFloat(_arguments[2]);
+                        } else if (obj.common.type === 'boolean') {
+                            _arguments[2] = _arguments[2] === 'true' || _arguments[2] === true || _arguments[2] === 1 || _arguments[2] === '1' || _arguments[2] === 'on' || _arguments[2] === 'ON';
+                        } else if (obj.common.type === 'string') {
+                            _arguments[2] = _arguments[2].toString();
+                        }
+                    }
+                } catch (error) {
+                    res.status(501).json({error});
+                    return;
+                }
+            }
+
             if (!error) {
                 if (args[args.length - 1] === 'callback') {
                     _arguments.push((error, ...args) => {
@@ -910,9 +951,9 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
         }
     });
 
-    this.app.get(this.routerPrefix + 'log/*',(req, res) => {
+    this.app.get(`${this.routerPrefix}log/*`,(req, res) => {
         let parts = decodeURIComponent(req.url).split('/');
-        if (req.originalUrl.startsWith('/' + WEB_EXTENSION_PREFIX)) {
+        if (req.originalUrl.startsWith(`/${WEB_EXTENSION_PREFIX}`)) {
             parts.shift();
         }
 
@@ -922,7 +963,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
             const [host, transport] = parts;
             parts = parts.splice(2);
             let filename = parts.join('/');
-            this.adapter.sendToHost('system.host.' + host, 'getLogFile', {filename, transport}, result => {
+            this.adapter.sendToHost(`system.host.${host}`, 'getLogFile', {filename, transport}, result => {
                 if (!result || result.error) {
                     res.status(404).send(`File ${escapeHtml(filename)} not found`);
                 } else {
@@ -969,9 +1010,9 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
                     }
 
                     if (logFolder[0] !== '/' && logFolder[0] !== '\\' && !logFolder.match(/^[a-zA-Z]:/)) {
-                        const _logFolder = path.normalize(path.join(__dirname + '/../../../', logFolder).replace(/\\/g, '/')).replace(/\\/g, '/');
+                        const _logFolder = path.normalize(path.join(`${__dirname}/../../../`, logFolder).replace(/\\/g, '/')).replace(/\\/g, '/');
                         if (!fs.existsSync(_logFolder)) {
-                            logFolder = path.normalize(path.join(__dirname + '/../../', logFolder).replace(/\\/g, '/')).replace(/\\/g, '/');
+                            logFolder = path.normalize(path.join(`${__dirname}/../../`, logFolder).replace(/\\/g, '/')).replace(/\\/g, '/');
                         } else {
                             logFolder = _logFolder;
                         }
@@ -1013,9 +1054,12 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
         }
     });
 
+    // parse binary files
+    this.app.post(`${this.routerPrefix}v1/file/*`, multer().fields([{ name: 'file', maxCount: 1 }]), (req, res, next) => next());
+
     this.unload = async () => {
         if (this.config.webInstance) {
-            await this.adapter.setForeignStateAsync(this.namespace + '.info.extension', false, true);
+            await this.adapter.setForeignStateAsync(`${this.namespace}.info.extension`, false, true);
         }
         this.checkInterval && clearInterval(this.checkInterval);
         this.checkInterval = null;

package/main.js

@@ -4,7 +4,7 @@
 'use strict';
 
 const utils       = require('@iobroker/adapter-core'); // Get common adapter utils
-const LE          = utils.commonTools.letsEncrypt;
+const { WebServer } = require('@iobroker/webserver');
 const RestAPI     = require('./lib/rest-api.js');
 const adapterName = require('./package.json').name.split('.').pop();
 
@@ -106,7 +106,12 @@ function initWebServer(settings, callback) {
             }
 
             try {
-                server.server = await LE.createServerAsync(app, settings, adapter.config.certificates, adapter.config.leConfig, adapter.log);
+                const webserver = new WebServer({
+                    app,
+                    adapter,
+                    secure: adapter.config.secure
+                });
+                server.server = await webserver.init();
             } catch (err) {
                 adapter.log.error(`Cannot create webserver: ${err}`);
                 adapter.terminate ? adapter.terminate(1) : process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.rest-api",
-  "version": "1.0.5",
+  "version": "2.0.1",
   "description": "RESTful interface for ioBroker with GUI.",
   "author": {
     "name": "bluefox",
@@ -14,33 +14,38 @@
     "swagger-ui",
     "web"
   ],
+  "engines": {
+    "node": ">=16"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/ioBroker/ioBroker.rest-api"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^2.6.7",
-    "@iobroker/socket-classes": "^1.1.5",
-    "axios": "^1.3.4",
+    "@iobroker/adapter-core": "^3.1.4",
+    "@iobroker/socket-classes": "^1.5.0",
+    "@iobroker/webserver": "^1.0.3",
+    "axios": "^1.6.8",
     "body-parser": "^1.20.2",
     "cors": "^2.8.5",
-    "express": "^4.18.2",
+    "express": "^4.19.2",
+    "multer": "^1.4.5-lts.1",
     "swagger-node-runner-fork": "^0.8.0",
-    "swagger-ui-express": "^4.6.2",
+    "swagger-ui-express": "^5.0.0",
     "yamljs": "^0.3.0"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.5.9",
-    "@alcalzone/release-script-plugin-iobroker": "^3.5.9",
-    "@alcalzone/release-script-plugin-license": "^3.5.9",
-    "@iobroker/adapter-dev": "^1.2.0",
-    "@iobroker/testing": "^4.1.0",
-    "chai": "^4.3.7",
+    "@alcalzone/release-script": "^3.7.0",
+    "@alcalzone/release-script-plugin-iobroker": "^3.7.0",
+    "@alcalzone/release-script-plugin-license": "^3.7.0",
+    "@iobroker/adapter-dev": "^1.3.0",
+    "@iobroker/testing": "^4.1.3",
+    "chai": "^4.4.1",
     "eslint-plugin-eqeqeq-fix": "^1.0.3",
     "eslint-plugin-only-warn": "^1.1.0",
-    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react": "^7.34.1",
     "gulp": "^4.0.2",
-    "mocha": "^10.2.0"
+    "mocha": "^10.4.0"
   },
   "bugs": {
     "url": "https://github.com/ioBroker/ioBroker.rest-api/issues"
@@ -62,7 +67,8 @@
     "release-patch": "release-script patch --yes --no-update-lockfile",
     "release-minor": "release-script minor --yes --no-update-lockfile",
     "release-major": "release-script major --yes --no-update-lockfile",
-    "translate": "translate-adapter"
+    "translate": "translate-adapter",
+    "update-packages": "ncu --upgrade"
   },
   "license": "Apache-2.0"
 }