@iobroker/gui-components 10.0.2 → 10.0.4

package/build/Components/{ObjectBrowser.d.ts → ObjectBrowser/ObjectBrowserClass.d.ts}

@@ -3,10 +3,15 @@
  *
  * MIT License
  *
+ * The object browser itself: state, socket subscriptions, the tree and the rendering.
+ * The dialogs, the toolbar, the rows and the context menu live in the sibling files of this
+ * directory and get this instance as the first argument. Because of that, the members of this
+ * class are not private, even if they are not intended to be used outside of the object browser.
  */
 import React, { Component, type JSX } from 'react';
-import { getSelectIdIconFromObjects } from './objectBrowserUtils';
-import type { ObjectBrowserProps, AdapterColumn, ObjectBrowserFilter, ObjectBrowserState, TreeItem, CustomAdminColumnStored, ObjectEvent } from './objectBrowser.types';
+import { getSelectIdIconFromObjects } from './utils';
+import type { Width } from '../../types';
+import type { ObjectBrowserProps, AdapterColumn, ObjectBrowserFilter, ObjectBrowserPossibleColumns, ObjectBrowserState, TreeInfo, TreeItem, CustomAdminColumnStored, ObjectEvent } from './types';
 export { getSelectIdIconFromObjects, type ObjectBrowserFilter };
 declare global {
     interface Window {
@@ -20,33 +25,47 @@ declare module '@mui/material/Button' {
         grey: true;
     }
 }
-export declare const ITEM_IMAGES: Record<string, JSX.Element>;
 export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, ObjectBrowserState> {
-    private info;
-    private localStorage;
+    info: TreeInfo;
+    localStorage: Storage;
+    /**
+     * Own copy of the screen widths. The widths, that the user stored for THIS dialog, must not leak
+     * into the other instances of the object browser (the constant is a module singleton).
+     */
+    private readonly screenWidths;
     private readonly tableRef;
+    /** Watches the width of the table container to detect the width class */
+    private resizeObserver;
+    private observedContainer;
+    /** Width class for which the columns were calculated the last time */
+    private lastCalculatedWidth;
     private pausedSubscribes;
     private selectFirst;
     /** Last navigation that was applied from `navigateTo` or reported via `onNavigateTo` (loop guard). */
     private lastNav;
     /** True while applying `navigateTo`, so the derived-state watcher does not echo it back. */
     private applyingNav;
-    private root;
-    private readonly states;
-    private subscribes;
+    root: TreeItem | null;
+    readonly states: Record<string, ioBroker.State>;
+    subscribes: string[];
     private unsubscribeTimer;
     private statesUpdateTimer;
     private objectsUpdateTimer;
-    private readonly visibleCols;
-    private readonly texts;
-    private readonly possibleCols;
-    private readonly imagePrefix;
-    private adapterColumns;
+    /** Columns that are visible in the auto mode. Depends on the width of the container */
+    visibleCols: ObjectBrowserPossibleColumns[];
+    readonly texts: Record<string, string>;
+    readonly possibleCols: ObjectBrowserPossibleColumns[];
+    readonly imagePrefix: string;
+    adapterColumns: AdapterColumn[];
     private styleTheme;
-    private edit;
-    private readonly levelPadding;
+    edit: {
+        val: string | number | boolean | null;
+        q: number;
+        ack: boolean;
+        id: string;
+    };
+    readonly levelPadding: number;
     private customWidth;
-    private resizeTimeout;
     private resizerNextName;
     private resizerActiveName;
     private resizerCurrentWidths;
@@ -59,20 +78,61 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     private resizerActiveDiv;
     private resizerNextDiv;
     private storedWidths;
-    private systemConfig;
+    systemConfig: ioBroker.SystemConfigObject | null;
     objects: Record<string, ioBroker.Object>;
-    private defaultHistory;
+    defaultHistory: string;
     private ctrlPressed;
-    private columnsVisibility;
-    private changedIds;
-    private contextMenu;
-    private recordStates;
-    private styles;
+    columnsVisibility: {
+        id?: number | string;
+        name?: number | string;
+        type?: number;
+        role?: number;
+        room?: number;
+        func?: number;
+        changedFrom?: number;
+        qualityCode?: number;
+        timestamp?: number;
+        lastChange?: number;
+        val?: number;
+        buttons?: number;
+    };
+    changedIds: null | string[];
+    contextMenu: null | {
+        item: any;
+        ts: number;
+    };
+    recordStates: string[];
+    styles: {
+        cellIdIconFolder?: React.CSSProperties;
+        cellIdIconDocument?: React.CSSProperties;
+        iconDeviceError?: React.CSSProperties;
+        iconDeviceConnected?: React.CSSProperties;
+        iconDeviceDisconnected?: React.CSSProperties;
+        cellButtonsButtonWithCustoms?: React.CSSProperties;
+        invertedBackground?: React.CSSProperties;
+        invertedBackgroundFlex?: React.CSSProperties;
+        contextMenuEdit?: React.CSSProperties;
+        contextMenuEditValue?: React.CSSProperties;
+        contextMenuView?: React.CSSProperties;
+        contextMenuCustom?: React.CSSProperties;
+        contextMenuACL?: React.CSSProperties;
+        contextMenuRoom?: React.CSSProperties;
+        contextMenuRole?: React.CSSProperties;
+        contextMenuDelete?: React.CSSProperties;
+        filterInput?: React.CSSProperties;
+        iconCopy?: React.CSSProperties;
+        aliasReadWrite?: React.CSSProperties;
+        aliasAlone?: React.CSSProperties;
+    };
     private expertMode;
-    private customColumnDialog;
+    customColumnDialog: null | {
+        value: boolean | number | string;
+        type: 'boolean' | 'number' | 'string';
+        initValue: boolean | number | string;
+    };
     constructor(props: ObjectBrowserProps);
     loadAllObjects(update?: boolean): Promise<void>;
-    private expandAllSelected;
+    expandAllSelected(cb?: () => void): void;
     /**
      * @param isDouble is double click
      */
@@ -115,7 +175,6 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
      * Called when an item is selected/deselected.
      */
     onSelect(toggleItem: string, isDouble?: boolean, cb?: () => void): void;
-    private _renderDefinedList;
     /**
      * Renders the columns' selector.
      */
@@ -148,25 +207,18 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
             columnsForAdmin: Record<string, CustomAdminColumnStored[]> | null;
         };
     };
