@thoughtspot/visual-embed-sdk 1.40.1-alpha.2 → 1.40.1

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 (155) hide show
  1. package/cjs/package.json +7 -6
  2. package/cjs/src/css-variables.d.ts +316 -0
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +6 -1
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +22 -0
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +39 -2
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/bodyless-conversation.d.ts +0 -1
  11. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  12. package/cjs/src/embed/bodyless-conversation.js +3 -7
  13. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  14. package/cjs/src/embed/conversation.d.ts +63 -3
  15. package/cjs/src/embed/conversation.d.ts.map +1 -1
  16. package/cjs/src/embed/conversation.js +11 -8
  17. package/cjs/src/embed/conversation.js.map +1 -1
  18. package/cjs/src/embed/conversation.spec.js +102 -0
  19. package/cjs/src/embed/conversation.spec.js.map +1 -1
  20. package/cjs/src/embed/liveboard.d.ts +11 -3
  21. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  22. package/cjs/src/embed/liveboard.js +23 -33
  23. package/cjs/src/embed/liveboard.js.map +1 -1
  24. package/cjs/src/embed/liveboard.spec.js +182 -29
  25. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  26. package/cjs/src/embed/sage.d.ts +0 -1
  27. package/cjs/src/embed/sage.d.ts.map +1 -1
  28. package/cjs/src/embed/sage.js +6 -10
  29. package/cjs/src/embed/sage.js.map +1 -1
  30. package/cjs/src/embed/search-bar.d.ts +0 -1
  31. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  32. package/cjs/src/embed/search-bar.js +7 -11
  33. package/cjs/src/embed/search-bar.js.map +1 -1
  34. package/cjs/src/embed/search.d.ts +0 -1
  35. package/cjs/src/embed/search.d.ts.map +1 -1
  36. package/cjs/src/embed/search.js +8 -7
  37. package/cjs/src/embed/search.js.map +1 -1
  38. package/cjs/src/embed/ts-embed.d.ts +22 -9
  39. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  40. package/cjs/src/embed/ts-embed.js +75 -59
  41. package/cjs/src/embed/ts-embed.js.map +1 -1
  42. package/cjs/src/embed/ts-embed.spec.js +173 -1
  43. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  44. package/cjs/src/types.d.ts +154 -54
  45. package/cjs/src/types.d.ts.map +1 -1
  46. package/cjs/src/types.js +140 -52
  47. package/cjs/src/types.js.map +1 -1
  48. package/cjs/src/utils/liveboardService/liveboardService.d.ts +21 -6
  49. package/cjs/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  50. package/cjs/src/utils/liveboardService/liveboardService.js +21 -6
  51. package/cjs/src/utils/liveboardService/liveboardService.js.map +1 -1
  52. package/dist/{index-CmEQfuE3.js → index-P5YjBOuJ.js} +1 -1
  53. package/dist/src/css-variables.d.ts +316 -0
  54. package/dist/src/css-variables.d.ts.map +1 -1
  55. package/dist/src/embed/app.d.ts +6 -1
  56. package/dist/src/embed/app.d.ts.map +1 -1
  57. package/dist/src/embed/bodyless-conversation.d.ts +0 -1
  58. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  59. package/dist/src/embed/conversation.d.ts +63 -3
  60. package/dist/src/embed/conversation.d.ts.map +1 -1
  61. package/dist/src/embed/liveboard.d.ts +11 -3
  62. package/dist/src/embed/liveboard.d.ts.map +1 -1
  63. package/dist/src/embed/sage.d.ts +0 -1
  64. package/dist/src/embed/sage.d.ts.map +1 -1
  65. package/dist/src/embed/search-bar.d.ts +0 -1
  66. package/dist/src/embed/search-bar.d.ts.map +1 -1
  67. package/dist/src/embed/search.d.ts +0 -1
  68. package/dist/src/embed/search.d.ts.map +1 -1
  69. package/dist/src/embed/ts-embed.d.ts +22 -9
  70. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  71. package/dist/src/types.d.ts +154 -54
  72. package/dist/src/types.d.ts.map +1 -1
  73. package/dist/src/utils/liveboardService/liveboardService.d.ts +21 -6
  74. package/dist/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  75. package/dist/tsembed-react.es.js +298 -190
  76. package/dist/tsembed-react.js +297 -189
  77. package/dist/tsembed.es.js +319 -196
  78. package/dist/tsembed.js +318 -195
  79. package/dist/visual-embed-sdk-react-full.d.ts +583 -76
  80. package/dist/visual-embed-sdk-react.d.ts +583 -76
  81. package/dist/visual-embed-sdk.d.ts +583 -76
  82. package/lib/package.json +7 -6
  83. package/lib/src/css-variables.d.ts +316 -0
  84. package/lib/src/css-variables.d.ts.map +1 -1
  85. package/lib/src/embed/app.d.ts +6 -1
  86. package/lib/src/embed/app.d.ts.map +1 -1
  87. package/lib/src/embed/app.js +22 -0
  88. package/lib/src/embed/app.js.map +1 -1
  89. package/lib/src/embed/app.spec.js +39 -2
  90. package/lib/src/embed/app.spec.js.map +1 -1
  91. package/lib/src/embed/bodyless-conversation.d.ts +0 -1
  92. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  93. package/lib/src/embed/bodyless-conversation.js +3 -7
  94. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  95. package/lib/src/embed/conversation.d.ts +63 -3
  96. package/lib/src/embed/conversation.d.ts.map +1 -1
  97. package/lib/src/embed/conversation.js +12 -9
  98. package/lib/src/embed/conversation.js.map +1 -1
  99. package/lib/src/embed/conversation.spec.js +104 -2
  100. package/lib/src/embed/conversation.spec.js.map +1 -1
  101. package/lib/src/embed/liveboard.d.ts +11 -3
  102. package/lib/src/embed/liveboard.d.ts.map +1 -1
  103. package/lib/src/embed/liveboard.js +23 -33
  104. package/lib/src/embed/liveboard.js.map +1 -1
  105. package/lib/src/embed/liveboard.spec.js +182 -29
  106. package/lib/src/embed/liveboard.spec.js.map +1 -1
  107. package/lib/src/embed/sage.d.ts +0 -1
  108. package/lib/src/embed/sage.d.ts.map +1 -1
  109. package/lib/src/embed/sage.js +6 -10
  110. package/lib/src/embed/sage.js.map +1 -1
  111. package/lib/src/embed/search-bar.d.ts +0 -1
  112. package/lib/src/embed/search-bar.d.ts.map +1 -1
  113. package/lib/src/embed/search-bar.js +7 -11
  114. package/lib/src/embed/search-bar.js.map +1 -1
  115. package/lib/src/embed/search.d.ts +0 -1
  116. package/lib/src/embed/search.d.ts.map +1 -1
  117. package/lib/src/embed/search.js +8 -7
  118. package/lib/src/embed/search.js.map +1 -1
  119. package/lib/src/embed/ts-embed.d.ts +22 -9
  120. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  121. package/lib/src/embed/ts-embed.js +75 -59
  122. package/lib/src/embed/ts-embed.js.map +1 -1
  123. package/lib/src/embed/ts-embed.spec.js +173 -1
  124. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  125. package/lib/src/types.d.ts +154 -54
  126. package/lib/src/types.d.ts.map +1 -1
  127. package/lib/src/types.js +140 -52
  128. package/lib/src/types.js.map +1 -1
  129. package/lib/src/utils/liveboardService/liveboardService.d.ts +21 -6
  130. package/lib/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  131. package/lib/src/utils/liveboardService/liveboardService.js +21 -6
  132. package/lib/src/utils/liveboardService/liveboardService.js.map +1 -1
  133. package/lib/src/visual-embed-sdk.d.ts +584 -77
  134. package/package.json +7 -6
  135. package/src/css-variables.ts +396 -1
  136. package/src/embed/app.spec.ts +54 -2
  137. package/src/embed/app.ts +24 -0
  138. package/src/embed/bodyless-conversation.ts +3 -9
  139. package/src/embed/conversation.spec.ts +131 -5
  140. package/src/embed/conversation.ts +87 -23
  141. package/src/embed/liveboard.spec.ts +233 -32
  142. package/src/embed/liveboard.ts +24 -39
  143. package/src/embed/sage.ts +6 -11
  144. package/src/embed/search-bar.tsx +7 -14
  145. package/src/embed/search.ts +7 -18
  146. package/src/embed/ts-embed.spec.ts +344 -112
  147. package/src/embed/ts-embed.ts +82 -70
  148. package/src/types.ts +153 -54
  149. package/src/utils/liveboardService/liveboardService.ts +21 -6
  150. package/dist/index-D1pyb7RG.js +0 -7371
  151. package/dist/index-DeFzsyFF.js +0 -7371
  152. package/dist/index-Dpf0rd6w.js +0 -7371
  153. package/dist/index-UuEbsISo.js +0 -7447
  154. package/dist/index-e3Uw3YFO.js +0 -7371
  155. package/dist/index-k7pkZMhx.js +0 -7371
