@thoughtspot/visual-embed-sdk 1.52.2-beta.2 → 1.53.0

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 (237) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/css-variables.d.ts +373 -5
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +14 -0
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +6 -3
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +28 -0
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -1
  11. package/cjs/src/embed/auto-frame-renderer.js +244 -4
  12. package/cjs/src/embed/auto-frame-renderer.js.map +1 -1
  13. package/cjs/src/embed/auto-frame-renderer.spec.js +389 -0
  14. package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -1
  15. package/cjs/src/embed/bodyless-conversation.js +1 -1
  16. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  17. package/cjs/src/embed/conversation.d.ts +15 -0
  18. package/cjs/src/embed/conversation.d.ts.map +1 -1
  19. package/cjs/src/embed/conversation.js +7 -3
  20. package/cjs/src/embed/conversation.js.map +1 -1
  21. package/cjs/src/embed/conversation.spec.js +66 -0
  22. package/cjs/src/embed/conversation.spec.js.map +1 -1
  23. package/cjs/src/embed/liveboard-override-utils.d.ts +59 -0
  24. package/cjs/src/embed/liveboard-override-utils.d.ts.map +1 -0
  25. package/cjs/src/embed/liveboard-override-utils.js +19 -0
  26. package/cjs/src/embed/liveboard-override-utils.js.map +1 -0
  27. package/cjs/src/embed/liveboard-override-utils.spec.d.ts +2 -0
  28. package/cjs/src/embed/liveboard-override-utils.spec.d.ts.map +1 -0
  29. package/cjs/src/embed/liveboard-override-utils.spec.js +34 -0
  30. package/cjs/src/embed/liveboard-override-utils.spec.js.map +1 -0
  31. package/cjs/src/embed/liveboard.d.ts +58 -13
  32. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  33. package/cjs/src/embed/liveboard.js +11 -34
  34. package/cjs/src/embed/liveboard.js.map +1 -1
  35. package/cjs/src/embed/liveboard.spec.js +104 -79
  36. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  37. package/cjs/src/embed/search-bar.js +1 -1
  38. package/cjs/src/embed/search-bar.js.map +1 -1
  39. package/cjs/src/embed/search.js +1 -1
  40. package/cjs/src/embed/search.js.map +1 -1
  41. package/cjs/src/embed/search.spec.js +20 -0
  42. package/cjs/src/embed/search.spec.js.map +1 -1
  43. package/cjs/src/embed/spotter-utils.d.ts +11 -0
  44. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  45. package/cjs/src/embed/spotter-utils.js +13 -1
  46. package/cjs/src/embed/spotter-utils.js.map +1 -1
  47. package/cjs/src/embed/spotter-viz-utils.d.ts +15 -0
  48. package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
  49. package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
  50. package/cjs/src/embed/spotter-viz-utils.spec.js +11 -0
  51. package/cjs/src/embed/spotter-viz-utils.spec.js.map +1 -1
  52. package/cjs/src/embed/ts-embed.d.ts +27 -34
  53. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  54. package/cjs/src/embed/ts-embed.js +224 -102
  55. package/cjs/src/embed/ts-embed.js.map +1 -1
  56. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  57. package/cjs/src/embed/ts-embed.spec.js +543 -166
  58. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  59. package/cjs/src/index.d.ts +4 -2
  60. package/cjs/src/index.d.ts.map +1 -1
  61. package/cjs/src/index.js +4 -2
  62. package/cjs/src/index.js.map +1 -1
  63. package/cjs/src/mixpanel-service.d.ts +1 -0
  64. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  65. package/cjs/src/mixpanel-service.js +1 -0
  66. package/cjs/src/mixpanel-service.js.map +1 -1
  67. package/cjs/src/react/all-types-export.d.ts +1 -1
  68. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  69. package/cjs/src/react/all-types-export.js +2 -1
  70. package/cjs/src/react/all-types-export.js.map +1 -1
  71. package/cjs/src/types.d.ts +182 -2
  72. package/cjs/src/types.d.ts.map +1 -1
  73. package/cjs/src/types.js +109 -0
  74. package/cjs/src/types.js.map +1 -1
  75. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  76. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  77. package/cjs/src/utils/graphql/answerService/answer-queries.js +8 -1
  78. package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  79. package/cjs/src/utils/graphql/answerService/answerService.d.ts +28 -4
  80. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  81. package/cjs/src/utils/graphql/answerService/answerService.js +39 -4
  82. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  83. package/cjs/src/utils/graphql/answerService/answerService.spec.js +124 -0
  84. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  85. package/dist/{index-CnHREfvN.js → index-CyDR8j_0.js} +1 -1
  86. package/dist/src/css-variables.d.ts +373 -5
  87. package/dist/src/css-variables.d.ts.map +1 -1
  88. package/dist/src/embed/app.d.ts +14 -0
  89. package/dist/src/embed/app.d.ts.map +1 -1
  90. package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -1
  91. package/dist/src/embed/conversation.d.ts +15 -0
  92. package/dist/src/embed/conversation.d.ts.map +1 -1
  93. package/dist/src/embed/liveboard-override-utils.d.ts +59 -0
  94. package/dist/src/embed/liveboard-override-utils.d.ts.map +1 -0
  95. package/dist/src/embed/liveboard-override-utils.spec.d.ts +2 -0
  96. package/dist/src/embed/liveboard-override-utils.spec.d.ts.map +1 -0
  97. package/dist/src/embed/liveboard.d.ts +58 -13
  98. package/dist/src/embed/liveboard.d.ts.map +1 -1
  99. package/dist/src/embed/spotter-utils.d.ts +11 -0
  100. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  101. package/dist/src/embed/spotter-viz-utils.d.ts +15 -0
  102. package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
  103. package/dist/src/embed/ts-embed.d.ts +27 -34
  104. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  105. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  106. package/dist/src/index.d.ts +4 -2
  107. package/dist/src/index.d.ts.map +1 -1
  108. package/dist/src/mixpanel-service.d.ts +1 -0
  109. package/dist/src/mixpanel-service.d.ts.map +1 -1
  110. package/dist/src/react/all-types-export.d.ts +1 -1
  111. package/dist/src/react/all-types-export.d.ts.map +1 -1
  112. package/dist/src/types.d.ts +182 -2
  113. package/dist/src/types.d.ts.map +1 -1
  114. package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  115. package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  116. package/dist/src/utils/graphql/answerService/answerService.d.ts +28 -4
  117. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  118. package/dist/tsembed-react.es.js +437 -191
  119. package/dist/tsembed-react.js +436 -190
  120. package/dist/tsembed.es.js +680 -196
  121. package/dist/tsembed.js +678 -194
  122. package/dist/visual-embed-sdk-react-full.d.ts +702 -56
  123. package/dist/visual-embed-sdk-react.d.ts +697 -56
  124. package/dist/visual-embed-sdk.d.ts +744 -57
  125. package/lib/package.json +1 -1
  126. package/lib/src/css-variables.d.ts +373 -5
  127. package/lib/src/css-variables.d.ts.map +1 -1
  128. package/lib/src/embed/app.d.ts +14 -0
  129. package/lib/src/embed/app.d.ts.map +1 -1
  130. package/lib/src/embed/app.js +7 -4
  131. package/lib/src/embed/app.js.map +1 -1
  132. package/lib/src/embed/app.spec.js +28 -0
  133. package/lib/src/embed/app.spec.js.map +1 -1
  134. package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -1
  135. package/lib/src/embed/auto-frame-renderer.js +244 -4
  136. package/lib/src/embed/auto-frame-renderer.js.map +1 -1
  137. package/lib/src/embed/auto-frame-renderer.spec.js +389 -0
  138. package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -1
  139. package/lib/src/embed/bodyless-conversation.js +1 -1
  140. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  141. package/lib/src/embed/conversation.d.ts +15 -0
  142. package/lib/src/embed/conversation.d.ts.map +1 -1
  143. package/lib/src/embed/conversation.js +8 -4
  144. package/lib/src/embed/conversation.js.map +1 -1
  145. package/lib/src/embed/conversation.spec.js +67 -1
  146. package/lib/src/embed/conversation.spec.js.map +1 -1
  147. package/lib/src/embed/liveboard-override-utils.d.ts +59 -0
  148. package/lib/src/embed/liveboard-override-utils.d.ts.map +1 -0
  149. package/lib/src/embed/liveboard-override-utils.js +15 -0
  150. package/lib/src/embed/liveboard-override-utils.js.map +1 -0
  151. package/lib/src/embed/liveboard-override-utils.spec.d.ts +2 -0
  152. package/lib/src/embed/liveboard-override-utils.spec.d.ts.map +1 -0
  153. package/lib/src/embed/liveboard-override-utils.spec.js +32 -0
  154. package/lib/src/embed/liveboard-override-utils.spec.js.map +1 -0
  155. package/lib/src/embed/liveboard.d.ts +58 -13
  156. package/lib/src/embed/liveboard.d.ts.map +1 -1
  157. package/lib/src/embed/liveboard.js +11 -33
  158. package/lib/src/embed/liveboard.js.map +1 -1
  159. package/lib/src/embed/liveboard.spec.js +104 -79
  160. package/lib/src/embed/liveboard.spec.js.map +1 -1
  161. package/lib/src/embed/search-bar.js +1 -1
  162. package/lib/src/embed/search-bar.js.map +1 -1
  163. package/lib/src/embed/search.js +1 -1
  164. package/lib/src/embed/search.js.map +1 -1
  165. package/lib/src/embed/search.spec.js +20 -0
  166. package/lib/src/embed/search.spec.js.map +1 -1
  167. package/lib/src/embed/spotter-utils.d.ts +11 -0
  168. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  169. package/lib/src/embed/spotter-utils.js +12 -0
  170. package/lib/src/embed/spotter-utils.js.map +1 -1
  171. package/lib/src/embed/spotter-viz-utils.d.ts +15 -0
  172. package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
  173. package/lib/src/embed/spotter-viz-utils.js.map +1 -1
  174. package/lib/src/embed/spotter-viz-utils.spec.js +11 -0
  175. package/lib/src/embed/spotter-viz-utils.spec.js.map +1 -1
  176. package/lib/src/embed/ts-embed.d.ts +27 -34
  177. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  178. package/lib/src/embed/ts-embed.js +224 -102
  179. package/lib/src/embed/ts-embed.js.map +1 -1
  180. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  181. package/lib/src/embed/ts-embed.spec.js +544 -167
  182. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  183. package/lib/src/index.d.ts +4 -2
  184. package/lib/src/index.d.ts.map +1 -1
  185. package/lib/src/index.js +3 -2
  186. package/lib/src/index.js.map +1 -1
  187. package/lib/src/mixpanel-service.d.ts +1 -0
  188. package/lib/src/mixpanel-service.d.ts.map +1 -1
  189. package/lib/src/mixpanel-service.js +1 -0
  190. package/lib/src/mixpanel-service.js.map +1 -1
  191. package/lib/src/react/all-types-export.d.ts +1 -1
  192. package/lib/src/react/all-types-export.d.ts.map +1 -1
  193. package/lib/src/react/all-types-export.js +1 -1
  194. package/lib/src/react/all-types-export.js.map +1 -1
  195. package/lib/src/types.d.ts +182 -2
  196. package/lib/src/types.d.ts.map +1 -1
  197. package/lib/src/types.js +109 -0
  198. package/lib/src/types.js.map +1 -1
  199. package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  200. package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  201. package/lib/src/utils/graphql/answerService/answer-queries.js +7 -0
  202. package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  203. package/lib/src/utils/graphql/answerService/answerService.d.ts +28 -4
  204. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  205. package/lib/src/utils/graphql/answerService/answerService.js +39 -4
  206. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  207. package/lib/src/utils/graphql/answerService/answerService.spec.js +125 -1
  208. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  209. package/lib/src/visual-embed-sdk.d.ts +744 -57
  210. package/package.json +1 -1
  211. package/src/css-variables.ts +475 -26
  212. package/src/embed/app.spec.ts +32 -0
  213. package/src/embed/app.ts +28 -4
  214. package/src/embed/auto-frame-renderer.spec.ts +464 -0
  215. package/src/embed/auto-frame-renderer.ts +305 -6
  216. package/src/embed/bodyless-conversation.ts +1 -1
  217. package/src/embed/conversation.spec.ts +94 -1
  218. package/src/embed/conversation.ts +28 -3
  219. package/src/embed/liveboard-override-utils.spec.ts +38 -0
  220. package/src/embed/liveboard-override-utils.ts +71 -0
  221. package/src/embed/liveboard.spec.ts +119 -92
  222. package/src/embed/liveboard.ts +56 -40
  223. package/src/embed/search-bar.tsx +1 -1
  224. package/src/embed/search.spec.ts +23 -0
  225. package/src/embed/search.ts +1 -1
  226. package/src/embed/spotter-utils.ts +12 -0
  227. package/src/embed/spotter-viz-utils.spec.ts +11 -0
  228. package/src/embed/spotter-viz-utils.ts +15 -0
  229. package/src/embed/ts-embed.spec.ts +685 -207
  230. package/src/embed/ts-embed.ts +227 -97
  231. package/src/index.ts +16 -1
  232. package/src/mixpanel-service.ts +1 -0
  233. package/src/react/all-types-export.ts +6 -0
  234. package/src/types.ts +186 -5
  235. package/src/utils/graphql/answerService/answer-queries.ts +8 -0
  236. package/src/utils/graphql/answerService/answerService.spec.ts +145 -1
  237. package/src/utils/graphql/answerService/answerService.ts +65 -3
