@thoughtspot/visual-embed-sdk 1.32.1 → 1.32.3-alpha-1

package/src/hostEventsTypeMapping.ts

@@ -0,0 +1,23 @@
+import { HostEvent } from './types';
+
+/**
+ * {
+ *   HostEventType: {
+ *      returnType: string,
+ *      inoutParams: {}
+ *   }
+ * }
+ */
+interface HostEventTypeMapping {
+  [HostEvent.Pin]: {
+    returnType: string;
+    inputParams: {
+      vizId: string;
+    };
+  },
+  [HostEvent.Reload]: {
+    returnType: null;
+    inputParams: void;
+  },
+  [key: string] : any;
+}

package/src/mixpanel-service.ts

@@ -11,6 +11,10 @@ export const EndPoints = {
 const mixpanelLib = mixpanel.default || mixpanel;
 let mixpanelInstance: mixpanel.Mixpanel;
 
+/**
+ * Enum of mixpanel events
+ * @hidden
+ */
 export const MIXPANEL_EVENT = {
     VISUAL_SDK_RENDER_START: 'visual-sdk-render-start',
     VISUAL_SDK_CALLED_INIT: 'visual-sdk-called-init',

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}/?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=true&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true&collapseSearchBarInitially=true&enableCustomColumnGroups=false&dataPanelCustomGroupsAccordionInitialState=EXPAND_ALL#/embed/answer`,
             );
         });
 

package/src/types.ts

@@ -589,10 +589,17 @@ export interface EmbedConfig {
      * @version SDK: 1.28.5 | Thoughtspot: *
      */
     disableTokenVerification?: boolean;
+
+    /**
+     * This flag is used to disable showing the login failure page in the embedded app.
+     *
+     * @version SDK 1.32.3 | Thoughtspot: *
+     */
+    disableLoginFailurePage?: boolean;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface LayoutConfig { }
+export interface LayoutConfig {}
 
 /**
  * Embedded iframe configuration
@@ -1040,6 +1047,19 @@ export interface ViewConfig {
      * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
      */
     disableRedirectionLinksInNewTab?: boolean;
+    /**
+     * Flag to control Data panel experience
+     * @default true
+     * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    dataPanelV2: true,
+     * })
+     * ```
+     */
+    dataPanelV2?: boolean;
 }
 
 /**
@@ -1801,7 +1821,6 @@ export enum EmbedEvent {
     /**
      * Emitted when a user clicks the **Update TML** action on
      * embedded Liveboard.
-     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1813,7 +1832,6 @@ export enum EmbedEvent {
     /**
      * Emitted when a user clicks the **Edit TML** action
      * on an embedded Liveboard.
-     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -2423,20 +2441,16 @@ export enum HostEvent {
     /**
      * Trigger the **Export TML** action on an embedded Liveboard or
      * Answer.
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ExportTML)
      * ```
-     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     ExportTML = 'exportTSL',
     /**
      * Trigger the **Edit TML** action on an embedded Liveboard or
      * saved Answers in the full application embedding.
-     *
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -2563,7 +2577,6 @@ export enum HostEvent {
      * This event is not supported in visualization embed and search embed.
      * @param - object - To trigger the action for a specific visualization
      * in Liveboard embed, pass in `vizId` as a key.
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Edit)
@@ -2830,7 +2843,6 @@ export enum HostEvent {
     /**
      * Get details of filters applied on the Liveboard.
      * Returns arrays containing Liveboard filter and runtime filter elements.
-     *
      * @example
      * ```js
      * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -3133,6 +3145,7 @@ export enum Param {
     IsOnBeforeGetVizDataInterceptEnabled = 'isOnBeforeGetVizDataInterceptEnabled',
     FocusSearchBarOnRender = 'focusSearchBarOnRender',
     DisableRedirectionLinksInNewTab = 'disableRedirectionLinksInNewTab',
+    HomePageSearchBarMode = 'homePageSearchBarMode',
 }
 
 /**
@@ -3184,7 +3197,6 @@ export enum Action {
      * The **Save as View** action on the Answer
      * page. Saves an Answer as a View object in the full
      * application embedding mode.
-     *
      * @example
      * ```js
      * disabledActions: [Action.SaveAsView]
@@ -3643,7 +3655,6 @@ export enum Action {
     /**
      * The **Delete** action for Answers in the full application
      * embedding mode.
-     *
      * @example
      * ```js
      * disabledActions: [Action.AnswerDelete]
@@ -3915,9 +3926,6 @@ export enum Action {
      */
     RenameModalTitleDescription = 'renameModalTitleDescription',
     /**
-     *
-     * The **Request Verification** action on the Liveboard.
-     * Triggers a Liveboard verification request.
      *
      * @example
      * ```js
@@ -4064,7 +4072,7 @@ export enum Action {
      *
      * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
      */
-    CreateLiveboard = 'CreateLiveboard',
+    CreateLiveboard = 'createLiveboard',
 
     /**
      * Action ID for to hide Verified Liveboard Banner
@@ -4166,6 +4174,17 @@ export enum Action {
      */
     UnsubscribeScheduleHomepage = 'unsubscribeScheduleHomepage',
 
+    /**
+     * The **Manage Tags** action on Homepage Favourite Module.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.ManageTags]
+     * ```
+     * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
+     */
+    ManageTags = 'manageTags',
+
     /**
      * Action ID for delete schedule action on schedule on homepage
      * @example
@@ -4214,15 +4233,15 @@ export interface ColumnValue {
         [key: string]: any;
     };
     value:
-    | string
-    | number
-    | boolean
-    | {
-        v: {
-            s: number;
-            e: number;
-        };
-    };
+        | string
+        | number
+        | boolean
+        | {
+              v: {
+                  s: number;
+                  e: number;
+              };
+          };
 }
 
 export interface VizPoint {

package/src/utils/processData.ts

@@ -78,8 +78,8 @@ function processNoCookieAccess(e: any, containerEl: Element) {
  * @param containerEl
  */
 export function processAuthFailure(e: any, containerEl: Element) {
-    const { loginFailedMessage, authType } = getEmbedConfig();
-    if (authType !== AuthType.None) {
+    const { loginFailedMessage, authType, disableLoginFailurePage } = getEmbedConfig();
+    if (authType !== AuthType.None && !disableLoginFailurePage) {
         // eslint-disable-next-line no-param-reassign
         containerEl.innerHTML = loginFailedMessage;
         notifyAuthFailure(AuthFailureType.OTHER);