@thoughtspot/visual-embed-sdk 1.35.5-hostEvent.7 → 1.35.5-hostEvent.8

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

@@ -1170,7 +1170,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+            * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
             * @type {boolean}
             * @default false
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -1484,7 +1484,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         enableAskSage?: boolean;
         /**
-            * This flag is used to enable the 2 column layout in liveboard
+            * This flag is used to enable the 2 column layout on a Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -1519,7 +1519,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showPreviewLoader?: boolean;
         /**
-            * This flag is used to enable the compact header in liveboard
+            * This flag is used to enable the compact header on a Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -1533,7 +1533,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         isLiveboardCompactHeaderEnabled?: boolean;
         /**
-            * This flag is used to show/hide verified Icon in liveboard compact header
+            * This flag is used to show/hide verified icon in the Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1547,7 +1547,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * This flag is used to show/hide the re-verify banner
+            * in Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1561,7 +1562,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showLiveboardReverifyBanner?: boolean;
         /**
-            * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+            * This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
             * @type {boolean}
             * @default false
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -1650,8 +1651,8 @@ export declare class LiveboardEmbed extends V1Embed {
         render(): Promise<LiveboardEmbed>;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
         /**
-            * Returns the full url of the liveboard/viz which can be used to open
-            * this liveboard inside the full Thoughtspot application in a new tab.
+            * Returns the full url of the Liveboard/visualization which can be used to open
+            * this Liveboard inside the full Thoughtspot application in a new tab.
             * @returns url string
             */
         getLiveboardUrl(): string;
@@ -1783,7 +1784,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
 /**
     * Initializes the Visual Embed SDK globally and perform
     * authentication if applicable. This function needs to be called before any ThoughtSpot
-    * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+    * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
     * to actually embed. That is handled internally.
     * @param embedConfig The configuration object containing ThoughtSpot host,
     * authentication mechanism and so on.
@@ -3212,8 +3213,12 @@ export interface ViewConfig {
             */
         enableCustomColumnGroups?: boolean;
         /**
-            * View content for another org directly without having to use the org switcher
-            * This flag is honoured if orgPerUrl feature is enabled for the ThoughtSpot cluster
+            * Overrides an Org context for embedding application users.
+            * This parameter allows a user authenticated to one Org to view the
+            * objects from another Org.
+            * The `overrideOrgId` setting is honoured only if the
+            * Per Org URL feature is enabled on your ThoughtSpot instance.
+            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -4470,7 +4475,7 @@ export declare enum HostEvent {
             * @param - autoDrillDown - Optional. If true, the drill down will be
             * done automatically on the most popular column.
             * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
-            * in case of a liveboard.
+            * in case of a Liveboard.
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -4557,26 +4562,26 @@ export declare enum HostEvent {
             */
         SetActiveTab = "SetActiveTab",
         /**
-            * Update runtime filters applied on a Saved Answer or Liveboard. The
-            * runtime filters passed here are appended to the existing runtime
-            * filters.
+            * Updates the runtime filters applied on a Liveboard. The filter
+            * attributes passed with this event are appended to the existing runtime
+            * filters applied on a Liveboard.
+            *
             * Pass an array of runtime filters with the following attributes:
             *
-            * `columnName`
-            * _String_. The name of the column to filter on.
+            * `columnName` - _String_. The name of the column to filter on.
             *
-            * `operator`
-            * Runtime filter operator to apply. For information,
+            * `operator` - Runtime filter operator to apply. For more information,
             * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
             *
-            * `values`
-            * List of operands. Some operators such as EQ, LE allow a single value, whereas
-            * operators such as BW and IN accept multiple operands.
+            * `values` - List of operands. Some operators such as EQ and LE allow a
+            * single value, whereas BW and IN accept multiple values.
+            *
+            * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
+            * and `AppEmbed` only. In full application embedding, this event updates
+            * the runtime filters applied on the Liveboard and saved Answer objects.
             *
-            * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
-            * Search embedding (SearchEmbed) and Natural Language Search
-            * embedding (SageEmbed).
             * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
@@ -5275,7 +5280,7 @@ export declare enum HostEvent {
             */
         ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
         /**
-            * Triggers Update RuntimeParameters for answers and liveboard
+            * Triggers an event to Update Parameter values for Answers and Liveboard
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -5297,7 +5302,7 @@ export declare enum HostEvent {
             */
         GetParameters = "GetParameters",
         /**
-            * Triggers update of persoanlised view for a liveboard
+            * Triggers an event to update a persoanlised view of a Liveboard
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
             * ```
@@ -6286,7 +6291,7 @@ export declare enum Action {
             */
         ModifySageAnswer = "modifySageAnswer",
         /**
-            * The **Move to Tab** menu action on visualizations in liveboard edit mode.
+            * The **Move to Tab** menu action on visualizations in Liveboard edit mode.
             * Allows moving a visualization to a different tab.
             * @example
             * ```js
@@ -6339,7 +6344,8 @@ export declare enum Action {
             */
         TML = "tml",
         /**
-            * Action Id for CreateLiveboard for liveboard list page & Pin Modal
+            * Action ID for the create Liveboard option on the Liveboard list page
+            * and Pin modal
             * @example
             * ```js
             * hiddenAction: [Action.CreateLiveboard]
@@ -7680,7 +7686,7 @@ export declare class TsEmbed {
         /**
             * Returns the answerService which can be used to make arbitrary graphql calls on top
             * session.
-            * @param vizId [Optional] to get for a specific viz in case of a liveboard.
+            * @param vizId [Optional] to get for a specific viz in case of a Liveboard.
             * @version SDK: 1.25.0 / ThoughtSpot 9.10.0
             */
         getAnswerService(vizId?: string): Promise<AnswerService>;

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

