@thoughtspot/visual-embed-sdk 1.51.0 → 1.51.2

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 (228) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/config.d.ts +1 -0
  3. package/cjs/src/config.d.ts.map +1 -1
  4. package/cjs/src/config.js +2 -1
  5. package/cjs/src/config.js.map +1 -1
  6. package/cjs/src/css-variables.d.ts +27 -0
  7. package/cjs/src/css-variables.d.ts.map +1 -1
  8. package/cjs/src/embed/app.d.ts +43 -12
  9. package/cjs/src/embed/app.d.ts.map +1 -1
  10. package/cjs/src/embed/app.js +29 -3
  11. package/cjs/src/embed/app.js.map +1 -1
  12. package/cjs/src/embed/app.spec.js +253 -1
  13. package/cjs/src/embed/app.spec.js.map +1 -1
  14. package/cjs/src/embed/base.d.ts +1 -1
  15. package/cjs/src/embed/base.js +1 -1
  16. package/cjs/src/embed/conversation.d.ts +171 -1
  17. package/cjs/src/embed/conversation.d.ts.map +1 -1
  18. package/cjs/src/embed/conversation.js +4 -2
  19. package/cjs/src/embed/conversation.js.map +1 -1
  20. package/cjs/src/embed/conversation.spec.js +125 -0
  21. package/cjs/src/embed/conversation.spec.js.map +1 -1
  22. package/cjs/src/embed/events.spec.js +3 -0
  23. package/cjs/src/embed/events.spec.js.map +1 -1
  24. package/cjs/src/embed/host-events.spec.js +36 -0
  25. package/cjs/src/embed/host-events.spec.js.map +1 -1
  26. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +1 -1
  27. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  28. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +18 -0
  29. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  30. package/cjs/src/embed/liveboard.d.ts +40 -13
  31. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  32. package/cjs/src/embed/liveboard.js +25 -4
  33. package/cjs/src/embed/liveboard.js.map +1 -1
  34. package/cjs/src/embed/liveboard.spec.js +349 -2
  35. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  36. package/cjs/src/embed/search.spec.js +28 -0
  37. package/cjs/src/embed/search.spec.js.map +1 -1
  38. package/cjs/src/embed/spotter-utils.d.ts +8 -1
  39. package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
  40. package/cjs/src/embed/spotter-utils.js +15 -1
  41. package/cjs/src/embed/spotter-utils.js.map +1 -1
  42. package/cjs/src/embed/spotter-utils.spec.js +68 -0
  43. package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
  44. package/cjs/src/embed/spotter-viz-utils.d.ts +9 -10
  45. package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
  46. package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
  47. package/cjs/src/embed/ts-embed.d.ts +97 -9
  48. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  49. package/cjs/src/embed/ts-embed.js +76 -35
  50. package/cjs/src/embed/ts-embed.js.map +1 -1
  51. package/cjs/src/embed/ts-embed.spec.js +537 -3
  52. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  53. package/cjs/src/index.d.ts +3 -3
  54. package/cjs/src/index.d.ts.map +1 -1
  55. package/cjs/src/index.js +3 -2
  56. package/cjs/src/index.js.map +1 -1
  57. package/cjs/src/react/all-types-export.d.ts +1 -1
  58. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  59. package/cjs/src/react/all-types-export.js +2 -1
  60. package/cjs/src/react/all-types-export.js.map +1 -1
  61. package/cjs/src/react/all-types-export.parity.spec.d.ts +2 -0
  62. package/cjs/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  63. package/cjs/src/react/all-types-export.parity.spec.js +194 -0
  64. package/cjs/src/react/all-types-export.parity.spec.js.map +1 -0
  65. package/cjs/src/react/index.d.ts +66 -32
  66. package/cjs/src/react/index.d.ts.map +1 -1
  67. package/cjs/src/react/index.js +5 -3
  68. package/cjs/src/react/index.js.map +1 -1
  69. package/cjs/src/react/index.spec.js +101 -0
  70. package/cjs/src/react/index.spec.js.map +1 -1
  71. package/cjs/src/types.d.ts +330 -18
  72. package/cjs/src/types.d.ts.map +1 -1
  73. package/cjs/src/types.js +182 -12
  74. package/cjs/src/types.js.map +1 -1
  75. package/cjs/src/utils.d.ts +5 -0
  76. package/cjs/src/utils.d.ts.map +1 -1
  77. package/cjs/src/utils.js +19 -1
  78. package/cjs/src/utils.js.map +1 -1
  79. package/cjs/src/utils.spec.js +37 -0
  80. package/cjs/src/utils.spec.js.map +1 -1
  81. package/dist/{index-aBzH5ZwF.js → index-D8_Zs-Nr.js} +1 -1
  82. package/dist/src/config.d.ts +1 -0
  83. package/dist/src/config.d.ts.map +1 -1
  84. package/dist/src/css-variables.d.ts +27 -0
  85. package/dist/src/css-variables.d.ts.map +1 -1
  86. package/dist/src/embed/app.d.ts +43 -12
  87. package/dist/src/embed/app.d.ts.map +1 -1
  88. package/dist/src/embed/base.d.ts +1 -1
  89. package/dist/src/embed/conversation.d.ts +171 -1
  90. package/dist/src/embed/conversation.d.ts.map +1 -1
  91. package/dist/src/embed/hostEventClient/host-event-client.d.ts +1 -1
  92. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  93. package/dist/src/embed/liveboard.d.ts +40 -13
  94. package/dist/src/embed/liveboard.d.ts.map +1 -1
  95. package/dist/src/embed/spotter-utils.d.ts +8 -1
  96. package/dist/src/embed/spotter-utils.d.ts.map +1 -1
  97. package/dist/src/embed/spotter-viz-utils.d.ts +9 -10
  98. package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
  99. package/dist/src/embed/ts-embed.d.ts +97 -9
  100. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  101. package/dist/src/index.d.ts +3 -3
  102. package/dist/src/index.d.ts.map +1 -1
  103. package/dist/src/react/all-types-export.d.ts +1 -1
  104. package/dist/src/react/all-types-export.d.ts.map +1 -1
  105. package/dist/src/react/all-types-export.parity.spec.d.ts +2 -0
  106. package/dist/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  107. package/dist/src/react/index.d.ts +66 -32
  108. package/dist/src/react/index.d.ts.map +1 -1
  109. package/dist/src/types.d.ts +330 -18
  110. package/dist/src/types.d.ts.map +1 -1
  111. package/dist/src/utils.d.ts +5 -0
  112. package/dist/src/utils.d.ts.map +1 -1
  113. package/dist/tsembed-react.es.js +354 -64
  114. package/dist/tsembed-react.js +353 -63
  115. package/dist/tsembed.es.js +414 -126
  116. package/dist/tsembed.js +416 -128
  117. package/dist/visual-embed-sdk-react-full.d.ts +777 -90
  118. package/dist/visual-embed-sdk-react.d.ts +773 -89
  119. package/dist/visual-embed-sdk.d.ts +713 -60
  120. package/lib/package.json +1 -1
  121. package/lib/src/config.d.ts +1 -0
  122. package/lib/src/config.d.ts.map +1 -1
  123. package/lib/src/config.js +1 -0
  124. package/lib/src/config.js.map +1 -1
  125. package/lib/src/css-variables.d.ts +27 -0
  126. package/lib/src/css-variables.d.ts.map +1 -1
  127. package/lib/src/embed/app.d.ts +43 -12
  128. package/lib/src/embed/app.d.ts.map +1 -1
  129. package/lib/src/embed/app.js +30 -4
  130. package/lib/src/embed/app.js.map +1 -1
  131. package/lib/src/embed/app.spec.js +253 -1
  132. package/lib/src/embed/app.spec.js.map +1 -1
  133. package/lib/src/embed/base.d.ts +1 -1
  134. package/lib/src/embed/base.js +1 -1
  135. package/lib/src/embed/conversation.d.ts +171 -1
  136. package/lib/src/embed/conversation.d.ts.map +1 -1
  137. package/lib/src/embed/conversation.js +5 -3
  138. package/lib/src/embed/conversation.js.map +1 -1
  139. package/lib/src/embed/conversation.spec.js +125 -0
  140. package/lib/src/embed/conversation.spec.js.map +1 -1
  141. package/lib/src/embed/events.spec.js +3 -0
  142. package/lib/src/embed/events.spec.js.map +1 -1
  143. package/lib/src/embed/host-events.spec.js +36 -0
  144. package/lib/src/embed/host-events.spec.js.map +1 -1
  145. package/lib/src/embed/hostEventClient/host-event-client.d.ts +1 -1
  146. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  147. package/lib/src/embed/hostEventClient/host-event-client.spec.js +18 -0
  148. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  149. package/lib/src/embed/liveboard.d.ts +40 -13
  150. package/lib/src/embed/liveboard.d.ts.map +1 -1
  151. package/lib/src/embed/liveboard.js +25 -4
  152. package/lib/src/embed/liveboard.js.map +1 -1
  153. package/lib/src/embed/liveboard.spec.js +349 -2
  154. package/lib/src/embed/liveboard.spec.js.map +1 -1
  155. package/lib/src/embed/search.spec.js +28 -0
  156. package/lib/src/embed/search.spec.js.map +1 -1
  157. package/lib/src/embed/spotter-utils.d.ts +8 -1
  158. package/lib/src/embed/spotter-utils.d.ts.map +1 -1
  159. package/lib/src/embed/spotter-utils.js +13 -0
  160. package/lib/src/embed/spotter-utils.js.map +1 -1
  161. package/lib/src/embed/spotter-utils.spec.js +69 -1
  162. package/lib/src/embed/spotter-utils.spec.js.map +1 -1
  163. package/lib/src/embed/spotter-viz-utils.d.ts +9 -10
  164. package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
  165. package/lib/src/embed/spotter-viz-utils.js.map +1 -1
  166. package/lib/src/embed/ts-embed.d.ts +97 -9
  167. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  168. package/lib/src/embed/ts-embed.js +77 -36
  169. package/lib/src/embed/ts-embed.js.map +1 -1
  170. package/lib/src/embed/ts-embed.spec.js +537 -3
  171. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  172. package/lib/src/index.d.ts +3 -3
  173. package/lib/src/index.d.ts.map +1 -1
  174. package/lib/src/index.js +2 -2
  175. package/lib/src/index.js.map +1 -1
  176. package/lib/src/react/all-types-export.d.ts +1 -1
  177. package/lib/src/react/all-types-export.d.ts.map +1 -1
  178. package/lib/src/react/all-types-export.js +1 -1
  179. package/lib/src/react/all-types-export.js.map +1 -1
  180. package/lib/src/react/all-types-export.parity.spec.d.ts +2 -0
  181. package/lib/src/react/all-types-export.parity.spec.d.ts.map +1 -0
  182. package/lib/src/react/all-types-export.parity.spec.js +191 -0
  183. package/lib/src/react/all-types-export.parity.spec.js.map +1 -0
  184. package/lib/src/react/index.d.ts +66 -32
  185. package/lib/src/react/index.d.ts.map +1 -1
  186. package/lib/src/react/index.js +5 -3
  187. package/lib/src/react/index.js.map +1 -1
  188. package/lib/src/react/index.spec.js +102 -1
  189. package/lib/src/react/index.spec.js.map +1 -1
  190. package/lib/src/types.d.ts +330 -18
  191. package/lib/src/types.d.ts.map +1 -1
  192. package/lib/src/types.js +182 -12
  193. package/lib/src/types.js.map +1 -1
  194. package/lib/src/utils.d.ts +5 -0
  195. package/lib/src/utils.d.ts.map +1 -1
  196. package/lib/src/utils.js +17 -0
  197. package/lib/src/utils.js.map +1 -1
  198. package/lib/src/utils.spec.js +38 -1
  199. package/lib/src/utils.spec.js.map +1 -1
  200. package/lib/src/visual-embed-sdk.d.ts +713 -60
  201. package/package.json +1 -1
  202. package/src/config.ts +1 -0
  203. package/src/css-variables.ts +32 -0
  204. package/src/embed/app.spec.ts +335 -1
  205. package/src/embed/app.ts +71 -13
  206. package/src/embed/base.ts +1 -1
  207. package/src/embed/conversation.spec.ts +136 -0
  208. package/src/embed/conversation.ts +181 -3
  209. package/src/embed/events.spec.ts +4 -0
  210. package/src/embed/host-events.spec.ts +48 -0
  211. package/src/embed/hostEventClient/host-event-client.spec.ts +34 -0
  212. package/src/embed/hostEventClient/host-event-client.ts +2 -2
  213. package/src/embed/liveboard.spec.ts +457 -2
  214. package/src/embed/liveboard.ts +74 -15
  215. package/src/embed/search.spec.ts +31 -0
  216. package/src/embed/spotter-utils.spec.ts +72 -0
  217. package/src/embed/spotter-utils.ts +21 -1
  218. package/src/embed/spotter-viz-utils.ts +9 -10
  219. package/src/embed/ts-embed.spec.ts +699 -3
  220. package/src/embed/ts-embed.ts +91 -41
  221. package/src/index.ts +43 -2
  222. package/src/react/all-types-export.parity.spec.ts +208 -0
  223. package/src/react/all-types-export.ts +22 -0
  224. package/src/react/index.spec.tsx +158 -0
  225. package/src/react/index.tsx +70 -33
  226. package/src/types.ts +329 -16
  227. package/src/utils.spec.ts +49 -0
  228. package/src/utils.ts +16 -0
