@thoughtspot/visual-embed-sdk 1.42.1-HE2 → 1.42.1-HE2.0.1

package/dist/tsembed.js

@@ -1,4 +1,4 @@
-/* @thoughtspot/visual-embed-sdk version 1.42.1-HE2 */
+/* @thoughtspot/visual-embed-sdk version 1.42.1-HE2.0.1 */
 'use client';
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
@@ -3340,6 +3340,15 @@
          * ```
          */
         HostEvent["UpdateEmbedParams"] = "updateEmbedParams";
+        /**
+         * @hidden
+         * Triggers the get of the page context.
+         * @example
+         * ```js
+         * liveboardEmbed.trigger(HostEvent.GetPageContext);
+         * ```
+         */
+        HostEvent["GetPageContext"] = "GetPageContext";
     })(exports.HostEvent || (exports.HostEvent = {}));
     /**
      * The different visual modes that the data sources panel within
@@ -7260,6 +7269,29 @@
 
     var isEmpty_1 = isEmpty$1;
 
+    exports.UIPassthroughEvent = void 0;
+    (function (UIPassthroughEvent) {
+        UIPassthroughEvent["PinAnswerToLiveboard"] = "addVizToPinboard";
+        UIPassthroughEvent["SaveAnswer"] = "saveAnswer";
+        UIPassthroughEvent["GetDiscoverabilityStatus"] = "getDiscoverabilityStatus";
+        UIPassthroughEvent["GetAvailableUIPassthroughs"] = "getAvailableUiPassthroughs";
+        UIPassthroughEvent["GetAnswerConfig"] = "getAnswerPageConfig";
+        UIPassthroughEvent["GetLiveboardConfig"] = "getPinboardPageConfig";
+    })(exports.UIPassthroughEvent || (exports.UIPassthroughEvent = {}));
+    var ContextType;
+    (function (ContextType) {
+        ContextType["Search"] = "search";
+        ContextType["Liveboard"] = "liveboard";
+        ContextType["Answer"] = "answer";
+        ContextType["Spotter"] = "spotter";
+        ContextType["Default"] = "default";
+    })(ContextType || (ContextType = {}));
+    var PageType;
+    (function (PageType) {
+        PageType["PAGE"] = "page";
+        PageType["DIALOG"] = "dialog";
+    })(PageType || (PageType = {}));
+
     const ERROR_MESSAGE = {
         INVALID_THOUGHTSPOT_HOST: 'Error parsing ThoughtSpot host. Please provide a valid URL.',
         SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND: 'Please select a worksheet to get started',
@@ -17530,7 +17562,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
         return e;
     }
 
-    var name="@thoughtspot/visual-embed-sdk";var version$1="1.42.1-HE2";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports$1={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/all-types-export.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p tsconfig.build.json --incremental false; tsc -p tsconfig.build.json --incremental false --module commonjs --outDir cjs","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle-generator --config ./dts-config/dts-bundle-file.config.js","bundle-dts":"dts-bundle-generator --config ./dts-config/dts-bundle.config.js","bundle-dts-react":"dts-bundle-generator --config ./dts-config/dts-bundle-react.config.js","bundle-dts-react-full":"dts-bundle-generator --config ./dts-config/dts-bundle-react-full.config.js",build:"rollup -c",watch:"rollup -cw",docgen:"typedoc --tsconfig tsconfig.build.json --theme typedoc-theme --json static/typedoc/typedoc.json --disableOutputCheck","test-sdk":"jest -c jest.config.sdk.js --runInBand",test:"npm run test-sdk",posttest:"cat ./coverage/sdk/lcov.info | npx coveralls-next","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","check-size":"npm run build && size-limit","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest",dev:"vite -c vite.local.config.ts"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={classnames:"^2.3.1",eventemitter3:"^4.0.7",lodash:"^4.17.21","mixpanel-browser":"2.47.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1",yaml:"^2.5.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@size-limit/preset-big-lib":"^11.2.0","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/lodash":"^4.17.0","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^8.28.0","@typescript-eslint/parser":"^8.28.0",ajv:"^8.17.1",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1","coveralls-next":"^5.0.0",crypto:"^1.0.1","current-git-branch":"^1.1.0","dts-bundle-generator":"^9.5.1",eslint:"^9.23.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^10.1.1","eslint-import-resolver-typescript":"^4.2.5","eslint-plugin-comment-length":"2.2.1","eslint-plugin-import":"^2.31.0","eslint-plugin-jsdoc":"^50.6.9","eslint-plugin-prettier":"^5.2.5","eslint-plugin-react":"^7.37.5","eslint-plugin-react-hooks":"^5.2.0","fs-extra":"^10.0.0","gh-pages":"6.3.0",globals:"^16.0.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^2.0.0",jest:"^26.6.3","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0",prettier:"2.1.2",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"4.24.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","typescript-eslint":"^8.29.1","url-search-params-polyfill":"^8.1.0",util:"^0.12.4",vite:"^6.3.5"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embedded","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version$1,description:description,module:module,main:main,types:types,files:files,exports:exports$1,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.es.js",limit:"32 kB"}],scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
+    var name="@thoughtspot/visual-embed-sdk";var version$1="1.42.1-HE2.0.1";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**","cjs/**"];var exports$1={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/all-types-export.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p tsconfig.build.json --incremental false; tsc -p tsconfig.build.json --incremental false --module commonjs --outDir cjs","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle-generator --config ./dts-config/dts-bundle-file.config.js","bundle-dts":"dts-bundle-generator --config ./dts-config/dts-bundle.config.js","bundle-dts-react":"dts-bundle-generator --config ./dts-config/dts-bundle-react.config.js","bundle-dts-react-full":"dts-bundle-generator --config ./dts-config/dts-bundle-react-full.config.js",build:"rollup -c",watch:"rollup -cw",docgen:"typedoc --tsconfig tsconfig.build.json --theme typedoc-theme --json static/typedoc/typedoc.json --disableOutputCheck","test-sdk":"jest -c jest.config.sdk.js --runInBand",test:"npm run test-sdk",posttest:"cat ./coverage/sdk/lcov.info | npx coveralls-next","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","check-size":"npm run build && size-limit","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest",dev:"vite -c vite.local.config.ts"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={classnames:"^2.3.1",eventemitter3:"^4.0.7",lodash:"^4.17.21","mixpanel-browser":"2.47.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1",yaml:"^2.5.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@rollup/plugin-replace":"^5.0.2","@size-limit/preset-big-lib":"^11.2.0","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/lodash":"^4.17.0","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^8.28.0","@typescript-eslint/parser":"^8.28.0",ajv:"^8.17.1",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1","coveralls-next":"^5.0.0",crypto:"^1.0.1","current-git-branch":"^1.1.0","dts-bundle-generator":"^9.5.1",eslint:"^9.23.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^10.1.1","eslint-import-resolver-typescript":"^4.2.5","eslint-plugin-comment-length":"2.2.1","eslint-plugin-import":"^2.31.0","eslint-plugin-jsdoc":"^50.6.9","eslint-plugin-prettier":"^5.2.5","eslint-plugin-react":"^7.37.5","eslint-plugin-react-hooks":"^5.2.0","fs-extra":"^10.0.0","gh-pages":"6.3.0",globals:"^16.0.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^2.0.0",jest:"^26.6.3","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0",prettier:"2.1.2",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"4.24.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","typescript-eslint":"^8.29.1","url-search-params-polyfill":"^8.1.0",util:"^0.12.4",vite:"^6.3.5"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embedded","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version$1,description:description,module:module,main:main,types:types,files:files,exports:exports$1,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.es.js",limit:"32 kB"}],scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
 
     /**
      * Reloads the ThoughtSpot iframe.
@@ -17604,16 +17636,6 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
         });
     }
 
-    exports.UIPassthroughEvent = void 0;
-    (function (UIPassthroughEvent) {
-        UIPassthroughEvent["PinAnswerToLiveboard"] = "addVizToPinboard";
-        UIPassthroughEvent["SaveAnswer"] = "saveAnswer";
-        UIPassthroughEvent["GetDiscoverabilityStatus"] = "getDiscoverabilityStatus";
-        UIPassthroughEvent["GetAvailableUIPassthroughs"] = "getAvailableUiPassthroughs";
-        UIPassthroughEvent["GetAnswerConfig"] = "getAnswerPageConfig";
-        UIPassthroughEvent["GetLiveboardConfig"] = "getPinboardPageConfig";
-    })(exports.UIPassthroughEvent || (exports.UIPassthroughEvent = {}));
-
     class HostEventClient {
         constructor(iFrame) {
             this.iFrame = iFrame;
@@ -18721,7 +18743,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
          * @param {any} data The payload to send with the message
          * @returns A promise that resolves with the response from the embedded app
          */
-        async trigger(messageType, data = {}, context = {}) {
+        async trigger(messageType, data = {}, context) {
             uploadMixpanelEvent(`${MIXPANEL_EVENT.VISUAL_SDK_TRIGGER}-${messageType}`);
             if (!this.isRendered) {
                 this.handleError('Please call render before triggering events');
@@ -18771,6 +18793,17 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
         handleRenderForPrerender() {
             return this.render();
         }
+        async getCurrentContext() {
+            this.executeAfterEmbedContainerLoaded(async () => {
+                const context = await this.trigger(exports.HostEvent.GetPageContext, {});
+                return context;
+            });
+            return {
+                page: ContextType.Default,
+                pageType: PageType.PAGE,
+                objectIds: {},
+            };
+        }
         /**
          * Creates the preRender shell
          * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -19848,7 +19881,7 @@ query GetEurekaVizSnapshots(
          * @param {any} data The payload to send with the message
          * @returns A promise that resolves with the response from the embedded app
          */
-        trigger(messageType, data = {}) {
+        trigger(messageType, data = {}, context) {
             const dataWithVizId = data;
             if (messageType === exports.HostEvent.SetActiveTab) {
                 this.setActiveTab(data);
@@ -19857,7 +19890,7 @@ query GetEurekaVizSnapshots(
             if (typeof dataWithVizId === 'object' && this.viewConfig.vizId) {
                 dataWithVizId.vizId = this.viewConfig.vizId;
             }
-            return super.trigger(messageType, dataWithVizId);
+            return super.trigger(messageType, dataWithVizId, context);
         }
         /**
          * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
@@ -19926,6 +19959,10 @@ query GetEurekaVizSnapshots(
             }
             return url;
         }
+        async getCurrentContext() {
+            const context = await super.getCurrentContext();
+            return context;
+        }
     }
     /**
      * @hidden
@@ -20109,6 +20146,10 @@ query GetEurekaVizSnapshots(
             });
             return this;
         }
+        async getCurrentContext() {
+            const context = await super.getCurrentContext();
+            return context;
+        }
     }
 
     /**
@@ -20184,6 +20225,10 @@ query GetEurekaVizSnapshots(
             const defaultAppInitData = await super.getAppInitData();
             return { ...defaultAppInitData, ...this.getSearchInitData() };
         }
+        async getCurrentContext() {
+            const context = await super.getCurrentContext();
+            return context;
+        }
     }
 
     const createConversation = `
