@thoughtspot/visual-embed-sdk 1.27.0-loggers → 1.27.8

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 (178) hide show
  1. package/README.md +3 -3
  2. package/cjs/package.json +1 -1
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +2 -2
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/embed/app.d.ts +8 -2
  7. package/cjs/src/embed/app.d.ts.map +1 -1
  8. package/cjs/src/embed/app.js +5 -2
  9. package/cjs/src/embed/app.js.map +1 -1
  10. package/cjs/src/embed/app.spec.js +10 -0
  11. package/cjs/src/embed/app.spec.js.map +1 -1
  12. package/cjs/src/embed/base.d.ts +1 -1
  13. package/cjs/src/embed/base.d.ts.map +1 -1
  14. package/cjs/src/embed/base.js +5 -5
  15. package/cjs/src/embed/base.js.map +1 -1
  16. package/cjs/src/embed/base.spec.js +1 -1
  17. package/cjs/src/embed/base.spec.js.map +1 -1
  18. package/cjs/src/embed/liveboard.d.ts +7 -1
  19. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  20. package/cjs/src/embed/liveboard.js +5 -2
  21. package/cjs/src/embed/liveboard.js.map +1 -1
  22. package/cjs/src/embed/liveboard.spec.js +2 -1
  23. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  24. package/cjs/src/embed/sage.d.ts +1 -2
  25. package/cjs/src/embed/sage.d.ts.map +1 -1
  26. package/cjs/src/embed/sage.js +7 -6
  27. package/cjs/src/embed/sage.js.map +1 -1
  28. package/cjs/src/embed/sage.spec.js +3 -3
  29. package/cjs/src/embed/sage.spec.js.map +1 -1
  30. package/cjs/src/embed/search.d.ts +6 -3
  31. package/cjs/src/embed/search.d.ts.map +1 -1
  32. package/cjs/src/embed/search.js +9 -9
  33. package/cjs/src/embed/search.js.map +1 -1
  34. package/cjs/src/embed/ts-embed.d.ts +2 -2
  35. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  36. package/cjs/src/embed/ts-embed.js +10 -9
  37. package/cjs/src/embed/ts-embed.js.map +1 -1
  38. package/cjs/src/embed/ts-embed.spec.js +14 -8
  39. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  40. package/cjs/src/index.d.ts +2 -2
  41. package/cjs/src/index.d.ts.map +1 -1
  42. package/cjs/src/index.js +2 -1
  43. package/cjs/src/index.js.map +1 -1
  44. package/cjs/src/react/index.d.ts +1 -1
  45. package/cjs/src/react/index.d.ts.map +1 -1
  46. package/cjs/src/react/index.js +2 -1
  47. package/cjs/src/react/index.js.map +1 -1
  48. package/cjs/src/react/index.spec.js +12 -0
  49. package/cjs/src/react/index.spec.js.map +1 -1
  50. package/cjs/src/types.d.ts +136 -56
  51. package/cjs/src/types.d.ts.map +1 -1
  52. package/cjs/src/types.js +123 -50
  53. package/cjs/src/types.js.map +1 -1
  54. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  55. package/cjs/src/utils/graphql/answerService/answerService.js +1 -1
  56. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  57. package/cjs/src/utils/graphql/answerService/answerService.spec.js +2 -0
  58. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  59. package/cjs/src/utils/logger.d.ts.map +1 -1
  60. package/cjs/src/utils/logger.js +5 -3
  61. package/cjs/src/utils/logger.js.map +1 -1
  62. package/cjs/src/utils/logger.spec.js +36 -0
  63. package/cjs/src/utils/logger.spec.js.map +1 -1
  64. package/dist/src/auth.d.ts.map +1 -1
  65. package/dist/src/embed/app.d.ts +8 -2
  66. package/dist/src/embed/app.d.ts.map +1 -1
  67. package/dist/src/embed/base.d.ts +1 -1
  68. package/dist/src/embed/base.d.ts.map +1 -1
  69. package/dist/src/embed/liveboard.d.ts +7 -1
  70. package/dist/src/embed/liveboard.d.ts.map +1 -1
  71. package/dist/src/embed/sage.d.ts +1 -2
  72. package/dist/src/embed/sage.d.ts.map +1 -1
  73. package/dist/src/embed/search.d.ts +6 -3
  74. package/dist/src/embed/search.d.ts.map +1 -1
  75. package/dist/src/embed/ts-embed.d.ts +2 -2
  76. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  77. package/dist/src/index.d.ts +2 -2
  78. package/dist/src/index.d.ts.map +1 -1
  79. package/dist/src/react/index.d.ts +1 -1
  80. package/dist/src/react/index.d.ts.map +1 -1
  81. package/dist/src/types.d.ts +136 -56
  82. package/dist/src/types.d.ts.map +1 -1
  83. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  84. package/dist/src/utils/logger.d.ts.map +1 -1
  85. package/dist/tsembed-react.es.js +6791 -23886
  86. package/dist/tsembed-react.js +6806 -23902
  87. package/dist/tsembed.es.js +12044 -29139
  88. package/dist/tsembed.js +15362 -32458
  89. package/dist/visual-embed-sdk-react-full.d.ts +177 -62
  90. package/dist/visual-embed-sdk-react.d.ts +177 -62
  91. package/dist/visual-embed-sdk.d.ts +177 -62
  92. package/lib/package.json +1 -1
  93. package/lib/src/auth.d.ts.map +1 -1
  94. package/lib/src/auth.js +3 -3
  95. package/lib/src/auth.js.map +1 -1
  96. package/lib/src/embed/app.d.ts +8 -2
  97. package/lib/src/embed/app.d.ts.map +1 -1
  98. package/lib/src/embed/app.js +5 -2
  99. package/lib/src/embed/app.js.map +1 -1
  100. package/lib/src/embed/app.spec.js +10 -0
  101. package/lib/src/embed/app.spec.js.map +1 -1
  102. package/lib/src/embed/base.d.ts +1 -1
  103. package/lib/src/embed/base.d.ts.map +1 -1
  104. package/lib/src/embed/base.js +5 -5
  105. package/lib/src/embed/base.js.map +1 -1
  106. package/lib/src/embed/base.spec.js +2 -2
  107. package/lib/src/embed/base.spec.js.map +1 -1
  108. package/lib/src/embed/liveboard.d.ts +7 -1
  109. package/lib/src/embed/liveboard.d.ts.map +1 -1
  110. package/lib/src/embed/liveboard.js +5 -2
  111. package/lib/src/embed/liveboard.js.map +1 -1
  112. package/lib/src/embed/liveboard.spec.js +2 -1
  113. package/lib/src/embed/liveboard.spec.js.map +1 -1
  114. package/lib/src/embed/sage.d.ts +1 -2
  115. package/lib/src/embed/sage.d.ts.map +1 -1
  116. package/lib/src/embed/sage.js +7 -6
  117. package/lib/src/embed/sage.js.map +1 -1
  118. package/lib/src/embed/sage.spec.js +3 -3
  119. package/lib/src/embed/sage.spec.js.map +1 -1
  120. package/lib/src/embed/search.d.ts +6 -3
  121. package/lib/src/embed/search.d.ts.map +1 -1
  122. package/lib/src/embed/search.js +10 -10
  123. package/lib/src/embed/search.js.map +1 -1
  124. package/lib/src/embed/ts-embed.d.ts +2 -2
  125. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  126. package/lib/src/embed/ts-embed.js +13 -12
  127. package/lib/src/embed/ts-embed.js.map +1 -1
  128. package/lib/src/embed/ts-embed.spec.js +14 -8
  129. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  130. package/lib/src/index.d.ts +2 -2
  131. package/lib/src/index.d.ts.map +1 -1
  132. package/lib/src/index.js +2 -2
  133. package/lib/src/index.js.map +1 -1
  134. package/lib/src/react/index.d.ts +1 -1
  135. package/lib/src/react/index.d.ts.map +1 -1
  136. package/lib/src/react/index.js +1 -1
  137. package/lib/src/react/index.js.map +1 -1
  138. package/lib/src/react/index.spec.js +12 -0
  139. package/lib/src/react/index.spec.js.map +1 -1
  140. package/lib/src/types.d.ts +136 -56
  141. package/lib/src/types.d.ts.map +1 -1
  142. package/lib/src/types.js +123 -50
  143. package/lib/src/types.js.map +1 -1
  144. package/lib/src/utils/authService/authService.spec.js +1 -1
  145. package/lib/src/utils/authService/authService.spec.js.map +1 -1
  146. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  147. package/lib/src/utils/graphql/answerService/answerService.js +1 -1
  148. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  149. package/lib/src/utils/graphql/answerService/answerService.spec.js +2 -0
  150. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  151. package/lib/src/utils/logger.d.ts.map +1 -1
  152. package/lib/src/utils/logger.js +2 -1
  153. package/lib/src/utils/logger.js.map +1 -1
  154. package/lib/src/utils/logger.spec.js +36 -0
  155. package/lib/src/utils/logger.spec.js.map +1 -1
  156. package/lib/src/visual-embed-sdk.d.ts +181 -66
  157. package/package.json +1 -1
  158. package/src/auth.ts +6 -6
  159. package/src/embed/app.spec.ts +15 -0
  160. package/src/embed/app.ts +14 -3
  161. package/src/embed/base.spec.ts +3 -3
  162. package/src/embed/base.ts +12 -12
  163. package/src/embed/liveboard.spec.ts +2 -1
  164. package/src/embed/liveboard.ts +16 -6
  165. package/src/embed/sage.spec.ts +3 -3
  166. package/src/embed/sage.ts +8 -9
  167. package/src/embed/search.ts +15 -11
  168. package/src/embed/ts-embed.spec.ts +25 -19
  169. package/src/embed/ts-embed.ts +39 -41
  170. package/src/index.ts +2 -0
  171. package/src/react/index.spec.tsx +29 -0
  172. package/src/react/index.tsx +1 -0
  173. package/src/types.ts +141 -58
  174. package/src/utils/authService/authService.spec.ts +4 -4
  175. package/src/utils/graphql/answerService/answerService.spec.ts +2 -0
  176. package/src/utils/graphql/answerService/answerService.ts +3 -1
  177. package/src/utils/logger.spec.ts +41 -0
  178. package/src/utils/logger.ts +2 -1
