@thoughtspot/visual-embed-sdk 1.37.1-spotter-embed → 1.38.0-alpha.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 (161) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +2 -2
  3. package/cjs/src/embed/app.d.ts +43 -3
  4. package/cjs/src/embed/app.d.ts.map +1 -1
  5. package/cjs/src/embed/app.js +40 -7
  6. package/cjs/src/embed/app.js.map +1 -1
  7. package/cjs/src/embed/app.spec.js +23 -6
  8. package/cjs/src/embed/app.spec.js.map +1 -1
  9. package/cjs/src/embed/base.d.ts.map +1 -1
  10. package/cjs/src/embed/base.js +7 -0
  11. package/cjs/src/embed/base.js.map +1 -1
  12. package/cjs/src/embed/bodyless-conversation.d.ts +8 -3
  13. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  14. package/cjs/src/embed/bodyless-conversation.js +5 -2
  15. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  16. package/cjs/src/embed/bodyless-conversation.spec.js +286 -1
  17. package/cjs/src/embed/bodyless-conversation.spec.js.map +1 -1
  18. package/cjs/src/embed/conversation.d.ts +5 -3
  19. package/cjs/src/embed/conversation.d.ts.map +1 -1
  20. package/cjs/src/embed/conversation.js +3 -2
  21. package/cjs/src/embed/conversation.js.map +1 -1
  22. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  23. package/cjs/src/embed/liveboard.js +21 -10
  24. package/cjs/src/embed/liveboard.js.map +1 -1
  25. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  26. package/cjs/src/embed/ts-embed.js +6 -4
  27. package/cjs/src/embed/ts-embed.js.map +1 -1
  28. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  29. package/cjs/src/embed/ts-embed.spec.js +105 -0
  30. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  31. package/cjs/src/index.d.ts +4 -4
  32. package/cjs/src/index.d.ts.map +1 -1
  33. package/cjs/src/index.js +5 -3
  34. package/cjs/src/index.js.map +1 -1
  35. package/cjs/src/react/all-types-export.d.ts +1 -1
  36. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  37. package/cjs/src/react/all-types-export.js +2 -1
  38. package/cjs/src/react/all-types-export.js.map +1 -1
  39. package/cjs/src/react/index.d.ts +32 -3
  40. package/cjs/src/react/index.d.ts.map +1 -1
  41. package/cjs/src/react/index.js +54 -2
  42. package/cjs/src/react/index.js.map +1 -1
  43. package/cjs/src/react/index.spec.js +94 -0
  44. package/cjs/src/react/index.spec.js.map +1 -1
  45. package/cjs/src/types.d.ts +25 -51
  46. package/cjs/src/types.d.ts.map +1 -1
  47. package/cjs/src/types.js +24 -50
  48. package/cjs/src/types.js.map +1 -1
  49. package/dist/{index-Cj4BVGHL.js → index-DeFzsyFF.js} +1 -1
  50. package/dist/{index-DnIvX1FR.js → index-NZYq1Tu3.js} +1 -2
  51. package/dist/src/embed/app.d.ts +43 -3
  52. package/dist/src/embed/app.d.ts.map +1 -1
  53. package/dist/src/embed/base.d.ts.map +1 -1
  54. package/dist/src/embed/bodyless-conversation.d.ts +8 -3
  55. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  56. package/dist/src/embed/conversation.d.ts +5 -3
  57. package/dist/src/embed/conversation.d.ts.map +1 -1
  58. package/dist/src/embed/liveboard.d.ts.map +1 -1
  59. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  60. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  61. package/dist/src/index.d.ts +4 -4
  62. package/dist/src/index.d.ts.map +1 -1
  63. package/dist/src/react/all-types-export.d.ts +1 -1
  64. package/dist/src/react/all-types-export.d.ts.map +1 -1
  65. package/dist/src/react/index.d.ts +32 -3
  66. package/dist/src/react/index.d.ts.map +1 -1
  67. package/dist/src/types.d.ts +25 -51
  68. package/dist/src/types.d.ts.map +1 -1
  69. package/dist/tsembed-react.es.js +614 -77
  70. package/dist/tsembed-react.js +758 -296
  71. package/dist/tsembed.es.js +153 -75
  72. package/dist/tsembed.js +297 -295
  73. package/dist/visual-embed-sdk-react-full.d.ts +194 -145
  74. package/dist/visual-embed-sdk-react.d.ts +194 -145
  75. package/dist/visual-embed-sdk.d.ts +82 -61
  76. package/lib/package.json +2 -2
  77. package/lib/src/embed/app.d.ts +43 -3
  78. package/lib/src/embed/app.d.ts.map +1 -1
  79. package/lib/src/embed/app.js +39 -6
  80. package/lib/src/embed/app.js.map +1 -1
  81. package/lib/src/embed/app.spec.js +24 -7
  82. package/lib/src/embed/app.spec.js.map +1 -1
  83. package/lib/src/embed/base.d.ts.map +1 -1
  84. package/lib/src/embed/base.js +7 -0
  85. package/lib/src/embed/base.js.map +1 -1
  86. package/lib/src/embed/bodyless-conversation.d.ts +8 -3
  87. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  88. package/lib/src/embed/bodyless-conversation.js +5 -2
  89. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  90. package/lib/src/embed/bodyless-conversation.spec.js +287 -2
  91. package/lib/src/embed/bodyless-conversation.spec.js.map +1 -1
  92. package/lib/src/embed/conversation.d.ts +5 -3
  93. package/lib/src/embed/conversation.d.ts.map +1 -1
  94. package/lib/src/embed/conversation.js +3 -2
  95. package/lib/src/embed/conversation.js.map +1 -1
  96. package/lib/src/embed/liveboard.d.ts.map +1 -1
  97. package/lib/src/embed/liveboard.js +21 -10
  98. package/lib/src/embed/liveboard.js.map +1 -1
  99. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  100. package/lib/src/embed/ts-embed.js +6 -4
  101. package/lib/src/embed/ts-embed.js.map +1 -1
  102. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  103. package/lib/src/embed/ts-embed.spec.js +105 -0
  104. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  105. package/lib/src/index.d.ts +4 -4
  106. package/lib/src/index.d.ts.map +1 -1
  107. package/lib/src/index.js +4 -4
  108. package/lib/src/index.js.map +1 -1
  109. package/lib/src/react/all-types-export.d.ts +1 -1
  110. package/lib/src/react/all-types-export.d.ts.map +1 -1
  111. package/lib/src/react/all-types-export.js +1 -1
  112. package/lib/src/react/all-types-export.js.map +1 -1
  113. package/lib/src/react/index.d.ts +32 -3
  114. package/lib/src/react/index.d.ts.map +1 -1
  115. package/lib/src/react/index.js +53 -1
  116. package/lib/src/react/index.js.map +1 -1
  117. package/lib/src/react/index.spec.js +96 -2
  118. package/lib/src/react/index.spec.js.map +1 -1
  119. package/lib/src/types.d.ts +25 -51
  120. package/lib/src/types.d.ts.map +1 -1
  121. package/lib/src/types.js +24 -50
  122. package/lib/src/types.js.map +1 -1
  123. package/lib/src/visual-embed-sdk.d.ts +85 -64
  124. package/package.json +2 -2
  125. package/src/embed/app.spec.ts +30 -6
  126. package/src/embed/app.ts +62 -9
  127. package/src/embed/base.ts +9 -0
  128. package/src/embed/bodyless-conversation.spec.ts +308 -1
  129. package/src/embed/bodyless-conversation.ts +13 -3
  130. package/src/embed/conversation.ts +5 -3
  131. package/src/embed/liveboard.ts +25 -10
  132. package/src/embed/ts-embed.spec.ts +130 -0
  133. package/src/embed/ts-embed.ts +6 -4
  134. package/src/index.ts +10 -3
  135. package/src/react/all-types-export.ts +1 -0
  136. package/src/react/index.spec.tsx +157 -1
  137. package/src/react/index.tsx +64 -3
  138. package/src/types.ts +24 -56
  139. package/cjs/src/pages/embed-test.page.d.ts +0 -8
  140. package/cjs/src/pages/embed-test.page.d.ts.map +0 -1
  141. package/cjs/src/pages/embed-test.page.js +0 -20
  142. package/cjs/src/pages/embed-test.page.js.map +0 -1
  143. package/cjs/src/pages/home.page.d.ts +0 -6
  144. package/cjs/src/pages/home.page.d.ts.map +0 -1
  145. package/cjs/src/pages/home.page.js +0 -12
  146. package/cjs/src/pages/home.page.js.map +0 -1
  147. package/cjs/src/pages/login.page.d.ts +0 -15
  148. package/cjs/src/pages/login.page.d.ts.map +0 -1
  149. package/cjs/src/pages/login.page.js +0 -22
  150. package/cjs/src/pages/login.page.js.map +0 -1
  151. package/cjs/src/tests/auth.test.d.ts +0 -1
  152. package/cjs/src/tests/auth.test.d.ts.map +0 -1
  153. package/cjs/src/tests/auth.test.js +0 -1
  154. package/cjs/src/tests/auth.test.js.map +0 -1
  155. package/cjs/src/tests/e2e/auth.spec.d.ts +0 -2
  156. package/cjs/src/tests/e2e/auth.spec.d.ts.map +0 -1
  157. package/cjs/src/tests/e2e/auth.spec.js +0 -54
  158. package/cjs/src/tests/e2e/auth.spec.js.map +0 -1
  159. package/dist/index-DUaG1OG2.js +0 -7447
  160. package/dist/index-Fhk1V_Gw.js +0 -7371
  161. package/dist/index-OuiZF3zE.js +0 -7371
