@iobroker/json-config 8.4.14 → 8.5.3

package/build/JsonConfigComponent/ConfigGeneric.d.ts

@@ -33,7 +33,7 @@ export interface ConfigGenericProps {
     className?: string;
     expertMode?: boolean;
     commandRunning?: boolean;
-    common: Record<string, any>;
+    common?: Record<string, any>;
     custom?: boolean;
     customObj?: Record<string, any>;
     data: Record<string, any>;
@@ -41,8 +41,8 @@ export interface ConfigGenericProps {
     globalData?: Record<string, any>;
     index?: number;
     isParentTab?: boolean;
-    onChange: (attrOrData: string | Record<string, any>, val?: any, cb?: () => void, saveConfig?: boolean) => void;
-    onError: (attr: string, error?: string) => void;
+    onChange: (attrOrData: string | Record<string, any> | undefined, val?: any, cb?: () => void, saveConfig?: boolean) => void;
+    onError: (attr: string | undefined, error?: string) => void;
     onHiddenChanged?: (attr: string, hidden?: boolean) => void;
     /** Filled only by table: components with value/label options report their label mappings for table filtering */
     onFilterLabelUpdate?: (attr: string, valueToLabel: Record<string, string>) => void;
@@ -93,15 +93,18 @@ export default class ConfigGeneric<Props extends ConfigGenericProps = ConfigGene
     constructor(props: Props);
     protected getCachedObject(id: string): Promise<ioBroker.Object | null>;
     componentDidMount(): Promise<void>;
-    sendTo(): Promise<void>;
+    private defaultSendTo;
     componentWillUnmount(): void;
     onUpdate: (data: Record<string, any>) => void;
     /**
      * Extract attribute out of data
      */
-    static getValue(data: Record<string, any>, attr: string | string[]): any;
-    static setValue(data: Record<string, any>, attr: string | string[], value: any): void;
-    getText(text: ioBroker.StringOrTranslated, noTranslation?: boolean): string;
+    static getValue(data: Record<string, any>, attr: string | string[] | undefined): any;
+    static setValue(data: Record<string, any>, attr: string | string[] | undefined, value: any): void;
+    getText(text: ioBroker.StringOrTranslated | undefined | null | {
+        /** @deprecated */
+        func: ioBroker.StringOrTranslated;
+    }, noTranslation?: boolean): string;
     getTextAsync(text: ioBroker.StringOrTranslated, noTranslation?: boolean): Promise<string>;
     renderDialogConfirm(): JSX.Element | null;
     getIcon(iconSettings?: ConfigIconType | null): JSX.Element | null;
@@ -119,7 +122,7 @@ export default class ConfigGeneric<Props extends ConfigGenericProps = ConfigGene
      * @param newValue new value of the attribute
      * @param cb optional callback function, else returns a Promise
      */
-    onChange(attr: string, newValue: unknown, cb?: () => void): Promise<void>;
+    onChange(attr: string | undefined, newValue: unknown, cb?: () => void): Promise<void>;
     /** Ensure that every bare getObject( call is preceded by "await". */
     static ensureAwaitGetObject(code: string): string;
     /**
@@ -132,24 +135,24 @@ export default class ConfigGeneric<Props extends ConfigGenericProps = ConfigGene
      * @param data the data object the function was executed against
      */
     protected debugLog(funcName: string, func: string, result: unknown, data?: Record<string, any>): void;
-    execute(func: string | boolean | Record<string, string>, defaultValue: string | number | boolean, data: Record<string, any>, arrayIndex: number, globalData: Record<string, any>, funcName?: string): Promise<string | number | boolean>;
-    executeCustom(func: string | boolean | Record<string, string>, data: Record<string, any>, customObj: Record<string, any>, instanceObj: ioBroker.InstanceObject, arrayIndex: number, globalData: Record<string, any>, funcName?: string): Promise<string | boolean | number | null>;
+    execute(func: string | boolean | Record<string, string> | undefined, defaultValue: string | number | boolean | undefined, data: Record<string, any> | undefined, arrayIndex: number | undefined, globalData: Record<string, any> | undefined, funcName?: string): Promise<string | number | boolean | undefined>;
+    executeCustom(func: string | boolean | Record<string, string> | undefined, data: Record<string, any>, customObj: Record<string, any> | undefined, instanceObj: ioBroker.InstanceObject | undefined, arrayIndex: number | undefined, globalData: Record<string, any> | undefined, funcName?: string): Promise<string | boolean | number | null | undefined>;
     calculate(schema: Record<string, any>): Promise<{
         error: boolean;
         disabled: boolean;
         hidden: boolean;
         defaultValue: null | string | number | boolean;
     }>;
-    onError(attr: string, error?: string): void;
+    onError(attr: string | undefined, error?: string): void;
     renderItem(_error: unknown, _disabled: boolean, _defaultValue?: unknown): JSX.Element | string | null;
-    renderHelp(text: ioBroker.StringOrTranslated, link: string, noTranslation: boolean): JSX.Element | JSX.Element[] | string;
+    renderHelp(text: ioBroker.StringOrTranslated | undefined | null, link?: string | null, noTranslation?: boolean): JSX.Element | JSX.Element[] | string;
     renderHelpAsync(text: ioBroker.StringOrTranslated, link: string, noTranslation: boolean): Promise<JSX.Element | JSX.Element[] | string>;
     static escapeString(str: string, data: Record<string, any>): string;
     /** This function is used in pattern */
     getObject: (id: string) => Promise<ioBroker.Object | null>;
     getPatternAsync(pattern: string | {
         func: string;
-    }, data?: Record<string, any>, noTranslation?: boolean): Promise<string>;
+    }, data?: Record<string, any> | null, noTranslation?: boolean): Promise<string>;
     getPattern(pattern: string | {
         func: string;
     }, data?: Record<string, any>, noTranslation?: boolean): string;