@@ -234,7 +234,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
234
234
  * @summary ThoughtSpot Visual Embed SDK
235
235
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
236
236
  */
237
- export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, 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, };
237
+ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, 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, };
238
238
 
239
239
  /**
240
240
  * @group Embed components
@@ -438,7 +438,6 @@ export declare class SageEmbed extends V1Embed {
438
438
  *
439
439
  */
440
440
  protected viewConfig: SageViewConfig;
441
- protected embedComponentType: string;
442
441
  constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
443
442
  /**
444
443
  * Constructs a map of parameters to be passed on to the
@@ -447,6 +446,13 @@ export declare class SageEmbed extends V1Embed {
447
446
  * @returns {string} query string
448
447
  */
449
448
  protected getEmbedParams(): string;
449
+ /**
450
+ * Construct the URL of the embedded ThoughtSpot sage to be
451
+ * loaded in the iframe
452
+ *
453
+ * @returns {string} iframe url
454
+ */
455
+ getIFrameSrc(): string;
450
456
  /**
451
457
  * Render the embedded ThoughtSpot Sage
452
458
  *
@@ -501,6 +507,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
501
507
  * using raw answer data.
502
508
  */
503
509
  hideResults?: boolean;
510
+ /**
511
+ * If set to true, expands all the data sources panel.
512
+ */
513
+ expandAllDataSource?: boolean;
504
514
  /**
505
515
  * If set to true, the Search Assist feature is enabled.
506
516
  *
@@ -589,9 +599,16 @@ export declare class SearchEmbed extends TsEmbed {
589
599
  * The view configuration for the embedded ThoughtSpot search.
590
600
  */
