@thoughtspot/visual-embed-sdk 1.36.2 → 1.36.4

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 (271) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/authToken.d.ts.map +1 -1
  3. package/cjs/src/authToken.js +10 -3
  4. package/cjs/src/authToken.js.map +1 -1
  5. package/cjs/src/embed/app.d.ts +14 -0
  6. package/cjs/src/embed/app.d.ts.map +1 -1
  7. package/cjs/src/embed/app.js +5 -2
  8. package/cjs/src/embed/app.js.map +1 -1
  9. package/cjs/src/embed/app.spec.js +17 -0
  10. package/cjs/src/embed/app.spec.js.map +1 -1
  11. package/cjs/src/embed/base.d.ts +4 -0
  12. package/cjs/src/embed/base.d.ts.map +1 -1
  13. package/cjs/src/embed/base.js +27 -1
  14. package/cjs/src/embed/base.js.map +1 -1
  15. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  16. package/cjs/src/embed/bodyless-conversation.js +1 -1
  17. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  18. package/cjs/src/embed/conversation.d.ts.map +1 -1
  19. package/cjs/src/embed/conversation.js +1 -1
  20. package/cjs/src/embed/conversation.js.map +1 -1
  21. package/cjs/src/embed/embedConfig.d.ts +1 -1
  22. package/cjs/src/embed/embedConfig.d.ts.map +1 -1
  23. package/cjs/src/embed/embedConfig.js +5 -4
  24. package/cjs/src/embed/embedConfig.js.map +1 -1
  25. package/cjs/src/embed/liveboard.d.ts +6 -3
  26. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  27. package/cjs/src/embed/liveboard.js +4 -5
  28. package/cjs/src/embed/liveboard.js.map +1 -1
  29. package/cjs/src/embed/liveboard.spec.js +11 -11
  30. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  31. package/cjs/src/embed/sage.d.ts.map +1 -1
  32. package/cjs/src/embed/sage.js +1 -1
  33. package/cjs/src/embed/sage.js.map +1 -1
  34. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  35. package/cjs/src/embed/search-bar.js +1 -1
  36. package/cjs/src/embed/search-bar.js.map +1 -1
  37. package/cjs/src/embed/search.d.ts.map +1 -1
  38. package/cjs/src/embed/search.js +1 -1
  39. package/cjs/src/embed/search.js.map +1 -1
  40. package/cjs/src/embed/ts-embed.d.ts +4 -3
  41. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  42. package/cjs/src/embed/ts-embed.js +25 -16
  43. package/cjs/src/embed/ts-embed.js.map +1 -1
  44. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  45. package/cjs/src/embed/ts-embed.spec.js +71 -5
  46. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  47. package/cjs/src/errors.d.ts +1 -0
  48. package/cjs/src/errors.d.ts.map +1 -1
  49. package/cjs/src/errors.js +1 -0
  50. package/cjs/src/errors.js.map +1 -1
  51. package/cjs/src/react/all-types-export.d.ts +1 -1
  52. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  53. package/cjs/src/react/all-types-export.js +2 -1
  54. package/cjs/src/react/all-types-export.js.map +1 -1
  55. package/cjs/src/react/index.d.ts +16 -0
  56. package/cjs/src/react/index.d.ts.map +1 -1
  57. package/cjs/src/react/index.js +25 -2
  58. package/cjs/src/react/index.js.map +1 -1
  59. package/cjs/src/types.d.ts +85 -66
  60. package/cjs/src/types.d.ts.map +1 -1
  61. package/cjs/src/types.js +78 -59
  62. package/cjs/src/types.js.map +1 -1
  63. package/cjs/src/utils/with-resolvers-polyfill.d.ts +1 -0
  64. package/cjs/src/utils/with-resolvers-polyfill.d.ts.map +1 -0
  65. package/cjs/src/utils/with-resolvers-polyfill.js +12 -0
  66. package/cjs/src/utils/with-resolvers-polyfill.js.map +1 -0
  67. package/cjs/src/utils.d.ts +27 -0
  68. package/cjs/src/utils.d.ts.map +1 -1
  69. package/cjs/src/utils.js +45 -1
  70. package/cjs/src/utils.js.map +1 -1
  71. package/cjs/src/utils.spec.js +15 -0
  72. package/cjs/src/utils.spec.js.map +1 -1
  73. package/dist/{index-B3hd6DTM.js → index-NZYq1Tu3.js} +1 -1
  74. package/dist/src/authToken.d.ts.map +1 -1
  75. package/dist/src/embed/app.d.ts +14 -0
  76. package/dist/src/embed/app.d.ts.map +1 -1
  77. package/dist/src/embed/base.d.ts +4 -0
  78. package/dist/src/embed/base.d.ts.map +1 -1
  79. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  80. package/dist/src/embed/conversation.d.ts.map +1 -1
  81. package/dist/src/embed/embedConfig.d.ts +1 -1
  82. package/dist/src/embed/embedConfig.d.ts.map +1 -1
  83. package/dist/src/embed/liveboard.d.ts +6 -3
  84. package/dist/src/embed/liveboard.d.ts.map +1 -1
  85. package/dist/src/embed/sage.d.ts.map +1 -1
  86. package/dist/src/embed/search-bar.d.ts.map +1 -1
  87. package/dist/src/embed/search.d.ts.map +1 -1
  88. package/dist/src/embed/ts-embed.d.ts +4 -3
  89. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  90. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  91. package/dist/src/errors.d.ts +1 -0
  92. package/dist/src/errors.d.ts.map +1 -1
  93. package/dist/src/react/all-types-export.d.ts +1 -1
  94. package/dist/src/react/all-types-export.d.ts.map +1 -1
  95. package/dist/src/react/index.d.ts +16 -0
  96. package/dist/src/react/index.d.ts.map +1 -1
  97. package/dist/src/types.d.ts +85 -66
  98. package/dist/src/types.d.ts.map +1 -1
  99. package/dist/src/utils/with-resolvers-polyfill.d.ts +1 -0
  100. package/dist/src/utils/with-resolvers-polyfill.d.ts.map +1 -0
  101. package/dist/src/utils.d.ts +27 -0
  102. package/dist/src/utils.d.ts.map +1 -1
  103. package/dist/tsembed-react.es.js +458 -108
  104. package/dist/tsembed-react.js +456 -105
  105. package/dist/tsembed.es.js +197 -98
  106. package/dist/tsembed.js +196 -97
  107. package/dist/visual-embed-sdk-react-full.d.ts +1324 -1269
  108. package/dist/visual-embed-sdk-react.d.ts +814 -759
  109. package/dist/visual-embed-sdk.d.ts +113 -72
  110. package/lib/package.json +1 -1
  111. package/lib/src/authToken.d.ts.map +1 -1
  112. package/lib/src/authToken.js +10 -3
  113. package/lib/src/authToken.js.map +1 -1
  114. package/lib/src/embed/app.d.ts +14 -0
  115. package/lib/src/embed/app.d.ts.map +1 -1
  116. package/lib/src/embed/app.js +5 -2
  117. package/lib/src/embed/app.js.map +1 -1
  118. package/lib/src/embed/app.spec.js +17 -0
  119. package/lib/src/embed/app.spec.js.map +1 -1
  120. package/lib/src/embed/base.d.ts +4 -0
  121. package/lib/src/embed/base.d.ts.map +1 -1
  122. package/lib/src/embed/base.js +24 -1
  123. package/lib/src/embed/base.js.map +1 -1
  124. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  125. package/lib/src/embed/bodyless-conversation.js +1 -1
  126. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  127. package/lib/src/embed/conversation.d.ts.map +1 -1
  128. package/lib/src/embed/conversation.js +1 -1
  129. package/lib/src/embed/conversation.js.map +1 -1
  130. package/lib/src/embed/embedConfig.d.ts +1 -1
  131. package/lib/src/embed/embedConfig.d.ts.map +1 -1
  132. package/lib/src/embed/embedConfig.js +5 -4
  133. package/lib/src/embed/embedConfig.js.map +1 -1
  134. package/lib/src/embed/liveboard.d.ts +6 -3
  135. package/lib/src/embed/liveboard.d.ts.map +1 -1
  136. package/lib/src/embed/liveboard.js +4 -5
  137. package/lib/src/embed/liveboard.js.map +1 -1
  138. package/lib/src/embed/liveboard.spec.js +11 -11
  139. package/lib/src/embed/liveboard.spec.js.map +1 -1
  140. package/lib/src/embed/sage.d.ts.map +1 -1
  141. package/lib/src/embed/sage.js +1 -1
  142. package/lib/src/embed/sage.js.map +1 -1
  143. package/lib/src/embed/search-bar.d.ts.map +1 -1
  144. package/lib/src/embed/search-bar.js +1 -1
  145. package/lib/src/embed/search-bar.js.map +1 -1
  146. package/lib/src/embed/search.d.ts.map +1 -1
  147. package/lib/src/embed/search.js +1 -1
  148. package/lib/src/embed/search.js.map +1 -1
  149. package/lib/src/embed/ts-embed.d.ts +4 -3
  150. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  151. package/lib/src/embed/ts-embed.js +26 -17
  152. package/lib/src/embed/ts-embed.js.map +1 -1
  153. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  154. package/lib/src/embed/ts-embed.spec.js +71 -5
  155. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  156. package/lib/src/errors.d.ts +1 -0
  157. package/lib/src/errors.d.ts.map +1 -1
  158. package/lib/src/errors.js +1 -0
  159. package/lib/src/errors.js.map +1 -1
  160. package/lib/src/react/all-types-export.d.ts +1 -1
  161. package/lib/src/react/all-types-export.d.ts.map +1 -1
  162. package/lib/src/react/all-types-export.js +1 -1
  163. package/lib/src/react/all-types-export.js.map +1 -1
  164. package/lib/src/react/index.d.ts +16 -0
  165. package/lib/src/react/index.d.ts.map +1 -1
  166. package/lib/src/react/index.js +23 -1
  167. package/lib/src/react/index.js.map +1 -1
  168. package/lib/src/types.d.ts +85 -66
  169. package/lib/src/types.d.ts.map +1 -1
  170. package/lib/src/types.js +78 -59
  171. package/lib/src/types.js.map +1 -1
  172. package/lib/src/utils/with-resolvers-polyfill.d.ts +1 -0
  173. package/lib/src/utils/with-resolvers-polyfill.d.ts.map +1 -0
  174. package/lib/src/utils/with-resolvers-polyfill.js +12 -0
  175. package/lib/src/utils/with-resolvers-polyfill.js.map +1 -0
  176. package/lib/src/utils.d.ts +27 -0
  177. package/lib/src/utils.d.ts.map +1 -1
  178. package/lib/src/utils.js +41 -0
  179. package/lib/src/utils.js.map +1 -1
  180. package/lib/src/utils.spec.js +16 -1
  181. package/lib/src/utils.spec.js.map +1 -1
  182. package/lib/src/visual-embed-sdk.d.ts +114 -73
  183. package/package.json +1 -1
  184. package/src/authToken.ts +11 -3
  185. package/src/embed/app.spec.ts +27 -0
  186. package/src/embed/app.ts +21 -1
  187. package/src/embed/base.ts +41 -1
  188. package/src/embed/bodyless-conversation.ts +2 -1
  189. package/src/embed/conversation.ts +2 -1
  190. package/src/embed/embedConfig.ts +5 -4
  191. package/src/embed/liveboard.spec.ts +11 -11
  192. package/src/embed/liveboard.ts +9 -7
  193. package/src/embed/sage.ts +1 -2
  194. package/src/embed/search-bar.tsx +1 -2
  195. package/src/embed/search.ts +1 -2
  196. package/src/embed/ts-embed.spec.ts +83 -5
  197. package/src/embed/ts-embed.ts +33 -17
  198. package/src/errors.ts +1 -0
  199. package/src/react/all-types-export.ts +1 -0
  200. package/src/react/index.tsx +27 -2
  201. package/src/types.ts +89 -70
  202. package/src/utils/with-resolvers-polyfill.ts +11 -0
  203. package/src/utils.spec.ts +21 -0
  204. package/src/utils.ts +52 -0
  205. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
  206. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
  207. package/cjs/src/embed/searchEmbed-basic-auth.spec.js +0 -104
  208. package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +0 -1
  209. package/cjs/src/hostEventsTypeMapping.d.ts +0 -2
  210. package/cjs/src/hostEventsTypeMapping.d.ts.map +0 -1
  211. package/cjs/src/hostEventsTypeMapping.js +0 -4
  212. package/cjs/src/hostEventsTypeMapping.js.map +0 -1
  213. package/cjs/src/utils/embedApi/contracts.d.ts +0 -101
  214. package/cjs/src/utils/embedApi/contracts.d.ts.map +0 -1
  215. package/cjs/src/utils/embedApi/contracts.js +0 -17
  216. package/cjs/src/utils/embedApi/contracts.js.map +0 -1
  217. package/cjs/src/utils/embedApi/embedApiClient.d.ts +0 -12
  218. package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
  219. package/cjs/src/utils/embedApi/embedApiClient.js +0 -46
  220. package/cjs/src/utils/embedApi/embedApiClient.js.map +0 -1
  221. package/cjs/src/utils/embedApi/processEmbedApi.d.ts +0 -9
  222. package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
  223. package/cjs/src/utils/embedApi/processEmbedApi.js +0 -18
  224. package/cjs/src/utils/embedApi/processEmbedApi.js.map +0 -1
  225. package/dist/index-BBBimG1x.js +0 -7370
  226. package/dist/index-BGnxP5NY.js +0 -7370
  227. package/dist/index-CENLvayL.js +0 -7370
  228. package/dist/index-CR5u7BMC.js +0 -7370
  229. package/dist/index-CbltIawo.js +0 -7370
  230. package/dist/index-CoQfqaHj.js +0 -7370
  231. package/dist/index-CzwzS0P4.js +0 -7370
  232. package/dist/index-D-9WUCUl.js +0 -7370
  233. package/dist/index-DFwi_pV_.js +0 -7370
  234. package/dist/index-DOIjN0N_.js +0 -7370
  235. package/dist/index-DYBx8SuE.js +0 -7370
  236. package/dist/index-DaLHJaLd.js +0 -7370
  237. package/dist/index-DnJX-gN2.js +0 -7370
  238. package/dist/index-DpuhnTj2.js +0 -7370
  239. package/dist/index-IDmSUe93.js +0 -7370
  240. package/dist/index-nWevLycs.js +0 -7370
  241. package/dist/index-vxW97_xb.js +0 -7370
  242. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
  243. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
  244. package/dist/src/hostEventsTypeMapping.d.ts +0 -2
  245. package/dist/src/hostEventsTypeMapping.d.ts.map +0 -1
  246. package/dist/src/utils/embedApi/contracts.d.ts +0 -101
  247. package/dist/src/utils/embedApi/contracts.d.ts.map +0 -1
  248. package/dist/src/utils/embedApi/embedApiClient.d.ts +0 -12
  249. package/dist/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
  250. package/dist/src/utils/embedApi/processEmbedApi.d.ts +0 -9
  251. package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
  252. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
  253. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
  254. package/lib/src/embed/searchEmbed-basic-auth.spec.js +0 -101
  255. package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +0 -1
  256. package/lib/src/hostEventsTypeMapping.d.ts +0 -2
  257. package/lib/src/hostEventsTypeMapping.d.ts.map +0 -1
  258. package/lib/src/hostEventsTypeMapping.js +0 -2
  259. package/lib/src/hostEventsTypeMapping.js.map +0 -1
  260. package/lib/src/utils/embedApi/contracts.d.ts +0 -101
  261. package/lib/src/utils/embedApi/contracts.d.ts.map +0 -1
  262. package/lib/src/utils/embedApi/contracts.js +0 -14
  263. package/lib/src/utils/embedApi/contracts.js.map +0 -1
  264. package/lib/src/utils/embedApi/embedApiClient.d.ts +0 -12
  265. package/lib/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
  266. package/lib/src/utils/embedApi/embedApiClient.js +0 -42
  267. package/lib/src/utils/embedApi/embedApiClient.js.map +0 -1
  268. package/lib/src/utils/embedApi/processEmbedApi.d.ts +0 -9
  269. package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
  270. package/lib/src/utils/embedApi/processEmbedApi.js +0 -14
  271. package/lib/src/utils/embedApi/processEmbedApi.js.map +0 -1
