iobroker.sonoff 2.5.3 → 3.0.3

package/lib/tools.js

@@ -1,99 +1,99 @@
-const axios = require('axios').default;
-
-/**
- * Tests whether the given variable is a real object and not an Array
- * @param {any} it The variable to test
- * @returns {it is Record<string, any>}
- */
-function isObject(it) {
-    // This is necessary because:
-    // typeof null === 'object'
-    // typeof [] === 'object'
-    // [] instanceof Object === true
-    return Object.prototype.toString.call(it) === '[object Object]';
-}
-
-/**
- * Tests whether the given variable is really an Array
- * @param {any} it The variable to test
- * @returns {it is any[]}
- */
-function isArray(it) {
-    if (typeof Array.isArray === 'function') return Array.isArray(it);
-    return Object.prototype.toString.call(it) === '[object Array]';
-}
-
-/**
- * Translates text to the target language. Automatically chooses the right translation API.
- * @param {string} text The text to translate
- * @param {string} targetLang The target languate
- * @param {string} [yandexApiKey] The yandex API key. You can create one for free at https://translate.yandex.com/developers
- * @returns {Promise<string>}
- */
-async function translateText(text, targetLang, yandexApiKey) {
-    if (targetLang === 'en') {
-        return text;
-    } else if (!text) {
-        return '';
-    }
-    if (yandexApiKey) {
-        return translateYandex(text, targetLang, yandexApiKey);
-    } else {
-        return translateGoogle(text, targetLang);
-    }
-}
-
-/**
- * Translates text with Yandex API
- * @param {string} text The text to translate
- * @param {string} targetLang The target languate
- * @param {string} apiKey The yandex API key. You can create one for free at https://translate.yandex.com/developers
- * @returns {Promise<string>}
- */
-async function translateYandex(text, targetLang, apiKey) {
-    if (targetLang === 'zh-cn') {
-        targetLang = 'zh';
-    }
-    try {
-        const url = `https://translate.yandex.net/api/v1.5/tr.json/translate?key=${apiKey}&text=${encodeURIComponent(text)}&lang=en-${targetLang}`;
-        const response = await axios({url, timeout: 15000});
-        if (response.data && response.data.text && isArray(response.data.text)) {
-            return response.data.text[0];
-        }
-        throw new Error('Invalid response for translate request');
-    } catch (e) {
-        throw new Error(`Could not translate to "${targetLang}": ${e}`);
-    }
-}
-
-/**
- * Translates text with Google API
- * @param {string} text The text to translate
- * @param {string} targetLang The target languate
- * @returns {Promise<string>}
- */
-async function translateGoogle(text, targetLang) {
-    try {
-        const url = `http://translate.googleapis.com/translate_a/single?client=gtx&sl=en&tl=${targetLang}&dt=t&q=${encodeURIComponent(text)}&ie=UTF-8&oe=UTF-8`;
-        const response = await axios({url, timeout: 15000});
-        if (isArray(response.data)) {
-            // we got a valid response
-            return response.data[0][0][0];
-        }
-        throw new Error('Invalid response for translate request');
-    } catch (e) {
-        if (e.response && e.response.status === 429) {
-            throw new Error(
-                `Could not translate to "${targetLang}": Rate-limited by Google Translate`
-            );
-        } else {
-            throw new Error(`Could not translate to "${targetLang}": ${e}`);
-        }
-    }
-}
-
-module.exports = {
-    isArray,
-    isObject,
-    translateText
-};
+const axios = require('axios').default;
+
+/**
+ * Tests whether the given variable is a real object and not an Array
+ * @param {any} it The variable to test
+ * @returns {it is Record<string, any>}
+ */
+function isObject(it) {
+    // This is necessary because:
+    // typeof null === 'object'
+    // typeof [] === 'object'
+    // [] instanceof Object === true
+    return Object.prototype.toString.call(it) === '[object Object]';
+}
+
+/**
+ * Tests whether the given variable is really an Array
+ * @param {any} it The variable to test
+ * @returns {it is any[]}
+ */
+function isArray(it) {
+    if (typeof Array.isArray === 'function') return Array.isArray(it);
+    return Object.prototype.toString.call(it) === '[object Array]';
+}
+
+/**
+ * Translates text to the target language. Automatically chooses the right translation API.
+ * @param {string} text The text to translate
+ * @param {string} targetLang The target languate
+ * @param {string} [yandexApiKey] The yandex API key. You can create one for free at https://translate.yandex.com/developers
+ * @returns {Promise<string>}
+ */
+async function translateText(text, targetLang, yandexApiKey) {
+    if (targetLang === 'en') {
+        return text;
+    } else if (!text) {
+        return '';
+    }
+    if (yandexApiKey) {
+        return translateYandex(text, targetLang, yandexApiKey);
+    } else {
+        return translateGoogle(text, targetLang);
+    }
+}
+
+/**
+ * Translates text with Yandex API
+ * @param {string} text The text to translate
+ * @param {string} targetLang The target languate
+ * @param {string} apiKey The yandex API key. You can create one for free at https://translate.yandex.com/developers
+ * @returns {Promise<string>}
+ */
+async function translateYandex(text, targetLang, apiKey) {
+    if (targetLang === 'zh-cn') {
+        targetLang = 'zh';
+    }
+    try {
+        const url = `https://translate.yandex.net/api/v1.5/tr.json/translate?key=${apiKey}&text=${encodeURIComponent(text)}&lang=en-${targetLang}`;
+        const response = await axios({url, timeout: 15000});
+        if (response.data && response.data.text && isArray(response.data.text)) {
+            return response.data.text[0];
+        }
+        throw new Error('Invalid response for translate request');
+    } catch (e) {
+        throw new Error(`Could not translate to "${targetLang}": ${e}`);
+    }
+}
+
+/**
+ * Translates text with Google API
+ * @param {string} text The text to translate
+ * @param {string} targetLang The target languate
+ * @returns {Promise<string>}
+ */
+async function translateGoogle(text, targetLang) {
+    try {
+        const url = `http://translate.googleapis.com/translate_a/single?client=gtx&sl=en&tl=${targetLang}&dt=t&q=${encodeURIComponent(text)}&ie=UTF-8&oe=UTF-8`;
+        const response = await axios({url, timeout: 15000});
+        if (isArray(response.data)) {
+            // we got a valid response
+            return response.data[0][0][0];
+        }
+        throw new Error('Invalid response for translate request');
+    } catch (e) {
+        if (e.response && e.response.status === 429) {
+            throw new Error(
+                `Could not translate to "${targetLang}": Rate-limited by Google Translate`
+            );
+        } else {
+            throw new Error(`Could not translate to "${targetLang}": ${e}`);
+        }
+    }
+}
+
+module.exports = {
+    isArray,
+    isObject,
+    translateText
+};

