@thoughtspot/visual-embed-sdk 1.19.0-alpha.9 → 1.20.0-alpha.0

package/src/embed/ts-embed.ts

@@ -43,7 +43,14 @@ import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 import { processEventData } from '../utils/processData';
 import { processTrigger } from '../utils/processTrigger';
 import pkgInfo from '../../package.json';
-import { getAuthPromise, getEmbedConfig, renderInQueue } from './base';
+import {
+    getAuthPromise,
+    getEmbedConfig,
+    renderInQueue,
+    handleAuth,
+    notifyAuthFailure,
+} from './base';
+import { AuthFailureType, getAuthenticaionToken } from '../auth';
 
 const { version } = pkgInfo;
 
@@ -218,7 +225,11 @@ export class TsEmbed {
     /**
      * Send Custom style as part of payload of APP_INIT
      */
-    private appInitCb = (_: any, responder: any) => {
+    private appInitCb = async (_: any, responder: any) => {
+        let authToken = '';
+        if (this.embedConfig.authType === AuthType.TrustedAuthTokenCookieless) {
+            authToken = await getAuthenticaionToken(this.embedConfig);
+        }
         responder({
             type: EmbedEvent.APP_INIT,
             data: {
@@ -226,15 +237,34 @@ export class TsEmbed {
                     this.embedConfig,
                     this.viewConfig,
                 ),
+                authToken,
             },
         });
     };
 
+    /**
+     * Sends updated auth token to the iFrame to avoid user logout
+     */
+    private updateAuthToken = async (_: any, responder: any) => {
+        const { autoLogin = false, authType } = this.embedConfig; // Set autoLogin default to false
+        if (authType === AuthType.TrustedAuthTokenCookieless) {
+            const authToken = await getAuthenticaionToken(this.embedConfig);
+            responder({
+                type: EmbedEvent.AuthExpire,
+                data: { authToken },
+            });
+        } else if (autoLogin) {
+            handleAuth();
+        }
+        notifyAuthFailure(AuthFailureType.EXPIRY);
+    };
+
     /**
      * Register APP_INIT event and sendback init payload
      */
     private registerAppInit = () => {
         this.on(EmbedEvent.APP_INIT, this.appInitCb);
+        this.on(EmbedEvent.AuthExpire, this.updateAuthToken);
     };
 
     /**
@@ -288,6 +318,9 @@ export class TsEmbed {
         if (this.embedConfig.authType === AuthType.EmbeddedSSO) {
             queryParams[Param.ForceSAMLAutoRedirect] = true;
         }
+        if (this.embedConfig.authType === AuthType.TrustedAuthTokenCookieless) {
+            queryParams[Param.cookieless] = true;
+        }
 
         const {
             disabledActions,
@@ -300,6 +333,7 @@ export class TsEmbed {
             customizations,
             contextMenuTrigger,
             linkOverride,
+            insertInToSlide,
         } = this.viewConfig;
 
         if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
@@ -363,6 +397,9 @@ export class TsEmbed {
         if (linkOverride) {
             queryParams[Param.LinkOverride] = linkOverride;
         }
+        if (insertInToSlide) {
+            queryParams[Param.ShowInsertToSlide] = insertInToSlide;
+        }
         return queryParams;
     }
 

package/src/index.ts

@@ -17,7 +17,7 @@ import {
 } from './embed/liveboard';
 import { SearchEmbed, SearchViewConfig } from './embed/search';
 import { SearchBarEmbed, SearchBarViewConfig } from './embed/search-bar';
-import { AuthFailureType, AuthStatus, AuthEvent } from './auth';
+import { AuthFailureType, AuthStatus, AuthEvent, getSessionInfo } from './auth';
 import {
     AuthType,
     RuntimeFilter,
@@ -35,6 +35,7 @@ export {
     logout,
     prefetch,
     getEmbedConfig as getInitConfig,
+    getSessionInfo,
     SearchEmbed,
     SearchBarEmbed,
     PinboardEmbed,

package/src/types.ts

@@ -58,11 +58,18 @@ export enum AuthType {
      */
     AuthServer = 'AuthServer',
     /**
-     * Trusted authentication server, Use you own authentication server
+     * Trusted authentication server, Use your own authentication server
      * which returns a bearer token, generated using the secret_key obtained from
      * ThoughtSpot.
      */
     TrustedAuthToken = 'AuthServer',
+    /**
+     * Trusted authentication server Cookieless, Use you own authentication server
+     * which returns a bearer token, generated using the secret_key obtained from
+     * ThoughtSpot. This uses a cookieless authentication approach, recommended
+     * to by pass third-party cookie-blocking restriction implemented by some browsers
+     */
+    TrustedAuthTokenCookieless = 'AuthServerCookieless',
     /**
      * Use the ThoughtSpot login API to authenticate to the cluster directly.
      *
@@ -382,6 +389,12 @@ export interface ViewConfig {
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     linkOverride?: boolean;
+    /**
+     * flag to enable insert into slides action
+     * @hidden
+     * @private
+     */
+    insertInToSlide?: boolean;
 }
 
 /**
@@ -1236,8 +1249,10 @@ export enum Param {
     // eslint-disable-next-line @typescript-eslint/no-shadow
     AuthType = 'authType',
     IconSpriteUrl = 'iconSprite',
+    cookieless = 'cookieless',
     ContextMenuTrigger = 'isContextMenuEnabledOnLeftClick',
     LinkOverride = 'linkOverride',
+    ShowInsertToSlide = 'insertInToSlide',
 }
 
 /**
@@ -1443,6 +1458,10 @@ export enum Action {
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     AxisMenuRemove = 'axisMenuRemove',
+    /**
+     * @hidden
+     */
+    InsertInToSlide = 'insertInToSlide',
 }
 
 export interface SessionInterface {

package/src/utils/processData.spec.ts

@@ -94,40 +94,6 @@ describe('Unit test for process data', () => {
         expect(base.notifyAuthSuccess).toBeCalled();
     });
 
-    test('AuthExpire autoLogin false', () => {
-        const e = { type: EmbedEvent.AuthExpire };
-        jest.spyOn(base, 'notifyAuthFailure');
-        jest.spyOn(base, 'handleAuth');
-        jest.spyOn(base, 'getEmbedConfig').mockReturnValue({});
-        expect(
-            processDataInstance.processEventData(e.type, e, '', null),
-        ).toEqual({
-            type: e.type,
-        });
-        expect(base.notifyAuthFailure).toBeCalledWith(
-            auth.AuthFailureType.EXPIRY,
-        );
-        expect(base.handleAuth).not.toHaveBeenCalled();
-    });
-
-    test('AuthExpire autoLogin true', () => {
-        const e = { type: EmbedEvent.AuthExpire };
-        jest.spyOn(base, 'notifyAuthFailure');
-        jest.spyOn(base, 'handleAuth').mockResolvedValue(true);
-        jest.spyOn(base, 'getEmbedConfig').mockReturnValue({
-            autoLogin: true,
-        });
-        expect(
-            processDataInstance.processEventData(e.type, e, '', null),
-        ).toEqual({
-            type: e.type,
-        });
-        expect(base.notifyAuthFailure).toBeCalledWith(
-            auth.AuthFailureType.EXPIRY,
-        );
-        expect(base.handleAuth).toBeCalled();
-    });
-
     test('NoCookieAccess no suppress alert', () => {
         const e = { type: EmbedEvent.NoCookieAccess };
         jest.spyOn(base, 'notifyAuthFailure');

package/src/utils/processData.ts

@@ -1,7 +1,6 @@
 import {
     disableAutoLogin,
     getEmbedConfig,
-    handleAuth,
     notifyAuthFailure,
     notifyAuthSuccess,
     notifyLogout,
@@ -46,15 +45,6 @@ function processAuthInit(e: any) {
     };
 }
 
-function processAuthExpire(e: any) {
-    const { autoLogin = false } = getEmbedConfig(); // Set default to false
-    if (autoLogin) {
-        handleAuth();
-    }
-    notifyAuthFailure(AuthFailureType.EXPIRY);
-    return e;
-}
-
 function processNoCookieAccess(e: any, containerEl: Element) {
     const {
         loginFailedMessage,
@@ -102,8 +92,6 @@ export function processEventData(
             return processCustomAction(e, thoughtSpotHost);
         case EmbedEvent.AuthInit:
             return processAuthInit(e);
-        case EmbedEvent.AuthExpire:
-            return processAuthExpire(e);
         case EmbedEvent.NoCookieAccess:
             return processNoCookieAccess(e, containerEl);
         case EmbedEvent.AuthFailure: