@iobroker/adapter-react-v5 5.0.4 → 5.0.6

package/Components/TreeTable.js

@@ -312,7 +312,7 @@ class TreeTable extends react_1.Component {
     }
     renderSelectIdDialog() {
         if (this.state.showSelectId && this.props.socket) {
-            return react_1.default.createElement(SelectID_1.default, { key: "tableSelect", imagePrefix: "../..", dialogName: this.props.adapterName, themeType: this.props.themeType, socket: this.props.socket, selected: this.state.selectIdValue, onClose: () => this.setState({ showSelectId: false }), onOk: (selected /* , name*/) => {
+            return react_1.default.createElement(SelectID_1.default, { key: "tableSelect", imagePrefix: "../..", dialogName: this.props.adapterName, themeType: this.props.themeType, socket: this.props.socket, selected: this.state.selectIdValue, onClose: () => this.setState({ showSelectId: false }), onOk: (selected /* , name */) => {
                     this.setState({ showSelectId: false, selectIdValue: null });
                     this.selectCallback && this.selectCallback(selected);
                     this.selectCallback = null;
@@ -329,7 +329,7 @@ class TreeTable extends react_1.Component {
                 }, size: "large" },
                 react_1.default.createElement(icons_material_1.ViewHeadline, null)));
     }
-    renderCellNonEdit(item, col) {
+    static renderCellNonEdit(item, col) {
         let val = getAttr(item, col.field, col.lookup);
         if (Array.isArray(val)) {
             val = val[0];
@@ -343,7 +343,7 @@ class TreeTable extends react_1.Component {
         if (this.state.editMode === i && col.editable !== 'never' && col.editable !== false) {
             return react_1.default.createElement(material_1.TableCell, { key: col.field, className: Utils_1.default.clsx(this.props.classes.cell, level && this.props.classes.cellSecondary), style: col.cellStyle, component: "th" }, this.renderCellEdit(item, col));
         }
-        return react_1.default.createElement(material_1.TableCell, { key: col.field, className: Utils_1.default.clsx(this.props.classes.cell, level && this.props.classes.cellSecondary), style: col.cellStyle, component: "th" }, this.renderCellNonEdit(item, col));
+        return react_1.default.createElement(material_1.TableCell, { key: col.field, className: Utils_1.default.clsx(this.props.classes.cell, level && this.props.classes.cellSecondary), style: col.cellStyle, component: "th" }, TreeTable.renderCellNonEdit(item, col));
     }
     renderCellWithSubField(item, col) {
         const main = getAttr(item, col.field, col.lookup);
@@ -447,7 +447,7 @@ class TreeTable extends react_1.Component {
                     react_1.default.createElement(material_1.TableCell, { component: "th", className: Utils_1.default.clsx(this.props.classes.cell, this.props.classes.cellHeader, this.props.classes.cellButton) }) : null));
     }
     render() {
-        const col = this.props.columns.find(col => col.field === this.state.orderBy);
+        const col = this.props.columns.find(_col => _col.field === this.state.orderBy);
         if (col) {
             const lookup = col.lookup;
             const table = stableSort(this.props.data, getComparator(this.state.order, this.state.orderBy, lookup));
@@ -465,6 +465,7 @@ class TreeTable extends react_1.Component {
                 this.renderSelectIdDialog(),
                 this.renderSelectColorDialog());
         }
+        return null;
     }
 }
 /*

package/Components/Utils.d.ts

@@ -3,13 +3,9 @@
  *
  * MIT License
  *
- **/
+ * */
 import React from 'react';
 import { ThemeName, ThemeType } from '../types';
-interface GetObjectNameOptions {
-    name?: ioBroker.StringOrTranslated;
-    language?: ioBroker.Languages;
-}
 type SmartName = null | false | string | ({
     [lang in ioBroker.Languages]?: string;
 } & {
@@ -18,11 +14,9 @@ type SmartName = null | false | string | ({
     /** Which value to set when the ON command is issued */
     byON?: string | null;
 });
-declare namespace clsx {
-    type ClassValue = ClassArray | ClassDictionary | string | number | null | boolean | undefined;
-    type ClassDictionary = Record<string, any>;
-    type ClassArray = ClassValue[];
-}
+type ClassDictionary = Record<string, any>;
+type ClassValue = ClassArray | ClassDictionary | string | number | null | boolean | undefined;
+type ClassArray = ClassValue[];
 declare class Utils {
     static namespace: string;
     static INSTANCES: string;
@@ -31,37 +25,43 @@ declare class Utils {
     /**
      * Capitalize words.
      */
-    static CapitalWords(name: string): string;
+    static CapitalWords(name: string | null | undefined): string;
     static formatSeconds(seconds: number): string;
     /**
      * Get the name of the object by id from the name or description.
-     * @param objects
-     * @param id
-     * @param settings
-     * @param options
-     * @param isDesc Set to true to get the description.
      */
-    static getObjectName(objects: Record<string, ioBroker.Object>, id: string, settings?: GetObjectNameOptions | ioBroker.Languages | null, options?: GetObjectNameOptions, isDesc?: boolean): string;
+    static getObjectName(objects: Record<string, ioBroker.Object>, id: string, settings?: {
+        name: ioBroker.StringOrTranslated;
+    } | ioBroker.Languages | null, options?: {
+        language?: ioBroker.Languages;
+    }, 
+    /** Set to true to get the description. */
+    isDesc?: boolean): string;
     /**
      * Get the name of the object from the name or description.
-     * @param obj
-     * @param settings or language
-     * @param options
-     * @param isDesc Set to true to get the description.
-     * @param noTrim Allow to use spaces in name (by edit)
      */
-    static getObjectNameFromObj(obj: ioBroker.Object, settings?: GetObjectNameOptions | ioBroker.Languages | null, options?: GetObjectNameOptions, isDesc?: boolean, noTrim?: boolean): string;
+    static getObjectNameFromObj(obj: ioBroker.PartialObject, 
+    /** settings or language */
+    settings: {
+        name: ioBroker.StringOrTranslated;
+    } | ioBroker.Languages | null, options?: {
+        language?: ioBroker.Languages;
+    }, 
+    /** Set to true to get the description. */
+    isDesc?: boolean, 
+    /** Allow using spaces in name (by edit) */
+    noTrim?: boolean): string;
     /**
      * Extracts from the object material settings, depends on username
      */
     static getSettingsOrder(obj: ioBroker.StateObject | ioBroker.StateCommon, forEnumId: string, options: {
-        user: string;
+        user?: string;
     }): string | null;
     /**
         Used in material
      */
     static getSettingsCustomURLs(obj: ioBroker.StateObject | ioBroker.StateCommon, forEnumId: string, options: {
-        user: string;
+        user?: string;
     }): string | null;
     /**
      * Reorder the array items in list between source and dest.
@@ -81,7 +81,7 @@ declare class Utils {
     /**
         Sets smartName settings for the given object.
      */
-    static setSettings(obj: ioBroker.StateObject, settings: any, options: {
+    static setSettings(obj: Partial<ioBroker.Object>, settings: Record<string, any>, options: {
         user?: string;
         language?: ioBroker.Languages;
     }): boolean;
@@ -98,9 +98,9 @@ declare class Utils {
      */
     static getObjectIcon(id: string | ioBroker.PartialObject, obj?: ioBroker.PartialObject): string | null;
     /**
-     * Splits CamelCase into words.
+     * Converts word1_word2 to word1Word2.
      */
-    static splitCamelCase(text: string | undefined): string;
+    static splitCamelCase(text: string | null | undefined): string;
     /**
      * Check if the given color is bright.
      * https://stackoverflow.com/questions/35969656/how-can-i-generate-the-opposite-color-according-to-current-color
@@ -112,9 +112,10 @@ declare class Utils {
     static getTimeString(seconds: string | number): string;
     /**
      * Gets the wind direction with the given angle (degrees).
-     * @param angle in degrees.
      */
-    static getWindDirection(angle: number): string;
+    static getWindDirection(
+    /** angle in degrees from 0° to 360° */
+    angle: number): string;
     /**
      * Pad the given number with a zero if it's not two digits long.
      */
@@ -138,7 +139,7 @@ declare class Utils {
     /**
      * Get the smart name from a state.
      */
-    static getSmartNameFromObj(obj: ioBroker.StateObject, instanceId: string, noCommon?: boolean): SmartName | undefined;
+    static getSmartNameFromObj(obj: ioBroker.StateObject | ioBroker.StateCommon, instanceId: string, noCommon?: boolean): SmartName | undefined;
     /**
      * Enable smart name for a state.
      */
@@ -148,7 +149,7 @@ declare class Utils {
      */
     static removeSmartName(obj: ioBroker.StateObject, instanceId: string, noCommon?: boolean): void;
     /**
-     * Update the smartname of a state.
+     * Update the smart name of a state.
      */
     static updateSmartName(obj: ioBroker.StateObject, newSmartName: ioBroker.StringOrTranslated, byON: string | null, smartType: string | null, instanceId: string, noCommon?: boolean): void;
     /**
@@ -168,17 +169,19 @@ declare class Utils {
     /**
      * Format number of bytes as a string with B, KB, MB or GB.
      * The base for all calculations is 1024.
-     * @param bytes The number of bytes.
      * @returns The formatted string (e.g. '723.5 KB')
      */
-    static formatBytes(bytes: number): string;
+    static formatBytes(
+    /** The number of bytes. */
+    bytes: number): string;
     /**
      * Invert the given color according to a theme type to get the inverted text color for background
-     * @param color Color in the format '#rrggbb' or '#rgb' (or without a hash)
-     * @param themeType theme type
-     * @param invert dark theme has light color in control or light theme has light color in control
      */
-    static getInvertedColor(color: string, themeType?: ThemeType, invert?: boolean): string | undefined;
+    static getInvertedColor(
+    /** Color in the format '#rrggbb' or '#rgb' (or without a hash) */
+    color: string, themeType: ThemeType, 
+    /** dark theme has light color in control, or light theme has light color in control */
+    invert?: boolean): string | undefined;
     /**
      * Invert the given color
      * @param hex Color in the format '#rrggbb' or '#rgb' (or without hash)
@@ -208,12 +211,12 @@ declare class Utils {
     /**
      * @private
      */
-    static _toVal(mix: clsx.ClassValue): string;
+    static _toVal(mix: ClassValue): string;
     /**
      * Convert any object to a string with its values.
      * @returns {string}
      */
-    static clsx(...inputs: clsx.ClassValue[]): string;
+    static clsx(...inputs: ClassValue[]): string;
     /**
      * Get the current theme name (either from local storage or the browser settings).
      */
@@ -230,7 +233,7 @@ declare class Utils {
      * Toggle the theme name between 'dark' and 'colored'.
      * @returns the new theme name.
      */
-    static toggleTheme(themeName: ThemeName | null): ThemeName;
+    static toggleTheme(themeName?: ThemeName | null): ThemeName;
     /**
      * Get the list of themes
      * @returns list of possible themes
@@ -239,7 +242,7 @@ declare class Utils {
     /**
      * Parse a query string into its parts.
      */
-    static parseQuery(query: string): Record<string, string | boolean | number>;
+    static parseQuery(query: string): Record<string, string | number | boolean>;
     /**
      * Returns parent ID.
      * @returns parent ID or null if no parent
@@ -256,12 +259,11 @@ declare class Utils {
     };
     static MDremoveDocsify(text: string): string;
     /**
-     * Generate the json file on the file for download.
-     * @param fileName file name
-     * @param json file data
-     * @returns {object} json structure (not stringified)
+     * Generate the file for download from JSON object.
      */
-    static generateFile(fileName: string, json: string): void;
+    static generateFile(fileName: string, 
+    /**  json file data */
+    json: Record<string, any>): void;
     /**
      * Convert quality code into text
      * @returns lines that decode quality
@@ -270,7 +272,7 @@ declare class Utils {
     /**
      * Deep copy object
      */
-    static clone(object: any): any;
+    static clone(object: Record<string, any>): Record<string, any>;
     /**
      * Get states of object
      * @returns states as an object in form {"value1": "label1", "value2": "label2"} or null
@@ -284,27 +286,23 @@ declare class Utils {
     static getSvg(url: string): Promise<string>;
     /**
      * Detect file extension by its content
-     * @param {string} base64 Base64 encoded binary file
-     * @returns {string} Detected extension, like 'jpg'
+     * @returns Detected extension, like 'jpg'
      */
-    static detectMimeType(base64: string): string | null;
+    static detectMimeType(
+    /** Base64 encoded binary file */
+    base64: string): string | null;
     /**
      * Check if configured repository is the stable repository
-     *
-     * @param activeRepo current configured repository or multi repository
      */
-    static isStableRepository(activeRepo: string | string[]): boolean;
+    static isStableRepository(
+    /** current configured repository or multi repository */
+    activeRepo: string | string[]): boolean;
     /**
      * Check if a given string is an integer
-     *
-     * @param str string to check
      */
-    static isStringInteger(str: string): boolean;
+    static isStringInteger(str: string | number): boolean;
     /**
      * Check if the date is valid
-     *
-     * @param {Date} date
-     * @return {boolean}
      */
     static isValidDate(date: any): boolean;
 }