@thoughtspot/visual-embed-sdk 1.38.0 → 1.38.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 (216) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +1 -1
  3. package/cjs/src/embed/app.d.ts +96 -156
  4. package/cjs/src/embed/app.d.ts.map +1 -1
  5. package/cjs/src/embed/app.js +7 -4
  6. package/cjs/src/embed/app.js.map +1 -1
  7. package/cjs/src/embed/app.spec.js +10 -0
  8. package/cjs/src/embed/app.spec.js.map +1 -1
  9. package/cjs/src/embed/bodyless-conversation.d.ts +4 -4
  10. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  11. package/cjs/src/embed/bodyless-conversation.js +1 -1
  12. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  13. package/cjs/src/embed/conversation.d.ts +22 -11
  14. package/cjs/src/embed/conversation.d.ts.map +1 -1
  15. package/cjs/src/embed/conversation.js +1 -1
  16. package/cjs/src/embed/conversation.js.map +1 -1
  17. package/cjs/src/embed/liveboard.d.ts +110 -167
  18. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  19. package/cjs/src/embed/liveboard.js +25 -11
  20. package/cjs/src/embed/liveboard.js.map +1 -1
  21. package/cjs/src/embed/liveboard.spec.js +11 -0
  22. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  23. package/cjs/src/embed/sage.d.ts +17 -2
  24. package/cjs/src/embed/sage.d.ts.map +1 -1
  25. package/cjs/src/embed/sage.js +2 -0
  26. package/cjs/src/embed/sage.js.map +1 -1
  27. package/cjs/src/embed/search-bar.d.ts +16 -6
  28. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  29. package/cjs/src/embed/search-bar.js.map +1 -1
  30. package/cjs/src/embed/search.d.ts +46 -14
  31. package/cjs/src/embed/search.d.ts.map +1 -1
  32. package/cjs/src/embed/search.js.map +1 -1
  33. package/cjs/src/embed/ts-embed.d.ts +19 -2
  34. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  35. package/cjs/src/embed/ts-embed.js +49 -0
  36. package/cjs/src/embed/ts-embed.js.map +1 -1
  37. package/cjs/src/embed/ts-embed.spec.js +45 -4
  38. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  39. package/cjs/src/index.d.ts +2 -2
  40. package/cjs/src/index.d.ts.map +1 -1
  41. package/cjs/src/index.js +2 -1
  42. package/cjs/src/index.js.map +1 -1
  43. package/cjs/src/react/all-types-export.d.ts +1 -1
  44. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  45. package/cjs/src/react/all-types-export.js +2 -1
  46. package/cjs/src/react/all-types-export.js.map +1 -1
  47. package/cjs/src/react/index.d.ts +1 -1
  48. package/cjs/src/react/index.d.ts.map +1 -1
  49. package/cjs/src/react/index.js +1 -1
  50. package/cjs/src/react/util.d.ts +7 -4
  51. package/cjs/src/react/util.d.ts.map +1 -1
  52. package/cjs/src/react/util.js.map +1 -1
  53. package/cjs/src/types.d.ts +482 -251
  54. package/cjs/src/types.d.ts.map +1 -1
  55. package/cjs/src/types.js +31 -14
  56. package/cjs/src/types.js.map +1 -1
  57. package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -1
  58. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  59. package/cjs/src/utils/graphql/answerService/answerService.js +2 -1
  60. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  61. package/cjs/src/utils/processData.d.ts.map +1 -1
  62. package/cjs/src/utils/processData.js +15 -0
  63. package/cjs/src/utils/processData.js.map +1 -1
  64. package/cjs/src/utils/processData.spec.js +15 -0
  65. package/cjs/src/utils/processData.spec.js.map +1 -1
  66. package/cjs/src/utils/processTrigger.d.ts.map +1 -1
  67. package/cjs/src/utils/processTrigger.js +14 -0
  68. package/cjs/src/utils/processTrigger.js.map +1 -1
  69. package/cjs/src/utils/processTrigger.spec.js +54 -0
  70. package/cjs/src/utils/processTrigger.spec.js.map +1 -1
  71. package/cjs/src/utils.d.ts +11 -2
  72. package/cjs/src/utils.d.ts.map +1 -1
  73. package/cjs/src/utils.js +70 -1
  74. package/cjs/src/utils.js.map +1 -1
  75. package/cjs/src/utils.spec.js +85 -0
  76. package/cjs/src/utils.spec.js.map +1 -1
  77. package/dist/{index-BIcnpmMY.js → index-BKIWUvTr.js} +1 -1
  78. package/dist/src/embed/app.d.ts +96 -156
  79. package/dist/src/embed/app.d.ts.map +1 -1
  80. package/dist/src/embed/bodyless-conversation.d.ts +4 -4
  81. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  82. package/dist/src/embed/conversation.d.ts +22 -11
  83. package/dist/src/embed/conversation.d.ts.map +1 -1
  84. package/dist/src/embed/liveboard.d.ts +110 -167
  85. package/dist/src/embed/liveboard.d.ts.map +1 -1
  86. package/dist/src/embed/sage.d.ts +17 -2
  87. package/dist/src/embed/sage.d.ts.map +1 -1
  88. package/dist/src/embed/search-bar.d.ts +16 -6
  89. package/dist/src/embed/search-bar.d.ts.map +1 -1
  90. package/dist/src/embed/search.d.ts +46 -14
  91. package/dist/src/embed/search.d.ts.map +1 -1
  92. package/dist/src/embed/ts-embed.d.ts +19 -2
  93. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  94. package/dist/src/index.d.ts +2 -2
  95. package/dist/src/index.d.ts.map +1 -1
  96. package/dist/src/react/all-types-export.d.ts +1 -1
  97. package/dist/src/react/all-types-export.d.ts.map +1 -1
  98. package/dist/src/react/index.d.ts +1 -1
  99. package/dist/src/react/index.d.ts.map +1 -1
  100. package/dist/src/react/util.d.ts +7 -4
  101. package/dist/src/react/util.d.ts.map +1 -1
  102. package/dist/src/types.d.ts +482 -251
  103. package/dist/src/types.d.ts.map +1 -1
  104. package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -1
  105. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  106. package/dist/src/utils/processData.d.ts.map +1 -1
  107. package/dist/src/utils/processTrigger.d.ts.map +1 -1
  108. package/dist/src/utils.d.ts +11 -2
  109. package/dist/src/utils.d.ts.map +1 -1
  110. package/dist/tsembed-react.es.js +3498 -3322
  111. package/dist/tsembed-react.js +3497 -3321
  112. package/dist/tsembed.es.js +213 -37
  113. package/dist/tsembed.js +216 -40
  114. package/dist/visual-embed-sdk-react-full.d.ts +845 -655
  115. package/dist/visual-embed-sdk-react.d.ts +845 -655
  116. package/dist/visual-embed-sdk.d.ts +827 -640
  117. package/lib/package.json +1 -1
  118. package/lib/src/embed/app.d.ts +96 -156
  119. package/lib/src/embed/app.d.ts.map +1 -1
  120. package/lib/src/embed/app.js +7 -4
  121. package/lib/src/embed/app.js.map +1 -1
  122. package/lib/src/embed/app.spec.js +10 -0
  123. package/lib/src/embed/app.spec.js.map +1 -1
  124. package/lib/src/embed/bodyless-conversation.d.ts +4 -4
  125. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  126. package/lib/src/embed/bodyless-conversation.js +1 -1
  127. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  128. package/lib/src/embed/conversation.d.ts +22 -11
  129. package/lib/src/embed/conversation.d.ts.map +1 -1
  130. package/lib/src/embed/conversation.js +1 -1
  131. package/lib/src/embed/conversation.js.map +1 -1
  132. package/lib/src/embed/liveboard.d.ts +110 -167
  133. package/lib/src/embed/liveboard.d.ts.map +1 -1
  134. package/lib/src/embed/liveboard.js +25 -11
  135. package/lib/src/embed/liveboard.js.map +1 -1
  136. package/lib/src/embed/liveboard.spec.js +11 -0
  137. package/lib/src/embed/liveboard.spec.js.map +1 -1
  138. package/lib/src/embed/sage.d.ts +17 -2
  139. package/lib/src/embed/sage.d.ts.map +1 -1
  140. package/lib/src/embed/sage.js +2 -0
  141. package/lib/src/embed/sage.js.map +1 -1
  142. package/lib/src/embed/search-bar.d.ts +16 -6
  143. package/lib/src/embed/search-bar.d.ts.map +1 -1
  144. package/lib/src/embed/search-bar.js.map +1 -1
  145. package/lib/src/embed/search.d.ts +46 -14
  146. package/lib/src/embed/search.d.ts.map +1 -1
  147. package/lib/src/embed/search.js.map +1 -1
  148. package/lib/src/embed/ts-embed.d.ts +19 -2
  149. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  150. package/lib/src/embed/ts-embed.js +49 -0
  151. package/lib/src/embed/ts-embed.js.map +1 -1
  152. package/lib/src/embed/ts-embed.spec.js +45 -4
  153. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  154. package/lib/src/index.d.ts +2 -2
  155. package/lib/src/index.d.ts.map +1 -1
  156. package/lib/src/index.js +2 -2
  157. package/lib/src/index.js.map +1 -1
  158. package/lib/src/react/all-types-export.d.ts +1 -1
  159. package/lib/src/react/all-types-export.d.ts.map +1 -1
  160. package/lib/src/react/all-types-export.js +1 -1
  161. package/lib/src/react/all-types-export.js.map +1 -1
  162. package/lib/src/react/index.d.ts +1 -1
  163. package/lib/src/react/index.d.ts.map +1 -1
  164. package/lib/src/react/index.js +1 -1
  165. package/lib/src/react/util.d.ts +7 -4
  166. package/lib/src/react/util.d.ts.map +1 -1
  167. package/lib/src/react/util.js.map +1 -1
  168. package/lib/src/types.d.ts +482 -251
  169. package/lib/src/types.d.ts.map +1 -1
  170. package/lib/src/types.js +31 -14
  171. package/lib/src/types.js.map +1 -1
  172. package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -1
  173. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  174. package/lib/src/utils/graphql/answerService/answerService.js +2 -1
  175. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  176. package/lib/src/utils/processData.d.ts.map +1 -1
  177. package/lib/src/utils/processData.js +15 -0
  178. package/lib/src/utils/processData.js.map +1 -1
  179. package/lib/src/utils/processData.spec.js +15 -0
  180. package/lib/src/utils/processData.spec.js.map +1 -1
  181. package/lib/src/utils/processTrigger.d.ts.map +1 -1
  182. package/lib/src/utils/processTrigger.js +14 -0
  183. package/lib/src/utils/processTrigger.js.map +1 -1
  184. package/lib/src/utils/processTrigger.spec.js +54 -0
  185. package/lib/src/utils/processTrigger.spec.js.map +1 -1
  186. package/lib/src/utils.d.ts +11 -2
  187. package/lib/src/utils.d.ts.map +1 -1
  188. package/lib/src/utils.js +67 -0
  189. package/lib/src/utils.js.map +1 -1
  190. package/lib/src/utils.spec.js +86 -1
  191. package/lib/src/utils.spec.js.map +1 -1
  192. package/lib/src/visual-embed-sdk.d.ts +836 -649
  193. package/package.json +1 -1
  194. package/src/embed/app.spec.ts +14 -0
  195. package/src/embed/app.ts +98 -153
  196. package/src/embed/bodyless-conversation.ts +4 -4
  197. package/src/embed/conversation.ts +23 -12
  198. package/src/embed/liveboard.spec.ts +15 -0
  199. package/src/embed/liveboard.ts +142 -182
  200. package/src/embed/sage.ts +17 -5
  201. package/src/embed/search-bar.tsx +16 -17
  202. package/src/embed/search.ts +47 -21
  203. package/src/embed/ts-embed.spec.ts +52 -4
  204. package/src/embed/ts-embed.ts +61 -6
  205. package/src/index.ts +2 -0
  206. package/src/react/all-types-export.ts +1 -0
  207. package/src/react/index.tsx +3 -3
  208. package/src/react/util.ts +6 -4
  209. package/src/types.ts +488 -253
  210. package/src/utils/graphql/answerService/answerService.ts +5 -4
  211. package/src/utils/processData.spec.ts +28 -0
  212. package/src/utils/processData.ts +17 -0
  213. package/src/utils/processTrigger.spec.ts +90 -0
  214. package/src/utils/processTrigger.ts +16 -1
  215. package/src/utils.spec.ts +113 -0
  216. package/src/utils.ts +78 -2
@@ -11,7 +11,7 @@ declare module '@thoughtspot/visual-embed-sdk' {
11
11
  * @summary ThoughtSpot Visual Embed SDK
12
12
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
13
13
  */
14
- import { AppEmbed, Page, AppViewConfig, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage } from '@thoughtspot/visual-embed-sdk/embed/app';
14
+ import { AppEmbed, Page, AppViewConfig, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, DataPanelCustomColumnGroupsAccordionState } from '@thoughtspot/visual-embed-sdk/embed/app';
15
15
  import { init, prefetch, logout, executeTML, exportTML, executeTMLInput, exportTMLInput } from '@thoughtspot/visual-embed-sdk/embed/base';
16
16
  import { PinboardEmbed, LiveboardViewConfig, LiveboardEmbed } from '@thoughtspot/visual-embed-sdk/embed/liveboard';
17
17
  import { SearchEmbed, SearchViewConfig } from '@thoughtspot/visual-embed-sdk/embed/search';
@@ -30,7 +30,7 @@ declare module '@thoughtspot/visual-embed-sdk' {
30
30
  import { getAnswerFromQuery } from '@thoughtspot/visual-embed-sdk/utils/graphql/nlsService/nls-answer-service';
31
31
  import { createLiveboardWithAnswers } from '@thoughtspot/visual-embed-sdk/utils/liveboardService/liveboardService';
32
32
  import { UIPassthroughEvent } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
33
- export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
33
+ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, SpotterAgentEmbed, SpotterAgentEmbedViewConfig, BodylessConversationViewConfig, BodylessConversation, SpotterEmbed, SpotterEmbedViewConfig, ConversationViewConfig, ConversationEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, PrimaryNavbarVersion, HomePage, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, DataPanelCustomColumnGroupsAccordionState, };
34
34
  export { resetCachedAuthToken } from '@thoughtspot/visual-embed-sdk/authToken';
35
35
  }
