@thoughtspot/visual-embed-sdk 1.35.5 → 1.35.7

package/lib/src/utils/embedApi/contracts.js

@@ -0,0 +1,14 @@
+import { HostEvent } from '../../types';
+export var EmbedApiEvent;
+(function (EmbedApiEvent) {
+    EmbedApiEvent["addVizToPinboard"] = "addVizToPinboard";
+    EmbedApiEvent["saveAnswer"] = "saveAnswer";
+    EmbedApiEvent["getA3AnalysisColumns"] = "getA3AnalysisColumns";
+    EmbedApiEvent["getPinboardTabInfo"] = "getPinboardTabInfo";
+    EmbedApiEvent["getDiscoverabilityStatus"] = "getDiscoverabilityStatus";
+    EmbedApiEvent["getAvailableEmbedApis"] = "getAvailableEmbedApis";
+    EmbedApiEvent["getAnswerPageConfig"] = "getAnswerPageConfig";
+    EmbedApiEvent["getPinboardPageConfig"] = "getPinboardPageConfig";
+    EmbedApiEvent["embedApiEventNotFound"] = "embedApiEventNotFound";
+})(EmbedApiEvent || (EmbedApiEvent = {}));
+//# sourceMappingURL=contracts.js.map

package/lib/src/utils/embedApi/contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../../../src/utils/embedApi/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,CAAN,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,sDAAqC,CAAA;IACrC,0CAAyB,CAAA;IACzB,8DAA6C,CAAA;IAC7C,0DAAyC,CAAA;IACzC,sEAAqD,CAAA;IACrD,gEAA+C,CAAA;IAC/C,4DAA2C,CAAA;IAC3C,gEAA+C,CAAA;IAC/C,gEAA+C,CAAA;AACjD,CAAC,EAVW,aAAa,KAAb,aAAa,QAUxB"}

package/lib/src/utils/embedApi/embedApiClient.d.ts

@@ -0,0 +1,12 @@
+import { HostEvent } from '../../types';
+import { EmbedApiArrayResponse, EmbedApiContractBase, EmbedApiRequest, HostEventRequest, HostEventResponse } from './contracts';
+export declare class HostEventClient {
+    iFrame: HTMLIFrameElement;
+    thoughtSpotHost: string;
+    constructor(iFrame: HTMLIFrameElement, thoughtSpotHost: string);
+    executeEmbedApi<ApiName extends keyof EmbedApiContractBase>(apiName: ApiName, parameters: EmbedApiRequest<ApiName>): EmbedApiArrayResponse<ApiName>;
+    hostEventFallback(hostEvent: HostEvent, data: any): Promise<any>;
+    handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
+    executeHostEvent<T extends HostEvent>(hostEvent: HostEvent, payload: HostEventRequest<T>): Promise<HostEventResponse<HostEvent>>;
+}
+//# sourceMappingURL=embedApiClient.d.ts.map

package/lib/src/utils/embedApi/embedApiClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedApiClient.d.ts","sourceRoot":"","sources":["../../../../src/utils/embedApi/embedApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,OAAO,EACH,qBAAqB,EACrB,oBAAoB,EACL,eAAe,EAAE,gBAAgB,EAAE,iBAAiB,EACtE,MAAM,aAAa,CAAC;AAErB,qBAAa,eAAe;IAC1B,MAAM,EAAE,iBAAiB,CAAC;IAE1B,eAAe,EAAE,MAAM,CAAC;gBAEZ,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM;IAKxD,eAAe,CAAC,OAAO,SAAS,MAAM,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAC9E,UAAU,EAAE,eAAe,CAAC,OAAO,CAAC,GACtC,qBAAqB,CAAC,OAAO,CAAC;IAS1B,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhE,cAAc,CAChB,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG,CAAC,GACzC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAmBtC,gBAAgB,CAAC,CAAC,SAAS,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC5F,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;CAOxC"}

package/lib/src/utils/embedApi/embedApiClient.js