@@ -160,6 +160,20 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
160
160
  * ```
161
161
  */
162
162
  disableProfileAndHelp?: boolean;
163
+ /**
164
+ * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
165
+ * @default true
166
+ * Whether the help menu in the top nav bar should be served
167
+ * from Pendo or ThoughtSpot's internal help items.
168
+ * @example
169
+ * ```js
170
+ * const embed = new AppEmbed('#tsEmbed', {
171
+ * ... // other options
172
+ * enablePendoHelp: false,
173
+ * });
174
+ * ```
175
+ */
176
+ enablePendoHelp?: boolean;
163
177
  /**
164
178
  * Control the visibility of the application switcher button on the nav-bar.
165
179
  * By default, the application switcher is shown.
@@ -539,6 +553,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
539
553
  declare module '@thoughtspot/visual-embed-sdk/embed/base' {
540
554
  import { EmbedConfig, PrefetchFeatures } from '@thoughtspot/visual-embed-sdk/types';
541
555
  import { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, AuthEventEmitter } from '@thoughtspot/visual-embed-sdk/auth';
556
+ import '../utils/with-resolvers-polyfill';
542
557
  export interface executeTMLInput {
543
558
  metadata_tmls: string[];
544
559
  import_policy?: 'PARTIAL' | 'ALL_OR_NONE' | 'VALIDATE_ONLY';
@@ -573,6 +588,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
573
588
  export const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], additionalFlags?: {
574
589
  [key: string]: string | number | boolean;
575
590
  }) => void;
591
+ export const createAndSetInitPromise: () => void;
592
+ export const getInitPromise: () => Promise<ReturnType<typeof init>>;
593
+ export const getIsInitCalled: () => boolean;
576
594
  /**
577
595
  * Initializes the Visual Embed SDK globally and perform
578
596
  * authentication if applicable. This function needs to be called before any ThoughtSpot
@@ -688,7 +706,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
688
706
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
689
707
  */
690
708
  import { DOMSelector, HostEvent, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
691
- import { V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
709
+ import { TsEmbed, V1Embed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
692
710
  import { TriggerPayload, TriggerResponse } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
693
711
  /**
694
712
  * The configuration for the embedded Liveboard or visualization page view.
@@ -947,7 +965,10 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
947
965
  */
948
966
  showPreviewLoader?: boolean;
949
967
  /**
950
- * This flag is used to enable the compact header on a Liveboard
968
+ * Enables or disables the compact header feature on a Liveboard.
969
+ * Compact Liveboard header is turned off by default on Liveboards in
970
+ * ThoughtSpot Embedded apps.
971
+ *
951
972
  * @type {boolean}
952
973
  * @default false
953
974
  * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -1064,7 +1085,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
1064
1085
  */
1065
1086
  protected getEmbedParams(): string;
1066
1087
  protected beforePrerenderVisible(): void;
1067
- protected handleRenderForPrerender(): void;
1088
+ protected handleRenderForPrerender(): Promise<TsEmbed>;
1068
1089
  /**
1069
1090
  * Triggers an event to the embedded app
1070
1091
  * @param {HostEvent} messageType The event type
@@ -2164,9 +2185,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2164
2185
  export interface customCssInterface {
2165
2186
  /**
2166
2187
  * The custom css variables, which can be set.
2167
- * The allowed list is in the CustomCssVariables
2188
+ * The variables are available in the {@link CustomCssVariables}
2168
2189
  * interface. For more information, see
2169
- * link:https://developers.thoughtspot.com/docs/css-variables-reference
2190
+ * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
2170
2191
  */
2171
2192
  variables?: CustomCssVariables;
2172
2193
  /**
@@ -2693,7 +2714,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2693
2714
  */
2694
2715
  showAlerts?: boolean;
2695
2716
  /**
2696
- * The list of runtime filters to apply to a search answer,
2717
+ * The list of runtime filters to apply to a search Answer,
2697
2718
  * visualization, or Liveboard.
2698
2719
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2699
2720
  * @example
@@ -2712,7 +2733,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2712
2733
  */
2713
2734
  runtimeFilters?: RuntimeFilter[];
2714
2735
  /**
2715
- * The list of parameter override to apply to a search answer,
2736
+ * The list of parameter override to apply to a search Answer,
2716
2737
  * visualization, or Liveboard.
2717
2738
  * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2718
2739
  * @example
@@ -2730,7 +2751,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2730
2751
  */
2731
2752
  runtimeParameters?: RuntimeParameter[];
2732
2753
  /**
2733
- * The locale/language to use for the embedded view.
2754
+ * The locale settings to apply to the embedded view.
2734
2755
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2735
2756
  * @example
2736
2757
  * ```js
