@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
@@ -662,7 +662,6 @@ export declare class SearchBarEmbed extends TsEmbed {
662
662
  protected viewConfig: SearchBarViewConfig;
663
663
  protected embedComponentType: string;
664
664
  constructor(domSelector: string, viewConfig: SearchBarViewConfig);
665
- protected getEmbedParamsObject(): Record<any, any>;
666
665
  /**
667
666
  * Render the embedded ThoughtSpot search
668
667
  */
@@ -815,7 +814,6 @@ export declare class SageEmbed extends V1Embed {
815
814
  */
816
815
  protected viewConfig: SageViewConfig;
817
816
  constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
818
- protected getEmbedParamsObject(): Record<any, any>;
819
817
  /**
820
818
  * Constructs a map of parameters to be passed on to the
821
819
  * embedded Eureka or Sage search page.
@@ -1153,7 +1151,6 @@ export declare class SearchEmbed extends TsEmbed {
1153
1151
  };
1154
1152
  };
1155
1153
  protected getAppInitData(): Promise<SearchAppInitData>;
1156
- protected getEmbedParamsObject(): Record<any, any>;
1157
1154
  protected getEmbedParams(): string;
1158
1155
  /**
1159
1156
  * Construct the URL of the embedded ThoughtSpot search to be
@@ -1258,7 +1255,12 @@ export declare enum HomePage {
1258
1255
  * Modular (v2) introduces the updated Modular Home Experience.
1259
1256
  * It serves as the foundational version of the home page.
1260
1257
  */
1261
- Modular = "v2"
1258
+ Modular = "v2",
1259
+ /**
1260
+ * ModularWithStylingChanges (v3) introduces Modular Home Experience
1261
+ * with styling changes.
1262
+ */
1263
+ ModularWithStylingChanges = "v3"
1262
1264
  }
1263
1265
  /**
1264
1266
  * Define the version of the list page
@@ -2134,7 +2136,16 @@ export declare class LiveboardEmbed extends V1Embed {
2134
2136
  * embedded Liveboard or visualization.
2135
2137
  */
2136
2138
  protected getEmbedParams(): string;
2137
- protected getEmbedParamsObject(): any;
2139
+ /**
2140
+ * @hidden
2141
+ * Internal state to track the current liveboard id.
2142
+ * This is used to navigate to the correct liveboard when the prerender is visible.
2143
+ */
2144
+ currentLiveboardState: {
2145
+ liveboardId: string;
2146
+ vizId: string;
2147
+ activeTabId: string;
2148
+ };
2138
2149
  protected beforePrerenderVisible(): void;
2139
2150
  protected handleRenderForPrerender(): Promise<TsEmbed>;
2140
2151
  /**
@@ -2155,8 +2166,7 @@ export declare class LiveboardEmbed extends V1Embed {
2155
2166
  * visualization ID and the runtime filters.
2156
2167
  */
2157
2168
  render(): Promise<LiveboardEmbed>;
2158
- currentLiveboardId: string;
2159
- navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, onNavigateCalled?: () => void): void;
2169
+ navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
2160
2170
  /**
2161
2171
  * Returns the full url of the Liveboard/visualization which can be used to open
2162
2172
  * this Liveboard inside the full ThoughtSpot application in a new tab.
@@ -2199,7 +2209,6 @@ export interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConf
2199
2209
  export declare class ConversationMessage extends TsEmbed {
2200
2210
  protected viewConfig: SpotterAgentMessageViewConfig;
2201
2211
  constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
2202
- protected getEmbedParamsObject(): Record<any, any>;
2203
2212
  getIframeSrc(): string;
2204
2213
  render(): Promise<ConversationMessage>;
2205
2214
  }
@@ -3284,12 +3293,15 @@ export interface HomePageConfig {
3284
3293
  * Hide list page columns
3285
3294
  * For example: hiddenListColumns = [ListPageColumns.Author]
3286
3295
  *
3287
- * **Note**: This option is available only in full app embedding.
3296
+ * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
3297
+ * 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.
3288
3298
  *
3289
3299
  * Supported embed types: `AppEmbed`
3290
3300
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3291
3301
  * @example
3292
3302
  * ```js
3303
+ * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
3304
+ *
3293
3305
  * const embed = new AppEmbed('#tsEmbed', {
3294
3306
  * ... //other embed view config
3295
3307
  * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
@@ -3304,11 +3316,14 @@ export interface HomePageConfig {
3304
3316
  * **Note**: This option does not apply to the classic homepage.
3305
3317
  * To access the updated modular homepage, set
3306
3318
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3319
+ * To use it, you need to import `HomepageModule` enum.
3307
3320
  *
3308
3321
  * Supported embed types: `AppEmbed`
3309
3322
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3310
3323
  * @example
3311
3324
  * ```js
3325
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
3326
+ *
3312
3327
  * const embed = new AppEmbed('#tsEmbed', {
3313
3328
  * ... //other embed view config
3314
3329
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
@@ -3323,11 +3338,14 @@ export interface HomePageConfig {
3323
3338
  * **Note**: This option does not apply to the classic homepage.
3324
3339
  * To access the updated modular homepage, set
3325
3340
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3341
+ * To use it, you need to import `HomepageModule` enum.
3326
3342
  *
3327
3343
  * Supported embed types: `AppEmbed`
3328
3344
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3329
3345
  * @example
3330
3346
  * ```js
3347
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
3348
+ *
3331
3349
  * const embed = new AppEmbed('#tsEmbed', {
3332
3350
  * ... //other embed view config
3333
3351
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
@@ -3343,6 +3361,8 @@ export interface HomePageConfig {
3343
3361
  * Supported embed types: `AppEmbed`
3344
3362
  * @example
3345
3363
  * ```js
3364
+ * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
3365
+ *
3346
3366
  * const embed = new AppEmbed('#tsEmbed', {
3347
3367
  * ... //other embed view config
3348
3368
  * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
@@ -3352,6 +3372,7 @@ export interface HomePageConfig {
3352
3372
  * **Note**: This option does not apply to the classic homepage.
3353
3373
  * To access the updated modular homepage, set
3354
3374
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3375
+ * To use it, you need to import `HomeLeftNavItem` enum.
3355
3376
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3356
3377
  */
