@thoughtspot/visual-embed-sdk 1.47.1 → 1.47.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (159) hide show
  1. package/cjs/package.json +3 -3
  2. package/cjs/src/embed/app.d.ts +19 -1
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +7 -1
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/app.spec.js +141 -0
  7. package/cjs/src/embed/app.spec.js.map +1 -1
  8. package/cjs/src/embed/conversation.d.ts +2 -1
  9. package/cjs/src/embed/conversation.d.ts.map +1 -1
  10. package/cjs/src/embed/conversation.js.map +1 -1
  11. package/cjs/src/embed/hostEventClient/contracts.d.ts +4 -1
  12. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  13. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +2 -2
  14. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  15. package/cjs/src/embed/liveboard.d.ts +13 -0
  16. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  17. package/cjs/src/embed/liveboard.js +7 -1
  18. package/cjs/src/embed/liveboard.js.map +1 -1
  19. package/cjs/src/embed/liveboard.spec.js +54 -0
  20. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  21. package/cjs/src/embed/search.d.ts +24 -1
  22. package/cjs/src/embed/search.d.ts.map +1 -1
  23. package/cjs/src/embed/search.js +15 -2
  24. package/cjs/src/embed/search.js.map +1 -1
  25. package/cjs/src/embed/search.spec.js +99 -0
  26. package/cjs/src/embed/search.spec.js.map +1 -1
  27. package/cjs/src/embed/spotter-utils.d.ts +3 -0
  28. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  29. package/cjs/src/embed/spotter-utils.js +11 -3
  30. package/cjs/src/embed/spotter-utils.js.map +1 -1
  31. package/cjs/src/embed/spotter-utils.spec.js +51 -0
  32. package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
  33. package/cjs/src/embed/ts-embed.d.ts +14 -1
  34. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  35. package/cjs/src/embed/ts-embed.js +29 -3
  36. package/cjs/src/embed/ts-embed.js.map +1 -1
  37. package/cjs/src/embed/ts-embed.spec.js +139 -0
  38. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  39. package/cjs/src/index.d.ts +2 -2
  40. package/cjs/src/index.d.ts.map +1 -1
  41. package/cjs/src/index.js +8 -1
  42. package/cjs/src/index.js.map +1 -1
  43. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  44. package/cjs/src/mixpanel-service.js +2 -0
  45. package/cjs/src/mixpanel-service.js.map +1 -1
  46. package/cjs/src/mixpanel-service.spec.js +2 -0
  47. package/cjs/src/mixpanel-service.spec.js.map +1 -1
  48. package/cjs/src/test/test-utils.d.ts +1 -0
  49. package/cjs/src/test/test-utils.d.ts.map +1 -1
  50. package/cjs/src/test/test-utils.js +26 -1
  51. package/cjs/src/test/test-utils.js.map +1 -1
  52. package/cjs/src/types.d.ts +532 -6
  53. package/cjs/src/types.d.ts.map +1 -1
  54. package/cjs/src/types.js +225 -3
  55. package/cjs/src/types.js.map +1 -1
  56. package/dist/{index-CUgxBnPm.js → index-DZq20cR6.js} +1 -1
  57. package/dist/src/embed/app.d.ts +19 -1
  58. package/dist/src/embed/app.d.ts.map +1 -1
  59. package/dist/src/embed/conversation.d.ts +2 -1
  60. package/dist/src/embed/conversation.d.ts.map +1 -1
  61. package/dist/src/embed/hostEventClient/contracts.d.ts +4 -1
  62. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  63. package/dist/src/embed/liveboard.d.ts +13 -0
  64. package/dist/src/embed/liveboard.d.ts.map +1 -1
  65. package/dist/src/embed/search.d.ts +24 -1
  66. package/dist/src/embed/search.d.ts.map +1 -1
  67. package/dist/src/embed/spotter-utils.d.ts +3 -0
  68. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  69. package/dist/src/embed/ts-embed.d.ts +14 -1
  70. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  71. package/dist/src/index.d.ts +2 -2
  72. package/dist/src/index.d.ts.map +1 -1
  73. package/dist/src/mixpanel-service.d.ts.map +1 -1
  74. package/dist/src/test/test-utils.d.ts +1 -0
  75. package/dist/src/test/test-utils.d.ts.map +1 -1
  76. package/dist/src/types.d.ts +532 -6
  77. package/dist/src/types.d.ts.map +1 -1
  78. package/dist/tsembed-react.es.js +299 -17
  79. package/dist/tsembed-react.js +298 -16
  80. package/dist/tsembed.es.js +300 -18
  81. package/dist/tsembed.js +298 -16
  82. package/dist/visual-embed-sdk-react-full.d.ts +572 -6
  83. package/dist/visual-embed-sdk-react.d.ts +572 -6
  84. package/dist/visual-embed-sdk.d.ts +600 -6
  85. package/lib/package.json +3 -3
  86. package/lib/src/embed/app.d.ts +19 -1
  87. package/lib/src/embed/app.d.ts.map +1 -1
  88. package/lib/src/embed/app.js +7 -1
  89. package/lib/src/embed/app.js.map +1 -1
  90. package/lib/src/embed/app.spec.js +142 -1
  91. package/lib/src/embed/app.spec.js.map +1 -1
  92. package/lib/src/embed/conversation.d.ts +2 -1
  93. package/lib/src/embed/conversation.d.ts.map +1 -1
  94. package/lib/src/embed/conversation.js.map +1 -1
  95. package/lib/src/embed/hostEventClient/contracts.d.ts +4 -1
  96. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  97. package/lib/src/embed/hostEventClient/host-event-client.spec.js +2 -2
  98. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  99. package/lib/src/embed/liveboard.d.ts +13 -0
  100. package/lib/src/embed/liveboard.d.ts.map +1 -1
  101. package/lib/src/embed/liveboard.js +7 -1
  102. package/lib/src/embed/liveboard.js.map +1 -1
  103. package/lib/src/embed/liveboard.spec.js +54 -0
  104. package/lib/src/embed/liveboard.spec.js.map +1 -1
  105. package/lib/src/embed/search.d.ts +24 -1
  106. package/lib/src/embed/search.d.ts.map +1 -1
  107. package/lib/src/embed/search.js +15 -2
  108. package/lib/src/embed/search.js.map +1 -1
  109. package/lib/src/embed/search.spec.js +100 -1
  110. package/lib/src/embed/search.spec.js.map +1 -1
  111. package/lib/src/embed/spotter-utils.d.ts +3 -0
  112. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  113. package/lib/src/embed/spotter-utils.js +11 -3
  114. package/lib/src/embed/spotter-utils.js.map +1 -1
  115. package/lib/src/embed/spotter-utils.spec.js +51 -0
  116. package/lib/src/embed/spotter-utils.spec.js.map +1 -1
  117. package/lib/src/embed/ts-embed.d.ts +14 -1
  118. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  119. package/lib/src/embed/ts-embed.js +28 -2
  120. package/lib/src/embed/ts-embed.js.map +1 -1
  121. package/lib/src/embed/ts-embed.spec.js +139 -0
  122. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  123. package/lib/src/index.d.ts +2 -2
  124. package/lib/src/index.d.ts.map +1 -1
  125. package/lib/src/index.js +2 -2
  126. package/lib/src/index.js.map +1 -1
  127. package/lib/src/mixpanel-service.d.ts.map +1 -1
  128. package/lib/src/mixpanel-service.js +2 -0
  129. package/lib/src/mixpanel-service.js.map +1 -1
  130. package/lib/src/mixpanel-service.spec.js +2 -0
  131. package/lib/src/mixpanel-service.spec.js.map +1 -1
  132. package/lib/src/test/test-utils.d.ts +1 -0
  133. package/lib/src/test/test-utils.d.ts.map +1 -1
  134. package/lib/src/test/test-utils.js +25 -1
  135. package/lib/src/test/test-utils.js.map +1 -1
  136. package/lib/src/types.d.ts +532 -6
  137. package/lib/src/types.d.ts.map +1 -1
  138. package/lib/src/types.js +224 -2
  139. package/lib/src/types.js.map +1 -1
  140. package/lib/src/visual-embed-sdk.d.ts +600 -6
  141. package/package.json +3 -3
  142. package/src/embed/app.spec.ts +179 -0
  143. package/src/embed/app.ts +29 -0
  144. package/src/embed/conversation.ts +2 -1
  145. package/src/embed/hostEventClient/contracts.ts +2 -1
  146. package/src/embed/hostEventClient/host-event-client.spec.ts +2 -2
  147. package/src/embed/liveboard.spec.ts +73 -0
  148. package/src/embed/liveboard.ts +23 -0
  149. package/src/embed/search.spec.ts +118 -0
  150. package/src/embed/search.ts +43 -1
  151. package/src/embed/spotter-utils.spec.ts +52 -0
  152. package/src/embed/spotter-utils.ts +19 -3
  153. package/src/embed/ts-embed.spec.ts +185 -0
  154. package/src/embed/ts-embed.ts +29 -3
  155. package/src/index.ts +16 -0
  156. package/src/mixpanel-service.spec.ts +2 -0
  157. package/src/mixpanel-service.ts +2 -0
  158. package/src/test/test-utils.ts +33 -1
  159. package/src/types.ts +561 -2
