@thoughtspot/visual-embed-sdk 1.33.3 → 1.33.5

package/src/types.ts

@@ -588,6 +588,26 @@ export interface EmbedConfig {
      * @version SDK 1.32.3 | Thoughtspot: *
      */
     disableLoginFailurePage?: boolean;
+    /**
+     * This is an object (key/val) of override flags which will be applied
+     * to the internal embedded object. This can be used to add any
+     * URL flag.
+     * Warning: This option is for advanced use only and is used internally
+     * to control embed behavior in non-regular ways. We do not publish the
+     * list of supported keys and values associated with each.
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   additionalFlags: {
+     *        flag1: 'value1',
+     *        flag2: 'value2'
+     *     }
+     * });
+     * ```
+     * @version SDK: 1.33.5 | ThoughtSpot: *
+     */
+    additionalFlags?: { [key: string]: string | number | boolean };
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -779,6 +799,7 @@ export interface ViewConfig {
      * This is an object (key/val) of override flags which will be applied
      * to the internal embedded object. This can be used to add any
      * URL flag.
+     * If the same flags are passed in init, they will be overriden by the values here.
      * Warning: This option is for advanced use only and is used internally
      * to control embed behavior in non-regular ways. We do not publish the
      * list of supported keys and values associated with each.
@@ -1017,7 +1038,7 @@ export interface ViewConfig {
     // eslint-disable-next-line camelcase
     enableV2Shell_experimental?: boolean;
     /**
-     * To set the initial state of the search bar in case of saved-answers.
+     * To set the initial state of the search bar in case of saved Answers.
      * @default true
      * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
      * @example
@@ -1030,7 +1051,7 @@ export interface ViewConfig {
     collapseSearchBar?: boolean;
     /**
      * This flag can be used to disable links inside the embedded app,
-     * and disables redirection of links in a new tab.
+     * and disable redirection of links in a new tab.
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -1042,7 +1063,7 @@ export interface ViewConfig {
     disableRedirectionLinksInNewTab?: boolean;
     /**
      * Flag to control Data panel experience
-     * @default true
+     * @default false
      * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
      * @example
      * ```js
@@ -1066,6 +1087,19 @@ 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
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other options
+     *   overrideOrgId: 142536
+     * });
+     * ```
+     * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
+     */
+    overrideOrgId?: number;
 }
 
 /**
@@ -1121,7 +1155,7 @@ export type MessageCallbackObj = {
 export type GenericCallbackFn = (...args: any[]) => any;
 
 export type QueryParams = {
-    [key: string]: string;
+    [key: string]: string | boolean | number;
 };
 
 /**
@@ -2167,22 +2201,26 @@ export enum EmbedEvent {
      */
     Rename = 'rename',
     /**
-     * Emitted if the user wants to intercept the search execution
-     * and implement logic to decide whether to run the search or not
      *
-     * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
+     * This event can be emitted to intercept search execution initiated by
+     * the users and implement the logic to allow or restrict search execution.
+     * You can can also show custom error text if the search query must be
+     * restricted due to your application or business requirements.
+
+     * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
      * for this embed event to get emitted.
      * @param: payload
      * @param: responder
      * Contains elements that lets developers define whether ThoughtSpot
-     * will run the search or not, and if not, which error message to provide.
+     * should run the search, and if not, what error message
+     * should be shown to the user.
      *
-     * execute: When execute returns true, the search will be run.
-     * When execute returns false, the search will not be executed.
+     * execute: When execute returns `true`, the search will be run.
+     * When execute returns `false`, the search will not be executed.
      *
-     * error: Developers can customize the user facing message when execute is
-     * set to false using the error parameter in responder
-     * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+     * error: Developers can customize the error message text when `execute`
+     * returns `false` using the error parameter in responder.
+     * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
      * @example
      *```js
      * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -2222,15 +2260,15 @@ export enum EmbedEvent {
      */
     OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
     /**
-     * Emitted when parameter changes in an answer
-     * or liveboard
+     * Emitted when parameter changes in an Answer
+     * or Liveboard
      *
      * ```js
      * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+     * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
      */
     ParameterChanged = 'parameterChanged',
 }
@@ -2961,11 +2999,13 @@ export enum HostEvent {
      *  see link:https://developers.thoughtspot.com/docs/runtime-filters#rtOperator[Developer Documentation].
      *
      * `values` - An array of one or several values. The value definition on the
-     *  data type you choose to filter on. For a complete list of supported data types, see
-     *  link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types]
+     *  data type you choose to filter on. For a complete list of supported data types,
+     *  see
+     *  link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported
+     *  data types].
+     *
      * `type`  - To update filters for date time, specify the date format type.
      * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
-     *
      * @example
      * ```js
      *
@@ -3256,6 +3296,8 @@ export enum Param {
     ShowLiveboardReverifyBanner = 'showLiveboardReverifyBanner',
     LiveboardHeaderV2 = 'isLiveboardHeaderV2Enabled',
     SpotterEnabled = 'isSpotterExperienceEnabled',
+    IsUnifiedSearchExperienceEnabled = 'isUnifiedSearchExperienceEnabled',
+    OverrideOrgId = 'orgId',
 }
 
 /**
@@ -4237,7 +4279,7 @@ export enum Action {
     AIHighlights = 'AIHighlights',
 
     /**
-     * Action ID for edit schedule action on schedule on homepage
+     * Action ID for edit the schedule action on schedule on homepage
      * @example
      * ```js
      * disabledActions: [Action.EditScheduleHomepage]
@@ -4305,6 +4347,15 @@ export enum Action {
      *  @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
      */
     KPIAnalysisCTA = 'kpiAnalysisCTA',
+    /**
+     * Action ID for disabling chip reorder in Answer and Liveboard
+     * @example
+     * ```js
+     * const disabledActions = [Action.DisableChipReorder]
+     * ```
+     * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
+     */
+    DisableChipReorder = 'disableChipReorder',
 }
 
 export interface AnswerServiceType {