react-semaphor 0.0.73 → 0.0.75

package/dist/react-semaphor.d.ts

@@ -11,10 +11,13 @@ import { FontSpec } from 'chart.js';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { Layout } from 'react-grid-layout';
 import { Point } from 'chart.js';
+import { default as React_2 } from 'react';
 import { StoreApi } from 'zustand';
 import { UseBoundStore } from 'zustand';
 
 declare type Actions = {
+    addFilteringCard: (card: TCard) => void;
+    removeFilteringCard: (card: TCard) => void;
     setCustomCards: (customCards: CustomCard[]) => void;
     setAuthToken: (authToken: AuthToken) => void;
     setThemeStyle: (themeStyle: StyleProps) => void;
@@ -50,6 +53,7 @@ declare type Actions = {
     setFilterValues: (filterValues: TFilterValue[] | undefined) => void;
     addOrUpdateFilterValue: (filterValue: TFilterValue) => void;
     removeFilterValue: (filterId: string) => void;
+    replaceFilterValue: (filterValue: TFilterValue) => void;
     setStyle: (style: TStyle) => void;
     getStyle: () => TStyle | undefined;
     setOnSaveFunction: (onSaveFunction: (dashboard: TDashboard) => void) => void;
@@ -63,6 +67,7 @@ declare type Actions = {
     getCard: (cardId: string) => TCard | undefined;
     getSelectedCard: () => TCard | undefined;
     getSelectedSheetLayout: () => ReactGridLayout.Layout[] | undefined;
+    handleDataPointClickAction: (card: TCard, dataPoint: any) => void;
 };
 
 declare type Actions_2 = {
@@ -105,6 +110,11 @@ export declare type AuthToken = {
     refreshToken: string;
 };
 
+declare type BaseCustomCard = {
+    cardId: string;
+    replaceDefault?: boolean;
+};
+
 declare type BaseFilter = {
     filterId: TFilter['id'];
     expression?: string;
@@ -120,17 +130,39 @@ export declare type Bookmark = {
     filterValues?: TFilterValue[];
 };
 
-export declare function cleanCard(card: TCard): TCard;
+declare type CardWithContent = BaseCustomCard & {
+    content: React.FC<{
+        card: TCard;
+    }>;
+    footer?: React.FC<{
+        card: TCard;
+    }>;
+};
 
-export declare type CustomCard = {
-    cardId: string;
-    component: React.FC<{
+declare type CardWithFooter = BaseCustomCard & {
+    content?: React.FC<{
+        card: TCard;
+    }>;
+    footer: React.FC<{
         card: TCard;
     }>;
 };
 
+export declare function cleanCard(card: TCard): TCard;
+
+export declare type CustomCard = CardWithContent | CardWithFooter;
+
 export declare function Dashboard(props: DashboardProps): JSX_2.Element;
 
+export declare function DashboardCard({ card, footer, className, ...props }: DashboardCardProps): JSX_2.Element | null;
+
+declare type DashboardCardProps = {
+    card: TCard;
+    footer?: React_2.ReactNode;
+    showControls?: boolean;
+    fetchCardData?: boolean;
+} & React_2.HTMLAttributes<HTMLDivElement>;
+
 export declare function DashboardPlus({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element;
 
 declare type DashboardPlusProps = {
@@ -145,6 +177,7 @@ export declare type DashboardProps = {
     currentTheme?: 'light' | 'dark' | 'system';
     version?: string;
     customCards?: CustomCard[];
+    onChartElementClicked?: (card: TCard, fieldValues: any) => void;
     onEvent?: (event: TEvent) => void;
     onSave?: (dashboard: TDashboard) => void;
     LoadingComponent?: (props: LoadingProps) => React.ReactNode;
@@ -155,10 +188,11 @@ export declare function DashboardProvider({ children }: {
     children: React.ReactNode;
 }): JSX_2.Element;
 
-declare type DashboardStore = {
+export declare type DashboardStore = {
     authToken?: AuthToken;
     theme?: 'light' | 'dark' | 'system';
     themeStyle?: StyleProps;
+    filteringCards?: TCard[];
     bookmarkKey?: string;
     dashboard: TDashboard;
     selectedSheetId?: string | null | undefined;
@@ -399,6 +433,7 @@ export declare function useActions(): {
 
 export declare function useCard(cardId: string): {
     data: any;
+    card: TCard;
     isError: boolean;
     isLoading: boolean;
     isFetching: boolean;
@@ -407,7 +442,7 @@ export declare function useCard(cardId: string): {
     cfg: TChartConfiguration | undefined;
 };
 
-export declare function useDashboard({ id, version, authToken, customStyle, currentTheme, onSave, onEvent, customCards, }: UseDashboardProps): {
+export declare function useDashboard({ id, version, authToken, customStyle, currentTheme, onSave, onEvent, }: UseDashboardProps): {
     isLoading: boolean;
     isError: boolean;
 };
@@ -453,6 +488,33 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                 options?: any;
             } | undefined;
         } | undefined;
+        filteringCards?: {
+            id: string;
+            title: string;
+            description?: string | undefined;
+            connectionId?: string | undefined;
+            type: TChartType;
+            sql?: string | undefined;
+            data?: any[] | undefined;
+            cfg?: any;
+            childCards?: any[] | undefined;
+            customCfg?: any;
+            preferences?: {
+                filterOnClick?: boolean | undefined;
+                filterOnClickField?: string | undefined;
+                formatNumber?: {
+                    format?: string | undefined;
+                    currency?: string | undefined;
+                    locale?: string | undefined;
+                    suffix?: string | undefined;
+                    enabled?: string | boolean | undefined;
+                } | undefined;
+            } | undefined;
+            lastSelectedDatabase?: string | undefined;
+            lastSelectedSchema?: string | undefined;
+            lastSelectedTable?: string | undefined;
+            refreshInterval?: string | undefined;
+        }[] | undefined;
         bookmarkKey?: string | undefined;
         dashboard: {
             id: string;
@@ -476,7 +538,7 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                     static?: boolean | undefined;
                     isDraggable?: boolean | undefined;
                     isResizable?: boolean | undefined;
-                    resizeHandles?: ("w" | "s" | "e" | "n" | "sw" | "nw" | "se" | "ne")[] | undefined;
+                    resizeHandles?: ("s" | "w" | "e" | "n" | "sw" | "nw" | "se" | "ne")[] | undefined;
                     isBounded?: boolean | undefined;
                 }[] | undefined;
                 cards?: {
@@ -561,12 +623,25 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                 database: string;
                 sql: string;
             }[] | undefined;
-            customCards?: {
+            customCards?: ({
                 cardId: string;
-                component: FC<{
+                replaceDefault?: boolean | undefined;
+                content: FC<{
                     card: TCard;
                 }>;
-            }[] | undefined;
+                footer?: FC<{
+                    card: TCard;
+                }> | undefined;
+            } | {
+                cardId: string;
+                replaceDefault?: boolean | undefined;
+                content?: FC<{
+                    card: TCard;
+                }> | undefined;
+                footer: FC<{
+                    card: TCard;
+                }>;
+            })[] | undefined;
         };
         selectedSheetId?: string | null | undefined;
         selectedCardId?: string | null | undefined;
@@ -658,6 +733,8 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
         onUpdateCard?: ((card: TCard, sheetId: string) => void) | undefined;
         onRemoveCard?: ((card: TCard, sheetId: string) => void) | undefined;
         actions: {
+            addFilteringCard: (card: TCard) => void;
+            removeFilteringCard: (card: TCard) => void;
             setCustomCards: (customCards: CustomCard[]) => void;
             setAuthToken: (authToken: AuthToken) => void;
             setThemeStyle: (themeStyle: StyleProps) => void;
@@ -693,6 +770,7 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             setFilterValues: (filterValues: TFilterValue[] | undefined) => void;
             addOrUpdateFilterValue: (filterValue: TFilterValue) => void;
             removeFilterValue: (filterId: string) => void;
+            replaceFilterValue: (filterValue: TFilterValue) => void;
             setStyle: (style: TStyle) => void;
             getStyle: () => TStyle | undefined;
             setOnSaveFunction: (onSaveFunction: (dashboard: TDashboard) => void) => void;
@@ -706,6 +784,7 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             getCard: (cardId: string) => TCard | undefined;
             getSelectedCard: () => TCard | undefined;
             getSelectedSheetLayout: () => ReactGridLayout.Layout[] | undefined;
+            handleDataPointClickAction: (card: TCard, dataPoint: any) => void;
         };
     }) => void), shouldReplace?: boolean | undefined): void;
 }>;