3357
3378
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -4560,7 +4581,7 @@ export declare enum EmbedEvent {
4560
4581
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4561
4582
  * @example
4562
4583
  *```js
4563
- * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
4584
+ * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
4564
4585
  * console.log('Liveboard details', payload);
4565
4586
  * })
4566
4587
  *```
@@ -4935,58 +4956,58 @@ export declare enum EmbedEvent {
4935
4956
  */
4936
4957
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
4937
4958
  /**
4938
- * Emitted when spotter response is text data
4959
+ * Emitted when Spotter response is text data
4939
4960
  * @example
4940
4961
  * ```js
4941
4962
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
4942
4963
  * console.log('payload', payload);
4943
4964
  * })
4944
4965
  *```
4945
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4966
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4946
4967
  */
4947
4968
  SpotterData = "SpotterData",
4948
4969
  /**
4949
- * Emitted when user opens up the worksheet preview modal in spotter embed.
4970
+ * Emitted when user opens up the worksheet preview modal in Spotter embed.
4950
4971
  * @example
4951
4972
  * ```js
4952
4973
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
4953
4974
  * console.log('payload', payload);
4954
4975
  * })
4955
4976
  *```
4956
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4977
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4957
4978
  */
4958
4979
  PreviewSpotterData = "PreviewSpotterData",
4959
4980
  /**
4960
- * Emitted when the spotter query is triggered in spotter embed.
4981
+ * Emitted when the Spotter query is triggered in Spotter embed.
4961
4982
  * @example
4962
4983
  * ```js
4963
4984
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
4964
4985
  * console.log('payload', payload);
4965
4986
  * })
4966
4987
  *```
4967
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4988
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4968
4989
  */
4969
4990
  SpotterQueryTriggered = "SpotterQueryTriggered",
4970
4991
  /**
4971
- * Emitted when the last spotter query is edited in spotter embed.
4992
+ * Emitted when the last Spotter query is edited in Spotter embed.
4972
4993
  * @example
4973
4994
  * ```js
4974
4995
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
4975
4996
  * console.log('payload', payload);
4976
4997
  * })
4977
4998
  *```
4978
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
4999
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4979
5000
  */
4980
5001
  LastPromptEdited = "LastPromptEdited",
4981
5002
  /**
4982
- * Emitted when the last spotter query is deleted in spotter embed.
5003
+ * Emitted when the last Spotter query is deleted in Spotter embed.
4983
5004
  * @example
4984
5005
  * ```js
4985
5006
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
4986
5007
  * console.log('payload', payload);
4987
5008
  * })
4988
5009
  *```
4989
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5010
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4990
5011
  */
4991
5012
  LastPromptDeleted = "LastPromptDeleted",
4992
5013
  /**
@@ -4997,7 +5018,7 @@ export declare enum EmbedEvent {
4997
5018
  * console.log('payload', payload);
4998
5019
  * })
4999
5020
  *```
5000
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5021
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
5001
5022
  */
5002
5023
  ResetSpotterConversation = "ResetSpotterConversation",
5003
5024
  /**
@@ -5010,7 +5031,19 @@ export declare enum EmbedEvent {
5010
5031
  *```
5011
5032
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5012
5033
  */
5013
- SpotterInit = "SpotterInit"
5034
+ SpotterInit = "spotterInit",
5035
+ /**
5036
+ * @hidden
5037
+ * Triggers when the embed listener is ready to receive events.
5038
+ * This is used to trigger events after the embed container is loaded.
5039
+ * @example
5040
+ * ```js
5041
+ * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
5042
+ * console.log('EmbedListenerReady');
5043
+ * })
5044
+ * ```
5045
+ */
5046
+ EmbedListenerReady = "EmbedListenerReady"
5014
5047
  }
5015
5048
  /**
5016
5049
  * Event types that can be triggered by the host application
@@ -5098,6 +5131,7 @@ export declare enum HostEvent {
5098
5131
  * done automatically on the most popular column.
5099
5132
  * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
5100
5133
  * in case of a Liveboard.
5134
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5101
5135
  * @example
5102
5136
  * ```js
5103
5137
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -5417,12 +5451,21 @@ export declare enum HostEvent {
5417
5451
  * Trigger the **Download PDF** action on an embedded Liveboard,
5418
5452
  * visualization or Answer.
5419
5453
  *
5454
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5455
+ *
5420
5456
  * **NOTE**: The **Download** > **PDF** action is available on
5421
5457
  * visualizations and Answers if the data is in tabular format.
5422
5458
  * @example
5423
5459
  * ```js
5424
5460
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
5425
5461
  * ```
5462
+ * @example
5463
+ * ```js
5464
+ * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
5465
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5466
+ * });
5467
+ * ```
5468
+ *
5426
5469
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5427
5470
  */
5428
5471
  DownloadAsPdf = "downloadAsPdf",
@@ -5524,7 +5567,8 @@ export declare enum HostEvent {
5524
5567
  * This event is not supported in visualization embed and search embed.
5525
5568
  * @param - object - To trigger the action for a specific visualization
5526
5569
  * in Liveboard embed, pass in `vizId` as a key.
5527
- * **Required** in Spotter embed.
5570
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5571
+ *
5528
5572
  * @example
5529
5573
  * ```js
5530
5574
  * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5539,6 +5583,12 @@ export declare enum HostEvent {
5539
5583
  * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5540
5584
  * });
5541
5585
  * ```
5586
+ * @example
5587
+ * ```js
5588
+ * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
5589
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5590
+ * });
5591
+ * ```
5542
5592
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5543
5593
  */
5544
5594
  Edit = "edit",
@@ -5659,6 +5709,7 @@ export declare enum HostEvent {
5659
5709
  /**
5660
5710
  * Trigger the **Download** action on charts in
5661
5711
  * the embedded view.
5712
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5662
5713
  * @example
5663
5714
  * ```js
5664
5715
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -5667,6 +5718,11 @@ export declare enum HostEvent {
5667
5718
  * ```js
5668
5719
  * embed.trigger(HostEvent.Download)
5669
5720
  * ```
5721
+ * ```js
5722
+ * spotterEmbed.trigger(HostEvent.Download, {
5723
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5724
+ * });
5725
+ * ```
5670
5726
  * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
5671
5727
  * Use {@link DownloadAsPng}
5672
5728
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -5695,6 +5751,7 @@ export declare enum HostEvent {
5695
5751
  /**
5696
5752
  * Trigger the **Download** > **CSV** action on tables in
5697
5753
  * the embedded view.
5754
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5698
5755
  * @example
5699
5756
  * ```js
5700
5757
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -5717,6 +5774,7 @@ export declare enum HostEvent {
5717
5774
  /**
5718
5775
  * Trigger the **Download** > **XLSX** action on tables
5719
5776
  * in the embedded view.
5777
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5720
5778
  * @example
5721
5779
  * ```js
5722
5780
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -5752,7 +5810,7 @@ export declare enum HostEvent {
5752
5810
  /**
5753
5811
  * Trigger the **Save** action on a Liveboard or Answer.
5754
5812
  * Saves the changes.
5755
- * @param - `vizId` is required in Spotter Embed.
5813
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5756
5814
  * @example
5757
5815
  * ```js
5758
5816
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -6062,6 +6120,7 @@ export declare enum HostEvent {
6062
6120
  UpdateParameters = "UpdateParameters",
6063
6121
  /**
6064
6122
  * Triggers GetParameters to fetch the runtime Parameters.
6123
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6065
6124
  * ```js
6066
6125
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
6067
6126
  * console.log('parameters', parameter);
@@ -6105,7 +6164,7 @@ export declare enum HostEvent {
6105
6164
  * @param - optional attributes to set Answer properties.
6106
6165
  * `name` - Name string for the Answer.
6107
6166
  * `description` - Description text for the Answer.
6108
- *
6167
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6109
6168
  * @example
6110
6169
  * ```js
6111
6170
  * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -6113,6 +6172,14 @@ export declare enum HostEvent {
6113
6172
  * description: "Total sales by states in MidWest"
6114
6173
  * });
6115
6174
  * ```
6175
+ * @example
6176
+ * ```js
6177
+ * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
6178
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c',
6179
+ * name: "Sales by states",
6180
+ * description: "Total sales by states in MidWest"
6181
+ * });
6182
+ * ```
6116
6183
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
6117
6184
  */
6118
6185
  SaveAnswer = "saveAnswer",
@@ -6144,7 +6211,7 @@ export declare enum HostEvent {
6144
6211
  /**
6145
6212
  * Triggers a search operation with the search tokens specified in
6146
6213
  * the search query string in spotter embed.
6147
- * @param - `queryString`: Text string in Natural Language format
6214
+ * @param - `query`: Text string in Natural Language format
6148
6215
  * @param - `executeSearch`: Boolean to execute search and update search query
6149
6216
  * @example
6150
6217
  * ```js
@@ -6153,6 +6220,7 @@ export declare enum HostEvent {
6153
6220
  * executeSearch: true,
6154
6221
  * })
6155
6222
  * ```
6223
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6156
6224
  */
6157
6225
  SpotterSearch = "SpotterSearch",
6158
6226
  /**
@@ -6162,6 +6230,7 @@ export declare enum HostEvent {
6162
6230
  * ```js
6163
6231
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
6164
6232
  * ```
6233
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6165
6234
  */
6166
6235
  EditLastPrompt = "EditLastPrompt",
6167
6236
  /**
@@ -6170,6 +6239,7 @@ export declare enum HostEvent {
6170
6239
  * ```js
6171
6240
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
6172
6241
  * ```
6242
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6173
6243
  */
6174
6244
  PreviewSpotterData = "PreviewSpotterData",
6175
6245
  /**
@@ -6178,6 +6248,7 @@ export declare enum HostEvent {
6178
6248
  * ```js
6179
6249
  * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
6180
6250
  * ```
6251
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6181
6252
  */
6182
6253
  ResetSpotterConversation = "ResetSpotterConversation",
6183
6254
  /**
@@ -6186,17 +6257,19 @@ export declare enum HostEvent {
6186
6257
  * ```js
6187
6258
  * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
6188
6259
  * ```
6260
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6189
6261
  */
6190
6262
  DeleteLastPrompt = "DeleteLastPrompt",
6191
6263
  /**
6192
6264
  * Toggle the visualization to chart or table view.
6193
- * @param - `vizId ` In Spotter Embed, vizId is required.
6265
+ * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
6194
6266
  * @example
6195
6267
  * ```js
6196
6268
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
6197
- * vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
6269
+ * vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
6198
6270
  * });
6199
6271
  *```
6272
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6200
6273
  */
6201
6274
  AnswerChartSwitcher = "answerChartSwitcher",
6202
6275
  /**
@@ -6223,25 +6296,16 @@ export declare enum HostEvent {
6223
6296
  */
6224
6297
  VisibleEmbedCoordinates = "visibleEmbedCoordinates",
6225
6298
  /**
6226
- * Trigger the *Ask Sage* action for visualizations
6299
+ * Trigger the *Ask Spotter* action for visualizations
6300
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6227
6301
  * @example
6228
6302
  * ```js
6229
- * liveboardEmbed.trigger(HostEvent.AskSpotter,
6230
- * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
6303
+ * spotterEmbed.trigger(HostEvent.AskSpotter,
6304
+ * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
6231
6305
  * ```
6232
6306
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
6233
6307
  */
6234
- AskSpotter = "askSpotter",
6235
- /**
6236
- * @hidden
6237
- * Triggers the update of the embed params.
6238
- *
6239
- * @example
6240
- * ```js
6241
- * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
6242
- * ```
6243
- */
6244
- UpdateEmbedParams = "updateEmbedParams"
6308
+ AskSpotter = "AskSpotter"
6245
6309
  }
6246
6310
  /**
6247
6311
  * The different visual modes that the data sources panel within
@@ -6337,6 +6401,7 @@ export declare enum Param {
6337
6401
  Query = "query",
6338
6402
  HideHomepageLeftNav = "hideHomepageLeftNav",
6339
6403
  ModularHomeExperienceEnabled = "modularHomeExperience",
6404
+ HomepageVersion = "homepageVersion",
6340
6405
  ListPageVersion = "listpageVersion",
6341
6406
  PendoTrackingKey = "additionalPendoKey",
6342
6407
  LiveboardHeaderSticky = "isLiveboardHeaderSticky",
@@ -6529,27 +6594,27 @@ export declare enum Action {
6529
6594
  */
6530
6595
  ConfigureFilter = "configureFilter",
6531
6596
  /**
6532
- * The **Collapse data sources** icon on the Search page.
6533
- * Collapses the panel showing data sources.
6534
- *
6535
- * @example
6536
- * ```js
6537
- * disabledActions: [Action.CollapseDataPanel]
6538
- * ```
6539
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
6540
- */
6597
+ * The **Collapse data sources** icon on the Search page.
6598
+ * Collapses the panel showing data sources.
6599
+ *
6600
+ * @example
6601
+ * ```js
6602
+ * disabledActions: [Action.CollapseDataPanel]
6603
+ * ```
6604
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
6605
+ */
6541
6606
  CollapseDataSources = "collapseDataSources",
6542
6607
  /**
6543
- * The **Collapse data panel** icon on the Search page.
6544
- * Collapses the data panel view.
6545
- *
6546
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6547
- *
6548
- * @example
6549
- * ```js
6550
- * disabledActions: [Action.CollapseDataPanel]
6551
- * ```
6552
- */
6608
+ * The **Collapse data panel** icon on the Search page.
6609
+ * Collapses the data panel view.
6610
+ *
6611
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6612
+ *
6613
+ * @example
6614
+ * ```js
6615
+ * disabledActions: [Action.CollapseDataPanel]
6616
+ * ```
6617
+ */
6553
6618
  CollapseDataPanel = "collapseDataPanel",
6554
6619
  /**
6555
6620
  * The **Choose sources** button on Search page.
@@ -7245,6 +7310,17 @@ export declare enum Action {
7245
7310
  * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
7246
7311
  */
7247
7312
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
7313
+ /**
7314
+ * Action ID to hide or disable Iterative Change Analysis option
7315
+ * on contextual change analysis Inisght charts context menu
7316
+ *
7317
+ * @example
7318
+ * ```js
7319
+ * disabledActions: [Action.EnableIterativeChangeAnalysis]
7320
+ * ```
7321
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
7322
+ */
7323
+ EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis",
7248
7324
  /**
7249
7325
  * Action ID to hide or disable Natural Language Search query.
7250
7326
  *
@@ -7613,7 +7689,40 @@ export declare enum Action {
7613
7689
  * ```
7614
7690
  * @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
7615
7691
  */
7616
- InConversationTraining = "InConversationTraining"
7692
+ InConversationTraining = "InConversationTraining",
7693
+ /**
7694
+ * Action ID to hide the warnings banner in
7695
+ * Spotter results. It's an EA feature and
7696
+ * handled by LD.
7697
+ * @example
7698
+ * ```js
7699
+ * hiddenAction: [Action.SpotterWarningsBanner]
7700
+ * ```
7701
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7702
+ */
7703
+ SpotterWarningsBanner = "SpotterWarningsBanner",
7704
+ /**
7705
+ * Action ID to hide the warnings border on the knowledge
7706
+ * card in Spotter results. It's an EA feature and
7707
+ * handled by LD.
7708
+ * @example
7709
+ * ```js
7710
+ * hiddenAction: [Action.SpotterWarningsOnTokens]
7711
+ * ```
7712
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7713
+ */
7714
+ SpotterWarningsOnTokens = "SpotterWarningsOnTokens",
7715
+ /**
7716
+ * Action ID to disable the click event handler on knowledge
7717
+ * card in Spotter results. It's an EA feature and
7718
+ * handled by LD.
7719
+ * @example
7720
+ * ```js
7721
+ * hiddenAction: [Action.SpotterTokenQuickEdit]
7722
+ * ```
7723
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7724
+ */
7725
+ SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
7617
7726
  }
7618
7727
  export interface AnswerServiceType {
7619
7728
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -7807,7 +7916,8 @@ export interface SearchOptions {
7807
7916
  */
7808
7917
  export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
7809
7918
  /**
7810
- * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
7919
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses
7920
+ * this object to query data and generate Answers.
7811
7921
  */
7812
7922
  worksheetId: string;
7813
7923
  /**
@@ -7890,6 +8000,66 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
7890
8000
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
7891
8001
  */
7892
8002
  hideSampleQuestions?: boolean;
8003
+ /**
8004
+ * The list of runtime filters to apply to a search Answer,
8005
+ * visualization, or Liveboard.
8006
+ *
8007
+ * Supported embed types: `SpotterEmbed`
8008
+ * @example
8009
+ * ```js
8010
+ * const embed = new SpotterEmbed('#tsEmbed', {
8011
+ * // other embed view config
8012
+ * runtimeFilters: [
8013
+ * {
8014
+ * columnName: 'color',
8015
+ * operator: RuntimeFilterOp.EQ,
8016
+ * values: ['red'],
8017
+ * },
8018
+ * ],
8019
+ * })
8020
+ * ```
8021
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8022
+ */
8023
+ runtimeFilters?: RuntimeFilter[];
8024
+ /**
8025
+ * Flag to control whether runtime filters should be included in the URL.
8026
+ * If true, filters will be passed via app initialization payload instead.
8027
+ * If false/undefined, filters will be added to URL (default behavior).
8028
+ *
8029
+ * Supported embed types: `SpotterEmbed`
8030
+ * @default false
8031
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8032
+ */
8033
+ excludeRuntimeFiltersfromURL?: boolean;
8034
+ /**
8035
+ * The list of runtime parameters to apply to the conversation.
8036
+ *
8037
+ * Supported embed types: `SpotterEmbed`
8038
+ * @example
8039
+ * ```js
8040
+ * const embed = new SpotterEmbed('#tsEmbed', {
8041
+ * // other embed view config
8042
+ * runtimeParameters: [
8043
+ * {
8044
+ * name: 'Integer Param',
8045
+ * value: 10,
8046
+ * },
8047
+ * ],
8048
+ * })
8049
+ * ```
8050
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8051
+ */
8052
+ runtimeParameters?: RuntimeParameter[];
8053
+ /**
8054
+ * Flag to control whether runtime parameters should be included in the URL.
8055
+ * If true, parameters will be passed via app initialization payload instead.
8056
+ * If false/undefined, parameters will be added to URL (default behavior).
8057
+ *
8058
+ * Supported embed types: `SpotterEmbed`
8059
+ * @default false
8060
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8061
+ */
8062
+ excludeRuntimeParametersfromURL?: boolean;
7893
8063
  }
7894
8064
  /**
7895
8065
  * The configuration for the embedded spotterEmbed options.
@@ -7917,7 +8087,6 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
7917
8087
  export declare class SpotterEmbed extends TsEmbed {
7918
8088
  protected viewConfig: SpotterEmbedViewConfig;
7919
8089
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
7920
- protected getEmbedParamsObject(): Record<any, any>;
7921
8090
  getIframeSrc(): string;
7922
8091
  render(): Promise<SpotterEmbed>;
7923
8092
  }
@@ -8578,6 +8747,322 @@ export interface CustomCssVariables {
8578
8747
  * Background color of checkbox.
8579
8748
  */
8580
8749
  '--ts-var-checkbox-background-color'?: string;
8750
+ /**
8751
+ * Height of the tiles in the Liveboard.
8752
+ */
8753
+ '--ts-var-viz-tile-height'?: string;
8754
+ /**
8755
+ * Background color of the layout in the Liveboard.
8756
+ */
8757
+ '--ts-var-liveboard-layout-background'?: string;
8758
+ /**
8759
+ * Font color of the title of the layout in the Liveboard.
8760
+ */
8761
+ '--ts-var-liveboard-layout-title-color'?: string;
8762
+ /**
8763
+ * Font size of the title of the layout in the Liveboard.
8764
+ */
8765
+ '--ts-var-liveboard-layout-title-fontsize'?: string;
8766
+ /**
8767
+ * Background color of the header in the Liveboard.
8768
+ */
8769
+ '--ts-var-liveboard-header-background'?: string;
8770
+ /**
8771
+ * Font size of the header in the Liveboard.
8772
+ */
8773
+ '--ts-var-liveboard-header-fontsize'?: string;
8774
+ /**
8775
+ * Font color of the header in the Liveboard.
8776
+ */
8777
+ '--ts-var-liveboard-header-font-color'?: string;
8778
+ /**
8779
+ * Border color of the tiles in the Liveboard.
8780
+ */
8781
+ '--ts-var-liveboard-tile-border-color'?: string;
8782
+ /**
8783
+ * Background color of the tiles in the Liveboard.
8784
+ */
8785
+ '--ts-var-liveboard-tile-background'?: string;
8786
+ /**
8787
+ * Border radius of the tiles in the Liveboard.
8788
+ */
8789
+ '--ts-var-liveboard-tile-border-radius'?: string;
8790
+ /**
8791
+ * Padding of the tiles in the Liveboard.
8792
+ */
8793
+ '--ts-var-liveboard-tile-padding'?: string;
8794
+ /**
8795
+ * Background color of the table header in the Liveboard.
8796
+ */
8797
+ '--ts-var-liveboard-tile-table-header-background'?: string;
8798
+ /**
8799
+ * Padding of the groups in the Liveboard.
8800
+ */
8801
+ '--ts-var-liveboard-group-padding'?: string;
8802
+ /**
8803
+ * Padding of the title of the groups in the Liveboard.
8804
+ */
8805
+ '--ts-var-liveboard-group-title-padding'?: string;
8806
+ /**
8807
+ * Font size of the title of the groups in the Liveboard.
8808
+ */
8809
+ '--ts-var-liveboard-group-title-font-size'?: string;
8810
+ /**
8811
+ * Font weight of the title of the groups in the Liveboard.
8812
+ */
8813
+ '--ts-var-liveboard-group-title-font-weight'?: string;
8814
+ /**
8815
+ * Font size of the title of the tiles inside the groups in the Liveboard.
8816
+ */
8817
+ '--ts-var-liveboard-group-tile-title-font-size'?: string;
8818
+ /**
8819
+ * Font weight of the title of the tiles inside the groups in the Liveboard.
8820
+ */
8821
+ '--ts-var-liveboard-group-tile-title-font-weight'?: string;
8822
+ /**
8823
+ * Font size of the description of the groups in the Liveboard.
8824
+ */
8825
+ '--ts-var-liveboard-group-description-font-size'?: string;
8826
+ /**
8827
+ * Font weight of the description of the groups in the Liveboard.
8828
+ */
8829
+ '--ts-var-liveboard-group-description-font-weight'?: string;
8830
+ /**
8831
+ * Border of the tiles in the Liveboard.
8832
+ */
8833
+ '--ts-var-liveboard-group-tile-border'?: string;
8834
+ /**
8835
+ * Padding of the tiles in the Liveboard.
8836
+ */
8837
+ '--ts-var-liveboard-group-tile-padding'?: string;
8838
+ /**
8839
+ * Padding of the answer viz in the Liveboard.
8840
+ */
8841
+ '--ts-var-liveboard-answer-viz-padding'?: string;
8842
+ /**
8843
+ * Background color of the groups in the Liveboard.
8844
+ */
8845
+ '--ts-var-liveboard-group-background'?: string;
8846
+ /**
8847
+ * Border color of the groups in the Liveboard.
8848
+ */
8849
+ '--ts-var-liveboard-group-border-color'?: string;
8850
+ /**
8851
+ * Font color of the heading of the note title in the Liveboard.
8852
+ */
8853
+ '--ts-var-liveboard-notetitle-heading-font-color'?: string;
8854
+ /**
8855
+ * Font color of the body of the note title in the Liveboard.
8856
+ */
8857
+ '--ts-var-liveboard-notetitle-body-font-color'?: string;
8858
+ /**
8859
+ * Font color of the title of the groups in the Liveboard.
8860
+ */
8861
+ '--ts-var-liveboard-group-title-font-color'?: string;
8862
+ /**
8863
+ * Font color of the description of the groups in the Liveboard.
8864
+ */
8865
+ '--ts-var-liveboard-group-description-font-color'?: string;
8866
+ /**
8867
+ * Font color of the title of the tiles inside the groups in the Liveboard.
8868
+ */
8869
+ '--ts-var-liveboard-group-tile-title-font-color'?: string;
8870
+ /**
8871
+ * Background color of the tiles inside the groups in the Liveboard.
8872
+ */
8873
+ '--ts-var-liveboard-group-tile-background'?: string;
8874
+ /**
8875
+ * Background color of the chips in the Liveboard.
8876
+ */
8877
+ '--ts-var-liveboard-chip-background'?: string;
8878
+ /**
8879
+ * Font color of the chips in the Liveboard.
8880
+ */
8881
+ '--ts-var-liveboard-chip-color'?: string;
8882
+ /**
8883
+ * Background color of the chips in the Liveboard on hover.
8884
+ */
8885
+ '--ts-var-liveboard-chip--hover-background'?: string;
8886
+ /**
8887
+ * Font color of the chips in the Liveboard on hover.
8888
+ */
8889
+ '--ts-var-liveboard-chip--hover-color'?: string;
8890
+ /**
8891
+ * Background color of the chips in the Liveboard on active.
8892
+ */
8893
+ '--ts-var-liveboard-chip--active-background'?: string;
8894
+ /**
8895
+ * Font color of the chips in the Liveboard on active.
8896
+ */
8897
+ '--ts-var-liveboard-chip--active-color'?: string;
8898
+ /**
8899
+ * Width of the side panel in the Liveboard.
8900
+ */
8901
+ '--ts-var-side-panel-width'?: string;
8902
+ /**
8903
+ * Background color of the edit bar in the Liveboard.
8904
+ */
8905
+ '--ts-var-liveboard-edit-bar-background'?: string;
8906
+ /**
8907
+ * Breakpoint for the dual column layout in the Liveboard.
8908
+ */
8909
+ '--ts-var-liveboard-dual-column-breakpoint'?: string;
8910
+ /**
8911
+ * Breakpoint for the single column layout in the Liveboard.
8912
+ */
8913
+ '--ts-var-liveboard-single-column-breakpoint'?: string;
8914
+ /**
8915
+ * Background color of the cross filter layout in the Liveboard.
8916
+ */
8917
+ '--ts-var-liveboard-cross-filter-layout-background'?: string;
8918
+ /**
8919
+ * Border color of the active tab in the Liveboard.
8920
+ */
8921
+ '--ts-var-liveboard-tab-active-border-color'?: string;
8922
+ /**
8923
+ * Font color of the hover tab in the Liveboard.
8924
+ */
8925
+ '--ts-var-liveboard-tab-hover-color'?: string;
8926
+ /**
8927
+ * Font size of the title of the tiles in the Liveboard.
8928
+ */
8929
+ '--ts-var-liveboard-tile-title-fontsize'?: string;
8930
+ /**
8931
+ * Font weight of the title of the tiles in the Liveboard.
8932
+ */
8933
+ '--ts-var-liveboard-tile-title-fontweight'?: string;
8934
+ /**
8935
+ * Font weight of the description of the tiles in the Liveboard.
8936
+ */
8937
+ '--ts-var-liveboard-tile-description-font-weight'?: string;
8938
+ /**
8939
+ * Opacity of the description of the tiles in the Liveboard.
8940
+ */
8941
+ '--ts-var-liveboard-tile-description-opacity'?: string;
8942
+ /**
8943
+ * Background color of the parameter chips in the Liveboard.
8944
+ */
8945
+ '--ts-var-parameter-chip-background'?: string;
8946
+ /**
8947
+ * Font color of the parameter chips in the Liveboard.
8948
+ */
8949
+ '--ts-var-parameter-chip-text-color'?: string;
8950
+ /**
8951
+ * Background color of the parameter chips in the Liveboard on hover.
8952
+ */
8953
+ '--ts-var-parameter-chip-hover-background'?: string;
8954
+ /**
8955
+ * Font color of the parameter chips in the Liveboard on hover.
8956
+ */
8957
+ '--ts-var-parameter-chip-hover-text-color'?: string;
8958
+ /**
8959
+ * Background color of the parameter chips in the Liveboard on active.
8960
+ */
8961
+ '--ts-var-parameter-chip-active-background'?: string;
8962
+ /**
8963
+ * Font color of the parameter chips in the Liveboard on active.
8964
+ */
8965
+ '--ts-var-parameter-chip-active-text-color'?: string;
8966
+ /**
8967
+ * Background color of the action button in the Liveboard header.
8968
+ */
8969
+ '--ts-var-liveboard-header-action-button-background'?: string;
8970
+ /**
8971
+ * Font color of the action button in the Liveboard header.
8972
+ */
8973
+ '--ts-var-liveboard-header-action-button-font-color'?: string;
8974
+ /**
8975
+ * Font color of the action button in the Liveboard header on hover.
8976
+ */
8977
+ '--ts-var-liveboard-header-action-button-hover-color'?: string;
8978
+ /**
8979
+ * Font color of the action button in the Liveboard header on active.
8980
+ */
8981
+ '--ts-var-liveboard-header-action-button-active-color'?: string;
8982
+ /**
8983
+ * Background color of the badge in the Liveboard header.
8984
+ */
8985
+ '--ts-var-liveboard-header-badge-background'?: string;
8986
+ /**
8987
+ * Font color of the badge in the Liveboard header.
8988
+ */
8989
+ '--ts-var-liveboard-header-badge-font-color'?: string;
8990
+ /**
8991
+ * Background color of the modified badge in the Liveboard header.
8992
+ */
8993
+ '--ts-var-liveboard-header-badge-modified-background'?: string;
8994
+ /**
8995
+ * Font color of the modified badge in the Liveboard header.
8996
+ */
8997
+ '--ts-var-liveboard-header-badge-modified-font-color'?: string;
8998
+ /**
8999
+ * Font color of the badge in the Liveboard header on hover.
9000
+ */
9001
+ '--ts-var-liveboard-header-badge-hover-color'?: string;
9002
+ /**
9003
+ * Font color of the badge in the Liveboard header on active.
9004
+ */
9005
+ '--ts-var-liveboard-header-badge-active-color'?: string;
9006
+ /**
9007
+ * Font color of the hero text in the KPI widget.
9008
+ */
9009
+ '--ts-var-kpi-hero-color'?: string;
9010
+ /**
9011
+ * Font color of the comparison text in the KPI widget.
9012
+ */
9013
+ '--ts-var-kpi-comparison-color'?: string;
9014
+ /**
9015
+ * Font color of the analyze text in the KPI widget.
9016
+ */
9017
+ '--ts-var-kpi-analyze-text-color'?: string;
9018
+ /**
9019
+ * Font color of the legend title in the heatmap chart.
9020
+ */
9021
+ '--ts-var-chart-heatmap-legend-title-color'?: string;
9022
+ /**
9023
+ * Font color of the legend label in the heatmap chart.
9024
+ */
9025
+ '--ts-var-chart-heatmap-legend-label-color'?: string;
9026
+ /**
9027
+ * Font color of the legend title in the treemap chart.
9028
+ */
9029
+ '--ts-var-chart-treemap-legend-title-color'?: string;
9030
+ /**
9031
+ * Font color of the legend label in the treemap chart.
9032
+ */
9033
+ '--ts-var-chart-treemap-legend-label-color'?: string;
9034
+ /**
9035
+ * Color of the positive change in the KPI.
9036
+ */
9037
+ '--ts-var-kpi-positive-change-color'?: string;
9038
+ /**
9039
+ * Color of the negative change in the KPI.
9040
+ */
9041
+ '--ts-var-kpi-negative-change-color'?: string;
9042
+ /**
9043
+ * Background color of the change analysis insights.
9044
+ */
9045
+ '--ts-var-change-analysis-insights-background'?: string;
9046
+ /**
9047
+ * Background color of the forecasting card in the SpotIQ analyze.
9048
+ */
9049
+ '--ts-var-spotiq-analyze-forecasting-card-background'?: string;
9050
+ /**
9051
+ * Background color of the outlier card in the SpotIQ analyze.
9052
+ */
9053
+ '--ts-var-spotiq-analyze-outlier-card-background'?: string;
9054
+ /**
9055
+ * Background color of the trend card in the SpotIQ analyze.
9056
+ */
9057
+ '--ts-var-spotiq-analyze-trend-card-background'?: string;
9058
+ /**
9059
+ * Background color of the crosscorrelation card in the SpotIQ analyze.
9060
+ */
9061
+ '--ts-var-spotiq-analyze-crosscorrelation-card-background'?: string;
9062
+ /**
9063
+ * Background color of the summary header in the CCA modal.
9064
+ */
9065
+ '--ts-var-cca-modal-summary-header-background'?: string;
8581
9066
  }
8582
9067
 
8583
9068
  export interface SessionInterface {
@@ -8904,16 +9389,31 @@ export declare const getAnswerFromQuery: (query: string, worksheetId: string) =>
8904
9389
  }>;
8905
9390
 
8906
9391
  /**
8907
- * Create a liveboard with the given answers
8908
- * @param answers AnswerService[]
8909
- * @param name string
9392
+ * Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances.
9393
+ *
9394
+ * Each answer will be added as a visualization to the newly created Liveboard.
9395
+ *
9396
+ * @param {AnswerService[]} answers - An array of initialized `AnswerService` instances
9397
+ * representing the answers to be added to the Liveboard.
9398
+ * @param {string} name - The name of the Liveboard to create.
8910
9399
  * @returns result Promise
8911
9400
  * @version SDK: 1.33.1 | ThoughtSpot: *
8912
9401
  * @example
8913
9402
  * ```js
8914
- * const lb = createLiveboardWithAnswers([
8915
- * new AnswerService(session, null, 'tshost'),
8916
- * ], "my-liveboard");
9403
+ * import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk";
9404
+ *
9405
+ * embed.on(EmbedEvent.Data, async () => {
9406
+ * try {
9407
+ * const answerService = await embed.getAnswerService();
9408
+ * const lb = await createLiveboardWithAnswers(
9409
+ * [answerService],
9410
+ * "My Liveboard"
9411
+ * );
9412
+ * console.log("Liveboard created:", lb);
9413
+ * } catch (err) {
9414
+ * console.error("Failed to create liveboard:", err);
9415
+ * }
9416
+ * });
8917
9417
  * ```
8918
9418
  */
8919
9419
  export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
@@ -9072,25 +9572,20 @@ export declare class TsEmbed {
9072
9572
  protected isRendered: boolean;
9073
9573
  protected hostEventClient: HostEventClient;
9074
9574
  protected isReadyForRenderPromise: Promise<void>;
9075
- id: string;
9076
9575
  constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
9077
9576
  /**
9078
9577
  * Handles errors within the SDK
9079
9578
  * @param error The error message or object
9080
9579
  */
9081
9580
  protected handleError(error: string | Record<string, unknown>): void;
9082
- isEmbedContainerLoaded: boolean;
9083
9581
  protected getAuthTokenForCookielessInit(): Promise<string>;
9084
9582
  protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
9085
9583
  protected getAppInitData(): Promise<DefaultAppInitData>;
9086
- protected getPreRenderObj<T extends TsEmbed>(): T;
9087
- protected triggerAfterLoad(eventType: HostEvent, data: TriggerPayload<any, HostEvent>, onEventTriggered?: () => void): void;
9088
9584
  /**
9089
9585
  * Constructs the base URL string to load the ThoughtSpot app.
9090
9586
  * @param query
9091
9587
  */
9092
9588
  protected getEmbedBasePath(query: string): string;
9093
- protected getUpdateEmbedParamsObject(): Record<any, any>;
9094
9589
  /**
9095
9590
  * Common query params set for all the embed modes.
9096
9591
  * @param queryParams
@@ -9106,7 +9601,6 @@ export declare class TsEmbed {
9106
9601
  */
9107
9602
  protected getV1EmbedBasePath(queryString: string): string;
9108
9603
  protected getEmbedParams(): string;
9109
- protected getEmbedParamsObject(): Record<any, any>;
9110
9604
  protected getRootIframeSrc(): string;
9111
9605
  protected createIframeEl(frameSrc: string): HTMLIFrameElement;
9112
9606
  protected handleInsertionIntoDOM(child: string | Node): void;
@@ -9198,6 +9692,19 @@ export declare class TsEmbed {
9198
9692
  * ```
9199
9693
  */
9200
9694
  off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
9695
+ /**
9696
+ * @hidden
9697
+ * Internal state to track if the embed container is loaded.
9698
+ * This is used to trigger events after the embed container is loaded.
9699
+ */
9700
+ isEmbedContainerLoaded: boolean;
9701
+ protected getPreRenderObj<T extends TsEmbed>(): T;
9702
+ /**
9703
+ * Executes a callback after the embed container is loaded.
9704
+ * @param callback The callback to execute
9705
+ */
9706
+ protected executeAfterEmbedContainerLoaded(callback: () => void): void;
9707
+ protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void;
9201
9708
  /**
9202
9709
  * Triggers an event to the embedded app
9203
9710
  * @param {HostEvent} messageType The event type