@@ -104,7 +104,12 @@ export enum HomePage {
104
104
  * Modular (v2) introduces the updated Modular Home Experience.
105
105
  * It serves as the foundational version of the home page.
106
106
  */
107
- Modular = "v2"
107
+ Modular = "v2",
108
+ /**
109
+ * ModularWithStylingChanges (v3) introduces Modular Home Experience
110
+ * with styling changes.
111
+ */
112
+ ModularWithStylingChanges = "v3"
108
113
  }
109
114
  /**
110
115
  * Define the version of the list page
@@ -1121,7 +1126,16 @@ export class LiveboardEmbed extends V1Embed {
1121
1126
  * embedded Liveboard or visualization.
1122
1127
  */
1123
1128
  protected getEmbedParams(): string;
1124
- protected getEmbedParamsObject(): any;
1129
+ /**
1130
+ * @hidden
1131
+ * Internal state to track the current liveboard id.
1132
+ * This is used to navigate to the correct liveboard when the prerender is visible.
1133
+ */
1134
+ currentLiveboardState: {
1135
+ liveboardId: string;
1136
+ vizId: string;
1137
+ activeTabId: string;
1138
+ };
1125
1139
  protected beforePrerenderVisible(): void;
1126
1140
  protected handleRenderForPrerender(): Promise<TsEmbed>;
1127
1141
  /**
@@ -1142,8 +1156,7 @@ export class LiveboardEmbed extends V1Embed {
1142
1156
  * visualization ID and the runtime filters.
1143
1157
  */
1144
1158
  render(): Promise<LiveboardEmbed>;
1145
- currentLiveboardId: string;
1146
- navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, onNavigateCalled?: () => void): void;
1159
+ navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
1147
1160
  /**
1148
1161
  * Returns the full url of the Liveboard/visualization which can be used to open
1149
1162
  * this Liveboard inside the full ThoughtSpot application in a new tab.
@@ -1475,7 +1488,6 @@ export class SearchEmbed extends TsEmbed {
1475
1488
  };
1476
1489
  };
1477
1490
  protected getAppInitData(): Promise<SearchAppInitData>;
1478
- protected getEmbedParamsObject(): Record<any, any>;
1479
1491
  protected getEmbedParams(): string;
1480
1492
  /**
1481
1493
  * Construct the URL of the embedded ThoughtSpot search to be
@@ -1597,7 +1609,6 @@ export class SearchBarEmbed extends TsEmbed {
1597
1609
  protected viewConfig: SearchBarViewConfig;
1598
1610
  protected embedComponentType: string;
1599
1611
  constructor(domSelector: string, viewConfig: SearchBarViewConfig);
1600
- protected getEmbedParamsObject(): Record<any, any>;
1601
1612
  /**
1602
1613
  * Render the embedded ThoughtSpot search
1603
1614
  */
@@ -1637,7 +1648,6 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
1637
1648
  export class ConversationMessage extends TsEmbed {
1638
1649
  protected viewConfig: SpotterAgentMessageViewConfig;
1639
1650
  constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
1640
- protected getEmbedParamsObject(): Record<any, any>;
1641
1651
  getIframeSrc(): string;
1642
1652
  render(): Promise<ConversationMessage>;
1643
1653
  }