@@ -2962,6 +2962,22 @@ export interface LiveboardAppEmbedViewConfig {
2962
2962
  * ```
2963
2963
  */
2964
2964
  isLiveboardMasterpiecesEnabled?: boolean;
2965
+ /**
2966
+ * Enable or disable Muze chart phase 1 GA
2967
+ *
2968
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2969
+ * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
2970
+ * @default false
2971
+ * @example
2972
+ * ```js
2973
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
2974
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2975
+ * ... // other embed view config
2976
+ * newChartsLibrary: true,
2977
+ * })
2978
+ * ```
2979
+ */
2980
+ newChartsLibrary?: boolean;
2965
2981
  }
2966
2982
  export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
2967
2983
  }
@@ -4562,7 +4578,54 @@ export declare enum EmbedEvent {
4562
4578
  * ```
4563
4579
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
4564
4580
  */
4565
- RefreshAuthToken = "RefreshAuthToken"
4581
+ RefreshAuthToken = "RefreshAuthToken",
4582
+ /**
4583
+ * Triggered whenever the page context changes, returning the current context along with the navigation stack.
4584
+ * @example
4585
+ * ```js
4586
+ * embed.on(EmbedEvent.EmbedPageContextChanged, (payload) => {
4587
+ * console.log('payload', payload);
4588
+ * })
4589
+ * ```
4590
+ * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
4591
+ */
4592
+ EmbedPageContextChanged = "EmbedPageContextChanged",
4593
+ /**
4594
+ * Represents a special embed event that is triggered whenever any host event is subscribed.
4595
+ *
4596
+ * You can listen to this event when you need to dispatch a host event during load or render,
4597
+ * particularly in situations where timing issues may occur.
4598
+ *
4599
+ * @example
4600
+ * ```js
4601
+ * embed.on(`${HostEvent.Save} Subscribed`, () => {
4602
+ * // make action
4603
+ * });
4604
+ * ```
4605
+ *
4606
+ * @example
4607
+ * ```js
4608
+ * embed.on(subscribedEvent(HostEvent.Save), () => {
4609
+ * // make action
4610
+ * });
4611
+ * ```
4612
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.4.0.cl
4613
+ */
4614
+ Subscribed = "Subscribed",
4615
+ /**
4616
+ * Emitted when a user clicks the **Send Test Email** button in the
4617
+ * Liveboard schedule modal. Requires `isSendNowLiveboardSchedulingEnabled`
4618
+ * to be enabled.
4619
+ * @example
4620
+ * ```js
4621
+ * liveboardEmbed.on(EmbedEvent.SendTestScheduleEmail, (payload) => {
4622
+ * console.log('Send test email', payload);
4623
+ * // payload: { liveboardId: string, sendToSelf: boolean }
4624
+ * })
4625
+ * ```
4626
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
4627
+ */
4628
+ SendTestScheduleEmail = "sendTestScheduleEmail"
4566
4629
  }
