@thoughtspot/visual-embed-sdk 1.46.4 → 1.46.5

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 (255) hide show
  1. package/cjs/package.json +3 -3
  2. package/cjs/src/auth.d.ts +2 -1
  3. package/cjs/src/auth.d.ts.map +1 -1
  4. package/cjs/src/auth.js +2 -1
  5. package/cjs/src/auth.js.map +1 -1
  6. package/cjs/src/authToken.d.ts.map +1 -1
  7. package/cjs/src/authToken.js.map +1 -1
  8. package/cjs/src/css-variables.d.ts +87 -17
  9. package/cjs/src/css-variables.d.ts.map +1 -1
  10. package/cjs/src/embed/app.d.ts +41 -1
  11. package/cjs/src/embed/app.d.ts.map +1 -1
  12. package/cjs/src/embed/app.js +25 -36
  13. package/cjs/src/embed/app.js.map +1 -1
  14. package/cjs/src/embed/app.spec.js +35 -23
  15. package/cjs/src/embed/app.spec.js.map +1 -1
  16. package/cjs/src/embed/base.d.ts.map +1 -1
  17. package/cjs/src/embed/base.js.map +1 -1
  18. package/cjs/src/embed/base.spec.js.map +1 -1
  19. package/cjs/src/embed/conversation.d.ts +23 -1
  20. package/cjs/src/embed/conversation.d.ts.map +1 -1
  21. package/cjs/src/embed/conversation.js +18 -33
  22. package/cjs/src/embed/conversation.js.map +1 -1
  23. package/cjs/src/embed/conversation.spec.js +129 -97
  24. package/cjs/src/embed/conversation.spec.js.map +1 -1
  25. package/cjs/src/embed/events.spec.js +72 -0
  26. package/cjs/src/embed/events.spec.js.map +1 -1
  27. package/cjs/src/embed/hostEventClient/contracts.d.ts +105 -3
  28. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  29. package/cjs/src/embed/hostEventClient/contracts.js +9 -0
  30. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  31. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +28 -0
  32. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  33. package/cjs/src/embed/hostEventClient/host-event-client.js +106 -9
  34. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  35. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +327 -6
  36. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  37. package/cjs/src/embed/hostEventClient/utils.d.ts +22 -0
  38. package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -0
  39. package/cjs/src/embed/hostEventClient/utils.js +51 -0
  40. package/cjs/src/embed/hostEventClient/utils.js.map +1 -0
  41. package/cjs/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  42. package/cjs/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  43. package/cjs/src/embed/hostEventClient/utils.spec.js +115 -0
  44. package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -0
  45. package/cjs/src/embed/liveboard.d.ts +18 -0
  46. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  47. package/cjs/src/embed/liveboard.js +10 -3
  48. package/cjs/src/embed/liveboard.js.map +1 -1
  49. package/cjs/src/embed/liveboard.spec.js +54 -2
  50. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  51. package/cjs/src/embed/sage.d.ts.map +1 -1
  52. package/cjs/src/embed/sage.js.map +1 -1
  53. package/cjs/src/embed/search.spec.js.map +1 -1
  54. package/cjs/src/embed/spotter-utils.d.ts +20 -0
  55. package/cjs/src/embed/spotter-utils.d.ts.map +1 -0
  56. package/cjs/src/embed/spotter-utils.js +52 -0
  57. package/cjs/src/embed/spotter-utils.js.map +1 -0
  58. package/cjs/src/embed/spotter-utils.spec.d.ts +2 -0
  59. package/cjs/src/embed/spotter-utils.spec.d.ts.map +1 -0
  60. package/cjs/src/embed/spotter-utils.spec.js +54 -0
  61. package/cjs/src/embed/spotter-utils.spec.js.map +1 -0
  62. package/cjs/src/embed/ts-embed.d.ts +41 -2
  63. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  64. package/cjs/src/embed/ts-embed.js +54 -3
  65. package/cjs/src/embed/ts-embed.js.map +1 -1
  66. package/cjs/src/errors.d.ts +2 -0
  67. package/cjs/src/errors.d.ts.map +1 -1
  68. package/cjs/src/errors.js +2 -0
  69. package/cjs/src/errors.js.map +1 -1
  70. package/cjs/src/react/index.d.ts.map +1 -1
  71. package/cjs/src/react/index.js +58 -53
  72. package/cjs/src/react/index.js.map +1 -1
  73. package/cjs/src/types.d.ts +832 -33
  74. package/cjs/src/types.d.ts.map +1 -1
  75. package/cjs/src/types.js +835 -3
  76. package/cjs/src/types.js.map +1 -1
  77. package/cjs/src/utils/graphql/answerService/answerService.d.ts +4 -2
  78. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  79. package/cjs/src/utils/graphql/answerService/answerService.js +4 -2
  80. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  81. package/cjs/src/utils/graphql/preview-service.d.ts.map +1 -1
  82. package/cjs/src/utils/graphql/preview-service.js.map +1 -1
  83. package/cjs/src/utils/processData.d.ts.map +1 -1
  84. package/cjs/src/utils/processData.js.map +1 -1
  85. package/cjs/src/utils.d.ts +0 -9
  86. package/cjs/src/utils.d.ts.map +1 -1
  87. package/cjs/src/utils.js +1 -10
  88. package/cjs/src/utils.js.map +1 -1
  89. package/dist/index-ChNydfIz.js +7371 -0
  90. package/dist/index-DW2wEHqy.js +7371 -0
  91. package/dist/src/auth.d.ts +2 -1
  92. package/dist/src/auth.d.ts.map +1 -1
  93. package/dist/src/authToken.d.ts.map +1 -1
  94. package/dist/src/css-variables.d.ts +87 -17
  95. package/dist/src/css-variables.d.ts.map +1 -1
  96. package/dist/src/embed/app.d.ts +41 -1
  97. package/dist/src/embed/app.d.ts.map +1 -1
  98. package/dist/src/embed/base.d.ts.map +1 -1
  99. package/dist/src/embed/conversation.d.ts +23 -1
  100. package/dist/src/embed/conversation.d.ts.map +1 -1
  101. package/dist/src/embed/hostEventClient/contracts.d.ts +105 -3
  102. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  103. package/dist/src/embed/hostEventClient/host-event-client.d.ts +28 -0
  104. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  105. package/dist/src/embed/hostEventClient/utils.d.ts +22 -0
  106. package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -0
  107. package/dist/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  108. package/dist/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  109. package/dist/src/embed/liveboard.d.ts +18 -0
  110. package/dist/src/embed/liveboard.d.ts.map +1 -1
  111. package/dist/src/embed/sage.d.ts.map +1 -1
  112. package/dist/src/embed/spotter-utils.d.ts +20 -0
  113. package/dist/src/embed/spotter-utils.d.ts.map +1 -0
  114. package/dist/src/embed/spotter-utils.spec.d.ts +2 -0
  115. package/dist/src/embed/spotter-utils.spec.d.ts.map +1 -0
  116. package/dist/src/embed/ts-embed.d.ts +41 -2
  117. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  118. package/dist/src/errors.d.ts +2 -0
  119. package/dist/src/errors.d.ts.map +1 -1
  120. package/dist/src/react/index.d.ts.map +1 -1
  121. package/dist/src/types.d.ts +832 -33
  122. package/dist/src/types.d.ts.map +1 -1
  123. package/dist/src/utils/graphql/answerService/answerService.d.ts +4 -2
  124. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  125. package/dist/src/utils/graphql/preview-service.d.ts.map +1 -1
  126. package/dist/src/utils/processData.d.ts.map +1 -1
  127. package/dist/src/utils.d.ts +0 -9
  128. package/dist/src/utils.d.ts.map +1 -1
  129. package/dist/tsembed-react.es.js +1208 -154
  130. package/dist/tsembed-react.js +1206 -152
  131. package/dist/tsembed.es.js +1150 -101
  132. package/dist/tsembed.js +1148 -99
  133. package/dist/visual-embed-sdk-react-full.d.ts +1156 -55
  134. package/dist/visual-embed-sdk-react.d.ts +1156 -55
  135. package/dist/visual-embed-sdk.d.ts +1179 -60
  136. package/lib/package.json +3 -3
  137. package/lib/src/auth.d.ts +2 -1
  138. package/lib/src/auth.d.ts.map +1 -1
  139. package/lib/src/auth.js +2 -1
  140. package/lib/src/auth.js.map +1 -1
  141. package/lib/src/authToken.d.ts.map +1 -1
  142. package/lib/src/authToken.js.map +1 -1
  143. package/lib/src/css-variables.d.ts +87 -17
  144. package/lib/src/css-variables.d.ts.map +1 -1
  145. package/lib/src/embed/app.d.ts +41 -1
  146. package/lib/src/embed/app.d.ts.map +1 -1
  147. package/lib/src/embed/app.js +27 -38
  148. package/lib/src/embed/app.js.map +1 -1
  149. package/lib/src/embed/app.spec.js +35 -23
  150. package/lib/src/embed/app.spec.js.map +1 -1
  151. package/lib/src/embed/base.d.ts.map +1 -1
  152. package/lib/src/embed/base.js.map +1 -1
  153. package/lib/src/embed/base.spec.js.map +1 -1
  154. package/lib/src/embed/conversation.d.ts +23 -1
  155. package/lib/src/embed/conversation.d.ts.map +1 -1
  156. package/lib/src/embed/conversation.js +19 -34
  157. package/lib/src/embed/conversation.js.map +1 -1
  158. package/lib/src/embed/conversation.spec.js +131 -99
  159. package/lib/src/embed/conversation.spec.js.map +1 -1
  160. package/lib/src/embed/events.spec.js +73 -1
  161. package/lib/src/embed/events.spec.js.map +1 -1
  162. package/lib/src/embed/hostEventClient/contracts.d.ts +105 -3
  163. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  164. package/lib/src/embed/hostEventClient/contracts.js +9 -0
  165. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  166. package/lib/src/embed/hostEventClient/host-event-client.d.ts +28 -0
  167. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  168. package/lib/src/embed/hostEventClient/host-event-client.js +106 -9
  169. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  170. package/lib/src/embed/hostEventClient/host-event-client.spec.js +327 -6
  171. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  172. package/lib/src/embed/hostEventClient/utils.d.ts +22 -0
  173. package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -0
  174. package/lib/src/embed/hostEventClient/utils.js +43 -0
  175. package/lib/src/embed/hostEventClient/utils.js.map +1 -0
  176. package/lib/src/embed/hostEventClient/utils.spec.d.ts +2 -0
  177. package/lib/src/embed/hostEventClient/utils.spec.d.ts.map +1 -0
  178. package/lib/src/embed/hostEventClient/utils.spec.js +113 -0
  179. package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -0
  180. package/lib/src/embed/liveboard.d.ts +18 -0
  181. package/lib/src/embed/liveboard.d.ts.map +1 -1
  182. package/lib/src/embed/liveboard.js +10 -3
  183. package/lib/src/embed/liveboard.js.map +1 -1
  184. package/lib/src/embed/liveboard.spec.js +54 -2
  185. package/lib/src/embed/liveboard.spec.js.map +1 -1
  186. package/lib/src/embed/sage.d.ts.map +1 -1
  187. package/lib/src/embed/sage.js.map +1 -1
  188. package/lib/src/embed/search.spec.js.map +1 -1
  189. package/lib/src/embed/spotter-utils.d.ts +20 -0
  190. package/lib/src/embed/spotter-utils.d.ts.map +1 -0
  191. package/lib/src/embed/spotter-utils.js +47 -0
  192. package/lib/src/embed/spotter-utils.js.map +1 -0
  193. package/lib/src/embed/spotter-utils.spec.d.ts +2 -0
  194. package/lib/src/embed/spotter-utils.spec.d.ts.map +1 -0
  195. package/lib/src/embed/spotter-utils.spec.js +52 -0
  196. package/lib/src/embed/spotter-utils.spec.js.map +1 -0
  197. package/lib/src/embed/ts-embed.d.ts +41 -2
  198. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  199. package/lib/src/embed/ts-embed.js +55 -4
  200. package/lib/src/embed/ts-embed.js.map +1 -1
  201. package/lib/src/errors.d.ts +2 -0
  202. package/lib/src/errors.d.ts.map +1 -1
  203. package/lib/src/errors.js +2 -0
  204. package/lib/src/errors.js.map +1 -1
  205. package/lib/src/react/index.d.ts.map +1 -1
  206. package/lib/src/react/index.js +58 -53
  207. package/lib/src/react/index.js.map +1 -1
  208. package/lib/src/types.d.ts +832 -33
  209. package/lib/src/types.d.ts.map +1 -1
  210. package/lib/src/types.js +835 -3
  211. package/lib/src/types.js.map +1 -1
  212. package/lib/src/utils/graphql/answerService/answerService.d.ts +4 -2
  213. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  214. package/lib/src/utils/graphql/answerService/answerService.js +4 -2
  215. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  216. package/lib/src/utils/graphql/preview-service.d.ts.map +1 -1
  217. package/lib/src/utils/graphql/preview-service.js.map +1 -1
  218. package/lib/src/utils/processData.d.ts.map +1 -1
  219. package/lib/src/utils/processData.js.map +1 -1
  220. package/lib/src/utils.d.ts +0 -9
  221. package/lib/src/utils.d.ts.map +1 -1
  222. package/lib/src/utils.js +0 -8
  223. package/lib/src/utils.js.map +1 -1
  224. package/lib/src/visual-embed-sdk.d.ts +1179 -60
  225. package/package.json +3 -3
  226. package/src/auth.spec.ts +1 -1
  227. package/src/auth.ts +2 -1
  228. package/src/authToken.ts +0 -1
  229. package/src/css-variables.ts +96 -17
  230. package/src/embed/app.spec.ts +48 -30
  231. package/src/embed/app.ts +59 -54
  232. package/src/embed/base.spec.ts +1 -2
  233. package/src/embed/base.ts +1 -4
  234. package/src/embed/conversation.spec.ts +150 -119
  235. package/src/embed/conversation.ts +30 -54
  236. package/src/embed/events.spec.ts +88 -0
  237. package/src/embed/hostEventClient/contracts.ts +105 -2
  238. package/src/embed/hostEventClient/host-event-client.spec.ts +504 -6
  239. package/src/embed/hostEventClient/host-event-client.ts +146 -15
  240. package/src/embed/hostEventClient/utils.spec.ts +137 -0
  241. package/src/embed/hostEventClient/utils.ts +61 -0
  242. package/src/embed/liveboard.spec.ts +71 -2
  243. package/src/embed/liveboard.ts +29 -2
  244. package/src/embed/sage.ts +0 -1
  245. package/src/embed/search.spec.ts +0 -2
  246. package/src/embed/spotter-utils.spec.ts +56 -0
  247. package/src/embed/spotter-utils.ts +65 -0
  248. package/src/embed/ts-embed.ts +58 -4
  249. package/src/errors.ts +2 -0
  250. package/src/react/index.tsx +76 -72
  251. package/src/types.ts +843 -31
  252. package/src/utils/graphql/answerService/answerService.ts +4 -5
  253. package/src/utils/graphql/preview-service.ts +0 -1
  254. package/src/utils/processData.ts +0 -5
  255. package/src/utils.ts +0 -14