36
36
 
@@ -44,7 +44,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
44
44
  * @module
45
45
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
46
46
  */
47
- import { DOMSelector, ViewConfig, MessagePayload } from '@thoughtspot/visual-embed-sdk/types';
47
+ import { DOMSelector, MessagePayload, AllEmbedViewConfig } from '@thoughtspot/visual-embed-sdk/types';
48
48
  import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
49
49
  /**
50
50
  * Pages within the ThoughtSpot app that can be embedded.
@@ -108,7 +108,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
108
108
  }
109
109
  /**
110
110
  * Define the version of the primary navbar
111
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
111
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
112
112
  */
113
113
  export enum PrimaryNavbarVersion {
114
114
  /**
@@ -120,7 +120,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
120
120
  }
121
121
  /**
122
122
  * Define the version of the home page
123
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
123
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
124
124
  */
125
125
  export enum HomePage {
126
126
  /**
@@ -131,7 +131,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
131
131
  }
132
132
  /**
133
133
  * Define the discovery experience
134
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
134
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
135
135
  */
136
136
  export interface DiscoveryExperience {
137
137
  /**
@@ -147,17 +147,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
147
147
  * The view configuration for full app embedding.
148
148
  * @group Embed components
149
149
  */
150
- export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
150
+ export interface AppViewConfig extends AllEmbedViewConfig {
151
151
  /**
152
152
  * If true, the top navigation bar within the ThoughtSpot app
153
153
  * is displayed. By default, the navigation bar is hidden.
154
154
  * This flag also controls the homepage left navigation bar.
155
+ *
156
+ * Supported embed types: `AppEmbed`
155
157
  * @default true
156
158
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
157
159
  * @example
158
160
  * ```js
159
161
  * const embed = new AppEmbed('#tsEmbed', {
160
- * ... // other options
162
+ * ... // other embed view config
161
163
  * showPrimaryNavbar:true,
162
164
  * })
163
165
  * ```
@@ -172,12 +174,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
172
174
  * **Note**: This option does not apply to the classic homepage.
173
175
  * To access the updated modular homepage, set
174
176
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
177
+ *
178
+ * Supported embed types: `AppEmbed`
175
179
  * @default false
176
180
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
177
181
  * @example
178
182
  * ```js
179
183
  * const embed = new AppEmbed('#tsEmbed', {
180
- * ... // other options
184
+ * ... // other embed view config
181
185
  * hideHomepageLeftNav : true,
182
186
  * })
183
187
  * ```
@@ -186,12 +190,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
186
190
  /**
187
191
  * Control the visibility of the help (?) and profile buttons on the
188
192
  * Global nav-bar. By default, these buttons are visible on the nav-bar.
193
+ *
194
+ * Supported embed types: `AppEmbed`
189
195
  * @default false
190
196
  * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
191
197
  * @example
192
198
  * ```js
193
199
  * const embed = new AppEmbed('#tsEmbed', {
194
- * ... // other options
200
+ * ... // other embed view config
195
201
  * disableProfileAndHelp: true,
196
202
  * })
197
203
  * ```
@@ -202,10 +208,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
202
208
  * @default true
203
209
  * Whether the help menu in the top nav bar should be served
204
210
  * from Pendo or ThoughtSpot's internal help items.
211
+ *
212
+ * Supported embed types: `AppEmbed`
205
213
  * @example
206
214
  * ```js
207
215
  * const embed = new AppEmbed('#tsEmbed', {
208
- * ... // other options
216
+ * ... // other embed view config
209
217
  * enablePendoHelp: false,
210
218
  * });
211
219
  * ```
@@ -215,12 +223,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
215
223
  * Control the visibility of the hamburger icon on the top nav bar
216
224
  * available when new navigation V3 is enabled.
217
225
  *
226
+ * Supported embed types: `AppEmbed`
218
227
  * @default false
219
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
228
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
220
229
  * @example
221
230
  * ```js
222
231
  * const embed = new AppEmbed('#tsEmbed', {
223
- * ... // other options
232
+ * ... // other embed view config
224
233
  * hideHamburger : true,
225
234
  * })
226
235
  * ```
@@ -230,12 +239,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
230
239
  * Control the visibility of the Eureka search on the top nav bar
231
240
  * this will control for both new V2 and new navigation V3.
232
241
  *
242
+ * Supported embed types: `AppEmbed`
233
243
  * @default true
234
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
244
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
235
245
  * @example
236
246
  * ```js
237
247
  * const embed = new AppEmbed('#tsEmbed', {
238
- * ... // other options
248
+ * ... // other embed view config
239
249
  * hideObjectSearch: false,
240
250
  * })
241
251
  * ```
@@ -245,12 +255,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
245
255
  * Control the visibility of the notification on the top nav bar V3,
246
256
  * available when new navigation V3 is enabled.
247
257
  *
258
+ * Supported embed types: `AppEmbed`
248
259
  * @default true
249
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
260
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
250
261
  * @example
251
262
  * ```js
252
263
  * const embed = new AppEmbed('#tsEmbed', {
253
- * ... // other options
264
+ * ... // other embed view config
254
265
  * hideNotification: false,
255
266
  * })
256
267
  * ```
@@ -263,12 +274,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
263
274
  * **Note**: This option does not apply to the classic homepage.
264
275
  * To access the updated modular homepage, set
265
276
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
277
+ *
278
+ * Supported embed types: `AppEmbed`
266
279
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
267
280
  * @default false
268
281
  * @example
269
282
  * ```js
270
283
  * const embed = new AppEmbed('#tsEmbed', {
271
- * ... // other options
284
+ * ... // other embed view config
272
285
  * hideApplicationSwitcher : true,
273
286
  * })
274
287
  * ```
@@ -281,12 +294,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
281
294
  * **Note**: This option does not apply to the classic homepage.
282
295
  * To access the updated modular homepage, set
283
296
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
297
+ *
298
+ * Supported embed types: `AppEmbed`
284
299
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
285
300
  * @default true
286
301
  * @example
287
302
  * ```js
288
303
  * const embed = new AppEmbed('#tsEmbed', {
289
- * ... // other options
304
+ * ... // other embed view config
290
305
  * hideOrgSwitcher : true,
291
306
  * })
292
307
  * ```
@@ -300,12 +315,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
300
315
  *
301
316
  * For eg, if you want the component to open to a specific Liveboard
302
317
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
318
+ *
319
+ * Supported embed types: `AppEmbed`
303
320
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
304
321
  * @example
305
322
  * ```js
306
323
  * const embed = new AppEmbed('#tsEmbed', {
307
- * ... // other options
308
- * path:"pinboard/1234/tab/7464"
324
+ * ... // other embed view config
325
+ * path:"pinboard/1234/tab/7464",
309
326
  * })
310
327
  * ```
311
328
  */
@@ -316,12 +333,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
316
333
  *
317
334
  * Use this to open to particular page in the app. To open to a specific
318
335
  * path within the app, use the `path` attribute which is more flexible.
336
+ *
337
+ * Supported embed types: `AppEmbed`
319
338
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
320
339
  * @example
321
340
  * ```js
322
341
  * const embed = new AppEmbed('#tsEmbed', {
323
- * ... // other options
324
- * pageId : Page.Answers | Page.Data
342
+ * ... // other embed view config
343
+ * pageId : Page.Answers | Page.Data,
325
344
  * })
326
345
  * ```
327
346
  */
@@ -330,11 +349,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
330
349
  * This puts a filter tag on the application. All metadata lists in the
331
350
  * application, such as Liveboards and answers, would be filtered by this
332
351
  * tag.
352
+ *
353
+ * Supported embed types: `AppEmbed`
333
354
  * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
334
355
  * @example
335
356
  * ```js
336
357
  * const embed = new AppEmbed('#tsEmbed', {
337
- * ... // other options
358
+ * ... // other embed view config
338
359
  * tag:'value',
339
360
  * })
340
361
  * ```
@@ -342,11 +363,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
342
363
  tag?: string;
343
364
  /**
344
365
  * The array of GUIDs to be hidden
366
+ *
367
+ * Supported embed types: `AppEmbed`
345
368
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
346
369
  * @example
347
370
  * ```js
348
371
  * const embed = new AppEmbed('#tsEmbed', {
349
- * ... // other options
372
+ * ... // other embed view config
350
373
  * hideObjects: [
351
374
  * '430496d6-6903-4601-937e-2c691821af3c',
352
375
  * 'f547ec54-2a37-4516-a222-2b06719af726'
@@ -358,18 +381,22 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
358
381
  /**
359
382
  * Render liveboards using the new v2 rendering mode
360
383
  * This is a transient flag which is primarily meant for internal use
384
+ *
385
+ * Supported embed types: `AppEmbed`
361
386
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
362
387
  * @hidden
363
388
  */
364
389
  liveboardV2?: boolean;
365
390
  /**
366
391
  * If set to true, the Search Assist feature is enabled.
392
+ *
393
+ * Supported embed types: `AppEmbed`
367
394
  * @default true
368
395
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
369
396
  * @example
370
397
  * ```js
371
398
  * const embed = new AppEmbed('#tsEmbed', {
372
- * ... // other options
399
+ * ... // other embed view config
373
400
  * enableSearchAssist: true,
374
401
  * })
375
402
  * ```
@@ -387,63 +414,27 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
387
414
  * `false` fetches visualizations incrementally as
388
415
  * users scroll the page to view the charts and tables.
389
416
  *
417
+ * Supported embed types: `AppEmbed`
390
418
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
391
419
  * @example
392
420
  * ```js
393
421
  * const embed = new AppEmbed('#tsEmbed', {
394
- * ... // other options
422
+ * ... // other embed view config
395
423
  * fullHeight: true,
396
424
  * })
397
425
  * ```
398
426
  */
399
427
  fullHeight?: boolean;
400
- /**
401
- * Show or hide Liveboard header
402
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
403
- * @default false
404
- * @example
405
- * ```js
406
- * const embed = new AppEmbed('#tsEmbed', {
407
- * ... // other options
408
- * hideLiveboardHeader : true,
409
- * })
410
- * ```
411
- */
412
- hideLiveboardHeader?: boolean;
413
- /**
414
- * Show or hide Liveboard title
415
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
416
- * @default false
417
- * @example
418
- * ```js
419
- * const embed = new AppEmbed('#tsEmbed', {
420
- * ... // other options
421
- * showLiveboardTitle:true,
422
- * })
423
- * ```
424
- */
425
- showLiveboardTitle?: boolean;
426
- /**
427
- * Show or hide Liveboard description
428
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
429
- * @default false
430
- * @example
431
- * ```js
432
- * const embed = new AppEmbed('#tsEmbed', {
433
- * ... // other options
434
- * showLiveboardDescription:true,
435
- * })
436
- * ```
437
- */
438
- showLiveboardDescription?: boolean;
439
428
  /**
440
429
  * Flag to control new Modular Home experience.
430
+ *
431
+ * Supported embed types: `AppEmbed`
441
432
  * @default false
442
433
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
443
434
  * @example
444
435
  * ```js
445
436
  * const embed = new AppEmbed('#tsEmbed', {
446
- * ... // other options
437
+ * ... // other embed view config
447
438
  * modularHomeExperience : true,
448
439
  * })
449
440
  * ```
@@ -452,38 +443,21 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
452
443
  /**
453
444
  * To configure the top-left navigation and home page experience
454
445
  *
446
+ * Supported embed types: `AppEmbed`
455
447
  * @default false
456
- * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
448
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
457
449
  * @example
458
450
  * ```js
459
451
  * const embed = new AppEmbed('#tsEmbed', {
460
- * ... // other options
452
+ * ... // other embed view config
461
453
  * discoveryExperience : {
462
454
  * primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
463
- * homePage: HompePage.Modular,
455
+ * homePage: HomePage.Modular,
464
456
  * },
465
457
  * })
466
458
  * ```
467
459
  */
468
460
  discoveryExperience?: DiscoveryExperience;
469
- /**
470
- * Boolean to control if Liveboard header is sticky or not.
471
- * @example
472
- * ```js
473
- * const embed = new AppEmbed('#embed', {
474
- * ... // other app view config
475
- * isLiveboardHeaderSticky: true,
476
- * });
477
- * ```
478
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
479
- */
480
- isLiveboardHeaderSticky?: boolean;
481
- /**
482
- * enable or disable ask sage
483
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
484
- * @default false
485
- */
486
- enableAskSage?: boolean;
487
461
  /**
488
462
  * To set the initial state of the search bar in case of saved-answers.
489
463
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
@@ -498,6 +472,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
498
472
  * - EXPAND_ALL: Expand all the accordion initially in data panel v2.
499
473
  * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
500
474
  * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
475
+ *
476
+ * Supported embed types: `AppEmbed`
501
477
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
502
478
  * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
503
479
  * @example
@@ -510,20 +486,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
510
486
  * ```
511
487
  */
512
488
  dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
513
- /**
514
- * This attribute can be used to enable the two-column layout on an embedded Liveboard
515
- * @type {boolean}
516
- * @default false
517
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
518
- * @example
519
- * ```js
520
- * const embed = new LiveboardEmbed('#embed-container', {
521
- * ... // other options
522
- * enable2ColumnLayout: true,
523
- * })
524
- * ```
525
- */
526
- enable2ColumnLayout?: boolean;
527
489
  /**
528
490
  * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
529
491
  * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
@@ -531,79 +493,57 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
531
493
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
532
494
  /**
533
495
  * Flag to use home page search bar mode
496
+ *
497
+ * Supported embed types: `AppEmbed`
534
498
  * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
535
499
  */
536
500
  homePageSearchBarMode?: HomePageSearchBarMode;
537
501
  /**
538
- * This flag can be used to enable the compact header in Liveboard
539
- * @type {boolean}
540
- * @default false
541
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
542
- * @example
543
- * ```js
544
- * const embed = new AppEmbed('#embed-container', {
545
- * ... // other options
546
- * isLiveboardCompactHeaderEnabled: true,
547
- * })
548
- * ```
549
- */
550
- isLiveboardCompactHeaderEnabled?: boolean;
551
- /**
552
- * This flag can be used to show or hide the Liveboard verified icon in the compact header.
553
- * @type {boolean}
502
+ * This flag is used to enable unified search experience for full app embed.
503
+ *
504
+ * Supported embed types: `AppEmbed`
505
+ * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
554
506
  * @default true
555
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
556
- * @example
557
- * ```js
558
- * const embed = new AppEmbed('#embed-container', {
559
- * ... // other options
560
- * showLiveboardVerifiedBadge: true,
561
- * })
562
- * ```
563
- */
564
- showLiveboardVerifiedBadge?: boolean;
565
- /**
566
- * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
567
- * @type {boolean}
568
- * @default false
569
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
570
507
  * @example
571
508
  * ```js
572
- * const embed = new AppEmbed('#embed-container', {
573
- * ... // other options
574
- * hideIrrelevantChipsInLiveboardTabs: true,
509
+ * const embed = new AppEmbed('#tsEmbed', {
510
+ * ... // other embed view config
511
+ * isUnifiedSearchExperienceEnabled: true,
575
512
  * })
576
513
  * ```
577
514
  */
578
- hideIrrelevantChipsInLiveboardTabs?: boolean;
515
+ isUnifiedSearchExperienceEnabled?: boolean;
579
516
  /**
580
- * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
581
- * @type {boolean}
582
- * @default true
583
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
584
- * @example
585
- * ```js
586
- * const embed = new AppEmbed('#embed-container', {
587
- * ... // other options
588
- * showLiveboardReverifyBanner: true,
589
- * })
590
- * ```
591
- */
592
- showLiveboardReverifyBanner?: boolean;
517
+ * Show alert messages and toast messages in the embedded
518
+ * view in full app embed.
519
+ *
520
+ * Supported embed types: `AppEmbed`
521
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
522
+ * @example
523
+ * ```js
524
+ * const embed = new AppEmbed('#tsEmbed', {
525
+ * ... // other embed view config
526
+ * showAlerts:true,
527
+ * })
528
+ * ```
529
+ */
530
+ showAlerts?: boolean;
593
531
  /**
594
- * This flag is used to enable unified search experience for full app embed.
532
+ * This flag is used to enable/disable the styling and grouping in a Liveboard
533
+ *
534
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
595
535
  * @type {boolean}
596
- * @default true
597
- * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
536
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
598
537
  * @example
599
538
  * ```js
600
- * const embed = new AppEmbed('#embed-container', {
601
- * ... // other options
602
- * isUnifiedSearchExperienceEnabled: true,
539
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
540
+ * const embed = new <EmbedComponent>('#tsEmbed', {
541
+ * ... // other embed view config
542
+ * isLiveboardStylingAndGroupingEnabled: true,
603
543
  * })
604
544
  * ```
605
545
  */
606
- isUnifiedSearchExperienceEnabled?: boolean;
546
+ isLiveboardStylingAndGroupingEnabled?: boolean;
607
547
  }
608
548
  /**
609
549
  * Embeds full ThoughtSpot experience in a host application.
@@ -804,14 +744,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
804
744
  * @summary Liveboard & visualization embed
805
745
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
806
746
  */
807
- import { DOMSelector, HostEvent, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
747
+ import { DOMSelector, HostEvent, SearchLiveboardCommonViewConfig as LiveboardOtherViewConfig, BaseViewConfig, LiveboardAppEmbedViewConfig } from '@thoughtspot/visual-embed-sdk/types';
808
748
  import { TsEmbed, V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
809
749
  import { TriggerPayload, TriggerResponse } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
810
750
  /**
811
751
  * The configuration for the embedded Liveboard or visualization page view.
812
752
  * @group Embed components
813
753
  */
814
- export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
754
+ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewConfig, LiveboardAppEmbedViewConfig {
815
755
  /**
816
756
  * If set to true, the embedded object container dynamically resizes
817
757
  * according to the height of the Liveboard.
@@ -824,6 +764,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
824
764
  * incrementally as users scroll the page to view the charts and tables.
825
765
  *
826
766
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
767
+ *
768
+ * Supported embed types: `LiveboardEmbed`
827
769
  * @example
828
770
  * ```js
829
771
  * const embed = new LiveboardEmbed('#embed', {
@@ -837,6 +779,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
837
779
  * This is the minimum height(in pixels) for a full-height Liveboard.
838
780
  * Setting this height helps resolve issues with empty Liveboards and
839
781
  * other screens navigable from a Liveboard.
782
+ *
783
+ * Supported embed types: `LiveboardEmbed`
840
784
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
841
785
  * @default 500
842
786
  * @example
@@ -854,7 +798,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
854
798
  * @example
855
799
  * ```js
856
800
  * const embed = new LiveboardEmbed('#tsEmbed', {
857
- * ... // other options
801
+ * ... //other embed view config
858
802
  * enableVizTransformations:true,
859
803
  * })
860
804
  * ```
@@ -864,11 +808,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
864
808
  /**
865
809
  * The Liveboard to display in the embedded view.
866
810
  * Use either liveboardId or pinboardId to reference the Liveboard to embed.
811
+ *
812
+ * Supported embed types: `LiveboardEmbed`
867
813
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
868
814
  * @example
869
815
  * ```js
870
- * const embed = new LiveboardEmbed('#embed-container', {
871
- * ... // other options
816
+ * const embed = new LiveboardEmbed('#tsEmbed', {
817
+ * ... //other embed view config
872
818
  * liveboardId:id of liveboard,
873
819
  * })
874
820
  */
@@ -880,11 +826,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
880
826
  pinboardId?: string;
881
827
  /**
882
828
  * The visualization within the Liveboard to display.
829
+ *
830
+ * Supported embed types: `LiveboardEmbed`
883
831
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
884
832
  * @example
885
833
  * ```js
886
- * const embed = new LiveboardEmbed('#embed-container', {
887
- * ... // other options
834
+ * const embed = new LiveboardEmbed('#tsEmbed', {
835
+ * ... //other embed view config
888
836
  * vizId:'430496d6-6903-4601-937e-2c691821af3c',
889
837
  * })
890
838
  * ```
@@ -893,11 +841,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
893
841
  /**
894
842
  * If set to true, all filter chips from a
895
843
  * Liveboard page will be read-only (no X buttons)
844
+ *
845
+ * Supported embed types: `LiveboardEmbed`
896
846
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
897
847
  * @example
898
848
  * ```js
899
- * const embed = new LiveboardEmbed('#embed-container', {
900
- * ... // other options
849
+ * const embed = new LiveboardEmbed('#tsEmbed', {
850
+ * ... //other embed view config
901
851
  * preventLiveboardFilterRemoval:true,
902
852
  * })
903
853
  * ```
@@ -907,11 +857,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
907
857
  * Array of visualization IDs which should be visible when the Liveboard
908
858
  * renders. This can be changed by triggering the `SetVisibleVizs`
909
859
  * event.
860
+ *
861
+ * Supported embed types: `LiveboardEmbed`
910
862
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
911
863
  * @example
912
864
  * ```js
913
- * const embed = new LiveboardEmbed('#embed-container', {
914
- * ... // other options
865
+ * const embed = new LiveboardEmbed('#tsEmbed', {
866
+ * ... //other embed view config
915
867
  * visibleVizs: [
916
868
  * '430496d6-6903-4601-937e-2c691821af3c',
917
869
  * 'f547ec54-2a37-4516-a222-2b06719af726'
@@ -927,11 +879,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
927
879
  /**
928
880
  * Render embedded Liveboards and visualizations in the
929
881
  * new Liveboard experience mode.
882
+ *
883
+ * Supported embed types: `LiveboardEmbed`
930
884
  * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
931
885
  * @example
932
886
  * ```js
933
- * const embed = new LiveboardEmbed('#embed-container', {
934
- * ... // other options
887
+ * const embed = new LiveboardEmbed('#tsEmbed', {
888
+ * ... //other embed view config
935
889
  * liveboardV2:true,
936
890
  * })
937
891
  * ```
@@ -940,10 +894,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
940
894
  /**
941
895
  * Set a Liveboard tab as an active tab.
942
896
  * Specify the tab ID.
897
+ *
898
+ * Supported embed types: `LiveboardEmbed`
943
899
  * @example
944
900
  * ```js
945
901
  * const embed = new LiveboardEmbed('#tsEmbed', {
946
- * ... // other options
902
+ * ... //other embed view config
947
903
  * activeTabId:'id-1234',
948
904
  * })
949
905
  * ```
@@ -952,96 +908,18 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
952
908
  activeTabId?: string;
953
909
  /**
954
910
  * Show or hide the tab panel of the embedded Liveboard.
911
+ *
912
+ * Supported embed types: `LiveboardEmbed`
955
913
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
956
914
  * @example
957
915
  * ```js
958
- * const embed = new LiveboardEmbed('#embed-container', {
959
- * ... // other options
916
+ * const embed = new LiveboardEmbed('#tsEmbed', {
917
+ * ... //other embed view config
960
918
  * hideTabPanel:true,
961
919
  * })
962
920
  * ```
963
921
  */
964
922
  hideTabPanel?: boolean;
965
- /**
966
- * Show or hide the Liveboard header.
967
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
968
- * @default false
969
- * @example
970
- * ```js
971
- * const embed = new LiveboardEmbed('#embed', {
972
- * ... // other liveboard view config
973
- * hideLiveboardHeader:true,
974
- * });
975
- * ```
976
- */
977
- hideLiveboardHeader?: boolean;
978
- /**
979
- * Show or hide the Liveboard title.
980
- * @default false
981
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
982
- * @example
983
- * ```js
984
- * const embed = new LiveboardEmbed('#embed-container', {
985
- * ... // other options
986
- * showLiveboardTitle:true,
987
- * })
988
- * ```
989
- */
990
- showLiveboardTitle?: boolean;
991
- /**
992
- * Show or hide the Liveboard description.
993
- * @default false
994
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
995
- * @example
996
- * ```js
997
- * const embed = new LiveboardEmbed('#embed-container', {
998
- * ... // other options
999
- * showLiveboardDescription:true,
1000
- * })
1001
- * ```
1002
- */
1003
- showLiveboardDescription?: boolean;
1004
- /**
1005
- * Control the position and visibility of
1006
- * the Liveboard header as the users scroll down the
1007
- * embedded Liveboard page.
1008
- * @example
1009
- * ```js
1010
- * const embed = new LiveboardEmbed('#embed', {
1011
- * ... // other Liveboard view config
1012
- * isLiveboardHeaderSticky: true,
1013
- * });
1014
- * ```
1015
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
1016
- */
1017
- isLiveboardHeaderSticky?: boolean;
1018
- /**
1019
- * enable or disable ask sage
1020
- * @default false
1021
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
1022
- * @example
1023
- * ```js
1024
- * const embed = new SearchEmbed('#tsEmbed', {
1025
- * ... // other options
1026
- * enableAskSage:true,
1027
- * })
1028
- * ```
1029
- */
1030
- enableAskSage?: boolean;
1031
- /**
1032
- * This flag is used to enable the 2 column layout on a Liveboard
1033
- * @type {boolean}
1034
- * @default false
1035
- * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1036
- * @example
1037
- * ```js
1038
- * const embed = new LiveboardEmbed('#embed-container', {
1039
- * ... // other options
1040
- * enable2ColumnLayout: true,
1041
- * })
1042
- * ```
1043
- */
1044
- enable2ColumnLayout?: boolean;
1045
923
  /**
1046
924
  * Show a preview image of the visualization before the visualization loads.
1047
925
  * Only works for visualizations embeds with a viz id.
@@ -1051,9 +929,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
1051
929
  *
1052
930
  * Since, this will show preview images, be careful that it may show
1053
931
  * undesired data to the user when using row level security.
932
+ *
933
+ * Supported embed types: `LiveboardEmbed`
1054
934
  * @example
1055
935
  * ```js
1056
- * const embed = new LiveboardEmbed('#embed-container', {
936
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1057
937
  * liveboardId: 'liveboard-id',
1058
938
  * vizId: 'viz-id',
1059
939
  * showPreviewLoader: true,
@@ -1064,116 +944,119 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
1064
944
  */
1065
945
  showPreviewLoader?: boolean;
1066
946
  /**
1067
- * Enables or disables the compact header feature on a Liveboard.
1068
- * Compact Liveboard header is turned off by default on Liveboards in
1069
- * ThoughtSpot Embedded apps.
947
+ * The Liveboard to run on regular intervals to fetch the cdw token.
1070
948
  *
1071
- * @type {boolean}
1072
- * @default false
1073
- * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
949
+ * Supported embed types: `LiveboardEmbed`
950
+ * @hidden
951
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1074
952
  * @example
1075
953
  * ```js
1076
- * const embed = new LiveboardEmbed('#embed-container', {
1077
- * ... // other options
1078
- * isLiveboardCompactHeaderEnabled: true,
954
+ * const embed = new LiveboardEmbed('#tsEmbed', {
955
+ * ... //other embed view config
956
+ * oAuthPollingInterval: value in milliseconds,
1079
957
  * })
1080
- * ```
1081
958
  */
1082
- isLiveboardCompactHeaderEnabled?: boolean;
959
+ oAuthPollingInterval?: number;
1083
960
  /**
1084
- * This flag is used to show/hide verified icon in the Liveboard compact header
1085
- * @type {boolean}
1086
- * @default true
1087
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
961
+ * The Liveboard is set to force a token fetch during the initial load.
962
+ *
963
+ * Supported embed types: `LiveboardEmbed`
964
+ * @hidden
965
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1088
966
  * @example
1089
967
  * ```js
1090
- * const embed = new LiveboardEmbed('#embed-container', {
1091
- * ... // other options
1092
- * showLiveboardVerifiedBadge: true,
968
+ * const embed = new LiveboardEmbed('#tsEmbed', {
969
+ * ... //other embed view config
970
+ * isForceRedirect: false,
1093
971
  * })
1094
- * ```
1095
972
  */
1096
- showLiveboardVerifiedBadge?: boolean;
973
+ isForceRedirect?: boolean;
1097
974
  /**
1098
- * This flag is used to show/hide the re-verify banner
1099
- * in Liveboard compact header
1100
- * @type {boolean}
1101
- * @default true
1102
- * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
975
+ * The source connection ID for authentication.
976
+ * @hidden
977
+ * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
978
+ *
979
+ * Supported embed types: `LiveboardEmbed`
1103
980
  * @example
1104
981
  * ```js
1105
- * const embed = new LiveboardEmbed('#embed-container', {
1106
- * ... // other options
1107
- * showLiveboardReverifyBanner: true,
982
+ * const embed = new LiveboardEmbed('#tsEmbed', {
983
+ * ... //other embed view config
984
+ * dataSourceId: '',
1108
985
  * })
1109
- * ```
1110
986
  */
1111
- showLiveboardReverifyBanner?: boolean;
987
+ dataSourceId?: string;
1112
988
  /**
1113
- * This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
1114
- * @type {boolean}
1115
- * @default false
1116
- * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
989
+ * This flag is for show/hide checkboxes for include or exclude
990
+ * cover page and filters in the Liveboard PDF.
991
+ *
992
+ * Supported embed types: `LiveboardEmbed`
993
+ * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
994
+ * @default true
995
+ * Supported embed types: `LiveboardEmbed`
1117
996
  * @example
1118
997
  * ```js
1119
- * const embed = new LiveboardEmbed('#embed-container', {
1120
- * ... // other options
1121
- * hideIrrelevantChipsInLiveboardTabs: true,
998
+ * const embed = new LiveboardEmbed('#tsEmbed', {
999
+ * ... //other embed view config
1000
+ * coverAndFilterOptionInPDF: false,
1122
1001
  * })
1123
1002
  * ```
1124
1003
  */
1125
- hideIrrelevantChipsInLiveboardTabs?: boolean;
1126
- /**
1127
- * The Liveboard to run on regular intervals to fetch the cdw token.
1128
- * @hidden
1129
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1130
- * @example
1131
- * ```js
1132
- * const embed = new LiveboardEmbed('#embed-container', {
1133
- * ... // other options
1134
- * oAuthPollingInterval: value in milliseconds,
1135
- * })
1136
- */
1137
- oAuthPollingInterval?: number;
1004
+ coverAndFilterOptionInPDF?: boolean;
1138
1005
  /**
1139
- * The Liveboard is set to force a token fetch during the initial load.
1140
- * @hidden
1141
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1006
+ * The list of tab IDs to hide from the embedded.
1007
+ * This Tabs will be hidden from their respective LBs.
1008
+ * Use this to hide an tabID.
1009
+ *
1010
+ * Supported embed types: `LiveboardEmbed`
1142
1011
  * @example
1143
1012
  * ```js
1144
- * const embed = new LiveboardEmbed('#embed-container', {
1145
- * ... // other options
1146
- * isForceRedirect: false,
1147
- * })
1013
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1014
+ * ... // other embed view config
1015
+ * hiddenTabs: [
1016
+ * '430496d6-6903-4601-937e-2c691821af3c',
1017
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
1018
+ * ]
1019
+ * });
1020
+ * ```
1021
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
1148
1022
  */
1149
- isForceRedirect?: boolean;
1023
+ hiddenTabs?: string[];
1150
1024
  /**
1151
- * The source connection ID for authentication.
1152
- * @hidden
1153
- * @version SDK: 1.35.0 | ThoughtSpot:10.6.0.cl
1025
+ * The list of tab IDs to show in the embedded Liveboard.
1026
+ * Only the tabs specified in the array will be shown in the Liveboard.
1027
+ *
1028
+ * Use either `visibleTabs` or `hiddenTabs`.
1029
+ *
1030
+ * Supported embed types: `LiveboardEmbed`
1031
+ * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
1154
1032
  * @example
1155
1033
  * ```js
1156
- * const embed = new LiveboardEmbed('#embed-container', {
1157
- * ... // other options
1158
- * dataSourceId: '',
1034
+ * const embed = new LiveboardEmbed('#tsEmbed', {
1035
+ * ... // other embed view config
1036
+ * visibleTabs: [
1037
+ * '430496d6-6903-4601-937e-2c691821af3c',
1038
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
1039
+ * ]
1159
1040
  * })
1041
+ * ```
1160
1042
  */
1161
- dataSourceId?: string;
1043
+ visibleTabs?: string[];
1162
1044
  /**
1163
- * This flag is for show/hide checkboxes for include or exclude
1164
- * cover page and filters in the Liveboard PDF.
1045
+ * This flag is used to enable/disable the styling and grouping in a Liveboard
1046
+ *
1047
+ * Supported embed types: `LiveboardEmbed`, `AppEmbed`
1165
1048
  * @type {boolean}
1166
- * @default true
1167
- * @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
1049
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1168
1050
  * @example
1169
1051
  * ```js
1170
- * const embed = new LiveboardEmbed('#embed-container', {
1171
- * ... // other options
1172
- * coverAndFilterOptionInPDF: false,
1052
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
1053
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1054
+ * ... // other embed view config
1055
+ * isLiveboardStylingAndGroupingEnabled: true,
1173
1056
  * })
1174
1057
  * ```
1175
1058
  */
1176
- coverAndFilterOptionInPDF?: boolean;
1059
+ isLiveboardStylingAndGroupingEnabled?: boolean;
1177
1060
  }
1178
1061
  /**
1179
1062
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1236,7 +1119,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1236
1119
  * @summary Search embed
1237
1120
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
1238
1121
  */
1239
- import { DOMSelector, Action, ViewConfig, DefaultAppInitData } from '@thoughtspot/visual-embed-sdk/types';
1122
+ import { DOMSelector, Action, SearchLiveboardCommonViewConfig, DefaultAppInitData, BaseViewConfig } from '@thoughtspot/visual-embed-sdk/types';
1240
1123
  import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
1241
1124
  /**
1242
1125
  * Configuration for search options.
@@ -1277,15 +1160,17 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1277
1160
  * The configuration attributes for the embedded search view.
1278
1161
  * @group Embed components
1279
1162
  */
1280
- export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
1163
+ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction'> {
1281
1164
  /**
1282
1165
  * If set to true, the data sources panel is collapsed on load,
1283
1166
  * but can be expanded manually.
1167
+ *
1168
+ * Supported embed types: `SearchEmbed`
1284
1169
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
1285
1170
  * @example
1286
1171
  * ```js
1287
1172
  * const embed = new SearchEmbed('#tsEmbed', {
1288
- * ... // other options
1173
+ * ... // other embed view config
1289
1174
  * collapseDataSources:true,
1290
1175
  * })
1291
1176
  * ```
@@ -1294,11 +1179,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1294
1179
  /**
1295
1180
  * If set to true, the data panel is collapsed on load,
1296
1181
  * but can be expanded manually.
1182
+ *
1183
+ * Supported embed types: `SearchEmbed`
1297
1184
  * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
1298
1185
  * @example
1299
1186
  * ```js
1300
1187
  * const embed = new SearchEmbed('#tsEmbed', {
1301
- * ... // other options
1188
+ * ... // other embed view config
1302
1189
  * collapseDataPanel:true,
1303
1190
  * })
1304
1191
  * ```
@@ -1306,11 +1193,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1306
1193
  collapseDataPanel?: boolean;
1307
1194
  /**
1308
1195
  * Show or hide the data sources panel.
1196
+ *
1197
+ * Supported embed types: `SearchEmbed`
1309
1198
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
1310
1199
  * @example
1311
1200
  * ```js
1312
1201
  * const embed = new SearchEmbed('#tsEmbed', {
1313
- * ... // other options
1202
+ * ... // other embed view config
1314
1203
  * hideDataSources:true,
1315
1204
  * })
1316
1205
  * ```
@@ -1320,11 +1209,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1320
1209
  * Show or hide the charts and tables in search answers.
1321
1210
  * This attribute can be used to create a custom visualization
1322
1211
  * using raw answer data.
1212
+ *
1213
+ * Supported embed types: `SearchEmbed`
1323
1214
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
1324
1215
  * @example
1325
1216
  * ```js
1326
1217
  * const embed = new SearchEmbed('#tsEmbed', {
1327
- * ... // other options
1218
+ * ... // other embed view config
1328
1219
  * hideResults:true,
1329
1220
  * })
1330
1221
  * ```
@@ -1332,11 +1223,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1332
1223
  hideResults?: boolean;
1333
1224
  /**
1334
1225
  * If set to true, the Search Assist feature is enabled.
1226
+ *
1227
+ * Supported embed types: `SearchEmbed`
1335
1228
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
1336
1229
  * @example
1337
1230
  * ```js
1338
1231
  * const embed = new SearchEmbed('#tsEmbed', {
1339
- * ... // other options
1232
+ * ... // other embed view config
1340
1233
  * enableSearchAssist:true,
1341
1234
  * })
1342
1235
  * ```
@@ -1345,11 +1238,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1345
1238
  /**
1346
1239
  * If set to true, the tabular view is set as the default
1347
1240
  * format for presenting search data.
1241
+ *
1242
+ * Supported embed types: `SearchEmbed`
1348
1243
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
1349
1244
  * @example
1350
1245
  * ```js
1351
1246
  * const embed = new SearchEmbed('#tsEmbed', {
1352
- * ... // other options
1247
+ * ... // other embed view config
1353
1248
  * forceTable:true,
1354
1249
  * })
1355
1250
  */
@@ -1358,10 +1253,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1358
1253
  * The array of data source GUIDs to set on load.
1359
1254
  * Only a single data source is supported currently.
1360
1255
  * @deprecated Use `dataSource` instead.
1256
+ *
1257
+ * Supported embed types: `SearchEmbed`
1361
1258
  * @example
1362
1259
  * ```js
1363
1260
  * const embed = new SearchEmbed('#tsEmbed', {
1364
- * ... // other options
1261
+ * ... // other embed view config
1365
1262
  * dataSources:['id-234','id-456'],
1366
1263
  * })
1367
1264
  * ```
@@ -1369,11 +1266,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1369
1266
  dataSources?: string[];
1370
1267
  /**
1371
1268
  * The array of data source GUIDs to set on load.
1269
+ *
1270
+ * Supported embed types: `SearchEmbed`
1372
1271
  * @version: SDK: 1.19.0
1373
1272
  * @example
1374
1273
  * ```js
1375
1274
  * const embed = new SearchEmbed('#tsEmbed', {
1376
- * ... // other options
1275
+ * ... // other embed view config
1377
1276
  * dataSource:'id-234',
1378
1277
  * })
1379
1278
  * ```
@@ -1396,6 +1295,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1396
1295
  * If it is executed, the focus is placed on the results.
1397
1296
  * If it’s not executed, the focus is placed at the end of
1398
1297
  * the token string in the search bar.
1298
+ *
1299
+ * Supported embed types: `SearchEmbed`
1399
1300
  * @example
1400
1301
  * ```js
1401
1302
  * searchOptions: {
@@ -1408,6 +1309,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1408
1309
  /**
1409
1310
  * Exclude the search token string from the URL.
1410
1311
  * If set to true, the search token string is not appended to the URL.
1312
+ *
1313
+ * Supported embed types: `SearchEmbed`
1411
1314
  * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
1412
1315
  * @example
1413
1316
  * ```js
@@ -1423,11 +1326,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1423
1326
  excludeSearchTokenStringFromURL?: boolean;
1424
1327
  /**
1425
1328
  * The GUID of a saved answer to load initially.
1329
+ *
1330
+ * Supported embed types: `SearchEmbed`
1426
1331
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
1427
1332
  * @example
1428
1333
  * ```js
1429
1334
  * const embed = new SearchEmbed('#tsEmbed', {
1430
- * ... // other options
1335
+ * ... // other embed view config
1431
1336
  * answerId:'sed-1234',
1432
1337
  * })
1433
1338
  * ```
@@ -1436,11 +1341,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1436
1341
  /**
1437
1342
  * If set to true, the search page will render without the Search Bar
1438
1343
  * The chart/table should still be visible.
1344
+ *
1345
+ * Supported embed types: `SearchEmbed`
1439
1346
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
1440
1347
  * @example
1441
1348
  * ```js
1442
1349
  * const embed = new SearchEmbed('#tsEmbed', {
1443
- * ... // other options
1350
+ * ... // other embed view config
1444
1351
  * hideSearchBar:true,
1445
1352
  * })
1446
1353
  * ```
@@ -1448,6 +1355,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1448
1355
  hideSearchBar?: boolean;
1449
1356
  /**
1450
1357
  * Flag to set if last selected dataSource should be used
1358
+ *
1359
+ * Supported embed types: `SearchEmbed`
1451
1360
  * @version: SDK: 1.24.0
1452
1361
  */
1453
1362
  useLastSelectedSources?: boolean;
@@ -1460,6 +1369,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1460
1369
  collapseSearchBarInitially?: boolean;
1461
1370
  /**
1462
1371
  * Flag to enable onBeforeSearchExecute Embed Event
1372
+ *
1373
+ * Supported embed types: `SearchEmbed`
1463
1374
  * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
1464
1375
  */
1465
1376
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
@@ -1470,12 +1381,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1470
1381
  * - EXPAND_ALL: Expand all the accordion initially in data panel v2.
1471
1382
  * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
1472
1383
  * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
1384
+ *
1385
+ * Supported embed types: `SearchEmbed`
1473
1386
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1474
1387
  * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
1475
1388
  * @example
1476
1389
  * ```js
1477
1390
  * const embed = new SearchEmbed('#tsEmbed', {
1478
- * ... // other options
1391
+ * ... // other embed view config
1479
1392
  * dataPanelCustomGroupsAccordionInitialState:
1480
1393
  * DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
1481
1394
  * });
@@ -1485,12 +1398,14 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1485
1398
  /**
1486
1399
  * Flag to remove focus from search bar initially when user
1487
1400
  * lands on search embed page.
1401
+ *
1402
+ * Supported embed types: `SearchEmbed`
1488
1403
  * @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
1489
1404
  * @default true
1490
1405
  * @example
1491
1406
  * ```js
1492
1407
  * const embed = new SearchEmbed('#tsEmbed', {
1493
- * ... // other options
1408
+ * ... // other embed view config
1494
1409
  * focusSearchBarOnRender: false,
1495
1410
  * });
1496
1411
  * ```
@@ -1533,22 +1448,24 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1533
1448
  }
1534
1449
 
1535
1450
  declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
1536
- import { DefaultAppInitData, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
1451
+ import { SearchLiveboardCommonViewConfig, BaseViewConfig, DefaultAppInitData } from '@thoughtspot/visual-embed-sdk/types';
1537
1452
  import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
1538
1453
  import { SearchOptions } from '@thoughtspot/visual-embed-sdk/embed/search';
1539
1454
  /**
1540
1455
  * @group Embed components
1541
1456
  */
1542
- export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
1457
+ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig {
1543
1458
  /**
1544
1459
  * The array of data source GUIDs to set on load.
1545
1460
  * Only a single data source is supported currently.
1461
+ *
1462
+ * Supported embed types: `SearchBarEmbed`
1546
1463
  * @deprecated Use `dataSource` instead
1547
1464
  * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
1548
1465
  * @example
1549
1466
  * ```js
1550
1467
  * const embed = new SearchBarEmbed('#tsEmbed', {
1551
- * ... // other options
1468
+ * ... //other embed view config
1552
1469
  * dataSources:['id-2345','id-2345'],
1553
1470
  * })
1554
1471
  * ```
@@ -1556,11 +1473,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
1556
1473
  dataSources?: string[];
1557
1474
  /**
1558
1475
  * Pass the ID of the source to be selected.
1476
+ *
1477
+ * Supported embed types: `SearchBarEmbed`
1559
1478
  * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
1560
1479
  * @example
1561
1480
  * ```js
1562
1481
  * const embed = new SearchBarEmbed('#tsEmbed', {
1563
- * ... // other options
1482
+ * ... //other embed view config
1564
1483
  * dataSource:'id-2345',
1565
1484
  * })
1566
1485
  * ```
@@ -1568,11 +1487,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
1568
1487
  dataSource?: string;
1569
1488
  /**
1570
1489
  * Boolean to define if the last selected data source should be used
1490
+ *
1491
+ * Supported embed types: `SearchBarEmbed`
1571
1492
  * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
1572
1493
  * @example
1573
1494
  * ```js
1574
1495
  * const embed = new SearchBarEmbed('#tsEmbed', {
1575
- * ... // other options
1496
+ * ... //other embed view config
1576
1497
  * useLastSelectedSources:false,
1577
1498
  * })
1578
1499
  * ```
@@ -1588,11 +1509,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
1588
1509
  * If it is executed, the focus is placed on the results.
1589
1510
  * If it’s not executed, the focus is placed at the end of
1590
1511
  * the token string in the search bar.
1512
+ *
1513
+ * Supported embed types: `SearchBarEmbed`
1591
1514
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
1592
1515
  * @example
1593
1516
  * ```js
1594
1517
  * const embed = new SearchBarEmbed('#tsEmbed', {
1595
- * ... // other options
1518
+ * ... //other embed view config
1596
1519
  * searchOptions: {
1597
1520
  * searchTokenString: '[quantity purchased] [region]',
1598
1521
  * executeSearch: true,
@@ -1604,6 +1527,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
1604
1527
  /**
1605
1528
  * Exclude the search token string from the URL.
1606
1529
  * If set to true, the search token string is not appended to the URL.
1530
+ *
1531
+ * Supported embed types: `SearchBarEmbed`
1607
1532
  * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
1608
1533
  * @example
1609
1534
  * ```js
@@ -1645,13 +1570,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
1645
1570
  }
1646
1571
 
1647
1572
  declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
1648
- import { ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
1573
+ import { BaseViewConfig } from '@thoughtspot/visual-embed-sdk/types';
1649
1574
  import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
1650
1575
  /**
1651
1576
  * Configuration for bodyless conversation options.
1652
1577
  * @group Embed components
1653
1578
  */
1654
- export interface SpotterAgentEmbedViewConfig extends ViewConfig {
1579
+ export interface SpotterAgentEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
1655
1580
  /**
1656
1581
  * The ID of the worksheet to use for the conversation.
1657
1582
  */
@@ -1663,7 +1588,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
1663
1588
  }
1664
1589
  /**
1665
1590
  * Configuration for conversation options.
1666
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1591
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1667
1592
  * Use {@link SpotterAgentEmbedViewConfig} instead
1668
1593
  * @group Embed components
1669
1594
  */
@@ -1715,7 +1640,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
1715
1640
  /**
1716
1641
  * Create a conversation embed, which can be integrated inside
1717
1642
  * chatbots or other conversational interfaces.
1718
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1643
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1719
1644
  * Use {@link SpotterAgentEmbed} instead
1720
1645
  * @example
1721
1646
  * ```js
@@ -1739,7 +1664,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
1739
1664
  }
1740
1665
 
1741
1666
  declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1742
- import { ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
1667
+ import { BaseViewConfig } from '@thoughtspot/visual-embed-sdk/types';
1743
1668
  import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
1744
1669
  /**
1745
1670
  * Configuration for search options
@@ -1754,9 +1679,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1754
1679
  * The configuration for the embedded spotterEmbed options.
1755
1680
  * @group Embed components
1756
1681
  */
1757
- export interface SpotterEmbedViewConfig extends ViewConfig {
1682
+ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
1758
1683
  /**
1759
- * The ID of the worksheet to use for the conversation.
1684
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
1760
1685
  */
1761
1686
  worksheetId: string;
1762
1687
  /**
@@ -1766,10 +1691,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1766
1691
  /**
1767
1692
  * disableSourceSelection : Disables data source selection
1768
1693
  * but still display the selected data source.
1694
+ *
1695
+ * Supported embed types: `SpotterEmbed`
1769
1696
  * @example
1770
1697
  * ```js
1771
1698
  * const embed = new SpotterEmbed('#tsEmbed', {
1772
- * ... // other options
1699
+ * ... //other embed view config
1773
1700
  * disableSourceSelection : true,
1774
1701
  * })
1775
1702
  * ```
@@ -1778,10 +1705,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1778
1705
  disableSourceSelection?: boolean;
1779
1706
  /**
1780
1707
  * hideSourceSelection : Hide data source selection
1708
+ *
1709
+ * Supported embed types: `SpotterEmbed`
1781
1710
  * @example
1782
1711
  * ```js
1783
1712
  * const embed = new SpotterEmbed('#tsEmbed', {
1784
- * ... // other options
1713
+ * ... //other embed view config
1785
1714
  * hideSourceSelection : true,
1786
1715
  * })
1787
1716
  * ```
@@ -1790,12 +1719,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1790
1719
  hideSourceSelection?: boolean;
1791
1720
  /**
1792
1721
  * Flag to control Data panel experience
1722
+ *
1723
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
1793
1724
  * @default false
1794
1725
  * @version SDK: 1.36.0 | ThoughtSpot Cloud: 10.4.0.cl
1795
1726
  * @example
1796
1727
  * ```js
1797
- * const embed = new AppEmbed('#tsEmbed', {
1798
- * ... // other options
1728
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
1729
+ * const embed = new <EmbedComponent>('#tsEmbed', {
1730
+ * ... // other embed view config
1799
1731
  * dataPanelV2: true,
1800
1732
  * })
1801
1733
  * ```
@@ -1805,10 +1737,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1805
1737
  * showSpotterLimitations : show limitation text
1806
1738
  * of the spotter underneath the chat input.
1807
1739
  * default is false.
1740
+ *
1741
+ * Supported embed types: `SpotterEmbed`
1808
1742
  * @example
1809
1743
  * ```js
1810
1744
  * const embed = new SpotterEmbed('#tsEmbed', {
1811
- * ... // other options
1745
+ * ... //other embed view config
1812
1746
  * showSpotterLimitations : true,
1813
1747
  * })
1814
1748
  * ```
@@ -1818,10 +1752,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1818
1752
  /**
1819
1753
  * hideSampleQuestions : Hide sample questions on
1820
1754
  * the initial screen of the conversation.
1755
+ *
1756
+ * Supported embed types: `SpotterEmbed`
1821
1757
  * @example
1822
1758
  * ```js
1823
1759
  * const embed = new SpotterEmbed('#tsEmbed', {
1824
- * ... // other options
1760
+ * ... //other embed view config
1825
1761
  * hideSampleQuestions : true,
1826
1762
  * })
1827
1763
  * ```
@@ -1831,7 +1767,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1831
1767
  }
1832
1768
  /**
1833
1769
  * The configuration for the embedded spotterEmbed options.
1834
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1770
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1835
1771
  * Use {@link SpotterEmbedViewConfig} instead
1836
1772
  * @group Embed components
1837
1773
  */
@@ -1860,7 +1796,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1860
1796
  }
1861
1797
  /**
1862
1798
  * Embed ThoughtSpot AI Conversation.
1863
- * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1799
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
1864
1800
  * Use {@link SpotterEmbed} instead
1865
1801
  * @group Embed components
1866
1802
  * @example
@@ -2253,7 +2189,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2253
2189
  * // ...
2254
2190
  * authType: AuthType.SAMLRedirect,
2255
2191
  * authTriggerText: 'Login with SAML',
2256
- * authTriggerContainer: '#embed-container',
2192
+ * authTriggerContainer: '#tsEmbed',
2257
2193
  * inPopup: true,
2258
2194
  * });
2259
2195
  * ```
@@ -2378,13 +2314,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2378
2314
  /**
2379
2315
  * Create new options in the insights left navigation,
2380
2316
  * available when new navigation V3 is enabled.
2381
- * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2317
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2382
2318
  */
2383
2319
  Create = "create",
2384
2320
  /**
2385
2321
  * Spotter option in the insights left navigation,
2386
2322
  * available when new navigation V3 is enabled.
2387
- * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2323
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2388
2324
  */
2389
2325
  Spotter = "spotter"
2390
2326
  }
@@ -2792,6 +2728,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2792
2728
  */
2793
2729
  customVariablesForThirdPartyTools?: Record<string, any>;
2794
2730
  disablePreauthCache?: boolean;
2731
+ /**
2732
+ * Disable fullscreen presentation mode functionality. When enabled, prevents entering
2733
+ * and exiting fullscreen mode for embedded visualizations during presentations.
2734
+ * @default true (feature is disabled by default)
2735
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
2736
+ * @example
2737
+ * ```js
2738
+ * init({
2739
+ * ... // other embed config options
2740
+ * disableFullscreenPresentation: false, // enables the feature
2741
+ * })
2742
+ * ```
2743
+ */
2744
+ disableFullscreenPresentation?: boolean;
2795
2745
  }
2796
2746
  export interface LayoutConfig {
2797
2747
  }
@@ -2821,9 +2771,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2821
2771
  [key: string]: string | number | boolean | undefined;
2822
2772
  }
2823
2773
  /**
2824
- * The configuration object for an embedded view.
2774
+ * The common configuration object for an embedded view.
2825
2775
  */
2826
- export interface ViewConfig {
2776
+ export interface BaseViewConfig {
2827
2777
  /**
2828
2778
  * @hidden
2829
2779
  */
@@ -2831,16 +2781,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2831
2781
  /**
2832
2782
  * The width and height dimensions to render an embedded
2833
2783
  * object inside your app. Specify the values in pixels or percentage.
2784
+ *
2785
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2834
2786
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
2835
2787
  * @example
2836
2788
  * ```js
2837
- * const embed = new LiveboardEmbed('#embed', {
2838
- * ... // other liveboard view config
2839
- * frameParams: {
2840
- * width: '500px' | '50%',
2841
- * height: '400px' | '60%',
2842
- * },
2843
- * });
2789
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2790
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2791
+ * ... // other embed view config
2792
+ * frameParams: {
2793
+ * width: '500px' | '50%',
2794
+ * height: '400px' | '60%',
2795
+ * },
2796
+ * })
2844
2797
  * ```
2845
2798
  */
2846
2799
  frameParams?: FrameParams;
@@ -2857,38 +2810,31 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2857
2810
  * (...), and the contextual menu. These actions will be disabled
2858
2811
  * for the user.
2859
2812
  * Use this to disable actions.
2813
+ *
2814
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2860
2815
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2861
2816
  * @example
2862
2817
  * ```js
2863
- * const embed = new LiveboardEmbed('#embed', {
2864
- * ... // other liveboard view config
2865
- * disabledActions: [Action.Download, Action.Save]
2818
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2819
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2820
+ * ... // other embed view config
2821
+ * disabledActions: [Action.Download, Action.Save],
2866
2822
  * });
2867
2823
  * ```
2868
2824
  */
2869
2825
  disabledActions?: Action[];
2870
- /**
2871
- * The primary action to display on top of the viz for Liveboard and App Embed.
2872
- * Use this to set the primary action.
2873
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2874
- * @example
2875
- * ```js
2876
- * const embed = new LiveboardEmbed('#embed', {
2877
- * ... // other liveboard view config
2878
- * primaryAction: Action.Download
2879
- * });
2880
- * ```
2881
- */
2882
- primaryAction?: Action | string;
2883
2826
  /**
2884
2827
  * The tooltip to display for disabled actions.
2828
+ *
2829
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2885
2830
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2886
2831
  * @example
2887
2832
  * ```js
2888
- * const embed = new LiveboardEmbed('#embed', {
2889
- * ... // other liveboard view config
2890
- * disabledActions: [Action.Download, Action.Save]
2891
- * disabledActionReason: "Reason for disabling",
2833
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2834
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2835
+ * ... // other embed view config
2836
+ * disabledActions: [Action.Download, Action.Save],
2837
+ * disabledActionReason: "Reason for disabling",
2892
2838
  * });
2893
2839
  * ```
2894
2840
  */
@@ -2897,12 +2843,15 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2897
2843
  * The list of actions to hide from the embedded.
2898
2844
  * This actions will be hidden from the user.
2899
2845
  * Use this to hide an action.
2846
+ *
2847
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2900
2848
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2901
2849
  * @example
2902
2850
  * ```js
2903
- * const embed = new LiveboardEmbed('#embed', {
2904
- * ... // other liveboard view config
2905
- * hiddenActions: [Action.Download, Action.Export]
2851
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2852
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2853
+ * ... // other embed view config
2854
+ * hiddenActions: [Action.Download, Action.Export],
2906
2855
  * });
2907
2856
  * ```
2908
2857
  * @important
@@ -2915,74 +2864,30 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2915
2864
  * Use this to hide all actions except the ones you want to show.
2916
2865
  *
2917
2866
  * Use either this or hiddenActions.
2867
+ *
2868
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2918
2869
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2919
2870
  * @important
2920
2871
  * @example
2921
2872
  * ```js
2922
- * const embed = new LiveboardEmbed('#embed', {
2923
- * ... // other liveboard view config
2924
- * visibleActions: [Action.Download, Action.Export]
2873
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2874
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2875
+ * ... // other embed view config
2876
+ * visibleActions: [Action.Download, Action.Export],
2925
2877
  * });
2926
2878
  * ```
2927
2879
  */
2928
2880
  visibleActions?: Action[];
2929
- /**
2930
- * Show alert messages and toast messages in the embedded
2931
- * view in full app embed.
2932
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2933
- * @example
2934
- * ```js
2935
- * const embed = new AppEmbed('#embed-container', {
2936
- * ... // other options
2937
- * showAlerts:true,
2938
- * })
2939
- * ```
2940
- */
2941
- showAlerts?: boolean;
2942
- /**
2943
- * The list of runtime filters to apply to a search Answer,
2944
- * visualization, or Liveboard.
2945
- * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2946
- * @example
2947
- * ```js
2948
- * const embed = new LiveboardEmbed('#embed-container', {
2949
- * ... // other options
2950
- * runtimeFilters: [
2951
- * {
2952
- * columnName: 'value',
2953
- * operator: RuntimeFilterOp.EQ,
2954
- * values: ['string' | 123 | true],
2955
- * },
2956
- * ],
2957
- * })
2958
- * ```
2959
- */
2960
- runtimeFilters?: RuntimeFilter[];
2961
- /**
2962
- * The list of parameter override to apply to a search Answer,
2963
- * visualization, or Liveboard.
2964
- * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2965
- * @example
2966
- * ```js
2967
- * const embed = new LiveboardEmbed('#embed-container', {
2968
- * ... // other options
2969
- * runtimeParameters: [
2970
- * {
2971
- * name: 'value',
2972
- * value: 'string' | 123 | true,
2973
- * },
2974
- * ],
2975
- * })
2976
- * ```
2977
- */
2978
- runtimeParameters?: RuntimeParameter[];
2979
2881
  /**
2980
2882
  * The locale settings to apply to the embedded view.
2883
+ *
2884
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2981
2885
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2982
2886
  * @example
2983
2887
  * ```js
2984
- * const embed = new LiveboardEmbed('#embed-container', {
2985
- * ... // other options
2888
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2889
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2890
+ * ... // other embed view config
2986
2891
  * locale:'en',
2987
2892
  * })
2988
2893
  * ```
@@ -2996,14 +2901,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2996
2901
  * Warning: This option is for advanced use only and is used internally
2997
2902
  * to control embed behavior in non-regular ways. We do not publish the
2998
2903
  * list of supported keys and values associated with each.
2904
+ *
2905
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2999
2906
  * @example
3000
2907
  * ```js
3001
- * const embed = new LiveboardEmbed('#embed', {
3002
- * ... // other liveboard view config
2908
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2909
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2910
+ * ... // other embed view config
3003
2911
  * additionalFlags: {
3004
2912
  * flag1: 'value1',
3005
2913
  * flag2: 'value2'
3006
- * }
2914
+ * },
3007
2915
  * });
3008
2916
  * ```
3009
2917
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
@@ -3021,55 +2929,308 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3021
2929
  /**
3022
2930
  * Insert as a sibling of the target container, instead of appending to a
3023
2931
  * child inside it.
2932
+ *
2933
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3024
2934
  * @version SDK: 1.2.0 | ThoughtSpot: 9.0.0.cl, 9.0.0.sw
3025
2935
  * @example
3026
2936
  * ```js
3027
- * const embed = new LiveboardEmbed('#embed-container', {
3028
- * ... // other options
2937
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2938
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2939
+ * ... // other embed view config
3029
2940
  * insertAsSibling:true,
3030
2941
  * })
3031
2942
  * ```
3032
2943
  */
3033
2944
  insertAsSibling?: boolean;
3034
2945
  /**
3035
- * flag to set ContextMenu Trigger to either left or right click.
2946
+ * Use a pre-rendered iframe from a pool of pre-rendered iframes
2947
+ * if available and matches the configuration.
2948
+ * @version SDK: 1.22.0
2949
+ * @hidden
2950
+ *
2951
+ * See [docs]() on how to create a prerender pool.
2952
+ */
2953
+ usePrerenderedIfAvailable?: boolean;
2954
+ /**
2955
+ * PreRender id to be used for PreRendering the embed.
2956
+ * Use PreRender to render the embed in the background and then
2957
+ * show or hide the rendered embed using showPreRender or hidePreRender respectively.
2958
+ *
2959
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3036
2960
  * @example
3037
2961
  * ```js
3038
- * const embed = new LiveboardEmbed('#tsEmbed', {
3039
- * ... // other options
3040
- * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
3041
- * })
2962
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
2963
+ * const embed = new <EmbedComponent>('#tsEmbed', {
2964
+ * ... // other embed view config
2965
+ * preRenderId: "preRenderId-123",
2966
+ * });
2967
+ * embed.showPreRender();
3042
2968
  * ```
3043
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2969
+ * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
3044
2970
  */
3045
- contextMenuTrigger?: ContextMenuTriggerOptions;
2971
+ preRenderId?: string;
2972
+ /**
2973
+ * Determines if the PreRender component should dynamically track the size
2974
+ * of its embedding element and adjust its own size accordingly.
2975
+ * Enabling this option allows the PreRender component to automatically adapt
2976
+ * its dimensions based on changes to the size of the embedding element.
2977
+ * @type {boolean}
2978
+ * @default false
2979
+ * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
2980
+ * @example
2981
+ * ```js
2982
+ * // Disable tracking PreRender size in the configuration
2983
+ * const config = {
2984
+ * doNotTrackPreRenderSize: true,
2985
+ * };
2986
+ *
2987
+ * // Instantiate an object with the configuration
2988
+ * const myComponent = new MyComponent(config);
2989
+ * ```
2990
+ */
2991
+ doNotTrackPreRenderSize?: boolean;
2992
+ /**
2993
+ * Enable the V2 shell. This can provide performance benefits
2994
+ * due to a lighterweight shell.
2995
+ *
2996
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
2997
+ * @example
2998
+ * ```js
2999
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3000
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3001
+ * ... // other embed view config
3002
+ * enableV2Shell_experimental: true,
3003
+ * });
3004
+ * ```
3005
+ * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
3006
+ */
3007
+ enableV2Shell_experimental?: boolean;
3008
+ /**
3009
+ * For internal tracking of the embed component type.
3010
+ * @hidden
3011
+ */
3012
+ embedComponentType?: string;
3013
+ /**
3014
+ * This flag can be used to expose translation IDs on the embedded app.
3015
+ * @default false
3016
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
3017
+ */
3018
+ exposeTranslationIDs?: boolean;
3019
+ /**
3020
+ * This flag can be used to disable links inside the embedded app,
3021
+ * and disable redirection of links in a new tab.
3022
+ *
3023
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3024
+ * @example
3025
+ * ```js
3026
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3027
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3028
+ * ... // other embed view config
3029
+ * disableRedirectionLinksInNewTab: true,
3030
+ * });
3031
+ * ```
3032
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
3033
+ */
3034
+ disableRedirectionLinksInNewTab?: boolean;
3035
+ /**
3036
+ * Overrides an Org context for embedding application users.
3037
+ * This parameter allows a user authenticated to one Org to view the
3038
+ * objects from another Org.
3039
+ * The `overrideOrgId` setting is honoured only if the
3040
+ * Per Org URL feature is enabled on your ThoughtSpot instance.
3041
+ *
3042
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3043
+ * @example
3044
+ * ```js
3045
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3046
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3047
+ * ... // other embed view config
3048
+ * overrideOrgId: 142536,
3049
+ * });
3050
+ * ```
3051
+ * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3052
+ */
3053
+ overrideOrgId?: number;
3046
3054
  /**
3047
3055
  * Flag to override the *Open Link in New Tab* context menu option.
3056
+ *
3057
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SageEmbed`, `SearchEmbed`, `SpotterAgentEmbed`, `SpotterEmbed`, `SearchBarEmbed`
3048
3058
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3049
3059
  * @example
3050
3060
  * ```js
3051
- * const embed = new LiveboardEmbed('#embed-container', {
3052
- * ... // other options
3061
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3062
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3063
+ * ... // other embed view config
3053
3064
  * linkOverride:false,
3054
3065
  * })
3055
3066
  * ```
3056
3067
  */
3057
3068
  linkOverride?: boolean;
3069
+ /**
3070
+ * The primary action to display on top of the viz for Liveboard and App Embed.
3071
+ * Use this to set the primary action.
3072
+ *
3073
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3074
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
3075
+ * @example
3076
+ * ```js
3077
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3078
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3079
+ * ... // other embed view config
3080
+ * primaryAction: Action.Download
3081
+ * });
3082
+ * ```
3083
+ */
3084
+ primaryAction?: Action | string;
3058
3085
  /**
3059
3086
  * flag to enable insert into slides action
3060
3087
  * @hidden
3061
3088
  * @private
3062
3089
  */
3063
3090
  insertInToSlide?: boolean;
3091
+ }
3092
+ /**
3093
+ * The configuration object for Home page embeds configs.
3094
+ */
3095
+ export interface HomePageConfig {
3064
3096
  /**
3065
- * Use a pre-rendered iframe from a pool of pre-rendered iframes
3066
- * if available and matches the configuration.
3067
- * @version SDK: 1.22.0
3068
- * @hidden
3097
+ * Hide list page columns
3098
+ * For example: hiddenListColumns = [ListPageColumns.Author]
3069
3099
  *
3070
- * See [docs]() on how to create a prerender pool.
3100
+ * **Note**: This option is available only in full app embedding.
3101
+ *
3102
+ * Supported embed types: `AppEmbed`
3103
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3104
+ * @example
3105
+ * ```js
3106
+ * const embed = new AppEmbed('#tsEmbed', {
3107
+ * ... //other embed view config
3108
+ * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3109
+ * })
3110
+ * ```
3111
+ */
3112
+ hiddenListColumns?: ListPageColumns[];
3113
+ /**
3114
+ * Hide the home page modules
3115
+ * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
3116
+ *
3117
+ * **Note**: This option does not apply to the classic homepage.
3118
+ * To access the updated modular homepage, set
3119
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3120
+ *
3121
+ * Supported embed types: `AppEmbed`
3122
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3123
+ * @example
3124
+ * ```js
3125
+ * const embed = new AppEmbed('#tsEmbed', {
3126
+ * ... //other embed view config
3127
+ * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
3128
+ * })
3129
+ * ```
3130
+ */
3131
+ hiddenHomepageModules?: HomepageModule[];
3132
+ /**
3133
+ * reordering the home page modules
3134
+ * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
3135
+ *
3136
+ * **Note**: This option does not apply to the classic homepage.
3137
+ * To access the updated modular homepage, set
3138
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3139
+ *
3140
+ * Supported embed types: `AppEmbed`
3141
+ * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3142
+ * @example
3143
+ * ```js
3144
+ * const embed = new AppEmbed('#tsEmbed', {
3145
+ * ... //other embed view config
3146
+ * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
3147
+ * })
3148
+ * ```
3149
+ */
3150
+ reorderedHomepageModules?: HomepageModule[];
3151
+ /**
3152
+ * homepageLeftNavItems : Show or hide the left navigation bar items.
3153
+ * There are 8 eight home navigation list items.
3154
+ * To hide these items, specify the string in the array.
3155
+ *
3156
+ * Supported embed types: `AppEmbed`
3157
+ * @example
3158
+ * ```js
3159
+ * const embed = new AppEmbed('#tsEmbed', {
3160
+ * ... //other embed view config
3161
+ * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
3162
+ * })
3163
+ * ```
3164
+ *
3165
+ * **Note**: This option does not apply to the classic homepage.
3166
+ * To access the updated modular homepage, set
3167
+ * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3168
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3169
+ */
3170
+ hiddenHomeLeftNavItems?: HomeLeftNavItem[];
3171
+ }
3172
+ /**
3173
+ * The configuration object for common Search and Liveboard embeds configs.
3174
+ */
3175
+ export interface SearchLiveboardCommonViewConfig {
3176
+ /**
3177
+ * The list of runtime filters to apply to a search Answer,
3178
+ * visualization, or Liveboard.
3179
+ *
3180
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
3181
+ * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
3182
+ * @example
3183
+ * ```js
3184
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3185
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3186
+ * ... // other embed view config
3187
+ * runtimeFilters: [
3188
+ * {
3189
+ * columnName: 'value',
3190
+ * operator: RuntimeFilterOp.EQ,
3191
+ * values: ['string' | 123 | true],
3192
+ * },
3193
+ * ],
3194
+ * })
3195
+ * ```
3196
+ */
3197
+ runtimeFilters?: RuntimeFilter[];
3198
+ /**
3199
+ * The list of parameter override to apply to a search Answer,
3200
+ * visualization, or Liveboard.
3201
+ *
3202
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`, `SearchEmbed`
3203
+ * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3204
+ * @example
3205
+ * ```js
3206
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SearchEmbed, or LiveboardEmbed
3207
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3208
+ * ... // other embed view config
3209
+ * runtimeParameters: [
3210
+ * {
3211
+ * name: 'value',
3212
+ * value: 'string' | 123 | true,
3213
+ * },
3214
+ * ]
3215
+ * })
3216
+ * ```
3217
+ */
3218
+ runtimeParameters?: RuntimeParameter[];
3219
+ /**
3220
+ * flag to set ContextMenu Trigger to either left or right click.
3221
+ *
3222
+ * Supported embed types: `AppEmbed`, `SageEmbed`, `SearchEmbed`
3223
+ * @example
3224
+ * ```js
3225
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SageEmbed, or SearchEmbed
3226
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3227
+ * ... // other embed view config
3228
+ * contextMenuTrigger:ContextMenuTriggerOptions.LEFT_CLICK || RIGHT_CLICK,
3229
+ * })
3230
+ * ```
3231
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3071
3232
  */
3072
- usePrerenderedIfAvailable?: boolean;
3233
+ contextMenuTrigger?: ContextMenuTriggerOptions;
3073
3234
  /**
3074
3235
  * Boolean to exclude runtimeFilters in the URL
3075
3236
  * By default it is true, this flag removes runtime filters from the URL
@@ -3082,241 +3243,230 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3082
3243
  */
3083
3244
  excludeRuntimeFiltersfromURL?: boolean;
3084
3245
  /**
3085
- * The list of tab IDs to hide from the embedded.
3086
- * This Tabs will be hidden from their respective LBs.
3087
- * Use this to hide an tabID.
3088
- * @example
3089
- * ```js
3090
- * const embed = new LiveboardEmbed('#embed', {
3091
- * ... // other liveboard view config
3092
- * hiddenTabs: [
3093
- * '430496d6-6903-4601-937e-2c691821af3c',
3094
- * 'f547ec54-2a37-4516-a222-2b06719af726']
3095
- * });
3096
- * ```
3097
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3246
+ * Boolean to exclude runtimeParameters from the URL
3247
+ * when set to true, this flag removes runtime parameters from the URL.
3248
+ *
3249
+ * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
3250
+ * embedded view.
3251
+ * @default false
3252
+ * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
3098
3253
  */
3099
- hiddenTabs?: string[];
3254
+ excludeRuntimeParametersfromURL?: boolean;
3100
3255
  /**
3101
- * Hide the home page modules
3102
- * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
3256
+ * To set the initial state of the search bar in case of saved Answers.
3103
3257
  *
3104
- * **Note**: This option does not apply to the classic homepage.
3105
- * To access the updated modular homepage, set
3106
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3107
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3258
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`
3259
+ * @default true
3260
+ * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3108
3261
  * @example
3109
3262
  * ```js
3110
- * const embed = new AppEmbed('#tsEmbed', {
3111
- * ... // other options
3112
- * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
3113
- * })
3114
- * ```
3263
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
3264
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3265
+ * ... // other embed view config
3266
+ * collapseSearchBar: true,
3267
+ * });
3115
3268
  */
3116
- hiddenHomepageModules?: HomepageModule[];
3269
+ collapseSearchBar?: boolean;
3117
3270
  /**
3118
- * reordering the home page modules
3119
- * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
3271
+ * Flag to control Data panel experience
3120
3272
  *
3121
- * **Note**: This option does not apply to the classic homepage.
3122
- * To access the updated modular homepage, set
3123
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3124
- * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3273
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
3274
+ * @default false
3275
+ * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3125
3276
  * @example
3126
3277
  * ```js
3127
- * const embed = new AppEmbed('#tsEmbed', {
3128
- * ... // other options
3129
- * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary]
3278
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
3279
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3280
+ * ... // other embed view config
3281
+ * dataPanelV2: true,
3130
3282
  * })
3131
3283
  * ```
3132
3284
  */
3133
- reorderedHomepageModules?: HomepageModule[];
3285
+ dataPanelV2?: boolean;
3134
3286
  /**
3135
- * The list of tab IDs to show in the embedded Liveboard.
3136
- * Only the tabs specified in the array will be shown in the Liveboard.
3287
+ * To enable custom column groups in data panel v2
3137
3288
  *
3138
- * Use either `visibleTabs` or `hiddenTabs`.
3139
- * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
3289
+ * Supported embed types: `SageEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
3290
+ * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3291
+ * @default false
3140
3292
  * @example
3141
3293
  * ```js
3142
- * const embed = new LiveboardEmbed('#embed-container', {
3143
- * ... // other options
3144
- * visibleTabs: [
3145
- * '430496d6-6903-4601-937e-2c691821af3c',
3146
- * 'f547ec54-2a37-4516-a222-2b06719af726'
3147
- * ]
3148
- * })
3294
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, SearchBarEmbed, or LiveboardEmbed
3295
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3296
+ * ... // other embed view config
3297
+ * enableCustomColumnGroups: true,
3298
+ * });
3149
3299
  * ```
3150
3300
  */
3151
- visibleTabs?: string[];
3301
+ enableCustomColumnGroups?: boolean;
3302
+ }
3303
+ /**
3304
+ * The configuration object for common Liveboard and App embeds configs.
3305
+ */
3306
+ export interface LiveboardAppEmbedViewConfig {
3152
3307
  /**
3153
- * homepageLeftNavItems : Show or hide the left navigation bar items.
3154
- * There are 8 eight home navigation list items.
3155
- * To hide these items, specify the string in the array.
3308
+ * Show or hide Liveboard header
3309
+ *
3310
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3311
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3312
+ * @default false
3156
3313
  * @example
3157
3314
  * ```js
3158
- * const embed = new AppEmbed('#tsEmbed', {
3159
- * ... // other options
3160
- * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
3315
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3316
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3317
+ * ... // other embed view config
3318
+ * hideLiveboardHeader : true,
3161
3319
  * })
3162
3320
  * ```
3163
- *
3164
- * **Note**: This option does not apply to the classic homepage.
3165
- * To access the updated modular homepage, set
3166
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3167
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3168
3321
  */
3169
- hiddenHomeLeftNavItems?: HomeLeftNavItem[];
3322
+ hideLiveboardHeader?: boolean;
3170
3323
  /**
3171
- * PreRender id to be used for PreRendering the embed.
3172
- * Use PreRender to render the embed in the background and then
3173
- * show or hide the rendered embed using showPreRender or hidePreRender respectively.
3324
+ * Show or hide Liveboard title
3325
+ *
3326
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3327
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3328
+ * @default false
3174
3329
  * @example
3175
3330
  * ```js
3176
- * const embed = new LiveboardEmbed('#embed', {
3177
- * ... // other liveboard view config
3178
- * preRenderId: "preRenderId-123"
3179
- * });
3180
- * embed.showPreRender();
3331
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3332
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3333
+ * ... // other embed view config
3334
+ * showLiveboardTitle:true,
3335
+ * })
3181
3336
  * ```
3182
- * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
3183
3337
  */
3184
- preRenderId?: string;
3338
+ showLiveboardTitle?: boolean;
3185
3339
  /**
3186
- * Determines if the PreRender component should dynamically track the size
3187
- * of its embedding element and adjust its own size accordingly.
3188
- * Enabling this option allows the PreRender component to automatically adapt
3189
- * its dimensions based on changes to the size of the embedding element.
3190
- * @type {boolean}
3340
+ * Show or hide Liveboard description
3341
+ *
3342
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3343
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3191
3344
  * @default false
3192
- * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
3193
3345
  * @example
3194
3346
  * ```js
3195
- * // Disable tracking PreRender size in the configuration
3196
- * const config = {
3197
- * doNotTrackPreRenderSize: true,
3198
- * };
3199
- *
3200
- * // Instantiate an object with the configuration
3201
- * const myComponent = new MyComponent(config);
3347
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3348
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3349
+ * ... // other embed view config
3350
+ * showLiveboardDescription:true,
3351
+ * })
3202
3352
  * ```
3203
3353
  */
3204
- doNotTrackPreRenderSize?: boolean;
3205
- /**
3206
- * For internal tracking of the embed component type.
3207
- * @hidden
3208
- */
3209
- embedComponentType?: string;
3354
+ showLiveboardDescription?: boolean;
3210
3355
  /**
3211
- * Boolean to exclude runtimeParameters from the URL
3212
- * when set to true, this flag removes runtime parameters from the URL.
3356
+ * Boolean to control if Liveboard header is sticky or not.
3213
3357
  *
3214
- * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
3215
- * embedded view.
3216
- * @default false
3217
- * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
3218
- */
3219
- excludeRuntimeParametersfromURL?: boolean;
3220
- /**
3221
- * Enable the V2 shell. This can provide performance benefits
3222
- * due to a lighterweight shell.
3358
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3223
3359
  * @example
3224
3360
  * ```js
3225
- * const embed = new LiveboardEmbed('#embed', {
3226
- * liveboardId: '123',
3227
- * enableV2Shell_experimental: true
3361
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3362
+ * const embed = new <EmbedComponent>('#embed', {
3363
+ * ... // other app view config
3364
+ * isLiveboardHeaderSticky: true,
3228
3365
  * });
3229
3366
  * ```
3230
- * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
3367
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3231
3368
  */
3232
- enableV2Shell_experimental?: boolean;
3369
+ isLiveboardHeaderSticky?: boolean;
3233
3370
  /**
3234
- * To set the initial state of the search bar in case of saved Answers.
3235
- * @default true
3236
- * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
3371
+ * This attribute can be used to enable the two-column layout on an embedded Liveboard
3372
+ *
3373
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3374
+ * @type {boolean}
3375
+ * @default false
3376
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
3237
3377
  * @example
3238
3378
  * ```js
3239
- * const embed = new LiveboardEmbed('#embed', {
3240
- * liveboardId: '123',
3241
- * collapseSearchBar: true
3242
- * });
3379
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3380
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3381
+ * ... // other embed view config
3382
+ * enable2ColumnLayout: true,
3383
+ * })
3384
+ * ```
3243
3385
  */
3244
- collapseSearchBar?: boolean;
3386
+ enable2ColumnLayout?: boolean;
3245
3387
  /**
3246
- * This flag can be used to expose translation IDs on the embedded app.
3388
+ * This flag can be used to enable the compact header in Liveboard
3389
+ *
3390
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3391
+ * @type {boolean}
3247
3392
  * @default false
3248
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
3249
- */
3250
- exposeTranslationIDs?: boolean;
3251
- /**
3252
- * This flag can be used to disable links inside the embedded app,
3253
- * and disable redirection of links in a new tab.
3393
+ * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
3254
3394
  * @example
3255
3395
  * ```js
3256
- * const embed = new LiveboardEmbed('#embed', {
3257
- * disableRedirectionLinksInNewTab: true
3258
- * });
3396
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3397
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3398
+ * ... // other embed view config
3399
+ * isLiveboardCompactHeaderEnabled: true,
3400
+ * })
3259
3401
  * ```
3260
- * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
3261
3402
  */
3262
- disableRedirectionLinksInNewTab?: boolean;
3403
+ isLiveboardCompactHeaderEnabled?: boolean;
3263
3404
  /**
3264
- * Flag to control Data panel experience
3265
- * @default false
3266
- * @version SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
3405
+ * This flag can be used to show or hide the Liveboard verified icon in the compact header.
3406
+ *
3407
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3408
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
3409
+ * @default true
3267
3410
  * @example
3268
3411
  * ```js
3269
- * const embed = new AppEmbed('#tsEmbed', {
3270
- * ... // other options
3271
- * dataPanelV2: true,
3412
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3413
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3414
+ * ... // other embed view config
3415
+ * showLiveboardVerifiedBadge: true,
3272
3416
  * })
3273
3417
  * ```
3274
3418
  */
3275
- dataPanelV2?: boolean;
3419
+ showLiveboardVerifiedBadge?: boolean;
3276
3420
  /**
3277
- * To enable custom column groups in data panel v2
3278
- * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl, 10.1.0.sw
3421
+ * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
3422
+ *
3423
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3424
+ * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
3279
3425
  * @default false
3280
3426
  * @example
3281
3427
  * ```js
3282
- * const embed = new SearchEmbed('#tsEmbed', {
3283
- * ... // other options
3284
- * enableCustomColumnGroups: true,
3285
- * });
3428
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3429
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3430
+ * ... // other embed view config
3431
+ * hideIrrelevantChipsInLiveboardTabs: true,
3432
+ * })
3286
3433
  * ```
3287
3434
  */
3288
- enableCustomColumnGroups?: boolean;
3435
+ hideIrrelevantChipsInLiveboardTabs?: boolean;
3289
3436
  /**
3290
- * Overrides an Org context for embedding application users.
3291
- * This parameter allows a user authenticated to one Org to view the
3292
- * objects from another Org.
3293
- * The `overrideOrgId` setting is honoured only if the
3294
- * Per Org URL feature is enabled on your ThoughtSpot instance.
3437
+ * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
3438
+ *
3439
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3440
+ * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
3441
+ * @default true
3295
3442
  * @example
3296
3443
  * ```js
3297
- * const embed = new LiveboardEmbed('#embed', {
3298
- * ... // other options
3299
- * overrideOrgId: 142536
3300
- * });
3444
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
3445
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3446
+ * ... // other embed view config
3447
+ * showLiveboardReverifyBanner: true,
3448
+ * })
3301
3449
  * ```
3302
- * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3303
3450
  */
3304
- overrideOrgId?: number;
3451
+ showLiveboardReverifyBanner?: boolean;
3305
3452
  /**
3306
- * Hide list page columns
3307
- * For example: hiddenListColumns = [ListPageColumns.Author]
3453
+ * enable or disable ask sage
3308
3454
  *
3309
- * **Note**: This option is available only in full app embedding.
3310
- * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3455
+ * Supported embed types: `AppEmbed`, `LiveboardEmbed`
3456
+ * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
3457
+ * @default false
3311
3458
  * @example
3312
3459
  * ```js
3313
- * const embed = new AppEmbed('#tsEmbed', {
3314
- * ... // other options
3315
- * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3460
+ * // Replace <EmbedComponent> with embed component name. For example, AppEmbed, SpotterEmbed, or LiveboardEmbed
3461
+ * const embed = new <EmbedComponent>('#tsEmbed', {
3462
+ * ... // other embed view config
3463
+ * enableAskSage:true,
3316
3464
  * })
3317
3465
  * ```
3318
3466
  */
3319
- hiddenListColumns?: ListPageColumns[];
3467
+ enableAskSage?: boolean;
3468
+ }
3469
+ export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
3320
3470
  }
3321
3471
  /**
3322
3472
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3709,7 +3859,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3709
3859
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
3710
3860
  * @example
3711
3861
  * ```js
3712
- * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
3862
+ * LiveboardEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
3713
3863
  * console.log('VizPointDoubleClick', payload);
3714
3864
  * })
3715
3865
  * ```
@@ -4568,7 +4718,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4568
4718
  * Emitted when a user creates a Model.
4569
4719
  * @version SDK : 1.37.0 | ThoughtSpot : 10.8.0.cl
4570
4720
  */
4571
- CreateModel = "createModel"
4721
+ CreateModel = "createModel",
4722
+ /**
4723
+ * @hidden
4724
+ * Emitted when a user exits present mode.
4725
+ * @version SDK : 1.40.0 | ThoughtSpot : 10.11.0.cl
4726
+ */
4727
+ ExitPresentMode = "exitPresentMode"
4572
4728
  }
4573
4729
  /**
4574
4730
  * Event types that can be triggered by the host application
@@ -5640,7 +5796,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5640
5796
  * ```
5641
5797
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
5642
5798
  */
5643
- TransformTableVizData = "TransformTableVizData"
5799
+ TransformTableVizData = "TransformTableVizData",
5800
+ /**
5801
+ * @hidden
5802
+ * Trigger exit from presentation mode when user exits fullscreen.
5803
+ * This is automatically triggered by the SDK when fullscreen mode is exited.
5804
+ * ```js
5805
+ * liveboardEmbed.trigger(HostEvent.ExitPresentMode);
5806
+ *```
5807
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5808
+ */
5809
+ ExitPresentMode = "exitPresentMode"
5644
5810
  }
5645
5811
  /**
5646
5812
  * The different visual modes that the data sources panel within
@@ -5772,7 +5938,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5772
5938
  ShowSpotterLimitations = "showSpotterLimitations",
5773
5939
  CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
5774
5940
  PrimaryAction = "primaryAction",
5775
- isSpotterAgentEmbed = "isSpotterAgentEmbed"
5941
+ isSpotterAgentEmbed = "isSpotterAgentEmbed",
5942
+ IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
5776
5943
  }
5777
5944
  /**
5778
5945
  * ThoughtSpot application pages include actions and menu commands
@@ -5783,8 +5950,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5783
5950
  * or `hiddenActions` array.
5784
5951
  * @example
5785
5952
  * ```js
5786
- * const embed = new LiveboardEmbed('#embed-container', {
5787
- * ... // other options
5953
+ * const embed = new LiveboardEmbed('#tsEmbed', {
5954
+ * ... //other embed view config
5788
5955
  * visibleActions: [Action.Save, Action.Edit, Action.Present, ActionAction.Explore],
5789
5956
  * disabledActions: [Action.Download],
5790
5957
  * //hiddenActions: [], // Set either this or visibleActions
@@ -5792,8 +5959,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5792
5959
  * ```
5793
5960
  * @example
5794
5961
  * ```js
5795
- * const embed = new LiveboardEmbed('#embed-container', {
5796
- * ... // other options
5962
+ * const embed = new LiveboardEmbed('#tsEmbed', {
5963
+ * ... //other embed view config
5797
5964
  * //visibleActions: [],
5798
5965
  * disabledActions: [Action.Download],
5799
5966
  * hiddenActions: [Action.Edit, ActionAction.Explore],
@@ -7065,7 +7232,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
7065
7232
  * @example
7066
7233
  * ```js
7067
7234
  * init({
7068
- * ... // other options,
7235
+ * ... //other embed view config,
7069
7236
  * logLevel: LogLevel.SILENT,
7070
7237
  * })
7071
7238
  * ```
@@ -7077,7 +7244,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
7077
7244
  * @example
7078
7245
  * ```js
7079
7246
  * init({
7080
- * ... // other options,
7247
+ * ... //other embed view config,
7081
7248
  * logLevel: LogLevel.ERROR,
7082
7249
  * })
7083
7250
  * ```
@@ -7089,7 +7256,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
7089
7256
  * @example
7090
7257
  * ```js
7091
7258
  * init({
7092
- * ... // other options,
7259
+ * ... //other embed view config,
7093
7260
  * logLevel: LogLevel.WARN,
7094
7261
  * })
7095
7262
  * ```
@@ -7102,7 +7269,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
7102
7269
  * @example
7103
7270
  * ```js
7104
7271
  * init({
7105
- * ... // other options,
7272
+ * ... //other embed view config,
7106
7273
  * logLevel: LogLevel.INFO,
7107
7274
  * })
7108
7275
  * ```
@@ -7115,7 +7282,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
7115
7282
  * @example
7116
7283
  * ```js
7117
7284
  * init({
7118
- * ... // other options,
7285
+ * ... //other embed view config,
7119
7286
  * logLevel: LogLevel.DEBUG,
7120
7287
  * })
7121
7288
  * ```
@@ -7127,7 +7294,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
7127
7294
  * @example
7128
7295
  * ```js
7129
7296
  * init({
7130
- * ... // other options,
7297
+ * ... //other embed view config,
7131
7298
  * logLevel: LogLevel.TRACE,
7132
7299
  * })
7133
7300
  * ```
@@ -7551,7 +7718,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
7551
7718
  * @summary TS Sage embed
7552
7719
  * @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
7553
7720
  */
7554
- import { DOMSelector, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
7721
+ import { DOMSelector, BaseViewConfig, SearchLiveboardCommonViewConfig } from '@thoughtspot/visual-embed-sdk/types';
7555
7722
  import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
7556
7723
  /**
7557
7724
  * Configuration for search options
@@ -7573,9 +7740,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
7573
7740
  * The configuration attributes for the embedded Natural language search view. Based on
7574
7741
  * GPT and LLM.
7575
7742
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
7743
+ *
7744
+ * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
7576
7745
  * @group Embed components
7577
7746
  */
7578
- export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
7747
+ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<BaseViewConfig, 'primaryAction' | 'runtimeFilters' | 'runtimeParameters' | 'excludeRuntimeFiltersfromURL' | 'excludeRuntimeParametersfromURL'> {
7579
7748
  /**
7580
7749
  * If set to true, a list of Liveboard and Answers related
7581
7750
  * to the natural language search will be shown below the
@@ -7633,7 +7802,16 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
7633
7802
  * Show or hide sample questions.
7634
7803
  * The sample questions are autogenerated based on the worksheet
7635
7804
  * selected for the search operation.
7805
+ *
7806
+ * Supported embed types: `SageEmbed`
7636
7807
  * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
7808
+ * @example
7809
+ * ```js
7810
+ * const embed = new SageEmbed('#tsEmbed', {
7811
+ * ... //other embed view config
7812
+ * hideSampleQuestions : true,
7813
+ * })
7814
+ * ```
7637
7815
  */
7638
7816
  hideSampleQuestions?: boolean;
7639
7817
  /**
@@ -7650,6 +7828,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
7650
7828
  * If it is executed, the focus is placed on the results.
7651
7829
  * If it’s not executed, the focus is placed at the end of
7652
7830
  * the token string in the search bar.
7831
+ *
7832
+ * Supported embed types: `SageEmbed`
7653
7833
  * @example
7654
7834
  * ```js
7655
7835
  * searchOptions: {
@@ -7664,6 +7844,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
7664
7844
  /**
7665
7845
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
7666
7846
  * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
7847
+ *
7848
+ * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
7667
7849
  * @group Embed components
7668
7850
  */
7669
7851
  export class SageEmbed extends V1Embed {
@@ -7719,12 +7901,13 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answer
7719
7901
  * directly from your application.
7720
7902
  *
7721
7903
  * You can use this service to:
7904
+ *
7722
7905
  * - Add or remove columns from Answers (`addColumns`, `removeColumns`, `addColumnsByName`)
7723
7906
  * - Apply filters to Answers (`addFilter`)
7724
7907
  * - Get data from Answers in different formats (JSON, CSV, PNG) (`fetchData`, `fetchCSVBlob`, `fetchPNGBlob`)
7725
7908
  * - Get data for specific points in visualizations (`getUnderlyingDataForPoint`)
7726
7909
  * - Run custom queries (`executeQuery`)
7727
- * - Add visualizations to liveboards (`addDisplayedVizToLiveboard`)
7910
+ * - Add visualizations to Liveboards (`addDisplayedVizToLiveboard`)
7728
7911
  *
7729
7912
  * @example
7730
7913
  * ```js
@@ -8112,7 +8295,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
8112
8295
  */
8113
8296
  import { TriggerPayload, TriggerResponse, UIPassthroughArrayResponse, UIPassthroughEvent, UIPassthroughRequest } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
8114
8297
  import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
8115
- import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig, DefaultAppInitData } from '@thoughtspot/visual-embed-sdk/types';
8298
+ import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, DefaultAppInitData, AllEmbedViewConfig as ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
8116
8299
  import { HostEventClient } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/host-event-client';
8117
8300
  /**
8118
8301
  * Global prefix for all Thoughtspot postHash Params.
@@ -8150,7 +8333,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
8150
8333
  * @param {HTMLIFrameElement} iFrame HTMLIFrameElement
8151
8334
  */
8152
8335
  protected setIframeElement(iFrame: HTMLIFrameElement): void;
8153
- protected viewConfig: ViewConfig;
8336
+ protected viewConfig: ViewConfig & {
8337
+ visibleTabs?: string[];
8338
+ hiddenTabs?: string[];
8339
+ showAlerts?: boolean;
8340
+ };
8154
8341
  protected embedConfig: EmbedConfig;
8155
8342
  /**
8156
8343
  * The ThoughtSpot hostname or IP address