semaphor 0.0.24 → 0.0.26

package/dist/react-semaphor.d.ts

@@ -1,17 +1,11 @@
 /// <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';
 
@@ -21,26 +15,23 @@ declare type Actions = {
     setCustomCards: (customCards: CustomCard[]) => void;
     setAuthToken: (authToken: AuthToken) => void;
     setThemeStyle: (themeStyle: StyleProps) => void;
-    setIsEditorSaveEvent: (isEditorSaveEvent: boolean) => void;
     setBookmarkKey: (bookmarkKey: string) => void;
     setDashboard: (dashboard: TDashboard) => void;
     setDashboardTheme: (theme: 'light' | 'dark' | 'system') => void;
-    setDashboardTitle: (title: string) => void;
-    setDashboardDescription: (description: string) => void;
     setSheets: (sheets: TSheet[]) => void;
-    setSheetTitle: (sheetId: string, title: string) => void;
-    setSheetDescription: (sheetId: string, description: string) => void;
     setSelectedSheetId: (sheetId: string | null) => void;
     setSheetLayout: (sheetId: string, layout: ReactGridLayout.Layout[]) => void;
-    setCards: (sheetId: string, cards: TCard[]) => void;
     setSelectedCardId: (sheetId: string, cardId: string | null) => void;
-    setSelectedCard: (card: TCard | null) => void;
+    setSelectedFrameId: (frameId: string) => void;
     setCardTitle: (sheetId: string, cardId: string, title: string) => void;
     setCardSql: (sheetId: string, cardId: string, sql: string) => void;
     setCardDescription: (sheetId: string, cardId: string, description: string) => void;
-    setCardData: (sheetId: string, cardId: string, data: any[]) => void;
-    addCard: (sheetId: string, card: TCard) => void;
+    setFrameCardData: (sheetId: string, cardId: string, data: any[]) => void;
+    addFrame: (sheetId: string, frame: TFrame) => void;
+    updateFrame: (sheetId: string, frame: TFrame) => void;
     updateCard: (sheetId: string, card: TCard) => void;
+    updateFrameCard?: (sheetId: string, frameId: string, card: TCard) => void;
+    removeFrame: (sheetId: string, frameId: string) => void;
     removeCard: (sheetId: string, card: TCard) => void;
     setIsDashboardEditing: (editing: boolean) => void;
     setShowContext: (show: boolean) => void;
@@ -63,9 +54,8 @@ declare type Actions = {
     setOnEvent: (onEvent: (event: TEvent) => void) => void;
     getDashboard: () => TDashboard | undefined;
     getSelectedSheet: () => TSheet | undefined;
-    getSelectedSheetCards: () => TCard[] | undefined;
     getCard: (cardId: string) => TCard | undefined;
-    getSelectedCard: () => TCard | undefined;
+    getSelectedFrame: () => TFrame | undefined;
     getSelectedSheetLayout: () => ReactGridLayout.Layout[] | undefined;
     handleDataPointClickAction: (card: TCard, dataPoint: any) => void;
 };
@@ -79,6 +69,7 @@ declare type Actions_2 = {
     setFilterOnClickField: (field: string) => void;
     setIsSqlRunning: (isSqlRunning: boolean) => void;
     setCard: (card: TCard) => void;
+    setFrame: (frame: TFrame) => void;
     setSqlGen: (sqlGen: SqlGen) => void;
     setSqlGenMeasure: (name: string, calc: AggregateCalc) => void;
     setSqlGenDimension: (dimension: string) => void;
@@ -99,11 +90,11 @@ declare type Actions_2 = {
     setOnDatabaseChange: (onDatabaseChange: (databaseName: string) => void) => void;
     setOnSchemaChange: (onSchemaChange: (schemaName: string) => void) => void;
     setOnTableChange: (onTableChange: (tableNmae: string) => void) => void;
-    setOnSave: (onSave: (card: TCard) => void) => void;
+    setOnSave: (onSave: (card: TFrame) => void) => void;
     setOnClose: (onClose: () => void) => void;
 };
 
-declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
+export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
 
 export declare type AuthToken = {
     accessToken: string;
@@ -130,6 +121,8 @@ export declare type Bookmark = {
     filterValues?: TFilterValue[];
 };
 
+export declare const BOOLEAN_DATA_TYPES: string[];
+
 declare type CardWithContent = BaseCustomCard & {
     content: React.FC<{
         card: TCard;
@@ -150,19 +143,12 @@ declare type CardWithFooter = BaseCustomCard & {
 
 export declare function cleanCard(card: TCard): TCard;
 
+export declare function createSqlGenConfig(column: TDataColumn, preSqlGen: SqlGen, calc?: AggregateCalc): SqlGen;
+
 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 = {
@@ -196,6 +182,7 @@ export declare type DashboardStore = {
     bookmarkKey?: string;
     dashboard: TDashboard;
     selectedSheetId?: string | null | undefined;
+    selectedFrameId?: string | null;
     selectedCardId?: string | null;
     selectedCard?: TCard | null;
     isDashboardEditing: boolean;
@@ -204,10 +191,9 @@ export declare type DashboardStore = {
     showDashboardJSON: boolean;
     showFilters: boolean;
     filterValues?: TFilterValue[];
-    isEditorSaveEvent: boolean;
     onEvent?: (event: TEvent) => void;
     onSaveFunction?: (dashboard: TDashboard) => void;
-    onAddCard?: (card: TCard, sheetId: string) => void;
+    onAddFrame?: (card: TFrame, sheetId: string) => void;
     onUpdateCard?: (card: TCard, sheetId: string) => void;
     onRemoveCard?: (card: TCard, sheetId: string) => void;
     actions: Actions;
@@ -215,12 +201,15 @@ export declare type DashboardStore = {
 
 export declare const DashboardWC: CustomElementConstructor;
 
+export declare const DATE_DATA_TYPES: string[];
+
 declare type EditorStore = {
     isShowingVisual: boolean;
     runSql: boolean;
     isSqlRunning: boolean;
     actions: Actions_2;
     sqlGen: SqlGen;
+    frame: TFrame;
     card: TCard;
     showFilters: boolean;
     applyFilters: boolean;
@@ -234,7 +223,7 @@ declare type EditorStore = {
     onDatabaseChange?: (databaseName: string) => void;
     onTableChange?: (tableName: string) => void;
     onSchemaChange?: (schemaName: string) => void;
-    onSave?: (card: TCard) => void;
+    onSave?: (card: TFrame) => void;
     onClose?: () => void;
 };
 
@@ -272,15 +261,24 @@ declare type FilterForString = BaseFilter & {
     values: [string];
 };
 
+export declare function fmt(str: string): string;
+
 export declare function getBookmarkKey(dashboardId: string): string;
 
+export declare function getColumnDataType(column: TDataColumn): string;
+
 export declare function getDashbaordStateWithoutData(dashboardState: TDashboard): {
     sheets: {
-        cards: TCard[] | undefined;
+        frames: {
+            cards: TCard[];
+            id: string;
+            activeCardId: string;
+        }[] | undefined;
         id: string;
         title?: string | undefined;
         description?: string | undefined;
         layout?: Layout[] | undefined;
+        cards?: TCard[] | undefined;
     }[] | undefined;
     id: string;
     title?: string | undefined;
@@ -290,11 +288,41 @@ export declare function getDashbaordStateWithoutData(dashboardState: TDashboard)
     customCards?: CustomCard[] | undefined;
 };
 
+export declare function getFilterValueType(filter: TFilter): "string" | "number" | "date" | "boolean";
+
+export declare function getQualifiedTableName(schemaName: string, tableName: string): string;
+
+export declare function getSql(config: SqlGen, schemaName: string, tableName: string): string | undefined;
+
+export declare function isColumnInSqlGen(column: TDataColumn, sqlGen: SqlGen): boolean | undefined;
+
 export declare type LoadingProps = {
     message?: string;
 };
 
-declare type SqlGen = {
+export declare const NUMBER_DATA_TYPES: string[];
+
+export declare const resolveDataType: (value: any) => string;
+
+export declare function SelectComponent({ title, items, value, isLoading, isError, onChange, }: SelectProps): JSX_2.Element;
+
+declare type SelectProps = {
+    title: string;
+    items: {
+        id: string;
+        name: string;
+    }[];
+    value: string;
+    isLoading: boolean;
+    isError: boolean;
+    onChange?: (value: string) => void;
+};
+
+export declare function SemaphorQueryClient({ children, }: {
+    children: React.ReactNode;
+}): JSX_2.Element;
+
+export declare type SqlGen = {
     measures?: {
         name: string;
         calc: AggregateCalc;
@@ -339,7 +367,6 @@ export declare type TCard = {
     sql?: string;
     data?: any[];
     cfg?: any;
-    childCards?: any[];
     customCfg?: any;
     preferences?: TCardPreferences;
     lastSelectedDatabase?: string;
@@ -367,8 +394,6 @@ export declare type TCardPreferences = {
     };
 };
 
-declare type TChartConfiguration = ChartConfiguration;
-
 declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'table' | 'kpi' | 'custom';
 
 export declare type TDashboard = {
@@ -381,7 +406,7 @@ export declare type TDashboard = {
     customCards?: CustomCard[];
 };
 
-declare type TDataColumn = {
+export declare type TDataColumn = {
     column_name: string;
     data_type: string;
     is_nullable?: string;
@@ -392,6 +417,8 @@ export declare type TEvent = {
     message: any;
 };
 
+export declare const TEXT_DATA_TYPES: string[];
+
 declare type TFilter = {
     id: string;
     connectionId: string;
@@ -405,12 +432,19 @@ declare type TFilter = {
 
 declare type TFilterValue = FilterForString | FilterForEqual | FilterForCompare | FilterForBetween | FilterForIn | FilterForDate;
 
+export declare type TFrame = {
+    id: string;
+    cards: TCard[];
+    activeCardId: string;
+};
+
 export declare type TSheet = {
     id: string;
     title?: string;
     description?: string;
     layout?: ReactGridLayout.Layout[];
     cards?: TCard[];
+    frames?: TFrame[];
 };
 
 /**
@@ -422,7 +456,6 @@ export declare type TStyle = {
 };
 
 export declare function useActions(): {
-    setDashboardTitle: (title: string) => void;
     getStyle: () => TStyle | undefined;
     getDashboard: () => TDashboard | undefined;
     setOnSaveFunction: (onSaveFunction: (dashboard: TDashboard) => void) => void;
@@ -431,17 +464,6 @@ 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;
@@ -497,7 +519,6 @@ 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;
@@ -550,7 +571,6 @@ 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;
@@ -568,6 +588,36 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
                     lastSelectedTable?: string | undefined;
                     refreshInterval?: string | undefined;
                 }[] | undefined;
+                frames?: {
+                    id: string;
+                    cards: {
+                        id: string;
+                        title: string;
+                        description?: string | undefined;
+                        connectionId?: string | undefined;
+                        type: TChartType;
+                        sql?: string | undefined;
+                        data?: any[] | undefined;
+                        cfg?: any;
+                        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;
+                    }[];
+                    activeCardId: string;
+                }[] | undefined;
             }[] | undefined;
             style?: {
                 default: {
@@ -644,6 +694,7 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             })[] | undefined;
         };
         selectedSheetId?: string | null | undefined;
+        selectedFrameId?: string | null | undefined;
         selectedCardId?: string | null | undefined;
         selectedCard?: {
             id: string;
@@ -654,7 +705,6 @@ 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;
@@ -726,10 +776,9 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             operation: "in" | "not in";
             values: (string | number)[];
         })[] | undefined;
-        isEditorSaveEvent: boolean;
         onEvent?: ((event: TEvent) => void) | undefined;
         onSaveFunction?: ((dashboard: TDashboard) => void) | undefined;
-        onAddCard?: ((card: TCard, sheetId: string) => void) | undefined;
+        onAddFrame?: ((card: TFrame, sheetId: string) => void) | undefined;
         onUpdateCard?: ((card: TCard, sheetId: string) => void) | undefined;
         onRemoveCard?: ((card: TCard, sheetId: string) => void) | undefined;
         actions: {
@@ -738,26 +787,23 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             setCustomCards: (customCards: CustomCard[]) => void;
             setAuthToken: (authToken: AuthToken) => void;
             setThemeStyle: (themeStyle: StyleProps) => void;
-            setIsEditorSaveEvent: (isEditorSaveEvent: boolean) => void;
             setBookmarkKey: (bookmarkKey: string) => void;
             setDashboard: (dashboard: TDashboard) => void;
             setDashboardTheme: (theme: 'light' | 'dark' | 'system') => void;
-            setDashboardTitle: (title: string) => void;
-            setDashboardDescription: (description: string) => void;
             setSheets: (sheets: TSheet[]) => void;
-            setSheetTitle: (sheetId: string, title: string) => void;
-            setSheetDescription: (sheetId: string, description: string) => void;
             setSelectedSheetId: (sheetId: string | null) => void;
             setSheetLayout: (sheetId: string, layout: ReactGridLayout.Layout[]) => void;
-            setCards: (sheetId: string, cards: TCard[]) => void;
             setSelectedCardId: (sheetId: string, cardId: string | null) => void;
-            setSelectedCard: (card: TCard | null) => void;
+            setSelectedFrameId: (frameId: string) => void;
             setCardTitle: (sheetId: string, cardId: string, title: string) => void;
             setCardSql: (sheetId: string, cardId: string, sql: string) => void;
             setCardDescription: (sheetId: string, cardId: string, description: string) => void;
-            setCardData: (sheetId: string, cardId: string, data: any[]) => void;
-            addCard: (sheetId: string, card: TCard) => void;
+            setFrameCardData: (sheetId: string, cardId: string, data: any[]) => void;
+            addFrame: (sheetId: string, frame: TFrame) => void;
+            updateFrame: (sheetId: string, frame: TFrame) => void;
             updateCard: (sheetId: string, card: TCard) => void;
+            updateFrameCard?: ((sheetId: string, frameId: string, card: TCard) => void) | undefined;
+            removeFrame: (sheetId: string, frameId: string) => void;
             removeCard: (sheetId: string, card: TCard) => void;
             setIsDashboardEditing: (editing: boolean) => void;
             setShowContext: (show: boolean) => void;
@@ -780,9 +826,8 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             setOnEvent: (onEvent: (event: TEvent) => void) => void;
             getDashboard: () => TDashboard | undefined;
             getSelectedSheet: () => TSheet | undefined;
-            getSelectedSheetCards: () => TCard[] | undefined;
             getCard: (cardId: string) => TCard | undefined;
-            getSelectedCard: () => TCard | undefined;
+            getSelectedFrame: () => TFrame | undefined;
             getSelectedSheetLayout: () => ReactGridLayout.Layout[] | undefined;
             handleDataPointClickAction: (card: TCard, dataPoint: any) => void;
         };
@@ -791,6 +836,30 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
 
 export declare const useEditorActions: () => Actions_2;
 
+export declare function useEditorAside(token?: AuthToken, connectionQueryKey?: string): {
+    connectionItems: any;
+    isConnectionsLoading: boolean;
+    isConnectionsError: boolean;
+    databaseItems: any;
+    isDatabasesLoadingOrFetching: boolean;
+    isDatabaseError: boolean;
+    schemaItems: any;
+    isSchemaLoadingOrFetching: boolean;
+    isSchemaError: boolean;
+    tableItems: any;
+    isTableLoadingOrFetching: boolean;
+    isTableError: boolean;
+    columns: TDataColumn[];
+    isColumnsLoadingOrFetching: boolean;
+    isColumnsError: boolean;
+    isAPIConnection: boolean;
+    tableName: string;
+    schemaName: string;
+    handleConnectionChange: (value: string) => void;
+    handleDatabaseChange: (value: string) => void;
+    handleSchemaChange: (value: string) => void;
+};
+
 export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "setState"> & {
     setState(nextStateOrUpdater: EditorStore | Partial<EditorStore> | ((state: {
         isShowingVisual: boolean;
@@ -805,6 +874,7 @@ export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "
             setFilterOnClickField: (field: string) => void;
             setIsSqlRunning: (isSqlRunning: boolean) => void;
             setCard: (card: TCard) => void;
+            setFrame: (frame: TFrame) => void;
             setSqlGen: (sqlGen: SqlGen) => void;
             setSqlGenMeasure: (name: string, calc: AggregateCalc) => void;
             setSqlGenDimension: (dimension: string) => void;
@@ -825,7 +895,7 @@ export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "
             setOnDatabaseChange: (onDatabaseChange: (databaseName: string) => void) => void;
             setOnSchemaChange: (onSchemaChange: (schemaName: string) => void) => void;
             setOnTableChange: (onTableChange: (tableNmae: string) => void) => void;
-            setOnSave: (onSave: (card: TCard) => void) => void;
+            setOnSave: (onSave: (card: TFrame) => void) => void;
             setOnClose: (onClose: () => void) => void;
         };
         sqlGen: {
@@ -835,6 +905,36 @@ export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "
             }[] | undefined;
             dimensions?: string[] | undefined;
         };
+        frame: {
+            id: string;
+            cards: {
+                id: string;
+                title: string;
+                description?: string | undefined;
+                connectionId?: string | undefined;
+                type: TChartType;
+                sql?: string | undefined;
+                data?: any[] | undefined;
+                cfg?: any;
+                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;
+            }[];
+            activeCardId: string;
+        };
         card: {
             id: string;
             title: string;
@@ -844,7 +944,6 @@ 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;
@@ -926,7 +1025,7 @@ export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "
         onDatabaseChange?: ((databaseName: string) => void) | undefined;
         onTableChange?: ((tableName: string) => void) | undefined;
         onSchemaChange?: ((schemaName: string) => void) | undefined;
-        onSave?: ((card: TCard) => void) | undefined;
+        onSave?: ((card: TFrame) => void) | undefined;
         onClose?: (() => void) | undefined;
     }) => void), shouldReplace?: boolean | undefined): void;
 }>;