@iobroker/json-config 9.0.24 → 9.1.1

package/build/JsonConfigComponent/ConfigGeneric.js

@@ -65,6 +65,10 @@ export default class ConfigGeneric extends Component {
     reportedHidden = false;
     calculateTimeout = null;
     AsyncFunction;
+    /** Resolved `dependsOnStates` of this element: alias => state ID */
+    stateAliases = null;
+    /** True if this element has subscribed on states, so it must unsubscribe if `dependsOnStates` disappears */
+    statesSubscribed = false;
     constructor(props) {
         super(props);
         this.AsyncFunction = Object.getPrototypeOf(async function () { }).constructor;
@@ -98,7 +102,128 @@ export default class ConfigGeneric extends Component {
         }
         return (await this.props.oContext.socket.getObject(id)) || null;
     }
+    /**
+     * Bring the `dependsOnStates` attribute into the form `{ alias: stateID }`.
+     * In the short array form the state ID is used as an alias too.
+     *
+     * @param dependsOnStates value of the `dependsOnStates` attribute
+     * @returns aliases with the still unresolved state IDs
+     */
+    static normalizeDependsOnStates(dependsOnStates) {
+        const result = {};
+        if (!dependsOnStates) {
+            return result;
+        }
+        if (Array.isArray(dependsOnStates)) {
+            dependsOnStates.forEach(id => {
+                if (id && typeof id === 'string') {
+                    result[id] = id;
+                }
+            });
+        }
+        else if (isObject(dependsOnStates)) {
+            Object.keys(dependsOnStates).forEach(alias => {
+                if (dependsOnStates[alias] && typeof dependsOnStates[alias] === 'string') {
+                    result[alias] = dependsOnStates[alias];
+                }
+            });
+        }
+        else {
+            console.error(`[JsonConfigComponent] Invalid dependsOnStates: ${JSON.stringify(dependsOnStates)}`);
+        }
+        return result;
+    }
+    /**
+     * Build the real state ID out of a `dependsOnStates` entry: resolve the `${data.xxx}` patterns and
+     * expand a leading dot (`.info.running`) to the namespace of the own instance.
+     *
+     * @param id state ID from the schema
+     * @returns the resolved state ID or an empty string if it cannot be used
+     */
+    async resolveStateId(id) {
+        let result = (id || '').toString();
+        if (result.includes('${')) {
+            result = await this.getPatternAsync(result, null, true);
+        }
+        result = result.trim();
+        if (result.startsWith('.')) {
+            result = `${this.props.oContext.adapterName}.${this.props.oContext.instance || 0}${result}`;
+        }
+        if (result.includes('*')) {
+            console.error(`[JsonConfigComponent] Wildcards are not allowed in dependsOnStates: ${result}`);
+            return '';
+        }
+        return result;
+    }
+    /**
+     * Resolve all state IDs of a `dependsOnStates` attribute.
+     *
+     * @param dependsOnStates value of the `dependsOnStates` attribute
+     * @returns aliases with the resolved state IDs
+     */
+    async resolveDependsOnStates(dependsOnStates) {
+        const aliases = ConfigGeneric.normalizeDependsOnStates(dependsOnStates);
+        const resolved = {};
+        for (const alias of Object.keys(aliases)) {
+            const id = await this.resolveStateId(aliases[alias]);
+            if (id) {
+                resolved[alias] = id;
+            }
+        }
+        return resolved;
+    }
+    /**
+     * Subscribe on the given state IDs. The promise is resolved as soon as all values are known,
+     * so the following calculation does not run with unknown states.
+     *
+     * @param ids resolved state IDs
+     */
+    async subscribeOnStateIds(ids) {
+        if (!ids.length && !this.statesSubscribed) {
+            return;
+        }
+        this.statesSubscribed = !!ids.length;
+        await this.props.oContext.subscribeStates?.(this, ids, this.onDependsOnStateChanged);
+    }
+    /**
+     * Resolve the `dependsOnStates` attribute of this element and subscribe on the states.
+     *
+     * It is called before every calculation and not only once, because a state ID can contain a
+     * `${data.xxx}` pattern and so it can change if the user changes the configuration.
+     */
+    async updateStateSubscriptions() {
+        this.stateAliases = await this.resolveDependsOnStates(this.props.schema?.dependsOnStates);
+        await this.subscribeOnStateIds(Object.values(this.stateAliases));
+    }
+    /** True if this element depends on ioBroker states */
+    usesDependsOnStates() {
+        return !!this.props.schema?.dependsOnStates || this.statesSubscribed;
+    }
+    /** One of the states from `dependsOnStates` changed => recalculate `hidden`, `disabled`, ... */
+    onDependsOnStateChanged = () => {
+        this.forceUpdate();
+    };
+    /**
+     * Values of the subscribed states for the JS functions and patterns (`_states.<alias>`).
+     *
+     * @param aliases alias => state ID. If omitted, the aliases of this element are used
+     * @returns alias => state object. `null` if the state does not exist
+     */
+    getStateValues(aliases) {
+        const map = aliases === undefined ? this.stateAliases : aliases;
+        const result = {};
+        if (map) {
+            Object.keys(map).forEach(alias => {
+                result[alias] = this.props.oContext.getStateValue?.(map[alias]) ?? null;
+            });
+        }
+        return result;
+    }
     async componentDidMount() {
+        if (this.usesDependsOnStates()) {
+            // Subscribe before the first calculation, so `defaultFunc` and `hidden` already see the values
+            await this.updateStateSubscriptions();
+        }
         if (this.props.schema?.defaultFunc) {
             if (this.props.custom) {
                 this.defaultValue = await this.executeCustom(this.props.schema.defaultFunc, this.props.data, this.props.customObj, this.props.oContext.instanceObj, this.props.arrayIndex, this.props.globalData, 'defaultFunc');
@@ -195,6 +320,10 @@ export default class ConfigGeneric extends Component {
         if (this.props.attr) {
             this.props.oContext.registerOnForceUpdate?.(this.props.attr);
         }
+        // Not only if `statesSubscribed` is true: the element could have released its states before (an ID
+        // with a `${data.xxx}` pattern was resolved to nothing), but it is still registered in the pool
+        this.props.oContext.unsubscribeStates?.(this);
+        this.statesSubscribed = false;
         if (this.sendToTimeout) {
             clearTimeout(this.sendToTimeout);
             this.sendToTimeout = null;
@@ -259,14 +388,16 @@ export default class ConfigGeneric extends Component {
             ConfigGeneric.setValue(data[part], attr, value);
         }
     }
-    getText(text, noTranslation) {
+    getText(text, noTranslation, 
+    /** Values for `_states`. If omitted, the states of this element are used */
+    states) {
         if (!text) {
             return '';
         }
         if (typeof text === 'string') {
             const strText = noTranslation ? text : I18n.t(text);
             if (strText.includes('${')) {
-                return this.getPattern(strText, undefined, noTranslation);
+                return this.getPattern(strText, undefined, noTranslation, states);
             }
             return strText;
         }
@@ -277,9 +408,9 @@ export default class ConfigGeneric extends Component {
                 if (typeof funcText.func === 'object') {
                     return this.getPattern(funcText.func[this.lang] ||
                         funcText.func.en ||
-                        '', undefined, true);
+                        '', undefined, true, states);
                 }
-                return this.getPattern(funcText.func, undefined, noTranslation);
+                return this.getPattern(funcText.func, undefined, noTranslation, states);
             }
             return text[this.lang] || text.en || '';
         }
@@ -604,7 +735,9 @@ export default class ConfigGeneric extends Component {
         }
         return true;
     }
-    async execute(func, defaultValue, data, arrayIndex, globalData, funcName) {
+    async execute(func, defaultValue, data, arrayIndex, globalData, funcName, 
+    /** Values for `_states`. If omitted, the states of this element are used */
+    states) {
         let fun;
         if (isObject(func)) {
             fun = func.func;
@@ -623,8 +756,8 @@ export default class ConfigGeneric extends Component {
             fun = ConfigGeneric.ensureAwaitGetObject(fun);
         }
         try {
-            const f = new this.AsyncFunction('data', 'originalData', '_system', '_alive', '_common', '_socket', '_instance', 'arrayIndex', 'globalData', '_changed', '_href', 'getObject', '_os', '_arch', '_host', fun.includes('return') ? fun : `return ${fun}`);
-            const result = await f(data || this.props.data || {}, this.props.originalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.oContext.instance, arrayIndex, globalData || {}, this.props.changed, window.location.href, this.getObject, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {});
+            const f = new this.AsyncFunction('data', 'originalData', '_system', '_alive', '_common', '_socket', '_instance', 'arrayIndex', 'globalData', '_changed', '_href', 'getObject', '_os', '_arch', '_host', '_states', fun.includes('return') ? fun : `return ${fun}`);
+            const result = await f(data || this.props.data || {}, this.props.originalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.oContext.instance, arrayIndex, globalData || {}, this.props.changed, window.location.href, this.getObject, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {}, states || this.getStateValues());
             this.debugLog(funcName || 'JS function', fun, result, data);
             return result;
         }
@@ -634,7 +767,9 @@ export default class ConfigGeneric extends Component {
             return defaultValue;
         }
     }
-    async executeCustom(func, data, customObj, instanceObj, arrayIndex, globalData, funcName) {
+    async executeCustom(func, data, customObj, instanceObj, arrayIndex, globalData, funcName, 
+    /** Values for `_states`. If omitted, the states of this element are used */
+    states) {
         let fun;
         if (isObject(func)) {
             fun = func.func;
@@ -653,8 +788,8 @@ export default class ConfigGeneric extends Component {
             fun = ConfigGeneric.ensureAwaitGetObject(fun);
         }
         try {
-            const f = new this.AsyncFunction('data', 'originalData', '_system', 'instanceObj', 'customObj', '_socket', 'arrayIndex', 'globalData', '_changed', '_href', 'getObject', '_os', '_arch', '_host', fun.includes('return') ? fun : `return ${fun}`);
-            const result = await f(data || this.props.data, this.props.originalData, this.props.oContext.systemConfig, instanceObj || {}, customObj || {}, this.props.oContext.socket, arrayIndex, globalData || {}, this.props.changed, window.location.href, this.getObject, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {});
+            const f = new this.AsyncFunction('data', 'originalData', '_system', 'instanceObj', 'customObj', '_socket', 'arrayIndex', 'globalData', '_changed', '_href', 'getObject', '_os', '_arch', '_host', '_states', fun.includes('return') ? fun : `return ${fun}`);
+            const result = await f(data || this.props.data, this.props.originalData, this.props.oContext.systemConfig, instanceObj || {}, customObj || {}, this.props.oContext.socket, arrayIndex, globalData || {}, this.props.changed, window.location.href, this.getObject, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {}, states || this.getStateValues());
             this.debugLog(funcName || 'JS function', fun, result, data);
             return result;
         }
@@ -801,7 +936,9 @@ export default class ConfigGeneric extends Component {
             return null;
         }
     };
-    async getPatternAsync(pattern, data, noTranslation) {
+    async getPatternAsync(pattern, data, noTranslation, 
+    /** Values for `_states`. If omitted, the states of this element are used */
+    states) {
         data ||= this.props.data;
         if (!pattern) {
             return '';
@@ -825,15 +962,15 @@ export default class ConfigGeneric extends Component {
         }
         try {
             if (this.props.custom) {
-                const f = new this.AsyncFunction('data', 'originalData', 'arrayIndex', 'globalData', '_system', 'instanceObj', 'customObj', '_socket', '_changed', '_href', 'getObject', '_os', '_arch', '_host', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
-                const text = await f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.oContext.instanceObj, this.props.customObj, this.props.oContext.socket, this.props.changed, window.location.href, this.getObject, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {});
+                const f = new this.AsyncFunction('data', 'originalData', 'arrayIndex', 'globalData', '_system', 'instanceObj', 'customObj', '_socket', '_changed', '_href', 'getObject', '_os', '_arch', '_host', '_states', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
+                const text = await f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.oContext.instanceObj, this.props.customObj, this.props.oContext.socket, this.props.changed, window.location.href, this.getObject, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {}, states || this.getStateValues());
                 if (noTranslation) {
                     return text;
                 }
                 return I18n.t(text);
             }
-            const f = new this.AsyncFunction('data', 'originalData', 'arrayIndex', 'globalData', '_system', '_alive', '_common', '_socket', '_changed', '_href', 'getObject', '_os', '_arch', '_host', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
-            const text = await f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.changed, window.location.href, this.getObject, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {});
+            const f = new this.AsyncFunction('data', 'originalData', 'arrayIndex', 'globalData', '_system', '_alive', '_common', '_socket', '_changed', '_href', 'getObject', '_os', '_arch', '_host', '_states', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
+            const text = await f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.changed, window.location.href, this.getObject, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {}, states || this.getStateValues());
             if (noTranslation) {
                 return text;
             }
@@ -844,7 +981,9 @@ export default class ConfigGeneric extends Component {
             return patternStr;
         }
     }
-    getPattern(pattern, data, noTranslation) {
+    getPattern(pattern, data, noTranslation, 
+    /** Values for `_states`. If omitted, the states of this element are used */
+    states) {
         data ||= this.props.data;
         if (!pattern) {
             return '';
@@ -868,15 +1007,15 @@ export default class ConfigGeneric extends Component {
         }
         try {
             if (this.props.custom) {
-                const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', 'instanceObj', 'customObj', '_socket', '_changed', '_href', '_os', '_arch', '_host', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
-                const text = f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.oContext.instanceObj, this.props.customObj, this.props.oContext.socket, this.props.changed, window.location.href, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {});
+                const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', 'instanceObj', 'customObj', '_socket', '_changed', '_href', '_os', '_arch', '_host', '_states', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
+                const text = f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.oContext.instanceObj, this.props.customObj, this.props.oContext.socket, this.props.changed, window.location.href, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {}, states || this.getStateValues());
                 if (noTranslation) {
                     return text;
                 }
                 return I18n.t(text);
             }
-            const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', '_alive', '_common', '_socket', '_changed', '_href', '_os', '_arch', '_host', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
-            const text = f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.changed, window.location.href, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {});
+            const f = new Function('data', 'originalData', 'arrayIndex', 'globalData', '_system', '_alive', '_common', '_socket', '_changed', '_href', '_os', '_arch', '_host', '_states', `return \`${ConfigGeneric.escapeString(patternStr, data)}\``);
+            const text = f(data, this.props.originalData, this.props.arrayIndex, this.props.globalData, this.props.oContext.systemConfig, this.props.alive, this.props.common, this.props.oContext.socket, this.props.changed, window.location.href, this.props.oContext.hostInfo?.os || '', this.props.oContext.hostInfo?.arch || '', this.props.oContext.hostInfo || {}, states || this.getStateValues());
             if (noTranslation) {
                 return text;
             }
@@ -897,6 +1036,11 @@ export default class ConfigGeneric extends Component {
             if (!schema) {
                 return;
             }
+            if (this.usesDependsOnStates()) {
+                // The state IDs can contain `${data.xxx}` patterns, so they must be resolved anew if the data changed.
+                // It waits for the first values, so the element is not calculated with unknown states.
+                await this.updateStateSubscriptions();
+            }
             const { error, disabled, hidden, defaultValue } = await this.calculate(schema);
             if (!this.state.calculatedValues ||
                 this.state.calculatedValues.error !== error ||