@thoughtspot/visual-embed-sdk 1.35.10 → 1.35.11

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 (116) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +11 -2
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js.map +1 -1
  5. package/cjs/src/embed/hostEventClient/contracts.d.ts +1 -1
  6. package/cjs/src/embed/hostEventClient/contracts.js +1 -1
  7. package/cjs/src/embed/liveboard.d.ts +2 -0
  8. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  9. package/cjs/src/embed/liveboard.js +1 -1
  10. package/cjs/src/embed/liveboard.js.map +1 -1
  11. package/cjs/src/embed/liveboard.spec.js +16 -0
  12. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  13. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  14. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  15. package/cjs/src/embed/searchEmbed-basic-auth.spec.js +104 -0
  16. package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
  17. package/cjs/src/hostEventsTypeMapping.d.ts +2 -0
  18. package/cjs/src/hostEventsTypeMapping.d.ts.map +1 -0
  19. package/cjs/src/hostEventsTypeMapping.js +4 -0
  20. package/cjs/src/hostEventsTypeMapping.js.map +1 -0
  21. package/cjs/src/types.d.ts +253 -155
  22. package/cjs/src/types.d.ts.map +1 -1
  23. package/cjs/src/types.js +229 -131
  24. package/cjs/src/types.js.map +1 -1
  25. package/cjs/src/utils/embedApi/contracts.d.ts +101 -0
  26. package/cjs/src/utils/embedApi/contracts.d.ts.map +1 -0
  27. package/cjs/src/utils/embedApi/contracts.js +17 -0
  28. package/cjs/src/utils/embedApi/contracts.js.map +1 -0
  29. package/cjs/src/utils/embedApi/embedApiClient.d.ts +12 -0
  30. package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  31. package/cjs/src/utils/embedApi/embedApiClient.js +46 -0
  32. package/cjs/src/utils/embedApi/embedApiClient.js.map +1 -0
  33. package/cjs/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  34. package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  35. package/cjs/src/utils/embedApi/processEmbedApi.js +18 -0
  36. package/cjs/src/utils/embedApi/processEmbedApi.js.map +1 -0
  37. package/dist/{index-DWOIXXJ1.js → index-BBBimG1x.js} +1 -1
  38. package/dist/index-BGnxP5NY.js +7370 -0
  39. package/dist/index-CENLvayL.js +7370 -0
  40. package/dist/index-CbltIawo.js +7370 -0
  41. package/dist/index-CoQfqaHj.js +7370 -0
  42. package/dist/index-CzwzS0P4.js +7370 -0
  43. package/dist/index-DFwi_pV_.js +7370 -0
  44. package/dist/index-DOIjN0N_.js +7370 -0
  45. package/dist/index-DYBx8SuE.js +7370 -0
  46. package/dist/index-DaLHJaLd.js +7370 -0
  47. package/dist/index-DnJX-gN2.js +7370 -0
  48. package/dist/index-IDmSUe93.js +7370 -0
  49. package/dist/index-nWevLycs.js +7370 -0
  50. package/dist/src/embed/app.d.ts +11 -2
  51. package/dist/src/embed/app.d.ts.map +1 -1
  52. package/dist/src/embed/hostEventClient/contracts.d.ts +1 -1
  53. package/dist/src/embed/liveboard.d.ts +2 -0
  54. package/dist/src/embed/liveboard.d.ts.map +1 -1
  55. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  56. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  57. package/dist/src/hostEventsTypeMapping.d.ts +2 -0
  58. package/dist/src/hostEventsTypeMapping.d.ts.map +1 -0
  59. package/dist/src/types.d.ts +253 -155
  60. package/dist/src/types.d.ts.map +1 -1
  61. package/dist/src/utils/embedApi/contracts.d.ts +101 -0
  62. package/dist/src/utils/embedApi/contracts.d.ts.map +1 -0
  63. package/dist/src/utils/embedApi/embedApiClient.d.ts +12 -0
  64. package/dist/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  65. package/dist/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  66. package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  67. package/dist/tsembed-react.es.js +234 -136
  68. package/dist/tsembed-react.js +233 -135
  69. package/dist/tsembed.es.js +234 -136
  70. package/dist/tsembed.js +233 -135
  71. package/dist/visual-embed-sdk-react-full.d.ts +267 -158
  72. package/dist/visual-embed-sdk-react.d.ts +267 -158
  73. package/dist/visual-embed-sdk.d.ts +267 -158
  74. package/lib/package.json +1 -1
  75. package/lib/src/embed/app.d.ts +11 -2
  76. package/lib/src/embed/app.d.ts.map +1 -1
  77. package/lib/src/embed/app.js.map +1 -1
  78. package/lib/src/embed/hostEventClient/contracts.d.ts +1 -1
  79. package/lib/src/embed/hostEventClient/contracts.js +1 -1
  80. package/lib/src/embed/liveboard.d.ts +2 -0
  81. package/lib/src/embed/liveboard.d.ts.map +1 -1
  82. package/lib/src/embed/liveboard.js +1 -1
  83. package/lib/src/embed/liveboard.js.map +1 -1
  84. package/lib/src/embed/liveboard.spec.js +16 -0
  85. package/lib/src/embed/liveboard.spec.js.map +1 -1
  86. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +2 -0
  87. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +1 -0
  88. package/lib/src/embed/searchEmbed-basic-auth.spec.js +101 -0
  89. package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -0
  90. package/lib/src/hostEventsTypeMapping.d.ts +2 -0
  91. package/lib/src/hostEventsTypeMapping.d.ts.map +1 -0
  92. package/lib/src/hostEventsTypeMapping.js +2 -0
  93. package/lib/src/hostEventsTypeMapping.js.map +1 -0
  94. package/lib/src/types.d.ts +253 -155
  95. package/lib/src/types.d.ts.map +1 -1
  96. package/lib/src/types.js +229 -131
  97. package/lib/src/types.js.map +1 -1
  98. package/lib/src/utils/embedApi/contracts.d.ts +101 -0
  99. package/lib/src/utils/embedApi/contracts.d.ts.map +1 -0
  100. package/lib/src/utils/embedApi/contracts.js +14 -0
  101. package/lib/src/utils/embedApi/contracts.js.map +1 -0
  102. package/lib/src/utils/embedApi/embedApiClient.d.ts +12 -0
  103. package/lib/src/utils/embedApi/embedApiClient.d.ts.map +1 -0
  104. package/lib/src/utils/embedApi/embedApiClient.js +42 -0
  105. package/lib/src/utils/embedApi/embedApiClient.js.map +1 -0
  106. package/lib/src/utils/embedApi/processEmbedApi.d.ts +9 -0
  107. package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +1 -0
  108. package/lib/src/utils/embedApi/processEmbedApi.js +14 -0
  109. package/lib/src/utils/embedApi/processEmbedApi.js.map +1 -0
  110. package/lib/src/visual-embed-sdk.d.ts +267 -158
  111. package/package.json +1 -1
  112. package/src/embed/app.ts +11 -2
  113. package/src/embed/hostEventClient/contracts.ts +1 -1
  114. package/src/embed/liveboard.spec.ts +22 -1
  115. package/src/embed/liveboard.ts +3 -1
  116. package/src/types.ts +253 -161
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.35.10",
3
+ "version": "1.35.11",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
package/src/embed/app.ts CHANGED
@@ -257,8 +257,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
257
257
  */