@@ -217,7 +217,8 @@ interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
217
217
  export const SpotterEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & React.RefAttributes<_SpotterEmbed>>;
218
218
  /**
219
219
  * React component for LLM based conversation BI.
220
- * @deprecated This component is renamed to SpotterEmbed. Use {@link SpotterEmbed} instead.
220
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
221
+ * Use {@link SpotterEmbed} instead
221
222
  * @example
222
223
  * ```tsx
223
224
  * function Sage() {
@@ -232,6 +233,33 @@ export const SpotterEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & R
232
233
  * ```
233
234
  */
234
235
  export const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbedProps & React.RefAttributes<_ConversationEmbed>>;
236
+ interface SpotterAgentEmbedProps extends EmbedProps, SpotterAgentEmbedViewConfig {
237
+ }
238
+ /**
239
+ * React component for SpotterAgent embed, which can be integrated inside
240
+ * chatbots or other conversational interfaces.
241
+ * @example
242
+ * ```tsx
243
+ * function SpotterAgent() {
244
+ * const ref = useRef();
245
+ *
246
+ * const handleSendMessage = async () => {
247
+ * const { container, error } = await ref.current.sendMessage('show me sales by region');
248
+ * if (container) {
249
+ * document.body.appendChild(container);
250
+ * }
251
+ * };
252
+ *
253
+ * return (
254
+ * <div>
255
+ * <SpotterAgentEmbed ref={ref} worksheetId="worksheetId" />
256
+ * <button onClick={handleSendMessage}>Send Message</button>
257
+ * </div>
258
+ * );
259
+ * }
260
+ * ```
261
+ */
262
+ export const SpotterAgentEmbed: React.ForwardRefExoticComponent<SpotterAgentEmbedProps & React.RefAttributes<_SpotterAgentEmbed>>;
235
263
  /**
236
264
  * React component for PreRendered Conversation embed.
237
265
  *
@@ -251,7 +279,7 @@ export const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbe
251
279
  * ```
252
280
  */
