@thoughtspot/visual-embed-sdk 1.20.0-alpha.2 → 1.20.0-prerender.0

package/src/embed/search-bar.tsx

@@ -1,18 +1,24 @@
-import { DOMSelector, Param, Action, ViewConfig } from '../types';
+import {
+    DOMSelector, Param, Action, ViewConfig,
+} from '../types';
 import { getQueryParamString } from '../utils';
 import { TsEmbed } from './ts-embed';
 import { SearchOptions } from './search';
 
-export interface SearchBarViewConfig
-    extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
+/**
+ * @group Embed components
+ */
+export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts'> {
     /**
      * The array of data source GUIDs to set on load.
      * Only a single dataSource supported currently.
+     *
      * @deprecated Use dataSource instead
      */
     dataSources?: string[];
     /**
      * The array of data source GUIDs to set on load.
+     *
      * @version: SDK: 1.19.0
      */
     dataSource?: string;
@@ -25,8 +31,8 @@ export interface SearchBarViewConfig
 /**
  * Embed ThoughtSpot search bar
  *
- * @Category Search Embed
  * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+ * @group Embed components
  */
 export class SearchBarEmbed extends TsEmbed {
     /**
@@ -42,6 +48,7 @@ export class SearchBarEmbed extends TsEmbed {
     /**
      * Construct the URL of the embedded ThoughtSpot search to be
      * loaded in the iframe
+     *
      * @param dataSources A list of data source GUIDs
      */
     private getIFrameSrc() {
@@ -49,9 +56,7 @@ export class SearchBarEmbed extends TsEmbed {
         const path = 'search-bar-embed';
         const queryParams = this.getBaseQueryParams();
 
-        queryParams[Param.HideActions] = [
-            ...(queryParams[Param.HideActions] ?? []),
-        ];
+        queryParams[Param.HideActions] = [...(queryParams[Param.HideActions] ?? [])];
 
         if (dataSources && dataSources.length) {
             queryParams[Param.DataSources] = JSON.stringify(dataSources);
@@ -78,7 +83,7 @@ export class SearchBarEmbed extends TsEmbed {
         }
         const tsPostHashParams = this.getThoughtSpotPostUrlParams();
 
-        return `${this.getEmbedBasePath(query)}/${path}${tsPostHashParams}`;
+        return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
     }
 
     /**
@@ -88,7 +93,7 @@ export class SearchBarEmbed extends TsEmbed {
         super.render();
 
         const src = this.getIFrameSrc();
-        this.renderIFrame(src, this.viewConfig.frameParams);
+        this.renderIFrame(src);
         return this;
     }
 }

package/src/embed/search.spec.ts

@@ -9,6 +9,7 @@ import {
     getRootEl,
     fixedEncodeURI,
     defaultParamsWithoutHiddenActions as defaultParams,
+    expectUrlMatchesWithParams,
 } from '../test/test-utils';
 import { version } from '../../package.json';
 
@@ -21,10 +22,7 @@ const defaultViewConfig = {
 const answerId = 'eca215d4-0d2c-4a55-90e3-d81ef6848ae0';
 const thoughtSpotHost = 'tshost';
 const hideBydefault = `&hideAction=${fixedEncodeURI(
-    JSON.stringify([
-        Action.ReportError,
-        ...HiddenActionItemByDefaultForSearchEmbed,
-    ]),
+    JSON.stringify([Action.ReportError, ...HiddenActionItemByDefaultForSearchEmbed]),
 )}`;
 const defaultParamsWithHiddenActions = defaultParams + hideBydefault;
 const prefixParams = '&isSearchEmbed=true';
@@ -40,16 +38,15 @@ beforeAll(() => {
 describe('Search embed tests', () => {
     beforeEach(() => {
         document.body.innerHTML = getDocumentBody();
-        jest.spyOn(authInstance, 'getReleaseVersion').mockReturnValue(
-            '7.4.0.sw',
-        );
+        jest.spyOn(authInstance, 'getReleaseVersion').mockReturnValue('7.4.0.sw');
     });
 
     test('should render', async () => {
         const searchEmbed = new SearchEmbed(getRootEl(), {});
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -63,7 +60,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -81,7 +79,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -99,7 +98,8 @@ describe('Search embed tests', () => {
 
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -114,7 +114,8 @@ describe('Search embed tests', () => {
 
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&executeSearch=true&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -133,7 +134,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=collapse&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -152,7 +154,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=hide&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -178,7 +181,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=hide&useLastSelectedSources=false${prefixParams}&col1=city&op1=EQ&val1=berkeley#/embed/answer`,
             );
         });
@@ -197,7 +201,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=hide&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -217,7 +222,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParams}&disableAction=[%22download%22,%22edit%22]&disableHint=Permission%20denied${hideBydefault}&dataSources=[%22data-source-1%22]&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -230,7 +236,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&enableSearchAssist=true&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/answer`,
             );
         });
@@ -256,7 +263,8 @@ describe('Search embed tests', () => {
             ]),
         );
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParams}&hideAction=${hideActionUrl}&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });
@@ -280,7 +288,8 @@ describe('Search embed tests', () => {
             ]),
         );
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParams}&disableAction=[%22downloadAsXLSX%22]&disableHint=Access%20denied&hideAction=${hideActionUrl}&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });
@@ -293,7 +302,8 @@ describe('Search embed tests', () => {
         });
         searchEmbed.render();
         await executeAfterWait(() => {
-            expect(getIFrameSrc()).toBe(
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
                 `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSourceMode=expand&useLastSelectedSources=false${prefixParams}#/embed/saved-answer/${answerId}`,
             );
         });

package/src/embed/search.ts

@@ -15,11 +15,7 @@ import {
     ViewConfig,
     RuntimeFilter,
 } from '../types';
-import {
-    getQueryParamString,
-    checkReleaseVersionInBeta,
-    getFilterQuery,
-} from '../utils';
+import { getQueryParamString, checkReleaseVersionInBeta, getFilterQuery } from '../utils';
 import { TsEmbed } from './ts-embed';
 import { version } from '../../package.json';
 import { ERROR_MESSAGE } from '../errors';
@@ -37,7 +33,8 @@ export interface SearchOptions {
     /**
      * Boolean to determine if the search should be executed or not.
      * if it is executed, put the focus on the results.
-     * if it’s not executed, put the focus in the search bar - at the end of the tokens
+     * if it’s not executed, put the focus in the search bar - at the end of
+     * the tokens
      */
     executeSearch?: boolean;
 }
@@ -45,7 +42,7 @@ export interface SearchOptions {
 /**
  * The configuration attributes for the embedded search view.
  *
- * @Category Search Embed
+ * @group Embed components
  */
 export interface SearchViewConfig extends ViewConfig {
     /**
@@ -65,6 +62,7 @@ export interface SearchViewConfig extends ViewConfig {
     hideResults?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
+     *
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
      */
     enableSearchAssist?: boolean;
@@ -76,16 +74,19 @@ export interface SearchViewConfig extends ViewConfig {
     /**
      * The array of data source GUIDs to set on load.
      * Only a single dataSource supported currently.
+     *
      * @deprecated Use dataSource instead
      */
     dataSources?: string[];
     /**
      * The array of data source GUIDs to set on load.
+     *
      * @version: SDK: 1.19.0
      */
     dataSource?: string;
     /**
      * The initial search query to load the answer with.
+     *
      * @deprecated Use {@link searchOptions} instead
      */
     searchQuery?: string;
@@ -100,6 +101,7 @@ export interface SearchViewConfig extends ViewConfig {
     /**
      * If set to true, search page will render without the Search Bar
      * The chart/table should still be visible.
+     *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     hideSearchBar?: boolean;
@@ -116,7 +118,7 @@ export const HiddenActionItemByDefaultForSearchEmbed = [
 /**
  * Embed ThoughtSpot search
  *
- * @Category Search Embed
+ * @group Embed components
  */
 export class SearchEmbed extends TsEmbed {
     /**
@@ -145,13 +147,7 @@ export class SearchEmbed extends TsEmbed {
         return dataSourceMode;
     }
 
-    /**
-     * Construct the URL of the embedded ThoughtSpot search to be
-     * loaded in the iframe
-     * @param answerId The GUID of a saved answer
-     * @param dataSources A list of data source GUIDs
-     */
-    private getIFrameSrc(answerId: string, dataSources?: string[]) {
+    protected getEmbedParams(): string {
         const {
             hideResults,
             enableSearchAssist,
@@ -159,8 +155,8 @@ export class SearchEmbed extends TsEmbed {
             searchOptions,
             runtimeFilters,
             dataSource,
+            dataSources,
         } = this.viewConfig;
-        const answerPath = answerId ? `saved-answer/${answerId}` : 'answer';
         const queryParams = this.getBaseQueryParams();
 
         queryParams[Param.HideActions] = [
@@ -205,11 +201,21 @@ export class SearchEmbed extends TsEmbed {
         if (filterQuery) {
             query += `&${filterQuery}`;
         }
+        return query;
+    }
+
+    /**
+     * Construct the URL of the embedded ThoughtSpot search to be
+     * loaded in the iframe
+     *
+     * @param answerId The GUID of a saved answer
+     * @param dataSources A list of data source GUIDs
+     */
+    private getIFrameSrc(answerId: string) {
+        const answerPath = answerId ? `saved-answer/${answerId}` : 'answer';
         const tsPostHashParams = this.getThoughtSpotPostUrlParams();
 
-        return `${this.getEmbedBasePath(
-            query,
-        )}/${answerPath}${tsPostHashParams}`;
+        return `${this.getRootIframeSrc()}/embed/${answerPath}${tsPostHashParams}`;
     }
 
     /**
@@ -217,10 +223,10 @@ export class SearchEmbed extends TsEmbed {
      */
     public render(): SearchEmbed {
         super.render();
-        const { answerId, dataSources } = this.viewConfig;
+        const { answerId } = this.viewConfig;
 
-        const src = this.getIFrameSrc(answerId, dataSources);
-        this.renderIFrame(src, this.viewConfig.frameParams);
+        const src = this.getIFrameSrc(answerId);
+        this.renderIFrame(src);
         getAuthPromise().then(() => {
             if (
                 checkReleaseVersionInBeta(

package/src/embed/searchEmbed-basic-auth.spec.ts

@@ -19,27 +19,27 @@ init({
 });
 
 describe('Search embed tests when authType is Basic', () => {
+    /**
+     *
+     * @param version
+     */
     function setupVersion(version: string) {
-        jest.spyOn(window, 'addEventListener').mockImplementationOnce(
-            (event, handler, options) => {
-                handler({
-                    data: {
-                        type: 'xyz',
-                    },
-                    ports: [3000],
-                    source: null,
-                });
-            },
-        );
-        jest.spyOn(authService, 'fetchSessionInfoService').mockImplementation(
-            async () => ({
-                json: () => ({
-                    ...mockSessionInfo,
-                    releaseVersion: version,
-                }),
-                status: 200,
+        jest.spyOn(window, 'addEventListener').mockImplementationOnce((event, handler, options) => {
+            handler({
+                data: {
+                    type: 'xyz',
+                },
+                ports: [3000],
+                source: null,
+            });
+        });
+        jest.spyOn(authService, 'fetchSessionInfoService').mockImplementation(async () => ({
+            json: () => ({
+                ...mockSessionInfo,
+                releaseVersion: version,
             }),
-        );
+            status: 200,
+        }));
         jest.spyOn(authInstance, 'getReleaseVersion').mockReturnValue(version);
     }
     beforeEach(() => {
@@ -76,9 +76,7 @@ describe('Search embed tests when authType is Basic', () => {
 
     test('releaseVersion is above 8.4.0.sw', async () => {
         setupVersion('8.8.0.sw');
-        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
-            () => 'http://tshost',
-        );
+        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(() => 'http://tshost');
         const mockAlert = jest.spyOn(window, 'alert');
         const searchEmbed = new SearchEmbed(getRootEl(), {});
         await searchEmbed.render();
@@ -87,9 +85,7 @@ describe('Search embed tests when authType is Basic', () => {
 
     test('Alert should not appear when suppressSearchEmbedBetaWarning is true and releaseVersion is ts7.dec.cl', async () => {
         setupVersion('ts7.dec.cl');
-        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
-            () => 'http://tshost',
-        );
+        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(() => 'http://tshost');
         jest.spyOn(baseInstance, 'getEmbedConfig').mockReturnValue({
             suppressSearchEmbedBetaWarning: true,
         });
@@ -101,9 +97,7 @@ describe('Search embed tests when authType is Basic', () => {
 
     test('Alert should not appear when suppressSearchEmbedBetaWarning is true and releaseVersion is 8.4.0.sw', async () => {
         setupVersion('8.4.0.sw');
-        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
-            () => 'http://tshost',
-        );
+        jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(() => 'http://tshost');
         jest.spyOn(baseInstance, 'getEmbedConfig').mockReturnValue({
             suppressSearchEmbedBetaWarning: true,
         });