@@ -2667,6 +2667,17 @@ export declare enum EmbedEvent {
2667
2667
  * ```
2668
2668
  */
2669
2669
  DownloadAsXlsx = "downloadAsXlsx",
2670
+ /**
2671
+ * Emitted when the Download Liveboard as Continuous PDF action is triggered
2672
+ * on a Liveboard.
2673
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
2674
+ * @example
2675
+ * ```js
2676
+ * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
2677
+ * console.log('download liveboard as continuous PDF', payload)})
2678
+ * ```
2679
+ */
2680
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
2670
2681
  /**
2671
2682
  * Emitted when an Answer is deleted in the app
2672
2683
  * Use start:true to subscribe to when delete is initiated, or end:true to subscribe
@@ -3070,22 +3081,45 @@ export declare enum EmbedEvent {
3070
3081
  /**
3071
3082
  * Emitted when name, status (private or public) or filter values of a
3072
3083
  * Personalised view is updated.
3084
+ * This event is deprecated. Use {@link EmbedEvent.UpdatePersonalizedView} instead.
3073
3085
  * @returns viewName: string
3074
3086
  * @returns viewId: string
3075
3087
  * @returns liveboardId: string
3076
3088
  * @returns isPublic: boolean
3077
3089
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3090
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3078
3091
  */
3079
3092
  UpdatePersonalisedView = "updatePersonalisedView",
3093
+ /**
3094
+ * Emitted when name, status (private or public) or filter values of a
3095
+ * Personalized view is updated.
3096
+ * @returns viewName: string
3097
+ * @returns viewId: string
3098
+ * @returns liveboardId: string
3099
+ * @returns isPublic: boolean
3100
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3101
+ */
3102
+ UpdatePersonalizedView = "updatePersonalisedView",
3080
3103
  /**
3081
3104
  * Emitted when a Personalised view is saved.
3105
+ * This event is deprecated. Use {@link EmbedEvent.SavePersonalizedView} instead.
3082
3106
  * @returns viewName: string
3083
3107
  * @returns viewId: string
3084
3108
  * @returns liveboardId: string
3085
3109
  * @returns isPublic: boolean
3086
3110
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3111
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3087
3112
  */
3088
3113
  SavePersonalisedView = "savePersonalisedView",
3114
+ /**
3115
+ * Emitted when a Personalized view is saved.
3116
+ * @returns viewName: string
3117
+ * @returns viewId: string
3118
+ * @returns liveboardId: string
3119
+ * @returns isPublic: boolean
3120
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3121
+ */
3122
+ SavePersonalizedView = "savePersonalisedView",
3089
3123
  /**
3090
3124
  * Emitted when a Liveboard is reset.
3091
3125
  * @returns viewName: string
@@ -3097,11 +3131,41 @@ export declare enum EmbedEvent {
3097
3131
  ResetLiveboard = "resetLiveboard",
3098
3132
  /**
3099
3133
  * Emitted when a PersonalisedView is deleted.
3134
+ * This event is deprecated. Use {@link EmbedEvent.DeletePersonalizedView} instead.
3100
3135
  * @returns views: string[]
3101
3136
  * @returns liveboardId: string
3102
3137
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
3138
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3103
3139
  */
3104
3140
  DeletePersonalisedView = "deletePersonalisedView",
3141
+ /**
3142
+ * Emitted when a PersonalizedView is deleted.
3143
+ * @returns views: string[]
3144
+ * @returns liveboardId: string
3145
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3146
+ */
3147
+ DeletePersonalizedView = "deletePersonalisedView",
3148
+ /**
3149
+ * Emitted when a user selects a different Personalized View or
3150
+ * resets to the original/default view on a Liveboard.
3151
+ * @example
3152
+ * ```js
3153
+ * liveboardEmbed.on(EmbedEvent.ChangePersonalizedView, (data) => {
3154
+ * console.log(data.viewName); // 'Q4 Revenue' or 'Original View'
3155
+ * console.log(data.viewId); // '2a021a12-...' or null (default)
3156
+ * console.log(data.liveboardId); // 'abc123...'
3157
+ * console.log(data.isPublic); // true | false
3158
+ * })
3159
+ * ```
3160
+ * @returns viewName: string - Name of the selected view,
3161
+ * or 'Original View' when reset to default.
3162
+ * @returns viewId: string | null - GUID of the selected view,
3163
+ * or null when reset to default.
3164
+ * @returns liveboardId: string
3165
+ * @returns isPublic: boolean
3166
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
3167
+ */
3168
+ ChangePersonalizedView = "changePersonalisedView",
3105
3169
  /**
3106
3170
  * Emitted when a user creates a Worksheet.
3107
3171
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
@@ -3135,7 +3199,8 @@ export declare enum EmbedEvent {
3135
3199
  * @param - Includes the following parameters:
3136
3200
  * - `payload`: The payload received from the embed related to the Data API call.
3137
3201
  * - `responder`: Contains elements that let developers define whether ThoughtSpot
3138
- * will run or block the search operation, and if blocked, which error message to provide.
3202
+ * will run or block the search operation, and if blocked, which error message to
3203
+ * provide.
3139
3204
  * - `execute` - When `execute` returns `true`, the search is run.
3140
3205
  * When `execute` returns `false`, the search is not executed.
3141
3206
  * - `error` - Developers can customize the user-facing error message when `execute`
@@ -3569,6 +3634,25 @@ export declare enum EmbedEvent {
3569
3634
  * );
3570
3635
  * }
3571
3636
  * ```