@@ -1730,7 +1740,8 @@ export interface SearchOptions {
1730
1740
  */
1731
1741
  export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
1732
1742
  /**
1733
- * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
1743
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses
1744
+ * this object to query data and generate Answers.
1734
1745
  */
1735
1746
  worksheetId: string;
1736
1747
  /**
@@ -1813,6 +1824,66 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
1813
1824
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
1814
1825
  */
1815
1826
  hideSampleQuestions?: boolean;
1827
+ /**
1828
+ * The list of runtime filters to apply to a search Answer,
1829
+ * visualization, or Liveboard.
1830
+ *
1831
+ * Supported embed types: `SpotterEmbed`
1832
+ * @example
1833
+ * ```js
1834
+ * const embed = new SpotterEmbed('#tsEmbed', {
1835
+ * // other embed view config
1836
+ * runtimeFilters: [
1837
+ * {
1838
+ * columnName: 'color',
1839
+ * operator: RuntimeFilterOp.EQ,
1840
+ * values: ['red'],
1841
+ * },
1842
+ * ],
1843
+ * })
1844
+ * ```
1845
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
1846
+ */
1847
+ runtimeFilters?: RuntimeFilter[];
1848
+ /**
1849
+ * Flag to control whether runtime filters should be included in the URL.
1850
+ * If true, filters will be passed via app initialization payload instead.
1851
+ * If false/undefined, filters will be added to URL (default behavior).
1852
+ *
1853
+ * Supported embed types: `SpotterEmbed`
1854
+ * @default false
1855
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
1856
+ */
1857
+ excludeRuntimeFiltersfromURL?: boolean;
1858
+ /**
1859
+ * The list of runtime parameters to apply to the conversation.
1860
+ *
1861
+ * Supported embed types: `SpotterEmbed`
1862
+ * @example
1863
+ * ```js
1864
+ * const embed = new SpotterEmbed('#tsEmbed', {
1865
+ * // other embed view config
1866
+ * runtimeParameters: [
1867
+ * {
1868
+ * name: 'Integer Param',
1869
+ * value: 10,
1870
+ * },
1871
+ * ],
1872
+ * })
1873
+ * ```
1874
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
1875
+ */
1876
+ runtimeParameters?: RuntimeParameter[];
1877
+ /**
1878
+ * Flag to control whether runtime parameters should be included in the URL.
1879
+ * If true, parameters will be passed via app initialization payload instead.
1880
+ * If false/undefined, parameters will be added to URL (default behavior).
1881
+ *
1882
+ * Supported embed types: `SpotterEmbed`
1883
+ * @default false
1884
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
1885
+ */
1886
+ excludeRuntimeParametersfromURL?: boolean;
1816
1887
  }
1817
1888
  /**
1818
1889
  * The configuration for the embedded spotterEmbed options.
@@ -1840,7 +1911,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
1840
1911
  export class SpotterEmbed extends TsEmbed {
1841
1912
  protected viewConfig: SpotterEmbedViewConfig;
1842
1913
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
1843
- protected getEmbedParamsObject(): Record<any, any>;
1844
1914
  getIframeSrc(): string;
1845
1915
  render(): Promise<SpotterEmbed>;
1846
1916
  }
@@ -3157,12 +3227,15 @@ export interface HomePageConfig {
3157
3227
  * Hide list page columns
3158
3228
  * For example: hiddenListColumns = [ListPageColumns.Author]
3159
3229
  *
3160
- * **Note**: This option is available only in full app embedding.
3230
+ * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
3231
+ * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page.
3161
3232
  *
3162
3233
  * Supported embed types: `AppEmbed`
3163
3234
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3164
3235
  * @example
3165
3236
  * ```js
3237
+ * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
3238
+ *
3166
3239
  * const embed = new AppEmbed('#tsEmbed', {
3167
3240
  * ... //other embed view config
3168
3241
  * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
@@ -3177,11 +3250,14 @@ export interface HomePageConfig {
3177
3250
  * **Note**: This option does not apply to the classic homepage.
3178
3251
  * To access the updated modular homepage, set
3179
3252
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3253
+ * To use it, you need to import `HomepageModule` enum.
3180
3254
  *
3181
3255
  * Supported embed types: `AppEmbed`
3182
3256
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3183
3257
  * @example
3184
3258
  * ```js
3259
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
3260
+ *
3185
3261
  * const embed = new AppEmbed('#tsEmbed', {
3186
3262
  * ... //other embed view config
3187
3263
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
@@ -3196,11 +3272,14 @@ export interface HomePageConfig {
3196
3272
  * **Note**: This option does not apply to the classic homepage.
3197
3273
  * To access the updated modular homepage, set
3198
3274
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3275
+ * To use it, you need to import `HomepageModule` enum.
3199
3276
  *
3200
3277
  * Supported embed types: `AppEmbed`
3201
3278
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3202
3279
  * @example
3203
3280
  * ```js
3281
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
3282
+ *
3204
3283
  * const embed = new AppEmbed('#tsEmbed', {
3205
3284
  * ... //other embed view config
3206
3285
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
@@ -3216,6 +3295,8 @@ export interface HomePageConfig {
3216
3295
  * Supported embed types: `AppEmbed`
3217
3296
  * @example
3218
3297
  * ```js
3298
+ * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
3299
+ *
3219
3300
  * const embed = new AppEmbed('#tsEmbed', {
3220
3301
  * ... //other embed view config
3221
3302
  * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
@@ -3225,6 +3306,7 @@ export interface HomePageConfig {
3225
3306
  * **Note**: This option does not apply to the classic homepage.
3226
3307
  * To access the updated modular homepage, set
3227
3308
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3309
+ * To use it, you need to import `HomeLeftNavItem` enum.
3228
3310
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3229
3311
  */