253
281
  export const PreRenderedConversationEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & PreRenderProps & React.RefAttributes<_SpotterEmbed>>;
254
- type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed | typeof SpotterEmbed | typeof ConversationEmbed;
282
+ type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed | typeof SpotterAgentEmbed | typeof SpotterEmbed | typeof ConversationEmbed;
255
283
  /**
256
284
  * Get a reference to the embed component to trigger events on the component.
257
285
  * @example
@@ -1086,6 +1114,43 @@ export declare enum HomePageSearchBarMode {
1086
1114
  AI_ANSWER = "aiAnswer",
1087
1115
  NONE = "none"
1088
1116
  }
1117
+ /**
1118
+ * Define the version of the primary navbar
1119
+ * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1120
+ */
1121
+ export declare enum PrimaryNavbarVersion {
1122
+ /**
1123
+ * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
1124
+ * along with updates to the top navigation bar.
1125
+ * It serves as the foundational version of the PrimaryNavBar.
1126
+ */
1127
+ Sliding = "v3"
1128
+ }
1129
+ /**
1130
+ * Define the version of the home page
1131
+ * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1132
+ */
1133
+ export declare enum HomePage {
1134
+ /**
1135
+ * Modular (v2) introduces the updated Modular Home Experience.
1136
+ * It serves as the foundational version of the home page.
1137
+ */
1138
+ Modular = "v2"
1139
+ }
1140
+ /**
1141
+ * Define the discovery experience
1142
+ * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
1143
+ */
1144
+ export interface DiscoveryExperience {
1145
+ /**
1146
+ * primaryNavbarVersion determines the version of the navigation version.
1147
+ */
1148
+ primaryNavbarVersion?: PrimaryNavbarVersion;
1149
+ /**
1150
+ * homePage determines the version of the home page.
1151
+ */
1152
+ homePage?: HomePage;
1153
+ }
1089
1154
  /**
1090
1155
  * The view configuration for full app embedding.
1091
1156
  * @group Embed components
@@ -1393,7 +1458,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1393
1458
  */