3637
+ *
3638
+ * **Context Parameter (SDK: 1.45.2+)**
3639
+ *
3640
+ * Starting from SDK version 1.45.2 | ThoughtSpot: 26.3.0.cl, you can optionally pass a
3641
+ * `ContextType` as the third parameter to the `trigger` method to specify the context
3642
+ * from which the event is triggered. This helps ThoughtSpot understand the current page
3643
+ * context (Search, Answer, Liveboard, or Spotter) for better event handling.
3644
+ *
3645
+ * @example
3646
+ * ```js
3647
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
3648
+ *
3649
+ * // Trigger Pin event with Search context
3650
+ * appEmbed.trigger(HostEvent.Pin, {
3651
+ * vizId: "123",
3652
+ * liveboardId: "456"
3653
+ * }, ContextType.Search);
3654
+ * ```
3655
+ *
3572
3656
  * @group Events
3573
3657
  */
3574
3658
  export declare enum HostEvent {
@@ -3590,6 +3674,16 @@ export declare enum HostEvent {
3590
3674
  execute: true
3591
3675
  });
3592
3676
  * ```
3677
+ * @example
3678
+ * ```js
3679
+ * // Trigger search from search context
3680
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3681
+ * appEmbed.trigger(HostEvent.Search, {
3682
+ * searchQuery: "[revenue] by [region]",
3683
+ * dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"],
3684
+ * execute: true
3685
+ * }, ContextType.Search);
3686
+ * ```
3593
3687
  */
3594
3688
  Search = "search",
3595
3689
  /**
@@ -3640,6 +3734,24 @@ export declare enum HostEvent {
3640
3734
  * });
3641
3735
  * })
3642
3736
  * ```
3737
+ * @example
3738
+ * ```js
3739
+ * // Drill down from answer context
3740
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3741
+ * appEmbed.trigger(HostEvent.DrillDown, {
3742
+ * points: { clickedPoint, selectedPoints },
3743
+ * autoDrillDown: true
3744
+ * }, ContextType.Answer);
3745
+ * ```
3746
+ * @example
3747
+ * ```js
3748
+ * // Drill down from search context
3749
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3750
+ * searchEmbed.trigger(HostEvent.DrillDown, {
3751
+ * points: { clickedPoint, selectedPoints },
3752
+ * columnGuid: "column-guid"
3753
+ * }, ContextType.Search);
3754
+ * ```
3643
3755
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
3644
3756
  */
3645
3757
  DrillDown = "triggerDrillDown",
@@ -3660,6 +3772,13 @@ export declare enum HostEvent {
3660
3772
  * const url = embed.trigger(HostEvent.GetIframeUrl);
3661
3773
  * console.log("iFrameURL",url);
3662
3774
  * ```
3775
+ * @example
3776
+ * ```js
3777
+ * // Get iframe URL from specific context
3778
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3779
+ * const url = await appEmbed.trigger(HostEvent.GetIframeUrl, {}, ContextType.Answer);
3780
+ * console.log("iFrameURL", url);
3781
+ * ```
3663
3782
  * @version SDK: 1.35.0 | ThoughtSpot: 10.4.0.cl
3664
3783
  */
3665
3784
  GetIframeUrl = "GetIframeUrl",
@@ -3673,6 +3792,15 @@ export declare enum HostEvent {
3673
3792
  * '730496d6-6903-4601-937e-2c691821af3c',
3674
3793
  * 'd547ec54-2a37-4516-a222-2b06719af726'])
3675
3794
  * ```
3795
+ * @example
3796
+ * ```js
3797
+ * // Set visible vizs from liveboard context
3798
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3799
+ * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
3800
+ * '730496d6-6903-4601-937e-2c691821af3c',
3801
+ * 'd547ec54-2a37-4516-a222-2b06719af726'
3802
+ * ], ContextType.Liveboard);
3803
+ * ```
3676
3804
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
3677
3805
  */
3678
3806
  SetVisibleVizs = "SetPinboardVisibleVizs",
@@ -3685,6 +3813,14 @@ export declare enum HostEvent {
3685
3813
  * tabId:'730496d6-6903-4601-937e-2c691821af3c'
3686
3814
  * })
3687
3815
  * ```
3816
+ * @example
3817
+ * ```js
3818
+ * // Set active tab from liveboard context
3819
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3820
+ * liveboardEmbed.trigger(HostEvent.SetActiveTab, {
3821
+ * tabId: '730496d6-6903-4601-937e-2c691821af3c'
3822
+ * }, ContextType.Liveboard);
3823
+ * ```
3688
3824
  * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.1-sw
3689
3825
  */
3690
3826
  SetActiveTab = "SetActiveTab",
@@ -3718,6 +3854,15 @@ export declare enum HostEvent {
3718
3854
  * {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
3719
3855
  * ])
3720
3856
  * ```
3857
+ * @example
3858
+ * ```js
3859
+ * // Update runtime filters from liveboard context
3860
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3861
+ * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
3862
+ * {columnName: "region", operator: RuntimeFilterOp.EQ, values: ["west"]},
3863
+ * {columnName: "product", operator: RuntimeFilterOp.IN, values: ["shoes", "boots"]}
3864
+ * ], ContextType.Liveboard);
3865
+ * ```
3721
3866
  * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3722
3867
  * @important
3723
3868
  */
@@ -3751,6 +3896,14 @@ export declare enum HostEvent {
3751
3896
  * LiveboardEmbed.trigger(HostEvent.OpenFilter,
3752
3897
  * { column: {columnId: '<column-GUID>'}})
3753
3898
  * ```
3899
+ * @example
3900
+ * ```js
3901
+ * // Open filter from search context
3902
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3903
+ * searchEmbed.trigger(HostEvent.OpenFilter, {
3904
+ * column: { columnId: '<column-GUID>', name: 'region', type: 'ATTRIBUTE', dataType: 'CHAR'}
3905
+ * }, ContextType.Search);
3906
+ * ```
3754
3907
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3755
3908
  */
3756
3909
  OpenFilter = "openFilter",
@@ -3761,6 +3914,14 @@ export declare enum HostEvent {
3761
3914
  * ```js
3762
3915
  * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['<column-GUID>','<column-GUID>'] })