@@ -2739,6 +2739,45 @@ describe('Unit test case for ts embed', () => {
2739
2739
  (logger.error as any).mockClear();
2740
2740
  });
2741
2741
 
2742
+ it('should skip syncing styles when the placeholder is detached', async () => {
2743
+ createRootEleForEmbed();
2744
+ jest.spyOn(logger, 'debug').mockImplementation(jest.fn());
2745
+
2746
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2747
+ liveboardId: 'myLiveboardId',
2748
+ preRenderId: 'placeholder-detached',
2749
+ doNotTrackPreRenderSize: true,
2750
+ });
2751
+ libEmbed.preRender();
2752
+ await waitFor(() => !!getIFrameEl());
2753
+ await libEmbed.showPreRender();
2754
+
2755
+ const preRenderIds = libEmbed.getPreRenderIds();
2756
+ const wrapper = document.getElementById(preRenderIds.wrapper);
2757
+ const placeholder = document.getElementById(preRenderIds.placeHolder);
2758
+ const rectSpy = jest.spyOn(placeholder, 'getBoundingClientRect');
2759
+ wrapper.style.top = '42px';
2760
+ wrapper.style.height = '111px';
2761
+ (logger.debug as any).mockClear();
2762
+
2763
+ // Simulate the host subtree being unmounted: the placeholder is no
2764
+ // longer connected to the document.
2765
+ placeholder.remove();
2766
+ libEmbed.syncPreRenderStyle();
2767
+
2768
+ expect(logger.debug).toHaveBeenCalledWith(
2769
+ 'syncPreRenderStyle skipped: placeholder is detached',
2770
+ );
2771
+ // The detached node is never measured, so the wrapper keeps its
2772
+ // last known geometry instead of collapsing to a stale rect.
2773
+ expect(rectSpy).not.toHaveBeenCalled();
2774
+ expect(wrapper.style.top).toBe('42px');
2775
+ expect(wrapper.style.height).toBe('111px');
2776
+
2777
+ libEmbed.destroy();
2778
+ (logger.debug as any).mockRestore();
2779
+ });
2780
+
2742
2781
  describe('preRenderContainer', () => {
2743
2782
  it('should append preRenderWrapper to document.body when preRenderContainer is not set', async () => {
2744
2783
  createRootEleForEmbed();
@@ -2868,9 +2907,10 @@ describe('Unit test case for ts embed', () => {
2868
2907
 
2869
2908
  // Reverts to the exact value the container had before.
2870
2909
  expect(customContainer.style.position).toBe('static');
2871
- // The container reference is dropped so a destroyed embed does
2872
- // not pin the (possibly detached) element in memory.
2873
- expect((libEmbed as any).preRenderContainerEl).toBeNull();
2910
+ // The custom container reference is dropped (back to the default
2911
+ // body) so a destroyed embed does not pin the (possibly
2912
+ // detached) element in memory.
2913
+ expect((libEmbed as any).preRenderContainerEl).toBe(document.body);
2874
2914
 
2875
2915
  customContainer.remove();
2876
2916
  });
@@ -2896,6 +2936,38 @@ describe('Unit test case for ts embed', () => {
2896
2936
  customContainer.remove();
2897
2937
  });
2898
2938
 
2939
+ it('should default preRenderContainerEl to document.body before rendering', () => {
2940
+ createRootEleForEmbed();
2941
+
2942
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2943
+ liveboardId: 'myLiveboardId',
2944
+ });
2945
+
2946
+ // document.body is the "no custom container" sentinel, so the
2947
+ // field is never null and needs no null-guarding downstream.
2948
+ expect((libEmbed as any).preRenderContainerEl).toBe(document.body);
2949
+ });
2950
+
2951
+ it('should leave document.body untouched on destroy when no custom container is set', async () => {
2952
+ createRootEleForEmbed();
2953
+ const originalBodyPosition = document.body.style.position;
2954
+
2955
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
2956
+ preRenderId: 'container-body-destroy',
2957
+ liveboardId: 'myLiveboardId',
2958
+ });
2959
+ await libEmbed.preRender();
2960
+
2961
+ expect((libEmbed as any).preRenderContainerEl).toBe(document.body);
2962
+
2963
+ libEmbed.destroy();
2964
+
2965
+ // The body sentinel must never be treated as a custom container:
2966
+ // no position override to apply and none to restore.
2967
+ expect(document.body.style.position).toBe(originalBodyPosition);
2968
+ expect(document.body.dataset.tsEmbedOriginalPosition).toBeUndefined();
2969
+ });
2970
+
2899
2971
  it('should keep the container positioned on destroy while another preRender wrapper remains', async () => {
2900
2972
  createRootEleForEmbed();
2901
2973
  const customContainer = document.createElement('div');
@@ -2999,6 +3071,45 @@ describe('Unit test case for ts embed', () => {
2999
3071
  newContainer.remove();
3000
3072
  });
3001
3073
 
3074
+ it('should position the newly resolved container after a remount, not the stale one', async () => {
3075
+ createRootEleForEmbed();
3076
+ const oldContainer = document.createElement('div');
3077
+ oldContainer.id = 'reposition-remount-container';
3078
+ oldContainer.style.position = 'static';
3079
+ document.body.appendChild(oldContainer);
3080
+
3081
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3082
+ preRenderId: 'container-remount-position',
3083
+ liveboardId: 'myLiveboardId',
3084
+ preRenderContainer: '#reposition-remount-container',
3085
+ doNotTrackPreRenderSize: true,
3086
+ });
3087
+ libEmbed.preRender();
3088
+ await waitFor(() => !!getIFrameEl());
3089
+ await libEmbed.showPreRender();
3090
+
3091
+ expect(oldContainer.style.position).toBe('relative');
3092
+
3093
+ oldContainer.remove();
3094
+ const newContainer = document.createElement('div');
3095
+ newContainer.id = 'reposition-remount-container';
3096
+ newContainer.style.position = 'static';
3097
+ document.body.appendChild(newContainer);
3098
+
3099
+ libEmbed.syncPreRenderStyle();
3100
+
3101
+ // applyPreRenderContainerPositioning() reads preRenderContainerEl
3102
+ // instead of taking the container as an argument, so reconcile has
3103
+ // to assign the field before calling it — otherwise the override
3104
+ // lands on the detached node and the fresh one stays static.
3105
+ expect((libEmbed as any).preRenderContainerEl).toBe(newContainer);
3106
+ expect(newContainer.style.position).toBe('relative');
3107
+ expect(newContainer.dataset.tsEmbedOriginalPosition).toBe('static');
3108
+
3109
+ libEmbed.destroy();
3110
+ newContainer.remove();
3111
+ });
3112
+
3002
3113
  it('should leave an element-passed container untouched when it is detached', async () => {
3003
3114
  createRootEleForEmbed();
3004
3115
  const container = document.createElement('div');
@@ -3027,6 +3138,557 @@ describe('Unit test case for ts embed', () => {
3027
3138
 
3028
3139
  libEmbed.destroy();
3029
3140
  });
3141
+
3142
+ describe('connectPreRendered container init', () => {
3143
+ beforeEach(() => {
3144
+ (window as any).ResizeObserver = jest.fn().mockImplementation(() => ({
3145
+ disconnect: jest.fn(),
3146
+ observe: jest.fn(),
3147
+ unobserve: jest.fn(),
3148
+ }));
3149
+ });
3150
+
3151
+ it('should resolve preRenderContainerEl when connecting to an existing pre-render', async () => {
3152
+ createRootEleForEmbed();
3153
+
3154
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3155
+ preRenderId: 'connect-init-default',
3156
+ liveboardId: 'myLiveboardId',
3157
+ });
3158
+ await firstEmbed.preRender();
3159
+ await waitFor(() => !!getIFrameEl());
3160
+
3161
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3162
+ preRenderId: 'connect-init-default',
3163
+ liveboardId: 'myLiveboardId',
3164
+ });
3165
+ await connectingEmbed.showPreRender();
3166
+
3167
+ expect((connectingEmbed as any).preRenderContainerEl).not.toBeNull();
3168
+
3169
+ firstEmbed.destroy();
3170
+ });
3171
+
3172
+ it('should fall back to document.body when no preRenderContainer is configured on the connecting embed', async () => {
3173
+ createRootEleForEmbed();
3174
+
3175
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3176
+ preRenderId: 'connect-init-body',
3177
+ liveboardId: 'myLiveboardId',
3178
+ });
3179
+ await firstEmbed.preRender();
3180
+ await waitFor(() => !!getIFrameEl());
3181
+
3182
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3183
+ preRenderId: 'connect-init-body',
3184
+ liveboardId: 'myLiveboardId',
3185
+ });
3186
+ await connectingEmbed.showPreRender();
3187
+
3188
+ expect((connectingEmbed as any).preRenderContainerEl).toBe(document.body);
3189
+
3190
+ firstEmbed.destroy();
3191
+ });
3192
+
3193
+ it('should resolve a custom preRenderContainer on the connecting embed', async () => {
3194
+ createRootEleForEmbed();
3195
+ const customContainer = document.createElement('div');
3196
+ customContainer.id = 'connect-custom-container';
3197
+ document.body.appendChild(customContainer);
3198
+
3199
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3200
+ preRenderId: 'connect-init-custom',
3201
+ liveboardId: 'myLiveboardId',
3202
+ preRenderContainer: customContainer,
3203
+ });
3204
+ await firstEmbed.preRender();
3205
+ await waitFor(() => !!getIFrameEl());
3206
+
3207
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3208
+ preRenderId: 'connect-init-custom',
3209
+ liveboardId: 'myLiveboardId',
3210
+ preRenderContainer: customContainer,
3211
+ });
3212
+ await connectingEmbed.showPreRender();
3213
+
3214
+ expect((connectingEmbed as any).preRenderContainerEl).toBe(customContainer);
3215
+
3216
+ firstEmbed.destroy();
3217
+ customContainer.remove();
3218
+ });
3219
+
3220
+ it('should apply container positioning when the connecting embed resolves a static container', async () => {
3221
+ createRootEleForEmbed();
3222
+ const customContainer = document.createElement('div');
3223
+ customContainer.id = 'connect-static-container';
3224
+ customContainer.style.position = 'static';
3225
+ document.body.appendChild(customContainer);
3226
+
3227
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3228
+ preRenderId: 'connect-init-static',
3229
+ liveboardId: 'myLiveboardId',
3230
+ preRenderContainer: customContainer,
3231
+ });
3232
+ await firstEmbed.preRender();
3233
+ await waitFor(() => !!getIFrameEl());
3234
+
3235
+ // Reset position to static so the connecting embed also triggers the guard.
3236
+ customContainer.style.position = 'static';
3237
+ delete customContainer.dataset['preRenderContainerOriginalPosition'];
3238
+
3239
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3240
+ preRenderId: 'connect-init-static',
3241
+ liveboardId: 'myLiveboardId',
3242
+ preRenderContainer: customContainer,
3243
+ });
3244
+ await connectingEmbed.showPreRender();
3245
+
3246
+ expect(customContainer.style.position).toBe('relative');
3247
+
3248
+ firstEmbed.destroy();
3249
+ connectingEmbed.destroy();
3250
+ customContainer.remove();
3251
+ });
3252
+
3253
+ it('should inherit the container from the pre-rendering embed instead of re-resolving it', async () => {
3254
+ createRootEleForEmbed();
3255
+ const customContainer = document.createElement('div');
3256
+ customContainer.id = 'connect-inherit-container';
3257
+ document.body.appendChild(customContainer);
3258
+
3259
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3260
+ preRenderId: 'connect-no-re-resolve',
3261
+ liveboardId: 'myLiveboardId',
3262
+ preRenderContainer: customContainer,
3263
+ });
3264
+ await firstEmbed.preRender();
3265
+ await waitFor(() => !!getIFrameEl());
3266
+
3267
+ // No preRenderContainer here: the container belongs to the
3268
+ // PreRender component and is adopted as-is.
3269
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3270
+ preRenderId: 'connect-no-re-resolve',
3271
+ liveboardId: 'myLiveboardId',
3272
+ });
3273
+
3274
+ const resolveSpy = jest.spyOn(
3275
+ connectingEmbed as any,
3276
+ 'resolvePreRenderContainerTarget',
3277
+ );
3278
+
3279
+ (connectingEmbed as any).connectPreRendered();
3280
+
3281
+ expect((connectingEmbed as any).preRenderContainerEl).toBe(customContainer);
3282
+ expect(resolveSpy).not.toHaveBeenCalled();
3283
+
3284
+ firstEmbed.destroy();
3285
+ customContainer.remove();
3286
+ });
3287
+
3288
+ it('should warn and ignore a preRenderContainer passed on the connecting embed', async () => {
3289
+ createRootEleForEmbed();
3290
+ const ownerContainer = document.createElement('div');
3291
+ ownerContainer.id = 'connect-owner-container';
3292
+ const otherContainer = document.createElement('div');
3293
+ otherContainer.id = 'connect-other-container';
3294
+ document.body.appendChild(ownerContainer);
3295
+ document.body.appendChild(otherContainer);
3296
+ const warnSpy = jest.spyOn(logger, 'warn').mockImplementation(() => undefined);
3297
+
3298
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3299
+ preRenderId: 'connect-container-warn',
3300
+ liveboardId: 'myLiveboardId',
3301
+ preRenderContainer: ownerContainer,
3302
+ });
3303
+ await firstEmbed.preRender();
3304
+ await waitFor(() => !!getIFrameEl());
3305
+
3306
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3307
+ preRenderId: 'connect-container-warn',
3308
+ liveboardId: 'myLiveboardId',
3309
+ preRenderContainer: otherContainer,
3310
+ });
3311
+ (connectingEmbed as any).connectPreRendered();
3312
+
3313
+ expect((connectingEmbed as any).preRenderContainerEl).toBe(ownerContainer);
3314
+ expect(warnSpy).toHaveBeenCalledWith(
3315
+ expect.stringContaining('preRenderContainer is applied only by'),
3316
+ );
3317
+
3318
+ warnSpy.mockRestore();
3319
+ firstEmbed.destroy();
3320
+ ownerContainer.remove();
3321
+ otherContainer.remove();
3322
+ });
3323
+
3324
+ it('should not warn when the connecting embed passes the same container element', async () => {
3325
+ createRootEleForEmbed();
3326
+ const customContainer = document.createElement('div');
3327
+ customContainer.id = 'connect-same-element-container';
3328
+ document.body.appendChild(customContainer);
3329
+ const warnSpy = jest.spyOn(logger, 'warn').mockImplementation(() => undefined);
3330
+
3331
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3332
+ preRenderId: 'connect-same-element',
3333
+ liveboardId: 'myLiveboardId',
3334
+ preRenderContainer: customContainer,
3335
+ });
3336
+ await firstEmbed.preRender();
3337
+ await waitFor(() => !!getIFrameEl());
3338
+
3339
+ // Same config on both components — the value is redundant but
3340
+ // not wrong, so nagging about it would be noise.
3341
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3342
+ preRenderId: 'connect-same-element',
3343
+ liveboardId: 'myLiveboardId',
3344
+ preRenderContainer: customContainer,
3345
+ });
3346
+ (connectingEmbed as any).connectPreRendered();
3347
+
3348
+ expect((connectingEmbed as any).preRenderContainerEl).toBe(customContainer);
3349
+ expect(warnSpy).not.toHaveBeenCalledWith(
3350
+ expect.stringContaining('preRenderContainer is applied only by'),
3351
+ );
3352
+
3353
+ warnSpy.mockRestore();
3354
+ firstEmbed.destroy();
3355
+ customContainer.remove();
3356
+ });
3357
+
3358
+ it('should not warn when the connecting embed passes a selector for the same container', async () => {
3359
+ createRootEleForEmbed();
3360
+ const customContainer = document.createElement('div');
3361
+ customContainer.id = 'connect-same-selector-container';
3362
+ document.body.appendChild(customContainer);
3363
+ const warnSpy = jest.spyOn(logger, 'warn').mockImplementation(() => undefined);
3364
+
3365
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3366
+ preRenderId: 'connect-same-selector',
3367
+ liveboardId: 'myLiveboardId',
3368
+ preRenderContainer: customContainer,
3369
+ });
3370
+ await firstEmbed.preRender();
3371
+ await waitFor(() => !!getIFrameEl());
3372
+
3373
+ // A selector that resolves to the owner's element is the same
3374
+ // container, so the comparison must be by resolved node.
3375
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3376
+ preRenderId: 'connect-same-selector',
3377
+ liveboardId: 'myLiveboardId',
3378
+ preRenderContainer: '#connect-same-selector-container',
3379
+ });
3380
+ (connectingEmbed as any).connectPreRendered();
3381
+
3382
+ expect((connectingEmbed as any).preRenderContainerEl).toBe(customContainer);
3383
+ expect(warnSpy).not.toHaveBeenCalledWith(
3384
+ expect.stringContaining('preRenderContainer is applied only by'),
3385
+ );
3386
+
3387
+ warnSpy.mockRestore();
3388
+ firstEmbed.destroy();
3389
+ customContainer.remove();
3390
+ });
3391
+
3392
+ it('should keep its own container when the same instance owns the pre-render', async () => {
3393
+ createRootEleForEmbed();
3394
+ const customContainer = document.createElement('div');
3395
+ customContainer.id = 'connect-self-container';
3396
+ document.body.appendChild(customContainer);
3397
+ const warnSpy = jest.spyOn(logger, 'warn').mockImplementation(() => undefined);
3398
+
3399
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3400
+ preRenderId: 'connect-self',
3401
+ liveboardId: 'myLiveboardId',
3402
+ preRenderContainer: customContainer,
3403
+ });
3404
+ await libEmbed.preRender();
3405
+ await waitFor(() => !!getIFrameEl());
3406
+
3407
+ // preRender() then render() on one instance: it owns the
3408
+ // wrapper, so there is nothing to inherit and its own
3409
+ // preRenderContainer is entirely legitimate.
3410
+ (libEmbed as any).connectPreRendered();
3411
+
3412
+ expect((libEmbed as any).preRenderContainerEl).toBe(customContainer);
3413
+ expect(warnSpy).not.toHaveBeenCalledWith(
3414
+ expect.stringContaining('preRenderContainer is applied only by'),
3415
+ );
3416
+
3417
+ warnSpy.mockRestore();
3418
+ libEmbed.destroy();
3419
+ customContainer.remove();
3420
+ });
3421
+
3422
+ it('should stay on document.body when the wrapper has no owning embed', async () => {
3423
+ createRootEleForEmbed();
3424
+ const customContainer = document.createElement('div');
3425
+ customContainer.id = 'connect-unstamped-container';
3426
+ document.body.appendChild(customContainer);
3427
+ const warnSpy = jest.spyOn(logger, 'warn').mockImplementation(() => undefined);
3428
+
3429
+ const firstEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3430
+ preRenderId: 'connect-unstamped',
3431
+ liveboardId: 'myLiveboardId',
3432
+ preRenderContainer: customContainer,
3433
+ });
3434
+ await firstEmbed.preRender();
3435
+ await waitFor(() => !!getIFrameEl());
3436
+
3437
+ // Simulate a wrapper with no live embed behind it: the
3438
+ // __tsEmbed stamp used to locate the owner is gone, so there
3439
+ // is no container to inherit.
3440
+ const wrapper = document.getElementById(
3441
+ firstEmbed.getPreRenderIds().wrapper,
3442
+ );
3443
+ delete (wrapper as any).__tsEmbed;
3444
+
3445
+ const connectingEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3446
+ preRenderId: 'connect-unstamped',
3447
+ liveboardId: 'myLiveboardId',
3448
+ });
3449
+ (connectingEmbed as any).connectPreRendered();
3450
+
3451
+ // Falls back to the sentinel rather than crashing on the
3452
+ // missing owner, and warns about nothing.
3453
+ expect((connectingEmbed as any).preRenderContainerEl).toBe(document.body);
3454
+ expect(warnSpy).not.toHaveBeenCalledWith(
3455
+ expect.stringContaining('preRenderContainer is applied only by'),
3456
+ );
3457
+
3458
+ warnSpy.mockRestore();
3459
+ firstEmbed.destroy();
3460
+ customContainer.remove();
3461
+ });
3462
+ });
3463
+ });
3464
+
3465
+ describe('preRenderConfig', () => {
3466
+ beforeEach(() => {
3467
+ (window as any).ResizeObserver = jest.fn().mockImplementation(() => ({
3468
+ disconnect: jest.fn(),
3469
+ observe: jest.fn(),
3470
+ unobserve: jest.fn(),
3471
+ }));
3472
+ });
3473
+
3474
+ it('should use default z-index of -1000 when preRenderConfig is not set', async () => {
3475
+ createRootEleForEmbed();
3476
+
3477
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3478
+ preRenderId: 'pre-render-config-defaults',
3479
+ liveboardId: 'myLiveboardId',
3480
+ });
3481
+
3482
+ await libEmbed.preRender();
3483
+ await waitFor(() => !!getIFrameEl());
3484
+
3485
+ const preRenderIds = libEmbed.getPreRenderIds();
3486
+ const preRenderWrapper = document.getElementById(preRenderIds.wrapper);
3487
+
3488
+ expect(preRenderWrapper.style.zIndex).toBe('-1000');
3489
+
3490
+ libEmbed.destroy();
3491
+ });
3492
+
3493
+ it('should apply custom zIndex from preRenderConfig when hidden', async () => {
3494
+ createRootEleForEmbed();
3495
+
3496
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3497
+ preRenderId: 'pre-render-config-custom-z-index',
3498
+ liveboardId: 'myLiveboardId',
3499
+ preRenderConfig: {
3500
+ zIndex: -10,
3501
+ },
3502
+ });
3503
+
3504
+ await libEmbed.preRender();
3505
+ await waitFor(() => !!getIFrameEl());
3506
+
3507
+ const preRenderIds = libEmbed.getPreRenderIds();
3508
+ const preRenderWrapper = document.getElementById(preRenderIds.wrapper);
3509
+
3510
+ expect(preRenderWrapper.style.zIndex).toBe('-10');
3511
+
3512
+ libEmbed.destroy();
3513
+ });
3514
+
3515
+ it('should clear z-index on showPreRender and restore custom zIndex on hidePreRender', async () => {
3516
+ createRootEleForEmbed();
3517
+
3518
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3519
+ preRenderId: 'pre-render-config-cycle',
3520
+ liveboardId: 'myLiveboardId',
3521
+ preRenderConfig: {
3522
+ zIndex: -5,
3523
+ },
3524
+ });
3525
+
3526
+ await libEmbed.preRender();
3527
+ await waitFor(() => !!getIFrameEl());
3528
+
3529
+ const preRenderIds = libEmbed.getPreRenderIds();
3530
+ const preRenderWrapper = document.getElementById(preRenderIds.wrapper);
3531
+
3532
+ expect(preRenderWrapper.style.zIndex).toBe('-5');
3533
+
3534
+ libEmbed.showPreRender();
3535
+ expect(preRenderWrapper.style.zIndex).toBe('');
3536
+
3537
+ libEmbed.hidePreRender();
3538
+ expect(preRenderWrapper.style.zIndex).toBe('-5');
3539
+
3540
+ libEmbed.destroy();
3541
+ });
3542
+
3543
+ it('should use preRenderConfig.preRenderId to identify the pre-render instance', async () => {
3544
+ createRootEleForEmbed();
3545
+
3546
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3547
+ liveboardId: 'myLiveboardId',
3548
+ preRenderConfig: {
3549
+ preRenderId: 'config-level-id',
3550
+ },
3551
+ });
3552
+
3553
+ await libEmbed.preRender();
3554
+ await waitFor(() => !!getIFrameEl());
3555
+
3556
+ const preRenderIds = libEmbed.getPreRenderIds();
3557
+ expect(preRenderIds.wrapper).toContain('config-level-id');
3558
+ expect(document.getElementById(preRenderIds.wrapper)).not.toBeNull();
3559
+
3560
+ libEmbed.destroy();
3561
+ });
3562
+
3563
+ it('should prefer preRenderConfig.preRenderId over top-level preRenderId', async () => {
3564
+ createRootEleForEmbed();
3565
+
3566
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3567
+ liveboardId: 'myLiveboardId',
3568
+ preRenderId: 'top-level-id',
3569
+ preRenderConfig: {
3570
+ preRenderId: 'config-level-id',
3571
+ },
3572
+ });
3573
+
3574
+ await libEmbed.preRender();
3575
+ await waitFor(() => !!getIFrameEl());
3576
+
3577
+ const preRenderIds = libEmbed.getPreRenderIds();
3578
+ expect(preRenderIds.wrapper).toContain('config-level-id');
3579
+ expect(preRenderIds.wrapper).not.toContain('top-level-id');
3580
+
3581
+ libEmbed.destroy();
3582
+ });
3583
+
3584
+ it('should mount the wrapper into preRenderConfig.preRenderContainer', async () => {
3585
+ createRootEleForEmbed();
3586
+ const customContainer = document.createElement('div');
3587
+ customContainer.id = 'config-level-container';
3588
+ document.body.appendChild(customContainer);
3589
+
3590
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3591
+ liveboardId: 'myLiveboardId',
3592
+ preRenderConfig: {
3593
+ preRenderId: 'container-via-config',
3594
+ preRenderContainer: '#config-level-container',
3595
+ },
3596
+ });
3597
+
3598
+ await libEmbed.preRender();
3599
+ await waitFor(() => !!getIFrameEl());
3600
+
3601
+ const preRenderIds = libEmbed.getPreRenderIds();
3602
+ const preRenderWrapper = document.getElementById(preRenderIds.wrapper);
3603
+ expect(customContainer.contains(preRenderWrapper)).toBe(true);
3604
+
3605
+ libEmbed.destroy();
3606
+ customContainer.remove();
3607
+ });
3608
+
3609
+ it('should prefer preRenderConfig.preRenderContainer over top-level preRenderContainer', async () => {
3610
+ createRootEleForEmbed();
3611
+ const topContainer = document.createElement('div');
3612
+ topContainer.id = 'top-level-container';
3613
+ document.body.appendChild(topContainer);
3614
+ const configContainer = document.createElement('div');
3615
+ configContainer.id = 'config-level-container-2';
3616
+ document.body.appendChild(configContainer);
3617
+
3618
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3619
+ liveboardId: 'myLiveboardId',
3620
+ preRenderContainer: '#top-level-container',
3621
+ preRenderConfig: {
3622
+ preRenderId: 'container-precedence',
3623
+ preRenderContainer: '#config-level-container-2',
3624
+ },
3625
+ });
3626
+
3627
+ await libEmbed.preRender();
3628
+ await waitFor(() => !!getIFrameEl());
3629
+
3630
+ const preRenderIds = libEmbed.getPreRenderIds();
3631
+ const preRenderWrapper = document.getElementById(preRenderIds.wrapper);
3632
+ expect(configContainer.contains(preRenderWrapper)).toBe(true);
3633
+ expect(topContainer.contains(preRenderWrapper)).toBe(false);
3634
+
3635
+ libEmbed.destroy();
3636
+ topContainer.remove();
3637
+ configContainer.remove();
3638
+ });
3639
+
3640
+ it('should not attach ResizeObserver when preRenderConfig.doNotTrackPreRenderSize is true', async () => {
3641
+ createRootEleForEmbed();
3642
+ const observeMock = jest.fn();
3643
+ (window as any).ResizeObserver = jest.fn().mockImplementation(() => ({
3644
+ disconnect: jest.fn(),
3645
+ observe: observeMock,
3646
+ unobserve: jest.fn(),
3647
+ }));
3648
+
3649
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3650
+ liveboardId: 'myLiveboardId',
3651
+ preRenderConfig: {
3652
+ preRenderId: 'no-track-via-config',
3653
+ doNotTrackPreRenderSize: true,
3654
+ },
3655
+ });
3656
+
3657
+ await libEmbed.preRender();
3658
+ await waitFor(() => !!getIFrameEl());
3659
+ libEmbed.showPreRender();
3660
+
3661
+ expect(observeMock).not.toHaveBeenCalled();
3662
+
3663
+ libEmbed.destroy();
3664
+ });
3665
+
3666
+ it('should prefer preRenderConfig.doNotTrackPreRenderSize over top-level doNotTrackPreRenderSize', async () => {
3667
+ createRootEleForEmbed();
3668
+ const observeMock = jest.fn();
3669
+ (window as any).ResizeObserver = jest.fn().mockImplementation(() => ({
3670
+ disconnect: jest.fn(),
3671
+ observe: observeMock,
3672
+ unobserve: jest.fn(),
3673
+ }));
3674
+
3675
+ const libEmbed = new LiveboardEmbed('#tsEmbedDiv', {
3676
+ liveboardId: 'myLiveboardId',
3677
+ doNotTrackPreRenderSize: false,
3678
+ preRenderConfig: {
3679
+ preRenderId: 'no-track-precedence',
3680
+ doNotTrackPreRenderSize: true,
3681
+ },
3682
+ });
3683
+
3684
+ await libEmbed.preRender();
3685
+ await waitFor(() => !!getIFrameEl());
3686
+ libEmbed.showPreRender();
3687
+
3688
+ expect(observeMock).not.toHaveBeenCalled();
3689
+
3690
+ libEmbed.destroy();
3691
+ });
3030
3692
  });
