@thoughtspot/visual-embed-sdk 1.40.1-alpha.1 → 1.41.0-pre-render-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 (150) hide show
  1. package/cjs/package.json +5 -4
  2. package/cjs/src/css-variables.d.ts +316 -0
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts.map +1 -1
  5. package/cjs/src/embed/app.js +8 -0
  6. package/cjs/src/embed/app.js.map +1 -1
  7. package/cjs/src/embed/app.spec.js +12 -2
  8. package/cjs/src/embed/app.spec.js.map +1 -1
  9. package/cjs/src/embed/bodyless-conversation.d.ts +1 -0
  10. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  11. package/cjs/src/embed/bodyless-conversation.js +7 -3
  12. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  13. package/cjs/src/embed/conversation.d.ts +64 -2
  14. package/cjs/src/embed/conversation.d.ts.map +1 -1
  15. package/cjs/src/embed/conversation.js +16 -3
  16. package/cjs/src/embed/conversation.js.map +1 -1
  17. package/cjs/src/embed/conversation.spec.js +102 -0
  18. package/cjs/src/embed/conversation.spec.js.map +1 -1
  19. package/cjs/src/embed/liveboard.d.ts +12 -2
  20. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  21. package/cjs/src/embed/liveboard.js +48 -18
  22. package/cjs/src/embed/liveboard.js.map +1 -1
  23. package/cjs/src/embed/liveboard.spec.js +211 -5
  24. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  25. package/cjs/src/embed/sage.d.ts +1 -0
  26. package/cjs/src/embed/sage.d.ts.map +1 -1
  27. package/cjs/src/embed/sage.js +10 -6
  28. package/cjs/src/embed/sage.js.map +1 -1
  29. package/cjs/src/embed/search-bar.d.ts +1 -0
  30. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  31. package/cjs/src/embed/search-bar.js +11 -7
  32. package/cjs/src/embed/search-bar.js.map +1 -1
  33. package/cjs/src/embed/search.d.ts +1 -0
  34. package/cjs/src/embed/search.d.ts.map +1 -1
  35. package/cjs/src/embed/search.js +7 -8
  36. package/cjs/src/embed/search.js.map +1 -1
  37. package/cjs/src/embed/ts-embed.d.ts +24 -7
  38. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  39. package/cjs/src/embed/ts-embed.js +87 -57
  40. package/cjs/src/embed/ts-embed.js.map +1 -1
  41. package/cjs/src/embed/ts-embed.spec.js +173 -1
  42. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  43. package/cjs/src/types.d.ts +152 -44
  44. package/cjs/src/types.d.ts.map +1 -1
  45. package/cjs/src/types.js +139 -42
  46. package/cjs/src/types.js.map +1 -1
  47. package/cjs/src/utils/liveboardService/liveboardService.d.ts +21 -6
  48. package/cjs/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  49. package/cjs/src/utils/liveboardService/liveboardService.js +21 -6
  50. package/cjs/src/utils/liveboardService/liveboardService.js.map +1 -1
  51. package/dist/index-BDlM0f0T.js +7371 -0
  52. package/dist/index-k7pkZMhx.js +7371 -0
  53. package/dist/src/css-variables.d.ts +316 -0
  54. package/dist/src/css-variables.d.ts.map +1 -1
  55. package/dist/src/embed/app.d.ts.map +1 -1
  56. package/dist/src/embed/bodyless-conversation.d.ts +5 -0
  57. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  58. package/dist/src/embed/conversation.d.ts +64 -2
  59. package/dist/src/embed/conversation.d.ts.map +1 -1
  60. package/dist/src/embed/liveboard.d.ts +11 -0
  61. package/dist/src/embed/liveboard.d.ts.map +1 -1
  62. package/dist/src/embed/sage.d.ts +1 -0
  63. package/dist/src/embed/sage.d.ts.map +1 -1
  64. package/dist/src/embed/search-bar.d.ts +1 -0
  65. package/dist/src/embed/search-bar.d.ts.map +1 -1
  66. package/dist/src/embed/search.d.ts +1 -0
  67. package/dist/src/embed/search.d.ts.map +1 -1
  68. package/dist/src/embed/ts-embed.d.ts +24 -0
  69. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  70. package/dist/src/react/index.d.ts +2 -0
  71. package/dist/src/react/index.d.ts.map +1 -1
  72. package/dist/src/types.d.ts +351 -30
  73. package/dist/src/types.d.ts.map +1 -1
  74. package/dist/src/utils/graphql/nlsService/conversation-service.d.ts.map +1 -1
  75. package/dist/src/utils/liveboardService/liveboardService.d.ts +21 -6
  76. package/dist/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  77. package/dist/tsembed-react.es.js +551 -80
  78. package/dist/tsembed-react.js +550 -79
  79. package/dist/tsembed.es.js +572 -86
  80. package/dist/tsembed.js +571 -85
  81. package/dist/visual-embed-sdk-react-full.d.ts +787 -37
  82. package/dist/visual-embed-sdk-react.d.ts +787 -37
  83. package/dist/visual-embed-sdk.d.ts +785 -37
  84. package/lib/package.json +5 -4
  85. package/lib/src/css-variables.d.ts +316 -0
  86. package/lib/src/css-variables.d.ts.map +1 -1
  87. package/lib/src/embed/app.d.ts.map +1 -1
  88. package/lib/src/embed/app.js +8 -0
  89. package/lib/src/embed/app.js.map +1 -1
  90. package/lib/src/embed/app.spec.js +12 -2
  91. package/lib/src/embed/app.spec.js.map +1 -1
  92. package/lib/src/embed/bodyless-conversation.d.ts +1 -0
  93. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  94. package/lib/src/embed/bodyless-conversation.js +7 -3
  95. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  96. package/lib/src/embed/conversation.d.ts +64 -2
  97. package/lib/src/embed/conversation.d.ts.map +1 -1
  98. package/lib/src/embed/conversation.js +17 -4
  99. package/lib/src/embed/conversation.js.map +1 -1
  100. package/lib/src/embed/conversation.spec.js +104 -2
  101. package/lib/src/embed/conversation.spec.js.map +1 -1
  102. package/lib/src/embed/liveboard.d.ts +12 -2
  103. package/lib/src/embed/liveboard.d.ts.map +1 -1
  104. package/lib/src/embed/liveboard.js +48 -18
  105. package/lib/src/embed/liveboard.js.map +1 -1
  106. package/lib/src/embed/liveboard.spec.js +211 -5
  107. package/lib/src/embed/liveboard.spec.js.map +1 -1
  108. package/lib/src/embed/sage.d.ts +1 -0
  109. package/lib/src/embed/sage.d.ts.map +1 -1
  110. package/lib/src/embed/sage.js +10 -6
  111. package/lib/src/embed/sage.js.map +1 -1
  112. package/lib/src/embed/search-bar.d.ts +1 -0
  113. package/lib/src/embed/search-bar.d.ts.map +1 -1
  114. package/lib/src/embed/search-bar.js +11 -7
  115. package/lib/src/embed/search-bar.js.map +1 -1
  116. package/lib/src/embed/search.d.ts +1 -0
  117. package/lib/src/embed/search.d.ts.map +1 -1
  118. package/lib/src/embed/search.js +7 -8
  119. package/lib/src/embed/search.js.map +1 -1
  120. package/lib/src/embed/ts-embed.d.ts +24 -7
  121. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  122. package/lib/src/embed/ts-embed.js +87 -57
  123. package/lib/src/embed/ts-embed.js.map +1 -1
  124. package/lib/src/embed/ts-embed.spec.js +173 -1
  125. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  126. package/lib/src/types.d.ts +152 -44
  127. package/lib/src/types.d.ts.map +1 -1
  128. package/lib/src/types.js +139 -42
  129. package/lib/src/types.js.map +1 -1
  130. package/lib/src/utils/liveboardService/liveboardService.d.ts +21 -6
  131. package/lib/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  132. package/lib/src/utils/liveboardService/liveboardService.js +21 -6
  133. package/lib/src/utils/liveboardService/liveboardService.js.map +1 -1
  134. package/lib/src/visual-embed-sdk.d.ts +786 -38
  135. package/package.json +6 -4
  136. package/src/css-variables.ts +396 -1
  137. package/src/embed/app.spec.ts +17 -2
  138. package/src/embed/app.ts +8 -0
  139. package/src/embed/bodyless-conversation.ts +8 -3
  140. package/src/embed/conversation.spec.ts +131 -5
  141. package/src/embed/conversation.ts +102 -12
  142. package/src/embed/liveboard.spec.ts +264 -5
  143. package/src/embed/liveboard.ts +55 -20
  144. package/src/embed/sage.ts +12 -7
  145. package/src/embed/search-bar.tsx +14 -7
  146. package/src/embed/search.ts +18 -7
  147. package/src/embed/ts-embed.spec.ts +345 -113
  148. package/src/embed/ts-embed.ts +97 -67
  149. package/src/types.ts +199 -91
  150. package/src/utils/liveboardService/liveboardService.ts +21 -6
