semaphor 0.0.94 → 0.0.96

package/dist/types/types.d.ts

@@ -2,6 +2,8 @@ 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';
+
 export declare type AIScopeTable = {
     connectionId: string;
     connectionType: string;
@@ -17,6 +19,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;
@@ -61,6 +71,8 @@ export declare type ColorRange = {
     color: string;
 };
 
+declare type ColumnType = 'string' | 'number' | 'date';
+
 export declare type ConnectionPolicy = {
     connectionId?: string;
     name: string;
@@ -111,6 +123,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;
@@ -118,10 +132,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];
@@ -159,6 +185,8 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
+declare type FilterValue = string | number | null | (string | number)[] | RangeValue;
+
 export declare type GetDashboardResponse = {
     dashboard: TDashboard;
     lenses: TLens[];
@@ -173,6 +201,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;
 };
@@ -183,10 +219,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 = {
@@ -213,6 +257,11 @@ declare type OptionsMap = {
     none: NoneOptions;
 };
 
+declare interface OrderBy {
+    columnId: string;
+    direction: 'asc' | 'desc';
+}
+
 declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
@@ -228,6 +277,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;
@@ -302,6 +374,7 @@ export declare type TCard = {
     type: TChartType;
     sql?: string;
     python?: string;
+    queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
     customCardPreferences?: TCustomCardPreferences;
@@ -352,6 +425,9 @@ export declare type TCardPreferences = {
         projectionOffset?: [number, number];
         colorScale?: string;
     };
+    kpiVisualOptions?: {
+        lowerIsBetter?: boolean;
+    };
 };
 
 export declare type TChartOptions = {
@@ -389,7 +465,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;
@@ -431,6 +507,7 @@ export declare type TDashboard = {
     globalStyle?: TStyle;
     globalCacheConfig?: CacheConfig;
     emailSettings?: EmailSettings;
+    defaultFilterValues?: TFilterValue[];
 };
 
 export declare type TDataColumn = {
@@ -452,6 +529,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;

package/package.json

@@ -5,7 +5,7 @@
     "email": "support@semaphor.cloud"
   },
   "license": "MIT",
-  "version": "0.0.94",
+  "version": "0.0.96",
   "description": "Fully interactive and customizable dashboards for your apps.",
   "keywords": [
     "react",
@@ -15,7 +15,8 @@
   ],
   "type": "module",
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -46,6 +47,9 @@
   },
   "dependencies": {
     "@ai-sdk/react": "^1.1.18",
+    "@dnd-kit/core": "^6.3.1",
+    "@dnd-kit/sortable": "^10.0.0",
+    "@dnd-kit/utilities": "^3.2.2",
     "@headlessui/react": "^2.2.0",
     "@monaco-editor/react": "^4.7.0-rc.0",
     "@r2wc/react-to-web-component": "^2.0.4",
@@ -73,6 +77,7 @@
     "@tanstack/react-table": "^8.11.7",
     "ai": "^4.1.46",
     "chart.js": "^4.4.1",
+    "chartjs-chart-funnel": "^4.2.4",
     "chartjs-chart-geo": "^4.3.4",
     "chartjs-plugin-datalabels": "^2.2.0",
     "class-variance-authority": "^0.7.0",
@@ -104,7 +109,7 @@
     "react-dom": "^18.0.0 || ^19.0.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.49.1",
+    "@microsoft/api-extractor": "^7.52.1",
     "@tanstack/react-query-devtools": "^5.62.15",
     "@types/chart.js": "^2.9.41",
     "@types/dompurify": "^3.0.5",