@thoughtspot/visual-embed-sdk 1.29.0-alpha.7 → 1.29.0-alpha.SCAL-205893-1

package/dist/visual-embed-sdk-react-full.d.ts

@@ -1746,12 +1746,6 @@ export declare let loggedInStatus: boolean;
 export declare let samlAuthWindow: Window;
 export declare let samlCompletionPromise: Promise<void>;
 export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
-interface sessionInfoInterface {
-        userGUID: any;
-        isPublicUser: any;
-        mixpanelToken: any;
-        [key: string]: any;
-}
 /**
     * Enum for auth failure types. This is the parameter passed to the listner
     * of {@link AuthStatus.FAILURE}.
@@ -1869,7 +1863,7 @@ export declare function notifyAuthSDKSuccess(): void;
 /**
     *
     */
-export declare function notifyAuthSuccess(): void;
+export declare function notifyAuthSuccess(): Promise<void>;
 /**
     *
     * @param failureType
@@ -1879,19 +1873,23 @@ export declare function notifyAuthFailure(failureType: AuthFailureType): void;
     *
     */
 export declare function notifyLogout(): void;
-export declare const initSession: (sessionDetails: sessionInfoInterface) => void;
-export declare const getSessionDetails: (sessionInfoResp: any) => sessionInfoInterface;
 /**
-    * Return releaseVersion if available
+    * Services to be called after the login is successful,
+    * This should be called after the cookie is set for cookie auth or
+    * after the token is set for cookieless.
+    *
+    * @return {Promise<void>}
+    * @example
+    * ```js
+    * await postLoginService();
+    * ```
+    * @version SDK: 1.28.3 | ThoughtSpot: *
     */
-export declare function getReleaseVersion(): string;
+export declare function postLoginService(): Promise<void>;
 /**
-    * Return a promise that resolves with the session information when
-    * authentication is successful. And info is available.
-    *
-    * @group Global methods
+    * Return releaseVersion if available
     */
-export declare function getSessionInfo(): Promise<sessionInfoInterface>;
+export declare function getReleaseVersion(): string;
 /**
     * Perform token based authentication
     *
@@ -1927,7 +1925,72 @@ export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean
     * Check if we are authenticated to the ThoughtSpot cluster
     */
 export declare const isAuthenticated: () => boolean;
-export {};
+
+export type SessionInfo = {
+        releaseVersion: string;
+        userGUID: string;
+        currentOrgId: number;
+        privileges: string[];
+        mixpanelToken: string;
+        isPublicUser: boolean;
+        clusterId: string;
+        clusterName: string;
+        [key: string]: any;
+};
+/**
+    * Returns the session info object and caches it for future use.
+    * Once fetched the session info object is cached and returned from the cache on
+    * subsequent calls.
+    *
+    * @example ```js
+    * const sessionInfo = await getSessionInfo();
+    * console.log(sessionInfo);
+    * ```
+    * @version SDK: 1.28.3 | ThoughtSpot: *
+    * @returns {Promise<SessionInfo>} The session info object.
+    */
+export declare function getSessionInfo(): Promise<SessionInfo>;
+/**
+    * Returns the cached session info object. If the client is not authenticated the
+    * function will return null.
+    *
+    * @example ```js
+    * const sessionInfo = getCachedSessionInfo();
+    * if (sessionInfo) {
+    *   console.log(sessionInfo);
+    * } else {
+    *   console.log('Not authenticated');
+    * }
+    * ```
+    * @returns {SessionInfo | null} The session info object.
+    * @version SDK: 1.28.3 | ThoughtSpot: *
+    */
+export declare function getCachedSessionInfo(): SessionInfo | null;
+/**
+    * Processes the session info response and returns the session info object.
+    *
+    *  @param sessionInfoResp {any} Response from the session info API.
+    *  @returns {SessionInfo} The session info object.
+    *  @example ```js
+    *  const sessionInfoResp = await fetch(sessionInfoPath);
+    *  const sessionInfo = getSessionDetails(sessionInfoResp);
+    *  console.log(sessionInfo);
+    *  ```
+    * @version SDK: 1.28.3 | ThoughtSpot: *
+    */
+export declare const getSessionDetails: (sessionInfoResp: any) => SessionInfo;
+/**
+    * Resets the cached session info object and forces a new fetch on the next call.
+    *
+    * @example ```js
+    * resetCachedSessionInfo();
+    * const sessionInfo = await getSessionInfo();
+    * console.log(sessionInfo);
+    * ```
+    * @version SDK: 1.28.3 | ThoughtSpot ts7.april.cl, 7.2.1
+    * @returns {void}
+    */
+export declare function resetCachedSessionInfo(): void;
 
 /**
     * Copyright (c) 2023
@@ -2513,6 +2576,23 @@ export interface EmbedConfig {
             * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
             */
         currencyFormat?: string;
