@thoughtspot/visual-embed-sdk 1.13.0-alpha.2 → 1.13.0

package/CHANGELOG.md

@@ -6,7 +6,32 @@ This project follows Semantic Versioning.
 ## Unreleased
 
 ### New Features
-- Events for all actions on Search Embed
+- Event for navigating to a specific page in App embed without any reload
+- Ability to turn on search assist in Search embed
+- Set of new Host events to drive interactions on the embed programatically 
+
+## 1.12.1 (06-21-2022)
+### Fixed
+- Search embed beta warning check for TS cloud releases
+## 1.12.0 (06-21-2022)
+- Release to support TS version 8.4.0.cl
+- Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=embed-sdk-changelog)
+
+## 1.11.2 (06-10-2022)
+### Fixed
+- Typescript build that was affecting some Angular project configurations
+
+## 1.11.2 (06-10-2022)
+### Fixed
+- Typescript build that was affecting some Angular project configurations
+
+## 1.11.1 (05-30-2022)
+### Fixed
+- Whitelabeling - new [action](https://developers.thoughtspot.com/docs/typedoc/enums/Action.html#ReportError) for the ability to turn off TS specific error reporting by end users.
+
+## 1.11.0 (05-20-2022)
+- Release to support TS version 8.3.0.cl
+- Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=embed-sdk-changelog)
 
 ## 1.10.4 (05-06-2022)
 ### New Features
@@ -32,7 +57,7 @@ This project follows Semantic Versioning.
 ## 1.10.0 (04-22-2022)
 
 - Release to support TS version 8.2.0.cl
-- Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=whats-new)
+- Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=embed-sdk-changelog)
 
 ## 1.9.5 (04-06-2022)
 
@@ -48,12 +73,12 @@ This project follows Semantic Versioning.
 
 ## 1.9.3 (03-22-2022)
 
-### New Features 
+### New Features
 - `disableLoginRedirect` option in `EmbedConfig`
 
 ## 1.9.2 (03-17-2022)
 
-### New Features 
+### New Features
 - Ability to trigger events on React components
   - Added new `useEmbedRef` hook, check README for usage.
 
@@ -73,7 +98,7 @@ This project follows Semantic Versioning.
 ## 1.9.0
 
 - Release to support TS version 8.1.0.cl
-- Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=whats-new)
+- Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=embed-sdk-changelog)
 
 
 ## 1.8.1
@@ -94,4 +119,4 @@ This project follows Semantic Versioning.
 
 ## 1.7.0 (and earlier)
 
--   Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=whats-new)
+-   Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=embed-sdk-changelog)

package/README.md

@@ -4,7 +4,7 @@
 
 <br/>
 
-# ThoughtSpot Visual Embed SDK <br/> [![Coverage Status](https://coveralls.io/repos/github/ts-blink/embed-sdk/badge.svg?branch=main)](https://coveralls.io/github/ts-blink/embed-sdk?branch=main) ![npm (scoped with tag)](https://img.shields.io/npm/v/@thoughtspot/visual-embed-sdk) [![](https://data.jsdelivr.com/v1/package/npm/@thoughtspot/visual-embed-sdk/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@thoughtspot/visual-embed-sdk) ![npm](https://img.shields.io/npm/dm/@thoughtspot/visual-embed-sdk?label=npm%20downloads&style=flat-square) [![Featured on Openbase](https://badges.openbase.com/js/featured/@thoughtspot/visual-embed-sdk.svg?token=IoqZUwE8aX7LYNedeuBLM2w5Wt52hu+Dh0eyKjlpC0E=)](https://openbase.com/js/@thoughtspot/visual-embed-sdk?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge)
+# ThoughtSpot Visual Embed SDK <br/> [![Coverage Status](https://coveralls.io/repos/github/ts-blink/embed-sdk/badge.svg?branch=main)](https://coveralls.io/github/ts-blink/embed-sdk?branch=main) ![npm (scoped with tag)](https://img.shields.io/npm/v/@thoughtspot/visual-embed-sdk) [![](https://data.jsdelivr.com/v1/package/npm/@thoughtspot/visual-embed-sdk/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@thoughtspot/visual-embed-sdk) ![npm](https://img.shields.io/npm/dm/@thoughtspot/visual-embed-sdk?label=npm%20downloads&style=flat-square) [![Featured on Openbase](https://badges.openbase.com/js/featured/@thoughtspot/visual-embed-sdk.svg?token=IoqZUwE8aX7LYNedeuBLM2w5Wt52hu+Dh0eyKjlpC0E=)](https://openbase.com/js/@thoughtspot/visual-embed-sdk?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@thoughtspot/visual-embed-sdk?style=flat-square)
 
 
 SDK to embed ThoughtSpot into your web apps.

