react-semaphor 0.1.294 → 0.1.296

package/dist/types/shared.d.ts

@@ -259,6 +259,12 @@ declare interface ColumnSettings {
     maxWidth?: number;
     textOverflow?: 'ellipsis' | 'wrap' | 'clip';
     textWrap: 'wrap' | 'nowrap';
+    /**
+     * Totals-row behavior for this column. Undefined = 'none'. The footer
+     * renders only when at least one visible column has a non-'none' behavior.
+     */
+    totalsBehavior?: TotalsBehavior;
+    totalsLabel?: string;
     numberFormat: {
         style: 'decimal' | 'currency' | 'percent' | 'scientific';
         currency: string;
@@ -271,6 +277,14 @@ declare interface ColumnSettings {
         dataBarColor: string;
         dataBarMinValue?: number;
         dataBarMaxValue?: number;
+        /**
+         * When true, render the cell bg with a heatmap intensity tint scaled
+         * across the column's value range. Composes with the existing text
+         * color/color-range logic (tint is bg only). `showDataBar` takes
+         * precedence when both are set — per the canonical design, a cell is
+         * either a data-bar or a heatmap, never both.
+         */
+        showHeatmap?: boolean;
     };
     dateFormat: {
         format: string;
@@ -469,6 +483,206 @@ declare type Dialect = 'mysql' | 'postgres' | 'bigquery' | 'redshift' | 'snowfla
 
 declare type DisplayDataType = 'string' | 'date' | 'number' | 'html' | 'none';
 
+declare type DocumentChartSection = {
+    id: string;
+    type: 'chart';
+    title?: string;
+    card: TCard;
+    heightPx: number;
+};
+
+declare type DocumentControlInputDefinition = DocumentInputBase & {
+    kind: 'control';
+    control: ControlDefinition;
+    exports?: DocumentInputExportKey[];
+};
+
+declare type DocumentDefinition = {
+    version: 1;
+    page: DocumentPageSetup;
+    runtime?: DocumentRuntimeSettings;
+    inputs?: DocumentInputDefinition[];
+    defaultInputValues?: Record<string, unknown>;
+    header?: DocumentHeaderRegion;
+    footer?: DocumentFooterRegion;
+    sections: DocumentSection[];
+    theme?: DocumentTheme;
+};
+
+declare type DocumentFilterInputDefinition = DocumentInputBase & {
+    kind: 'filter';
+    filter: TFilter;
+    exports?: DocumentInputExportKey[];
+};
+
+declare type DocumentFooterRegion = DocumentRegionBase & {
+    region: 'footer';
+    layout: {
+        type: 'preset';
+        preset: 'mvp_footer';
+    };
+};
+
+declare type DocumentHeaderRegion = DocumentRegionBase & {
+    region: 'header';
+    layout: {
+        type: 'preset';
+        preset: 'mvp_header';
+    };
+};
+
+declare type DocumentImageRegionBlock = DocumentRegionBlockBase & {
+    type: 'image';
+    role?: 'logo';
+    src: string;
+    alt?: string;
+    widthPx?: number;
+};
+
+declare type DocumentInputBase = {
+    id: string;
+    label: string;
+    variableName: string;
+    requiredAtExecution: boolean;
+    documentPlacement?: 'input_bar';
+    description?: string;
+};
+
+declare type DocumentInputDefinition = DocumentFilterInputDefinition | DocumentControlInputDefinition;
+
+declare type DocumentInputExportKey = 'label' | 'value' | 'start' | 'end' | 'range';
+
+declare type DocumentPageBreakSection = {
+    id: string;
+    type: 'page_break';
+};
+
+declare type DocumentPageSetup = {
+    size: 'letter' | 'a4';
+    orientation: 'portrait' | 'landscape';
+    margins: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+        unit: 'in' | 'mm';
+    };
+};
+
+declare type DocumentRegionBase = {
+    enabled: boolean;
+    heightPx?: number;
+    layout: DocumentRegionLayout;
+    blocks: DocumentRegionBlock[];
+};
+
+declare type DocumentRegionBlock = DocumentTextRegionBlock | DocumentImageRegionBlock;
+
+declare type DocumentRegionBlockBase = {
+    id: string;
+    area?: 'left' | 'center' | 'right' | 'title' | 'metadata' | 'note' | 'pageInfo';
+};
+
+declare type DocumentRegionLayout = {
+    type: 'preset';
+    preset: 'mvp_header' | 'mvp_footer';
+};
+
+declare type DocumentRuntimeSettings = {
+    generatedAtFormat?: string;
+};
+
+declare type DocumentSection = DocumentTextSection | DocumentTableSection | DocumentChartSection | DocumentSpacerSection | DocumentPageBreakSection;
+
+declare type DocumentSpacerSection = {
+    id: string;
+    type: 'spacer';
+    heightPx: number;
+};
+
+declare type DocumentTableDensity = 'comfortable' | 'standard' | 'compact' | 'dense';
+
+declare type DocumentTableGridLines = 'none' | 'outer' | 'inner' | 'horizontal' | 'vertical' | 'top' | 'right' | 'bottom' | 'left' | 'full';
+
+declare type DocumentTableHeaderStyle = 'plain' | 'filled' | 'accent';
+
+declare type DocumentTableSection = {
+    id: string;
+    type: 'table';
+    title?: string;
+    card: TCard;
+    table: {
+        totalsRow?: boolean;
+        columnFormatting?: Record<string, unknown>;
+        repeatHeaderOnPageBreak?: boolean;
+        rowHeightPx?: number;
+        style?: DocumentTableStyle;
+    };
+};
+
+declare type DocumentTableStyle = {
+    density?: DocumentTableDensity;
+    headerStyle?: DocumentTableHeaderStyle;
+    headerBackgroundColor?: string;
+    headerTextColor?: string;
+    stripedRows?: boolean;
+    gridLines?: DocumentTableGridLines;
+    wrapText?: boolean;
+};
+
+declare type DocumentTextContent = DocumentTextNode[];
+
+declare type DocumentTextInlineFormat = {
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+};
+
+declare type DocumentTextNode = {
+    type: 'text';
+    value: string;
+    format?: DocumentTextInlineFormat;
+} | {
+    type: 'variable';
+    ref: DocumentVariableRef;
+    format?: DocumentTextInlineFormat;
+};
+
+declare type DocumentTextRegionBlock = DocumentRegionBlockBase & {
+    type: 'text';
+    role?: 'title' | 'metadata' | 'note' | 'pageInfo';
+    content: DocumentTextContent;
+    style?: DocumentTextStyle;
+};
+
+declare type DocumentTextSection = {
+    id: string;
+    type: 'text';
+    content: DocumentTextContent;
+    style?: DocumentTextStyle;
+};
+
+declare type DocumentTextStyle = {
+    fontSize?: number;
+    fontWeight?: 'normal' | 'medium' | 'semibold' | 'bold';
+    color?: string;
+    align?: 'left' | 'center' | 'right';
+};
+
+declare type DocumentTheme = {
+    fontFamily?: string;
+    primaryColor?: string;
+};
+
+declare type DocumentVariableRef = {
+    source: 'input';
+    inputId: string;
+    export: DocumentInputExportKey;
+} | {
+    source: 'documentMeta';
+    key: 'generatedAt' | 'pageNumber' | 'pageCount';
+};
+
 declare interface DrillDownInteraction {
     mode: 'drillDown';
     /**
@@ -1204,6 +1418,14 @@ declare type StyleProps = {
     };
 };
 
+/**
+ * Row rhythm for the whole table. Authors pick one per card; undefined
+ * falls back to 'compact' (the canonical default — dense scanning, matches
+ * the Linear-style spec). Drives row padding, cell font size, and header
+ * font size via a shared density spec in DataTable.
+ */
+declare type TableDensity = 'dense' | 'compact' | 'standard' | 'comfortable' | 'spacious';
+
 declare type TablePreferences = {
     columnSettingsMap?: ColumnSettingsMap;
     selectColumnVisible?: boolean;
@@ -1212,6 +1434,8 @@ declare type TablePreferences = {
     pageSize?: number;
     enableDevModePagination?: boolean;
     forceClientPagination?: boolean;
+    density?: TableDensity;
+    documentWrapText?: boolean;
 };
 
 /**
@@ -1891,11 +2115,26 @@ declare type TLegendOptions = {
 /** Line dash style options */
 declare type TLineStyle = 'solid' | 'dashed' | 'dotted' | 'dash-dot';
 
+/**
+ * Per-column contribution to the table-level totals row (`<tfoot>`).
+ * Additive and optional — omitting it keeps the cell empty in the footer,
+ * matching existing behavior when a totals row is not needed.
+ *
+ *   - 'sum'    → aggregate the column across the full dataset
+ *   - 'avg'    → arithmetic mean across the full dataset
+ *   - 'count'  → non-null count across the full dataset
+ *   - 'label'  → render `totalsLabel` (or 'Total') as static text — typically
+ *                on the first column so the footer reads as a labeled row
+ *   - 'none'   → blank cell in the footer
+ */
+declare type TotalsBehavior = 'sum' | 'avg' | 'count' | 'label' | 'none';
+
 /** Point style options supported by Chart.js */
 declare type TPointStyle = 'circle' | 'cross' | 'crossRot' | 'dash' | 'line' | 'rect' | 'rectRounded' | 'rectRot' | 'star' | 'triangle';
 
 declare type TSheet = {
     id: string;
+    kind?: 'dashboard' | 'document';
     title?: string;
     description?: string;
     layout?: ReactGridLayout.Layout[];
@@ -1903,6 +2142,7 @@ declare type TSheet = {
     cards?: TCard[];
     frames?: TFrame[];
     calculatedFields?: Field[];
+    document?: DocumentDefinition;
 };
 
 /**

package/dist/types/surfboard.d.ts

@@ -279,6 +279,12 @@ declare interface ColumnSettings {
     maxWidth?: number;
     textOverflow?: 'ellipsis' | 'wrap' | 'clip';
     textWrap: 'wrap' | 'nowrap';
+    /**
+     * Totals-row behavior for this column. Undefined = 'none'. The footer
+     * renders only when at least one visible column has a non-'none' behavior.
+     */
+    totalsBehavior?: TotalsBehavior;
+    totalsLabel?: string;
     numberFormat: {
         style: 'decimal' | 'currency' | 'percent' | 'scientific';
         currency: string;
@@ -291,6 +297,14 @@ declare interface ColumnSettings {
         dataBarColor: string;
         dataBarMinValue?: number;
         dataBarMaxValue?: number;
+        /**
+         * When true, render the cell bg with a heatmap intensity tint scaled
+         * across the column's value range. Composes with the existing text
+         * color/color-range logic (tint is bg only). `showDataBar` takes
+         * precedence when both are set — per the canonical design, a cell is
+         * either a data-bar or a heatmap, never both.
+         */
+        showHeatmap?: boolean;
     };
     dateFormat: {
         format: string;
@@ -456,6 +470,18 @@ export declare type DashboardProps = {
         cardControlDefinitions?: ControlDefinition[];
         controlBindings?: ControlBinding[];
     };
+    /**
+     * Document-local runtime values for print/render entry points. Values are
+     * keyed by document input id and are intentionally separate from dashboard
+     * filters/controls.
+     */
+    documentInputValues?: DocumentInputRuntimeValues;
+    /**
+     * Render target for print entry points. Generic dashboard PDF exports also
+     * use cardDisplay.mode="print"; document-specific print handling must only
+     * run when this is explicitly "document".
+     */
+    renderMode?: 'dashboard' | 'document';
     customStyle?: TStyle;
     currentTheme?: Theme;
     version?: string;
@@ -594,6 +620,215 @@ declare type Dialect = 'mysql' | 'postgres' | 'bigquery' | 'redshift' | 'snowfla
 
 export declare type DisplayDataType = 'string' | 'date' | 'number' | 'html' | 'none';
 
+export declare type DocumentChartSection = {
+    id: string;
+    type: 'chart';
+    title?: string;
+    card: TCard;
+    heightPx: number;
+};
+
+export declare type DocumentControlInputDefinition = DocumentInputBase & {
+    kind: 'control';
+    control: ControlDefinition;
+    exports?: DocumentInputExportKey[];
+};
+
+export declare type DocumentDefinition = {
+    version: 1;
+    page: DocumentPageSetup;
+    runtime?: DocumentRuntimeSettings;
+    inputs?: DocumentInputDefinition[];
+    defaultInputValues?: Record<string, unknown>;
+    header?: DocumentHeaderRegion;
+    footer?: DocumentFooterRegion;
+    sections: DocumentSection[];
+    theme?: DocumentTheme;
+};
+
+export declare type DocumentFilterInputDefinition = DocumentInputBase & {
+    kind: 'filter';
+    filter: TFilter;
+    exports?: DocumentInputExportKey[];
+};
+
+export declare type DocumentFooterRegion = DocumentRegionBase & {
+    region: 'footer';
+    layout: {
+        type: 'preset';
+        preset: 'mvp_footer';
+    };
+};
+
+export declare type DocumentHeaderRegion = DocumentRegionBase & {
+    region: 'header';
+    layout: {
+        type: 'preset';
+        preset: 'mvp_header';
+    };
+};
+
+export declare type DocumentImageRegionBlock = DocumentRegionBlockBase & {
+    type: 'image';
+    role?: 'logo';
+    src: string;
+    alt?: string;
+    widthPx?: number;
+};
+
+export declare type DocumentInputBase = {
+    id: string;
+    label: string;
+    variableName: string;
+    requiredAtExecution: boolean;
+    documentPlacement?: 'input_bar';
+    description?: string;
+};
+
+export declare type DocumentInputDefinition = DocumentFilterInputDefinition | DocumentControlInputDefinition;
+
+export declare type DocumentInputExportKey = 'label' | 'value' | 'start' | 'end' | 'range';
+
+export declare type DocumentInputRuntimeValues = {
+    sheetId?: string;
+    filterValuesByInputId?: Record<string, TFilterValue | undefined>;
+    controlValuesByInputId?: Record<string, unknown>;
+    generatedAt?: string;
+};
+
+export declare type DocumentPageBreakSection = {
+    id: string;
+    type: 'page_break';
+};
+
+export declare type DocumentPageSetup = {
+    size: 'letter' | 'a4';
+    orientation: 'portrait' | 'landscape';
+    margins: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+        unit: 'in' | 'mm';
+    };
+};
+
+export declare type DocumentRegion = DocumentHeaderRegion | DocumentFooterRegion;
+
+export declare type DocumentRegionBase = {
+    enabled: boolean;
+    heightPx?: number;
+    layout: DocumentRegionLayout;
+    blocks: DocumentRegionBlock[];
+};
+
+export declare type DocumentRegionBlock = DocumentTextRegionBlock | DocumentImageRegionBlock;
+
+export declare type DocumentRegionBlockBase = {
+    id: string;
+    area?: 'left' | 'center' | 'right' | 'title' | 'metadata' | 'note' | 'pageInfo';
+};
+
+export declare type DocumentRegionLayout = {
+    type: 'preset';
+    preset: 'mvp_header' | 'mvp_footer';
+};
+
+export declare type DocumentRuntimeSettings = {
+    generatedAtFormat?: string;
+};
+
+export declare type DocumentSection = DocumentTextSection | DocumentTableSection | DocumentChartSection | DocumentSpacerSection | DocumentPageBreakSection;
+
+export declare type DocumentSpacerSection = {
+    id: string;
+    type: 'spacer';
+    heightPx: number;
+};
+
+export declare type DocumentTableDensity = 'comfortable' | 'standard' | 'compact' | 'dense';
+
+export declare type DocumentTableGridLines = 'none' | 'outer' | 'inner' | 'horizontal' | 'vertical' | 'top' | 'right' | 'bottom' | 'left' | 'full';
+
+export declare type DocumentTableHeaderStyle = 'plain' | 'filled' | 'accent';
+
+export declare type DocumentTableSection = {
+    id: string;
+    type: 'table';
+    title?: string;
+    card: TCard;
+    table: {
+        totalsRow?: boolean;
+        columnFormatting?: Record<string, unknown>;
+        repeatHeaderOnPageBreak?: boolean;
+        rowHeightPx?: number;
+        style?: DocumentTableStyle;
+    };
+};
+
+export declare type DocumentTableStyle = {
+    density?: DocumentTableDensity;
+    headerStyle?: DocumentTableHeaderStyle;
+    headerBackgroundColor?: string;
+    headerTextColor?: string;
+    stripedRows?: boolean;
+    gridLines?: DocumentTableGridLines;
+    wrapText?: boolean;
+};
+
+export declare type DocumentTextContent = DocumentTextNode[];
+
+export declare type DocumentTextInlineFormat = {
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+};
+
+export declare type DocumentTextNode = {
+    type: 'text';
+    value: string;
+    format?: DocumentTextInlineFormat;
+} | {
+    type: 'variable';
+    ref: DocumentVariableRef;
+    format?: DocumentTextInlineFormat;
+};
+
+export declare type DocumentTextRegionBlock = DocumentRegionBlockBase & {
+    type: 'text';
+    role?: 'title' | 'metadata' | 'note' | 'pageInfo';
+    content: DocumentTextContent;
+    style?: DocumentTextStyle;
+};
+
+export declare type DocumentTextSection = {
+    id: string;
+    type: 'text';
+    content: DocumentTextContent;
+    style?: DocumentTextStyle;
+};
+
+export declare type DocumentTextStyle = {
+    fontSize?: number;
+    fontWeight?: 'normal' | 'medium' | 'semibold' | 'bold';
+    color?: string;
+    align?: 'left' | 'center' | 'right';
+};
+
+export declare type DocumentTheme = {
+    fontFamily?: string;
+    primaryColor?: string;
+};
+
+export declare type DocumentVariableRef = {
+    source: 'input';
+    inputId: string;
+    export: DocumentInputExportKey;
+} | {
+    source: 'documentMeta';
+    key: 'generatedAt' | 'pageNumber' | 'pageCount';
+};
+
 declare interface DrillDownInteraction {
     mode: 'drillDown';
     /**
@@ -1309,6 +1544,16 @@ declare type RelativeDateFilter = {
     to: number;
 };
 
+export declare type ResolvedDocumentInput = {
+    inputId: string;
+    variableName: string;
+    rawValue: unknown;
+    displayValue: string;
+    filterValues?: TFilterValue[];
+    controlValue?: unknown;
+    exports: Record<string, string | number | boolean | null>;
+};
+
 declare type ResolvedPrimaryDateField = {
     sourceDataset: string;
     sourceField: string;
@@ -1409,6 +1654,14 @@ export declare type StyleProps = {
 
 export declare function Surfboard({ showControls, showFooter, ...rest }: DashboardPlusProps): JSX.Element;
 
+/**
+ * Row rhythm for the whole table. Authors pick one per card; undefined
+ * falls back to 'compact' (the canonical default — dense scanning, matches
+ * the Linear-style spec). Drives row padding, cell font size, and header
+ * font size via a shared density spec in DataTable.
+ */
+declare type TableDensity = 'dense' | 'compact' | 'standard' | 'comfortable' | 'spacious';
+
 declare type TablePreferences = {
     columnSettingsMap?: ColumnSettingsMap;
     selectColumnVisible?: boolean;
@@ -1417,6 +1670,8 @@ declare type TablePreferences = {
     pageSize?: number;
     enableDevModePagination?: boolean;
     forceClientPagination?: boolean;
+    density?: TableDensity;
+    documentWrapText?: boolean;
 };
 
 /**
@@ -2141,11 +2396,26 @@ export declare type TLens = {
 /** Line dash style options */
 export declare type TLineStyle = 'solid' | 'dashed' | 'dotted' | 'dash-dot';
 
+/**
+ * Per-column contribution to the table-level totals row (`<tfoot>`).
+ * Additive and optional — omitting it keeps the cell empty in the footer,
+ * matching existing behavior when a totals row is not needed.
+ *
+ *   - 'sum'    → aggregate the column across the full dataset
+ *   - 'avg'    → arithmetic mean across the full dataset
+ *   - 'count'  → non-null count across the full dataset
+ *   - 'label'  → render `totalsLabel` (or 'Total') as static text — typically
+ *                on the first column so the footer reads as a labeled row
+ *   - 'none'   → blank cell in the footer
+ */
+declare type TotalsBehavior = 'sum' | 'avg' | 'count' | 'label' | 'none';
+
 /** Point style options supported by Chart.js */
 export declare type TPointStyle = 'circle' | 'cross' | 'crossRot' | 'dash' | 'line' | 'rect' | 'rectRounded' | 'rectRot' | 'star' | 'triangle';
 
 export declare type TSheet = {
     id: string;
+    kind?: 'dashboard' | 'document';
     title?: string;
     description?: string;
     layout?: ReactGridLayout.Layout[];
@@ -2153,6 +2423,7 @@ export declare type TSheet = {
     cards?: TCard[];
     frames?: TFrame[];
     calculatedFields?: Field[];
+    document?: DocumentDefinition;
 };
 
 /**