1394
1459
  modularHomeExperience?: boolean;
1395
1460
  /**
1396
- * Flag to control new navigation v3 home experience.
1461
+ * To configure the top-left navigation and home page experience
1397
1462
  *
1398
1463
  * @default false
1399
1464
  * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
@@ -1401,11 +1466,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1401
1466
  * ```js
1402
1467
  * const embed = new AppEmbed('#tsEmbed', {
1403
1468
  * ... // other options
1404
- * modularHomeExperienceV3 : true,
1469
+ * discoveryExperience : {
1470
+ * primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
1471
+ * homePage: HompePage.Modular,
1472
+ * },
1405
1473
  * })
1406
1474
  * ```
1407
1475
  */
1408
- modularHomeExperienceV3?: boolean;
1476
+ discoveryExperience?: DiscoveryExperience;
1409
1477
  /**
1410
1478
  * Boolean to control if Liveboard header is sticky or not.
1411
1479
  * @example
@@ -2017,6 +2085,96 @@ export declare class LiveboardEmbed extends V1Embed {
2017
2085
  export declare class PinboardEmbed extends LiveboardEmbed {
2018
2086
  }
2019
2087
 
2088
+ /**
2089
+ * Configuration for bodyless conversation options.
2090
+ * @group Embed components
2091
+ */
2092
+ export interface SpotterAgentEmbedViewConfig extends ViewConfig {
2093
+ /**
2094
+ * The ID of the worksheet to use for the conversation.
2095
+ */
2096
+ worksheetId: string;
2097
+ /**
2098
+ * Optional CSS class name to add to the container div.
2099
+ */
2100
+ containerClassName?: string;
2101
+ }
2102
+ /**
2103
+ * Configuration for conversation options.
2104
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
2105
+ * Use {@link SpotterAgentEmbedViewConfig} instead
2106
+ * @group Embed components
2107
+ */
2108
+ export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
2109
+ }
2110
+ interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
2111
+ sessionId: string;
2112
+ genNo: number;
2113
+ acSessionId: string;
2114
+ acGenNo: number;
2115
+ }
2116
+ declare class ConversationMessage extends TsEmbed {
2117
+ protected viewConfig: SpotterAgentMessageViewConfig;
2118
+ constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
2119
+ getIframeSrc(): string;
2120
+ render(): Promise<ConversationMessage>;
2121
+ }
2122
+ /**
2123
+ * Create a conversation embed, which can be integrated inside
2124
+ * chatbots or other conversational interfaces.
2125
+ * @example
2126
+ * ```js
2127
+ * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
2128
+ *
2129
+ * const conversation = new SpotterAgentEmbed({
2130
+ * worksheetId: 'worksheetId',
2131
+ * });
2132
+ *
2133
+ * const { container, error } = await conversation.sendMessage('show me sales by region');
2134
+ *
2135
+ * // append the container to the DOM
2136
+ * document.body.appendChild(container); // or to any other element
2137
+ * ```
2138
+ * @group Embed components
2139
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2140
+ */
2141
+ export declare class SpotterAgentEmbed {
2142
+ constructor(viewConfig: SpotterAgentEmbedViewConfig);
2143
+ sendMessage(userMessage: string): Promise<{
2144
+ error: any;
2145
+ container?: undefined;
2146
+ viz?: undefined;
2147
+ } | {
2148
+ container: HTMLDivElement;
2149
+ viz: ConversationMessage;
2150
+ error?: undefined;
2151
+ }>;
2152
+ }
2153
+ /**
2154
+ * Create a conversation embed, which can be integrated inside
2155
+ * chatbots or other conversational interfaces.
2156
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
2157
+ * Use {@link SpotterAgentEmbed} instead
2158
+ * @example
2159
+ * ```js
2160
+ * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
2161
+ *
2162
+ * const conversation = new SpotterAgentEmbed({
2163
+ * worksheetId: 'worksheetId',
2164
+ * });
2165
+ *
2166
+ * const { container, error } = await conversation.sendMessage('show me sales by region');
2167
+ *
2168
+ * // append the container to the DOM
2169
+ * document.body.appendChild(container); // or to any other element
2170
+ * ```
2171
+ * @group Embed components
2172
+ */
2173
+ export declare class BodylessConversation extends SpotterAgentEmbed {
2174
+ constructor(viewConfig: BodylessConversationViewConfig);
2175
+ }
2176
+ export {};
2177
+
2020
2178
  /**
2021
2179
  * Copyright (c) 2023
2022
2180
  *
@@ -4642,9 +4800,12 @@ export declare enum HostEvent {
4642
4800
  * @example
4643
4801
  * ```js
4644
4802
  * searchEmbed.trigger(HostEvent.OpenFilter,
4645
- * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
4803
+ * {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
4804
+ * ```
4805
+ * @example
4806
+ * ```js
4646
4807
  * LiveboardEmbed.trigger(HostEvent.OpenFilter,
4647
- * { columnId: '<column-GUID>'})
4808
+ * { column: {columnId: '<column-GUID>'}})
4648
4809
  * ```
4649
4810
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4650
4811
  */