@@ -1153,6 +1153,17 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
1153
1153
  * embedded Liveboard or visualization.
1154
1154
  */
1155
1155
  protected getEmbedParams(): string;
1156
+ protected getEmbedParamsObject(): any;
1157
+ /**
1158
+ * @hidden
1159
+ * Internal state to track the current liveboard id.
1160
+ * This is used to navigate to the correct liveboard when the prerender is visible.
1161
+ */
1162
+ currentLiveboardState: {
1163
+ liveboardId: string;
1164
+ vizId: string;
1165
+ activeTabId: string;
1166
+ };
1156
1167
  protected beforePrerenderVisible(): void;
1157
1168
  protected handleRenderForPrerender(): Promise<TsEmbed>;
1158
1169
  /**
@@ -1509,6 +1520,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1509
1520
  };
1510
1521
  };
1511
1522
  protected getAppInitData(): Promise<SearchAppInitData>;
1523
+ protected getEmbedParamsObject(): Record<any, any>;
1512
1524
  protected getEmbedParams(): string;
1513
1525
  /**
1514
1526
  * Construct the URL of the embedded ThoughtSpot search to be
@@ -1635,6 +1647,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
1635
1647
  protected viewConfig: SearchBarViewConfig;
1636
1648
  protected embedComponentType: string;
1637
1649
  constructor(domSelector: string, viewConfig: SearchBarViewConfig);
1650
+ protected getEmbedParamsObject(): Record<any, any>;
1638
1651
  /**
1639
1652
  * Render the embedded ThoughtSpot search
1640
1653
  */
@@ -1672,10 +1685,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
1672
1685
  genNo: number;
1673
1686
  acSessionId: string;
1674
1687
  acGenNo: number;
1688
+ convId: string;
1689
+ messageId: string;
1675
1690
  }
1676
1691
  export class ConversationMessage extends TsEmbed {
1677
1692
  protected viewConfig: SpotterAgentMessageViewConfig;
1678
1693
  constructor(container: HTMLElement, viewConfig: SpotterAgentMessageViewConfig);
1694
+ protected getEmbedParamsObject(): Record<any, any>;
1679
1695
  getIframeSrc(): string;
1680
1696
  render(): Promise<ConversationMessage>;
1681
1697
  }
@@ -1719,6 +1735,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
1719
1735
  data?: undefined;
1720
1736
  } | {
1721
1737
  data: {
1738
+ convId: any;
1739
+ messageId: any;
1722
1740
  sessionId: any;
1723
1741
  genNo: any;
1724
1742
  acSessionId: any;
@@ -1753,7 +1771,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/bodyless-conversation' {
1753
1771
  }
1754
1772
 
1755
1773
  declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1756
- import { BaseViewConfig } from '@thoughtspot/visual-embed-sdk/types';
1774
+ import { BaseViewConfig, RuntimeFilter, RuntimeParameter } from '@thoughtspot/visual-embed-sdk/types';
1757
1775
  import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
1758
1776
  /**
1759
1777
  * Configuration for search options
@@ -1770,7 +1788,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1770
1788
  */
1771
1789
  export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
1772
1790
  /**
1773
- * The ID of the data source object. For example, Model, View, or Table. Spotter uses this object to query data and generate Answers.
1791
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses
1792
+ * this object to query data and generate Answers.
1774
1793
  */
1775
1794
  worksheetId: string;
1776
1795
  /**
@@ -1853,6 +1872,66 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1853
1872
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
1854
1873
  */
1855
1874
  hideSampleQuestions?: boolean;
1875
+ /**
1876
+ * The list of runtime filters to apply to a search Answer,
1877
+ * visualization, or Liveboard.
1878
+ *
1879
+ * Supported embed types: `SpotterEmbed`
1880
+ * @example
1881
+ * ```js
1882
+ * const embed = new SpotterEmbed('#tsEmbed', {
1883
+ * // other embed view config
1884
+ * runtimeFilters: [
1885
+ * {
1886
+ * columnName: 'color',
1887
+ * operator: RuntimeFilterOp.EQ,
1888
+ * values: ['red'],
1889
+ * },
1890
+ * ],
1891
+ * })
1892
+ * ```
1893
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
1894
+ */
1895
+ runtimeFilters?: RuntimeFilter[];
1896
+ /**
1897
+ * Flag to control whether runtime filters should be included in the URL.
1898
+ * If true, filters will be passed via app initialization payload instead.
1899
+ * If false/undefined, filters will be added to URL (default behavior).
1900
+ *
1901
+ * Supported embed types: `SpotterEmbed`
1902
+ * @default false
1903
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
1904
+ */
1905
+ excludeRuntimeFiltersfromURL?: boolean;
1906
+ /**
1907
+ * The list of runtime parameters to apply to the conversation.
1908
+ *
1909
+ * Supported embed types: `SpotterEmbed`
1910
+ * @example
1911
+ * ```js
1912
+ * const embed = new SpotterEmbed('#tsEmbed', {
1913
+ * // other embed view config
1914
+ * runtimeParameters: [
1915
+ * {
1916
+ * name: 'Integer Param',
1917
+ * value: 10,
1918
+ * },
1919
+ * ],
1920
+ * })
1921
+ * ```
1922
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
1923
+ */
1924
+ runtimeParameters?: RuntimeParameter[];
1925
+ /**
1926
+ * Flag to control whether runtime parameters should be included in the URL.
1927
+ * If true, parameters will be passed via app initialization payload instead.
1928
+ * If false/undefined, parameters will be added to URL (default behavior).
1929
+ *
1930
+ * Supported embed types: `SpotterEmbed`
1931
+ * @default false
1932
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
1933
+ */
1934
+ excludeRuntimeParametersfromURL?: boolean;
1856
1935
  }