4567
4630
  /**
4568
4631
  * Event types that can be triggered by the host application
@@ -6260,7 +6323,8 @@ export declare enum HostEvent {
6260
6323
  * ```js
6261
6324
  * // Get parameters from liveboard context
6262
6325
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
6263
- * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
6326
+ * liveboardEmbed.trigger(HostEvent.GetParameters, {},
6327
+ * ContextType.Liveboard).then((parameters) => {
6264
6328
  * console.log('parameters', parameters);
6265
6329
  * });
6266
6330
  * ```
@@ -6611,7 +6675,27 @@ export declare enum HostEvent {
6611
6675
  * ```
6612
6676
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
6613
6677
  */
6614
- GetPageContext = "GetPageContext"
6678
+ GetPageContext = "GetPageContext",
6679
+ /**
6680
+ * Trigger the **Send Test Email** action in the Liveboard schedule modal.
6681
+ * Sends a test schedule email to self or all recipients.
6682
+ * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
6683
+ * @example
6684
+ * ```js
6685
+ * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
6686
+ * sendToSelf: true,
6687
+ * })
6688
+ * ```
6689
+ * @example
6690
+ * ```js
6691
+ * // Send to all recipients
6692
+ * liveboardEmbed.trigger(HostEvent.SendTestScheduleEmail, {
6693
+ * sendToSelf: false,
6694
+ * })
6695
+ * ```
6696
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
6697
+ */
6698
+ SendTestScheduleEmail = "sendTestScheduleEmail"
6615
6699
  }
6616
6700
  /**
6617
6701
  * The different visual modes that the data sources panel within
@@ -6950,7 +7034,7 @@ export declare enum Action {
6950
7034
  * ```js
6951
7035
  * disabledActions: [Action.DownloadLiveboard]
6952
7036
  * ```
6953
- * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
7037
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6954
7038
  */
