semaphor 0.0.15 → 0.0.17

package/dist/react-semaphor.d.ts

@@ -31,12 +31,14 @@ declare type Actions = {
     updateCard: (sheetId: string, card: TCard) => void;
     removeCard: (sheetId: string, card: TCard) => void;
     setIsDashboardEditing: (editing: boolean) => void;
+    setShowContext: (show: boolean) => void;
     setShowDashboardJSON: (show: boolean) => void;
     setIsVisualEditing: (editing: boolean) => void;
     setShowFilters: (show: boolean) => void;
     addFilter: (filter: TFilter) => void;
     removeFilter: (filterId: string) => void;
     updateFilter: (filter: TFilter) => void;
+    setFilterValues: (filterValues: TFilterValue[] | undefined) => void;
     addOrUpdateFilterValue: (filterValue: TFilterValue) => void;
     removeFilterValue: (filterId: string) => void;
     setStyle: (style: TStyle) => void;
@@ -53,6 +55,40 @@ declare type Actions = {
     getSelectedSheetLayout: () => ReactGridLayout.Layout[] | undefined;
 };
 
+declare type Actions_2 = {
+    setCardRefreshInterval: (refreshInterval: string) => void;
+    setIsShowingVisual: (isShowingVisual: boolean) => void;
+    setRunSql: (runSql: boolean) => void;
+    setCardPreferences: (preferences: TCardPreferences) => void;
+    setFilterOnClickField: (field: string) => void;
+    setIsSqlRunning: (isSqlRunning: boolean) => void;
+    setCard: (card: TCard) => void;
+    setSqlGen: (sqlGen: SqlGen) => void;
+    setSqlGenMeasure: (name: string, calc: AggregateCalc) => void;
+    setSqlGenDimension: (dimension: string) => void;
+    setCardType: (type: TChartType) => void;
+    setCardSql: (sql: string) => void;
+    setCardData: (data: any[]) => void;
+    setCardCustomCfg: (cfg: any) => void;
+    setCardCfg: (cfg: any) => void;
+    setShowFilters: (showFilters: boolean) => void;
+    setApplyFilters: (applyFilters: boolean) => void;
+    setFilterValues: (filterValues: TFilterValue[]) => void;
+    setSelectedConnectionId: (connectionId: string) => void;
+    setSelectedDatabaseName: (databaseName: string) => void;
+    setSelectedSchemaName: (schemaName: string) => void;
+    setSelectedTableName: (tableName: string) => void;
+    setCurrentColumns: (columns: TDataColumn[]) => void;
+    setOnConnectionChange: (onConnectionChange: (connectionId: string) => void) => void;
+    setOnDatabaseChange: (onDatabaseChange: (databaseName: string) => void) => void;
+    setOnSchemaChange: (onSchemaChange: (schemaName: string) => void) => void;
+    setOnTableChange: (onTableChange: (tableNmae: string) => void) => void;
+    setOnSave: (onSave: (card: TCard) => void) => void;
+    setOnClose: (onClose: () => void) => void;
+};
+
+declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
+
 export declare type AuthToken = {
     accessToken: string;
     refreshToken: string;
@@ -70,6 +106,7 @@ export declare type Bookmark = {
     name: string;
     default: boolean;
     template: TDashboard;
+    filterValues?: TFilterValue[];
 };
 
 export declare function cleanCard(card: TCard): TCard;
@@ -105,6 +142,7 @@ declare type DashboardStore = {
     selectedCard?: TCard | null;
     isDashboardEditing: boolean;
     isVisualEditing: boolean;
+    showContext: boolean;
     showDashboardJSON: boolean;
     showFilters: boolean;
     filterValues?: TFilterValue[];
@@ -119,6 +157,29 @@ declare type DashboardStore = {
 
 export declare const DashboardWC: CustomElementConstructor;
 
+declare type EditorStore = {
+    isShowingVisual: boolean;
+    runSql: boolean;
+    isSqlRunning: boolean;
+    actions: Actions_2;
+    sqlGen: SqlGen;
+    card: TCard;
+    showFilters: boolean;
+    applyFilters: boolean;
+    filterValues?: TFilterValue[];
+    selectedConnectionId?: string;
+    selectedDatabaseName?: string;
+    selectedSchemaName?: string;
+    selectedTableName?: string;
+    currentColumns?: TDataColumn[];
+    onConnectionChange?: (connectionId: string) => void;
+    onDatabaseChange?: (databaseName: string) => void;
+    onTableChange?: (tableName: string) => void;
+    onSchemaChange?: (schemaName: string) => void;
+    onSave?: (card: TCard) => void;
+    onClose?: () => void;
+};
+
 export declare type ErrorProps = {
     message?: string;
 };
@@ -174,6 +235,14 @@ export declare type LoadingProps = {
     message?: string;
 };
 
+declare type SqlGen = {
+    measures?: {
+        name: string;
+        calc: AggregateCalc;
+    }[];
+    dimensions?: string[];
+};
+
 /**
  * Style propeerites for the dashboard
  */
@@ -219,6 +288,13 @@ export declare type TCard = {
     refreshInterval?: string;
 };
 
+export declare type TCardContext = {
+    id: string;
+    name: string;
+    description: string;
+    sql: string;
+};
+
 export declare type TCardPreferences = {
     filterOnClick?: boolean;
     filterOnClickField?: string;
@@ -235,8 +311,14 @@ export declare type TDashboard = {
     filters?: TFilter[];
 };
 
+declare type TDataColumn = {
+    column_name: string;
+    data_type: string;
+    is_nullable?: string;
+};
+
 export declare type TEvent = {
-    type: "success" | "error" | "info" | "warning";
+    type: 'success' | 'error' | 'info' | 'warning';
     message: any;
 };
 
@@ -431,6 +513,7 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
         } | null | undefined;
         isDashboardEditing: boolean;
         isVisualEditing: boolean;
+        showContext: boolean;
         showDashboardJSON: boolean;
         showFilters: boolean;
         filterValues?: ({
@@ -513,12 +596,14 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
             updateCard: (sheetId: string, card: TCard) => void;
             removeCard: (sheetId: string, card: TCard) => void;
             setIsDashboardEditing: (editing: boolean) => void;
+            setShowContext: (show: boolean) => void;
             setShowDashboardJSON: (show: boolean) => void;
             setIsVisualEditing: (editing: boolean) => void;
             setShowFilters: (show: boolean) => void;
             addFilter: (filter: TFilter) => void;
             removeFilter: (filterId: string) => void;
             updateFilter: (filter: TFilter) => void;
+            setFilterValues: (filterValues: TFilterValue[] | undefined) => void;
             addOrUpdateFilterValue: (filterValue: TFilterValue) => void;
             removeFilterValue: (filterId: string) => void;
             setStyle: (style: TStyle) => void;
@@ -537,4 +622,135 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
     }) => void), shouldReplace?: boolean | undefined): void;
 }>;
 
+export declare const useEditorStore: UseBoundStore<Omit<StoreApi<EditorStore>, "setState"> & {
+    setState(nextStateOrUpdater: EditorStore | Partial<EditorStore> | ((state: {
+        isShowingVisual: boolean;
+        runSql: boolean;
+        isSqlRunning: boolean;
+        actions: {
+            setCardRefreshInterval: (refreshInterval: string) => void;
+            setIsShowingVisual: (isShowingVisual: boolean) => void;
+            setRunSql: (runSql: boolean) => void;
+            setCardPreferences: (preferences: TCardPreferences) => void;
+            setFilterOnClickField: (field: string) => void;
+            setIsSqlRunning: (isSqlRunning: boolean) => void;
+            setCard: (card: TCard) => void;
+            setSqlGen: (sqlGen: SqlGen) => void;
+            setSqlGenMeasure: (name: string, calc: AggregateCalc) => void;
+            setSqlGenDimension: (dimension: string) => void;
+            setCardType: (type: TChartType) => void;
+            setCardSql: (sql: string) => void;
+            setCardData: (data: any[]) => void;
+            setCardCustomCfg: (cfg: any) => void;
+            setCardCfg: (cfg: any) => void;
+            setShowFilters: (showFilters: boolean) => void;
+            setApplyFilters: (applyFilters: boolean) => void;
+            setFilterValues: (filterValues: TFilterValue[]) => void;
+            setSelectedConnectionId: (connectionId: string) => void;
+            setSelectedDatabaseName: (databaseName: string) => void;
+            setSelectedSchemaName: (schemaName: string) => void;
+            setSelectedTableName: (tableName: string) => void;
+            setCurrentColumns: (columns: TDataColumn[]) => void;
+            setOnConnectionChange: (onConnectionChange: (connectionId: string) => void) => void;
+            setOnDatabaseChange: (onDatabaseChange: (databaseName: string) => void) => void;
+            setOnSchemaChange: (onSchemaChange: (schemaName: string) => void) => void;
+            setOnTableChange: (onTableChange: (tableNmae: string) => void) => void;
+            setOnSave: (onSave: (card: TCard) => void) => void;
+            setOnClose: (onClose: () => void) => void;
+        };
+        sqlGen: {
+            measures?: {
+                name: string;
+                calc: AggregateCalc;
+            }[] | undefined;
+            dimensions?: string[] | undefined;
+        };
+        card: {
+            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;
+            } | undefined;
+            lastSelectedDatabase?: string | undefined;
+            lastSelectedSchema?: string | undefined;
+            lastSelectedTable?: string | undefined;
+            refreshInterval?: string | undefined;
+        };
+        showFilters: boolean;
+        applyFilters: boolean;
+        filterValues?: ({
+            filterId: string;
+            expression?: string | undefined;
+            name: string;
+            valueType: "string" | "number" | "boolean" | "date";
+            connectionType?: "database" | "api" | undefined;
+            operation: "like" | "not like";
+            values: [string];
+        } | {
+            filterId: string;
+            expression?: string | undefined;
+            name: string;
+            valueType: "string" | "number" | "boolean" | "date";
+            connectionType?: "database" | "api" | undefined;
+            operation: "=" | "!=" | "is null" | "is not null";
+            values: [string | number];
+        } | {
+            filterId: string;
+            expression?: string | undefined;
+            name: string;
+            valueType: "string" | "number" | "boolean" | "date";
+            connectionType?: "database" | "api" | undefined;
+            operation: ">" | "<" | ">=" | "<=";
+            values: [number];
+        } | {
+            filterId: string;
+            expression?: string | undefined;
+            name: string;
+            valueType: "string" | "number" | "boolean" | "date";
+            connectionType?: "database" | "api" | undefined;
+            operation: "between" | "not between";
+            values: [number, number];
+        } | {
+            filterId: string;
+            expression?: string | undefined;
+            name: string;
+            valueType: "string" | "number" | "boolean" | "date";
+            connectionType?: "database" | "api" | undefined;
+            operation: "between" | "not between";
+            values: [Date, Date];
+        } | {
+            filterId: string;
+            expression?: string | undefined;
+            name: string;
+            valueType: "string" | "number" | "boolean" | "date";
+            connectionType?: "database" | "api" | undefined;
+            operation: "in" | "not in";
+            values: (string | number)[];
+        })[] | undefined;
+        selectedConnectionId?: string | undefined;
+        selectedDatabaseName?: string | undefined;
+        selectedSchemaName?: string | undefined;
+        selectedTableName?: string | undefined;
+        currentColumns?: {
+            column_name: string;
+            data_type: string;
+            is_nullable?: string | undefined;
+        }[] | undefined;
+        onConnectionChange?: ((connectionId: string) => void) | undefined;
+        onDatabaseChange?: ((databaseName: string) => void) | undefined;
+        onTableChange?: ((tableName: string) => void) | undefined;
+        onSchemaChange?: ((schemaName: string) => void) | undefined;
+        onSave?: ((card: TCard) => void) | undefined;
+        onClose?: (() => void) | undefined;
+    }) => void), shouldReplace?: boolean | undefined): void;
+}>;
+
 export { }