react-semaphor 0.0.5801 → 0.0.6371

package/dist/surfboard/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../chunks/dashboard-plus-2Ws4IDjX.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-CjnhLxYD.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-CHD4IsyS.js";
+import { D as f } from "../chunks/dashboard-plus-DecDM7dW.js";
 import { EMPTY_SELECTION as a } from "../types/index.js";
 export {
   a as EMPTY_SELECTION,

package/dist/types/dashboard.d.ts

@@ -1,3 +1,4 @@
+import { ColumnSizingState } from '@tanstack/react-table';
 import { FontSpec } from 'chart.js';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 
@@ -7,6 +8,7 @@ declare type AggregateFunction = 'COUNT' | 'SUM' | 'AVG' | 'MIN' | 'MAX' | 'MEDI
 
 declare type AIContext = {
     selectedEntities: SelectedEntities;
+    fileAttachments?: FileAttachment[];
 };
 
 export declare type AIScopeTable = {
@@ -191,7 +193,10 @@ declare interface ColorRange_2 {
 declare interface ColumnSettings {
     type: 'none' | 'text' | 'number' | 'date' | 'badge' | 'link' | 'progress';
     textAlign: 'left' | 'center' | 'right';
-    width: string;
+    width: number;
+    minWidth?: number;
+    maxWidth?: number;
+    textOverflow?: 'ellipsis' | 'wrap' | 'clip';
     textWrap: 'wrap' | 'nowrap';
     numberFormat: {
         style: 'decimal' | 'currency' | 'percent';
@@ -209,6 +214,8 @@ declare interface ColumnSettings {
         useCustomFormat: boolean;
         customFormat: string;
         useRelativeTime: boolean;
+        timezone?: string;
+        sourceTimezone?: string;
     };
     colorRanges: ColorRange_2[];
 }
@@ -233,6 +240,33 @@ export declare type DashboardEventHandlers = {
     onExportData?: (payload: ExportDataPayload) => void;
 };
 
+/**
+ * Unified dashboard preferences for both card display and UI modes
+ */
+export declare type DashboardPreferences = {
+    /**
+     * Visual display preferences for cards
+     * Controls how card content is rendered (headers, footers, etc.)
+     */
+    cardDisplay?: VisualDisplayPreferences;
+    /**
+     * UI modes for developer and debug features
+     * Controls what developer tools and debug panels are available
+     */
+    uiMode?: {
+        /**
+         * Enable developer mode
+         * Shows additional controls and debug information
+         */
+        developer?: boolean;
+        /**
+         * Enable console mode
+         * Shows console panel for debugging
+         */
+        console?: boolean;
+    };
+};
+
 export declare type DashboardProps = {
     id?: string;
     /**
@@ -242,10 +276,7 @@ export declare type DashboardProps = {
     /**
      * Default filter values for the dashboard. The dashboard will be filtered by these values when the user loads the dashboard.
      */
-    defaultFilterValues?: {
-        filterId: string;
-        values: string[] | number[];
-    }[] | TFilterValue[];
+    defaultFilterValues?: TFilterValue[];
     customStyle?: TStyle;
     currentTheme?: Theme;
     version?: string;
@@ -266,6 +297,11 @@ export declare type DashboardProps = {
      * The id of the sheet to be selected when the dashboard is loaded.
      */
     selectedSheetId?: string;
+    /**
+     * Unified preferences for dashboard configuration
+     * Includes both card display preferences and UI mode settings
+     */
+    preferences?: DashboardPreferences;
 };
 
 declare interface DatabaseEntityReference {
@@ -416,6 +452,17 @@ declare interface Field {
     role?: 'groupby' | 'metric' | 'sortby' | 'pivotby';
 }
 
+declare type FileAttachment = {
+    id: string;
+    name: string;
+    size: number;
+    type: string;
+    data?: string;
+    url?: string;
+    preview?: string;
+    uploadProgress?: number;
+};
+
 declare interface FileEntityReference extends DatabaseEntityReference {
     id: string;
     type: 'file' | 'url' | 'upload';
@@ -489,7 +536,7 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
-declare type FilterValue = string | number | boolean | Date | [number, number] | [string, string] | string[] | number[];
+declare type FilterValue = string | number | boolean | Date | null | [number, number] | [string, string] | string[] | number[];
 
 export declare type GetDashboardResponse = {
     dashboard: TDashboard;
@@ -638,7 +685,7 @@ declare type OldFilterValue = string | number | null | (string | number)[] | Ran
 
 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 Operator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'contains' | 'startsWith' | 'endsWith' | 'in' | 'not in' | 'between' | 'isNull' | 'isNotNull';
 
 declare type OptionsMap = {
     number: NumberOptions;
@@ -770,6 +817,7 @@ declare type TablePreferences = {
     columnSettingsMap?: ColumnSettingsMap;
     selectColumnVisible?: boolean;
     columnVisibility?: Record<string, boolean>;
+    columnSizing?: ColumnSizingState;
     pageSize?: number;
     enableDevModePagination?: boolean;
 };
@@ -808,6 +856,11 @@ export declare type TCard = {
     lastSelectedSchema?: string;
     lastSelectedTable?: string;
     refreshInterval?: string;
+    /**
+     * Card-specific display preferences that override dashboard-level preferences.
+     * If not specified, the card will use the dashboard's display preferences.
+     */
+    displayPreferences?: VisualDisplayPreferences;
 };
 
 export declare type TCardContext = {
@@ -858,6 +911,7 @@ export declare type TCardPreferences = {
     kpiVisualOptions?: {
         lowerIsBetter?: boolean;
         countryLogoId?: string;
+        valueAlignment?: 'left' | 'center';
         formatOptions?: TFormatOptions;
         metricComparison?: {
             enabled?: boolean;
@@ -1105,4 +1159,41 @@ export declare type TStyle = {
     dark?: StyleProps;
 };
 
+/**
+ * Display mode for visual components - controls which UI elements are shown
+ */
+export declare type VisualDisplayMode = 'full' | 'content-only' | 'print' | 'embed' | 'table-print';
+
+/**
+ * Display preferences for controlling visual component rendering
+ */
+export declare type VisualDisplayPreferences = {
+    /**
+     * Predefined display mode
+     * - 'full': All UI elements (default)
+     * - 'content-only': Just the visualization/table content
+     * - 'print': Optimized for printing (shows title and description, hides interactive elements)
+     * - 'embed': Minimal chrome for embedding in other contexts
+     */
+    mode?: VisualDisplayMode;
+    /**
+     * Override specific UI elements visibility
+     * These overrides take precedence over the mode presets
+     */
+    overrides?: {
+        showHeader?: boolean;
+        showTitle?: boolean;
+        showDescription?: boolean;
+        showTabs?: boolean;
+        showFooter?: boolean;
+        showFilters?: boolean;
+        showBreadcrumbs?: boolean;
+        showRefreshIndicator?: boolean;
+        showFilterInfo?: boolean;
+        showPagination?: boolean;
+        showTableToolbar?: boolean;
+        showColumnSettings?: boolean;
+    };
+};
+
 export { }

package/dist/types/main.d.ts

@@ -3,6 +3,7 @@ import { AIScopeTable as AIScopeTable_2 } from '..';
 import { CacheConfig as CacheConfig_2 } from '..';
 import { Chart } from 'chart.js';
 import { ChartConfiguration } from 'chart.js';
+import { ColumnSizingState } from '@tanstack/react-table';
 import { ComboBoxOption as ComboBoxOption_2 } from '../../components/surfboard/filter/types';
 import { CustomCard as CustomCard_2 } from '..';
 import { DateRange } from 'react-day-picker';
@@ -67,6 +68,7 @@ declare type Actions = {
     setCardSql: (sheetId: string, cardId: string, sql: string) => void;
     setCardPython: (cardId: string, pythonCode: string) => void;
     setCardDescription: (sheetId: string, cardId: string, description: string) => void;
+    setCardKpiOptions: (sheetId: string, cardId: string, kpiOptions: Record<string, any>) => void;
     addFrame: (sheetId: string, frame: TFrame, position?: 'start' | 'end') => void;
     updateFrame: (sheetId: string, frame: TFrame) => void;
     updateCard: (sheetId: string, card: TCard) => void;
@@ -109,11 +111,17 @@ declare type Actions = {
     removeBaseQuery: (baseQueryId: string) => void;
     setBaseQueries: (baseQueries: TBaseQuery[]) => void;
     setIsDashboardPanelOpen: (open: boolean) => void;
+    updateCardId: (oldCardId: string, newCardId: string) => {
+        success: boolean;
+        error?: string;
+    };
+    isCardIdUnique: (cardId: string, currentCardId?: string) => boolean;
 };
 
 declare type Actions_2 = TableActions & ExplorerActions & DrillActions & {
     setEditorFilterMode: (filterColumnName: string, filterMode: 'include' | 'exclude') => void;
     setLowerIsBetter: (lowerIsBetter: boolean) => void;
+    setValueAlignment: (valueAlignment: 'left' | 'center') => void;
     clearEditorFilter: (filterColumn: FilterByColumn) => void;
     removeEditorFilter: (filterColumn: FilterByColumn) => void;
     updateEditorFilterValue: (filterColumnName: string, filterValue: OldFilterValue, clearFilter?: boolean) => void;
@@ -125,6 +133,7 @@ declare type Actions_2 = TableActions & ExplorerActions & DrillActions & {
     setQueryConfig: (queryConfig: QueryConfig | undefined) => void;
     setCardTitle: (title: string) => void;
     setCardDescription: (description: string) => void;
+    setCardId: (cardId: string) => void;
     setCountryLogo: (countryLogoId: string | null) => void;
     setIsDevMode: (isDevMode: boolean) => void;
     setOrderByColumns: (orderByColumns: OrderBy[]) => void;
@@ -212,6 +221,7 @@ export declare type AggregateFunction = 'COUNT' | 'SUM' | 'AVG' | 'MIN' | 'MAX'
 
 declare type AIContext = {
     selectedEntities: SelectedEntities;
+    fileAttachments?: FileAttachment[];
 };
 
 export declare type AIScopeTable = {
@@ -402,7 +412,10 @@ export declare type ColumnRole = 'groupby' | 'trendby' | 'metric' | 'filter';
 declare interface ColumnSettings {
     type: 'none' | 'text' | 'number' | 'date' | 'badge' | 'link' | 'progress';
     textAlign: 'left' | 'center' | 'right';
-    width: string;
+    width: number;
+    minWidth?: number;
+    maxWidth?: number;
+    textOverflow?: 'ellipsis' | 'wrap' | 'clip';
     textWrap: 'wrap' | 'nowrap';
     numberFormat: {
         style: 'decimal' | 'currency' | 'percent';
@@ -420,6 +433,8 @@ declare interface ColumnSettings {
         useCustomFormat: boolean;
         customFormat: string;
         useRelativeTime: boolean;
+        timezone?: string;
+        sourceTimezone?: string;
     };
     colorRanges: ColorRange_2[];
 }
@@ -463,6 +478,33 @@ declare type DashboardPlusProps = {
     showFooter?: boolean;
 } & DashboardProps;
 
+/**
+ * Unified dashboard preferences for both card display and UI modes
+ */
+export declare type DashboardPreferences = {
+    /**
+     * Visual display preferences for cards
+     * Controls how card content is rendered (headers, footers, etc.)
+     */
+    cardDisplay?: VisualDisplayPreferences;
+    /**
+     * UI modes for developer and debug features
+     * Controls what developer tools and debug panels are available
+     */
+    uiMode?: {
+        /**
+         * Enable developer mode
+         * Shows additional controls and debug information
+         */
+        developer?: boolean;
+        /**
+         * Enable console mode
+         * Shows console panel for debugging
+         */
+        console?: boolean;
+    };
+};
+
 export declare type DashboardProps = {
     id?: string;
     /**
@@ -472,10 +514,7 @@ export declare type DashboardProps = {
     /**
      * Default filter values for the dashboard. The dashboard will be filtered by these values when the user loads the dashboard.
      */
-    defaultFilterValues?: {
-        filterId: string;
-        values: string[] | number[];
-    }[] | TFilterValue[];
+    defaultFilterValues?: TFilterValue[];
     customStyle?: TStyle;
     currentTheme?: Theme;
     version?: string;
@@ -496,6 +535,11 @@ export declare type DashboardProps = {
      * The id of the sheet to be selected when the dashboard is loaded.
      */
     selectedSheetId?: string;
+    /**
+     * Unified preferences for dashboard configuration
+     * Includes both card display preferences and UI mode settings
+     */
+    preferences?: DashboardPreferences;
 };
 
 export declare type DashboardStore = {
@@ -600,7 +644,7 @@ export declare type Dialect = 'mysql' | 'postgresql' | 'bigquery' | 'redshift' |
 
 export declare type DisplayDataType = 'string' | 'date' | 'number' | 'html' | 'none';
 
-export declare function downloadPdf(): Promise<void>;
+export declare function downloadPdf(password?: string): Promise<void>;
 
 declare interface DrillActions {
     updateDrillHierarchies: (h: DrillHierarchy[]) => void;
@@ -824,6 +868,17 @@ export declare interface Field {
     role?: 'groupby' | 'metric' | 'sortby' | 'pivotby';
 }
 
+declare type FileAttachment = {
+    id: string;
+    name: string;
+    size: number;
+    type: string;
+    data?: string;
+    url?: string;
+    preview?: string;
+    uploadProgress?: number;
+};
+
 export declare interface FileEntityReference extends DatabaseEntityReference {
     id: string;
     type: 'file' | 'url' | 'upload';
@@ -897,7 +952,7 @@ declare type FilterOnClick = {
     columnIndex: number;
 };
 
-export declare type FilterValue = string | number | boolean | Date | [number, number] | [string, string] | string[] | number[];
+export declare type FilterValue = string | number | boolean | Date | null | [number, number] | [string, string] | string[] | number[];
 
 export declare function fmt(str: string): string;
 
@@ -1091,6 +1146,11 @@ export declare interface MetricField extends Field {
     valueAliases?: Record<string, string>;
 }
 
+declare interface MinimalResourceForSharing {
+    id: string;
+    title: string;
+}
+
 export declare type ModelItem = DropdownItem;
 
 declare type NoneOptions = {};
@@ -1113,7 +1173,7 @@ export declare type OldFilterValue = string | number | null | (string | number)[
 
 declare type Operation = '=' | '>' | '<' | '>=' | '<=' | '!=' | 'in' | 'not in' | 'like' | 'not like' | 'between' | 'not between' | 'is null' | 'is not null';
 
-export declare type Operator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'contains' | 'startsWith' | 'endsWith' | 'in' | 'not in' | 'between';
+export declare type Operator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'contains' | 'startsWith' | 'endsWith' | 'in' | 'not in' | 'between' | 'isNull' | 'isNotNull';
 
 declare type OptionsMap = {
     number: NumberOptions;
@@ -1231,6 +1291,11 @@ declare interface ResourceManagementPanelProps {
     onDashboardItemClick?: (dashboardId: string) => void;
 }
 
+export declare enum ResourceType {
+    DASHBOARD = "dashboard",
+    VISUAL = "visual"
+}
+
 export declare function ScheduleDashboard({ triggerButtonClassName, }: {
     triggerButtonClassName?: string;
 }): JSX_2.Element;
@@ -1273,6 +1338,16 @@ declare function SemaphorQueryClient({ children, }: {
 export { SemaphorQueryClient as SemaphorDataProvider }
 export { SemaphorQueryClient }
 
+export declare function ShareDialog({ resource, resourceType, onClose, onShareSuccess, onRemoveSuccess, }: ShareDialogProps): JSX_2.Element;
+
+declare interface ShareDialogProps {
+    resource: MinimalResourceForSharing;
+    resourceType: ResourceType;
+    onClose: () => void;
+    onShareSuccess?: () => void;
+    onRemoveSuccess?: () => void;
+}
+
 export declare interface SortByField extends Field {
     role: 'sortby';
     direction: 'asc' | 'desc';
@@ -1346,6 +1421,7 @@ export declare function Surfboard({ showControls, showFooter, ...rest }: Dashboa
 declare interface TableActions {
     updateColumnSettingsMap: (columnSettings: ColumnSettingsMap) => void;
     updateColumnVisibility: (columnId: string, isVisible: boolean) => void;
+    updateColumnSizing: (sizing: ColumnSizingState) => void;
     updatePageSize: (pageSize: number) => void;
     showAllColumns: () => void;
     hideAllColumns: () => void;
@@ -1367,6 +1443,7 @@ declare type TablePreferences = {
     columnSettingsMap?: ColumnSettingsMap;
     selectColumnVisible?: boolean;
     columnVisibility?: Record<string, boolean>;
+    columnSizing?: ColumnSizingState;
     pageSize?: number;
     enableDevModePagination?: boolean;
 };
@@ -1405,6 +1482,11 @@ export declare type TCard = {
     lastSelectedSchema?: string;
     lastSelectedTable?: string;
     refreshInterval?: string;
+    /**
+     * Card-specific display preferences that override dashboard-level preferences.
+     * If not specified, the card will use the dashboard's display preferences.
+     */
+    displayPreferences?: VisualDisplayPreferences;
 };
 
 export declare type TCardContext = {
@@ -1455,6 +1537,7 @@ export declare type TCardPreferences = {
     kpiVisualOptions?: {
         lowerIsBetter?: boolean;
         countryLogoId?: string;
+        valueAlignment?: 'left' | 'center';
         formatOptions?: TFormatOptions;
         metricComparison?: {
             enabled?: boolean;
@@ -1690,7 +1773,7 @@ export declare type TLens = {
  * Parameters for customizing token behavior and formatting.
  */
 export declare type TokenParams = {
-    currencyFormat: {
+    currencyFormat?: {
         /**
          * Locale identifier (e.g., 'en-US', 'fr-FR').
          */
@@ -1700,6 +1783,79 @@ export declare type TokenParams = {
          */
         currency: string;
     };
+    /**
+     * Time zone identifier (e.g., 'America/New_York', 'Europe/London').
+     */
+    timeZone?: string;
+};
+
+export declare type TokenProps = {
+    /**
+     * Allowed semantic domains.
+     */
+    allowedSemanticDomains?: string[];
+    /**
+     * Type of the token request. Default is 'dashboard'.
+     */
+    type?: 'dashboard' | 'project';
+    /**
+     * Initial dashboard id to be accessed.
+     */
+    dashboard_id?: string;
+    /**
+     * Unique identifier of the project.
+     */
+    project_id?: string;
+    /**
+     * Unique identifier of the tenant.
+     */
+    tenantId?: string;
+    /**
+     * Unique identifier of the tenant user accessing the dashboard.
+     */
+    endUserId?: string;
+    /**
+     * Email of the tenant user (for personalization, audit, or identification).
+     */
+    endUserEmail?: string;
+    /**
+     * Unique identifier of the org user accessing the dashboard.
+     */
+    orgUserId?: string;
+    /**
+     * Email of the org user (for personalization, audit, or identification).
+     */
+    orgUserEmail?: string;
+    /**
+     * Display name of the end user.
+     */
+    displayName?: string;
+    /**
+     * 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.
+     */
+    cls?: TokenSecurityPolicy[] | TokenSecurityPolicy;
+    /**
+     * Row-level security policies.
+     * Can be a single policy or an array of policies.
+     */
+    rcls?: TokenSecurityPolicy[] | TokenSecurityPolicy;
+    /**
+     * Parameter overrides and preferences (e.g., formatting).
+     */
+    params?: TokenParams;
+    /**
+     * UI behavior and feature flags.
+     */
+    config?: UIConfig;
 };
 
 /**
@@ -1850,6 +2006,11 @@ export declare type UIConfig = {
      * Defaults to true unless explicitly disabled.
      */
     showAdvancedMode?: boolean;
+    /**
+     * Enables the Info tab in the editor/explorer view.
+     * Defaults to true unless explicitly disabled.
+     */
+    showInfoTab?: boolean;
     /**
      * Enables the AI-powered dashboard assistant.
      * Defaults to true unless explicitly disabled.
@@ -1978,4 +2139,49 @@ export declare function useTextFilterHook(filterId: string): {
     allSelected: boolean;
 };
 
+export declare function Visual(props: VisualProps): JSX_2.Element;
+
+/**
+ * Display mode for visual components - controls which UI elements are shown
+ */
+export declare type VisualDisplayMode = 'full' | 'content-only' | 'print' | 'embed' | 'table-print';
+
+/**
+ * Display preferences for controlling visual component rendering
+ */
+export declare type VisualDisplayPreferences = {
+    /**
+     * Predefined display mode
+     * - 'full': All UI elements (default)
+     * - 'content-only': Just the visualization/table content
+     * - 'print': Optimized for printing (shows title and description, hides interactive elements)
+     * - 'embed': Minimal chrome for embedding in other contexts
+     */
+    mode?: VisualDisplayMode;
+    /**
+     * Override specific UI elements visibility
+     * These overrides take precedence over the mode presets
+     */
+    overrides?: {
+        showHeader?: boolean;
+        showTitle?: boolean;
+        showDescription?: boolean;
+        showTabs?: boolean;
+        showFooter?: boolean;
+        showFilters?: boolean;
+        showBreadcrumbs?: boolean;
+        showRefreshIndicator?: boolean;
+        showFilterInfo?: boolean;
+        showPagination?: boolean;
+        showTableToolbar?: boolean;
+        showColumnSettings?: boolean;
+    };
+};
+
+declare type VisualProps = DashboardProps & {
+    cardId: string;
+    dashboardId: string;
+    displayPreferences?: VisualDisplayPreferences;
+};
+
 export { }