@thoughtspot/visual-embed-sdk 1.28.3 → 1.28.5-alpha-1

package/src/embed/ts-embed.ts

@@ -8,54 +8,57 @@
  */
 
 import isEqual from 'lodash/isEqual';
-import pkgInfo from '../../package.json';
-import { AuthFailureType } from '../auth';
+import { logger } from '../utils/logger';
 import { getAuthenticationToken } from '../authToken';
+import { AnswerService } from '../utils/graphql/answerService/answerService';
+import {
+    getEncodedQueryParamsString,
+    getCssDimension,
+    getOffsetTop,
+    embedEventStatus,
+    setAttributes,
+    getCustomisations,
+    getRuntimeFilters,
+    getDOMNode,
+    getFilterQuery,
+    getQueryParamString,
+    getRuntimeParameters,
+    setStyleProperties,
+    removeStyleProperties,
+    isUndefined,
+} from '../utils';
 import {
-    DEFAULT_EMBED_HEIGHT,
-    DEFAULT_EMBED_WIDTH,
-    URL_MAX_LENGTH,
     getThoughtSpotHost,
+    URL_MAX_LENGTH,
+    DEFAULT_EMBED_WIDTH,
+    DEFAULT_EMBED_HEIGHT,
     getV2BasePath,
 } from '../config';
-import { MIXPANEL_EVENT, uploadMixpanelEvent } from '../mixpanel-service';
 import {
-    Action,
     AuthType,
-    ContextMenuTriggerOptions,
     DOMSelector,
-    EmbedConfig,
-    EmbedEvent,
     HostEvent,
+    EmbedEvent,
     MessageCallback,
-    MessageCallbackObj,
-    MessageOptions,
+    Action,
     Param,
+    EmbedConfig,
+    MessageOptions,
+    MessagePayload,
+    MessageCallbackObj,
     ViewConfig,
+    FrameParams,
+    ContextMenuTriggerOptions,
+    RuntimeFilter,
 } from '../types';
-import {
-    embedEventStatus,
-    getCssDimension,
-    getCustomisations,
-    getDOMNode,
-    getEncodedQueryParamsString,
-    getFilterQuery,
-    getOffsetTop,
-    getQueryParamString,
-    getRuntimeFilters,
-    getRuntimeParameters,
-    isUndefined,
-    removeStyleProperties,
-    setAttributes,
-    setStyleProperties,
-} from '../utils';
-import { AnswerService } from '../utils/graphql/answerService/answerService';
-import { logger } from '../utils/logger';
-import { processAuthFailure, processEventData } from '../utils/processData';
+import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
+import { processEventData, processAuthFailure } from '../utils/processData';
 import { processTrigger } from '../utils/processTrigger';
+import pkgInfo from '../../package.json';
 import {
-    getAuthPromise, handleAuth, notifyAuthFailure, renderInQueue,
+    getAuthPromise, renderInQueue, handleAuth, notifyAuthFailure,
 } from './base';
+import { AuthFailureType } from '../auth';
 import { getEmbedConfig } from './embedConfig';
 
 const { version } = pkgInfo;
@@ -414,6 +417,15 @@ export class TsEmbed {
         if (this.embedConfig.pendoTrackingKey) {
             queryParams[Param.PendoTrackingKey] = this.embedConfig.pendoTrackingKey;
         }
+        if (this.embedConfig.numberFormatLocale) {
+            queryParams[Param.NumberFormatLocale] = this.embedConfig.numberFormatLocale;
+        }
+        if (this.embedConfig.dateFormatLocale) {
+            queryParams[Param.DateFormatLocale] = this.embedConfig.dateFormatLocale;
+        }
+        if (this.embedConfig.currencyFormat) {
+            queryParams[Param.CurrencyFormat] = this.embedConfig.currencyFormat;
+        }
 
         const {
             disabledActions,
@@ -553,7 +565,8 @@ export class TsEmbed {
 
         const {
             height: frameHeight,
-            width: frameWidth, ...restParams
+            width: frameWidth,
+            ...restParams
         } = this.viewConfig.frameParams || {};
         const width = getCssDimension(frameWidth || DEFAULT_EMBED_WIDTH);
         const height = getCssDimension(frameHeight || DEFAULT_EMBED_HEIGHT);
@@ -675,7 +688,7 @@ export class TsEmbed {
     protected connectPreRendered(): boolean {
         const preRenderIds = this.getPreRenderIds();
         this.preRenderWrapper = this.preRenderWrapper
-        || document.getElementById(preRenderIds.wrapper);
+            || document.getElementById(preRenderIds.wrapper);
 
         this.preRenderChild = this.preRenderChild || document.getElementById(preRenderIds.child);
 
@@ -1093,11 +1106,11 @@ export class TsEmbed {
                 ) {
                     logger.warn(
                         `${viewConfig.embedComponentType || 'Component'} was pre-rendered with `
-                            + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
-                            + `but a different value "${JSON.stringify(viewConfig[key])}" `
-                            + 'was passed to the Embed component. '
-                            + 'The new value provided is ignored, the value provided during '
-                            + 'preRender is used.',
+                        + `"${key}" as "${JSON.stringify(preRenderedObject.viewConfig[key])}" `
+                        + `but a different value "${JSON.stringify(viewConfig[key])}" `
+                        + 'was passed to the Embed component. '
+                        + 'The new value provided is ignored, the value provided during '
+                        + 'preRender is used.',
                     );
                 }
             });

package/src/errors.ts

@@ -1,6 +1,6 @@
 export const ERROR_MESSAGE = {
     INVALID_THOUGHTSPOT_HOST: 'Error parsing ThoughtSpot host. Please provide a valid URL.',
-    LIVEBOARD_VIZ_ID_VALIDATION: 'Please provide either liveboardId or pinboardId',
+    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.',

package/src/react/index.spec.tsx

@@ -49,7 +49,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#/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=false&enableCustomColumnGroups=false#/embed/answer`,
             );
         });
 
@@ -200,35 +200,6 @@ describe('React Components', () => {
             ).toBe(true);
             expect(containerSibling.querySelector('div')).toBe(null);
         });