package/main.js

@@ -1,93 +1,101 @@
-/* jshint -W097 */
-/* jshint strict:true */
-/* jslint node: true */
-/* jslint esversion: 6 */
-
-/**
- *
- *      ioBroker sonoff Adapter
- *
- *      (c) 2017-2023 bluefox
- *
- *      MIT License
- *
- */
-'use strict';
-
-const utils       = require('@iobroker/adapter-core'); // Get common adapter utils
-const adapterName = require('./package.json').name.split('.').pop();
-const Server      = require('./lib/server');
-let   server      = null;
-let   adapter;
-
-function decrypt(key, value) {
-    let result = '';
-    for (let i = 0; i < value.length; ++i) {
-        result += String.fromCharCode(key[i % key.length].charCodeAt(0) ^ value.charCodeAt(i));
-    }
-    return result;
-}
-
-function startAdapter(options) {
-    options = options || {};
-    Object.assign(options, {name: adapterName});
-
-    adapter = new utils.Adapter(options);
-
-    adapter.on('ready', () => {
-        // it must be like this
-
-        adapter.getForeignObject('system.config', (err, obj) => {
-            if (obj && obj.native && obj.native.secret) {
-                //noinspection JSUnresolvedVariable
-                adapter.config.pass = decrypt(obj.native.secret, adapter.config.pass);
-            } else {
-                //noinspection JSUnresolvedVariable
-                adapter.config.pass = decrypt('Zgfr56gFe87jJOM', adapter.config.pass);
-            }
-            main();
-        });
-    });
-
-    adapter.on('unload', cb => {
-        if (server) {
-            server.destroy(cb);
-            server = null;
-        } else if (typeof cb === 'function') {
-            cb();
-        }
-    });
-
-    // is called if a subscribed state changes
-    adapter.on('stateChange', (id, state) => {
-        adapter.log.debug(`stateChange ${id}: ${JSON.stringify(state)}`);
-        // you can use the ack flag to detect if state is desired or acknowledged
-        state && !state.ack && server && server.onStateChange(id, state);
-    });
-    return adapter;
-}
-
-function main() {
-    adapter.config.TELE_SENSOR = adapter.config.TELE_SENSOR === true || adapter.config.TELE_SENSOR === 'true';
-    adapter.config.TELE_STATE  = adapter.config.TELE_STATE  === true || adapter.config.TELE_STATE  === 'true';
-    adapter.config.STAT_RESULT = adapter.config.STAT_RESULT === true || adapter.config.STAT_RESULT === 'true';
-    adapter.config.OBJ_TREE    = adapter.config.OBJ_TREE    === true || adapter.config.OBJ_TREE    === 'true';
-
-    // subscribe for all own variables
-    adapter.subscribeStates('*');
-
-    // read all states and set alive to false
-    adapter.getStatesOf('', '', (err, states) =>
-        states && states.length && states.forEach(state =>
-                state._id.match(/\.alive$/) && adapter.setForeignState(state._id, false, true)));
-
-    server = new Server(adapter);
-}
-
-// If started as allInOne/compact mode => return function to create instance
-if (module && module.parent) {
-    module.exports = startAdapter;
-} else {
-    // or start the instance directly
-    startAdapter();
-}
+/**
+ *
+ *      ioBroker sonoff Adapter
+ *
+ *      (c) 2017-2023 bluefox
+ *
+ *      MIT License
+ *
+ */
+'use strict';
+
+const utils       = require('@iobroker/adapter-core'); // Get common adapter utils
+const adapterName = require('./package.json').name.split('.').pop();
+const Server      = require('./lib/server');
+let   server      = null;
+let   adapter;
+
+function decrypt(key, value) {
+    let result = '';
+    for (let i = 0; i < value.length; ++i) {
+        result += String.fromCharCode(key[i % key.length].charCodeAt(0) ^ value.charCodeAt(i));
+    }
+    return result;
+}
+
+function startAdapter(options) {
+    options = options || {};
+    Object.assign(options, { name: adapterName });
+
+    adapter = new utils.Adapter(options);
+
+    adapter.on('ready', () => {
+        // delete pass if a password set
+        if (adapter.config.password && adapter.config.pass) {
+            // delete adapter.config.pass
+            adapter.getForeignObject(`system.adapter.${adapter.namespace}`, (err, config) => {
+                delete config.native.pass;
+                adapter.setForeignObject(config._id, config);
+            });
+        } else if (!adapter.config.password && adapter.config.pass) {
+            // migrate
+            adapter.getForeignObject('system.config', (err, systemConfig) => {
+                adapter.getForeignObject(`system.adapter.${adapter.namespace}`, (err, config) => {
+                    if (systemConfig && systemConfig.native && systemConfig.native.secret) {
+                        // noinspection JSUnresolvedVariable
+                        config.native.password = decrypt(systemConfig.native.secret, adapter.config.pass);
+                    } else {
+                        // noinspection JSUnresolvedVariable
+                        config.native.password = decrypt('Zgfr56gFe87jJOM', adapter.config.pass);
+                    }
+                    delete config.native.pass;
+                    adapter.setForeignObject(config._id, config);
+                });
+            });
+        } else {
+            main();
+        }
+    });
+
+    adapter.on('unload', cb => {
+        if (server) {
+            server.destroy(cb);
+            server = null;
+        } else if (typeof cb === 'function') {
+            cb();
+        }
+    });
+
+    // called if the subscribed state changes itself
+    adapter.on('stateChange', (id, state) => {
+        adapter.log.debug(`stateChange ${id}: ${JSON.stringify(state)}`);
+        // you can use the ack flag to detect if state is desired or acknowledged
+        state && !state.ack && server && server.onStateChange(id, state);
+    });
+    return adapter;
+}
+
+function main() {
+    adapter.config.TELE_SENSOR = adapter.config.TELE_SENSOR === true || adapter.config.TELE_SENSOR === 'true';
+    adapter.config.TELE_STATE  = adapter.config.TELE_STATE  === true || adapter.config.TELE_STATE  === 'true';
+    adapter.config.STAT_RESULT = adapter.config.STAT_RESULT === true || adapter.config.STAT_RESULT === 'true';
+    adapter.config.OBJ_TREE    = adapter.config.OBJ_TREE    === true || adapter.config.OBJ_TREE    === 'true';
+
+    // subscribe for all own variables
+    adapter.subscribeStates('*');
+
+    // read all states and set alive to false
+    adapter.getStatesOf('', '', (err, states) =>
+        states && states.length && states.forEach(state =>
+                state._id.match(/\.alive$/) && adapter.setForeignState(state._id, false, true)));
+
+    server = new Server(adapter);
+}
+
+// If started as allInOne/compact mode => return function to create instance
+if (module && module.parent) {
+    module.exports = startAdapter;
+} else {
+    // or start the instance directly
+    startAdapter();
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "iobroker.sonoff",
   "description": "The adapter allows to send and receive MQTT messages from ioBroker and to be a broker.",
-  "version": "2.5.3",
+  "version": "3.0.3",
   "author": "bluefox <dogafox@gmail.com>",
   "homepage": "https://github.com/ioBroker/ioBroker.sonoff",
   "repository": {
@@ -17,18 +17,18 @@
   ],
   "dependencies": {
     "mqtt-connection": "^4.1.0",
-    "@iobroker/adapter-core": "^2.6.8"
+    "@iobroker/adapter-core": "^3.0.3"
   },
   "devDependencies": {
-    "@alcalzone/release-script": "^3.5.9",
-    "@alcalzone/release-script-plugin-iobroker": "^3.5.9",
+    "@alcalzone/release-script": "^3.6.0",
+    "@alcalzone/release-script-plugin-iobroker": "^3.6.0",
     "@alcalzone/release-script-plugin-license": "^3.5.9",
-    "@iobroker/legacy-testing": "^0.1.1",
-    "axios": "^1.3.4",
+    "@iobroker/legacy-testing": "^1.0.0",
+    "axios": "^1.5.0",
     "mqtt": "^4.3.7",
     "gulp": "^4.0.2",
     "mocha": "^10.2.0",
-    "chai": "^4.3.7"
+    "chai": "^4.3.8"
   },
   "bugs": {
     "url": "https://github.com/ioBroker/ioBroker.sonoff/issues"
@@ -46,7 +46,8 @@
     "release": "release-script",
     "release-patch": "release-script patch --yes",
     "release-minor": "release-script minor --yes",
-    "release-major": "release-script major --yes"
+    "release-major": "release-script major --yes",
+    "update-packages": "ncu --upgrade"
   },
   "engines": {
     "node": ">=4.0.0"