semaphor 0.0.111 → 0.0.113

package/dist/surfboard/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../chunks/dashboard-plus-CCV5mAgn.js"),r=require("../types/index.cjs");exports.Surfboard=e.DashboardPlus;exports.EMPTY_SELECTION=r.EMPTY_SELECTION;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../chunks/dashboard-plus-jmg1QJuX.js"),r=require("../types/index.cjs");exports.Surfboard=e.DashboardPlus;exports.EMPTY_SELECTION=r.EMPTY_SELECTION;

package/dist/surfboard/index.js

@@ -1,4 +1,4 @@
-import { D as f } from "../chunks/dashboard-plus-CZggRVns.js";
+import { D as f } from "../chunks/dashboard-plus-BXuu8joa.js";
 import { EMPTY_SELECTION as a } from "../types/index.js";
 export {
   a as EMPTY_SELECTION,

package/dist/types/dashboard.d.ts

@@ -88,6 +88,16 @@ declare interface CardConfig {
     showTrendline?: boolean;
     trendlineWindow?: number;
     trendlineGranularity?: 'day' | 'week' | 'month';
+    rowAggregates?: Array<{
+        label?: string;
+        function: AggregateFunction;
+        groupLevel: string | 'ALL';
+    }>;
+    columnAggregates?: Array<{
+        label?: string;
+        function: AggregateFunction;
+        pivotLevel: string | 'ALL';
+    }>;
 }
 
 declare interface CardInteractionConfig {
@@ -194,7 +204,7 @@ declare type ConnectionType = 'GoogleSheets' | 'MySQL' | 'MSSQL' | 'PostgreSQL'
 
 export declare type CustomCard = CardWithContent | CardWithFooter;
 
-export declare function Dashboard(props: DashboardProps): JSX_2.Element;
+export declare function Dashboard(props: DashboardProps): JSX_2.Element | null;
 
 export declare type DashboardEventHandlers = {
     onExportData?: (payload: ExportDataPayload) => void;
@@ -617,6 +627,14 @@ declare interface OrderBy {
     direction: 'asc' | 'desc';
 }
 
+/**
+ * Pagination configuration for table queries
+ */
+declare interface PaginationConfig {
+    page: number;
+    pageSize: number;
+}
+
 declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
@@ -727,6 +745,7 @@ declare type TablePreferences = {
     selectColumnVisible?: boolean;
     columnVisibility?: Record<string, boolean>;
     pageSize?: number;
+    enableDevModePagination?: boolean;
 };
 
 export declare type TBaseQuery = {
@@ -753,6 +772,7 @@ export declare type TCard = {
     dataSource?: DataSource;
     config?: CardConfig;
     interactionConfig?: CardInteractionConfig;
+    paginationConfig?: PaginationConfig;
     queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
@@ -853,7 +873,7 @@ export declare type TChartOptions = {
     };
 };
 
-declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'pivotTable' | 'kpi' | 'pyramid' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'pivotTable' | 'aggregateTable' | 'kpi' | 'pyramid' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
 
 export declare type TColumnSetting<T extends DisplayDataType> = {
     columnIdx: number;

package/dist/types/main.d.ts

@@ -14,6 +14,7 @@ import { FontSpec } from 'chart.js';
 import { GroupByField as GroupByField_2 } from '../types/explorer-types';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { MetricField as MetricField_2 } from '../types/explorer-types';
+import { PaginationMetadata as PaginationMetadata_2 } from '../types/explorer-types';
 import { PivotByField as PivotByField_2 } from '../types/explorer-types';
 import { QueryObserverResult } from '@tanstack/query-core';
 import { RefetchOptions } from '@tanstack/query-core';
@@ -199,6 +200,14 @@ declare type Actions_2 = TableActions & ExplorerActions & DrillActions & {
 
 export declare type AggregateCalc = 'AVG' | 'MIN' | 'MAX' | 'SUM' | 'COUNT' | 'COUNT_DISTINCT';
 
+/**
+ * Configuration for which aggregate functions to use and at which levels (by Field.id)
+ */
+export declare interface AggregateConfig {
+    functions: AggregateFunction[];
+    levels?: string[];
+}
+
 export declare type AggregateFunction = 'COUNT' | 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'DISTINCT';
 
 declare type AIContext = {
@@ -284,6 +293,16 @@ export declare interface CardConfig {
     showTrendline?: boolean;
     trendlineWindow?: number;
     trendlineGranularity?: 'day' | 'week' | 'month';
+    rowAggregates?: Array<{
+        label?: string;
+        function: AggregateFunction;
+        groupLevel: string | 'ALL';
+    }>;
+    columnAggregates?: Array<{
+        label?: string;
+        function: AggregateFunction;
+        pivotLevel: string | 'ALL';
+    }>;
 }
 
 declare interface CardInteractionConfig {
@@ -384,6 +403,13 @@ declare interface ColumnSettings {
 
 declare type ColumnSettingsMap = Record<string, ColumnSettings>;
 
+export declare interface ColumnSubtotalMeta {
+    alias: string;
+    subtotalLevel?: string;
+    isColumnSubtotal?: boolean;
+    isColumnTotal?: boolean;
+}
+
 export declare type ColumnType = 'string' | 'number' | 'date';
 
 declare type ComboBoxOption = {
@@ -410,7 +436,7 @@ export declare function createSqlGenConfig(column: TDataColumn, preSqlGen: SqlGe
 
 export declare type CustomCard = CardWithContent | CardWithFooter;
 
-export declare function Dashboard(props: DashboardProps): JSX_2.Element;
+export declare function Dashboard(props: DashboardProps): JSX_2.Element | null;
 
 export declare type DashboardEventHandlers = {
     onExportData?: (payload: ExportDataPayload) => void;
@@ -1083,6 +1109,26 @@ export declare interface OrderBy {
     direction: 'asc' | 'desc';
 }
 
+/**
+ * Pagination configuration for table queries
+ */
+export declare interface PaginationConfig {
+    page: number;
+    pageSize: number;
+}
+
+/**
+ * Pagination metadata returned with query results
+ */
+export declare interface PaginationMetadata {
+    page: number;
+    pageSize: number;
+    pageCount: number;
+    totalCount: number;
+    hasNextPage: boolean;
+    hasPrevPage: boolean;
+}
+
 declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
@@ -1091,14 +1137,35 @@ export declare interface PivotByField extends Field {
     role: 'pivotby';
 }
 
-export declare interface PivotColumnSchema {
-    alias: string;
-    metricId: string;
-    metricName: string;
-    metricLabel?: string;
-    pivotValues: string[];
-    pivotFields: string[];
-    displayLabel?: string;
+/**
+ const config: CardConfig = {
+ groupByColumns: [
+ { id: 'region', name: 'region', label: 'Region', ... },
+ { id: 'country', name: 'country', label: 'Country', ... }
+ ],
+ pivotByColumns: [
+ { id: 'year', name: 'year', label: 'Year', ... },
+ { id: 'quarter', name: 'quarter', label: 'Quarter', ... }
+ ],
+ metricColumns: [ ... ],
+ rowAggregates: ['SUM', 'AVG'],
+ columnAggregates: ['SUM'],
+ subtotals: {
+ groupBy: { functions: ['SUM'], levels: ['region'] }, // subtotal at region level
+ pivotBy: { functions: ['SUM'], levels: ['year'] }    // subtotal at year level
+ }
+ };
+ */
+export declare enum PivotMarkerEnum {
+    SUBTOTAL = "__SUBTOTAL__",
+    TOTAL = "__TOTAL__",
+    ALL = "__ALL__"
+}
+
+export declare interface PivotRowMetadata {
+    isSubtotal?: boolean;
+    subtotalLevel?: string | null;
+    isGrandTotal?: boolean;
 }
 
 export declare type Placeholders = {
@@ -1253,7 +1320,15 @@ export declare type StyleProps = {
     };
 };
 
-export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element;
+/**
+ * Subtotal configuration for groupBy and pivotBy axes
+ */
+export declare interface SubtotalConfig {
+    groupBy?: AggregateConfig;
+    pivotBy?: AggregateConfig;
+}
+
+export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element | null;
 
 declare interface TableActions {
     updateColumnSettingsMap: (columnSettings: ColumnSettingsMap) => void;
@@ -1280,6 +1355,7 @@ declare type TablePreferences = {
     selectColumnVisible?: boolean;
     columnVisibility?: Record<string, boolean>;
     pageSize?: number;
+    enableDevModePagination?: boolean;
 };
 
 export declare type TBaseQuery = {
@@ -1306,6 +1382,7 @@ export declare type TCard = {
     dataSource?: DataSource;
     config?: CardConfig;
     interactionConfig?: CardInteractionConfig;
+    paginationConfig?: PaginationConfig;
     queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
@@ -1408,7 +1485,7 @@ export declare type TChartOptions = {
     };
 };
 
-declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'pivotTable' | 'kpi' | 'pyramid' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'pivotTable' | 'aggregateTable' | 'kpi' | 'pyramid' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
 
 export declare type TColumnSetting<T extends DisplayDataType> = {
     columnIdx: number;
@@ -1610,6 +1687,10 @@ export declare type TokenRequest = {
      * Enables self-service editing and lens creation by the end user.
      */
     allowEdit?: boolean;
+    /**
+     * Schema level security policy. The schema name for the tenant.
+     */
+    sls?: string;
     /**
      * Connection-level security policies.
      * Can be a single policy or an array of policies.
@@ -1708,6 +1789,7 @@ export declare function useCard(cardId: string): {
     handleDatapointClick: (chart: Chart, datasetIndex: number, clickIndex: number, value: number) => void;
     cfg: TChartConfiguration | undefined;
     queryKey: string[];
+    pagination: PaginationMetadata_2 | undefined;
 };
 
 export declare const useCurrentActiveCard: () => TCard | undefined;

package/dist/types/surfboard.d.ts

@@ -88,6 +88,16 @@ declare interface CardConfig {
     showTrendline?: boolean;
     trendlineWindow?: number;
     trendlineGranularity?: 'day' | 'week' | 'month';
+    rowAggregates?: Array<{
+        label?: string;
+        function: AggregateFunction;
+        groupLevel: string | 'ALL';
+    }>;
+    columnAggregates?: Array<{
+        label?: string;
+        function: AggregateFunction;
+        pivotLevel: string | 'ALL';
+    }>;
 }
 
 declare interface CardInteractionConfig {
@@ -620,6 +630,14 @@ declare interface OrderBy {
     direction: 'asc' | 'desc';
 }
 
+/**
+ * Pagination configuration for table queries
+ */
+declare interface PaginationConfig {
+    page: number;
+    pageSize: number;
+}
+
 declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
@@ -725,13 +743,14 @@ export declare type StyleProps = {
     };
 };
 
-export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element;
+export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX_2.Element | null;
 
 declare type TablePreferences = {
     columnSettingsMap?: ColumnSettingsMap;
     selectColumnVisible?: boolean;
     columnVisibility?: Record<string, boolean>;
     pageSize?: number;
+    enableDevModePagination?: boolean;
 };
 
 export declare type TBaseQuery = {
@@ -758,6 +777,7 @@ export declare type TCard = {
     dataSource?: DataSource;
     config?: CardConfig;
     interactionConfig?: CardInteractionConfig;
+    paginationConfig?: PaginationConfig;
     queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
@@ -858,7 +878,7 @@ export declare type TChartOptions = {
     };
 };
 
-declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'pivotTable' | 'kpi' | 'pyramid' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'pivotTable' | 'aggregateTable' | 'kpi' | 'pyramid' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
 
 export declare type TColumnSetting<T extends DisplayDataType> = {
     columnIdx: number;

package/dist/types/types.d.ts

@@ -87,6 +87,16 @@ declare interface CardConfig {
     showTrendline?: boolean;
     trendlineWindow?: number;
     trendlineGranularity?: 'day' | 'week' | 'month';
+    rowAggregates?: Array<{
+        label?: string;
+        function: AggregateFunction;
+        groupLevel: string | 'ALL';
+    }>;
+    columnAggregates?: Array<{
+        label?: string;
+        function: AggregateFunction;
+        pivotLevel: string | 'ALL';
+    }>;
 }
 
 declare interface CardInteractionConfig {
@@ -614,6 +624,14 @@ declare interface OrderBy {
     direction: 'asc' | 'desc';
 }
 
+/**
+ * Pagination configuration for table queries
+ */
+declare interface PaginationConfig {
+    page: number;
+    pageSize: number;
+}
+
 declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
@@ -724,6 +742,7 @@ declare type TablePreferences = {
     selectColumnVisible?: boolean;
     columnVisibility?: Record<string, boolean>;
     pageSize?: number;
+    enableDevModePagination?: boolean;
 };
 
 export declare type TBaseQuery = {
@@ -750,6 +769,7 @@ export declare type TCard = {
     dataSource?: DataSource;
     config?: CardConfig;
     interactionConfig?: CardInteractionConfig;
+    paginationConfig?: PaginationConfig;
     queryConfig?: QueryConfig;
     customCfg?: any;
     preferences?: TCardPreferences;
@@ -850,7 +870,7 @@ export declare type TChartOptions = {
     };
 };
 
-declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'pivotTable' | 'kpi' | 'pyramid' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
+declare type TChartType = 'bar' | 'horizontalBar' | 'line' | 'pie' | 'doughnut' | 'radar' | 'polarArea' | 'bubble' | 'scatter' | 'stackedBar' | 'stackedLine' | 'table' | 'pivotTable' | 'aggregateTable' | 'kpi' | 'pyramid' | 'tornado' | 'range' | 'text' | 'map' | 'funnel' | 'custom';
 
 export declare type TColumnSetting<T extends DisplayDataType> = {
     columnIdx: number;

package/package.json

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