@tenorlab/react-dashboard 1.3.8 → 1.4.1

package/dist/react-dashboard.d.ts

@@ -10,75 +10,18 @@ import { UseBoundStore } from 'zustand';
 
 export declare function AddIcon({ className }: TIconProps): JSX_2.Element;
 
-export declare const blankDashboardConfig: IDashboardConfig;
-
 export declare function Button(props: IButtonProps): JSX_2.Element;
 
 export declare function CircleQuestionMark({ className }: TIconProps): JSX_2.Element;
 
-/**
- * @name createDynamicEntry
- * Helper function to create dynamic entries
- * This helps keep the catalog registration clean
- */
-export declare const createDynamicEntry: (key: string, loader: TWidgetFactoryBase, metaData: TWidgetMetaInfoBase) => [string, IDynamicWidgetCatalogEntryBase];
-
-/**
- * @name createStaticEntry
- * Helper function to create static entries
- * This helps keep the catalog registration clean
- */
-export declare const createStaticEntry: <TFrameworkComponentType = any>(key: string, component: TFrameworkComponentType, metaData?: TWidgetMetaInfoBase) => [string, IDynamicWidgetCatalogEntryBase];
-
 export declare function CrosshairIcon({ className }: TIconProps): JSX_2.Element;
 
-export declare const cssSettingsCatalog: IDashboardSettingEntry[];
-
-/**
- * @name cssVarsUtils
- * @description Provides helpers method like getCssVariableValue, setCssVariableValue etc
- */
-export declare const cssVarsUtils: {
-    /**
-     * @name getCssVariableValue
-     * @description Return the value of a CSS custom property from the current HTML document
-     * @param cssPropertyName
-     * @returns
-     */
-    getCssVariableValue: (cssPropertyName: string) => string | null;
-    /**
-     * @name setCssVariableValue
-     * @description Sets the value of a CSS custom property on the current HTML document
-     * @param cssPropertyName
-     * @param value
-     */
-    setCssVariableValue: (cssPropertyName: string, value: string) => void;
-    /**
-     * @name restoreCssVarsFromSettings
-     * @description
-     * Sets the values of many CSS custom properties on the current HTML document
-     * from the list of dashboard settings provided
-     * @param settings, an array of IDashboardSettingEntry
-     */
-    restoreCssVarsFromSettings: (settings: IDashboardSettingEntry[]) => void;
-};
-
 export declare const DashboardGrid: ForwardRefExoticComponent<IDashboardGridProps & RefAttributes<HTMLDivElement>>;
 
-export declare const DashboardMaxZoomScale: 1;
-
-export declare const DashboardMinZoomScale: 0.7;
-
-export declare const dashboardSettingsUtils: {
-    incrementOrDecrementValue: (item: IDashboardSettingEntry, direction: -1 | 1) => IDashboardSettingEntry;
-};
-
 export declare const DashboardWidgetBase: (props: IDashboardWidgetProps & {
     ref?: React.ForwardedRef<HTMLDivElement>;
 }) => React.ReactElement | null;
 
-export declare const DashboardZoomStep: 0.05;
-
 export declare function DeleteIcon({ className }: TIconProps): JSX_2.Element;
 
 export declare const DraggablePanel: ForwardRefExoticComponent<DraggablePanelProps & RefAttributes<HTMLDivElement>>;