@@ -0,0 +1,42 @@
+import { HostEvent } from '../../types';
+import { processTrigger } from '../processTrigger';
+import { EmbedApiEvent, } from './contracts';
+export class HostEventClient {
+    constructor(iFrame, thoughtSpotHost) {
+        this.iFrame = iFrame;
+        this.thoughtSpotHost = thoughtSpotHost;
+    }
+    async executeEmbedApi(apiName, parameters) {
+        const res = await processTrigger(this.iFrame, HostEvent.UiPassthrough, this.thoughtSpotHost, {
+            type: apiName,
+            parameters,
+        });
+        return res;
+    }
+    async hostEventFallback(hostEvent, data) {
+        return processTrigger(this.iFrame, hostEvent, this.thoughtSpotHost, data);
+    }
+    async handlePinEvent(payload) {
+        var _a, _b, _c, _d;
+        const res = (await this.executeEmbedApi(EmbedApiEvent.addVizToPinboard, payload))
+            .filter((r) => r.error || r.value)[0];
+        if (!res) {
+            const noVizFoundError = `No viz found${payload.vizId ? ` with id ${payload.vizId}` : ''}`;
+            return { error: noVizFoundError };
+        }
+        if (res.error) {
+            return { error: (_a = res === null || res === void 0 ? void 0 : res.error) === null || _a === void 0 ? void 0 : _a.message };
+        }
+        if ((_c = (_b = res.value) === null || _b === void 0 ? void 0 : _b.errors) === null || _c === void 0 ? void 0 : _c.message) {
+            return { error: (_d = res === null || res === void 0 ? void 0 : res.value.errors) === null || _d === void 0 ? void 0 : _d.message };
+        }
+        return { value: res.value };
+    }
+    async executeHostEvent(hostEvent, payload) {
+        if (hostEvent === HostEvent.Pin && typeof payload === 'object') {
+            return this.handlePinEvent(payload);
+        }
+        return this.hostEventFallback(hostEvent, payload);
+    }
+}
+//# sourceMappingURL=embedApiClient.js.map

package/lib/src/utils/embedApi/embedApiClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedApiClient.js","sourceRoot":"","sources":["../../../../src/utils/embedApi/embedApiClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAGH,aAAa,GAChB,MAAM,aAAa,CAAC;AAErB,MAAM,OAAO,eAAe;IAK1B,YAAY,MAAyB,EAAE,eAAuB;QAC1D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,eAAe,CAA6C,OAAgB,EAC9E,UAAoC;QAEpC,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,aAAa,EAAE,IAAI,CAAC,eAAe,EAAE;YACzF,IAAI,EAAE,OAAO;YACb,UAAU;SACb,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACf,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,SAAoB,EAAE,IAAS;QACnD,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED,KAAK,CAAC,cAAc,CAChB,OAAwC;;QAExC,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;aAC5E,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1C,IAAI,CAAC,GAAG,EAAE;YACN,MAAM,eAAe,GAAG,eAAe,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YAC1F,OAAO,EAAE,KAAK,EAAE,eAAe,EAAsC,CAAC;SACzE;QAED,IAAI,GAAG,CAAC,KAAK,EAAE;YACX,OAAO,EAAE,KAAK,EAAE,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,0CAAE,OAAO,EAAE,CAAC;SACzC;QACD,IAAI,MAAA,MAAA,GAAG,CAAC,KAAK,0CAAE,MAAM,0CAAE,OAAO,EAAE;YAC5B,OAAO,EAAE,KAAK,EAAE,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,KAAK,CAAC,MAAM,0CAAE,OAAO,EAAE,CAAC;SAChD;QAED,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAsB,SAAoB,EAAE,OAA4B;QAE1F,IAAI,SAAS,KAAK,SAAS,CAAC,GAAG,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;YAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,OAA0C,CAAC,CAAC;SAC1E;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;CACF"}

package/lib/src/utils/embedApi/processEmbedApi.d.ts

@@ -0,0 +1,9 @@
+import { HostEvent } from '../../types';
+/**
+ * Check if the event is an embed API event.
+ * @param messageType
+ * @param payload
+ * @returns boolean
+ */
+export declare function isEmbedApiEvent(messageType: HostEvent, payload: any): boolean;
+//# sourceMappingURL=processEmbedApi.d.ts.map

package/lib/src/utils/embedApi/processEmbedApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processEmbedApi.d.ts","sourceRoot":"","sources":["../../../../src/utils/embedApi/processEmbedApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,SAAS,EAAE,MAAM,aAAa,CAAC;AAMpD;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAK7E"}

package/lib/src/utils/embedApi/processEmbedApi.js

@@ -0,0 +1,14 @@
+import { HostEvent } from '../../types';
+/**
+ * Check if the event is an embed API event.
+ * @param messageType
+ * @param payload
+ * @returns boolean
+ */
+export function isEmbedApiEvent(messageType, payload) {
+    if (messageType === HostEvent.Pin && typeof payload === 'object') {
+        return true;
+    }
+    return false;
+}
+//# sourceMappingURL=processEmbedApi.js.map