@@ -2797,7 +2818,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2797
2818
  */
2798
2819
  contextMenuTrigger?: ContextMenuTriggerOptions;
2799
2820
  /**
2800
- * Flag to override openNew tab context menu link
2821
+ * Flag to override the *Open Link in New Tab* context menu option.
2801
2822
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2802
2823
  * @example
2803
2824
  * ```js
@@ -2936,7 +2957,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2936
2957
  */
2937
2958
  preRenderId?: string;
2938
2959
  /**
2939
- * Determines whether the PreRender component should not dynamically track the size
2960
+ * Determines if the PreRender component should dynamically track the size
2940
2961
  * of its embedding element and adjust its own size accordingly.
2941
2962
  * Enabling this option allows the PreRender component to automatically adapt
2942
2963
  * its dimensions based on changes to the size of the embedding element.
@@ -3308,8 +3329,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3308
3329
  */
3309
3330
  Load = "load",
3310
3331
  /**
3311
- * Data pertaining to answer or Liveboard is received
3312
- * @return data - The answer or Liveboard data
3332
+ * Data pertaining to an Answer or Liveboard is received
3333
+ * @return data - The Answer or Liveboard data
3313
3334
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3314
3335
  * @example
3315
3336
  *```js
@@ -3483,7 +3504,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3483
3504
  */