3763
3916
  * ```
3917
+ * @example
3918
+ * ```js
3919
+ * // Add columns from search context
3920
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3921
+ * searchEmbed.trigger(HostEvent.AddColumns, {
3922
+ * columnIds: ['col-guid-1', 'col-guid-2']
3923
+ * }, ContextType.Search);
3924
+ * ```
3764
3925
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3765
3926
  */
3766
3927
  AddColumns = "addColumns",
@@ -3771,6 +3932,14 @@ export declare enum HostEvent {
3771
3932
  * ```js
3772
3933
  * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '<column-Guid>' })
3773
3934
  * ```
3935
+ * @example
3936
+ * ```js
3937
+ * // Remove column from search context
3938
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
3939
+ * searchEmbed.trigger(HostEvent.RemoveColumn, {
3940
+ * columnId: 'column-guid'
3941
+ * }, ContextType.Search);
3942
+ * ```
3774
3943
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
3775
3944
  */
3776
3945
  RemoveColumn = "removeColumn",
@@ -3857,6 +4026,37 @@ export declare enum HostEvent {
3857
4026
  *
3858
4027
  * spotterEmbed.trigger(HostEvent.Pin, { vizId: latestSpotterVizId });
3859
4028
  * ```
4029
+ * @example
4030
+ * ```js
4031
+ * // Using context parameter to specify the context type (SDK: 1.45.2+)
4032
+ * // Pin from a search answer context
4033
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4034
+ * appEmbed.trigger(HostEvent.Pin, {
4035
+ * vizId: "123",
4036
+ * newVizName: "Sales by region",
4037
+ * liveboardId: "456"
4038
+ * }, ContextType.Search);
4039
+ * ```
4040
+ * @example
4041
+ * ```js
4042
+ * // Pin from an answer context (explore modal/page) (SDK: 1.45.2+)
4043
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4044
+ * appEmbed.trigger(HostEvent.Pin, {
4045
+ * vizId: "789",
4046
+ * newVizName: "Revenue trends",
4047
+ * liveboardId: "456"
4048
+ * }, ContextType.Answer);
4049
+ * ```
4050
+ * @example
4051
+ * ```js
4052
+ * // Pin from a spotter context (SDK: 1.45.2+)
4053
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4054
+ * appEmbed.trigger(HostEvent.Pin, {
4055
+ * vizId: latestSpotterVizId,
4056
+ * newVizName: "AI-generated insights",
4057
+ * liveboardId: "456"
4058
+ * }, ContextType.Spotter);
4059
+ * ```
3860
4060
  *
3861
4061
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3862
4062
  */
