@tenorlab/react-dashboard 1.3.2 → 1.3.5

package/dist/{index.d.ts → react-dashboard.d.ts}

@@ -1,23 +1,11 @@
 import { CSSProperties } from 'react';
 import { default as default_2 } from 'react';
 import { ForwardRefExoticComponent } from 'react';
-import { IChildWidgetConfigEntry } from './interfaces/';
-import { IDashboardConfig } from './interfaces/';
-import { IDashboardGridPropsBase } from './interfaces/';
-import { IDashboardSettingEntry } from './interfaces/';
-import { IDashboardWidgetPropsBase } from './interfaces/';
-import { IDynamicWidgetCatalogEntryBase } from './interfaces/';
 import { JSX } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { ReactNode } from 'react';
 import { RefAttributes } from 'react';
 import { StoreApi } from 'zustand';
-import { TDashboardUndoStatus } from './interfaces/';
-import { TDashboardWidgetCatalogBase } from './interfaces/';
-import { TDashboardWidgetKey } from './interfaces/';
-import { TUndoHistoryEntry } from './interfaces/';
-import { TWidgetFactoryBase } from './interfaces/';
-import { TWidgetMetaInfoBase } from './interfaces/';
 import { UseBoundStore } from 'zustand';
 
 export declare function AddIcon({ className }: TIconProps): JSX_2.Element;
@@ -90,10 +78,47 @@ export declare interface IButtonProps {
     tooltip?: ITooltipProps;
 }
 
+declare interface IChildWidgetConfigEntry {
+    parentWidgetKey: TDashboardWidgetKey;
+    widgetKey: TDashboardWidgetKey;
+}
+
+declare interface IDashboardConfig {
+    userID: number | string;
+    clientAppKey: string;
+    dashboardId: string;
+    dashboardName: string;
+    zoomScale: number;
+    responsiveGrid: boolean;
+    widgets: TDashboardWidgetKey[];
+    childWidgetsConfig: IChildWidgetConfigEntry[];
+    cssSettings: IDashboardSettingEntry[];
+    _version?: number;
+    _stateDescription?: string;
+}
+
 export declare interface IDashboardGridProps extends IDashboardGridPropsBase {
     children?: ReactNode;
 }
 
+declare interface IDashboardGridPropsBase {
+    isEditing: boolean;
+    zoomScale: number;
+    responsiveGrid: boolean;
+}
+
+declare interface IDashboardSettingEntry {
+    key: string;
+    name: string;
+    description: string;
+    cssProperty: string;
+    step: number;
+    defaultUnit: string;
+    minValue: number;
+    defaultValue: string;
+    value: string;
+}
+
 export declare interface IDashboardWidget extends JSX.Element {
 }
 
@@ -104,9 +129,46 @@ export declare interface IDashboardWidgetProps<TExtraProps = any> extends IDashb
     selectContainer?: (containerKey?: TDashboardWidgetKey) => void;
 }
 
+declare interface IDashboardWidgetPropsBase<TExtraProps = any> {
+    index: number;
+    maxIndex: number;
+    widgetKey: TDashboardWidgetKey;
+    parentWidgetKey?: TDashboardWidgetKey;
+    isEditing: boolean;
+    highlight?: boolean;
+    testId?: string;
+    title?: string;
+    size?: TWidgetSize;
+    borderCssClasses?: string;
+    backgroundCssClasses?: string;
+    hideTitle?: boolean;
+    noShadow?: boolean;
+    noBorder?: boolean;
+    noPadding?: boolean;
+    direction?: TWidgetDirection;
+    extraProps?: TExtraProps;
+}
+
 export declare interface IDynamicWidgetCatalogEntry extends IDynamicWidgetCatalogEntryBase<TFrameworkElementType, TFrameworkComponentType> {
 }
 