1857
1936
  /**
1858
1937
  * The configuration for the embedded spotterEmbed options.
@@ -1880,6 +1959,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/conversation' {
1880
1959
  export class SpotterEmbed extends TsEmbed {
1881
1960
  protected viewConfig: SpotterEmbedViewConfig;
1882
1961
  constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
1962
+ protected getEmbedParamsObject(): Record<any, any>;
1883
1963
  getIframeSrc(): string;
1884
1964
  render(): Promise<SpotterEmbed>;
1885
1965
  }
@@ -3206,12 +3286,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3206
3286
  * Hide list page columns
3207
3287
  * For example: hiddenListColumns = [ListPageColumns.Author]
3208
3288
  *
3209
- * **Note**: This option is available only in full app embedding.
3289
+ * **Note**: This option is available only in full app embedding. To use it, you need to import `ListPageColumns` enum.
3210
3290
  *
3211
3291
  * Supported embed types: `AppEmbed`
3212
3292
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
3213
3293
  * @example
3214
3294
  * ```js
3295
+ * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
3296
+ *
3215
3297
  * const embed = new AppEmbed('#tsEmbed', {
3216
3298
  * ... //other embed view config
3217
3299
  * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
@@ -3226,11 +3308,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3226
3308
  * **Note**: This option does not apply to the classic homepage.
3227
3309
  * To access the updated modular homepage, set
3228
3310
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3311
+ * To use it, you need to import `HomepageModule` enum.
3229
3312
  *
3230
3313
  * Supported embed types: `AppEmbed`
3231
3314
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3232
3315
  * @example
3233
3316
  * ```js
3317
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
3318
+ *
3234
3319
  * const embed = new AppEmbed('#tsEmbed', {
3235
3320
  * ... //other embed view config
3236
3321
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
@@ -3245,11 +3330,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3245
3330
  * **Note**: This option does not apply to the classic homepage.
3246
3331
  * To access the updated modular homepage, set
3247
3332
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3333
+ * To use it, you need to import `HomepageModule` enum.
3248
3334
  *
3249
3335
  * Supported embed types: `AppEmbed`
3250
3336
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3251
3337
  * @example
3252
3338
  * ```js
3339
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
3340
+ *
3253
3341
  * const embed = new AppEmbed('#tsEmbed', {
3254
3342
  * ... //other embed view config
3255
3343
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
@@ -3265,6 +3353,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3265
3353
  * Supported embed types: `AppEmbed`
3266
3354
  * @example
3267
3355
  * ```js
3356
+ * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
3357
+ *
3268
3358
  * const embed = new AppEmbed('#tsEmbed', {
3269
3359
  * ... //other embed view config
3270
3360
  * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
@@ -3274,6 +3364,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3274
3364
  * **Note**: This option does not apply to the classic homepage.
3275
3365
  * To access the updated modular homepage, set
3276
3366
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
3367
+ * To use it, you need to import `HomeLeftNavItem` enum.
3277
3368
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3278
3369
  */
3279
3370
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -4482,7 +4573,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4482
4573
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4483
4574
  * @example
4484
4575
  *```js
4485
- * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
4576
+ * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
4486
4577
  * console.log('Liveboard details', payload);
4487
4578
  * })
4488
4579
  *```
@@ -4855,7 +4946,96 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4855
4946
  * @version SDK : 1.39.0 | ThoughtSpot : 10.10.0.cl
4856
4947
  * @hidden
4857
4948
  */
4858
- RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates"
4949
+ RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
4950
+ /**
4951
+ * Emitted when Spotter response is text data
4952
+ * @example
4953
+ * ```js
4954
+ * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
4955
+ * console.log('payload', payload);
4956
+ * })
4957
+ *```
4958
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4959
+ */
4960
+ SpotterData = "SpotterData",
4961
+ /**
4962
+ * Emitted when user opens up the worksheet preview modal in Spotter embed.
4963
+ * @example
4964
+ * ```js
4965
+ * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
4966
+ * console.log('payload', payload);
4967
+ * })
4968
+ *```
4969
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4970
+ */
4971
+ PreviewSpotterData = "PreviewSpotterData",
4972
+ /**
4973
+ * Emitted when the Spotter query is triggered in Spotter embed.
4974
+ * @example
4975
+ * ```js
4976
+ * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
4977
+ * console.log('payload', payload);
4978
+ * })
4979
+ *```
4980
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4981
+ */
4982
+ SpotterQueryTriggered = "SpotterQueryTriggered",
4983
+ /**
4984
+ * Emitted when the last Spotter query is edited in Spotter embed.
4985
+ * @example
4986
+ * ```js
4987
+ * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
4988
+ * console.log('payload', payload);
4989
+ * })
4990
+ *```
4991
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
4992
+ */
4993
+ LastPromptEdited = "LastPromptEdited",
4994
+ /**
4995
+ * Emitted when the last Spotter query is deleted in Spotter embed.
4996
+ * @example
4997
+ * ```js
4998
+ * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
4999
+ * console.log('payload', payload);
5000
+ * })
5001
+ *```
5002
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
5003
+ */
5004
+ LastPromptDeleted = "LastPromptDeleted",
5005
+ /**
5006
+ * Emitted when the coversation is reset in spotter embed.
5007
+ * @example
5008
+ * ```js
5009
+ * spotterEmbed.on(EmbedEvent.ResetSpotterConversation, (payload) => {
5010
+ * console.log('payload', payload);
5011
+ * })
5012
+ *```
5013
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
5014
+ */
5015
+ ResetSpotterConversation = "ResetSpotterConversation",
5016
+ /**
5017
+ * Emitted when the *Spotter* is initialized.
5018
+ * @example
5019
+ * ```js
5020
+ * spotterEmbed.on(EmbedEvent.SpotterInit, (payload) => {
5021
+ * console.log('payload', payload);
5022
+ * })
5023
+ *```
5024
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
5025
+ */
5026
+ SpotterInit = "spotterInit",
5027
+ /**
5028
+ * @hidden
5029
+ * Triggers when the embed listener is ready to receive events.
5030
+ * This is used to trigger events after the embed container is loaded.
5031
+ * @example
5032
+ * ```js
5033
+ * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
5034
+ * console.log('EmbedListenerReady');
5035
+ * })
5036
+ * ```
5037
+ */
5038
+ EmbedListenerReady = "EmbedListenerReady"
4859
5039
  }