@@ -3867,6 +4067,12 @@ export declare enum HostEvent {
3867
4067
  * @example
3868
4068
  * ```js
3869
4069
  * liveboardEmbed.trigger(HostEvent.LiveboardInfo)
4070
+ *```
4071
+ * @example
4072
+ * ```js
4073
+ * // Show liveboard info from liveboard context
4074
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4075
+ * liveboardEmbed.trigger(HostEvent.LiveboardInfo, {}, ContextType.Liveboard);
3870
4076
  * ```
3871
4077
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3872
4078
  */
@@ -3877,6 +4083,12 @@ export declare enum HostEvent {
3877
4083
  * ```js
3878
4084
  * liveboardEmbed.trigger(HostEvent.Schedule)
3879
4085
  * ```
4086
+ * @example
4087
+ * ```js
4088
+ * // Schedule from liveboard context
4089
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4090
+ * liveboardEmbed.trigger(HostEvent.Schedule, {}, ContextType.Liveboard);
4091
+ * ```
3880
4092
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3881
4093
  */
3882
4094
  Schedule = "subscription",
@@ -3886,6 +4098,12 @@ export declare enum HostEvent {
3886
4098
  * ```js
3887
4099
  * liveboardEmbed.trigger(HostEvent.ScheduleList)
3888
4100
  * ```
4101
+ * @example
4102
+ * ```js
4103
+ * // Manage schedules from liveboard context
4104
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4105
+ * liveboardEmbed.trigger(HostEvent.ScheduleList, {}, ContextType.Liveboard);
4106
+ * ```
3889
4107
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3890
4108
  */
3891
4109
  SchedulesList = "schedule-list",
@@ -3896,6 +4114,18 @@ export declare enum HostEvent {
3896
4114
  * ```js
3897
4115
  * liveboardEmbed.trigger(HostEvent.ExportTML)
3898
4116
  * ```
4117
+ * @example
4118
+ * ```js
4119
+ * // Export TML from liveboard context
4120
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4121
+ * liveboardEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Liveboard);
4122
+ * ```
4123
+ * @example
4124
+ * ```js
4125
+ * // Export TML from search-answer context
4126
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4127
+ * appEmbed.trigger(HostEvent.ExportTML, {}, ContextType.Search);
4128
+ * ```
3899
4129
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3900
4130
  */
3901
4131
  ExportTML = "exportTSL",
@@ -3906,6 +4136,18 @@ export declare enum HostEvent {
3906
4136
  * ```js
3907
4137
  * liveboardEmbed.trigger(HostEvent.EditTML)
3908
4138
  * ```
4139
+ * @example
4140
+ * ```js
4141
+ * // Edit TML from liveboard context
4142
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4143
+ * liveboardEmbed.trigger(HostEvent.EditTML, {}, ContextType.Liveboard);
4144
+ * ```
4145
+ * @example
4146
+ * ```js
4147
+ * // Edit TML from search-answer context
4148
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4149
+ * appEmbed.trigger(HostEvent.EditTML, {}, ContextType.Search);
4150
+ * ```
3909
4151
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3910
4152
  */
3911
4153
  EditTML = "editTSL",
@@ -3915,6 +4157,12 @@ export declare enum HostEvent {
3915
4157
  * ```js
3916
4158
  * liveboardEmbed.trigger(HostEvent.UpdateTML)
3917
4159
  * ```
4160
+ * @example
4161
+ * ```js
4162
+ * // Update TML from liveboard context
4163
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4164
+ * liveboardEmbed.trigger(HostEvent.UpdateTML, {}, ContextType.Liveboard);
4165
+ * ```
3918
4166
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3919
4167
  */
3920
4168
  UpdateTML = "updateTSL",
@@ -3941,10 +4189,34 @@ export declare enum HostEvent {
3941
4189
  *
3942
4190
  * spotterEmbed.trigger(HostEvent.DownloadAsPdf, { vizId: latestSpotterVizId });
3943
4191
  * ```
4192
+ * @example
4193
+ * ```js
4194
+ * // Download as PDF from search-answer context
4195
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4196
+ * appEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Search);
4197
+ * ```
4198
+ * @example
4199
+ * ```js
4200
+ * // Download as PDF from liveboard context
4201
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4202
+ * liveboardEmbed.trigger(HostEvent.DownloadAsPdf, {}, ContextType.Liveboard);
4203
+ * ```
3944
4204
  *
3945
4205
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3946
4206
  */
3947
4207
  DownloadAsPdf = "downloadAsPdf",
4208
+ /**
4209
+ * Trigger the **Download Liveboard as Continuous PDF** action on an
4210
+ * embedded Liveboard.
4211
+ *
4212
+ * @example
4213
+ * ```js
4214
+ * liveboardEmbed.trigger(HostEvent.DownloadLiveboardAsContinuousPDF)
4215
+ * ```
4216
+ *
4217
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4218
+ */
4219
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
3948
4220
  /**
3949
4221
  * Trigger the **AI Highlights** action on an embedded Liveboard
3950
4222
  *
@@ -3985,6 +4257,18 @@ export declare enum HostEvent {
3985
4257
  *
3986
4258
  * spotterEmbed.trigger(HostEvent.MakeACopy, { vizId: latestSpotterVizId });
3987
4259
  * ```
4260
+ * @example
4261
+ * ```js
4262
+ * // Make a copy from answer context
4263
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4264
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Answer);
4265
+ * ```
4266
+ * @example
4267
+ * ```js
4268
+ * // Make a copy from search context
4269
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4270
+ * appEmbed.trigger(HostEvent.MakeACopy, {}, ContextType.Search);
4271
+ * ```
3988
4272
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3989
4273
  */
3990
4274
  MakeACopy = "makeACopy",
@@ -4009,6 +4293,14 @@ export declare enum HostEvent {
4009
4293
  * ```js
4010
4294
  * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
4011
4295
  * ```
4296
+ * @example
4297
+ * ```js
4298
+ * // Explore from liveboard context
4299
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4300
+ * liveboardEmbed.trigger(HostEvent.Explore, {
4301
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4302
+ * }, ContextType.Liveboard);
4303
+ * ```
4012
4304
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4013
4305
  */
4014
4306
  Explore = "explore",
@@ -4026,6 +4318,20 @@ export declare enum HostEvent {
4026
4318
  * ```js
4027
4319
  * searchEmbed.trigger(HostEvent.CreateMonitor)
4028
4320
  * ```
4321
+ * @example
4322
+ * ```js
4323
+ * // Create monitor from answer context
4324
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4325
+ * appEmbed.trigger(HostEvent.CreateMonitor, {}, ContextType.Answer);
4326
+ * ```
4327
+ * @example
4328
+ * ```js
4329
+ * // Create monitor from liveboard context
4330
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4331
+ * liveboardEmbed.trigger(HostEvent.CreateMonitor, {
4332
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4333
+ * }, ContextType.Liveboard);
4334
+ * ```
4029
4335
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4030
4336
  */
4031
4337
  CreateMonitor = "createMonitor",
@@ -4047,6 +4353,20 @@ export declare enum HostEvent {
4047
4353
  * ```js
4048
4354
  * vizEmbed.trigger(HostEvent.ManageMonitor)
4049
4355
  * ```
4356
+ * @example
4357
+ * ```js
4358
+ * // Manage monitor from answer context
4359
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4360
+ * appEmbed.trigger(HostEvent.ManageMonitor, {}, ContextType.Answer);
4361
+ * ```
4362
+ * @example
4363
+ * ```js
4364
+ * // Manage monitor from liveboard context
4365
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4366
+ * liveboardEmbed.trigger(HostEvent.ManageMonitor, {
4367
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4368
+ * }, ContextType.Liveboard);
4369
+ * ```
4050
4370
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4051
4371
  */
4052
4372
  ManageMonitor = "manageMonitor",
@@ -4072,6 +4392,26 @@ export declare enum HostEvent {
4072
4392
  * ```js
4073
4393
  * spotterEmbed.trigger(HostEvent.Edit);
4074
4394
  * ```
4395
+ * @example
4396
+ * ```js
4397
+ * // Using context parameter to edit liveboard context
4398
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4399
+ * liveboardEmbed.trigger(HostEvent.Edit, {}, ContextType.Liveboard);
4400
+ * ```
4401
+ * @example
4402
+ * ```js
4403
+ * // Edit from search context
4404
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4405
+ * appEmbed.trigger(HostEvent.Edit, {}, ContextType.Search);
4406
+ * ```
4407
+ * * @example
4408
+ * ```js
4409
+ * // Edit from spotter context
4410
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4411
+ * appEmbed.trigger(HostEvent.Edit, {
4412
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4413
+ * }, ContextType.Spotter);
4414
+ * ```
4075
4415
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4076
4416
  */
4077
4417
  Edit = "edit",
@@ -4089,6 +4429,34 @@ export declare enum HostEvent {
4089
4429
  * ```js
4090
4430
  * vizEmbed.trigger(HostEvent.CopyLink)
4091
4431
  * ```
4432
+ * @example
4433
+ * ```js
4434
+ * // Copy link from liveboard context
4435
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4436
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
4437
+ * ```
4438
+ * @example
4439
+ * ```js
4440
+ * // Copy link from liveboard visualization context
4441
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4442
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
4443
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4444
+ * }, ContextType.Liveboard);
4445
+ * ```
4446
+ * @example
4447
+ * ```js
4448
+ * // Copy link from liveboard context
4449
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4450
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {}, ContextType.Liveboard);
4451
+ * ```
4452
+ * @example
4453
+ * ```js
4454
+ * // Copy link from liveboard visualization context
4455
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4456
+ * liveboardEmbed.trigger(HostEvent.CopyLink, {
4457
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4458
+ * }, ContextType.Liveboard);
4459
+ * ```
4092
4460
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4093
4461
  */
4094
4462
  CopyLink = "embedDocument",
@@ -4106,6 +4474,34 @@ export declare enum HostEvent {
4106
4474
  * ```js
4107
4475
  * vizEmbed.trigger(HostEvent.Present)
4108
4476
  * ```
4477
+ * @example
4478
+ * ```js
4479
+ * // Present from liveboard visualization context
4480
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4481
+ * liveboardEmbed.trigger(HostEvent.Present, {
4482
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4483
+ * }, ContextType.Liveboard);
4484
+ * ```
4485
+ * @example
4486
+ * ```js
4487
+ * // Present from liveboard context
4488
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4489
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
4490
+ * ```
4491
+ * @example
4492
+ * ```js
4493
+ * // Present from liveboard visualization context
4494
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4495
+ * liveboardEmbed.trigger(HostEvent.Present, {
4496
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4497
+ * }, ContextType.Liveboard);
4498
+ * ```
4499
+ * @example
4500
+ * ```js
4501
+ * // Present from liveboard context
4502
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4503
+ * liveboardEmbed.trigger(HostEvent.Present, {}, ContextType.Liveboard);
4504
+ * ```
4109
4505
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4110
4506
  */
4111
4507
  Present = "present",
@@ -4134,6 +4530,22 @@ export declare enum HostEvent {
4134
4530
  * tml.answer.search_query // TML representation of the search query
4135
4531
  * );
4136
4532
  * })
4533
+ * ```
4534
+ * @example
4535
+ * ```js
4536
+ * // Get TML from search context
4537
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4538
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
4539
+ * console.log(tml.answer.search_query);
4540
+ * });
4541
+ * ```
4542
+ * @example
4543
+ * ```js
4544
+ * // Get TML from search-answer context
4545
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4546
+ * appEmbed.trigger(HostEvent.GetTML, {}, ContextType.Search).then((tml) => {
4547
+ * console.log(tml.answer);
4548
+ * });
4137
4549
  * ```
4138
4550
  * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1.sw
4139
4551
  * @important
@@ -4155,6 +4567,20 @@ export declare enum HostEvent {
4155
4567
  * ```js
4156
4568
  * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
4157
4569
  * ```
4570
+ * @example
4571
+ * ```js
4572
+ * // Show underlying data from liveboard visualization context
4573
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4574
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {
4575
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4576
+ * }, ContextType.Liveboard);
4577
+ * ```
4578
+ * @example
4579
+ * ```js
4580
+ * // Show underlying data from search context
4581
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4582
+ * appEmbed.trigger(HostEvent.ShowUnderlyingData, {}, ContextType.Search);
4583
+ * ```
4158
4584
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4159
4585
  */
4160
4586
  ShowUnderlyingData = "showUnderlyingData",
@@ -4172,6 +4598,18 @@ export declare enum HostEvent {
4172
4598
  * ```js
4173
4599
  * searchEmbed.trigger(HostEvent.Delete)
4174
4600
  * ```
4601
+ * @example
4602
+ * ```js
4603
+ * // Delete from liveboard context
4604
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4605
+ * liveboardEmbed.trigger(HostEvent.Delete, {}, ContextType.Liveboard);
4606
+ * ```
4607
+ * @example
4608
+ * ```js
4609
+ * // Delete from search context
4610
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4611
+ * appEmbed.trigger(HostEvent.Delete, {}, ContextType.Search);
4612
+ * ```
4175
4613
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4176
4614
  */
4177
4615
  Delete = "onDeleteAnswer",
@@ -4192,6 +4630,20 @@ export declare enum HostEvent {
4192
4630
  * ```js
4193
4631
  * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
4194
4632
  * ```
4633
+ * @example
4634
+ * ```js
4635
+ * // SpotIQ analyze from search-answer context
4636
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4637
+ * appEmbed.trigger(HostEvent.SpotIQAnalyze, { vizId: '730496d6-6903-4601-937e-2c691821af3c' }, ContextType.Search);
4638
+ * ```
4639
+ * @example
4640
+ * ```js
4641
+ * // SpotIQ analyze from search context
4642
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4643
+ * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {
4644
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4645
+ * }, ContextType.Liveboard);
4646
+ * ```
4195
4647
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4196
4648
  */
4197
4649
  SpotIQAnalyze = "spotIQAnalyze",
@@ -4243,6 +4695,12 @@ export declare enum HostEvent {
4243
4695
  *
4244
4696
  * spotterEmbed.trigger(HostEvent.DownloadAsPng, { vizId: latestSpotterVizId });
4245
4697
  * ```
4698
+ * @example
4699
+ * ```js
4700
+ * // Download as PNG from search-answer context
4701
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4702
+ * appEmbed.trigger(HostEvent.DownloadAsPng, {}, ContextType.Search);
4703
+ * ```
4246
4704
  *
4247
4705
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1.sw
4248
4706
  */
@@ -4271,6 +4729,18 @@ export declare enum HostEvent {
4271
4729
  *
4272
4730
  * spotterEmbed.trigger(HostEvent.DownloadAsCsv, { vizId: latestSpotterVizId });
4273
4731
  * ```
4732
+ * @example
4733
+ * ```js
4734
+ * // Download as CSV from search-answer context
4735
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4736
+ * appEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
4737
+ * ```
4738
+ * @example
4739
+ * ```js
4740
+ * // Download as CSV from search context
4741
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4742
+ * searchEmbed.trigger(HostEvent.DownloadAsCsv, {}, ContextType.Search);
4743
+ * ```
4274
4744
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4275
4745
  */
4276
4746
  DownloadAsCsv = "downloadAsCSV",
@@ -4298,6 +4768,18 @@ export declare enum HostEvent {
4298
4768
  *
4299
4769
  * spotterEmbed.trigger(HostEvent.DownloadAsXlsx, { vizId: latestSpotterVizId });
4300
4770
  * ```
4771
+ * @example
4772
+ * ```js
4773
+ * // Download as XLSX from answer context
4774
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4775
+ * appEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Answer);
4776
+ * ```
4777
+ * @example
4778
+ * ```js
4779
+ * // Download as XLSX from search context
4780
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4781
+ * searchEmbed.trigger(HostEvent.DownloadAsXlsx, {}, ContextType.Search);
4782
+ * ```
4301
4783
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4302
4784
  */
4303
4785
  DownloadAsXlsx = "downloadAsXLSX",
@@ -4311,6 +4793,18 @@ export declare enum HostEvent {
4311
4793
  * ```js
4312
4794
  * searchEmbed.trigger(HostEvent.Share)
4313
4795
  * ```
4796
+ * @example
4797
+ * ```js
4798
+ * // Share from Liveboard context
4799
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4800
+ * liveboardEmbed.trigger(HostEvent.Share, {}, ContextType.Liveboard);
4801
+ * ```
4802
+ * @example
4803
+ * ```js
4804
+ * // Share from search-answer context
4805
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4806
+ * appEmbed.trigger(HostEvent.Share, {}, ContextType.Search);
4807
+ * ```
4314
4808
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4315
4809
  */
4316
4810
  Share = "share",
@@ -4350,6 +4844,18 @@ export declare enum HostEvent {
4350
4844
  *
4351
4845
  * spotterEmbed.trigger(HostEvent.Save, { vizId: latestSpotterVizId });
4352
4846
  * ```
4847
+ * @example
4848
+ * ```js
4849
+ * // Save from answer context
4850
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4851
+ * appEmbed.trigger(HostEvent.Save, {}, ContextType.Answer);
4852
+ * ```
4853
+ * @example
4854
+ * ```js
4855
+ * // Save from search context
4856
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4857
+ * searchEmbed.trigger(HostEvent.Save, {}, ContextType.Search);
4858
+ * ```
4353
4859
  *
4354
4860
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4355
4861
  */
@@ -4366,6 +4872,20 @@ export declare enum HostEvent {
4366
4872
  * ```js
4367
4873
  * vizEmbed.trigger(HostEvent.SyncToSheets)
4368
4874
  * ```
4875
+ * @example
4876
+ * ```js
4877
+ * // Sync to sheets from answer context
4878
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4879
+ * appEmbed.trigger(HostEvent.SyncToSheets, {}, ContextType.Answer);
4880
+ * ```
4881
+ * @example
4882
+ * ```js
4883
+ * // Sync to sheets from liveboard context
4884
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4885
+ * liveboardEmbed.trigger(HostEvent.SyncToSheets, {
4886
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4887
+ * }, ContextType.Liveboard);
4888
+ * ```
4369
4889
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4370
4890
  */
4371
4891
  SyncToSheets = "sync-to-sheets",
@@ -4382,6 +4902,20 @@ export declare enum HostEvent {
4382
4902
  * ```js
4383
4903
  * vizEmbed.trigger(HostEvent.SyncToOtherApps)
4384
4904
  * ```
4905
+ * @example
4906
+ * ```js
4907
+ * // Sync to other apps from answer context
4908
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4909
+ * appEmbed.trigger(HostEvent.SyncToOtherApps, {}, ContextType.Answer);
4910
+ * ```
4911
+ * @example
4912
+ * ```js
4913
+ * // Sync to other apps from liveboard context
4914
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4915
+ * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {
4916
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4917
+ * }, ContextType.Liveboard);
4918
+ * ```
4385
4919
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4386
4920
  */
4387
4921
  SyncToOtherApps = "sync-to-other-apps",
@@ -4398,6 +4932,20 @@ export declare enum HostEvent {
4398
4932
  * ```js
4399
4933
  * vizEmbed.trigger(HostEvent.ManagePipelines)
4400
4934
  * ```
4935
+ * @example
4936
+ * ```js
4937
+ * // Manage pipelines from answer context
4938
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4939
+ * appEmbed.trigger(HostEvent.ManagePipelines, {}, ContextType.Answer);
4940
+ * ```
4941
+ * @example
4942
+ * ```js
4943
+ * // Manage pipelines from liveboard context
4944
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4945
+ * liveboardEmbed.trigger(HostEvent.ManagePipelines, {
4946
+ * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4947
+ * }, ContextType.Liveboard);
4948
+ * ```
4401
4949
  * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
4402
4950
  */
4403
4951
  ManagePipelines = "manage-pipeline",
@@ -4410,6 +4958,12 @@ export declare enum HostEvent {
4410
4958
  * ```js
4411
4959
  * appEmbed.trigger(HostEvent.ResetSearch)
4412
4960
  * ```
4961
+ * @example
4962
+ * ```js
4963
+ * // Reset search from search context
4964
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4965
+ * searchEmbed.trigger(HostEvent.ResetSearch, {}, ContextType.Search);
4966
+ * ```
4413
4967
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1.sw
4414
4968
  */
4415
4969
  ResetSearch = "resetSearch",
@@ -4421,6 +4975,13 @@ export declare enum HostEvent {
4421
4975
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
4422
4976
  * console.log('data', data);
4423
4977
  * ```
4978
+ * @example
4979
+ * ```js
4980
+ * // Get filters from liveboard context
4981
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
4982
+ * const data = await liveboardEmbed.trigger(HostEvent.GetFilters, {}, ContextType.Liveboard);
4983
+ * console.log('filters', data);
4984
+ * ```
4424
4985
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
4425
4986
  */
4426
4987
  GetFilters = "getFilters",
@@ -4428,7 +4989,8 @@ export declare enum HostEvent {
4428
4989
  * Update one or several filters applied on a Liveboard.
4429
4990
  * @param - Includes the following keys:
4430
4991
  * - `filter`: A single filter object containing column name, filter operator, and
4431
- * values. - `filters`: Multiple filter objects with column name, filter operator,
4992
+ * values.
4993
+ * - `filters`: Multiple filter objects with column name, filter operator,
4432
4994
  * and values for each.
4433
4995
  *
4434
4996
  * Each filter object must include the following attributes:
@@ -4511,6 +5073,18 @@ export declare enum HostEvent {
4511
5073
  * }]
4512
5074
  * });
4513
5075
  * ```
5076
+ * @example
5077
+ * ```js
5078
+ * // Update filters from liveboard context
5079
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5080
+ * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
5081
+ * filter: {
5082
+ * column: "item type",
5083
+ * oper: "IN",
5084
+ * values: ["shoes", "boots"]
5085
+ * }
5086
+ * }, ContextType.Liveboard);
5087
+ * ```
4514
5088
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
4515
5089
  */
4516
5090
  UpdateFilters = "updateFilters",
@@ -4524,6 +5098,14 @@ export declare enum HostEvent {
4524
5098
  * );
4525
5099
  * })
4526
5100
  * ```
5101
+ * @example
5102
+ * ```js
5103
+ * // Get tabs from liveboard context
5104
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5105
+ * liveboardEmbed.trigger(HostEvent.GetTabs, {}, ContextType.Liveboard).then((tabDetails) => {
5106
+ * console.log('tabs', tabDetails);
5107
+ * });
5108
+ * ```
4527
5109
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl
4528
5110
  */
4529
5111
  GetTabs = "getTabs",
@@ -4537,6 +5119,15 @@ export declare enum HostEvent {
4537
5119
  * '430496d6-6903-4601-937e-2c691821af3c',
4538
5120
  * 'f547ec54-2a37-4516-a222-2b06719af726'])
4539
5121
  * ```
5122
+ * @example
5123
+ * ```js
5124
+ * // Set visible tabs from liveboard context
5125
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5126
+ * liveboardEmbed.trigger(HostEvent.SetVisibleTabs, [
5127
+ * '430496d6-6903-4601-937e-2c691821af3c',
5128
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
5129
+ * ], ContextType.Liveboard);
5130
+ * ```
4540
5131
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4541
5132
  */
4542
5133
  SetVisibleTabs = "SetPinboardVisibleTabs",
@@ -4550,6 +5141,15 @@ export declare enum HostEvent {
4550
5141
  * '630496d6-6903-4601-937e-2c691821af3c',
4551
5142
  * 'i547ec54-2a37-4516-a222-2b06719af726'])
4552
5143
  * ```
5144
+ * @example
5145
+ * ```js
5146
+ * // Set hidden tabs from liveboard context
5147
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5148
+ * liveboardEmbed.trigger(HostEvent.SetHiddenTabs, [
5149
+ * '630496d6-6903-4601-937e-2c691821af3c',
5150
+ * 'i547ec54-2a37-4516-a222-2b06719af726'
5151
+ * ], ContextType.Liveboard);
5152
+ * ```
4553
5153
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
4554
5154
  */
4555
5155
  SetHiddenTabs = "SetPinboardHiddenTabs",
@@ -4626,13 +5226,24 @@ export declare enum HostEvent {
4626
5226
  UpdateCrossFilter = "UpdateCrossFilter",
4627
5227
  /**
4628
5228
  * Trigger reset action for a personalized Liveboard view.
5229
+ * This event is deprecated. Use {@link HostEvent.ResetLiveboardPersonalizedView} instead.
4629
5230
  * @example
4630
5231
  * ```js
4631
5232
  * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
4632
5233
  * ```
4633
5234
  * @version SDK: 1.29.0 | ThoughtSpot Cloud: 10.1.0.cl, 10.1.0.sw
5235
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4634
5236
  */
4635
5237
  ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
5238
+ /**
5239
+ * Trigger reset action for a personalized Liveboard view.
5240
+ * @example
5241
+ * ```js
5242
+ * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalizedView);
5243
+ * ```
5244
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5245
+ */
5246
+ ResetLiveboardPersonalizedView = "ResetLiveboardPersonalisedView",
4636
5247
  /**
4637
5248
  * Triggers an action to update Parameter values on embedded
4638
5249
  * Answers, Liveboard, and Spotter answer in Edit mode.
@@ -4649,6 +5260,16 @@ export declare enum HostEvent {
4649
5260
  * isVisibleToUser: false
4650
5261
  * }])
4651
5262
  * ```
5263
+ * @example
5264
+ * ```js
5265
+ * // Update parameters from liveboard context
5266
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5267
+ * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
5268
+ * name: "Region Param",
5269
+ * value: "West",
5270
+ * isVisibleToUser: true
5271
+ * }], ContextType.Liveboard);
5272
+ * ```
4652
5273
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4653
5274
  */
4654
5275
  UpdateParameters = "UpdateParameters",
@@ -4668,18 +5289,77 @@ export declare enum HostEvent {
4668
5289
  * });
4669
5290
  *
4670
5291
  * spotterEmbed.trigger(HostEvent.GetParameters, { vizId: latestSpotterVizId });
5292
+ *```
5293
+ * @example
5294
+ * ```js
5295
+ * // Get parameters from liveboard context
5296
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5297
+ * liveboardEmbed.trigger(HostEvent.GetParameters, {}, ContextType.Liveboard).then((parameters) => {
5298
+ * console.log('parameters', parameters);
5299
+ * });
4671
5300
  * ```
4672
5301
  * @version SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl, 10.1.0.sw
4673
5302
  */
4674
5303
  GetParameters = "GetParameters",
4675
5304
  /**
4676
5305
  * Triggers an event to update a personalized view of a Liveboard.
5306
+ * This event is deprecated. Use {@link HostEvent.UpdatePersonalizedView} instead.
4677
5307
  * ```js
4678
5308
  * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
4679
5309
  * ```
5310
+ * @example
5311
+ * ```js
5312
+ * // Update personalized view from liveboard context
5313
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5314
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {
5315
+ * viewId: '1234'
5316
+ * }, ContextType.Liveboard);
5317
+ * ```
4680
5318
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5319
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
4681
5320
  */
4682
5321
  UpdatePersonalisedView = "UpdatePersonalisedView",
5322
+ /**
5323
+ * Triggers an event to update a personalized view of a Liveboard.
5324
+ * ```js
5325
+ * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
5326
+ * ```
5327
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5328
+ */
5329
+ UpdatePersonalizedView = "UpdatePersonalisedView",
5330
+ /**
5331
+ * Triggers selection of a specific Personalized View on a
5332
+ * Liveboard without reloading the embed. Pass either a
5333
+ * `viewId` (GUID) or `viewName`. If both are provided, `viewId` takes precedence.
5334
+ * If neither is provided, the Liveboard resets to the original/default view.
5335
+ * When a `viewName` is provided and multiple views share
5336
+ * the same name, the first match is selected.
5337
+ * @example
5338
+ * ```js
5339
+ * liveboardEmbed.trigger(
5340
+ * HostEvent.SelectPersonalizedView,
5341
+ * { viewId: '2a021a12-1aed-425d-984b-141ee916ce72' },
5342
+ * )
5343
+ * ```
5344
+ * @example
5345
+ * ```js
5346
+ * // Select by name
5347
+ * liveboardEmbed.trigger(
5348
+ * HostEvent.SelectPersonalizedView,
5349
+ * { viewName: 'Dr Smith Cardiology' },
5350
+ * )
5351
+ * ```
5352
+ * @example
5353
+ * ```js
5354
+ * // Reset to default view
5355
+ * liveboardEmbed.trigger(
5356
+ * HostEvent.SelectPersonalizedView,
5357
+ * {},
5358
+ * )
5359
+ * ```
5360
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5361
+ */
5362
+ SelectPersonalizedView = "SelectPersonalisedView",
4683
5363
  /**
4684
5364
  * @hidden
4685
5365
  * Notify when info call is completed successfully
@@ -4699,7 +5379,8 @@ export declare enum HostEvent {
4699
5379
  * add a name and description for the Answer.
4700
5380
  * @param - Includes the following keys:
4701
5381
  * - `vizId`: Refers to the Answer ID in Spotter embed and is **required** in Spotter
4702
- * embed. - `name`: Optional. Name string for the Answer.
5382
+ * embed.
5383
+ * - `name`: Optional. Name string for the Answer.
4703
5384
  * - `description`: Optional. Description text for the Answer.
4704
5385
  * @example
4705
5386
  * ```js
@@ -4718,6 +5399,34 @@ export declare enum HostEvent {
4718
5399
  *
4719
5400
  * spotterEmbed.trigger(HostEvent.SaveAnswer, { vizId: latestSpotterVizId });
4720
5401
  * ```
5402
+ * @example
5403
+ * ```js
5404
+ * // Using context parameter to save answer from search context
5405
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5406
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
5407
+ * name: "Regional sales analysis",
5408
+ * description: "Sales breakdown by region"
5409
+ * }, ContextType.Search);
5410
+ * ```
5411
+ * @example
5412
+ * ```js
5413
+ * // Save answer from answer context (explore modal)
5414
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5415
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
5416
+ * name: "Modified analysis",
5417
+ * description: "Updated from explore view"
5418
+ * }, ContextType.Answer);
5419
+ * ```
5420
+ * @example
5421
+ * ```js
5422
+ * // Save answer from spotter context
5423
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5424
+ * const saveAnswerResponse = await appEmbed.trigger(HostEvent.SaveAnswer, {
5425
+ * vizId: latestSpotterVizId,
5426
+ * name: "AI insights",
5427
+ * description: "Generated from Spotter"
5428
+ * }, ContextType.Spotter);
5429
+ * ```
4721
5430
  * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
4722
5431
  */
4723
5432
  SaveAnswer = "saveAnswer",
@@ -4759,6 +5468,15 @@ export declare enum HostEvent {
4759
5468
  * executeSearch: true,
4760
5469
  * })
4761
5470
  * ```
