@thoughtspot/visual-embed-sdk 1.33.4 → 1.33.6

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

@@ -13,6 +13,7 @@ import {
 import {
     Action, HomeLeftNavItem, RuntimeFilter, RuntimeFilterOp, HomepageModule, HostEvent,
     RuntimeParameter,
+    Param,
 } from '../types';
 import {
     executeAfterWait,
@@ -24,10 +25,12 @@ import {
     defaultParamsForPinboardEmbed,
     waitFor,
     expectUrlMatchesWithParams,
+    expectUrlToHaveParamsWithValues,
     mockMessageChannel,
     createRootEleForEmbed,
 } from '../test/test-utils';
 import * as config from '../config';
+import * as embedConfig from './embedConfig';
 import * as tsEmbedInstance from './ts-embed';
 import * as mixpanelInstance from '../mixpanel-service';
 import * as authInstance from '../auth';
@@ -1274,6 +1277,36 @@ describe('Unit test case for ts embed', () => {
             );
         });
 
+        it('should set the additional flags correctly on the iframe src from init and view config', async () => {
+            init({
+                thoughtSpotHost: 'http://tshost',
+                authType: AuthType.None,
+                additionalFlags: {
+                    foo: 'bar1',
+                    foo2: 'bar2',
+                    foo3: false,
+                },
+            });
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+                additionalFlags: {
+                    foo: 'bar',
+                    baz: 1,
+                    bool: true,
+                },
+            });
+            await appEmbed.render();
+            console.log('val ', getIFrameSrc());
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
+                + `&foo=bar&foo2=bar2&foo3=false&baz=1&bool=true${defaultParamsPost}#/home`,
+            );
+        });
+
         it('Sets the showAlerts param', async () => {
             const appEmbed = new AppEmbed(getRootEl(), {
                 frameParams: {
@@ -1407,6 +1440,20 @@ describe('Unit test case for ts embed', () => {
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&numberFormatLocale=en-US&dateFormatLocale=en-IN&currencyFormat=USD${defaultParamsPost}#/home`,
             );
         });
+        it('Sets the overrideOrgId param', async () => {
+            const overrideOrgId = 142536;
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+                overrideOrgId,
+            });
+            await appEmbed.render();
+            expectUrlToHaveParamsWithValues(getIFrameSrc(), {
+                orgId: overrideOrgId,
+            });
+        });
     });
 
     describe('When destroyed', () => {

package/src/embed/ts-embed.ts

@@ -7,6 +7,8 @@
  */
 
 import isEqual from 'lodash/isEqual';
+import isEmpty from 'lodash/isEmpty';
+import isObject from 'lodash/isObject';
 import { logger } from '../utils/logger';
 import { getAuthenticationToken } from '../authToken';
 import { AnswerService } from '../utils/graphql/answerService/answerService';
@@ -398,6 +400,7 @@ export class TsEmbed {
         if (hostAppUrl.includes('localhost') || hostAppUrl.includes('127.0.0.1')) {
             hostAppUrl = 'local-host';
         }
+        queryParams[Param.EmbedApp] = true;
         queryParams[Param.HostAppUrl] = encodeURIComponent(hostAppUrl);
         queryParams[Param.ViewPortHeight] = window.innerHeight;
         queryParams[Param.ViewPortWidth] = window.innerWidth;
@@ -435,15 +438,23 @@ export class TsEmbed {
             hiddenTabs,
             visibleTabs,
             showAlerts,
-            additionalFlags,
+            additionalFlags: additionalFlagsFromView,
             locale,
             customizations,
             contextMenuTrigger,
             linkOverride,
             insertInToSlide,
             disableRedirectionLinksInNewTab,
+            overrideOrgId,
         } = this.viewConfig;
 
+        const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
+
+        const additionalFlags = {
+            ...additionalFlagsFromInit,
+            ...additionalFlagsFromView,
+        };
+
         if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
             this.handleError('You cannot have both hidden actions and visible actions');
             return queryParams;
@@ -503,11 +514,14 @@ export class TsEmbed {
         if (disableRedirectionLinksInNewTab) {
             queryParams[Param.DisableRedirectionLinksInNewTab] = disableRedirectionLinksInNewTab;
         }
+        if (overrideOrgId !== undefined) {
+            queryParams[Param.OverrideOrgId] = overrideOrgId;
+        }
 
         queryParams[Param.OverrideNativeConsole] = true;
         queryParams[Param.ClientLogLevel] = this.embedConfig.logLevel;
 
-        if (additionalFlags && additionalFlags.constructor.name === 'Object') {
+        if (isObject(additionalFlags) && !isEmpty(additionalFlags)) {
             Object.assign(queryParams, additionalFlags);
         }
 

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=false&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true&collapseSearchBarInitially=true&enableCustomColumnGroups=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_ALL#/embed/answer`,
+                `http://${thoughtSpotHost}/?embedApp=true&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`,
             );
         });
 
@@ -230,7 +230,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]&overrideConsoleLogs=true&clientLogLevel=ERROR&dataSources=[%22test%22]&searchTokenString=%5Brevenue%5D&executeSearch=true&useLastSelectedSources=false&isSearchEmbed=true#/embed/search-bar-embed`,
+                `http://${thoughtSpotHost}/?embedApp=true&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&authType=None&blockNonEmbedFullAppAccess=true&hideAction=[%22${Action.ReportError}%22]&overrideConsoleLogs=true&clientLogLevel=ERROR&dataSources=[%22test%22]&searchTokenString=%5Brevenue%5D&executeSearch=true&useLastSelectedSources=false&isSearchEmbed=true#/embed/search-bar-embed`,
             );
         });
     });

