iobroker.rest-api 1.0.1 → 1.0.5

package/README.md

@@ -73,6 +73,7 @@ You cannot send POST request to commands via GUI.
 <!-- START -->
 ### States
 - `getStates(pattern)` - get the list of states for pattern (e.g. for system.adapter.admin.0.*). GUI can have problems by visualization of answer.
+- `getForeignStates(pattern)` - same as getStates
 - `getState(id)` - get state value by ID
 - `setState(id, state)` - set state value with JSON object (e.g. `{"val": 1, "ack": true}`)
 - `getBinaryState(id)` - get binary state by ID
@@ -115,6 +116,7 @@ You cannot send POST request to commands via GUI.
 - `getCompactAdapters()` - read list of installed adapters with short information
 - `getCompactInstalled(host)` - read short information about installed adapters
 - `getCompactSystemConfig()` - read short system config
+- `getCompactSystemRepositories()`
 - `getCompactRepository(host)` - read short repository
 - `getCompactHosts()` - get short information about hosts
 - `addUser(user, pass)` - add new user
@@ -125,7 +127,6 @@ You cannot send POST request to commands via GUI.
 - `getAllObjects()` - read all objects as list. GUI can have problems by visualization of answer.
 - `extendObject(id, obj)` - modify object by ID with JSON. (.e.g. `{"common":{"enabled": true}}`) 
 - `getForeignObjects(pattern, type)` - same as getObjects
-- `getForeignStates(pattern)` - same as getStates
 - `delObjects(id, options)` - delete objects by pattern
 
 ### Others
