@thoughtspot/visual-embed-sdk 1.47.1 → 1.47.3

package/src/types.ts

@@ -1994,6 +1994,22 @@ export interface LiveboardAppEmbedViewConfig {
      * ```
      */
     isLiveboardMasterpiecesEnabled?: boolean;
+    /**
+     * Enable or disable Muze chart phase 1 GA
+     *
+     * Supported embed types: `AppEmbed`, `LiveboardEmbed`
+     * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
+     * @default false
+     * @example
+     * ```js
+     * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
+     * const embed = new <EmbedComponent>('#tsEmbed', {
+     *    ... // other embed view config
+     *    newChartsLibrary: true,
+     * })
+     * ```
+     */
+    newChartsLibrary?: boolean;
 }
 
 export interface AllEmbedViewConfig
@@ -3636,6 +3652,56 @@ export enum EmbedEvent {
      * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
      */
     RefreshAuthToken = 'RefreshAuthToken',
+
+    /**
+     * Triggered whenever the page context changes, returning the current context along with the navigation stack.
+     * @example
+     * ```js
+     * embed.on(EmbedEvent.EmbedPageContextChanged, (payload) => {
+     *     console.log('payload', payload);
+     * })
+     * ```
+     * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
+     */
+    EmbedPageContextChanged = 'EmbedPageContextChanged',
+
+    /**
+     * Represents a special embed event that is triggered whenever any host event is subscribed.
+     *
+     * You can listen to this event when you need to dispatch a host event during load or render,
+     * particularly in situations where timing issues may occur.
+     *
+     * @example
+     * ```js
+     * embed.on(`${HostEvent.Save} Subscribed`, () => {
+     *     // make action
+     * });
+     * ```
+     * 
+     * @example
+     * ```js
+     * embed.on(subscribedEvent(HostEvent.Save), () => {
+     *     // make action
+     * });
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot: 26.4.0.cl
+     */
+    Subscribed = 'Subscribed',
+    
+    /**
+     * Emitted when a user clicks the **Send Test Email** button in the
+     * Liveboard schedule modal. Requires `isSendNowLiveboardSchedulingEnabled`
+     * to be enabled.
+     * @example
+     * ```js
+     * liveboardEmbed.on(EmbedEvent.SendTestScheduleEmail, (payload) => {
+     *     console.log('Send test email', payload);
+     *     // payload: { liveboardId: string, sendToSelf: boolean }
+     * })
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     */
+    SendTestScheduleEmail = 'sendTestScheduleEmail',
 }
 
 /**
@@ -5336,7 +5402,8 @@ export enum HostEvent {
      * ```js
      * // Get parameters from liveboard context
      * import { ContextType } from '@thoughtspot/visual-embed-sdk';
-     * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
+     * liveboardEmbed.trigger(HostEvent.GetParameters, {},
+     * ContextType.Liveboard).then((parameters) => {
      *     console.log('parameters', parameters);
      * });
      * ```
@@ -5690,6 +5757,26 @@ export enum HostEvent {
      * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
      */
     GetPageContext = 'GetPageContext',
