@thoughtspot/visual-embed-sdk 1.35.2 → 1.35.5-hostEvent.1

package/dist/tsembed.js

@@ -1,4 +1,4 @@
-/* @thoughtspot/visual-embed-sdk version 1.35.2 */
+/* @thoughtspot/visual-embed-sdk version 1.35.5-hostEvent.1 */
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
     typeof define === 'function' && define.amd ? define(['exports'], factory) :
@@ -1069,8 +1069,8 @@
          *
          * **Note**: This event is deprecated in v1.21.0.
          * To fire an event when a download action is initiated on a chart or table,
-         * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
-         * or `EmbedEvent.DownloadAsXLSX`
+         * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
+         * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
          * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
          * @example
          *```js
@@ -2554,6 +2554,16 @@
          * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
          */
         HostEvent["UpdatePersonalisedView"] = "UpdatePersonalisedView";
+        /**
+         * Triggers the action to get the current view of the liveboard
+         * @version SDK: 1.34.0 | Thoughtspot: 10.6.0.cl
+         */
+        HostEvent["SaveAnswer"] = "saveAnswer";
+        /**
+         * EmbedApi
+         * @hidden
+         */
+        HostEvent["UiPassthrough"] = "UiPassthrough";
     })(exports.HostEvent || (exports.HostEvent = {}));
     /**
      * The different visual modes that the data sources panel within
@@ -14741,6 +14751,8 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
         return e;
     }
 
+    var name="@thoughtspot/visual-embed-sdk";var version$1="1.35.5-hostEvent.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 . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw",docgen:"typedoc --tsconfig tsconfig.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 | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && 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={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",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":"^8.2.6","@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":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0",crypto:"^1.0.1","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","eslint-plugin-comment-length":"1.7.3","eslint-plugin-jsdoc":"^46.9.0","fs-extra":"^10.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0","node-sass":"^8.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","url-search-params-polyfill":"^8.1.0",util:"^0.12.4",vite:"^5.3.4"};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:"31 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.
      * @param iFrame
@@ -14799,7 +14811,60 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
         });
     }
 
-    var name="@thoughtspot/visual-embed-sdk";var version$1="1.35.2";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 . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","bundle-dts":"dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true","bundle-dts-react":"dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw",docgen:"typedoc --tsconfig tsconfig.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 | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && 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={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",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":"^8.2.6","@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":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0","command-line-args":"^5.1.1",coveralls:"^3.1.0",crypto:"^1.0.1","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","eslint-plugin-comment-length":"1.7.3","eslint-plugin-jsdoc":"^46.9.0","fs-extra":"^10.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-fetch-mock":"^3.0.3",jsdom:"^17.0.0","node-sass":"^8.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","url-search-params-polyfill":"^8.1.0",util:"^0.12.4",vite:"^5.3.4"};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:"31 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};
+    exports.UiPassthroughEvent = void 0;
+    (function (UiPassthroughEvent) {
+        UiPassthroughEvent["addVizToPinboard"] = "addVizToPinboard";
+        UiPassthroughEvent["saveAnswer"] = "saveAnswer";
+        UiPassthroughEvent["getA3AnalysisColumns"] = "getA3AnalysisColumns";
+        UiPassthroughEvent["getDiscoverabilityStatus"] = "getDiscoverabilityStatus";
+        UiPassthroughEvent["getAvailableUiPassthroughs"] = "getAvailableUiPassthroughs";
+        UiPassthroughEvent["getAnswerPageConfig"] = "getAnswerPageConfig";
+        UiPassthroughEvent["getPinboardPageConfig"] = "getPinboardPageConfig";
+        UiPassthroughEvent["UiPassthroughEventNotFound"] = "UiPassthroughEventNotFound";
+    })(exports.UiPassthroughEvent || (exports.UiPassthroughEvent = {}));
+
+    class HostEventClient {
+        constructor(thoughtSpotHost) {
+            this.executeUiPassthroughApi = async (iFrame, apiName, parameters) => {
+                const res = await processTrigger(iFrame, exports.HostEvent.UiPassthrough, this.thoughtSpotHost, {
+                    type: apiName,
+                    parameters,
+                });
+                return res;
+            };
+            this.handleUiPassthroughForHostEvent = async (iFrame, apiName, parameters) => {
+                var _a, _b, _c;
+                const response = (_b = (_a = (await this.executeUiPassthroughApi(iFrame, apiName, parameters))) === null || _a === void 0 ? void 0 : _a.filter) === null || _b === void 0 ? void 0 : _b.call(_a, (r) => r.error || r.value)[0];
+                if (!response) {
+                    const error = `No answer found${parameters.vizId ? ` for vizId: ${parameters.vizId}` : ''}.`;
+                    // eslint-disable-next-line no-throw-literal
+                    throw { error };
+                }
+                const errors = response.error || ((_c = response.value) === null || _c === void 0 ? void 0 : _c.errors);
+                if (errors) {
+                    // eslint-disable-next-line no-throw-literal
+                    throw { error: response.error };
+                }
+                return { ...response.value };
+            };
+            this.thoughtSpotHost = thoughtSpotHost;
+        }
+        async hostEventFallback(iFrame, hostEvent, data) {
+            return processTrigger(iFrame, hostEvent, this.thoughtSpotHost, data);
+        }
+        async executeHostEvent(iFrame, hostEvent, payload) {
+            if (hostEvent === exports.HostEvent.Pin && (payload === null || payload === void 0 ? void 0 : payload.newVizName)) {
+                return this.handleUiPassthroughForHostEvent(iFrame, exports.UiPassthroughEvent.addVizToPinboard, payload);
+            }
+            if (hostEvent === exports.HostEvent.SaveAnswer && (payload === null || payload === void 0 ? void 0 : payload.name)) {
+                return this.handleUiPassthroughForHostEvent(iFrame, exports.UiPassthroughEvent.saveAnswer, payload);
+            }
+            // fallback for save answer is Save
+            if (hostEvent === exports.HostEvent.SaveAnswer)
+                hostEvent = exports.HostEvent.Save;
+            return this.hostEventFallback(iFrame, hostEvent, payload);
+        }
+    }
 
     /**
      * Copyright (c) 2022
@@ -14914,6 +14979,17 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
                 this.on(exports.EmbedEvent.AuthExpire, this.updateAuthToken, { start: false }, true);
             };
             this.showPreRenderByDefault = false;
+            /**
+             * Triggers an event to the embedded app, skipping the UI flow.
+             * @param {UiPassthroughEvent} apiName - The name of the API to be triggered.
+             * @param {UiPassthroughRequest} parameters - The parameters to be passed to the API.
+             * @returns {Promise<UiPassthroughRequest>} - A promise that resolves with the response
+             * from the embedded app.
+             */
+            // eslint-disable-next-line arrow-body-style
+            this.triggerUiPassThrough = (apiName, parameters) => {
+                return this.hostEventClient.executeUiPassthroughApi(this.iFrame, apiName, parameters);
+            };
             this.validatePreRenderViewConfig = (viewConfig) => {
                 var _a;
                 const preRenderAllowedKeys = ['preRenderId', 'vizId', 'liveboardId'];
@@ -14955,6 +15031,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
             uploadMixpanelEvent(MIXPANEL_EVENT.VISUAL_SDK_EMBED_CREATE, {
                 ...viewConfig,
             });
+            this.hostEventClient = new HostEventClient(this.embedConfig.thoughtSpotHost);
         }
         /**
          * Throws error encountered during initialization.
@@ -15229,6 +15306,9 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
             setAttributes(iFrame, restParams);
             iFrame.style.width = `${width}`;
             iFrame.style.height = `${height}`;
+            // Set minimum height to the frame so that,
+            // scaling down on the fullheight doesn't make it too small.
+            iFrame.style.minHeight = `${height}`;
             iFrame.style.border = '0';
             iFrame.name = 'ThoughtSpot Embedded Analytics';
             return iFrame;
@@ -15570,8 +15650,9 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
          * Triggers an event to the embedded app
          * @param messageType The event type
          * @param 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) {
             uploadMixpanelEvent(`${MIXPANEL_EVENT.VISUAL_SDK_TRIGGER}-${messageType}`);
             if (!this.isRendered) {
                 this.handleError('Please call render before triggering events');
@@ -15581,7 +15662,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
                 this.handleError('Host event type is undefined');
                 return null;
             }
-            return processTrigger(this.iFrame, messageType, this.thoughtSpotHost, data);
+            return this.hostEventClient.executeHostEvent(this.iFrame, messageType, data);
         }
         /**
          * Marks the ThoughtSpot object to have been rendered
@@ -16395,7 +16476,7 @@ query GetEurekaVizSnapshots(
          * @param messageType The event type
          * @param data The payload to send with the message
          */
-        trigger(messageType, data = {}) {
+        trigger(messageType, data) {
             const dataWithVizId = data;
             if (messageType === exports.HostEvent.SetActiveTab) {
                 this.setActiveTab(data);

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

@@ -259,7 +259,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UiPassthroughEvent, };
 
 /**
     * @group Embed components
@@ -1641,7 +1641,7 @@ export declare class LiveboardEmbed extends V1Embed {
             * @param messageType The event type
             * @param data The payload to send with the message
             */
-        trigger(messageType: HostEvent, data?: any): Promise<any>;
+        trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
         /**
             * Render an embedded ThoughtSpot Liveboard or visualization
             * @param renderOptions An object specifying the Liveboard ID,
@@ -3821,8 +3821,8 @@ export declare enum EmbedEvent {
             *
             * **Note**: This event is deprecated in v1.21.0.
             * To fire an event when a download action is initiated on a chart or table,
-            * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
-            * or `EmbedEvent.DownloadAsXLSX`
+            * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
+            * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -5303,7 +5303,17 @@ export declare enum HostEvent {
             * ```
             * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
             */