4860
5040
  /**
4861
5041
  * Event types that can be triggered by the host application
@@ -4873,7 +5053,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4873
5053
  * // create the liveboard embed.
4874
5054
  *
4875
5055
  * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
4876
- * { columnName: 'state, operator: RuntimeFilterOp.EQ, values: ['california']}
5056
+ * { columnName: 'state', operator: RuntimeFilterOp.EQ, values: ["california"]}
4877
5057
  * ]);
4878
5058
  * ```
4879
5059
  * @example
@@ -4943,6 +5123,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4943
5123
  * done automatically on the most popular column.
4944
5124
  * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
4945
5125
  * in case of a Liveboard.
5126
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
4946
5127
  * @example
4947
5128
  * ```js
4948
5129
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -5081,12 +5262,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5081
5262
  * Works with Search and Liveboard embed.
5082
5263
  * @param - { columnId: string,
5083
5264
  * name: string,
5084
- * type: INT64/CHAR/DATE,
5085
- * dataType: ATTRIBUTE/MEASURE }
5265
+ * type: ATTRIBUTE/MEASURE,
5266
+ * dataType: INT64/CHAR/DATE }
5086
5267
  * @example
5087
5268
  * ```js
5088
5269
  * searchEmbed.trigger(HostEvent.OpenFilter,
5089
- * {column: { columnId: '<column-GUID>', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE'}})
5270
+ * {column: { columnId: '<column-GUID>', name: 'column name', type: 'ATTRIBUTE', dataType: 'INT64'}})
5090
5271
  * ```
5091
5272
  * @example
5092
5273
  * ```js
@@ -5144,6 +5325,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5144
5325
  * @param
5145
5326
  * `vizId`- GUID of the saved Answer or visualization to pin to a Liveboard.
5146
5327
  * Optional when pinning a new chart or table generated from a Search query.
5328
+ * **Required** in Spotter Embed.
5147
5329
  * @param
5148
5330
  * `liveboardID` - GUID of the Liveboard to pin an Answer. If there is no Liveboard,
5149
5331
  * specify the `newLiveboardName` parameter to create a new Liveboard.
@@ -5191,6 +5373,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5191
5373
  * ```js
5192
5374
  * appEmbed.trigger(HostEvent.Pin)
5193
5375
  * ```
5376
+ * @example
5377
+ * ```js
5378
+ * const pinResponse = await spotterEmbed.trigger(HostEvent.Pin, {
5379
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5380
+ * });
5381
+ * ```
5194
5382
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5195
5383
  */
5196
5384
  Pin = "pin",
@@ -5255,12 +5443,21 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5255
5443
  * Trigger the **Download PDF** action on an embedded Liveboard,
5256
5444
  * visualization or Answer.
5257
5445
  *
5446
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5447
+ *
5258
5448
  * **NOTE**: The **Download** > **PDF** action is available on
5259
5449
  * visualizations and Answers if the data is in tabular format.
5260
5450
  * @example
5261
5451
  * ```js
5262
5452
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
5263
5453
  * ```
5454
+ * @example
5455
+ * ```js
5456
+ * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
5457
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5458
+ * });
5459
+ * ```
5460
+ *
5264
5461
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5265
5462
  */
5266
5463
  DownloadAsPdf = "downloadAsPdf",
@@ -5284,6 +5481,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5284
5481
  * ```js
5285
5482
  * searchEmbed.trigger(HostEvent.MakeACopy)
5286
5483
  * ```
5484
+ * @example
5485
+ * ```js
5486
+ * const pinResponse = await spotterEmbed.trigger(HostEvent.MakeACopy, {
5487
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5488
+ * });
5489
+ * ```
5287
5490
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5288
5491
  */
5289
5492
  MakeACopy = "makeACopy",
@@ -5356,6 +5559,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5356
5559
  * This event is not supported in visualization embed and search embed.
5357
5560
  * @param - object - To trigger the action for a specific visualization
5358
5561
  * in Liveboard embed, pass in `vizId` as a key.
5562
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5563
+ *
5359
5564
  * @example
5360
5565
  * ```js
5361
5566
  * liveboardEmbed.trigger(HostEvent.Edit)
@@ -5364,6 +5569,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5364
5569
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
5365
5570
  * '730496d6-6903-4601-937e-2c691821af3c'})
5366
5571
  * ```
5572
+ * @example
5573
+ * ```js
5574
+ * const pinResponse = await spotterEmbed.trigger(HostEvent.Edit, {
5575
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5576
+ * });
5577
+ * ```
5578
+ * @example
5579
+ * ```js
5580
+ * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
5581
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5582
+ * });
5583
+ * ```
5367
5584
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
5368
5585
  */
5369
5586
  Edit = "edit",
@@ -5411,6 +5628,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5411
5628
  * );
5412
5629
  * })
5413
5630
  * ```
5631
+ * @example
5632
+ * ```js
5633
+ * spotterEmbed.trigger(HostEvent.GetTML, {
5634
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
5635
+ * }).then((tml) => {
5636
+ * console.log(
5637
+ * tml.answer.search_query // TML representation of the search query
5638
+ * );
5639
+ * })
5640
+ * ```
5414
5641
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5415
5642
  * @important
5416
5643
  */
@@ -5474,6 +5701,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5474
5701
  /**
5475
5702
  * Trigger the **Download** action on charts in
5476
5703
  * the embedded view.
5704
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5477
5705
  * @example
5478
5706
  * ```js
5479
5707
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -5482,6 +5710,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5482
5710
  * ```js
5483
5711
  * embed.trigger(HostEvent.Download)
5484
5712
  * ```
5713
+ * ```js
5714
+ * spotterEmbed.trigger(HostEvent.Download, {
5715
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
5716
+ * });
5717
+ * ```
5485
5718
  * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
5486
5719
  * Use {@link DownloadAsPng}
5487
5720
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -5498,13 +5731,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5498
5731
  * vizEmbed.trigger(HostEvent.DownloadAsPng)
5499
5732
  *
5500
5733
  * searchEmbed.trigger(HostEvent.DownloadAsPng)
5734
+ *
5735
+ * spotterEmbed.trigger(HostEvent.DownloadAsPng, {
5736
+ * vizId:"730496d6-6903-4601-937e-2c691821af3c"
5737
+ * })
5501
5738
  * ```
5739
+ *
5502
5740
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
5503
5741
  */
5504
5742
  DownloadAsPng = "downloadAsPng",
5505
5743
  /**
5506
5744
  * Trigger the **Download** > **CSV** action on tables in
5507
5745
  * the embedded view.
5746
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5508
5747
  * @example
5509
5748
  * ```js
5510
5749
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -5516,12 +5755,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5516
5755
  * ```js
5517
5756
  * searchEmbed.trigger(HostEvent.DownloadAsCsv)
5518
5757
  * ```
5758
+ * ```js
5759
+ * spotterEmbed.trigger(HostEvent.DownloadAsCsv, {
5760
+ * vizId:"730496d6-6903-4601-937e-2c691821af3c"
5761
+ * })
5762
+ * ```
5519
5763
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5520
5764
  */