package/build/JsonConfigComponent/ConfigGeneric.js

@@ -68,30 +68,36 @@ export default class ConfigGeneric extends Component {
                 this.defaultValue = await this.execute(this.props.schema.defaultFunc, this.props.schema.default, this.props.data, this.props.arrayIndex, this.props.globalData, 'defaultFunc');
             }
         }
-        this.props.oContext.registerOnForceUpdate?.(this.props.attr, this.onUpdate);
+        if (this.props.attr) {
+            this.props.oContext.registerOnForceUpdate?.(this.props.attr, this.onUpdate);
+        }
         const LIKE_SELECT = ['select', 'autocomplete', 'autocompleteSendTo'];
         // init default value
-        if (this.defaultValue !== undefined) {
+        if (this.defaultValue !== undefined && this.props.attr) {
             const value = ConfigGeneric.getValue(this.props.data, this.props.attr);
             if (value === undefined ||
                 (LIKE_SELECT.includes(this.props.schema.type) && (value === '' || value === null))) {
                 setTimeout(() => {
+                    if (!this.props.attr) {
+                        return;
+                    }
                     if (this.props.custom) {
-                        this.props.onChange(this.props.attr, this.defaultValue, () => setTimeout(() => this.props.oContext.forceUpdate([this.props.attr], this.props.data), 100));
+                        this.props.onChange(this.props.attr, this.defaultValue, () => setTimeout(() => this.props.attr &&
+                            this.props.oContext.forceUpdate([this.props.attr], this.props.data), 100));
                     }
                     else {
                         ConfigGeneric.setValue(this.props.data, this.props.attr, this.defaultValue);
-                        this.props.onChange(this.props.data, undefined, () => this.props.oContext.forceUpdate([this.props.attr], this.props.data));
+                        this.props.onChange(this.props.data, undefined, () => this.props.attr && this.props.oContext.forceUpdate([this.props.attr], this.props.data));
                     }
                 }, 100);
             }
         }
         else if (this.props.schema.defaultSendTo) {
-            this.sendTo().catch(e => console.error(e));
+            this.defaultSendTo().catch(e => console.error(e));
         }
     }