@@ -5253,6 +5414,25 @@ export declare enum HostEvent {
5253
5414
  * }]
5254
5415
  * });
5255
5416
  * ```
5417
+ * If there are multiple columns with the same name, consider
5418
+ * using `WORKSHEET_NAME::COLUMN_NAME` format.
5419
+ *
5420
+ * @example
5421
+ *
5422
+ * ```js
5423
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
5424
+ * filters: [{
5425
+ * column: "(Sample) Retail - Apparel::city",
5426
+ * oper: 'IN',
5427
+ * values: ["atlanta"]
5428
+ * },
5429
+ * {
5430
+ * column: "(Sample) Retail - Apparel::Region",
5431
+ * oper: 'IN',
5432
+ * values: ["West","Midwest"]
5433
+ * }]
5434
+ * });
5435
+ * ```
5256
5436
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5257
5437
  */
5258
5438
  UpdateFilters = "updateFilters",
@@ -5461,55 +5641,7 @@ export declare enum HostEvent {
5461
5641
  * ```
5462
5642
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
5463
5643
  */
5464
- TransformTableVizData = "TransformTableVizData",
5465
- /**
5466
- * Triggers the table visualization re-render with the updated data.
5467
- * Includes the following properties:
5468
- * @param - `columnDataLite` - an array of object containing the
5469
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5470
- * payload.For example, { columnDataLite: []}`.
5471
- */
5472
- SpotterSearch = "SpotterSearch",
5473
- /**
5474
- * Triggers the table visualization re-render with the updated data.
5475
- * Includes the following properties:
5476
- * @param - `columnDataLite` - an array of object containing the
5477
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5478
- * payload.For example, { columnDataLite: []}`.
5479
- */
5480
- EditLastPrompt = "EditLastPrompt",
5481
- /**
5482
- * Triggers the table visualization re-render with the updated data.
5483
- * Includes the following properties:
5484
- * @param - `columnDataLite` - an array of object containing the
5485
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5486
- * payload.For example, { columnDataLite: []}`.
5487
- */
5488
- PreviewSpotterData = "PreviewSpotterData",
5489
- /**
5490
- * Triggers the table visualization re-render with the updated data.
5491
- * Includes the following properties:
5492
- * @param - `columnDataLite` - an array of object containing the
5493
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5494
- * payload.For example, { columnDataLite: []}`.
5495
- */
5496
- ResetSpotterConversation = "ResetSpotterConversation",
5497
- /**
5498
- * Triggers the table visualization re-render with the updated data.
5499
- * Includes the following properties:
5500
- * @param - `columnDataLite` - an array of object containing the
5501
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5502
- * payload.For example, { columnDataLite: []}`.
5503
- */
5504
- DeleteLastPrompt = "DeleteLastPrompt",
5505
- /**
5506
- * Triggers the table visualization re-render with the updated data.
5507
- * Includes the following properties:
5508
- * @param - `columnDataLite` - an array of object containing the
5509
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5510
- * payload.For example, { columnDataLite: []}`.
5511
- */
5512
- AnswerChartSwitcher = "answerChartSwitcher"
5644
+ TransformTableVizData = "TransformTableVizData"
5513
5645
  }
5514
5646
  /**
5515
5647
  * The different visual modes that the data sources panel within
@@ -7126,7 +7258,8 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
7126
7258
  }
7127
7259
  /**
7128
7260
  * The configuration for the embedded spotterEmbed options.
7129
- * @deprecated Renamed to SpotterEmbedViewConfig
7261
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
7262
+ * Use {@link SpotterEmbedViewConfig} instead
7130
7263
  * @group Embed components
7131
7264
  */
7132
7265
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
@@ -7144,7 +7277,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
7144
7277
  * });
7145
7278
  * conversation.render();