-
-        it('Should have the correct container element', async () => {
-            const { container } = render(
-                <LiveboardEmbed liveboardId="abcd" className="def" />,
-            );
-
-            await waitFor(() => getIFrameEl(container));
-            expect(container.querySelector('div')).not.toBe(null);
-            expect(
-                container.querySelector('div').classList.contains('def'),
-            ).toBe(true);
-
-            const { container: containerSibling } = render(
-                <LiveboardEmbed
-                    liveboardId="abcd"
-                    className="def"
-                    insertAsSibling={true}
-                />,
-            );
-            await waitFor(() => getIFrameEl(containerSibling));
-            expect(containerSibling.querySelector('span')).not.toBe(null);
-            expect(containerSibling.querySelector('span').style.position).toBe(
-                'absolute',
-            );
-            expect(
-                getIFrameEl(containerSibling).classList.contains('def'),
-            ).toBe(true);
-            expect(containerSibling.querySelector('div')).toBe(null);
-        });
     });
 
     describe('SearchBarEmbed', () => {

package/src/types.ts

@@ -146,7 +146,6 @@ export enum AuthType {
      *      .then((data) => data.token);
      *  }
      * });
-     * });
      * ```
      */
     TrustedAuthToken = 'AuthServer',
@@ -496,7 +495,6 @@ export interface EmbedConfig {
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
      */
     suppressSearchEmbedBetaWarning?: boolean;
-
     /**
      * Hide `beta` alert warning message for SageEmbed.
      *
@@ -594,6 +592,42 @@ export interface EmbedConfig {
      * @version SDK: 1.27.9
      */
     disableSDKTracking?: boolean;
+    /**
+     * Overrides default/user preffered locale for date formatting
+     *
+     * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+     */
+    dateFormatLocale?: string;
+    /**
+     * Overrides default/user preffered locale for number formatting
+     *
+     * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+     */
+    numberFormatLocale?: string;
+    /**
+     * Format to be used for currency when currency format is set to infer from browser
+     *
+     * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
+     */
+    currencyFormat?: string;
+
+    /**
+     * This flag is used to disable the token verification in the SDK.
+     * Enabling this flag will also disable the caching of the token.
+     *
+     * @hidden
+     *
+     * @example
+     * ```js
+     * init({
+     *   ...embedConfig,
+     *   disableTokenVerification : true
+     * })
+     * ```
+     *
+     * @version SDK: 1.28.5 | Thoughtspot: *
+     */
+    disableTokenVerification?: boolean;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -639,6 +673,7 @@ export interface ViewConfig {
      * object inside your app.  Specify the values in pixels or percentage.
      *
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -678,7 +713,6 @@ export interface ViewConfig {
     disabledActions?: Action[];
     /**
      * The tooltip to display for disabled actions.
-     *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      * ```js
@@ -696,6 +730,7 @@ export interface ViewConfig {
      * Use this to hide an action.
      *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -716,6 +751,7 @@ export interface ViewConfig {
      *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @important
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -729,6 +765,7 @@ export interface ViewConfig {
      * Show alert messages and toast messages in the embedded view.
      *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -743,6 +780,7 @@ export interface ViewConfig {
      * visualization, or Liveboard.
      *
      * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -763,6 +801,7 @@ export interface ViewConfig {
      * visualization, or Liveboard.
      *
      * @version SDK : 1.25.0 | Thoughtspot: 9.2.0.cl, 9.5.0.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -797,7 +836,6 @@ export interface ViewConfig {
      * 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', {
@@ -824,6 +862,7 @@ export interface ViewConfig {
      * child inside it.
      *
      * @version SDK: 1.2.0 | Thoughtspot: 9.0.0.cl, 9.0.0.sw
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -909,8 +948,6 @@ export interface ViewConfig {
      * Hide the home page modules
      * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
      *
-     *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -923,13 +960,13 @@ export interface ViewConfig {
      *    hiddenHomepageModules : [HomepageModule.Favorite,HomepageModule.Learning],
      * })
      * ```
+     *
      */
     hiddenHomepageModules?: HomepageModule[];
     /**
      * reordering the home page modules
      * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
      *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -952,6 +989,7 @@ export interface ViewConfig {
      * Use either `visibleTabs` or `hiddenTabs`.
      *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     *
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed-container', {
@@ -977,8 +1015,6 @@ export interface ViewConfig {
      * })
      * ```
      *
-     *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -1012,6 +1048,7 @@ export interface ViewConfig {
      * @type {boolean}
      * @default false
      * @version SDK: 1.24.0 | ThoughtSpot:9.4.0.cl, 9.4.0.sw
+     *
      * @example
      * ```js
      * // Disable tracking PreRender size in the configuration
@@ -1432,8 +1469,7 @@ export enum EmbedEvent {
      *
      *  API - API call failure error.
      *
-     *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen
-     *  mode.
+     *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen mode.
      *
      *  SINGLE_VALUE_FILTER - Error due to multiple values in the single value filter.
      *
@@ -3082,6 +3118,13 @@ export enum Param {
     ClientLogLevel = 'clientLogLevel',
     OverrideNativeConsole = 'overrideConsoleLogs',
     enableAskSage = 'enableAskSage',
+    CollapseSearchBarInitially= 'collapseSearchBarInitially',
+    EnableCustomColumnGroups = 'enableCustomColumnGroups',
+    DateFormatLocale = 'dateFormatLocale',
+    NumberFormatLocale = 'numberFormatLocale',
+    CurrencyFormat = 'currencyFormat',
+    Enable2ColumnLayout = 'enable2ColumnLayout',
+    IsFullAppEmbed = 'isFullAppEmbed',
 }
 
 /**
@@ -3219,6 +3262,18 @@ export enum Action {
      * ```
      */
     AddFilter = 'addFilter',
+    /**
+     * The **Add Data Panel Objects** action on the data panel v2.
+     * Allows to show action menu to add different objects (like
+     * formulas, parameters) in data panel v2.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.AddDataPanelObjects]
+     * ```
+     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     */
+    AddDataPanelObjects = 'addDataPanelObjects',
     /**
      * Filter configuration options on a Liveboard and Search page.
      * Allows configuring filter options when adding filters to a
@@ -3261,6 +3316,28 @@ export enum Action {
      * ```
      */
     AddParameter = 'addParameter',
+    /**
+     * The **Add Column Set** action on a Answer.
+     * Allows adding column sets to a Answer.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.AddColumnSet]
+     * ```
+     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     */
+    AddColumnSet = 'addSimpleCohort',
+    /**
+     * The **Add Query Set** action on a Answer.
+     * Allows adding query sets to a Answer.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.AddQuerySet]
+     * ```
+     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     */
+    AddQuerySet = 'addAdvancedCohort',
     /**
      * @hidden
      */
@@ -3693,6 +3770,28 @@ export enum Action {
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     CrossFilter = 'context-menu-item-cross-filter',
+    /**
+     * The **Sync to Slack** action on Liveboard visualizations.
+     * Allows sending data to third-party apps Slack
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.SyncToSlack]
+     * ```
+     * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
+     */
+    SyncToSlack = 'syncToSlack',
+    /**
+     * The **Sync to Teams** action on Liveboard visualizations.
+     * Allows sending data to third-party apps Team
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.SyncToTeams]
+     * ```
+     * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
+     */
+    SyncToTeams = 'syncToTeams',
     /**
      * The **Remove** action that appears when cross filters are applied
      * on a Liveboard.
@@ -4001,15 +4100,15 @@ export enum Action {
     RemoveFromWatchlist = 'removeFromWatchlist',
 
     /**
-     * The **Copy KPI Link** menu action on KPI watchlist.
+     * The **Organise Favourites** action on Homepage Favourite Module.
      *
      * @example
      * ```js
-     * disabledActions: [Action.CopyKpiLink]
+     * disabledActions: [Action.OrganiseFavourites]
      * ```
-     * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
+     * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
      */
-    CopyKpiLink = 'copyKpiLink',
+    OrganiseFavourites = 'organiseFavourites',
 
     /**
      * Action ID for AI Highlights button

package/src/utils/authService/authService.spec.ts

@@ -1,11 +1,11 @@
 import {
-    EndPoints,
-    fetchAuthPostService,
-    fetchAuthService,
+    fetchSessionInfoService,
     fetchAuthTokenService,
+    fetchAuthService,
     fetchBasicAuthService,
-    fetchSessionInfoService,
+    fetchAuthPostService,
     verifyTokenService,
+    EndPoints,
 } from '.';
 import { logger } from '../logger';