@thoughtspot/visual-embed-sdk 1.46.5-beta.1 → 1.46.5

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 (180) hide show
  1. package/cjs/package.json +4 -4
  2. package/cjs/src/css-variables.d.ts +36 -0
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +41 -2
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +26 -46
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +36 -69
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/conversation.d.ts +23 -1
  11. package/cjs/src/embed/conversation.d.ts.map +1 -1
  12. package/cjs/src/embed/conversation.js +18 -33
  13. package/cjs/src/embed/conversation.js.map +1 -1
  14. package/cjs/src/embed/conversation.spec.js +129 -97
  15. package/cjs/src/embed/conversation.spec.js.map +1 -1
  16. package/cjs/src/embed/hostEventClient/contracts.d.ts +31 -0
  17. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  18. package/cjs/src/embed/hostEventClient/contracts.js +2 -0
  19. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  20. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +18 -0
  21. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  22. package/cjs/src/embed/hostEventClient/host-event-client.js +69 -9
  23. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  24. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +185 -19
  25. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  26. package/cjs/src/embed/hostEventClient/utils.d.ts +22 -0
  27. package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -0
  28. package/cjs/src/embed/hostEventClient/utils.js +51 -0
  29. package/cjs/src/embed/hostEventClient/utils.js.map +1 -0
  30. package/cjs/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  31. package/cjs/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  32. package/cjs/src/embed/hostEventClient/utils.spec.js +115 -0
  33. package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -0
  34. package/cjs/src/embed/liveboard.d.ts +18 -1
  35. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  36. package/cjs/src/embed/liveboard.js +9 -11
  37. package/cjs/src/embed/liveboard.js.map +1 -1
  38. package/cjs/src/embed/liveboard.spec.js +29 -71
  39. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  40. package/cjs/src/embed/spotter-utils.d.ts +20 -0
  41. package/cjs/src/embed/spotter-utils.d.ts.map +1 -0
  42. package/cjs/src/embed/spotter-utils.js +52 -0
  43. package/cjs/src/embed/spotter-utils.js.map +1 -0
  44. package/cjs/src/embed/spotter-utils.spec.d.ts +2 -0
  45. package/cjs/src/embed/spotter-utils.spec.d.ts.map +1 -0
  46. package/cjs/src/embed/spotter-utils.spec.js +54 -0
  47. package/cjs/src/embed/spotter-utils.spec.js.map +1 -0
  48. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  49. package/cjs/src/embed/ts-embed.js +13 -1
  50. package/cjs/src/embed/ts-embed.js.map +1 -1
  51. package/cjs/src/errors.d.ts +2 -0
  52. package/cjs/src/errors.d.ts.map +1 -1
  53. package/cjs/src/errors.js +2 -0
  54. package/cjs/src/errors.js.map +1 -1
  55. package/cjs/src/types.d.ts +102 -1
  56. package/cjs/src/types.d.ts.map +1 -1
  57. package/cjs/src/types.js +101 -0
  58. package/cjs/src/types.js.map +1 -1
  59. package/cjs/src/utils.d.ts +0 -9
  60. package/cjs/src/utils.d.ts.map +1 -1
  61. package/cjs/src/utils.js +1 -10
  62. package/cjs/src/utils.js.map +1 -1
  63. package/dist/index-ChNydfIz.js +7371 -0
  64. package/dist/index-DGV_zh53.js +7371 -0
  65. package/dist/src/css-variables.d.ts +36 -0
  66. package/dist/src/css-variables.d.ts.map +1 -1
  67. package/dist/src/embed/app.d.ts +41 -2
  68. package/dist/src/embed/app.d.ts.map +1 -1
  69. package/dist/src/embed/conversation.d.ts +23 -1
  70. package/dist/src/embed/conversation.d.ts.map +1 -1
  71. package/dist/src/embed/hostEventClient/contracts.d.ts +31 -0
  72. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  73. package/dist/src/embed/hostEventClient/host-event-client.d.ts +18 -0
  74. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  75. package/dist/src/embed/hostEventClient/utils.d.ts +22 -0
  76. package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -0
  77. package/dist/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  78. package/dist/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  79. package/dist/src/embed/liveboard.d.ts +18 -1
  80. package/dist/src/embed/liveboard.d.ts.map +1 -1
  81. package/dist/src/embed/spotter-utils.d.ts +20 -0
  82. package/dist/src/embed/spotter-utils.d.ts.map +1 -0
  83. package/dist/src/embed/spotter-utils.spec.d.ts +2 -0
  84. package/dist/src/embed/spotter-utils.spec.d.ts.map +1 -0
  85. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  86. package/dist/src/errors.d.ts +2 -0
  87. package/dist/src/errors.d.ts.map +1 -1
  88. package/dist/src/types.d.ts +102 -1
  89. package/dist/src/types.d.ts.map +1 -1
  90. package/dist/src/utils.d.ts +0 -9
  91. package/dist/src/utils.d.ts.map +1 -1
  92. package/dist/tsembed-react.es.js +324 -110
  93. package/dist/tsembed-react.js +323 -109
  94. package/dist/tsembed.es.js +324 -110
  95. package/dist/tsembed.js +323 -109
  96. package/dist/visual-embed-sdk-react-full.d.ts +266 -3
  97. package/dist/visual-embed-sdk-react.d.ts +266 -3
  98. package/dist/visual-embed-sdk.d.ts +266 -3
  99. package/lib/package.json +4 -4
  100. package/lib/src/css-variables.d.ts +36 -0
  101. package/lib/src/css-variables.d.ts.map +1 -1
  102. package/lib/src/embed/app.d.ts +41 -2
  103. package/lib/src/embed/app.d.ts.map +1 -1
  104. package/lib/src/embed/app.js +28 -48
  105. package/lib/src/embed/app.js.map +1 -1
  106. package/lib/src/embed/app.spec.js +36 -69
  107. package/lib/src/embed/app.spec.js.map +1 -1
  108. package/lib/src/embed/conversation.d.ts +23 -1
  109. package/lib/src/embed/conversation.d.ts.map +1 -1
  110. package/lib/src/embed/conversation.js +19 -34
  111. package/lib/src/embed/conversation.js.map +1 -1
  112. package/lib/src/embed/conversation.spec.js +131 -99
  113. package/lib/src/embed/conversation.spec.js.map +1 -1
  114. package/lib/src/embed/hostEventClient/contracts.d.ts +31 -0
  115. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  116. package/lib/src/embed/hostEventClient/contracts.js +2 -0
  117. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  118. package/lib/src/embed/hostEventClient/host-event-client.d.ts +18 -0
  119. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  120. package/lib/src/embed/hostEventClient/host-event-client.js +69 -9
  121. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  122. package/lib/src/embed/hostEventClient/host-event-client.spec.js +185 -19
  123. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  124. package/lib/src/embed/hostEventClient/utils.d.ts +22 -0
  125. package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -0
  126. package/lib/src/embed/hostEventClient/utils.js +43 -0
  127. package/lib/src/embed/hostEventClient/utils.js.map +1 -0
  128. package/lib/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  129. package/lib/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  130. package/lib/src/embed/hostEventClient/utils.spec.js +113 -0
  131. package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -0
  132. package/lib/src/embed/liveboard.d.ts +18 -1
  133. package/lib/src/embed/liveboard.d.ts.map +1 -1
  134. package/lib/src/embed/liveboard.js +9 -11
  135. package/lib/src/embed/liveboard.js.map +1 -1
  136. package/lib/src/embed/liveboard.spec.js +29 -71
  137. package/lib/src/embed/liveboard.spec.js.map +1 -1
  138. package/lib/src/embed/spotter-utils.d.ts +20 -0
  139. package/lib/src/embed/spotter-utils.d.ts.map +1 -0
  140. package/lib/src/embed/spotter-utils.js +47 -0
  141. package/lib/src/embed/spotter-utils.js.map +1 -0
  142. package/lib/src/embed/spotter-utils.spec.d.ts +2 -0
  143. package/lib/src/embed/spotter-utils.spec.d.ts.map +1 -0
  144. package/lib/src/embed/spotter-utils.spec.js +52 -0
  145. package/lib/src/embed/spotter-utils.spec.js.map +1 -0
  146. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  147. package/lib/src/embed/ts-embed.js +13 -1
  148. package/lib/src/embed/ts-embed.js.map +1 -1
  149. package/lib/src/errors.d.ts +2 -0
  150. package/lib/src/errors.d.ts.map +1 -1
  151. package/lib/src/errors.js +2 -0
  152. package/lib/src/errors.js.map +1 -1
  153. package/lib/src/types.d.ts +102 -1
  154. package/lib/src/types.d.ts.map +1 -1
  155. package/lib/src/types.js +101 -0
  156. package/lib/src/types.js.map +1 -1
  157. package/lib/src/utils.d.ts +0 -9
  158. package/lib/src/utils.d.ts.map +1 -1
  159. package/lib/src/utils.js +0 -8
  160. package/lib/src/utils.js.map +1 -1
  161. package/lib/src/visual-embed-sdk.d.ts +266 -3
  162. package/package.json +4 -4
  163. package/src/css-variables.ts +45 -0
  164. package/src/embed/app.spec.ts +51 -92
  165. package/src/embed/app.ts +60 -64
  166. package/src/embed/conversation.spec.ts +150 -119
  167. package/src/embed/conversation.ts +30 -54
  168. package/src/embed/hostEventClient/contracts.ts +31 -0
  169. package/src/embed/hostEventClient/host-event-client.spec.ts +260 -19
  170. package/src/embed/hostEventClient/host-event-client.ts +87 -11
  171. package/src/embed/hostEventClient/utils.spec.ts +137 -0
  172. package/src/embed/hostEventClient/utils.ts +61 -0
  173. package/src/embed/liveboard.spec.ts +38 -93
  174. package/src/embed/liveboard.ts +28 -10
  175. package/src/embed/spotter-utils.spec.ts +56 -0
  176. package/src/embed/spotter-utils.ts +65 -0
  177. package/src/embed/ts-embed.ts +15 -1
  178. package/src/errors.ts +2 -0
  179. package/src/types.ts +104 -0
  180. package/src/utils.ts +0 -14
