@thoughtspot/visual-embed-sdk 1.20.1 → 1.21.0-alpha.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 (184) hide show
  1. package/README.md +1 -1
  2. package/dist/src/auth.d.ts +48 -3
  3. package/dist/src/auth.d.ts.map +1 -1
  4. package/dist/src/config.d.ts +1 -0
  5. package/dist/src/config.d.ts.map +1 -1
  6. package/dist/src/embed/app.d.ts +17 -5
  7. package/dist/src/embed/app.d.ts.map +1 -1
  8. package/dist/src/embed/base.d.ts +20 -9
  9. package/dist/src/embed/base.d.ts.map +1 -1
  10. package/dist/src/embed/liveboard.d.ts +17 -5
  11. package/dist/src/embed/liveboard.d.ts.map +1 -1
  12. package/dist/src/embed/search-bar.d.ts +3 -0
  13. package/dist/src/embed/search-bar.d.ts.map +1 -1
  14. package/dist/src/embed/search.d.ts +9 -5
  15. package/dist/src/embed/search.d.ts.map +1 -1
  16. package/dist/src/embed/ts-embed.d.ts +64 -6
  17. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  18. package/dist/src/errors.d.ts.map +1 -1
  19. package/dist/src/index.d.ts.map +1 -1
  20. package/dist/src/mixpanel-service.d.ts +8 -0
  21. package/dist/src/mixpanel-service.d.ts.map +1 -1
  22. package/dist/src/react/index.d.ts +15 -0
  23. package/dist/src/react/index.d.ts.map +1 -1
  24. package/dist/src/react/util.d.ts +4 -0
  25. package/dist/src/react/util.d.ts.map +1 -1
  26. package/dist/src/test/test-utils.d.ts +11 -2
  27. package/dist/src/test/test-utils.d.ts.map +1 -1
  28. package/dist/src/types.d.ts +297 -77
  29. package/dist/src/types.d.ts.map +1 -1
  30. package/dist/src/utils/answerService.d.ts +7 -0
  31. package/dist/src/utils/answerService.d.ts.map +1 -1
  32. package/dist/src/utils/authService.d.ts +30 -0
  33. package/dist/src/utils/authService.d.ts.map +1 -1
  34. package/dist/src/utils/processData.d.ts +12 -0
  35. package/dist/src/utils/processData.d.ts.map +1 -1
  36. package/dist/src/utils/processTrigger.d.ts +7 -0
  37. package/dist/src/utils/processTrigger.d.ts.map +1 -1
  38. package/dist/src/utils.d.ts +12 -0
  39. package/dist/src/utils.d.ts.map +1 -1
  40. package/dist/tsembed.es.js +694 -267
  41. package/dist/tsembed.js +686 -266
  42. package/lib/package.json +3 -8
  43. package/lib/src/auth.d.ts +48 -3
  44. package/lib/src/auth.d.ts.map +1 -1
  45. package/lib/src/auth.js +70 -25
  46. package/lib/src/auth.js.map +1 -1
  47. package/lib/src/auth.spec.js +14 -5
  48. package/lib/src/auth.spec.js.map +1 -1
  49. package/lib/src/config.d.ts +1 -0
  50. package/lib/src/config.d.ts.map +1 -1
  51. package/lib/src/config.js +5 -3
  52. package/lib/src/config.js.map +1 -1
  53. package/lib/src/config.spec.js.map +1 -1
  54. package/lib/src/embed/app.d.ts +17 -5
  55. package/lib/src/embed/app.d.ts.map +1 -1
  56. package/lib/src/embed/app.js +25 -15
  57. package/lib/src/embed/app.js.map +1 -1
  58. package/lib/src/embed/app.spec.js +12 -12
  59. package/lib/src/embed/app.spec.js.map +1 -1
  60. package/lib/src/embed/base.d.ts +20 -9
  61. package/lib/src/embed/base.d.ts.map +1 -1
  62. package/lib/src/embed/base.js +31 -15
  63. package/lib/src/embed/base.js.map +1 -1
  64. package/lib/src/embed/base.spec.js.map +1 -1
  65. package/lib/src/embed/embed.spec.js +1 -1
  66. package/lib/src/embed/embed.spec.js.map +1 -1
  67. package/lib/src/embed/liveboard.d.ts +17 -5
  68. package/lib/src/embed/liveboard.d.ts.map +1 -1
  69. package/lib/src/embed/liveboard.js +49 -37
  70. package/lib/src/embed/liveboard.js.map +1 -1
  71. package/lib/src/embed/liveboard.spec.js +37 -30
  72. package/lib/src/embed/liveboard.spec.js.map +1 -1
  73. package/lib/src/embed/pinboard.spec.js +14 -26
  74. package/lib/src/embed/pinboard.spec.js.map +1 -1
  75. package/lib/src/embed/search-bar.d.ts +3 -0
  76. package/lib/src/embed/search-bar.d.ts.map +1 -1
  77. package/lib/src/embed/search-bar.js +5 -6
  78. package/lib/src/embed/search-bar.js.map +1 -1
  79. package/lib/src/embed/search.d.ts +9 -5
  80. package/lib/src/embed/search.d.ts.map +1 -1
  81. package/lib/src/embed/search.js +18 -14
  82. package/lib/src/embed/search.js.map +1 -1
  83. package/lib/src/embed/search.spec.js +16 -19
  84. package/lib/src/embed/search.spec.js.map +1 -1
  85. package/lib/src/embed/searchEmbed-basic-auth.spec.js +4 -0
  86. package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +1 -1
  87. package/lib/src/embed/ts-embed.d.ts +64 -6
  88. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  89. package/lib/src/embed/ts-embed.js +150 -76
  90. package/lib/src/embed/ts-embed.js.map +1 -1
  91. package/lib/src/embed/ts-embed.spec.js +46 -24
  92. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  93. package/lib/src/errors.d.ts.map +1 -1
  94. package/lib/src/errors.js.map +1 -1
  95. package/lib/src/index.d.ts.map +1 -1
  96. package/lib/src/index.js +2 -2
  97. package/lib/src/index.js.map +1 -1
  98. package/lib/src/mixpanel-service.d.ts +8 -0
  99. package/lib/src/mixpanel-service.d.ts.map +1 -1
  100. package/lib/src/mixpanel-service.js +13 -1
  101. package/lib/src/mixpanel-service.js.map +1 -1
  102. package/lib/src/mixpanel-service.spec.js.map +1 -1
  103. package/lib/src/react/index.d.ts +15 -0
  104. package/lib/src/react/index.d.ts.map +1 -1
  105. package/lib/src/react/index.js +21 -6
  106. package/lib/src/react/index.js.map +1 -1
  107. package/lib/src/react/index.spec.js +15 -6
  108. package/lib/src/react/index.spec.js.map +1 -1
  109. package/lib/src/react/util.d.ts +4 -0
  110. package/lib/src/react/util.d.ts.map +1 -1
  111. package/lib/src/react/util.js +4 -0
  112. package/lib/src/react/util.js.map +1 -1
  113. package/lib/src/test/test-utils.d.ts +11 -2
  114. package/lib/src/test/test-utils.d.ts.map +1 -1
  115. package/lib/src/test/test-utils.js +36 -25
  116. package/lib/src/test/test-utils.js.map +1 -1
  117. package/lib/src/types.d.ts +297 -77
  118. package/lib/src/types.d.ts.map +1 -1
  119. package/lib/src/types.js +224 -55
  120. package/lib/src/types.js.map +1 -1
  121. package/lib/src/utils/answerService.d.ts +7 -0
  122. package/lib/src/utils/answerService.d.ts.map +1 -1
  123. package/lib/src/utils/answerService.js +7 -0
  124. package/lib/src/utils/answerService.js.map +1 -1
  125. package/lib/src/utils/answerService.spec.js.map +1 -1
  126. package/lib/src/utils/authService.d.ts +30 -0
  127. package/lib/src/utils/authService.d.ts.map +1 -1
  128. package/lib/src/utils/authService.js +39 -2
  129. package/lib/src/utils/authService.js.map +1 -1
  130. package/lib/src/utils/authService.spec.js.map +1 -1
  131. package/lib/src/utils/processData.d.ts +12 -0
  132. package/lib/src/utils/processData.d.ts.map +1 -1
  133. package/lib/src/utils/processData.js +33 -5
  134. package/lib/src/utils/processData.js.map +1 -1
  135. package/lib/src/utils/processData.spec.js.map +1 -1
  136. package/lib/src/utils/processTrigger.d.ts +7 -0
  137. package/lib/src/utils/processTrigger.d.ts.map +1 -1
  138. package/lib/src/utils/processTrigger.js +17 -3
  139. package/lib/src/utils/processTrigger.js.map +1 -1
  140. package/lib/src/utils/processTrigger.spec.js.map +1 -1
  141. package/lib/src/utils.d.ts +12 -0
  142. package/lib/src/utils.d.ts.map +1 -1
  143. package/lib/src/utils.js +24 -19
  144. package/lib/src/utils.js.map +1 -1
  145. package/lib/src/utils.spec.js.map +1 -1
  146. package/lib/src/visual-embed-sdk.d.ts +461 -104
  147. package/package.json +3 -8
  148. package/src/auth.spec.ts +68 -150
  149. package/src/auth.ts +115 -109
  150. package/src/config.spec.ts +2 -4
  151. package/src/config.ts +5 -3
  152. package/src/embed/app.spec.ts +25 -14
  153. package/src/embed/app.ts +47 -35
  154. package/src/embed/base.spec.ts +3 -9
  155. package/src/embed/base.ts +51 -53
  156. package/src/embed/embed.spec.ts +5 -6
  157. package/src/embed/liveboard.spec.ts +56 -37
  158. package/src/embed/liveboard.ts +66 -64
  159. package/src/embed/pinboard.spec.ts +26 -29
  160. package/src/embed/search-bar.tsx +10 -8
  161. package/src/embed/search.spec.ts +31 -21
  162. package/src/embed/search.ts +26 -25
  163. package/src/embed/searchEmbed-basic-auth.spec.ts +22 -28
  164. package/src/embed/ts-embed.spec.ts +99 -144
  165. package/src/embed/ts-embed.ts +183 -160
  166. package/src/errors.ts +3 -6
  167. package/src/index.ts +4 -10
  168. package/src/mixpanel-service.spec.ts +1 -3
  169. package/src/mixpanel-service.ts +13 -1
  170. package/src/react/index.spec.tsx +37 -13
  171. package/src/react/index.tsx +53 -57
  172. package/src/react/util.ts +8 -4
  173. package/src/test/test-utils.ts +43 -39
  174. package/src/types.ts +294 -79
  175. package/src/utils/answerService.spec.ts +3 -5
  176. package/src/utils/answerService.ts +21 -17
  177. package/src/utils/authService.spec.ts +26 -41
  178. package/src/utils/authService.ts +47 -21
  179. package/src/utils/processData.spec.ts +26 -59
  180. package/src/utils/processData.ts +36 -14
  181. package/src/utils/processTrigger.spec.ts +1 -6
  182. package/src/utils/processTrigger.ts +18 -9
  183. package/src/utils.spec.ts +8 -12
  184. package/src/utils.ts +25 -26
