@iobroker/adapter-react-v5 4.9.1 → 4.9.2

package/Components/Utils.d.ts

@@ -1,4 +1,25 @@
-export default Utils;
+/**
+ * Copyright 2018-2023 Denis Haev <dogafox@gmail.com>
+ *
+ * MIT License
+ *
+ **/
+import React from 'react';
+interface GetObjectNameOptions {
+    name?: ioBroker.StringOrTranslated;
+    language?: ioBroker.Languages;
+}
+type SmartName = null | (ioBroker.StringOrTranslated & {
+    /** Which kind of device it is */
+    smartType?: string | null;
+    /** 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[];
+}
 declare class Utils {
     static namespace: string;
     static INSTANCES: string;
@@ -6,280 +27,202 @@ declare class Utils {
     static FORBIDDEN_CHARS: RegExp;
     /**
      * Capitalize words.
-     * @param {string | undefined} name
-     * @returns {string}
      */
-    static CapitalWords(name: string | undefined): string;
-    static formatSeconds(seconds: any): string;
+    static CapitalWords(name: string): string;
+    static formatSeconds(seconds: number): string;
     /**
      * Get the name of the object by id from the name or description.
-     * @param {Record<string, ioBroker.Object>} objects
-     * @param {string} id
-     * @param {{ name: any; } | ioBroker.Languages | null} settings
-     * @param {{ language?: ioBroker.Languages; }} options
-     * @param {boolean} [isDesc] Set to true to get the description.
-     * @returns {string}
+     * @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: {
-        name: any;
-    } | ioBroker.Languages | null, options: {
-        language?: ioBroker.Languages;
-    }, isDesc?: boolean): string;
+    static getObjectName(objects: Record<string, ioBroker.Object>, id: string, settings?: GetObjectNameOptions | ioBroker.Languages | null, options?: GetObjectNameOptions, isDesc?: boolean): string;
     /**
      * Get the name of the object from the name or description.
-     * @param {ioBroker.PartialObject} obj
-     * @param {{ name: any; } | ioBroker.Languages | null } settings or language
-     * @param {{ language?: ioBroker.Languages; } } options
-     * @param {boolean} [isDesc] Set to true to get the description.
-     * @param {boolean} [noTrim] Allow to use spaces in name (by edit)
-     * @returns {string}
+     * @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.PartialObject, settings: {
-        name: any;
-    } | ioBroker.Languages | null, options: {
-        language?: ioBroker.Languages;
-    }, isDesc?: boolean, noTrim?: boolean): string;
+    static getObjectNameFromObj(obj: ioBroker.Object, settings?: GetObjectNameOptions | ioBroker.Languages | null, options?: GetObjectNameOptions, isDesc?: boolean, noTrim?: boolean): string;
     /**
-     * @param {ioBroker.PartialObject | ioBroker.ObjectCommon} obj
-     * @param {string} forEnumId
-     * @param {{ user: string; }} options
-     * @returns {string | null}
+     * Extracts from the object material settings, depends on username
      */
-    static getSettingsOrder(obj: ioBroker.PartialObject | ioBroker.ObjectCommon, forEnumId: string, options: {
+    static getSettingsOrder(obj: ioBroker.StateObject | ioBroker.StateCommon, forEnumId: string, options: {
         user: string;
     }): string | null;
     /**
-     * @param {ioBroker.PartialObject | ioBroker.ObjectCommon} obj
-     * @param {string} forEnumId
-     * @param {{ user: string; }} options
+        Used in material
      */
-    static getSettingsCustomURLs(obj: ioBroker.PartialObject | ioBroker.ObjectCommon, forEnumId: string, options: {
+    static getSettingsCustomURLs(obj: ioBroker.StateObject | ioBroker.StateCommon, forEnumId: string, options: {
         user: string;
-    }): any;
+    }): string | null;
     /**
      * Reorder the array items in list between source and dest.
-     * @param {Iterable<any> | ArrayLike<any>} list
-     * @param {number} source
-     * @param {number} dest
-     */
-    static reorder(list: Iterable<any> | ArrayLike<any>, source: number, dest: number): any[];
-    /**
-     * @param {any} obj
-     * @param {{ id: any; user: any; name: any; icon: any; color: any; language: ioBroker.Languages; }} options
-     * @param {boolean} [defaultEnabling]
-     */
-    static getSettings(obj: any, options: {
-        id: any;
-        user: any;
-        name: any;
-        icon: any;
-        color: any;
-        language: ioBroker.Languages;
+     */
+    static reorder(list: Iterable<any> | ArrayLike<any>, source: number, dest: number): Iterable<any> | ArrayLike<any>;
+    /**
+        Get smart name settings for the given object.
+     */
+    static getSettings(obj: ioBroker.StateObject | ioBroker.StateCommon, options: {
+        id?: string;
+        user?: string;
+        name?: ioBroker.StringOrTranslated;
+        icon?: string;
+        color?: string;
+        language?: ioBroker.Languages;
     }, defaultEnabling?: boolean): any;
     /**
-     * @param {any} obj
-     * @param {any} settings
-     * @param {{ user: any; language: ioBroker.Languages; }} options
+        Sets smartName settings for the given object.
      */
-    static setSettings(obj: any, settings: any, options: {
-        user: any;
-        language: ioBroker.Languages;
+    static setSettings(obj: ioBroker.StateObject, settings: any, options: {
+        user?: string;
+        language?: ioBroker.Languages;
     }): boolean;
     /**
      * Get the icon for the given settings.
-     * @param {{ icon: string | undefined; name: string | undefined; prefix: string | undefined}} settings
-     * @param {any} style
-     * @returns {JSX.Element | null}
      */
     static getIcon(settings: {
-        icon: string | undefined;
-        name: string | undefined;
-        prefix: string | undefined;
-    }, style: any): JSX.Element | null;
+        icon?: string;
+        name?: string;
+        prefix?: string;
+    }, style?: React.CSSProperties): React.JSX.Element | null;
     /**
      * Get the icon for the given object.
-     * @param {string} id
-     * @param {{ common: { icon: any; }; }} obj
-     * @returns {string | null}
-     */
-    static getObjectIcon(id: string, obj: {
-        common: {
-            icon: any;
-        };
-    }): string | null;
+     */
+    static getObjectIcon(id: string | ioBroker.PartialObject, obj?: ioBroker.PartialObject): string | null;
     /**
      * Splits CamelCase into words.
-     * @param {string | undefined} text
-     * @returns {string}
      */
     static splitCamelCase(text: string | 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
-     * @param {string | null | undefined} color
-     * @param {boolean} [defaultValue]
-     * @returns {boolean}
      */
     static isUseBright(color: string | null | undefined, defaultValue?: boolean): boolean;
     /**
      * Get the time string in the format 00:00.
-     * @param {string | number} seconds
      */
     static getTimeString(seconds: string | number): string;
     /**
      * Gets the wind direction with the given angle (degrees).
-     * @param {number} angle in degrees.
-     * @returns {string | undefined}
+     * @param angle in degrees.
      */
-    static getWindDirection(angle: number): string | undefined;
+    static getWindDirection(angle: number): string;
     /**
-     * Pad the given number with a zero if it's not 2 digits long.
-     * @param {string | number} num
+     * Pad the given number with a zero if it's not two digits long.
      */
-    static padding(num: string | number): string | number;
+    static padding(num: string | number): string;
     /**
      * Sets the date format.
-     * @param {string} format
      */
     static setDataFormat(format: string): void;
     /**
      * Converts the date to a string.
-     * @param {string | number | Date} now
-     * @returns {string}
      */
     static date2string(now: string | number | Date): string;
     /**
      * Render a text as a link.
-     * @param {string} text
-     * @returns {string | JSX.Element[]}
      */
-    static renderTextWithA(text: string): string | JSX.Element[];
+    static renderTextWithA(text: string): React.JSX.Element[] | string;
     /**
      * Get the smart name of the given state.
-     * @param {Record<string, ioBroker.StateObject> | ioBroker.StateObject} states
-     * @param {string} id
-     * @param {string} instanceId
-     * @param {boolean} [noCommon]
      */
-    static getSmartName(states: Record<string, ioBroker.StateObject> | ioBroker.StateObject, id: string, instanceId: string, noCommon?: boolean): any;
+    static getSmartName(states: Record<string, ioBroker.StateObject> | ioBroker.StateObject | ioBroker.StateCommon, id: string, instanceId: string, noCommon?: boolean): SmartName | undefined;
     /**
      * Get the smart name from a state.
-     * @param {ioBroker.StateObject} obj
-     * @param {string} instanceId
-     * @param {boolean} [noCommon]
      */
-    static getSmartNameFromObj(obj: ioBroker.StateObject, instanceId: string, noCommon?: boolean): any;
+    static getSmartNameFromObj(obj: ioBroker.StateObject, instanceId: string, noCommon?: boolean): SmartName | undefined;
     /**
      * Enable smart name for a state.
-     * @param {ioBroker.StateObject} obj
-     * @param {string} instanceId
-     * @param {boolean} [noCommon]
      */
     static enableSmartName(obj: ioBroker.StateObject, instanceId: string, noCommon?: boolean): void;
     /**
      * Completely remove smart name from a state.
-     * @param {ioBroker.StateObject} obj
-     * @param {string | number} instanceId
-     * @param {boolean} [noCommon]
      */
-    static removeSmartName(obj: ioBroker.StateObject, instanceId: string | number, noCommon?: boolean): void;
+    static removeSmartName(obj: ioBroker.StateObject, instanceId: string, noCommon?: boolean): void;
     /**
      * Update the smartname of a state.
-     * @param {ioBroker.StateObject} obj
-     * @param {string} newSmartName
-     * @param {string | undefined} byON
-     * @param {string | undefined} smartType
-     * @param {string} instanceId
-     * @param {boolean} [noCommon]
      */
-    static updateSmartName(obj: ioBroker.StateObject, newSmartName: string, byON: string | undefined, smartType: string | undefined, instanceId: string, noCommon?: boolean): void;
+    static updateSmartName(obj: ioBroker.StateObject, newSmartName: ioBroker.StringOrTranslated, byON: string | null, smartType: string | null, instanceId: string, noCommon?: boolean): void;
     /**
      * Disable the smart name of a state.
-     * @param {ioBroker.StateObject} obj
-     * @param {string} instanceId
-     * @param {boolean} [noCommon]
      */
     static disableSmartName(obj: ioBroker.StateObject, instanceId: string, noCommon?: boolean): void;
     /**
      * Copy text to the clipboard.
-     * @param {string} text
-     * @param {Event} [e]
      */
-    static copyToClipboard(text: string, e?: Event): boolean;
+    static copyToClipboard(text: string, e: Event): boolean;
     /**
      * Gets the extension of a file name.
-     * @param {string | null} [fileName] the file name.
-     * @returns {string | null} The extension in lower case.
+     * @param fileName the file name.
+     * @returns The extension in lower case.
      */
-    static getFileExtension(fileName?: string | null): string | null;
+    static getFileExtension(fileName: string): string | null;
     /**
      * Format number of bytes as a string with B, KB, MB or GB.
      * The base for all calculations is 1024.
-     * @param {number} bytes The number of bytes.
-     * @returns {string} The formatted string (e.g. '723.5 KB')
+     * @param bytes The number of bytes.
+     * @returns The formatted string (e.g. '723.5 KB')
      */
     static formatBytes(bytes: number): string;
     /**
      * Invert the given color according to a theme type to get the inverted text color for background
-     * @param {string} color Color in the format '#rrggbb' or '#rgb' (or without a hash)
-     * @param {string} themeType theme type
-     * @param {string} invert dark theme has light color in control or light theme has light color in control
-     * @returns {string | undefined}
+     * @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: string, invert: string): string | undefined;
+    static getInvertedColor(color: string, themeType?: string, invert?: boolean): string | undefined;
     /**
      * Invert the given color
-     * @param {string} hex Color in the format '#rrggbb' or '#rgb' (or without hash)
-     * @param {boolean} bw Set to black or white.
-     * @returns {string}
+     * @param hex Color in the format '#rrggbb' or '#rgb' (or without hash)
+     * @param bw Set to black or white.
      */
-    static invertColor(hex: string, bw: boolean): string;
+    static invertColor(hex: string, bw?: boolean): string;
     /**
      * Convert RGB to array [r, g, b]
-     * @param {string} hex Color in the format '#rrggbb' or '#rgb' (or without hash) or rgb(r,g,b) or rgba(r,g,b,a)
-     * @returns {Array<number>} Array with 3 elements [r, g, b]
+     * @param hex Color in the format '#rrggbb' or '#rgb' (or without hash) or rgb(r,g,b) or rgba(r,g,b,a)
+     * @returns Array with 3 elements [r, g, b]
      */
-    static color2rgb(hex: string): Array<number>;
+    static color2rgb(hex: string): false | [number, number, number] | '';
     /**
      * Convert RGB to LAB
      * @param {Array<number>} rgb color in format [r,g,b]
      * @returns {Array<number>} lab color in format [l,a,b]
      */
-    static rgb2lab(rgb: Array<number>): Array<number>;
+    static rgb2lab(rgb: [number, number, number]): [number, number, number];
     /**
      * Calculate the distance between two colors in LAB color space in the range 0-100^2
      * If distance is less than 1000, the colors are similar
-     * @param {string} color1 Color in the format '#rrggbb' or '#rgb' (or without hash) or rgb(r,g,b) or rgba(r,g,b,a)
-     * @param {string} color2 Color in the format '#rrggbb' or '#rgb' (or without hash) or rgb(r,g,b) or rgba(r,g,b,a)
-     * @returns {number} distance in the range 0-100^2
+     * @param color1 Color in the format '#rrggbb' or '#rgb' (or without hash) or rgb(r,g,b) or rgba(r,g,b,a)
+     * @param color2 Color in the format '#rrggbb' or '#rgb' (or without hash) or rgb(r,g,b) or rgba(r,g,b,a)
+     * @returns distance in the range 0-100^2
      */
     static colorDistance(color1: string, color2: string): number;
     /**
      * @private
-     * @param {any} mix
-     * @returns {string}
      */
-    private static _toVal;
+    static _toVal(mix: clsx.ClassValue): string;
     /**
      * Convert any object to a string with its values.
      * @returns {string}
      */
-    static clsx(...args: any[]): string;
+    static clsx(...inputs: clsx.ClassValue[]): string;
     /**
      * Get the current theme name (either from local storage or the browser settings).
      * @param {string} [themeName]
      * @returns {string}
      */
-    static getThemeName(themeName?: string): string;
+    static getThemeName(themeName?: string): any;
     /**
      * Get the type of theme.
-     * @param {string} [themeName]
-     * @returns {'dark' | 'light'}
      */
     static getThemeType(themeName?: string): 'dark' | 'light';
     /**
      * Set the theme name and theme type.
-     * @param {string} themeName
      */
     static setThemeName(themeName: string): void;
     /**
@@ -290,80 +233,72 @@ declare class Utils {
     static toggleTheme(themeName: string | null): string;
     /**
      * Get the list of themes
-     * @returns {array<string>} list of possible themes
+     * @returns list of possible themes
      */
-    static getThemeNames(): array<string>;
+    static getThemeNames(): string[];
     /**
      * Parse a query string into its parts.
-     * @param {string} query
-     * @returns {Record<string, string | boolean | number>}
      */
     static parseQuery(query: string): Record<string, string | boolean | number>;
     /**
      * Returns parent ID.
-     * @param {string} id
-     * @returns {string | null} parent ID or null if no parent
+     * @returns parent ID or null if no parent
      */
     static getParentId(id: string): string | null;
-    static formatDate(dateObj: any, dateFormat: any): string;
-    static formatTime(seconds: any): string;
-    static MDtext2link(text: any): any;
-    static openLink(url: any, target: any): void;
-    static MDgetTitle(text: any): any;
-    static MDextractHeader(text: any): {
-        header: {};
-        body: any;
+    static formatDate(dateObj: Date, dateFormat: string): string;
+    static formatTime(seconds: number): string;
+    static MDtext2link(text: string): string;
+    static openLink(url: string, target?: string): void;
+    static MDgetTitle(text: string): string;
+    static MDextractHeader(text: string): {
+        header: Record<string, string | boolean | number>;
+        body: string;
     };
-    static MDremoveDocsify(text: any): any;
+    static MDremoveDocsify(text: string): string;
     /**
      * Generate the json file on the file for download.
-     * @param {string} filename file name
-     * @param {string} json file data
+     * @param fileName file name
+     * @param json file data
      * @returns {object} json structure (not stringified)
      */
-    static generateFile(filename: string, json: string): object;
+    static generateFile(fileName: string, json: string): void;
     /**
      * Convert quality code into text
      * @param {number} quality code
      * @returns {array<string>} lines that decode quality
      */
-    static quality2text(quality: number): array<string>;
+    static quality2text(quality: number): string[];
     /**
      * Deep copy object
-     * @param {object} object
-     * @returns {object}
      */
-    static clone(object: object): object;
+    static clone(object: any): any;
     /**
      * Get states of object
-     * @param {object} obj
-     * @returns {object} states as an object in form {"value1": "label1", "value2": "label2"} or null
+     * @returns states as an object in form {"value1": "label1", "value2": "label2"} or null
      */
-    static getStates(obj: object): object;
+    static getStates(obj: ioBroker.StateObject | null | undefined): Record<string, string> | null;
     /**
      * Get svg file as text
-     * @param {string} url URL of SVG file
-     * @returns {object} Promise with "data:image..."
+     * @param url URL of SVG file
+     * @returns Promise with "data:image..."
      */
-    static getSvg(url: string): object;
+    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'
      */
-    static detectMimeType(base64: string): string;
+    static detectMimeType(base64: string): string | null;
     /**
      * Check if configured repository is the stable repository
      *
-     * @param {string | string[]} activeRepo current configured repository or multi repository
-     * @return {boolean}
+     * @param activeRepo current configured repository or multi repository
      */
     static isStableRepository(activeRepo: string | string[]): boolean;
     /**
-     * Check if given string is an integer
+     * Check if a given string is an integer
      *
-     * @param {string} str string to check
-     * @return {boolean}
+     * @param str string to check
      */
     static isStringInteger(str: string): boolean;
     /**
@@ -372,5 +307,6 @@ declare class Utils {
      * @param {Date} date
      * @return {boolean}
      */
-    static isValidDate(date: Date): boolean;
+    static isValidDate(date: any): boolean;
 }
+export default Utils;