react-semaphor 0.1.428 → 0.1.430

package/dist/types/report-runtime-context.d.ts

@@ -0,0 +1,99 @@
+export declare type CalendarContext = {
+    tz: string;
+    weekStart: WeekStart;
+    anchor: 'now' | {
+        iso: string;
+    };
+    fiscalCalendar?: MonthAlignedFiscalCalendar;
+};
+
+export declare type CalendarPreferences = {
+    tz?: string;
+    weekStart?: WeekStart;
+};
+
+export declare type CalendarPreferencesResponse = {
+    stored: CalendarPreferences | null;
+    inherited: ResolvedCalendarPreferences;
+    inheritedSources: ResolvedCalendarPreferenceSources;
+    resolved: ResolvedCalendarPreferences;
+    sources: ResolvedCalendarPreferenceSources;
+};
+
+export declare const DEFAULT_CALENDAR_CONTEXT: CalendarContext;
+
+declare type LocaleStyle = 'short' | 'medium' | 'long';
+
+export declare type MonthAlignedFiscalCalendar = {
+    kind: 'month_aligned';
+    yearStartMonth: number;
+};
+
+export declare function parseCalendarContext(input: unknown): ReportRuntimeContextParseResult<CalendarContext>;
+
+export declare function parseCalendarPreferencesResponse(input: unknown): ReportRuntimeContextParseResult<CalendarPreferencesResponse>;
+
+export declare function parseReportRuntimeContext(input: unknown): ReportRuntimeContextParseResult<ReportRuntimeContext>;
+
+declare const REPORT_PREFERENCE_SOURCES: readonly ["viewer_user", "viewer_tenant_user", "session_initial", "viewer_tenant", "viewer_organization", "system_default"];
+
+declare type ReportPreferenceSource = (typeof REPORT_PREFERENCE_SOURCES)[number];
+
+export declare type ReportPreferenceSources = {
+    calendar: ResolvedCalendarPreferenceSources;
+    valueFormat: ResolvedValueFormatPreferenceSources;
+};
+
+export declare type ReportRuntimeContext = {
+    calendar: CalendarContext;
+    valueFormat: ResolvedValueFormatPreferences;
+    preferenceSources: ReportPreferenceSources;
+};
+
+export declare type ReportRuntimeContextParseResult<T> = {
+    ok: true;
+    value: T;
+} | {
+    ok: false;
+    issues: ReportRuntimeContextValidationIssue[];
+};
+
+export declare type ReportRuntimeContextValidationIssue = {
+    path: string;
+    code: 'invalid_type' | 'unknown_property' | 'invalid_timezone' | 'invalid_week_start' | 'invalid_anchor' | 'invalid_fiscal_calendar' | 'invalid_value_format' | 'invalid_preference_source';
+    message: string;
+};
+
+export declare type ResolvedCalendarPreferences = {
+    tz: string;
+    weekStart: WeekStart;
+};
+
+export declare type ResolvedCalendarPreferenceSources = {
+    tz: ReportPreferenceSource;
+    weekStart: ReportPreferenceSource;
+};
+
+declare type ResolvedValueFormatPreferences = {
+    locale: string;
+    dateStyle: LocaleStyle;
+    dateTime: {
+        dateStyle: LocaleStyle;
+        timeStyle: LocaleStyle;
+    };
+    defaultCurrency: string;
+};
+
+declare type ResolvedValueFormatPreferenceSources = {
+    locale: ReportPreferenceSource;
+    dateStyle: ReportPreferenceSource;
+    dateTime: {
+        dateStyle: ReportPreferenceSource;
+        timeStyle: ReportPreferenceSource;
+    };
+    defaultCurrency: ReportPreferenceSource;
+};
+
+export declare type WeekStart = 0 | 1 | 2 | 3 | 4 | 5 | 6;
+
+export { }

package/dist/types/shared.d.ts