5521
5765
  DownloadAsCsv = "downloadAsCSV",
5522
5766
  /**
5523
5767
  * Trigger the **Download** > **XLSX** action on tables
5524
5768
  * in the embedded view.
5769
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5525
5770
  * @example
5526
5771
  * ```js
5527
5772
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -5533,6 +5778,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5533
5778
  * ```js
5534
5779
  * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
5535
5780
  * ```
5781
+ * ```js
5782
+ * spotterEmbed.trigger(HostEvent.downloadAsXLSX, {
5783
+ * vizId:"730496d6-6903-4601-937e-2c691821af3c"
5784
+ * })
5785
+ * ```
5536
5786
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5537
5787
  */
5538
5788
  DownloadAsXlsx = "downloadAsXLSX",
@@ -5552,6 +5802,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5552
5802
  /**
5553
5803
  * Trigger the **Save** action on a Liveboard or Answer.
5554
5804
  * Saves the changes.
5805
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5555
5806
  * @example
5556
5807
  * ```js
5557
5808
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -5559,6 +5810,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5559
5810
  * ```js
5560
5811
  * searchEmbed.trigger(HostEvent.Save)
5561
5812
  * ```
5813
+ * ```js
5814
+ * spotterEmbed.trigger(HostEvent.Save, {
5815
+ * vizId:"730496d6-6903-4601-937e-2c691821af3c"
5816
+ * })
5817
+ * ```
5562
5818
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
5563
5819
  */
5564
5820
  Save = "save",
@@ -5842,7 +6098,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5842
6098
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
5843
6099
  /**
5844
6100
  * Triggers an action to update Parameter values on embedded
5845
- * Answers and Liveboard.
6101
+ * Answers, Liveboard and Spotter answer in Edit mode.
5846
6102
  *
5847
6103
  * @example
5848
6104
  * ```js
@@ -5856,11 +6112,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5856
6112
  UpdateParameters = "UpdateParameters",
5857
6113
  /**
5858
6114
  * Triggers GetParameters to fetch the runtime Parameters.
6115
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5859
6116
  * ```js
5860
6117
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
5861
6118
  * console.log('parameters', parameter);
5862
6119
  * });
5863
6120
  *```
6121
+ *```js
6122
+ * spotterEmbed.trigger(HostEvent.GetParameters, {
6123
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
6124
+ * }).then((parameter) => {
6125
+ * console.log('parameters', parameter);
6126
+ * });
6127
+ *```
5864
6128
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
5865
6129
  */
5866
6130
  GetParameters = "GetParameters",
@@ -5892,7 +6156,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5892
6156
  * @param - optional attributes to set Answer properties.
5893
6157
  * `name` - Name string for the Answer.
5894
6158
  * `description` - Description text for the Answer.
5895
- *
6159
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
5896
6160
  * @example
5897
6161
  * ```js
5898
6162
  * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -5900,6 +6164,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5900
6164
  * description: "Total sales by states in MidWest"
5901
6165
  * });
5902
6166
  * ```
6167
+ * @example
6168
+ * ```js
6169
+ * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
6170
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c',
6171
+ * name: "Sales by states",
6172
+ * description: "Total sales by states in MidWest"
6173
+ * });
6174
+ * ```
5903
6175
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5904
6176
  */
5905
6177
  SaveAnswer = "saveAnswer",
@@ -5928,6 +6200,70 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5928
6200
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
5929
6201
  */
5930
6202
  TransformTableVizData = "TransformTableVizData",
6203
+ /**
6204
+ * Triggers a search operation with the search tokens specified in
6205
+ * the search query string in spotter embed.
6206
+ * @param - `query`: Text string in Natural Language format
6207
+ * @param - `executeSearch`: Boolean to execute search and update search query
6208
+ * @example
6209
+ * ```js
6210
+ * spotterEmbed.trigger(HostEvent.SpotterSearch, {
6211
+ * query: 'revenue per year',
6212
+ * executeSearch: true,
6213
+ * })
6214
+ * ```
6215
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6216
+ */
6217
+ SpotterSearch = "SpotterSearch",
6218
+ /**
6219
+ * Edits the last prompt in spotter embed.
6220
+ * @param - `query`: Text string
6221
+ * @example
6222
+ * ```js
6223
+ * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
6224
+ * ```
6225
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6226
+ */
6227
+ EditLastPrompt = "EditLastPrompt",
6228
+ /**
6229
+ * Opens the Worksheet preview modal in Spotter Embed.
6230
+ * @example
6231
+ * ```js
6232
+ * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
6233
+ * ```
6234
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6235
+ */
6236
+ PreviewSpotterData = "PreviewSpotterData",
6237
+ /**
6238
+ * Resets the Spotter Embed Conversation.
6239
+ * @example
6240
+ * ```js
6241
+ * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
6242
+ * ```
6243
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6244
+ */
6245
+ ResetSpotterConversation = "ResetSpotterConversation",
6246
+ /**
6247
+ * Deletes the last prompt in spotter embed.
6248
+ * @example
6249
+ * ```js
6250
+ * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
6251
+ * ```
6252
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6253
+ */
6254
+ DeleteLastPrompt = "DeleteLastPrompt",
6255
+ /**
6256
+ * Toggle the visualization to chart or table view.
6257
+ * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
6258
+ * @example
6259
+ * ```js
6260
+ * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
6261
+ * vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
6262
+ * });
6263
+ *```
6264
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
6265
+ */
6266
+ AnswerChartSwitcher = "answerChartSwitcher",
5931
6267
  /**
5932
6268
  * @hidden
5933
6269
  * Trigger exit from presentation mode when user exits fullscreen.
@@ -5950,7 +6286,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5950
6286
  *
5951
6287
  * @hidden
5952
6288
  */
5953
- VisibleEmbedCoordinates = "visibleEmbedCoordinates"
6289
+ VisibleEmbedCoordinates = "visibleEmbedCoordinates",
6290
+ /**
6291
+ * Trigger the *Ask Spotter* action for visualizations
6292
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
6293
+ * @example
6294
+ * ```js
6295
+ * spotterEmbed.trigger(HostEvent.AskSpotter,
6296
+ * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
6297
+ * ```
6298
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
6299
+ */
6300
+ AskSpotter = "AskSpotter",
6301
+ /**
6302
+ * @hidden
6303
+ * Triggers the update of the embed params.
6304
+ *
6305
+ * @example
6306
+ * ```js
6307
+ * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
6308
+ * ```
6309
+ */
6310
+ UpdateEmbedParams = "updateEmbedParams"
5954
6311
  }
5955
6312
  /**
5956
6313
  * The different visual modes that the data sources panel within
@@ -6238,27 +6595,27 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6238
6595
  */
6239
6596
  ConfigureFilter = "configureFilter",
