@thoughtspot/visual-embed-sdk 1.32.4-dc.14 → 1.32.4-dc.16

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 (90) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/auth.d.ts +1 -0
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +1 -0
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/embed/liveboard.d.ts +9 -0
  7. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  8. package/cjs/src/embed/liveboard.js +16 -0
  9. package/cjs/src/embed/liveboard.js.map +1 -1
  10. package/cjs/src/tokenizedFetch.d.ts +1 -0
  11. package/cjs/src/tokenizedFetch.d.ts.map +1 -1
  12. package/cjs/src/tokenizedFetch.js +1 -0
  13. package/cjs/src/tokenizedFetch.js.map +1 -1
  14. package/cjs/src/types.d.ts +25 -3
  15. package/cjs/src/types.d.ts.map +1 -1
  16. package/cjs/src/types.js +25 -3
  17. package/cjs/src/types.js.map +1 -1
  18. package/cjs/src/utils/authService/tokenizedAuthService.d.ts +2 -0
  19. package/cjs/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
  20. package/cjs/src/utils/authService/tokenizedAuthService.js +2 -0
  21. package/cjs/src/utils/authService/tokenizedAuthService.js.map +1 -1
  22. package/cjs/src/utils/liveboardService/liveboardService.js +2 -1
  23. package/cjs/src/utils/liveboardService/liveboardService.js.map +1 -1
  24. package/cjs/src/utils/processData.d.ts.map +1 -1
  25. package/cjs/src/utils/processData.js +1 -0
  26. package/cjs/src/utils/processData.js.map +1 -1
  27. package/cjs/src/utils/sessionInfoService.d.ts +4 -0
  28. package/cjs/src/utils/sessionInfoService.d.ts.map +1 -1
  29. package/cjs/src/utils/sessionInfoService.js +4 -0
  30. package/cjs/src/utils/sessionInfoService.js.map +1 -1
  31. package/dist/src/auth.d.ts +1 -0
  32. package/dist/src/auth.d.ts.map +1 -1
  33. package/dist/src/embed/liveboard.d.ts +9 -0
  34. package/dist/src/embed/liveboard.d.ts.map +1 -1
  35. package/dist/src/tokenizedFetch.d.ts +1 -0
  36. package/dist/src/tokenizedFetch.d.ts.map +1 -1
  37. package/dist/src/types.d.ts +25 -3
  38. package/dist/src/types.d.ts.map +1 -1
  39. package/dist/src/utils/authService/tokenizedAuthService.d.ts +2 -0
  40. package/dist/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
  41. package/dist/src/utils/processData.d.ts.map +1 -1
  42. package/dist/src/utils/sessionInfoService.d.ts +4 -0
  43. package/dist/src/utils/sessionInfoService.d.ts.map +1 -1
  44. package/dist/tsembed-react.es.js +49 -4
  45. package/dist/tsembed-react.js +49 -4
  46. package/dist/tsembed.es.js +51 -5
  47. package/dist/tsembed.js +51 -5
  48. package/dist/visual-embed-sdk-react-full.d.ts +40 -3
  49. package/dist/visual-embed-sdk-react.d.ts +40 -3
  50. package/dist/visual-embed-sdk.d.ts +40 -3
  51. package/lib/package.json +1 -1
  52. package/lib/src/auth.d.ts +1 -0
  53. package/lib/src/auth.d.ts.map +1 -1
  54. package/lib/src/auth.js +1 -0
  55. package/lib/src/auth.js.map +1 -1
  56. package/lib/src/embed/liveboard.d.ts +9 -0
  57. package/lib/src/embed/liveboard.d.ts.map +1 -1
  58. package/lib/src/embed/liveboard.js +16 -0
  59. package/lib/src/embed/liveboard.js.map +1 -1
  60. package/lib/src/tokenizedFetch.d.ts +1 -0
  61. package/lib/src/tokenizedFetch.d.ts.map +1 -1
  62. package/lib/src/tokenizedFetch.js +1 -0
  63. package/lib/src/tokenizedFetch.js.map +1 -1
  64. package/lib/src/types.d.ts +25 -3
  65. package/lib/src/types.d.ts.map +1 -1
  66. package/lib/src/types.js +25 -3
  67. package/lib/src/types.js.map +1 -1
  68. package/lib/src/utils/authService/tokenizedAuthService.d.ts +2 -0
  69. package/lib/src/utils/authService/tokenizedAuthService.d.ts.map +1 -1
  70. package/lib/src/utils/authService/tokenizedAuthService.js +2 -0
  71. package/lib/src/utils/authService/tokenizedAuthService.js.map +1 -1
  72. package/lib/src/utils/liveboardService/liveboardService.js +2 -1
  73. package/lib/src/utils/liveboardService/liveboardService.js.map +1 -1
  74. package/lib/src/utils/processData.d.ts.map +1 -1
  75. package/lib/src/utils/processData.js +1 -0
  76. package/lib/src/utils/processData.js.map +1 -1
  77. package/lib/src/utils/sessionInfoService.d.ts +4 -0
  78. package/lib/src/utils/sessionInfoService.d.ts.map +1 -1
  79. package/lib/src/utils/sessionInfoService.js +4 -0
  80. package/lib/src/utils/sessionInfoService.js.map +1 -1
  81. package/lib/src/visual-embed-sdk.d.ts +40 -3
  82. package/package.json +1 -1
  83. package/src/auth.ts +1 -0
  84. package/src/embed/liveboard.ts +21 -0
  85. package/src/tokenizedFetch.ts +1 -0
  86. package/src/types.ts +25 -3
  87. package/src/utils/authService/tokenizedAuthService.ts +2 -0
  88. package/src/utils/liveboardService/liveboardService.ts +1 -1
  89. package/src/utils/processData.ts +1 -0
  90. package/src/utils/sessionInfoService.ts +4 -0