5471
+ * @example
5472
+ * ```js
5473
+ * // Spotter search from spotter context
5474
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5475
+ * spotterEmbed.trigger(HostEvent.SpotterSearch, {
5476
+ * query: 'sales by region',
5477
+ * executeSearch: true
5478
+ * }, ContextType.Spotter);
5479
+ * ```
4762
5480
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4763
5481
  */
4764
5482
  SpotterSearch = "SpotterSearch",
@@ -4769,6 +5487,12 @@ export declare enum HostEvent {
4769
5487
  * ```js
4770
5488
  * spotterEmbed.trigger(HostEvent.EditLastPrompt, "revenue per year");
4771
5489
  * ```
5490
+ * @example
5491
+ * ```js
5492
+ * // Edit last prompt from spotter context
5493
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5494
+ * spotterEmbed.trigger(HostEvent.EditLastPrompt, "sales by region", ContextType.Spotter);
5495
+ * ```
4772
5496
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4773
5497
  */
4774
5498
  EditLastPrompt = "EditLastPrompt",
@@ -4778,6 +5502,12 @@ export declare enum HostEvent {
4778
5502
  * ```js
4779
5503
  * spotterEmbed.trigger(HostEvent.PreviewSpotterData);
4780
5504
  * ```
5505
+ * @example
5506
+ * ```js
5507
+ * // Preview spotter data from spotter context
5508
+ * import { ContextType } from '@thoughtspot/visual-embed-sdk';
5509
+ * spotterEmbed.trigger(HostEvent.PreviewSpotterData, {}, ContextType.Spotter);
5510
+ * ```
4781
5511
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
4782
5512
  */
4783
5513
  PreviewSpotterData = "PreviewSpotterData",
@@ -5060,6 +5790,7 @@ export declare enum Param {
5060
5790
  IsLazyLoadingForEmbedEnabled = "isLazyLoadingForEmbedEnabled",
5061
5791
  RootMarginForLazyLoad = "rootMarginForLazyLoad",
5062
5792
  isPNGInScheduledEmailsEnabled = "isPNGInScheduledEmailsEnabled",
5793
+ IsWYSIWYGLiveboardPDFEnabled = "isWYSIWYGLiveboardPDFEnabled",
5063
5794
  isLiveboardXLSXCSVDownloadEnabled = "isLiveboardXLSXCSVDownloadEnabled",
5064
5795
  isGranularXLSXCSVSchedulesEnabled = "isGranularXLSXCSVSchedulesEnabled",
5065
5796
  isCentralizedLiveboardFilterUXEnabled = "isCentralizedLiveboardFilterUXEnabled",
@@ -5403,6 +6134,16 @@ export declare enum Action {
5403
6134
  * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
5404
6135
  */
5405
6136
  DownloadLiveboard = "downloadLiveboard",
6137
+ /**
6138
+ * The **Download Liveboard as Continuous PDF** menu action on a Liveboard.
6139
+ * Allows downloading the entire Liveboard as a continuous PDF.
6140
+ * @example
6141
+ * ```js
6142
+ * disabledActions: [Action.DownloadLiveboardAsContinuousPDF]
6143
+ * ```
6144
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6145
+ */
6146
+ DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
5406
6147
  /**
5407
6148
  * @hidden
5408
6149
  */
@@ -6036,13 +6777,25 @@ export declare enum Action {
6036
6777
  /**
6037
6778
  * The Liveboard Personalised Views dropdown.
6038
6779
  * Allows navigating to a personalized Liveboard View.
6780
+ * This action is deprecated. Use {@link Action.PersonalizedViewsDropdown} instead.
6039
6781
  * @example
6040
6782
  * ```js
6041
6783
  * disabledActions: [Action.PersonalisedViewsDropdown]
6042
6784
  * ```
6043
6785
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 10.1.0.sw
6786
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6044
6787
  */
6045
6788
  PersonalisedViewsDropdown = "personalisedViewsDropdown",
6789
+ /**
6790
+ * The Liveboard Personalized Views dropdown.
6791
+ * Allows navigating to a personalized Liveboard View.
6792
+ * @example
6793
+ * ```js
6794
+ * disabledActions: [Action.PersonalizedViewsDropdown]
6795
+ * ```
6796
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6797
+ */
6798
+ PersonalizedViewsDropdown = "personalisedViewsDropdown",
6046
6799
  /**
6047
6800
  * Action ID for show or hide the user details on a
6048
6801
  * Liveboard (Recently visited / social proof)
@@ -6130,14 +6883,27 @@ export declare enum Action {
6130
6883
  /**
6131
6884
  * The **Organize Favourites** action on Homepage
6132
6885
  * *Favorites* module.
6886
+ * This action is deprecated. Use {@link Action.OrganizeFavorites} instead.
6133
6887
  *
6134
6888
  * @example
6135
6889
  * ```js
6136
6890
  * disabledActions: [Action.OrganiseFavourites]
6137
6891
  * ```
6138
6892
  * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
6893
+ * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6139
6894
  */
6140
6895
  OrganiseFavourites = "organiseFavourites",
6896
+ /**
6897
+ * The **Organize Favorites** action on Homepage
6898
+ * *Favorites* module.
6899
+ *
6900
+ * @example
6901
+ * ```js
6902
+ * disabledActions: [Action.OrganizeFavorites]
6903
+ * ```
6904
+ * @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
6905
+ */
6906
+ OrganizeFavorites = "organiseFavourites",
6141
6907
  /**
6142
6908
  * The **AI Highlights** action on a Liveboard.
6143
6909
  *
@@ -6593,6 +7359,39 @@ export declare enum Action {
6593
7359
  * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6594
7360
  */
6595
7361
  SpotterDocs = "spotterDocs",
7362
+ /**
7363
+ * Controls visibility and disable state of the connector resources
7364
+ * section in the Spotter chat interface.
7365
+ * @example
7366
+ * ```js
7367
+ * hiddenActions: [Action.SpotterChatConnectorResources]
7368
+ * disabledActions: [Action.SpotterChatConnectorResources]
7369
+ * ```
7370
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
7371
+ */
7372
+ SpotterChatConnectorResources = "spotterChatConnectorResources",
7373
+ /**
7374
+ * Controls visibility and disable state of the connectors
7375
+ * in the Spotter chat interface.
7376
+ * @example
7377
+ * ```js
7378
+ * hiddenActions: [Action.SpotterChatConnectors]
7379
+ * disabledActions: [Action.SpotterChatConnectors]
7380
+ * ```
7381
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
7382
+ */
7383
+ SpotterChatConnectors = "spotterChatConnectors",
7384
+ /**
7385
+ * Controls visibility and disable state of the mode switcher
7386
+ * in the Spotter chat interface.
7387
+ * @example
7388
+ * ```js
7389
+ * hiddenActions: [Action.SpotterChatModeSwitcher]
7390
+ * disabledActions: [Action.SpotterChatModeSwitcher]
7391
+ * ```
7392
+ * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
7393
+ */
7394
+ SpotterChatModeSwitcher = "spotterChatModeSwitcher",
6596
7395
  /**
6597
7396
  * The **Include current period** checkbox for date filters.
6598
7397
  * Controls the visibility and availability of the option to include
@@ -6939,7 +7738,13 @@ export declare enum EmbedErrorCodes {
6939
7738
  /** Failed to update embed parameters during pre-render */
6940
7739
  UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
6941
7740
  /** Invalid URL provided in configuration */
6942
- INVALID_URL = "INVALID_URL"
7741
+ INVALID_URL = "INVALID_URL",
7742
+ /** Host event payload validation failed */
7743
+ HOST_EVENT_VALIDATION = "HOST_EVENT_VALIDATION",
7744
+ /** UpdateFilters payload is invalid - missing or malformed filter/filters */
7745
+ UPDATEFILTERS_INVALID_PAYLOAD = "UPDATEFILTERS_INVALID_PAYLOAD",
7746
+ /** DrillDown payload is invalid - missing or malformed points */
7747
+ DRILLDOWN_INVALID_PAYLOAD = "DRILLDOWN_INVALID_PAYLOAD"
6943
7748
  }
6944
7749
  /**
6945
7750
  * Error event object emitted when an error occurs in an embedded component.
@@ -6952,7 +7757,8 @@ export declare enum EmbedErrorCodes {
6952
7757
  *
6953
7758
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
6954
7759
  * - **message**: Human-readable error description (string or array of strings for
6955
- * multiple errors) - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
7760
+ * multiple errors)
7761
+ * - **code**: Machine-readable error identifier {@link EmbedErrorCodes}
6956
7762
  * values
6957
7763
  * - **[key: string]**: Additional context-specific for backward compatibility
6958
7764
  *
@@ -7000,6 +7806,22 @@ export interface EmbedErrorDetailsEvent {
7000
7806
  /** Additional context-specific for backward compatibility */
7001
7807
  [key: string]: any;
7002
7808
  }
7809
+ /**
7810
+ * Context types for specifying the page context when triggering host events.
7811
+ * Used as the third parameter in the `trigger` method to help ThoughtSpot
7812
+ * understand the current page context for better event handling.
7813
+ *
7814
+ * @example
7815
+ * ```js
7816
+ * import { HostEvent, ContextType } from '@thoughtspot/visual-embed-sdk';
7817
+ *
7818
+ * // Trigger an event with specific context
7819
+ * embed.trigger(HostEvent.Pin, { vizId: "123", liveboardId: "456" }, ContextType.Search);
7820
+ * ```
7821
+ *
7822
+ * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
7823
+ * @group Events
7824
+ */
7003
7825
  export declare enum ContextType {
7004
7826
  /**
7005
7827
  * Search answer context for search page or edit viz dialog on liveboard page.
@@ -7016,7 +7838,11 @@ export declare enum ContextType {
7016
7838
  /**
7017
7839
  * Spotter context for spotter modal/page.
7018
7840
  */
7019
- Spotter = "spotter"
7841
+ Spotter = "spotter",
7842
+ /**
7843
+ * Other context for any other generic page.
7844
+ */
7845
+ Other = "other"
7020
7846
  }
7021
7847
  export interface DefaultAppInitData {
7022
7848
  customisations: CustomisationsInterface;
@@ -7119,33 +7945,6 @@ export interface ObjectIds {
7119
7945
  */
7120
7946
  modalTitle?: string;
7121
7947
  }
7122
- /**
7123
- * Context object for the embedded component.
7124
- * @example
7125
- * ```js
7126
- * const context = await embed.getCurrentContext();
7127
- * console.log(context);
7128
- * {
7129
- * stack: [
7130
- * {
7131
- * name: 'Liveboard',
7132
- * type: ContextType.Liveboard,
7133
- * objectIds: {
7134
- * liveboardId: '123',
7135
- * },
7136
- * },
7137
- * ],
7138
- * currentContext: {
7139
- * name: 'Liveboard',
7140
- * type: ContextType.Liveboard,
7141
- * objectIds: {
7142
- * liveboardId: '123',
7143
- * },
7144
- * },
7145
- * }
7146
- * ```
7147
- * @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
7148
- */
7149
7948
  export interface ContextObject {
7150
7949
  /**
7151
7950
  * Stack of context objects.