react-semaphor 0.0.489 → 0.0.491

package/dist/types/main.d.ts

@@ -101,12 +101,12 @@ declare type Actions = {
     setBaseQueries: (baseQueries: TBaseQuery[]) => void;
 };
 
-declare type Actions_2 = TableActions & {
+declare type Actions_2 = TableActions & ExplorerActions & {
     setEditorFilterMode: (filterColumnName: string, filterMode: 'include' | 'exclude') => void;
     setLowerIsBetter: (lowerIsBetter: boolean) => void;
     clearEditorFilter: (filterColumn: FilterByColumn) => void;
     removeEditorFilter: (filterColumn: FilterByColumn) => void;
-    updateEditorFilterValue: (filterColumnName: string, filterValue: FilterValue, clearFilter?: boolean) => void;
+    updateEditorFilterValue: (filterColumnName: string, filterValue: OldFilterValue, clearFilter?: boolean) => void;
     setTempQueryData: (tempQueryData: {
         queryKey: string[];
         queryData: any;
@@ -129,9 +129,9 @@ declare type Actions_2 = TableActions & {
     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;
+    updateMetricColumnOld: (columnId: string, column: MetricColumn) => void;
+    updateGroupByColumnOld: (columnId: string, column: GroupByColumn) => void;
+    updatePivotByColumnOld: (columnId: string, column: GroupByColumn) => void;
     updateFilterColumn: (columnId: string, column: FilterByColumn) => void;
     setCurrentAssitantScope: (currentAssitantScope: AIScopeTable[]) => void;
     setChartGrid: (chartGrid: 'xy' | 'x' | 'y' | 'none') => void;
@@ -168,6 +168,7 @@ declare type Actions_2 = TableActions & {
     setCardPython: (python: string | undefined) => void;
     setPythonStdOut: (pythonStdOut: string) => void;
     setCardCustomCfg: (cfg: any) => void;
+    setCardConfig: (config: CardConfig | undefined) => void;
     setShowFilters: (showFilters: boolean) => void;
     setApplyFilters: (applyFilters: boolean) => void;
     setFilterValues: (filterValues: TFilterValue[]) => void;
@@ -186,7 +187,7 @@ declare type Actions_2 = TableActions & {
 
 export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
 
-export declare type AggregateFunction = 'SUM' | 'AVG' | 'COUNT' | 'MAX' | 'MIN' | 'DISTINCT';
+export declare type AggregateFunction = 'COUNT' | 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'DISTINCT';
 
 export declare type AIScopeTable = {
     connectionId: string;
@@ -233,6 +234,15 @@ export declare type CacheConfig = {
     status: 'on' | 'on-refresh' | 'off';
 };
 
+export declare interface CardConfig {
+    groupByColumns?: GroupByField[];
+    metricColumns?: MetricField[];
+    pivotByColumns?: PivotByField[];
+    sortByColumns?: SortByField[];
+    filters?: FilterGroup;
+    joinPlan?: JoinPlan;
+}
+
 declare type CardWithContent = BaseCustomCard & {
     content: React.FC<{
         card: TCard;
@@ -313,6 +323,10 @@ export declare type ConnectionPolicy = {
     params: Params;
 };
 
+export declare type ConnectionType = 'GoogleSheets' | 'MySQL' | 'MSSQL' | 'PostgreSQL' | 'BigQuery' | 'Redshift' | 'Snowflake' | 'S3' | 'clickhouse' | 'S3Tables' | 'API' | 'none';
+
+export declare type ContainerId = 'groupBy' | 'metrics' | 'pivotBy' | 'sortBy' | 'source';
+
 export declare function createSqlGenConfig(column: TDataColumn, preSqlGen: SqlGen, calc?: AggregateCalc): SqlGen;
 
 export declare type CustomCard = CardWithContent | CardWithFooter;
@@ -396,8 +410,58 @@ export declare type DashboardStore = {
 
 export declare const DashboardWC: CustomElementConstructor;
 
+export declare interface DatabaseEntityReference {
+    connectionId: string;
+    connectionType: ConnectionType;
+    type: EntityType;
+    dialect?: Dialect;
+    database?: string;
+    schema?: string;
+    name: string;
+}
+
+export declare type DatabaseEntityType = 'table' | 'view';
+
 export declare type DatabaseItem = DropdownItem;
 
+export declare interface DataModelEntityReference extends DatabaseEntityReference {
+    type: 'model';
+    id: string;
+    label: string;
+    description: string;
+}
+
+export declare interface DatasetEntityReference extends DatabaseEntityReference {
+    type: 'dataset';
+    id: string;
+    label: string;
+    description: string;
+}
+
+export declare interface DataSource {
+    connectionId: string;
+    semanticModelId?: string;
+    connectionType: string;
+    mode: 'database' | 'upload' | 'url' | 'semanticModel';
+    dbSelection?: {
+        database: string;
+        schema: string;
+        entityType: DatabaseEntityType;
+    };
+    selectedEntities?: SelectedEntities;
+}
+
+export declare type DataType = 'string' | 'number' | 'date' | 'datetime' | 'boolean' | 'json' | 'geo';
+
+export declare const DATE_FORMAT_VALUES: readonly ["YYYY-MM-DD", "MM/DD/YYYY", "DD/MM/YYYY", "MMMM DD, YYYY", "MMM DD, YYYY", "DD MMM YYYY", "YYYY-MM", "MMMM YYYY", "custom"];
+
+export declare type DateFormatOption = {
+    value: DateFormatValue;
+    label: string;
+};
+
+export declare type DateFormatValue = (typeof DATE_FORMAT_VALUES)[number];
+
 export declare type DateOptions = {
     locale: string;
     format: string;
@@ -406,6 +470,8 @@ export declare type DateOptions = {
 
 export { DateRange }
 
+export declare type Dialect = 'mysql' | 'postgresql' | 'bigquery' | 'redshift' | 'snowflake' | 'clickhouse' | 'duckdb';
+
 export declare type DisplayDataType = 'string' | 'date' | 'number' | 'html' | 'none';
 
 export declare function downloadPdf(): Promise<void>;
@@ -464,10 +530,62 @@ export declare type EmailSettings = {
 
 export declare const EMPTY_SELECTION: SelectionState;
 
+export declare type EntityColumnGroup = {
+    entityId: string;
+    entityType: EntityType;
+    entityName: string;
+    qualifiedEntityName: string;
+    label?: string;
+    description?: string;
+    columns: Field[];
+};
+
+export declare type EntityType = 'table' | 'view' | 'model' | 'file' | 'dataset' | 'url' | 'upload';
+
 export declare type ErrorProps = {
     message?: string;
 };
 
+declare interface ExplorerActions {
+    updateFrame: (updates: Partial<TFrame>) => void;
+    setActiveCardInFrame: (cardId: string) => void;
+    addCard: () => void;
+    removeCard: (cardId: string) => void;
+    updateCard: (cardId: string, updates: Partial<TCard>) => void;
+    setActiveCard: (cardId: string) => void;
+    setActiveTabCard: (cardId: string | null) => void;
+    updateDataSource: (dataSource: DataSource) => void;
+    updateSemanticModel: (semanticModelId: string) => void;
+    updateDirectSource: (updates: Partial<DataSource>) => void;
+    getAvailableFields: () => Array<{
+        id: string;
+        name: string;
+        label: string;
+        dataType: string;
+        icon: any;
+        qualifiedEntityName?: string;
+    }>;
+    updateCardConfig: (cardId: string, config: Partial<CardConfig>) => void;
+    addGroupByColumn: (cardId: string, column: GroupByField) => void;
+    removeGroupByColumn: (cardId: string, columnId: string) => void;
+    updateGroupByColumn: (cardId: string, columnId: string, updates: Partial<GroupByField>) => void;
+    addMetricColumn: (cardId: string, column: MetricField) => void;
+    removeMetricColumn: (cardId: string, columnId: string) => void;
+    updateMetricColumn: (cardId: string, columnId: string, updates: Partial<MetricField>) => void;
+    addPivotByColumn: (cardId: string, column: PivotByField) => void;
+    removePivotByColumn: (cardId: string, columnId: string) => void;
+    updatePivotByColumn: (cardId: string, columnId: string, updates: Partial<PivotByField>) => void;
+    addSortByColumn: (cardId: string, column: SortByField) => void;
+    removeSortByColumn: (cardId: string, columnId: string) => void;
+    updateSortByColumn: (cardId: string, columnId: string, updates: Partial<SortByField>) => void;
+    updateFilters: (cardId: string, filters: FilterGroup) => void;
+    clearFilters: (cardId: string) => void;
+    addJoin: (cardId: string, join: Join) => void;
+    removeJoin: (cardId: string, joinId: string) => void;
+    updateJoin: (cardId: string, joinId: string, updates: Partial<Join>) => void;
+    reorderJoins: (cardId: string, joinIds: string[]) => void;
+}
+
 export declare type ExportDataPayload = {
     cardId: string;
     title: string;
@@ -475,6 +593,32 @@ export declare type ExportDataPayload = {
     sql: string;
 };
 
+export declare interface Field {
+    id: string;
+    name: string;
+    dataType: string;
+    label: string;
+    description?: string;
+    qualifiedEntityName?: string;
+    dateFormat?: DateFormatValue;
+    customFormat?: string;
+    granularity?: TimeGranularity;
+    entityId: string;
+    entityName: string;
+    entityType: EntityType;
+    role?: 'groupby' | 'metric' | 'sortby' | 'pivotby';
+}
+
+export declare interface FileEntityReference extends DatabaseEntityReference {
+    id: string;
+    type: 'file' | 'url' | 'upload';
+    label: string;
+    description: string;
+    originalName: string;
+    file?: File;
+    url?: string;
+}
+
 export declare interface FilterByColumn extends BaseColumn {
     role: 'filter';
     operators?: string[];
@@ -486,6 +630,13 @@ export declare interface FilterByColumn extends BaseColumn {
     staticValues?: string[];
 }
 
+export declare interface FilterCondition {
+    id: string;
+    field: Field;
+    operator: Operator;
+    value: FilterValue;
+}
+
 declare type FilterForBetween = BaseFilter & {
     operation: 'between' | 'not between';
     values: [number, number];
@@ -516,6 +667,14 @@ declare type FilterForString = BaseFilter & {
     values: [string];
 };
 
+export declare interface FilterGroup {
+    id: string;
+    logicalOperator: LogicalOperator;
+    negate: boolean;
+    conditions: FilterCondition[];
+    groups: FilterGroup[];
+}
+
 declare type FilterLocation = 'dashboard' | 'frame' | undefined;
 
 declare type FilterOnClick = {
@@ -523,7 +682,7 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
-export declare type FilterValue = string | number | null | (string | number)[] | RangeValue;
+export declare type FilterValue = string | number | boolean | Date | [number, number] | [string, string] | string[] | number[];
 
 export declare function fmt(str: string): string;
 
@@ -599,6 +758,11 @@ export declare interface GroupByColumn extends BaseColumn {
     format?: string;
 }
 
+export declare interface GroupByField extends Field {
+    role: 'groupby';
+    granularity?: 'day' | 'week' | 'month' | 'quarter' | 'year';
+}
+
 export declare type HtmlOptions = {
     html: string;
 };
@@ -615,6 +779,33 @@ export declare function isNumberDataType(dataType: string): boolean;
 
 export declare function isTextDataType(dataType: string): boolean;
 
+export declare interface Join {
+    id: string;
+    source: DatabaseEntityReference;
+    target: DatabaseEntityReference;
+    joinType: 'INNER' | 'LEFT' | 'RIGHT' | 'FULL';
+    joinKeyGroups: JoinKeyGroup[];
+    sequence: number;
+}
+
+export declare interface JoinKey {
+    id?: string;
+    source: Field;
+    target: Field;
+    operator: string;
+}
+
+export declare interface JoinKeyGroup {
+    id: string;
+    operator: string;
+    keys: JoinKey[];
+}
+
+export declare interface JoinPlan {
+    baseEntity: DatabaseEntityReference;
+    joins: Join[];
+}
+
 export declare type KPICardProps = {
     card: TCard;
     isLoading?: boolean;
@@ -627,12 +818,21 @@ export declare type LoadingProps = {
     message?: string;
 };
 
+export declare type LogicalOperator = 'AND' | 'OR';
+
 export declare interface MetricColumn extends BaseColumn {
     role: 'metric';
     aggregate: AggregateFunction;
     aliasTemplate?: string;
 }
 
+export declare interface MetricField extends Field {
+    role: 'metric';
+    aggregate: AggregateFunction;
+    aliasTemplate?: string;
+    valueAliases?: Record<string, string>;
+}
+
 export declare type ModelItem = DropdownItem;
 
 declare type NoneOptions = {};
@@ -651,8 +851,12 @@ export declare type NumberOptions = {
     colorRanges?: ColorRange[];
 };
 
+export declare type OldFilterValue = string | number | null | (string | number)[] | RangeValue;
+
 declare type Operation = '=' | '>' | '<' | '>=' | '<=' | '!=' | 'in' | 'not in' | 'like' | 'not like' | 'between' | 'not between' | 'is null' | 'is not null';
 
+export declare type Operator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'contains' | 'startsWith' | 'endsWith' | 'in' | 'not in';
+
 declare type OptionsMap = {
     number: NumberOptions;
     string: StringOptions;
@@ -670,6 +874,10 @@ declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
 
+export declare interface PivotByField extends Field {
+    role: 'pivotby';
+}
+
 export declare type Placeholders = {
     /**
      * Placeholder for the card when there are no records to display.
@@ -695,7 +903,7 @@ export declare interface QueryConfig {
 
 export declare type QueryFilter = {
     filterColumnName: string;
-    filterValue: FilterValue;
+    filterValue: OldFilterValue;
 };
 
 export declare type RangeValue = {
@@ -717,6 +925,8 @@ export declare type SchemaItem = DropdownItem;
 
 export declare function SelectComponent({ title, items, value, isLoading, isError, refetch, onChange, showNone, className, disabled, type, }: SelectProps): JSX_2.Element;
 
+export declare type SelectedEntities = DatabaseEntityReference[] | DataModelEntityReference[] | FileEntityReference[];
+
 export declare type SelectionState = Record<Level, string | null>;
 
 declare type SelectProps = {
@@ -744,6 +954,13 @@ declare function SemaphorQueryClient({ children, }: {
 export { SemaphorQueryClient as SemaphorDataProvider }
 export { SemaphorQueryClient }
 
+export declare interface SortByField extends Field {
+    role: 'sortby';
+    direction: 'asc' | 'desc';
+}
+
+export declare type SortDirection = 'asc' | 'desc';
+
 export declare type SqlGen = {
     measures?: {
         name: string;
@@ -847,6 +1064,8 @@ export declare type TCard = {
     type: TChartType;
     sql?: string;
     python?: string;
+    dataSource?: DataSource;
+    config?: CardConfig;
     queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
@@ -990,6 +1209,8 @@ export declare type TDataColumn = {
     column_name: string;
     data_type: string;
     is_nullable?: string;
+    label?: string;
+    description?: string;
 };
 
 export declare type TDatasetOptions = {
@@ -1043,6 +1264,8 @@ export declare type TFrame = {
 
 export declare type Theme = 'dark' | 'light' | 'system';
 
+export declare type TimeGranularity = 'day' | 'week' | 'month' | 'quarter' | 'year';
+
 export declare type TLegendOptions = {
     display?: boolean;
     position?: 'top' | 'left' | 'bottom' | 'right';
@@ -1097,6 +1320,14 @@ export declare const useDashboardStore: UseBoundStore<Omit<StoreApi<DashboardSto
 setState(nextStateOrUpdater: DashboardStore | Partial<DashboardStore> | ((state: WritableDraft<DashboardStore>) => void), shouldReplace?: boolean | undefined): void;
 }>;
 
+export declare function useDataColumns(token?: AuthToken): {
+    columns: TDataColumn[];
+    isColumnsLoading: boolean;
+    isColumnsFetching: boolean;
+    isColumnsError: boolean;
+    refetchColumns: (options?: RefetchOptions) => Promise<QueryObserverResult<any, Error>>;
+};
+
 export declare function useDateFilterHook(filterId: string): {
     records: any;
     isLoading: boolean;