package/README.md CHANGED
@@ -7,7 +7,7 @@
7
7
  # ThoughtSpot Visual Embed SDK <br/> [![Coverage Status](https://coveralls.io/repos/github/ts-blink/embed-sdk/badge.svg?branch=main)](https://coveralls.io/github/ts-blink/embed-sdk?branch=main) ![npm (scoped with tag)](https://img.shields.io/npm/v/@thoughtspot/visual-embed-sdk) [![](https://data.jsdelivr.com/v1/package/npm/@thoughtspot/visual-embed-sdk/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@thoughtspot/visual-embed-sdk) ![npm](https://img.shields.io/npm/dm/@thoughtspot/visual-embed-sdk?label=npm%20downloads&style=flat-square) [![Featured on Openbase](https://badges.openbase.com/js/featured/@thoughtspot/visual-embed-sdk.svg?token=IoqZUwE8aX7LYNedeuBLM2w5Wt52hu+Dh0eyKjlpC0E=)](https://openbase.com/js/@thoughtspot/visual-embed-sdk?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@thoughtspot/visual-embed-sdk?style=flat-square)
8
8
 
9
9
 
10
- SDK to embed ThoughtSpot into your web apps. You need to have a ThoughtSpot account to use the SDK, [click here](https://www.thoughtspot.com/trial?tsref=trialtse) to start a trial.
10
+ SDK to embed ThoughtSpot into your web apps. You need a ThoughtSpot account to use the SDK, [click here](https://www.thoughtspot.com/trial?tsref=trialtse) to start a trial.
11
11
 
12
12
  * [Installation](#installation)
13
13
  * [Live Playground](#live-playground)
@@ -15,6 +15,7 @@ export declare const EndPoints: {
15
15
  /**
16
16
  * Enum for auth failure types. This is the parameter passed to the listner
17
17
  * of {@link AuthStatus.FAILURE}.
18
+ *
18
19
  * @group Authentication / Init
19
20
  */
20
21
  export declare enum AuthFailureType {
@@ -25,6 +26,7 @@ export declare enum AuthFailureType {
25
26
  }
26
27
  /**
27
28
  * Enum for auth status emitted by the emitter returned from {@link init}.
29
+ *
28
30
  * @group Authentication / Init
29
31
  */
30
32
  export declare enum AuthStatus {
@@ -48,31 +50,45 @@ export declare enum AuthStatus {
48
50
  * Emitted when inPopup: true in the SAMLRedirect flow.
49
51
  * And, we are waiting for popup to be triggered either programatically
50
52
  * or by the trigger button.
53
+ *
51
54
  * @version SDK: 1.19.0
52
55
  */
53
56
  WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
54
57
  }
55
58
  /**
56
59
  * Event emitter returned from {@link init}.
60
+ *
57
61
  * @group Authentication / Init
58
62
  */
59
63
  export interface AuthEventEmitter {
60
64
  /**
61
- * Registed a listener on Auth failure.
65
+ * Register a listener on Auth failure.
66
+ *
62
67
  * @param event
63
68
  * @param listener
64
69
  */
65
70
  on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
71
+ /**
72
+ * Register a listener on Auth SDK success.
73
+ *
74
+ * @param event
75
+ * @param listener
76
+ */
66
77
  on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
67
78
  on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
79
+ once(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
80
+ once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
81
+ once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
68
82
  /**
69
83
  * Trigger an event on the emitter returned from init.
84
+ *
70
85
  * @param {@link AuthEvent}
71
86
  */
72
87
  emit(event: AuthEvent): void;
73
88
  }
74
89
  /**
75
90
  * Events which can be triggered on the emitter returned from {@link init}.
91
+ *
76
92
  * @group Authentication / Init
77
93
  */
78
94
  export declare enum AuthEvent {
@@ -82,31 +98,58 @@ export declare enum AuthEvent {
82
98
  */
83
99
  TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
84
100
  }
101
+ /**
102
+ *
103
+ */
85
104
  export declare function getAuthEE(): EventEmitter<AuthStatus | AuthEvent>;
105
+ /**
106
+ *
107
+ * @param eventEmitter
108
+ */
86
109
  export declare function setAuthEE(eventEmitter: EventEmitter<AuthStatus | AuthEvent>): void;
110
+ /**
111
+ *
112
+ */
87
113
  export declare function notifyAuthSDKSuccess(): void;
114
+ /**
115
+ *
116
+ */
88
117
  export declare function notifyAuthSuccess(): void;
118
+ /**
119
+ *
120
+ * @param failureType
121
+ */
89
122
  export declare function notifyAuthFailure(failureType: AuthFailureType): void;
123
+ /**
124
+ *
125
+ */
90
126
  export declare function notifyLogout(): void;
91
127
  /**
92
128
  * Return releaseVersion if available
93
129
  */
94
130
  export declare function getReleaseVersion(): string;
95
131
  /**
96
- * Return a promise that resolves with the session information when authentication is
97
- * successful. And info is available.
132
+ * Return a promise that resolves with the session information when
133
+ * authentication is successful. And info is available.
134
+ *
98
135
  * @group Global methods
99
136
  */
100
137
  export declare function getSessionInfo(): Promise<any>;
138
+ /**
139
+ *
140
+ * @param sessionDetails
141
+ */
101
142
  export declare function initSession(sessionDetails: any): void;
102
143
  export declare const getAuthenticaionToken: (embedConfig: EmbedConfig) => Promise<any>;
103
144
  /**
104
145
  * Perform token based authentication
146
+ *
105
147
  * @param embedConfig The embed configuration
106
148
  */
107
149
  export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
108
150
  /**
109
151
  * Validate embedConfig parameters required for cookielessTokenAuth
152
+ *
110
153
  * @param embedConfig The embed configuration
111
154
  */
112
155
  export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
@@ -116,6 +159,7 @@ export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promis
116
159
  *
117
160
  * Warning: This feature is primarily intended for developer testing. It is
118
161
  * strongly advised not to use this authentication method in production.
162
+ *
119
163
  * @param embedConfig The embed configuration
120
164
  */
121
165
  export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
@@ -124,6 +168,7 @@ export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
124
168
  export declare const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
125
169
  /**
126
170
  * Perform authentication on the ThoughtSpot cluster
171
+ *
127
172
  * @param embedConfig The embed configuration
128
173
  */
129
174
  export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
@@ -1 +1 @@
1
- {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,EAAyB,WAAW,EAAqB,MAAM,SAAS,CAAC;AAahF,eAAO,IAAI,cAAc,SAAQ,CAAC;AAElC,eAAO,IAAI,cAAc,EAAE,MAAa,CAAC;AAEzC,eAAO,IAAI,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAQ,CAAC;AAQvD,eAAO,MAAM,2BAA2B,yCACE,CAAC;AAE3C,eAAO,MAAM,SAAS;;qCAEe,MAAM;qCAEN,MAAM;;;;CAK1C,CAAC;AAEF;;;;GAIG;AACH,oBAAY,eAAe;IACvB,GAAG,QAAQ;IACX,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,KAAK,UAAU;CAClB;AAED;;;GAGG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;OAKG;IACH,iBAAiB,sBAAsB;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;OAIG;IACH,EAAE,CACE,KAAK,EAAE,UAAU,CAAC,OAAO,EACzB,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GACjD,IAAI,CAAC;IACR,EAAE,CACE,KAAK,EACC,UAAU,CAAC,WAAW,GACtB,UAAU,CAAC,MAAM,GACjB,UAAU,CAAC,iBAAiB,EAClC,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC1E;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;CAChC;AAED;;;GAGG;AACH,oBAAY,SAAS;IACjB;;;OAGG;IACH,iBAAiB,sBAAsB;CAC1C;AAID,wBAAgB,SAAS,IAAI,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,CAEhE;AAED,wBAAgB,SAAS,CACrB,YAAY,EAAE,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,GACnD,IAAI,CAEN;AAED,wBAAgB,oBAAoB,IAAI,IAAI,CAM3C;AAED,wBAAgB,iBAAiB,IAAI,IAAI,CAMxC;AAED,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAMpE;AAED,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAmBD;;GAEG;AACH,wBAAgB,iBAAiB,WAEhC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAE7C;AAED,wBAAgB,WAAW,CAAC,cAAc,EAAE,GAAG,QAI9C;AAoCD,eAAO,MAAM,qBAAqB,gBACjB,WAAW,KACzB,QAAQ,GAAG,CAWb,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,gBACP,WAAW,KACzB,QAAQ,OAAO,CAkCjB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,qBAAqB,gBACjB,WAAW,KACzB,QAAQ,OAAO,CAQjB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,gBACP,WAAW,KACzB,QAAQ,OAAO,CAiBjB,CAAC;AAkFF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAmBxD,CAAC;AAEF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAoBxD,CAAC;AAEF,eAAO,MAAM,MAAM,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAKtE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,gBACR,WAAW,KACzB,QAAQ,OAAO,CAoBjB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,QAAO,OAAyB,CAAC"}
1
+ {"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAEzC,OAAO,EACoB,WAAW,EACrC,MAAM,SAAS,CAAC;AAajB,eAAO,IAAI,cAAc,SAAQ,CAAC;AAElC,eAAO,IAAI,cAAc,EAAE,MAAa,CAAC;AAEzC,eAAO,IAAI,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAQ,CAAC;AAQvD,eAAO,MAAM,2BAA2B,yCAAyC,CAAC;AAElF,eAAO,MAAM,SAAS;;qCAEe,MAAM;qCACN,MAAM;;;;CAI1C,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,eAAe;IACvB,GAAG,QAAQ;IACX,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,KAAK,UAAU;CAClB;AAED;;;;GAIG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;;OAMG;IACH,iBAAiB,sBAAsB;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACtF;;;;;OAKG;IACH,EAAE,CACE,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAChF,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC1E,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACxF,IAAI,CACA,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAChF,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC5E;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;CAChC;AAED;;;;GAIG;AACH,oBAAY,SAAS;IACjB;;;OAGG;IACH,iBAAiB,sBAAsB;CAC1C;AAID;;GAEG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,CAEhE;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,IAAI,CAElF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAM3C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAMxC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAMpE;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAoBD;;GAEG;AACH,wBAAgB,iBAAiB,WAEhC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,CAE7C;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,cAAc,EAAE,GAAG,QAI9C;AAqCD,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,GAAG,CAWjF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAyB3E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAMrF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAa3E,CAAC;AA6EF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,MAAM,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAKtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAoB5E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,QAAO,OAAyB,CAAC"}
@@ -2,6 +2,7 @@ import { EmbedConfig } from './types';
2
2
  /**
3
3
  * Parse and construct the ThoughtSpot hostname or IP address
4
4
  * from the embed configuration object.
5
+ *
5
6
  * @param config
6
7
  */
7
8
  export declare const getThoughtSpotHost: (config: EmbedConfig) => string;
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAqBtC;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,WAAY,WAAW,KAAG,MAiBxD,CAAC;AAEF,eAAO,MAAM,aAAa,WAAY,WAAW,KAAG,MAenD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAC1C,eAAO,MAAM,oBAAoB,SAAS,CAAC"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAqBtC;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,WAAY,WAAW,KAAG,MAiBxD,CAAC;AAEF,eAAO,MAAM,aAAa,WAAY,WAAW,KAAG,MAgBnD,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,mBAAmB,SAAS,CAAC;AAC1C,eAAO,MAAM,oBAAoB,SAAS,CAAC"}
@@ -45,6 +45,7 @@ export declare enum Page {
45
45
  }
46
46
  /**
47
47
  * The view configuration for full app embedding.
48
+ *
48
49
  * @group Embed components
49
50
  */
50
51
  export interface AppViewConfig extends ViewConfig {
@@ -70,8 +71,9 @@ export interface AppViewConfig extends ViewConfig {
70
71
  */
71
72
  pageId?: Page;
72
73
  /**
73
- * This puts a filter tag on the application. All metadata lists in the application, such as
74
- * Liveboards and answers, would be filtered by this tag.
74
+ * This puts a filter tag on the application. All metadata lists in the
75
+ * application, such as Liveboards and answers, would be filtered by this
76
+ * tag.
75
77
  */
76
78
  tag?: string;
77
79
  /**
@@ -81,18 +83,21 @@ export interface AppViewConfig extends ViewConfig {
81
83
  /**
82
84
  * Render liveboards using the new v2 rendering mode
83
85
  * This is a transient flag which is primarily meant for internal use
86
+ *
84
87
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
85
88
  * @hidden
86
89
  */
87
90
  liveboardV2?: boolean;
88
91
  /**
89
92
  * If set to true, the Search Assist feature is enabled.
93
+ *
90
94
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
91
95
  */
92
96
  enableSearchAssist?: boolean;
93
97
  }
94
98
  /**
95
99
  * Embeds full ThoughtSpot experience in a host application.
100
+ *
96
101
  * @group Embed components
97
102
  */
98
103
  export declare class AppEmbed extends V1Embed {
@@ -102,35 +107,42 @@ export declare class AppEmbed extends V1Embed {
102
107
  * Constructs a map of parameters to be passed on to the
103
108
  * embedded Liveboard or visualization.
104
109
  */
105
- private getEmbedParams;
110
+ protected getEmbedParams(): string;
106
111
  /**
107
112
  * Constructs the URL of the ThoughtSpot app page to be rendered.
113
+ *
108
114
  * @param pageId The ID of the page to be embedded.
109
115
  */
110
116
  private getIFrameSrc;
111
117
  /**
112
118
  * Gets the ThoughtSpot route of the page for a particular page ID.
119
+ *
113
120
  * @param pageId The identifier for a page in the ThoughtSpot app.
114
121
  */
115
122
  private getPageRoute;
116
123
  /**
117
124
  * Formats the path provided by the user.
125
+ *
118
126
  * @param path The URL path.
119
127
  * @returns The URL path that the embedded app understands.
120
128
  */
121
129
  private formatPath;
122
130
  /**
123
131
  * Navigate to particular page for app embed. eg:answers/pinboards/home
124
- * This is used for embedding answers, pinboards, visualizations and full application only.
132
+ * This is used for embedding answers, pinboards, visualizations and full application
133
+ * only.
134
+ *
125
135
  * @param path string | number The string, set to iframe src and navigate to new page
126
136
  * eg: appEmbed.navigateToPage('pinboards')
127
- * When used with `noReload` this can also be a number like 1/-1 to go forward/back.
137
+ * When used with `noReload` (default: true) this can also be a number
138
+ * like 1/-1 to go forward/back.
128
139
  * @param noReload boolean Trigger the navigation without reloading the page
129
140
  * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
130
141
  */
131
142
  navigateToPage(path: string | number, noReload?: boolean): void;
132
143
  /**
133
144
  * Renders the embedded application pages in the ThoughtSpot app.
145
+ *
134
146
  * @param renderOptions An object containing the page ID
135
147
  * to be embedded.
136
148
  */
@@ -1 +1 @@
1
- {"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAGH,WAAW,EAEX,UAAU,EACb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;gBAGxB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAI/D;;;OAGG;IACH,OAAO,CAAC,cAAc;IAmBtB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;OAGG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;OAQG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAuBpE;;;;OAIG;IACI,MAAM,IAAI,QAAQ;CAU5B"}
1
+ {"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EACmB,WAAW,EAAa,UAAU,EAC3D,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;gBAGxB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAI/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAoCxB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAWpB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;;OAWG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;;OAKG;IACI,MAAM,IAAI,QAAQ;CAO5B"}
@@ -16,7 +16,10 @@ export { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogou
16
16
  */
17
17
  export declare const handleAuth: () => Promise<boolean>;
18
18
  /**
19
- * Prefetches static resources from the specified URL. Web browsers can then cache the prefetched resources and serve them from the user's local disk to provide faster access to your app.
19
+ * Prefetches static resources from the specified URL. Web browsers can then cache the
20
+ * prefetched resources and serve them from the user's local disk to provide faster access
21
+ * to your app.
22
+ *
20
23
  * @param url The URL provided for prefetch
21
24
  * @param prefetchFeatures Specify features which needs to be prefetched.
22
25
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
@@ -26,9 +29,9 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
26
29
  /**
27
30
  * Initializes the Visual Embed SDK globally and perform
28
31
  * authentication if applicable.
32
+ *
29
33
  * @param embedConfig The configuration object containing ThoughtSpot host,
30
34
  * authentication mechanism and so on.
31
- *
32
35
  * @example
33
36
  * ```js
34
37
  * const authStatus = init({
@@ -37,19 +40,22 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
37
40
  * });
38
41
  * authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
39
42
  * ```
40
- *
41
- * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success, failure and logout. See {@link AuthStatus}
43
+ * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success,
44
+ * failure and logout. See {@link AuthStatus}
42
45
  * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
43
46
  * @group Authentication / Init
44
47
  */
45
48
  export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter;
49
+ /**
50
+ *
51
+ */
46
52
  export declare function disableAutoLogin(): void;
47
53
  /**
48
- * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to prevent
49
- * the SDK from automatically logging in again.
54
+ * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
55
+ * prevent the SDK from automatically logging in again.
50
56
  *
51
- * You can call the `init` method again to re login, if autoLogin is set to true in this
52
- * second call it will be honored.
57
+ * You can call the `init` method again to re login, if autoLogin is set to
58
+ * true in this second call it will be honored.
53
59
  *
54
60
  * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
55
61
  * @returns Promise which resolves when logout completes.
@@ -58,9 +64,14 @@ export declare function disableAutoLogin(): void;
58
64
  */
59
65
  export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
60
66
  /**
61
- * Renders functions in a queue, resolves to next function only after the callback next is called
67
+ * Renders functions in a queue, resolves to next function only after the callback next
68
+ * is called
69
+ *
62
70
  * @param fn The function being registered
63
71
  */
64
72
  export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
73
+ /**
74
+ *
75
+ */
65
76
  export declare function reset(): void;
66
77
  //# sourceMappingURL=base.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AAYA,OAAO,EAAY,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACnE,OAAO,EAMH,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEZ,gBAAgB,EACnB,MAAM,SAAS,CAAC;AAUjB,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AACzC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,QAAO,WAAqB,CAAC;AAExD,eAAO,MAAM,cAAc,QAAO,QAAQ,OAAO,CAAgB,CAAC;AAElE,OAAO,EACH,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,GACf,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,QAAO,QAAQ,OAAO,CAe5C,CAAC;AASF;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,SACX,MAAM,qBACO,gBAAgB,EAAE,KACtC,IAqBF,CAAC;AAiCF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,gBAgC/C,CAAC;AAEF,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,MAAM,uCAAoC,QAAQ,OAAO,CAQrE,CAAC;AAIF;;;GAGG;AACH,eAAO,MAAM,aAAa,sBACH,GAAG,KAAK,IAAI,KAAK,QAAQ,GAAG,CAAC,KACjD,QAAQ,GAAG,CAQb,CAAC;AAGF,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AAYA,OAAO,EAAY,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACnE,OAAO,EAMH,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEZ,gBAAgB,EACnB,MAAM,SAAS,CAAC;AAUjB,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AACzC;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,QAAO,WAAqB,CAAC;AAExD,eAAO,MAAM,cAAc,QAAO,QAAQ,OAAO,CAAgB,CAAC;AAElE,OAAO,EACH,iBAAiB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,YAAY,GAC3E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,QAAO,QAAQ,OAAO,CAe5C,CAAC;AASF;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,SAAU,MAAM,qBAAqB,gBAAgB,EAAE,KAAG,IAqB9E,CAAC;AAiCF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,gBA2B/C,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,MAAM,uCAAoC,QAAQ,OAAO,CAQrE,CAAC;AAIF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,sBAAuB,GAAG,KAAK,IAAI,KAAK,QAAQ,GAAG,CAAC,KAAG,QAAQ,GAAG,CAQ3F,CAAC;AAGF;;GAEG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}
@@ -12,12 +12,14 @@ import { DOMSelector, HostEvent, ViewConfig } from '../types';
12
12
  import { V1Embed } from './ts-embed';
13
13
  /**
14
14
  * The configuration for the embedded Liveboard or visualization page view.
15
+ *
15
16
  * @group Embed components
16
17
  */
17
18
  export interface LiveboardViewConfig extends ViewConfig {
18
19
  /**
19
20
  * If set to true, the embedded object container dynamically resizes
20
21
  * according to the height of the Liveboard.
22
+ *
21
23
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
22
24
  */
23
25
  fullHeight?: boolean;
@@ -25,6 +27,7 @@ export interface LiveboardViewConfig extends ViewConfig {
25
27
  * This is the minimum height(in pixels) for a full height Liveboard.
26
28
  * Setting this height helps resolves issues with empty Liveboards and
27
29
  * other screens navigable from a Liveboard.
30
+ *
28
31
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
29
32
  * @default 500
30
33
  */
@@ -36,11 +39,13 @@ export interface LiveboardViewConfig extends ViewConfig {
36
39
  /**
37
40
  * The Liveboard to display in the embedded view.
38
41
  * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
42
+ *
39
43
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
40
44
  */
41
45
  liveboardId?: string;
42
46
  /**
43
47
  * To support backward compatibility
48
+ *
44
49
  * @hidden
45
50
  */
46
51
  pinboardId?: string;
@@ -51,6 +56,7 @@ export interface LiveboardViewConfig extends ViewConfig {
51
56
  /**
52
57
  * If set to true, all filter chips from a
53
58
  * Liveboard page will be read-only (no X buttons)
59
+ *
54
60
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
55
61
  */
56
62
  preventLiveboardFilterRemoval?: boolean;
@@ -58,27 +64,32 @@ export interface LiveboardViewConfig extends ViewConfig {
58
64
  * Array of viz ids which should be visible when the liveboard
59
65
  * first renders. This can be changed by triggering the "SetVisibleVizs"
60
66
  * event.
67
+ *
61
68
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
62
69
  */
63
70
  visibleVizs?: string[];
64
71
  /**
65
72
  * To support backward compatibilty
73
+ *
66
74
  * @hidden
67
75
  */
68
76
  preventPinboardFilterRemoval?: boolean;
69
77
  /**
70
78
  * Render embedded Liveboards and visualizations in the new Liveboard experience mode
79
+ *
71
80
  * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
72
81
  */
73
82
  liveboardV2?: boolean;
74
83
  /**
75
84
  * Tab Id of the Liveboard that is supposed to be active
85
+ *
76
86
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
77
87
  */
78
88
  activeTabId?: string;
79
89
  }
80
90
  /**
81
91
  * Embed a ThoughtSpot Liveboard or visualization
92
+ *
82
93
  * @group Embed components
83
94
  */
84
95
  export declare class LiveboardEmbed extends V1Embed {
@@ -89,19 +100,17 @@ export declare class LiveboardEmbed extends V1Embed {
89
100
  * Construct a map of params to be passed on to the
90
101
  * embedded Liveboard or visualization.
91
102
  */
92
- private getEmbedParams;
103
+ protected getEmbedParams(): string;
104
+ private getIframeSuffixSrc;
93
105
  /**
94
106
  * Construct the URL of the embedded ThoughtSpot Liveboard or visualization
95
107
  * to be loaded within the iframe.
96
- * @param liveboardId The GUID of the Liveboard.
97
- * @param vizId The optional GUID of a visualization within the Liveboard.
98
- * @param runtimeFilters A list of runtime filters to be applied to
99
- * the Liveboard or visualization on load.
100
108
  */
101
109
  private getIFrameSrc;
102
110
  /**
103
111
  * Set the iframe height as per the computed height received
104
112
  * from the ThoughtSpot app.
113
+ *
105
114
  * @param data The event payload
106
115
  */
107
116
  private updateIFrameHeight;
@@ -109,16 +118,19 @@ export declare class LiveboardEmbed extends V1Embed {
109
118
  private setIframeHeightForNonEmbedLiveboard;
110
119
  /**
111
120
  * Triggers an event to the embedded app
121
+ *
112
122
  * @param messageType The event type
113
123
  * @param data The payload to send with the message
114
124
  */
115
125
  trigger(messageType: HostEvent, data?: any): Promise<any>;
116
126
  /**
117
127
  * Render an embedded ThoughtSpot Liveboard or visualization
128
+ *
118
129
  * @param renderOptions An object specifying the Liveboard ID,
119
130
  * visualization ID and the runtime filters.
120
131
  */
121
132
  render(): LiveboardEmbed;
133
+ navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
122
134
  }
123
135
  /**
124
136
  * @hidden
@@ -1 +1 @@
1
- {"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,UAAU,EACb,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACnD;;;;OAIG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IAIrE;;;OAGG;IACH,OAAO,CAAC,cAAc;IA6CtB;;;;;;;OAOG;IACH,OAAO,CAAC,YAAY;IA8BpB;;;;OAIG;IACH,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAIzC;IAEF;;;;OAIG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAQpE;;;;OAIG;IACI,MAAM,IAAI,cAAc;CA8BlC;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAG"}
1
+ {"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,UAAU,EACb,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACnD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IASrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IA4CxB,OAAO,CAAC,kBAAkB;IAa1B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAcpB;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAIzC;IAEF;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAQpE;;;;;OAKG;IACI,MAAM,IAAI,cAAc;IASxB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAWvF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAI"}
@@ -8,11 +8,13 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
8
8
  /**
9
9
  * The array of data source GUIDs to set on load.
10
10
  * Only a single dataSource supported currently.
11
+ *
11
12
  * @deprecated Use dataSource instead
12
13
  */
13
14
  dataSources?: string[];
14
15
  /**
15
16
  * The array of data source GUIDs to set on load.
17
+ *
16
18
  * @version: SDK: 1.19.0
17
19
  */
18
20
  dataSource?: string;
@@ -36,6 +38,7 @@ export declare class SearchBarEmbed extends TsEmbed {
36
38
  /**
37
39
  * Construct the URL of the embedded ThoughtSpot search to be
38
40
  * loaded in the iframe
41
+ *
39
42
  * @param dataSources A list of data source GUIDs
40
43
  */
41
44
  private getIFrameSrc;
@@ -1 +1 @@
1
- {"version":3,"file":"search-bar.d.ts","sourceRoot":"","sources":["search-bar.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA8B,UAAU,EAAE,MAAM,UAAU,CAAC;AAElE,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CAAC,UAAU,EAAE,gBAAgB,GAAG,YAAY,CAAC;IACzD;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;gBAE9B,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB;IAKhE;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAqCpB;;OAEG;IACI,MAAM,IAAI,cAAc;CAOlC"}
1
+ {"version":3,"file":"search-bar.d.ts","sourceRoot":"","sources":["search-bar.tsx"],"names":[],"mappings":"AAAA,OAAO,EACyB,UAAU,EACzC,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,UAAU,EAAE,gBAAgB,GAAG,YAAY,CAAC;IAC1F;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;gBAE9B,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB;IAKhE;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAmCpB;;OAEG;IACI,MAAM,IAAI,cAAc;CAOlC"}
@@ -19,7 +19,8 @@ export interface SearchOptions {
19
19
  /**
20
20
  * Boolean to determine if the search should be executed or not.
21
21
  * if it is executed, put the focus on the results.
22
- * if it’s not executed, put the focus in the search bar - at the end of the tokens
22
+ * if it’s not executed, put the focus in the search bar - at the end of
23
+ * the tokens
23
24
  */
24
25
  executeSearch?: boolean;
25
26
  }
@@ -44,12 +45,9 @@ export interface SearchViewConfig extends ViewConfig {
44
45
  * using raw answer data.
45
46
  */
46
47
  hideResults?: boolean;
47
- /**
48
- * If set to true, expands all the data sources panel.
49
- */
50
- expandAllDataSource?: boolean;
51
48
  /**
52
49
  * If set to true, the Search Assist feature is enabled.
50
+ *
53
51
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
54
52
  */
55
53
  enableSearchAssist?: boolean;
@@ -61,16 +59,19 @@ export interface SearchViewConfig extends ViewConfig {
61
59
  /**
62
60
  * The array of data source GUIDs to set on load.
63
61
  * Only a single dataSource supported currently.
62
+ *
64
63
  * @deprecated Use dataSource instead
65
64
  */
66
65
  dataSources?: string[];
67
66
  /**
68
67
  * The array of data source GUIDs to set on load.
68
+ *
69
69
  * @version: SDK: 1.19.0
70
70
  */
71
71
  dataSource?: string;
72
72
  /**
73
73
  * The initial search query to load the answer with.
74
+ *
74
75
  * @deprecated Use {@link searchOptions} instead
75
76
  */
76
77
  searchQuery?: string;
@@ -85,6 +86,7 @@ export interface SearchViewConfig extends ViewConfig {
85
86
  /**
86
87
  * If set to true, search page will render without the Search Bar
87
88
  * The chart/table should still be visible.
89
+ *
88
90
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
89
91
  */
90
92
  hideSearchBar?: boolean;
@@ -106,9 +108,11 @@ export declare class SearchEmbed extends TsEmbed {
106
108
  * ThoughtSpot search will be initialized with.
107
109
  */
108
110
  private getDataSourceMode;
111
+ protected getEmbedParams(): string;
109
112
  /**
110
113
  * Construct the URL of the embedded ThoughtSpot search to be
111
114
  * loaded in the iframe
115
+ *
112
116
  * @param answerId The GUID of a saved answer
113
117
  * @param dataSources A list of data source GUIDs
114
118
  */
@@ -1 +1 @@
1
- {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEH,WAAW,EAEX,MAAM,EACN,UAAU,EAEb,MAAM,UAAU,CAAC;AAMlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAMrC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,eAAO,MAAM,uCAAuC,UAMnD,CAAC;AAEF;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACpC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBAE3B,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB;IAKlE;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAYzB;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IA8DpB;;OAEG;IACI,MAAM,IAAI,WAAW;CAkB/B"}
1
+ {"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEH,WAAW,EAEX,MAAM,EACN,UAAU,EAEb,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAMrC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,eAAO,MAAM,uCAAuC,UAMnD,CAAC;AAEF;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACpC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBAE3B,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB;IAKlE;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAYzB,SAAS,CAAC,cAAc,IAAI,MAAM;IAyDlC;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACI,MAAM,IAAI,WAAW;CAkB/B"}