@@ -140,12 +141,25 @@ You cannot send POST request to commands via GUI.
 - `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
+### 1.0.5 (2023-03-27)
+* (Apollon77) Prepare for future js-controller versions
+
+### 1.0.4 (2022-08-31)
+* (bluefox) Check if the port is occupied only on defined interface
+
+### 1.0.2 (2022-07-27)
+* (bluefox) Implemented binary read/write operations
+
 ### 1.0.1 (2022-07-27)
 * (bluefox) Increased the max size of body to 100Mb
 
@@ -179,4 +193,4 @@ You cannot send POST request to commands via GUI.
 ## License
 Apache 2.0
 
-Copyright (c) 2017-2022 bluefox <dogafox@gmail.com>
+Copyright (c) 2017-2023 bluefox <dogafox@gmail.com>

package/io-package.json

@@ -1,8 +1,45 @@
 {
   "common": {
     "name": "rest-api",
-    "version": "1.0.1",
+    "version": "1.0.5",
     "news": {
+      "1.0.5": {
+        "en": "Prepare for future js-controller versions",
+        "de": "Bereiten Sie sich auf zukünftige js-Controller-Versionen",
+        "ru": "Подготовьтесь к будущим версиям js-controller",
+        "pt": "Prepare-se para futuras versões js-controller",
+        "nl": "Bereid je voor op toekomstige Js-controller versie",
+        "fr": "Préparez-vous pour les versions futures de js-controller",
+        "it": "Prepararsi per le future versioni js-controller",
+        "es": "Prepararse para futuras versiones js-controller",
+        "pl": "Prepare for future js-controller version",
+        "uk": "Підготовка до майбутніх версій js-controller",
+        "zh-cn": "今后防污版本的编制"
+      },
+      "1.0.4": {
+        "en": "Check if the port is occupied only on defined interface",
+        "de": "Überprüfen Sie, ob der Port nur auf definierter Schnittstelle besetzt ist",
+        "ru": "Проверьте, занят ли порт только на определенном интерфейсе",
+        "pt": "Verifique se a porta está ocupada apenas na interface definida",
+        "nl": "Controleer of de haven alleen bezet is op definitieve interface",
+        "fr": "Vérifiez si le port n'est occupé que sur l'interface définie",
+        "it": "Controllare se la porta è occupata solo su interfaccia definita",
+        "es": "Compruebe si el puerto está ocupado sólo en la interfaz definida",
+        "pl": "Jeśli port jest zajęty tylko na określonym interfejsie",
+        "zh-cn": "如果港口只在界定的界线上被占有,则该港口将被扣押。"
+      },
+      "1.0.2": {
+        "en": "Implemented binary read/write operations",
+        "de": "Implementierung binärer Schreib-/Lesevorgänge",
+        "ru": "Внедренные бинарные чтения / записи операции",
+        "pt": "Operações de leitura/escrita binárias implementadas",
+        "nl": "Geïmplementeerde binaire las/schrijf operaties",
+        "fr": "Opérations de lecture/écriture binaires mises en œuvre",
+        "it": "Operazioni di lettura/scrittura binarie implementate",
+        "es": "Operaciones de lectura y escritura binarias aplicadas",
+        "pl": "Poprawianie binarnego odczytu/pisania operacji",
+        "zh-cn": "执行本文的文字/仪式作业"
+      },
       "1.0.1": {
         "en": "Increased the max size of body to 100Mb",
         "de": "Erhöht die maximale Körpergröße auf 100Mb",
@@ -50,42 +87,6 @@
         "es": "Se corrigieron algunos errores de acceso",
         "pl": "Poprawiono niektóre błędy dostępu",
         "zh-cn": "一些访问错误已得到纠正"
-      },
-      "0.4.0": {
-        "en": "Added socket commands",
-        "de": "Socket-Befehle hinzugefügt",
-        "ru": "Добавлены команды сокета",
-        "pt": "Comandos de soquete adicionados",
-        "nl": "Socket-opdrachten toegevoegd",
-        "fr": "Commandes de socket ajoutées",
-        "it": "Aggiunti comandi socket",
-        "es": "Comandos de socket agregados",
-        "pl": "Dodano polecenia dotyczące gniazd",
-        "zh-cn": "添加了套接字命令"
-      },
-      "0.3.6": {
-        "en": "Added object creation and enumerations reading",
-        "de": "Objekterstellung und Lesen von Aufzählungen hinzugefügt",
-        "ru": "Добавлено создание объектов и чтение перечислений",
-        "pt": "Adicionado criação de objetos e leitura de enumerações",
-        "nl": "Toegevoegd objectcreatie en opsommingen lezen",
-        "fr": "Ajout de la création d'objets et de la lecture des énumérations",
-        "it": "Aggiunta creazione di oggetti e lettura di enumerazioni",
-        "es": "Añadida creación de objetos y lectura de enumeraciones.",
-        "pl": "Dodano tworzenie obiektów i odczytywanie wyliczeń",
-        "zh-cn": "添加了对象创建和枚举读取"
-      },
-      "0.3.5": {
-        "en": "Allowed the reading of current subscriptions",
-        "de": "Erlaubt das Lesen aktueller Abonnements",
-        "ru": "Разрешено чтение текущих подписок",
-        "pt": "Permitiu a leitura de assinaturas atuais",
-        "nl": "Lezen van huidige abonnementen toegestaan",
-        "fr": "Autorisé la lecture des abonnements en cours",
-        "it": "Consentita la lettura degli abbonamenti in corso",
-        "es": "Permitida la lectura de suscripciones vigentes",
-        "pl": "Umożliwił czytanie aktualnych subskrypcji",
-        "zh-cn": "允许阅读当前订阅"
       }
     },
     "title": "REST API",

package/lib/api/controllers/common.js

@@ -31,7 +31,7 @@ function findState(adapter, idOrName, user, type, callback) {
         callback = type;
         type = null;
     }
-    adapter.findForeignObject(idOrName, type, {user: user, checked: true, limitToOwnerRights: adapter.config.onlyAllowWhenUserIsOwner}, callback);
+    adapter.findForeignObject(idOrName, type, {user, checked: true, limitToOwnerRights: adapter.config.onlyAllowWhenUserIsOwner}, callback);
 }
 
 function getState(adapter, idOrName, user, type, callback) {
@@ -48,7 +48,7 @@ function getState(adapter, idOrName, user, type, callback) {
                 id = idOrName;
             }
             if (id) {
-                adapter.getForeignState(id, {user: user, limitToOwnerRights: adapter.config.onlyAllowWhenUserIsOwner}, (err, state) => {
+                adapter.getForeignState(id, {user, limitToOwnerRights: adapter.config.onlyAllowWhenUserIsOwner}, (err, state) => {
                     if (err || !state) {
                         state = undefined;
                     }
@@ -61,6 +61,42 @@ function getState(adapter, idOrName, user, type, callback) {
     });
 }
 
+function getBinaryState(adapter, idOrName, user, type, callback) {
+    if (typeof type === 'function') {
+        callback = type;
+        type = null;
+    }
+    findState(adapter, idOrName, user, type, (err, id, originId) => {
+        if (err && (!err.message || !err.message.includes('permissionError'))) {
+            callback && callback(err, undefined, null, originId);
+        } else {
+            if (err && err.message.includes('permissionError')) {
+                // assume it is ID
+                id = idOrName;
+            }
+            if (id) {
+                if (adapter.getForeignBinaryState) {
+                    adapter.getForeignBinaryState(id, {user, limitToOwnerRights: adapter.config.onlyAllowWhenUserIsOwner}, (err, binary) => {
+                        if (err) {
+                            binary = undefined;
+                        }
+                        callback && callback (err, binary, id, originId);
+                    });
+                } else {
+                    adapter.getBinaryState(id, {user, limitToOwnerRights: adapter.config.onlyAllowWhenUserIsOwner}, (err, binary) => {
+                        if (err) {
+                            binary = undefined;
+                        }
+                        callback && callback (err, binary, id, originId);
+                    });
+                }
+            } else {
+                callback && callback(null, undefined, null, originId);
+            }
+        }
+    });
+}
+
 function parseUrl(url, swagger, webExtensionPrefix) {
     // "/v1/object/adapter.system.admin.0.alive"
     const parts = url.split('?')[0].split('/');
@@ -108,6 +144,7 @@ module.exports = {
     checkPermissions,
     findState,
     getState,
+    getBinaryState,
     parseUrl,
     errorResponse,
 };

package/lib/api/controllers/sendTo.js

@@ -1,120 +1,123 @@
 'use strict';
 const commonLib = require('./common.js');
 
-module.exports = {
-    sendTo: function (req, res) {
-        commonLib.checkPermissions(req._adapter, req._user, [{type: 'other', operation: 'sendto'}],  async error => {
-            if (error) {
-                commonLib.errorResponse(req, res, error);
-            } else {
-                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
-                let message = req.query.message;
-                let noResponse = req.query.noResponse;
-                let timeout = req.query.timeout;
-                let data = req.query.data;
-                if (req.body && req.body.message) {
-                    message = req.query.message;
-                }
-                if (req.body && req.body.timeout) {
-                    timeout = req.query.timeout;
-                }
-                timeout = parseInt(timeout, 10) || 10000;
-                if (req.body && req.body.noResponse !== undefined) {
-                    noResponse = req.query.noResponse;
-                }
-                noResponse = noResponse === 'true';
+function sendTo(req, res) {
+    commonLib.checkPermissions(req._adapter, req._user, [{type: 'other', operation: 'sendto'}],  async error => {
+        if (error) {
+            commonLib.errorResponse(req, res, error);
+        } else {
+            const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
+            let message = req.query.message;
+            let noResponse = req.query.noResponse;
+            let timeout = req.query.timeout;
+            let data = req.query.data;
+            if (req.body && req.body.message) {
+                message = req.query.message;
+            }
+            if (req.body && req.body.timeout) {
+                timeout = req.query.timeout;
+            }
+            timeout = parseInt(timeout, 10) || 10000;
+            if (req.body && req.body.noResponse !== undefined) {
+                noResponse = req.query.noResponse;
+            }
+            noResponse = noResponse === 'true';
 
-                if (req.body && req.body.data !== undefined) {
-                    data = req.query.data;
-                } else {
-                    if (data !== undefined && data !== null) {
-                        if (data === 'null') {
-                            data = null;
-                        } else if (data === 'undefined') {
-                            data = undefined;
-                        } else if (data === 'true') {
-                            data = true;
-                        } else if (data === 'false') {
-                            data = false;
-                        } else if (isFinite(data)) {
-                            data = parseFloat(data);
-                        } else if (data.startsWith('{') && data.endsWith('}')) {
-                            try {
-                                data = JSON.parse(data);
-                            } catch (error) {
-                                // ignore
-                            }
-                        } else if (data.startsWith('[') && data.endsWith(']')) {
-                            try {
-                                data = JSON.parse(data);
-                            } catch (error) {
-                                // ignore
-                            }
+            if (req.body && req.body.data !== undefined) {
+                data = req.query.data;
+            } else {
+                if (data !== undefined && data !== null) {
+                    if (data === 'null') {
+                        data = null;
+                    } else if (data === 'undefined') {
+                        data = undefined;
+                    } else if (data === 'true') {
+                        data = true;
+                    } else if (data === 'false') {
+                        data = false;
+                    } else if (isFinite(data)) {
+                        data = parseFloat(data);
+                    } else if (data.startsWith('{') && data.endsWith('}')) {
+                        try {
+                            data = JSON.parse(data);
+                        } catch (error) {
+                            // ignore
+                        }
+                    } else if (data.startsWith('[') && data.endsWith(']')) {
+                        try {
+                            data = JSON.parse(data);
+                        } catch (error) {
+                            // ignore
                         }
                     }
                 }
-                const instance = params.instance;
+            }
+            const instance = params.instance;
 
-                if (!instance) {
-                    res
-                        .status(422)
-                        .json({error: 'No instance provided'});
-                    return;
-                }
-                if (!message) {
-                    res
-                        .status(422)
-                        .json({error: 'No message provided'});
-                    return;
-                }
+            if (!instance) {
+                res
+                    .status(422)
+                    .json({error: 'No instance provided'});
+                return;
+            }
+            if (!message) {
+                res
+                    .status(422)
+                    .json({error: 'No message provided'});
+                return;
+            }
 
-                // check if instance is alive
-                let state;
-                try {
-                    state = await req._adapter.getForeignStateAsync(`system.adapter.${instance}.alive`);
-                    if (!state || !state.val) {
-                        res
-                            .status(500)
-                            .json({error: 'instance is not online', instance});
-                        return;
-                    }
-                } catch (error) {
+            // check if instance is alive
+            let state;
+            try {
+                state = await req._adapter.getForeignStateAsync(`system.adapter.${instance}.alive`);
+                if (!state || !state.val) {
                     res
                         .status(500)
-                        .json({error: 'invalid instance', instance});
+                        .json({error: 'instance is not online', instance});
                     return;
                 }
-                if (noResponse) {
-                    req._adapter.sendTo(instance, message, data);
-                    res.json({result: 'sent'});
-                } else {
-                    let timer;
-                    let answerDone = false;
-                    if (timeout) {
-                        timer = setTimeout(() => {
-                            timer = null;
-                            if (!answerDone) {
-                                answerDone = true;
-                                res.status(408).json({error: 'timeout'});
-                            }
-                        }, timeout);
-                    }
-
-                    req._adapter.sendTo(instance, message, data, (result, result1) => {
-                        timer && clearTimeout(timer);
+            } catch (error) {
+                res
+                    .status(500)
+                    .json({error: 'invalid instance', instance});
+                return;
+            }
+            if (noResponse) {
+                req._adapter.sendTo(instance, message, data);
+                res.json({result: 'sent'});
+            } else {
+                let timer;
+                let answerDone = false;
+                if (timeout) {
+                    timer = setTimeout(() => {
+                        timer = null;
                         if (!answerDone) {
                             answerDone = true;
-                            if (!result && result1) {
-                                res.json(result1);
-                            } else if (result && !result1) {
-                                res.json(result);
-                            } else {
-                                res.json({error: result, result: result1});
-                            }
+                            res.status(408).json({error: 'timeout'});
                         }
-                    });
+                    }, timeout);
                 }
+
+                req._adapter.sendTo(instance, message, data, (result, result1) => {
+                    timer && clearTimeout(timer);
+                    if (!answerDone) {
+                        answerDone = true;
+                        if (!result && result1) {
+                            res.json(result1);
+                        } else if (result && !result1) {
+                            res.json(result);
+                        } else {
+                            res.json({error: result, result: result1});
+                        }
+                    }
+                });
             }
-        });
-    },
+        }
+    });
+}
+
+module.exports = {
+    sendToPost: sendTo,
+    sendTo: sendTo,
 };

package/lib/api/controllers/state.js

@@ -295,6 +295,101 @@ module.exports = {
         });
     },
 
+    readBinaryState: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'state', 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);
+                const oId = getIDs(params.stateId)[0];
+
+                let result;
+                let foundID;
+                try {
+                    const {binary, id, originId} = await new Promise((resolve, reject) => commonLib.getBinaryState(req._adapter, oId, req._user, (error, binary, id) =>
+                        error ? reject(error) : resolve({binary, id})));
+
+                    if (!id) {
+                        res.status(404).json({error: 'ID not found', id: originId});
+                        return;
+                    }
+                    result = binary;
+                    foundID = id;
+                } catch (error) {
+                    req._adapter.log.warn(`Cannot read ${oId}: ${error}`);
+                    commonLib.errorResponse(req, res, error, {id: oId});
+                    return;
+                }
+
+                // try to detect popular content types
+                foundID = foundID.toLowerCase()
+                if (foundID.endsWith('.png')) {
+                    res.setHeader('Content-Type', 'image/png');
+                } else if (foundID.endsWith('.jpg')) {
+                    res.setHeader('Content-Type', 'image/jpeg');
+                } else if (foundID.endsWith('.svg')) {
+                    res.setHeader('Content-Type', 'image/svg+xml');
+                } else if (foundID.endsWith('.txt')) {
+                    res.setHeader('Content-Type', 'text/plain');
+                } else if (foundID.endsWith('.json')) {
+                    res.setHeader('Content-Type', 'application/json');
+                } else if (foundID.endsWith('.mp3')) {
+                    res.setHeader('Content-Type', 'audio/mpeg');
+                } else if (foundID.endsWith('.wav')) {
+                    res.setHeader('Content-Type', 'audio/wav');
+                } else if (foundID.endsWith('.ogg')) {
+                    res.setHeader('Content-Type', 'audio/ogg');
+                } else {
+                    res.setHeader('Content-Type', 'application/octet-stream');
+                }
+
+                res.send(result);
+            }
+        });
+    },
+
+    writeBinaryState: function (req, res) {
+        commonLib.checkPermissions(req._adapter, req._user, [{type: 'state', operation: 'write'}], error => {
+            if (error) {
+                commonLib.errorResponse(req, res, error);
+            } else {
+                const params = commonLib.parseUrl(req.url, req.swagger, req._adapter.WEB_EXTENSION_PREFIX);
+                const oId = getIDs(params.stateId)[0];
+
+                commonLib.findState(req._adapter, oId, req._user, async (error, id, originId) => {
+                    if (error && error.message && error.message.includes('permissionError')) {
+                        // assume it is ID
+                        id = oId;
+                        error = null;
+                    }
+
+                    if (error) {
+                        commonLib.errorResponse(req, res, error, {id: oId});
+                    } else if (!id) {
+                        res.status(404).json({error: 'ID not found', id: oId});
+                    } else {
+                        try {
+                            const obj = await req._adapter.getForeignObjectAsync(id, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
+                            if (obj && obj.common && obj.common.type === 'file') {
+                                if (req._adapter.setForeignBinaryStateAsync) {
+                                    await req._adapter.setForeignBinaryStateAsync(id, req.body, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
+                                } else {
+                                    await req._adapter.setBinaryStateAsync(id, req.body, {user: req._user, limitToOwnerRights: req._adapter.config.onlyAllowWhenUserIsOwner});
+                                }
+                                res.status(200).json({result: 'ok', id});
+                            } else {
+                                res.status(422).json({error: 'State is not binary', id});
+                            }
+                        } catch (error) {
+                            req._adapter.log.warn(`Cannot read object ${id}: ${error.toString()}`);
+                            res.status(401).json({error: `Cannot read object ${id}: ${error.toString()}`, id});
+                        }
+                    }
+                });
+            }
+        });
+    },
+
     plainState: function (req, res) {
         commonLib.checkPermissions(req._adapter, req._user, [{type: 'state', operation: 'read'}], async error => {
             if (error) {

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.1"
+  version: "1.0.5"
   title: "ioBroker Swagger UI"
   contact:
     email: "admin@iobroker.net"
@@ -16,6 +16,8 @@ basePath: "/v1"
 tags:
   - name: "state"
     description: "Read, write the states"
+  - name: "binary"
+    description: "Read, write the binary states"
   - name: "object"
     description: "Read the objects"
   - name: "history"
@@ -94,6 +96,12 @@ paths:
           required: false
           type: "integer"
           format: "int64"
+        - in: "body"
+          required: true
+          name: "data"
+          description: "State object to write"
+          schema:
+            $ref: "#/definitions/WriteState"
       responses:
         200:
           description: "successful operation"
@@ -105,6 +113,7 @@ paths:
           description: "State not found"
         405:
           description: "Invalid value"
+
   /state/{stateId}/toggle:
     x-swagger-router-controller: state
     get:
@@ -262,6 +271,63 @@ paths:
           description: "State not found"
         400:
           description: "Invalid state ID supplied"
+  /binary/{stateId}:
+    x-swagger-router-controller: state
+    get:
+      tags:
+        - "binary"
+      summary: "Read value of the binary state as stream"
+      operationId: "readBinaryState"
+      produces:
+        - "application/octet-stream"
+      parameters:
+        - name: "stateId"
+          in: "path"
+          description: "ID of the state to return"
+          required: true
+          type: "string"
+
+      responses:
+        200:
+          description: "successful operation"
+        404:
+          description: "State not found"
+        400:
+          description: "Invalid state ID supplied"
+    patch:
+      tags:
+        - "binary"
+      summary: "Update the value of the state"
+      description: ""
+      operationId: "writeBinaryState"
+      consumes:
+        - "application/octet-stream"
+      produces:
+        - "application/json"
+      parameters:
+        - in: "path"
+          name: "stateId"
+          description: "ID of the state to write"
+          required: true
+          type: "string"
+        - in: "body"
+          required: true
+          name: "data"
+          description: "Binary data to write"
+          schema:
+            type: string
+            format: binary
+      responses:
+        200:
+          description: "successful operation"
+          schema:
+            $ref: "#/definitions/State"
+        400:
+          description: "Invalid state ID supplied"
+        404:
+          description: "State not found"
+        405:
+          description: "Invalid value"
   /states:
     x-swagger-router-controller: state
     get:
@@ -456,7 +522,7 @@ paths:
         - "object"
       summary: "Delete object"
       description: ""
-      operationId: "deletedObject"
+      operationId: "deleteObject"
       produces:
         - "application/json"
       parameters:
@@ -559,9 +625,7 @@ paths:
         200:
           description: "successful operation"
           schema:
-            type: array
-            items:
-              $ref: "#/definitions/Object"
+            $ref: "#/definitions/ObjectArray"
         404:
           description: "URL or session not found"
         422:
@@ -905,7 +969,7 @@ paths:
         - "sendTo"
       summary: "Send message to instance as POST"
       description: "You can send message to instance that supports it"
-      operationId: "sendTo"
+      operationId: "sendToPost"
       consumes:
         - "application/json"
       produces:
@@ -950,6 +1014,23 @@ paths:
       responses:
         200:
           description: "successful operation"
+  /command/getForeignStates:
+    get:
+      tags:
+        - "commands"
+      summary: "same as getStates"
+      produces:
+        - "application/json"
+      parameters:
+
+        - name: "pattern"            
+          in: "query"
+          description: ""
+          type: "string"
+          required: true        
+      responses:
+        200:
+          description: "successful operation"
   /command/getState:
     get:
       tags:
@@ -1691,6 +1772,16 @@ paths:
       responses:
         200:
           description: "successful operation"
+  /command/getCompactSystemRepositories:
+    get:
+      tags:
+        - "commands"
+      summary: ""
+      produces:
+        - "application/json"        
+      responses:
+        200:
+          description: "successful operation"
   /command/getCompactRepository:
     get:
       tags:
@@ -1883,23 +1974,6 @@ paths:
       responses:
         200:
           description: "successful operation"
-  /command/getForeignStates:
-    get:
-      tags:
-        - "commands"
-      summary: "same as getStates"
-      produces:
-        - "application/json"
-      parameters:
-
-        - name: "pattern"            
-          in: "query"
-          description: ""
-          type: "string"
-          required: true        
-      responses:
-        200:
-          description: "successful operation"
   /command/delObjects:
     get:
       tags:
@@ -2082,7 +2156,6 @@ definitions:
         type: "string"
         description: "ID of the state"
       val:
-        type: "string"
         description: "Actual value"
       q:
         type: "integer"
@@ -2114,6 +2187,29 @@ definitions:
       native:
         type: "object"
         description: "Native state description"
+  WriteState:
+    type: "object"
+    properties:
+      val:
+        description: "Actual value"
+      q:
+        type: "integer"
+        format: "int32"
+        description: "Quality"
+      ts:
+        type: "integer"
+        format: "int64"
+        description: "Timestamp in ms from epoch of last update"
+      lc:
+        type: "integer"
+        format: "int64"
+        description: "Timestamp in ms from epoch of last value change"
+      ack:
+        type: "boolean"
+        description: "Is acknowledged. true = update, false = command"
+      expire:
+        type: "integer"
+        description: "Expire in seconds"
   #Type:
   #  type: "string"
   #  enum: [state, channel, device, enum, instance, adapter, host, chart, script, folder]
@@ -2133,6 +2229,10 @@ definitions:
       native:
         type: "object"
         description: "Native state description"
+  ObjectArray:
+    type: "object"
+    additionalProperties:
+      $ref: "#/definitions/Object"
   UrlHook:
     type: "object"
     properties:
@@ -2227,7 +2327,6 @@ definitions:
     type: "object"
     properties:
       val:
-        type: "number"
         description: "Value"
       ts:
         type: "number"
@@ -2252,7 +2351,6 @@ definitions:
     type: "object"
     properties:
       val:
-        type: "number"
         description: "Value"
       ts:
         type: "number"

package/lib/rest-api.js

@@ -14,7 +14,7 @@ const cors          = require('cors');
 const fs            = require('fs');
 const path          = require('path');
 const utils         = require('@iobroker/adapter-core'); // Get common adapter utils
-const tools         = require(utils.controllerDir + '/lib/tools');
+const pattern2RegEx = utils.commonTools.pattern2RegEx;
 const CommandsAdmin = require('@iobroker/socket-classes').SocketCommandsAdmin;
 const CommandsCommon = require('@iobroker/socket-classes').SocketCommands;
 const common        = require('./common');
@@ -258,9 +258,28 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
 
     // enable cors only if standalone
     !instanceSettings && this.app.use(cors());
-    this.app.use(bodyParser.json({
+    const jsonParser = bodyParser.json({
+        limit: '100mb',
+    });
+    const rawParser = bodyParser.raw({
+        limit: '100mb',
+    });
+
+    this.app.use((req, res, next) => {
+        if (req.method !== 'GET' && req.url.startsWith('/v1/binary/')) {
+            rawParser(req, res, next);
+        } else {
+            jsonParser(req, res, next);
+        }
+    });
+    /*this.app.use(bodyParser.json({
         limit: '100mb',
     }));
+    this.app.use(bodyParser.urlencoded({
+        extended: true,
+        parameterLimit: 100000,
+        limit: '100mb',
+    }));*/
 
     const _options = {
         appRoot: __dirname,
@@ -514,7 +533,7 @@ function SwaggerUI(_ignore, webSettings, adapter, instanceSettings, app, callbac
             const item = {id, delta: options.delta, onchange: options.onchange};
             this.subscribes[urlHash][type].push(item);
             if (item.id.includes('*')) {
-                item.regEx = new RegExp(tools.pattern2RegEx(item.id));
+                item.regEx = new RegExp(pattern2RegEx(item.id));
             }
 
             if (type === 'state') {

package/main.js

@@ -4,7 +4,7 @@
 'use strict';
 
 const utils       = require('@iobroker/adapter-core'); // Get common adapter utils
-const LE          = require(utils.controllerDir + '/lib/letsencrypt.js');
+const LE          = utils.commonTools.letsEncrypt;
 const RestAPI     = require('./lib/rest-api.js');
 const adapterName = require('./package.json').name.split('.').pop();
 
@@ -137,14 +137,14 @@ function initWebServer(settings, callback) {
                 }
             });
 
-            adapter.getPort(settings.port, port => {
+            adapter.getPort(settings.port, (!settings.bind || settings.bind === '0.0.0.0') ? undefined : settings.bind || undefined, port => {
                 if (port !== settings.port && !adapter.config.findNextPort) {
                     adapter.log.error(`port ${settings.port} already in use`);
                     process.exit(1);
                 }
                 serverPort = port;
 
-                server.server.listen(port, async () => {
+                server.server.listen(port, (!settings.bind || settings.bind === '0.0.0.0') ? undefined : settings.bind || undefined, async () => {
                     await adapter.setStateAsync('info.connection', true, true);
                     adapter.log.info(`http${settings.secure ? 's' : ''} server listening on port ${port}`);
                     serverListening = true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.rest-api",
-  "version": "1.0.1",
+  "version": "1.0.5",
   "description": "RESTful interface for ioBroker with GUI.",
   "author": {
     "name": "bluefox",
@@ -19,27 +19,28 @@
     "url": "https://github.com/ioBroker/ioBroker.rest-api"
   },
   "dependencies": {
-    "@iobroker/adapter-core": "^2.6.0",
-    "@iobroker/socket-classes": "^0.5.0",
-    "axios": "^0.27.2",
-    "body-parser": "^1.20.0",
+    "@iobroker/adapter-core": "^2.6.7",
+    "@iobroker/socket-classes": "^1.1.5",
+    "axios": "^1.3.4",
+    "body-parser": "^1.20.2",
     "cors": "^2.8.5",
-    "express": "^4.18.1",
+    "express": "^4.18.2",
     "swagger-node-runner-fork": "^0.8.0",
-    "swagger-ui-express": "^4.5.0",
+    "swagger-ui-express": "^4.6.2",
     "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/testing": "^3.0.2",
-    "chai": "^4.3.6",
+    "@iobroker/adapter-dev": "^1.2.0",
+    "@iobroker/testing": "^4.1.0",
+    "chai": "^4.3.7",
     "eslint-plugin-eqeqeq-fix": "^1.0.3",
-    "eslint-plugin-only-warn": "^1.0.3",
-    "eslint-plugin-react": "^7.30.1",
+    "eslint-plugin-only-warn": "^1.1.0",
+    "eslint-plugin-react": "^7.32.2",
     "gulp": "^4.0.2",
-    "mocha": "^9.2.2"
+    "mocha": "^10.2.0"
   },
   "bugs": {
     "url": "https://github.com/ioBroker/ioBroker.rest-api/issues"
@@ -60,7 +61,8 @@
     "release": "release-script",
     "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"
+    "release-major": "release-script major --yes --no-update-lockfile",
+    "translate": "translate-adapter"
   },
   "license": "Apache-2.0"
 }