@thoughtspot/visual-embed-sdk 1.40.1-alpha.2 → 1.40.1

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 (155) hide show
  1. package/cjs/package.json +7 -6
  2. package/cjs/src/css-variables.d.ts +316 -0
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +6 -1
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +22 -0
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +39 -2
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/bodyless-conversation.d.ts +0 -1
  11. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  12. package/cjs/src/embed/bodyless-conversation.js +3 -7
  13. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  14. package/cjs/src/embed/conversation.d.ts +63 -3
  15. package/cjs/src/embed/conversation.d.ts.map +1 -1
  16. package/cjs/src/embed/conversation.js +11 -8
  17. package/cjs/src/embed/conversation.js.map +1 -1
  18. package/cjs/src/embed/conversation.spec.js +102 -0
  19. package/cjs/src/embed/conversation.spec.js.map +1 -1
  20. package/cjs/src/embed/liveboard.d.ts +11 -3
  21. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  22. package/cjs/src/embed/liveboard.js +23 -33
  23. package/cjs/src/embed/liveboard.js.map +1 -1
  24. package/cjs/src/embed/liveboard.spec.js +182 -29
  25. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  26. package/cjs/src/embed/sage.d.ts +0 -1
  27. package/cjs/src/embed/sage.d.ts.map +1 -1
  28. package/cjs/src/embed/sage.js +6 -10
  29. package/cjs/src/embed/sage.js.map +1 -1
  30. package/cjs/src/embed/search-bar.d.ts +0 -1
  31. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  32. package/cjs/src/embed/search-bar.js +7 -11
  33. package/cjs/src/embed/search-bar.js.map +1 -1
  34. package/cjs/src/embed/search.d.ts +0 -1
  35. package/cjs/src/embed/search.d.ts.map +1 -1
  36. package/cjs/src/embed/search.js +8 -7
  37. package/cjs/src/embed/search.js.map +1 -1
  38. package/cjs/src/embed/ts-embed.d.ts +22 -9
  39. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  40. package/cjs/src/embed/ts-embed.js +75 -59
  41. package/cjs/src/embed/ts-embed.js.map +1 -1
  42. package/cjs/src/embed/ts-embed.spec.js +173 -1
  43. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  44. package/cjs/src/types.d.ts +154 -54
  45. package/cjs/src/types.d.ts.map +1 -1
  46. package/cjs/src/types.js +140 -52
  47. package/cjs/src/types.js.map +1 -1
  48. package/cjs/src/utils/liveboardService/liveboardService.d.ts +21 -6
  49. package/cjs/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  50. package/cjs/src/utils/liveboardService/liveboardService.js +21 -6
  51. package/cjs/src/utils/liveboardService/liveboardService.js.map +1 -1
  52. package/dist/{index-CmEQfuE3.js → index-P5YjBOuJ.js} +1 -1
  53. package/dist/src/css-variables.d.ts +316 -0
  54. package/dist/src/css-variables.d.ts.map +1 -1
  55. package/dist/src/embed/app.d.ts +6 -1
  56. package/dist/src/embed/app.d.ts.map +1 -1
  57. package/dist/src/embed/bodyless-conversation.d.ts +0 -1
  58. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  59. package/dist/src/embed/conversation.d.ts +63 -3
  60. package/dist/src/embed/conversation.d.ts.map +1 -1
  61. package/dist/src/embed/liveboard.d.ts +11 -3
  62. package/dist/src/embed/liveboard.d.ts.map +1 -1
  63. package/dist/src/embed/sage.d.ts +0 -1
  64. package/dist/src/embed/sage.d.ts.map +1 -1
  65. package/dist/src/embed/search-bar.d.ts +0 -1
  66. package/dist/src/embed/search-bar.d.ts.map +1 -1
  67. package/dist/src/embed/search.d.ts +0 -1
  68. package/dist/src/embed/search.d.ts.map +1 -1
  69. package/dist/src/embed/ts-embed.d.ts +22 -9
  70. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  71. package/dist/src/types.d.ts +154 -54
  72. package/dist/src/types.d.ts.map +1 -1
  73. package/dist/src/utils/liveboardService/liveboardService.d.ts +21 -6
  74. package/dist/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  75. package/dist/tsembed-react.es.js +298 -190
  76. package/dist/tsembed-react.js +297 -189
  77. package/dist/tsembed.es.js +319 -196
  78. package/dist/tsembed.js +318 -195
  79. package/dist/visual-embed-sdk-react-full.d.ts +583 -76
  80. package/dist/visual-embed-sdk-react.d.ts +583 -76
  81. package/dist/visual-embed-sdk.d.ts +583 -76
  82. package/lib/package.json +7 -6
  83. package/lib/src/css-variables.d.ts +316 -0
  84. package/lib/src/css-variables.d.ts.map +1 -1
  85. package/lib/src/embed/app.d.ts +6 -1
  86. package/lib/src/embed/app.d.ts.map +1 -1
  87. package/lib/src/embed/app.js +22 -0
  88. package/lib/src/embed/app.js.map +1 -1
  89. package/lib/src/embed/app.spec.js +39 -2
  90. package/lib/src/embed/app.spec.js.map +1 -1
  91. package/lib/src/embed/bodyless-conversation.d.ts +0 -1
  92. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  93. package/lib/src/embed/bodyless-conversation.js +3 -7
  94. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  95. package/lib/src/embed/conversation.d.ts +63 -3
  96. package/lib/src/embed/conversation.d.ts.map +1 -1
  97. package/lib/src/embed/conversation.js +12 -9
  98. package/lib/src/embed/conversation.js.map +1 -1
  99. package/lib/src/embed/conversation.spec.js +104 -2
  100. package/lib/src/embed/conversation.spec.js.map +1 -1
  101. package/lib/src/embed/liveboard.d.ts +11 -3
  102. package/lib/src/embed/liveboard.d.ts.map +1 -1
  103. package/lib/src/embed/liveboard.js +23 -33
  104. package/lib/src/embed/liveboard.js.map +1 -1
  105. package/lib/src/embed/liveboard.spec.js +182 -29
  106. package/lib/src/embed/liveboard.spec.js.map +1 -1
  107. package/lib/src/embed/sage.d.ts +0 -1
  108. package/lib/src/embed/sage.d.ts.map +1 -1
  109. package/lib/src/embed/sage.js +6 -10
  110. package/lib/src/embed/sage.js.map +1 -1
  111. package/lib/src/embed/search-bar.d.ts +0 -1
  112. package/lib/src/embed/search-bar.d.ts.map +1 -1
  113. package/lib/src/embed/search-bar.js +7 -11
  114. package/lib/src/embed/search-bar.js.map +1 -1
  115. package/lib/src/embed/search.d.ts +0 -1
  116. package/lib/src/embed/search.d.ts.map +1 -1
  117. package/lib/src/embed/search.js +8 -7
  118. package/lib/src/embed/search.js.map +1 -1
  119. package/lib/src/embed/ts-embed.d.ts +22 -9
  120. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  121. package/lib/src/embed/ts-embed.js +75 -59
  122. package/lib/src/embed/ts-embed.js.map +1 -1
  123. package/lib/src/embed/ts-embed.spec.js +173 -1
  124. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  125. package/lib/src/types.d.ts +154 -54
  126. package/lib/src/types.d.ts.map +1 -1
  127. package/lib/src/types.js +140 -52
  128. package/lib/src/types.js.map +1 -1
  129. package/lib/src/utils/liveboardService/liveboardService.d.ts +21 -6
  130. package/lib/src/utils/liveboardService/liveboardService.d.ts.map +1 -1
  131. package/lib/src/utils/liveboardService/liveboardService.js +21 -6
  132. package/lib/src/utils/liveboardService/liveboardService.js.map +1 -1
  133. package/lib/src/visual-embed-sdk.d.ts +584 -77
  134. package/package.json +7 -6
  135. package/src/css-variables.ts +396 -1
  136. package/src/embed/app.spec.ts +54 -2
  137. package/src/embed/app.ts +24 -0
  138. package/src/embed/bodyless-conversation.ts +3 -9
  139. package/src/embed/conversation.spec.ts +131 -5
  140. package/src/embed/conversation.ts +87 -23
  141. package/src/embed/liveboard.spec.ts +233 -32
  142. package/src/embed/liveboard.ts +24 -39
  143. package/src/embed/sage.ts +6 -11
  144. package/src/embed/search-bar.tsx +7 -14
  145. package/src/embed/search.ts +7 -18
  146. package/src/embed/ts-embed.spec.ts +344 -112
  147. package/src/embed/ts-embed.ts +82 -70
  148. package/src/types.ts +153 -54
  149. package/src/utils/liveboardService/liveboardService.ts +21 -6
  150. package/dist/index-D1pyb7RG.js +0 -7371
  151. package/dist/index-DeFzsyFF.js +0 -7371
  152. package/dist/index-Dpf0rd6w.js +0 -7371
  153. package/dist/index-UuEbsISo.js +0 -7447
  154. package/dist/index-e3Uw3YFO.js +0 -7371
  155. package/dist/index-k7pkZMhx.js +0 -7371