3031
3693
  });
3032
3694
 
@@ -5502,4 +6164,38 @@ describe('ShowPreRender with UpdateEmbedParams', () => {
5502
6164
  embed.destroy();
5503
6165
  });
5504
6166
  });
6167
+
6168
+ describe('trigger typing contracts (compile-time)', () => {
6169
+ // Guards the BASE TsEmbed.trigger — the implementation every
6170
+ // non-Liveboard embed (SearchEmbed, AppEmbed, ConversationEmbed, …)
6171
+ // calls. LiveboardEmbed's override is covered in liveboard.spec.ts;
6172
+ // this locks the base defaults so a "lint fix" that drops them here
6173
+ // can't silently de-type every embed except Liveboard.
6174
+ // Enforced by ts-jest at compile time.
6175
+ type IsAny<T> = 0 extends 1 & T ? true : false;
6176
+ type Extends<A, B> = A extends B ? true : false;
6177
+
6178
+ it('infers typed response for no-payload calls on the base trigger', () => {
6179
+ const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
6180
+
6181
+ const getTabs = () => searchEmbed.trigger(HostEvent.GetTabs);
6182
+ type TabsResponse = Awaited<ReturnType<typeof getTabs>>;
6183
+ const tabsIsTyped: IsAny<TabsResponse> = false;
6184
+ const tabsHasContractFields: Extends<
6185
+ TabsResponse,
6186
+ { numberOfTabs: number; orderedTabIds: string[] }
6187
+ > = true;
6188
+ const probeUnknownField = (r: TabsResponse) =>
6189
+ // @ts-expect-error — field not on the GetTabs contract (was silent when `any`)
6190
+ r.tabCount;
6191
+ void probeUnknownField;
6192
+
6193
+ const reload = () => searchEmbed.trigger(HostEvent.Reload);
6194
+ type ReloadResponse = Awaited<ReturnType<typeof reload>>;
6195
+ const reloadStaysAny: IsAny<ReloadResponse> = true;
6196
+
6197
+ expect([tabsIsTyped, tabsHasContractFields, reloadStaysAny])
6198
+ .toEqual([false, true, true]);
6199
+ });
6200
+ });
5505
6201
  });