@@ -295,12 +295,17 @@ declare interface ColumnSettings {
     totalsLabel?: string;
     numberFormat: {
         style: 'decimal' | 'currency' | 'percent' | 'scientific';
-        currency: string;
-        locale: string;
-        minimumFractionDigits: number;
-        maximumFractionDigits: number;
+        currency?: string;
+        locale?: string;
+        minimumFractionDigits?: number;
+        maximumFractionDigits?: number;
         useGrouping?: boolean;
         percentValueMode?: 'fraction' | 'whole';
+        scale?: number;
+        compact?: boolean;
+        negativeStyle?: 'minus' | 'parentheses';
+        prefix?: string;
+        suffix?: string;
         showDataBar: boolean;
         dataBarColor: string;
         dataBarMinValue?: number;
@@ -326,8 +331,6 @@ declare interface ColumnSettings {
     colorRanges: ColorRange_2[];
 }
 
-declare type ColumnSettingsMap = Record<string, ColumnSettings>;
-
 declare type ColumnTextWrap = 'default' | 'truncate' | 'wrap' | 'nowrap' | 'preserve';
 
 declare type ColumnType = 'string' | 'number' | 'date';
@@ -465,7 +468,7 @@ declare type ControlBinding = {
     controlId: string;
     target: 'config_grain';
     mapping: Record<string, string>;
-};
+} | CurrencyPresentationBinding;
 
 declare type ControlDashboardInput = DashboardInputBase & {
     kind: 'control';
@@ -520,6 +523,23 @@ declare type ControlSource = {
 
 declare type ControlType = 'enum' | 'multi_enum' | 'text' | 'number' | 'boolean' | 'date' | 'field_selector' | 'metric_selector' | 'aggregation_selector' | 'grain_selector';
 
+declare type CurrencyPresentationBinding = {
+    controlId: string;
+    target: 'presentation_currency';
+    presentationTarget: CurrencyPresentationTarget;
+};
+
+declare type CurrencyPresentationTarget = {
+    kind: 'metric';
+    metricId: string;
+} | {
+    kind: 'column';
+    columnKey: string;
+} | {
+    kind: 'matrix_measure';
+    measureId: string;
+};
+
 declare type CustomCard = CardWithContent | CardWithFooter;
 
 declare type DashboardAIContext = AIContext & {
@@ -1603,6 +1623,12 @@ declare interface PaginationConfig {
     pageSize: number;
 }
 
+declare type PersistedColumnSettings = Omit<Partial<ColumnSettings>, 'numberFormat'> & {
+    numberFormat?: Partial<ColumnSettings['numberFormat']>;
+};
+
+declare type PersistedColumnSettingsMap = Record<string, PersistedColumnSettings>;
+
 declare type PersistedInteraction = Interaction & {
     id?: string;
 };
@@ -1933,7 +1959,6 @@ declare type SemaphorTimeGrain = 'hour' | 'day' | 'week' | 'month' | 'quarter' |
 
 declare type SemaphorValueFormat = {
     type: 'number' | 'currency' | 'percent' | 'percentage' | 'scientific';
-    locale?: string;
     minimumFractionDigits?: number;
     maximumFractionDigits?: number;
     useGrouping?: boolean;
@@ -2082,7 +2107,7 @@ declare type TableHeaderStyle = 'plain' | 'filled' | 'accent';
 declare type TablePart = 'body' | 'header' | 'footer' | 'subtotal' | 'grandTotal';
 
 declare type TablePreferences = {
-    columnSettingsMap?: ColumnSettingsMap;
+    columnSettingsMap?: PersistedColumnSettingsMap;
     baseFormatting?: TableBaseFormatting;
     conditionalFormatting?: TableConditionalFormatting;
     selectColumnVisible?: boolean;

package/dist/types/surfboard.d.ts

@@ -1,5 +1,4 @@
 import { ColumnSizingState } from '@tanstack/react-table';
-import { default as default_2 } from 'react';
 import { FontSpec } from 'chart.js';
 import { JSX } from 'react';
 
@@ -204,12 +203,14 @@ declare interface CalculatedFieldFormula {
  */
 declare type CalculatedFieldOperation = 'sum' | 'difference' | 'product' | 'ratio' | 'change' | 'percentage' | 'scale' | 'custom';
 
-export declare function CalendarPreferencesDialog({ open, onOpenChange, }: CalendarPreferencesDialogProps): default_2.JSX.Element;
-
-declare interface CalendarPreferencesDialogProps {
-    open: boolean;
-    onOpenChange: (open: boolean) => void;
-}
+declare type CalendarContext = {
+    tz: string;
+    weekStart: WeekStart;
+    anchor: 'now' | {
+        iso: string;
+    };
+    fiscalCalendar?: MonthAlignedFiscalCalendar;
+};
 
 declare interface CardConfig {
     /**
@@ -395,12 +396,17 @@ declare interface ColumnSettings {
     totalsLabel?: string;
     numberFormat: {
         style: 'decimal' | 'currency' | 'percent' | 'scientific';
-        currency: string;
-        locale: string;
-        minimumFractionDigits: number;
-        maximumFractionDigits: number;
+        currency?: string;
+        locale?: string;
+        minimumFractionDigits?: number;
+        maximumFractionDigits?: number;
         useGrouping?: boolean;
         percentValueMode?: 'fraction' | 'whole';
+        scale?: number;
+        compact?: boolean;
+        negativeStyle?: 'minus' | 'parentheses';
+        prefix?: string;
+        suffix?: string;
         showDataBar: boolean;
         dataBarColor: string;
         dataBarMinValue?: number;
@@ -426,8 +432,6 @@ declare interface ColumnSettings {
     colorRanges: ColorRange_2[];
 }
 
-declare type ColumnSettingsMap = Record<string, ColumnSettings>;
-
 declare type ColumnTextWrap = 'default' | 'truncate' | 'wrap' | 'nowrap' | 'preserve';
 
 declare type ColumnType = 'string' | 'number' | 'date';
@@ -573,7 +577,7 @@ export declare type ControlBinding = {
     controlId: string;
     target: 'config_grain';
     mapping: Record<string, string>;
-};
+} | CurrencyPresentationBinding;
 
 export declare type ControlDashboardInput = DashboardInputBase & {
     kind: 'control';
@@ -628,6 +632,23 @@ export declare type ControlSource = {
 
 export declare type ControlType = 'enum' | 'multi_enum' | 'text' | 'number' | 'boolean' | 'date' | 'field_selector' | 'metric_selector' | 'aggregation_selector' | 'grain_selector';
 
+export declare type CurrencyPresentationBinding = {
+    controlId: string;
+    target: 'presentation_currency';
+    presentationTarget: CurrencyPresentationTarget;
+};
+
+export declare type CurrencyPresentationTarget = {
+    kind: 'metric';
+    metricId: string;
+} | {
+    kind: 'column';
+    columnKey: string;
+} | {
+    kind: 'matrix_measure';
+    measureId: string;
+};
+
 export declare type CustomCard = CardWithContent | CardWithFooter;
 
 declare type DashboardAIContext = AIContext & {
@@ -965,6 +986,16 @@ declare type Dialect = 'mysql' | 'postgres' | 'bigquery' | 'redshift' | 'snowfla
 
 export declare type DisplayDataType = 'string' | 'date' | 'number' | 'html' | 'none';
 
+export declare function DisplayFormatPreferencesFields({ value, inherited, inheritedSources, onChange, disabled, }: DisplayFormatPreferencesFieldsProps): JSX.Element;
+
+export declare type DisplayFormatPreferencesFieldsProps = {
+    value: ValueFormatPreferences;
+    inherited: ResolvedValueFormatPreferences;
+    inheritedSources: Pick<ResolvedValueFormatPreferenceSources, 'locale' | 'defaultCurrency'>;
+    onChange: (value: ValueFormatPreferences) => void;
+    disabled?: boolean;
+};
+
 export declare type DocumentChartSection = {
     id: string;
     type: 'chart';
@@ -1572,6 +1603,7 @@ declare type FormatSpec = {
 
 export declare type GetDashboardResponse = {
     dashboard: TDashboard;
+    initialReportContext: ReportRuntimeContext;
     lenses: TLens[];
     filterValues?: TFilterValue[] | null;
     inputValues?: LensInputValuesSnapshot | null;
@@ -1753,6 +1785,8 @@ export declare type LoadingProps = {
     message?: string;
 };
 
+declare type LocaleStyle = 'short' | 'medium' | 'long';
+
 declare type LogicalOperator = 'AND' | 'OR';
 
 /**
@@ -1847,6 +1881,11 @@ declare interface MetricField extends Field {
     semanticComparisonPolarity?: MetricComparisonPolarity;
 }
 
+declare type MonthAlignedFiscalCalendar = {
+    kind: 'month_aligned';
+    yearStartMonth: number;
+};
+
 declare type NoneOptions = {};
 
 export declare type NumberAxisFormat = {
@@ -1898,6 +1937,12 @@ declare type Params = {
     [key: string]: string | number | string[] | number[];
 };
 
+declare type PersistedColumnSettings = Omit<Partial<ColumnSettings>, 'numberFormat'> & {
+    numberFormat?: Partial<ColumnSettings['numberFormat']>;
+};
+
+declare type PersistedColumnSettingsMap = Record<string, PersistedColumnSettings>;
+
 declare type PersistedInteraction = Interaction & {
     id?: string;
 };
@@ -1965,6 +2010,33 @@ declare type RelativeDateFilter = {
     to: number;
 };
 
+declare const REPORT_PREFERENCE_SOURCES: readonly ["viewer_user", "viewer_tenant_user", "session_initial", "viewer_tenant", "viewer_organization", "system_default"];
+
+export declare function ReportPreferencesDialog({ open, onOpenChange, }: ReportPreferencesDialogProps): JSX.Element;
+
+declare type ReportPreferencesDialogProps = {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+};
+
+declare type ReportPreferenceSource = (typeof REPORT_PREFERENCE_SOURCES)[number];
+
+declare type ReportPreferenceSources = {
+    calendar: ResolvedCalendarPreferenceSources;
+    valueFormat: ResolvedValueFormatPreferenceSources;
+};
+
+declare type ReportRuntimeContext = {
+    calendar: CalendarContext;
+    valueFormat: ResolvedValueFormatPreferences;
+    preferenceSources: ReportPreferenceSources;
+};
+
+declare type ResolvedCalendarPreferenceSources = {
+    tz: ReportPreferenceSource;
+    weekStart: ReportPreferenceSource;
+};
+
 export declare type ResolvedDashboardDateComparisonInput = {
     inputId: string;
     filterId: string;
@@ -2040,6 +2112,26 @@ declare type ResolvedPrimaryDateField = {
     supportedGranularities?: TimeGranularity[];
 } | null;
 
+declare type ResolvedValueFormatPreferences = {
+    locale: string;
+    dateStyle: LocaleStyle;
+    dateTime: {
+        dateStyle: LocaleStyle;
+        timeStyle: LocaleStyle;
+    };
+    defaultCurrency: string;
+};
+
+declare type ResolvedValueFormatPreferenceSources = {
+    locale: ReportPreferenceSource;
+    dateStyle: ReportPreferenceSource;
+    dateTime: {
+        dateStyle: ReportPreferenceSource;
+        timeStyle: ReportPreferenceSource;
+    };
+    defaultCurrency: ReportPreferenceSource;
+};
+
 declare type SelectedEntities = SelectedEntity[];
 
 declare type SelectedEntity = DatabaseEntityReference | DataModelEntityReference | DatasetEntityReference | FileEntityReference;
@@ -2326,7 +2418,6 @@ declare type SemaphorTimeGrain = 'hour' | 'day' | 'week' | 'month' | 'quarter' |
 
 declare type SemaphorValueFormat = {
     type: 'number' | 'currency' | 'percent' | 'percentage' | 'scientific';
-    locale?: string;
     minimumFractionDigits?: number;
     maximumFractionDigits?: number;
     useGrouping?: boolean;
@@ -2524,7 +2615,7 @@ declare type TableHeaderStyle = 'plain' | 'filled' | 'accent';
 declare type TablePart = 'body' | 'header' | 'footer' | 'subtotal' | 'grandTotal';
 
 declare type TablePreferences = {
-    columnSettingsMap?: ColumnSettingsMap;
+    columnSettingsMap?: PersistedColumnSettingsMap;
     baseFormatting?: TableBaseFormatting;
     conditionalFormatting?: TableConditionalFormatting;
     selectColumnVisible?: boolean;
@@ -3421,6 +3512,16 @@ export declare interface UserPreference {
     updatedAt: string;
 }
 
+declare type ValueFormatPreferences = {
+    locale?: string;
+    dateStyle?: LocaleStyle;
+    dateTime?: {
+        dateStyle?: LocaleStyle;
+        timeStyle?: LocaleStyle;
+    };
+    defaultCurrency?: string;
+};
+
 declare type ViewerPeriodComparisonSpec = Extract<MetricComparisonSpec, {
     kind: 'previous_period' | 'previous_year';
 }>;
@@ -3461,6 +3562,8 @@ export declare type VisualDisplayPreferences = {
     };
 };
 
+declare type WeekStart = 0 | 1 | 2 | 3 | 4 | 5 | 6;
+
 declare type WindowFunction = 'running_total' | 'moving_average' | 'previous_period_delta' | 'percent_of_total';
 
 declare interface WindowTransform {