@thoughtspot/visual-embed-sdk 1.24.0-sage.3 → 1.24.1

package/dist/visual-embed-sdk.d.ts

@@ -13,7 +13,7 @@ import EventEmitter from 'eventemitter3';
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
 
 /**
     * Copyright (c) 2022
@@ -67,8 +67,19 @@ export interface AppViewConfig extends ViewConfig {
         /**
             * If true, the main navigation bar within the ThoughtSpot app
             * is displayed. By default, the navigation bar is hidden.
+            * This flag also control the homepage left nav-bar.
             */
         showPrimaryNavbar?: boolean;
+        /**
+            * Flag to control Homepage Left Nav Bar
+            * If showPrimaryNavbar is true, ie navigation bar(Global nav-bar) and Homepage left
+            * nav-bar is visible, this flag will only hide the homepage left nav.
+            * Precedence of showPrimaryNavbar flag > hideHomepageLeftNav flag.
+            *
+            * @default false
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        hideHomepageLeftNav?: boolean;
         /**
             * If true, help and profile buttons will hide on NavBar. By default,
             * they are shown.
@@ -87,12 +98,24 @@ export interface AppViewConfig extends ViewConfig {
         /**
             * A URL path within the app that is to be embedded.
             * If both path and pageId attributes are defined, the path definition
-            * takes precedence.
+            * takes precedence. This is the path post the `#/` in the URL of the standalone
+            * ThoughtSpot app. Use this to open the embedded view to a specific path.
+            *
+            * For eg, if you want the component to open to a specific liveboard
+            * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
+            *
+            * @example
+            * ```
+            * <AppEmbed path="pinboard/1234/tab/7464" />
+            * ```
             */
         path?: string;
         /**
             * The application page to set as the start page
             * in the embedded view.
+            *
+            * Use this to open to particular page in the app. To open to a specific
+            * path within the app, use the `path` attribute which is more flexible.
             */
         pageId?: Page;
         /**
@@ -134,6 +157,13 @@ export interface AppViewConfig extends ViewConfig {
             * @hidden
             */
         dataPanelV2?: boolean;
+        /**
+            * Flag to control new Modular Home experience
+            *
+            * @default false
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        modularHomeExperience?: boolean;
 }
 /**
     * Embeds full ThoughtSpot experience in a host application.
@@ -142,6 +172,7 @@ export interface AppViewConfig extends ViewConfig {
     */
 export class AppEmbed extends V1Embed {
         protected viewConfig: AppViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
         /**
             * Constructs a map of parameters to be passed on to the
@@ -265,14 +296,19 @@ export const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
 export const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
 /**
     * Imports TML representation of the metadata objects into ThoughtSpot.
+    *
     * @param data
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    * @group Global methods
     */
 export const executeTML: (data: executeTMLInput) => Promise<any>;
 /**
-    * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format.
+    * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
+    * format.
+    *
     * @param data
     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+    * @group Global methods
     */
 export const exportTML: (data: exportTMLInput) => Promise<any>;
 /**
@@ -372,6 +408,10 @@ export interface LiveboardViewConfig extends ViewConfig {
             * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
             */
         hideTabPanel?: boolean;
+        /**
+            * The list of parameter override to apply to a Liveboard.
+            */
+        runtimeParameters?: RuntimeParameter[];
 }
 /**
     * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
@@ -390,6 +430,7 @@ export interface LiveboardViewConfig extends ViewConfig {
     */
 export class LiveboardEmbed extends V1Embed {
         protected viewConfig: LiveboardViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
         /**
             * Construct a map of params to be passed on to the
@@ -463,6 +504,10 @@ 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.
             *
@@ -513,9 +558,18 @@ export interface SearchViewConfig extends ViewConfig {
             *
             * @default false
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
-            * @hidden
             */
         dataPanelV2?: boolean;
+        /**
+            * Flag to set if last selected dataSource should be used
+            *
+            * @version: SDK: 1.24.0
+            */
+        useLastSelectedSources?: boolean;
+        /**
+            * The list of parameter override to apply to a search answer.
+            */
+        runtimeParameters?: RuntimeParameter[];
 }
 export const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