+/**
+ * 2. Define the flexible Catalog Entry
+ * Definition of a single widget or container in the catalog.
+ * It must have EITHER a direct 'component' reference OR a 'loader' function.
+ *
+ * TFrameworkElementType: see TWidgetMetaInfoBase
+ * TFrameworkComponentType: i.e. React.ComponentType<any> (see TWidgetFactoryBase)
+ */
+declare interface IDynamicWidgetCatalogEntryBase<TFrameworkElementType = any, TFrameworkComponentType = any> {
+    key: TDashboardWidgetKey;
+    title: string;
+    isContainer?: boolean;
+    meta?: TWidgetMetaInfoBase<TFrameworkElementType>;
+    component?: TFrameworkComponentType;
+    loader?: TWidgetFactoryBase<TFrameworkComponentType>;
+}
+
 /**
  * Compares two version strings (e.g., "19.2.0" and "19.2.3")
  * Returns true if the widget version is compatible with the host.
@@ -206,8 +268,19 @@ declare type TDashboardSlice = {
 
 export declare type TDashboardUndoService = ReturnType<typeof useDashboardUndoService>;
 
+declare type TDashboardUndoStatus = {
+    isUndoDisabled: boolean;
+    isRedoDisabled: boolean;
+    _currentIndex?: number;
+    _historyLength?: number;
+};
+
 export declare type TDashboardWidgetCatalog = TDashboardWidgetCatalogBase<TFrameworkElementType, TFrameworkComponentType>;
 
+declare type TDashboardWidgetCatalogBase<TFrameworkElementType = any, TFrameworkComponentType = any> = Map<TDashboardWidgetKey, IDynamicWidgetCatalogEntryBase<TFrameworkElementType, TFrameworkComponentType>>;
+
+declare type TDashboardWidgetKey = string;
+
 declare type TDynamicWidgetLoaderProps<TExtraProps = any> = {
     index: number;
     maxIndex: number;
@@ -261,10 +334,40 @@ export declare type TStackProps = {
     children: React.ReactNode;
 };
 
+declare type TUndoHistoryEntry = {
+    undoIndex: number;
+    config: IDashboardConfig;
+};
+
+declare type TWidgetCategory = 'Widget' | 'Chart' | 'Container';
+
+declare type TWidgetDirection = 'row' | 'column';
+
 export declare type TWidgetFactory = TWidgetFactoryBase<TFrameworkComponentType>;
 
+/**
+ * 1. Define the Async Loader type
+ * Type for the function that performs the asynchronous dynamic import.
+ * It must return a promise that resolves to the module containing the widget component
+ * as its default export (or a named export if you change the loading strategy).
+ *
+ * TFrameworkComponent could be "React.ComponentType<any>"" or "VueComponent" etc
+ */
+declare type TWidgetFactoryBase<TFrameworkComponent = any> = () => Promise<{
+    default: TFrameworkComponent;
+}>;
+
 export declare type TWidgetMetaInfo = TWidgetMetaInfoBase<TFrameworkElementType | undefined>;
 
+declare type TWidgetMetaInfoBase<TFrameworkElementType = any> = {
+    name: string;
+    description: string;
+    categories: TWidgetCategory[];
+    noDuplicatedWidgets?: boolean;
+    icon: TFrameworkElementType | undefined;
+    externalDependencies: string[];
+};
+
 export declare type TWidgetsCatalogFlyoutProps = {
     targetContainerKey?: TDashboardWidgetKey;
     widgetsCatalog: TDashboardWidgetCatalog;
@@ -278,6 +381,8 @@ export declare type TWidgetsCatalogFlyoutProps = {
     onDoneClick: () => any;
 };
 
+declare type TWidgetSize = 'default' | 'large' | 'xlarge';
+
 export declare function UndoIcon({ className }: TIconProps): JSX_2.Element;
 
 export declare const useDashboardStore: UseBoundStore<StoreApi<TDashboardSlice>>;
@@ -312,10 +417,4 @@ export declare function ZoomInIcon({ className }: TIconProps): JSX_2.Element;
 
 export declare function ZoomOutIcon({ className }: TIconProps): JSX_2.Element;
 
-
-export * from "./dashboard-settings";
-export * from "./interfaces/";
-export * from "./storage-service";
-export * from "./utils";
-
 export { }