@@ -89,7 +89,6 @@ export declare class TsEmbed {
89
89
  * Handler for fullscreen change events
90
90
  */
91
91
  private fullscreenChangeHandler;
92
- id: string;
93
92
  constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
94
93
  /**
95
94
  * Throws error encountered during initialization.
@@ -131,7 +130,6 @@ export declare class TsEmbed {
131
130
  */
132
131
  private formatEventData;
133
132
  private subscribedListeners;
134
- isEmbedContainerLoaded: boolean;
135
133
  /**
136
134
  * Adds a global event listener to window for "message" events.
137
135
  * ThoughtSpot detects if a particular event is targeted to this
@@ -161,11 +159,6 @@ export declare class TsEmbed {
161
159
  * @param responder
162
160
  */
163
161
  private idleSessionTimeout;
164
- private pendingEvents;
165
- protected getPreRenderObj<T extends TsEmbed>(): T;
166
- private checkEmbedContainerLoaded;
167
- private executePendingEvents;
168
- protected triggerAfterLoad(eventType: HostEvent, data: TriggerPayload<any, HostEvent>, onEventTriggered?: () => void): void;
169
162
  /**
170
163
  * Register APP_INIT event and sendback init payload
171
164
  */
@@ -175,7 +168,6 @@ export declare class TsEmbed {
175
168
  * @param query
176
169
  */
177
170
  protected getEmbedBasePath(query: string): string;
178
- protected getUpdateEmbedParamsObject(): Record<any, any>;
179
171
  /**
180
172
  * Common query params set for all the embed modes.
181
173
  * @param queryParams
@@ -191,7 +183,6 @@ export declare class TsEmbed {
191
183
  */
192
184
  protected getV1EmbedBasePath(queryString: string): string;
193
185
  protected getEmbedParams(): string;
194
- protected getEmbedParamsObject(): Record<any, any>;
195
186
  protected getRootIframeSrc(): string;
196
187
  protected createIframeEl(frameSrc: string): HTMLIFrameElement;
197
188
  protected handleInsertionIntoDOM(child: string | Node): void;
@@ -293,6 +284,28 @@ export declare class TsEmbed {
293
284
  * @param payload
294
285
  */
295
286
  private triggerEventOnPort;
287
+ /**
288
+ * @hidden
289
+ * Internal state to track if the embed container is loaded.
290
+ * This is used to trigger events after the embed container is loaded.
291
+ */
292
+ isEmbedContainerLoaded: boolean;
293
+ /**
294
+ * @hidden
295
+ * Internal state to track the callbacks to be executed after the embed container
296
+ * is loaded.
297
+ * This is used to trigger events after the embed container is loaded.
298
+ */
299
+ private embedContainerReadyCallbacks;
300
+ protected getPreRenderObj<T extends TsEmbed>(): T;
301
+ private checkEmbedContainerLoaded;
302
+ private executeEmbedContainerReadyCallbacks;
303
+ /**
304
+ * Executes a callback after the embed container is loaded.
305
+ * @param callback The callback to execute
306
+ */
307
+ protected executeAfterEmbedContainerLoaded(callback: () => void): void;
308
+ protected createEmbedContainerHandler: (source: EmbedEvent.AuthInit | EmbedEvent.EmbedListenerReady) => () => void;
296
309
  /**
297
310
  * Triggers an event to the embedded app
298
311
  * @param {HostEvent} messageType The event type
@@ -1 +1 @@
1
- {"version":3,"file":"ts-embed.d.ts","sourceRoot":"","sources":["ts-embed.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH,OAAO,EACH,cAAc,EACd,eAAe,EACf,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACvB,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAwB7E,OAAO,EAEH,WAAW,EACX,SAAS,EACT,UAAU,EACV,eAAe,EAGf,WAAW,EACX,cAAc,EAGd,kBAAkB,EAClB,kBAAkB,IAAI,UAAU,EACnC,MAAM,UAAU,CAAC;AAalB,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAItE;;GAEG;AACH,eAAO,MAAM,wBAAwB,QAAQ,CAAC;AAW9C;;;;GAIG;AACH,qBAAa,OAAO;IAChB;;;;;OAKG;IACH,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,YAAY,SAAe;IAErC,SAAS,CAAC,gBAAgB,UAAS;IAEnC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEpC;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAK3D,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAE3G,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAKlC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAAoC;IAE3D;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,OAAO,CAAU;IAEzB;;OAEG;IACH,OAAO,CAAC,aAAa,CAAU;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B,CAAS;IAE3C,OAAO,CAAC,oBAAoB,CAAwB;IAEpD,OAAO,CAAC,cAAc,CAAiB;IAEvC,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAE3C,SAAS,CAAC,uBAAuB,gBAAC;IAElC;;OAEG;IACH,OAAO,CAAC,uBAAuB,CAA6B;IAErD,EAAE,EAAE,MAAM,CAAC;gBAEN,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,UAAU;IA6B7D;;OAEG;IACH,OAAO,CAAC,cAAc;IAItB;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAS7D;;;OAGG;IACH,OAAO,CAAC,YAAY;IAKpB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAOpB;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAiB7B;;;OAGG;IACH,OAAO,CAAC,sCAAsC;IAW9C;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,mBAAmB,CAA2B;IAE/C,sBAAsB,UAAS;IAEtC;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IA0CzB,OAAO,CAAC,mBAAmB;cAMX,6BAA6B;cAc7B,qBAAqB,IAAI,OAAO,CAAC,kBAAkB,CAAC;cAuBpD,cAAc;IAI9B;;;;OAIG;IACH,OAAO,CAAC,SAAS,CAWf;IAEF;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAqBrB;IAEF;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAiBxB;IAEF,OAAO,CAAC,aAAa,CAA4G;IAEjI,SAAS,CAAC,eAAe,CAAC,CAAC,SAAS,OAAO,KAAK,CAAC;IAQjD,OAAO,CAAC,yBAAyB;IAWjC,OAAO,CAAC,oBAAoB;IAU5B,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,CAAC,GAAG,EAAE,SAAS,CAAC,EAAE,gBAAgB,CAAC,EAAE,MAAM,IAAI;IASpH;;OAEG;IACH,OAAO,CAAC,eAAe,CAQrB;IAEF;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAcjD,SAAS,CAAC,0BAA0B;IAMpC;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,CAAC,WAAW,GAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAM;IAgK/D;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IASzD,SAAS,CAAC,cAAc;IAKxB,SAAS,CAAC,oBAAoB;IAK9B,SAAS,CAAC,gBAAgB;IAK1B,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB;IAqC7D,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAW5D;;;;OAIG;cACa,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAiFvD,SAAS,CAAC,sBAAsB,IAAI,cAAc;IAiBlD,SAAS,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAExC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC;IAEtC,SAAS,CAAC,kBAAkB,IAAI,OAAO;IAmBvC,SAAS,CAAC,oBAAoB,IAAI,OAAO;IAQzC,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,WAAW;IAuBjE,SAAS,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAsB/D,OAAO,CAAC,sBAAsB,CAAS;IAEvC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAwBnD;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAIxD;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CACtB,SAAS,EAAE,UAAU,EACrB,IAAI,EAAE,GAAG,EACT,SAAS,CAAC,EAAE,WAAW,GAAG,IAAI,GAC/B,IAAI;IAqBP;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,MAAM;IAItC;;;;;OAKG;IACH,SAAS,CAAC,sBAAsB,CAAC,SAAS,EAAE,UAAU,GAAG,UAAU;IAInE;;;;;;;OAOG;IACH,SAAS,CAAC,eAAe;;;;;;;IA2BzB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,EAAE,CACL,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,EAC1C,iBAAiB,UAAQ,GAC1B,OAAO,OAAO,CAAC,SAAS;IAe3B;;;;;;;;;;OAUG;IACI,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,eAAe,GAAG,OAAO,OAAO,CAAC,SAAS;IASxF;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;;;;OAKG;IACU,OAAO,CAAC,UAAU,SAAS,SAAS,EAAE,QAAQ,EACvD,WAAW,EAAE,UAAU,EACvB,IAAI,GAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAa,GACvD,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAgBjD;;;;;;OAMG;IACU,oBAAoB,CAAC,mBAAmB,SAAS,kBAAkB,EAC5E,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAC;IAK3D;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAUhC,YAAY,IAAI,MAAM;IAI7B,SAAS,CAAC,wBAAwB;IAIlC;;;OAGG;IACU,SAAS,CAAC,sBAAsB,UAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAUxE;;;;;OAKG;IACI,2BAA2B,CAC9B,gBAAgB,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAO,GAC1D,MAAM;IAwBT;;;OAGG;IACI,OAAO,IAAI,IAAI;IAUf,yBAAyB,IAAI,iBAAiB;IAIrD;;;;;;OAMG;IACU,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAW7C,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAIxC,OAAO,CAAC,2BAA2B,CAyBjC;IAEF;;;;;OAKG;IACU,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAgD9C;;;;;;;OAOG;IACI,kBAAkB,IAAI,IAAI;IAejC;;;OAGG;IACI,aAAa,IAAI,IAAI;IAqB5B;;;;;;OAMG;IACI,eAAe;;;;IAOtB;;;;;OAKG;IACU,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAKrE;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IA6BpC;;OAEG;IACH,OAAO,CAAC,6BAA6B;CAMxC;AAED;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,OAAO;IAChC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;gBAErB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU;IAK5D;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,SAAS,CAAC,gBAAgB,IAAI,MAAM;IAqBpC;;;;;;;;;;;;;;;;OAgBG;IACI,EAAE,CACL,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,GAC3C,OAAO,OAAO,CAAC,SAAS;IAK3B;;;OAGG;IAEI,sBAAsB,6EAAyB;CACzD"}
1
+ {"version":3,"file":"ts-embed.d.ts","sourceRoot":"","sources":["ts-embed.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH,OAAO,EACH,cAAc,EACd,eAAe,EACf,0BAA0B,EAC1B,kBAAkB,EAClB,oBAAoB,EACvB,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAwB7E,OAAO,EAEH,WAAW,EACX,SAAS,EACT,UAAU,EACV,eAAe,EAGf,WAAW,EACX,cAAc,EAGd,kBAAkB,EAClB,kBAAkB,IAAI,UAAU,EACnC,MAAM,UAAU,CAAC;AAalB,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAItE;;GAEG;AACH,eAAO,MAAM,wBAAwB,QAAQ,CAAC;AAW9C;;;;GAIG;AACH,qBAAa,OAAO;IAChB;;;;;OAKG;IACH,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC;IAE9B;;OAEG;IACH,SAAS,CAAC,EAAE,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,YAAY,SAAe;IAErC,SAAS,CAAC,gBAAgB,UAAS;IAEnC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEpC;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAK3D,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG;QAAE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAE3G,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,CAAC;IAKlC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC;IAEpC;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAAoC;IAE3D;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,OAAO,CAAU;IAEzB;;OAEG;IACH,OAAO,CAAC,aAAa,CAAU;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,0BAA0B,CAAS;IAE3C,OAAO,CAAC,oBAAoB,CAAwB;IAEpD,OAAO,CAAC,cAAc,CAAiB;IAEvC,SAAS,CAAC,eAAe,EAAE,eAAe,CAAC;IAE3C,SAAS,CAAC,uBAAuB,gBAAC;IAElC;;OAEG;IACH,OAAO,CAAC,uBAAuB,CAA6B;gBAEhD,WAAW,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,UAAU;IA2B7D;;OAEG;IACH,OAAO,CAAC,cAAc;IAItB;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAS7D;;;OAGG;IACH,OAAO,CAAC,YAAY;IAKpB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAOpB;;;;OAIG;IACH,OAAO,CAAC,qBAAqB;IAiB7B;;;OAGG;IACH,OAAO,CAAC,sCAAsC;IAW9C;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,mBAAmB,CAA2B;IAEtD;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IA0CzB,OAAO,CAAC,mBAAmB;cAMX,6BAA6B;cAc7B,qBAAqB,IAAI,OAAO,CAAC,kBAAkB,CAAC;cAuBpD,cAAc;IAI9B;;;;OAIG;IACH,OAAO,CAAC,SAAS,CAWf;IAEF;;;;OAIG;IACH,OAAO,CAAC,eAAe,CAqBrB;IAEF;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAiBxB;IAEF;;OAEG;IACH,OAAO,CAAC,eAAe,CAUrB;IAEF;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAcjD;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,CAAC,WAAW,GAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAM;IAgK/D;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IASzD,SAAS,CAAC,cAAc;IAKxB,SAAS,CAAC,gBAAgB;IAK1B,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB;IAqC7D,SAAS,CAAC,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAW5D;;;;OAIG;cACa,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAiFvD,SAAS,CAAC,sBAAsB,IAAI,cAAc;IAiBlD,SAAS,CAAC,gBAAgB,EAAE,WAAW,CAAC;IAExC,SAAS,CAAC,cAAc,EAAE,WAAW,CAAC;IAEtC,SAAS,CAAC,kBAAkB,IAAI,OAAO;IAmBvC,SAAS,CAAC,oBAAoB,IAAI,OAAO;IAQzC,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,WAAW;IAuBjE,SAAS,CAAC,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAsB/D,OAAO,CAAC,sBAAsB,CAAS;IAEvC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAwBnD;;;OAGG;IACH,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAIxD;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CACtB,SAAS,EAAE,UAAU,EACrB,IAAI,EAAE,GAAG,EACT,SAAS,CAAC,EAAE,WAAW,GAAG,IAAI,GAC/B,IAAI;IAqBP;;OAEG;IACH,SAAS,CAAC,kBAAkB,IAAI,MAAM;IAItC;;;;;OAKG;IACH,SAAS,CAAC,sBAAsB,CAAC,SAAS,EAAE,UAAU,GAAG,UAAU;IAInE;;;;;;;OAOG;IACH,SAAS,CAAC,eAAe;;;;;;;IA2BzB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,EAAE,CACL,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,EAC1C,iBAAiB,UAAQ,GAC1B,OAAO,OAAO,CAAC,SAAS;IAa3B;;;;;;;;;;OAUG;IACI,GAAG,CAAC,WAAW,EAAE,UAAU,EAAE,QAAQ,EAAE,eAAe,GAAG,OAAO,OAAO,CAAC,SAAS;IASxF;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;;;OAIG;IACI,sBAAsB,UAAS;IAEtC;;;;;OAKG;IACH,OAAO,CAAC,4BAA4B,CAAyB;IAE7D,SAAS,CAAC,eAAe,CAAC,CAAC,SAAS,OAAO,KAAK,CAAC;IAQjD,OAAO,CAAC,yBAAyB;IAUjC,OAAO,CAAC,mCAAmC;IAQ3C;;;OAGG;IACH,SAAS,CAAC,gCAAgC,CAAC,QAAQ,EAAE,MAAM,IAAI;IAS/D,SAAS,CAAC,2BAA2B,WAAY,WAAW,QAAQ,GAAG,WAAW,kBAAkB,gBAenG;IAED;;;;;OAKG;IACU,OAAO,CAAC,UAAU,SAAS,SAAS,EAAE,QAAQ,EACvD,WAAW,EAAE,UAAU,EACvB,IAAI,GAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAa,GACvD,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;IAgBjD;;;;;;OAMG;IACU,oBAAoB,CAAC,mBAAmB,SAAS,kBAAkB,EAC5E,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAC;IAK3D;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAUhC,YAAY,IAAI,MAAM;IAI7B,SAAS,CAAC,wBAAwB;IAIlC;;;OAGG;IACU,SAAS,CAAC,sBAAsB,UAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAUxE;;;;;OAKG;IACI,2BAA2B,CAC9B,gBAAgB,GAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;KAAO,GAC1D,MAAM;IAwBT;;;OAGG;IACI,OAAO,IAAI,IAAI;IAUf,yBAAyB,IAAI,iBAAiB;IAIrD;;;;;;OAMG;IACU,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAW7C,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAIxC,OAAO,CAAC,2BAA2B,CAyBjC;IAEF;;;;;OAKG;IACU,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IA8C9C;;;;;;;OAOG;IACI,kBAAkB,IAAI,IAAI;IAejC;;;OAGG;IACI,aAAa,IAAI,IAAI;IAqB5B;;;;;;OAMG;IACI,eAAe;;;;IAOtB;;;;;OAKG;IACU,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAKrE;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IA6BpC;;OAEG;IACH,OAAO,CAAC,6BAA6B;CAMxC;AAED;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,OAAO;IAChC,SAAS,CAAC,UAAU,EAAE,UAAU,CAAC;gBAErB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU;IAK5D;;;OAGG;IACH,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD,SAAS,CAAC,gBAAgB,IAAI,MAAM;IAqBpC;;;;;;;;;;;;;;;;OAgBG;IACI,EAAE,CACL,WAAW,EAAE,UAAU,EACvB,QAAQ,EAAE,eAAe,EACzB,OAAO,GAAE,cAAiC,GAC3C,OAAO,OAAO,CAAC,SAAS;IAK3B;;;OAGG;IAEI,sBAAsB,6EAAyB;CACzD"}
@@ -1007,12 +1007,15 @@ export interface HomePageConfig {
1007
1007
  * Hide list page columns
1008
1008
  * For example: hiddenListColumns = [ListPageColumns.Author]
1009
1009
  *
1010
- * **Note**: This option is available only in full app embedding.
1010
+ * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
1011
+ * At present, it can be used with Liveboard and Answer list pages, and starting with version 10.14.0.cl, it will also be supported for the Home page.
1011
1012
  *
1012
1013
  * Supported embed types: `AppEmbed`
1013
1014
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
1014
1015
  * @example
1015
1016
  * ```js
1017
+ * import { ListPageColumns } from '@thoughtspot/visual-embed-sdk';
1018
+ *
1016
1019
  * const embed = new AppEmbed('#tsEmbed', {
1017
1020
  * ... //other embed view config
1018
1021
  * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
@@ -1027,11 +1030,14 @@ export interface HomePageConfig {
1027
1030
  * **Note**: This option does not apply to the classic homepage.
1028
1031
  * To access the updated modular homepage, set
1029
1032
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
1033
+ * To use it, you need to import `HomepageModule` enum.
1030
1034
  *
1031
1035
  * Supported embed types: `AppEmbed`
1032
1036
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1033
1037
  * @example
1034
1038
  * ```js
1039
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
1040
+ *
1035
1041
  * const embed = new AppEmbed('#tsEmbed', {
1036
1042
  * ... //other embed view config
1037
1043
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
@@ -1046,11 +1052,14 @@ export interface HomePageConfig {
1046
1052
  * **Note**: This option does not apply to the classic homepage.
1047
1053
  * To access the updated modular homepage, set
1048
1054
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
1055
+ * To use it, you need to import `HomepageModule` enum.
1049
1056
  *
1050
1057
  * Supported embed types: `AppEmbed`
1051
1058
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1052
1059
  * @example
1053
1060
  * ```js
1061
+ * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
1062
+ *
1054
1063
  * const embed = new AppEmbed('#tsEmbed', {
1055
1064
  * ... //other embed view config
1056
1065
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
@@ -1066,6 +1075,8 @@ export interface HomePageConfig {
1066
1075
  * Supported embed types: `AppEmbed`
1067
1076
  * @example
1068
1077
  * ```js
1078
+ * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
1079
+ *
1069
1080
  * const embed = new AppEmbed('#tsEmbed', {
1070
1081
  * ... //other embed view config
1071
1082
  * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
@@ -1075,6 +1086,7 @@ export interface HomePageConfig {
1075
1086
  * **Note**: This option does not apply to the classic homepage.
1076
1087
  * To access the updated modular homepage, set
1077
1088
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
1089
+ * To use it, you need to import `HomeLeftNavItem` enum.
1078
1090
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
1079
1091
  */
1080
1092
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -2283,7 +2295,7 @@ export declare enum EmbedEvent {
2283
2295
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
2284
2296
  * @example
2285
2297
  *```js
2286
- * liveboardEmbed.on(EmbedEvent.AnswerChartSwitcher, payload => {
2298
+ * liveboardEmbed.on(EmbedEvent.LiveboardInfo, payload => {
2287
2299
  * console.log('Liveboard details', payload);
2288
2300
  * })
2289
2301
  *```
@@ -2658,58 +2670,58 @@ export declare enum EmbedEvent {
2658
2670
  */
2659
2671
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
2660
2672
  /**
2661
- * Emitted when spotter response is text data
2673
+ * Emitted when Spotter response is text data
2662
2674
  * @example
2663
2675
  * ```js
2664
2676
  * spotterEmbed.on(EmbedEvent.SpotterData, (payload) => {
2665
2677
  * console.log('payload', payload);
2666
2678
  * })
2667
2679
  *```
2668
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
2680
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2669
2681
  */
2670
2682
  SpotterData = "SpotterData",
2671
2683
  /**
2672
- * Emitted when user opens up the worksheet preview modal in spotter embed.
2684
+ * Emitted when user opens up the worksheet preview modal in Spotter embed.
2673
2685
  * @example
2674
2686
  * ```js
2675
2687
  * spotterEmbed.on(EmbedEvent.PreviewSpotterData, (payload) => {
2676
2688
  * console.log('payload', payload);
2677
2689
  * })
2678
2690
  *```
2679
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
2691
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2680
2692
  */
2681
2693
  PreviewSpotterData = "PreviewSpotterData",
2682
2694
  /**
2683
- * Emitted when the spotter query is triggered in spotter embed.
2695
+ * Emitted when the Spotter query is triggered in Spotter embed.
2684
2696
  * @example
2685
2697
  * ```js
2686
2698
  * spotterEmbed.on(EmbedEvent.SpotterQueryTriggered, (payload) => {
2687
2699
  * console.log('payload', payload);
2688
2700
  * })
2689
2701
  *```
2690
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
2702
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2691
2703
  */
2692
2704
  SpotterQueryTriggered = "SpotterQueryTriggered",
2693
2705
  /**
2694
- * Emitted when the last spotter query is edited in spotter embed.
2706
+ * Emitted when the last Spotter query is edited in Spotter embed.
2695
2707
  * @example
2696
2708
  * ```js
2697
2709
  * spotterEmbed.on(EmbedEvent.LastPromptEdited, (payload) => {
2698
2710
  * console.log('payload', payload);
2699
2711
  * })
2700
2712
  *```
2701
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
2713
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2702
2714
  */
2703
2715
  LastPromptEdited = "LastPromptEdited",
2704
2716
  /**
2705
- * Emitted when the last spotter query is deleted in spotter embed.
2717
+ * Emitted when the last Spotter query is deleted in Spotter embed.
2706
2718
  * @example
2707
2719
  * ```js
2708
2720
  * spotterEmbed.on(EmbedEvent.LastPromptDeleted, (payload) => {
2709
2721
  * console.log('payload', payload);
2710
2722
  * })
2711
2723
  *```
2712
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
2724
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2713
2725
  */
2714
2726
  LastPromptDeleted = "LastPromptDeleted",
2715
2727
  /**
@@ -2720,7 +2732,7 @@ export declare enum EmbedEvent {
2720
2732
  * console.log('payload', payload);
2721
2733
  * })
2722
2734
  *```
2723
- * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
2735
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
2724
2736
  */
2725
2737
  ResetSpotterConversation = "ResetSpotterConversation",
2726
2738
  /**
@@ -2733,7 +2745,19 @@ export declare enum EmbedEvent {
2733
2745
  *```
2734
2746
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
2735
2747
  */
2736
- SpotterInit = "SpotterInit"
2748
+ SpotterInit = "spotterInit",
2749
+ /**
2750
+ * @hidden
2751
+ * Triggers when the embed listener is ready to receive events.
2752
+ * This is used to trigger events after the embed container is loaded.
2753
+ * @example
2754
+ * ```js
2755
+ * liveboardEmbed.on(EmbedEvent.EmbedListenerReady, () => {
2756
+ * console.log('EmbedListenerReady');
2757
+ * })
2758
+ * ```
2759
+ */
2760
+ EmbedListenerReady = "EmbedListenerReady"
2737
2761
  }
2738
2762
  /**
2739
2763
  * Event types that can be triggered by the host application
@@ -2821,6 +2845,7 @@ export declare enum HostEvent {
2821
2845
  * done automatically on the most popular column.
2822
2846
  * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
2823
2847
  * in case of a Liveboard.
2848
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
2824
2849
  * @example
2825
2850
  * ```js
2826
2851
  * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -3140,12 +3165,21 @@ export declare enum HostEvent {
3140
3165
  * Trigger the **Download PDF** action on an embedded Liveboard,
3141
3166
  * visualization or Answer.
3142
3167
  *
3168
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3169
+ *
3143
3170
  * **NOTE**: The **Download** > **PDF** action is available on
3144
3171
  * visualizations and Answers if the data is in tabular format.
3145
3172
  * @example
3146
3173
  * ```js
3147
3174
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
3148
3175
  * ```
3176
+ * @example
3177
+ * ```js
3178
+ * spotterEmbed.trigger(HostEvent.DownloadAsPdf, {
3179
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
3180
+ * });
3181
+ * ```
3182
+ *
3149
3183
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3150
3184
  */
3151
3185
  DownloadAsPdf = "downloadAsPdf",
@@ -3247,7 +3281,8 @@ export declare enum HostEvent {
3247
3281
  * This event is not supported in visualization embed and search embed.
3248
3282
  * @param - object - To trigger the action for a specific visualization
3249
3283
  * in Liveboard embed, pass in `vizId` as a key.
3250
- * **Required** in Spotter embed.
3284
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3285
+ *
3251
3286
  * @example
3252
3287
  * ```js
3253
3288
  * liveboardEmbed.trigger(HostEvent.Edit)
@@ -3262,6 +3297,12 @@ export declare enum HostEvent {
3262
3297
  * vizId:'730496d6-6903-4601-937e-2c691821af3c'
3263
3298
  * });
3264
3299
  * ```
3300
+ * @example
3301
+ * ```js
3302
+ * const editResponse = await spotterEmbed.trigger(HostEvent.Edit, {
3303
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
3304
+ * });
3305
+ * ```
3265
3306
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3266
3307
  */
3267
3308
  Edit = "edit",
@@ -3382,6 +3423,7 @@ export declare enum HostEvent {
3382
3423
  /**
3383
3424
  * Trigger the **Download** action on charts in
3384
3425
  * the embedded view.
3426
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3385
3427
  * @example
3386
3428
  * ```js
3387
3429
  * liveboardEmbed.trigger(HostEvent.Download, {vizId:
@@ -3390,6 +3432,11 @@ export declare enum HostEvent {
3390
3432
  * ```js
3391
3433
  * embed.trigger(HostEvent.Download)
3392
3434
  * ```
3435
+ * ```js
3436
+ * spotterEmbed.trigger(HostEvent.Download, {
3437
+ * vizId:'730496d6-6903-4601-937e-2c691821af3c'
3438
+ * });
3439
+ * ```
3393
3440
  * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1.sw
3394
3441
  * Use {@link DownloadAsPng}
3395
3442
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
@@ -3418,6 +3465,7 @@ export declare enum HostEvent {
3418
3465
  /**
3419
3466
  * Trigger the **Download** > **CSV** action on tables in
3420
3467
  * the embedded view.
3468
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3421
3469
  * @example
3422
3470
  * ```js
3423
3471
  * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId:
@@ -3440,6 +3488,7 @@ export declare enum HostEvent {
3440
3488
  /**
3441
3489
  * Trigger the **Download** > **XLSX** action on tables
3442
3490
  * in the embedded view.
3491
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3443
3492
  * @example
3444
3493
  * ```js
3445
3494
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -3475,7 +3524,7 @@ export declare enum HostEvent {
3475
3524
  /**
3476
3525
  * Trigger the **Save** action on a Liveboard or Answer.
3477
3526
  * Saves the changes.
3478
- * @param - `vizId` is required in Spotter Embed.
3527
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3479
3528
  * @example
3480
3529
  * ```js
3481
3530
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -3785,6 +3834,7 @@ export declare enum HostEvent {
3785
3834
  UpdateParameters = "UpdateParameters",
3786
3835
  /**
3787
3836
  * Triggers GetParameters to fetch the runtime Parameters.
3837
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3788
3838
  * ```js
3789
3839
  * liveboardEmbed.trigger(HostEvent.GetParameters).then((parameter) => {
3790
3840
  * console.log('parameters', parameter);
@@ -3828,7 +3878,7 @@ export declare enum HostEvent {
3828
3878
  * @param - optional attributes to set Answer properties.
3829
3879
  * `name` - Name string for the Answer.
3830
3880
  * `description` - Description text for the Answer.
3831
- *
3881
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3832
3882
  * @example
3833
3883
  * ```js
3834
3884
  * const saveAnswerResponse = await searchEmbed.trigger(HostEvent.SaveAnswer, {
@@ -3836,6 +3886,14 @@ export declare enum HostEvent {
3836
3886
  * description: "Total sales by states in MidWest"
3837
3887
  * });
3838
3888
  * ```
3889
+ * @example
3890
+ * ```js
3891
+ * const saveAnswerResponse = await spotterEmbed.trigger(HostEvent.SaveAnswer, {
3892
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c',
3893
+ * name: "Sales by states",
3894
+ * description: "Total sales by states in MidWest"
3895
+ * });
3896
+ * ```
3839
3897
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
3840
3898
  */
3841
3899
  SaveAnswer = "saveAnswer",
@@ -3867,7 +3925,7 @@ export declare enum HostEvent {
3867
3925
  /**
3868
3926
  * Triggers a search operation with the search tokens specified in
3869
3927
  * the search query string in spotter embed.
3870
- * @param - `queryString`: Text string in Natural Language format
3928
+ * @param - `query`: Text string in Natural Language format
3871
3929
  * @param - `executeSearch`: Boolean to execute search and update search query
3872
3930
  * @example
3873
3931
  * ```js
@@ -3876,6 +3934,7 @@ export declare enum HostEvent {
3876
3934
  * executeSearch: true,
3877
3935
  * })
3878
3936
  * ```
3937
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3879
3938
  */
3880
3939
  SpotterSearch = "SpotterSearch",
3881
3940
  /**
@@ -3885,6 +3944,7 @@ export declare enum HostEvent {
3885
3944
  * ```js
3886
3945
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
3887
3946
  * ```
3947
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3888
3948
  */
3889
3949
  EditLastPrompt = "EditLastPrompt",
3890
3950
  /**
@@ -3893,6 +3953,7 @@ export declare enum HostEvent {
3893
3953
  * ```js
3894
3954
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
3895
3955
  * ```
3956
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3896
3957
  */
3897
3958
  PreviewSpotterData = "PreviewSpotterData",
3898
3959
  /**
@@ -3901,6 +3962,7 @@ export declare enum HostEvent {
3901
3962
  * ```js
3902
3963
  * spotterEmbed.trigger(HostEvent.ResetSpotterConversation);
3903
3964
  * ```
3965
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3904
3966
  */
3905
3967
  ResetSpotterConversation = "ResetSpotterConversation",
3906
3968
  /**
@@ -3909,17 +3971,19 @@ export declare enum HostEvent {
3909
3971
  * ```js
3910
3972
  * spotterEmbed.trigger(HostEvent.DeleteLastPrompt);
3911
3973
  * ```
3974
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3912
3975
  */
3913
3976
  DeleteLastPrompt = "DeleteLastPrompt",
3914
3977
  /**
3915
3978
  * Toggle the visualization to chart or table view.
3916
- * @param - `vizId ` In Spotter Embed, vizId is required.
3979
+ * @param - `vizId ` refers to the answer id in spotter Embed, it is required in spotter Embed.
3917
3980
  * @example
3918
3981
  * ```js
3919
3982
  * spotterEmbed.trigger(HostEvent.AnswerChartSwitcher, {
3920
- * vizId:"'b535c760-8bbe-4e6f-bb26-af56b4129a1e'"
3983
+ * vizId:'b535c760-8bbe-4e6f-bb26-af56b4129a1e'
3921
3984
  * });
3922
3985
  *```
3986
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
3923
3987
  */
3924
3988
  AnswerChartSwitcher = "answerChartSwitcher",
3925
3989
  /**
@@ -3946,25 +4010,16 @@ export declare enum HostEvent {
3946
4010
  */
3947
4011
  VisibleEmbedCoordinates = "visibleEmbedCoordinates",
3948
4012
  /**
3949
- * Trigger the *Ask Sage* action for visualizations
4013
+ * Trigger the *Ask Spotter* action for visualizations
4014
+ * @param - `vizId` refers to the Answer ID in Spotter embed and is required in Spotter embed.
3950
4015
  * @example
3951
4016
  * ```js
3952
- * liveboardEmbed.trigger(HostEvent.AskSpotter,
3953
- * {containerId:'730496d6-6903-4601-937e-2c691821af3c'})
4017
+ * spotterEmbed.trigger(HostEvent.AskSpotter,
4018
+ * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
3954
4019
  * ```
3955
4020
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
3956
4021
  */
3957
- AskSpotter = "askSpotter",
3958
- /**
3959
- * @hidden
3960
- * Triggers the update of the embed params.
3961
- *
3962
- * @example
3963
- * ```js
3964
- * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
3965
- * ```
3966
- */
3967
- UpdateEmbedParams = "updateEmbedParams"
4022
+ AskSpotter = "AskSpotter"
3968
4023
  }
3969
4024
  /**
3970
4025
  * The different visual modes that the data sources panel within
@@ -4060,6 +4115,7 @@ export declare enum Param {
4060
4115
  Query = "query",
4061
4116
  HideHomepageLeftNav = "hideHomepageLeftNav",
4062
4117
  ModularHomeExperienceEnabled = "modularHomeExperience",
4118
+ HomepageVersion = "homepageVersion",
4063
4119
  ListPageVersion = "listpageVersion",
4064
4120
  PendoTrackingKey = "additionalPendoKey",
4065
4121
  LiveboardHeaderSticky = "isLiveboardHeaderSticky",
@@ -4252,27 +4308,27 @@ export declare enum Action {
4252
4308
  */
4253
4309
  ConfigureFilter = "configureFilter",
4254
4310
  /**
4255
- * The **Collapse data sources** icon on the Search page.
4256
- * Collapses the panel showing data sources.
4257
- *
4258
- * @example
4259
- * ```js
4260
- * disabledActions: [Action.CollapseDataPanel]
4261
- * ```
4262
- * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
4263
- */
4311
+ * The **Collapse data sources** icon on the Search page.
4312
+ * Collapses the panel showing data sources.
4313
+ *
4314
+ * @example
4315
+ * ```js
4316
+ * disabledActions: [Action.CollapseDataPanel]
4317
+ * ```
4318
+ * @version: SDK: 1.1.0 | ThoughtSpot Cloud: ts7.may.cl, 8.4.1.sw
4319
+ */
4264
4320
  CollapseDataSources = "collapseDataSources",
4265
4321
  /**
4266
- * The **Collapse data panel** icon on the Search page.
4267
- * Collapses the data panel view.
4268
- *
4269
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4270
- *
4271
- * @example
4272
- * ```js
4273
- * disabledActions: [Action.CollapseDataPanel]
4274
- * ```
4275
- */
4322
+ * The **Collapse data panel** icon on the Search page.
4323
+ * Collapses the data panel view.
4324
+ *
4325
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
4326
+ *
4327
+ * @example
4328
+ * ```js
4329
+ * disabledActions: [Action.CollapseDataPanel]
4330
+ * ```
4331
+ */
4276
4332
  CollapseDataPanel = "collapseDataPanel",
4277
4333
  /**
4278
4334
  * The **Choose sources** button on Search page.
@@ -4968,6 +5024,17 @@ export declare enum Action {
4968
5024
  * @version SDK: 1.25.0 | ThoughtSpot Cloud: 9.6.0.cl
4969
5025
  */
4970
5026
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
5027
+ /**
5028
+ * Action ID to hide or disable Iterative Change Analysis option
5029
+ * on contextual change analysis Inisght charts context menu
5030
+ *
5031
+ * @example
5032
+ * ```js
5033
+ * disabledActions: [Action.EnableIterativeChangeAnalysis]
5034
+ * ```
5035
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 9.12.0.cl
5036
+ */
5037
+ EnableIterativeChangeAnalysis = "enableIterativeChangeAnalysis",
4971
5038
  /**
4972
5039
  * Action ID to hide or disable Natural Language Search query.
4973
5040
  *
@@ -5336,7 +5403,40 @@ export declare enum Action {
5336
5403
  * ```
5337
5404
  * @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
5338
5405
  */
5339
- InConversationTraining = "InConversationTraining"
5406
+ InConversationTraining = "InConversationTraining",
5407
+ /**
5408
+ * Action ID to hide the warnings banner in
5409
+ * Spotter results. It's an EA feature and
5410
+ * handled by LD.
5411
+ * @example
5412
+ * ```js
5413
+ * hiddenAction: [Action.SpotterWarningsBanner]
5414
+ * ```
5415
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
5416
+ */
5417
+ SpotterWarningsBanner = "SpotterWarningsBanner",
5418
+ /**
5419
+ * Action ID to hide the warnings border on the knowledge
5420
+ * card in Spotter results. It's an EA feature and
5421
+ * handled by LD.
5422
+ * @example
5423
+ * ```js
5424
+ * hiddenAction: [Action.SpotterWarningsOnTokens]
5425
+ * ```
5426
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
5427
+ */
5428
+ SpotterWarningsOnTokens = "SpotterWarningsOnTokens",
5429
+ /**
5430
+ * Action ID to disable the click event handler on knowledge
5431
+ * card in Spotter results. It's an EA feature and
5432
+ * handled by LD.
5433
+ * @example
5434
+ * ```js
5435
+ * hiddenAction: [Action.SpotterTokenQuickEdit]
5436
+ * ```
5437
+ * @version SDK: 1.41.0 | ThoughtSpot Cloud: 10.13.0.cl
5438
+ */
5439
+ SpotterTokenQuickEdit = "SpotterTokenQuickEdit"
5340
5440
  }
5341
5441
  export interface AnswerServiceType {
5342
5442
  getAnswer?: (offset: number, batchSize: number) => any;