semaphor 0.0.22 → 0.0.24

package/dist/react-semaphor.d.ts

@@ -1,12 +1,24 @@
+/// <reference types="react" />
 /// <reference types="react-grid-layout" />
 
+import { BubbleDataPoint } from 'chart.js';
+import { Chart as Chart_2 } from 'chart.js';
+import { ChartConfiguration } from 'chart.js';
+import { ChartTypeRegistry } from 'chart.js';
+import { Draft } from 'immer';
+import { FC } from 'react';
 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;
     setIsEditorSaveEvent: (isEditorSaveEvent: boolean) => void;
@@ -41,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;
@@ -51,12 +64,15 @@ declare type Actions = {
     getDashboard: () => TDashboard | undefined;
     getSelectedSheet: () => TSheet | undefined;
     getSelectedSheetCards: () => TCard[] | undefined;
+    getCard: (cardId: string) => TCard | undefined;
     getSelectedCard: () => TCard | undefined;
     getSelectedSheetLayout: () => ReactGridLayout.Layout[] | undefined;
+    handleDataPointClickAction: (card: TCard, dataPoint: any) => void;
 };
 
 declare type Actions_2 = {
     setCardRefreshInterval: (refreshInterval: string) => void;
+    setNumberFormat: (format: string, currency: string, locale: string, suffix: string) => void;
     setIsShowingVisual: (isShowingVisual: boolean) => void;
     setRunSql: (runSql: boolean) => void;
     setCardPreferences: (preferences: TCardPreferences) => void;
@@ -94,6 +110,11 @@ export declare type AuthToken = {
     refreshToken: string;
 };
 
+declare type BaseCustomCard = {
+    cardId: string;
+    replaceDefault?: boolean;
+};
+
 declare type BaseFilter = {
     filterId: TFilter['id'];
     expression?: string;
@@ -109,10 +130,39 @@ export declare type Bookmark = {
     filterValues?: TFilterValue[];
 };
 
+declare type CardWithContent = BaseCustomCard & {
+    content: React.FC<{
+        card: TCard;
+    }>;
+    footer?: React.FC<{
+        card: TCard;
+    }>;
+};
+
+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 = {
@@ -126,16 +176,23 @@ export declare type DashboardProps = {
     style?: TStyle;
     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;
     ErrorComponent?: (props: ErrorProps) => React.ReactNode;
 };
 
-declare type DashboardStore = {
+export declare function DashboardProvider({ children }: {
+    children: React.ReactNode;
+}): JSX_2.Element;
+
+export declare type DashboardStore = {
     authToken?: AuthToken;
     theme?: 'light' | 'dark' | 'system';
     themeStyle?: StyleProps;
+    filteringCards?: TCard[];
     bookmarkKey?: string;
     dashboard: TDashboard;
     selectedSheetId?: string | null | undefined;
@@ -230,6 +287,7 @@ export declare function getDashbaordStateWithoutData(dashboardState: TDashboard)
     description?: string | undefined;
     style?: TStyle | undefined;
     filters?: TFilter[] | undefined;
+    customCards?: CustomCard[] | undefined;
 };
 
 export declare type LoadingProps = {
@@ -281,6 +339,7 @@ export declare type TCard = {
     sql?: string;
     data?: any[];
     cfg?: any;
+    childCards?: any[];
     customCfg?: any;
     preferences?: TCardPreferences;
     lastSelectedDatabase?: string;
@@ -299,9 +358,18 @@ export declare type TCardContext = {
 export declare type TCardPreferences = {
     filterOnClick?: boolean;
     filterOnClickField?: string;
+    formatNumber?: {
+        format?: string;
+        currency?: string;
+        locale?: string;
+        suffix?: string;
+        enabled?: boolean | string;
+    };
 };
 
-declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'table';
+declare type TChartConfiguration = ChartConfiguration;
+
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'table' | 'kpi' | 'custom';
 
 export declare type TDashboard = {
     id: string;
@@ -310,6 +378,7 @@ export declare type TDashboard = {
     sheets?: TSheet[];
     style?: TStyle;
     filters?: TFilter[];
+    customCards?: CustomCard[];
 };
 
 declare type TDataColumn = {
@@ -362,6 +431,35 @@ export declare function useActions(): {
     setOnRemoveCard: (onRemoveCard: (card: TCard, sheetId: string) => void) => void;
 };
 
+export declare function useCard(cardId: string): {
+    data: any;
+    card: TCard;
+    isError: boolean;
+    isLoading: boolean;
+    isFetching: boolean;
+    visualKey: number;
+    handleDatapointClick: (chart: Chart_2<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint | null)[], unknown>, datasetIndex: number, clickIndex: number, value: number) => void;
+    cfg: TChartConfiguration | undefined;
+};
+
+export declare function useDashboard({ id, version, authToken, customStyle, currentTheme, onSave, onEvent, }: UseDashboardProps): {
+    isLoading: boolean;
+    isError: boolean;
+};
+
+export declare const useDashboardActions: () => Actions;
+
+declare type UseDashboardProps = {
+    id: string;
+    version?: string;
+    authToken: AuthToken | undefined;
+    customStyle?: TStyle;
+    currentTheme?: 'light' | 'dark' | 'system';
+    onSave?: (dashboard: TDashboard) => void;
+    onEvent?: (event: TEvent) => void;
+    customCards?: CustomCard[];
+};
+
 export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardStore>, "setState"> & {
     setState(nextStateOrUpdater: DashboardStore | Partial<DashboardStore> | ((state: {
         authToken?: {
@@ -390,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;
@@ -413,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?: {
@@ -425,10 +550,18 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                     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;
@@ -490,6 +623,25 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                 database: string;
                 sql: string;
             }[] | undefined;
+            customCards?: ({
+                cardId: string;
+                replaceDefault?: boolean | undefined;
+                content: FC<{
+                    card: TCard;
+                }>;
+                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;
@@ -502,10 +654,18 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             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;
@@ -573,6 +733,9 @@ 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;
             setIsEditorSaveEvent: (isEditorSaveEvent: boolean) => void;
@@ -607,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;
@@ -617,12 +781,16 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             getDashboard: () => TDashboard | undefined;
             getSelectedSheet: () => TSheet | undefined;
             getSelectedSheetCards: () => TCard[] | undefined;
+            getCard: (cardId: string) => TCard | undefined;
             getSelectedCard: () => TCard | undefined;
             getSelectedSheetLayout: () => ReactGridLayout.Layout[] | undefined;
+            handleDataPointClickAction: (card: TCard, dataPoint: any) => void;
         };
     }) => void), shouldReplace?: boolean | undefined): void;
 }>;
 
+export declare const useEditorActions: () => Actions_2;
+
 export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "setState"> & {
     setState(nextStateOrUpdater: EditorStore | Partial<EditorStore> | ((state: {
         isShowingVisual: boolean;
@@ -630,6 +798,7 @@ export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "
         isSqlRunning: boolean;
         actions: {
             setCardRefreshInterval: (refreshInterval: string) => void;
+            setNumberFormat: (format: string, currency: string, locale: string, suffix: string) => void;
             setIsShowingVisual: (isShowingVisual: boolean) => void;
             setRunSql: (runSql: boolean) => void;
             setCardPreferences: (preferences: TCardPreferences) => void;
@@ -675,10 +844,18 @@ export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "
             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;
@@ -754,4 +931,8 @@ export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "
     }) => void), shouldReplace?: boolean | undefined): void;
 }>;
 
+export declare type WritableDraft<T> = {
+    -readonly [K in keyof T]: Draft<T[K]>;
+};
+
 export { }