6955
7039
  DownloadLiveboard = "downloadLiveboard",
6956
7040
  /**
@@ -6963,6 +7047,26 @@ export declare enum Action {
6963
7047
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6964
7048
  */
6965
7049
  DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
7050
+ /**
7051
+ * The **Download Liveboard as XLSX** menu action on a Liveboard.
7052
+ * Allows downloading the entire Liveboard as an XLSX file.
7053
+ * @example
7054
+ * ```js
7055
+ * disabledActions: [Action.DownloadLiveboardAsXlsx]
7056
+ * ```
7057
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7058
+ */
7059
+ DownloadLiveboardAsXlsx = "downloadLiveboardAsXlsx",
7060
+ /**
7061
+ * The **Download Liveboard as CSV** menu action on a Liveboard.
7062
+ * Allows downloading the entire Liveboard as a CSV file.
7063
+ * @example
7064
+ * ```js
7065
+ * disabledActions: [Action.DownloadLiveboardAsCsv]
7066
+ * ```
7067
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
7068
+ */
7069
+ DownloadLiveboardAsCsv = "downloadLiveboardAsCsv",
6966
7070
  /**
6967
7071
  * @hidden
6968
7072
  */
@@ -8222,7 +8326,19 @@ export declare enum Action {
8222
8326
  * ```
8223
8327
  * @version SDK: 1.45.0 | ThoughtSpot: 26.4.0.cl
8224
8328
  */
8225
- IncludeCurrentPeriod = "includeCurrentPeriod"
8329
+ IncludeCurrentPeriod = "includeCurrentPeriod",
8330
+ /**
8331
+ * The **Send Test Email** button in the Liveboard schedule modal.
8332
+ * Allows sending a test schedule email to self or all recipients.
8333
+ * Requires `isSendNowLiveboardSchedulingEnabled` to be enabled.
8334
+ * @example
8335
+ * ```js
8336
+ * disabledActions: [Action.SendTestScheduleEmail]
8337
+ * hiddenActions: [Action.SendTestScheduleEmail]
8338
+ * ```
8339
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
8340
+ */
8341
+ SendTestScheduleEmail = "sendTestScheduleEmail"
8226
8342
  }
8227
8343
  export declare enum PrefetchFeatures {
8228
8344
  FullApp = "FullApp",
@@ -8791,6 +8907,413 @@ export interface ContextObject {
8791
8907
  objectIds: ObjectIds;
8792
8908
  };
8793
8909
  }
8910
+ export interface FontProperties {
8911
+ color?: string;
8912
+ bold?: boolean;
8913
+ italic?: boolean;
8914
+ strikeThrough?: boolean;
8915
+ underline?: boolean;
8916
+ }
8917
+ export interface SolidBackgroundAttrs {
8918
+ color?: string;
8919
+ }
8920
+ export interface GradientBackgroundAttrs {
8921
+ backgroundFormatMidpoint?: number;
8922
+ colors?: string[];
8923
+ backgroundFormatRange?: number[];
8924
+ isAutoScaled?: boolean;
8925
+ }
8926
+ /**
8927
+ * Data label filter operators
8928
+ * @group Visual Overrides
8929
+ */
8930
+ export declare enum DataLabelFilterOperator {
8931
+ /** Greater than */
8932
+ GreaterThan = "GREATER_THAN",
8933
+ /** Less than */
8934
+ LessThan = "LESS_THAN",
8935
+ /** Greater than or equal to */
8936
+ GreaterThanOrEqualTo = "GREATER_THAN_OR_EQUAL_TO",
8937
+ /** Less than or equal to */
8938
+ LessThanOrEqualTo = "LESS_THAN_OR_EQUAL_TO",
8939
+ /** Equal to */
8940
+ EqualTo = "EQUAL_TO",
8941
+ /** Not equal to */
8942
+ NotEqualTo = "NOT_EQUAL_TO"
8943
+ }
8944
+ /**
8945
+ * Conditional formatting operators
8946
+ * @group Visual Overrides
8947
+ */
8948
+ export declare enum ConditionalFormattingOperator {
8949
+ /** Is equal to */
8950
+ Is = "IS",
8951
+ /** Is not equal to */
8952
+ IsNot = "IS_NOT",
8953
+ /** Contains */
8954
+ Contains = "CONTAINS",
8955
+ /** Does not contain */
8956
+ DoesNotContain = "DOES_NOT_CONTAIN",
8957
+ /** Starts with */
8958
+ StartsWith = "STARTS_WITH",
8959
+ /** Ends with */
8960
+ EndsWith = "ENDS_WITH",
8961
+ /** Greater than */
8962
+ GreaterThan = "GREATER_THAN",
8963
+ /** Less than */
8964
+ LessThan = "LESS_THAN",
8965
+ /** Greater than or equal to */
8966
+ GreaterThanEqualTo = "GREATER_THAN_EQUAL_TO",
8967
+ /** Less than or equal to */
8968
+ LessThanEqualTo = "LESS_THAN_EQUAL_TO",
8969
+ /** Equal to */
8970
+ EqualTo = "EQUAL_TO",
8971
+ /** Not equal to */
8972
+ NotEqualTo = "NOT_EQUAL_TO",
8973
+ /** Is between */
8974
+ IsBetween = "IS_BETWEEN",
8975
+ /** Is null */
8976
+ IsNull = "IS_NULL",
8977
+ /** Is not null */
8978
+ IsNotNull = "IS_NOT_NULL"
8979
+ }
8980
+ /**
8981
+ * Background format types for conditional formatting
8982
+ * @group Visual Overrides
8983
+ */
8984
+ export declare enum BackgroundFormatType {
8985
+ /** Solid color background */
8986
+ Solid = "SOLID",
8987
+ /** Gradient background */
8988
+ Gradient = "GRADIENT"
8989
+ }
8990
+ /**
8991
+ * Comparison types for conditional formatting
8992
+ * @group Visual Overrides
8993
+ */
8994
+ export declare enum ConditionalFormattingComparisonType {
8995
+ /** Value-based comparison */
8996
+ ValueBased = "VALUE_BASED",
8997
+ /** Column-based comparison */
8998
+ ColumnBased = "COLUMN_BASED",
8999
+ /** Parameter-based comparison */
9000
+ ParameterBased = "PARAMETER_BASED"
9001
+ }
9002
+ /**
9003
+ * A single conditional formatting rule row
9004
+ * @group Visual Overrides
9005
+ */
9006
+ export interface ConditionalFormattingRow {
9007
+ /** Comparison operator */
9008
+ operator: ConditionalFormattingOperator | string;
9009
+ /** Value to compare against */
9010
+ value?: string;
9011
+ /** Range values for range-based comparisons */
9012
+ rangeValues?: {
9013
+ min: number;
9014
+ max: number;
9015
+ };
9016
+ /** Plot the formatting as a band/area */
9017
+ plotAsBand?: boolean;
9018
+ /** Highlight this row if the condition is met */
9019
+ isHighlightRow?: boolean;
9020
+ /** Type of comparison: value-based, column-based, or parameter-based */
9021
+ comparisonType?: ConditionalFormattingComparisonType | string;
9022
+ /** Column ID to apply the formatting to (left-hand side) */
9023
+ lhsColumnId?: string;
9024
+ /** Column name to compare against (right-hand side) */
9025
+ columnToCompare?: string;
9026
+ /** Parameter ID to compare against */
9027
+ comparisonParameterId?: string;
9028
+ /** Font properties to apply (color, bold, italic, etc.) */
9029
+ fontProperties?: FontProperties;
9030
+ /** Background format type: solid color or gradient */
9031
+ backgroundFormatType?: BackgroundFormatType | string;
9032
+ /** Solid background color attributes */
9033
+ solidBackgroundAttrs?: SolidBackgroundAttrs;
9034
+ /** Gradient background attributes */
9035
+ gradientBackgroundAttrs?: GradientBackgroundAttrs;
9036
+ }
9037
+ /**
9038
+ * Conditional formatting configuration
9039
+ * @group Visual Overrides
9040
+ */
9041
+ export interface ConditionalFormatting {
9042
+ /** Array of conditional formatting rules */
9043
+ rows?: ConditionalFormattingRow[];
9044
+ }
9045
+ /**
9046
+ * Color palette for charts
9047
+ * @group Visual Overrides
9048
+ */
9049
+ export interface ColorPalette {
9050
+ /** Array of color values (hex codes or color names) */
9051
+ colors?: string[];
9052
+ }
9053
+ /**
9054
+ * Legend position options
9055
+ * @group Visual Overrides
9056
+ */
9057
+ export declare enum LegendPosition {
9058
+ /** Position legend at the top */
9059
+ Top = "top",
9060
+ /** Position legend at the bottom */
9061
+ Bottom = "bottom",
9062
+ /** Position legend on the left */
9063
+ Left = "left",
9064
+ /** Position legend on the right */
9065
+ Right = "right"
9066
+ }
9067
+ /**
9068
+ * Table theme options
9069
+ * @group Visual Overrides
9070
+ */
9071
+ export declare enum TableTheme {
9072
+ /** Outline theme */
9073
+ Outline = "OUTLINE",
9074
+ /** Row theme */
9075
+ Row = "ROW",
9076
+ /** Zebra theme */
9077
+ Zebra = "ZEBRA"
9078
+ }
9079
+ /**
9080
+ * Table content density options
9081
+ * @group Visual Overrides
9082
+ */
9083
+ export declare enum TableContentDensity {
9084
+ /** Regular density */
9085
+ Regular = "REGULAR",
9086
+ /** Compact density */
9087
+ Compact = "COMPACT"
9088
+ }
9089
+ /**
9090
+ * Chart legend configuration
9091
+ * @group Visual Overrides
9092
+ */
9093
+ export interface ChartLegend {
9094
+ /** Show or hide the legend */
9095
+ show?: boolean;
9096
+ /** Position of the legend */
9097
+ position?: LegendPosition | string;
9098
+ /** Color palette to use for legend colors */
9099
+ colorPalette?: ColorPalette;
9100
+ }
9101
+ /**
9102
+ * Filter for data labels
9103
+ * @group Visual Overrides
9104
+ */
9105
+ export interface DataLabelFilter {
9106
+ /** Filter threshold value */
9107
+ value?: number;
9108
+ /** Filter operator */
9109
+ operator?: DataLabelFilterOperator | string;
9110
+ }
9111
+ /**
9112
+ * Data label configuration for a specific column
9113
+ * @group Visual Overrides
9114
+ */
9115
+ export interface ColumnDataLabel {
9116
+ /** Column name to apply data label overrides to */
9117
+ name: string;
9118
+ /** Show or hide data labels for this column */
9119
+ visible?: boolean;
9120
+ /** Filter to apply to data labels */
9121
+ filter?: DataLabelFilter | null;
9122
+ }
9123
+ /**
9124
+ * Chart data label configuration
9125
+ * @group Visual Overrides
9126
+ */
9127
+ export interface ChartDataLabel {
9128
+ /** Show labels for all data points */
9129
+ allLabels?: boolean;
9130
+ /** Show labels for stacked values */
9131
+ stackLabels?: boolean;
9132
+ /** Per-column data label configurations */
9133
+ columnDataLabel?: ColumnDataLabel[];
9134
+ }
9135
+ /**
9136
+ * Chart summaries and totals configuration
9137
+ * @group Visual Overrides
9138
+ */
9139
+ export interface ChartSummaries {
9140
+ /** Show row totals */
9141
+ showRowTotals?: boolean;
9142
+ /** Show column totals */
9143
+ showColumnTotals?: boolean;
9144
+ /** Show row grand totals */
9145
+ showRowGrandTotals?: boolean;
9146
+ /** Show column grand totals */
9147
+ showColumnGrandTotals?: boolean;
9148
+ }
9149
+ /**
9150
+ * Gridline configuration
9151
+ * @group Visual Overrides
9152
+ */
9153
+ export interface GridLine {
9154
+ /** Show vertical gridlines */
9155
+ x?: boolean;
9156
+ /** Show horizontal gridlines */
9157
+ y?: boolean;
9158
+ }
9159
+ /**
9160
+ * Chart display configuration
9161
+ * @group Visual Overrides
9162
+ */
9163
+ export interface ChartDisplay {
9164
+ /** Summary and totals configuration */
9165
+ summaries?: ChartSummaries;
9166
+ /** Show regression line on chart */
9167
+ regressionLine?: boolean;
9168
+ /** Gridline visibility configuration */
9169
+ gridLine?: GridLine;
9170
+ }
9171
+ /**
9172
+ * Y-axis range configuration
9173
+ * @group Visual Overrides
9174
+ */
9175
+ export interface YAxisRange {
9176
+ /** Minimum value for Y-axis */
9177
+ min?: number;
9178
+ /** Maximum value for Y-axis */
9179
+ max?: number;
9180
+ }
9181
+ /**
9182
+ * Chart axis configuration
9183
+ * @group Visual Overrides
9184
+ */
9185
+ export interface ChartAxis {
9186
+ /** Column names to link to this axis */
9187
+ linkedColumns?: string[];
9188
+ /** Show the axis name */
9189
+ showName?: boolean;
9190
+ /** Show the axis label values */
9191
+ showLabelValue?: boolean;
9192
+ /** Y-axis range configuration */
9193
+ yAxisRange?: YAxisRange;
9194
+ }
9195
+ /**
9196
+ * Chart column override configuration
9197
+ * @group Visual Overrides
9198
+ */
9199
+ export interface ChartColumn {
9200
+ /** Column name to apply overrides to */
9201
+ name: string;
9202
+ /** Color for the column (hex code) */
9203
+ color?: string;
9204
+ /** Conditional formatting rules to apply to the column */
9205
+ conditionalFormatting?: ConditionalFormatting;
9206
+ }
9207
+ /**
9208
+ * Chart visualization overrides
9209
+ * @group Visual Overrides
9210
+ */
9211
+ export interface ChartOverrides {
9212
+ /** Legend configuration */
9213
+ legend?: ChartLegend;
9214
+ /** Data label configuration */
9215
+ dataLabel?: ChartDataLabel;
9216
+ /** Display properties (summaries, regression line, gridlines) */
9217
+ display?: ChartDisplay;
9218
+ /** Per-axis configurations */
9219
+ axis?: ChartAxis[];
9220
+ /** Per-column configurations */
9221
+ columns?: ChartColumn[];
9222
+ /** Update mask paths for partial updates */
9223
+ updateMaskPaths?: string[];
9224
+ }
9225
+ /**
9226
+ * Table column override configuration
9227
+ * @group Visual Overrides
9228
+ */
9229
+ export interface TableColumn {
9230
+ /**
9231
+ * Name of the column to apply overrides to
9232
+ */
9233
+ name: string;
9234
+ /**
9235
+ * Enable or disable text wrapping for the column
9236
+ */
9237
+ wrapText?: boolean;
9238
+ /**
9239
+ * Show or hide the column
9240
+ */
9241
+ show?: boolean;
9242
+ /**
9243
+ * Conditional formatting rules to apply to the column
9244
+ */
9245
+ conditionalFormatting?: ConditionalFormatting;
9246
+ }
9247
+ /**
9248
+ * Table display configuration
9249
+ * @group Visual Overrides
9250
+ */
9251
+ export interface TableDisplay {
9252
+ /** Table theme */
9253
+ tableTheme?: TableTheme | string;
9254
+ /** Table content density */
9255
+ tableContentDensity?: TableContentDensity | string;
9256
+ }
9257
+ /**
9258
+ * Column summary visibility configuration
9259
+ * @group Visual Overrides
9260
+ */
9261
+ export interface ColumnSummaryVisibility {
9262
+ /** Column ID to control summary visibility for */
9263
+ columnId: string;
9264
+ /** Show or hide summary for this column */
9265
+ visible: boolean;
9266
+ }
9267
+ /**
9268
+ * Display summary configuration
9269
+ * @group Visual Overrides
9270
+ */
9271
+ export interface DisplaySummaryConfig {
9272
+ /** Show all column summaries by default */
9273
+ showAllSummaries?: boolean;
9274
+ /** Per-column summary visibility overrides */
9275
+ columnVisibility?: ColumnSummaryVisibility[];
9276
+ }
9277
+ /**
9278
+ * Table visualization overrides
9279
+ * @group Visual Overrides
9280
+ */
9281
+ export interface TableOverrides {
9282
+ /** Per-column configurations (properties, conditional formatting) */
9283
+ columns?: TableColumn[];
9284
+ /** Table display properties (theme, density) */
9285
+ display?: TableDisplay;
9286
+ /** Summary/headline column visibility configuration */
9287
+ displaySummaryConfig?: DisplaySummaryConfig;
9288
+ /** Update mask paths for partial updates */
9289
+ updateMaskPaths?: string[];
9290
+ }
9291
+ /**
9292
+ * Visualization overrides to customize chart and table rendering
9293
+ * within embedded ThoughtSpot components.
9294
+ *
9295
+ * @group Visual Overrides
9296
+ * @example
9297
+ * ```js
9298
+ * const embed = new AppEmbed('#tsEmbed', {
9299
+ * visualOverrides: {
9300
+ * chart: {
9301
+ * legend: { show: true, position: 'bottom' },
9302
+ * columns: [{ name: 'Revenue', color: '#1f77b4' }],
9303
+ * },
9304
+ * table: {
9305
+ * display: { tableTheme: 'ZEBRA', tableContentDensity: 'COMPACT' },
9306
+ * },
9307
+ * },
9308
+ * });
9309
+ * ```
9310
+ */
9311
+ export interface VisualizationOverrides {
9312
+ /** Chart visualization overrides */
9313
+ chart?: ChartOverrides;
9314
+ /** Table visualization overrides */
9315
+ table?: TableOverrides;
9316
+ }
8794
9317
  export interface LiveboardTab {
8795
9318
  id: string;
8796
9319
  name: string;
@@ -8924,7 +9447,10 @@ export type UIPassthroughContractBase = {
8924
9447
  [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
8925
9448
  request: Record<string, never>;
8926
9449
  response: {
8927
- v2Content: string;
9450
+ data: {
9451
+ v2Content: string;
9452
+ };
9453
+ type: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
8928
9454
  };
8929
9455
  };
8930
9456
  [UIPassthroughEvent.UpdateFilters]: {
@@ -9258,6 +9784,7 @@ declare class TsEmbed {
9258
9784
  * @returns
9259
9785
  */
9260
9786
  protected createEmbedEventResponder: (eventPort: MessagePort | void, eventType: EmbedEvent) => (payload: any) => void;
9787
+ private shouldSkipEvent;
9261
9788
  /**
9262
9789
  * Executes all registered event handlers for a particular event type
9263
9790
  * @param eventType The event type
@@ -9427,6 +9954,18 @@ declare class TsEmbed {
9427
9954
  * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
9428
9955
  */
9429
9956
  getCurrentContext(): Promise<ContextObject>;
9957
+ /**
9958
+ * Generates the event name for a "Subscribed" embed event.
9959
+ *
9960
+ * This helper appends the "Subscribed" suffix to a given host or action event,
9961
+ * allowing you to listen for subscription lifecycle events in a consistent format.
9962
+ *
9963
+ * @param eventName - The host or action event to generate the subscribed event name for.
9964
+ * @returns The formatted event name (e.g., "Save Subscribed").
9965
+ *
9966
+ * @version SDK: 1.47.2 | ThoughtSpot: 26.3.0.cl
9967
+ */
9968
+ subscribedEvent(eventName: HostEvent | Action): string;
9430
9969
  /**
9431
9970
  * Creates the preRender shell
9432
9971
  * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -9889,6 +10428,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
9889
10428
  export interface SpotterAppInitData extends DefaultAppInitData {
9890
10429
  embedParams?: {
9891
10430
  spotterSidebarConfig?: SpotterSidebarViewConfig;
10431
+ visualOverridesParams?: VisualizationOverrides | null;
9892
10432
  };
9893
10433
  }
9894
10434
  /**
@@ -10693,6 +11233,24 @@ export interface AppViewConfig extends AllEmbedViewConfig {
10693
11233
  * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
10694
11234
  */
10695
11235
  enableHomepageAnnouncement?: boolean;
11236
+ /**
11237
+ * If set to true, enables visualization data caching on the Liveboard.
11238
+ * @type {boolean}
11239
+ * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
11240
+ * @example
11241
+ * ```js
11242
+ * const embed = new AppEmbed('#tsEmbed', {
11243
+ * ... // other options
11244
+ * enableLiveboardDataCache: true,
11245
+ * })
11246
+ * ```
11247
+ */
11248
+ enableLiveboardDataCache?: boolean;
11249
+ /**
11250
+ * Visual overrides to customize the chart or table properties.
11251
+ * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
11252
+ */
11253
+ visualOverrides?: VisualizationOverrides;
10696
11254
  }
10697
11255
  /**
10698
11256
  * APP_INIT data shape for AppEmbed.
@@ -11571,6 +12129,19 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
11571
12129
  * ```
11572
12130
  */
11573
12131
  spotterChatConfig?: SpotterChatViewConfig;
12132
+ /**
12133
+ * If set to true, enables visualization data caching on the Liveboard.
12134
+ * @type {boolean}
12135
+ * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
12136
+ * @example
12137
+ * ```js
12138
+ * const embed = new LiveboardEmbed('#embed-container', {
12139
+ * ... // other options
12140
+ * enableLiveboardDataCache: true,
12141
+ * })
12142
+ * ```
12143
+ */
12144
+ enableLiveboardDataCache?: boolean;
11574
12145
  }