@@ -2,11 +2,12 @@ import { resetValueFromWindow } from '../utils';
2
2
  import { ERROR_MESSAGE } from '../errors';
3
3
  import { resetCachedAuthToken } from '../authToken';
4
4
  import { AuthType, init, EmbedEvent, SearchEmbed, PinboardEmbed, AppEmbed, LiveboardEmbed, AnswerService, SpotterEmbed, } from '../index';
5
- import { Action, HomeLeftNavItem, RuntimeFilterOp, HomepageModule, HostEvent, ContextMenuTriggerOptions, CustomActionTarget, CustomActionsPosition, ErrorDetailsTypes, EmbedErrorCodes, EmbedErrorSeverity, } from '../types';
5
+ import { Action, HomeLeftNavItem, RuntimeFilterOp, HomepageModule, HostEvent, Param, ContextMenuTriggerOptions, CustomActionTarget, CustomActionsPosition, ErrorDetailsTypes, EmbedErrorCodes, EmbedErrorSeverity, } from '../types';
6
6
  import { executeAfterWait, getDocumentBody, getIFrameEl, getIFrameSrc, getRootEl, postMessageToParent, defaultParamsForPinboardEmbed, waitFor, expectUrlMatchesWithParams, expectUrlToHaveParamsWithValues, mockMessageChannel, createRootEleForEmbed, fixedEncodeURI, } from '../test/test-utils';