@@ -1425,6 +1425,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1425
1425
  *
1426
1426
  * Since, this will show preview images, be careful that it may show
1427
1427
  * undesired data to the user when using row level security.
1428
+ *
1428
1429
  * @example
1429
1430
  * ```js
1430
1431
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -1434,6 +1435,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1434
1435
  * });
1435
1436
  * embed.render();
1436
1437
  * ```
1438
+ *
1437
1439
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
1438
1440
  */
1439
1441
  showPreviewLoader?: boolean;
@@ -1476,6 +1478,13 @@ export declare class LiveboardEmbed extends V1Embed {
1476
1478
  */
1477
1479
  render(): Promise<LiveboardEmbed>;
1478
1480
  navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
1481
+ /**
1482
+ * Returns the full url of the liveboard/viz which can be used to open
1483
+ * this liveboard inside the full Thoughtspot application in a new tab.
1484
+ *
1485
+ * @returns url string
1486
+ */
1487
+ getLiveboardUrl(): string;
1479
1488
  }
1480
1489
  /**
1481
1490
  * @hidden
@@ -1783,6 +1792,7 @@ export declare function notifyLogout(): void;
1783
1792
  * Services to be called after the login is successful,
1784
1793
  * This should be called after the cookie is set for cookie auth or
1785
1794
  * after the token is set for cookieless.
1795
+ *
1786
1796
  * @return {Promise<void>}
1787
1797
  * @example
1788
1798
  * ```js
@@ -1842,6 +1852,7 @@ export type SessionInfo = {
1842
1852
  * Returns the session info object and caches it for future use.
1843
1853
  * Once fetched the session info object is cached and returned from the cache on
1844
1854
  * subsequent calls.
1855
+ *
1845
1856
  * @example ```js
1846
1857
  * const sessionInfo = await getSessionInfo();
1847
1858
  * console.log(sessionInfo);
@@ -1853,6 +1864,7 @@ export declare function getSessionInfo(): Promise<SessionInfo>;
1853
1864
  /**
1854
1865
  * Returns the cached session info object. If the client is not authenticated the
1855
1866
  * function will return null.
1867
+ *
1856
1868
  * @example ```js
1857
1869
  * const sessionInfo = getCachedSessionInfo();
1858
1870
  * if (sessionInfo) {
@@ -1867,6 +1879,7 @@ export declare function getSessionInfo(): Promise<SessionInfo>;
1867
1879
  export declare function getCachedSessionInfo(): SessionInfo | null;
1868
1880
  /**
1869
1881
  * Processes the session info response and returns the session info object.
1882
+ *
1870
1883
  * @param sessionInfoResp {any} Response from the session info API.
1871
1884
  * @returns {SessionInfo} The session info object.
1872
1885
  * @example ```js
@@ -1879,6 +1892,7 @@ export declare function getCachedSessionInfo(): SessionInfo | null;
1879
1892
  export declare const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
1880
1893
  /**
1881
1894
  * Resets the cached session info object and forces a new fetch on the next call.
1895
+ *
1882
1896
  * @example ```js
1883
1897
  * resetCachedSessionInfo();
1884
1898
  * const sessionInfo = await getSessionInfo();
@@ -4307,23 +4321,28 @@ export declare enum HostEvent {
4307
4321
  /**
4308
4322
  * Trigger the **Make a copy** action on a Liveboard,
4309
4323
  * visualization, or Answer page.
4324
+ *
4310
4325
  * @example
4311
4326
  * ```js
4312
4327
  * liveboardEmbed.trigger(HostEvent.MakeACopy)
4313
4328
  * ```
4329
+ *
4314
4330
  * @example
4315
4331
  * ```js
4316
4332
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {
4317
4333
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4318
4334
  * ```
4335
+ *
4319
4336
  * @example
4320
4337
  * ```js
4321
4338
  * vizEmbed.trigger(HostEvent.MakeACopy)
4322
4339
  * ```
4340
+ *
4323
4341
  * @example
4324
4342
  * ```js
4325
4343
  * searchEmbed.trigger(HostEvent.MakeACopy)
4326
4344
  * ```
4345
+ *
4327
4346
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4328
4347
  */
