@thoughtspot/visual-embed-sdk 1.36.7 → 1.36.9-primary-actions

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

@@ -346,6 +346,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -381,6 +382,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -422,6 +424,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [HomepageModule.MyLibrary, HomepageModule.Learning],
+                        hiddenListColumns: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -459,6 +462,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -499,6 +503,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         reorderedHomepageModules:
                             [HomepageModule.MyLibrary, HomepageModule.Watchlist],
                         customVariablesForThirdPartyTools,
@@ -542,6 +547,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: 'param1=color&paramVal1=blue',
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -586,6 +592,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -629,6 +636,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -673,6 +681,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
@@ -716,6 +725,7 @@ describe('Unit test case for ts embed', () => {
                         hiddenHomeLeftNavItems:
                       [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools,
                     },
@@ -883,6 +893,7 @@ describe('Unit test case for ts embed', () => {
                         runtimeParameterParams: null,
                         hiddenHomeLeftNavItems: [],
                         hiddenHomepageModules: [],
+                        hiddenListColumns: [],
                         hostConfig: undefined,
                         reorderedHomepageModules: [],
                         customVariablesForThirdPartyTools: {},
@@ -894,6 +905,113 @@ describe('Unit test case for ts embed', () => {
         });
     });
 
+    describe('StringIDs and StringIDsUrl in customisations', () => {
+        const customisationWithStringIds = {
+            style: {
+                customCSS: {},
+            },
+            content: {
+                strings: {
+                    Liveboard: 'Dashboard',
+                },
+                stringIDsUrl: 'https://sample-string-ids-url.com',
+                stringIDs: {
+                    'liveboard.header.title': 'Dashboard name',
+                },
+            },
+        };
+        beforeEach(() => {
+            jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);
+            jest.spyOn(authService, 'verifyTokenService').mockResolvedValue(true);
+            init({
+                thoughtSpotHost: 'tshost',
+                customizations: customisationWithStringIds,
+                authType: AuthType.TrustedAuthTokenCookieless,
+                getAuthToken: () => Promise.resolve('test_auth_token1'),
+            });
+        });
+
+        afterEach(() => {
+            baseInstance.reset();
+            jest.clearAllMocks();
+        });
+
+        test('should pass stringIDsUrl and stringIDs in customisations during APP_INIT', async () => {
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.APP_INIT,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), defaultViewConfig);
+            searchEmbed.render();
+            const mockPort: any = {
+                postMessage: jest.fn(),
+            };
+
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                expect(iframe.src).toContain('overrideStringIDsUrl=https://sample-string-ids-url.com');
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+
+            await executeAfterWait(() => {
+                expect(mockPort.postMessage).toHaveBeenCalledWith({
+                    type: EmbedEvent.APP_INIT,
+                    data: {
+                        customisations: {
+                            content: {
+                                strings: {
+                                    Liveboard: 'Dashboard',
+                                },
+                                stringIDsUrl: 'https://sample-string-ids-url.com',
+                                stringIDs: {
+                                    'liveboard.header.title': 'Dashboard name',
+                                },
+                            },
+                            style: {
+                                customCSS: {},
+                                customCSSUrl: undefined,
+                            },
+                        },
+                        authToken: 'test_auth_token1',
+                        runtimeFilterParams: null,
+                        runtimeParameterParams: null,
+                        hiddenHomeLeftNavItems: [],
+                        hiddenHomepageModules: [],
+                        hiddenListColumns: [],
+                        hostConfig: undefined,
+                        reorderedHomepageModules: [],
+                        customVariablesForThirdPartyTools: {},
+                    },
+                });
+                const customisationContent = mockPort.postMessage.mock.calls[0][0].data.customisations.content;
+                expect(customisationContent.stringIDsUrl)
+                    .toBe('https://sample-string-ids-url.com');
+                expect(customisationContent.stringIDs)
+                    .toEqual({
+                        'liveboard.header.title': 'Dashboard name',
+                    });
+            });
+        });
+
+        test('should allow passing exposeTranslationIDs in viewConfig', async () => {
+            const mockEmbedEventPayload = {
+                type: EmbedEvent.APP_INIT,
+                data: {},
+            };
+            const searchEmbed = new SearchEmbed(getRootEl(), { ...defaultViewConfig, exposeTranslationIDs: true });
+            searchEmbed.render();
+            const mockPort: any = {
+                postMessage: jest.fn(),
+            };
+
+            await executeAfterWait(() => {
+                const iframe = getIFrameEl();
+                expect(iframe.src).toContain('exposeTranslationIDs=true');
+                postMessageToParent(iframe.contentWindow, mockEmbedEventPayload, mockPort);
+            });
+        });
+    });
+
     describe('Token fetch fails in cookieless authentication authType', () => {
         beforeEach(() => {
             jest.spyOn(authInstance, 'doCookielessTokenAuth').mockResolvedValueOnce(true);

package/src/embed/ts-embed.ts

@@ -377,6 +377,7 @@ export class TsEmbed {
                 : [],
             customVariablesForThirdPartyTools:
                 this.embedConfig.customVariablesForThirdPartyTools || {},
+            hiddenListColumns: this.viewConfig.hiddenListColumns || [],
         };
     }
 
@@ -538,6 +539,8 @@ export class TsEmbed {
             insertInToSlide,
             disableRedirectionLinksInNewTab,
             overrideOrgId,
+            exposeTranslationIDs,
+            primaryActions,
         } = this.viewConfig;
 
         const { additionalFlags: additionalFlagsFromInit } = this.embedConfig;
@@ -560,9 +563,15 @@ export class TsEmbed {
         if (disabledActions?.length) {
             queryParams[Param.DisableActions] = disabledActions;
         }
+        if (primaryActions?.length) {
+            queryParams[Param.PrimaryActions] = primaryActions;
+        }
         if (disabledActionReason) {
             queryParams[Param.DisableActionReason] = disabledActionReason;
         }
+        if (exposeTranslationIDs) {
+            queryParams[Param.ExposeTranslationIDs] = exposeTranslationIDs;
+        }
         queryParams[Param.HideActions] = [...this.defaultHiddenActions, ...(hiddenActions ?? [])];
         if (Array.isArray(visibleActions)) {
             queryParams[Param.VisibleActions] = visibleActions;
@@ -592,6 +601,12 @@ export class TsEmbed {
             queryParams[Param.IconSpriteUrl] = spriteUrl.replace('https://', '');
         }
 
+        const stringIDsUrl = customizations?.content?.stringIDsUrl
+            || embedCustomizations?.content?.stringIDsUrl;
+        if (stringIDsUrl) {
+            queryParams[Param.StringIDsUrl] = stringIDsUrl;
+        }
+
         if (showAlerts !== undefined) {
             queryParams[Param.ShowAlerts] = showAlerts;
         }

package/src/index.ts

@@ -52,6 +52,7 @@ import {
     LogLevel,
     VizPoint,
     CustomActionPayload,
+    ListPageColumns,
 } from './types';
 import { CustomCssVariables } from './css-variables';
 import { SageEmbed, SageViewConfig } from './embed/sage';
@@ -129,6 +130,7 @@ export {
     VizPoint,
     CustomActionPayload,
     UIPassthroughEvent,
+    ListPageColumns,
 };
 
 export { resetCachedAuthToken } from './authToken';

package/src/react/index.tsx

@@ -24,8 +24,8 @@ const componentFactory = <T extends typeof TsEmbed, U extends EmbedProps, V exte
 ) => React.forwardRef<InstanceType<T>, U>(
     (props: U, forwardedRef: React.MutableRefObject<InstanceType<T>>) => {
         const ref = React.useRef<HTMLDivElement>(null);
-        const { className, ...embedProps } = props;
-        const { viewConfig, listeners } = getViewPropsAndListeners<Omit<U, 'className'>, V>(
+        const { className, style, ...embedProps } = props;
+        const { viewConfig, listeners } = getViewPropsAndListeners<Omit<U, 'className' | 'style'>, V>(
             embedProps,
         );
 
@@ -93,7 +93,7 @@ const componentFactory = <T extends typeof TsEmbed, U extends EmbedProps, V exte
         return viewConfig.insertAsSibling ? (
             <span data-testid="tsEmbed" ref={ref} style={{ position: 'absolute' }}></span>
         ) : (
-            <div data-testid="tsEmbed" ref={ref} className={className}></div>
+            <div data-testid="tsEmbed" ref={ref} style={style} className={`ts-embed-container ${className}`}></div>
         );
     },
 );
@@ -444,4 +444,5 @@ export {
     HomepageModule,
     LogLevel,
     getSessionInfo,
+    ListPageColumns,
 } from '../index';

package/src/react/util.ts

@@ -4,6 +4,7 @@ export type EmbedEventHandlers = { [key in keyof typeof EmbedEvent as `on${Capit
 
 export interface EmbedProps extends ViewConfig, EmbedEventHandlers {
     className?: string;
+    style?: React.CSSProperties;
 }
 
 export interface ViewConfigAndListeners<T extends ViewConfig> {

package/src/types.ts

@@ -297,6 +297,8 @@ export interface CustomisationsInterface {
          * @version SDK: 1.26.0 | 9.7.0.cl
          */
         strings?: Record<string, any>;
+        stringIDs?: Record<string, string>;
+        stringIDsUrl?: string;
         [key: string]: any;
     };
     iconSpriteUrl?: string;
@@ -626,14 +628,14 @@ export interface EmbedConfig {
      *     }
      * });
      * ```
-     *  @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
+     *  @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
     customVariablesForThirdPartyTools?: Record< string, any >;
 
     disablePreauthCache?: boolean;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface LayoutConfig {}
 
 /**
@@ -710,6 +712,20 @@ export interface ViewConfig {
      * ```
      */
     disabledActions?: Action[];
+    /**
+     * The list of actions to display as primary actions,
+     *  These actions will be displayed upfront in the liveboard/app embed.
+     * Use this to display actions.
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.9.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   primaryActions: [Action.Download]
+     * });
+     * ```
+     */
+    primaryActions?: Action[];
     /**
      * The tooltip to display for disabled actions.
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
@@ -1072,6 +1088,12 @@ export interface ViewConfig {
      * });
      */
     collapseSearchBar?: boolean;
+    /**
+     * This flag can be used to expose translation IDs on the embedded app.
+     * @default false
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+     */
+    exposeTranslationIDs?: boolean;
     /**
      * This flag can be used to disable links inside the embedded app,
      * and disable redirection of links in a new tab.
@@ -1126,6 +1148,21 @@ export interface ViewConfig {
      * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
      */
     overrideOrgId?: number;
+    /**
+     * Hide list page columns
+     * For example: hiddenListColumns = [ListPageColumns.Author]
+     *
+     * **Note**: This option is appplicable only in full app embedding.
+     * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
+     * })
+     * ```
+     */
+    hiddenListColumns?: ListPageColumns[];
 }
 
 /**
@@ -1286,6 +1323,35 @@ export enum HomepageModule {
     Learning = 'LEARNING',
 }
 
+/**
+ * List page columns that can be hidden.
+ * **Note**: This option is applicable only in full app embedding.
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
+ */
+// eslint-disable-next-line no-shadow
+export enum ListPageColumns {
+    /**
+     * Favourite
+     */
+    Favourite = 'FAVOURITE',
+    /**
+     * Tags
+     */
+    Tags = 'TAGS',
+    /**
+     * Author
+     */
+    Author = 'AUTHOR',
+    /**
+     * Last viewed/Last modified
+     */
+    DateSort = 'DATE_SORT',
+    /**
+     * Share
+     */
+    Share = 'SHARE',
+}
+
 /**
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
  * visualizations at runtime.
@@ -2312,16 +2378,19 @@ export enum EmbedEvent {
     /**
      * Emits when a table visualization is rendered in
      * the ThoughtSpot embedded app.
+     *
      * You can also use this event as a hook to trigger host events
      * such as `HostEvent.TransformTableVizData` on the table visualization.
      * The event payload contains the data used in the rendered table.
      * You can extract the relevant data from the payload
      * stored in `payload.data.data.columnDataLite`.
+     *
      * `columnDataLite` is a multidimensional array that contains
      * data values for each column, which was used in the query to
      * generate the table visualization. To find and modify specific cell data,
      * you can either loop through the array or directly access a cell if
      * you know its position and data index.
+     *
      * In the following code sample, the first cell in the first column
      * (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
      * Note that any changes made to the data in the payload will only update the
@@ -2331,6 +2400,7 @@ export enum EmbedEvent {
      * payload in the `columnDataLite` is passed on to
      * `HostEvent.TransformTableVizData` and trigger an update to
      * the table visualization.
+     *
      * If the Row-Level Security (RLS) rules are applied on the
      * Worksheet or Model, exercise caution when changing column
      * or table cell values to maintain data security.
@@ -2345,7 +2415,7 @@ export enum EmbedEvent {
      *      searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
      * })
      * ```
-     * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
      */
      TableVizRendered = 'TableVizRendered',
      /**
@@ -2358,7 +2428,7 @@ export enum EmbedEvent {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
+     * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
      */
     CreateLiveboard = 'createLiveboard',
     /**
@@ -2807,7 +2877,7 @@ export enum HostEvent {
      * ```js
      * liveboardEmbed.trigger(HostEvent.Remove)
      * ```
-     * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
      */
     Remove = 'delete',
     /**
@@ -3355,7 +3425,7 @@ export enum HostEvent {
      * ```js
      * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
      *```
-     * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
      InfoSuccess = 'InfoSuccess',
     /**
@@ -3402,7 +3472,7 @@ export enum HostEvent {
      *      searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
      * })
      * ```
-     * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
      */
     TransformTableVizData = 'TransformTableVizData',
 }
@@ -3457,6 +3527,7 @@ export enum Param {
     livedBoardEmbed = 'isLiveboardEmbed',
     searchEmbed = 'isSearchEmbed',
     vizEmbed = 'isVizEmbed',
+    StringIDsUrl = 'overrideStringIDsUrl',
     Version = 'sdkVersion',
     ViewPortHeight = 'viewPortHeight',
     ViewPortWidth = 'viewPortWidth',
@@ -3512,6 +3583,7 @@ export enum Param {
     HideSageAnswerHeader = 'hideSageAnswerHeader',
     HideSearchBar = 'hideSearchBar',
     ClientLogLevel = 'clientLogLevel',
+    ExposeTranslationIDs = 'exposeTranslationIDs',
     OverrideNativeConsole = 'overrideConsoleLogs',
     enableAskSage = 'enableAskSage',
     CollapseSearchBarInitially = 'collapseSearchBarInitially',
@@ -3538,6 +3610,8 @@ export enum Param {
     DataSourceId = 'dataSourceId',
     preAuthCache = 'preAuthCache',
     ShowSpotterLimitations = 'showSpotterLimitations',
+    CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
+    PrimaryActions = 'primaryActions',
 }
 
 /**
@@ -3704,7 +3778,7 @@ export enum Action {
     * The **Collapse data panel** icon on the Search page.
     * Collapses the data panel view.
     *
-    * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
+    * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
     *
     * @example
     * ```js
@@ -4766,6 +4840,16 @@ export enum Action {
      *  @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
      */
     ColumnRename = 'columnRename',
+    /**
+     * Action ID for hide checkboxes for include or exclude
+     * cover and filter pages in the Liveboard PDF
+     *  @example
+     * ```js
+     * hiddenAction: [Action.CoverAndFilterOptionInPDF]
+     * ```
+     *  @version SDK: 1.38.0 | ThoughtSpot Cloud: 10.8.0.cl
+     */
+    CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
 }
 
 export interface AnswerServiceType {
@@ -4780,8 +4864,8 @@ export enum PrefetchFeatures {
 }
 
 /**
- * Enum for options to change context trigger
- * BOTH_CLICKS option is introduced in 10.7
+ * Enum for options to change context trigger.
+ * The `BOTH_CLICKS` option is available from 10.8.0.cl.
  */
 export enum ContextMenuTriggerOptions {
     LEFT_CLICK = 'left-click',
@@ -4933,4 +5017,5 @@ export interface DefaultAppInitData {
     hostConfig: Record<string, any>;
     hiddenHomeLeftNavItems: string[];
     customVariablesForThirdPartyTools: Record<string, any>;
+    hiddenListColumns: ListPageColumns[];
 }