package/src/types.ts

@@ -588,6 +588,26 @@ export interface EmbedConfig {
      * @version SDK 1.32.3 | Thoughtspot: *
      */
     disableLoginFailurePage?: boolean;
+    /**
+     * This is an object (key/val) of override flags which will be applied
+     * to the internal embedded object. This can be used to add any
+     * URL flag.
+     * Warning: This option is for advanced use only and is used internally
+     * to control embed behavior in non-regular ways. We do not publish the
+     * list of supported keys and values associated with each.
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   additionalFlags: {
+     *        flag1: 'value1',
+     *        flag2: 'value2'
+     *     }
+     * });
+     * ```
+     * @version SDK: 1.33.5 | ThoughtSpot: *
+     */
+    additionalFlags?: { [key: string]: string | number | boolean };
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -779,6 +799,7 @@ export interface ViewConfig {
      * This is an object (key/val) of override flags which will be applied
      * to the internal embedded object. This can be used to add any
      * URL flag.
+     * If the same flags are passed in init, they will be overriden by the values here.
      * Warning: This option is for advanced use only and is used internally
      * to control embed behavior in non-regular ways. We do not publish the
      * list of supported keys and values associated with each.
@@ -1066,6 +1087,19 @@ export interface ViewConfig {
      * ```
      */
     enableCustomColumnGroups?: boolean;
+    /**
+     * View content for another org directly without having to use the org switcher
+     * This flag is honoured if orgPerUrl feature is enabled for the ThoughtSpot cluster
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other options
+     *   overrideOrgId: 142536
+     * });
+     * ```
+     * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
+     */
+    overrideOrgId?: number;
 }
 
 /**
@@ -1121,7 +1155,7 @@ export type MessageCallbackObj = {
 export type GenericCallbackFn = (...args: any[]) => any;
 
 export type QueryParams = {
-    [key: string]: string;
+    [key: string]: string | boolean | number;
 };
 
 /**
@@ -2965,12 +2999,13 @@ 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[Supported data types].
+     *  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
      *
@@ -3260,8 +3295,10 @@ export enum Param {
     ShowLiveboardVerifiedBadge = 'showLiveboardVerifiedBadge',
     ShowLiveboardReverifyBanner = 'showLiveboardReverifyBanner',
     LiveboardHeaderV2 = 'isLiveboardHeaderV2Enabled',
+    HideIrrelevantFiltersInTab = 'hideIrrelevantFiltersAtTabLevel',
     SpotterEnabled = 'isSpotterExperienceEnabled',
     IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
+    OverrideOrgId = 'orgId',
 }
 
 /**
@@ -4320,6 +4357,16 @@ export enum Action {
      * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
      */
     DisableChipReorder = 'disableChipReorder',
+
+    /**
+     * Action ID for Hide Irrelevant filters button
+     *  @example
+     * ```js
+     * hiddenAction: [Action.ChangeFilterVisibilityInTab]
+     * ```
+     *  @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
+     */
+    ChangeFilterVisibilityInTab = 'changeFilterVisibilityInTab',
 }
 
 export interface AnswerServiceType {