-        UpdatePersonalisedView = "UpdatePersonalisedView"
+        UpdatePersonalisedView = "UpdatePersonalisedView",
+        /**
+            * Triggers the action to get the current view of the liveboard
+            * @version SDK: 1.34.0 | Thoughtspot: 10.6.0.cl
+            */
+        SaveAnswer = "saveAnswer",
+        /**
+            * EmbedApi
+            * @hidden
+            */
+        UiPassthrough = "UiPassthrough"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -7316,6 +7326,102 @@ export declare const getAnswerFromQuery: (query: string, worksheetId: string) =>
   */
 export declare const createLiveboardWithAnswers: (answers: AnswerService[], name: string) => Promise<any>;
 
+export declare enum UiPassthroughEvent {
+    addVizToPinboard = "addVizToPinboard",
+    saveAnswer = "saveAnswer",
+    getA3AnalysisColumns = "getA3AnalysisColumns",
+    getDiscoverabilityStatus = "getDiscoverabilityStatus",
+    getAvailableUiPassthroughs = "getAvailableUiPassthroughs",
+    getAnswerPageConfig = "getAnswerPageConfig",
+    getPinboardPageConfig = "getPinboardPageConfig",
+    UiPassthroughEventNotFound = "UiPassthroughEventNotFound"
+}
+export type UiPassthroughContractBase = {
+    [UiPassthroughEvent.addVizToPinboard]: {
+        request: {
+            vizId?: string;
+            newVizName: string;
+            newVizDescription?: string;
+            pinboardId?: string;
+            tabId?: string;
+            newPinboardName?: string;
+            newTabName?: string;
+        };
+        response: {
+            pinboardId: string;
+            tabId: string;
+            vizId: string;
+        };
+    };
+    [UiPassthroughEvent.saveAnswer]: {
+        request: {
+            name: string;
+            description: string;
+            vizId: string;
+            isDiscoverable?: boolean;
+        };
+        response: {
+            answerId: string;
+            errors?: any;
+        };
+    };
+    [UiPassthroughEvent.getA3AnalysisColumns]: {
+        request: {
+            vizId?: string;
+        };
+        response: {
+            data?: any;
+            errors?: any;
+        };
+    };
+    [UiPassthroughEvent.getDiscoverabilityStatus]: {
+        request: any;
+        response: {
+            shouldShowDiscoverability: boolean;
+            isDiscoverabilityCheckboxUnselectedPerOrg: boolean;
+        };
+    };
+    [UiPassthroughEvent.getAvailableUiPassthroughs]: {
+        request: any;
+        response: {
+            keys: string[];
+        };
+    };
+    [UiPassthroughEvent.getAnswerPageConfig]: {
+        request: {
+            vizId?: string;
+        };
+        response: any;
+    };
+    [UiPassthroughEvent.getPinboardPageConfig]: {
+        request: any;
+        response: any;
+    };
+    [UiPassthroughEvent.UiPassthroughEventNotFound]: {
+        request: any;
+        response: any;
+    };
+};
+export type UiPassthroughRequest<T extends keyof UiPassthroughContractBase> = UiPassthroughContractBase[T]['request'];
+export type UiPassthroughResponse<T extends keyof UiPassthroughContractBase> = UiPassthroughContractBase[T]['response'];
+export type UiPassthroughArrayResponse<ApiName extends keyof UiPassthroughContractBase> = Promise<Array<{
+    redId?: string;
+    value?: UiPassthroughResponse<ApiName>;
+    error?: any;
+}>>;
+export type EmbedApiHostEventMapping = {
+    [HostEvent.Pin]: UiPassthroughEvent.addVizToPinboard;
+    [HostEvent.SaveAnswer]: UiPassthroughEvent.saveAnswer;
+    'hostEventNotMapped': UiPassthroughEvent.UiPassthroughEventNotFound;
+};
+export type FlattenType<T> = T extends infer R ? {
+    [K in keyof R]: R[K];
+} : never;
+export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? FlattenType<UiPassthroughRequest<EmbedApiHostEventMapping[HostEventT]>> : any;
+export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? {
+    value?: UiPassthroughResponse<EmbedApiHostEventMapping[HostEventT]>;
+} : any;
+
 /**
     *
     * @param embedConfig
@@ -7381,6 +7487,7 @@ export declare class TsEmbed {
             * A flag that is set to true post render.
             */
         protected isRendered: boolean;
