react-semaphor 0.1.303 → 0.1.304

package/dist/surfboard/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("../chunks/index-BWjB_9uz.js"),e=require("../types/index.cjs"),r=require("../chunks/dashboard-summary-settings-dialog-BdxKl1UF.js");exports.Surfboard=a.DashboardPlus;exports.CONTROL_CARD_DEFAULT_VALUE=e.CONTROL_CARD_DEFAULT_VALUE;exports.EMPTY_SELECTION=e.EMPTY_SELECTION;exports.CalendarPreferencesDialog=r.CalendarPreferencesDialog;exports.DashboardSummarySettingsDialog=r.DashboardSummarySettingsDialog;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("../chunks/index-D2vz3gvd.js"),e=require("../chunks/common-types-nBuCd3u2.js"),r=require("../chunks/dashboard-summary-settings-dialog-DJyY-PB9.js");exports.Surfboard=a.DashboardPlus;exports.CONTROL_CARD_DEFAULT_VALUE=e.CONTROL_CARD_DEFAULT_VALUE;exports.EMPTY_SELECTION=e.EMPTY_SELECTION;exports.CalendarPreferencesDialog=r.CalendarPreferencesDialog;exports.DashboardSummarySettingsDialog=r.DashboardSummarySettingsDialog;

package/dist/surfboard/index.js

@@ -1,10 +1,10 @@
-import { a as o } from "../chunks/index-CYWgnME0.js";
-import { CONTROL_CARD_DEFAULT_VALUE as s, EMPTY_SELECTION as D } from "../types/index.js";
-import { C as m, D as t } from "../chunks/dashboard-summary-settings-dialog-ChK3344r.js";
+import { a as o } from "../chunks/index-GHhvGdF9.js";
+import { C as s, E as C } from "../chunks/common-types-C6cAQgyh.js";
+import { C as E, D as f } from "../chunks/dashboard-summary-settings-dialog-BlD77h63.js";
 export {
   s as CONTROL_CARD_DEFAULT_VALUE,
-  m as CalendarPreferencesDialog,
-  t as DashboardSummarySettingsDialog,
-  D as EMPTY_SELECTION,
+  E as CalendarPreferencesDialog,
+  f as DashboardSummarySettingsDialog,
+  C as EMPTY_SELECTION,
   o as Surfboard
 };

package/dist/types/dashboard.d.ts

@@ -427,6 +427,11 @@ export declare type ControlBinding = {
     mapping: Record<string, string>;
 };
 