6240
6597
  /**
6241
- * The **Collapse data sources** icon on the Search page.
6242
- * Collapses the panel showing data sources.
6243
- *
6244
- * @example
6245
- * ```js
6246
- * disabledActions: [Action.CollapseDataPanel]
6247
- * ```
6248
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
6249
- */
6598
+ * The **Collapse data sources** icon on the Search page.
6599
+ * Collapses the panel showing data sources.
6600
+ *
6601
+ * @example
6602
+ * ```js
6603
+ * disabledActions: [Action.CollapseDataPanel]
6604
+ * ```
6605
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
6606
+ */
6250
6607
  CollapseDataSources = "collapseDataSources",
6251
6608
  /**
6252
- * The **Collapse data panel** icon on the Search page.
6253
- * Collapses the data panel view.
6254
- *
6255
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6256
- *
6257
- * @example
6258
- * ```js
6259
- * disabledActions: [Action.CollapseDataPanel]
6260
- * ```
6261
- */
6609
+ * The **Collapse data panel** icon on the Search page.
6610
+ * Collapses the data panel view.
6611
+ *
6612
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
6613
+ *
6614
+ * @example
6615
+ * ```js
6616
+ * disabledActions: [Action.CollapseDataPanel]
6617
+ * ```
6618
+ */
6262
6619
  CollapseDataPanel = "collapseDataPanel",
6263
6620
  /**
6264
6621
  * The **Choose sources** button on Search page.
@@ -6954,6 +7311,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6954
7311
  * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
6955
7312
  */
6956
7313
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
7314
+ /**
7315
+ * Action ID to hide or disable Iterative Change Analysis option
7316
+ * on contextual change analysis Inisght charts context menu
7317
+ *
7318
+ * @example
7319
+ * ```js
7320
+ * disabledActions: [Action.EnableIterativeChangeAnalysis]
7321
+ * ```
7322
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
7323
+ */
7324
+ EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis",
6957
7325
  /**
6958
7326
  * Action ID to hide or disable Natural Language Search query.
6959
7327
  *
@@ -7322,7 +7690,40 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
7322
7690
  * ```
7323
7691
  * @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
7324
7692
  */
7325
- InConversationTraining = "InConversationTraining"
7693
+ InConversationTraining = "InConversationTraining",
7694
+ /**
7695
+ * Action ID to hide the warnings banner in
7696
+ * Spotter results. It's an EA feature and
7697
+ * handled by LD.
7698
+ * @example
7699
+ * ```js
7700
+ * hiddenAction: [Action.SpotterWarningsBanner]
7701
+ * ```
7702
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7703
+ */
7704
+ SpotterWarningsBanner = "SpotterWarningsBanner",
7705
+ /**
7706
+ * Action ID to hide the warnings border on the knowledge
7707
+ * card in Spotter results. It's an EA feature and
7708
+ * handled by LD.
7709
+ * @example
7710
+ * ```js
7711
+ * hiddenAction: [Action.SpotterWarningsOnTokens]
7712
+ * ```
7713
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7714
+ */
7715
+ SpotterWarningsOnTokens = "SpotterWarningsOnTokens",
7716
+ /**
7717
+ * Action ID to disable the click event handler on knowledge
7718
+ * card in Spotter results. It's an EA feature and
7719
+ * handled by LD.
7720
+ * @example
7721
+ * ```js
7722
+ * hiddenAction: [Action.SpotterTokenQuickEdit]
7723
+ * ```
7724
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
7725
+ */
7726
+ SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
7326
7727
  }
7327
7728
  export interface AnswerServiceType {
7328
7729
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -7871,6 +8272,322 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
7871
8272
  * Background color of checkbox.
7872
8273
  */
7873
8274
  '--ts-var-checkbox-background-color'?: string;
8275
+ /**
8276
+ * Height of the tiles in the Liveboard.
8277
+ */
8278
+ '--ts-var-viz-tile-height'?: string;
8279
+ /**
8280
+ * Background color of the layout in the Liveboard.
8281
+ */
8282
+ '--ts-var-liveboard-layout-background'?: string;
8283
+ /**
8284
+ * Font color of the title of the layout in the Liveboard.
8285
+ */
8286
+ '--ts-var-liveboard-layout-title-color'?: string;
8287
+ /**
8288
+ * Font size of the title of the layout in the Liveboard.
8289
+ */
8290
+ '--ts-var-liveboard-layout-title-fontsize'?: string;
8291
+ /**
8292
+ * Background color of the header in the Liveboard.
8293
+ */
8294
+ '--ts-var-liveboard-header-background'?: string;
8295
+ /**
8296
+ * Font size of the header in the Liveboard.
8297
+ */
8298
+ '--ts-var-liveboard-header-fontsize'?: string;
8299
+ /**
8300
+ * Font color of the header in the Liveboard.
8301
+ */
8302
+ '--ts-var-liveboard-header-font-color'?: string;
8303
+ /**
8304
+ * Border color of the tiles in the Liveboard.
8305
+ */
8306
+ '--ts-var-liveboard-tile-border-color'?: string;
8307
+ /**
8308
+ * Background color of the tiles in the Liveboard.
8309
+ */
8310
+ '--ts-var-liveboard-tile-background'?: string;
8311
+ /**
8312
+ * Border radius of the tiles in the Liveboard.
8313
+ */
8314
+ '--ts-var-liveboard-tile-border-radius'?: string;
8315
+ /**
8316
+ * Padding of the tiles in the Liveboard.
8317
+ */
8318
+ '--ts-var-liveboard-tile-padding'?: string;
8319
+ /**
8320
+ * Background color of the table header in the Liveboard.
8321
+ */
8322
+ '--ts-var-liveboard-tile-table-header-background'?: string;
8323
+ /**
8324
+ * Padding of the groups in the Liveboard.
8325
+ */
8326
+ '--ts-var-liveboard-group-padding'?: string;
8327
+ /**
8328
+ * Padding of the title of the groups in the Liveboard.
8329
+ */
8330
+ '--ts-var-liveboard-group-title-padding'?: string;
8331
+ /**
8332
+ * Font size of the title of the groups in the Liveboard.
8333
+ */
8334
+ '--ts-var-liveboard-group-title-font-size'?: string;
8335
+ /**
8336
+ * Font weight of the title of the groups in the Liveboard.
8337
+ */
8338
+ '--ts-var-liveboard-group-title-font-weight'?: string;
8339
+ /**
8340
+ * Font size of the title of the tiles inside the groups in the Liveboard.
8341
+ */
8342
+ '--ts-var-liveboard-group-tile-title-font-size'?: string;
8343
+ /**
8344
+ * Font weight of the title of the tiles inside the groups in the Liveboard.
8345
+ */
8346
+ '--ts-var-liveboard-group-tile-title-font-weight'?: string;
8347
+ /**
8348
+ * Font size of the description of the groups in the Liveboard.
8349
+ */
8350
+ '--ts-var-liveboard-group-description-font-size'?: string;
8351
+ /**
8352
+ * Font weight of the description of the groups in the Liveboard.
8353
+ */
8354
+ '--ts-var-liveboard-group-description-font-weight'?: string;
8355
+ /**
8356
+ * Border of the tiles in the Liveboard.
8357
+ */
8358
+ '--ts-var-liveboard-group-tile-border'?: string;
8359
+ /**
8360
+ * Padding of the tiles in the Liveboard.
8361
+ */
8362
+ '--ts-var-liveboard-group-tile-padding'?: string;
8363
+ /**
8364
+ * Padding of the answer viz in the Liveboard.
8365
+ */
8366
+ '--ts-var-liveboard-answer-viz-padding'?: string;
8367
+ /**
8368
+ * Background color of the groups in the Liveboard.
8369
+ */
8370
+ '--ts-var-liveboard-group-background'?: string;
8371
+ /**
8372
+ * Border color of the groups in the Liveboard.
8373
+ */
8374
+ '--ts-var-liveboard-group-border-color'?: string;
8375
+ /**
8376
+ * Font color of the heading of the note title in the Liveboard.
8377
+ */
8378
+ '--ts-var-liveboard-notetitle-heading-font-color'?: string;
8379
+ /**
8380
+ * Font color of the body of the note title in the Liveboard.
8381
+ */
8382
+ '--ts-var-liveboard-notetitle-body-font-color'?: string;
8383
+ /**
8384
+ * Font color of the title of the groups in the Liveboard.
8385
+ */
8386
+ '--ts-var-liveboard-group-title-font-color'?: string;
8387
+ /**
8388
+ * Font color of the description of the groups in the Liveboard.
8389
+ */
8390
+ '--ts-var-liveboard-group-description-font-color'?: string;
8391
+ /**
8392
+ * Font color of the title of the tiles inside the groups in the Liveboard.
8393
+ */
8394
+ '--ts-var-liveboard-group-tile-title-font-color'?: string;
8395
+ /**
8396
+ * Background color of the tiles inside the groups in the Liveboard.
8397
+ */
8398
+ '--ts-var-liveboard-group-tile-background'?: string;
8399
+ /**
8400
+ * Background color of the chips in the Liveboard.
8401
+ */
8402
+ '--ts-var-liveboard-chip-background'?: string;
8403
+ /**
8404
+ * Font color of the chips in the Liveboard.
8405
+ */
8406
+ '--ts-var-liveboard-chip-color'?: string;
8407
+ /**
8408
+ * Background color of the chips in the Liveboard on hover.
8409
+ */
8410
+ '--ts-var-liveboard-chip--hover-background'?: string;
8411
+ /**
8412
+ * Font color of the chips in the Liveboard on hover.
8413
+ */
8414
+ '--ts-var-liveboard-chip--hover-color'?: string;
8415
+ /**
8416
+ * Background color of the chips in the Liveboard on active.
8417
+ */
8418
+ '--ts-var-liveboard-chip--active-background'?: string;
8419
+ /**
8420
+ * Font color of the chips in the Liveboard on active.
8421
+ */
8422
+ '--ts-var-liveboard-chip--active-color'?: string;
8423
+ /**
8424
+ * Width of the side panel in the Liveboard.
8425
+ */
8426
+ '--ts-var-side-panel-width'?: string;
8427
+ /**
8428
+ * Background color of the edit bar in the Liveboard.
8429
+ */
8430
+ '--ts-var-liveboard-edit-bar-background'?: string;
8431
+ /**
8432
+ * Breakpoint for the dual column layout in the Liveboard.
8433
+ */
8434
+ '--ts-var-liveboard-dual-column-breakpoint'?: string;
8435
+ /**
8436
+ * Breakpoint for the single column layout in the Liveboard.
8437
+ */
8438
+ '--ts-var-liveboard-single-column-breakpoint'?: string;
8439
+ /**
8440
+ * Background color of the cross filter layout in the Liveboard.
8441
+ */
8442
+ '--ts-var-liveboard-cross-filter-layout-background'?: string;
8443
+ /**
8444
+ * Border color of the active tab in the Liveboard.
8445
+ */
8446
+ '--ts-var-liveboard-tab-active-border-color'?: string;
8447
+ /**
8448
+ * Font color of the hover tab in the Liveboard.
8449
+ */
8450
+ '--ts-var-liveboard-tab-hover-color'?: string;
8451
+ /**
8452
+ * Font size of the title of the tiles in the Liveboard.
8453
+ */
8454
+ '--ts-var-liveboard-tile-title-fontsize'?: string;
8455
+ /**
8456
+ * Font weight of the title of the tiles in the Liveboard.
8457
+ */
8458
+ '--ts-var-liveboard-tile-title-fontweight'?: string;
8459
+ /**
8460
+ * Font weight of the description of the tiles in the Liveboard.
8461
+ */
8462
+ '--ts-var-liveboard-tile-description-font-weight'?: string;
8463
+ /**
8464
+ * Opacity of the description of the tiles in the Liveboard.
8465
+ */
8466
+ '--ts-var-liveboard-tile-description-opacity'?: string;
8467
+ /**
8468
+ * Background color of the parameter chips in the Liveboard.
8469
+ */
8470
+ '--ts-var-parameter-chip-background'?: string;
8471
+ /**
8472
+ * Font color of the parameter chips in the Liveboard.
8473
+ */
8474
+ '--ts-var-parameter-chip-text-color'?: string;
8475
+ /**
8476
+ * Background color of the parameter chips in the Liveboard on hover.
8477
+ */
8478
+ '--ts-var-parameter-chip-hover-background'?: string;
8479
+ /**
8480
+ * Font color of the parameter chips in the Liveboard on hover.
8481
+ */
8482
+ '--ts-var-parameter-chip-hover-text-color'?: string;
8483
+ /**
8484
+ * Background color of the parameter chips in the Liveboard on active.
8485
+ */
8486
+ '--ts-var-parameter-chip-active-background'?: string;
8487
+ /**
8488
+ * Font color of the parameter chips in the Liveboard on active.
8489
+ */
8490
+ '--ts-var-parameter-chip-active-text-color'?: string;
8491
+ /**
8492
+ * Background color of the action button in the Liveboard header.
8493
+ */
8494
+ '--ts-var-liveboard-header-action-button-background'?: string;
8495
+ /**
8496
+ * Font color of the action button in the Liveboard header.
8497
+ */
8498
+ '--ts-var-liveboard-header-action-button-font-color'?: string;
8499
+ /**
8500
+ * Font color of the action button in the Liveboard header on hover.
8501
+ */
8502
+ '--ts-var-liveboard-header-action-button-hover-color'?: string;
8503
+ /**
8504
+ * Font color of the action button in the Liveboard header on active.
8505
+ */
8506
+ '--ts-var-liveboard-header-action-button-active-color'?: string;
8507
+ /**
8508
+ * Background color of the badge in the Liveboard header.
8509
+ */
8510
+ '--ts-var-liveboard-header-badge-background'?: string;
8511
+ /**
8512
+ * Font color of the badge in the Liveboard header.
8513
+ */
8514
+ '--ts-var-liveboard-header-badge-font-color'?: string;
8515
+ /**
8516
+ * Background color of the modified badge in the Liveboard header.
8517
+ */
8518
+ '--ts-var-liveboard-header-badge-modified-background'?: string;
8519
+ /**
8520
+ * Font color of the modified badge in the Liveboard header.
8521
+ */
8522
+ '--ts-var-liveboard-header-badge-modified-font-color'?: string;
8523
+ /**
8524
+ * Font color of the badge in the Liveboard header on hover.
8525
+ */
8526
+ '--ts-var-liveboard-header-badge-hover-color'?: string;
8527
+ /**
8528
+ * Font color of the badge in the Liveboard header on active.
8529
+ */
8530
+ '--ts-var-liveboard-header-badge-active-color'?: string;
8531
+ /**
8532
+ * Font color of the hero text in the KPI widget.
8533
+ */
8534
+ '--ts-var-kpi-hero-color'?: string;
8535
+ /**
8536
+ * Font color of the comparison text in the KPI widget.
8537
+ */
8538
+ '--ts-var-kpi-comparison-color'?: string;
8539
+ /**
8540
+ * Font color of the analyze text in the KPI widget.
8541
+ */
8542
+ '--ts-var-kpi-analyze-text-color'?: string;
8543
+ /**
8544
+ * Font color of the legend title in the heatmap chart.
8545
+ */
8546
+ '--ts-var-chart-heatmap-legend-title-color'?: string;
8547
+ /**
8548
+ * Font color of the legend label in the heatmap chart.
8549
+ */
8550
+ '--ts-var-chart-heatmap-legend-label-color'?: string;
8551
+ /**
8552
+ * Font color of the legend title in the treemap chart.
8553
+ */
8554
+ '--ts-var-chart-treemap-legend-title-color'?: string;
8555
+ /**
8556
+ * Font color of the legend label in the treemap chart.
8557
+ */
8558
+ '--ts-var-chart-treemap-legend-label-color'?: string;
8559
+ /**
8560
+ * Color of the positive change in the KPI.
8561
+ */
8562
+ '--ts-var-kpi-positive-change-color'?: string;
8563
+ /**
8564
+ * Color of the negative change in the KPI.
8565
+ */
8566
+ '--ts-var-kpi-negative-change-color'?: string;
8567
+ /**
8568
+ * Background color of the change analysis insights.
8569
+ */
8570
+ '--ts-var-change-analysis-insights-background'?: string;
8571
+ /**
8572
+ * Background color of the forecasting card in the SpotIQ analyze.
8573
+ */
8574
+ '--ts-var-spotiq-analyze-forecasting-card-background'?: string;
8575
+ /**
8576
+ * Background color of the outlier card in the SpotIQ analyze.
8577
+ */
8578
+ '--ts-var-spotiq-analyze-outlier-card-background'?: string;
8579
+ /**
8580
+ * Background color of the trend card in the SpotIQ analyze.
8581
+ */
8582
+ '--ts-var-spotiq-analyze-trend-card-background'?: string;
8583
+ /**
8584
+ * Background color of the crosscorrelation card in the SpotIQ analyze.
8585
+ */
8586
+ '--ts-var-spotiq-analyze-crosscorrelation-card-background'?: string;
8587
+ /**
8588
+ * Background color of the summary header in the CCA modal.
8589
+ */
8590
+ '--ts-var-cca-modal-summary-header-background'?: string;
7874
8591
  }