package/src/types.ts CHANGED
@@ -2738,6 +2738,17 @@ export enum EmbedEvent {
2738
2738
  * ```
2739
2739
  */
2740
2740
  DownloadAsXlsx = 'downloadAsXlsx',
2741
+ /**
2742
+ * Emitted when the Download Liveboard as Continuous PDF action is triggered
2743
+ * on a Liveboard.
2744
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
2745
+ * @example
2746
+ * ```js
2747
+ * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
2748
+ * console.log('download liveboard as continuous PDF', payload)})
2749
+ * ```
2750
+ */
2751
+ DownloadLiveboardAsContinuousPDF = 'downloadLiveboardAsContinuousPDF',
2741
2752
  /**
2742
2753
  * Emitted when an Answer is deleted in the app
2743
2754
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
@@ -4268,6 +4279,18 @@ export enum HostEvent {
4268
4279
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4269
4280
  */
4270
4281
  DownloadAsPdf = 'downloadAsPdf',
4282
+ /**
4283
+ * Trigger the **Download Liveboard as Continuous PDF** action on an
4284
+ * embedded Liveboard.
4285
+ *
4286
+ * @example
4287
+ * ```js
4288
+ * liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
4289
+ * ```
4290
+ *
4291
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4292
+ */
4293
+ DownloadLiveboardAsContinuousPDF = 'downloadLiveboardAsContinuousPDF',
4271
4294
  /**
4272
4295
  * Trigger the **AI Highlights** action on an embedded Liveboard
4273
4296
  *
@@ -4494,6 +4517,20 @@ export enum HostEvent {
4494
4517
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4495
4518
  * }, ContextType.Liveboard);
4496
4519
  * ```