+        protected hostEventClient: HostEventClient;
         constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
         /**
             * Handles errors within the SDK
@@ -7502,8 +7609,17 @@ export declare class TsEmbed {
             * Triggers an event to the embedded app
             * @param messageType The event type
             * @param data The payload to send with the message
+            * @returns A promise that resolves with the response from the embedded app
             */
-        trigger(messageType: HostEvent, data?: any): Promise<any>;
+        trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
+        /**
+            * Triggers an event to the embedded app, skipping the UI flow.
+            * @param {UiPassthroughEvent} apiName - The name of the API to be triggered.
+            * @param {UiPassthroughRequest} parameters - The parameters to be passed to the API.
+            * @returns {Promise<UiPassthroughRequest>} - A promise that resolves with the response
+            * from the embedded app.
+            */
+        triggerUiPassThrough: UiPassthroughHandler;
         /**
             * Marks the ThoughtSpot object to have been rendered
             * Needs to be overridden by subclasses to do the actual
@@ -7622,3 +7738,15 @@ export declare class V1Embed extends TsEmbed {
         test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
 }
 
+type UiPassthroughHandlerWithIframe = <UiPassthroughEventT extends UiPassthroughEvent>(iFrame: HTMLIFrameElement, apiName: UiPassthroughEventT, parameters: FlattenType<UiPassthroughRequest<UiPassthroughEventT>>) => UiPassthroughArrayResponse<UiPassthroughEventT>;
+export type UiPassthroughHandler = <UiPassthroughEventT extends UiPassthroughEvent>(apiName: UiPassthroughEventT, parameters: FlattenType<UiPassthroughRequest<UiPassthroughEventT>>) => UiPassthroughArrayResponse<UiPassthroughEventT>;
+export declare class HostEventClient {
+    thoughtSpotHost: string;
+    constructor(thoughtSpotHost: string);
+    executeUiPassthroughApi: UiPassthroughHandlerWithIframe;
+    handleUiPassthroughForHostEvent: UiPassthroughHandlerWithIframe;
+    hostEventFallback(iFrame: HTMLIFrameElement, hostEvent: HostEvent, data: any): Promise<any>;
+    executeHostEvent<T extends HostEvent>(iFrame: HTMLIFrameElement, hostEvent: HostEvent, payload?: HostEventRequest<T>): Promise<HostEventResponse<HostEvent>>;
+}
+export {};
+

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

@@ -1631,7 +1631,7 @@ export declare class LiveboardEmbed extends V1Embed {
             * @param messageType The event type
             * @param data The payload to send with the message
             */