3484
3505
  Alert = "alert",
3485
3506
  /**
3486
- * The ThoughtSpot auth session has expired.
3507
+ * The ThoughtSpot authentication session has expired.
3487
3508
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
3488
3509
  * @example
3489
3510
  *```js
@@ -3553,7 +3574,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3553
3574
  /**
3554
3575
  * Emitted when the embed does not have cookie access. This happens
3555
3576
  * when Safari and other Web browsers block third-party cookies
3556
- * are blocked by default. `NoCookieAccess` can trigger
3577
+ * are blocked by default. `NoCookieAccess` can trigger.
3557
3578
  * @example
3558
3579
  *```js
3559
3580
  * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -3641,7 +3662,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3641
3662
  */
3642
3663
  Save = "save",
3643
3664
  /**
3644
- * Emitted when the download action is triggered on an answer
3665
+ * Emitted when the download action is triggered on an Answer.
3645
3666
  *
3646
3667
  * **Note**: This event is deprecated in v1.21.0.
3647
3668
  * To fire an event when a download action is initiated on a chart or table,
@@ -3657,7 +3678,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3657
3678
  */
3658
3679
  Download = "download",
3659
3680
  /**
3660
- * Emitted when the download action is triggered on an answer
3681
+ * Emitted when the download action is triggered on an Answer.
3661
3682
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
3662
3683
  * @example
3663
3684
  *```js
@@ -3671,7 +3692,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3671
3692
  */
