@thoughtspot/visual-embed-sdk 1.28.0-alpha.1 → 1.28.0-alpha.3

package/src/tokenizedFetch.ts

@@ -3,6 +3,15 @@ import { getEmbedConfig } from './embed/embedConfig';
 
 import { AuthType } from './types';
 
+/**
+ * Fetch wrapper that adds the authentication token to the request.
+ * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
+ *
+ * @param input
+ * @param init
+ * @version SDK: 1.28.0
+ * @group Global methods
+ */
 export const tokenizedFetch: typeof fetch = async (input, init): Promise<Response> => {
     const embedConfig = getEmbedConfig();
     if (embedConfig.authType !== AuthType.TrustedAuthTokenCookieless) {

package/src/types.ts

@@ -145,6 +145,7 @@ export enum AuthType {
      *      .then((response) => response.json())
      *      .then((data) => data.token);
      *  }
+     * });
      * ```
      */
     TrustedAuthToken = 'AuthServer',
@@ -179,15 +180,30 @@ export enum AuthType {
 }
 
 export enum HomeLeftNavItem {
-    QueryBuilder = 'query-builder',
+    /**
+     * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+     */
+    SearchData = 'search-data',
+    /**
+     * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+     */
     Home = 'insights-home',
+    /**
+     * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+     */
     Liveboards = 'liveboards',
+    /**
+     * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+     */
     Answers = 'answers',
+    /**
+     * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+     */
     MonitorSubscription = 'monitor-alerts',
+    /**
+     * @version SDK: 1.27.9| ThoughtSpot: 9.12.0.cl
+     */
     SpotIQAnalysis = 'spotiq-analysis',
-    Tutorials = 'tutorials',
-    Documentation = 'documentation',
-    Community = 'community',
 }
 export type DOMSelector = string | HTMLElement;
 
@@ -246,6 +262,8 @@ export interface CustomStyles {
 /**
  * Configuration to define the customization on the Embedded
  * Thoughtspot components.
+ * You can customize styles, text strings, and icons.
+ * For more information, see https://developers.thoughtspot.com/docs/custom-css.
  *
  * @example
  * ```js
@@ -260,7 +278,12 @@ export interface CustomStyles {
  *     },
  *     content: {
  *      strings: {
- *        'LIVEBOARDS': 'Dashboards'
+ *        'LIVEBOARDS': 'Dashboards',
+ *        'ANSWERS': 'Visualizations',
+ *        'Edit': 'Modify',
+ *        'Show underlying data': 'Show source data',
+ *        'SpotIQ': 'Insights',
+ *        'Monitor': 'Alerts',
  *      }
  *     },
  *     iconSpriteUrl: 'https://my-custom-icon-sprite.svg'