package/lib/src/utils/embedApi/processEmbedApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processEmbedApi.js","sourceRoot":"","sources":["../../../../src/utils/embedApi/processEmbedApi.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,SAAS,EAAE,MAAM,aAAa,CAAC;AAMpD;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,WAAsB,EAAE,OAAY;IAChE,IAAI,WAAW,KAAK,SAAS,CAAC,GAAG,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC9D,OAAO,IAAI,CAAC;KACf;IACD,OAAO,KAAK,CAAC;AACjB,CAAC"}

package/lib/src/visual-embed-sdk.d.ts

@@ -1089,7 +1089,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
         * @summary Search embed
         * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
         */
-    import { DOMSelector, Action, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
+    import { DOMSelector, Action, ViewConfig, DefaultAppInitData } from '@thoughtspot/visual-embed-sdk/types';
     import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
         * Configuration for search options.
@@ -1258,6 +1258,22 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 * ```
                 */
             searchOptions?: SearchOptions;
+            /**
+                * Exclude the search token string from the URL.
+                * If set to true, the search token string is not appended to the URL.
+                * @version: SDK: 1.35.7 | ThoughtSpot: 10.7.0.cl
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *  searchOptions: {
+                *    searchTokenString: '[quantity purchased] [region]',
+                *    executeSearch: true,
+                *  },
+                *  excludeSearchTokenStringFromURL: true,
+                * });
+                * ```
+                */
+            excludeSearchTokenStringFromURL?: boolean;
             /**
                 * The GUID of a saved answer to load initially.
                 * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
@@ -1335,6 +1351,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
             focusSearchBarOnRender?: boolean;
     }
     export const HiddenActionItemByDefaultForSearchEmbed: Action[];
+    export interface SearchAppInitData extends DefaultAppInitData {
+            searchOptions?: SearchOptions;
+    }
     /**
         * Embed ThoughtSpot search
         * @group Embed components
@@ -1345,6 +1364,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
                 */
             protected viewConfig: SearchViewConfig;
             constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
+            protected getSearchInitData(): {
+                    searchOptions?: {
+                            searchTokenString: string;
+                    };
+            };
+            protected getAppInitData(): Promise<SearchAppInitData>;
             protected getEmbedParams(): string;
             /**
                 * Construct the URL of the embedded ThoughtSpot search to be
@@ -1361,7 +1386,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
 }
 
 declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
-    import { ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
+    import { DefaultAppInitData, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     import { SearchOptions } from '@thoughtspot/visual-embed-sdk/embed/search';
     /**
@@ -1429,6 +1454,25 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
                 * ```
                 */
             searchOptions?: SearchOptions;
+            /**
+                * Exclude the search token string from the URL.
+                * If set to true, the search token string is not appended to the URL.
+                * @version: SDK: 1.35.7 | ThoughtSpot: 10.7.0.cl
+                * @example
+                * ```js
+                * const embed = new SearchEmbed('#tsEmbed', {
+                *  searchOptions: {
+                *    searchTokenString: '[quantity purchased] [region]',
+                *    executeSearch: true,
+                *  },
+                *  excludeSearchTokenStringFromURL: true,
+                * });
+                * ```
+                */
+            excludeSearchTokenStringFromURL?: boolean;
+    }
+    export interface SearchAppInitData extends DefaultAppInitData {
+            searchOptions: SearchOptions;
     }
     /**
         * Embed ThoughtSpot search bar
@@ -1446,6 +1490,10 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
                 * Render the embedded ThoughtSpot search
                 */
             render(): Promise<SearchBarEmbed>;
+            protected getSearchInitData(): {
+                    searchOptions: SearchOptions;
+            };
+            protected getAppInitData(): Promise<SearchAppInitData>;
     }
 }
 
@@ -2384,6 +2432,22 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             additionalFlags?: {
                     [key: string]: string | number | boolean;
             };
+            /**
+                * This is an object (key/val) for customVariables being
+                * used by the third party tool's script.
+                * @example
+                * ```js
+                * const embed = new LiveboardEmbed('#embed', {
+                *   ... // other liveboard view config
+                *   customVariablesForThirdPartyTools: {
+                *        key1: 'value1',
+                *        key2: 'value2'
+                *     }
+                * });
+                * ```
+                *  @version SDK 1.37.0 | Thoughtspot: 10.7.0.cl
+                */
+            customVariablesForThirdPartyTools?: Record<string, any>;
     }
     export interface LayoutConfig {
     }
@@ -6319,6 +6383,17 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             TRACE = "TRACE"
     }
