@thoughtspot/visual-embed-sdk 1.29.0-alpha.fullH → 1.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.29.0-alpha.fullH",
+    "version": "1.29.0",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -175,6 +175,7 @@
     "keywords": [
         "thoughtspot",
         "everywhere",
+        "embedded",
         "embed",
         "sdk",
         "analytics"

package/src/auth.ts

@@ -1,18 +1,18 @@
 import EventEmitter from 'eventemitter3';
+import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
 import { initMixpanel } from './mixpanel-service';
 import {
-    AuthType, DOMSelector, EmbedConfig, EmbedEvent, Param,
+    AuthType, DOMSelector, EmbedConfig, EmbedEvent,
 } from './types';
 import { getDOMNode, getRedirectUrl } from './utils';
 import {
-    fetchSessionInfoService,
+    EndPoints,
+    fetchAuthPostService,
     fetchAuthService,
     fetchBasicAuthService,
     fetchLogoutService,
-    fetchAuthPostService,
-    EndPoints,
+    fetchSessionInfoService,
 } from './utils/authService';
-import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
 import { logger } from './utils/logger';
 import { getEmbedConfig } from './embed/embedConfig';
 
@@ -41,7 +41,6 @@ interface sessionInfoInterface {
 /**
  * Enum for auth failure types. This is the parameter passed to the listner
  * of {@link AuthStatus.FAILURE}.
- *
  * @group Authentication / Init
  */
 export enum AuthFailureType {
@@ -53,7 +52,6 @@ export enum AuthFailureType {
 
 /**
  * Enum for auth status emitted by the emitter returned from {@link init}.
- *
  * @group Authentication / Init
  */
 export enum AuthStatus {
@@ -77,7 +75,6 @@ export enum AuthStatus {
      * Emitted when inPopup is true in the SAMLRedirect flow and the
      * popup is waiting to be triggered either programmatically
      * or by the trigger button.
-     *
      * @version SDK: 1.19.0
      */
     WAITING_FOR_POPUP = 'WAITING_FOR_POPUP',
@@ -85,20 +82,17 @@ export enum AuthStatus {
 
 /**
  * Event emitter returned from {@link init}.
- *
  * @group Authentication / Init
  */
 export interface AuthEventEmitter {
     /**
      * Register a listener on Auth failure.
-     *
      * @param event
      * @param listener
      */
     on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
     /**
      * Register a listener on Auth SDK success.
-     *
      * @param event
      * @param listener
      */
@@ -115,13 +109,11 @@ export interface AuthEventEmitter {
     once(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
     /**
      * Trigger an event on the emitter returned from init.
-     *
      * @param {@link AuthEvent}
      */
     emit(event: AuthEvent, ...args: any[]): boolean;
     /**
      * Remove listener from the emitter returned from init.
-     *
      * @param event
      * @param listener
      * @param context
@@ -130,7 +122,6 @@ export interface AuthEventEmitter {
     off(event: AuthStatus, listener: (...args: any[]) => void, context: any, once: boolean): this;
     /**
      * Remove all the event listeners
-     *
      * @param event
      */
     removeAllListeners(event: AuthStatus): this;
@@ -138,7 +129,6 @@ export interface AuthEventEmitter {
 
 /**
  * Events which can be triggered on the emitter returned from {@link init}.
- *
  * @group Authentication / Init
  */
 export enum AuthEvent {
@@ -241,7 +231,6 @@ export const getSessionDetails = (sessionInfoResp: any): sessionInfoInterface =>
 
 /**
  * Check if we are logged into the ThoughtSpot cluster
- *
  * @param thoughtSpotHost The ThoughtSpot cluster hostname or IP
  */
 async function isLoggedIn(thoughtSpotHost: string): Promise<boolean> {
@@ -270,7 +259,6 @@ export function getReleaseVersion() {
 /**
  * Return a promise that resolves with the session information when
  * authentication is successful. And info is available.
- *
  * @group Global methods
  */
 export function getSessionInfo(): Promise<sessionInfoInterface> {
@@ -298,7 +286,6 @@ function removeSSORedirectUrlMarker(): void {
 
 /**
  * Perform token based authentication
- *
  * @param embedConfig The embed configuration
  */
 export const doTokenAuth = async (embedConfig: EmbedConfig): Promise<boolean> => {
@@ -330,7 +317,6 @@ export const doTokenAuth = async (embedConfig: EmbedConfig): Promise<boolean> =>
 
 /**
  * Validate embedConfig parameters required for cookielessTokenAuth
- *
  * @param embedConfig The embed configuration
  */
 export const doCookielessTokenAuth = async (embedConfig: EmbedConfig): Promise<boolean> => {
@@ -357,7 +343,6 @@ export const doCookielessTokenAuth = async (embedConfig: EmbedConfig): Promise<b
  *
  * Warning: This feature is primarily intended for developer testing. It is
  * strongly advised not to use this authentication method in production.
- *
  * @param embedConfig The embed configuration
  */
 export const doBasicAuth = async (embedConfig: EmbedConfig): Promise<boolean> => {
@@ -417,7 +402,6 @@ async function samlPopupFlow(ssoURL: string, triggerContainer: DOMSelector, trig
 
 /**
  * Perform SAML authentication
- *
  * @param embedConfig The embed configuration
  * @param ssoEndPoint
  */
@@ -492,7 +476,7 @@ export const logout = async (embedConfig: EmbedConfig): Promise<boolean> => {
     const { thoughtSpotHost } = embedConfig;
     await fetchLogoutService(thoughtSpotHost);
     resetCachedAuthToken();
-    const thoughtspotIframes = document.querySelectorAll('[data-ts-iframe=\'true\']');
+    const thoughtspotIframes = document.querySelectorAll("[data-ts-iframe='true']");
     if (thoughtspotIframes?.length) {
         thoughtspotIframes.forEach((el) => {
             el.parentElement.innerHTML = embedConfig.loginFailedMessage;
@@ -504,7 +488,6 @@ export const logout = async (embedConfig: EmbedConfig): Promise<boolean> => {
 
 /**
  * Perform authentication on the ThoughtSpot cluster
- *
  * @param embedConfig The embed configuration
  */
 export const authenticate = async (embedConfig: EmbedConfig): Promise<boolean> => {

package/src/authToken.spec.ts

@@ -0,0 +1,31 @@
+import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
+import * as authServiceInstance from './utils/authService/authService';
+import { EmbedConfig } from './types';
+
+describe('AuthToken Unit tests', () => {
+    test('getAuthenticationToken: When verification is disabled', async () => {
+        jest.spyOn(authServiceInstance, 'verifyTokenService');
+
+        const token = await getAuthenticationToken({
+            getAuthToken: async () => 'abc3',
+            disableTokenVerification: true,
+        } as EmbedConfig);
+
+        expect(token).toBe('abc3');
+        expect(authServiceInstance.verifyTokenService).not.toBeCalled();
+    });
+
+    test.only('getAuthenticationToken: When verification is enabled', async () => {
+        resetCachedAuthToken();
+        jest.clearAllMocks();
+        jest.spyOn(authServiceInstance, 'verifyTokenService').mockImplementation(() => true);
+        const token = await getAuthenticationToken({
+            thoughtSpotHost: 'test',
+            getAuthToken: async () => 'abc2',
+            disableTokenVerification: false,
+        } as EmbedConfig);
+
+        expect(token).toBe('abc2');
+        expect(authServiceInstance.verifyTokenService).toBeCalledWith('test', 'abc2');
+    });
+});

package/src/authToken.ts

@@ -1,5 +1,6 @@
 import { EmbedConfig } from './types';
 import { fetchAuthTokenService, verifyTokenService } from './utils/authService/authService';
+import { logger } from './utils/logger';
 
 const DUPLICATE_TOKEN_ERR = 'Duplicate token, please issue a new token every time getAuthToken callback is called.'
     + 'See https://developers.thoughtspot.com/docs/?pageid=embed-auth#trusted-auth-embed for more details.';
@@ -10,7 +11,9 @@ let cachedAuthToken: string | null = null;
 
 // This method can be used to get the authToken using the embedConfig
 export const getAuthenticationToken = async (embedConfig: EmbedConfig): Promise<string> => {
-    if (cachedAuthToken) {
+    // Since we don't have token validation enabled , we cannot tell if the
+    // cached token is valid or not. So we will always fetch a new token.
+    if (cachedAuthToken && !embedConfig.disableTokenVerification) {
         let isCachedTokenStillValid;
         try {
             isCachedTokenStillValid = await validateAuthToken(embedConfig, cachedAuthToken, true);
@@ -43,6 +46,10 @@ const validateAuthToken = async (
     authToken: string,
     suppressAlert?: boolean,
 ): Promise<boolean> => {
+    if (embedConfig.disableTokenVerification) {
+        logger.info('Token verification is disabled. Assuming token is valid.');
+        return true;
+    }
     try {
         const isTokenValid = await verifyTokenService(embedConfig.thoughtSpotHost, authToken);
         if (isTokenValid) return true;
@@ -63,12 +70,11 @@ const validateAuthToken = async (
 
 /**
  * Resets the auth token and a new token will be fetched on the next request.
- *
  * @example
  * ```js
  * resetCachedAuthToken();
  * ```
- * @version SDK: 1.28.0 | ThoughtSpot: *
+ * @version SDK: 1.28.2 | ThoughtSpot: *
  * @group Authentication / Init
  */
 export const resetCachedAuthToken = (): void => {

package/src/config.ts

@@ -5,7 +5,6 @@ import { EmbedConfig } from './types';
  * Copyright (c) 2023
  *
  * Utilities related to reading configuration objects
- *
  * @summary Config-related utils
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
@@ -23,7 +22,6 @@ const urlRegex = new RegExp(
 /**
  * Parse and construct the ThoughtSpot hostname or IP address
  * from the embed configuration object.
- *
  * @param config
  */
 export const getThoughtSpotHost = (config: EmbedConfig): string => {

package/src/embed/app.spec.ts

@@ -1,4 +1,9 @@
-import { AppEmbed, AppViewConfig, Page } from './app';
+import {
+    AppEmbed,
+    AppViewConfig,
+    DataPanelCustomColumnGroupsAccordionState,
+    Page,
+} from './app';
 import { init } from '../index';
 import {
     Action, AuthType, EmbedEvent, HostEvent, RuntimeFilterOp,
@@ -289,6 +294,21 @@ describe('App embed tests', () => {
         });
     });
 
+    test('should set enable2ColumnLayout to true in url', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            enable2ColumnLayout: true,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&profileAndHelpInNavBarHidden=false&enable2ColumnLayout=true${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('Should add the tag to the iframe src', async () => {
         const appEmbed = new AppEmbed(getRootEl(), {
             ...defaultViewConfig,
@@ -409,6 +429,22 @@ describe('App embed tests', () => {
         });
     });
 
+    test('Should add dataPanelCustomGroupsAccordionInitialState flag to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            // eslint-disable-next-line max-len
+            dataPanelCustomGroupsAccordionInitialState: DataPanelCustomColumnGroupsAccordionState.EXPAND_FIRST,
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&modularHomeExperience=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_FIRST${defaultParams}${defaultParamsPost}#/home`,
+            );
+        });
+    });
+
     test('should register event handlers to adjust iframe height', async () => {
         const onSpy = jest.spyOn(AppEmbed.prototype, 'on')
             .mockImplementation((event, callback) => {