@thoughtspot/visual-embed-sdk 1.33.2 → 1.33.4

package/src/embed/liveboard.spec.ts

@@ -67,7 +67,7 @@ describe('Liveboard/viz embed tests', () => {
         });
     });
 
-    test('should render liveboard with data panel v2 flag set to true by default', async () => {
+    test('should render liveboard with data panel v2 flag set to false by default', async () => {
         const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
             ...defaultViewConfig,
             liveboardId,
@@ -76,7 +76,7 @@ describe('Liveboard/viz embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}${prefixParams}&enableDataPanelV2=true#/embed/viz/${liveboardId}`,
+                `http://${thoughtSpotHost}/?embedApp=true${defaultParams}${prefixParams}&enableDataPanelV2=false#/embed/viz/${liveboardId}`,
             );
         });
     });

package/src/embed/liveboard.ts

@@ -270,7 +270,6 @@ export interface LiveboardViewConfig
      *
      * Since, this will show preview images, be careful that it may show
      * undesired data to the user when using row level security.
-     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -280,7 +279,6 @@ export interface LiveboardViewConfig
      * });
      * embed.render();
      * ```
-     *
      * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
      */
     showPreviewLoader?: boolean;
@@ -385,7 +383,7 @@ export class LiveboardEmbed extends V1Embed {
             showLiveboardReverifyBanner = true,
             enableAskSage,
             enable2ColumnLayout,
-            dataPanelV2 = true,
+            dataPanelV2 = false,
             enableCustomColumnGroups = false,
         } = this.viewConfig;
 
@@ -613,7 +611,6 @@ export class LiveboardEmbed extends V1Embed {
     /**
      * Returns the full url of the liveboard/viz which can be used to open
      * this liveboard inside the full Thoughtspot application in a new tab.
-     *
      * @returns url string
      */
     public getLiveboardUrl(): string {

package/src/embed/search.spec.ts

@@ -52,7 +52,7 @@ describe('Search embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&enableDataPanelV2=true&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&enableDataPanelV2=false&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
     });
@@ -438,7 +438,7 @@ describe('Search embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=true&useLastSelectedSources=true${prefixParams}#/embed/saved-answer/${answerId}`,
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=true${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });
     });
@@ -453,7 +453,7 @@ describe('Search embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&enableDataPanelV2=true&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });
     });
@@ -468,7 +468,7 @@ describe('Search embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&enableDataPanelV2=true&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });
     });
@@ -499,7 +499,7 @@ describe('Search embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=true&useLastSelectedSources=false&hideSearchBar=true${prefixParams}#/embed/saved-answer/${answerId}`,
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false&hideSearchBar=true${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });
     });
@@ -514,7 +514,7 @@ describe('Search embed tests', () => {
         await executeAfterWait(() => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
-                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=true&useLastSelectedSources=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_FIRST${prefixParams}#/embed/saved-answer/${answerId}`,
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_FIRST${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });
     });

package/src/embed/search.ts