@@ -528,6 +582,7 @@ export class SearchEmbed extends TsEmbed {
             * The view configuration for the embedded ThoughtSpot search.
             */
         protected viewConfig: SearchViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
         protected getEmbedParams(): string;
         /**
@@ -553,6 +608,12 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
             * @version: SDK: 1.19.0
             */
         dataSource?: string;
+        /**
+            * Flag to set if last selected dataSource should be used
+            *
+            * @version: SDK: 1.24.0
+            */
+        useLastSelectedSources?: boolean;
         /**
             * Configuration for search options
             */
@@ -569,6 +630,7 @@ export class SearchBarEmbed extends TsEmbed {
             * The view configuration for the embedded ThoughtSpot search bar.
             */
         protected viewConfig: SearchBarViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: string, viewConfig: SearchBarViewConfig);
         /**
             * Render the embedded ThoughtSpot search
@@ -934,6 +996,17 @@ export enum AuthType {
             */
         Basic = "Basic"
 }
+export enum HomeLeftNavItem {
+        QueryBuilder = "query-builder",
+        Home = "insights-home",
+        Liveboards = "liveboards",
+        Answers = "answers",
+        MonitorSubscription = "monitor-alerts",
+        SpotIQAnalysis = "spotiq-analysis",
+        Tutorials = "tutorials",
+        Documentation = "documentation",
+        Community = "community"
+}
 export type DOMSelector = string | HTMLElement;
 /**
     * inline customCSS within the {@link CustomisationsInterface}.
@@ -1239,12 +1312,21 @@ export interface EmbedConfig {
         blockNonEmbedFullAppAccess?: boolean;
         /**
             * Host config incase embedded app is inside TS app itself
+            *
+            * @hidden
             */
         hostConfig?: {
                 hostUserGuid: string;
                 hostClusterId: string;
                 hostClusterName: string;
         };
+        /**
+            * Pendo API key to enable Pendo tracking to your own subscription, the key
+            * is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
+            *
+            * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
+            */
+        pendoTrackingKey?: string;
 }
 export interface LayoutConfig {
 }
@@ -1352,6 +1434,11 @@ export interface ViewConfig {
             * visualization, or Liveboard.
             */
         runtimeFilters?: RuntimeFilter[];
+        /**
+            * The list of parameter override to apply to a search answer,
+            * visualization, or Liveboard.
+            */
+        runtimeParameters?: RuntimeParameter[];
         /**
             * The locale/language to use for the embedded view.
             *
@@ -1458,6 +1545,19 @@ export interface ViewConfig {
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         hiddenTabs?: string[];
+        /**
+            * Hide the home page modules
+            * eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
+            *
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        hiddenHomepageModules?: HomepageModule[];
+        /**
+            * reordering the home page modules
+            * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
+            * @version SDK: 1.28.0 | Thoughtspot: 9.9.0.cl
+            */
+        reorderedHomepageModules?: HomepageModule[];
         /**
             * The list of tab IDs to show in the embedded.
             * Only this Tabs will be shown in their respective LBs.
@@ -1477,6 +1577,15 @@ export interface ViewConfig {
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         visibleTabs?: string[];
+        /**
+            * homepageLeftNavItems : show/hide Homeapage Left Nav Bar Items
+            * There are 8 home nav list items, we will send those item as list
+            * which we want to hide for TSE.
+            * eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
+            *
+            * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        hiddenHomeLeftNavItems?: HomeLeftNavItem[];
 }
 /**
     * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -1588,6 +1697,35 @@ export enum RuntimeFilterOp {
             */
         IN = "IN"
 }