7146
7279
  * ```
7147
- * @version SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
7280
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
7148
7281
  */
7149
7282
  export declare class SpotterEmbed extends TsEmbed {
7150
7283
  protected viewConfig: SpotterEmbedViewConfig;
@@ -7154,7 +7287,8 @@ export declare class SpotterEmbed extends TsEmbed {
7154
7287
  }
7155
7288
  /**
7156
7289
  * Embed ThoughtSpot AI Conversation.
7157
- * @deprecated Renamed to SpotterEmbed
7290
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
7291
+ * Use {@link SpotterEmbed} instead
7158
7292
  * @group Embed components
7159
7293
  * @example
7160
7294
  * ```js
@@ -7181,7 +7315,7 @@ export declare class ConversationEmbed extends SpotterEmbed {
7181
7315
  * @summary ThoughtSpot Visual Embed SDK
7182
7316
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
7183
7317
  */
7184
- 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, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
7318
+ 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, };
7185
7319
 
7186
7320
  /**
7187
7321
  * Copyright (c) 2022
@@ -8297,91 +8431,6 @@ export declare const exportTML: (data: exportTMLInput) => Promise<any>;
8297
8431
  */
8298
8432
  export declare function reset(): void;
8299
8433
 
8300
- /**
8301
- * Configuration for bodyless conversation options.
8302
- * @group Embed components
8303
- */
8304
- export interface SpotterAgentEmbedViewConfig extends ViewConfig {
8305
- /**
8306
- * The ID of the worksheet to use for the conversation.
8307
- */
8308
- worksheetId: string;
8309
- }
8310
- /**
8311
- * Configuration for conversation options.
8312
- * @deprecated Renamed to SpotterAgentEmbedViewConfig
8313
- * @group Embed components
8314
- */
8315
- export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
8316
- }
8317
- interface SpotterAgentMessageViewConfig extends SpotterAgentEmbedViewConfig {
8318
- sessionId: string;
8319
- genNo: number;
8320
- acSessionId: string;
8321
- acGenNo: number;
8322
- }
8323
- declare class ConversationMessage extends TsEmbed {
8324
- protected viewConfig: SpotterAgentMessageViewConfig;
8325
- constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
8326
- getIframeSrc(): string;
8327
- render(): Promise<ConversationMessage>;
8328
- }
8329
- /**
8330
- * Create a conversation embed, which can be integrated inside
8331
- * chatbots or other conversational interfaces.
8332
- * @example
8333
- * ```js
8334
- * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
8335
- *
8336
- * const conversation = new SpotterAgentEmbed({
8337
- * worksheetId: 'worksheetId',
8338
- * });
8339
- *
8340
- * const { container, error } = await conversation.sendMessage('show me sales by region');
8341
- *
8342
- * // append the container to the DOM
8343
- * document.body.appendChild(container); // or to any other element
8344
- * ```
8345
- * @group Embed components
8346
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
8347
- */
8348
- export declare class SpotterAgentEmbed {
8349
- constructor(viewConfig: SpotterAgentEmbedViewConfig);
8350
- sendMessage(userMessage: string): Promise<{
8351
- error: any;
8352
- container?: undefined;
8353
- viz?: undefined;
8354
- } | {
8355
- container: HTMLDivElement;
8356
- viz: ConversationMessage;
8357
- error?: undefined;
8358
- }>;
8359
- }
8360
- /**
8361
- * Create a conversation embed, which can be integrated inside
8362
- * chatbots or other conversational interfaces.
8363
- * @deprecated Renamed to SpotterAgentEmbed
8364
- * @example
8365
- * ```js
8366
- * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
8367
- *
8368
- * const conversation = new SpotterAgentEmbed({
8369
- * worksheetId: 'worksheetId',
8370
- * });
8371
- *
8372
- * const { container, error } = await conversation.sendMessage('show me sales by region');
8373
- *
8374
- * // append the container to the DOM
8375
- * document.body.appendChild(container); // or to any other element
8376
- * ```
8377
- * @group Embed components
8378
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
8379
- */
8380
- export declare class BodylessConversation extends SpotterAgentEmbed {
8381
- constructor(viewConfig: BodylessConversationViewConfig);
8382
- }
8383
- export {};
8384
-
8385
8434
  export type SessionInfo = {
8386
8435
  releaseVersion: string;
8387
8436
  userGUID: string;
@@ -12,7 +12,7 @@ import EventEmitter from 'eventemitter3';
12
12
  * @summary ThoughtSpot Visual Embed SDK
13
13
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
14
14
  */
15
- 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, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
15
+ 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, };
16
16
 
