semaphor 0.0.94 → 0.0.96

package/dist/types/main.d.ts

@@ -2,6 +2,7 @@ import { AIScopeTable as AIScopeTable_2 } from '..';
 import { CacheConfig as CacheConfig_2 } from '..';
 import { Chart } from 'chart.js';
 import { ChartConfiguration } from 'chart.js';
+import { ComboBoxOption as ComboBoxOption_2 } from '../../components/surfboard/filter/types';
 import { CustomCard as CustomCard_2 } from '..';
 import { DateRange } from 'react-day-picker';
 import { default as default_2 } from 'react-grid-layout';
@@ -13,6 +14,7 @@ import { RefetchOptions } from '@tanstack/query-core';
 import { StoreApi } from 'zustand';
 import { TBaseQuery as TBaseQuery_2 } from '..';
 import { TFilter as TFilter_2 } from '../surfboard/filter/types';
+import { TFilterValue as TFilterValue_2 } from '..';
 import { TStyle as TStyle_2 } from '..';
 import { UseBoundStore } from 'zustand';
 import { WritableDraft } from 'immer';
@@ -20,6 +22,7 @@ import { WritableDraft } from 'immer';
 declare type Actions = {
     setInitStore: () => void;
     setGlobalStyle: (style: TStyle) => void;
+    setDefaultFilterValues: (filterValues: TFilterValue[] | undefined) => void;
     updateEmailSettings: (emailSettings: EmailSettings) => void;
     setIsDownloadingPdf: (isDownloadingPdf: boolean) => void;
     setLenses: (lenses: TLens[]) => void;
@@ -96,6 +99,35 @@ declare type Actions = {
 };
 
 declare type Actions_2 = {
+    setLowerIsBetter: (lowerIsBetter: boolean) => void;
+    removeEditorFilter: (filterColumn: FilterByColumn) => void;
+    updateEditorFilterValue: (filterColumnName: string, filterValue: FilterValue, clearFilter?: boolean) => void;
+    setTempQueryData: (tempQueryData: {
+        queryKey: string[];
+        queryData: any;
+    }) => void;
+    clearQueryConfig: () => void;
+    setQueryConfig: (queryConfig: QueryConfig | undefined) => void;
+    setIsDevMode: (isDevMode: boolean) => void;
+    setOrderByColumns: (orderByColumns: OrderBy[]) => void;
+    addOrderByColumn: (orderByColumn: OrderBy) => void;
+    removeOrderByColumn: (orderByColumn: OrderBy) => void;
+    updateOrderByColumn: (orderByColumn: OrderBy) => void;
+    setGroupByColumns: (groupByColumns: GroupByColumn[]) => void;
+    setMetricColumns: (metricColumns: MetricColumn[]) => void;
+    setPivotByColumns: (pivotColumns: GroupByColumn[]) => void;
+    removeColumnFromGroupBy: (columnId: string) => void;
+    removeColumnFromMetricColumns: (columnId: string) => void;
+    removeColumnFromPivotBy: (columnId: string) => void;
+    addColumnToGroupBy: (column: GroupByColumn) => void;
+    addColumnToMetricColumns: (column: MetricColumn) => void;
+    setFilterColumns: (filterColumns: FilterByColumn[]) => void;
+    addColumnToFilterColumns: (column: FilterByColumn) => void;
+    removeColumnFromFilterColumns: (columnId: string) => void;
+    updateMetricColumn: (columnId: string, column: MetricColumn) => void;
+    updateGroupByColumn: (columnId: string, column: GroupByColumn) => void;
+    updatePivotByColumn: (columnId: string, column: GroupByColumn) => void;
+    updateFilterColumn: (columnId: string, column: FilterByColumn) => void;
     setCurrentAssitantScope: (currentAssitantScope: AIScopeTable[]) => void;
     setChartGrid: (chartGrid: 'xy' | 'x' | 'y' | 'none') => void;
     setLegendOptions: (legendOptions: TLegendOptions) => void;
@@ -139,7 +171,6 @@ declare type Actions_2 = {
     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;
@@ -150,6 +181,8 @@ declare type Actions_2 = {
 
 export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
 
+export declare type AggregateFunction = 'SUM' | 'AVG' | 'COUNT' | 'MAX' | 'MIN' | 'DISTINCT';
+
 export declare type AIScopeTable = {
     connectionId: string;
     connectionType: string;
@@ -165,6 +198,14 @@ export declare type AuthToken = {
     refreshToken?: string;
 };
 
+export declare interface BaseColumn {
+    id: string;
+    name: string;
+    label?: string;
+    type: ColumnType;
+    table?: string;
+}
+
 declare type BaseCustomCard = {
     cardId: string;
     replaceDefault?: boolean;
@@ -211,6 +252,16 @@ export declare type ColorRange = {
     color: string;
 };
 
+export declare type ColumnRole = 'groupby' | 'trendby' | 'metric' | 'filter';
+
+export declare type ColumnType = 'string' | 'number' | 'date';
+
+declare type ComboBoxOption = {
+    id: number | string;
+    value: string;
+    [key: string]: number | string;
+};
+
 export declare type ConnectionPolicy = {
     connectionId?: string;
     name: string;
@@ -284,7 +335,7 @@ export declare type DashboardStore = {
     showFilters: boolean;
     filterValues?: TFilterValue[];
     onEvent?: (event: TEvent) => void;
-    onSaveFunction?: (dashboard: TDashboard) => void;
+    onSaveFunction?: (dashboard: TDashboard, description?: string) => void;
     onAddFrame?: (card: TFrame, sheetId: string) => void;
     onAcceptChanges?: (frame: TFrame, dashboard: TDashboard) => void;
     onUpdateCard?: (card: TCard, sheetId: string) => void;
@@ -306,7 +357,14 @@ export declare type DisplayDataType = 'string' | 'date' | 'number' | 'html' | 'n
 
 export declare function downloadPdf(): Promise<void>;
 
+export declare type DroppableId = 'droppable-group-by' | 'droppable-metric';
+
 declare type EditorStore = {
+    tempQueryData?: {
+        queryKey: string[];
+        queryData: any;
+    };
+    isDevMode: boolean;
     isShowingVisual: boolean;
     showAIDialog: boolean;
     userInputForAI: string;
@@ -329,7 +387,6 @@ declare type EditorStore = {
     selectedDatabaseName?: string;
     selectedSchemaName?: string;
     selectedTableName?: string;
-    currentColumns?: TDataColumn[];
     currentAssitantScope?: AIScopeTable[];
     onConnectionChange?: (connectionId: string) => void;
     onDatamodelChange?: (datamodelId: string) => void;
@@ -347,10 +404,22 @@ export declare type EmailSettings = {
     senderTitle: string;
 };
 
+export declare const EMPTY_SELECTION: SelectionState;
+
 export declare type ErrorProps = {
     message?: string;
 };
 
+export declare interface FilterByColumn extends BaseColumn {
+    role: 'filter';
+    operators?: string[];
+    sql?: string;
+    fetchValues?: boolean;
+    fetchLimit?: number;
+    valueSource?: 'distinct' | 'static' | 'range';
+    staticValues?: string[];
+}
+
 declare type FilterForBetween = BaseFilter & {
     operation: 'between' | 'not between';
     values: [number, number];
@@ -388,6 +457,8 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
+export declare type FilterValue = string | number | null | (string | number)[] | RangeValue;
+
 export declare function fmt(str: string): string;
 
 export declare function getColumnDataType(column: TDataColumn): string;
@@ -418,6 +489,7 @@ export declare function getDashbaordStateWithoutData(dashboardState: TDashboard)
     globalStyle?: TStyle_2;
     globalCacheConfig?: CacheConfig_2;
     emailSettings?: EmailSettings_2;
+    defaultFilterValues?: TFilterValue_2[];
 };
 
 export declare type GetDashboardResponse = {
@@ -429,11 +501,12 @@ export declare type GetDashboardResponse = {
 
 export declare function getFilterValueType(filter: TFilter): "string" | "number" | "date" | "boolean";
 
-export declare function getFormattedTableNameForQuery({ schemaName, tableName, modelName, connectionType, }: {
+export declare function getFormattedTableNameForQuery({ schemaName, tableName, modelName, connectionType, databaseName, }: {
     schemaName: string;
     tableName: string;
     modelName: string | undefined;
     connectionType: string;
+    databaseName: string;
 }): string;
 
 export declare type GetPluginsResponse = {
@@ -443,9 +516,22 @@ export declare type GetPluginsResponse = {
     }[];
 };
 
-export declare function getQualifiedTableName(schemaName: string, tableName: string, connectionType: string): string;
+export declare function getQualifiedTableName({ schemaName, tableName, connectionType, databaseName, }: {
+    schemaName: string;
+    tableName: string;
+    connectionType: string;
+    databaseName: string;
+}): string;
 
-export declare function getSql(config: SqlGen, schemaName: string, tableName: string, modelName: string, connectionType: string): string | undefined;
+export declare function getSql(config: SqlGen, schemaName: string, tableName: string, modelName: string, connectionType: string, databaseName: string): string | undefined;
+
+export declare type Granularity = 'day' | 'week' | 'month' | 'year';
+
+export declare interface GroupByColumn extends BaseColumn {
+    role: 'groupby';
+    granularity?: Granularity;
+    format?: string;
+}
 
 export declare type HtmlOptions = {
     html: string;
@@ -469,10 +555,18 @@ export declare type KPICardProps = {
     renderFilterInfo?: () => JSX.Element | null;
 };
 
+export declare type Level = 'database' | 'schema' | 'table';
+
 export declare type LoadingProps = {
     message?: string;
 };
 
+export declare interface MetricColumn extends BaseColumn {
+    role: 'metric';
+    aggregate: AggregateFunction;
+    aliasTemplate?: string;
+}
+
 declare type NoneOptions = {};
 
 export declare type NumberAxisFormat = {
@@ -499,6 +593,11 @@ declare type OptionsMap = {
     none: NoneOptions;
 };
 
+export declare interface OrderBy {
+    columnId: string;
+    direction: 'asc' | 'desc';
+}
+
 declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
@@ -514,6 +613,29 @@ export declare type Placeholders = {
     SessionExpired?: React.ReactNode;
 };
 
+export declare type QueryColumn = GroupByColumn | MetricColumn | FilterByColumn;
+
+export declare interface QueryConfig {
+    groupByColumns?: GroupByColumn[];
+    pivotColumns?: GroupByColumn[];
+    metricColumns?: MetricColumn[];
+    filterColumns?: FilterByColumn[];
+    filters?: {
+        filterColumnName: string;
+        filterValue: FilterValue;
+        exclude?: boolean;
+    }[];
+    limit?: number;
+    orderBy?: OrderBy[];
+}
+
+export declare type RangeValue = {
+    gte?: string | number;
+    lte?: string | number;
+    lt?: string | number;
+    gt?: string | number;
+};
+
 export declare function resolveDatamodelName(datamodelName: string): string;
 
 export declare const resolveDataType: (value: any) => string;
@@ -522,7 +644,9 @@ export declare function ScheduleDashboard({ triggerButtonClassName, }: {
     triggerButtonClassName?: string;
 }): JSX_2.Element;
 
-export declare function SelectComponent({ title, items, value, isLoading, isError, refetch, connectionTooltip, onChange, showNone, className, showIcon, disabled, type, }: SelectProps): JSX_2.Element;
+export declare function SelectComponent({ title, items, value, isLoading, isError, refetch, onChange, showNone, className, disabled, type, }: SelectProps): JSX_2.Element;
+
+export declare type SelectionState = Record<Level, string | null>;
 
 declare type SelectProps = {
     title: string;
@@ -604,6 +728,13 @@ export declare type StyleProps = {
 
 export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element;
 
+export declare type TableConfig = {
+    databaseName: string;
+    schemaName: string;
+    tableName: string;
+    datamodelId: string;
+};
+
 export declare type TBaseQuery = {
     id: string;
     name: string;
@@ -625,6 +756,7 @@ export declare type TCard = {
     type: TChartType;
     sql?: string;
     python?: string;
+    queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
     customCardPreferences?: TCustomCardPreferences;
@@ -675,6 +807,9 @@ export declare type TCardPreferences = {
         projectionOffset?: [number, number];
         colorScale?: string;
     };
+    kpiVisualOptions?: {
+        lowerIsBetter?: boolean;
+    };
 };
 
 declare type TChartConfiguration = ChartConfiguration;
@@ -714,7 +849,7 @@ export declare type TChartOptions = {
     };
 };
 
-declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'kpi' | 'pyramid' | 'range' | 'text' | 'map' | 'custom';
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'kpi' | 'pyramid' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
 
 export declare type TColumnSetting<T extends DisplayDataType> = {
     columnIdx: number;
@@ -756,6 +891,7 @@ export declare type TDashboard = {
     globalStyle?: TStyle;
     globalCacheConfig?: CacheConfig;
     emailSettings?: EmailSettings;
+    defaultFilterValues?: TFilterValue[];
 };
 
 export declare type TDataColumn = {
@@ -777,6 +913,11 @@ export declare type TDatasetOptions = {
     };
 };
 
+export declare type TDbCapabilities = {
+    path: Level[];
+    labels?: Partial<Record<Level, string>>;
+};
+
 export declare type TEvent = {
     type: 'success' | 'error' | 'info' | 'warning';
     message: any;
@@ -825,11 +966,7 @@ export declare type TLens = {
     shared?: boolean;
 };
 
-export declare type TSelectedRecord = {
-    id: number | string;
-    value: string;
-    [key: string]: number | string;
-};
+export declare type TSelectedRecord = ComboBoxOption;
 
 export declare type TSheet = {
     id: string;
@@ -852,6 +989,7 @@ export declare type TStyle = {
 export declare function useCard(cardId: string): {
     data: any;
     card: TCard;
+    isPending: boolean;
     isError: boolean;
     isLoading: boolean;
     isFetching: boolean;
@@ -876,12 +1014,14 @@ export declare function useDateFilterHook(filterId: string): {
     dateRange: DateRange | undefined;
     handleClear: () => void;
     handleChange: (date: DateRange | undefined) => void;
+    handleReset: () => void;
 };
 
 export declare const useEditorActions: () => Actions_2;
 
 export declare function useEditorAside(token?: AuthToken, _connectionQueryKey?: string): {
     connectionItems: any;
+    selectedConnectionId: string | undefined;
     isConnectionsLoading: boolean;
     isConnectionsError: boolean;
     modelItems: any;
@@ -889,13 +1029,16 @@ export declare function useEditorAside(token?: AuthToken, _connectionQueryKey?:
     selectedDatamodelName: any;
     isModelsLoading: boolean;
     isModelsError: boolean;
+    selectedDatabaseName: string | undefined;
     databaseItems: any;
     isDatabasesLoadingOrFetching: boolean;
     isDatabaseError: boolean;
     schemaItems: any;
+    selectedSchemaName: string | undefined;
     isSchemaLoadingOrFetching: boolean;
     isSchemaError: boolean;
     tableItems: any;
+    selectedTableName: string | undefined;
     isTableLoadingOrFetching: boolean;
     isTableError: boolean;
     columns: TDataColumn[];
@@ -904,6 +1047,7 @@ export declare function useEditorAside(token?: AuthToken, _connectionQueryKey?:
     isNonDbConnection: boolean;
     connectionType: any;
     tableName: any;
+    formattedTableName: string;
     schemaName: string;
     refetchConnections: (options?: RefetchOptions) => Promise<QueryObserverResult<any, Error>>;
     refetchModels: (options?: RefetchOptions) => Promise<QueryObserverResult<any, Error>>;
@@ -925,12 +1069,12 @@ export declare function useTextFilterHook(filterId: string): {
     isLoading: boolean;
     isFetching: boolean;
     isError: boolean;
-    records: TSelectedRecord[];
-    selectedRecords: TSelectedRecord[];
+    records: ComboBoxOption_2[];
+    selectedRecords: ComboBoxOption_2[];
     handleChange: (selectedRecords: TSelectedRecord[]) => void;
     handleClear: () => void;
     handleSelectAll: (checked: boolean) => void;
-    filteredRecords: TSelectedRecord[];
+    filteredRecords: ComboBoxOption_2[];
     isSingleSelect: boolean;
     allSelected: boolean;
 };

package/dist/types/surfboard.d.ts

@@ -3,6 +3,8 @@ import { JSX as JSX_2 } from 'react/jsx-runtime';
 
 export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
 
+declare type AggregateFunction = 'SUM' | 'AVG' | 'COUNT' | 'MAX' | 'MIN' | 'DISTINCT';
+
 export declare type AIScopeTable = {
     connectionId: string;
     connectionType: string;
@@ -18,6 +20,14 @@ export declare type AuthToken = {
     refreshToken?: string;
 };
 
+declare interface BaseColumn {
+    id: string;
+    name: string;
+    label?: string;
+    type: ColumnType;
+    table?: string;
+}
+
 declare type BaseCustomCard = {
     cardId: string;
     replaceDefault?: boolean;
@@ -62,6 +72,8 @@ export declare type ColorRange = {
     color: string;
 };
 
+declare type ColumnType = 'string' | 'number' | 'date';
+
 export declare type ConnectionPolicy = {
     connectionId?: string;
     name: string;
@@ -117,6 +129,8 @@ export declare type DateOptions = {
 
 export declare type DisplayDataType = 'string' | 'date' | 'number' | 'html' | 'none';
 
+export declare type DroppableId = 'droppable-group-by' | 'droppable-metric';
+
 export declare type EmailSettings = {
     companyName: string;
     dashboardUrl: string;
@@ -124,10 +138,22 @@ export declare type EmailSettings = {
     senderTitle: string;
 };
 
+export declare const EMPTY_SELECTION: SelectionState;
+
 export declare type ErrorProps = {
     message?: string;
 };
 
+declare interface FilterByColumn extends BaseColumn {
+    role: 'filter';
+    operators?: string[];
+    sql?: string;
+    fetchValues?: boolean;
+    fetchLimit?: number;
+    valueSource?: 'distinct' | 'static' | 'range';
+    staticValues?: string[];
+}
+
 declare type FilterForBetween = BaseFilter & {
     operation: 'between' | 'not between';
     values: [number, number];
@@ -165,6 +191,8 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
+declare type FilterValue = string | number | null | (string | number)[] | RangeValue;
+
 export declare type GetDashboardResponse = {
     dashboard: TDashboard;
     lenses: TLens[];
@@ -179,6 +207,14 @@ export declare type GetPluginsResponse = {
     }[];
 };
 
+declare type Granularity = 'day' | 'week' | 'month' | 'year';
+
+declare interface GroupByColumn extends BaseColumn {
+    role: 'groupby';
+    granularity?: Granularity;
+    format?: string;
+}
+
 export declare type HtmlOptions = {
     html: string;
 };
@@ -189,10 +225,18 @@ export declare type KPICardProps = {
     renderFilterInfo?: () => JSX.Element | null;
 };
 
+export declare type Level = 'database' | 'schema' | 'table';
+
 export declare type LoadingProps = {
     message?: string;
 };
 
+declare interface MetricColumn extends BaseColumn {
+    role: 'metric';
+    aggregate: AggregateFunction;
+    aliasTemplate?: string;
+}
+
 declare type NoneOptions = {};
 
 export declare type NumberAxisFormat = {
@@ -219,6 +263,11 @@ declare type OptionsMap = {
     none: NoneOptions;
 };
 
+declare interface OrderBy {
+    columnId: string;
+    direction: 'asc' | 'desc';
+}
+
 declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
@@ -234,6 +283,29 @@ export declare type Placeholders = {
     SessionExpired?: React.ReactNode;
 };
 
+declare interface QueryConfig {
+    groupByColumns?: GroupByColumn[];
+    pivotColumns?: GroupByColumn[];
+    metricColumns?: MetricColumn[];
+    filterColumns?: FilterByColumn[];
+    filters?: {
+        filterColumnName: string;
+        filterValue: FilterValue;
+        exclude?: boolean;
+    }[];
+    limit?: number;
+    orderBy?: OrderBy[];
+}
+
+declare type RangeValue = {
+    gte?: string | number;
+    lte?: string | number;
+    lt?: string | number;
+    gt?: string | number;
+};
+
+export declare type SelectionState = Record<Level, string | null>;
+
 export declare type SqlGen = {
     measures?: {
         name: string;
@@ -310,6 +382,7 @@ export declare type TCard = {
     type: TChartType;
     sql?: string;
     python?: string;
+    queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
     customCardPreferences?: TCustomCardPreferences;
@@ -360,6 +433,9 @@ export declare type TCardPreferences = {
         projectionOffset?: [number, number];
         colorScale?: string;
     };
+    kpiVisualOptions?: {
+        lowerIsBetter?: boolean;
+    };
 };
 
 export declare type TChartOptions = {
@@ -397,7 +473,7 @@ export declare type TChartOptions = {
     };
 };
 
-declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'kpi' | 'pyramid' | 'range' | 'text' | 'map' | 'custom';
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'kpi' | 'pyramid' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
 
 export declare type TColumnSetting<T extends DisplayDataType> = {
     columnIdx: number;
@@ -439,6 +515,7 @@ export declare type TDashboard = {
     globalStyle?: TStyle;
     globalCacheConfig?: CacheConfig;
     emailSettings?: EmailSettings;
+    defaultFilterValues?: TFilterValue[];
 };
 
 export declare type TDataColumn = {
@@ -460,6 +537,11 @@ export declare type TDatasetOptions = {
     };
 };
 
+export declare type TDbCapabilities = {
+    path: Level[];
+    labels?: Partial<Record<Level, string>>;
+};
+
 export declare type TEvent = {
     type: 'success' | 'error' | 'info' | 'warning';
     message: any;