+/**
+    * Home page module that can be hide
+    */
+export enum HomepageModule {
+        /**
+            * Search bar
+            */
+        Search = "SEARCH",
+        /**
+            * kPI watchlist module
+            */
+        Watchlist = "WATCHLIST",
+        /**
+            * favorite objects
+            */
+        Favorite = "FAVORITE",
+        /**
+            * List of answers and liveboards
+            */
+        MyLibrary = "MY_LIBRARY",
+        /**
+            * Trending list
+            */
+        Trending = "TRENDING",
+        /**
+            * Learning videos
+            */
+        Learning = "LEARNING"
+}
 /**
     * A filter that can be applied to ThoughtSpot answers, Liveboards, or
     * visualizations at runtime.
@@ -1608,6 +1746,20 @@ export interface RuntimeFilter {
             */
         values: (number | boolean | string)[];
 }
+/**
+    * A filter that can be applied to ThoughtSpot answers, Liveboards, or
+    * visualizations at runtime.
+    */
+export interface RuntimeParameter {
+        /**
+            * The name of the runtime parameter to filter on (case-sensitive)
+            */
+        name: string;
+        /**
+            * Values
+            */
+        value: number | boolean | string;
+}
 /**
     * Event types emitted by the embedded ThoughtSpot application.
     *
@@ -2032,23 +2184,74 @@ export enum EmbedEvent {
             */
         InsertIntoSlide = "insertInToSlide",
         /**
+            * @hidden
             * Emitted when a user changes any filter on a Liveboard.
-            *
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         FilterChanged = "filterChanged",
         /**
             *  Emitted when a user click on Go button in Sage Embed
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
             */
         SageEmbedQuery = "sageEmbedQuery",
         /**
             * Emitten when a user select data source in Sage Embed
             *
-            * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        SageWorksheetUpdated = "sageWorksheetUpdated",
+        /**
+            * Emitten when a user updates a connection in Data tab
+            *
+            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
             */
-        SageWorksheetUpdated = "sageWorksheetUpdated"
+        UpdateConnection = "updateConnection",
+        /**
+            * Emitted when name, status (private or public) or filter values of a
+            * PersonalisedView is updated.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        UpdatePersonalisedView = "updatePersonalisedView",
+        /**
+            * Emitted when a PersonalisedView is saved.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        SavePersonalisedView = "savePersonalisedView",
+        /**
+            * Emitted when a Liveboard is reset.
+            *
+            * @returns viewName: string
+            * @returns viewId: string
+            * @returns liveboardId: string
+            * @returns isPublic: boolean
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        ResetLiveboard = "resetLiveboard",
+        /**
+            * Emitted when a PersonalisedView is deleted.
+            *
+            * @returns views: string[]
+            * @returns liveboardId: string
+            * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        DeletePersonalisedView = "deletePersonalisedView",
+        /**
+            * Emitten when a user creates a new worksheet
+            *
+            * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
+            */
+        CreateWorksheet = "createWorksheet"
 }
 /**
     * Event types that can be triggered by the host application
@@ -2691,16 +2894,16 @@ export enum HostEvent {
             */
         ResetSearch = "resetSearch",
         /**
+            * @hidden
             * Gets the currents visible and runtime filters applied on a Liveboard
-            *
             * @example
             * liveboardEmbed.trigger(HostEvent.GetFilters)
             * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
             */
         GetFilters = "getFilters",
         /**
+            * @hidden
             * Updates the visible filters on the Liveboard.
-            *
             * @param - filter: filter object containing column name and filter operation and values
             * @example
             *
@@ -2851,7 +3054,10 @@ export enum Param {
         HideTabPanel = "hideTabPanel",
         HideSampleQuestions = "hideSampleQuestions",
         WorksheetId = "worksheet",
-        Query = "query"
+        Query = "query",
+        HideHomepageLeftNav = "hideHomepageLeftNav",
+        ModularHomeExperienceEnabled = "modularHomeExperience",
+        PendoTrackingKey = "additionalPendoKey"
 }
 /**
     * ThoughtSpot application pages include actions and menu commands
@@ -3354,7 +3560,7 @@ export enum Action {
             * disabledActions: [Action.QueryDetailsButtons]
             * ```
             */