3672
3693
  DownloadAsPng = "downloadAsPng",
3673
3694
  /**
3674
- * Emitted when the Download as PDF action is triggered on an answer
3695
+ * Emitted when the Download as PDF action is triggered on an Answer
3675
3696
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3676
3697
  * @example
3677
3698
  *```js
@@ -3685,7 +3706,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3685
3706
  */
3686
3707
  DownloadAsPdf = "downloadAsPdf",
3687
3708
  /**
3688
- * Emitted when the Download as CSV action is triggered on an answer
3709
+ * Emitted when the Download as CSV action is triggered on an Answer.
3689
3710
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3690
3711
  * @example
3691
3712
  *```js
@@ -3699,7 +3720,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3699
3720
  */
3700
3721
  DownloadAsCsv = "downloadAsCsv",
3701
3722
  /**
3702
- * Emitted when the Download as XLSX action is triggered on an answer
3723
+ * Emitted when the Download as XLSX action is triggered on an Answer.
3703
3724
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3704
3725
  * @example
3705
3726
  *```js
@@ -3727,7 +3748,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3727
3748
  */
3728
3749
  AnswerDelete = "answerDelete",
3729
3750
  /**
3730
- * Emitted when an answer is pinned to a Liveboard
3751
+ * Emitted when a user initiates the Pin action to
3752
+ * add an Answer to a Liveboard.
3731
3753
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3732
3754
  * @example
3733
3755
  *```js
@@ -3865,7 +3887,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3865
3887
  */
3866
3888
  SaveAsView = "saveAsView",
3867
3889
  /**
3868
- * Emitted when the user creates a copy of an Answer
3890
+ * Emitted when the user creates a copy of an Answer.
3869
3891
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3870
3892
  * @example
3871
3893
  *```js
@@ -3879,7 +3901,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3879
3901
  */
3880
3902
  CopyAEdit = "copyAEdit",
3881
3903
  /**
3882
- * Emitted when a user clicks Show underlying data on an Answer
3904
+ * Emitted when a user clicks *Show underlying data* on an Answer.
3883
3905
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3884
3906
  * @example
3885
3907
  *```js
@@ -3890,7 +3912,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3890
3912
  */
3891
3913
  ShowUnderlyingData = "showUnderlyingData",
3892
3914
  /**
3893
- * Emitted when an answer is switched to a chart or table view.
3915
+ * Emitted when an Answer is switched to a chart or table view.
3894
3916
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3895
3917
  * @example
3896
3918
  *```js
@@ -4024,11 +4046,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4024
4046
  */
4025
4047
  CopyLink = "embedDocument",
4026
4048
  /**
4027
- * Emitted when a user interacts with cross filters on a visualization or Liveboard
4049
+ * Emitted when a user interacts with cross filters on a
4050
+ * visualization or Liveboard.
4028
4051
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
4029
4052
  * @example
4030
4053
  *```js
4031
- * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
4054
+ * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
4032
4055
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4033
4056
  *```
4034
4057
  */
@@ -4122,8 +4145,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4122
4145
  */
4123
4146
  DeletePersonalisedView = "deletePersonalisedView",
4124
4147
  /**
4125
- * Emitted when a user creates a new worksheet
4126
- * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
4148
+ * Emitted when a user creates a Worksheet.
4149
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
4127
4150
  */
4128
4151
  CreateWorksheet = "createWorksheet",
4129
4152
  /**
@@ -4136,8 +4159,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4136
4159
  */
4137
4160
  AskSageInit = "AskSageInit",
4138
4161
  /**
4139
- * Emitted when a LB/viz is renamed
4140
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
4162
+ * Emitted when a Liveboard or visualization is renamed.
4163
+ * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
4141
4164
  */
4142
4165
  Rename = "rename",
4143
4166
  /**
@@ -4201,8 +4224,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4201
4224
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
4202
4225
  /**
4203
4226
  * Emitted when parameter changes in an Answer
4204
- * or Liveboard
4205
- *
4227
+ * or Liveboard.
4206
4228
  * ```js
4207
4229
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
4208
4230
  * console.log('payload', payload);
@@ -4229,7 +4251,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4229
4251
  */