591
601
  protected viewConfig: SearchViewConfig;
592
- protected embedComponentType: string;
593
602
  constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
594
603
  protected getEmbedParams(): string;
604
+ /**
605
+ * Construct the URL of the embedded ThoughtSpot search to be
606
+ * loaded in the iframe
607
+ *
608
+ * @param answerId The GUID of a saved answer
609
+ * @param dataSources A list of data source GUIDs
610
+ */
611
+ getIFrameSrc(): string;
595
612
  /**
596
613
  * Render the embedded ThoughtSpot search
597
614
  */
@@ -781,6 +798,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
781
798
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
782
799
  */
783
800
  isLiveboardHeaderSticky?: boolean;
801
+ /**
802
+ * enable or disable ask sage
803
+ *
804
+ * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
805
+ * @default false
806
+ */
807
+ enableAskSage?: boolean;
784
808
  }
785
809
  /**
786
810
  * Embeds full ThoughtSpot experience in a host application.
@@ -789,13 +813,18 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
789
813
  */
790
814
  export declare class AppEmbed extends V1Embed {
791
815
  protected viewConfig: AppViewConfig;
792
- protected embedComponentType: string;
793
816
  constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
794
817
  /**
795
818
  * Constructs a map of parameters to be passed on to the
796
819
  * embedded Liveboard or visualization.
797
820
  */
798
821
  protected getEmbedParams(): string;
822
+ /**
823
+ * Constructs the URL of the ThoughtSpot app page to be rendered.
824
+ *
825
+ * @param pageId The ID of the page to be embedded.
826
+ */
827
+ getIFrameSrc(): string;
799
828
  /**
800
829
  * Set the iframe height as per the computed height received
801
830
  * from the ThoughtSpot app.
@@ -955,6 +984,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
955
984
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
956
985
  */
957
986
  isLiveboardHeaderSticky?: boolean;
987
+ /**
988
+ * enable or disable ask sage
989
+ *
990
+ * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
991
+ * @default false
992
+ */
993
+ enableAskSage?: boolean;
958
994
  }
959
995
  /**
960
996
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -974,7 +1010,6 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
974
1010
  */