-        QueryDetailsButtons = "QueryDetailsButtons",
+        QueryDetailsButtons = "queryDetailsButtons",
         /**
             * The **Delete** action for Answers.
             *
@@ -3658,19 +3864,36 @@ export enum Action {
         /**
             * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
             */
-        ModifySageAnswer = "modifySageAnswer"
-}
-export interface SessionInterface {
-        sessionId: string;
-        genNo: number;
-        acSession: {
-                sessionId: string;
-                genNo: number;
-        };
-}
-export enum OperationType {
-        GetChartWithData = "GetChartWithData",
-        GetTableWithHeadlineData = "GetTableWithHeadlineData"
+        ModifySageAnswer = "modifySageAnswer",
+        /**
+            * The **Move to Tab** menu action on visualizations in liveboard edit mode.
+            * Allows moving a visualization to a different tab.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.MoveToTab]
+            * ```
+            */
+        MoveToTab = "onContainerMove",
+        /**
+            * The **Manage Alertsb** menu action on KPI visualizations.
+            *
+            * @example
+            * ```js
+            * disabledActions: [Action.ManageMonitor]
+            * ```
+            */
+        ManageMonitor = "ManageMonitor",
+        /**
+            * Action ID for Liveboard Personalised Views dropdown
+            *
+            *  @example
+            * ```js
+            * disabledActions: [Action.PersonalisedViewsDropdown]
+            * ```
+            *  @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
+            */
+        PersonalisedViewsDropdown = "personalisedViewsDropdown"
 }
 export interface AnswerServiceType {
         getAnswer?: (offset: number, batchSize: number) => any;
@@ -3688,6 +3911,39 @@ export enum ContextMenuTriggerOptions {
         LEFT_CLICK = "left-click",
         RIGHT_CLICK = "right-click"
 }
+export interface ColumnValue {
+        column: {
+                id: string;
+                name: string;
+                dataType: string;
+                [key: string]: any;
+        };
+        value: string | number | boolean;
+}
+export interface VizPoint {
+        selectedAttributes: ColumnValue[];
+        selectedMeasures: ColumnValue[];
+}
+export interface CustomActionPayload {
+        contextMenuPoints?: {
+                clickedPoint: VizPoint;
+                selectedPoints: VizPoint[];
+        };
+        embedAnswerData: {
+                name: string;
+                id: string;
+                sources: {
+                        header: {
+                                guid: string;
+                        };
+                };
+                columns: any[];
+                data: any[];
+                [key: string]: any;
+        };
+        session: SessionInterface;
+        vizId?: string;
+}
 
 /**
     * The list of customization css variables. These
@@ -3710,6 +3966,12 @@ export interface CustomCssVariables {
             * Text transformation specification for UI elements in the app.
             */
         '--ts-var-root-text-transform'?: string;
+        /**
+            * application color, it replaces #2770EF which is rd-color(blue,base) and
+            * its similar colors like rd-color(blue,60), rd-color(accent, base) and
+            * rd-color(text, accent) in the app.
+            */
+        '--ts-var-application-color'?: string;
         /**
             * Background color of the top navigation panel.
             */
@@ -3970,6 +4232,10 @@ export interface CustomCssVariables {
             * Background color for menu items on hover.
             */
         '--ts-var-menu--hover-background'?: string;
+        /**
+            * Text color for selected menu items.
+            */
+        '--ts-var-menu-selected-text-color'?: string;
         /**
             * Background color of the dialogs.
             */
@@ -3990,6 +4256,34 @@ export interface CustomCssVariables {
             * Background color of the footer area on dialogs.
             */
         '--ts-var-dialog-footer-background'?: string;
+        /**
+            * Background for selected state in list
+            */
+        '--ts-var-list-selected-background'?: string;
+        /**
+            * Background for hover state in list
+            */
+        '--ts-var-list-hover-background'?: string;
+        /**
+            * Background for hover state in segment control.
+            */
+        '--ts-var-segment-control-hover-background'?: string;
+        /**
+            * Text color for slected item in modular home's watchlist.
+            */
+        '--ts-var-home-watchlist-selected-text-color'?: string;
+        /**
+            * Text color for favorite carousel find your favorites card in modular home.
+            */
+        '--ts-var-home-favorite-suggestion-card-text-color'?: string;
+        /**
+            * Icon color for favorite carousel find your favorites card in modular home.
+            */
+        '--ts-var-home-favorite-suggestion-card-icon-color'?: string;
+        /**
+            * Background for favorite carousel find your favorites card in modular home.
+            */
+        '--ts-var-home-favorite-suggestion-card-background'?: string;
 }
 
 /**
@@ -4075,6 +4369,7 @@ export class SageEmbed extends V1Embed {
             *
             */
         protected viewConfig: SageViewConfig;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig: SageViewConfig);
         /**
             * Constructs a map of parameters to be passed on to the
@@ -4091,6 +4386,62 @@ export class SageEmbed extends V1Embed {
         render(): SageEmbed;
 }
 
+export interface SessionInterface {
+        sessionId: string;
+        genNo: number;
+        acSession: {
+                sessionId: string;
+                genNo: number;
+        };
+}
+export enum OperationType {
+        GetChartWithData = "GetChartWithData",
+        GetTableWithHeadlineData = "GetTableWithHeadlineData"
+}
+interface UnderlyingDataPoint {
+        columnId: string;
+        dataValue: any;
+}
+/**
+    * Class representing the answer service provided with the
+    * custom action payload. This service could be used to run
+    * graphql queries in the context of the answer on which the
+    * custom action was triggered.
+    *
+    * @example
+    * ```js
+    *  embed.on(EmbedEvent.CustomAction, e => {
+    *     const underlying = await e.answerService.getUnderlyingDataForPoint([
+    *       'col name 1'
+    *     ]);
+    *     const data = await underlying.fetchData(0, 100);
+    *  })
+    * ```
+    * @version
+    * ThoughtSpot: 9.9.0.cl / SDK: 1.25.0
+    */
+export class AnswerService {
+        constructor(session: SessionInterface, answer: any, thoughtSpotHost: string, selectedPoints?: VizPoint[]);
+        getSourceDetail(): Promise<any>;
+        removeColumns(columnIds: string[]): Promise<any>;
+        addColumns(columnIds: string[]): Promise<any>;
+        fetchData(offset?: number, size?: number): Promise<{
+                columns: any;
+                data: any;
+        }>;
+        /**
+            *
+            * @param userLocale
+            * @param omitInfo Omit the download Info on top of the CSV
+            * @returns Response
+            */
+        fetchCSVBlob(userLocale?: string, omitInfo?: boolean): Promise<Response>;
+        getUnderlyingDataForPoint(outputColumnNames: string[], selectedPoints?: UnderlyingDataPoint[]): Promise<AnswerService>;
+        executeQuery(query: string, variables: any): Promise<any>;
+        getSession(): SessionInterface;
+}
+export {};
+
 /**
     * Copyright (c) 2022
     *
@@ -4122,6 +4473,7 @@ export class TsEmbed {
             */
         protected thoughtSpotHost: string;
         protected thoughtSpotV2Base: string;
+        protected embedComponentType: string;
         constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
         /**
             * Handles errors within the SDK
@@ -4212,6 +4564,8 @@ export class TsEmbed {
             * @param messageType The message type
             * @param callback A callback as a function
             * @param options The message options
+            * @param isSelf
+            * @param isRegisteredBySDK
             * @example
             * ```js
             * tsEmbed.on(EmbedEvent.Error, (data) => {
@@ -4227,7 +4581,7 @@ export class TsEmbed {
             * });
             * ```
             */
-        on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions): typeof TsEmbed.prototype;
+        on(messageType: EmbedEvent, callback: MessageCallback, options?: MessageOptions, isRegisteredBySDK?: boolean): typeof TsEmbed.prototype;
         /**
             * Removes an event listener for a particular event type.
             *