@thoughtspot/visual-embed-sdk 1.13.0-alpha.1 → 1.13.0-alpha.4

package/dist/src/auth.d.ts

@@ -18,8 +18,21 @@ export declare enum AuthFailureType {
     OTHER = "OTHER"
 }
 export declare enum AuthStatus {
+    /**
+     * Emits when the SDK fails to authenticate
+     */
     FAILURE = "FAILURE",
+    /**
+     * Emits when the SDK succeeds to authenticate
+     */
+    SDK_SUCCESS = "SDK_SUCCESS",
+    /**
+     * Emits when the App sends a auth success
+     */
     SUCCESS = "SUCCESS",
+    /**
+     * Emits when there is a logout
+     */
     LOGOUT = "LOGOUT"
 }
 /**

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/base.d.ts

@@ -12,6 +12,7 @@ import { AuthFailureType } from '../auth';
 export declare let authPromise: Promise<boolean>;
 export declare const getEmbedConfig: () => EmbedConfig;
 export declare const getAuthPromise: () => Promise<boolean>;
+export declare function notifyAuthSDKSuccess(): void;
 export declare function notifyAuthSuccess(): void;
 export declare function notifyAuthFailure(failureType: AuthFailureType): void;
 export declare function notifyLogout(): void;

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

@@ -183,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.
      */
@@ -199,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.

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,
@@ -167,6 +192,10 @@ export interface EmbedConfig {
      * @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)
@@ -521,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 = "copyLink"
 }
 /**
  * Event types that can be triggered by the host application
@@ -583,12 +671,106 @@ export declare enum HostEvent {
      */
     getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
     /**
-     * Fires 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 viz embeds
+     * 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
      */
-    Pin = "pin"
+    Present = "present"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -633,6 +815,7 @@ export declare enum Param {
     fullHeight = "isFullHeightPinboard",
     livedBoardEmbed = "isLiveboardEmbed",
     searchEmbed = "isSearchEmbed",
+    vizEmbed = "isVizEmbed",
     Version = "sdkVersion",
     ViewPortHeight = "viewPortHeight",
     ViewPortWidth = "viewPortWidth",
@@ -642,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
@@ -803,3 +987,4 @@ export declare enum OperationType {
 export interface AnswerServiceType {
     getAnswer?: (offset: number, batchSize: number) => any;
 }
+export {};

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:
@@ -43,3 +43,4 @@ 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;