@thoughtspot/visual-embed-sdk 1.32.0 → 1.32.2

package/src/types.ts

@@ -201,6 +201,10 @@ export enum HomeLeftNavItem {
      * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
      */
     SpotIQAnalysis = 'spotiq-analysis',
+    /**
+     * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
+     */
+    LiveboardSchedules = 'liveboard-schedules'
 }
 export type DOMSelector = string | HTMLElement;
 
@@ -588,7 +592,7 @@ export interface EmbedConfig {
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface LayoutConfig { }
+export interface LayoutConfig {}
 
 /**
  * Embedded iframe configuration
@@ -1012,6 +1016,43 @@ export interface ViewConfig {
      */
     // eslint-disable-next-line camelcase
     enableV2Shell_experimental?: boolean;
+    /**
+     * To set the initial state of the search bar in case of saved-answers.
+     * @default true
+     * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   liveboardId: '123',
+     *   collapseSearchBar: true
+     * });
+     */
+    collapseSearchBar?: boolean;
+    /**
+     * This flag can be used to disable links inside the embedded app,
+     * and disables redirection of links in a new tab.
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   disableRedirectionLinksInNewTab: true
+     * });
+     * ```
+     * @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;
 }
 
 /**
@@ -2493,13 +2534,15 @@ export enum HostEvent {
      *
      * @example
      * ```js
-     * appEmbed.trigger(HostEvent.CreateMonitor)
+     * searchEmbed.trigger(HostEvent.CreateMonitor)
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     CreateMonitor = 'createMonitor',
     /**
-     * Trigger the **Manage alerts** action on a visualization
+     * Trigger the **Manage alerts** action on a KPI chart
+     * in a visualization or saved Answer.
+     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2507,6 +2550,16 @@ export enum HostEvent {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
+     *
+     * @example
+     * ```js
+     * searchEmbed.trigger(HostEvent.ManageMonitor)
+     * ```
+     *
+     * @example
+     * ```js
+     * vizEmbed.trigger(HostEvent.ManageMonitor)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     ManageMonitor = 'manageMonitor',
@@ -3084,6 +3137,8 @@ export enum Param {
     IsFullAppEmbed = 'isFullAppEmbed',
     IsOnBeforeGetVizDataInterceptEnabled = 'isOnBeforeGetVizDataInterceptEnabled',
     FocusSearchBarOnRender = 'focusSearchBarOnRender',
+    DisableRedirectionLinksInNewTab = 'disableRedirectionLinksInNewTab',
+    HomePageSearchBarMode = 'homePageSearchBarMode',
 }
 
 /**
@@ -3234,6 +3289,7 @@ export enum Action {
      */
     ConfigureFilter = 'configureFilter',
     CollapseDataSources = 'collapseDataSources',
+    CollapseDataPanel = 'collapseDataPanel',
     /**
      * The **Choose sources** button on Search page.
      * Allows selecting data sources for search queries.
@@ -3630,12 +3686,15 @@ export enum Action {
      * The Create alert action on KPI charts.
      * @example
      * ```js
-     * disabledActions: [Action.CreateMonitor ]
+     * disabledActions: [Action.CreateMonitor]
      * ```
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      */
     CreateMonitor = 'createMonitor',
     /**
+     * @deprecated
+     * Reports errors
+     *
      * @example
      * ```js
      * disabledActions: [Action.ReportError]
@@ -3860,35 +3919,84 @@ export enum Action {
      */
     RenameModalTitleDescription = 'renameModalTitleDescription',
     /**
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.RequestVerification]
+     * ```
      *
      * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
      */
     RequestVerification = 'requestVerification',
     /**
+     *
+     * Allows users to mark a Liveboard as verified.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.MarkAsVerified]
+     * ```
      * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
      */
     MarkAsVerified = 'markAsVerified',
     /**
+     * The **Add Tab** action on a Liveboard.
+     * Allows adding a new tab to a Liveboard view.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.AddTab]
+     * ```
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     AddTab = 'addTab',
     /**
+     *
+     * Initiates contextual change analysis on KPI charts.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.EnableContextualChangeAnalysis]
+     * ```
      * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
      */
     EnableContextualChangeAnalysis = 'enableContextualChangeAnalysis',
     /**
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.ShowSageQuery]
+     * ```
+     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     ShowSageQuery = 'showSageQuery',
     /**
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.EditSageAnswer]
+     * ```
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     EditSageAnswer = 'editSageAnswer',
     /**
+     *
+     * This action allows users to send feedback on AI-generated Answers.
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.SageAnswerFeedback]
+     * ```
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     SageAnswerFeedback = 'sageAnswerFeedback',
     /**
+     *
+     * @example
+     * ```js
+     * disabledActions: [Action.ModifySageAnswer]
+     * ```
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     ModifySageAnswer = 'modifySageAnswer',
@@ -4018,6 +4126,77 @@ export enum Action {
      *  @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
      */
     AIHighlights = 'AIHighlights',
+
+    /**
+     * Action ID for edit schedule action on schedule on homepage
+     * @example
+     * ```js
+     * disabledActions: [Action.EditScheduleHomepage]
+     * ```
+     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     */
+    EditScheduleHomepage = 'editScheduleHomepage',
+
+    /**
+     * Action ID for pause schedule action on schedule on homepage
+     * @example
+     * ```js
+     * disabledActions: [Action.PauseScheduleHomepage]
+     * ```
+     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     */
+    PauseScheduleHomepage = 'pauseScheduleHomepage',
+
+    /**
+     * Action ID for view schedule run action on schedule on homepage
+     * @example
+     * ```js
+     * disabledActions: [Action.ViewScheduleRunHomepage]
+     * ```
+     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     */
+    ViewScheduleRunHomepage = 'viewScheduleRunHomepage',
+
+    /**
+     * Action ID for unsubscribe schedule action on schedule on homepage
+     * @example
+     * ```js
+     * disabledActions: [Action.UnsubscribeScheduleHomepage]
+     * ```
+     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     */
+    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
+     * ```js
+     * disabledActions: [Action.DeleteScheduleHomepage]
+     * ```
+     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     */
+    DeleteScheduleHomepage = 'deleteScheduleHomepage',
+
+    /**
+     * The **Analyze CTA** action on KPI chart.
+     * @example
+     * ```js
+     * disabledActions: [Action.KPIAnalysisCTA]
+     * ```
+     *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
+     */
+    KPIAnalysisCTA = 'kpiAnalysisCTA',
 }
 
 export interface AnswerServiceType {
@@ -4047,15 +4226,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

@@ -9,6 +9,7 @@ import { AuthFailureType } from '../auth';
 import { AuthType, CustomActionPayload, EmbedEvent } from '../types';
 import { AnswerService } from './graphql/answerService/answerService';
 import { resetCachedAuthToken } from '../authToken';
+import { ERROR_MESSAGE } from '../errors';
 
 /**
  *
@@ -62,9 +63,7 @@ function processNoCookieAccess(e: any, containerEl: Element) {
     if (!ignoreNoCookieAccess) {
         if (!suppressNoCookieAccessAlert && !suppressErrorAlerts) {
             // eslint-disable-next-line no-alert
-            alert(
-                'Third party cookie access is blocked on this browser, please allow third party cookies for this to work properly. \nYou can use `suppressNoCookieAccessAlert` to suppress this message.',
-            );
+            alert(ERROR_MESSAGE.THIRD_PARTY_COOKIE_BLOCKED_ALERT);
         }
         // eslint-disable-next-line no-param-reassign
         containerEl.innerHTML = loginFailedMessage;

package/src/utils/reporting.spec.ts

@@ -0,0 +1,91 @@
+import { setEmbedConfig } from '../embed/embedConfig';
+import { registerReportingObserver, getGlobalReportingObserver, resetGlobalReportingObserver } from './reporting';
+import { logger } from './logger';
+import { AuthType } from '../types';
+import { ERROR_MESSAGE } from '../errors';
+
+jest.mock('./logger');
+
+describe('ReportingObserver', () => {
+    let mockReportingObserver: jest.Mock;
+
+    beforeAll(() => {
+        // Mock the ReportingObserver
+        mockReportingObserver = jest.fn().mockImplementation((callback: any, options: any) => ({
+            observe: jest.fn(),
+            disconnect: jest.fn(),
+            takeRecords: jest.fn(),
+        }));
+        (window as any).ReportingObserver = mockReportingObserver;
+    });
+
+    afterEach(() => {
+        jest.clearAllMocks();
+        resetGlobalReportingObserver();
+    });
+
+    test('should warn if ReportingObserver is not supported', () => {
+        (window as any).ReportingObserver = undefined;
+        const observer = registerReportingObserver();
+        expect(observer).toBeNull();
+        expect(logger.warn).toHaveBeenCalledWith('ReportingObserver not supported');
+        (window as any).ReportingObserver = mockReportingObserver;
+    });
+
+    test('should return existing globalObserver if override is false', () => {
+        const firstObserver = registerReportingObserver();
+        const secondObserver = registerReportingObserver();
+        expect(firstObserver === secondObserver).toBe(true);
+    });
+
+    test('should override existing globalObserver if override is true', () => {
+        const firstObserver = registerReportingObserver();
+        const secondObserver = registerReportingObserver(true);
+        expect(firstObserver).not.toBe(secondObserver);
+    });
+
+    test('should return globalObserver', () => {
+        const observer = registerReportingObserver();
+        const globalObserver = getGlobalReportingObserver();
+        expect(globalObserver).toBe(observer);
+    });
+
+    test('Should register a global observer with callback', () => {
+        let callBackPassed: any;
+
+        // Mock the ReportingObserver
+        const NewMockRO = jest.fn().mockImplementation((callback: any, options: any) => {
+            callBackPassed = callback;
+            return ({
+                observe: jest.fn(),
+                disconnect: jest.fn(),
+                takeRecords: jest.fn(),
+            });
+        });
+        const currentObserver = (window as any).ReportingObserver;
+        (window as any).ReportingObserver = NewMockRO;
+
+        setEmbedConfig({
+            thoughtSpotHost: 'testHost',
+            authType: AuthType.None,
+        });
+
+        const mockAlert = jest.fn();
+        window.alert = mockAlert;
+
+        const observer = registerReportingObserver();
+        expect(observer).toBeDefined();
+        expect(NewMockRO).toHaveBeenCalled();
+        expect(callBackPassed).toBeDefined();
+
+        // call the callback
+        callBackPassed([{ type: 'csp-violation', url: 'testHost', body: { effectiveDirective: 'frame-ancestors' } }]);
+
+        expect(mockAlert).toHaveBeenCalledWith(ERROR_MESSAGE.CSP_VIOLATION_ALERT);
+        expect(logger.error).toHaveBeenCalledWith(
+            ERROR_MESSAGE.CSP_FRAME_HOST_VIOLATION_LOG_MESSAGE,
+        );
+
+        (window as any).ReportingObserver = currentObserver;
+    });
+});

package/src/utils/reporting.ts

@@ -0,0 +1,71 @@
+import { getEmbedConfig } from '../embed/embedConfig';
+import { logger } from './logger';
+import { ERROR_MESSAGE } from '../errors';
+
+enum ReportType {
+  CSP_VIOLATION = 'csp-violation',
+  DEPRECATION = 'deprecation',
+  INTERVENTION = 'intervention',
+}
+
+let globalObserver: ReportingObserver | null = null;
+
+/**
+ * Register a global ReportingObserver to capture all unhandled errors
+ * @param overrideExisting boolean to override existing observer
+ * @returns ReportingObserver | null
+ */
+export function registerReportingObserver(overrideExisting = false): ReportingObserver | null {
+    if (!((window as any).ReportingObserver)) {
+        logger.warn(ERROR_MESSAGE.MISSING_REPORTING_OBSERVER);
+        return null;
+    }
+
+    if (overrideExisting) {
+        resetGlobalReportingObserver();
+    }
+
+    if (globalObserver) {
+        return globalObserver;
+    }
+
+    const embedConfig = getEmbedConfig();
+
+    globalObserver = new ReportingObserver((reports) => {
+        reports.forEach((report) => {
+            const { type, url, body } = report;
+            const reportBody = body as any;
+
+            const isThoughtSpotHost = url
+                && url.startsWith(embedConfig.thoughtSpotHost);
+
+            const isFrameHostError = type === ReportType.CSP_VIOLATION
+                && reportBody.effectiveDirective === 'frame-ancestors';
+
+            if (isThoughtSpotHost && isFrameHostError) {
+                if (!embedConfig.suppressErrorAlerts) {
+                    alert(ERROR_MESSAGE.CSP_VIOLATION_ALERT);
+                }
+                logger.error(ERROR_MESSAGE.CSP_FRAME_HOST_VIOLATION_LOG_MESSAGE);
+            }
+        });
+    }, { buffered: true });
+    globalObserver.observe();
+    return globalObserver;
+}
+
+/**
+ * Get the global ReportingObserver
+ * @returns - ReportingObserver | null
+ */
+export function getGlobalReportingObserver(): ReportingObserver | null {
+    return globalObserver;
+}
+
+/**
+ * Resets the global ReportingObserver
+ */
+export function resetGlobalReportingObserver(): void {
+    if (globalObserver) globalObserver.disconnect();
+    globalObserver = null;
+}