react-semaphor 0.0.3931 → 0.0.5321

package/dist/types/surfboard.d.ts

@@ -3,6 +3,12 @@ import { JSX as JSX_2 } from 'react/jsx-runtime';
 
 export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
 
+declare type AggregateFunction = 'COUNT' | 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'DISTINCT';
+
+declare type AIContext = {
+    selectedEntities: SelectedEntities;
+};
+
 export declare type AIScopeTable = {
     connectionId: string;
     connectionType: string;
@@ -13,11 +19,21 @@ export declare type AIScopeTable = {
     datamodelName: string;
 };
 
+export declare type AssistantId = 'dashboard-assistant' | 'editor-assistant';
+
 export declare type AuthToken = {
     accessToken: string;
     refreshToken?: string;
 };
 
+declare interface BaseColumn {
+    id: string;
+    name: string;
+    label?: string;
+    type: ColumnType;
+    table?: string;
+}
+
 declare type BaseCustomCard = {
     cardId: string;
     replaceDefault?: boolean;
@@ -38,6 +54,49 @@ export declare type CacheConfig = {
     status: 'on' | 'on-refresh' | 'off';
 };
 
+declare interface CardConfig {
+    groupByColumns?: GroupByField[];
+    metricColumns?: MetricField[];
+    pivotByColumns?: PivotByField[];
+    sortByColumns?: SortByField[];
+    filters?: FilterGroup;
+    joinPlan?: JoinPlan;
+    rowLimit?: number;
+    /**
+     * One or more hierarchies that define drillable paths through dimensions.
+     */
+    drillHierarchies?: DrillHierarchy[];
+    /**
+     * Optional list of dimensions allowed for dynamic drill-down across this card.
+     * Used only when drill steps contain `mode: 'dynamicDrill'` or `type: 'dynamic'`.
+     */
+    allowedDrillTargets?: Field[];
+    /**
+     * NOT UOptional preload settings for inline drill previews
+     */
+    inlineDrillPreview?: {
+        enabled: boolean;
+        limit: number;
+        mode: 'lazy' | 'preloaded';
+    };
+    /**
+     * Configuration for on-click dashboard filters triggered by this card.
+     */
+    clickFilterInteractions?: ClickFilterInteraction[];
+    comparisonType?: 'none' | 'previous_period' | 'same_period_last_year' | 'target';
+    targetValue?: number;
+    showTrendline?: boolean;
+    trendlineWindow?: number;
+    trendlineGranularity?: 'day' | 'week' | 'month';
+}
+
+declare interface CardInteractionConfig {
+    allowedDrillTargets?: Field[];
+    drillHierarchies?: DrillHierarchy[];
+    drillInteractions?: DrillInteraction[];
+    clickFilterInteractions?: ClickFilterInteraction[];
+}
+
 declare type CardWithContent = BaseCustomCard & {
     content: React.FC<{
         card: TCard;
@@ -56,20 +115,89 @@ declare type CardWithFooter = BaseCustomCard & {
     }>;
 };
 
+declare interface ClickFilterInteraction {
+    mode: 'clickFilter';
+    /**
+     * Fields from the chart element that should be used as filters.
+     * e.g., [region, ship_mode] from a stacked bar chart
+     */
+    filterFields: Field[];
+    /**
+     * Should this card visually highlight when clicked?
+     */
+    highlightSelf?: boolean;
+    /**
+     * Cards this filter applies to (inclusive).
+     * If omitted and `excludeCardIds` is also omitted → applies to all cards except self.
+     */
+    applyToCardIds?: string[];
+    /**
+     * Cards to explicitly exclude from receiving this filter.
+     * Takes effect only if `applyToCardIds` is undefined (acts as override).
+     */
+    excludeCardIds?: string[];
+    /**
+     * Optional UI label or tooltip.
+     */
+    label?: string;
+}
+
 export declare type ColorRange = {
     start: number;
     end: number;
     color: string;
 };
 
+declare interface ColorRange_2 {
+    min: number;
+    max: number;
+    color: string;
+    applyTo: 'cell' | 'row';
+}
+
+declare interface ColumnSettings {
+    type: 'none' | 'text' | 'number' | 'date' | 'badge' | 'link' | 'progress';
+    textAlign: 'left' | 'center' | 'right';
+    width: string;
+    textWrap: 'wrap' | 'nowrap';
+    numberFormat: {
+        style: 'decimal' | 'currency' | 'percent';
+        currency: string;
+        locale: string;
+        minimumFractionDigits: number;
+        maximumFractionDigits: number;
+        showDataBar: boolean;
+        dataBarColor: string;
+        dataBarMinValue?: number;
+        dataBarMaxValue?: number;
+    };
+    dateFormat: {
+        format: string;
+        useCustomFormat: boolean;
+        customFormat: string;
+        useRelativeTime: boolean;
+    };
+    colorRanges: ColorRange_2[];
+}
+
+declare type ColumnSettingsMap = Record<string, ColumnSettings>;
+
+declare type ColumnType = 'string' | 'number' | 'date';
+
 export declare type ConnectionPolicy = {
     connectionId?: string;
     name: string;
     params: Params;
 };
 
+declare type ConnectionType = 'GoogleSheets' | 'MySQL' | 'MSSQL' | 'PostgreSQL' | 'BigQuery' | 'Redshift' | 'Snowflake' | 'S3' | 'clickhouse' | 'S3Tables' | 'API' | 'none';
+
 export declare type CustomCard = CardWithContent | CardWithFooter;
 
+export declare type DashboardEventHandlers = {
+    onExportData?: (payload: ExportDataPayload) => void;
+};
+
 declare type DashboardPlusProps = {
     showControls?: boolean;
     showFooter?: boolean;
@@ -99,6 +227,7 @@ export declare type DashboardProps = {
     onFilterValuesChange?: (filterValues: TFilterValue[]) => void;
     LoadingComponent?: (props: LoadingProps) => React.ReactNode;
     ErrorComponent?: (props: ErrorProps) => React.ReactNode;
+    eventHandlers?: DashboardEventHandlers;
     /**
      * Placeholders for the dashboard.
      */
@@ -109,18 +238,181 @@ export declare type DashboardProps = {
     selectedSheetId?: string;
 };
 
+declare interface DatabaseEntityReference {
+    connectionId: string;
+    connectionType: ConnectionType;
+    type: EntityType;
+    dialect?: Dialect;
+    database?: string;
+    schema?: string;
+    name: string;
+}
+
+declare type DatabaseEntityType = 'table' | 'view';
+
+declare interface DataModelEntityReference extends DatabaseEntityReference {
+    type: 'model';
+    id: string;
+    label: string;
+    description: string;
+}
+
+declare interface DataSource {
+    connectionId: string;
+    semanticDomainId?: string;
+    connectionType: string;
+    mode: 'database' | 'upload' | 'url' | 'semanticDomain';
+    dbSelection?: {
+        database: string;
+        schema: string;
+        entityType: DatabaseEntityType;
+    };
+    selectedEntities: SelectedEntities;
+}
+
+declare const DATE_FORMAT_VALUES: readonly ["MM-DD-YYYY", "YYYY-MM-DD", "MM/DD/YYYY", "DD/MM/YYYY", "MMMM DD, YYYY", "MMM DD, YYYY", "DD MMM YYYY", "YYYY-MM", "MMMM YYYY", "custom"];
+
+declare type DateFormatValue = (typeof DATE_FORMAT_VALUES)[number];
+
 export declare type DateOptions = {
     locale: string;
     format: string;
     options: Intl.DateTimeFormatOptions;
 };
 
+declare type Dialect = 'mysql' | 'postgresql' | 'bigquery' | 'redshift' | 'snowflake' | 'clickhouse' | 'duckdb';
+
 export declare type DisplayDataType = 'string' | 'date' | 'number' | 'html' | 'none';
 
+declare interface DrillHierarchy {
+    id: string;
+    label?: string;
+    type: 'static';
+    steps: DrillHierarchyStep[];
+    default?: boolean;
+}
+
+declare interface DrillHierarchyStep {
+    field: Field;
+    mode: 'drillDown';
+    preferredChartType?: TChartType;
+    breadcrumbLabelTemplate?: string;
+    retainFilters?: boolean;
+    label?: string;
+    linkedInsightId?: string;
+}
+
+declare type DrillInteraction = DrillThroughInteraction | DrillToDetailInteraction | DrillToURLInteraction | InlineDrillInteraction;
+
+declare interface DrillThroughInteraction {
+    mode: 'drillThrough';
+    filterFields: Field[];
+    targetSheetId: string;
+    label?: string;
+}
+
+declare interface DrillToDetailInteraction {
+    mode: 'drillToDetail';
+    filterFields: Field[];
+    detailFields?: Field[];
+    sortBy?: SortByField[];
+    limit?: number;
+    detailTitle?: string;
+    label?: string;
+}
+
+declare interface DrillToURLInteraction {
+    mode: 'drillToURL';
+    filterFields: Field[];
+    urlTemplate: string;
+    label?: string;
+}
+
+export declare type DroppableId = 'droppable-group-by' | 'droppable-metric';
+
+export declare type EmailSettings = {
+    companyName: string;
+    dashboardUrl: string;
+    supportEmail: string;
+    senderTitle: string;
+};
+
+export declare const EMPTY_SELECTION: SelectionState;
+
+declare type EntityType = 'table' | 'view' | 'model' | 'file' | 'dataset' | 'url' | 'upload';
+
 export declare type ErrorProps = {
     message?: string;
 };
 
+export declare type ExportDataPayload = {
+    cardId: string;
+    title: string;
+    data: Record<string, any>[];
+    sql: string;
+};
+
+declare interface Field {
+    /**
+     * Unique identifier for this field instance (for joins, UI state, etc.).
+     * Should be unique within the context of the query or data model.
+     * Example: 'orders.customer_id', 'expr_12345', etc.
+     */
+    id: string;
+    /**
+     * The physical/source column name in the database or data source.
+     * Used for mapping to the underlying data model and SQL generation (unless overridden by expression).
+     */
+    name: string;
+    /**
+     * Human-friendly, localizable display name for the UI (table headers, chart axes, etc.).
+     */
+    label: string;
+    /**
+     * Unique, stable, machine-friendly reference name for SQL (AS alias), exports, and scripting.
+     * If not provided, should be auto-generated from label or name.
+     */
+    alias?: string;
+    dataType: string;
+    description?: string;
+    qualifiedEntityName?: string;
+    dateFormat?: DateFormatValue;
+    customFormat?: string;
+    granularity?: TimeGranularity;
+    entityId: string;
+    entityName: string;
+    entityType: EntityType;
+    role?: 'groupby' | 'metric' | 'sortby' | 'pivotby';
+}
+
+declare interface FileEntityReference extends DatabaseEntityReference {
+    id: string;
+    type: 'file' | 'url' | 'upload';
+    label: string;
+    description: string;
+    originalName: string;
+    file?: File;
+    url?: string;
+}
+
+declare interface FilterByColumn extends BaseColumn {
+    role: 'filter';
+    operators?: string[];
+    mode?: 'include' | 'exclude';
+    sql?: string;
+    fetchValues?: boolean;
+    fetchLimit?: number;
+    valueSource?: 'distinct' | 'static' | 'range';
+    staticValues?: string[];
+}
+
+declare interface FilterCondition {
+    id: string;
+    field: Field;
+    operator: Operator;
+    value: FilterValue;
+}
+
 declare type FilterForBetween = BaseFilter & {
     operation: 'between' | 'not between';
     values: [number, number];
@@ -151,6 +443,14 @@ declare type FilterForString = BaseFilter & {
     values: [string];
 };
 
+declare interface FilterGroup {
+    id: string;
+    logicalOperator: LogicalOperator;
+    negate: boolean;
+    conditions: FilterCondition[];
+    groups: FilterGroup[];
+}
+
 declare type FilterLocation = 'dashboard' | 'frame' | undefined;
 
 declare type FilterOnClick = {
@@ -158,6 +458,8 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
+declare type FilterValue = string | number | boolean | Date | [number, number] | [string, string] | string[] | number[];
+
 export declare type GetDashboardResponse = {
     dashboard: TDashboard;
     lenses: TLens[];
@@ -169,23 +471,120 @@ export declare type GetPluginsResponse = {
     plugins: {
         label: string;
         value: string;
+        type: PluginType;
     }[];
 };
 
+declare type Granularity = 'day' | 'week' | 'month' | 'year';
+
+declare interface GroupByColumn extends BaseColumn {
+    role: 'groupby';
+    granularity?: Granularity;
+    format?: string;
+}
+
+declare interface GroupByField extends Field {
+    role: 'groupby';
+    granularity?: 'day' | 'week' | 'month' | 'quarter' | 'year';
+    /**
+     * Optional SQL expression for grouping (e.g., DATE_TRUNC('month', order_date)).
+     * If present, used in SELECT and GROUP BY instead of just the column name.
+     */
+    expression?: string;
+    timeDrillPath?: TimeDrillStep[];
+}
+
 export declare type HtmlOptions = {
     html: string;
 };
 
+declare interface InlineDrillInteraction {
+    mode: 'inlineDrill';
+    filterFields: Field[];
+    fetchMode?: 'lazy' | 'preloaded';
+    inlineLimit?: number;
+    label?: string;
+}
+
+declare interface Join {
+    id: string;
+    source: DatabaseEntityReference;
+    target: DatabaseEntityReference;
+    joinType: 'INNER' | 'LEFT' | 'RIGHT' | 'FULL';
+    joinKeyGroups: JoinKeyGroup[];
+    sequence: number;
+}
+
+declare interface JoinKey {
+    id?: string;
+    source: Field;
+    target: Field;
+    operator: string;
+}
+
+declare interface JoinKeyGroup {
+    id: string;
+    operator: string;
+    keys: JoinKey[];
+}
+
+declare interface JoinPlan {
+    baseEntity: DatabaseEntityReference;
+    joins: Join[];
+}
+
 export declare type KPICardProps = {
     card: TCard;
     isLoading?: boolean;
     renderFilterInfo?: () => JSX.Element | null;
 };
 
+export declare type Level = 'database' | 'schema' | 'table';
+
 export declare type LoadingProps = {
     message?: string;
 };
 
+declare type LogicalOperator = 'AND' | 'OR';
+
+declare interface MetricColumn extends BaseColumn {
+    role: 'metric';
+    aggregate: AggregateFunction;
+    aliasTemplate?: string;
+}
+
+declare interface MetricField extends Field {
+    role: 'metric';
+    aggregate: AggregateFunction;
+    /**
+     * Optional SQL expression for the metric (e.g., ship_date - order_date).
+     * If present, used as aggregate(expression) instead of aggregate(name).
+     */
+    expression?: string;
+    /**
+     * Optional parameters for future extensibility (e.g., window functions).
+     * * Example:
+     * {
+     aggregate: "SUM",
+     name: "sales",
+     parameters: {
+     window: "PARTITION BY region ORDER BY date ROWS BETWEEN 1 PRECEDING AND CURRENT ROW"
+     }
+     }
+
+     {
+     aggregate: "COUNT",
+     name: "order_id",
+     parameters: {
+     filter: "status = 'Active'"
+     }
+     }
+     */
+    parameters?: Record<string, any>;
+    aliasTemplate?: string;
+    valueAliases?: Record<string, string>;
+}
+
 declare type NoneOptions = {};
 
 export declare type NumberAxisFormat = {
@@ -202,8 +601,12 @@ export declare type NumberOptions = {
     colorRanges?: ColorRange[];
 };
 
+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';
 
+declare type Operator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'contains' | 'startsWith' | 'endsWith' | 'in' | 'not in' | 'between';
+
 declare type OptionsMap = {
     number: NumberOptions;
     string: StringOptions;
@@ -212,10 +615,19 @@ declare type OptionsMap = {
     none: NoneOptions;
 };
 
+declare interface OrderBy {
+    columnId: string;
+    direction: 'asc' | 'desc';
+}
+
 declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
 
+declare interface PivotByField extends Field {
+    role: 'pivotby';
+}
+
 export declare type Placeholders = {
     /**
      * Placeholder for the card when there are no records to display.
@@ -227,6 +639,39 @@ export declare type Placeholders = {
     SessionExpired?: React.ReactNode;
 };
 
+export declare type PluginType = 'custom' | 'standard';
+
+declare interface QueryConfig {
+    groupByColumns?: GroupByColumn[];
+    pivotColumns?: GroupByColumn[];
+    metricColumns?: MetricColumn[];
+    filterColumns?: FilterByColumn[];
+    filters?: QueryFilter[];
+    limit?: number;
+    orderBy?: OrderBy[];
+}
+
+declare type QueryFilter = {
+    filterColumnName: string;
+    filterValue: OldFilterValue;
+};
+
+declare type RangeValue = {
+    gte?: string | number;
+    lte?: string | number;
+    lt?: string | number;
+    gt?: string | number;
+};
+
+declare type SelectedEntities = DatabaseEntityReference[] | DataModelEntityReference[] | FileEntityReference[];
+
+export declare type SelectionState = Record<Level, string | null>;
+
+declare interface SortByField extends Field {
+    role: 'sortby';
+    direction: 'asc' | 'desc';
+}
+
 export declare type SqlGen = {
     measures?: {
         name: string;
@@ -254,6 +699,14 @@ export declare type StyleProps = {
     dashboardCardContainer?: string;
     dashboardCard?: string;
     /** grid-layout config */
+    /**
+     * Border radius for the control inputs such as filter input, tabs, date picker, etc.
+     */
+    controlInputRadius?: number;
+    /**
+     * Border radius for the cards
+     */
+    cardBorderRadius?: number;
     gridLayout?: {
         /** css class for `react-grid-layout` */
         className?: string;
@@ -274,6 +727,13 @@ export declare type StyleProps = {
 
 export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element;
 
+declare type TablePreferences = {
+    columnSettingsMap?: ColumnSettingsMap;
+    selectColumnVisible?: boolean;
+    columnVisibility?: Record<string, boolean>;
+    pageSize?: number;
+};
+
 export declare type TBaseQuery = {
     id: string;
     name: string;
@@ -295,7 +755,10 @@ export declare type TCard = {
     type: TChartType;
     sql?: string;
     python?: string;
-    cfg?: any;
+    dataSource?: DataSource;
+    config?: CardConfig;
+    interactionConfig?: CardInteractionConfig;
+    queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
     customCardPreferences?: TCustomCardPreferences;
@@ -331,6 +794,7 @@ export declare type TCardPreferences = {
     datasetOptions?: TDatasetOptions[];
     chartOptions?: TChartOptions;
     columnSettings?: TColumnSetting<DisplayDataType>[];
+    tablePrefs?: TablePreferences;
     allowDownload?: boolean;
     customVisualCode?: string;
     textVisualOptions?: {
@@ -346,6 +810,10 @@ export declare type TCardPreferences = {
         projectionOffset?: [number, number];
         colorScale?: string;
     };
+    kpiVisualOptions?: {
+        lowerIsBetter?: boolean;
+        countryLogoId?: string;
+    };
 };
 
 export declare type TChartOptions = {
@@ -377,10 +845,13 @@ export declare type TChartOptions = {
     indexAxis?: 'x' | 'y' | undefined;
     plugins?: {
         legend?: TLegendOptions;
+        datalabels?: {
+            anchor?: string;
+        };
     };
 };
 
-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' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
 
 export declare type TColumnSetting<T extends DisplayDataType> = {
     columnIdx: number;
@@ -395,6 +866,7 @@ export declare type TCustomCardPreferences = {
     url: string;
     componentName: string;
     icon?: string;
+    pluginChartType?: string;
     type?: 'iframe' | 'component';
     visualType?: 'single' | 'multiple';
     settings?: any;
@@ -412,6 +884,7 @@ export declare type TCustomCardPreferences = {
 export declare type TDashboard = {
     id: string;
     title?: string;
+    aiContext?: AIContext;
     description?: string;
     sheets?: TSheet[];
     style?: TStyle;
@@ -421,12 +894,16 @@ export declare type TDashboard = {
     aiScopeTables?: AIScopeTable[];
     globalStyle?: TStyle;
     globalCacheConfig?: CacheConfig;
+    emailSettings?: EmailSettings;
+    defaultFilterValues?: TFilterValue[];
 };
 
 export declare type TDataColumn = {
     column_name: string;
     data_type: string;
     is_nullable?: string;
+    label?: string;
+    description?: string;
 };
 
 export declare type TDatasetOptions = {
@@ -442,6 +919,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;
@@ -475,6 +957,15 @@ export declare type TFrame = {
 
 export declare type Theme = 'dark' | 'light' | 'system';
 
+declare interface TimeDrillStep {
+    granularity: TimeGranularity;
+    next?: TimeGranularity;
+    comparison?: 'previous_year' | 'previous_period';
+    rollingWindow?: number;
+}
+
+declare type TimeGranularity = 'day' | 'week' | 'month' | 'quarter' | 'year';
+
 export declare type TLegendOptions = {
     display?: boolean;
     position?: 'top' | 'left' | 'bottom' | 'right';