+        /**
+            * This flag is used to disable the token verification in the SDK.
+            * Enabling this flag will also disable the caching of the token.
+            *
+            * @hidden
+            *
+            * @example
+            * ```js
+            * init({
+            *   ...embedConfig,
+            *   disableTokenVerification : true
+            * })
+            * ```
+            *
+            * @version SDK: 1.28.5 | Thoughtspot: *
+            */
+        disableTokenVerification?: boolean;
 }
 export interface LayoutConfig {
 }
@@ -3112,7 +3192,7 @@ export interface RuntimeFilter {
             * a single operand, whereas other operators like BW and IN accept multiple
             * operands.
             */
-        values: (number | boolean | string)[];
+        values: (number | boolean | string | bigint)[];
 }
 /**
     * A filter that can be applied to ThoughtSpot Answers, Liveboards, or
@@ -3166,6 +3246,8 @@ export declare enum EmbedEvent {
         /**
             * Authentication has either succeeded or failed.
             *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+            *
             * @example
             *```js
             * appEmbed.on(EmbedEvent.AuthInit, payload => {
@@ -3179,6 +3261,8 @@ export declare enum EmbedEvent {
             * The embed object container has loaded.
             *
             * @returns timestamp - The timestamp when the event was generated.
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             *```js
             * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
@@ -3193,6 +3277,8 @@ export declare enum EmbedEvent {
             * Data pertaining to answer or Liveboard is received
             *
             * @return data - The answer or Liveboard data
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             *```js
             * liveboardEmbed.on(EmbedEvent.Data, payload => {
@@ -3211,6 +3297,7 @@ export declare enum EmbedEvent {
         /**
             * Search query has been updated by the user.
             *
+            * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
             * @example
             *```js
             * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
@@ -3220,12 +3307,14 @@ export declare enum EmbedEvent {
         /**
             * A drill-down operation has been performed.
             *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+            *
             * @returns additionalFilters - Any additional filters applied
             * @returns drillDownColumns - The columns on which drill down was performed
             * @returns nonFilteredColumns - The columns that were not filtered
             * @example
             *```js
-            * searchEmbed.trigger(EmbedEvent.DrillDown, {
+            * searchEmbed.on(EmbedEvent.DrillDown, {
             *    points: {
             *        clickedPoint,
             *        selectedPoints: selectedPoint
@@ -3258,6 +3347,8 @@ export declare enum EmbedEvent {
             * One or more data sources have been selected.
             *
             * @returns dataSourceIds - the list of data sources
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
@@ -3285,6 +3376,8 @@ export declare enum EmbedEvent {
             * @returns actionId - ID of the custom action
             * @returns payload {@link CustomActionPayload} - Response payload with the
             * Answer or Liveboard data
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             * ```js
             * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -3332,21 +3425,18 @@ export declare enum EmbedEvent {
         /**
             * An error has occurred. This event is fired for the following error types:
             *
-            *  API - API call failure error.
-            *
-            *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
-            *
-            *  SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
-            *
-            *  NON_EXIST_FILTER - Error due to a non-existent filter.
+            *  `API` - API call failure error.
+            *  `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen mode.
+            *  `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value filter.
+            *  `NON_EXIST_FILTER` - Error due to a non-existent filter.
+            *  `INVALID_DATE_VALUE` - Invalid date value error.
+            *  `INVALID_OPERATOR` - Use of invalid operator during filter application.
             *
-            *  INVALID_DATE_VALUE - Invalid date value error.
-            *
-            *  INVALID_OPERATOR - Use of invalid operator during filter application.
-            *
-            *  For more information, see [Developer Documentation](https://developers.thoughtspot.com/docs/events-app-integration#errorType)
+            *  For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
             *
             * @returns error - An error object or message
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
             * @example
             * ```js
             * // API error
@@ -3372,6 +3462,9 @@ export declare enum EmbedEvent {
             * The embedded object has sent an alert.
             *
             * @returns alert - An alert object
+            *
+            * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+            *
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.Alert)
@@ -3381,6 +3474,8 @@ export declare enum EmbedEvent {
         /**
             * The ThoughtSpot auth session has expired.
             *
+            * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
+            *
             * @example
             *```js
             * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
@@ -3434,6 +3529,7 @@ export declare enum EmbedEvent {
         /**
             * Detects the route change.
             *
+            * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
             * @example
             *```js
             * searchEmbed.on(EmbedEvent.RouteChange, payload =>
@@ -3514,8 +3610,7 @@ export declare enum EmbedEvent {
             */
         LiveboardRendered = "PinboardRendered",
         /**
-            * This can be used to register an event listener which
-            * is triggered on all events.
+            * Emits all events.
             *
             * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
             * @example
@@ -3532,13 +3627,13 @@ export declare enum EmbedEvent {
             * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //Emit when action starts
             *  searchEmbed.on(EmbedEvent.Save, payload => {
             *    console.log('Save', payload)
             *  }, {
             *    start: true
             * })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.Save, payload => {
             *    console.log('Save', payload)
             * })
@@ -3556,7 +3651,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(HostEvent.Download, {
+            * liveboardEmbed.on(EmbedEvent.Download, {
             * vizId: '730496d6-6903-4601-937e-2c691821af3c'
             * })
             *```
@@ -3568,10 +3663,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
             *   console.log('download PNG', payload)}, {start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
             *   console.log('download PNG', payload)})
             *```
@@ -3583,10 +3678,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
             *   console.log('download PDF', payload)}, {start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
             *   console.log('download PDF', payload)})
             *```
@@ -3598,10 +3693,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
             *   console.log('download CSV', payload)}, {start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
             *    console.log('download CSV', payload)})
             *```
@@ -3613,10 +3708,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
             *   console.log('download Xlsx', payload)}, { start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
             *   console.log('download Xlsx', payload)})
             *```
@@ -3628,7 +3723,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
             *    console.log('delete answer', payload)}, {start: true })
             * //trigger when action is completed
@@ -3643,13 +3738,13 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.Pin, payload => {
             *    console.log('pin', payload)
             * }, {
             * start: true
             * })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.Pin, payload => {
             *    console.log('pin', payload)
             * })
@@ -3662,13 +3757,13 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
             *   console.log('SpotIQAnalyze', payload)
             * }, {
             * start: true
             * })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
             *   console.log('SpotIQ analyze', payload)
             * })
@@ -3681,13 +3776,13 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.Share, payload => {
             *    console.log('Share', payload)
             * }, {
             * start: true
             * })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.Share, payload => {
             *   console.log('Share', payload)
             * })
@@ -3762,10 +3857,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * searchEmbed.on(EmbedEvent.ExportTML, payload => {
             *     console.log('Export TML', payload)}, { start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * searchEmbed.on(EmbedEvent.ExportTML, payload => {
             *     console.log('Export TML', payload)})
             *```
@@ -3789,10 +3884,10 @@ export declare enum EmbedEvent {
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
-            * //trigger when action starts
+            * //emit when action starts
             * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
             *    console.log('Copy and edit', payload)}, {start: true })
-            * //trigger when action ends
+            * //emit when action ends
             * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
             *    console.log('Copy and edit', payload)})
             *```
@@ -3894,7 +3989,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(HostEvent.Present)
+            * liveboardEmbed.on(EmbedEvent.Present)
             *```
             * @example
             *```js
@@ -3910,7 +4005,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.Delete,
+            * liveboardEmbed.on(EmbedEvent.Delete,
             *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
             */
