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