7
7
  import * as config from '../config';
8
8
  import * as embedConfig from './embedConfig';
9
9
  import * as tsEmbedInstance from './ts-embed';
10
+ import { BOOTSTRAP_URL_PARAMS } from './ts-embed';
10
11
  import * as mixpanelInstance from '../mixpanel-service';
11
12
  import * as authInstance from '../auth';
12
13
  import * as baseInstance from './base';
@@ -1091,6 +1092,26 @@ describe('Unit test case for ts embed', () => {
1091
1092
  elHeight: 0,
1092
1093
  }));
1093
1094
  });
1095
+ test('should send visual-sdk-init-actions with configured actions, [] when unused', async () => {
1096
+ await new SearchEmbed(getRootEl(), {
1097
+ hiddenActions: [Action.Download],
1098
+ disabledActions: [Action.Edit],
1099
+ }).render();
1100
+ expect(mockMixPanelEvent).toHaveBeenCalledWith(MIXPANEL_EVENT.VISUAL_SDK_INIT_ACTIONS, expect.objectContaining({
1101
+ hiddenActions: [Action.Download],
1102
+ visibleActions: [],
1103
+ disabledActions: [Action.Edit],
1104
+ }));
1105
+ mockMixPanelEvent.mockClear();
1106
+ await new SearchEmbed(getRootEl(), {
1107
+ visibleActions: [Action.Save],
1108
+ }).render();
1109
+ expect(mockMixPanelEvent).toHaveBeenCalledWith(MIXPANEL_EVENT.VISUAL_SDK_INIT_ACTIONS, expect.objectContaining({
1110
+ hiddenActions: [],
1111
+ visibleActions: [Action.Save],
1112
+ disabledActions: [],
1113
+ }));
1114
+ });
1094
1115
  test('Should remove prefetch iframe', async () => {
1095
1116
  await setup(true);
1096
1117
  const prefetchIframe = document.querySelectorAll('.prefetchIframe');
@@ -2108,6 +2129,71 @@ describe('Unit test case for ts embed', () => {
2108
2129
  });
2109
2130
  });
2110
2131
  });
2132
+ describe('isDarkMode', () => {
2133
+ const renderAppEmbed = async (viewConfig = {}) => {
2134
+ const appEmbed = new AppEmbed(getRootEl(), {
2135
+ frameParams: {
2136
+ width: '100%',
2137
+ height: '100%',
2138
+ },
2139
+ ...viewConfig,
2140
+ });
2141
+ appEmbed.render();
2142
+ await waitFor(() => !!getIFrameEl());
2143
+ return getIFrameSrc();
2144
+ };
2145
+ it('sends the appearance the host asked for in init, with the radiant theme', async () => {
2146
+ init({
2147
+ thoughtSpotHost: 'tshost',
2148
+ authType: AuthType.None,
2149
+ isDarkMode: true,
2150
+ });
2151
+ expectUrlToHaveParamsWithValues(await renderAppEmbed(), {
2152
+ isDarkMode: true,
2153
+ radiantThemeEnabled: true,
2154
+ });
2155
+ });
2156
+ it('sends an explicit false', async () => {
2157
+ init({
2158
+ thoughtSpotHost: 'tshost',
2159
+ authType: AuthType.None,
2160
+ isDarkMode: false,
2161
+ });
2162
+ const src = await renderAppEmbed();
2163
+ expectUrlToHaveParamsWithValues(src, { isDarkMode: false });
2164
+ // `false` leaves the radiant theme to the cluster.
2165
+ expect(src).not.toContain('radiantThemeEnabled=');
2166
+ });
2167
+ it('omits the param when the host says nothing', async () => {
2168
+ init({
2169
+ thoughtSpotHost: 'tshost',
2170
+ authType: AuthType.None,
2171
+ });
2172
+ // Absent rather than `isDarkMode=false`: an omitted param keeps the
2173
+ // URL short, and the app treats a missing param like `false`.
2174
+ const src = await renderAppEmbed();
2175
+ expect(src).not.toContain('isDarkMode=');
2176
+ expect(src).not.toContain('radiantThemeEnabled=');
2177
+ });
2178
+ it('lets the view config override the value set in init', async () => {
2179
+ init({
2180
+ thoughtSpotHost: 'tshost',
2181
+ authType: AuthType.None,
2182
+ isDarkMode: true,
2183
+ });
2184
+ const src = await renderAppEmbed({ isDarkMode: false });
2185
+ expectUrlToHaveParamsWithValues(src, { isDarkMode: false });
2186
+ expect(src).not.toContain('radiantThemeEnabled=');
2187
+ });
2188
+ it('lets additionalFlags override the radiant theme it turns on', async () => {
2189
+ init({
2190
+ thoughtSpotHost: 'tshost',
2191
+ authType: AuthType.None,
2192
+ isDarkMode: true,
2193
+ });
2194
+ expectUrlToHaveParamsWithValues(await renderAppEmbed({ additionalFlags: { radiantThemeEnabled: false } }), { isDarkMode: true, radiantThemeEnabled: false });
2195
+ });
2196
+ });
2111
2197
  describe('validate preRender flow', () => {
2112
2198
  beforeAll(() => {
2113
2199
  init({
@@ -2171,7 +2257,7 @@ describe('Unit test case for ts embed', () => {
2171
2257
  expect(preRenderWrapper.style.height).toEqual(`${297}px`);
2172
2258
  expect(preRenderWrapper.style.width).toEqual(`${987}px`);
2173
2259
  expect(preRenderWrapper.style.opacity).toBe('');
2174
- expect(preRenderWrapper.style.pointerEvents).toBe('auto');
2260
+ expect(preRenderWrapper.style.pointerEvents).toBe('');
2175
2261
  expect(preRenderWrapper.style.zIndex).toBe('');
2176
2262
  libEmbed.hidePreRender();
2177
2263
  expect(preRenderWrapper.style.opacity).toBe('0');
@@ -2200,7 +2286,7 @@ describe('Unit test case for ts embed', () => {
2200
2286
  await waitFor(() => !!getIFrameEl());
2201
2287
  const preRenderWrapper = document.getElementById(preRenderIds.wrapper);
2202
2288
  expect(preRenderWrapper.style.opacity).toBe('');
2203
- expect(preRenderWrapper.style.pointerEvents).toBe('auto');
2289
+ expect(preRenderWrapper.style.pointerEvents).toBe('');
2204
2290
  expect(preRenderWrapper.style.zIndex).toBe('');
2205
2291
  });
2206
2292
  it('hidePreRender should not preRender if not available', async () => {
@@ -2340,170 +2426,6 @@ describe('Unit test case for ts embed', () => {
2340
2426
  libEmbed.destroy();
2341
2427
  logger.debug.mockRestore();
2342
2428
  });
2343
- describe('position tracking (SCAL-338563)', () => {
2344
- /**
2345
- * A host app whose page scrolls in an inner element rather than the
2346
- * document — the shape both reported cases have. The placeholder's
2347
- * rect is driven off that element's scrollTop, the way a real
2348
- * layout would move it.
2349
- */
2350
- const mountInNestedScroller = () => {
2351
- createRootEleForEmbed();
2352
- const scroller = document.createElement('div');
2353
- scroller.id = 'inner-scroller';
2354
- document.body.appendChild(scroller);
2355
- scroller.appendChild(document.getElementById('tsEmbedDiv'));
2356
- let scrollTop = 0;
2357
- Object.defineProperty(scroller, 'scrollTop', {
2358
- configurable: true,
2359
- get: () => scrollTop,
2360
- set: (value) => {
2361
- scrollTop = value;
2362
- },
2363
- });
2364
- scroller.getBoundingClientRect = () => ({
2365
- x: 0, y: 0, width: 800, height: 600,
2366
- top: 0, left: 0, bottom: 600, right: 800,
2367
- });
2368
- const placeholderTopAtRest = 400;
2369
- const readPlaceholderTop = () => placeholderTopAtRest - scroller.scrollTop;
2370
- return { scroller, readPlaceholderTop };
2371
- };
2372
- const stubPlaceholderRect = (embed, readTop) => {
2373
- const placeholder = embed.getPreRenderPlaceHolderElement();
2374
- placeholder.getBoundingClientRect = () => {
2375
- const top = readTop();
2376
- return {
2377
- x: 0, y: top, width: 800, height: 300,
2378
- top, left: 0, bottom: top + 300, right: 800,
2379
- };
2380
- };
2381
- return placeholder;
2382
- };
2383
- it('should stop observing the placeholder once the frame is hidden', async () => {
2384
- const { scroller } = mountInNestedScroller();
2385
- const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2386
- preRenderId: 'observer-stops-on-hide',
2387
- liveboardId: 'myLiveboardId',
2388
- });
2389
- libEmbed.preRender();
2390
- await waitFor(() => !!getIFrameEl());
2391
- await libEmbed.showPreRender();
2392
- // Size is the only thing the browser will not handle for us, so
2393
- // the observer is the one live resource a hide has to release.
2394
- const observer = libEmbed.resizeObserver;
2395
- expect(observer).toBeDefined();
2396
- const disconnectSpy = jest.spyOn(observer, 'disconnect');
2397
- libEmbed.hidePreRender();
2398
- expect(disconnectSpy).toHaveBeenCalled();
2399
- disconnectSpy.mockRestore();
2400
- libEmbed.destroy();
2401
- scroller.remove();
2402
- });
2403
- it('should default the container to the host scrolling ancestor', async () => {
2404
- const { scroller } = mountInNestedScroller();
2405
- scroller.style.overflowY = 'auto';
2406
- const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2407
- preRenderId: 'auto-scroll-container',
2408
- liveboardId: 'myLiveboardId',
2409
- });
2410
- libEmbed.preRender();
2411
- await waitFor(() => !!getIFrameEl());
2412
- await libEmbed.showPreRender();
2413
- const wrapper = document.getElementById(libEmbed.getPreRenderIds().wrapper);
2414
- // In the scroller, so the browser moves it — no repositioning.
2415
- expect(wrapper.parentElement).toBe(scroller);
2416
- expect(libEmbed.preRenderContainerEl).toBe(scroller);
2417
- libEmbed.destroy();
2418
- scroller.remove();
2419
- });
2420
- it('should still use document.body when nothing scrolls', async () => {
2421
- createRootEleForEmbed();
2422
- const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2423
- preRenderId: 'no-scroller-body',
2424
- liveboardId: 'myLiveboardId',
2425
- });
2426
- libEmbed.preRender();
2427
- await waitFor(() => !!getIFrameEl());
2428
- await libEmbed.showPreRender();
2429
- const wrapper = document.getElementById(libEmbed.getPreRenderIds().wrapper);
2430
- expect(wrapper.parentElement).toBe(document.body);
2431
- libEmbed.destroy();
2432
- });
2433
- it('should set pointer-events on show rather than dropping the property', async () => {
2434
- createRootEleForEmbed();
2435
- const container = document.createElement('div');
2436
- container.id = 'parking-root';
2437
- // Usual styling for a parking root: no swallowed clicks.
2438
- container.style.pointerEvents = 'none';
2439
- document.body.appendChild(container);
2440
- const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2441
- preRenderId: 'pointer-events-restored',
2442
- liveboardId: 'myLiveboardId',
2443
- preRenderContainer: '#parking-root',
2444
- });
2445
- libEmbed.preRender();
2446
- await waitFor(() => !!getIFrameEl());
2447
- await libEmbed.showPreRender();
2448
- const wrapper = document.getElementById(libEmbed.getPreRenderIds().wrapper);
2449
- // Merely removing the property would leave the container's
2450
- // inherited `none` in force, and the frame dead to input.
2451
- expect(wrapper.style.pointerEvents).toBe('auto');
2452
- libEmbed.destroy();
2453
- container.remove();
2454
- });
2455
- it('should park a hidden wrapper out of the scrollable area', async () => {
2456
- createRootEleForEmbed();
2457
- const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2458
- preRenderId: 'hidden-parked',
2459
- liveboardId: 'myLiveboardId',
2460
- });
2461
- libEmbed.preRender();
2462
- await waitFor(() => !!getIFrameEl());
2463
- await libEmbed.showPreRender();
2464
- const wrapper = document.getElementById(libEmbed.getPreRenderIds().wrapper);
2465
- expect(wrapper.style.transform).toBe('');
2466
- libEmbed.hidePreRender();
2467
- expect(wrapper.style.transform).toBe('translateY(-100%)');
2468
- await libEmbed.showPreRender();
2469
- expect(wrapper.style.transform).toBe('');
2470
- libEmbed.destroy();
2471
- });
2472
- it('should not seed the placeholder with the unmeasured wrapper height', async () => {
2473
- createRootEleForEmbed();
2474
- const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2475
- preRenderId: 'unmeasured-height',
2476
- liveboardId: 'myLiveboardId',
2477
- fullHeight: true,
2478
- frameParams: { height: 420 },
2479
- });
2480
- libEmbed.preRender();
2481
- await waitFor(() => !!getIFrameEl());
2482
- const wrapper = document.getElementById(libEmbed.getPreRenderIds().wrapper);
2483
- // createPreRenderWrapper() seeds 100vh, not a measurement.
2484
- expect(wrapper.style.height).toBe('100vh');
2485
- await libEmbed.showPreRender();
2486
- const placeholder = libEmbed.getPreRenderPlaceHolderElement();
2487
- expect(placeholder.style.height).toBe('420px');
2488
- libEmbed.destroy();
2489
- });
2490
- it('should seed the placeholder with a height fullHeight has measured', async () => {
2491
- createRootEleForEmbed();
2492
- const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2493
- preRenderId: 'measured-height',
2494
- liveboardId: 'myLiveboardId',
2495
- fullHeight: true,
2496
- frameParams: { height: 420 },
2497
- });
2498
- libEmbed.preRender();
2499
- await waitFor(() => !!getIFrameEl());
2500
- libEmbed.setIFrameHeight(1180);
2501
- await libEmbed.showPreRender();
2502
- const placeholder = libEmbed.getPreRenderPlaceHolderElement();
2503
- expect(placeholder.style.height).toBe('1180px');
2504
- libEmbed.destroy();
2505
- });
2506
- });
2507
2429
  describe('preRenderContainer', () => {
2508
2430
  it('should append preRenderWrapper to document.body when preRenderContainer is not set', async () => {
2509
2431
  createRootEleForEmbed();
@@ -2722,14 +2644,19 @@ describe('Unit test case for ts embed', () => {
2722
2644
  expect(oldContainer.contains(wrapper)).toBe(true);
2723
2645
  // Simulate React remounting the container: the old node (with
2724
2646
  // our wrapper) is detached and a fresh node takes its place.
2647
+ const removeSpy = jest.spyOn(oldContainer, 'removeEventListener');
2725
2648
  oldContainer.remove();
2726
2649
  const newContainer = document.createElement('div');
2727
2650
  newContainer.id = 'remount-container';
2728
2651
  document.body.appendChild(newContainer);
2652
+ const addSpy = jest.spyOn(newContainer, 'addEventListener');
2729
2653
  // A reposition (scroll/resize/re-show) heals the stale ref.
2730
2654
  libEmbed.syncPreRenderStyle();
2731
2655
  expect(newContainer.contains(wrapper)).toBe(true);
2732
2656
  expect(oldContainer.contains(wrapper)).toBe(false);
2657
+ // The scroll listener is migrated to the live container.
2658
+ expect(removeSpy).toHaveBeenCalledWith('scroll', expect.any(Function));
2659
+ expect(addSpy).toHaveBeenCalledWith('scroll', expect.any(Function));
2733
2660
  libEmbed.destroy();
2734
2661
  newContainer.remove();
2735
2662
  });
@@ -5491,4 +5418,454 @@ describe('ShowPreRender with UpdateEmbedParams', () => {
5491
5418
  });
5492
5419
  });
5493
5420
  });
