@iobroker/adapter-react-v5 4.10.4 → 4.11.0

package/GenericApp.d.ts

@@ -1,98 +1,147 @@
-export default GenericApp;
 /**
- * @extends {Router<import('./types').GenericAppProps, import('./types').GenericAppState>}
- */
-declare class GenericApp extends Router<import("./types").GenericAppProps, import("./types").GenericAppState> {
+ * Copyright 2018-2023 Denis Haev (bluefox) <dogafox@gmail.com>
+ *
+ * MIT License
+ *
+ **/
+import React from 'react';
+import { Connection, AdminConnection } from '@iobroker/socket-client';
+import { type Theme } from '@mui/material';
+import Router from './Components/Router';
+import LegacyConnection from './LegacyConnection';
+import { ConnectionProps, ThemeName, ThemeType, Width } from './types';
+declare global {
+    interface Window {
+        io: any;
+        SocketClient: any;
+        adapterName: string;
+        socketUrl: string;
+        oldAlert: any;
+        changed: boolean;
+    }
+}
+interface GenericAppProps {
+    /** Adapter instance number if known, else will be determined from url */
+    instance?: number;
+    /** The name of the adapter. */
+    adapterName?: string;
+    /** Should the bottom buttons be shown (default: true). */
+    bottomButtons?: boolean;
+    /** Additional translations. */
+    translations?: {
+        [lang in ioBroker.Languages]?: Record<string, string>;
+    };
+    /** Fields that should be encrypted/decrypted. */
+    encryptedFields?: string[];
+    /** Socket.io configuration. */
+    socket?: ConnectionProps;
+    /** Desired connection object */
+    Connection?: LegacyConnection | Connection | AdminConnection;
+    /** sentry DNS */
+    sentryDSN?: string;
+    onThemeChange?: (newThemeName: ThemeName) => void;
+    classes?: Record<string, string>;
+}
+interface GenericAppSettings extends GenericAppProps {
+    /** Don't load all objects on start-up. */
+    doNotLoadAllObjects?: boolean;
+}
+interface GenericAppState {
+    loaded: boolean;
+    themeType: ThemeType;
+    themeName: ThemeName;
+    theme: Theme;
+    expertMode: boolean;
+    selectedTab: string;
+    selectedTabNum: number | undefined;
+    native: Record<string, any>;
+    errorText: string | React.JSX.Element;
+    changed: boolean;
+    connected: boolean;
+    isConfigurationError: string;
+    toast: string | React.JSX.Element;
+    bottomButtons: boolean;
+    width: Width;
+    confirmClose: boolean;
+    _alert: boolean;
+    _alertType: 'info' | 'warning' | 'error' | 'success';
+    _alertMessage: string | React.JSX.Element;
+    common?: Record<string, any>;
+}
+declare class GenericApp extends Router<GenericAppProps, GenericAppState> {
+    protected socket: AdminConnection;
+    protected readonly instance: number;
+    protected readonly adapterName: string;
+    protected readonly instanceId: string;
+    protected readonly newReact: boolean;
+    protected encryptedFields: string[];
+    protected readonly sentryDSN: string | undefined;
+    private alertDialogRendered;
+    private _secret;
+    protected _systemConfig: Record<string, any> | undefined;
+    private savedNative;
+    private common;
+    private sentryStarted;
+    private sentryInited;
+    private resizeTimer;
     /**
-     * Gets the width depending on the window inner width.
-     * @returns {import('./types').Width}
+     * @param {import('./types').GenericAppProps} props
+     * @param {import('./types').GenericAppSettings | undefined} settings
      */
-    static getWidth(): import('./types').Width;
+    constructor(props: GenericAppProps, settings?: GenericAppSettings);
     /**
-     * Closes the dialog.
-     * @private
+     * Checks if this connection is running in a web adapter and not in an admin.
+     * @returns True if running in a web adapter or in a socketio adapter.
      */
-    private static onClose;
+    static isWeb(): boolean;
+    showAlert(message: string, type?: 'info' | 'warning' | 'error' | 'success'): void;
+    renderAlertSnackbar(): React.JSX.Element;
+    onSystemConfigChanged: (id: string, obj: ioBroker.Object | null | undefined) => void;
     /**
-     * @param {import('./types').GenericAppProps} props
-     * @param {import('./types').GenericAppSettings | undefined} settings
+     * Called immediately after a component is mounted. Setting state here will trigger re-rendering.
      */
-    constructor(props: import('./types').GenericAppProps, settings: import('./types').GenericAppSettings | undefined);
+    componentDidMount(): void;
     /**
-     * @type {import('@iobroker/socket-client').Connection | import('@iobroker/socket-client').AdminConnection}
+     * Called immediately before a component is destroyed.
      */
-    socket: import('@iobroker/socket-client').Connection | import('@iobroker/socket-client').AdminConnection;
-    instance: number;
-    adapterName: any;
-    instanceId: string;
-    newReact: boolean;
-    state: {
-        selectedTab: any;
-        selectedTabNum: number;
-        native: {};
-        errorText: string;
-        changed: boolean;
-        connected: boolean;
-        loaded: boolean;
-        isConfigurationError: string;
-        expertMode: boolean;
-        toast: string;
-        theme: import("./types").Theme;
-        themeName: string;
-        themeType: string;
-        bottomButtons: boolean;
-        width: import("./types").Width;
-        confirmClose: boolean;
-        _alert: boolean;
-        _alertType: string;
-        _alertMessage: string;
-    };
-    savedNative: {};
-    encryptedFields: string[];
-    sentryDSN: any;
-    alerDialogRendered: boolean;
-    _secret: any;
-    _systemConfig: {};
-    sentryStarted: boolean;
-    sentryInited: boolean;
-    common: (ioBroker.StateCommon & Record<string, any>) | (ioBroker.ChannelCommon & Record<string, any>) | (ioBroker.DeviceCommon & Record<string, any>) | (ioBroker.OtherCommon & Record<string, any>) | (ioBroker.EnumCommon & Record<string, any>) | (ioBroker.MetaCommon & Record<string, any>) | (ioBroker.HostCommon & Record<string, any>) | (ioBroker.AdapterCommon & Record<string, any>) | (ioBroker.InstanceCommon & Record<string, any>) | (ioBroker.UserCommon & Record<string, any>) | (ioBroker.GroupCommon & Record<string, any>) | (ioBroker.ScriptCommon & Record<string, any>) | (ioBroker.ChartCommon & Record<string, any>) | (ioBroker.ScheduleCommon & Record<string, any>);
-    showAlert(message: any, type: any): void;
-    renderAlertSnackbar(): React.JSX.Element;
-    onSystemConfigChanged: (id: any, obj: any) => void;
-    onReceiveMessage: (message: any) => void;
+    componentWillUnmount(): void;
+    onReceiveMessage: (message: {
+        data: string;
+    } | null) => void;
     /**
      * @private
      */
-    private onResize;
-    resizeTimer: any;
+    onResize: () => void;
+    /**
+     * Gets the width depending on the window inner width.
+     * @returns {import('./types').Width}
+     */
+    static getWidth(): Width;
     /**
      * Get a theme
-     * @param {string} name Theme name
-     * @returns {import('./types').Theme}
+     * @param name Theme name
      */
-    createTheme(name?: string): import('./types').Theme;
+    createTheme(name?: ThemeName | null | undefined): Theme;
     /**
      * Get the theme name
-     * @param {import('./types').Theme} currentTheme Theme
-     * @returns {string} Theme name
      */
-    getThemeName(currentTheme: import('./types').Theme): string;
+    getThemeName(currentTheme: Theme): ThemeName;
     /**
      * Get the theme type
-     * @param {import('./types').Theme} currentTheme Theme
-     * @returns {string} Theme type
      */
-    getThemeType(currentTheme: import('./types').Theme): string;
+    getThemeType(currentTheme: Theme): ThemeType;
+    onThemeChanged(newThemeName: string): void;
+    onToggleExpertMode(expertMode: boolean): void;
     /**
      * Changes the current theme
-     * @param {string} newThemeName Theme name
+     * @param newThemeName Theme name
      **/
-    toggleTheme(newThemeName: string): void;
+    toggleTheme(newThemeName?: ThemeName): void;
     /**
      * Gets the system configuration.
      * @returns {Promise<ioBroker.OtherObject>}
      */
-    getSystemConfig(): Promise<ioBroker.OtherObject>;
+    getSystemConfig(): Promise<import("@iobroker/socket-client").SystemConfig>;
     /**
      * Get current expert mode
      * @returns {boolean}
@@ -105,126 +154,112 @@ declare class GenericApp extends Router<import("./types").GenericAppProps, impor
     onConnectionReady(): void;
     /**
      * Encrypts a string.
-     * @param {string} value
-     * @returns {string}
      */
     encrypt(value: string): string;
     /**
      * Decrypts a string.
-     * @param {string} value
-     * @returns {string}
      */
     decrypt(value: string): string;
+    /**
+     * Gets called when the navigation hash changes.
+     * You may override this if needed.
+     */
+    onHashChanged(): void;
     /**
      * Selects the given tab.
-     * @param {string} tab
-     * @param {number} [index]
      */
     selectTab(tab: string, index?: number): void;
     /**
      * Gets called before the settings are saved.
      * You may override this if needed.
-     * @param {Record<string, any>} settings
      */
     onPrepareSave(settings: Record<string, any>): boolean;
     /**
      * Gets called after the settings are loaded.
      * You may override this if needed.
-     * @param {Record<string, any>} settings
-     * @param {string[]} encryptedNative optional list of fields to be decrypted
+     * @param encryptedNative optional list of fields to be decrypted
      */
-    onPrepareLoad(settings: Record<string, any>, encryptedNative: string[]): void;
+    onPrepareLoad(settings: Record<string, any>, encryptedNative?: string[]): void;
     /**
      * Gets the extendable instances.
      * @returns {Promise<any[]>}
      */
-    getExtendableInstances(): Promise<any[]>;
+    getExtendableInstances(): Promise<ioBroker.InstanceObject[]>;
     /**
      * Gets the IP addresses of the given host.
-     * @param {string} host
      */
-    getIpAddresses(host: string): Promise<any>;
+    getIpAddresses(host: string): Promise<{
+        name: string;
+        address: string;
+        family: 'ipv4' | 'ipv6';
+    }[]>;
     /**
      * Saves the settings to the server.
-     * @param {boolean} isClose True if the user is closing the dialog.
+     * @param isClose True if the user is closing the dialog.
      */
-    onSave(isClose: boolean): void;
+    onSave(isClose?: boolean): void;
     /**
      * Renders the toast.
-     * @returns {JSX.Element | null} The JSX element.
      */
-    renderToast(): JSX.Element | null;
+    renderToast(): React.JSX.Element;
+    /**
+     * Closes the dialog.
+     * @private
+     */
+    static onClose(): void;
     /**
      * Renders the error dialog.
      * @returns {JSX.Element | null} The JSX element.
      */
-    renderError(): JSX.Element | null;
+    renderError(): React.JSX.Element;
     /**
      * Checks if the configuration has changed.
      * @param {Record<string, any>} [native] the new state
      */
-    getIsChanged(native?: Record<string, any>): boolean;
+    getIsChanged(native: Record<string, any>): boolean;
     /**
      * Gets called when loading the configuration.
-     * @param {Record<string, any>} newNative The new configuration object.
+     * @param newNative The new configuration object.
      */
     onLoadConfig(newNative: Record<string, any>): void;
     /**
      * Sets the configuration error.
-     * @param {string} errorText
      */
     setConfigurationError(errorText: string): void;
     /**
      * Renders the save and close buttons.
      * @returns {JSX.Element | undefined} The JSX element.
      */
-    renderSaveCloseButtons(): JSX.Element | undefined;
+    renderSaveCloseButtons(): React.JSX.Element;
     /**
      * @private
-     * @param {Record<string, any>} obj
-     * @param {any} attrs
-     * @param {any} value
-     * @returns {boolean | undefined}
      */
-    private _updateNativeValue;
+    _updateNativeValue(obj: Record<string, any>, attrs: string | string[], value: any): boolean;
     /**
      * Update the native value
-     * @param {string} attr The attribute name with dots as delimiter.
-     * @param {any} value The new value.
-     * @param {(() => void)} [cb] Callback which will be called upon completion.
+     * @param attr The attribute name with dots as delimiter.
+     * @param value The new value.
+     * @param cb Callback which will be called upon completion.
      */
-    updateNativeValue(attr: string, value: any, cb?: (() => void)): void;
+    updateNativeValue(attr: string, value: any, cb: () => void): void;
     /**
      * Set the error text to be shown.
-     * @param {string | JSX.Element} text
      */
-    showError(text: string | JSX.Element): void;
+    showError(text: string | React.JSX.Element): void;
     /**
      * Sets the toast to be shown.
      * @param {string} toast
      */
-    showToast(toast: string): void;
+    showToast(toast: string | React.JSX.Element): void;
     /**
      * Renders helper dialogs
      * @returns {JSX.Element} The JSX element.
      */
-    renderHelperDialogs(): JSX.Element;
+    renderHelperDialogs(): React.JSX.Element;
     /**
      * Renders this component.
      * @returns {JSX.Element} The JSX element.
      */
-    render(): JSX.Element;
+    render(): React.JSX.Element;
 }
-declare namespace GenericApp {
-    namespace propTypes {
-        let adapterName: PropTypes.Requireable<string>;
-        let onThemeChange: PropTypes.Requireable<(...args: any[]) => any>;
-        let socket: PropTypes.Requireable<object>;
-        let encryptedFields: PropTypes.Requireable<any[]>;
-        let bottomButtons: PropTypes.Requireable<boolean>;
-        let Connection: PropTypes.Requireable<object>;
-    }
-}
-import Router from './Components/Router';
-import React from 'react';
-import PropTypes from 'prop-types';
+export default GenericApp;