+    /**
+     * Trigger the **Send Test Email** action in the Liveboard schedule modal.
+     * Sends a test schedule email to self or all recipients.
+     * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
+     *     sendToSelf: true,
+     * })
+     * ```
+     * @example
+     * ```js
+     * // Send to all recipients
+     * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
+     *     sendToSelf: false,
+     * })
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     */
+    SendTestScheduleEmail = 'sendTestScheduleEmail',
 }
 
 /**
@@ -5791,6 +5878,7 @@ export enum Param {
     ShowLiveboardTitle = 'showLiveboardTitle',
     ShowMaskedFilterChip = 'showMaskedFilterChip',
     IsLiveboardMasterpiecesEnabled = 'isLiveboardMasterpiecesEnabled',
+    EnableNewChartLibrary = 'muzeChartPhase1EnabledGA',
     HiddenTabs = 'hideTabs',
     VisibleTabs = 'visibleTabs',
     HideTabPanel = 'hideTabPanel',
@@ -5846,6 +5934,7 @@ export enum Param {
     IsWYSIWYGLiveboardPDFEnabled = 'isWYSIWYGLiveboardPDFEnabled',
     isLiveboardXLSXCSVDownloadEnabled = 'isLiveboardXLSXCSVDownloadEnabled',
     isGranularXLSXCSVSchedulesEnabled = 'isGranularXLSXCSVSchedulesEnabled',
+    isSendNowLiveboardSchedulingEnabled = 'isSendNowLiveboardSchedulingEnabled',
     isCentralizedLiveboardFilterUXEnabled = 'isCentralizedLiveboardFilterUXEnabled',
     isLinkParametersEnabled = 'isLinkParametersEnabled',
     EnablePastConversationsSidebar = 'enablePastConversationsSidebar',
@@ -5865,6 +5954,7 @@ export enum Param {
     HideToolResponseCardBranding = 'hideToolResponseCardBranding',
     ToolResponseCardBrandingLabel = 'toolResponseCardBrandingLabel',
     EnableHomepageAnnouncement = 'enableHomepageAnnouncement',
+    EnableLiveboardDataCache = 'enableLiveboardDataCache',
 }
 
 /**
@@ -6187,7 +6277,7 @@ export enum Action {
      * ```js
      * disabledActions: [Action.DownloadLiveboard]
      * ```
-     * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
+     * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
      */
     DownloadLiveboard = 'downloadLiveboard',
     /**
@@ -6200,6 +6290,26 @@ export enum Action {
      * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
      */
     DownloadLiveboardAsContinuousPDF = 'downloadLiveboardAsContinuousPDF',
+    /**
+     * The **Download Liveboard as XLSX** menu action on a Liveboard.
+     * Allows downloading the entire Liveboard as an XLSX file.
+     * @example
+     * ```js
+     * disabledActions: [Action.DownloadLiveboardAsXlsx]
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+     */
+    DownloadLiveboardAsXlsx = 'downloadLiveboardAsXlsx',
+    /**
+     * The **Download Liveboard as CSV** menu action on a Liveboard.
+     * Allows downloading the entire Liveboard as a CSV file.
+     * @example
+     * ```js
+     * disabledActions: [Action.DownloadLiveboardAsCsv]
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
+     */
+    DownloadLiveboardAsCsv = 'downloadLiveboardAsCsv',
     /**
      * @hidden
      */
@@ -7481,6 +7591,18 @@ export enum Action {
      * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
      */
     IncludeCurrentPeriod = 'includeCurrentPeriod',
+    /**
+     * The **Send Test Email** button in the Liveboard schedule modal.
+     * Allows sending a test schedule email to self or all recipients.
+     * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
+     * @example
+     * ```js
+     * disabledActions: [Action.SendTestScheduleEmail]
+     * hiddenActions: [Action.SendTestScheduleEmail]
+     * ```
+     * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
+     */
+    SendTestScheduleEmail = 'sendTestScheduleEmail',
 }
 export interface AnswerServiceType {
     getAnswer?: (offset: number, batchSize: number) => any;
@@ -8092,3 +8214,440 @@ export interface ContextObject {
         objectIds: ObjectIds;
     };
 }