@@ -1160,7 +1160,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+            * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
             * @type {boolean}
             * @default false
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -1474,7 +1474,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         enableAskSage?: boolean;
         /**
-            * This flag is used to enable the 2 column layout in liveboard
+            * This flag is used to enable the 2 column layout on a Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -1509,7 +1509,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showPreviewLoader?: boolean;
         /**
-            * This flag is used to enable the compact header in liveboard
+            * This flag is used to enable the compact header on a Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -1523,7 +1523,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         isLiveboardCompactHeaderEnabled?: boolean;
         /**
-            * This flag is used to show/hide verified Icon in liveboard compact header
+            * This flag is used to show/hide verified icon in the Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1537,7 +1537,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * This flag is used to show/hide the re-verify banner
+            * in Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1551,7 +1552,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showLiveboardReverifyBanner?: boolean;
         /**
-            * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+            * This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
             * @type {boolean}
             * @default false
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -1640,8 +1641,8 @@ export declare class LiveboardEmbed extends V1Embed {
         render(): Promise<LiveboardEmbed>;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
         /**
-            * Returns the full url of the liveboard/viz which can be used to open
-            * this liveboard inside the full Thoughtspot application in a new tab.
+            * Returns the full url of the Liveboard/visualization which can be used to open
+            * this Liveboard inside the full Thoughtspot application in a new tab.
             * @returns url string
             */
         getLiveboardUrl(): string;