@@ -102,45 +45,6 @@ export declare function DynamicWidgetLoader({ index, maxIndex, widgetKey, parent
 
 export declare function EditIcon({ className }: TIconProps): JSX_2.Element;
 
-/**
- * @name ensureContainersSequence
- * @description
- * Ensures that the container widgets are numbered sequentially in the dashboardConfig, but the original order is preserved.
- */
-export declare const ensureContainersSequence: (dashboardConfig: IDashboardConfig) => IDashboardConfig;
-
-export declare const ensureZoomScaleIsWithinRange: (value: number) => number;
-
-export declare const getDefaultWidgetMetaFromKey: TGetDefaultWidgetMetaFromKey;
-
-/**
- * @name getDefaultWidgetMetaFromMap
- * @description Helper to get widget meta info from the catalog by key.
- */
-export declare const getDefaultWidgetMetaFromMap: <TFrameworkElementType = any>(widgetKey: TDashboardWidgetKey, defaultWidgetMetaMap: Record<TDashboardWidgetKey, TWidgetMetaInfoBase<TFrameworkElementType>>, options?: {
-    title?: string;
-    description?: string;
-}) => TWidgetMetaInfoBase<TFrameworkElementType>;
-
-/**
- * @name getDistinctCssClasses
- * @description Ensures a distinct list off css classes, avoiding duplicates
- * @param defaultClasses
- * @param additionalClasses
- * @returns the distinct list as a string
- */
-export declare const getDistinctCssClasses: (defaultClasses: string, ...additionalClasses: string[]) => string;
-
-export declare const getMetaInfoFromFile: (widgetMetaModules: Record<string, Record<string, TWidgetMetaInfoBase>>, baseSrcPath: string, folder: string, key: string) => TWidgetMetaInfoBase | undefined;
-
-export declare const getNewZoomScaleWithinRange: (currentZoomScale: number, direction: -1 | 1) => number;
-
-/**
- * @name getWidgetMetaFromCatalog
- * @description Helper to get widget meta info from the catalog by key.
- */
-export declare const getWidgetMetaFromCatalog: <TFrameworkElementType = any, TFrameworkComponentType = any>(widgetKey: TDashboardWidgetKey, widgetsCatalog: TDashboardWidgetCatalogBase<TFrameworkElementType, TFrameworkComponentType>) => TWidgetMetaInfoBase<TFrameworkElementType>;
-
 export declare function GridIcon({ className }: TIconProps): JSX_2.Element;
 
 export declare function HandGrabIcon({ className }: TIconProps): JSX_2.Element;
@@ -307,14 +211,6 @@ export declare const ListItemMiddleChild: ForwardRefExoticComponent<TListItemChi
 
 export declare const ListItemRightChild: ForwardRefExoticComponent<TListItemChildProps & RefAttributes<HTMLDivElement>>;
 
-/**
- * @name localWidgetDiscovery
- * @description Scans local directories for widgets.
- * If lazy is true, it registers loaders. If false, it registers static components.
- */
-export declare const localWidgetDiscovery: (baseSrcPath: string, // e.g., "/src/async-widgets" or "/src/bundled-widgets"
-widgetModules: Record<string, any>, widgetMetaModules: Record<string, any>, lazy?: boolean) => [string, IDynamicWidgetCatalogEntryBase][];
-
 export declare function MonitorIcon({ className }: TIconProps): JSX_2.Element;
 
 export declare function MonitorSmartphoneIcon({ className }: TIconProps): JSX_2.Element;
@@ -323,40 +219,8 @@ export declare function MoveLeftIcon({ className }: TIconProps): JSX_2.Element;
 
 export declare function MoveRightIcon({ className }: TIconProps): JSX_2.Element;
 
-export declare const parseContainerTitle: (containerWidgetKey: TDashboardWidgetKey) => string;
-
-/**
- * Enhanced helper to derive key and title from widget file paths.
- * Handles:
- * - widget-revenue-trends1 -> WidgetRevenueTrends1
- * - widget-with-extraprops -> WidgetWithExtraprops
- * - widget-revenue-trends-async -> WidgetRevenueTrendsAsync
- */
-export declare const parseKeyAndTitleFromFilePath: (path: string) => {
-    key: TDashboardWidgetKey;
-    title: string;
-    folder: string;
-} | null;
-
 export declare function RedoIcon({ className }: TIconProps): JSX_2.Element;
 
-export declare const remoteWidgetDiscovery: (manifestUrl: string) => Promise<{
-    entries: [string, IDynamicWidgetCatalogEntryBase][];
-    message: string;
-    details: string;
-}>;
-
-export declare const removeEmptyContainers: (dashboardConfig: IDashboardConfig) => IDashboardConfig;
-
-/**
- * @name resolveColorFromClass
- * @description Resolves the current computed color using your existing CSS classes
- * @param classNames, i.e. 'bg-primary'
- * @param property to resolve, i.e. 'backgroundColor'
- * @returns
- */
-export declare const resolveColorFromClass: (classNames: string | string[], property?: "color" | "backgroundColor") => string;
-
 export declare function SettingsIcon({ className }: TIconProps): JSX_2.Element;
 
 export declare const showToast: (options: any) => void;
@@ -446,14 +310,7 @@ declare type TFrameworkComponentType = React.ComponentType<any>;
 
 declare type TFrameworkElementType = React.ElementType;
 
-export declare type TGetDefaultWidgetMetaFromKey = (widgetKey: TDashboardWidgetKey, options?: TGetDefaultWidgetMetaFromKeyOptions) => TWidgetMetaInfoBase<any>;
-
-export declare type TGetDefaultWidgetMetaFromKeyOptions = {
-    title?: string;
-    description?: string;
-};
-
-export declare type TGetSavedDashboards = (userID: number | string, clientAppKey: string, widgetCatalog: TDashboardWidgetCatalogBase, defaultDashboardConfig: IDashboardConfig) => Promise<IDashboardConfig[]>;
+declare type TGetSavedDashboards = (userID: number | string, clientAppKey: string, widgetCatalog: TDashboardWidgetCatalogBase, defaultDashboardConfig: IDashboardConfig) => Promise<IDashboardConfig[]>;
 
 declare type TIconProps = {
     className?: string;
@@ -479,7 +336,7 @@ declare type TProps = {
 
 declare type TRemoveWidgetResponse = TAddWidgetResponse;
 
-export declare type TSaveDashboards = (userID: number | string, clientAppKey: string, dashboardConfigs: IDashboardConfig[], widgetCatalog: TDashboardWidgetCatalogBase) => Promise<boolean>;
+declare type TSaveDashboards = (userID: number | string, clientAppKey: string, dashboardConfigs: IDashboardConfig[], widgetCatalog: TDashboardWidgetCatalogBase) => Promise<boolean>;
 
 declare type TSize = 'small' | 'medium';
 
@@ -542,8 +399,6 @@ export declare type TWidgetSize = 'default' | 'large' | 'xlarge';
 
 export declare function UndoIcon({ className }: TIconProps): JSX_2.Element;
 
-export declare const useDashboardStorageService: () => IDashboardStorageService;
-
 export declare const useDashboardStore: UseBoundStore<StoreApi<TDashboardSlice>>;
 
 export declare const useDashboardUndoService: () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tenorlab/react-dashboard",
-  "version": "1.3.8",
+  "version": "1.4.1",
   "description": "Foundation components for creating user-configurable dashboards in React",
   "author": "Damiano Fusco",
   "type": "module",
@@ -50,7 +50,8 @@
   "module": "./dist/react-dashboard.es.js",
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
-    "react-dom": "^18.0.0 || ^19.0.0"
+    "react-dom": "^18.0.0 || ^19.0.0",
+    "zustand": "^5.0.0 || ^5.0.9"
   },
   "devDependencies": {
     "@tenorlab/dashboard-core": "^1.0.1",