4230
4252
  TableVizRendered = "TableVizRendered",
4231
4253
  /**
4232
- * Emitted when the liveboard is created from pin modal or liveboard list page.
4254
+ * Emitted when the liveboard is created from pin modal or Liveboard list page.
4233
4255
  * You can use this event as a hook to trigger
4234
4256
  * other events on liveboard creation.
4235
4257
  *
@@ -4372,7 +4394,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4372
4394
  */
4373
4395
  Filter = "filter",
4374
4396
  /**
4375
- * Reload the answer or visualization
4397
+ * Reload the Answer or visualization
4376
4398
  * @hidden
4377
4399
  */
4378
4400
  Reload = "reload",
@@ -4422,12 +4444,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4422
4444
  * and `AppEmbed` only. In full application embedding, this event updates
4423
4445
  * the runtime filters applied on the Liveboard and saved Answer objects.
4424
4446
  *
4425
- *
4426
- * Pass an array of runtime filters with the following attributes:
4427
- *
4447
+ * @param - Pass an array of {@link RuntimeFilter} with the following attributes:
4428
4448
  * `columnName` - _String_. The name of the column to filter on.
4429
4449
  *
4430
- * `operator` - Runtime filter operator to apply. For more information,
4450
+ * `operator` - {@link RuntimeFilterOp} to apply. For more information,
4431
4451
  * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
4432
4452
  *
4433
4453
  * `values` - List of operands. Some operators such as EQ and LE allow a
@@ -4439,7 +4459,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4439
4459
  * will be cleared, restoring the original visualization
4440
4460
  * with the updated filters.
4441
4461
  *
4442
- * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
4462
+
4443
4463
  * @example
4444
4464
  * ```js
4445
4465
  * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
@@ -4678,6 +4698,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4678
4698
  * appEmbed.trigger(HostEvent.Remove)
4679
4699
  * ```
4680
4700
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4701
+ * * @example
4702
+ * ```js
4703
+ * liveboardEmbed.trigger(HostEvent.Remove)
4704
+ * ```
4705
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4681
4706
  */
4682
4707
  Remove = "delete",
4683
4708
  /**
@@ -5088,7 +5113,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5088
5113
  * ```js
5089
5114
  * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
5090
5115
  * console.log(
5091
- * tabDetails // TabDetails of current LB
5116
+ * tabDetails // TabDetails of current Liveboard
5092
5117
  * );
5093
5118
  * })
5094
5119
  * ```
@@ -5136,7 +5161,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5136
5161
  */
5137
5162
  UpdateSageQuery = "updateSageQuery",
5138
5163
  /**
5139
- * Get the answer session for a Search or
5164
+ * Get the Answer session for a Search or
5140
5165
  * Liveboard visualization.
5141
5166
  * @example
5142
5167
  * ```js
@@ -5311,6 +5336,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5311
5336
  HostAppUrl = "hostAppUrl",
5312
5337
  EnableVizTransformations = "enableVizTransform",
5313
5338
  EnableSearchAssist = "enableSearchAssist",
5339
+ EnablePendoHelp = "enablePendoHelp",
5314
5340
  HideResult = "hideResult",
5315
5341
  UseLastSelectedDataSource = "useLastSelectedSources",
5316
5342
  Tag = "tag",
@@ -5535,9 +5561,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5535
5561
  */
5536
5562
  AddDataPanelObjects = "addDataPanelObjects",
5537
5563
  /**
5538
- * Filter configuration options on a Liveboard page.
5539
- * Allows configuring filters on a
5540
- * Liveboard.
5564
+ * The filter configuration options for a Liveboard.
5565
+ * The configuration options are available when adding
5566
+ * filters on a Liveboard.
5567
+ *
5541
5568
  * @example
5542
5569
  * ```js
5543
5570
  * disabledActions: [Action.ConfigureFilter]
@@ -5635,14 +5662,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5635
5662
  * @hidden
5636
5663
  */
5637
5664
  SpotIQFollow = "spotIQFollow",
5665
+ /**
5666
+ * The Share action for a Liveboard visualization.
5667
+ */
5638
5668
  ShareViz = "shareViz",
5639
5669
  /**
5640
5670
  * @hidden
5641
5671
  */
5642
5672
  ReplaySearch = "replaySearch",
5643
5673
  /**
5644
- * The **Show underlying data** menu action on a visualization or
5645
- * Answer page.
5674
+ * The **Show underlying data** menu action on a
5675
+ * visualization or Answer page.
5646
5676
  * Displays detailed information and raw data
5647
5677
  * for a given visualization.
5648
5678
  * @example
@@ -5652,8 +5682,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5652
5682
  */
5653
5683
  ShowUnderlyingData = "showUnderlyingData",
5654
5684
  /**
5655
- * The **Download** menu action on Liveboard visualizations
5656
- * and Answers.
5685
+ * The **Download** menu action on Liveboard
5686
+ * visualizations and Answers.
5657
5687
  * Allows downloading a visualization or Answer.
5658
5688
  * @example
5659
5689
  * ```js
@@ -5674,11 +5704,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5674
5704
  /**
5675
5705
  *
5676
5706
  *The **Download PDF** action that downloads a Liveboard,
5677
- *visualization, or Answer as a PDF file.
5678
- *
5707
+ * visualization, or Answer as a PDF file.
5679
5708
  *
5680
- ***NOTE**: The **Download** > **PDF** action is available on
5681
- *visualizations and Answers if the data is in tabular format.
5709
+ * **NOTE**: The **Download** > **PDF** option is available for
5710
+ * tables in visualizations and Answers.
5682
5711
  * @example
5683
5712
  * ```js
5684
5713
  * disabledActions: [Action.DownloadAsPdf]
@@ -5710,9 +5739,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5710
5739
  */