258
258
  enableSearchAssist?: boolean;
259
259
  /**
260
- * If set to true, the embedded object container dynamically resizes
261
- * according to the height of the pages which support fullHeight mode.
260
+ * If set to true, the Liveboard container dynamically resizes
261
+ * according to the height of the Liveboard.
262
+ *
263
+ * **Note**: Using fullHeight loads all visualizations
264
+ * on the Liveboard simultaneously, which results in
265
+ * multiple warehouse queries and potentially a
266
+ * longer wait for the topmost visualizations to
267
+ * display on the screen. Setting fullHeight to
268
+ * `false` fetches visualizations incrementally as
269
+ * users scroll the page to view the charts and tables.
270
+ *
262
271
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
263
272
  * @example
264
273
  * ```js
@@ -4,7 +4,7 @@ export enum UIPassthroughEvent {
4
4
  PinAnswerToLiveboard = 'addVizToPinboard',
5
5
  SaveAnswer = 'saveAnswer',
6
6
  GetDiscoverabilityStatus = 'getDiscoverabilityStatus',
7
- GetAvailableUIPassthroughs = 'getAvailableUIPassthroughs',
7
+ GetAvailableUIPassthroughs = 'getAvailableUiPassthroughs',
8
8
  GetAnswerConfig = 'getAnswerPageConfig',
9
9
  GetLiveboardConfig = 'getPinboardPageConfig',
10
10
  }
@@ -1,5 +1,5 @@
1
1
  import { LiveboardViewConfig, LiveboardEmbed } from './liveboard';
2
- import { init } from '../index';
2
+ import { init, UIPassthroughEvent } from '../index';
3
3
  import {
4
4
  Action,
5
5
  AuthType,
@@ -767,4 +767,25 @@ describe('Liveboard/viz embed tests', () => {
767
767
  });
768
768
  });
769
769
  });
770
+
771
+ describe('Host events for liveborad', () => {
772
+ test('Host event with empty param', async () => {
773
+ const mockProcessTrigger = jest.spyOn(tsEmbed.TsEmbed.prototype, 'trigger');
774
+ const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
775
+ liveboardId: '123',
776
+ ...defaultViewConfig,
777
+ vizId: 'testViz',
778
+ });
779
+ liveboardEmbed.render();
780
+ mockProcessTrigger.mockResolvedValue({ session: 'test' });
781
+ await executeAfterWait(async () => {
782
+ await liveboardEmbed.trigger(
783
+ HostEvent.Save,
784
+ );
785
+ expect(mockProcessTrigger).toHaveBeenCalledWith(
786
+ HostEvent.Save, { vizId: 'testViz' },
787
+ );
788
+ });
789
+ });
790
+ });
770
791
  });
@@ -37,12 +37,14 @@ export interface LiveboardViewConfig
37
37
  /**
38
38
  * If set to true, the embedded object container dynamically resizes
39
39
  * according to the height of the Liveboard.
40
+ *
40
41
  * **Note**: Using fullHeight loads all visualizations on the
41
42
  * Liveboard simultaneously, which results in multiple warehouse
42
43
  * queries and potentially a longer wait for the topmost
43
44
  * visualizations to display on the screen.
44
45
  * Setting `fullHeight` to `false` fetches visualizations
45
46
  * incrementally as users scroll the page to view the charts and tables.
47
+ *
46
48
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
47
49
  * @example
48
50
  * ```js
@@ -640,7 +642,7 @@ export class LiveboardEmbed extends V1Embed {
640
642
  */
641
643
  public trigger<HostEventT extends HostEvent>(
642
644
  messageType: HostEventT,
643
- data?: HostEventRequest<HostEventT>,
645
+ data: HostEventRequest<HostEventT> = ({} as any),
644
646
  ): Promise<HostEventResponse<HostEventT>> {
645
647
  const dataWithVizId = data;
646
648
  if (messageType === HostEvent.SetActiveTab) {