-        trigger(messageType: HostEvent, data?: any): Promise<any>;
+        trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
         /**
             * Render an embedded ThoughtSpot Liveboard or visualization
             * @param renderOptions An object specifying the Liveboard ID,
@@ -1744,7 +1744,7 @@ export declare class ConversationEmbed extends TsEmbed {
   * @summary ThoughtSpot Visual Embed SDK
   * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
   */
-export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, };
+export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, 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, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UiPassthroughEvent, };
 
 /**
     * Copyright (c) 2023
@@ -3413,8 +3413,8 @@ export declare enum EmbedEvent {
             *
             * **Note**: This event is deprecated in v1.21.0.
             * To fire an event when a download action is initiated on a chart or table,
-            * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
-            * or `EmbedEvent.DownloadAsXLSX`
+            * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`,
+            * `EmbedEvent.DownloadAsCSV`, or `EmbedEvent.DownloadAsXLSX`
             * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
             * @example
             *```js
@@ -4895,7 +4895,17 @@ export declare enum HostEvent {
             * ```
             * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
             */
-        UpdatePersonalisedView = "UpdatePersonalisedView"
+        UpdatePersonalisedView = "UpdatePersonalisedView",
+        /**
+            * Triggers the action to get the current view of the liveboard
+            * @version SDK: 1.34.0 | Thoughtspot: 10.6.0.cl
+            */
+        SaveAnswer = "saveAnswer",
+        /**
+            * EmbedApi
+            * @hidden
+            */
+        UiPassthrough = "UiPassthrough"
 }
 /**
     * The different visual modes that the data sources panel within
@@ -6301,6 +6311,7 @@ export declare class TsEmbed {
             * A flag that is set to true post render.
             */
         protected isRendered: boolean;
