@thoughtspot/visual-embed-sdk 1.35.6 → 1.35.8

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>;
     }
 }
 
@@ -6335,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' {
@@ -7272,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.
@@ -7328,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.6",
+    "version": "1.35.8",
     "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,
             );