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

package/lib/src/visual-embed-sdk.d.ts

@@ -441,7 +441,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
                 */
             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
@@ -567,7 +567,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
     /**
         * 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.
@@ -901,7 +901,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             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
@@ -936,7 +936,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             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
@@ -950,7 +950,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             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
@@ -964,7 +964,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             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
@@ -978,7 +979,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             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
@@ -1067,8 +1068,8 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             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;
@@ -2859,8 +2860,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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', {
@@ -4117,7 +4122,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @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) => {
@@ -4204,26 +4209,26 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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, [
@@ -4922,7 +4927,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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, [{
@@ -4944,7 +4949,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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'})
                 * ```
@@ -5933,7 +5938,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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
@@ -5986,7 +5991,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             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]
@@ -7508,7 +7514,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
             /**
                 * 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/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/src/embed/app.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

package/src/embed/base.ts

@@ -174,7 +174,7 @@ function backwardCompat(embedConfig: EmbedConfig): 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/src/embed/hostEventClient/host-event-client.ts

@@ -10,11 +10,6 @@ import {
     TriggerResponse,
 } from './contracts';
 
-// Define a type for the eventHandlerMap
-type EventHandlerMap = {
-  [K in HostEvent]: any;
-};
-
 export class HostEventClient {
   iFrame: HTMLIFrameElement;
 
@@ -61,7 +56,7 @@ export class HostEventClient {
 
       if (errors) {
       // eslint-disable-next-line no-throw-literal
-          throw { error: response.error };
+          throw { error: errors };
       }
 
       return { ...response.value };

package/src/embed/liveboard.ts

@@ -249,7 +249,7 @@ export interface LiveboardViewConfig
      */
     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
@@ -284,7 +284,7 @@ export interface LiveboardViewConfig
      */
     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
@@ -298,7 +298,7 @@ export interface LiveboardViewConfig
      */
     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
@@ -312,7 +312,8 @@ export interface LiveboardViewConfig
      */
     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
@@ -326,7 +327,7 @@ export interface LiveboardViewConfig
      */
     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
@@ -682,8 +683,8 @@ export class LiveboardEmbed extends V1Embed {
     }
 
     /**
-     * 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
      */
     public getLiveboardUrl(): string {

package/src/embed/ts-embed.ts

@@ -1282,7 +1282,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
      */
     public async getAnswerService(vizId?: string): Promise<AnswerService> {

package/src/types.ts

@@ -1088,8 +1088,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', {
@@ -2365,7 +2369,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) => {
@@ -2452,26 +2456,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, [
@@ -3170,7 +3174,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, [{
@@ -3192,7 +3196,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'})
      * ```
@@ -4189,7 +4193,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
@@ -4244,7 +4248,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]