@@ -3921,7 +4016,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.SchedulesList)
+            * liveboardEmbed.on(EmbedEvent.SchedulesList)
             *```
             */
         SchedulesList = "schedule-list",
@@ -3931,7 +4026,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.Cancel)
+            * liveboardEmbed.on(EmbedEvent.Cancel)
             *```
             */
         Cancel = "cancel",
@@ -3941,7 +4036,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.Explore,  {
+            * liveboardEmbed.on(EmbedEvent.Explore,  {
             *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
             */
@@ -3952,7 +4047,7 @@ export declare enum EmbedEvent {
             * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
             * @example
             *```js
-            * liveboardEmbed.trigger(EmbedEvent.CopyLink, {
+            * liveboardEmbed.on(EmbedEvent.CopyLink, {
             *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
             *```
             */
@@ -4330,7 +4425,7 @@ export declare enum HostEvent {
             *
             * @example
             * ```js
-            * liveboardEmbed.trigger(HostEvent.getexportrequestforcurrentpinboard).then(
+            * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard).then(
             * data=>console.log(data))
             * ```
             * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1.sw
@@ -4794,7 +4889,7 @@ export declare enum HostEvent {
             *
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
-            *  filter: { column: 'column name', oper: 'IN', values: [1,2,3], is_mandatory: false }
+            *  filter: { column: 'column name', oper: 'IN', values: [1,2,3]}
             * })
             * ```
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -5944,7 +6039,7 @@ export declare enum Action {
             * disabledActions: [Action.TML] // to disable all TML actions
             * ```
             *
-            * @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
+            * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
             */
         TML = "tml",
         /**
@@ -6518,6 +6613,16 @@ export interface UnderlyingDataPoint {
     *     const data = await underlying.fetchData(0, 100);
     *  })
     * ```
+    * @example
+    * ```js
+    * embed.on(EmbedEvent.Data, async (e) => {
+    *     const service = await embed.getAnswerService();
+    *     await service.addColumns([
+    *         "<column guid>"
+    *     ]);
+    *     console.log(await service.fetchData());
+    * });
+    * ```
     * @version SDK: 1.25.0| ThoughtSpot: 9.10.0.cl
     * @group Events
     */
@@ -6657,7 +6762,7 @@ export declare function uploadMixpanelEvent(eventId: string, eventProps?: {}): v
     *
     * @param sessionInfo
     */
-export declare function initMixpanel(sessionInfo: any): void;
+export declare function initMixpanel(sessionInfo: SessionInfo): void;
 /**
     *
     */
@@ -6674,7 +6779,7 @@ export declare function testResetMixpanel(): void;
   */
 export declare const tokenizedFetch: typeof fetch;
 
-export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promise<string>;
+export declare function getAuthenticationToken(embedConfig: EmbedConfig): Promise<string>;
 /**
   * Resets the auth token and a new token will be fetched on the next request.
   *