iobroker.lovelace 4.1.0 → 4.1.1

package/README.md

@@ -473,6 +473,12 @@ After that checkout modified version in `./build` folder. Then.
 	PLACEHOLDER for next version:
 	### **WORK IN PROGRESS**
 -->
+### 4.1.1 (2024-01-02)
+* (Garfonso) changed: determining user id
+* (Garfosno) changed: history attributes handling
+* (Garfonso) added: handle browser_mod/recall_id service call.
+* (Garfonso) changed: all states are strings (fixes #483)
+
 ### 4.1.0 (2023-12-18)
 * (Garfons) add an option to show users on login screen (off by default)
 
@@ -488,12 +494,9 @@ After that checkout modified version in `./build` folder. Then.
 * (Garfonso) fix: login & authorization
 * (Garfonso) added: user images & names on login screen
 
-### 4.0.9 (2023-12-12)
-* (Garfonso) fixed: timestamp in legacy history data
-
 ## License
 
-Copyright 2019-2023, bluefox <dogafox@gmail.com>
+Copyright 2019-2024, bluefox <dogafox@gmail.com>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

package/io-package.json

@@ -1,8 +1,12 @@
 {
   "common": {
     "name": "lovelace",
-    "version": "4.1.0",
+    "version": "4.1.1",
     "news": {
+      "4.1.1": {
+        "en": "changed: determining user id\nchanged: history attributes handling\nadded: handle browser_mod/recall_id service call.\nchanged: all states are strings!",
+        "de": "geändert: bestimmung der benutzer-id\ngeändert: historie für attribute\nhinzugefügt: handle browser_mod/recall_id service call.\ngeändert: alle zustände sind strings!"
+      },
       "4.1.0": {
         "en": "add an option to show users on login screen (off by default)",
         "de": "Neu Option um Benutzer auf dem Login-Bildschirm anzuzeigen"
@@ -44,19 +48,6 @@
       "4.0.8": {
         "en": "re-add legacy history for custom cards",
         "de": "re-add die alten history methoden für benutzerdefinierte karten"
-      },
-      "4.0.7": {
-        "en": "history should be working again.",
-        "de": "history sollte wieder funktionieren.",
-        "ru": "история должна работать снова.",
-        "pt": "a história deve estar a trabalhar de novo.",
-        "nl": "de geschiedenis zou weer moeten werken.",
-        "fr": "l'histoire devrait retravailler.",
-        "it": "la storia dovrebbe funzionare di nuovo.",
-        "es": "la historia debe estar trabajando de nuevo.",
-        "pl": "historia powinna być kontynuowana.",
-        "uk": "історія повинна працювати знову.",
-        "zh-cn": "历史应该再次发挥作用。."
       }
     },
     "title": "Visualization with Lovelace-UI",

package/lib/converters/climate.js

@@ -237,11 +237,15 @@ function fillClimateEntityFromStates(states, objects, entity, iobType) {
 
     //controls hvac_mode which can be 'off' but not 'on', so translate 'on' to heat / cool depending on type.
     if (states.state || states.stateRead) {
+        if (!entity.attributes.hvac_modes) {
+            entity.attributes.hvac_modes = [];
+        }
+        entity.attributes.hvac_modes.push('off');
         if (!states.hvac_mode) {
             if (iobType === typeDetector.Types.airCondition) {
-                entity.attributes.hvac_modes = ['off', 'cool'];
+                entity.attributes.hvac_modes.push('cool');
             } else {
-                entity.attributes.hvac_modes = ['off', 'heat'];
+                entity.attributes.hvac_modes.push('heat');
             }
         }
         entity.context.STATE.getParser = function (entity, attr, state) {

package/lib/converters/genericConverter.js

@@ -48,8 +48,6 @@ exports.numericDeviceClasses = [
     'distance'
 ];
 
-const numericDeviceClassesIob = exports.numericDeviceClasses.concat(['timestamp']);
-
 exports.iobState2EntityState = function (entity, val, attribute) {
     let type = entity.context.type;
     const pos = type.lastIndexOf('.');
@@ -61,14 +59,17 @@ exports.iobState2EntityState = function (entity, val, attribute) {
         return val ? 'on' : 'off';
     } else if (type === 'binary_sensor') {
         return val ? 'on' : 'off';
-    } else if (typeof val === 'number' && entity.attributes && (numericDeviceClassesIob.includes(entity.attributes.device_class) || entity.attributes.unit_of_measurement)) {
-        return val; //do not convert timestamps or values that have a unit of measurement..
-    } else if (typeof val === 'number' && entity.attributes && ['date'].includes(entity.attributes.device_class)) {
-        const dateStr = new Date(val).toDateString(); //convert to date string
+    }else if (typeof val === 'number' && entity.attributes && ['date', 'timestamp'].includes(entity.attributes.device_class)) {
+        //convert to date string
+        const date = new Date(val);
+        let dateStr = date.toDateString();
+        if (attribute === 'timestamp') {
+            dateStr = date.toISOString();
+        }
         return dateStr === 'Invalid Date' ? 'unknown' : dateStr;
     } else if (type === 'lock') {
         return val ? 'unlocked' : 'locked';
-    } else if (typeof val === 'boolean' && type !== 'media_player') {
+    } else if (typeof val === 'boolean' && type !== 'media_player' && !attribute) { //attributes can have true/false.
         return val ? 'on' : 'off';
     } else if (typeof val === 'number' && entity.context.STATE.map2lovelace) {
         return entity.context.STATE.map2lovelace[val] || val;

package/lib/modules/browser_mod.js

@@ -344,6 +344,7 @@ class BrowserModModule {
                     instance: message.browserID,
                     ws
                 };
+                ws.browserID = message.browserID; //store browserID in ws object to handle recall service call later.
 
                 ws.send(JSON.stringify([{id: message.id, type: 'result', success: true, result: null}, {
                     id: message.id, type: 'event', event: {
@@ -399,6 +400,8 @@ class BrowserModModule {
                     this.adapter.log.debug('Updated browser_mod settings: ' + message.key + ' to ' + message.value);
                 }
                 //think about making this permanent somehow? -> but only if we find a way to allow browser_mod_settings panel.
+            } else if (method === 'recall_id') {
+                ws.send(JSON.stringify({id: message.id, type: 'result', success: true, result: ws.browserID}));
             } else {
                 this.adapter.log.warn('Unknown browser_mod method: ' + JSON.stringify(message));
             }

package/lib/modules/history.js

@@ -67,7 +67,7 @@ async function getHistory(adapter, entities, start, end, noAttributes, user) {
                                 }
                                 let found = false;
                                 let best = null;
-                                let bestDiff = 1000;
+                                let bestDiff = 10000;
                                 const results = attributesResult[attribute.attribute].result;
                                 for (const result of results) {
                                     if (result.val !== null) {
@@ -81,10 +81,10 @@ async function getHistory(adapter, entities, start, end, noAttributes, user) {
                                 }
                                 if (found) {
                                     attributeValues[attribute.attribute] = typeof attribute.historyParser === 'function' ? attribute.historyParser(id, best.val) : best.val;
-                                    best.used = true;
-                                } else {
+                                    best.used = true; //will be checked later, all "unused" attributes will be added without state later.
+                                } /*else { //let's try to leave attribute empty, for now, if no value in history that is closer than 10 seconds.
                                     attributeValues[attribute.attribute] = entity.attributes[attribute.attribute]; //use current value as default if none found.
-                                }
+                                }*/
                             }
                         }
                         for (const key of Object.keys(entity.attributes)) {
@@ -103,7 +103,7 @@ async function getHistory(adapter, entities, start, end, noAttributes, user) {
                             s: typeof entity.context.STATE.historyParser === 'function' ?
                                 entity.context.STATE.historyParser(id, e.val).toString() :
                                 iobState2EntityState(entity, e.val),
-                            a: noAttributes ? undefined : getAttributeValues(e, attributesResult, attributesUsed),
+                            a: noAttributes ? {} : getAttributeValues(e, attributesResult, attributesUsed),
                             lc: 1,
                             lu: 1
                         };
@@ -113,6 +113,8 @@ async function getHistory(adapter, entities, start, end, noAttributes, user) {
                     //add unused attribute values:
                     if (!noAttributes && entity.context.ATTRIBUTES) {
                         for (const attribute of entity.context.ATTRIBUTES) {
+                            //find other attributes for this type. Will use this attribute as "state" for the getAttributeValues function.
+                            // so we don't want to find this attribute again. Will add all matching attributes anyway. So in later runs this attribute will be "empty", i.e. all used.
                             attributesUsed.push(attribute.attribute);
                             const results = attributesResult[attribute.attribute].result;
                             for (const result of results) {
@@ -125,7 +127,7 @@ async function getHistory(adapter, entities, start, end, noAttributes, user) {
                                         //state: null,
                                         lc: 1,
                                         lu: 1,
-                                        a: noAttributes ? undefined : getAttributeValues(result, attributesResult, attributesUsed, attributeValues)
+                                        a: noAttributes ? {} : getAttributeValues(result, attributesResult, attributesUsed, attributeValues)
                                     };
                                     updateTimestamps(data, result, true);
                                     historyPerEntity.push(data);
@@ -137,6 +139,7 @@ async function getHistory(adapter, entities, start, end, noAttributes, user) {
                     if (historyPerEntity.length === 0) {
                         historyPerEntity.push({
                             s: entity.state,
+                            a: {},
                             lu: start / 1000
                         });
                     }
@@ -177,12 +180,12 @@ function sendHistoryResponse(ws, id, historyData, parameters) {
                 state.s = 'unknown';
             }
 
-            if (parameters.noAttributes) {
+            /*if (parameters.noAttributes) {
                 delete state.a;
             }
             if (parameters.minimalResponse) {
                 delete state.lc;
-            }
+            }*/
         }
     }
 
@@ -275,7 +278,7 @@ class HistoryModule {
                     id: Number(message.id)
                 };
 
-                // add subscribe here.
+                // add subscription here.
                 ws._subscribes.history = ws._subscribes.history || [];
                 ws._subscribes.history.push(parameters);
             } else if (message.type === 'history/history_during_period') {

package/lib/modules/person.js

@@ -22,6 +22,27 @@ class PersonModule {
         return result;
     }
 
+    /**
+     * Get the user id from the username
+     * @param {string} name
+     * @returns {string}
+     */
+    getUserIDFromName(name) {
+        for (const userObj of Object.values(this.usersCache)) {
+            if (userObj.name === name) {
+                return userObj.iobId;
+            }
+        }
+
+        //fallback, default user "admin" is misleading, if user renamed admin.. hm. :-/
+        if (this.adapter.config.auth && name === 'admin') {
+            return 'system.user.admin';
+        }
+
+        this.adapter.log.warn(`Could not get user id for ${name} - Trying with username` + JSON.stringify(this.usersCache['system.user.' + name.toLowerCase()]));
+        return 'system.user.' + name.toLowerCase(); //hack and not correct since js-controller 3.2
+    }
+
     onObjectChange(id, obj) {
         if (id.startsWith('system.user.')) {
             if (obj && obj.common && obj.common.enabled()) {
@@ -41,6 +62,7 @@ class PersonModule {
 
     async init() {
         const userObjects = await this.adapter.getForeignObjectsAsync('system.user.*', 'user');
+        let defaultUserObject = null;
         for (const [id, obj] of Object.entries(userObjects)) {
             if (obj.common && obj.common.enabled) { //only show enabled persons?
                 this.usersCache[id] = {
@@ -50,8 +72,24 @@ class PersonModule {
                     picture: obj.common.icon,
                     description: obj.common.desc
                 };
+                if (obj.common.name === this.adapter.config.defaultUser) {
+                    defaultUserObject = obj;
+                }
+            }
+        }
+
+        //default user only relevant for !auth.
+        if (!defaultUserObject) {
+            //Ok, we did not find defaultUser object. Might be renamed admin?
+            defaultUserObject = userObjects['system.user.admin'];
+            this.adapter.config.defaultUser = defaultUserObject.common.name;
+            if (this.adapter.config.defaultUser !== 'admin' && !this.adapter.config.auth) {
+                //Activating auth will hide this setting. Not sure what to do then... In general: all users will be able to read everything in this case.
+                this.adapter.log.warn(`Could not find default user ${this.adapter.config.defaultUser} - Using admin - Please update your configuration.`);
             }
         }
+
+
         await this.adapter.subscribeObjectsAsync('system.user.*');
     }
 }

package/lib/modules/todo.js

@@ -181,6 +181,9 @@ class TodoModule {
             if (state && state.val) {
                 try {
                     todoList.items = JSON.parse(state.val);
+                    if (!todoList.items || !Array.isArray(todoList.items)) {
+                        todoList.items = [];
+                    }
                     //convert legacy items:
                     for (const item of todoList.items) {
                         if (item.name && !item.summary) {

package/lib/server.js

@@ -518,7 +518,7 @@ class WebServer {
     }
 
     async _processSingleCall(ws, data, entity_id) {
-        const user = await this._getUserId(ws.__auth.username || this.config.defaultUser);
+        const user = this._modules.person.getUserIDFromName(ws.__auth.username || this.config.defaultUser);
 
         const entity = entityData.entityId2Entity[entity_id];
         const id = entity.context.STATE.setId;
@@ -681,7 +681,7 @@ class WebServer {
             entity.state = 'unknown';
             if (entity.context.STATE && entity.context.STATE.getId) {
                 try {
-                    const user = await this._getUserId(this.config.defaultUser); //TODO: why is this always defaultUser?
+                    const user = this._modules.person.getUserIDFromName(this.config.defaultUser); //TODO: why is this always defaultUser?
                     const state = await this.adapter.getForeignStateAsync(entity.context.STATE.getId, {user});
                     if (state) {
                         await this.onStateChange(entity.context.STATE.getId, state);
@@ -1477,7 +1477,7 @@ class WebServer {
             file = file.substring(0, pos);
         }
         try {
-            const user = await this._getUserId(this.config.defaultUser); //TODO: why is this always default user?
+            const user = this._modules.person.getUserIDFromName(this.config.defaultUser); //TODO: why is this always default user?
             let data;
             if (file.startsWith('/lovelace/')) {
                 file = file.replace('/lovelace/', '');
@@ -1501,7 +1501,7 @@ class WebServer {
             file = file.substring(0, pos);
         }
         try {
-            const user = await this._getUserId(this.config.defaultUser); //TODO: why is this always default user?
+            const user = this._modules.person.getUserIDFromName(this.config.defaultUser); //TODO: why is this always default user?
             const data = await this.adapter.readFileAsync(this.adapter.namespace, file.replace('/local/custom_ui/', '/cards/'), {user});
             const pos = req.url.lastIndexOf('.');
             res.setHeader('content-type', (mime.getType || mime.lookup).call(data.mimeType, file.substring(pos + 1).toLowerCase()));
@@ -1844,7 +1844,7 @@ class WebServer {
             }
 
             try {
-                const user = await this._getUserId(this.config.defaultUser); //TODO: why is this always default user?
+                const user = this._modules.person.getUserIDFromName(this.config.defaultUser); //TODO: why is this always default user?
                 const image = await this.adapter.readFileAsync(id, url, {user});
                 if (image.file === null || image.file === undefined) {
                     throw new Error('File empty');
@@ -1868,7 +1868,7 @@ class WebServer {
                 if (obj && obj.common.type === 'file')  {
                     contentType = (mime.getType || mime.lookup).call(mime, fileName[0]);
                 }
-                const user = await this._getUserId(this.config.defaultUser);
+                const user = this._modules.person.getUserIDFromName(this.config.defaultUser);
                 const data = await this.adapter.getBinaryStateAsync(fileName[0], {user});
                 if (data !== null && obj !== undefined) {
                     if (data && typeof data === 'object' && data.val !== undefined && data.ack !== undefined) {
@@ -1937,7 +1937,7 @@ class WebServer {
                 return res.status(404).json({error: 'Start or end misformated'});
             }
 
-            const user = await this._getUserId(this.config.defaultUser);
+            const user = this._modules.person.getUserIDFromName(this.config.defaultUser);
             try {
                 const state = await this.adapter.getForeignStateAsync(entity.context.STATE.getId, {user});
                 if (state && state.val) {
@@ -2018,29 +2018,8 @@ class WebServer {
         });
     }
 
-    async _getUserId(user) {
-        let userId = this._userNamesToIds[user];
-        if (userId) {
-            return userId;
-        }
-
-        if (typeof this.adapter.getUserID === 'function') {
-            try {
-                userId = await this.adapter.getUserID(user);
-                this._userNamesToIds[user] = userId;
-            } catch (err) {
-                this.log.warn(`Could not get user id for ${user} - ${err}`);
-            }
-        }
-        if (!userId) {
-            this.log.warn(`Could not get user id for ${user} - Trying with username`);
-            userId = 'system.user.' + user.toLowerCase(); //hack and not correct since js-controller 3.2
-        }
-        return userId;
-    }
-
     async _getCurrentUser(ws) {
-        const user = await this._getUserId(ws.__auth.username || this.config.defaultUser);
+        const user = this._modules.person.getUserIDFromName(ws.__auth.username || this.config.defaultUser);
         const userObj = {
             id: user,
             name: ws.__auth.username || this.config.defaultUser,
@@ -2159,7 +2138,7 @@ class WebServer {
             }
             if (id) {
                 try {
-                    const user = await this._getUserId(userName);
+                    const user = this._modules.person.getUserIDFromName(userName);
                     const state = await this.adapter.getForeignStateAsync(id, {user});
                     if (state && state.val && typeof state.val === 'string') {
                         const val = state.val.split('?')[0] || '';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.lovelace",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "With this adapter you can build visualization for ioBroker with Home Assistant Lovelace UI",
   "author": {
     "name": "bluefox",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@iobroker/adapter-core": "^3.0.4",
-    "axios": "^1.6.2",
+    "axios": "^1.6.3",
     "body-parser": "^1.20.2",
     "express": "^4.18.2",
     "iobroker.type-detector": "^3.0.5",
@@ -31,7 +31,7 @@
     "nyc": "^15.1.0",
     "pinyin": "^3.1.0",
     "translit-rus-eng": "^1.0.8",
-    "ws": "^8.15.1"
+    "ws": "^8.16.0"
   },
   "devDependencies": {
     "@alcalzone/release-script": "^3.7.0",
@@ -44,13 +44,13 @@
     "@types/chai-as-promised": "^7.1.8",
     "@types/gulp": "^4.0.17",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^16.18.68 < 17",
+    "@types/node": "^16.18.69 < 17",
     "@types/proxyquire": "^1.3.31",
     "@types/sinon": "^17.0.2",
     "@types/sinon-chai": "^3.2.12",
     "chai": "^4.3.10",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.55.0",
+    "eslint": "^8.56.0",
     "gulp": "^4.0.2",
     "mocha": "^10.2.0",
     "proxyquire": "^2.1.3",