@thoughtspot/visual-embed-sdk 1.44.2 → 1.44.4-HE-beta.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 (213) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +1 -1
  3. package/cjs/src/embed/app.d.ts +44 -32
  4. package/cjs/src/embed/app.d.ts.map +1 -1
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/base.d.ts +1 -1
  7. package/cjs/src/embed/base.d.ts.map +1 -1
  8. package/cjs/src/embed/base.js +4 -0
  9. package/cjs/src/embed/base.js.map +1 -1
  10. package/cjs/src/embed/base.spec.js +60 -0
  11. package/cjs/src/embed/base.spec.js.map +1 -1
  12. package/cjs/src/embed/conversation.d.ts +7 -0
  13. package/cjs/src/embed/conversation.d.ts.map +1 -1
  14. package/cjs/src/embed/conversation.js +9 -0
  15. package/cjs/src/embed/conversation.js.map +1 -1
  16. package/cjs/src/embed/hostEventClient/contracts.d.ts +20 -3
  17. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  18. package/cjs/src/embed/hostEventClient/contracts.js +6 -1
  19. package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
  20. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +8 -8
  21. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  22. package/cjs/src/embed/hostEventClient/host-event-client.js +18 -18
  23. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  24. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +7 -7
  25. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  26. package/cjs/src/embed/liveboard.d.ts +10 -4
  27. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  28. package/cjs/src/embed/liveboard.js +12 -2
  29. package/cjs/src/embed/liveboard.js.map +1 -1
  30. package/cjs/src/embed/liveboard.spec.js +1 -1
  31. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  32. package/cjs/src/embed/sage.d.ts +7 -0
  33. package/cjs/src/embed/sage.d.ts.map +1 -1
  34. package/cjs/src/embed/sage.js +9 -0
  35. package/cjs/src/embed/sage.js.map +1 -1
  36. package/cjs/src/embed/search-bar.d.ts +7 -0
  37. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  38. package/cjs/src/embed/search-bar.js +9 -0
  39. package/cjs/src/embed/search-bar.js.map +1 -1
  40. package/cjs/src/embed/search.d.ts +7 -0
  41. package/cjs/src/embed/search.d.ts.map +1 -1
  42. package/cjs/src/embed/search.js +9 -0
  43. package/cjs/src/embed/search.js.map +1 -1
  44. package/cjs/src/embed/ts-embed.d.ts +9 -3
  45. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  46. package/cjs/src/embed/ts-embed.js +41 -8
  47. package/cjs/src/embed/ts-embed.js.map +1 -1
  48. package/cjs/src/embed/ts-embed.spec.js +156 -24
  49. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  50. package/cjs/src/errors.d.ts +2 -0
  51. package/cjs/src/errors.d.ts.map +1 -1
  52. package/cjs/src/errors.js +2 -0
  53. package/cjs/src/errors.js.map +1 -1
  54. package/cjs/src/index.d.ts +2 -2
  55. package/cjs/src/index.d.ts.map +1 -1
  56. package/cjs/src/index.js +5 -1
  57. package/cjs/src/index.js.map +1 -1
  58. package/cjs/src/types.d.ts +142 -45
  59. package/cjs/src/types.d.ts.map +1 -1
  60. package/cjs/src/types.js +91 -16
  61. package/cjs/src/types.js.map +1 -1
  62. package/cjs/src/utils/logger.spec.d.ts +20 -5
  63. package/cjs/src/utils/logger.spec.d.ts.map +1 -1
  64. package/cjs/src/utils/processTrigger.d.ts +3 -2
  65. package/cjs/src/utils/processTrigger.d.ts.map +1 -1
  66. package/cjs/src/utils/processTrigger.js +4 -2
  67. package/cjs/src/utils/processTrigger.js.map +1 -1
  68. package/cjs/src/utils.d.ts +15 -4
  69. package/cjs/src/utils.d.ts.map +1 -1
  70. package/cjs/src/utils.js +38 -6
  71. package/cjs/src/utils.js.map +1 -1
  72. package/cjs/src/utils.spec.js +53 -0
  73. package/cjs/src/utils.spec.js.map +1 -1
  74. package/dist/index-BFdRRz03.js +7371 -0
  75. package/dist/index-BUfrYJ3w.js +7371 -0
  76. package/dist/index-CI6s4VMY.js +7371 -0
  77. package/dist/{index-CSFjfTVk.js → index-CWQnMX2L.js} +1 -1
  78. package/dist/index-CaW-1mu5.js +7371 -0
  79. package/dist/index-CcSgNJVi.js +7371 -0
  80. package/dist/index-Djtv-y7A.js +7371 -0
  81. package/dist/index-UY-4yjBN.js +7371 -0
  82. package/dist/src/embed/app.d.ts +44 -32
  83. package/dist/src/embed/app.d.ts.map +1 -1
  84. package/dist/src/embed/base.d.ts +1 -1
  85. package/dist/src/embed/base.d.ts.map +1 -1
  86. package/dist/src/embed/conversation.d.ts +7 -0
  87. package/dist/src/embed/conversation.d.ts.map +1 -1
  88. package/dist/src/embed/hostEventClient/contracts.d.ts +20 -3
  89. package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  90. package/dist/src/embed/hostEventClient/host-event-client.d.ts +8 -8
  91. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  92. package/dist/src/embed/liveboard.d.ts +10 -4
  93. package/dist/src/embed/liveboard.d.ts.map +1 -1
  94. package/dist/src/embed/sage.d.ts +7 -0
  95. package/dist/src/embed/sage.d.ts.map +1 -1
  96. package/dist/src/embed/search-bar.d.ts +7 -0
  97. package/dist/src/embed/search-bar.d.ts.map +1 -1
  98. package/dist/src/embed/search.d.ts +7 -0
  99. package/dist/src/embed/search.d.ts.map +1 -1
  100. package/dist/src/embed/ts-embed.d.ts +9 -3
  101. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  102. package/dist/src/errors.d.ts +2 -0
  103. package/dist/src/errors.d.ts.map +1 -1
  104. package/dist/src/index.d.ts +2 -2
  105. package/dist/src/index.d.ts.map +1 -1
  106. package/dist/src/types.d.ts +142 -45
  107. package/dist/src/types.d.ts.map +1 -1
  108. package/dist/src/utils/logger.spec.d.ts +20 -5
  109. package/dist/src/utils/logger.spec.d.ts.map +1 -1
  110. package/dist/src/utils/processTrigger.d.ts +3 -2
  111. package/dist/src/utils/processTrigger.d.ts.map +1 -1
  112. package/dist/src/utils.d.ts +15 -4
  113. package/dist/src/utils.d.ts.map +1 -1
  114. package/dist/tsembed-react.es.js +288 -95
  115. package/dist/tsembed-react.js +287 -94
  116. package/dist/tsembed.es.js +289 -96
  117. package/dist/tsembed.js +314 -121
  118. package/dist/visual-embed-sdk-react-full.d.ts +246 -83
  119. package/dist/visual-embed-sdk-react.d.ts +251 -90
  120. package/dist/visual-embed-sdk.d.ts +299 -93
  121. package/lib/package.json +1 -1
  122. package/lib/src/embed/app.d.ts +44 -32
  123. package/lib/src/embed/app.d.ts.map +1 -1
  124. package/lib/src/embed/app.js.map +1 -1
  125. package/lib/src/embed/base.d.ts +1 -1
  126. package/lib/src/embed/base.d.ts.map +1 -1
  127. package/lib/src/embed/base.js +5 -1
  128. package/lib/src/embed/base.js.map +1 -1
  129. package/lib/src/embed/base.spec.js +61 -1
  130. package/lib/src/embed/base.spec.js.map +1 -1
  131. package/lib/src/embed/conversation.d.ts +7 -0
  132. package/lib/src/embed/conversation.d.ts.map +1 -1
  133. package/lib/src/embed/conversation.js +9 -0
  134. package/lib/src/embed/conversation.js.map +1 -1
  135. package/lib/src/embed/hostEventClient/contracts.d.ts +20 -3
  136. package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
  137. package/lib/src/embed/hostEventClient/contracts.js +5 -0
  138. package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
  139. package/lib/src/embed/hostEventClient/host-event-client.d.ts +8 -8
  140. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  141. package/lib/src/embed/hostEventClient/host-event-client.js +18 -18
  142. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  143. package/lib/src/embed/hostEventClient/host-event-client.spec.js +7 -7
  144. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  145. package/lib/src/embed/liveboard.d.ts +10 -4
  146. package/lib/src/embed/liveboard.d.ts.map +1 -1
  147. package/lib/src/embed/liveboard.js +12 -2
  148. package/lib/src/embed/liveboard.js.map +1 -1
  149. package/lib/src/embed/liveboard.spec.js +1 -1
  150. package/lib/src/embed/liveboard.spec.js.map +1 -1
  151. package/lib/src/embed/sage.d.ts +7 -0
  152. package/lib/src/embed/sage.d.ts.map +1 -1
  153. package/lib/src/embed/sage.js +9 -0
  154. package/lib/src/embed/sage.js.map +1 -1
  155. package/lib/src/embed/search-bar.d.ts +7 -0
  156. package/lib/src/embed/search-bar.d.ts.map +1 -1
  157. package/lib/src/embed/search-bar.js +9 -0
  158. package/lib/src/embed/search-bar.js.map +1 -1
  159. package/lib/src/embed/search.d.ts +7 -0
  160. package/lib/src/embed/search.d.ts.map +1 -1
  161. package/lib/src/embed/search.js +9 -0
  162. package/lib/src/embed/search.js.map +1 -1
  163. package/lib/src/embed/ts-embed.d.ts +9 -3
  164. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  165. package/lib/src/embed/ts-embed.js +41 -8
  166. package/lib/src/embed/ts-embed.js.map +1 -1
  167. package/lib/src/embed/ts-embed.spec.js +156 -24
  168. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  169. package/lib/src/errors.d.ts +2 -0
  170. package/lib/src/errors.d.ts.map +1 -1
  171. package/lib/src/errors.js +2 -0
  172. package/lib/src/errors.js.map +1 -1
  173. package/lib/src/index.d.ts +2 -2
  174. package/lib/src/index.d.ts.map +1 -1
  175. package/lib/src/index.js +2 -2
  176. package/lib/src/index.js.map +1 -1
  177. package/lib/src/types.d.ts +142 -45
  178. package/lib/src/types.d.ts.map +1 -1
  179. package/lib/src/types.js +90 -15
  180. package/lib/src/types.js.map +1 -1
  181. package/lib/src/utils/logger.spec.d.ts +20 -5
  182. package/lib/src/utils/logger.spec.d.ts.map +1 -1
  183. package/lib/src/utils/processTrigger.d.ts +3 -2
  184. package/lib/src/utils/processTrigger.d.ts.map +1 -1
  185. package/lib/src/utils/processTrigger.js +4 -2
  186. package/lib/src/utils/processTrigger.js.map +1 -1
  187. package/lib/src/utils.d.ts +15 -4
  188. package/lib/src/utils.d.ts.map +1 -1
  189. package/lib/src/utils.js +35 -5
  190. package/lib/src/utils.js.map +1 -1
  191. package/lib/src/utils.spec.js +54 -1
  192. package/lib/src/utils.spec.js.map +1 -1
  193. package/package.json +1 -1
  194. package/src/embed/app.ts +45 -32
  195. package/src/embed/base.spec.ts +79 -1
  196. package/src/embed/base.ts +5 -2
  197. package/src/embed/conversation.ts +11 -0
  198. package/src/embed/hostEventClient/contracts.ts +23 -4
  199. package/src/embed/hostEventClient/host-event-client.spec.ts +7 -1
  200. package/src/embed/hostEventClient/host-event-client.ts +22 -11
  201. package/src/embed/liveboard.spec.ts +1 -1
  202. package/src/embed/liveboard.ts +18 -5
  203. package/src/embed/sage.ts +11 -0
  204. package/src/embed/search-bar.tsx +11 -0
  205. package/src/embed/search.ts +11 -0
  206. package/src/embed/ts-embed.spec.ts +205 -18
  207. package/src/embed/ts-embed.ts +45 -9
  208. package/src/errors.ts +2 -0
  209. package/src/index.ts +6 -0
  210. package/src/types.ts +146 -43
  211. package/src/utils/processTrigger.ts +6 -3
  212. package/src/utils.spec.ts +78 -0
  213. package/src/utils.ts +35 -8