17
17
  /**
18
18
  * Copyright (c) 2022
@@ -83,6 +83,43 @@ export enum HomePageSearchBarMode {
83
83
  AI_ANSWER = "aiAnswer",
84
84
  NONE = "none"
85
85
  }
86
+ /**
87
+ * Define the version of the primary navbar
88
+ * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
89
+ */
90
+ export enum PrimaryNavbarVersion {
91
+ /**
92
+ * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
93
+ * along with updates to the top navigation bar.
94
+ * It serves as the foundational version of the PrimaryNavBar.
95
+ */
96
+ Sliding = "v3"
97
+ }
98
+ /**
99
+ * Define the version of the home page
100
+ * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
101
+ */
102
+ export enum HomePage {
103
+ /**
104
+ * Modular (v2) introduces the updated Modular Home Experience.
105
+ * It serves as the foundational version of the home page.
106
+ */
107
+ Modular = "v2"
108
+ }
109
+ /**
110
+ * Define the discovery experience
111
+ * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
112
+ */
113
+ export interface DiscoveryExperience {
114
+ /**
115
+ * primaryNavbarVersion determines the version of the navigation version.
116
+ */
117
+ primaryNavbarVersion?: PrimaryNavbarVersion;
118
+ /**
119
+ * homePage determines the version of the home page.
120
+ */
121
+ homePage?: HomePage;
122
+ }
86
123
  /**
87
124
  * The view configuration for full app embedding.
88
125
  * @group Embed components
@@ -390,7 +427,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
390
427
  */
391
428
  modularHomeExperience?: boolean;
392
429
  /**
393
- * Flag to control new navigation v3 home experience.
430
+ * To configure the top-left navigation and home page experience
394
431
  *
395
432
  * @default false
396
433
  * @version SDK: 1.39.0 | Thoughtspot: 10.10.0.cl
@@ -398,11 +435,14 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
398
435
  * ```js
399
436
  * const embed = new AppEmbed('#tsEmbed', {
400
437
  * ... // other options
401
- * modularHomeExperienceV3 : true,
438
+ * discoveryExperience : {
439
+ * primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
440
+ * homePage: HompePage.Modular,
441
+ * },
402
442
  * })
403
443
  * ```
404
444
  */
405
- modularHomeExperienceV3?: boolean;
445
+ discoveryExperience?: DiscoveryExperience;
406
446
  /**
407
447
  * Boolean to control if Liveboard header is sticky or not.
408
448
  * @example
@@ -1571,10 +1611,15 @@ export interface SpotterAgentEmbedViewConfig extends ViewConfig {
1571
1611
  * The ID of the worksheet to use for the conversation.
1572
1612
  */
1573
1613
  worksheetId: string;
1614
+ /**
1615
+ * Optional CSS class name to add to the container div.
1616
+ */
1617
+ containerClassName?: string;
1574
1618
  }
1575
1619
  /**
1576
1620
  * Configuration for conversation options.
1577
- * @deprecated Renamed to SpotterAgentEmbedViewConfig
1621
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1622
+ * Use {@link SpotterAgentEmbedViewConfig} instead
1578
1623
  * @group Embed components
1579
1624
  */
1580
1625
  export interface BodylessConversationViewConfig extends SpotterAgentEmbedViewConfig {
@@ -1625,7 +1670,8 @@ export class SpotterAgentEmbed {
1625
1670
  /**
1626
1671
  * Create a conversation embed, which can be integrated inside
1627
1672
  * chatbots or other conversational interfaces.
1628
- * @deprecated Renamed to SpotterAgentEmbed
1673
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1674
+ * Use {@link SpotterAgentEmbed} instead
1629
1675
  * @example
1630
1676
  * ```js
1631
1677
  * import { SpotterAgentEmbed } from '@thoughtspot/visual-embed-sdk';
@@ -1640,7 +1686,6 @@ export class SpotterAgentEmbed {
1640
1686
  * document.body.appendChild(container); // or to any other element
1641
1687
  * ```
1642
1688
  * @group Embed components
1643
- * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
1644
1689
  */
1645
1690
  export class BodylessConversation extends SpotterAgentEmbed {
1646
1691
  constructor(viewConfig: BodylessConversationViewConfig);
@@ -1737,7 +1782,8 @@ export interface SpotterEmbedViewConfig extends ViewConfig {
1737
1782
  }
1738
1783
  /**
1739
1784
  * The configuration for the embedded spotterEmbed options.
1740
- * @deprecated Renamed to SpotterEmbedViewConfig
1785
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1786
+ * Use {@link SpotterEmbedViewConfig} instead
1741
1787
  * @group Embed components
1742
1788
  */
1743
1789
  export interface ConversationViewConfig extends SpotterEmbedViewConfig {
@@ -1755,7 +1801,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
1755
1801
  * });
1756
1802
  * conversation.render();
1757
1803
  * ```
1758
- * @version SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1804
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
1759
1805
  */
1760
1806
  export class SpotterEmbed extends TsEmbed {
1761
1807
  protected viewConfig: SpotterEmbedViewConfig;
@@ -1765,7 +1811,8 @@ export class SpotterEmbed extends TsEmbed {
1765
1811
  }
1766
1812
  /**
1767
1813
  * Embed ThoughtSpot AI Conversation.
1768
- * @deprecated Renamed to SpotterEmbed
1814
+ * @deprecated from SDK: 1.38.0 | ThoughtSpot: 10.10.0.cl
1815
+ * Use {@link SpotterEmbed} instead
1769
1816
  * @group Embed components
1770
1817
  * @example
1771
1818
  * ```js
@@ -4693,9 +4740,12 @@ export enum HostEvent {
4693
4740
  * @example
4694
4741
  * ```js
4695
4742
  * searchEmbed.trigger(HostEvent.OpenFilter,
4696
- * { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'})
4743
+ * {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
4744
+ * ```
4745
+ * @example
4746
+ * ```js
4697
4747
  * LiveboardEmbed.trigger(HostEvent.OpenFilter,
4698
- * { columnId: '<column-GUID>'})
4748
+ * { column: {columnId: '<column-GUID>'}})
4699
4749
  * ```
4700
4750
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4701
4751
  */
@@ -5304,6 +5354,25 @@ export enum HostEvent {
5304
5354
  * }]
5305
5355
  * });