@@ -293,12 +316,6 @@ export interface EmbedConfig {
      * The ThoughtSpot cluster hostname or IP address.
      */
     thoughtSpotHost: string;
-    /**
-     * If true, all the iframe links will have /v2 added automatically.
-     * If false, all the iframe links will have /v1 added automatically.
-     * If undefined, nothing will be added
-     */
-    enableReactShell?: boolean | undefined;
     /**
      * The authentication mechanism to use.
      */
@@ -561,6 +578,12 @@ export interface EmbedConfig {
      * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
      */
     logLevel?: LogLevel;
+    /**
+     * Disables the Mixpanel tracking from the SDK.
+     *
+     * @version SDK: 1.27.9
+     */
+    disableSDKTracking?: boolean;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -740,9 +763,14 @@ export interface ViewConfig {
     usePrerenderedIfAvailable?: boolean;
     /**
      * Boolean to exclude runtimeFilters in the URL
+     * By default it is true, this flag removes runtime filters from the URL
+     * when set to false, runtime filters will be included in the URL.
      *
-     * @default false
-     * @hidden
+     * Irrespective of this flag, runtime filters ( if passed ) will be applied to the
+     * embedded view.
+     *
+     * @default true
+     * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl
      */
     excludeRuntimeFiltersfromURL?: boolean;
     /**
@@ -764,16 +792,24 @@ export interface ViewConfig {
     hiddenTabs?: string[];
     /**
      * Hide the home page modules
-     * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+     * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
      *
-     * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+     *
+     * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
      */
     hiddenHomepageModules?: HomepageModule[];
     /**
      * reordering the home page modules
      * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
      *
-     * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl onwards).
+     *
+     * @version SDK: 1.27.9| Thoughtspot: 9.12.0.cl
      */
     reorderedHomepageModules?: HomepageModule[];
     /**
@@ -800,7 +836,11 @@ export interface ViewConfig {
      * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
      * ```
      *
-     * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
+     *
+     * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
      */
     hiddenHomeLeftNavItems?: HomeLeftNavItem[];
     /**
@@ -991,6 +1031,10 @@ export enum HomepageModule {
     MyLibrary = 'MY_LIBRARY',
     /**
      * Trending list
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available in Early Access from 9.12.0.cl onwards).
      */
     Trending = 'TRENDING',
     /**
@@ -1132,7 +1176,7 @@ export enum EmbedEvent {
      * @returns nonFilteredColumns - The columns that were not filtered
      * @example
      *```js
-     * searchEmbed.trigger(HostEvent.DrillDown, {
+     * searchEmbed.trigger(EmbedEvent.DrillDown, {
      *    points: {
      *        clickedPoint,
      *        selectedPoints: selectedPoint
@@ -1224,7 +1268,7 @@ export enum EmbedEvent {
      * @important
      * @example
      * ```js
-     * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
+     * embed.on(EmbedEvent.VizPointClick, ({data}) => {
      *   console.log(
      *    data.vizId, // viz id
      *    data.clickedPoint.selectedAttributes[0].value,
@@ -1237,15 +1281,41 @@ export enum EmbedEvent {
      */
     VizPointClick = 'vizPointClick',
     /**
-     * An error has occurred.
+     * 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.
+     *
+     *  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)
      *
      * @returns error - An error object or message
      * @example
      * ```js
-     * SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
-     * //show error messaage
-     *  function showErrorMsg() {
-     *    document.getElementById("error");
+     * // API error
+     * SearchEmbed.on(EmbedEvent.Error, (error) => {
+     *   console.log(error);
+     *  // { type: "Error", data: { errorType: "API", error: { message: '...', error: '...' } } }
+     * });
+     * ```
+     * @example
+     * ```js
+     * // Fullscreen error (Errors during presenting of a liveboard)
+     * LiveboardEmbed.on(EmbedEvent.Error, (error) => {
+     *   console.log(error);
+     *   // { type: "Error", data: { errorType: "FULLSCREEN", error: {
+     *   //   message: "Fullscreen API is not enabled",
+     *   //   stack: "..."
+     *   // } }}
+     * })
      * ```
      */
     Error = 'Error',
@@ -1791,7 +1861,7 @@ export enum EmbedEvent {
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
-     * liveboardEmbed.trigger(HostEvent.Delete,
+     * liveboardEmbed.trigger(EmbedEvent.Delete,
      *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
      */
@@ -1802,7 +1872,7 @@ export enum EmbedEvent {
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
-     * liveboardEmbed.trigger(HostEvent.SchedulesList)
+     * liveboardEmbed.trigger(EmbedEvent.SchedulesList)
      *```
      */
     SchedulesList = 'schedule-list',
@@ -1812,7 +1882,7 @@ export enum EmbedEvent {
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
-     * liveboardEmbed.trigger(HostEvent.Cancel)
+     * liveboardEmbed.trigger(EmbedEvent.Cancel)
      *```
      */
     Cancel = 'cancel',
@@ -1822,7 +1892,7 @@ export enum EmbedEvent {
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
-     * liveboardEmbed.trigger(HostEvent.Explore,  {
+     * liveboardEmbed.trigger(EmbedEvent.Explore,  {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
      */
@@ -1833,7 +1903,7 @@ export enum EmbedEvent {
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      * @example
      *```js
-     * liveboardEmbed.trigger(HostEvent.CopyLink, {
+     * liveboardEmbed.trigger(EmbedEvent.CopyLink, {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
      */
@@ -1955,7 +2025,7 @@ export enum EmbedEvent {
     /**
      * Emitted when a LB/viz is renamed
      *
-     * @version SDK : 1.28.0 | ThoughtSpot: 9.11.0.cl
+     * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
      */
     Rename = 'rename',
 }
@@ -2104,10 +2174,13 @@ export enum HostEvent {
      * _String_. The name of the column to filter on.
      * `operator`
      *  Runtime filter operator to apply. For information,
-     *  see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
+     *  see https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator.
      * `values`
      *  List of operands. Some operators such as EQ, LE allow a single value, whereas
      *  operators such as BW and IN accept multiple operands.
+     *  **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
+     *  Search embedding (SearchEmbed) and Natural Language Search
+     *  embedding (SageEmbed).
      *
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @example
@@ -2630,22 +2703,24 @@ export enum HostEvent {
      */
     ResetSearch = 'resetSearch',
     /**
-     * @hidden
+     *
      * Get the currents visible and runtime filters applied on a Liveboard
+     *
      * @example
      * liveboardEmbed.trigger(HostEvent.GetFilters)
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
      */
     GetFilters = 'getFilters',
     /**
-     * @hidden
+     *
      * Update the visible filters on the Liveboard.
+     *
      * @param - filter: filter object containing column name and filter operation and values
      * @example
      *
      * ```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], is_mandatory: false }
      * })
      * ```
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -2732,6 +2807,32 @@ export enum HostEvent {
      * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
      */
     AskSage = 'AskSage',
+    /**
+     * Trigger UpdateCrossFilter for Liveboard
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
+     *      vizId: 'b535c760-8bbe-4e6f-bb26-af56b4129a1e',
+     *      conditions: [
+     *      { columnName: 'Category', values: ['mfgr#12','mfgr#14'] },
+     *      { columnName: 'color', values: ['mint','hot'] },
+     *    ],
+     * });
+     * ```
+     * @version SDK: 1.29.0 | Thoughtspot: 10.0.0.cl
+     */
+    UpdateCrossFilter = 'UpdateCrossFilter',
+    /**
+     * Trigger ResetLiveboardPersonalisedView for Liveboard
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
+     * ```
+     * @version SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+     */
+    ResetLiveboardPersonalisedView = 'ResetLiveboardPersonalisedView',
 }
 
 /**
@@ -3707,6 +3808,50 @@ export enum Action {
      *  @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
      */
     AskAi = 'AskAi',
+
+    /**
+     * The **Add KPI to Watchlist** action on Home page watchlist.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.AddToWatchlist]
+     * ```
+     * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+     */
+    AddToWatchlist = 'addToWatchlist',
+
+    /**
+     * The **Remove from watchlist** menu action on KPI watchlist.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.RemoveFromWatchlist]
+     * ```
+     * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+     */
+    RemoveFromWatchlist = 'removeFromWatchlist',
+
+    /**
+     * The **Copy KPI Link** menu action on KPI watchlist.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.CopyKpiLink]
+     * ```
+     * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+     */
+    CopyKpiLink = 'copyKpiLink',
+
+    /**
+     * Action ID for AI Highlights button
+     *
+     *  @example
+     * ```js
+     * hiddenAction: [Action.AIHighlights]
+     * ```
+     *  @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
+     */
+    AIHighlights = 'AIHighlights',
 }
 
 export interface AnswerServiceType {

package/src/utils/authService/authService.spec.ts

@@ -53,6 +53,18 @@ describe('Unit test for authService', () => {
         );
     });
 
+    test('fetchAuthService without username', async () => {
+        global.fetch = jest.fn(() => Promise.resolve({ success: true, ok: true }));
+        await fetchAuthService(thoughtSpotHost, undefined, authToken);
+        expect(fetch).toBeCalledWith(
+            `${thoughtSpotHost}${EndPoints.TOKEN_LOGIN}?auth_token=${authToken}`,
+            {
+                credentials: 'include',
+                redirect: 'manual',
+            },
+        );
+    });
+
     test('fetchAuthPostService', async () => {
         global.fetch = jest.fn(() => Promise.resolve({ success: true, ok: true }));
         await fetchAuthPostService(thoughtSpotHost, username, authToken);
@@ -68,6 +80,21 @@ describe('Unit test for authService', () => {
         });
     });
 
+    test('fetchAuthPostService without username', async () => {
+        global.fetch = jest.fn(() => Promise.resolve({ success: true, ok: true }));
+        await fetchAuthPostService(thoughtSpotHost, undefined, authToken);
+        expect(fetch).toBeCalledWith(`${thoughtSpotHost}${EndPoints.TOKEN_LOGIN}`, {
+            method: 'POST',
+            credentials: 'include',
+            redirect: 'manual',
+            body: 'auth_token=token',
+            headers: {
+                'content-type': 'application/x-www-form-urlencoded',
+                'x-requested-by': 'ThoughtSpot',
+            },
+        });
+    });
+
     test('fetchBasicAuthService called with manual redirect', async () => {
         global.fetch = jest.fn(() => Promise.resolve({ success: true, ok: true }));
         await fetchBasicAuthService(thoughtSpotHost, username, password);

package/src/utils/authService/authService.ts

@@ -47,7 +47,7 @@ export async function verifyTokenService(
         });
         return res.ok;
     } catch (e) {
-        logger.error(`Token Verification Service failed : ${e.message}`);
+        logger.warn(`Token Verification Service failed : ${e.message}`);
     }
 
     return false;
@@ -72,15 +72,15 @@ export async function fetchAuthService(
     username: string,
     authToken: string,
 ): Promise<any> {
-    return failureLoggedFetch(
-        `${thoughtSpotHost}${EndPoints.TOKEN_LOGIN}?username=${username}&auth_token=${authToken}`,
-        {
-            credentials: 'include',
-            // We do not want to follow the redirect, as it starts giving a CORS
-            // error
-            redirect: 'manual',
-        },
-    );
+    const fetchUrlParams = username
+        ? `username=${username}&auth_token=${authToken}`
+        : `auth_token=${authToken}`;
+    return failureLoggedFetch(`${thoughtSpotHost}${EndPoints.TOKEN_LOGIN}?${fetchUrlParams}`, {
+        credentials: 'include',
+        // We do not want to follow the redirect, as it starts giving a CORS
+        // error
+        redirect: 'manual',
+    });
 }
 
 /**
@@ -94,15 +94,16 @@ export async function fetchAuthPostService(
     username: string,
     authToken: string,
 ): Promise<any> {
+    const bodyPrams = username
+        ? `username=${encodeURIComponent(username)}&auth_token=${encodeURIComponent(authToken)}`
+        : `auth_token=${encodeURIComponent(authToken)}`;
     return failureLoggedFetch(`${thoughtSpotHost}${EndPoints.TOKEN_LOGIN}`, {
         method: 'POST',
         headers: {
             'content-type': 'application/x-www-form-urlencoded',
             'x-requested-by': 'ThoughtSpot',
         },
-        body: `username=${encodeURIComponent(username)}&auth_token=${encodeURIComponent(
-            authToken,
-        )}`,
+        body: bodyPrams,
         credentials: 'include',
         // We do not want to follow the redirect, as it starts giving a CORS
         // error