@@ -1056,56 +1056,70 @@ export declare enum AuthType {
1056
1056
  }
1057
1057
  /**
1058
1058
  *
1059
- * This option does not apply to the classic homepage experience.
1060
- * To access the updated modular homepage,
1061
- * set `modularHomeExperience` to `true`
1062
- * (available as Early Access feature in 9.12.5.cl).
1059
+ * **Note**: This attribute is not supported in the classic (V1) homepage experience.
1063
1060
  *
1064
1061
  */
1065
1062
  export declare enum HomeLeftNavItem {
1066
1063
  /**
1064
+ * The *Search data* option in
1065
+ * the *Insights* left navigation panel.
1067
1066
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1068
1067
  */
1069
1068
  SearchData = "search-data",
1070
1069
  /**
1070
+ * The *Home* menu option in
1071
+ * the *Insights* left navigation panel.
1071
1072
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1072
1073
  */
1073
1074
  Home = "insights-home",
1074
1075
  /**
1076
+ * The *Liveboards* menu option in
1077
+ * the *Insights* left navigation panel.
1075
1078
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1076
1079
  */
1077
1080
  Liveboards = "liveboards",
1078
1081
  /**
1082
+ * The *Answers* menu option in
1083
+ * the *Insights* left navigation panel.
1079
1084
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1080
1085
  */
1081
1086
  Answers = "answers",
1082
1087
  /**
1088
+ * The *Monitor subscriptions* menu option in
1089
+ * the *Insights* left navigation panel.
1083
1090
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1084
1091
  */
1085
1092
  MonitorSubscription = "monitor-alerts",
1086
1093
  /**
1094
+ * The *SpotIQ analysis* menu option in
1095
+ * the *Insights* left navigation panel.
1087
1096
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1088
1097
  */
1089
1098
  SpotIQAnalysis = "spotiq-analysis",
1090
1099
  /**
1100
+ * The *Liveboard schedules* menu option in
1101
+ * the *Insights* left navigation panel.
1091
1102
  * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
1092
1103
  */
1093
1104
  LiveboardSchedules = "liveboard-schedules",
1094
1105
  /**
1095
- * Create new options in the insights left navigation,
1096
- * available when new navigation V3 is enabled.
1106
+ * The create option in the *Insights*
1107
+ * left navigation panel.
1108
+ * Available in the V3 navigation experience.
1097
1109
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1098
1110
  */
1099
1111
  Create = "create",
1100
1112
  /**
1101
- * Spotter option in the insights left navigation,
1102
- * available when new navigation V3 is enabled.
1113
+ * The *Spotter* menu option in the *Insights*
1114
+ * left navigation panel.
1115
+ * Available in the V3 navigation experience.
1103
1116
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
1104
1117
  */
1105
1118
  Spotter = "spotter",
1106
1119
  /**
1107
- * Favorites option in the insights left navigation,
1108
- * available when new navigation V3 is enabled.
1120
+ * The *Favorites* section in the *Insights*
1121
+ * left navigation panel.
1122
+ * Available in the V3 navigation experience.
1109
1123
  * @version SDK: 1.41.0 | ThoughtSpot: 10.12.0.cl
1110
1124
  */
1111
1125
  Favorites = "favorites"
@@ -1962,17 +1976,45 @@ export interface BaseViewConfig extends ApiInterceptFlags {
1962
1976
  * ```
1963
1977
  */
1964
1978
  customActions?: CustomAction[];
1979
+ /**
1980
+ * Flag to bypass host events payload validation
1981
+ * @default false
1982
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
1983
+ * @example
1984
+ * ```js
1985
+ * const embed = new AppEmbed('#tsEmbed', {
1986
+ * ... // other embed view config
1987
+ * shouldBypassPayloadValidation:true,
1988
+ * })
1989
+ * ```
1990
+ */
1991
+ shouldBypassPayloadValidation?: boolean;
1992
+ /**
1993
+ * Flag to use host events v2. This is used to enable the new host events v2 API.
1994
+ * @default false
1995
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
1996
+ * @example
1997
+ * ```js
1998
+ * const embed = new AppEmbed('#tsEmbed', {
1999
+ * ... // other embed view config
2000
+ * useHostEventsV2:true,
2001
+ * })
2002
+ * ```
2003
+ */
2004
+ useHostEventsV2?: boolean;
1965
2005
  }
1966
2006
  /**
1967
2007
  * The configuration object for Home page embeds configs.
1968
2008
  */
1969
2009
  export interface HomePageConfig {
1970
2010
  /**
1971
- * Hide list page columns
1972
- * For example: hiddenListColumns = [ListPageColumns.Author]
2011
+ * Hide columns on list pages such as
2012
+ * *Liveboards* and *Answers*.
2013
+ * For example: `hiddenListColumns = [ListPageColumns.Author]`
1973
2014
  *
1974
- * **Note**: This option is currently available only in full app embedding and requires importing the ListPageColumns enum.
1975
- * 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.
2015
+ * **Note**: This option is available only in full app embedding and requires importing the `ListPageColumns` enum.
2016
+ * Starting with version 10.14.0.cl, you can use this attribute to
2017
+ * hide the columns on all list pages in the *Insights* section.
1976
2018
  *
1977
2019
  * Supported embed types: `AppEmbed`
1978
2020
  * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
@@ -1988,13 +2030,11 @@ export interface HomePageConfig {
1988
2030
  */
1989
2031
  hiddenListColumns?: ListPageColumns[];
1990
2032
  /**
1991
- * Hide the home page modules
1992
- * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
2033
+ * Control the visibility of home page modules.
2034
+ * To specify the modules, import the `HomepageModule` enum.
2035
+ * For example: `hiddenHomepageModules = [HomepageModule.MyLibrary]`
1993
2036
  *
1994
- * **Note**: This option does not apply to the classic homepage.
1995
- * To access the updated modular homepage, set
1996
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
1997
- * To use it, you need to import `HomepageModule` enum.
2037
+ * **Note**: This attribute is not supported in the classic (v1) experience.
1998
2038
  *
1999
2039
  * Supported embed types: `AppEmbed`
2000
2040
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -2003,20 +2043,18 @@ export interface HomePageConfig {
2003
2043
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
2004
2044
  *
2005
2045
  * const embed = new AppEmbed('#tsEmbed', {
2006
- * ... //other embed view config
2046
+ * ... // V2/V3 navigation and home page experience attributes
2007
2047
  * hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
2048
+ * //...other embed view configuration attributes
2008
2049
  * })
2009
2050
  * ```
2010
2051
  */
2011
2052
  hiddenHomepageModules?: HomepageModule[];
2012
2053
  /**
2013
- * reordering the home page modules
2014
- * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
2015
- *
2016
- * **Note**: This option does not apply to the classic homepage.
2017
- * To access the updated modular homepage, set
2018
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2019
- * To use it, you need to import `HomepageModule` enum.
2054
+ * Reorder home page modules.
2055
+ * To specify the modules, import the `HomepageModule` enum.
2056
+ * For example: `reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]`
2057
+ * **Note**: This attribute is not supported in the classic (v1) homepage.
2020
2058
  *
2021
2059
  * Supported embed types: `AppEmbed`
2022
2060
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl, 10.1.0.sw
@@ -2025,16 +2063,19 @@ export interface HomePageConfig {
2025
2063
  * import { HomepageModule } from '@thoughtspot/visual-embed-sdk';
2026
2064
  *
2027
2065
  * const embed = new AppEmbed('#tsEmbed', {
2028
- * ... //other embed view config
2066
+ * ...//V2/V3 navigation and home page experience attributes
2029
2067
  * reorderedHomepageModules:[HomepageModule.Favorite,HomepageModule.MyLibrary],
2068
+ * //... other embed view configuration attributes
2030
2069
  * })
2031
2070
  * ```
2032
2071
  */
2033
2072
  reorderedHomepageModules?: HomepageModule[];
2034
2073
  /**
2035
- * homepageLeftNavItems : Show or hide the left navigation bar items.
2036
- * There are 8 eight home navigation list items.
2037
- * To hide these items, specify the string in the array.
2074
+ * Controls the visibility of the menu items
2075
+ * on the home page left navigation panel.
2076
+ * To specify the menu items, import the `HomeLeftNavItem` enum.
2077
+ *
2078
+ * **Note**: This attribute is not supported in the classic (v1) homepage.
2038
2079
  *
2039
2080
  * Supported embed types: `AppEmbed`
2040
2081
  * @example
@@ -2042,15 +2083,11 @@ export interface HomePageConfig {
2042
2083
  * import { HomeLeftNavItem } from '@thoughtspot/visual-embed-sdk';
2043
2084
  *
2044
2085
  * const embed = new AppEmbed('#tsEmbed', {
2045
- * ... //other embed view config
2086
+ * //... V2/V3 experience attributes
2046
2087
  * hiddenHomeLeftNavItems : [HomeLeftNavItem.Home,HomeLeftNavItem.Answers],
2088
+ * ... //other embed view configuration attributes
2047
2089
  * })
2048
2090
  * ```
2049
- *
2050
- * **Note**: This option does not apply to the classic homepage.
2051
- * To access the updated modular homepage, set
2052
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2053
- * To use it, you need to import `HomeLeftNavItem` enum.
2054
2091
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2055
2092
  */
2056
2093
  hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -2568,10 +2605,11 @@ export declare enum RuntimeFilterOp {
2568
2605
  NOT_IN = "NOT_IN"
2569
2606
  }
2570
2607
  /**
2571
- * Home page module that can be hidden.
2572
- * **Note**: This option does not apply to the classic homepage.
2573
- * To access the updated modular homepage, set
2574
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2608
+ * Home page modules that can be hidden
2609
+ * via `hiddenHomepageModules` and reordered via
2610
+ * `reorderedHomepageModules`.
2611
+ *
2612
+ * **Note**: This option is not supported in the classic (v1) experience.
2575
2613
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
2576
2614
  */
2577
2615
  export declare enum HomepageModule {
@@ -2584,7 +2622,7 @@ export declare enum HomepageModule {
2584
2622
  */
2585
2623
  Watchlist = "WATCHLIST",
2586
2624
  /**
2587
- * favorite objects
2625
+ * Favorite module
2588
2626
  */
2589
2627
  Favorite = "FAVORITE",
2590
2628
  /**
@@ -3772,6 +3810,28 @@ export declare enum EmbedEvent {
3772
3810
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
3773
3811
  */
3774
3812
  PreviewSpotterData = "PreviewSpotterData",
3813
+ /**
3814
+ * Emitted when user opens up the Add to Coaching modal on any visualization in Spotter Embed.
3815
+ * @example
3816
+ * ```js
3817
+ * spotterEmbed.on(EmbedEvent.AddToCoaching, (payload) => {
3818
+ * console.log('payload', payload);
3819
+ * })
3820
+ *```
3821
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3822
+ */
3823
+ AddToCoaching = "addToCoaching",
3824
+ /**
3825
+ * Emitted when user opens up the data model instructions modal in Spotter embed.
3826
+ * @example
3827
+ * ```js
3828
+ * spotterEmbed.on(EmbedEvent.DataModelInstructions, (payload) => {
3829
+ * console.log('payload', payload);
3830
+ * })
3831
+ * ```
3832
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
3833
+ */
3834
+ DataModelInstructions = "DataModelInstructions",
3775
3835
  /**
3776
3836
  * Emitted when the Spotter query is triggered in Spotter embed.
3777
3837
  * @example
@@ -5195,6 +5255,26 @@ export declare enum HostEvent {
5195
5255
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5196
5256
  */
5197
5257
  PreviewSpotterData = "PreviewSpotterData",
5258
+ /**
5259
+ * Opens the Add to Coaching modal from a visualization in Spotter Embed.
5260
+ * @param - `vizId ` refers to the Visualization ID in Spotter embed and is required.
5261
+ * @example
5262
+ * ```js
5263
+ * spotterEmbed.trigger(HostEvent.AddToCoaching, { vizId: '730496d6-6903-4601-937e-2c691821af3c' });
5264
+ *
5265
+ *```
5266
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5267
+ */
5268
+ AddToCoaching = "addToCoaching",
5269
+ /**
5270
+ * Opens the data model instructions modal in Spotter Embed.
5271
+ * @example
5272
+ * ```js
5273
+ * spotterEmbed.trigger(HostEvent.DataModelInstructions);
5274
+ * ```
5275
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5276
+ */
5277
+ DataModelInstructions = "DataModelInstructions",
5198
5278
  /**
5199
5279
  * Resets the Spotter Embed Conversation.
5200
5280
  * @example
@@ -5296,7 +5376,16 @@ export declare enum HostEvent {
5296
5376
  * ```
5297
5377
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5298
5378
  */
5299
- StartNewSpotterConversation = "StartNewSpotterConversation"
5379
+ StartNewSpotterConversation = "StartNewSpotterConversation",
5380
+ /**
5381
+ * Get the current context of the embedded page.
5382
+ * @example
5383
+ * ```js
5384
+ * const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
5385
+ * ```
5386
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5387
+ */
5388
+ GetPageContext = "GetPageContext"
5300
5389
  }
5301
5390
  /**
5302
5391
  * The different visual modes that the data sources panel within
@@ -6843,7 +6932,19 @@ export declare enum LogLevel {
6843
6932
  */
6844
6933
  TRACE = "TRACE"
6845
6934
  }
6846
- declare enum ErrorDetailsTypes {
6935
+ /**
6936
+ * Error types emitted by embedded components.
6937
+ *
6938
+ * These enum values categorize different types of errors that can occur during
6939
+ * the lifecycle of an embedded ThoughtSpot component. Use these values to implement
6940
+ * specific error handling logic based on the error category.
6941
+ *
6942
+ * @see {@link EmbedErrorDetailsEvent} - The error event object structure
6943
+ * @see {@link EmbedEvent.Error} - The event that emits these errors
6944
+ * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
6945
+ * @group Error Handling
6946
+ */
6947
+ export declare enum ErrorDetailsTypes {
6847
6948
  /** API call failure */
6848
6949
  API = "API",
6849
6950
  /** General validation error */
@@ -6851,7 +6952,40 @@ declare enum ErrorDetailsTypes {
6851
6952
  /** Network connectivity or request error */
6852
6953
  NETWORK = "NETWORK"
6853
6954
  }
6854
- declare enum EmbedErrorCodes {
6955
+ /**
6956
+ * Specific error codes for embedded component errors.
6957
+ *
6958
+ * These codes provide granular identification of errors that occur in embedded components.
6959
+ * They are returned in the {@link EmbedErrorDetailsEvent.code} property and allow for
6960
+ * precise error handling and debugging.
6961
+ *
6962
+ * The codes are organized into categories:
6963
+ * - **Worksheet ID not found or does not exist**: Errors related to applying or updating filters
6964
+ * - **Liveboard ID missing**: Errors related to missing liveboard ID
6965
+ * - **Conflicting actions configuration**: Errors related to conflicting actions configuration
6966
+ * - **Conflicting tabs configuration**: Errors related to conflicting tabs configuration
6967
+ * - **Initialization error**: Errors related to initialization error
6968
+ * - **Network error**: Errors related to network error
6969
+ * - **Custom action validation**: Errors related to custom action validation
6970
+ * - **Login failed**: Errors related to login failed
6971
+ * - **Render not called**: Errors related to render not called
6972
+ * - **Host event type undefined or invalid**: Errors related to host event type undefined or invalid
6973
+ *
6974
+ * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
6975
+ * @group Error Handling
6976
+ * @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
6977
+ * @see {@link ErrorDetailsTypes} - General error type categories
6978
+ *
6979
+ * @example
6980
+ * Handle specific error codes
6981
+ *
6982
+ * embed.on(EmbedEvent.Error, (error) => {
6983
+ * if (error.code === EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND) {
6984
+ * console.error('Worksheet ID not found:', error.message);
6985
+ * }
6986
+ * });
6987
+ * */
6988
+ export declare enum EmbedErrorCodes {
6855
6989
  /** Worksheet ID not found or does not exist */
6856
6990
  WORKSHEET_ID_NOT_FOUND = "WORKSHEET_ID_NOT_FOUND",
6857
6991
  /** Required Liveboard ID is missing from configuration */
@@ -6873,7 +7007,9 @@ declare enum EmbedErrorCodes {
6873
7007
  /** Host event type is undefined or invalid */
6874
7008
  HOST_EVENT_TYPE_UNDEFINED = "HOST_EVENT_TYPE_UNDEFINED",
6875
7009
  /** Error parsing api intercept body */
6876
- PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR"
7010
+ PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
7011
+ /** Failed to update embed parameters during pre-render */
7012
+ UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
6877
7013
  }
6878
7014
  /**
6879
7015
  * Error event object emitted when an error occurs in an embedded component.
@@ -6946,6 +7082,12 @@ export interface EmbedErrorDetailsEvent {
6946
7082
  /** Additional context-specific for backward compatibility */
6947
7083
  [key: string]: any;
6948
7084
  }
7085
+ export declare enum ContextType {
7086
+ Search = "search-answer",
7087
+ Liveboard = "liveboard",
7088
+ Answer = "answer",
7089
+ Spotter = "spotter"
7090
+ }
6949
7091
  export interface DefaultAppInitData {
6950
7092
  customisations: CustomisationsInterface;
6951
7093
  authToken: string;
@@ -7105,9 +7247,25 @@ export type EmbedApiHostEventMapping = {
7105
7247
  [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
7106
7248
  };
7107
7249
  export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
7108
- export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
7250
+ export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
7109
7251
  export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
7110
- export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
7252
+ export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
7253
+ declare enum PageType {
7254
+ PAGE = "page",
7255
+ DIALOG = "dialog"
7256
+ }
7257
+ export interface Objects {
7258
+ answerId?: string;
7259
+ liveboardId?: string;
7260
+ vizIds?: string[];
7261
+ dataModelIds?: string[];
7262
+ modalTitle?: string;
7263
+ }
7264
+ export interface PageContextOptions {
7265
+ page: ContextType;
7266
+ pageType: PageType;
7267
+ objects: Objects;
7268
+ }
7111
7269
  declare class HostEventClient {
7112
7270
  iFrame: HTMLIFrameElement;
7113
7271
  constructor(iFrame?: HTMLIFrameElement);
@@ -7117,18 +7275,18 @@ declare class HostEventClient {
7117
7275
  * @param {any} data Data to send with the host event
7118
7276
  * @returns {Promise<any>} - the response from the process trigger
7119
7277
  */
7120
- protected processTrigger(message: HostEvent, data: any): Promise<any>;
7121
- handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
7122
- hostEventFallback(hostEvent: HostEvent, data: any): Promise<any>;
7278
+ protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
7279
+ handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
7280
+ hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
7123
7281
  /**
7124
7282
  * Setter for the iframe element used for host events
7125
7283
  * @param {HTMLIFrameElement} iFrame - the iframe element to set
7126
7284
  */
7127
7285
  setIframeElement(iFrame: HTMLIFrameElement): void;
7128
- triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
7129
- protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
7130
- protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>): Promise<any>;
7131
- triggerHostEvent<HostEventT extends HostEvent, PayloadT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
7286
+ triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
7287
+ protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
7288
+ protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
7289
+ triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
7132
7290
  }
7133
7291
  declare class TsEmbed {
7134
7292
  /**
@@ -7296,7 +7454,7 @@ declare class TsEmbed {
7296
7454
  * @param query
7297
7455
  */
7298
7456
  protected getEmbedBasePath(query: string): string;
7299
- protected getUpdateEmbedParamsObject(): Record<any, any>;
7457
+ protected getUpdateEmbedParamsObject(): Promise<Record<any, any>>;
7300
7458
  /**
7301
7459
  * Common query params set for all the embed modes.
7302
7460
  * @param queryParams
@@ -7450,7 +7608,7 @@ declare class TsEmbed {
7450
7608
  * @param {any} data The payload to send with the message
7451
7609
  * @returns A promise that resolves with the response from the embedded app
7452
7610
  */
7453
- trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
7611
+ trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
7454
7612
  /**
7455
7613
  * Triggers an event to the embedded app, skipping the UI flow.
7456
7614
  * @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
@@ -7468,6 +7626,12 @@ declare class TsEmbed {
7468
7626
  render(): Promise<TsEmbed>;
7469
7627
  getIframeSrc(): string;
7470
7628
  protected handleRenderForPrerender(): Promise<TsEmbed>;
7629
+ /**
7630
+ * Get the current context of the embedded TS component.
7631
+ * @returns The current context object containing the page type and object ids.
7632
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
7633
+ */
7634
+ getCurrentContext(): Promise<any>;
7471
7635
  /**
7472
7636
  * Creates the preRender shell
7473
7637
  * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -7724,14 +7888,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
7724
7888
  */
7725
7889
  showPrimaryNavbar?: boolean;
7726
7890
  /**
7727
- * Control the visibility of the left navigation bar on the Homepage.
7728
- * If showPrimaryNavbar is true, that is, if the Global and Homepage
7729
- * nav-bars are visible, this flag will only hide the homepage left nav-bar.
7730
- * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
7891
+ * Control the visibility of the left navigation panel on the home page
7892
+ * in the V2 and V3 navigation and home page experience.
7893
+ * If `showPrimaryNavbar` is true, that is, if the Global and Homepage
7894
+ * navigation bars are visible, this flag will only hide the left navigation bar
7895
+ * on the home page.
7896
+ * The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
7731
7897
  *
7732
- * **Note**: This option does not apply to the classic homepage.
7733
- * To access the updated modular homepage, set
7734
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
7898
+ * **Note**: This attribute is not supported in the classic (V1) experience.
7735
7899
  *
7736
7900
  * Supported embed types: `AppEmbed`
7737
7901
  * @default false
@@ -7746,8 +7910,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
7746
7910
  */
7747
7911
  hideHomepageLeftNav?: boolean;
7748
7912
  /**
7749
- * Control the visibility of the help (?) and profile buttons on the
7750
- * Global nav-bar. By default, these buttons are visible on the nav-bar.
7913
+ * Control the visibility of the help (?) and profile
7914
+ * buttons on the top navigation bar.
7915
+ * These buttons are visible if the
7916
+ * navigation bar is not hidden via `showPrimaryNavbar`.
7751
7917
  *
7752
7918
  * Supported embed types: `AppEmbed`
7753
7919
  * @default false
@@ -7764,7 +7930,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
7764
7930
  /**
7765
7931
  * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
7766
7932
  * @default true
7767
- * Whether the help menu in the top nav bar should be served
7933
+ * Whether the help menu in the top navigation bar should be served
7768
7934
  * from Pendo or ThoughtSpot's internal help items.
7769
7935
  *
7770
7936
  * Supported embed types: `AppEmbed`
@@ -7778,8 +7944,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
7778
7944
  */
7779
7945
  enablePendoHelp?: boolean;
7780
7946
  /**
7781
- * Control the visibility of the hamburger icon on the top nav bar
7782
- * available when new navigation V3 is enabled.
7947
+ * Control the visibility of the hamburger icon on
7948
+ * the top navigation bar in the V3 navigation experience.
7783
7949
  *
7784
7950
  * Supported embed types: `AppEmbed`
7785
7951
  * @default false
@@ -7794,8 +7960,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
7794
7960
  */
7795
7961
  hideHamburger?: boolean;
7796
7962
  /**
7797
- * Control the visibility of the Eureka search on the top nav bar
7798
- * this will control for both new V2 and new navigation V3.
7963
+ * Control the visibility of the object search
7964
+ * on the top navigation bar in the
7965
+ * V2 and V3 navigation experience.
7966
+ *
7967
+ * **Note**: This attribute is not supported
7968
+ * in the classic (V1) experience.
7799
7969
  *
7800
7970
  * Supported embed types: `AppEmbed`
7801
7971
  * @default true
@@ -7810,8 +7980,11 @@ export interface AppViewConfig extends AllEmbedViewConfig {
7810
7980
  */
7811
7981
  hideObjectSearch?: boolean;
7812
7982
  /**
7813
- * Control the visibility of the notification on the top nav bar V3,
7814
- * available when new navigation V3 is enabled.
7983
+ * Control the visibility of the notification icon
7984
+ * on the top navigation bar in V3 navigation experience.
7985
+ *
7986
+ * **Note**: This attribute is not supported
7987
+ * in the classic (V1) and V2 experience modes.
7815
7988
  *
7816
7989
  * Supported embed types: `AppEmbed`
7817
7990
  * @default true
@@ -7826,12 +7999,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
7826
7999
  */
7827
8000
  hideNotification?: boolean;
7828
8001
  /**
7829
- * Control the visibility of the application switcher button on the nav-bar.
7830
- * By default, the application switcher is shown.
8002
+ * Control the visibility of the application selection menu
8003
+ * in the top navigation bar in the V2 experience.
8004
+ * In the V3 experience, it shows or hides application selection
8005
+ * icons on the left navigation panel.
8006
+ * By default, the application selection menu and icons are
8007
+ * shown in the UI
7831
8008
  *
7832
- * **Note**: This option does not apply to the classic homepage.
7833
- * To access the updated modular homepage, set
7834
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
8009
+ * **Note**: This attribute is not supported in the classic (V1) experience.
7835
8010
  *
7836
8011
  * Supported embed types: `AppEmbed`
7837
8012
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -7849,9 +8024,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
7849
8024
  * Control the visibility of the Org switcher button on the nav-bar.
7850
8025
  * By default, the Org switcher button is shown.
7851
8026
  *
7852
- * **Note**: This option does not apply to the classic homepage.
7853
- * To access the updated modular homepage, set
7854
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
8027
+ * **Note**: This attribute is not supported in the classic (V1) experience.
7855
8028
  *
7856
8029
  * Supported embed types: `AppEmbed`
7857
8030
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -8004,8 +8177,9 @@ export interface AppViewConfig extends AllEmbedViewConfig {
8004
8177
  */
8005
8178
  fullHeight?: boolean;
8006
8179
  /**
8007
- * Flag to control new Modular Home experience.
8008
- *
8180
+ * Enables the V2 navigation and modular home page experience.
8181
+ * For more information,
8182
+ * see link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
8009
8183
  * Supported embed types: `AppEmbed`
8010
8184
  * @default false
8011
8185
  * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
@@ -8019,18 +8193,20 @@ export interface AppViewConfig extends AllEmbedViewConfig {
8019
8193
  */
8020
8194
  modularHomeExperience?: boolean;
8021
8195
  /**
8022
- * To configure the top-left navigation and home page experience
8023
- *
8196
+ * Configures the V3 navigation and home page experience.
8197
+ * For more information, see
8198
+ * link:https://developers.thoughtspot.com/docs/full-app-customize[full app embed documentation].
8024
8199
  * Supported embed types: `AppEmbed`
8025
8200
  * @default false
8026
8201
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
8027
8202
  * @example
8028
8203
  * ```js
8029
8204
  * const embed = new AppEmbed('#tsEmbed', {
8030
- * ... // other embed view config
8205
+ * // Enable V3 navigation and home page experience
8031
8206
  * discoveryExperience : {
8032
- * primaryNavbarVersion: PrimaryNavbarVersion.Sliding,
8033
- * homePage: HomePage.Modular,
8207
+ * primaryNavbarVersion: PrimaryNavbarVersion.Sliding, // Enable V3 navigation
8208
+ * homePage: HomePage.ModularWithStylingChanges, // Enable V3 modular home page
8209
+ * ... // other embed view config
8034
8210
  * },
8035
8211
  * })
8036
8212
  * ```
@@ -8178,7 +8354,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
8178
8354
  * Setting this height helps resolve issues with empty Apps and
8179
8355
  * other screens navigable from an App.
8180
8356
  *
8181
- * @version SDK: 1.44.2 | ThoughtSpot: 26.0.2.cl
8357
+ * @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
8182
8358
  * @default 500
8183
8359
  * @example
8184
8360
  * ```js
@@ -8413,7 +8589,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
8413
8589
  * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
8414
8590
  * @group Authentication / Init
8415
8591
  */
8416
- export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter;
8592
+ export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter | null;
8417
8593
  /**
8418
8594
  * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
8419
8595
  * prevent the SDK from automatically logging in again.
@@ -8540,7 +8716,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
8540
8716
  * Setting this height helps resolve issues with empty Liveboards and
8541
8717
  * other screens navigable from a Liveboard.
8542
8718
  *
8543
- * @version SDK: 1.44.2 | ThoughtSpot: 26.0.2.cl
8719
+ * @version SDK: 1.44.2 | ThoughtSpot: 10.15.0.cl
8544
8720
  * @default 500
8545
8721
  * @example
8546
8722
  * ```js
@@ -8954,7 +9130,7 @@ export declare class LiveboardEmbed extends V1Embed {
8954
9130
  * @param {any} data The payload to send with the message
8955
9131
  * @returns A promise that resolves with the response from the embedded app
8956
9132
  */
8957
- trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
9133
+ trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
8958
9134
  /**
8959
9135
  * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
8960
9136
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
@@ -8976,6 +9152,12 @@ export declare class LiveboardEmbed extends V1Embed {
8976
9152
  * @returns url string
8977
9153
  */
8978
9154
  getLiveboardUrl(): string;
9155
+ /**
9156
+ * Get the current context of the embedded liveboard.
9157
+ * @returns The current context object containing the page type and object ids.
9158
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9159
+ */
9160
+ getCurrentContext(): Promise<PageContextOptions>;
8979
9161
  }
8980
9162
  /**
8981
9163
  * @hidden
@@ -9299,6 +9481,12 @@ export declare class SearchEmbed extends TsEmbed {
9299
9481
  * Render the embedded ThoughtSpot search
9300
9482
  */
9301
9483
  render(): Promise<SearchEmbed>;
9484
+ /**
9485
+ * Get the current context of the embedded search.
9486
+ * @returns The current context object containing the page type and object ids.
9487
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9488
+ */
9489
+ getCurrentContext(): Promise<PageContextOptions>;
9302
9490
  }
9303
9491
  /**
9304
9492
  * @group Embed components
@@ -9422,6 +9610,12 @@ export declare class SearchBarEmbed extends TsEmbed {
9422
9610
  searchOptions: SearchOptions;
9423
9611
  };
9424
9612
  protected getAppInitData(): Promise<SearchAppInitData$1>;
9613
+ /**
9614
+ * Get the current context of the embedded search bar.
9615
+ * @returns The current context object containing the page type and object ids.
9616
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9617
+ */
9618
+ getCurrentContext(): Promise<PageContextOptions>;
9425
9619
  }
9426
9620
  /**
9427
9621
  * Configuration for bodyless conversation options.
@@ -9748,6 +9942,12 @@ export declare class SpotterEmbed extends TsEmbed {
9748
9942
  protected getEmbedParamsObject(): Record<any, any>;
9749
9943
  getIframeSrc(): string;
9750
9944
  render(): Promise<SpotterEmbed>;
9945
+ /**
9946
+ * Get the current context of the embedded SpotterEmbed.
9947
+ * @returns The current context object containing the page type and object ids.
9948
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9949
+ */
9950
+ getCurrentContext(): Promise<PageContextOptions>;
9751
9951
  }
9752
9952
  /**
9753
9953
  * Embed ThoughtSpot AI Conversation.
@@ -9944,6 +10144,12 @@ export declare class SageEmbed extends V1Embed {
9944
10144
  * @returns {SageEmbed} Eureka/Sage embed
9945
10145
  */
9946
10146
  render(): Promise<SageEmbed>;
10147
+ /**
10148
+ * Get the current context of the embedded SageEmbed.
10149
+ * @returns The current context object containing the page type and object ids.
10150
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
10151
+ */
10152
+ getCurrentContext(): Promise<PageContextOptions>;
9947
10153
  }
9948
10154
  /**
9949
10155
  * Gets the embed configuration settings that were used to