5421
+ describe('excludeConfigFromURL', () => {
5422
+ const lbConfig = {
5423
+ liveboardId,
5424
+ hiddenActions: [Action.Download],
5425
+ additionalFlags: { internalBlinkFlag: true },
5426
+ liveboardV2: true,
5427
+ };
5428
+ const withPostMessage = (viewConfig) => ({
5429
+ ...viewConfig,
5430
+ additionalFlags: { ...viewConfig.additionalFlags, excludeConfigFromURL: true },
5431
+ });
5432
+ const renderAndGetSrc = async (viewConfig) => {
5433
+ const embed = new LiveboardEmbed(getRootEl(), { ...defaultViewConfig, ...viewConfig });
5434
+ await embed.render();
5435
+ await waitFor(() => !!getIFrameEl());
5436
+ return { embed, src: getIFrameSrc() };
5437
+ };
5438
+ const signalFrameReady = () => {
5439
+ postMessageToParent(getIFrameEl().contentWindow, {
5440
+ type: EmbedEvent.EmbedListenerReady,
5441
+ });
5442
+ };
5443
+ beforeEach(() => {
5444
+ document.body.innerHTML = getDocumentBody();
5445
+ mockProcessTrigger.mockReset();
5446
+ mockProcessTrigger.mockResolvedValue({});
5447
+ init({
5448
+ thoughtSpotHost,
5449
+ authType: AuthType.None,
5450
+ });
5451
+ });
5452
+ test('leaves the URL untouched when the flag is not set', async () => {
5453
+ const { src } = await renderAndGetSrc(lbConfig);
5454
+ expect(src).toContain('hideAction=');
5455
+ expect(src).toContain('internalBlinkFlag=true');
5456
+ expect(src).toContain('isPinboardV2Enabled=true');
5457
+ });
5458
+ test('keeps only the bootstrap params on the URL when the flag is set', async () => {
5459
+ const { src } = await renderAndGetSrc(withPostMessage(lbConfig));
5460
+ // Boot and auth handshake stays on the URL.
5461
+ expect(src).toContain('hostAppUrl=');
5462
+ expect(src).toContain(`authType=${AuthType.None}`);
5463
+ expect(src).toContain(`sdkVersion=${version}`);
5464
+ expect(src).toContain('blockNonEmbedFullAppAccess=true');
5465
+ expect(src).toContain('viewPortHeight=');
5466
+ // View configuration and internal flags do not.
5467
+ expect(src).not.toContain('hideAction=');
5468
+ expect(src).not.toContain('internalBlinkFlag');
5469
+ });
5470
+ describe('BOOTSTRAP_URL_PARAMS', () => {
5471
+ test('keeps the auth and origin params', () => {
5472
+ [Param.EmbedApp, Param.HostAppUrl, Param.Version, Param.AuthType].forEach((param) => {
5473
+ expect(BOOTSTRAP_URL_PARAMS.has(param)).toBe(true);
5474
+ });
5475
+ });
5476
+ test('leaves the layout flags to the APP_INIT payload', () => {
5477
+ [
5478
+ Param.LiveboardV2Enabled,
5479
+ Param.PrimaryNavHidden,
5480
+ Param.HideSearchBar,
5481
+ Param.SpotterExperienceVersion,
5482
+ ].forEach((param) => {
5483
+ expect(BOOTSTRAP_URL_PARAMS.has(param)).toBe(false);
5484
+ });
5485
+ });
5486
+ });
5487
+ describe('params held back from the URL go in the APP_INIT payload', () => {
5488
+ const renderEmbed = async (EmbedClass, viewConfig, excludeConfig = true) => {
5489
+ const embed = new EmbedClass(getRootEl(), {
5490
+ ...defaultViewConfig,
5491
+ ...viewConfig,
5492
+ additionalFlags: {
5493
+ ...viewConfig.additionalFlags,
5494
+ ...(excludeConfig && { excludeConfigFromURL: true }),
5495
+ },
5496
+ });
5497
+ await embed.render();
5498
+ await waitFor(() => !!getIFrameEl());
5499
+ return embed;
5500
+ };
5501
+ const requestAppInit = async () => {
5502
+ const mockPort = { postMessage: jest.fn() };
5503
+ postMessageToParent(getIFrameEl().contentWindow, { type: EmbedEvent.APP_INIT, data: {} }, mockPort);
5504
+ await waitFor(() => mockPort.postMessage.mock.calls.length > 0);
5505
+ return mockPort.postMessage.mock.calls[0][0].data;
5506
+ };
5507
+ const getAppInitFor = async (EmbedClass, viewConfig) => {
5508
+ await renderEmbed(EmbedClass, viewConfig);
5509
+ return requestAppInit();
5510
+ };
5511
+ test('sends the app navigation and page version flags', async () => {
5512
+ const { embedParams } = await getAppInitFor(AppEmbed, {
5513
+ showPrimaryNavbar: false,
5514
+ hideHamburger: true,
5515
+ hideNotification: true,
5516
+ hideObjectSearch: true,
5517
+ hideOrgSwitcher: true,
5518
+ hideApplicationSwitcher: true,
5519
+ disableProfileAndHelp: true,
5520
+ hideHomepageLeftNav: true,
5521
+ hideTagFilterChips: true,
5522
+ modularHomeExperience: true,
5523
+ liveboardV2: true,
5524
+ });
5525
+ expect(embedParams).toEqual(expect.objectContaining({
5526
+ [Param.PrimaryNavHidden]: true,
5527
+ [Param.HideHamburger]: true,
5528
+ [Param.HideNotification]: true,
5529
+ [Param.HideObjectSearch]: true,
5530
+ [Param.HideOrgSwitcher]: true,
5531
+ [Param.HideApplicationSwitcher]: true,
5532
+ [Param.HideProfleAndHelp]: true,
5533
+ [Param.HideHomepageLeftNav]: true,
5534
+ [Param.HideTagFilterChips]: true,
5535
+ [Param.ModularHomeExperienceEnabled]: true,
5536
+ [Param.LiveboardV2Enabled]: true,
5537
+ [Param.NavigationVersion]: expect.any(String),
5538
+ [Param.HomepageVersion]: expect.any(String),
5539
+ }));
5540
+ });
5541
+ test('sends the Liveboard layout flags', async () => {
5542
+ const { embedParams } = await getAppInitFor(LiveboardEmbed, {
5543
+ liveboardId,
5544
+ visibleVizs: ['viz-1'],
5545
+ hideLiveboardHeader: true,
5546
+ showLiveboardTitle: true,
5547
+ showLiveboardDescription: true,
5548
+ hideTabPanel: true,
5549
+ enable2ColumnLayout: true,
5550
+ isLiveboardHeaderSticky: true,
5551
+ showLiveboardVerifiedBadge: true,
5552
+ });
5553
+ expect(embedParams).toEqual(expect.objectContaining({
5554
+ [Param.visibleVizs]: ['viz-1'],
5555
+ [Param.HideLiveboardHeader]: true,
5556
+ [Param.ShowLiveboardTitle]: true,
5557
+ [Param.ShowLiveboardDescription]: true,
5558
+ [Param.HideTabPanel]: true,
5559
+ [Param.Enable2ColumnLayout]: true,
5560
+ [Param.LiveboardHeaderSticky]: true,
5561
+ [Param.ShowLiveboardVerifiedBadge]: true,
5562
+ }));
5563
+ });
5564
+ test('sends the search layout flags and the initial query', async () => {
5565
+ const { embedParams } = await getAppInitFor(SearchEmbed, {
5566
+ dataSource: 'ds-1',
5567
+ searchOptions: {
5568
+ searchTokenString: '[revenue]',
5569
+ executeSearch: true,
5570
+ },
5571
+ hideResults: true,
5572
+ hideSearchBar: true,
5573
+ collapseSearchBarInitially: true,
5574
+ enableSearchAssist: true,
5575
+ });
5576
+ expect(embedParams).toEqual(expect.objectContaining({
5577
+ [Param.HideResult]: true,
5578
+ [Param.HideSearchBar]: true,
5579
+ [Param.CollapseSearchBarInitially]: true,
5580
+ [Param.EnableSearchAssist]: true,
5581
+ [Param.executeSearch]: true,
5582
+ [Param.DataSourceMode]: expect.anything(),
5583
+ }));
5584
+ expect(embedParams).not.toHaveProperty(Param.searchTokenString);
5585
+ });
5586
+ test('sends the Spotter empty-screen flags', async () => {
5587
+ const { embedParams } = await getAppInitFor(SpotterEmbed, {
5588
+ worksheetId: 'worksheet-1',
5589
+ hideSampleQuestions: true,
5590
+ hideSourceSelection: true,
5591
+ disableSourceSelection: true,
5592
+ showSpotterLimitations: true,
5593
+ showSpotterRadiance: true,
5594
+ updatedSpotterChatPrompt: true,
5595
+ spotterChatConfig: { enableStarterPrompts: true },
5596
+ });
5597
+ expect(embedParams).toEqual(expect.objectContaining({
5598
+ [Param.HideSampleQuestions]: true,
5599
+ [Param.HideSourceSelection]: true,
5600
+ [Param.DisableSourceSelection]: true,
5601
+ [Param.ShowSpotterLimitations]: true,
5602
+ [Param.ShowSpotterRadiance]: true,
5603
+ [Param.UpdatedSpotterChatPrompt]: true,
5604
+ [Param.IsStarterPromptsEnabled]: true,
5605
+ }));
5606
+ });
5607
+ test('sends the action and tab lists and the additionalFlags', async () => {
5608
+ await renderEmbed(LiveboardEmbed, {
5609
+ liveboardId,
5610
+ visibleActions: [Action.Download],
5611
+ visibleTabs: ['tab-1'],
5612
+ additionalFlags: { internalBlinkFlag: true },
5613
+ });
5614
+ const src = getIFrameSrc();
5615
+ const { embedParams } = await requestAppInit();
5616
+ expect(src).not.toContain(`${Param.VisibleActions}=`);
5617
+ expect(src).not.toContain(`${Param.VisibleTabs}=`);
5618
+ expect(embedParams).toEqual(expect.objectContaining({
5619
+ [Param.VisibleActions]: [Action.Download],
5620
+ [Param.VisibleTabs]: ['tab-1'],
5621
+ internalBlinkFlag: true,
5622
+ }));
5623
+ });
5624
+ test('sends the feature flags only in embedParams', async () => {
5625
+ const appInitData = await getAppInitFor(AppEmbed, {
5626
+ showPrimaryNavbar: false,
5627
+ liveboardV2: true,
5628
+ dataPanelV2: true,
5629
+ });
5630
+ const featureFlags = {
5631
+ [Param.PrimaryNavHidden]: true,
5632
+ [Param.LiveboardV2Enabled]: true,
5633
+ [Param.DataPanelV2Enabled]: true,
5634
+ };
5635
+ // The app overrides its feature flags from embedParams.
5636
+ expect(appInitData.embedParams).toEqual(expect.objectContaining(featureFlags));
5637
+ Object.keys(featureFlags).forEach((flag) => {
5638
+ expect(appInitData).not.toHaveProperty(flag);
5639
+ });
5640
+ });
5641
+ test("lets the embed's own embedParams win over a param of the same name", async () => {
5642
+ const { embedParams } = await getAppInitFor(SpotterEmbed, {
5643
+ worksheetId: 'worksheet-1',
5644
+ spotterSidebarConfig: { enablePastConversationsSidebar: true },
5645
+ additionalFlags: { spotterSidebarConfig: 'from-flags' },
5646
+ });
5647
+ expect(embedParams.spotterSidebarConfig).toEqual(expect.objectContaining({ enablePastConversationsSidebar: true }));
5648
+ });
5649
+ test("keeps the embed's own embedParams alongside the params", async () => {
5650
+ const { embedParams } = await getAppInitFor(SpotterEmbed, {
5651
+ worksheetId: 'worksheet-1',
5652
+ hideSampleQuestions: true,
5653
+ spotterSidebarConfig: { enablePastConversationsSidebar: true },
5654
+ });
5655
+ expect(embedParams).toEqual(expect.objectContaining({
5656
+ [Param.HideSampleQuestions]: true,
5657
+ spotterSidebarConfig: expect.objectContaining({
5658
+ enablePastConversationsSidebar: true,
5659
+ }),
5660
+ }));
5661
+ });
5662
+ test('keeps the search token on the URL', async () => {
5663
+ const { embedParams } = await getAppInitFor(SearchEmbed, {
5664
+ dataSource: 'ds-1',
5665
+ searchOptions: { searchTokenString: '[revenue] [region]' },
5666
+ });
5667
+ expect(new URL(getIFrameSrc()).searchParams.get(Param.searchTokenString)).toBe('[revenue] [region]');
5668
+ expect(embedParams).not.toHaveProperty(Param.searchTokenString);
5669
+ });
5670
+ test('sends the token in searchOptions when it is excluded from the URL', async () => {
5671
+ const appInitData = await getAppInitFor(SearchEmbed, {
5672
+ dataSource: 'ds-1',
5673
+ excludeSearchTokenStringFromURL: true,
5674
+ searchOptions: { searchTokenString: '[revenue]' },
5675
+ });
5676
+ expect(getIFrameSrc()).not.toContain(Param.searchTokenString);
5677
+ // The app merges searchOptions.searchTokenString into embedParams.
5678
+ expect(appInitData.searchOptions).toEqual({ searchTokenString: '[revenue]' });
5679
+ expect(appInitData.embedParams).not.toHaveProperty(Param.searchTokenString);
5680
+ });
5681
+ test('sends a flag the caller set to false', async () => {
5682
+ const { embedParams } = await getAppInitFor(AppEmbed, {
5683
+ showPrimaryNavbar: true,
5684
+ liveboardV2: false,
5685
+ modularHomeExperience: false,
5686
+ });
5687
+ expect(embedParams).toEqual(expect.objectContaining({
5688
+ [Param.PrimaryNavHidden]: false,
5689
+ [Param.LiveboardV2Enabled]: false,
5690
+ [Param.ModularHomeExperienceEnabled]: false,
5691
+ }));
5692
+ });
5693
+ test('sends a flag only when the caller sets it', async () => {
5694
+ const { embedParams } = await getAppInitFor(AppEmbed, {});
5695
+ expect(embedParams).not.toHaveProperty(Param.HideHamburger);
5696
+ expect(embedParams).not.toHaveProperty(Param.HideNotification);
5697
+ expect(embedParams).not.toHaveProperty(Param.ModularHomeExperienceEnabled);
5698
+ });
5699
+ test('does not repeat the params that stay on the URL', async () => {
5700
+ const { embedParams } = await getAppInitFor(LiveboardEmbed, { liveboardId });
5701
+ Object.keys(embedParams).forEach((key) => {
5702
+ expect(BOOTSTRAP_URL_PARAMS.has(key)).toBe(false);
5703
+ });
5704
+ });
5705
+ test('leaves the APP_INIT payload unchanged when the flag is not set', async () => {
5706
+ await renderEmbed(LiveboardEmbed, { liveboardId, hideLiveboardHeader: true }, false);
5707
+ const appInitData = await requestAppInit();
5708
+ expect(appInitData).not.toHaveProperty('embedParams');
5709
+ expect(appInitData).not.toHaveProperty(Param.HideLiveboardHeader);
5710
+ });
5711
+ test('sends no embedParams when every param stays on the URL', async () => {
5712
+ const getParams = jest
5713
+ .spyOn(LiveboardEmbed.prototype, 'getEmbedParamsObject')
5714
+ .mockReturnValue({
5715
+ [Param.EmbedApp]: true,
5716
+ [Param.AuthType]: AuthType.None,
5717
+ });
5718
+ await renderEmbed(LiveboardEmbed, { liveboardId });
5719
+ const appInitData = await requestAppInit();
5720
+ getParams.mockRestore();
5721
+ expect(appInitData).not.toHaveProperty('embedParams');
5722
+ });
5723
+ test('sends the params when excludeConfigFromURL is set in init', async () => {
5724
+ init({
5725
+ thoughtSpotHost,
5726
+ authType: AuthType.None,
5727
+ additionalFlags: { excludeConfigFromURL: true },
5728
+ });
5729
+ await renderEmbed(LiveboardEmbed, { liveboardId, hideLiveboardHeader: true }, false);
5730
+ const { embedParams } = await requestAppInit();
5731
+ expect(getIFrameSrc()).not.toContain(`${Param.HideLiveboardHeader}=`);
5732
+ expect(embedParams).toEqual(expect.objectContaining({ [Param.HideLiveboardHeader]: true }));
5733
+ });
5734
+ test('sends the params for a pre-rendered embed', async () => {
5735
+ window.ResizeObserver =
5736
+ window.ResizeObserver ||
5737
+ jest.fn().mockImplementation(() => ({
5738
+ disconnect: jest.fn(),
5739
+ observe: jest.fn(),
5740
+ unobserve: jest.fn(),
5741
+ }));
5742
+ const embed = new LiveboardEmbed(getRootEl(), {
5743
+ ...defaultViewConfig,
5744
+ ...withPostMessage({ liveboardId, hideLiveboardHeader: true }),
5745
+ preRenderId: 'app-init-pre-render',
5746
+ });
5747
+ await embed.preRender();
5748
+ await waitFor(() => !!getIFrameEl());
5749
+ const { embedParams } = await requestAppInit();
5750
+ expect(embedParams).toEqual(expect.objectContaining({ [Param.HideLiveboardHeader]: true }));
5751
+ });
5752
+ test('does not add the APP_INIT copy to UpdateEmbedParams', async () => {
5753
+ mockMessageChannel();
5754
+ window.ResizeObserver =
5755
+ window.ResizeObserver ||
5756
+ jest.fn().mockImplementation(() => ({
5757
+ disconnect: jest.fn(),
5758
+ observe: jest.fn(),
5759
+ unobserve: jest.fn(),
5760
+ }));
5761
+ const embed = new LiveboardEmbed(getRootEl(), {
5762
+ ...defaultViewConfig,
5763
+ ...withPostMessage({ liveboardId, hideLiveboardHeader: true }),
5764
+ preRenderId: 'app-init-copy-pre-render',
5765
+ });
5766
+ await embed.preRender();
5767
+ await waitFor(() => !!getIFrameEl());
5768
+ signalFrameReady();
5769
+ await executeAfterWait(() => {
5770
+ expect(embed.isEmbedContainerLoaded).toBe(true);
5771
+ });
5772
+ // The show cycle is what sends UpdateEmbedParams.
5773
+ await embed.showPreRender();
5774
+ await executeAfterWait(() => {
5775
+ const updateCall = mockProcessTrigger.mock.calls.find((call) => call[1] === HostEvent.UpdateEmbedParams);
5776
+ expect(updateCall[3]).toEqual(expect.objectContaining({ [Param.HideLiveboardHeader]: true }));
5777
+ expect(updateCall[3]).not.toHaveProperty('embedParams');
5778
+ });
5779
+ });
5780
+ // BOOTSTRAP_URL_PARAMS is the source of truth. Each param goes
5781
+ // through additionalFlags so it is checked on its own.
5782
+ test.each([...BOOTSTRAP_URL_PARAMS])('keeps %s on the URL', async (param) => {
5783
+ await renderEmbed(LiveboardEmbed, {
5784
+ liveboardId,
5785
+ additionalFlags: { [param]: 'bootstrap-value' },
5786
+ });
5787
+ expect(new URL(getIFrameSrc()).searchParams.has(param)).toBe(true);
5788
+ });
5789
+ });
5790
+ test('strips a non-bootstrap additionalFlag from the URL when the flag is set', async () => {
5791
+ const { src } = await renderAndGetSrc({
5792
+ ...lbConfig,
5793
+ additionalFlags: {
5794
+ internalBlinkFlag: true,
5795
+ someCustomFlag: 'abc',
5796
+ excludeConfigFromURL: true,
5797
+ },
5798
+ });
5799
+ expect(src).not.toContain('internalBlinkFlag');
5800
+ expect(src).not.toContain('someCustomFlag');
5801
+ });
5802
+ test('keeps an additionalFlag that overrides a bootstrap param on the URL', async () => {
5803
+ const { src } = await renderAndGetSrc({
5804
+ ...lbConfig,
5805
+ additionalFlags: { [Param.OverrideOrgId]: 42, excludeConfigFromURL: true },
5806
+ });
5807
+ expect(src).toContain(`${Param.OverrideOrgId}=42`);
5808
+ });
5809
+ test('keeps the dark mode params on the URL when the flag is set', async () => {
5810
+ const { src } = await renderAndGetSrc(withPostMessage({ ...lbConfig, isDarkMode: true }));
5811
+ expect(src).toContain(`${Param.IsDarkMode}=true`);
5812
+ expect(src).toContain(`${Param.RadiantThemeEnabled}=true`);
5813
+ });
5814
+ test('keeps the deep-link route on the URL when the flag is set', async () => {
5815
+ const { src } = await renderAndGetSrc(withPostMessage(lbConfig));
5816
+ expect(src).toContain(`/embed/viz/${liveboardId}`);
5817
+ });
5818
+ test('sends the config in APP_INIT, not UpdateEmbedParams, on the first load', async () => {
5819
+ await renderAndGetSrc(withPostMessage(lbConfig));
5820
+ const mockPort = { postMessage: jest.fn() };
5821
+ postMessageToParent(getIFrameEl().contentWindow, { type: EmbedEvent.APP_INIT, data: {} }, mockPort);
5822
+ await waitFor(() => mockPort.postMessage.mock.calls.length > 0);
5823
+ signalFrameReady();
5824
+ expect(mockPort.postMessage.mock.calls[0][0].data.embedParams).toEqual(expect.objectContaining({
5825
+ internalBlinkFlag: true,
5826
+ [Param.HideActions]: expect.arrayContaining([Action.Download]),
5827
+ }));
5828
+ await executeAfterWait(() => {
5829
+ const updateCalls = mockProcessTrigger.mock.calls.filter((call) => call[1] === HostEvent.UpdateEmbedParams);
5830
+ expect(updateCalls).toHaveLength(0);
5831
+ });
5832
+ });
5833
+ test('does not send UpdateEmbedParams when the flag is not set', async () => {
5834
+ await renderAndGetSrc(lbConfig);
5835
+ signalFrameReady();
5836
+ await executeAfterWait(() => {
5837
+ const updateCalls = mockProcessTrigger.mock.calls.filter((call) => call[1] === HostEvent.UpdateEmbedParams);
5838
+ expect(updateCalls).toHaveLength(0);
5839
+ });
5840
+ });
5841
+ test('does not double-send for a pre-rendered embed that is shown', async () => {
5842
+ mockMessageChannel();
5843
+ window.ResizeObserver =
5844
+ window.ResizeObserver ||
5845
+ jest.fn().mockImplementation(() => ({
5846
+ disconnect: jest.fn(),
5847
+ observe: jest.fn(),
5848
+ unobserve: jest.fn(),
5849
+ }));
5850
+ const embed = new LiveboardEmbed(getRootEl(), {
5851
+ ...defaultViewConfig,
5852
+ ...withPostMessage(lbConfig),
5853
+ preRenderId: 'send-config-post-message',
5854
+ });
5855
+ await embed.preRender();
5856
+ await waitFor(() => !!getIFrameEl());
5857
+ signalFrameReady();
5858
+ await executeAfterWait(() => {
5859
+ expect(embed.isEmbedContainerLoaded).toBe(true);
5860
+ });
5861
+ // The frame being ready sends nothing; the config went in APP_INIT.
5862
+ expect(mockProcessTrigger.mock.calls.filter((call) => call[1] === HostEvent.UpdateEmbedParams)).toHaveLength(0);
5863
+ mockProcessTrigger.mockClear();
5864
+ await embed.showPreRender();
5865
+ await executeAfterWait(() => {
5866
+ const updateCalls = mockProcessTrigger.mock.calls.filter((call) => call[1] === HostEvent.UpdateEmbedParams);
5867
+ expect(updateCalls).toHaveLength(1);
5868
+ });
5869
+ });
5870
+ });
5494
5871
  //# sourceMappingURL=ts-embed.spec.js.map