@@ -20802,6 +20847,10 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
             await this.renderIFrame(src);
             return this;
         }
+        async getCurrentContext() {
+            const context = await super.getCurrentContext();
+            return context;
+        }
     }
     /**
      * Embed ThoughtSpot AI Conversation.
@@ -20908,6 +20957,10 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
             await this.renderV1Embed(src);
             return this;
         }
+        async getCurrentContext() {
+            const context = await super.getCurrentContext();
+            return context;
+        }
     }
 
     const getAnswerSessionFromQuery = `

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

@@ -5048,7 +5048,16 @@ export declare enum HostEvent {
 	 * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
 	 * ```
 	 */
-	UpdateEmbedParams = "updateEmbedParams"
+	UpdateEmbedParams = "updateEmbedParams",
+	/**
+	 * @hidden
+	 * Triggers the get of the page context.
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.GetPageContext);
+	 * ```
+	 */
+	GetPageContext = "GetPageContext"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -6694,9 +6703,16 @@ export type EmbedApiHostEventMapping = {
 	[HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
 };
 export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
-export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
+export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
 export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
-export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
+export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
+declare enum ContextType {
+	Search = "search",
+	Liveboard = "liveboard",
+	Answer = "answer",
+	Spotter = "spotter",
+	Default = "default"
+}
 declare class HostEventClient {
 	iFrame: HTMLIFrameElement;
 	constructor(iFrame?: HTMLIFrameElement);
@@ -6706,18 +6722,18 @@ declare class HostEventClient {
 	 * @param {any} data Data to send with the host event
 	 * @returns {Promise<any>} - the response from the process trigger
 	 */
-	protected processTrigger(message: HostEvent, data: any, context?: any): Promise<any>;
+	protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
 	handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
-	hostEventFallback(hostEvent: HostEvent, data: any, context?: any): Promise<any>;
+	hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
 	/**
 	 * Setter for the iframe element used for host events
 	 * @param {HTMLIFrameElement} iFrame - the iframe element to set
 	 */
 	setIframeElement(iFrame: HTMLIFrameElement): void;
 	triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
-	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
+	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
 	protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>): Promise<any>;
-	triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
 }
 declare class TsEmbed {
 	/**
@@ -7028,7 +7044,7 @@ declare class TsEmbed {
 	 * @param {any} data The payload to send with the message
 	 * @returns A promise that resolves with the response from the embedded app
 	 */
-	trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: any): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
 	/**
 	 * Triggers an event to the embedded app, skipping the UI flow.
 	 * @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
@@ -7046,6 +7062,7 @@ declare class TsEmbed {
 	render(): Promise<TsEmbed>;
 	getIframeSrc(): string;
 	protected handleRenderForPrerender(): Promise<TsEmbed>;
+	getCurrentContext(): Promise<any>;
 	/**
 	 * Creates the preRender shell
 	 * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -7158,6 +7175,28 @@ declare class V1Embed extends TsEmbed {
 	 */
 	test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
 }