+export declare type ControlDashboardInput = DashboardInputBase & {
+    kind: 'control';
+    control: ControlDefinition;
+};
+
 export declare type ControlDefinition = {
     id: string;
     label: string;
@@ -489,6 +494,118 @@ export declare type DashboardEventHandlers = {
     onExportData?: (payload: ExportDataPayload) => void;
 };
 
+export declare type DashboardInput = FilterDashboardInput | ControlDashboardInput;
+
+export declare type DashboardInputBase = {
+    id: string;
+    label: string;
+    variableName: string;
+    description?: string;
+    requiredAtExecution?: boolean;
+    scope: DashboardInputScope;
+    runtimeScope: DashboardInputRuntimeScope;
+    presentation?: DashboardInputPresentation;
+    exports?: DashboardInputExportKey[];
+    compatibility?: DashboardInputCompatibilityMetadata;
+};
+
+export declare type DashboardInputCompatibilityMetadata = {
+    source: 'dashboardFilter';
+    filterId: string;
+} | {
+    source: 'dashboardControl';
+    controlId: string;
+} | {
+    source: 'cardInlineFilter';
+    cardId: string;
+    filterId: string;
+} | {
+    source: 'cardControl';
+    cardId: string;
+    controlId: string;
+} | {
+    source: 'documentInput';
+    sheetId: string;
+    inputId: string;
+};
+
+export declare type DashboardInputExecutionSnapshot = {
+    sheetId?: string;
+    cardId?: string;
+    mode: 'dashboard' | 'document' | 'visual';
+    dashboardInputValues: DashboardInputValues;
+    generatedAt?: string;
+    timezone?: string;
+};
+
+export declare type DashboardInputExportKey = 'label' | 'value' | 'start' | 'end' | 'range';
+
+export declare type DashboardInputPresentation = {
+    placement?: 'toolbar' | 'card_header' | 'advanced' | 'hidden';
+    widthPx?: number;
+    order?: number;
+};
+
+export declare type DashboardInputRuntimeScope = 'shared' | 'perSheet' | 'perCard' | 'perDocumentSection';
+
+export declare type DashboardInputScope = {
+    kind: 'allSheets';
+    sheetKinds?: Array<'dashboard' | 'document'>;
+} | {
+    kind: 'sheets';
+    sheetIds: string[];
+} | {
+    kind: 'cards';
+    cardIds: string[];
+} | {
+    kind: 'documentSections';
+    sheetId: string;
+    sectionIds: string[];
+};
+
+export declare type DashboardInputSlot = {
+    status: 'set';
+    value: DashboardInputValue;
+} | {
+    status: 'cleared';
+};
+
+export declare type DashboardInputTextContent = Array<{
+    type: 'text';
+    value: string;
+} | {
+    type: 'variable';
+    ref: DashboardInputVariableRef;
+}>;
+
+export declare type DashboardInputValue = {
+    kind: 'filter';
+    filterValue: TFilterValue;
+} | {
+    kind: 'control';
+    value: unknown;
+};
+
+export declare type DashboardInputValues = {
+    shared?: Record<string, DashboardInputSlot>;
+    bySheetId?: Record<string, Record<string, DashboardInputSlot>>;
+    byCardId?: Record<string, Record<string, DashboardInputSlot>>;
+    byDocumentSectionId?: Record<string, Record<string, DashboardInputSlot>>;
+};
+
+export declare type DashboardInputVariableRef = {
+    source: 'dashboardInput';
+    inputId: string;
+    export: DashboardInputExportKey;
+} | {
+    source: 'dashboardInputAlias';
+    variableName: string;
+    export?: DashboardInputExportKey;
+} | {
+    source: 'documentMeta';
+    key: 'generatedAt' | 'pageNumber' | 'pageCount';
+};
+
 /**
  * Unified dashboard preferences for both card display and UI modes
  */
@@ -544,8 +661,17 @@ export declare type DashboardProps = {
      * Document-local runtime values for print/render entry points. Values are
      * keyed by document input id and are intentionally separate from dashboard
      * filters/controls.
+     *
+     * @deprecated Use dashboardInputExecutionSnapshot for document print/export
+     * entry points backed by DashboardInput.
      */
     documentInputValues?: DocumentInputRuntimeValues;
+    /**
+     * Authoritative dashboard input runtime snapshot for print/render entry
+     * points. Document print/export should use this for DashboardInput-backed
+     * inputs instead of documentInputValues.
+     */
+    dashboardInputExecutionSnapshot?: DashboardInputExecutionSnapshot;
     /**
      * Render target for print entry points. Generic dashboard PDF exports also
      * use cardDisplay.mode="print"; document-specific print handling must only
@@ -1142,6 +1268,11 @@ declare interface FilterCondition {
     value: FilterValue;
 }
 
+export declare type FilterDashboardInput = DashboardInputBase & {
+    kind: 'filter';
+    filter: TFilter;
+};
+
 /**
  * Display mode for individual filters
  * - 'canvas': Filter displayed as a draggable card on the dashboard canvas
@@ -1620,6 +1751,36 @@ declare type RelativeDateFilter = {
     to: number;
 };
 
+export declare type ResolvedDashboardInput = {
+    id: string;
+    kind: 'filter' | 'control';
+    label: string;
+    variableName: string;
+    requiredAtExecution: boolean;
+    slot?: DashboardInputSlot;
+    rawValue?: unknown;
+    displayValue: string;
+    exports: Partial<Record<DashboardInputExportKey, string | number | boolean | null>>;
+    filter?: TFilter;
+    filterValue?: TFilterValue;
+    control?: ControlDefinition;
+    controlValue?: unknown;
+    missingRequiredValue?: boolean;
+};
+
+export declare type ResolvedDashboardInputContext = {
+    inputs: DashboardInput[];
+    resolvedInputs: ResolvedDashboardInput[];
+    activeFilters: TFilterValue[];
+    controlDefinitions: ControlDefinition[];
+    cardControlDefinitions: ControlDefinition[];
+    controlBindings: ControlBinding[];
+    controlValues: Record<string, unknown>;
+    variablesByName: Record<string, ResolvedDashboardInput>;
+    variablesById: Record<string, ResolvedDashboardInput>;
+    missingRequiredInputs: ResolvedDashboardInput[];
+};
+
 export declare type ResolvedDocumentInput = {
     inputId: string;
     variableName: string;
@@ -2038,6 +2199,7 @@ export declare type TCardPreferences = {
     customVisualCode?: string;
     textVisualOptions?: {
         isDynamicText?: boolean;
+        content?: DashboardInputTextContent;
     };
     mapVisualOptions?: {
         topoJsonUrl?: string;
@@ -2201,6 +2363,8 @@ export declare type TDashboard = {
     defaultFilterValues?: TFilterValue[];
     controls?: ControlDefinition[];
     defaultControlValues?: Record<string, unknown>;
+    inputs?: DashboardInput[];
+    defaultInputValues?: DashboardInputValues;
     filterLayout?: FilterLayoutSettings;
 };
 
@@ -2332,6 +2496,8 @@ declare type TFilter = {
     location?: FilterLocation;
     hide?: boolean;
     id: string;
+    /** Alias exposed to document/text variables, for example {{region}}. */
+    variableName?: string;
     connectionId: string;
     title: string;
     column: string;
@@ -2465,6 +2631,8 @@ declare type TimeGranularity = 'day' | 'week' | 'month' | 'quarter' | 'year' | '
  */
 export declare type TInlineFilter = {
     id: string;
+    /** Alias exposed to document/text variables, for example {{region}}. */
+    variableName?: string;
     column: string;
     title: string;
     dataType: string;

package/dist/types/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const _={mode:"all"},E={tz:"UTC",weekStart:1,anchor:"now"},A={database:null,schema:null,table:null},T="__card_default__";exports.CONTROL_CARD_DEFAULT_VALUE=T;exports.DEFAULT_CALENDAR_CONTEXT=E;exports.DEFAULT_SEMANTIC_DOMAIN_ACCESS=_;exports.EMPTY_SELECTION=A;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const E=require("../chunks/common-types-nBuCd3u2.js"),T={mode:"all"},A={tz:"UTC",weekStart:1,anchor:"now"};exports.CONTROL_CARD_DEFAULT_VALUE=E.CONTROL_CARD_DEFAULT_VALUE;exports.EMPTY_SELECTION=E.EMPTY_SELECTION;exports.DEFAULT_CALENDAR_CONTEXT=A;exports.DEFAULT_SEMANTIC_DOMAIN_ACCESS=T;

package/dist/types/index.js

@@ -1,18 +1,15 @@
-const _ = {
+import { C as _, E as o } from "../chunks/common-types-C6cAQgyh.js";
+const E = {
   mode: "all"
-}, t = {
+}, A = {
   tz: "UTC",
   weekStart: 1,
   // Monday (ISO standard)
   anchor: "now"
-}, E = {
-  database: null,
-  schema: null,
-  table: null
-}, a = "__card_default__";
+};
 export {
-  a as CONTROL_CARD_DEFAULT_VALUE,
-  t as DEFAULT_CALENDAR_CONTEXT,
-  _ as DEFAULT_SEMANTIC_DOMAIN_ACCESS,
-  E as EMPTY_SELECTION
+  _ as CONTROL_CARD_DEFAULT_VALUE,
+  A as DEFAULT_CALENDAR_CONTEXT,
+  E as DEFAULT_SEMANTIC_DOMAIN_ACCESS,
+  o as EMPTY_SELECTION
 };

package/dist/types/main.d.ts

@@ -41,6 +41,15 @@ declare type Actions_2 = {
     setGlobalStyle: (style: TStyle) => void;
     setDefaultFilterValues: (filterValues: TFilterValue[] | undefined) => void;
     setDefaultControlValues: (controlValues: Record<string, unknown> | undefined) => void;
+    setDashboardInputs: (inputs: DashboardInput[]) => void;
+    upsertDashboardInput: (input: DashboardInput) => void;
+    removeDashboardInput: (inputId: string) => void;
+    setDefaultDashboardInputValues: (values: DashboardInputValues | undefined) => void;
+    setDashboardInputValues: (values: DashboardInputValues) => void;
+    setDashboardInputValuesAreAuthoritative: (isAuthoritative: boolean) => void;
+    setDashboardInputSlot: (input: Pick<DashboardInput, 'id' | 'runtimeScope'>, target: DashboardInputRuntimeTarget, slot: DashboardInputSlot) => void;
+    clearDashboardInputSlot: (input: Pick<DashboardInput, 'id' | 'runtimeScope'>, target: DashboardInputRuntimeTarget) => void;
+    removeDashboardInputSlot: (input: Pick<DashboardInput, 'id' | 'runtimeScope'>, target: DashboardInputRuntimeTarget) => void;
     setDashboardControlsModel: (controls: ControlDefinition[], defaultValues?: Record<string, unknown>, options?: DashboardControlsModelOptions) => void;
     updateDashboardControl: (controlId: string, updates: Partial<ControlDefinition>) => void;
     reorderDashboardControls: (orderedControlIds: string[]) => void;
@@ -62,10 +71,14 @@ declare type Actions_2 = {
     setThemeStyle: (themeStyle: StyleProps) => void;
     setDashboard: (dashboard: TDashboard, options?: {
         semanticExecutionPayload?: SemanticExecutionPayload;
+        dashboardInputValues?: DashboardInputValues;
+        dashboardInputValuesAreAuthoritative?: boolean;
     }) => void;
     setDashboardWithFilterValues: (dashboard: TDashboard, filterValues: TFilterValue[], runtimeOverrides?: Record<string, unknown>, options?: {
         selectedSheetId?: string | null;
         semanticExecutionPayload?: SemanticExecutionPayload;
+        dashboardInputValues?: DashboardInputValues;
+        dashboardInputValuesAreAuthoritative?: boolean;
     }) => void;
     hydrateRuntimeControlValues: (dashboard: TDashboard, runtimeOverrides?: Record<string, unknown>) => void;
     mergeSemanticExecutionPayload: (semanticExecutionPayload: SemanticExecutionPayload) => void;
@@ -100,7 +113,7 @@ declare type Actions_2 = {
     setCardInfo: (cardId: string, info: string) => void;
     setCardSql: (sheetId: string, cardId: string, sql: string) => void;
     setCardPython: (cardId: string, pythonCode: string) => void;
-    setCardDescription: (sheetId: string, cardId: string, description: string) => void;
+    setCardDescription: (sheetId: string, cardId: string, description: string, preferences?: TCard['preferences']) => void;
     setCardKpiOptions: (sheetId: string, cardId: string, kpiOptions: Record<string, any>) => void;
     updateCardFilters: (cardId: string, filters: FilterGroup | undefined) => void;
     clearCardFilters: (cardId: string) => void;
@@ -1300,6 +1313,11 @@ export declare type ControlBinding = {
 
 declare type ControlBindingsByCardId = Record<string, ControlBinding[] | undefined>;
 
+export declare type ControlDashboardInput = DashboardInputBase & {
+    kind: 'control';
+    control: ControlDefinition;
+};
+
 export declare type ControlDefinition = {
     id: string;
     label: string;
@@ -1483,6 +1501,124 @@ declare type DashboardFilterControlsButtonProps = {
     dropdownContentClassName?: string;
 };
 
+export declare type DashboardInput = FilterDashboardInput | ControlDashboardInput;
+
+export declare type DashboardInputBase = {
+    id: string;
+    label: string;
+    variableName: string;
+    description?: string;
+    requiredAtExecution?: boolean;
+    scope: DashboardInputScope;
+    runtimeScope: DashboardInputRuntimeScope;
+    presentation?: DashboardInputPresentation;
+    exports?: DashboardInputExportKey[];
+    compatibility?: DashboardInputCompatibilityMetadata;
+};
+
+export declare type DashboardInputCompatibilityMetadata = {
+    source: 'dashboardFilter';
+    filterId: string;
+} | {
+    source: 'dashboardControl';
+    controlId: string;
+} | {
+    source: 'cardInlineFilter';
+    cardId: string;
+    filterId: string;
+} | {
+    source: 'cardControl';
+    cardId: string;
+    controlId: string;
+} | {
+    source: 'documentInput';
+    sheetId: string;
+    inputId: string;
+};
+
+export declare type DashboardInputExecutionSnapshot = {
+    sheetId?: string;
+    cardId?: string;
+    mode: 'dashboard' | 'document' | 'visual';
+    dashboardInputValues: DashboardInputValues;
+    generatedAt?: string;
+    timezone?: string;
+};
+
+export declare type DashboardInputExportKey = 'label' | 'value' | 'start' | 'end' | 'range';
+
+export declare type DashboardInputPresentation = {
+    placement?: 'toolbar' | 'card_header' | 'advanced' | 'hidden';
+    widthPx?: number;
+    order?: number;
+};
+
+export declare type DashboardInputRuntimeScope = 'shared' | 'perSheet' | 'perCard' | 'perDocumentSection';
+
+declare type DashboardInputRuntimeTarget = {
+    sheetId?: string | null;
+    cardId?: string | null;
+    sectionId?: string | null;
+};
+
+export declare type DashboardInputScope = {
+    kind: 'allSheets';
+    sheetKinds?: Array<'dashboard' | 'document'>;
+} | {
+    kind: 'sheets';
+    sheetIds: string[];
+} | {
+    kind: 'cards';
+    cardIds: string[];
+} | {
+    kind: 'documentSections';
+    sheetId: string;
+    sectionIds: string[];
+};
+
+export declare type DashboardInputSlot = {
+    status: 'set';
+    value: DashboardInputValue;
+} | {
+    status: 'cleared';
+};
+
+export declare type DashboardInputTextContent = Array<{
+    type: 'text';
+    value: string;
+} | {
+    type: 'variable';
+    ref: DashboardInputVariableRef;
+}>;
+
+export declare type DashboardInputValue = {
+    kind: 'filter';
+    filterValue: TFilterValue;
+} | {
+    kind: 'control';
+    value: unknown;
+};
+
+export declare type DashboardInputValues = {
+    shared?: Record<string, DashboardInputSlot>;
+    bySheetId?: Record<string, Record<string, DashboardInputSlot>>;
+    byCardId?: Record<string, Record<string, DashboardInputSlot>>;
+    byDocumentSectionId?: Record<string, Record<string, DashboardInputSlot>>;
+};
+
+export declare type DashboardInputVariableRef = {
+    source: 'dashboardInput';
+    inputId: string;
+    export: DashboardInputExportKey;
+} | {
+    source: 'dashboardInputAlias';
+    variableName: string;
+    export?: DashboardInputExportKey;
+} | {
+    source: 'documentMeta';
+    key: 'generatedAt' | 'pageNumber' | 'pageCount';
+};
+
 declare type DashboardPlusProps = {
     showControls?: boolean;
     showFooter?: boolean;
@@ -1543,8 +1679,17 @@ export declare type DashboardProps = {
      * Document-local runtime values for print/render entry points. Values are
      * keyed by document input id and are intentionally separate from dashboard
      * filters/controls.
+     *
+     * @deprecated Use dashboardInputExecutionSnapshot for document print/export
+     * entry points backed by DashboardInput.
      */
     documentInputValues?: DocumentInputRuntimeValues;
+    /**
+     * Authoritative dashboard input runtime snapshot for print/render entry
+     * points. Document print/export should use this for DashboardInput-backed
+     * inputs instead of documentInputValues.
+     */
+    dashboardInputExecutionSnapshot?: DashboardInputExecutionSnapshot;
     /**
      * Render target for print entry points. Generic dashboard PDF exports also
      * use cardDisplay.mode="print"; document-specific print handling must only
@@ -1622,6 +1767,10 @@ export declare type DashboardStore = {
     controlValues: Record<string, unknown>;
     /** Runtime-only card-scoped control values, keyed by cardId then controlId. */
     cardControlValuesMap: Record<string, Record<string, unknown>>;
+    /** Runtime-only dashboard input values keyed by input runtime scope. */
+    dashboardInputValues: DashboardInputValues;
+    /** True when dashboardInputValues came from a strict execution snapshot. */
+    dashboardInputValuesAreAuthoritative: boolean;
     semanticExecutionPayload: SemanticExecutionPayload;
     isDashboardPanelOpen: boolean;
     drillHistory: Array<{
@@ -2069,7 +2218,8 @@ export declare function downloadDocumentPdf(apiServiceUrl: string, authToken: Au
     title: string;
     pageSize: string;
     orientation: string;
-    inputValues: DocumentInputRuntimeValues;
+    inputSnapshot?: DashboardInputExecutionSnapshot;
+    inputValues?: DocumentInputRuntimeValues;
     timezone?: string;
     password?: string;
 }): Promise<void>;
@@ -2721,6 +2871,11 @@ export declare interface FilterCondition {
     value: FilterValue;
 }
 
+export declare type FilterDashboardInput = DashboardInputBase & {
+    kind: 'filter';
+    filter: TFilter;
+};
+
 /**
  * Display mode for individual filters
  * - 'canvas': Filter displayed as a draggable card on the dashboard canvas
@@ -3584,6 +3739,36 @@ export declare function resolveDatamodelName(datamodelName: string): string;
 
 export declare const resolveDataType: (value: any) => string;
 
+export declare type ResolvedDashboardInput = {
+    id: string;
+    kind: 'filter' | 'control';
+    label: string;
+    variableName: string;
+    requiredAtExecution: boolean;
+    slot?: DashboardInputSlot;
+    rawValue?: unknown;
+    displayValue: string;
+    exports: Partial<Record<DashboardInputExportKey, string | number | boolean | null>>;
+    filter?: TFilter;
+    filterValue?: TFilterValue;
+    control?: ControlDefinition;
+    controlValue?: unknown;
+    missingRequiredValue?: boolean;
+};
+
+export declare type ResolvedDashboardInputContext = {
+    inputs: DashboardInput[];
+    resolvedInputs: ResolvedDashboardInput[];
+    activeFilters: TFilterValue[];
+    controlDefinitions: ControlDefinition[];
+    cardControlDefinitions: ControlDefinition[];
+    controlBindings: ControlBinding[];
+    controlValues: Record<string, unknown>;
+    variablesByName: Record<string, ResolvedDashboardInput>;
+    variablesById: Record<string, ResolvedDashboardInput>;
+    missingRequiredInputs: ResolvedDashboardInput[];
+};
+
 export declare type ResolvedDocumentInput = {
     inputId: string;
     variableName: string;
@@ -4259,6 +4444,7 @@ export declare type TCardPreferences = {
     customVisualCode?: string;
     textVisualOptions?: {
         isDynamicText?: boolean;
+        content?: DashboardInputTextContent;
     };
     mapVisualOptions?: {
         topoJsonUrl?: string;
@@ -4424,6 +4610,8 @@ export declare type TDashboard = {
     defaultFilterValues?: TFilterValue[];
     controls?: ControlDefinition[];
     defaultControlValues?: Record<string, unknown>;
+    inputs?: DashboardInput[];
+    defaultInputValues?: DashboardInputValues;
     filterLayout?: FilterLayoutSettings;
 };
 
@@ -4557,6 +4745,8 @@ export declare type TFilter = {
     location?: FilterLocation;
     hide?: boolean;
     id: string;
+    /** Alias exposed to document/text variables, for example {{region}}. */
+    variableName?: string;
     connectionId: string;
     title: string;
     column: string;
@@ -4696,6 +4886,8 @@ export declare type TimeGranularity = 'day' | 'week' | 'month' | 'quarter' | 'ye
  */
 export declare type TInlineFilter = {
     id: string;
+    /** Alias exposed to document/text variables, for example {{region}}. */
+    variableName?: string;
     column: string;
     title: string;
     dataType: string;