-    private subscribe;
-    private unsubscribe;
-    private pauseSubscribe;
+    subscribe(id: string): void;
+    unsubscribe(id: string): void;
+    pauseSubscribe(isPause: boolean): void;
     clearFilter(): void;
     isFilterEmpty(): boolean;
-    private getFilterInput;
-    private getFilterSelect;
-    private getFilterSelectRole;
-    private getFilterSelectRoom;
-    private getFilterSelectFunction;
-    private getFilterSelectType;
-    private getFilterSelectCustoms;
-    private onExpandAll;
-    private onCollapseAll;
+    onExpandAll(root?: TreeItem, expanded?: string[]): void;
+    onCollapseAll(): void;
     private expandDepth;
     private static collapseDepth;
-    private onExpandVisible;
-    private onStatesViewVisible;
-    private onCollapseVisible;
+    onExpandVisible(): void;
+    onStatesViewVisible(): void;
+    onCollapseVisible(): void;
     private getEnumsForId;
     private _createAllEnums;
     private loadObjects;
@@ -174,10 +226,23 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     /**
      * Exports the selected objects based on the given options and triggers file generation
      */
-    private _exportObjects;
+    _exportObjects(
+    /**  Options to filter/reduce the output */
+    options: {
+        /** Whether all objects should be exported or only the selected ones */
+        isAll?: boolean;
+        /** Whether the output should be beautified */
+        beautify?: boolean;
+        /** Whether "system.repositories" should be excluded */
+        excludeSystemRepositories?: boolean;
+        /** Whether translations should be reduced to only the english value */
+        excludeTranslations?: boolean;
+        /** Whether the values of the states should be not included */
+        noStatesByExportImport?: boolean;
+    }): Promise<void>;
     renderExportDialog(): JSX.Element | null;
     renderRenameDialog(): JSX.Element | null;
-    private parseJsonFile;
+    parseJsonFile(contents: string): Promise<void>;
     private handleJsonUpload;
     toolTipObjectCreating: () => JSX.Element[] | string;
     onOpenFile(): void;
@@ -186,33 +251,22 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
      * Renders the toolbar.
      */
     getToolbar(): JSX.Element;
-    private toggleExpanded;
-    private onCopy;
-    renderTooltipAccessControl: (acl: ioBroker.StateACL) => null | JSX.Element;
+    toggleExpanded(id: string): void;
+    onCopy(e: React.MouseEvent, text: string | undefined): void;
+    renderTooltipAccessControl(acl: ioBroker.StateACL): null | JSX.Element;
     renderColumnButtons(id: string, item: TreeItem): (JSX.Element | null)[] | JSX.Element | null;