+    export interface DefaultAppInitData {
+            customisations: CustomisationsInterface;
+            authToken: string;
+            runtimeFilterParams: string | null;
+            runtimeParameterParams: string | null;
+            hiddenHomepageModules: HomepageModule[];
+            reorderedHomepageModules: string[];
+            hostConfig: Record<string, any>;
+            hiddenHomeLeftNavItems: string[];
+            customVariablesForThirdPartyTools: Record<string, any>;
+    }
 }
 
 declare module '@thoughtspot/visual-embed-sdk/css-variables' {
@@ -7256,7 +7331,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
         */
     import { TriggerPayload, TriggerResponse, UIPassthroughArrayResponse, UIPassthroughEvent, UIPassthroughRequest } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/contracts';
     import { AnswerService } from '@thoughtspot/visual-embed-sdk/utils/graphql/answerService/answerService';
-    import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
+    import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig, DefaultAppInitData } from '@thoughtspot/visual-embed-sdk/types';
     import { HostEventClient } from '@thoughtspot/visual-embed-sdk/embed/hostEventClient/host-event-client';
     /**
         * Global prefix for all Thoughtspot postHash Params.
@@ -7312,6 +7387,9 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * @param error The error message or object
                 */
             protected handleError(error: string | Record<string, unknown>): void;
+            protected getAuthTokenForCookielessInit(): Promise<string>;
+            protected getDefaultAppInitData(): Promise<DefaultAppInitData>;
+            protected getAppInitData(): Promise<DefaultAppInitData>;
             /**
                 * Constructs the base URL string to load the ThoughtSpot app.
                 * @param query

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.35.5",
+    "version": "1.35.7",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

package/src/embed/search-bar.tsx

@@ -1,4 +1,4 @@
-import { Param, ViewConfig } from '../types';
+import { DefaultAppInitData, Param, ViewConfig } from '../types';
 import { getQueryParamString } from '../utils';
 import { TsEmbed } from './ts-embed';
 import { SearchOptions } from './search';
@@ -79,6 +79,26 @@ export interface SearchBarViewConfig
      * ```
      */
     searchOptions?: SearchOptions;
+    /**
+     * Exclude the search token string from the URL.
+     * If set to true, the search token string is not appended to the URL.
+     * @version: SDK: 1.35.7 | ThoughtSpot: 10.7.0.cl
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *  searchOptions: {
+     *    searchTokenString: '[quantity purchased] [region]',
+     *    executeSearch: true,
+     *  },
+     *  excludeSearchTokenStringFromURL: true,
+     * });
+     * ```
+     */
+    excludeSearchTokenStringFromURL?: boolean;
+}
+
+export interface SearchAppInitData extends DefaultAppInitData {
+    searchOptions: SearchOptions;
 }
 
 /**
@@ -110,6 +130,7 @@ export class SearchBarEmbed extends TsEmbed {
             dataSource,
             dataSources,
             useLastSelectedSources = false,
+            excludeSearchTokenStringFromURL,
         } = this.viewConfig;
         const path = 'search-bar-embed';
         const queryParams = this.getBaseQueryParams();
@@ -122,7 +143,7 @@ export class SearchBarEmbed extends TsEmbed {
         if (dataSource) {
             queryParams[Param.DataSources] = `["${dataSource}"]`;
         }
-        if (searchOptions?.searchTokenString) {
+        if (searchOptions?.searchTokenString && !excludeSearchTokenStringFromURL) {
             queryParams[Param.searchTokenString] = encodeURIComponent(
                 searchOptions.searchTokenString,
             );
@@ -157,4 +178,17 @@ export class SearchBarEmbed extends TsEmbed {
         await this.renderIFrame(src);
         return this;
     }
+
+    protected getSearchInitData() {
+        return {
+            searchOptions: this.viewConfig.excludeSearchTokenStringFromURL
+                ? this.viewConfig.searchOptions
+                : null,
+        };
+    }
+
+    protected async getAppInitData(): Promise<SearchAppInitData> {
+        const defaultAppInitData = await super.getAppInitData();
+        return { ...defaultAppInitData, ...this.getSearchInitData() };
+    }
 }

package/src/embed/search.spec.ts

@@ -2,10 +2,13 @@ import {
     SearchEmbed,
     HiddenActionItemByDefaultForSearchEmbed,
     DataPanelCustomColumnGroupsAccordionState,
+    SearchOptions,
 } from './search';
 import * as authInstance from '../auth';
 import { init } from '../index';
-import { Action, AuthType, RuntimeFilterOp } from '../types';
+import {
+    Action, AuthType, EmbedEvent, RuntimeFilterOp,
+} from '../types';
 import {
     executeAfterWait,
     getDocumentBody,
@@ -14,6 +17,8 @@ import {
     fixedEncodeURI,
     defaultParamsWithoutHiddenActions as defaultParams,
     expectUrlMatchesWithParams,
+    getIFrameEl,
+    postMessageToParent,
 } from '../test/test-utils';
 import { version } from '../../package.json';
 import { SearchBarEmbed } from './search-bar';
@@ -533,4 +538,64 @@ describe('Search embed tests', () => {
             );
         });
     });
+
+    test('with excludeSearchTokenStringFromURL', async () => {
+        const searchOptions: SearchOptions = {
+            searchTokenString: '[commit date][revenue]',
+            executeSearch: true,
+        };
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            searchOptions,
+            excludeSearchTokenStringFromURL: true,
+        });
+        const mockEmbedEventPayload = {
+            type: EmbedEvent.APP_INIT,
+            data: {},
+        };
+        searchEmbed.render();
+
+        const mockPort: any = {
+            postMessage: jest.fn(),
+        };
+        await executeAfterWait(() => {
+            const iframe = getIFrameEl();
+            postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+        });
+
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
+            );
+        });
+
+        expect(mockPort.postMessage).toHaveBeenCalledWith({
+            type: EmbedEvent.APP_INIT,
+            data: expect.objectContaining({
+                searchOptions: {
+                    searchTokenString: '[commit date][revenue]',
+                },
+            }),
+        });
+    });
+
+    test('without excludeSearchTokenStringFromURL', async () => {
+        const searchOptions: SearchOptions = {
+            searchTokenString: '[commit date][revenue]',
+            executeSearch: true,
+        };
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            searchOptions,
+            excludeSearchTokenStringFromURL: false,
+        });
+        searchEmbed.render();
+        await executeAfterWait(() => {
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&enableDataPanelV2=false&useLastSelectedSources=false&searchTokenString=[commit date][revenue]${prefixParams}#/embed/saved-answer/${answerId}`,
+            );
+        });
+    });
 });

package/src/embed/search.ts

@@ -12,6 +12,7 @@ import {
     Param,
     Action,
     ViewConfig,
+    DefaultAppInitData,
 } from '../types';
 import {
     getQueryParamString,
@@ -202,6 +203,22 @@ export interface SearchViewConfig
      * ```
      */
     searchOptions?: SearchOptions;