5306
5356
  * ```
5357
+ * If there are multiple columns with the same name, consider
5358
+ * using `WORKSHEET_NAME::COLUMN_NAME` format.
5359
+ *
5360
+ * @example
5361
+ *
5362
+ * ```js
5363
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
5364
+ * filters: [{
5365
+ * column: "(Sample) Retail - Apparel::city",
5366
+ * oper: 'IN',
5367
+ * values: ["atlanta"]
5368
+ * },
5369
+ * {
5370
+ * column: "(Sample) Retail - Apparel::Region",
5371
+ * oper: 'IN',
5372
+ * values: ["West","Midwest"]
5373
+ * }]
5374
+ * });
5375
+ * ```
5307
5376
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
5308
5377
  */
5309
5378
  UpdateFilters = "updateFilters",
@@ -5512,55 +5581,7 @@ export enum HostEvent {
5512
5581
  * ```
5513
5582
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
5514
5583
  */
5515
- TransformTableVizData = "TransformTableVizData",
5516
- /**
5517
- * Triggers the table visualization re-render with the updated data.
5518
- * Includes the following properties:
5519
- * @param - `columnDataLite` - an array of object containing the
5520
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5521
- * payload.For example, { columnDataLite: []}`.
5522
- */
5523
- SpotterSearch = "SpotterSearch",
5524
- /**
5525
- * Triggers the table visualization re-render with the updated data.
5526
- * Includes the following properties:
5527
- * @param - `columnDataLite` - an array of object containing the
5528
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5529
- * payload.For example, { columnDataLite: []}`.
5530
- */
5531
- EditLastPrompt = "EditLastPrompt",
5532
- /**
5533
- * Triggers the table visualization re-render with the updated data.
5534
- * Includes the following properties:
5535
- * @param - `columnDataLite` - an array of object containing the
5536
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5537
- * payload.For example, { columnDataLite: []}`.
5538
- */
5539
- PreviewSpotterData = "PreviewSpotterData",
5540
- /**
5541
- * Triggers the table visualization re-render with the updated data.
5542
- * Includes the following properties:
5543
- * @param - `columnDataLite` - an array of object containing the
5544
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5545
- * payload.For example, { columnDataLite: []}`.
5546
- */
5547
- ResetSpotterConversation = "ResetSpotterConversation",
5548
- /**
5549
- * Triggers the table visualization re-render with the updated data.
5550
- * Includes the following properties:
5551
- * @param - `columnDataLite` - an array of object containing the
5552
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5553
- * payload.For example, { columnDataLite: []}`.
5554
- */
5555
- DeleteLastPrompt = "DeleteLastPrompt",
5556
- /**
5557
- * Triggers the table visualization re-render with the updated data.
5558
- * Includes the following properties:
5559
- * @param - `columnDataLite` - an array of object containing the
5560
- * data value modifications retrieved from the `EmbedEvent.TableVizRendered`
5561
- * payload.For example, { columnDataLite: []}`.
5562
- */
5563
- AnswerChartSwitcher = "answerChartSwitcher"
5584
+ TransformTableVizData = "TransformTableVizData"
5564
5585
  }
5565
5586
  /**
5566
5587
  * The different visual modes that the data sources panel within