5711
5740
  DownloadTrace = "downloadTrace",
5712
5741
  /**
5713
- * The **Export TML** menu action on Liveboard, Answers
5714
- * Worksheets and Data Connections page.
5715
- * Exports an object as a TML file.
5742
+ * The **Export TML** menu action on a Liveboard, Answer, and
5743
+ * the Data Workspace pages for data objects and connections.
5744
+ *
5745
+ * Allows exporting an object as a TML file.
5746
+ *
5716
5747
  * @example
5717
5748
  * ```js
5718
5749
  * disabledActions: [Action.ExportTML]
@@ -5720,7 +5751,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5720
5751
  */
5721
5752
  ExportTML = "exportTSL",
5722
5753
  /**
5723
- * The **Import TML** menu action for Liveboards and Answers.
5754
+ * The **Import TML** menu action on the
5755
+ * *Data Workspace* > *Utilities* page.
5724
5756
  * Imports TML representation of ThoughtSpot objects.
5725
5757
  * @example
5726
5758
  * ```js
@@ -5730,7 +5762,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5730
5762
  ImportTML = "importTSL",
5731
5763
  /**
5732
5764
  * The **Update TML** menu action for Liveboards and Answers.
5733
- * Update TML representation of ThoughtSpot objects.
5765
+ * Updates TML representation of ThoughtSpot objects.
5734
5766
  * @example
5735
5767
  * ```js
5736
5768
  * disabledActions: [Action.UpdateTML]
@@ -5757,8 +5789,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5757
5789
  */
5758
5790
  Present = "present",
5759
5791
  /**
5760
- * The tile resize options in the visualization menu.
5761
- * Allows switching between different preset layouts.
5792
+ * The visualization tile resize option.
5793
+ * Also available via More `...` options menu on a visualization.
5794
+ * Allows resizing visualization tiles and switching
5795
+ * between different preset layout option.
5796
+ *
5762
5797
  * @example
5763
5798
  * ```js
5764
5799
  * disabledActions: [Action.ToggleSize]
@@ -5784,8 +5819,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5784
5819
  */
5785
5820
  EditTitle = "editTitle",
5786
5821
  /**
5787
- * The **Delete** menu action on Liveboards and visualizations.
5788
- * Deletes a Liveboard or a visualization from a Liveboard.
5822
+ * The **Delete** action on a Liveboard, *Liveboards* and
5823
+ * *Answers* list pages in full application embedding.
5824
+ *
5789
5825
  * @example
5790
5826
  * ```js
5791
5827
  * disabledActions: [Action.Remove]
@@ -5862,8 +5898,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5862
5898
  */
5863
5899
  Explore = "explore",
5864
5900
  /**
5865
- * The action to include data points on a drilled-down Answer
5866
- * or visualization
5901
+ * The contextual menu action to include a specific data point
5902
+ * when drilling down a table or chart on an Answer.
5903
+ *
5867
5904
  * @example
5868
5905
  * ```js
5869
5906
  * disabledActions: [Action.DrillInclude]
@@ -5871,8 +5908,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5871
5908
  */
5872
5909
  DrillInclude = "context-menu-item-include",
5873
5910
  /**
5874
- * The action to exclude data points on a drilled-down Answer
5875
- * or visualization
5911
+ * The contextual menu action to exclude a specific data point
5912
+ * when drilling down a table or chart on an Answer.
5876
5913
  * @example
5877
5914
  * ```js
5878
5915
  * disabledActions: [Action.DrillInclude]
@@ -6019,7 +6056,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6019
6056
  * Allows users to manage data sync pipelines to third-party apps.
6020
6057
  * @example
6021
6058
  * ```js
6022
- * disabledActions: [Action.SyncToOtherApps]
6059
+ * disabledActions: [Action.ManagePipelines]
6023
6060
  * ```
6024
6061
  * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
6025
6062
  */
@@ -6338,7 +6375,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6338
6375
  /**
6339
6376
  * Action ID for the Parent TML action
6340
6377
  * The parent action **TML** must be included to access TML-related options
6341
- * within the cascading menu (specific to the answer page)
6378
+ * within the cascading menu (specific to the Answer page)
6342
6379
  * @example
6343
6380
  * ```js
6344
6381
  * // to include specific TML actions
@@ -6377,8 +6414,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6377
6414
  */
6378
6415
  VerifiedLiveboard = "verifiedLiveboard",
6379
6416
  /**
6380
- * The *Ask Sage* action for Answers and visualizations.
6381
- * Allows initiating a Natural Language Search query.
6417
+ * Action ID for the *Ask Sage* In Natural Language Search embed,
6418
+ * *Spotter* in Liveboard, full app, and Spotter embed.
6419
+ *
6420
+ * Allows initiating a conversation with ThoughtSpot AI analyst.
6382
6421
  *
6383
6422
  * @example
6384
6423
  * ```js
@@ -6574,7 +6613,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
6574
6613
  */
6575
6614
  DeletePreviousPrompt = "deletePreviousPrompt",
6576
6615
  /**
6577
- * Action ID for hide/disable edit of tokens on spotter results.
6616
+ * Action ID for hide or disable editing tokens generated from
6617
+ * Spotter results.
6578
6618
  * @example
6579
6619
  * ```js
6580
6620
  * hiddenAction: [Action.EditTokens]
@@ -7475,7 +7515,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/embedConfig' {
7475
7515
  * @version SDK: 1.27.0 | ThoughtSpot: *
7476
7516
  * @group Global methods
7477
7517
  */
7478
- export const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
7518
+ export const setEmbedConfig: (newConfig: EmbedConfig) => any;
7479
7519
  }