4520
+ * @example
4521
+ * ```js
4522
+ * // Copy link from liveboard context
4523
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4524
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
4525
+ * ```
4526
+ * @example
4527
+ * ```js
4528
+ * // Copy link from liveboard visualization context
4529
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4530
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
4531
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4532
+ * }, ContextType.Liveboard);
4533
+ * ```
4497
4534
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4498
4535
  */
4499
4536
  CopyLink = 'embedDocument',
@@ -4525,6 +4562,20 @@ export enum HostEvent {
4525
4562
  * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4526
4563
  * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
4527
4564
  * ```
4565
+ * @example
4566
+ * ```js
4567
+ * // Present from liveboard visualization context
4568
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4569
+ * liveboardEmbed.trigger(HostEvent.Present, {
4570
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4571
+ * }, ContextType.Liveboard);
4572
+ * ```
4573
+ * @example
4574
+ * ```js
4575
+ * // Present from liveboard context
4576
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4577
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
4578
+ * ```
4528
4579
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4529
4580
  */
4530
4581
  Present = 'present',
@@ -5826,6 +5877,7 @@ export enum Param {
5826
5877
  IsLazyLoadingForEmbedEnabled = 'isLazyLoadingForEmbedEnabled',
5827
5878
  RootMarginForLazyLoad = 'rootMarginForLazyLoad',
5828
5879
  isPNGInScheduledEmailsEnabled = 'isPNGInScheduledEmailsEnabled',
5880
+ IsWYSIWYGLiveboardPDFEnabled = 'isWYSIWYGLiveboardPDFEnabled',
5829
5881
  isLiveboardXLSXCSVDownloadEnabled = 'isLiveboardXLSXCSVDownloadEnabled',
5830
5882
  isGranularXLSXCSVSchedulesEnabled = 'isGranularXLSXCSVSchedulesEnabled',
5831
5883
  isCentralizedLiveboardFilterUXEnabled = 'isCentralizedLiveboardFilterUXEnabled',
@@ -6171,6 +6223,16 @@ export enum Action {
6171
6223
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
6172
6224
  */
6173
6225
  DownloadLiveboard = 'downloadLiveboard',
6226
+ /**
6227
+ * The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
6228
+ * Allows downloading the entire Liveboard as a continuous PDF.
6229
+ * @example
6230
+ * ```js
6231
+ * disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
6232
+ * ```
6233
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6234
+ */
6235
+ DownloadLiveboardAsContinuousPDF = 'downloadLiveboardAsContinuousPDF',
6174
6236
  /**
6175
6237
  * @hidden
6176
6238
  */
@@ -7407,6 +7469,39 @@ export enum Action {
7407
7469
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
7408
7470
  */
7409
7471
  SpotterDocs = 'spotterDocs',
7472
+ /**
7473
+ * Controls visibility and disable state of the connector resources
7474
+ * section in the Spotter chat interface.
7475
+ * @example
7476
+ * ```js
7477
+ * hiddenActions: [Action.SpotterChatConnectorResources]
7478
+ * disabledActions: [Action.SpotterChatConnectorResources]
7479
+ * ```
7480
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
7481
+ */
7482
+ SpotterChatConnectorResources = 'spotterChatConnectorResources',
7483
+ /**
7484
+ * Controls visibility and disable state of the connectors
7485
+ * in the Spotter chat interface.
7486
+ * @example
7487
+ * ```js
7488
+ * hiddenActions: [Action.SpotterChatConnectors]
7489
+ * disabledActions: [Action.SpotterChatConnectors]
7490
+ * ```
7491
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
7492
+ */
7493
+ SpotterChatConnectors = 'spotterChatConnectors',
7494
+ /**
7495
+ * Controls visibility and disable state of the mode switcher
7496
+ * in the Spotter chat interface.
7497
+ * @example
7498
+ * ```js
7499
+ * hiddenActions: [Action.SpotterChatModeSwitcher]
7500
+ * disabledActions: [Action.SpotterChatModeSwitcher]
7501
+ * ```
7502
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
7503
+ */
7504
+ SpotterChatModeSwitcher = 'spotterChatModeSwitcher',
7410
7505
  /**
7411
7506
  * The **Include current period** checkbox for date filters.
7412
7507
  * Controls the visibility and availability of the option to include
@@ -7783,6 +7878,15 @@ export enum EmbedErrorCodes {
7783
7878
 
7784
7879
  /** Invalid URL provided in configuration */
7785
7880
  INVALID_URL = 'INVALID_URL',
7881
+
7882
+ /** Host event payload validation failed */
7883
+ HOST_EVENT_VALIDATION = 'HOST_EVENT_VALIDATION',
7884
+
7885
+ /** UpdateFilters payload is invalid - missing or malformed filter/filters */
7886
+ UPDATEFILTERS_INVALID_PAYLOAD = 'UPDATEFILTERS_INVALID_PAYLOAD',
7887
+
7888
+ /** DrillDown payload is invalid - missing or malformed points */
7889
+ DRILLDOWN_INVALID_PAYLOAD = 'DRILLDOWN_INVALID_PAYLOAD',
7786
7890
  }
7787
7891
 
7788
7892
  /**
package/src/utils.ts CHANGED
@@ -600,20 +600,6 @@ export const validateHttpUrl = (url: string): [boolean, Error | null] => {
600
600
  }
601
601
  };
602
602
 
603
- /**
604
- * Resolves enablePastConversationsSidebar with
605
- * spotterSidebarConfig taking precedence over the
606
- * standalone flag.
607
- */
608
- export const resolveEnablePastConversationsSidebar = (params: {
609
- spotterSidebarConfigValue?: boolean;
610
- standaloneValue?: boolean;
611
- }): boolean | undefined => (
612
- params.spotterSidebarConfigValue !== undefined
613
- ? params.spotterSidebarConfigValue
614
- : params.standaloneValue
615
- );
616
-
617
603
  /**
618
604
  * Sets a query parameter if the value is defined.
619
605
  * @param queryParams - The query params object to modify