11575
12146
  /**
11576
12147
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -11945,9 +12516,32 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
11945
12516
  * ```
11946
12517
  */
11947
12518
  focusSearchBarOnRender?: boolean;
12519
+ /**
12520
+ * Enable or disable Muze chart phase 1 GA
12521
+ *
12522
+ * Supported embed types: `SearchEmbed`
12523
+ * @version SDK: 1.49.0 | ThoughtSpot Cloud: 26.6.0.cl
12524
+ * @default false
12525
+ * @example
12526
+ * ```js
12527
+ * const embed = new SearchEmbed('#tsEmbed', {
12528
+ * ... // other embed view config
12529
+ * newChartsLibrary: true,
12530
+ * })
12531
+ * ```
12532
+ */
12533
+ newChartsLibrary?: boolean;
12534
+ /**
12535
+ * Visual overrides to customize the chart or table properties.
12536
+ * @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
12537
+ */
12538
+ visualOverrides?: VisualizationOverrides;
11948
12539
  }
11949
12540
  export interface SearchAppInitData extends DefaultAppInitData {
11950
12541
  searchOptions?: SearchOptions$1;
12542
+ embedParams?: {
12543
+ visualOverridesParams?: VisualizationOverrides | null;
12544
+ };
11951
12545
  }
11952
12546
  /**
11953
12547
  * Embed ThoughtSpot search