975
1011
  export declare class LiveboardEmbed extends V1Embed {
976
1012
  protected viewConfig: LiveboardViewConfig;
977
- protected embedComponentType: string;
978
1013
  constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
979
1014
  /**
980
1015
  * Construct a map of params to be passed on to the
@@ -1856,8 +1891,8 @@ export interface EmbedConfig {
1856
1891
  suppressErrorAlerts?: boolean;
1857
1892
  /**
1858
1893
  * Log level for the SDK.
1859
- * @default LogLevel.ERROR
1860
1894
  *
1895
+ * @default LogLevel.ERROR
1861
1896
  * @example
1862
1897
  * ```js
1863
1898
  * init({
@@ -1865,7 +1900,7 @@ export interface EmbedConfig {
1865
1900
  * logLevel: LogLevel.SILENT
1866
1901
  * })
1867
1902
  * ```
1868
- * @version SDK: 1.26.3 | ThoughtSpot: 9.10.0.cl
1903
+ * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
1869
1904
  */
1870
1905
  logLevel?: LogLevel;
1871
1906
  }
@@ -2104,6 +2139,7 @@ export interface ViewConfig {
2104
2139
  * ```js
2105
2140
  * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
2106
2141
  * ```
2142
+ *
2107
2143
  * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
2108
2144
  */
2109
2145
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -2141,6 +2177,12 @@ export interface ViewConfig {
2141
2177
  * const myComponent = new MyComponent(config);
2142
2178
  */
2143
2179
  doNotTrackPreRenderSize?: boolean;
2180
+ /**
2181
+ * For internal tracking of the embed component type.
2182
+ *
2183
+ * @hidden
2184
+ */
2185
+ embedComponentType?: string;
2144
2186
  }
2145
2187
  /**
2146
2188
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -2338,6 +2380,7 @@ export interface RuntimeParameter {
2338
2380
  export declare enum EmbedEvent {
2339
2381
  /**
2340
2382
  * Rendering has initialized.
2383
+ *
2341
2384
  * @example
2342
2385
  *```js
2343
2386
  * liveboardEmbed.on(EmbedEvent.Init, showLoader)
@@ -2346,7 +2389,6 @@ export declare enum EmbedEvent {
2346
2389
  * document.getElementById("loader");
2347
2390
  * }
2348
2391
  *```
2349
- *
2350
2392
  * @returns timestamp - The timestamp when the event was generated.
2351
2393
  */
2352
2394
  Init = "init",
@@ -2359,12 +2401,12 @@ export declare enum EmbedEvent {
2359
2401
  * console.log('AuthInit', payload);
2360
2402
  * })
2361
2403
  *```
2362
- *
2363
2404
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
2364
2405
  */
2365
2406
  AuthInit = "authInit",
2366
2407
  /**
2367
2408
  * The embed object container has loaded.
2409
+ *
2368
2410
  * @returns timestamp - The timestamp when the event was generated.
2369
2411
  * @example
2370
2412
  *```js