7480
7520
 
7481
7521
  declare module '@thoughtspot/visual-embed-sdk/mixpanel-service' {
@@ -7731,6 +7771,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
7731
7771
  */
7732
7772
  protected isRendered: boolean;
7733
7773
  protected hostEventClient: HostEventClient;
7774
+ protected isReadyForRenderPromise: Promise<void>;
7734
7775
  constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
7735
7776
  /**
7736
7777
  * Handles errors within the SDK
@@ -7874,12 +7915,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
7874
7915
  */
7875
7916
  render(): Promise<TsEmbed>;
7876
7917
  getIframeSrc(): string;
7877
- protected handleRenderForPrerender(): void;
7918
+ protected handleRenderForPrerender(): Promise<TsEmbed>;
7878
7919
  /**
7879
7920
  * Creates the preRender shell
7880
7921
  * @param showPreRenderByDefault - Show the preRender after render, hidden by default
7881
7922
  */
7882
- preRender(showPreRenderByDefault?: boolean): TsEmbed;
7923
+ preRender(showPreRenderByDefault?: boolean): Promise<TsEmbed>;
7883
7924
  /**
7884
7925
  * Get the Post Url Params for THOUGHTSPOT from the current
7885
7926
  * host app URL.
@@ -7910,7 +7951,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
7910
7951
  * Also, synchronizes the style of the PreRender component with the embedding
7911
7952
  * element.
7912
7953
  */
7913
- showPreRender(): void;
7954
+ showPreRender(): Promise<TsEmbed>;
7914
7955
  /**
7915
7956
  * Synchronizes the style properties of the PreRender component with the embedding
7916
7957
  * element. This function adjusts the position, width, and height of the PreRender
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.36.2",
3
+ "version": "1.36.4",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
package/src/authToken.ts CHANGED
@@ -1,9 +1,15 @@
1
1
  import { ERROR_MESSAGE } from './errors';
2
2
  import { EmbedConfig } from './types';
3
+ import { getValueFromWindow, storeValueInWindow } from './utils';
3
4
  import { fetchAuthTokenService, verifyTokenService } from './utils/authService/authService';
4
5
  import { logger } from './utils/logger';
5
6
 
6
- let cachedAuthToken: string | null = null;
7
+ const cacheAuthTokenKey = 'cachedAuthToken';
8
+
9
+ const getCacheAuthToken = (): string | null => getValueFromWindow(cacheAuthTokenKey);
10
+ const storeAuthTokenInCache = (token: string): void => {
11
+ storeValueInWindow(cacheAuthTokenKey, token);
12
+ };
7
13
 
8
14
  // This method can be used to get the authToken using the embedConfig
9
15
  /**
@@ -11,6 +17,7 @@ let cachedAuthToken: string | null = null;
11
17
  * @param embedConfig
12
18
  */
13
19
  export async function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string> {
20
+ const cachedAuthToken = getCacheAuthToken();
14
21
  // Since we don't have token validation enabled , we cannot tell if the
15
22
  // cached token is valid or not. So we will always fetch a new token.
16
23
  if (cachedAuthToken && !embedConfig.disableTokenVerification) {
@@ -42,7 +49,7 @@ export async function getAuthenticationToken(embedConfig: EmbedConfig): Promise<
42
49
  throw e;
43
50
  }
44
51
 
45
- cachedAuthToken = authToken;
52
+ storeAuthTokenInCache(authToken);
46
53
  return authToken;
47
54
  }
48
55
 
@@ -51,6 +58,7 @@ const validateAuthToken = async (
51
58
  authToken: string,
52
59
  suppressAlert?: boolean,
53
60
  ): Promise<boolean> => {
61
+ const cachedAuthToken = getCacheAuthToken();
54
62
  if (embedConfig.disableTokenVerification) {
55
63
  logger.info('Token verification is disabled. Assuming token is valid.');
56
64
  return true;
@@ -83,5 +91,5 @@ const validateAuthToken = async (
83
91
  * @group Authentication / Init
84
92
  */
85
93
  export const resetCachedAuthToken = (): void => {
86
- cachedAuthToken = null;
94
+ storeAuthTokenInCache(null);
87
95
  };
@@ -509,6 +509,33 @@ describe('App embed tests', () => {
509
509
  });
510
510
  });
511
511
 
512
+ test('Should add enablePendoHelp flag to the iframe src conditional on navbar', async () => {
513
+ const appEmbed = new AppEmbed(getRootEl(), {
514
+ ...defaultViewConfig,
515
+ } as AppViewConfig);
516
+
517
+ appEmbed.render();
518
+ await executeAfterWait(() => {
519
+ expectUrlMatchesWithParams(
520
+ getIFrameSrc(),
521
+ `http://${thoughtSpotHost}/?enablePendoHelp=true&embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`,
522
+ );
523
+ });
524
+
525
+ const noNavEmbed = new AppEmbed(getRootEl(), {
526
+ ...defaultViewConfig,
527
+ enablePendoHelp: false,
528
+ } as AppViewConfig);
529
+
530
+ noNavEmbed.render();
531
+ await executeAfterWait(() => {
532
+ expectUrlMatchesWithParams(
533
+ getIFrameSrc(),
534
+ `http://${thoughtSpotHost}/?enablePendoHelp=false&embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false${defaultParams}${defaultParamsPost}#/home`,
535
+ );
536
+ });
537
+ });
538
+
512
539
  test('Should add HomePageSearchBarMode flag with object search to the iframe src', async () => {
513
540
  const appEmbed = new AppEmbed(getRootEl(), {
514
541
  ...defaultViewConfig,