@thoughtspot/visual-embed-sdk 1.36.8 → 1.36.9-primaryAction

package/src/types.ts

@@ -297,6 +297,8 @@ export interface CustomisationsInterface {
          * @version SDK: 1.26.0 | 9.7.0.cl
          */
         strings?: Record<string, any>;
+        stringIDs?: Record<string, string>;
+        stringIDsUrl?: string;
         [key: string]: any;
     };
     iconSpriteUrl?: string;
@@ -626,14 +628,14 @@ export interface EmbedConfig {
      *     }
      * });
      * ```
-     *  @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
+     *  @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
      */
     customVariablesForThirdPartyTools?: Record< string, any >;
 
     disablePreauthCache?: boolean;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface LayoutConfig {}
 
 /**
@@ -738,6 +740,23 @@ export interface ViewConfig {
      * @important
      */
     hiddenActions?: Action[];
+
+    /**
+     * The primary action to display from the embedded.
+     * This action will be displayed from the embedded.
+     * Use this to set the primary action.
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed', {
+     *   ... // other liveboard view config
+     *   primaryAction: 'download'
+     * });
+     * ```
+     * @important
+     */
+    primaryAction?: string;
+
     /**
      * The list of actions to display from the primary menu, more menu
      * (...), and the contextual menu. These will be only actions that
@@ -768,6 +787,8 @@ export interface ViewConfig {
      * })
      * ```
      */
+
+
     showAlerts?: boolean;
     /**
      * The list of runtime filters to apply to a search Answer,
@@ -1072,6 +1093,12 @@ export interface ViewConfig {
      * });
      */
     collapseSearchBar?: boolean;
+    /**
+     * This flag can be used to expose translation IDs on the embedded app.
+     * @default false
+     * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
+     */
+    exposeTranslationIDs?: boolean;
     /**
      * This flag can be used to disable links inside the embedded app,
      * and disable redirection of links in a new tab.
@@ -1126,6 +1153,21 @@ export interface ViewConfig {
      * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
      */
     overrideOrgId?: number;
+    /**
+     * Hide list page columns
+     * For example: hiddenListColumns = [ListPageColumns.Author]
+     *
+     * **Note**: This option is appplicable only in full app embedding.
+     * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
+     * })
+     * ```
+     */
+    hiddenListColumns?: ListPageColumns[];
 }
 
 /**
@@ -1286,6 +1328,35 @@ export enum HomepageModule {
     Learning = 'LEARNING',
 }
 
+/**
+ * List page columns that can be hidden.
+ * **Note**: This option is applicable only in full app embedding.
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
+ */
+// eslint-disable-next-line no-shadow
+export enum ListPageColumns {
+    /**
+     * Favourite
+     */
+    Favourite = 'FAVOURITE',
+    /**
+     * Tags
+     */
+    Tags = 'TAGS',
+    /**
+     * Author
+     */
+    Author = 'AUTHOR',
+    /**
+     * Last viewed/Last modified
+     */
+    DateSort = 'DATE_SORT',
+    /**
+     * Share
+     */
+    Share = 'SHARE',
+}
+
 /**
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
  * visualizations at runtime.
@@ -2312,16 +2383,19 @@ export enum EmbedEvent {
     /**
      * Emits when a table visualization is rendered in
      * the ThoughtSpot embedded app.
+     *
      * You can also use this event as a hook to trigger host events
      * such as `HostEvent.TransformTableVizData` on the table visualization.
      * The event payload contains the data used in the rendered table.
      * You can extract the relevant data from the payload
      * stored in `payload.data.data.columnDataLite`.
+     *
      * `columnDataLite` is a multidimensional array that contains
      * data values for each column, which was used in the query to
      * generate the table visualization. To find and modify specific cell data,
      * you can either loop through the array or directly access a cell if
      * you know its position and data index.
+     *
      * In the following code sample, the first cell in the first column
      * (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
      * Note that any changes made to the data in the payload will only update the
@@ -2331,6 +2405,7 @@ export enum EmbedEvent {
      * payload in the `columnDataLite` is passed on to
      * `HostEvent.TransformTableVizData` and trigger an update to
      * the table visualization.
+     *
      * If the Row-Level Security (RLS) rules are applied on the
      * Worksheet or Model, exercise caution when changing column
      * or table cell values to maintain data security.
@@ -2345,7 +2420,7 @@ export enum EmbedEvent {
      *      searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
      * })
      * ```
-     * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
      */
      TableVizRendered = 'TableVizRendered',
      /**
@@ -2358,7 +2433,7 @@ export enum EmbedEvent {
      *     console.log('payload', payload);
      * })
      *```
-     * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
+     * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
      */
     CreateLiveboard = 'createLiveboard',
     /**
@@ -2807,7 +2882,7 @@ export enum HostEvent {
      * ```js
      * liveboardEmbed.trigger(HostEvent.Remove)
      * ```
-     * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
      */
     Remove = 'delete',
     /**
@@ -3355,7 +3430,7 @@ export enum HostEvent {
      * ```js
      * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
      *```
-     * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
+     * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
      */
      InfoSuccess = 'InfoSuccess',
     /**
@@ -3402,7 +3477,7 @@ export enum HostEvent {
      *      searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
      * })
      * ```
-     * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
+     * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
      */
     TransformTableVizData = 'TransformTableVizData',
 }
@@ -3457,6 +3532,7 @@ export enum Param {
     livedBoardEmbed = 'isLiveboardEmbed',
     searchEmbed = 'isSearchEmbed',
     vizEmbed = 'isVizEmbed',
+    StringIDsUrl = 'overrideStringIDsUrl',
     Version = 'sdkVersion',
     ViewPortHeight = 'viewPortHeight',
     ViewPortWidth = 'viewPortWidth',
@@ -3512,6 +3588,7 @@ export enum Param {
     HideSageAnswerHeader = 'hideSageAnswerHeader',
     HideSearchBar = 'hideSearchBar',
     ClientLogLevel = 'clientLogLevel',
+    ExposeTranslationIDs = 'exposeTranslationIDs',
     OverrideNativeConsole = 'overrideConsoleLogs',
     enableAskSage = 'enableAskSage',
     CollapseSearchBarInitially = 'collapseSearchBarInitially',
@@ -3539,6 +3616,7 @@ export enum Param {
     preAuthCache = 'preAuthCache',
     ShowSpotterLimitations = 'showSpotterLimitations',
     CoverAndFilterOptionInPDF = 'coverAndFilterOptionInPDF',
+    PrimaryAction = 'primaryAction',
 }
 
 /**
@@ -3705,7 +3783,7 @@ export enum Action {
     * The **Collapse data panel** icon on the Search page.
     * Collapses the data panel view.
     *
-    * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
+    * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
     *
     * @example
     * ```js
@@ -4791,8 +4869,8 @@ export enum PrefetchFeatures {
 }
 
 /**
- * Enum for options to change context trigger
- * BOTH_CLICKS option is introduced in 10.7
+ * Enum for options to change context trigger.
+ * The `BOTH_CLICKS` option is available from 10.8.0.cl.
  */
 export enum ContextMenuTriggerOptions {
     LEFT_CLICK = 'left-click',
@@ -4944,4 +5022,5 @@ export interface DefaultAppInitData {
     hostConfig: Record<string, any>;
     hiddenHomeLeftNavItems: string[];
     customVariablesForThirdPartyTools: Record<string, any>;
+    hiddenListColumns: ListPageColumns[];
 }