react-semaphor 0.0.490 → 0.0.492

package/dist/types/surfboard.d.ts

@@ -3,7 +3,7 @@ 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';
+declare type AggregateFunction = 'COUNT' | 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'DISTINCT';
 
 export declare type AIScopeTable = {
     connectionId: string;
@@ -50,6 +50,15 @@ export declare type CacheConfig = {
     status: 'on' | 'on-refresh' | 'off';
 };
 
+declare interface CardConfig {
+    groupByColumns?: GroupByField[];
+    metricColumns?: MetricField[];
+    pivotByColumns?: PivotByField[];
+    sortByColumns?: SortByField[];
+    filters?: FilterGroup;
+    joinPlan?: JoinPlan;
+}
+
 declare type CardWithContent = BaseCustomCard & {
     content: React.FC<{
         card: TCard;
@@ -116,6 +125,8 @@ export declare type ConnectionPolicy = {
     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 = {
@@ -162,12 +173,50 @@ 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;
+    semanticModelId?: string;
+    connectionType: string;
+    mode: 'database' | 'upload' | 'url' | 'semanticModel';
+    dbSelection?: {
+        database: string;
+        schema: string;
+        entityType: DatabaseEntityType;
+    };
+    selectedEntities?: SelectedEntities;
+}
+
+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"];
+
+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';
 
 export declare type DroppableId = 'droppable-group-by' | 'droppable-metric';
@@ -181,6 +230,8 @@ export declare type EmailSettings = {
 
 export declare const EMPTY_SELECTION: SelectionState;
 
+declare type EntityType = 'table' | 'view' | 'model' | 'file' | 'dataset' | 'url' | 'upload';
+
 export declare type ErrorProps = {
     message?: string;
 };
@@ -192,6 +243,32 @@ export declare type ExportDataPayload = {
     sql: string;
 };
 
+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';
+}
+
+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[];
@@ -203,6 +280,13 @@ declare interface FilterByColumn extends BaseColumn {
     staticValues?: string[];
 }
 
+declare interface FilterCondition {
+    id: string;
+    field: Field;
+    operator: Operator;
+    value: FilterValue;
+}
+
 declare type FilterForBetween = BaseFilter & {
     operation: 'between' | 'not between';
     values: [number, number];
@@ -233,6 +317,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 = {
@@ -240,7 +332,7 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
-declare type FilterValue = string | number | null | (string | number)[] | RangeValue;
+declare type FilterValue = string | number | boolean | Date | [number, number] | [string, string] | string[] | number[];
 
 export declare type GetDashboardResponse = {
     dashboard: TDashboard;
@@ -264,10 +356,42 @@ declare interface GroupByColumn extends BaseColumn {
     format?: string;
 }
 
+declare interface GroupByField extends Field {
+    role: 'groupby';
+    granularity?: 'day' | 'week' | 'month' | 'quarter' | 'year';
+}
+
 export declare type HtmlOptions = {
     html: 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;
@@ -280,12 +404,21 @@ 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;
+    aliasTemplate?: string;
+    valueAliases?: Record<string, string>;
+}
+
 declare type NoneOptions = {};
 
 export declare type NumberAxisFormat = {
@@ -302,8 +435,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';
+
 declare type OptionsMap = {
     number: NumberOptions;
     string: StringOptions;
@@ -321,6 +458,10 @@ 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.
@@ -344,7 +485,7 @@ declare interface QueryConfig {
 
 declare type QueryFilter = {
     filterColumnName: string;
-    filterValue: FilterValue;
+    filterValue: OldFilterValue;
 };
 
 declare type RangeValue = {
@@ -354,8 +495,15 @@ declare type RangeValue = {
     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;
@@ -439,6 +587,8 @@ export declare type TCard = {
     type: TChartType;
     sql?: string;
     python?: string;
+    dataSource?: DataSource;
+    config?: CardConfig;
     queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
@@ -580,6 +730,8 @@ export declare type TDataColumn = {
     column_name: string;
     data_type: string;
     is_nullable?: string;
+    label?: string;
+    description?: string;
 };
 
 export declare type TDatasetOptions = {
@@ -633,6 +785,8 @@ export declare type TFrame = {
 
 export declare type Theme = 'dark' | 'light' | 'system';
 
+declare type TimeGranularity = 'day' | 'week' | 'month' | 'quarter' | 'year';
+
 export declare type TLegendOptions = {
     display?: boolean;
     position?: 'top' | 'left' | 'bottom' | 'right';

package/dist/types/types.d.ts

@@ -2,7 +2,7 @@ import { FontSpec } from 'chart.js';
 
 export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
 
-declare type AggregateFunction = 'SUM' | 'AVG' | 'COUNT' | 'MAX' | 'MIN' | 'DISTINCT';
+declare type AggregateFunction = 'COUNT' | 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'DISTINCT';
 
 export declare type AIScopeTable = {
     connectionId: string;
@@ -49,6 +49,15 @@ export declare type CacheConfig = {
     status: 'on' | 'on-refresh' | 'off';
 };
 
+declare interface CardConfig {
+    groupByColumns?: GroupByField[];
+    metricColumns?: MetricField[];
+    pivotByColumns?: PivotByField[];
+    sortByColumns?: SortByField[];
+    filters?: FilterGroup;
+    joinPlan?: JoinPlan;
+}
+
 declare type CardWithContent = BaseCustomCard & {
     content: React.FC<{
         card: TCard;
@@ -115,6 +124,8 @@ export declare type ConnectionPolicy = {
     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 = {
@@ -156,12 +167,50 @@ 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;
+    semanticModelId?: string;
+    connectionType: string;
+    mode: 'database' | 'upload' | 'url' | 'semanticModel';
+    dbSelection?: {
+        database: string;
+        schema: string;
+        entityType: DatabaseEntityType;
+    };
+    selectedEntities?: SelectedEntities;
+}
+
+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"];
+
+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';
 
 export declare type DroppableId = 'droppable-group-by' | 'droppable-metric';
@@ -175,6 +224,8 @@ export declare type EmailSettings = {
 
 export declare const EMPTY_SELECTION: SelectionState;
 
+declare type EntityType = 'table' | 'view' | 'model' | 'file' | 'dataset' | 'url' | 'upload';
+
 export declare type ErrorProps = {
     message?: string;
 };
@@ -186,6 +237,32 @@ export declare type ExportDataPayload = {
     sql: string;
 };
 
+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';
+}
+
+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[];
@@ -197,6 +274,13 @@ declare interface FilterByColumn extends BaseColumn {
     staticValues?: string[];
 }
 
+declare interface FilterCondition {
+    id: string;
+    field: Field;
+    operator: Operator;
+    value: FilterValue;
+}
+
 declare type FilterForBetween = BaseFilter & {
     operation: 'between' | 'not between';
     values: [number, number];
@@ -227,6 +311,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 = {
@@ -234,7 +326,7 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
-declare type FilterValue = string | number | null | (string | number)[] | RangeValue;
+declare type FilterValue = string | number | boolean | Date | [number, number] | [string, string] | string[] | number[];
 
 export declare type GetDashboardResponse = {
     dashboard: TDashboard;
@@ -258,10 +350,42 @@ declare interface GroupByColumn extends BaseColumn {
     format?: string;
 }
 
+declare interface GroupByField extends Field {
+    role: 'groupby';
+    granularity?: 'day' | 'week' | 'month' | 'quarter' | 'year';
+}
+
 export declare type HtmlOptions = {
     html: 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;
@@ -274,12 +398,21 @@ 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;
+    aliasTemplate?: string;
+    valueAliases?: Record<string, string>;
+}
+
 declare type NoneOptions = {};
 
 export declare type NumberAxisFormat = {
@@ -296,8 +429,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';
+
 declare type OptionsMap = {
     number: NumberOptions;
     string: StringOptions;
@@ -315,6 +452,10 @@ 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.
@@ -338,7 +479,7 @@ declare interface QueryConfig {
 
 declare type QueryFilter = {
     filterColumnName: string;
-    filterValue: FilterValue;
+    filterValue: OldFilterValue;
 };
 
 declare type RangeValue = {
@@ -348,8 +489,15 @@ declare type RangeValue = {
     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;
@@ -431,6 +579,8 @@ export declare type TCard = {
     type: TChartType;
     sql?: string;
     python?: string;
+    dataSource?: DataSource;
+    config?: CardConfig;
     queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
@@ -572,6 +722,8 @@ export declare type TDataColumn = {
     column_name: string;
     data_type: string;
     is_nullable?: string;
+    label?: string;
+    description?: string;
 };
 
 export declare type TDatasetOptions = {
@@ -625,6 +777,8 @@ export declare type TFrame = {
 
 export declare type Theme = 'dark' | 'light' | 'system';
 
+declare type TimeGranularity = 'day' | 'week' | 'month' | 'quarter' | 'year';
+
 export declare type TLegendOptions = {
     display?: boolean;
     position?: 'top' | 'left' | 'bottom' | 'right';

package/package.json

@@ -5,7 +5,7 @@
     "email": "support@semaphor.cloud"
   },
   "license": "MIT",
-  "version": "0.0.490",
+  "version": "0.0.492",
   "description": "Fully interactive and customizable dashboards for your apps.",
   "keywords": [
     "react",