@@ -2378,6 +2420,7 @@ export declare enum EmbedEvent {
2378
2420
  Load = "load",
2379
2421
  /**
2380
2422
  * Data pertaining to answer or Liveboard is received
2423
+ *
2381
2424
  * @return data - The answer or Liveboard data
2382
2425
  * @example
2383
2426
  *```js
@@ -2401,7 +2444,6 @@ export declare enum EmbedEvent {
2401
2444
  *```js
2402
2445
  * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
2403
2446
  *```
2404
- *
2405
2447
  */
2406
2448
  QueryChanged = "queryChanged",
2407
2449
  /**
@@ -2410,7 +2452,6 @@ export declare enum EmbedEvent {
2410
2452
  * @returns additionalFilters - Any additional filters applied
2411
2453
  * @returns drillDownColumns - The columns on which drill down was performed
2412
2454
  * @returns nonFilteredColumns - The columns that were not filtered
2413
- *
2414
2455
  * @example
2415
2456
  *```js
2416
2457
  * searchEmbed.trigger(HostEvent.DrillDown, {
@@ -2424,7 +2465,6 @@ export declare enum EmbedEvent {
2424
2465
  * In this example, `VizPointDoubleClick` event is used for
2425
2466
  * triggering the `DrillDown` event when an area or specific
2426
2467
  * data point on a table or chart is double-clicked.
2427
- *
2428
2468
  * @example
2429
2469
  *```js
2430
2470
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -2441,34 +2481,31 @@ export declare enum EmbedEvent {
2441
2481
  * })
2442
2482
  * })
2443
2483
  *```
2444
- *
2445
2484
  */
2446
2485
  Drilldown = "drillDown",
2447
2486
  /**
2448
2487
  * One or more data sources have been selected.
2449
- * @returns dataSourceIds - the list of data sources
2450
2488
  *
2489
+ * @returns dataSourceIds - the list of data sources
2451
2490
  * @example
2452
2491
  * ```js
2453
2492
  * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
2454
2493
  * console.log('DataSourceSelected', payload);
2455
2494
  * })
2456
2495
  * ```
2457
- *
2458
2496
  */
2459
2497
  DataSourceSelected = "dataSourceSelected",
2460
2498
  /**
2461
2499
  * One or more data columns have been selected.
2500
+ *
2462
2501
  * @returns columnIds - the list of columns
2463
2502
  * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2464
- *
2465
2503
  * @example
2466
2504
  * ```js
2467
2505
  * appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
2468
2506
  * console.log('AddRemoveColumns', payload);
2469
2507
  * })
2470
2508
  * ```
2471
- *
2472
2509
  */
2473
2510
  AddRemoveColumns = "addRemoveColumns",
2474
2511
  /**
@@ -2476,7 +2513,6 @@ export declare enum EmbedEvent {
2476
2513
  *
2477
2514
  * @returns actionId - ID of the custom action
2478
2515
  * @returns data - Response payload with the Answer or Liveboard data
2479
- *
2480
2516
  * @example
2481
2517
  * ```js
2482
2518
  * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -2492,9 +2528,7 @@ export declare enum EmbedEvent {
2492
2528
  * Listen to double click actions on a visualization.
2493
2529
  *
2494
2530
  * @return ContextMenuInputPoints - Data point that is double-clicked
2495
- *
2496
2531
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
2497
- *
2498
2532
  * @example
2499
2533
  * ```js
2500
2534
  * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
@@ -2509,7 +2543,6 @@ export declare enum EmbedEvent {
2509
2543
  * @return viz, clickedPoint - metadata about the point that is clicked
2510
2544
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2511
2545
  * @important
2512
- *
2513
2546
  * @example
2514
2547
  * ```js
2515
2548
  * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
@@ -2528,7 +2561,6 @@ export declare enum EmbedEvent {
2528
2561
  * An error has occurred.
2529
2562
  *
2530
2563
  * @returns error - An error object or message
2531
- *
2532
2564
  * @example
2533
2565
  * ```js
2534
2566
  * SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
@@ -2536,19 +2568,16 @@ export declare enum EmbedEvent {
2536
2568
  * function showErrorMsg() {
2537
2569
  * document.getElementById("error");
2538
2570
  * ```
2539
- *
2540
2571
  */
2541
2572
  Error = "Error",
2542
2573
  /**
2543
2574
  * The embedded object has sent an alert.
2544
2575
  *
2545
2576
  * @returns alert - An alert object
2546
- *
2547
2577
  * @example
2548
2578
  * ```js
2549
2579
  * searchEmbed.on(EmbedEvent.Alert)
2550
2580
  * ```
2551
- *
2552
2581
  */
2553
2582
  Alert = "alert",
2554
2583
  /**
@@ -2595,7 +2624,6 @@ export declare enum EmbedEvent {
2595
2624
  * Applicable to `SearchBarEmbed` only.
2596
2625
  *
2597
2626
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
2598
- *
2599
2627
  * @example
2600
2628
  *```js
2601
2629
  * searchbarEmbed.on(EmbedEvent.GetDataClick)
@@ -2642,8 +2670,8 @@ export declare enum EmbedEvent {
2642
2670
  SAMLComplete = "samlComplete",
2643
2671
  /**
2644
2672
  * Emitted when any modal is opened in the app
2645
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2646
2673
  *
2674
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2647
2675
  * @example
2648
2676
  *```js
2649
2677
  * appEmbed.on(EmbedEvent.DialogOpen, payload => {
@@ -2654,8 +2682,8 @@ export declare enum EmbedEvent {
2654
2682
  DialogOpen = "dialog-open",
2655
2683
  /**
2656
2684
  * Emitted when any modal is closed in the app
2657
- * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2658
2685
  *
2686
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2659
2687
  * @example
2660
2688
  *```js
2661
2689
  * appEmbed.on(EmbedEvent.DialogClose, payload => {
@@ -2668,8 +2696,8 @@ export declare enum EmbedEvent {
2668
2696
  * Emitted when the Liveboard shell loads.
2669
2697
  * You can use this event as a hook to trigger
2670
2698
  * other events on the rendered Liveboard.
2671
- * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2672
2699
  *
2700
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2673
2701
  * @example
2674
2702
  *```js
2675
2703
  * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
@@ -2678,7 +2706,6 @@ export declare enum EmbedEvent {
2678
2706
  *```
2679
2707
  * The following example shows how to trigger
2680
2708
  * `SetVisibleVizs` event using LiveboardRendered embed event:
2681
- *
2682
2709
  * @example
2683
2710
  *```js
2684
2711
  * const embedRef = useEmbedRef();
@@ -2691,8 +2718,8 @@ export declare enum EmbedEvent {
2691
2718
  /**
2692
2719
  * This can be used to register an event listener which
2693
2720
  * is triggered on all events.
2694
- * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2695
2721
  *
2722
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
2696
2723
  * @example
2697
2724
  *```js
2698
2725
  * appEmbed.on(EmbedEvent.ALL, payload => {
@@ -2703,6 +2730,7 @@ export declare enum EmbedEvent {
2703
2730
  ALL = "*",
2704
2731
  /**
2705
2732
  * Emitted when an Answer is saved in the app
2733
+ *
2706
2734
  * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2707
2735
  * @example
2708
2736
  *```js
@@ -2728,7 +2756,6 @@ export declare enum EmbedEvent {
2728
2756
  * or `EmbedEvent.DownloadAsXLSX`
2729
2757
  *
2730
2758
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2731
- *
2732
2759
  * @example
2733
2760
  *```js
2734
2761
  * liveboardEmbed.trigger(HostEvent.Download, {
@@ -2739,8 +2766,8 @@ export declare enum EmbedEvent {
2739
2766
  Download = "download",
2740
2767
  /**
2741
2768
  * Emitted when the download action is triggered on an answer
2742
- * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
2743
2769
  *
2770
+ * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
2744
2771
  * @example
2745
2772
  *```js
2746
2773
  * //trigger when action starts
@@ -2750,14 +2777,12 @@ export declare enum EmbedEvent {
2750
2777
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
2751
2778
  * console.log('download PNG', payload)})
2752
2779
  *```
2753
- *
2754
2780
  */
2755
2781
  DownloadAsPng = "downloadAsPng",
2756
2782
  /**
2757
2783
  * Emitted when the Download as PDF action is triggered on an answer
2758
2784
  *
2759
2785
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2760
- *
2761
2786
  * @example
2762
2787
  *```js
2763
2788
  * //trigger when action starts
@@ -2767,7 +2792,6 @@ export declare enum EmbedEvent {
2767
2792
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
2768
2793
  * console.log('download PDF', payload)})
2769
2794
  *```
2770
- *
2771
2795
  */
2772
2796
  DownloadAsPdf = "downloadAsPdf",
2773
2797
  /**
@@ -2789,7 +2813,6 @@ export declare enum EmbedEvent {
2789
2813
  * Emitted when the Download as XLSX action is triggered on an answer
2790
2814
  *
2791
2815
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2792
- *
2793
2816
  * @example
2794
2817
  *```js
2795
2818
  * //trigger when action starts
@@ -2805,7 +2828,6 @@ export declare enum EmbedEvent {
2805
2828
  * Emitted when an Answer is deleted in the app
2806
2829
  *
2807
2830
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2808
- *
2809
2831
  * @example
2810
2832
  *```js
2811
2833
  * //trigger when action starts
@@ -2859,7 +2881,6 @@ export declare enum EmbedEvent {
2859
2881
  * Emitted when a user shares an object with another user or group
2860
2882
  *
2861
2883
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2862
- *
2863
2884
  * @example
2864
2885
  *```js
2865
2886
  * //trigger when action starts
@@ -2939,6 +2960,7 @@ export declare enum EmbedEvent {
2939
2960
  /**
2940
2961
  * Emitted when the **Export TML** action is triggered on an
2941
2962
  * an embedded object in the app
2963
+ *
2942
2964
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
2943
2965
  * @example
2944
2966
  *```js
@@ -3076,7 +3098,6 @@ export declare enum EmbedEvent {
3076
3098
  *```js
3077
3099
  * liveboardEmbed.trigger(HostEvent.Present)
3078
3100
  *```
3079
- *
3080
3101
  * @example
3081
3102
  *```js
3082
3103
  * liveboardEmbed.on(EmbedEvent.Present, {
@@ -3094,77 +3115,65 @@ export declare enum EmbedEvent {
3094
3115
  * liveboardEmbed.trigger(HostEvent.Delete,
3095
3116
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3096
3117
  *```
3097
- *
3098
3118
  */
3099
3119
  Delete = "delete",
3100
3120
  /**
3101
3121
  * Emitted when a user clicks Manage schedules on a Liveboard
3102
3122
  *
3103
3123
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3104
- *
3105
3124
  * @example
3106
3125
  *```js
3107
3126
  * liveboardEmbed.trigger(HostEvent.SchedulesList)
3108
3127
  *```
3109
- *
3110
3128
  */
3111
3129
  SchedulesList = "schedule-list",
3112
3130
  /**
3113
3131
  * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
3114
3132
  *
3115
3133
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3116
- *
3117
3134
  * @example
3118
3135
  *```js
3119
3136
  * liveboardEmbed.trigger(HostEvent.Cancel)
3120
3137
  *```
3121
- *
3122
3138
  */
3123
3139
  Cancel = "cancel",
3124
3140
  /**
3125
3141
  * Emitted when a user clicks **Explore** on a visualization
3126
3142
  *
3127
3143
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3128
- *
3129
3144
  * @example
3130
3145
  *```js
3131
3146
  * liveboardEmbed.trigger(HostEvent.Explore, {
3132
3147
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3133
3148
  *```
3134
- *
3135
3149
  */
3136
3150
  Explore = "explore",
3137
3151
  /**
3138
3152
  * Emitted when a user clicks **Copy link** action on a visualization
3139
3153
  *
3140
3154
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3141
- *
3142
3155
  * @example
3143
3156
  *```js
3144
3157
  * liveboardEmbed.trigger(HostEvent.CopyLink, {
3145
3158
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3146
3159
  *```
3147
- *
3148
3160
  */
3149
3161
  CopyLink = "embedDocument",
3150
3162
  /**
3151
3163
  * Emitted when a user interacts with cross filters on a visualization or Liveboard
3152
3164
  *
3153
3165
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3154
- *
3155
3166
  * @example
3156
3167
  *```js
3157
3168
  * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
3158
3169
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3159
3170
  *```
3160
- *
3161
3171
  */
3162
3172
  CrossFilterChanged = "cross-filter-changed",
3163
3173
  /**
3164
3174
  * Emitted when a user right clicks on a visualization (chart or table)
3165
3175
  *
3166
3176
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3167
- *
3168
3177
  * @example
3169
3178
  *```js
3170
3179
  * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
@@ -3195,7 +3204,6 @@ export declare enum EmbedEvent {
3195
3204
  * Emitted when a user selects a data source.
3196
3205
  *
3197
3206
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
3198
- *
3199
3207
  */
3200
3208
  SageWorksheetUpdated = "sageWorksheetUpdated",
3201
3209
  /**
@@ -3254,7 +3262,23 @@ export declare enum EmbedEvent {
3254
3262
  *
3255
3263
  * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
3256
3264
  */
3257
- CreateWorksheet = "createWorksheet"
3265
+ CreateWorksheet = "createWorksheet",
3266
+ /**
3267
+ * Emitted when Ask Sage is initialized.
3268
+ *
3269
+ * @returns viewName: string
3270
+ * @returns viewId: string
3271
+ * @returns liveboardId: string
3272
+ * @returns isPublic: boolean
3273
+ * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
3274
+ */
3275
+ AskSageInit = "AskSageInit",
3276
+ /**
3277
+ * Emitted when a LB/viz is renamed
3278
+ *
3279
+ * @version SDK : 1.28.0 | ThoughtSpot: 9.11.0.cl
3280
+ */
3281
+ Rename = "rename"
3258
3282
  }