@@ -330,7 +330,7 @@ export class SearchEmbed extends TsEmbed {
             dataSources,
             excludeRuntimeFiltersfromURL,
             hideSearchBar,
-            dataPanelV2 = true,
+            dataPanelV2 = false,
             useLastSelectedSources = false,
             runtimeParameters,
             collapseSearchBarInitially = false,

package/src/embed/ts-embed.spec.ts

@@ -1615,7 +1615,7 @@ describe('Unit test case for ts embed', () => {
             });
             libEmbed.preRender();
 
-            expect(logger.error).toHaveBeenCalledWith('PreRender id is required for preRender');
+            expect(logger.error).toHaveBeenCalledWith('PreRender ID is required for preRender');
         });
 
         it('showPreRender should preRender if not available', async () => {

package/src/errors.ts

@@ -1,18 +1,19 @@
 export const ERROR_MESSAGE = {
     INVALID_THOUGHTSPOT_HOST: 'Error parsing ThoughtSpot host. Please provide a valid URL.',
-    LIVEBOARD_VIZ_ID_VALIDATION: 'Please select a liveboard to embed.',
-    TRIGGER_TIMED_OUT: 'Trigger timedout in getting response',
-    SEARCHEMBED_BETA_WRANING_MESSAGE: 'Search Embed is in Beta in this release.',
-    SAGE_EMBED_BETA_WARNING_MESSAGE: 'Sage Embed is in Beta in this release.',
-    THIRD_PARTY_COOKIE_BLOCKED_ALERT: 'Third party cookie access is blocked on this browser, please allow third party cookies for this to work properly. \nYou can use `suppressNoCookieAccessAlert` to suppress this message.',
-    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.',
+    SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND: 'Please select a worksheet to get started',
+    LIVEBOARD_VIZ_ID_VALIDATION: 'Please select a Liveboard to embed.',
+    TRIGGER_TIMED_OUT: 'Trigger timed-out in getting a response',
+    SEARCHEMBED_BETA_WRANING_MESSAGE: 'SearchEmbed is in Beta in this release.',
+    SAGE_EMBED_BETA_WARNING_MESSAGE: 'SageEmbed is in Beta in this release.',
+    THIRD_PARTY_COOKIE_BLOCKED_ALERT: 'Third-party cookie access is blocked on this browser. Please allow third-party cookies for this to work properly. \nYou can use `suppressNoCookieAccessAlert` to suppress this message.',
+    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.',
     SDK_NOT_INITIALIZED: 'SDK not initialized',
-    SESSION_INFO_FAILED: 'Failed to get session info',
+    SESSION_INFO_FAILED: 'Failed to get session information',
     INVALID_TOKEN_ERROR: 'Received invalid token from getAuthToken callback or authToken endpoint.',
     MIXPANEL_TOKEN_NOT_FOUND: 'Mixpanel token not found in session info',
-    PRERENDER_ID_MISSING: 'PreRender id is required for preRender',
+    PRERENDER_ID_MISSING: 'PreRender ID is required for preRender',
     SYNC_STYLE_CALLED_BEFORE_RENDER: 'PreRender should be called before using syncPreRenderStyle',
     CSP_VIOLATION_ALERT: 'CSP violation detected. Please check the console errors for more details.',
-    CSP_FRAME_HOST_VIOLATION_LOG_MESSAGE: 'Please setup CSP Correctly for the Application to start working. You can know more about setting CSP Correctly here: https://developers.thoughtspot.com/docs/security-settings#csp-viz-embed-hosts. \n In case you are still facing error, please read: https://developers.thoughtspot.com/docs/security-settings#csp-viz-embed-hosts',
+    CSP_FRAME_HOST_VIOLATION_LOG_MESSAGE: 'Please set up CSP correctly for the application to start working. For more information, see https://developers.thoughtspot.com/docs/security-settings#csp-viz-embed-hosts. \n If the issue persists, refer to https://developers.thoughtspot.com/docs/security-settings#csp-viz-embed-hosts',
     MISSING_REPORTING_OBSERVER: 'ReportingObserver not supported',
 };

package/src/react/index.spec.tsx

@@ -56,7 +56,7 @@ describe('React Components', () => {
                 ),
             ).toBe(true);
             expect(getIFrameSrc(container)).toBe(
-                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&authType=None&blockNonEmbedFullAppAccess=true&hideAction=[%22${Action.ReportError}%22,%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&overrideConsoleLogs=true&clientLogLevel=ERROR&enableDataPanelV2=true&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true&collapseSearchBarInitially=true&enableCustomColumnGroups=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_ALL#/embed/answer`,
+                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&authType=None&blockNonEmbedFullAppAccess=true&hideAction=[%22${Action.ReportError}%22,%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&overrideConsoleLogs=true&clientLogLevel=ERROR&enableDataPanelV2=false&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true&collapseSearchBarInitially=true&enableCustomColumnGroups=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_ALL#/embed/answer`,
             );
         });
 

package/src/tokenizedFetch.ts

@@ -7,7 +7,6 @@ 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.
  * The interface for this method is the same as Web `Fetch`.
- *
  * @param input
  * @param init
  * @example

package/src/types.ts

@@ -1017,7 +1017,7 @@ export interface ViewConfig {
     // eslint-disable-next-line camelcase
     enableV2Shell_experimental?: boolean;
     /**
-     * To set the initial state of the search bar in case of saved-answers.
+     * To set the initial state of the search bar in case of saved Answers.
      * @default true
      * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
      * @example
@@ -1030,7 +1030,7 @@ export interface ViewConfig {
     collapseSearchBar?: boolean;
     /**
      * This flag can be used to disable links inside the embedded app,
-     * and disables redirection of links in a new tab.
+     * and disable redirection of links in a new tab.
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -1042,7 +1042,7 @@ export interface ViewConfig {
     disableRedirectionLinksInNewTab?: boolean;
     /**
      * Flag to control Data panel experience
-     * @default true
+     * @default false
      * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
      * @example
      * ```js
@@ -2167,22 +2167,26 @@ export enum EmbedEvent {
      */
     Rename = 'rename',
     /**
-     * Emitted if the user wants to intercept the search execution
-     * and implement logic to decide whether to run the search or not
      *
-     * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
+     * This event can be emitted to intercept search execution initiated by
+     * the users and implement the logic to allow or restrict search execution.
+     * You can can also show custom error text if the search query must be
+     * restricted due to your application or business requirements.
+
+     * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
      * for this embed event to get emitted.
      * @param: payload
      * @param: responder
      * Contains elements that lets developers define whether ThoughtSpot
-     * will run the search or not, and if not, which error message to provide.
+     * should run the search, and if not, what error message
+     * should be shown to the user.
      *
-     * execute: When execute returns true, the search will be run.
-     * When execute returns false, the search will not be executed.
+     * execute: When execute returns `true`, the search will be run.
+     * When execute returns `false`, the search will not be executed.
      *
-     * error: Developers can customize the user facing message when execute is
-     * set to false using the error parameter in responder
-     * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+     * error: Developers can customize the error message text when `execute`
+     * returns `false` using the error parameter in responder.
+     * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
      * @example
      *```js
      * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -2222,15 +2226,15 @@ export enum EmbedEvent {
      */
     OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
     /**
-     * Emitted when parameter changes in an answer
-     * or liveboard
+     * Emitted when parameter changes in an Answer
+     * or Liveboard
      *
      * ```js
      * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+     * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
      */
     ParameterChanged = 'parameterChanged',
 }
@@ -2961,8 +2965,12 @@ export enum HostEvent {
      *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
      *
      * `values` - An array of one or several values. The value definition on the
-     *  data type you choose to filter on. For a complete list of supported data types,
-     *  see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
+     *  data type you choose to filter on. For a complete list of supported data types, see
+     *  link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types].
+     *
+     * `type`  - To update filters for date time, specify the date format type.
+     * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
+     *
      * @example
      * ```js
      *
@@ -3092,7 +3100,7 @@ export enum HostEvent {
      */
     AskSage = 'AskSage',
     /**
-     * Trigger UpdateCrossFilter for Liveboard
+     * Trigger cross filter update action on a Liveboard
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateCrossFilter, {
@@ -3107,7 +3115,7 @@ export enum HostEvent {
      */
     UpdateCrossFilter = 'UpdateCrossFilter',
     /**
-     * Trigger ResetLiveboardPersonalisedView for Liveboard
+     * Trigger reset action for a personalized Liveboard view.
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ResetLiveboardPersonalisedView);
@@ -3253,6 +3261,7 @@ export enum Param {
     ShowLiveboardReverifyBanner = 'showLiveboardReverifyBanner',
     LiveboardHeaderV2 = 'isLiveboardHeaderV2Enabled',
     SpotterEnabled = 'isSpotterExperienceEnabled',
+    IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
 }
 
 /**
@@ -4234,7 +4243,7 @@ export enum Action {
     AIHighlights = 'AIHighlights',
 
     /**
-     * Action ID for edit schedule action on schedule on homepage
+     * Action ID for edit the schedule action on schedule on homepage
      * @example
      * ```js
      * disabledActions: [Action.EditScheduleHomepage]
@@ -4302,6 +4311,15 @@ export enum Action {
      *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
      */
     KPIAnalysisCTA = 'kpiAnalysisCTA',
+    /**
+     * Action ID for disabling chip reorder in Answer and Liveboard
+     * @example
+     * ```js
+     * const disabledActions = [Action.DisableChipReorder]
+     * ```
+     * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
+     */
+    DisableChipReorder = 'disableChipReorder',
 }
 
 export interface AnswerServiceType {

package/src/utils/processData.ts

@@ -32,7 +32,6 @@ export function processCustomAction(e: any, thoughtSpotHost: string) {
 
 /**
  * Responds to AuthInit sent from host signifying successful authentication in host.
- *
  * @param e
  * @returns {any}
  */

package/src/utils/sessionInfoService.ts

@@ -19,7 +19,6 @@ let sessionInfo: null | SessionInfo = null;
  * 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);
@@ -40,7 +39,6 @@ export async 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) {
@@ -58,7 +56,6 @@ export 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
@@ -87,7 +84,6 @@ export 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();

package/src/utils.spec.ts

@@ -119,9 +119,9 @@ describe('unit test for utils', () => {
 
     test('appendToUrlHash', () => {
         expect(appendToUrlHash('http://myhost:3000', 'hashFrag')).toBe(
-            'http://myhost:3000#hashFrag',
+            'http://myhost:3000#?tsSSOMarker=hashFrag',
         );
-        expect(appendToUrlHash('http://xyz.com/#foo', 'bar')).toBe('http://xyz.com/#foobar');
+        expect(appendToUrlHash('http://xyz.com/#foo', 'bar')).toBe('http://xyz.com/#foo?tsSSOMarker=bar');
     });
 
     describe('getRedirectURL', () => {
@@ -135,9 +135,9 @@ describe('unit test for utils', () => {
 
         test('Should return correct value when path is undefined', () => {
             expect(getRedirectUrl('http://myhost:3000', 'hashFrag')).toBe(
-                'http://myhost:3000#hashFrag',
+                'http://myhost:3000#?tsSSOMarker=hashFrag',
             );
-            expect(getRedirectUrl('http://xyz.com/#foo', 'bar')).toBe('http://xyz.com/#foobar');
+            expect(getRedirectUrl('http://xyz.com/#foo', 'bar')).toBe('http://xyz.com/#foo?tsSSOMarker=bar');
         });
 
         test('Should return correct value when path is set', () => {
@@ -148,11 +148,11 @@ describe('unit test for utils', () => {
             }));
 
             expect(getRedirectUrl('http://myhost:3000/', 'hashFrag', '/bar')).toBe(
-                'http://myhost:3000/bar#hashFrag',
+                'http://myhost:3000/bar#?tsSSOMarker=hashFrag',
             );
 
             expect(getRedirectUrl('http://myhost:3000/#/foo', 'hashFrag', '#/bar')).toBe(
-                'http://myhost:3000/#/barhashFrag',
+                'http://myhost:3000/#/bar?tsSSOMarker=hashFrag',
             );
         });
     });

package/src/utils.ts

@@ -131,6 +131,11 @@ export const getCssDimension = (value: number | string): string => {
     return value;
 };
 
+export const getSSOMarker = (markerId: string) => {
+    const encStringToAppend = encodeURIComponent(markerId);
+    return `tsSSOMarker=${encStringToAppend}`;
+};
+
 /**
  * Append a string to a URL's hash fragment
  * @param url A URL
@@ -140,11 +145,18 @@ export const appendToUrlHash = (url: string, stringToAppend: string) => {
     let outputUrl = url;
     const encStringToAppend = encodeURIComponent(stringToAppend);
 
+    const marker = `tsSSOMarker=${encStringToAppend}`;
+
+    let splitAdder = '';
+
     if (url.indexOf('#') >= 0) {
-        outputUrl = `${outputUrl}${encStringToAppend}`;
+        // If second half of hash contains a '?' already add a '&' instead of
+        // '?' which appends to query params.
+        splitAdder = url.split('#')[1].indexOf('?') >= 0 ? '&' : '?';
     } else {
-        outputUrl = `${outputUrl}#${encStringToAppend}`;
+        splitAdder = '#?';
     }
+    outputUrl = `${outputUrl}${splitAdder}${marker}`;
 
     return outputUrl;
 };