7875
8592
  }
7876
8593
 
@@ -8019,6 +8736,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
8019
8736
  */
8020
8737
  protected viewConfig: SageViewConfig;
8021
8738
  constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
8739
+ protected getEmbedParamsObject(): Record<any, any>;
8022
8740
  /**
8023
8741
  * Constructs a map of parameters to be passed on to the
8024
8742
  * embedded Eureka or Sage search page.
@@ -8379,16 +9097,31 @@ declare module '@thoughtspot/visual-embed-sdk/utils/graphql/nlsService/nls-answe
8379
9097
  declare module '@thoughtspot/visual-embed-sdk/utils/liveboardService/liveboardService' {
8380
9098
  import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
8381
9099
  /**
8382
- * Create a liveboard with the given answers
8383
- * @param answers AnswerService[]
8384
- * @param name string
9100
+ * Creates a new Liveboard in ThoughtSpot using the provided AnswerService instances.
9101
+ *
9102
+ * Each answer will be added as a visualization to the newly created Liveboard.
9103
+ *
9104
+ * @param {AnswerService[]} answers - An array of initialized `AnswerService` instances
9105
+ * representing the answers to be added to the Liveboard.
9106
+ * @param {string} name - The name of the Liveboard to create.
8385
9107
  * @returns result Promise
8386
9108
  * @version SDK: 1.33.1 | ThoughtSpot: *
8387
9109
  * @example
8388
9110
  * ```js
8389
- * const lb = createLiveboardWithAnswers([
8390
- * new AnswerService(session, null, 'tshost'),
8391
- * ], "my-liveboard");
9111
+ * import { EmbedEvent, AnswerService } from "@thoughtspot/visual-embed-sdk";
9112
+ *
9113
+ * embed.on(EmbedEvent.Data, async () => {
9114
+ * try {
9115
+ * const answerService = await embed.getAnswerService();
9116
+ * const lb = await createLiveboardWithAnswers(
9117
+ * [answerService],
9118
+ * "My Liveboard"
9119
+ * );
9120
+ * console.log("Liveboard created:", lb);
9121
+ * } catch (err) {
9122
+ * console.error("Failed to create liveboard:", err);
9123
+ * }
9124
+ * });
8392
9125
  * ```
8393
9126
  */
8394
9127
  export const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
@@ -8573,6 +9306,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
8573
9306
  * @param query
8574
9307
  */
8575
9308
  protected getEmbedBasePath(query: string): string;
9309
+ protected getUpdateEmbedParamsObject(): Record<any, any>;
8576
9310
  /**
8577
9311
  * Common query params set for all the embed modes.
8578
9312
  * @param queryParams
@@ -8588,6 +9322,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
8588
9322
  */
8589
9323
  protected getV1EmbedBasePath(queryString: string): string;
8590
9324
  protected getEmbedParams(): string;
9325
+ protected getEmbedParamsObject(): Record<any, any>;
8591
9326
  protected getRootIframeSrc(): string;
8592
9327
  protected createIframeEl(frameSrc: string): HTMLIFrameElement;
8593
9328
  protected handleInsertionIntoDOM(child: string | Node): void;
@@ -8679,6 +9414,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
8679
9414
  * ```
8680
9415
  */
8681
9416
  off(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
9417
+ /**
9418
+ * @hidden
9419
+ * Internal state to track if the embed container is loaded.
9420
+ * This is used to trigger events after the embed container is loaded.
9421
+ */
9422
+ isEmbedContainerLoaded: boolean;
9423
+ protected getPreRenderObj<T extends TsEmbed>(): T;
9424
+ /**
9425
+ * Executes a callback after the embed container is loaded.
9426
+ * @param callback The callback to execute
9427
+ */
9428
+ protected executeAfterEmbedContainerLoaded(callback: () => void): void;
9429
+ protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void;
8682
9430
  /**
8683
9431
  * Triggers an event to the embedded app
8684
9432
  * @param {HostEvent} messageType The event type