+    /**
+     * Exclude the search token string from the URL.
+     * If set to true, the search token string is not appended to the URL.
+     * @version: SDK: 1.35.7 | ThoughtSpot: 10.7.0.cl
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *  searchOptions: {
+     *    searchTokenString: '[quantity purchased] [region]',
+     *    executeSearch: true,
+     *  },
+     *  excludeSearchTokenStringFromURL: true,
+     * });
+     * ```
+     */
+    excludeSearchTokenStringFromURL?: boolean;
     /**
      * The GUID of a saved answer to load initially.
      * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
@@ -287,6 +304,10 @@ export const HiddenActionItemByDefaultForSearchEmbed = [
     Action.AnswerDelete,
 ];
 
+export interface SearchAppInitData extends DefaultAppInitData {
+  searchOptions?: SearchOptions;
+}
+
 /**
  * Embed ThoughtSpot search
  * @group Embed components
@@ -319,6 +340,21 @@ export class SearchEmbed extends TsEmbed {
         return dataSourceMode;
     }
 
+    protected getSearchInitData() {
+        return {
+            ...(this.viewConfig.excludeSearchTokenStringFromURL ? {
+                searchOptions: {
+                    searchTokenString: this.viewConfig.searchOptions?.searchTokenString,
+                },
+            } : {}),
+        };
+    }
+
+    protected async getAppInitData(): Promise<SearchAppInitData> {
+        const defaultAppInitData = await super.getAppInitData();
+        return { ...defaultAppInitData, ...this.getSearchInitData() };
+    }
+
     protected getEmbedParams(): string {
         const {
             hideResults,
@@ -340,6 +376,7 @@ export class SearchEmbed extends TsEmbed {
             dataPanelCustomGroupsAccordionInitialState = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
             focusSearchBarOnRender = true,
             excludeRuntimeParametersfromURL,
+            excludeSearchTokenStringFromURL,
             collapseSearchBar = true,
         } = this.viewConfig;
         const queryParams = this.getBaseQueryParams();
@@ -355,7 +392,7 @@ export class SearchEmbed extends TsEmbed {
         if (dataSource) {
             queryParams[Param.DataSources] = `["${dataSource}"]`;
         }
-        if (searchOptions?.searchTokenString) {
+        if (searchOptions?.searchTokenString && !excludeSearchTokenStringFromURL) {
             queryParams[Param.searchTokenString] = encodeURIComponent(
                 searchOptions.searchTokenString,
             );