+declare enum ContextType$1 {
+	Search = "search",
+	Liveboard = "liveboard",
+	Answer = "answer",
+	Spotter = "spotter",
+	Default = "default"
+}
+declare enum PageType {
+	PAGE = "page",
+	DIALOG = "dialog"
+}
+export interface ObjectIds {
+	answerId?: string;
+	liveboardId?: string;
+	vizIds?: string[];
+	dataModelIds?: string[];
+}
+export type PageContextOptions = {
+	page: ContextType$1;
+	pageType: PageType;
+	objectIds: ObjectIds;
+};
 /**
  * Configuration for search options.
  *
@@ -7478,6 +7517,7 @@ declare class SearchEmbed extends TsEmbed {
 	 * Render the embedded ThoughtSpot search
 	 */
 	render(): Promise<SearchEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * @group Embed components
@@ -7596,6 +7636,7 @@ declare class SearchBarEmbed extends TsEmbed {
 		searchOptions: SearchOptions;
 	};
 	protected getAppInitData(): Promise<SearchAppInitData$1>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 interface SearchOptions$1 {
 	/**
@@ -7740,6 +7781,7 @@ declare class SageEmbed extends V1Embed {
 	 * @returns {SageEmbed} Eureka/Sage embed
 	 */
 	render(): Promise<SageEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * Pages within the ThoughtSpot app that can be embedded.
@@ -8800,7 +8842,7 @@ declare class LiveboardEmbed extends V1Embed {
 	 * @param {any} data The payload to send with the message
 	 * @returns A promise that resolves with the response from the embedded app
 	 */
-	trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
 	/**
 	 * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
 	 * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
@@ -8822,6 +8864,7 @@ declare class LiveboardEmbed extends V1Embed {
 	 * @returns url string
 	 */
 	getLiveboardUrl(): string;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * @hidden
@@ -9033,6 +9076,7 @@ declare class SpotterEmbed extends TsEmbed {
 	protected getEmbedParamsObject(): Record<any, any>;
 	getIframeSrc(): string;
 	render(): Promise<SpotterEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 declare class ConversationEmbed extends SpotterEmbed {
 	protected viewConfig: ConversationViewConfig;

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

@@ -5063,7 +5063,16 @@ export declare enum HostEvent {
 	 * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
 	 * ```
 	 */
-	UpdateEmbedParams = "updateEmbedParams"
+	UpdateEmbedParams = "updateEmbedParams",
+	/**
+	 * @hidden
+	 * Triggers the get of the page context.
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.GetPageContext);
+	 * ```
+	 */
+	GetPageContext = "GetPageContext"
 }
 /**
  * ThoughtSpot application pages include actions and menu commands
@@ -6682,9 +6691,16 @@ export type EmbedApiHostEventMapping = {
 	[HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
 };
 export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
-export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
+export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
 export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
-export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
+export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
+declare enum ContextType {
+	Search = "search",
+	Liveboard = "liveboard",
+	Answer = "answer",
+	Spotter = "spotter",
+	Default = "default"
+}
 declare class HostEventClient {
 	iFrame: HTMLIFrameElement;
 	constructor(iFrame?: HTMLIFrameElement);
@@ -6694,18 +6710,18 @@ declare class HostEventClient {
 	 * @param {any} data Data to send with the host event
 	 * @returns {Promise<any>} - the response from the process trigger
 	 */
-	protected processTrigger(message: HostEvent, data: any, context?: any): Promise<any>;
+	protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
 	handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
-	hostEventFallback(hostEvent: HostEvent, data: any, context?: any): Promise<any>;
+	hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
 	/**
 	 * Setter for the iframe element used for host events
 	 * @param {HTMLIFrameElement} iFrame - the iframe element to set
 	 */
 	setIframeElement(iFrame: HTMLIFrameElement): void;
 	triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
-	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
+	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
 	protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>): Promise<any>;
-	triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
 }
 declare class TsEmbed {
 	/**
@@ -7016,7 +7032,7 @@ declare class TsEmbed {
 	 * @param {any} data The payload to send with the message
 	 * @returns A promise that resolves with the response from the embedded app
 	 */
-	trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: any): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
 	/**
 	 * Triggers an event to the embedded app, skipping the UI flow.
 	 * @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
@@ -7034,6 +7050,7 @@ declare class TsEmbed {
 	render(): Promise<TsEmbed>;
 	getIframeSrc(): string;
 	protected handleRenderForPrerender(): Promise<TsEmbed>;
+	getCurrentContext(): Promise<any>;
 	/**
 	 * Creates the preRender shell
 	 * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -7146,6 +7163,28 @@ declare class V1Embed extends TsEmbed {
 	 */
 	test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
 }
+declare enum ContextType$1 {
+	Search = "search",
+	Liveboard = "liveboard",
+	Answer = "answer",
+	Spotter = "spotter",
+	Default = "default"
+}
+declare enum PageType {
+	PAGE = "page",
+	DIALOG = "dialog"
+}
+export interface ObjectIds {
+	answerId?: string;
+	liveboardId?: string;
+	vizIds?: string[];
+	dataModelIds?: string[];
+}
+export type PageContextOptions = {
+	page: ContextType$1;
+	pageType: PageType;
+	objectIds: ObjectIds;
+};
 /**
  * Configuration for search options.
  *
@@ -7466,6 +7505,7 @@ declare class SearchEmbed extends TsEmbed {
 	 * Render the embedded ThoughtSpot search
 	 */
 	render(): Promise<SearchEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * @group Embed components
@@ -7584,6 +7624,7 @@ declare class SearchBarEmbed extends TsEmbed {
 		searchOptions: SearchOptions;
 	};
 	protected getAppInitData(): Promise<SearchAppInitData$1>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 interface SearchOptions$1 {
 	/**
@@ -7728,6 +7769,7 @@ declare class SageEmbed extends V1Embed {
 	 * @returns {SageEmbed} Eureka/Sage embed
 	 */
 	render(): Promise<SageEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * Pages within the ThoughtSpot app that can be embedded.
@@ -8784,7 +8826,7 @@ declare class LiveboardEmbed extends V1Embed {
 	 * @param {any} data The payload to send with the message
 	 * @returns A promise that resolves with the response from the embedded app
 	 */
-	trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
 	/**
 	 * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
 	 * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
@@ -8806,6 +8848,7 @@ declare class LiveboardEmbed extends V1Embed {
 	 * @returns url string
 	 */
 	getLiveboardUrl(): string;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * Configuration for bodyless conversation options.
@@ -9012,6 +9055,7 @@ declare class SpotterEmbed extends TsEmbed {
 	protected getEmbedParamsObject(): Record<any, any>;
 	getIframeSrc(): string;
 	render(): Promise<SpotterEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 declare class ConversationEmbed extends SpotterEmbed {
 	protected viewConfig: ConversationViewConfig;

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

@@ -5114,7 +5114,16 @@ export declare enum HostEvent {
 	 * liveboardEmbed.trigger(HostEvent.UpdateEmbedParams, viewConfig);
 	 * ```
 	 */
-	UpdateEmbedParams = "updateEmbedParams"
+	UpdateEmbedParams = "updateEmbedParams",
+	/**
+	 * @hidden
+	 * Triggers the get of the page context.
+	 * @example
+	 * ```js
+	 * liveboardEmbed.trigger(HostEvent.GetPageContext);
+	 * ```
+	 */
+	GetPageContext = "GetPageContext"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -6698,9 +6707,16 @@ export type EmbedApiHostEventMapping = {
 	[HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
 };
 export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
-export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
+export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
 export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
-export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
+export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
+declare enum ContextType {
+	Search = "search",
+	Liveboard = "liveboard",
+	Answer = "answer",
+	Spotter = "spotter",
+	Default = "default"
+}
 declare class HostEventClient {
 	iFrame: HTMLIFrameElement;
 	constructor(iFrame?: HTMLIFrameElement);
@@ -6710,18 +6726,18 @@ declare class HostEventClient {
 	 * @param {any} data Data to send with the host event
 	 * @returns {Promise<any>} - the response from the process trigger
 	 */
-	protected processTrigger(message: HostEvent, data: any, context?: any): Promise<any>;
+	protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
 	handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
-	hostEventFallback(hostEvent: HostEvent, data: any, context?: any): Promise<any>;
+	hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
 	/**
 	 * Setter for the iframe element used for host events
 	 * @param {HTMLIFrameElement} iFrame - the iframe element to set
 	 */
 	setIframeElement(iFrame: HTMLIFrameElement): void;
 	triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
-	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin>>;
+	protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
 	protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>): Promise<any>;
-	triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
 }
 declare class TsEmbed {
 	/**
@@ -7032,7 +7048,7 @@ declare class TsEmbed {
 	 * @param {any} data The payload to send with the message
 	 * @returns A promise that resolves with the response from the embedded app
 	 */
-	trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: any): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
 	/**
 	 * Triggers an event to the embedded app, skipping the UI flow.
 	 * @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
@@ -7050,6 +7066,7 @@ declare class TsEmbed {
 	render(): Promise<TsEmbed>;
 	getIframeSrc(): string;
 	protected handleRenderForPrerender(): Promise<TsEmbed>;
+	getCurrentContext(): Promise<any>;
 	/**
 	 * Creates the preRender shell
 	 * @param showPreRenderByDefault - Show the preRender after render, hidden by default
@@ -8036,6 +8053,28 @@ export declare const executeTML: (data: executeTMLInput) => Promise<any>;
  * @group Global methods
  */
 export declare const exportTML: (data: exportTMLInput) => Promise<any>;
+declare enum ContextType$1 {
+	Search = "search",
+	Liveboard = "liveboard",
+	Answer = "answer",
+	Spotter = "spotter",
+	Default = "default"
+}
+declare enum PageType {
+	PAGE = "page",
+	DIALOG = "dialog"
+}
+export interface ObjectIds {
+	answerId?: string;
+	liveboardId?: string;
+	vizIds?: string[];
+	dataModelIds?: string[];
+}
+export type PageContextOptions = {
+	page: ContextType$1;
+	pageType: PageType;
+	objectIds: ObjectIds;
+};
 /**
  * The configuration for the embedded Liveboard or visualization page view.
  * @group Embed components
@@ -8469,7 +8508,7 @@ export declare class LiveboardEmbed extends V1Embed {
 	 * @param {any} data The payload to send with the message
 	 * @returns A promise that resolves with the response from the embedded app
 	 */
-	trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>): Promise<TriggerResponse<PayloadT, HostEventT>>;
+	trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
 	/**
 	 * Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
 	 * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
@@ -8491,6 +8530,7 @@ export declare class LiveboardEmbed extends V1Embed {
 	 * @returns url string
 	 */
 	getLiveboardUrl(): string;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * @hidden
@@ -8821,6 +8861,7 @@ export declare class SearchEmbed extends TsEmbed {
 	 * Render the embedded ThoughtSpot search
 	 */
 	render(): Promise<SearchEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * @group Embed components
@@ -8944,6 +8985,7 @@ export declare class SearchBarEmbed extends TsEmbed {
 		searchOptions: SearchOptions;
 	};
 	protected getAppInitData(): Promise<SearchAppInitData$1>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * Configuration for bodyless conversation options.
@@ -9239,6 +9281,7 @@ export declare class SpotterEmbed extends TsEmbed {
 	protected getEmbedParamsObject(): Record<any, any>;
 	getIframeSrc(): string;
 	render(): Promise<SpotterEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * Embed ThoughtSpot AI Conversation.
@@ -9435,6 +9478,7 @@ export declare class SageEmbed extends V1Embed {
 	 * @returns {SageEmbed} Eureka/Sage embed
 	 */
 	render(): Promise<SageEmbed>;
+	getCurrentContext(): Promise<PageContextOptions>;
 }
 /**
  * Gets the embed configuration settings that were used to