@iobroker/adapter-react-v5 7.0.1 → 7.1.0

package/Components/ObjectBrowser.d.ts

@@ -3,15 +3,15 @@
  *
  * MIT License
  *
- * */
-import React, { Component } from 'react';
+ */
+import React, { Component, type JSX } from 'react';
 import type Router from './Router';
 import type { ThemeType, ThemeName, IobTheme, Translate } from '../types';
 import Connection from '../Connection';
 declare global {
     interface Window {
         sparkline: {
-            sparkline: (el: HTMLDivElement, data: number[]) => React.JSX.Element;
+            sparkline: (el: HTMLDivElement, data: number[]) => JSX.Element;
         };
     }
 }
@@ -51,7 +51,7 @@ export interface TreeItemData {
     /** Link to parent item */
     parent?: TreeItem;
     level?: number;
-    icon?: string | React.JSX.Element | null;
+    icon?: string | JSX.Element | null;
     /** If the item existing object or generated folder */
     generated?: boolean;
     title?: string;
@@ -79,10 +79,10 @@ export interface TreeItemData {
     per?: boolean;
     lang?: ioBroker.Languages;
     state?: {
-        valTextRx?: React.JSX.Element[] | null;
+        valTextRx?: JSX.Element[] | null;
         style?: React.CSSProperties;
     };
-    aclTooltip?: null | React.JSX.Element;
+    aclTooltip?: null | JSX.Element;
 }
 interface ObjectBrowserCustomFilter {
     type?: ioBroker.ObjectType | ioBroker.ObjectType[];
@@ -97,8 +97,8 @@ export interface TreeItem {
     data: TreeItemData;
     children?: TreeItem[];
 }
-export declare function getSelectIdIconFromObjects(objects: Record<string, ioBroker.Object>, id: string, imagePrefix?: string): string | React.JSX.Element | null;
-export declare const ITEM_IMAGES: Record<string, React.JSX.Element>;
+export declare function getSelectIdIconFromObjects(objects: Record<string, ioBroker.Object>, id: string, lang: ioBroker.Languages, imagePrefix?: string): string | JSX.Element | null;
+export declare const ITEM_IMAGES: Record<string, JSX.Element>;
 export interface ObjectBrowserFilter {
     id?: string;
     name?: string;
@@ -137,7 +137,7 @@ interface DragWrapperProps {
     item: TreeItem;
     className?: string;
     style?: React.CSSProperties;
-    children: React.JSX.Element | null;
+    children: JSX.Element | null;
 }
 interface ObjectCustomDialogProps {
     t: Translate;
@@ -183,7 +183,7 @@ interface ObjectBrowserValueProps {
     isFloatComma: boolean;
     t: Translate;
     lang: ioBroker.Languages;
-    width: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    width?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
 }
 interface ObjectBrowserEditObjectProps {
     socket: Connection;
@@ -200,7 +200,7 @@ interface ObjectBrowserEditObjectProps {
     isFloatComma: boolean;
     onNewObject: (obj: ioBroker.AnyObject) => void;
     t: Translate;
-    width: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+    width?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
 }
 interface ObjectAliasEditorProps {
     t: Translate;
@@ -242,11 +242,12 @@ interface ObjectBrowserProps {
     objectImportExport?: boolean;
     objectEditOfAccessControl?: boolean;
     /** modal add object */
-    modalNewObject?: (oBrowser: ObjectBrowserClass) => React.JSX.Element;
+    modalNewObject?: (oBrowser: ObjectBrowserClass) => JSX.Element;
     /** modal Edit Of Access Control */
-    modalEditOfAccessControl: (oBrowser: ObjectBrowserClass, data: TreeItemData) => React.JSX.Element;
+    modalEditOfAccessControl: (oBrowser: ObjectBrowserClass, data: TreeItemData) => JSX.Element;
     onObjectDelete?: (id: string, hasChildren: boolean, objectExists: boolean, childrenCount: number) => void;
-    /** optional filter
+    /**
+     * Optional filter
      *   `{common: {custom: true}}` - show only objects with some custom settings
      *   `{common: {custom: 'sql.0'}}` - show only objects with sql.0 custom settings (only of the specific instance)
      *   `{common: {custom: '_dataSources'}}` - show only objects of adapters `influxdb' or 'sql' or 'history'
@@ -275,9 +276,10 @@ interface ObjectBrowserProps {
     root?: string;
     /** cache of objects */
     objectsWorker?: ObjectsWorker;
-    /** function to filter out all unnecessary objects. It cannot be used together with "types"
+    /**
+     * function to filter out all unnecessary objects. It cannot be used together with "types"
      * Example for function: `obj => obj.common?.type === 'boolean'` to show only boolean states
-     * */
+     */
     filterFunc?: (obj: ioBroker.Object) => boolean;
     /** Used for enums dragging */
     DragWrapper?: React.FC<DragWrapperProps>;
@@ -331,6 +333,10 @@ interface ObjectBrowserState {
     showDescription: boolean;
     showContextMenu: {
         item: TreeItem;
+        position: {
+            left: number;
+            top: number;
+        };
         subItem?: string;
         subAnchor?: HTMLLIElement;
     } | null;
@@ -344,14 +350,16 @@ interface ObjectBrowserState {
         initialType?: ioBroker.ObjectType;
         initialStateType?: ioBroker.CommonType;
     };
-    error?: undefined | any;
+    error?: any;
     modalEditOfAccess?: boolean;
     modalEditOfAccessObjData?: TreeItemData;
     updateOpened?: boolean;
     tooltipInfo: null | {
-        el: React.JSX.Element[];
+        el: JSX.Element[];
         id: string;
     };
+    /** Show the menu with aliases for state */
+    aliasMenu: string;
 }
 export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, ObjectBrowserState> {
     #private;
@@ -441,7 +449,7 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     /**
      * Renders the error dialog.
      */
-    renderErrorDialog(): React.JSX.Element | null;
+    renderErrorDialog(): JSX.Element | null;
     /**
      * Show the error dialog.
      */
@@ -454,7 +462,7 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     /**
      * Renders the columns' selector.
      */
-    renderColumnsSelectorDialog(): React.JSX.Element | null;
+    renderColumnsSelectorDialog(): JSX.Element | null;
     private getAdditionalColumns;
     private checkUnsubscribes;
     /**
@@ -469,15 +477,15 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     onObjectChangeFromWorker: (events: ObjectEvent[]) => void;
     onObjectChange: (id: string, obj?: ioBroker.Object | null) => void;
     afterObjectUpdated(): void;
+    updateAliases(aliasId: string): void;
     /**
      * Processes a single element in regard to certain filters, columns for admin and updates object dict
+     *
+     * @param id The id of the object
+     * @param obj The object itself
      * @returns Returns an object containing the new state (if any) and whether the object was filtered.
      */
-    processOnObjectChangeElement(
-    /** The id of the object */
-    id: string, 
-    /** The object itself */
-    obj?: ioBroker.Object | null): {
+    processOnObjectChangeElement(id: string, obj?: ioBroker.Object | null): {
         filtered: boolean;
         newInnerState: null | {
             columnsForAdmin: Record<string, CustomAdminColumnStored[]> | null;
@@ -506,22 +514,22 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     private getEnumsForId;
     private _createAllEnums;
     private loadObjects;
-    _getSelectedIdsForExport(): any[];
+    _getSelectedIdsForExport(): string[];
     /**
      * Exports the selected objects based on the given options and triggers file generation
      */
     private _exportObjects;
-    renderExportDialog(): React.JSX.Element;
+    renderExportDialog(): JSX.Element | null;
     private handleJsonUpload;
-    toolTipObjectCreating: () => string | React.JSX.Element[];
+    toolTipObjectCreating: () => JSX.Element[] | string;
     /**
      * Renders the toolbar.
      */
-    getToolbar(): React.JSX.Element;
+    getToolbar(): JSX.Element;
     private toggleExpanded;
     private onCopy;
-    renderTooltipAccessControl: (acl: ioBroker.StateACL) => null | React.JSX.Element;
-    renderColumnButtons(id: string, item: TreeItem): React.JSX.Element | React.JSX.Element[];
+    renderTooltipAccessControl: (acl: ioBroker.StateACL) => null | JSX.Element;
+    renderColumnButtons(id: string, item: TreeItem): (JSX.Element | null)[] | JSX.Element | null;
     private readHistory;
     private getTooltipInfo;
     private renderColumnValue;
@@ -536,22 +544,23 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     /**
      * Renders a custom value.
      */
-    renderCustomValue(obj: ioBroker.Object, it: AdapterColumn, item: TreeItem): React.JSX.Element | null;
+    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.
      */
     renderLeaf(item: TreeItem, isExpanded: boolean | undefined, counter: {
         count: number;
     }): {
-        row: React.JSX.Element;
-        details: React.JSX.Element | null;
+        row: JSX.Element;
+        details: JSX.Element | null;
     };
     /**
      * Renders an item.
      */
     renderItem(root: TreeItem, isExpanded: boolean | undefined, counter?: {
         count: number;
-    }): React.JSX.Element[];
+    }): JSX.Element[];
     private calculateColumnsVisibility;
     resizerMouseMove: (e: MouseEvent) => void;
     resizerMouseUp: () => void;
@@ -568,7 +577,7 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     /**
      * Render the right handle for resizing
      */
-    renderHandleRight(): React.JSX.Element;
+    renderHandleRight(): JSX.Element;
     private renderHeader;
     private renderToast;
     /**
@@ -582,6 +591,8 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     private renderViewObjectFileDialog;
     private renderAliasEditorDialog;
     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
      */
@@ -590,7 +601,7 @@ export declare class ObjectBrowserClass extends Component<ObjectBrowserProps, Ob
     /**
      * The rendering method of this component.
      */
-    render(): React.JSX.Element;
+    render(): JSX.Element;
 }
-declare const _default: (props: Record<string, any>) => React.JSX.Element;
+declare const _default: (props: Record<string, any>) => JSX.Element;
 export default _default;