-    async sendTo() {
-        if (this.props.alive) {
+    async defaultSendTo() {
+        if (this.props.alive && this.props.schema.defaultSendTo) {
             this.defaultSendToDone = true;
             let data = this.props.schema.data;
             if (data === undefined && this.props.schema.jsonData) {
@@ -122,19 +128,21 @@ export default class ConfigGeneric extends Component {
                     return;
                 }
             }
-            void this.props.oContext.socket
-                .sendTo(instance, this.props.schema.defaultSendTo, data)
-                .then((value) => {
-                if (value !== null && value !== undefined) {
+            try {
+                const value = await this.props.oContext.socket.sendTo(instance, this.props.schema.defaultSendTo, data);
+                if (value !== null && value !== undefined && this.props.attr) {
                     if (this.props.custom) {
-                        this.props.onChange(this.props.attr, value, () => this.props.oContext.forceUpdate([this.props.attr], this.props.data));
+                        this.props.onChange(this.props.attr, value, () => this.props.attr && this.props.oContext.forceUpdate([this.props.attr], this.props.data));
                     }
                     else {
                         ConfigGeneric.setValue(this.props.data, this.props.attr, value);
-                        this.props.onChange(this.props.data, undefined, () => this.props.oContext.forceUpdate([this.props.attr], this.props.data));
+                        this.props.onChange(this.props.data, undefined, () => this.props.attr && this.props.oContext.forceUpdate([this.props.attr], this.props.data));
                     }
                 }
-            });
+            }
+            catch (e) {
+                console.error(e);
+            }
         }
         else {
             this.defaultSendToDone = false;
@@ -145,8 +153,8 @@ export default class ConfigGeneric extends Component {
         }
     }
     componentWillUnmount() {
-        if (this.props.oContext.registerOnForceUpdate) {
-            this.props.oContext.registerOnForceUpdate(this.props.attr);
+        if (this.props.attr) {
+            this.props.oContext.registerOnForceUpdate?.(this.props.attr);
         }
         if (this.sendToTimeout) {
             clearTimeout(this.sendToTimeout);
@@ -170,6 +178,9 @@ export default class ConfigGeneric extends Component {
      * Extract attribute out of data
      */
     static getValue(data, attr) {
+        if (!attr) {
+            return undefined;
+        }
         if (typeof attr === 'string') {
             return ConfigGeneric.getValue(data, attr.split('.'));
         }
@@ -183,6 +194,9 @@ export default class ConfigGeneric extends Component {
         return undefined;
     }
     static setValue(data, attr, value) {
+        if (!attr) {
+            return;
+        }
         if (typeof attr === 'string') {
             ConfigGeneric.setValue(data, attr.split('.'), value);
             return;
@@ -213,18 +227,20 @@ export default class ConfigGeneric extends Component {
         if (typeof text === 'string') {
             const strText = noTranslation ? text : I18n.t(text);
             if (strText.includes('${')) {
-                return this.getPattern(strText, null, noTranslation);
+                return this.getPattern(strText, undefined, noTranslation);
             }
             return strText;
         }
-        if (isObject(text)) {
-            // todo
-            if (text.func) {
+        if (text && typeof text === 'object') {
+            const funcText = text;
+            if (funcText.func) {
                 // calculate pattern
-                if (typeof text.func === 'object') {
-                    return this.getPattern(text.func[this.lang] || text.func.en || '', null, true);
+                if (typeof funcText.func === 'object') {
+                    return this.getPattern(funcText.func[this.lang] ||
+                        funcText.func.en ||
+                        '', undefined, true);
                 }
-                return this.getPattern(text.func, null, noTranslation);
+                return this.getPattern(funcText.func, undefined, noTranslation);
             }
             return text[this.lang] || text.en || '';
         }
@@ -259,6 +275,9 @@ export default class ConfigGeneric extends Component {
             return null;
         }
         const confirm = this.state.confirmData || this.props.schema.confirm;
+        if (!confirm) {
+            return null;
+        }
         let icon = null;
         if (confirm.type === 'warning') {
             icon = React.createElement(IconWarning, null);
@@ -435,6 +454,9 @@ export default class ConfigGeneric extends Component {
                     const val = ConfigGeneric.getValue(data, dep.attr);
                     if (await this.execute(dep.confirm.condition, false, data, this.props.arrayIndex, this.props.globalData, 'confirm.condition')) {
                         return new Promise(resolve => {
+                            if (!dep.confirm) {
+                                throw new Error(`Cannot set value: confirm is not defined for ${dep.attr}`);
+                            }
                             this.setState({
                                 confirmDialog: true,
                                 confirmNewValue: newValue,
@@ -468,7 +490,7 @@ export default class ConfigGeneric extends Component {
                     else {
                         _newValue = await this.execute(dep.onChange.calculateFunc, val, data, this.props.arrayIndex, this.props.globalData, 'onChange.calculateFunc');
                     }
-                    if (_newValue !== val) {
+                    if (_newValue !== val && dep.attr) {
                         ConfigGeneric.setValue(data, dep.attr, _newValue);
                         changed.push(dep.attr);
                     }
@@ -478,7 +500,7 @@ export default class ConfigGeneric extends Component {
         if (this.props.schema.hiddenDependsOn) {
             for (let z = 0; z < this.props.schema.hiddenDependsOn.length; z++) {
                 const dep = this.props.schema.hiddenDependsOn[z];
-                if (dep.hidden) {
+                if (dep.hidden && dep.attr) {
                     changed.push(dep.attr);
                 }
             }
@@ -486,7 +508,7 @@ export default class ConfigGeneric extends Component {
         if (this.props.schema.labelDependsOn) {
             for (let z = 0; z < this.props.schema.labelDependsOn.length; z++) {
                 const dep = this.props.schema.labelDependsOn[z];
-                if (dep.hidden) {
+                if (dep.hidden && dep.attr) {
                     changed.push(dep.attr);
                 }
             }
@@ -494,7 +516,7 @@ export default class ConfigGeneric extends Component {
         if (this.props.schema.helpDependsOn) {
             for (let z = 0; z < this.props.schema.helpDependsOn.length; z++) {
                 const dep = this.props.schema.helpDependsOn[z];
-                if (dep.hidden) {
+                if (dep.hidden && dep.attr) {
                     changed.push(dep.attr);
                 }
             }
@@ -509,7 +531,7 @@ export default class ConfigGeneric extends Component {
             }
         }
         if (this.props.custom) {
-            this.props.onChange(attr, newValue, () => cb && cb());
+            this.props.onChange(attr, newValue, () => cb?.());
             if (changed?.length) {
                 changed.forEach((_attr, i) => setTimeout(() => this.props.onChange(_attr, ConfigGeneric.getValue(data, _attr)), i * 50));
             }
@@ -582,7 +604,7 @@ export default class ConfigGeneric extends Component {
         }
         try {
             const f = new this.AsyncFunction('data', 'originalData', '_system', '_alive', '_common', '_socket', '_instance', 'arrayIndex', 'globalData', '_changed', '_href', 'getObject', 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);
+            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.debugLog(funcName || 'JS function', fun, result, data);
             return result;
         }
@@ -612,7 +634,7 @@ export default class ConfigGeneric extends Component {
         }
         try {
             const f = new this.AsyncFunction('data', 'originalData', '_system', 'instanceObj', 'customObj', '_socket', 'arrayIndex', 'globalData', '_changed', '_href', 'getObject', 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);
+            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.debugLog(funcName || 'JS function', fun, result, data);
             return result;
         }
@@ -683,15 +705,15 @@ export default class ConfigGeneric extends Component {
         };
     }
     onError(attr, error) {
-        if (!error) {
-            delete this.isError[attr];
-        }
-        else {
-            this.isError[attr] = error;
-        }
-        if (this.props.onError) {
-            this.props.onError(attr, error);
+        if (attr) {
+            if (!error) {
+                delete this.isError[attr];
+            }
+            else {
+                this.isError[attr] = error;
+            }
         }
+        this.props.onError?.(attr, error);
     }
     renderItem(_error, _disabled, _defaultValue) {
         return this.getText(this.props.schema.label) || this.getText(this.props.schema.text);
@@ -751,7 +773,7 @@ export default class ConfigGeneric extends Component {
     /** This function is used in pattern */
     getObject = async (id) => {
         try {
-            const obj = await this.props.oContext.getCachedObject(id);
+            const obj = await this.props.oContext.getCachedObject?.(id);
             return obj || null;
         }
         catch (e) {
@@ -853,7 +875,7 @@ export default class ConfigGeneric extends Component {
             this.calculateTimeout = null;
             const schema = this.props.schema;
             if (!schema) {
-                return null;
+                return;
             }
             const { error, disabled, hidden, defaultValue } = await this.calculate(schema);
             if (!this.state.calculatedValues ||
@@ -879,7 +901,7 @@ export default class ConfigGeneric extends Component {
         if (this.props.alive && this.defaultSendToDone === false) {
             this.sendToTimeout = setTimeout(async () => {
                 this.sendToTimeout = null;
-                await this.sendTo();
+                await this.defaultSendTo();
             }, 200);
         }
         this.updateCalculatedValues();
@@ -915,16 +937,16 @@ export default class ConfigGeneric extends Component {
             // Used in table to not render hidden elements at all, so we need to inform about it
             if (this.props.onHiddenChanged && !this.reportedHidden) {
                 this.reportedHidden = true;
-                setTimeout(() => this.props.onHiddenChanged(this.props.attr, true), 10);
+                setTimeout(() => this.props.attr && this.props.onHiddenChanged?.(this.props.attr, true), 10);
             }
             return null;
         }
         if (this.props.onHiddenChanged && this.reportedHidden) {
             this.reportedHidden = false;
-            setTimeout(() => this.props.onHiddenChanged(this.props.attr, false), 10);
+            setTimeout(() => this.props.attr && this.props.onHiddenChanged?.(this.props.attr, false), 10);
         }
         // Add error
-        if (schema.validatorNoSaveOnError) {
+        if (schema.validatorNoSaveOnError && this.props.attr) {
             if (this.state.calculatedValues.error && !Object.keys(this.isError).length) {
                 this.isError = {
                     [this.props.attr]: schema.validatorErrorText ? I18n.t(schema.validatorErrorText) : true,
@@ -936,7 +958,7 @@ export default class ConfigGeneric extends Component {
                 this.isError = {};
             }
         }
-        const renderedItem = this.renderItem(this.state.calculatedValues.error, this.state.calculatedValues.disabled || this.props.commandRunning || this.props.disabled, this.state.calculatedValues.defaultValue);
+        const renderedItem = this.renderItem(this.state.calculatedValues.error, this.state.calculatedValues.disabled || this.props.commandRunning || this.props.disabled || false, this.state.calculatedValues.defaultValue);
         if (this.noPlaceRequired) {
             return renderedItem;
         }
@@ -955,7 +977,7 @@ export default class ConfigGeneric extends Component {
             } }, this.props.schema.defaultSendTo && this.props.schema.button ? (React.createElement(Grid2, { container: true, style: { width: '100%' } },
             React.createElement(Grid2, { flex: 1 }, renderedItem),
             React.createElement(Grid2, null,
-                React.createElement(Button, { disabled: this.state.calculatedValues.disabled, variant: "outlined", onClick: () => this.sendTo(), title: this.props.schema.buttonTooltip
+                React.createElement(Button, { disabled: this.state.calculatedValues.disabled, variant: "outlined", onClick: () => this.defaultSendTo(), title: this.props.schema.buttonTooltip
                         ? this.getText(this.props.schema.buttonTooltip, this.props.schema.buttonTooltipNoTranslation)
                         : I18n.t('jc_Request data by instance') }, this.getText(this.props.schema.button))))) : (renderedItem)));
         if (schema.newLine) {