react-semaphor 0.0.503 → 0.0.505

package/dist/types/dashboard.d.ts

@@ -246,10 +246,27 @@ export declare type ExportDataPayload = {
 };
 
 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;
-    dataType: 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;
@@ -361,6 +378,11 @@ declare interface GroupByColumn extends BaseColumn {
 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;
 }
 
 export declare type HtmlOptions = {
@@ -417,6 +439,31 @@ declare interface MetricColumn extends BaseColumn {
 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>;
 }

package/dist/types/main.d.ts

@@ -7,6 +7,7 @@ import { ComboBoxOption as ComboBoxOption_2 } from '../../components/surfboard/f
 import { CustomCard as CustomCard_2 } from '..';
 import { DateRange } from 'react-day-picker';
 import { default as default_2 } from 'react-grid-layout';
+import { Dialect as Dialect_2 } from '../types/explorer-types';
 import { DropdownItem as DropdownItem_2 } from '../types/dropdown-types';
 import { EmailSettings as EmailSettings_2 } from '..';
 import { FontSpec } from 'chart.js';
@@ -15,6 +16,7 @@ import { QueryObserverResult } from '@tanstack/query-core';
 import { RefetchOptions } from '@tanstack/query-core';
 import { StoreApi } from 'zustand';
 import { TBaseQuery as TBaseQuery_2 } from '..';
+import { TDbCapabilities as TDbCapabilities_2 } from '../types';
 import { TFilter as TFilter_2 } from '../surfboard/filter/types';
 import { TFilterValue as TFilterValue_2 } from '..';
 import { TStyle as TStyle_2 } from '..';
@@ -603,10 +605,27 @@ export declare type ExportDataPayload = {
 };
 
 export 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;
-    dataType: 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;
@@ -771,6 +790,11 @@ export declare interface GroupByColumn extends BaseColumn {
 export 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;
 }
 
 export declare type HtmlOptions = {
@@ -839,6 +863,31 @@ export declare interface MetricColumn extends BaseColumn {
 export 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>;
 }
@@ -1356,6 +1405,14 @@ export declare const useEditorActions: () => Actions_2;
 export declare function useEditorAside(token?: AuthToken, _connectionQueryKey?: string): {
     connectionItems: ConnectionItem[];
     selectedConnectionId: string | undefined;
+    selectedConnection: {
+        id: string;
+        name: string;
+        type: string;
+        dialect?: Dialect_2;
+        uiType?: "database" | "api" | "s3";
+        capabilities: TDbCapabilities_2;
+    } | undefined;
     isConnectionsLoading: boolean;
     isConnectionsError: boolean;
     modelItems: DropdownItem_2[];

package/dist/types/surfboard.d.ts

@@ -249,10 +249,27 @@ export declare type ExportDataPayload = {
 };
 
 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;
-    dataType: 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;
@@ -364,6 +381,11 @@ declare interface GroupByColumn extends BaseColumn {
 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;
 }
 
 export declare type HtmlOptions = {
@@ -420,6 +442,31 @@ declare interface MetricColumn extends BaseColumn {
 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>;
 }

package/dist/types/types.d.ts

@@ -243,10 +243,27 @@ export declare type ExportDataPayload = {
 };
 
 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;
-    dataType: 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;
@@ -358,6 +375,11 @@ declare interface GroupByColumn extends BaseColumn {
 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;
 }
 
 export declare type HtmlOptions = {
@@ -414,6 +436,31 @@ declare interface MetricColumn extends BaseColumn {
 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>;
 }

package/package.json

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