4329
4348
  MakeACopy = "makeACopy",
@@ -4349,6 +4368,7 @@ export declare enum HostEvent {
4349
4368
  /**
4350
4369
  * Trigger the **Create alert** action on a KPI chart
4351
4370
  * in a Liveboard or saved Answer.
4371
+ *
4352
4372
  * @param - an object with `vizId` as a key
4353
4373
  * @example
4354
4374
  * ```js
@@ -4356,6 +4376,7 @@ export declare enum HostEvent {
4356
4376
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4357
4377
  * })
4358
4378
  * ```
4379
+ *
4359
4380
  * @example
4360
4381
  * ```js
4361
4382
  * searchEmbed.trigger(HostEvent.CreateMonitor)
@@ -4366,6 +4387,7 @@ export declare enum HostEvent {
4366
4387
  /**
4367
4388
  * Trigger the **Manage alerts** action on a KPI chart
4368
4389
  * in a visualization or saved Answer.
4390
+ *
4369
4391
  * @param - an object with `vizId` as a key
4370
4392
  * @example
4371
4393
  * ```js
@@ -4373,10 +4395,12 @@ export declare enum HostEvent {
4373
4395
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4374
4396
  * })
4375
4397
  * ```
4398
+ *
4376
4399
  * @example
4377
4400
  * ```js
4378
4401
  * searchEmbed.trigger(HostEvent.ManageMonitor)
4379
4402
  * ```
4403
+ *
4380
4404
  * @example
4381
4405
  * ```js
4382
4406
  * vizEmbed.trigger(HostEvent.ManageMonitor)
@@ -4774,6 +4798,7 @@ export declare enum HostEvent {
4774
4798
  /**
4775
4799
  * Get the answer session for a Search or
4776
4800
  * Liveboard visualization.
4801
+ *
4777
4802
  * @example
4778
4803
  * ```js
4779
4804
  * const {session} = await embed.trigger(
@@ -4781,10 +4806,12 @@ export declare enum HostEvent {
4781
4806
  * vizId: '123', // For Liveboard Visualization.
4782
4807
  * })
4783
4808
  * ```
4809
+ *
4784
4810
  * @example
4785
4811
  * ```js
4786
4812
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
4787
4813
  * ```
4814
+ *
4788
4815
  * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
4789
4816
  */
4790
4817
  GetAnswerSession = "getAnswerSession",
@@ -5503,6 +5530,7 @@ export declare enum Action {
5503
5530
  /**
5504
5531
  * @deprecated
5505
5532
  * Reports errors
5533
+ *
5506
5534
  * @example
5507
5535
  * ```js
5508
5536
  * disabledActions: [Action.ReportError]
@@ -5732,12 +5760,14 @@ export declare enum Action {
5732
5760
  * ```js
5733
5761
  * disabledActions: [Action.RequestVerification]
5734
5762
  * ```
5763
+ *
5735
5764
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5736
5765
  */
5737
5766
  RequestVerification = "requestVerification",
5738
5767
  /**
5739
5768
  *
5740
- *Allows users to mark a Liveboard as verified.
5769
+ * Allows users to mark a Liveboard as verified.
5770
+ *
5741
5771
  * @example
5742
5772
  * ```js
5743
5773
  * disabledActions: [Action.MarkAsVerified]
@@ -5748,6 +5778,7 @@ export declare enum Action {
5748
5778
  /**
5749
5779
  * The **Add Tab** action on a Liveboard.
5750
5780
  * Allows adding a new tab to a Liveboard view.
5781
+ *
5751
5782
  * @example
5752
5783
  * ```js
5753
5784
  * disabledActions: [Action.AddTab]
@@ -5757,7 +5788,8 @@ export declare enum Action {
5757
5788
  AddTab = "addTab",
5758
5789
  /**
5759
5790
  *
5760
- *Initiates contextual change analysis on KPI charts.
5791
+ * Initiates contextual change analysis on KPI charts.
5792
+ *
5761
5793
  * @example
5762
5794
  * ```js
5763
5795
  * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -5771,6 +5803,7 @@ export declare enum Action {
5771
5803
  * ```js
5772
5804
  * disabledActions: [Action.ShowSageQuery]
5773
5805
  * ```
5806
+ *
5774
5807
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5775
5808
  */
5776
5809
  ShowSageQuery = "showSageQuery",
@@ -5785,7 +5818,8 @@ export declare enum Action {
5785
5818
  EditSageAnswer = "editSageAnswer",
5786
5819
  /**
5787
5820
  *
5788
- *This action allows users to send feedback on AI-generated Answers.
5821
+ * This action allows users to send feedback on AI-generated Answers.
5822
+ *
5789
5823
  * @example
5790
5824
  * ```js
5791
5825
  * disabledActions: [Action.SageAnswerFeedback]
@@ -5862,6 +5896,7 @@ export declare enum Action {
5862
5896
  * hiddenAction: [Action.CreateLiveboard]
5863
5897
  * disabledActions: [Action.CreateLiveboard]
5864
5898
  * ```
5899
+ *
5865
5900
  * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
5866
5901
  */
5867
5902
  CreateLiveboard = "createLiveboard",
@@ -5957,6 +5992,7 @@ export declare enum Action {
5957
5992
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
5958
5993
  /**
5959
5994
  * The **Manage Tags** action on Homepage Favourite Module.
5995
+ *
5960
5996
  * @example
5961
5997
  * ```js
5962
5998
  * disabledActions: [Action.ManageTags]
@@ -6694,6 +6730,7 @@ export declare function testResetMixpanel(): void;
6694
6730
  * Fetch wrapper that adds the authentication token to the request.
6695
6731
  * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
6696
6732
  * The interface for this method is the same as Web `Fetch`.
6733
+ *
6697
6734
  * @param input
6698
6735
  * @param init
6699
6736
  * @example
@@ -1415,6 +1415,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1415
1415
  *
1416
1416
  * Since, this will show preview images, be careful that it may show
1417
1417
  * undesired data to the user when using row level security.
1418
+ *
1418
1419
  * @example
1419
1420
  * ```js
1420
1421
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -1424,6 +1425,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1424
1425
  * });
1425
1426
  * embed.render();
1426
1427
  * ```
1428
+ *
1427
1429
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
1428
1430
  */
1429
1431
  showPreviewLoader?: boolean;
@@ -1466,6 +1468,13 @@ export declare class LiveboardEmbed extends V1Embed {
1466
1468
  */
1467
1469
  render(): Promise<LiveboardEmbed>;
1468
1470
  navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
1471
+ /**
1472
+ * Returns the full url of the liveboard/viz which can be used to open
1473
+ * this liveboard inside the full Thoughtspot application in a new tab.
1474
+ *
1475
+ * @returns url string
1476
+ */
1477
+ getLiveboardUrl(): string;
1469
1478
  }
1470
1479
  /**
1471
1480
  * @hidden
@@ -3919,23 +3928,28 @@ export declare enum HostEvent {
3919
3928
  /**
3920
3929
  * Trigger the **Make a copy** action on a Liveboard,
3921
3930
  * visualization, or Answer page.
3931
+ *
3922
3932
  * @example
3923
3933
  * ```js
3924
3934
  * liveboardEmbed.trigger(HostEvent.MakeACopy)
3925
3935
  * ```
3936
+ *
3926
3937
  * @example
3927
3938
  * ```js
3928
3939
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {
3929
3940
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3930
3941
  * ```
3942
+ *
3931
3943
  * @example
3932
3944
  * ```js
3933
3945
  * vizEmbed.trigger(HostEvent.MakeACopy)
3934
3946
  * ```
3947
+ *
3935
3948
  * @example
3936
3949
  * ```js
3937
3950
  * searchEmbed.trigger(HostEvent.MakeACopy)
3938
3951
  * ```
3952
+ *
3939
3953
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3940
3954
  */
3941
3955
  MakeACopy = "makeACopy",
@@ -3961,6 +3975,7 @@ export declare enum HostEvent {
3961
3975
  /**
3962
3976
  * Trigger the **Create alert** action on a KPI chart
3963
3977
  * in a Liveboard or saved Answer.
3978
+ *
3964
3979
  * @param - an object with `vizId` as a key
3965
3980
  * @example
3966
3981
  * ```js
@@ -3968,6 +3983,7 @@ export declare enum HostEvent {
3968
3983
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
3969
3984
  * })
3970
3985
  * ```
3986
+ *
3971
3987
  * @example
3972
3988
  * ```js
3973
3989
  * searchEmbed.trigger(HostEvent.CreateMonitor)
@@ -3978,6 +3994,7 @@ export declare enum HostEvent {
3978
3994
  /**
3979
3995
  * Trigger the **Manage alerts** action on a KPI chart
3980
3996
  * in a visualization or saved Answer.
3997
+ *
3981
3998
  * @param - an object with `vizId` as a key
3982
3999
  * @example
3983
4000
  * ```js
@@ -3985,10 +4002,12 @@ export declare enum HostEvent {
3985
4002
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
3986
4003
  * })
3987
4004
  * ```
4005
+ *
3988
4006
  * @example
3989
4007
  * ```js
3990
4008
  * searchEmbed.trigger(HostEvent.ManageMonitor)
3991
4009
  * ```
4010
+ *
3992
4011
  * @example
3993
4012
  * ```js
3994
4013
  * vizEmbed.trigger(HostEvent.ManageMonitor)
@@ -4386,6 +4405,7 @@ export declare enum HostEvent {
4386
4405
  /**
4387
4406
  * Get the answer session for a Search or
4388
4407
  * Liveboard visualization.
4408
+ *
4389
4409
  * @example
4390
4410
  * ```js
4391
4411
  * const {session} = await embed.trigger(
@@ -4393,10 +4413,12 @@ export declare enum HostEvent {
4393
4413
  * vizId: '123', // For Liveboard Visualization.
4394
4414
  * })
4395
4415
  * ```
4416
+ *
4396
4417
  * @example
4397
4418
  * ```js
4398
4419
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
4399
4420
  * ```
4421
+ *
4400
4422
  * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
4401
4423
  */
4402
4424
  GetAnswerSession = "getAnswerSession",
@@ -5115,6 +5137,7 @@ export declare enum Action {
5115
5137
  /**
5116
5138
  * @deprecated
5117
5139
  * Reports errors
5140
+ *
5118
5141
  * @example
5119
5142
  * ```js
5120
5143
  * disabledActions: [Action.ReportError]
@@ -5344,12 +5367,14 @@ export declare enum Action {
5344
5367
  * ```js
5345
5368
  * disabledActions: [Action.RequestVerification]
5346
5369
  * ```
5370
+ *
5347
5371
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5348
5372
  */
5349
5373
  RequestVerification = "requestVerification",
5350
5374
  /**
5351
5375
  *
5352
- *Allows users to mark a Liveboard as verified.
5376
+ * Allows users to mark a Liveboard as verified.
5377
+ *
5353
5378
  * @example
5354
5379
  * ```js
5355
5380
  * disabledActions: [Action.MarkAsVerified]
@@ -5360,6 +5385,7 @@ export declare enum Action {
5360
5385
  /**
5361
5386
  * The **Add Tab** action on a Liveboard.
5362
5387
  * Allows adding a new tab to a Liveboard view.
5388
+ *
5363
5389
  * @example
5364
5390
  * ```js
5365
5391
  * disabledActions: [Action.AddTab]
@@ -5369,7 +5395,8 @@ export declare enum Action {
5369
5395
  AddTab = "addTab",
5370
5396
  /**
5371
5397
  *
5372
- *Initiates contextual change analysis on KPI charts.
5398
+ * Initiates contextual change analysis on KPI charts.
5399
+ *
5373
5400
  * @example
5374
5401
  * ```js
5375
5402
  * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -5383,6 +5410,7 @@ export declare enum Action {
5383
5410
  * ```js
5384
5411
  * disabledActions: [Action.ShowSageQuery]
5385
5412
  * ```
5413
+ *
5386
5414
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5387
5415
  */
5388
5416
  ShowSageQuery = "showSageQuery",
@@ -5397,7 +5425,8 @@ export declare enum Action {
5397
5425
  EditSageAnswer = "editSageAnswer",
5398
5426
  /**
5399
5427
  *
5400
- *This action allows users to send feedback on AI-generated Answers.
5428
+ * This action allows users to send feedback on AI-generated Answers.
5429
+ *
5401
5430
  * @example
5402
5431
  * ```js
5403
5432
  * disabledActions: [Action.SageAnswerFeedback]
@@ -5474,6 +5503,7 @@ export declare enum Action {
5474
5503
  * hiddenAction: [Action.CreateLiveboard]
5475
5504
  * disabledActions: [Action.CreateLiveboard]
5476
5505
  * ```
5506
+ *
5477
5507
  * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
5478
5508
  */
5479
5509
  CreateLiveboard = "createLiveboard",
@@ -5569,6 +5599,7 @@ export declare enum Action {
5569
5599
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
5570
5600
  /**
5571
5601
  * The **Manage Tags** action on Homepage Favourite Module.
5602
+ *
5572
5603
  * @example
5573
5604
  * ```js
5574
5605
  * disabledActions: [Action.ManageTags]
@@ -6299,6 +6330,7 @@ export declare function notifyLogout(): void;
6299
6330
  * Services to be called after the login is successful,
6300
6331
  * This should be called after the cookie is set for cookie auth or
6301
6332
  * after the token is set for cookieless.
6333
+ *
6302
6334
  * @return {Promise<void>}
6303
6335
  * @example
6304
6336
  * ```js
@@ -6358,6 +6390,7 @@ export type SessionInfo = {
6358
6390
  * Returns the session info object and caches it for future use.
6359
6391
  * Once fetched the session info object is cached and returned from the cache on
6360
6392
  * subsequent calls.
6393
+ *
6361
6394
  * @example ```js
6362
6395
  * const sessionInfo = await getSessionInfo();
6363
6396
  * console.log(sessionInfo);
@@ -6369,6 +6402,7 @@ export declare function getSessionInfo(): Promise<SessionInfo>;
6369
6402
  /**
6370
6403
  * Returns the cached session info object. If the client is not authenticated the
6371
6404
  * function will return null.
6405
+ *
6372
6406
  * @example ```js
6373
6407
  * const sessionInfo = getCachedSessionInfo();
6374
6408
  * if (sessionInfo) {
@@ -6383,6 +6417,7 @@ export declare function getSessionInfo(): Promise<SessionInfo>;
6383
6417
  export declare function getCachedSessionInfo(): SessionInfo | null;
6384
6418
  /**
6385
6419
  * Processes the session info response and returns the session info object.
6420
+ *
6386
6421
  * @param sessionInfoResp {any} Response from the session info API.
6387
6422
  * @returns {SessionInfo} The session info object.
6388
6423
  * @example ```js
@@ -6395,6 +6430,7 @@ export declare function getCachedSessionInfo(): SessionInfo | null;
6395
6430
  export declare const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
6396
6431
  /**
6397
6432
  * Resets the cached session info object and forces a new fetch on the next call.
6433
+ *
6398
6434
  * @example ```js
6399
6435
  * resetCachedSessionInfo();
6400
6436
  * const sessionInfo = await getSessionInfo();
@@ -6984,6 +7020,7 @@ export declare function testResetMixpanel(): void;
6984
7020
  * Fetch wrapper that adds the authentication token to the request.
6985
7021
  * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
6986
7022
  * The interface for this method is the same as Web `Fetch`.
7023
+ *
6987
7024
  * @param input
6988
7025
  * @param init
6989
7026
  * @example
@@ -831,6 +831,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
831
831
  *
832
832
  * Since, this will show preview images, be careful that it may show
833
833
  * undesired data to the user when using row level security.
834
+ *
834
835
  * @example
835
836
  * ```js
836
837
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -840,6 +841,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
840
841
  * });
841
842
  * embed.render();
842
843
  * ```
844
+ *
843
845
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
844
846
  */
845
847
  showPreviewLoader?: boolean;
@@ -882,6 +884,13 @@ export class LiveboardEmbed extends V1Embed {
882
884
  */
883
885
  render(): Promise<LiveboardEmbed>;
884
886
  navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
887
+ /**
888
+ * Returns the full url of the liveboard/viz which can be used to open
889
+ * this liveboard inside the full Thoughtspot application in a new tab.
890
+ *
891
+ * @returns url string
892
+ */
893
+ getLiveboardUrl(): string;
885
894
  }
886
895
  /**
887
896
  * @hidden
@@ -1409,6 +1418,7 @@ export function notifyLogout(): void;
1409
1418
  * Services to be called after the login is successful,
1410
1419
  * This should be called after the cookie is set for cookie auth or
1411
1420
  * after the token is set for cookieless.
1421
+ *
1412
1422
  * @return {Promise<void>}
1413
1423
  * @example
1414
1424
  * ```js
@@ -1468,6 +1478,7 @@ export type SessionInfo = {
1468
1478
  * Returns the session info object and caches it for future use.
1469
1479
  * Once fetched the session info object is cached and returned from the cache on
1470
1480
  * subsequent calls.
1481
+ *
1471
1482
  * @example ```js
1472
1483
  * const sessionInfo = await getSessionInfo();
1473
1484
  * console.log(sessionInfo);
@@ -1479,6 +1490,7 @@ export function getSessionInfo(): Promise<SessionInfo>;
1479
1490
  /**
1480
1491
  * Returns the cached session info object. If the client is not authenticated the
1481
1492
  * function will return null.
1493
+ *
1482
1494
  * @example ```js
1483
1495
  * const sessionInfo = getCachedSessionInfo();
1484
1496
  * if (sessionInfo) {
@@ -1493,6 +1505,7 @@ export function getSessionInfo(): Promise<SessionInfo>;
1493
1505
  export function getCachedSessionInfo(): SessionInfo | null;
1494
1506
  /**
1495
1507
  * Processes the session info response and returns the session info object.
1508
+ *
1496
1509
  * @param sessionInfoResp {any} Response from the session info API.
1497
1510
  * @returns {SessionInfo} The session info object.
1498
1511
  * @example ```js
@@ -1505,6 +1518,7 @@ export function getCachedSessionInfo(): SessionInfo | null;
1505
1518
  export const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
1506
1519
  /**
1507
1520
  * Resets the cached session info object and forces a new fetch on the next call.
1521
+ *
1508
1522
  * @example ```js
1509
1523
  * resetCachedSessionInfo();
1510
1524
  * const sessionInfo = await getSessionInfo();
@@ -3933,23 +3947,28 @@ export enum HostEvent {
3933
3947
  /**
3934
3948
  * Trigger the **Make a copy** action on a Liveboard,
3935
3949
  * visualization, or Answer page.
3950
+ *
3936
3951
  * @example
3937
3952
  * ```js
3938
3953
  * liveboardEmbed.trigger(HostEvent.MakeACopy)
3939
3954
  * ```
3955
+ *
3940
3956
  * @example
3941
3957
  * ```js
3942
3958
  * liveboardEmbed.trigger(HostEvent.MakeACopy, {
3943
3959
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3944
3960
  * ```
3961
+ *
3945
3962
  * @example
3946
3963
  * ```js
3947
3964
  * vizEmbed.trigger(HostEvent.MakeACopy)
3948
3965
  * ```
3966
+ *
3949
3967
  * @example
3950
3968
  * ```js
3951
3969
  * searchEmbed.trigger(HostEvent.MakeACopy)
3952
3970
  * ```
3971
+ *
3953
3972
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3954
3973
  */
3955
3974
  MakeACopy = "makeACopy",
@@ -3975,6 +3994,7 @@ export enum HostEvent {
3975
3994
  /**
3976
3995
  * Trigger the **Create alert** action on a KPI chart
3977
3996
  * in a Liveboard or saved Answer.
3997
+ *
3978
3998
  * @param - an object with `vizId` as a key
3979
3999
  * @example
3980
4000
  * ```js
@@ -3982,6 +4002,7 @@ export enum HostEvent {
3982
4002
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
3983
4003
  * })
3984
4004
  * ```
4005
+ *
3985
4006
  * @example
3986
4007
  * ```js
3987
4008
  * searchEmbed.trigger(HostEvent.CreateMonitor)
@@ -3992,6 +4013,7 @@ export enum HostEvent {
3992
4013
  /**
3993
4014
  * Trigger the **Manage alerts** action on a KPI chart
3994
4015
  * in a visualization or saved Answer.
4016
+ *
3995
4017
  * @param - an object with `vizId` as a key
3996
4018
  * @example
3997
4019
  * ```js
@@ -3999,10 +4021,12 @@ export enum HostEvent {
3999
4021
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4000
4022
  * })
4001
4023
  * ```
4024
+ *
4002
4025
  * @example
4003
4026
  * ```js
4004
4027
  * searchEmbed.trigger(HostEvent.ManageMonitor)
4005
4028
  * ```
4029
+ *
4006
4030
  * @example
4007
4031
  * ```js
4008
4032
  * vizEmbed.trigger(HostEvent.ManageMonitor)
@@ -4400,6 +4424,7 @@ export enum HostEvent {
4400
4424
  /**
4401
4425
  * Get the answer session for a Search or
4402
4426
  * Liveboard visualization.
4427
+ *
4403
4428
  * @example
4404
4429
  * ```js
4405
4430
  * const {session} = await embed.trigger(
@@ -4407,10 +4432,12 @@ export enum HostEvent {
4407
4432
  * vizId: '123', // For Liveboard Visualization.
4408
4433
  * })
4409
4434
  * ```
4435
+ *
4410
4436
  * @example
4411
4437
  * ```js
4412
4438
  * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
4413
4439
  * ```
4440
+ *
4414
4441
  * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
4415
4442
  */
4416
4443
  GetAnswerSession = "getAnswerSession",
@@ -5129,6 +5156,7 @@ export enum Action {
5129
5156
  /**
5130
5157
  * @deprecated
5131
5158
  * Reports errors
5159
+ *
5132
5160
  * @example
5133
5161
  * ```js
5134
5162
  * disabledActions: [Action.ReportError]
@@ -5358,12 +5386,14 @@ export enum Action {
5358
5386
  * ```js
5359
5387
  * disabledActions: [Action.RequestVerification]
5360
5388
  * ```
5389
+ *
5361
5390
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5362
5391
  */
5363
5392
  RequestVerification = "requestVerification",
5364
5393
  /**
5365
5394
  *
5366
- *Allows users to mark a Liveboard as verified.
5395
+ * Allows users to mark a Liveboard as verified.
5396
+ *
5367
5397
  * @example
5368
5398
  * ```js
5369
5399
  * disabledActions: [Action.MarkAsVerified]
@@ -5374,6 +5404,7 @@ export enum Action {
5374
5404
  /**
5375
5405
  * The **Add Tab** action on a Liveboard.
5376
5406
  * Allows adding a new tab to a Liveboard view.
5407
+ *
5377
5408
  * @example
5378
5409
  * ```js
5379
5410
  * disabledActions: [Action.AddTab]
@@ -5383,7 +5414,8 @@ export enum Action {
5383
5414
  AddTab = "addTab",
5384
5415
  /**
5385
5416
  *
5386
- *Initiates contextual change analysis on KPI charts.
5417
+ * Initiates contextual change analysis on KPI charts.
5418
+ *
5387
5419
  * @example
5388
5420
  * ```js
5389
5421
  * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -5397,6 +5429,7 @@ export enum Action {
5397
5429
  * ```js
5398
5430
  * disabledActions: [Action.ShowSageQuery]
5399
5431
  * ```
5432
+ *
5400
5433
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5401
5434
  */
5402
5435
  ShowSageQuery = "showSageQuery",
@@ -5411,7 +5444,8 @@ export enum Action {
5411
5444
  EditSageAnswer = "editSageAnswer",
5412
5445
  /**
5413
5446
  *
5414
- *This action allows users to send feedback on AI-generated Answers.
5447
+ * This action allows users to send feedback on AI-generated Answers.
5448
+ *
5415
5449
  * @example
5416
5450
  * ```js
5417
5451
  * disabledActions: [Action.SageAnswerFeedback]
@@ -5488,6 +5522,7 @@ export enum Action {
5488
5522
  * hiddenAction: [Action.CreateLiveboard]
5489
5523
  * disabledActions: [Action.CreateLiveboard]
5490
5524
  * ```
5525
+ *
5491
5526
  * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
5492
5527
  */
5493
5528
  CreateLiveboard = "createLiveboard",
@@ -5583,6 +5618,7 @@ export enum Action {
5583
5618
  UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
5584
5619
  /**
5585
5620
  * The **Manage Tags** action on Homepage Favourite Module.
5621
+ *
5586
5622
  * @example
5587
5623
  * ```js
5588
5624
  * disabledActions: [Action.ManageTags]
@@ -6466,6 +6502,7 @@ export function testResetMixpanel(): void;
6466
6502
  * Fetch wrapper that adds the authentication token to the request.
6467
6503
  * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
6468
6504
  * The interface for this method is the same as Web `Fetch`.
6505
+ *
6469
6506
  * @param input
6470
6507
  * @param init
6471
6508
  * @example