-    private readHistory;
-    private getTooltipInfo;
-    /**
-     * This function renders the value in different forms in the table
-     *
-     * @param id state ID
-     * @param item Item
-     * @param narrowStyleWithDetails if use mobile view
-     */
-    private renderColumnValue;
+    readHistory(id: string): void;
+    getTooltipInfo(id: string, cb?: () => void): void;
     private _syncEnum;
-    private syncEnum;
-    private renderEnumDialog;
-    private renderEditRoleDialog;
-    private onColumnsEditCustomDialogClose;
-    private renderColumnsEditCustomDialog;
+    syncEnum(id: string, enumName: 'func' | 'room', newArray: string[]): Promise<void>;
+    onColumnsEditCustomDialogClose(isSave?: boolean): void;
     /**
      * Renders a custom value.
      */
     renderCustomValue(obj: ioBroker.Object, it: AdapterColumn, item: TreeItem): JSX.Element | null;
     renderAliasLink(id: string, index?: number, customStyle?: Record<string, any>): JSX.Element | null;
     /**
-     * Renders a leaf.
+     * Renders one row of the table.
      */
     renderLeaf(item: TreeItem, isExpanded: boolean | undefined, counter: {
         count: number;
@@ -226,7 +280,25 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     renderItem(root: TreeItem, isExpanded: boolean | undefined, counter?: {
         count: number;
     }): (JSX.Element | null)[];
-    private calculateColumnsVisibility;
+    calculateColumnsVisibility(aColumnsAuto?: boolean | null, aColumns?: string[] | null, aColumnsForAdmin?: Record<string, CustomAdminColumnStored[]> | null, aColumnsWidths?: Record<string, number>): void;
+    /**
+     * The width class of the object browser. It is measured from the container and not from the
+     * window, so the browser shows the right columns if it is used in a narrow panel or dialog too.
+     * `props.width` overwrites the measured value.
+     */
+    get width(): Width;
+    /** Watch the width of the table container to detect the width class (see `width`) */
+    observeContainerWidth(): void;
+    /** Store the width class of the container if it changed */
+    setContainerWidth(containerWidth: number): void;
+    /**
+     * All column widths as CSS variables of the table container. The header and every row read the
+     * widths from here (see `colWidth`), so they can never get out of sync, and the resizer can
+     * change a width by writing one variable instead of re-rendering all rows.
+     */
+    getColumnWidthVariables(): React.CSSProperties;
+    /** Set the width of one column without re-rendering the rows */
+    setColumnWidth(name: string, width: number): void;
     resizerMouseMove: (e: MouseEvent) => void;
     resizerMouseUp: () => void;
     resizerMouseDown: (e: React.MouseEvent<HTMLDivElement>) => void;
@@ -246,8 +318,6 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
      * Render the right handle for resizing
      */
     renderHandleRight(): JSX.Element;
-    private renderHeader;
-    private renderToast;
     /** Derive the current navigation target from the dialog/selection state. */
     private getStateNav;
     private static navEqual;
@@ -262,23 +332,18 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
      */
     componentDidUpdate(prevProps: ObjectBrowserProps): void;
     scrollToItem(id: string): void;
-    private renderCustomDialog;
-    private onUpdate;
-    private renderEditObjectDialog;
-    private renderViewObjectFileDialog;
-    private renderAliasEditorDialog;
+    onUpdate(valAck: {
+        val: ioBroker.StateValue;
+        ack: boolean;
+        q: ioBroker.STATE_QUALITY[keyof ioBroker.STATE_QUALITY];
+        expire: number | undefined;
+    }): void;
     showAddDataPointDialog(id: string, initialType: ioBroker.ObjectType, initialStateType?: ioBroker.CommonType): void;
     /** Renders the aliases list for one state (if more than 2) */
-    private renderAliasMenu;
-    /**
-     * Renders the right mouse button context menu
-     */
-    private renderContextMenu;
-    private renderEditValueDialog;
     doFilter(doNotStore?: boolean): void;
     /**
      * The rendering method of this component.
      */
     render(): JSX.Element;
 }
-export declare const ObjectBrowser: (props: Record<string, any>) => JSX.Element;
+export declare const ObjectBrowser: typeof ObjectBrowserClass;