+        protected hostEventClient: HostEventClient;
         constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
         /**
             * Handles errors within the SDK
@@ -6422,8 +6433,17 @@ export declare class TsEmbed {
             * Triggers an event to the embedded app
             * @param messageType The event type
             * @param data The payload to send with the message
+            * @returns A promise that resolves with the response from the embedded app
+            */
+        trigger<HostEventT extends HostEvent>(messageType: HostEventT, data?: HostEventRequest<HostEventT>): Promise<HostEventResponse<HostEventT>>;
+        /**
+            * Triggers an event to the embedded app, skipping the UI flow.
+            * @param {UiPassthroughEvent} apiName - The name of the API to be triggered.
+            * @param {UiPassthroughRequest} parameters - The parameters to be passed to the API.
+            * @returns {Promise<UiPassthroughRequest>} - A promise that resolves with the response
+            * from the embedded app.
             */
-        trigger(messageType: HostEvent, data?: any): Promise<any>;
+        triggerUiPassThrough: UiPassthroughHandler;
         /**
             * Marks the ThoughtSpot object to have been rendered
             * Needs to be overridden by subclasses to do the actual
@@ -6542,6 +6562,102 @@ export declare class V1Embed extends TsEmbed {
         test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
 }
 
+export declare enum UiPassthroughEvent {
+    addVizToPinboard = "addVizToPinboard",
+    saveAnswer = "saveAnswer",
+    getA3AnalysisColumns = "getA3AnalysisColumns",
+    getDiscoverabilityStatus = "getDiscoverabilityStatus",
+    getAvailableUiPassthroughs = "getAvailableUiPassthroughs",
+    getAnswerPageConfig = "getAnswerPageConfig",
+    getPinboardPageConfig = "getPinboardPageConfig",
+    UiPassthroughEventNotFound = "UiPassthroughEventNotFound"
+}
+export type UiPassthroughContractBase = {
+    [UiPassthroughEvent.addVizToPinboard]: {
+        request: {
+            vizId?: string;
+            newVizName: string;
+            newVizDescription?: string;
+            pinboardId?: string;
+            tabId?: string;
+            newPinboardName?: string;
+            newTabName?: string;
+        };
+        response: {
+            pinboardId: string;
+            tabId: string;
+            vizId: string;
+        };
+    };
+    [UiPassthroughEvent.saveAnswer]: {
+        request: {
+            name: string;
+            description: string;
+            vizId: string;
+            isDiscoverable?: boolean;
+        };
+        response: {
+            answerId: string;
+            errors?: any;
+        };
+    };
+    [UiPassthroughEvent.getA3AnalysisColumns]: {
+        request: {
+            vizId?: string;
+        };
+        response: {
+            data?: any;
+            errors?: any;
+        };
+    };
+    [UiPassthroughEvent.getDiscoverabilityStatus]: {
+        request: any;
+        response: {
+            shouldShowDiscoverability: boolean;
+            isDiscoverabilityCheckboxUnselectedPerOrg: boolean;
+        };
+    };
+    [UiPassthroughEvent.getAvailableUiPassthroughs]: {
+        request: any;
+        response: {
+            keys: string[];
+        };
+    };
+    [UiPassthroughEvent.getAnswerPageConfig]: {
+        request: {
+            vizId?: string;
+        };
+        response: any;
+    };
+    [UiPassthroughEvent.getPinboardPageConfig]: {
+        request: any;
+        response: any;
+    };
+    [UiPassthroughEvent.UiPassthroughEventNotFound]: {
+        request: any;
+        response: any;
+    };
+};
+export type UiPassthroughRequest<T extends keyof UiPassthroughContractBase> = UiPassthroughContractBase[T]['request'];
+export type UiPassthroughResponse<T extends keyof UiPassthroughContractBase> = UiPassthroughContractBase[T]['response'];
+export type UiPassthroughArrayResponse<ApiName extends keyof UiPassthroughContractBase> = Promise<Array<{
+    redId?: string;
+    value?: UiPassthroughResponse<ApiName>;
+    error?: any;
+}>>;
+export type EmbedApiHostEventMapping = {
+    [HostEvent.Pin]: UiPassthroughEvent.addVizToPinboard;
+    [HostEvent.SaveAnswer]: UiPassthroughEvent.saveAnswer;
+    'hostEventNotMapped': UiPassthroughEvent.UiPassthroughEventNotFound;
+};
+export type FlattenType<T> = T extends infer R ? {
+    [K in keyof R]: R[K];
+} : never;
+export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? FlattenType<UiPassthroughRequest<EmbedApiHostEventMapping[HostEventT]>> : any;
+export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? {
+    value?: UiPassthroughResponse<EmbedApiHostEventMapping[HostEventT]>;
+} : any;
+
 export interface executeTMLInput {
         metadata_tmls: string[];
         import_policy?: 'PARTIAL' | 'ALL_OR_NONE' | 'VALIDATE_ONLY';
@@ -7622,3 +7738,15 @@ export declare function getAuthenticationToken(embedConfig: EmbedConfig): Promis
     */
 export declare const resetCachedAuthToken: () => void;
 
+type UiPassthroughHandlerWithIframe = <UiPassthroughEventT extends UiPassthroughEvent>(iFrame: HTMLIFrameElement, apiName: UiPassthroughEventT, parameters: FlattenType<UiPassthroughRequest<UiPassthroughEventT>>) => UiPassthroughArrayResponse<UiPassthroughEventT>;
+export type UiPassthroughHandler = <UiPassthroughEventT extends UiPassthroughEvent>(apiName: UiPassthroughEventT, parameters: FlattenType<UiPassthroughRequest<UiPassthroughEventT>>) => UiPassthroughArrayResponse<UiPassthroughEventT>;
+export declare class HostEventClient {
+    thoughtSpotHost: string;
+    constructor(thoughtSpotHost: string);
+    executeUiPassthroughApi: UiPassthroughHandlerWithIframe;
+    handleUiPassthroughForHostEvent: UiPassthroughHandlerWithIframe;
+    hostEventFallback(iFrame: HTMLIFrameElement, hostEvent: HostEvent, data: any): Promise<any>;
+    executeHostEvent<T extends HostEvent>(iFrame: HTMLIFrameElement, hostEvent: HostEvent, payload?: HostEventRequest<T>): Promise<HostEventResponse<HostEvent>>;
+}
+export {};
+