3259
3283
  /**
3260
3284
  * Event types that can be triggered by the host application
@@ -3343,7 +3367,7 @@ export declare enum HostEvent {
3343
3367
  * clickedPoint,
3344
3368
  * selectedPoints: selectedPoint
3345
3369
  * },
3346
- * autoDrillDown: true,
3370
+ * columnGuid: "<guid of the column to drill>",
3347
3371
  * vizId: payload.data.vizId
3348
3372
  * });
3349
3373
  * })
@@ -3422,7 +3446,6 @@ export declare enum HostEvent {
3422
3446
  *
3423
3447
  * @param - `path` - the path to navigate to to go forward or back. The path value can
3424
3448
  * be a number; for example, `1`, `-1`.
3425
- *
3426
3449
  * @example
3427
3450
  * ```js
3428
3451
  * appEmbed.navigateToPage(-1)
@@ -3993,9 +4016,7 @@ export declare enum HostEvent {
3993
4016
  * Updates the search query string for Natural Language Search operations.
3994
4017
  *
3995
4018
  * @param - `queryString`: Text string in Natural Language format
3996
- *
3997
4019
  * @param - `executeSearch`: Boolean to execute search and update search query
3998
- *
3999
4020
  * @example
4000
4021
  * ```js
4001
4022
  * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -4018,7 +4039,18 @@ export declare enum HostEvent {
4018
4039
  * ```
4019
4040
  * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
4020
4041
  */