package/dist/src/auth.d.ts

@@ -2,7 +2,6 @@ import { EmbedConfig } from './types';
 export declare let loggedInStatus: boolean;
 export declare let samlAuthWindow: Window;
 export declare let samlCompletionPromise: Promise<void>;
-export declare let sessionInfo: any;
 export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
 export declare const EndPoints: {
     AUTH_VERIFICATION: string;
@@ -36,6 +35,10 @@ export declare enum AuthStatus {
      */
     LOGOUT = "LOGOUT"
 }
+/**
+ * Return releaseVersion if available
+ */
+export declare function getReleaseVersion(): string;
 /**
  * Return sessionInfo if available else make a loggedIn check to fetch the sessionInfo
  */

package/dist/src/auth.spec.d.ts

@@ -1,3 +1,4 @@
+export declare const embedConfig: any;
 export declare const mockSessionInfo: {
     sessionId: string;
     genNo: number;

package/dist/src/embed/app.d.ts

@@ -86,6 +86,11 @@ export interface AppViewConfig extends ViewConfig {
      * @hidden
      */
     liveboardV2?: boolean;
+    /**
+     * If set to true, the Search Assist feature is enabled.
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
+     */
+    enableSearchAssist?: boolean;
 }
 /**
  * Embeds full ThoughtSpot experience in a host application.

package/dist/src/embed/liveboard.d.ts

@@ -8,7 +8,7 @@
  * @summary Liveboard & visualization embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { DOMSelector } from '../types';
+import { DOMSelector, HostEvent } from '../types';
 import { V1Embed, ViewConfig } from './ts-embed';
 /**
  * The configuration for the embedded Liveboard or visualization page view.
@@ -71,6 +71,11 @@ export interface LiveboardViewConfig extends ViewConfig {
      * @hidden
      */
     liveboardV2?: boolean;
+    /**
+     * Tab Id of the Liveboard that is supposed to be active
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    activeTabId?: string;
 }
 /**
  * Embed a ThoughtSpot Liveboard or visualization
@@ -102,6 +107,12 @@ export declare class LiveboardEmbed extends V1Embed {
     private updateIFrameHeight;
     private embedIframeCenter;
     private setIframeHeightForNonEmbedLiveboard;
+    /**
+     * Triggers an event to the embedded app
+     * @param messageType The event type
+     * @param data The payload to send with the message
+     */
+    trigger(messageType: HostEvent, data?: any): Promise<any>;
     /**
      * Render an embedded ThoughtSpot Liveboard or visualization
      * @param renderOptions An object specifying the Liveboard ID,

package/dist/src/embed/search.d.ts

@@ -44,8 +44,13 @@ export interface SearchViewConfig extends ViewConfig {
      * using raw answer data.
      */
     hideResults?: boolean;
+    /**
+     * If set to true, expands all the data sources panel.
+     */
+    expandAllDataSource?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
      */
     enableSearchAssist?: boolean;
     /**

package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/embed/ts-embed.d.ts

@@ -29,7 +29,7 @@ export interface FrameParams {
      * This parameters will be passed on the iframe
      * as is.
      */
-    [key: string]: string | number | boolean;
+    [key: string]: string | number | boolean | undefined;
 }
 /**
  * The configuration object for an embedded view.
@@ -142,6 +142,7 @@ export declare class TsEmbed {
      * @default false
      */
     private shouldEncodeUrlQueryParams;
+    private defaultHiddenActions;
     constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
     /**
      * Gets a reference to the root DOM node where
@@ -182,6 +183,14 @@ export declare class TsEmbed {
      * and executes the registered callbacks accordingly.
      */
     private subscribeToEvents;
+    /**
+     * Send Custom style as part of payload of APP_INIT
+     */
+    private appInitCb;
+    /**
+     * Register APP_INIT event and sendback init payload
+     */
+    private registerAppInit;
     /**
      * Constructs the base URL string to load the ThoughtSpot app.
      */
@@ -198,7 +207,7 @@ export declare class TsEmbed {
      * @param isAppEmbed A Boolean parameter to specify if you are embedding
      * the full application.
      */
-    protected getV1EmbedBasePath(queryString: string, showPrimaryNavbar?: boolean, disableProfileAndHelp?: boolean, isAppEmbed?: boolean): string;
+    protected getV1EmbedBasePath(queryString: string, showPrimaryNavbar?: boolean, disableProfileAndHelp?: boolean, isAppEmbed?: boolean, enableSearchAssist?: boolean): string;
     /**
      * Renders the embedded ThoughtSpot app in an iframe and sets up
      * event listeners.
@@ -265,7 +274,7 @@ export declare class TsEmbed {
      * @param messageType The event type
      * @param data The payload to send with the message
      */
-    trigger(messageType: HostEvent, data: any): typeof TsEmbed.prototype;
+    trigger(messageType: HostEvent, data: any): Promise<any>;
     /**
      * Marks the ThoughtSpot object to have been rendered
      * Needs to be overridden by subclasses to do the actual

package/dist/src/errors.d.ts

@@ -1,4 +1,6 @@
 export declare const ERROR_MESSAGE: {
     INVALID_THOUGHTSPOT_HOST: string;
     LIVEBOARD_VIZ_ID_VALIDATION: string;
+    TRIGGER_TIMED_OUT: string;
+    SEARCHEMBED_BETA_WRANING_MESSAGE: string;
 };

package/dist/src/test/test-utils.d.ts

@@ -25,4 +25,10 @@ export declare const executeAfterWait: (fn: (...args: any[]) => void, waitTime?:
  */
 export declare const EVENT_WAIT_TIME = 1000;
 export declare function fixedEncodeURI(str: string): string;
+/**
+ * MessageChannel is available in Node > 15.0.0. Since the current node environment's
+ * used for github actions is not above 14, we are mocking this for the current unit tests.
+ */
+export declare const messageChannelMock: any;
+export declare const mockMessageChannel: () => void;
 export {};

package/dist/src/types.d.ts

@@ -17,8 +17,13 @@ export declare enum AuthType {
     None = "None",
     /**
      * SSO using SAML
+     * @deprecated Use {@link SAML} instead
      */
     SSO = "SSO_SAML",
+    /**
+     * SSO using SAML
+     */
+    SAML = "SSO_SAML",
     /**
      * SSO using OIDC
      */
@@ -36,6 +41,26 @@ export declare enum AuthType {
     Basic = "Basic"
 }
 export declare type DOMSelector = string | HTMLElement;
+interface customCssInterface {
+    variables?: {
+        [variableName: string]: string;
+    };
+    rules_UNSTABLE?: {
+        [selector: string]: {
+            [declaration: string]: string;
+        };
+    };
+}
+interface CustomStyles {
+    customCSSUrl?: string;
+    customCss?: customCssInterface;
+}
+export interface CustomisationsInterface {
+    style: CustomStyles;
+    content: {
+        [key: string]: string;
+    };
+}
 /**
  * The configuration object for embedding ThoughtSpot content.
  * It includes the ThoughtSpot hostname or IP address,
@@ -161,6 +186,16 @@ export interface EmbedConfig {
      * @version SDK: 1.10.4 | ThoughtSpot: *
      */
     detectCookieAccessSlow?: boolean;
+    /**
+     * Hide beta alert warning message for SearchEmbed.
+     *
+     * @version SDK: 1.12.0 | ThoughtSpot: *
+     */
+    suppressSearchEmbedBetaWarning?: boolean;
+    /**
+     * Custom style params for embed Config
+     */
+    customisations?: CustomisationsInterface;
 }
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -515,7 +550,66 @@ export declare enum EmbedEvent {
      * Emitted when an answer is switched to a chart or table view
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
      */
-    AnswerChartSwitcher = "answerChartSwitcher"
+    AnswerChartSwitcher = "answerChartSwitcher",
+    /**
+     *
+     */
+    APP_INIT = "appInit",
+    /**
+     * Emitted when a user clicks Show Liveboard details on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    LiveboardInfo = "pinboardInfo",
+    /**
+     * Emitted when a user clicks on the Favorite icon on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    AddToFavorites = "addToFavorites",
+    /**
+     * Emitted when a user clicks Schedule on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Schedule = "subscription",
+    /**
+     * Emitted when a user clicks Edit on a Liveboard or visualization
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Edit = "edit",
+    /**
+     * Emitted when a user clicks Make a copy on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    MakeACopy = "makeACopy",
+    /**
+     * Emitted when a user clicks Present on a Liveboard or visualization
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Present = "present",
+    /**
+     * Emitted when a user clicks Delete on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Delete = "delete",
+    /**
+     * Emitted when a user clicks Manage schedules on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    SchedulesList = "schedule-list",
+    /**
+     * Emitted when a user clicks Cancel in edit mode on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Cancel = "cancel",
+    /**
+     * Emitted when a user clicks Explore on a visualization
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Explore = "explore",
+    /**
+     * Emitted when a user clicks Copy link action on a visualization
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    CopyLink = "embedDocument"
 }
 /**
  * Event types that can be triggered by the host application
@@ -570,7 +664,113 @@ export declare enum HostEvent {
      * @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl
      */
-    Navigate = "Navigate"
+    Navigate = "Navigate",
+    /**
+     * Gets the current pinboard content.
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
+     */
+    getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
+    /**
+     * Triggers the Pin action on an embedded object
+     * @param - incase of Liveboard embed, takes in an object with vizId as a key
+     * can be left empty for search and visualization embeds
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Pin = "pin",
+    /**
+     * Triggers the Show Liveboard details action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    LiveboardInfo = "pinboardInfo",
+    /**
+     * Triggers the Schedule action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Schedule = "subscription",
+    /**
+     * Triggers the Manage schedule action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    SchedulesList = "schedule-list",
+    /**
+     * Triggers the Export TML action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    ExportTML = "exportTSL",
+    /**
+     * Triggers the Edit TML action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    EditTML = "editTSL",
+    /**
+     * Triggers the Update TML action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    UpdateTML = "updateTSL",
+    /**
+     * Triggers the Download PDF action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    DownloadAsPdf = "downloadAsPdf",
+    /**
+     * Triggers the Make a copy action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    MakeACopy = "makeACopy",
+    /**
+     * Triggers the Delete action on a Liveboard
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Remove = "delete",
+    /**
+     * Triggers the Explore action on a visualization
+     * @param - an object with vizId as a key
+     * eg: {vizId: '730496d6-6903-4601-937e-2c691821af3c'}
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Explore = "explore",
+    /**
+     * Triggers the Create alert action on a visualization
+     * @param - an object with vizId as a key
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    CreateMonitor = "createMonitor",
+    /**
+     * Triggers the Manage alert action on a visualization
+     * @param - an object with vizId as a key
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    ManageMonitor = "manageMonitor",
+    /**
+     * Triggers the Edit action on a Liveboard or visualization
+     * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Edit)
+     * liveboardEmbed.trigger(HostEvent.Edit, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger((HostEvent.Edit)
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Edit = "edit",
+    /**
+     * Triggers the Copy link action on a Liveboard or visualization
+     * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.CopyLink)
+     * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger((HostEvent.CopyLink)
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    CopyLink = "embedDocument",
+    /**
+     * Triggers the Present action on a Liveboard or visualization
+     * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Present)
+     * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger((HostEvent.Present)
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
+     */
+    Present = "present"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -615,6 +815,7 @@ export declare enum Param {
     fullHeight = "isFullHeightPinboard",
     livedBoardEmbed = "isLiveboardEmbed",
     searchEmbed = "isSearchEmbed",
+    vizEmbed = "isVizEmbed",
     Version = "sdkVersion",
     ViewPortHeight = "viewPortHeight",
     ViewPortWidth = "viewPortWidth",
@@ -624,7 +825,8 @@ export declare enum Param {
     visibleVizs = "pinboardVisibleVizs",
     LiveboardV2Enabled = "isPinboardV2Enabled",
     ShowAlerts = "showAlerts",
-    Locale = "locale"
+    Locale = "locale",
+    CustomStyle = "customStyle"
 }
 /**
  * The list of actions that can be performed on visual ThoughtSpot
@@ -764,7 +966,11 @@ export declare enum Action {
     /**
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
      */
-    CreateMonitor = "createMonitor"
+    CreateMonitor = "createMonitor",
+    /**
+     * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl
+     */
+    ReportError = "reportError"
 }
 export interface SessionInterface {
     sessionId: string;
@@ -781,3 +987,4 @@ export declare enum OperationType {
 export interface AnswerServiceType {
     getAnswer?: (offset: number, batchSize: number) => any;
 }
+export {};

package/dist/src/utils/processTrigger.d.ts

@@ -1,2 +1,2 @@
 import { HostEvent } from '../types';
-export declare function processTrigger(iFrame: HTMLIFrameElement, messageType: HostEvent, thoughtSpotHost: string, data: any): void;
+export declare function processTrigger(iFrame: HTMLIFrameElement, messageType: HostEvent, thoughtSpotHost: string, data: any): Promise<any>;

package/dist/src/utils.d.ts

@@ -6,7 +6,7 @@
  * @summary Utils
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { QueryParams, RuntimeFilter } from './types';
+import { EmbedConfig, QueryParams, RuntimeFilter, CustomisationsInterface } from './types';
 /**
  * Construct a runtime filters query string from the given filters.
  * Refer to the following docs for more details on runtime filter syntax:
@@ -42,3 +42,5 @@ export declare const embedEventStatus: {
 export declare const setAttributes: (element: HTMLElement, attributes: {
     [key: string]: string | number | boolean;
 }) => void;
+export declare const checkReleaseVersionInBeta: (releaseVersion: string, suppressBetaWarning: boolean) => boolean;
+export declare const getCustomisations: (embedConfig: EmbedConfig) => CustomisationsInterface;