3230
3312
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -4433,7 +4515,7 @@ export enum EmbedEvent {
4433
4515
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4434
4516
  * @example
4435
4517
  *```js
4436
- * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
4518
+ * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
4437
4519
  * console.log('Liveboard details', payload);
4438
4520
  * })
4439
4521
  *```
@@ -4808,58 +4890,58 @@ export enum EmbedEvent {
4808
4890
  */
4809
4891
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
4810
4892
  /**
4811
- * Emitted when spotter response is text data
4893
+ * Emitted when Spotter response is text data
4812
4894
  * @example
4813
4895
  * ```js
4814
4896
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
4815
4897
  * console.log('payload', payload);
4816
4898
  * })
4817
4899
  *```
4818
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4900
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4819
4901
  */
4820
4902
  SpotterData = "SpotterData",
4821
4903
  /**
4822
- * Emitted when user opens up the worksheet preview modal in spotter embed.
4904
+ * Emitted when user opens up the worksheet preview modal in Spotter embed.
4823
4905
  * @example
4824
4906
  * ```js
4825
4907
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
4826
4908
  * console.log('payload', payload);
4827
4909
  * })
4828
4910
  *```
4829
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4911
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4830
4912
  */
4831
4913
  PreviewSpotterData = "PreviewSpotterData",
4832
4914
  /**
4833
- * Emitted when the spotter query is triggered in spotter embed.
4915
+ * Emitted when the Spotter query is triggered in Spotter embed.
4834
4916
  * @example
4835
4917
  * ```js
4836
4918
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
4837
4919
  * console.log('payload', payload);
4838
4920
  * })
4839
4921
  *```
4840
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4922
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4841
4923
  */
4842
4924
  SpotterQueryTriggered = "SpotterQueryTriggered",
4843
4925
  /**
4844
- * Emitted when the last spotter query is edited in spotter embed.
4926
+ * Emitted when the last Spotter query is edited in Spotter embed.
4845
4927
  * @example
4846
4928
  * ```js
4847
4929
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
4848
4930
  * console.log('payload', payload);
4849
4931
  * })
4850
4932
  *```
4851
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4933
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4852
4934
  */
4853
4935
  LastPromptEdited = "LastPromptEdited",
4854
4936
  /**
4855
- * Emitted when the last spotter query is deleted in spotter embed.
4937
+ * Emitted when the last Spotter query is deleted in Spotter embed.
4856
4938
  * @example
4857
4939
  * ```js
4858
4940
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
4859
4941
  * console.log('payload', payload);
4860
4942
  * })
4861
4943
  *```
4862
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4944
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4863
4945
  */
4864
4946
  LastPromptDeleted = "LastPromptDeleted",
4865
4947
  /**
@@ -4870,7 +4952,7 @@ export enum EmbedEvent {
4870
4952
  * console.log('payload', payload);
4871
4953
  * })
4872
4954
  *```
4873
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4955
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4874
4956
  */
4875
4957
  ResetSpotterConversation = "ResetSpotterConversation",
4876
4958
  /**
@@ -4883,7 +4965,19 @@ export enum EmbedEvent {
4883
4965
  *```
4884
4966
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4885
4967
  */
4886
- SpotterInit = "SpotterInit"
4968
+ SpotterInit = "spotterInit",
4969
+ /**
4970
+ * @hidden
4971
+ * Triggers when the embed listener is ready to receive events.
4972
+ * This is used to trigger events after the embed container is loaded.
4973
+ * @example
4974
+ * ```js
4975
+ * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
4976
+ * console.log('EmbedListenerReady');
4977
+ * })
4978
+ * ```
4979
+ */
4980
+ EmbedListenerReady = "EmbedListenerReady"
4887
4981
  }
4888
4982
  /**
4889
4983
  * Event types that can be triggered by the host application
@@ -4971,6 +5065,7 @@ export enum HostEvent {
4971
5065
  * done automatically on the most popular column.
4972
5066
  * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
4973
5067
  * in case of a Liveboard.
5068
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
4974
5069
  * @example
4975
5070
  * ```js
4976
5071
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -5290,12 +5385,21 @@ export enum HostEvent {
5290
5385
  * Trigger the **Download PDF** action on an embedded Liveboard,
5291
5386
  * visualization or Answer.
5292
5387
  *
5388
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5389
+ *
5293
5390
  * **NOTE**: The **Download** > **PDF** action is available on
5294
5391
  * visualizations and Answers if the data is in tabular format.
5295
5392
  * @example
5296
5393
  * ```js
5297
5394
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
5298
5395
  * ```
5396
+ * @example
5397
+ * ```js
5398
+ * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
5399
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5400
+ * });
5401
+ * ```
5402
+ *
5299
5403
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5300
5404
  */
5301
5405
  DownloadAsPdf = "downloadAsPdf",
@@ -5397,7 +5501,8 @@ export enum HostEvent {
5397
5501
  * This event is not supported in visualization embed and search embed.
5398
5502
  * @param - object - To trigger the action for a specific visualization
5399
5503
  * in Liveboard embed, pass in `vizId` as a key.
5400
- * **Required** in Spotter embed.
5504
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5505
+ *
5401
5506
  * @example
5402
5507
  * ```js
5403
5508
  * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5412,6 +5517,12 @@ export enum HostEvent {
5412
5517
  * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5413
5518
  * });
5414
5519
  * ```
5520
+ * @example
5521
+ * ```js
5522
+ * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
5523
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5524
+ * });
5525
+ * ```
5415
5526
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5416
5527
  */
5417
5528
  Edit = "edit",
@@ -5532,6 +5643,7 @@ export enum HostEvent {
5532
5643
  /**
5533
5644
  * Trigger the **Download** action on charts in
5534
5645
  * the embedded view.
5646
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5535
5647
  * @example
5536
5648
  * ```js
5537
5649
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -5540,6 +5652,11 @@ export enum HostEvent {
5540
5652
  * ```js
5541
5653
  * embed.trigger(HostEvent.Download)
5542
5654
  * ```
5655
+ * ```js
5656
+ * spotterEmbed.trigger(HostEvent.Download, {
5657
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5658
+ * });
5659
+ * ```
5543
5660
  * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
5544
5661
  * Use {@link DownloadAsPng}
5545
5662
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -5568,6 +5685,7 @@ export enum HostEvent {
5568
5685
  /**
5569
5686
  * Trigger the **Download** > **CSV** action on tables in
5570
5687
  * the embedded view.
5688
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5571
5689
  * @example
5572
5690
  * ```js
5573
5691
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -5590,6 +5708,7 @@ export enum HostEvent {
5590
5708
  /**
5591
5709
  * Trigger the **Download** > **XLSX** action on tables
5592
5710
  * in the embedded view.
5711
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5593
5712
  * @example
5594
5713
  * ```js
5595
5714
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -5625,7 +5744,7 @@ export enum HostEvent {
5625
5744
  /**
5626
5745
  * Trigger the **Save** action on a Liveboard or Answer.
5627
5746
  * Saves the changes.
5628
- * @param - `vizId` is required in Spotter Embed.
5747
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5629
5748
  * @example
5630
5749
  * ```js
5631
5750
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -5935,6 +6054,7 @@ export enum HostEvent {
5935
6054
  UpdateParameters = "UpdateParameters",
5936
6055
  /**
5937
6056
  * Triggers GetParameters to fetch the runtime Parameters.
6057
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5938
6058
  * ```js
5939
6059
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
5940
6060
  * console.log('parameters', parameter);
@@ -5978,7 +6098,7 @@ export enum HostEvent {
5978
6098
  * @param - optional attributes to set Answer properties.
5979
6099
  * `name` - Name string for the Answer.
5980
6100
  * `description` - Description text for the Answer.
5981
- *
6101
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5982
6102
  * @example
5983
6103
  * ```js
5984
6104
  * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -5986,6 +6106,14 @@ export enum HostEvent {
5986
6106
  * description: "Total sales by states in MidWest"
5987
6107
  * });
5988
6108
  * ```
6109
+ * @example
6110
+ * ```js
6111
+ * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
6112
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c',
6113
+ * name: "Sales by states",
6114
+ * description: "Total sales by states in MidWest"
6115
+ * });
6116
+ * ```
5989
6117
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5990
6118
  */
5991
6119
  SaveAnswer = "saveAnswer",
@@ -6017,7 +6145,7 @@ export enum HostEvent {
6017
6145
  /**
6018
6146
  * Triggers a search operation with the search tokens specified in
6019
6147
  * the search query string in spotter embed.
6020
- * @param - `queryString`: Text string in Natural Language format
6148
+ * @param - `query`: Text string in Natural Language format
6021
6149
  * @param - `executeSearch`: Boolean to execute search and update search query
6022
6150
  * @example
6023
6151
  * ```js
@@ -6026,6 +6154,7 @@ export enum HostEvent {
6026
6154
  * executeSearch: true,
6027
6155
  * })
6028
6156
  * ```
6157
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6029
6158
  */
6030
6159
  SpotterSearch = "SpotterSearch",
6031
6160
  /**
@@ -6035,6 +6164,7 @@ export enum HostEvent {
6035
6164
  * ```js
6036
6165
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
6037
6166
  * ```
6167
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6038
6168
  */
6039
6169
  EditLastPrompt = "EditLastPrompt",
6040
6170
  /**
@@ -6043,6 +6173,7 @@ export enum HostEvent {
6043
6173
  * ```js
6044
6174
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
6045
6175
  * ```
6176
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6046
6177
  */
6047
6178
  PreviewSpotterData = "PreviewSpotterData",
6048
6179
  /**
@@ -6051,6 +6182,7 @@ export enum HostEvent {
6051
6182
  * ```js
6052
6183
  * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
6053
6184
  * ```
6185
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6054
6186
  */
6055
6187
  ResetSpotterConversation = "ResetSpotterConversation",
6056
6188
  /**
@@ -6059,17 +6191,19 @@ export enum HostEvent {
6059
6191
  * ```js
6060
6192
  * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
6061
6193
  * ```
6194
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6062
6195
  */
6063
6196
  DeleteLastPrompt = "DeleteLastPrompt",
6064
6197
  /**
6065
6198
  * Toggle the visualization to chart or table view.
6066
- * @param - `vizId ` In Spotter Embed, vizId is required.
6199
+ * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
6067
6200
  * @example
6068
6201
  * ```js
6069
6202
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
6070
- * vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
6203
+ * vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
6071
6204
  * });
6072
6205
  *```
6206
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6073
6207
  */
6074
6208
  AnswerChartSwitcher = "answerChartSwitcher",
6075
6209
  /**
@@ -6096,25 +6230,16 @@ export enum HostEvent {
6096
6230
  */
6097
6231
  VisibleEmbedCoordinates = "visibleEmbedCoordinates",
6098
6232
  /**
6099
- * Trigger the *Ask Sage* action for visualizations
6233
+ * Trigger the *Ask Spotter* action for visualizations
6234
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6100
6235
  * @example
6101
6236
  * ```js
6102
- * liveboardEmbed.trigger(HostEvent.AskSpotter,
6103
- * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
6237
+ * spotterEmbed.trigger(HostEvent.AskSpotter,
6238
+ * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
6104
6239
  * ```
6105
6240
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
6106
6241
  */
6107
- AskSpotter = "askSpotter",
6108
- /**
6109
- * @hidden
6110
- * Triggers the update of the embed params.
6111
- *
6112
- * @example
6113
- * ```js
6114
- * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
6115
- * ```
6116
- */
6117
- UpdateEmbedParams = "updateEmbedParams"
6242
+ AskSpotter = "AskSpotter"
6118
6243
  }
6119
6244
  /**
6120
6245
  * The different visual modes that the data sources panel within
@@ -6210,6 +6335,7 @@ export enum Param {
6210
6335
  Query = "query",
6211
6336
  HideHomepageLeftNav = "hideHomepageLeftNav",
6212
6337
  ModularHomeExperienceEnabled = "modularHomeExperience",
6338
+ HomepageVersion = "homepageVersion",
6213
6339
  ListPageVersion = "listpageVersion",
6214
6340
  PendoTrackingKey = "additionalPendoKey",
6215
6341
  LiveboardHeaderSticky = "isLiveboardHeaderSticky",
@@ -6402,27 +6528,27 @@ export enum Action {
6402
6528
  */
6403
6529
  ConfigureFilter = "configureFilter",
6404
6530
  /**
6405
- * The **Collapse data sources** icon on the Search page.
6406
- * Collapses the panel showing data sources.
6407
- *
6408
- * @example
6409
- * ```js
6410
- * disabledActions: [Action.CollapseDataPanel]
6411
- * ```
6412
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
6413
- */
6531
+ * The **Collapse data sources** icon on the Search page.
6532
+ * Collapses the panel showing data sources.
6533
+ *
6534
+ * @example
6535
+ * ```js
6536
+ * disabledActions: [Action.CollapseDataPanel]
6537
+ * ```
6538
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
6539
+ */
6414
6540
  CollapseDataSources = "collapseDataSources",
6415
6541
  /**
6416
- * The **Collapse data panel** icon on the Search page.
6417
- * Collapses the data panel view.
6418
- *
6419
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6420
- *
6421
- * @example
6422
- * ```js
6423
- * disabledActions: [Action.CollapseDataPanel]
6424
- * ```
6425
- */
6542
+ * The **Collapse data panel** icon on the Search page.
6543
+ * Collapses the data panel view.
6544
+ *
6545
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6546
+ *
6547
+ * @example
6548
+ * ```js
6549
+ * disabledActions: [Action.CollapseDataPanel]
6550
+ * ```
6551
+ */
6426
6552
  CollapseDataPanel = "collapseDataPanel",
6427
6553
  /**
6428
6554
  * The **Choose sources** button on Search page.
@@ -7118,6 +7244,17 @@ export enum Action {
7118
7244
  * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
7119
7245
  */
7120
7246
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
7247
+ /**
7248
+ * Action ID to hide or disable Iterative Change Analysis option
7249
+ * on contextual change analysis Inisght charts context menu
7250
+ *
7251
+ * @example
7252
+ * ```js
7253
+ * disabledActions: [Action.EnableIterativeChangeAnalysis]
7254
+ * ```
7255
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
7256
+ */
7257
+ EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis",
7121
7258
  /**
7122
7259
  * Action ID to hide or disable Natural Language Search query.
7123
7260
  *
@@ -7486,7 +7623,40 @@ export enum Action {
7486
7623
  * ```
7487
7624
  * @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
7488
7625
  */
7489
- InConversationTraining = "InConversationTraining"
7626
+ InConversationTraining = "InConversationTraining",
7627
+ /**
7628
+ * Action ID to hide the warnings banner in
7629
+ * Spotter results. It's an EA feature and
7630
+ * handled by LD.
7631
+ * @example
7632
+ * ```js
7633
+ * hiddenAction: [Action.SpotterWarningsBanner]
7634
+ * ```
7635
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7636
+ */
7637
+ SpotterWarningsBanner = "SpotterWarningsBanner",
7638
+ /**
7639
+ * Action ID to hide the warnings border on the knowledge
7640
+ * card in Spotter results. It's an EA feature and
7641
+ * handled by LD.
7642
+ * @example
7643
+ * ```js
7644
+ * hiddenAction: [Action.SpotterWarningsOnTokens]
7645
+ * ```
7646
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7647
+ */
7648
+ SpotterWarningsOnTokens = "SpotterWarningsOnTokens",
7649
+ /**
7650
+ * Action ID to disable the click event handler on knowledge
7651
+ * card in Spotter results. It's an EA feature and
7652
+ * handled by LD.
7653
+ * @example
7654
+ * ```js
7655
+ * hiddenAction: [Action.SpotterTokenQuickEdit]
7656
+ * ```
7657
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7658
+ */
7659
+ SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
7490
7660
  }
7491
7661
  export interface AnswerServiceType {
7492
7662
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -8033,6 +8203,322 @@ export interface CustomCssVariables {
8033
8203
  * Background color of checkbox.
8034
8204
  */
8035
8205
  '--ts-var-checkbox-background-color'?: string;
8206
+ /**
8207
+ * Height of the tiles in the Liveboard.
8208
+ */
8209
+ '--ts-var-viz-tile-height'?: string;
8210
+ /**
8211
+ * Background color of the layout in the Liveboard.
8212
+ */
8213
+ '--ts-var-liveboard-layout-background'?: string;
8214
+ /**
8215
+ * Font color of the title of the layout in the Liveboard.
8216
+ */
8217
+ '--ts-var-liveboard-layout-title-color'?: string;
8218
+ /**
8219
+ * Font size of the title of the layout in the Liveboard.
8220
+ */
8221
+ '--ts-var-liveboard-layout-title-fontsize'?: string;
8222
+ /**
8223
+ * Background color of the header in the Liveboard.
8224
+ */
8225
+ '--ts-var-liveboard-header-background'?: string;
8226
+ /**
8227
+ * Font size of the header in the Liveboard.
8228
+ */
8229
+ '--ts-var-liveboard-header-fontsize'?: string;
8230
+ /**
8231
+ * Font color of the header in the Liveboard.
8232
+ */
8233
+ '--ts-var-liveboard-header-font-color'?: string;
8234
+ /**
8235
+ * Border color of the tiles in the Liveboard.
8236
+ */
8237
+ '--ts-var-liveboard-tile-border-color'?: string;
8238
+ /**
8239
+ * Background color of the tiles in the Liveboard.
8240
+ */
8241
+ '--ts-var-liveboard-tile-background'?: string;
8242
+ /**
8243
+ * Border radius of the tiles in the Liveboard.
8244
+ */
8245
+ '--ts-var-liveboard-tile-border-radius'?: string;
8246
+ /**
8247
+ * Padding of the tiles in the Liveboard.
8248
+ */
8249
+ '--ts-var-liveboard-tile-padding'?: string;
8250
+ /**
8251
+ * Background color of the table header in the Liveboard.
8252
+ */
8253
+ '--ts-var-liveboard-tile-table-header-background'?: string;
8254
+ /**
8255
+ * Padding of the groups in the Liveboard.
8256
+ */
8257
+ '--ts-var-liveboard-group-padding'?: string;
8258
+ /**
8259
+ * Padding of the title of the groups in the Liveboard.
8260
+ */
8261
+ '--ts-var-liveboard-group-title-padding'?: string;
8262
+ /**
8263
+ * Font size of the title of the groups in the Liveboard.
8264
+ */
8265
+ '--ts-var-liveboard-group-title-font-size'?: string;
8266
+ /**
8267
+ * Font weight of the title of the groups in the Liveboard.
8268
+ */
8269
+ '--ts-var-liveboard-group-title-font-weight'?: string;
8270
+ /**
8271
+ * Font size of the title of the tiles inside the groups in the Liveboard.
8272
+ */
8273
+ '--ts-var-liveboard-group-tile-title-font-size'?: string;
8274
+ /**
8275
+ * Font weight of the title of the tiles inside the groups in the Liveboard.
8276
+ */
8277
+ '--ts-var-liveboard-group-tile-title-font-weight'?: string;
8278
+ /**
8279
+ * Font size of the description of the groups in the Liveboard.
8280
+ */
8281
+ '--ts-var-liveboard-group-description-font-size'?: string;
8282
+ /**
8283
+ * Font weight of the description of the groups in the Liveboard.
8284
+ */
8285
+ '--ts-var-liveboard-group-description-font-weight'?: string;
8286
+ /**
8287
+ * Border of the tiles in the Liveboard.
8288
+ */
8289
+ '--ts-var-liveboard-group-tile-border'?: string;
8290
+ /**
8291
+ * Padding of the tiles in the Liveboard.
8292
+ */
8293
+ '--ts-var-liveboard-group-tile-padding'?: string;
8294
+ /**
8295
+ * Padding of the answer viz in the Liveboard.
8296
+ */
8297
+ '--ts-var-liveboard-answer-viz-padding'?: string;
8298
+ /**
8299
+ * Background color of the groups in the Liveboard.
8300
+ */
8301
+ '--ts-var-liveboard-group-background'?: string;
8302
+ /**
8303
+ * Border color of the groups in the Liveboard.
8304
+ */
8305
+ '--ts-var-liveboard-group-border-color'?: string;
8306
+ /**
8307
+ * Font color of the heading of the note title in the Liveboard.
8308
+ */
8309
+ '--ts-var-liveboard-notetitle-heading-font-color'?: string;
8310
+ /**
8311
+ * Font color of the body of the note title in the Liveboard.
8312
+ */
8313
+ '--ts-var-liveboard-notetitle-body-font-color'?: string;
8314
+ /**
8315
+ * Font color of the title of the groups in the Liveboard.
8316
+ */
8317
+ '--ts-var-liveboard-group-title-font-color'?: string;
8318
+ /**
8319
+ * Font color of the description of the groups in the Liveboard.
8320
+ */
8321
+ '--ts-var-liveboard-group-description-font-color'?: string;
8322
+ /**
8323
+ * Font color of the title of the tiles inside the groups in the Liveboard.
8324
+ */
8325
+ '--ts-var-liveboard-group-tile-title-font-color'?: string;
8326
+ /**
8327
+ * Background color of the tiles inside the groups in the Liveboard.
8328
+ */
8329
+ '--ts-var-liveboard-group-tile-background'?: string;
8330
+ /**
8331
+ * Background color of the chips in the Liveboard.
8332
+ */
8333
+ '--ts-var-liveboard-chip-background'?: string;
8334
+ /**
8335
+ * Font color of the chips in the Liveboard.
8336
+ */
8337
+ '--ts-var-liveboard-chip-color'?: string;
8338
+ /**
8339
+ * Background color of the chips in the Liveboard on hover.
8340
+ */
8341
+ '--ts-var-liveboard-chip--hover-background'?: string;
8342
+ /**
8343
+ * Font color of the chips in the Liveboard on hover.
8344
+ */
8345
+ '--ts-var-liveboard-chip--hover-color'?: string;
8346
+ /**
8347
+ * Background color of the chips in the Liveboard on active.
8348
+ */
8349
+ '--ts-var-liveboard-chip--active-background'?: string;
8350
+ /**
8351
+ * Font color of the chips in the Liveboard on active.
8352
+ */
8353
+ '--ts-var-liveboard-chip--active-color'?: string;
8354
+ /**
8355
+ * Width of the side panel in the Liveboard.
8356
+ */
8357
+ '--ts-var-side-panel-width'?: string;
8358
+ /**
8359
+ * Background color of the edit bar in the Liveboard.
8360
+ */
8361
+ '--ts-var-liveboard-edit-bar-background'?: string;
8362
+ /**
8363
+ * Breakpoint for the dual column layout in the Liveboard.
8364
+ */
8365
+ '--ts-var-liveboard-dual-column-breakpoint'?: string;
8366
+ /**
8367
+ * Breakpoint for the single column layout in the Liveboard.
8368
+ */
8369
+ '--ts-var-liveboard-single-column-breakpoint'?: string;
8370
+ /**
8371
+ * Background color of the cross filter layout in the Liveboard.
8372
+ */
8373
+ '--ts-var-liveboard-cross-filter-layout-background'?: string;
8374
+ /**
8375
+ * Border color of the active tab in the Liveboard.
8376
+ */
8377
+ '--ts-var-liveboard-tab-active-border-color'?: string;
8378
+ /**
8379
+ * Font color of the hover tab in the Liveboard.
8380
+ */
8381
+ '--ts-var-liveboard-tab-hover-color'?: string;
8382
+ /**
8383
+ * Font size of the title of the tiles in the Liveboard.
8384
+ */
8385
+ '--ts-var-liveboard-tile-title-fontsize'?: string;
8386
+ /**
8387
+ * Font weight of the title of the tiles in the Liveboard.
8388
+ */
8389
+ '--ts-var-liveboard-tile-title-fontweight'?: string;
8390
+ /**
8391
+ * Font weight of the description of the tiles in the Liveboard.
8392
+ */
8393
+ '--ts-var-liveboard-tile-description-font-weight'?: string;
8394
+ /**
8395
+ * Opacity of the description of the tiles in the Liveboard.
8396
+ */
8397
+ '--ts-var-liveboard-tile-description-opacity'?: string;
8398
+ /**
8399
+ * Background color of the parameter chips in the Liveboard.
8400
+ */
8401
+ '--ts-var-parameter-chip-background'?: string;
8402
+ /**
8403
+ * Font color of the parameter chips in the Liveboard.
8404
+ */
8405
+ '--ts-var-parameter-chip-text-color'?: string;
8406
+ /**
8407
+ * Background color of the parameter chips in the Liveboard on hover.
8408
+ */
8409
+ '--ts-var-parameter-chip-hover-background'?: string;
8410
+ /**
8411
+ * Font color of the parameter chips in the Liveboard on hover.
8412
+ */
8413
+ '--ts-var-parameter-chip-hover-text-color'?: string;
8414
+ /**
8415
+ * Background color of the parameter chips in the Liveboard on active.
8416
+ */
8417
+ '--ts-var-parameter-chip-active-background'?: string;
8418
+ /**
8419
+ * Font color of the parameter chips in the Liveboard on active.
8420
+ */
8421
+ '--ts-var-parameter-chip-active-text-color'?: string;
8422
+ /**
8423
+ * Background color of the action button in the Liveboard header.
8424
+ */
8425
+ '--ts-var-liveboard-header-action-button-background'?: string;
8426
+ /**
8427
+ * Font color of the action button in the Liveboard header.
8428
+ */
8429
+ '--ts-var-liveboard-header-action-button-font-color'?: string;
8430
+ /**
8431
+ * Font color of the action button in the Liveboard header on hover.
8432
+ */
8433
+ '--ts-var-liveboard-header-action-button-hover-color'?: string;
8434
+ /**
8435
+ * Font color of the action button in the Liveboard header on active.
8436
+ */
8437
+ '--ts-var-liveboard-header-action-button-active-color'?: string;
8438
+ /**
8439
+ * Background color of the badge in the Liveboard header.
8440
+ */
8441
+ '--ts-var-liveboard-header-badge-background'?: string;
8442
+ /**
8443
+ * Font color of the badge in the Liveboard header.
8444
+ */
8445
+ '--ts-var-liveboard-header-badge-font-color'?: string;
8446
+ /**
8447
+ * Background color of the modified badge in the Liveboard header.
8448
+ */
8449
+ '--ts-var-liveboard-header-badge-modified-background'?: string;
8450
+ /**
8451
+ * Font color of the modified badge in the Liveboard header.
8452
+ */
8453
+ '--ts-var-liveboard-header-badge-modified-font-color'?: string;
8454
+ /**
8455
+ * Font color of the badge in the Liveboard header on hover.
8456
+ */
8457
+ '--ts-var-liveboard-header-badge-hover-color'?: string;
8458
+ /**
8459
+ * Font color of the badge in the Liveboard header on active.
8460
+ */
8461
+ '--ts-var-liveboard-header-badge-active-color'?: string;
8462
+ /**
8463
+ * Font color of the hero text in the KPI widget.
8464
+ */
8465
+ '--ts-var-kpi-hero-color'?: string;
8466
+ /**
8467
+ * Font color of the comparison text in the KPI widget.
8468
+ */
8469
+ '--ts-var-kpi-comparison-color'?: string;
8470
+ /**
8471
+ * Font color of the analyze text in the KPI widget.
8472
+ */
8473
+ '--ts-var-kpi-analyze-text-color'?: string;
8474
+ /**
8475
+ * Font color of the legend title in the heatmap chart.
8476
+ */
8477
+ '--ts-var-chart-heatmap-legend-title-color'?: string;
8478
+ /**
8479
+ * Font color of the legend label in the heatmap chart.
8480
+ */
8481
+ '--ts-var-chart-heatmap-legend-label-color'?: string;
8482
+ /**
8483
+ * Font color of the legend title in the treemap chart.
8484
+ */
8485
+ '--ts-var-chart-treemap-legend-title-color'?: string;
8486
+ /**
8487
+ * Font color of the legend label in the treemap chart.
8488
+ */
8489
+ '--ts-var-chart-treemap-legend-label-color'?: string;
8490
+ /**
8491
+ * Color of the positive change in the KPI.
8492
+ */
8493
+ '--ts-var-kpi-positive-change-color'?: string;
8494
+ /**
8495
+ * Color of the negative change in the KPI.
8496
+ */
8497
+ '--ts-var-kpi-negative-change-color'?: string;
8498
+ /**
8499
+ * Background color of the change analysis insights.
8500
+ */
8501
+ '--ts-var-change-analysis-insights-background'?: string;
8502
+ /**
8503
+ * Background color of the forecasting card in the SpotIQ analyze.
8504
+ */
8505
+ '--ts-var-spotiq-analyze-forecasting-card-background'?: string;
8506
+ /**
8507
+ * Background color of the outlier card in the SpotIQ analyze.
8508
+ */
8509
+ '--ts-var-spotiq-analyze-outlier-card-background'?: string;
8510
+ /**
8511
+ * Background color of the trend card in the SpotIQ analyze.
8512
+ */
8513
+ '--ts-var-spotiq-analyze-trend-card-background'?: string;
8514
+ /**
8515
+ * Background color of the crosscorrelation card in the SpotIQ analyze.
8516
+ */
8517
+ '--ts-var-spotiq-analyze-crosscorrelation-card-background'?: string;
8518
+ /**
8519
+ * Background color of the summary header in the CCA modal.
8520
+ */
8521
+ '--ts-var-cca-modal-summary-header-background'?: string;
8036
8522
  }
8037
8523
 
8038
8524
  /**
@@ -8177,7 +8663,6 @@ export class SageEmbed extends V1Embed {
8177
8663
  */
8178
8664
  protected viewConfig: SageViewConfig;
8179
8665
  constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
8180
- protected getEmbedParamsObject(): Record<any, any>;
8181
8666
  /**
8182
8667
  * Constructs a map of parameters to be passed on to the
8183
8668
  * embedded Eureka or Sage search page.
@@ -8521,16 +9006,31 @@ export const getAnswerFromQuery: (query: string, worksheetId: string) => Promise
8521
9006
  }>;
8522
9007
 
8523
9008
  /**
8524
- * Create a liveboard with the given answers
8525
- * @param answers AnswerService[]
8526
- * @param name string
9009
+ * Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances.
9010
+ *
9011
+ * Each answer will be added as a visualization to the newly created Liveboard.
9012
+ *
9013
+ * @param {AnswerService[]} answers - An array of initialized `AnswerService` instances
9014
+ * representing the answers to be added to the Liveboard.
9015
+ * @param {string} name - The name of the Liveboard to create.
8527
9016
  * @returns result Promise
8528
9017
  * @version SDK: 1.33.1 | ThoughtSpot: *
8529
9018
  * @example
8530
9019
  * ```js
8531
- * const lb = createLiveboardWithAnswers([
8532
- * new AnswerService(session, null, 'tshost'),
8533
- * ], "my-liveboard");
9020
+ * import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk";
9021
+ *
9022
+ * embed.on(EmbedEvent.Data, async () => {
9023
+ * try {
9024
+ * const answerService = await embed.getAnswerService();
9025
+ * const lb = await createLiveboardWithAnswers(
9026
+ * [answerService],
9027
+ * "My Liveboard"
9028
+ * );
9029
+ * console.log("Liveboard created:", lb);
9030
+ * } catch (err) {
9031
+ * console.error("Failed to create liveboard:", err);
9032
+ * }
9033
+ * });
8534
9034
  * ```
8535
9035
  */
8536
9036
  export const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
@@ -8689,25 +9189,20 @@ export class TsEmbed {
8689
9189
  protected isRendered: boolean;
8690
9190
  protected hostEventClient: HostEventClient;
8691
9191
  protected isReadyForRenderPromise: Promise<void>;
8692
- id: string;
8693
9192
  constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
8694
9193
  /**
8695
9194
  * Handles errors within the SDK
8696
9195
  * @param error The error message or object
8697
9196
  */
8698
9197
  protected handleError(error: string | Record<string, unknown>): void;
8699
- isEmbedContainerLoaded: boolean;
8700
9198
  protected getAuthTokenForCookielessInit(): Promise<string>;
8701
9199
  protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
8702
9200
  protected getAppInitData(): Promise<DefaultAppInitData>;
8703
- protected getPreRenderObj<T extends TsEmbed>(): T;
8704
- protected triggerAfterLoad(eventType: HostEvent, data: TriggerPayload<any, HostEvent>, onEventTriggered?: () => void): void;
8705
9201
  /**
8706
9202
  * Constructs the base URL string to load the ThoughtSpot app.
8707
9203
  * @param query
8708
9204
  */
8709
9205
  protected getEmbedBasePath(query: string): string;
8710
- protected getUpdateEmbedParamsObject(): Record<any, any>;
8711
9206
  /**
8712
9207
  * Common query params set for all the embed modes.
8713
9208
  * @param queryParams
@@ -8723,7 +9218,6 @@ export class TsEmbed {
8723
9218
  */
8724
9219
  protected getV1EmbedBasePath(queryString: string): string;
8725
9220
  protected getEmbedParams(): string;
8726
- protected getEmbedParamsObject(): Record<any, any>;
8727
9221
  protected getRootIframeSrc(): string;
8728
9222
  protected createIframeEl(frameSrc: string): HTMLIFrameElement;
8729
9223
  protected handleInsertionIntoDOM(child: string | Node): void;
@@ -8815,6 +9309,19 @@ export class TsEmbed {
8815
9309
  * ```
8816
9310
  */
8817
9311
  off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
9312
+ /**
9313
+ * @hidden
9314
+ * Internal state to track if the embed container is loaded.
9315
+ * This is used to trigger events after the embed container is loaded.
9316
+ */
9317
+ isEmbedContainerLoaded: boolean;
9318
+ protected getPreRenderObj<T extends TsEmbed>(): T;
9319
+ /**
9320
+ * Executes a callback after the embed container is loaded.
9321
+ * @param callback The callback to execute
9322
+ */
9323
+ protected executeAfterEmbedContainerLoaded(callback: () => void): void;
9324
+ protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void;
8818
9325
  /**
8819
9326
  * Triggers an event to the embedded app
8820
9327
  * @param {HostEvent} messageType The event type