4021
- GetAnswerSession = "getAnswerSession"
4042
+ GetAnswerSession = "getAnswerSession",
4043
+ /**
4044
+ * Trigger Ask Sage for viz
4045
+ *
4046
+ * @example
4047
+ * ```js
4048
+ * liveboardEmbed.trigger(HostEvent.AskSage,
4049
+ * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
4050
+ * ```
4051
+ * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
4052
+ */
4053
+ AskSage = "AskSage"
4022
4054
  }
4023
4055
  /**
4024
4056
  * The different visual modes that the data sources panel within
@@ -4113,7 +4145,8 @@ export declare enum Param {
4113
4145
  HideSageAnswerHeader = "hideSageAnswerHeader",
4114
4146
  HideSearchBar = "hideSearchBar",
4115
4147
  ClientLogLevel = "clientLogLevel",
4116
- OverrideNativeConsole = "overrideConsoleLogs"
4148
+ OverrideNativeConsole = "overrideConsoleLogs",
4149
+ enableAskSage = "enableAskSage"
4117
4150
  }
4118
4151
  /**
4119
4152
  * ThoughtSpot application pages include actions and menu commands
@@ -4972,7 +5005,17 @@ export declare enum Action {
4972
5005
  * ```
4973
5006
  * @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
4974
5007
  */