+
+
+// ─── Visual Overrides ────────────────────────────────────────────────────────
+
+export interface FontProperties {
+    color?: string;
+    bold?: boolean;
+    italic?: boolean;
+    strikeThrough?: boolean;
+    underline?: boolean;
+}
+
+export interface SolidBackgroundAttrs {
+    color?: string;
+}
+
+export interface GradientBackgroundAttrs {
+    backgroundFormatMidpoint?: number;
+    colors?: string[];
+    backgroundFormatRange?: number[];
+    isAutoScaled?: boolean;
+}
+
+/**
+ * Data label filter operators
+ * @group Visual Overrides
+ */
+export enum DataLabelFilterOperator {
+    /** Greater than */
+    GreaterThan = 'GREATER_THAN',
+    /** Less than */
+    LessThan = 'LESS_THAN',
+    /** Greater than or equal to */
+    GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO',
+    /** Less than or equal to */
+    LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO',
+    /** Equal to */
+    EqualTo = 'EQUAL_TO',
+    /** Not equal to */
+    NotEqualTo = 'NOT_EQUAL_TO',
+}
+
+/**
+ * Conditional formatting operators
+ * @group Visual Overrides
+ */
+export enum ConditionalFormattingOperator {
+    /** Is equal to */
+    Is = 'IS',
+    /** Is not equal to */
+    IsNot = 'IS_NOT',
+    /** Contains */
+    Contains = 'CONTAINS',
+    /** Does not contain */
+    DoesNotContain = 'DOES_NOT_CONTAIN',
+    /** Starts with */
+    StartsWith = 'STARTS_WITH',
+    /** Ends with */
+    EndsWith = 'ENDS_WITH',
+    /** Greater than */
+    GreaterThan = 'GREATER_THAN',
+    /** Less than */
+    LessThan = 'LESS_THAN',
+    /** Greater than or equal to */
+    GreaterThanEqualTo = 'GREATER_THAN_EQUAL_TO',
+    /** Less than or equal to */
+    LessThanEqualTo = 'LESS_THAN_EQUAL_TO',
+    /** Equal to */
+    EqualTo = 'EQUAL_TO',
+    /** Not equal to */
+    NotEqualTo = 'NOT_EQUAL_TO',
+    /** Is between */
+    IsBetween = 'IS_BETWEEN',
+    /** Is null */
+    IsNull = 'IS_NULL',
+    /** Is not null */
+    IsNotNull = 'IS_NOT_NULL',
+}
+
+/**
+ * Background format types for conditional formatting
+ * @group Visual Overrides
+ */
+export enum BackgroundFormatType {
+    /** Solid color background */
+    Solid = 'SOLID',
+    /** Gradient background */
+    Gradient = 'GRADIENT',
+}
+
+/**
+ * Comparison types for conditional formatting
+ * @group Visual Overrides
+ */
+export enum ConditionalFormattingComparisonType {
+    /** Value-based comparison */
+    ValueBased = 'VALUE_BASED',
+    /** Column-based comparison */
+    ColumnBased = 'COLUMN_BASED',
+    /** Parameter-based comparison */
+    ParameterBased = 'PARAMETER_BASED',
+}
+
+/**
+ * A single conditional formatting rule row
+ * @group Visual Overrides
+ */
+export interface ConditionalFormattingRow {
+    /** Comparison operator */
+    operator: ConditionalFormattingOperator | string;
+    /** Value to compare against */
+    value?: string;
+    /** Range values for range-based comparisons */
+    rangeValues?: { min: number; max: number };
+    /** Plot the formatting as a band/area */
+    plotAsBand?: boolean;
+    /** Highlight this row if the condition is met */
+    isHighlightRow?: boolean;
+    /** Type of comparison: value-based, column-based, or parameter-based */
+    comparisonType?: ConditionalFormattingComparisonType | string;
+    /** Column ID to apply the formatting to (left-hand side) */
+    lhsColumnId?: string;
+    /** Column name to compare against (right-hand side) */
+    columnToCompare?: string;
+    /** Parameter ID to compare against */
+    comparisonParameterId?: string;
+    /** Font properties to apply (color, bold, italic, etc.) */
+    fontProperties?: FontProperties;
+    /** Background format type: solid color or gradient */
+    backgroundFormatType?: BackgroundFormatType | string;
+    /** Solid background color attributes */
+    solidBackgroundAttrs?: SolidBackgroundAttrs;
+    /** Gradient background attributes */
+    gradientBackgroundAttrs?: GradientBackgroundAttrs;
+}
+
+/**
+ * Conditional formatting configuration
+ * @group Visual Overrides
+ */
+export interface ConditionalFormatting {
+    /** Array of conditional formatting rules */
+    rows?: ConditionalFormattingRow[];
+}
+
+/**
+ * Color palette for charts
+ * @group Visual Overrides
+ */
+export interface ColorPalette {
+    /** Array of color values (hex codes or color names) */
+    colors?: string[];
+}
+
+/**
+ * Legend position options
+ * @group Visual Overrides
+ */
+export enum LegendPosition {
+    /** Position legend at the top */
+    Top = 'top',
+    /** Position legend at the bottom */
+    Bottom = 'bottom',
+    /** Position legend on the left */
+    Left = 'left',
+    /** Position legend on the right */
+    Right = 'right',
+}
+
+/**
+ * Table theme options
+ * @group Visual Overrides
+ */
+export enum TableTheme {
+    /** Outline theme */
+    Outline = 'OUTLINE',
+    /** Row theme */
+    Row = 'ROW',
+    /** Zebra theme */
+    Zebra = 'ZEBRA',
+}
+
+/**
+ * Table content density options
+ * @group Visual Overrides
+ */
+export enum TableContentDensity {
+    /** Regular density */
+    Regular = 'REGULAR',
+    /** Compact density */
+    Compact = 'COMPACT',
+}
+
+/**
+ * Chart legend configuration
+ * @group Visual Overrides
+ */
+export interface ChartLegend {
+    /** Show or hide the legend */
+    show?: boolean;
+    /** Position of the legend */
+    position?: LegendPosition | string;
+    /** Color palette to use for legend colors */
+    colorPalette?: ColorPalette;
+}
+
+/**
+ * Filter for data labels
+ * @group Visual Overrides
+ */
+export interface DataLabelFilter {
+    /** Filter threshold value */
+    value?: number;
+    /** Filter operator */
+    operator?: DataLabelFilterOperator | string;
+}
+
+/**
+ * Data label configuration for a specific column
+ * @group Visual Overrides
+ */
+export interface ColumnDataLabel {
+    /** Column name to apply data label overrides to */
+    name: string;
+    /** Show or hide data labels for this column */
+    visible?: boolean;
+    /** Filter to apply to data labels */
+    filter?: DataLabelFilter | null;
+}
+
+/**
+ * Chart data label configuration
+ * @group Visual Overrides
+ */
+export interface ChartDataLabel {
+    /** Show labels for all data points */
+    allLabels?: boolean;
+    /** Show labels for stacked values */
+    stackLabels?: boolean;
+    /** Per-column data label configurations */
+    columnDataLabel?: ColumnDataLabel[];
+}
+
+/**
+ * Chart summaries and totals configuration
+ * @group Visual Overrides
+ */
+export interface ChartSummaries {
+    /** Show row totals */
+    showRowTotals?: boolean;
+    /** Show column totals */
+    showColumnTotals?: boolean;
+    /** Show row grand totals */
+    showRowGrandTotals?: boolean;
+    /** Show column grand totals */
+    showColumnGrandTotals?: boolean;
+}
+
+/**
+ * Gridline configuration
+ * @group Visual Overrides
+ */
+export interface GridLine {
+    /** Show vertical gridlines */
+    x?: boolean;
+    /** Show horizontal gridlines */
+    y?: boolean;
+}
+
+/**
+ * Chart display configuration
+ * @group Visual Overrides
+ */
+export interface ChartDisplay {
+    /** Summary and totals configuration */
+    summaries?: ChartSummaries;
+    /** Show regression line on chart */
+    regressionLine?: boolean;
+    /** Gridline visibility configuration */
+    gridLine?: GridLine;
+}
+
+/**
+ * Y-axis range configuration
+ * @group Visual Overrides
+ */
+export interface YAxisRange {
+    /** Minimum value for Y-axis */
+    min?: number;
+    /** Maximum value for Y-axis */
+    max?: number;
+}
+
+/**
+ * Chart axis configuration
+ * @group Visual Overrides
+ */
+export interface ChartAxis {
+    /** Column names to link to this axis */
+    linkedColumns?: string[];
+    /** Show the axis name */
+    showName?: boolean;
+    /** Show the axis label values */
+    showLabelValue?: boolean;
+    /** Y-axis range configuration */
+    yAxisRange?: YAxisRange;
+}
+
+/**
+ * Chart column override configuration
+ * @group Visual Overrides
+ */
+export interface ChartColumn {
+    /** Column name to apply overrides to */
+    name: string;
+    /** Color for the column (hex code) */
+    color?: string;
+    /** Conditional formatting rules to apply to the column */
+    conditionalFormatting?: ConditionalFormatting;
+}
+
+/**
+ * Chart visualization overrides
+ * @group Visual Overrides
+ */
+export interface ChartOverrides {
+    /** Legend configuration */
+    legend?: ChartLegend;
+    /** Data label configuration */
+    dataLabel?: ChartDataLabel;
+    /** Display properties (summaries, regression line, gridlines) */
+    display?: ChartDisplay;
+    /** Per-axis configurations */
+    axis?: ChartAxis[];
+    /** Per-column configurations */
+    columns?: ChartColumn[];
+    /** Update mask paths for partial updates */
+    updateMaskPaths?: string[];
+}
+
+/**
+ * Table column override configuration
+ * @group Visual Overrides
+ */
+export interface TableColumn {
+    /**
+     * Name of the column to apply overrides to
+     */
+    name: string;
+    /**
+     * Enable or disable text wrapping for the column
+     */
+    wrapText?: boolean;
+    /**
+     * Show or hide the column
+     */
+    show?: boolean;
+    /**
+     * Conditional formatting rules to apply to the column
+     */
+    conditionalFormatting?: ConditionalFormatting;
+}
+
+/**
+ * Table display configuration
+ * @group Visual Overrides
+ */
+export interface TableDisplay {
+    /** Table theme */
+    tableTheme?: TableTheme | string;
+    /** Table content density */
+    tableContentDensity?: TableContentDensity | string;
+}
+
+/**
+ * Column summary visibility configuration
+ * @group Visual Overrides
+ */
+export interface ColumnSummaryVisibility {
+    /** Column ID to control summary visibility for */
+    columnId: string;
+    /** Show or hide summary for this column */
+    visible: boolean;
+}
+
+/**
+ * Display summary configuration
+ * @group Visual Overrides
+ */
+export interface DisplaySummaryConfig {
+    /** Show all column summaries by default */
+    showAllSummaries?: boolean;
+    /** Per-column summary visibility overrides */
+    columnVisibility?: ColumnSummaryVisibility[];
+}
+
+/**
+ * Table visualization overrides
+ * @group Visual Overrides
+ */
+export interface TableOverrides {
+    /** Per-column configurations (properties, conditional formatting) */
+    columns?: TableColumn[];
+    /** Table display properties (theme, density) */
+    display?: TableDisplay;
+    /** Summary/headline column visibility configuration */
+    displaySummaryConfig?: DisplaySummaryConfig;
+    /** Update mask paths for partial updates */
+    updateMaskPaths?: string[];
+}
+
+/**
+ * Visualization overrides to customize chart and table rendering
+ * within embedded ThoughtSpot components.
+ *
+ * @group Visual Overrides
+ * @example
+ * ```js
+ * const embed = new AppEmbed('#tsEmbed', {
+ *   visualOverrides: {
+ *     chart: {
+ *       legend: { show: true, position: 'bottom' },
+ *       columns: [{ name: 'Revenue', color: '#1f77b4' }],
+ *     },
+ *     table: {
+ *       display: { tableTheme: 'ZEBRA', tableContentDensity: 'COMPACT' },
+ *     },
+ *   },
+ * });
+ * ```
+ */
+export interface VisualizationOverrides {
+    /** Chart visualization overrides */
+    chart?: ChartOverrides;
+    /** Table visualization overrides */
+    table?: TableOverrides;
+}