@@ -2804,8 +2805,12 @@ export interface ViewConfig {
             */
         enableCustomColumnGroups?: boolean;
         /**
-            * View content for another org directly without having to use the org switcher
-            * This flag is honoured if orgPerUrl feature is enabled for the ThoughtSpot cluster
+            * Overrides an Org context for embedding application users.
+            * This parameter allows a user authenticated to one Org to view the
+            * objects from another Org.
+            * The `overrideOrgId` setting is honoured only if the
+            * Per Org URL feature is enabled on your ThoughtSpot instance.
+            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -4062,7 +4067,7 @@ export declare enum HostEvent {
             * @param - autoDrillDown - Optional. If true, the drill down will be
             * done automatically on the most popular column.
             * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
-            * in case of a liveboard.
+            * in case of a Liveboard.
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -4149,26 +4154,26 @@ export declare enum HostEvent {
             */
         SetActiveTab = "SetActiveTab",
         /**
-            * Update runtime filters applied on a Saved Answer or Liveboard. The
-            * runtime filters passed here are appended to the existing runtime
-            * filters.
+            * Updates the runtime filters applied on a Liveboard. The filter
+            * attributes passed with this event are appended to the existing runtime
+            * filters applied on a Liveboard.
+            *
             * Pass an array of runtime filters with the following attributes:
             *
-            * `columnName`
-            * _String_. The name of the column to filter on.
+            * `columnName` - _String_. The name of the column to filter on.
             *
-            * `operator`
-            * Runtime filter operator to apply. For information,
+            * `operator` - Runtime filter operator to apply. For more information,
             * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
             *
-            * `values`
-            * List of operands. Some operators such as EQ, LE allow a single value, whereas
-            * operators such as BW and IN accept multiple operands.
+            * `values` - List of operands. Some operators such as EQ and LE allow a
+            * single value, whereas BW and IN accept multiple values.
+            *
+            * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
+            * and `AppEmbed` only. In full application embedding, this event updates
+            * the runtime filters applied on the Liveboard and saved Answer objects.
             *
-            * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
-            * Search embedding (SearchEmbed) and Natural Language Search
-            * embedding (SageEmbed).
             * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
@@ -4867,7 +4872,7 @@ export declare enum HostEvent {
             */
         ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
         /**
-            * Triggers Update RuntimeParameters for answers and liveboard
+            * Triggers an event to Update Parameter values for Answers and Liveboard
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -4889,7 +4894,7 @@ export declare enum HostEvent {
             */
         GetParameters = "GetParameters",
         /**
-            * Triggers update of persoanlised view for a liveboard
+            * Triggers an event to update a persoanlised view of a Liveboard
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
             * ```
@@ -5878,7 +5883,7 @@ export declare enum Action {
             */
         ModifySageAnswer = "modifySageAnswer",
         /**
-            * The **Move to Tab** menu action on visualizations in liveboard edit mode.
+            * The **Move to Tab** menu action on visualizations in Liveboard edit mode.
             * Allows moving a visualization to a different tab.
             * @example
             * ```js
@@ -5931,7 +5936,8 @@ export declare enum Action {
             */
         TML = "tml",
         /**
-            * Action Id for CreateLiveboard for liveboard list page & Pin Modal
+            * Action ID for the create Liveboard option on the Liveboard list page
+            * and Pin modal
             * @example
             * ```js
             * hiddenAction: [Action.CreateLiveboard]
@@ -6522,7 +6528,7 @@ export declare class TsEmbed {
         /**
             * Returns the answerService which can be used to make arbitrary graphql calls on top
             * session.
-            * @param vizId [Optional] to get for a specific viz in case of a liveboard.
+            * @param vizId [Optional] to get for a specific viz in case of a Liveboard.
             * @version SDK: 1.25.0 / ThoughtSpot 9.10.0
             */
         getAnswerService(vizId?: string): Promise<AnswerService>;
@@ -6682,7 +6688,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
 /**
     * Initializes the Visual Embed SDK globally and perform
     * authentication if applicable. This function needs to be called before any ThoughtSpot
-    * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+    * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
     * to actually embed. That is handled internally.
     * @param embedConfig The configuration object containing ThoughtSpot host,
     * authentication mechanism and so on.

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

@@ -418,7 +418,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+            * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
             * @type {boolean}
             * @default false
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -540,7 +540,7 @@ export const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], add
 /**
     * Initializes the Visual Embed SDK globally and perform
     * authentication if applicable. This function needs to be called before any ThoughtSpot
-    * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+    * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
     * to actually embed. That is handled internally.
     * @param embedConfig The configuration object containing ThoughtSpot host,
     * authentication mechanism and so on.
@@ -869,7 +869,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         enableAskSage?: boolean;
         /**
-            * This flag is used to enable the 2 column layout in liveboard
+            * This flag is used to enable the 2 column layout on a Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -904,7 +904,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showPreviewLoader?: boolean;
         /**
-            * This flag is used to enable the compact header in liveboard
+            * This flag is used to enable the compact header on a Liveboard
             * @type {boolean}
             * @default false
             * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -918,7 +918,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         isLiveboardCompactHeaderEnabled?: boolean;
         /**
-            * This flag is used to show/hide verified Icon in liveboard compact header
+            * This flag is used to show/hide verified icon in the Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -932,7 +932,8 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showLiveboardVerifiedBadge?: boolean;
         /**
-            * This flag is used to show/hide re-verify banner in liveboard compact header
+            * This flag is used to show/hide the re-verify banner
+            * in Liveboard compact header
             * @type {boolean}
             * @default true
             * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -946,7 +947,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
             */
         showLiveboardReverifyBanner?: boolean;
         /**
-            * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+            * This flag is used to enable/disable hide irrelevant filters in a Liveboard tab
             * @type {boolean}
             * @default false
             * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl
@@ -1035,8 +1036,8 @@ export class LiveboardEmbed extends V1Embed {
         render(): Promise<LiveboardEmbed>;
         navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
         /**
-            * Returns the full url of the liveboard/viz which can be used to open
-            * this liveboard inside the full Thoughtspot application in a new tab.
+            * Returns the full url of the Liveboard/visualization which can be used to open
+            * this Liveboard inside the full Thoughtspot application in a new tab.
             * @returns url string
             */
         getLiveboardUrl(): string;
@@ -2801,8 +2802,12 @@ export interface ViewConfig {
             */
         enableCustomColumnGroups?: boolean;
         /**
-            * View content for another org directly without having to use the org switcher
-            * This flag is honoured if orgPerUrl feature is enabled for the ThoughtSpot cluster
+            * Overrides an Org context for embedding application users.
+            * This parameter allows a user authenticated to one Org to view the
+            * objects from another Org.
+            * The `overrideOrgId` setting is honoured only if the
+            * Per Org URL feature is enabled on your ThoughtSpot instance.
+            *
             * @example
             * ```js
             * const embed = new LiveboardEmbed('#embed', {
@@ -4059,7 +4064,7 @@ export enum HostEvent {
             * @param - autoDrillDown - Optional. If true, the drill down will be
             * done automatically on the most popular column.
             * @param - vizId [TS >= 9.8.0] - Optional. The GUID of the visualization to drill
-            * in case of a liveboard.
+            * in case of a Liveboard.
             * @example
             * ```js
             * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -4146,26 +4151,26 @@ export enum HostEvent {
             */
         SetActiveTab = "SetActiveTab",
         /**
-            * Update runtime filters applied on a Saved Answer or Liveboard. The
-            * runtime filters passed here are appended to the existing runtime
-            * filters.
+            * Updates the runtime filters applied on a Liveboard. The filter
+            * attributes passed with this event are appended to the existing runtime
+            * filters applied on a Liveboard.
+            *
             * Pass an array of runtime filters with the following attributes:
             *
-            * `columnName`
-            * _String_. The name of the column to filter on.
+            * `columnName` - _String_. The name of the column to filter on.
             *
-            * `operator`
-            * Runtime filter operator to apply. For information,
+            * `operator` - Runtime filter operator to apply. For more information,
             * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
             *
-            * `values`
-            * List of operands. Some operators such as EQ, LE allow a single value, whereas
-            * operators such as BW and IN accept multiple operands.
+            * `values` - List of operands. Some operators such as EQ and LE allow a
+            * single value, whereas BW and IN accept multiple values.
+            *
+            * **Note**: `HostEvent.UpdateRuntimeFilters` is supported in `LiveboardEmbed`
+            * and `AppEmbed` only. In full application embedding, this event updates
+            * the runtime filters applied on the Liveboard and saved Answer objects.
             *
-            * **Note**: `HostEvent.UpdateRuntimeFilters` is not supported in
-            * Search embedding (SearchEmbed) and Natural Language Search
-            * embedding (SageEmbed).
             * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+            *
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
@@ -4864,7 +4869,7 @@ export enum HostEvent {
             */
         ResetLiveboardPersonalisedView = "ResetLiveboardPersonalisedView",
         /**
-            * Triggers Update RuntimeParameters for answers and liveboard
+            * Triggers an event to Update Parameter values for Answers and Liveboard
             * @example
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdateParameters, [{
@@ -4886,7 +4891,7 @@ export enum HostEvent {
             */
         GetParameters = "GetParameters",
         /**
-            * Triggers update of persoanlised view for a liveboard
+            * Triggers an event to update a persoanlised view of a Liveboard
             * ```js
             * liveboardEmbed.trigger(HostEvent.UpdatePersonalisedView, {viewId: '1234'})
             * ```
@@ -5875,7 +5880,7 @@ export enum Action {
             */
         ModifySageAnswer = "modifySageAnswer",
         /**
-            * The **Move to Tab** menu action on visualizations in liveboard edit mode.
+            * The **Move to Tab** menu action on visualizations in Liveboard edit mode.
             * Allows moving a visualization to a different tab.
             * @example
             * ```js
@@ -5928,7 +5933,8 @@ export enum Action {
             */
         TML = "tml",
         /**
-            * Action Id for CreateLiveboard for liveboard list page & Pin Modal
+            * Action ID for the create Liveboard option on the Liveboard list page
+            * and Pin modal
             * @example
             * ```js
             * hiddenAction: [Action.CreateLiveboard]
@@ -7415,7 +7421,7 @@ export class TsEmbed {
         /**
             * Returns the answerService which can be used to make arbitrary graphql calls on top
             * session.
-            * @param vizId [Optional] to get for a specific viz in case of a liveboard.
+            * @param vizId [Optional] to get for a specific viz in case of a Liveboard.
             * @version SDK: 1.25.0 / ThoughtSpot 9.10.0
             */
         getAnswerService(vizId?: string): Promise<AnswerService>;

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.35.5-hostEvent.7",
+    "version": "1.35.5-hostEvent.8",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

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

@@ -404,7 +404,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
      */
     showLiveboardVerifiedBadge?: boolean;
     /**
-     * This flag is used to enable/disable hide irrelevant filters in liveboard tab
+     * This flag is used to enable/disable hide irrelevant filters in Liveboard tab
      * @type {boolean}
      * @default false
      * @version SDK: 1.36.0 | ThoughtSpot:10.6.0.cl

package/lib/src/embed/base.d.ts

@@ -37,7 +37,7 @@ export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeature
 /**
  * Initializes the Visual Embed SDK globally and perform
  * authentication if applicable. This function needs to be called before any ThoughtSpot
- * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+ * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
  * to actually embed. That is handled internally.
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.

package/lib/src/embed/base.js

@@ -120,7 +120,7 @@ function backwardCompat(embedConfig) {
 /**
  * Initializes the Visual Embed SDK globally and perform
  * authentication if applicable. This function needs to be called before any ThoughtSpot
- * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+ * component like Liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
  * to actually embed. That is handled internally.
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.

package/lib/src/embed/hostEventClient/host-event-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"host-event-client.d.ts","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/host-event-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,OAAO,EACH,0BAA0B,EAC1B,kBAAkB,EAAE,gBAAgB,EAAE,iBAAiB,EACvD,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACd,eAAe,EAClB,MAAM,aAAa,CAAC;AAOrB,qBAAa,eAAe;IAC1B,MAAM,EAAE,iBAAiB,CAAC;gBAEd,MAAM,CAAC,EAAE,iBAAiB;IAItC;;;;;OAKG;cACa,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAc9D,wBAAwB,CAAC,mBAAmB,SAAS,kBAAkB,EAChF,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;IAsBzC,iBAAiB,CAC1B,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,GAAG,GACV,OAAO,CAAC,GAAG,CAAC;IAIf;;;OAGG;IACI,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAI3C,uBAAuB,CAAC,mBAAmB,SAAS,kBAAkB,EAC/E,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAC;cAS3C,cAAc,CAC1B,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG,CAAC,GACzC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;cAU5B,qBAAqB,CACjC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,GAChD,OAAO,CAAC,GAAG,CAAC;IAeF,gBAAgB,CAC3B,UAAU,SAAS,SAAS,EAC5B,QAAQ,EAEN,SAAS,EAAE,UAAU,EACrB,OAAO,CAAC,EAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,GAC/C,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;CAYlD"}
+{"version":3,"file":"host-event-client.d.ts","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/host-event-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,OAAO,EACH,0BAA0B,EAC1B,kBAAkB,EAAE,gBAAgB,EAAE,iBAAiB,EACvD,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACd,eAAe,EAClB,MAAM,aAAa,CAAC;AAErB,qBAAa,eAAe;IAC1B,MAAM,EAAE,iBAAiB,CAAC;gBAEd,MAAM,CAAC,EAAE,iBAAiB;IAItC;;;;;OAKG;cACa,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAc9D,wBAAwB,CAAC,mBAAmB,SAAS,kBAAkB,EAChF,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;IAsBzC,iBAAiB,CAC1B,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,GAAG,GACV,OAAO,CAAC,GAAG,CAAC;IAIf;;;OAGG;IACI,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAI3C,uBAAuB,CAAC,mBAAmB,SAAS,kBAAkB,EAC/E,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,GACtD,OAAO,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAC;cAS3C,cAAc,CAC1B,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG,CAAC,GACzC,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;cAU5B,qBAAqB,CACjC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,GAChD,OAAO,CAAC,GAAG,CAAC;IAeF,gBAAgB,CAC3B,UAAU,SAAS,SAAS,EAC5B,QAAQ,EAEN,SAAS,EAAE,UAAU,EACrB,OAAO,CAAC,EAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,GAC/C,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;CAYlD"}

package/lib/src/embed/hostEventClient/host-event-client.js

@@ -32,7 +32,7 @@ export class HostEventClient {
             || ((_d = response.value) === null || _d === void 0 ? void 0 : _d.error);
         if (errors) {
             // eslint-disable-next-line no-throw-literal
-            throw { error: response.error };
+            throw { error: errors };
         }
         return { ...response.value };
     }

package/lib/src/embed/hostEventClient/host-event-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"host-event-client.js","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/host-event-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAEH,kBAAkB,GAKrB,MAAM,aAAa,CAAC;AAOrB,MAAM,OAAO,eAAe;IAG1B,YAAY,MAA0B;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,cAAc,CAAC,OAAkB,EAAE,IAAS;QACxD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAChD;QAED,MAAM,eAAe,GAAG,cAAc,EAAE,CAAC,eAAe,CAAC;QACzD,OAAO,qBAAqB,CACxB,IAAI,CAAC,MAAM,EACX,OAAO,EACP,eAAe,EACf,IAAI,CACP,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACjC,OAA4B,EAC5B,UAAqD;;QAErD,MAAM,QAAQ,GAAG,MAAA,MAAA,CAAC,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,0CACpE,MAAM,mDAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAE7C,IAAI,CAAC,QAAQ,EAAE;YACX,MAAM,KAAK,GAAG,kBAAkB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC;YAC7F,4CAA4C;YAC5C,MAAM,EAAE,KAAK,EAAE,CAAC;SACnB;QAED,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK;gBACxB,MAAC,QAAQ,CAAC,KAAa,0CAAE,MAAM,CAAA;gBAC/B,MAAC,QAAQ,CAAC,KAAa,0CAAE,KAAK,CAAA,CAAC;QAEpC,IAAI,MAAM,EAAE;YACZ,4CAA4C;YACxC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC;SACnC;QAED,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC1B,SAAoB,EACpB,IAAS;QAET,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,MAAyB;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAChC,OAA4B,EAC5B,UAAqD;QAErD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,aAAa,EAAE;YAC3D,IAAI,EAAE,OAAO;YACb,UAAU;SACb,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACf,CAAC;IAES,KAAK,CAAC,cAAc,CAC1B,OAAwC;QAExC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,YAAY,IAAI,OAAO,CAAC,EAAE;YACxC,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACzD;QAED,OAAO,IAAI,CAAC,wBAAwB,CAChC,kBAAkB,CAAC,oBAAoB,EAAE,OAAO,CACnD,CAAC;IACN,CAAC;IAES,KAAK,CAAC,qBAAqB,CACjC,OAA+C;;QAE/C,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC,EAAE;YACjE,sCAAsC;YACtC,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAC1D;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAC5C,kBAAkB,CAAC,UAAU,EAAE,OAAO,CACzC,CAAC;QACF,OAAO;YACH,GAAG,IAAI;YACP,QAAQ,EAAE,MAAA,MAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,0CAAE,IAAI,0CAAE,YAAY,0CAAE,MAAM,0CAAE,EAAE;SAC/D,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAIzB,SAAqB,EACrB,OAA8C;QAE9C,QAAQ,SAAS,EAAE;YACf,KAAK,SAAS,CAAC,GAAG;gBACd,OAAO,IAAI,CAAC,cAAc,CAAC,OAA0C,CAAQ,CAAC;YAClF,KAAK,SAAS,CAAC,UAAU;gBACrB,OAAO,IAAI,CAAC,qBAAqB,CAC7B,OAAiD,CAC7C,CAAC;YACb;gBACI,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;SACzD;IACL,CAAC;CACF"}
+{"version":3,"file":"host-event-client.js","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/host-event-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACrF,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAEH,kBAAkB,GAKrB,MAAM,aAAa,CAAC;AAErB,MAAM,OAAO,eAAe;IAG1B,YAAY,MAA0B;QAClC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,cAAc,CAAC,OAAkB,EAAE,IAAS;QACxD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAChD;QAED,MAAM,eAAe,GAAG,cAAc,EAAE,CAAC,eAAe,CAAC;QACzD,OAAO,qBAAqB,CACxB,IAAI,CAAC,MAAM,EACX,OAAO,EACP,eAAe,EACf,IAAI,CACP,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACjC,OAA4B,EAC5B,UAAqD;;QAErD,MAAM,QAAQ,GAAG,MAAA,MAAA,CAAC,MAAM,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,0CACpE,MAAM,mDAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAE7C,IAAI,CAAC,QAAQ,EAAE;YACX,MAAM,KAAK,GAAG,kBAAkB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC;YAC7F,4CAA4C;YAC5C,MAAM,EAAE,KAAK,EAAE,CAAC;SACnB;QAED,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK;gBACxB,MAAC,QAAQ,CAAC,KAAa,0CAAE,MAAM,CAAA;gBAC/B,MAAC,QAAQ,CAAC,KAAa,0CAAE,KAAK,CAAA,CAAC;QAEpC,IAAI,MAAM,EAAE;YACZ,4CAA4C;YACxC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;SAC3B;QAED,OAAO,EAAE,GAAG,QAAQ,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC1B,SAAoB,EACpB,IAAS;QAET,OAAO,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,MAAyB;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,uBAAuB,CAChC,OAA4B,EAC5B,UAAqD;QAErD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,aAAa,EAAE;YAC3D,IAAI,EAAE,OAAO;YACb,UAAU;SACb,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACf,CAAC;IAES,KAAK,CAAC,cAAc,CAC1B,OAAwC;QAExC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,YAAY,IAAI,OAAO,CAAC,EAAE;YACxC,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACzD;QAED,OAAO,IAAI,CAAC,wBAAwB,CAChC,kBAAkB,CAAC,oBAAoB,EAAE,OAAO,CACnD,CAAC;IACN,CAAC;IAES,KAAK,CAAC,qBAAqB,CACjC,OAA+C;;QAE/C,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,CAAC,EAAE;YACjE,sCAAsC;YACtC,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;SAC1D;QAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAC5C,kBAAkB,CAAC,UAAU,EAAE,OAAO,CACzC,CAAC;QACF,OAAO;YACH,GAAG,IAAI;YACP,QAAQ,EAAE,MAAA,MAAA,MAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,YAAY,0CAAE,IAAI,0CAAE,YAAY,0CAAE,MAAM,0CAAE,EAAE;SAC/D,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAIzB,SAAqB,EACrB,OAA8C;QAE9C,QAAQ,SAAS,EAAE;YACf,KAAK,SAAS,CAAC,GAAG;gBACd,OAAO,IAAI,CAAC,cAAc,CAAC,OAA0C,CAAQ,CAAC;YAClF,KAAK,SAAS,CAAC,UAAU;gBACrB,OAAO,IAAI,CAAC,qBAAqB,CAC7B,OAAiD,CAC7C,CAAC;YACb;gBACI,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;SACzD;IACL,CAAC;CACF"}