iobroker.rest-api 0.3.0

package/main.js

@@ -0,0 +1,165 @@
+/* jshint -W097 */
+/* jshint strict: false */
+/* jslint node: true */
+'use strict';
+
+const utils       = require('@iobroker/adapter-core'); // Get common adapter utils
+const RestAPI     = require('./lib/rest-api.js');
+const LE          = require(utils.controllerDir + '/lib/letsencrypt.js');
+const adapterName = require('./package.json').name.split('.').pop();
+
+let webServer = null;
+let adapter;
+
+function startAdapter(options) {
+    options = options || {};
+    Object.assign(options, {
+        name: adapterName,
+        stateChange: (id, state) => {
+            webServer && webServer.api && webServer.api.stateChange(id, state);
+        },
+        objectChange: (id, obj) => webServer && webServer.api && webServer.api.objectChange(id, obj),
+        unload: callback => {
+            try {
+                adapter.log.info(`terminating http${adapter.config.secure ? 's' : ''} server on port ${adapter.config.port}`);
+                if (webServer && webServer.api) {
+                    webServer.api.unload()
+                        .then(() => {
+                            try {
+                                if (webServer.server) {
+                                    webServer.server.close();
+                                    webServer.server = null;
+                                }
+                            } catch (error) {
+                                // ignore
+                                console.error('Cannot close server: ' + error);
+                            }
+                            webServer = null;
+                            callback();
+                        });
+                } else {
+                    if (webServer && webServer.server) {
+                        webServer.server.close();
+                        webServer.server = null;
+                    }
+                    webServer = null;
+                    callback();
+                }
+            } catch (error) {
+                console.error('Cannot close server: ' + error);
+                callback();
+            }
+        },
+        ready: main
+    });
+
+    adapter = new utils.Adapter(options);
+
+    return adapter;
+}
+
+function main() {
+    if (adapter.config.webInstance) {
+        console.log('Adapter runs as a part of web service');
+        adapter.log.warn('Adapter runs as a part of web service');
+        adapter.setForeignState(`system.adapter.${adapter.namespace}.alive`, false, true, () =>
+            setTimeout(() => process.exit(), 1000));
+    } else {
+        if (adapter.config.secure) {
+            // Load certificates
+            adapter.getCertificates((err, certificates, leConfig) => {
+                adapter.config.certificates = certificates;
+                adapter.config.leConfig     = leConfig;
+                initWebServer(adapter.config, server =>
+                    webServer = server);
+            });
+        } else {
+            initWebServer(adapter.config, server =>
+                webServer = server);
+        }
+    }
+}
+
+//settings: {
+//    "port":   8080,
+//    "auth":   false,
+//    "secure": false,
+//    "bind":   "0.0.0.0", // "::"
+//    "cache":  false
+//}
+function initWebServer(settings, callback) {
+    settings.port = parseInt(settings.port, 10);
+
+    const server = {
+        app:    null,
+        server: null,
+        api:    null,
+        io:     null,
+        settings
+    };
+
+    server.api = new RestAPI(server.server, settings, adapter, null, null, async app => {
+        if (settings.port) {
+            if (settings.secure && !adapter.config.certificates) {
+                return null;
+            }
+
+            try {
+                server.server = await LE.createServerAsync(app, settings, adapter.config.certificates, adapter.config.leConfig, adapter.log);
+            } catch (err) {
+                adapter.log.error(`Cannot create webserver: ${err}`);
+                adapter.terminate ? adapter.terminate(1) : process.exit(1);
+                return;
+            }
+            server.server.__server = server;
+        } else {
+            adapter.log.error('port missing');
+            process.exit(1);
+        }
+
+        if (server.server) {
+            let serverListening = false;
+            let serverPort = settings.port;
+
+            server.server.on('error', e => {
+                if (e.toString().includes('EACCES') && serverPort <= 1024) {
+                    adapter.log.error(`node.js process has no rights to start server on the port ${serverPort}.\n` +
+                        `Do you know that on linux you need special permissions for ports under 1024?\n` +
+                        `You can call in shell following scrip to allow it for node.js: "iobroker fix"`
+                    );
+                } else {
+                    adapter.log.error(`Cannot start server on ${settings.bind || '0.0.0.0'}:${serverPort}: ${e}`);
+                }
+                if (!serverListening) {
+                    callback && callback(server);
+                    adapter.terminate ? adapter.terminate(1) : process.exit(1);
+                }
+            });
+
+            adapter.getPort(settings.port, 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, () =>
+                    serverListening = true);
+                adapter.log.info(`http${settings.secure ? 's' : ''} server listening on port ${port}`);
+                callback && callback(server);
+                callback = null;
+            });
+        } else if (callback) {
+            callback(server);
+            callback = null;
+        }
+    });
+}
+
+// If started as allInOne mode => return function to create instance
+if (module.parent) {
+    module.exports = startAdapter;
+} else {
+    // or start the instance directly
+    startAdapter();
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "iobroker.rest-api",
+  "version": "0.3.0",
+  "description": "RESTful interface for ioBroker with GUI.",
+  "author": {
+    "name": "bluefox",
+    "email": "dogafox@gmail.com"
+  },
+  "contributors": [],
+  "homepage": "https://github.com/ioBroker/ioBroker.rest-api",
+  "keywords": [
+    "ioBroker",
+    "rest-api",
+    "swagger-ui",
+    "web"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ioBroker/ioBroker.rest-api"
+  },
+  "dependencies": {
+    "express": "^4.17.3",
+    "body-parser": "^1.20.0",
+    "swagger-node-runner-fork": "^0.8.0",
+    "swagger-ui-express": "^4.3.0",
+    "yamljs": "^0.3.0",
+    "@iobroker/adapter-core": "^2.6.0",
+    "axios": "^0.26.1",
+    "cors": "^2.8.5"
+  },
+  "devDependencies": {
+    "@alcalzone/release-script": "^3.5.6",
+    "@alcalzone/release-script-plugin-iobroker": "^3.5.7",
+    "@alcalzone/release-script-plugin-license": "^3.5.3",
+    "eslint-plugin-eqeqeq-fix": "^1.0.3",
+    "eslint-plugin-only-warn": "^1.0.3",
+    "eslint-plugin-react": "^7.25.1",
+    "mocha": "^9.2.2",
+    "chai": "^4.3.6"
+  },
+  "bugs": {
+    "url": "https://github.com/ioBroker/ioBroker.rest-api/issues"
+  },
+  "main": "main.js",
+  "files": [
+    "admin/",
+    "img/",
+    "lib/",
+    "examples/",
+    "LICENSE",
+    "main.js",
+    "io-package.json"
+  ],
+  "scripts": {
+    "test": "node node_modules/mocha/bin/mocha --exit",
+    "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"
+  },
+  "license": "Apache 2.0"
+}