4975
- VerifiedLiveboard = "verifiedLiveboard"
5008
+ VerifiedLiveboard = "verifiedLiveboard",
5009
+ /**
5010
+ * Action ID for ask sage button
5011
+ *
5012
+ * @example
5013
+ * ```js
5014
+ * hiddenAction: [Action.AskAi]
5015
+ * ```
5016
+ * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
5017
+ */
5018
+ AskAi = "AskAi"
4976
5019
  }
4977
5020
  export interface AnswerServiceType {
4978
5021
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -5029,11 +5072,83 @@ export interface CustomActionPayload {
5029
5072
  vizId?: string;
5030
5073
  }
5031
5074
  export declare enum LogLevel {
5075
+ /**
5076
+ * No logs will be logged in the console.
5077
+ *
5078
+ * @example
5079
+ * ```js
5080
+ * init({
5081
+ * ... // other options,
5082
+ * logLevel: LogLevel.SILENT,
5083
+ * })
5084
+ * ```
5085
+ * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
5086
+ */
5032
5087
  SILENT = "SILENT",
5088
+ /**
5089
+ * Only ERROR logs will be logged in the console.
5090
+ *
5091
+ * @example
5092
+ * ```js
5093
+ * init({
5094
+ * ... // other options,
5095
+ * logLevel: LogLevel.ERROR,
5096
+ * })
5097
+ * ```
5098
+ * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
5099
+ */
5033
5100
  ERROR = "ERROR",
5101
+ /**
5102
+ * Only WARN and ERROR logs will be logged in the console.
5103
+ *
5104
+ * @example
5105
+ * ```js
5106
+ * init({
5107
+ * ... // other options,
5108
+ * logLevel: LogLevel.WARN,
5109
+ * })
5110
+ * ```
5111
+ * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
5112
+ */
5034
5113
  WARN = "WARN",
5114
+ /**
5115
+ * Only INFO, WARN, and ERROR logs will be logged in the console.
5116
+ *
5117
+ * @example
5118
+ * ```js
5119
+ * init({
5120
+ * ... // other options,
5121
+ * logLevel: LogLevel.INFO,
5122
+ * })
5123
+ * ```
5124
+ * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
5125
+ */
5035
5126
  INFO = "INFO",
5127
+ /**
5128
+ * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
5129
+ *
5130
+ * @example
5131
+ * ```js
5132
+ * init({
5133
+ * ... // other options,
5134
+ * logLevel: LogLevel.DEBUG,
5135
+ * })
5136
+ * ```
5137
+ * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
5138
+ */
5036
5139
  DEBUG = "DEBUG",
5140
+ /**
5141
+ * All logs will be logged in the console.
5142
+ *
5143
+ * @example
5144
+ * ```js
5145
+ * init({
5146
+ * ... // other options,
5147
+ * logLevel: LogLevel.TRACE,
5148
+ * })
5149
+ * ```
5150
+ * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
5151
+ */
5037
5152
  TRACE = "TRACE"
5038
5153
  }
5039
5154
 
@@ -5515,7 +5630,6 @@ export declare class TsEmbed {
5515
5630
  */
5516
5631
  protected thoughtSpotHost: string;
5517
5632
  protected thoughtSpotV2Base: string;
5518
- protected embedComponentType: string;
5519
5633
  /**
5520
5634
  * A flag that is set to true post render.
5521
5635
  */
@@ -5663,6 +5777,7 @@ export declare class TsEmbed {
5663
5777
  * @param args
5664
5778
  */
5665
5779
  render(): TsEmbed;
5780
+ getIframeSrc(): string;
5666
5781
  protected handleRenderForPrerender(): void;
5667
5782
  /**
5668
5783
  * Creates the preRender shell