@thoughtspot/visual-embed-sdk 1.17.2-customcss → 1.18.0-alpha.1

package/CHANGELOG.md

@@ -6,14 +6,14 @@ This project follows Semantic Versioning.
 ## Unreleased
 
 ### New Features
-- Set of new Host events to drive interactions on the embed programatically
+- Set of new Host events to drive interactions on the embed programatically 
 
 ## 1.14.1 (08-31-2022)
 - Fixed "not logged in" message showing up on "SearchEmbed" with AuthType.None.
 
 ## 1.14.0 (08-29-2022)
 - [AuthType.AuthServer] Now uses `POST` call to log the user in using the bearer token.
-- `liveboardV2` flag on `LiveboardEmbed` to try out the LiveboardV2 experience.
+- `liveboardV2` flag on `LiveboardEmbed` to try out the LiveboardV2 experience. 
 
 ## 1.13.0 (07-19-2022)
 - Release to support TS version 8.5.0.cl
@@ -29,10 +29,6 @@ This project follows Semantic Versioning.
 ### Fixed
 - Typescript build that was affecting some Angular project configurations
 
-## 1.11.2 (06-10-2022)
-### Fixed
-- Typescript build that was affecting some Angular project configurations
-
 ## 1.11.1 (05-30-2022)
 ### Fixed
 - Whitelabeling - new [action](https://developers.thoughtspot.com/docs/typedoc/enums/Action.html#ReportError) for the ability to turn off TS specific error reporting by end users.
@@ -81,12 +77,12 @@ This project follows Semantic Versioning.
 
 ## 1.9.3 (03-22-2022)
 
-### New Features
+### New Features 
 - `disableLoginRedirect` option in `EmbedConfig`
 
 ## 1.9.2 (03-17-2022)
 
-### New Features
+### New Features 
 - Ability to trigger events on React components
   - Added new `useEmbedRef` hook, check README for usage.
 

package/README.md

@@ -7,7 +7,7 @@
 # ThoughtSpot Visual Embed SDK <br/> [![Coverage Status](https://coveralls.io/repos/github/ts-blink/embed-sdk/badge.svg?branch=main)](https://coveralls.io/github/ts-blink/embed-sdk?branch=main) ![npm (scoped with tag)](https://img.shields.io/npm/v/@thoughtspot/visual-embed-sdk) [![](https://data.jsdelivr.com/v1/package/npm/@thoughtspot/visual-embed-sdk/badge?style=rounded)](https://www.jsdelivr.com/package/npm/@thoughtspot/visual-embed-sdk) ![npm](https://img.shields.io/npm/dm/@thoughtspot/visual-embed-sdk?label=npm%20downloads&style=flat-square) [![Featured on Openbase](https://badges.openbase.com/js/featured/@thoughtspot/visual-embed-sdk.svg?token=IoqZUwE8aX7LYNedeuBLM2w5Wt52hu+Dh0eyKjlpC0E=)](https://openbase.com/js/@thoughtspot/visual-embed-sdk?utm_source=embedded&amp;utm_medium=badge&amp;utm_campaign=rate-badge) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@thoughtspot/visual-embed-sdk?style=flat-square)
 
 
-SDK to embed ThoughtSpot into your web apps. You need to have a ThoughtSpot account to use the SDK, [click here](https://www.thoughtspot.com/trial?tsref=trialtse) to start a trial. 
+SDK to embed ThoughtSpot into your web apps. You need a ThoughtSpot account to use the SDK, [click here](https://www.thoughtspot.com/trial?tsref=trialtse) to start a trial. 
 
    * [Installation](#installation)
    * [Live Playground](#live-playground)

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

@@ -8,8 +8,8 @@
  * @module
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { DOMSelector } from '../types';
-import { V1Embed, ViewConfig } from './ts-embed';
+import { DOMSelector, ViewConfig } from '../types';
+import { V1Embed } from './ts-embed';
 /**
  * Pages within the ThoughtSpot app that can be embedded.
  */

package/dist/src/embed/liveboard.d.ts

@@ -8,8 +8,8 @@
  * @summary Liveboard & visualization embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { DOMSelector, HostEvent } from '../types';
-import { V1Embed, ViewConfig } from './ts-embed';
+import { DOMSelector, HostEvent, ViewConfig } from '../types';
+import { V1Embed } from './ts-embed';
 /**
  * The configuration for the embedded Liveboard or visualization page view.
  * @Category Liveboards and Charts

package/dist/src/embed/search-bar.d.ts

@@ -1,4 +1,5 @@
-import { TsEmbed, ViewConfig } from './ts-embed';
+import { ViewConfig } from '../types';
+import { TsEmbed } from './ts-embed';
 import { SearchOptions } from './search';
 export interface SearchBarViewConfig extends ViewConfig {
     /**
@@ -18,7 +19,7 @@ export interface SearchBarViewConfig extends ViewConfig {
  * Embed ThoughtSpot search bar
  *
  * @Category Search Embed
- * @version: SDK: 1.17.0 | ThoughtSpot 8.10.0.cl, 9.0.1-sw
+ * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
  */
 export declare class SearchBarEmbed extends TsEmbed {
     /**

package/dist/src/embed/search.d.ts

@@ -6,8 +6,8 @@
  * @summary Search embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { DOMSelector, Action } from '../types';
-import { ViewConfig, TsEmbed } from './ts-embed';
+import { DOMSelector, Action, ViewConfig } from '../types';
+import { TsEmbed } from './ts-embed';
 /**
  * Configuration for search options
  */
@@ -44,10 +44,6 @@ export interface SearchViewConfig extends ViewConfig {
      * using raw answer data.
      */
     hideResults?: boolean;
-    /**
-     * If set to true, expands all the data sources panel.
-     */
-    expandAllDataSource?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw

package/dist/src/embed/ts-embed.d.ts

@@ -6,106 +6,11 @@
  * @summary Base classes
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, Action, RuntimeFilter, EmbedConfig, MessageOptions } from '../types';
+import { DOMSelector, HostEvent, EmbedEvent, MessageCallback, EmbedConfig, MessageOptions, ViewConfig, FrameParams } from '../types';
 /**
  * Global prefix for all Thoughtspot postHash Params.
  */
 export declare const THOUGHTSPOT_PARAM_PREFIX = "ts-";
-export interface LayoutConfig {
-}
-/**
- * Embedded iFrame configuration
- */
-export interface FrameParams {
-    /**
-     * The width of the iFrame (unit is pixels if numeric).
-     */
-    width?: number | string;
-    /**
-     * The height of the iFrame (unit is pixels if numeric).
-     */
-    height?: number | string;
-    /**
-     * This parameters will be passed on the iframe
-     * as is.
-     */
-    [key: string]: string | number | boolean | undefined;
-}
-/**
- * The configuration object for an embedded view.
- */
-export interface ViewConfig {
-    /**
-     * @hidden
-     */
-    layoutConfig?: LayoutConfig;
-    /**
-     * The <b>width</b> and <b>height</b> dimensions to render an embedded object inside your app.  Specify the values in pixels or percentage.
-     */
-    frameParams?: FrameParams;
-    /**
-     * @hidden
-     */
-    theme?: string;
-    /**
-     * @hidden
-     */
-    styleSheet__unstable?: string;
-    /**
-     * The list of actions to disable from the primary menu, more menu
-     * (...), and the contextual menu.
-     */
-    disabledActions?: Action[];
-    /**
-     * The tooltip to display for disabled actions.
-     */
-    disabledActionReason?: string;
-    /**
-     * The list of actions to hide from the primary menu, more menu
-     * (...), and the contextual menu.
-     */
-    hiddenActions?: Action[];
-    /**
-     * The list of actions to display from the primary menu, more menu
-     * (...), and the contextual menu.
-     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
-     */
-    visibleActions?: Action[];
-    /**
-     * Show alert messages and toast messages in the embedded view.
-     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
-     */
-    showAlerts?: boolean;
-    /**
-     * The list of runtime filters to apply to a search answer,
-     * visualization, or Liveboard.
-     */
-    runtimeFilters?: RuntimeFilter[];
-    /**
-     * The locale/language to use for the embedded view.
-     * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
-     */
-    locale?: string;
-    /**
-     * 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.
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
-     */
-    additionalFlags?: {
-        [key: string]: string | number | boolean;
-    };
-    /**
-     * Dynamic CSS Url to be injected in the loaded application.
-     * You would also need to set `style-src` in the CSP settings.
-     * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
-     * @default ''
-     */
-    customCssUrl?: string;
-}
 /**
  * Base class for embedding v2 experience
  * Note: the v2 version of ThoughtSpot Blink is built on the new stack:
@@ -275,7 +180,7 @@ export declare class TsEmbed {
      * @param messageType The event type
      * @param data The payload to send with the message
      */
-    trigger(messageType: HostEvent, data: any): Promise<any>;
+    trigger(messageType: HostEvent, data?: any): Promise<any>;
     /**
      * Marks the ThoughtSpot object to have been rendered
      * Needs to be overridden by subclasses to do the actual

package/dist/src/react/util.d.ts

@@ -1,5 +1,4 @@
-import { EmbedEvent, MessageCallback } from '../types';
-import { ViewConfig } from '../embed/ts-embed';
+import { EmbedEvent, MessageCallback, ViewConfig } from '../types';
 export declare type EmbedEventHandlers = {
     [key in keyof typeof EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
 };

package/dist/src/types.d.ts

@@ -82,11 +82,11 @@ interface customCssInterface {
 }
 interface CustomStyles {
     customCSSUrl?: string;
-    customCss?: customCssInterface;
+    customCSS?: customCssInterface;
 }
 export interface CustomisationsInterface {
-    style: CustomStyles;
-    content: {
+    style?: CustomStyles;
+    content?: {
         [key: string]: string;
     };
 }
@@ -226,7 +226,7 @@ export interface EmbedConfig {
      *
      * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
      */
-    customisations?: CustomisationsInterface;
+    customizations?: CustomisationsInterface;
     /**
      * For noRedirect SSO Auth, we need a button which the user
      * click to trigger the flow. This is the containing element
@@ -242,6 +242,101 @@ export interface EmbedConfig {
      */
     authTriggerText?: string;
 }
+export interface LayoutConfig {
+}
+/**
+ * Embedded iFrame configuration
+ */
+export interface FrameParams {
+    /**
+     * The width of the iFrame (unit is pixels if numeric).
+     */
+    width?: number | string;
+    /**
+     * The height of the iFrame (unit is pixels if numeric).
+     */
+    height?: number | string;
+    /**
+     * This parameters will be passed on the iframe
+     * as is.
+     */
+    [key: string]: string | number | boolean | undefined;
+}
+/**
+ * The configuration object for an embedded view.
+ */
+export interface ViewConfig {
+    /**
+     * @hidden
+     */
+    layoutConfig?: LayoutConfig;
+    /**
+     * The <b>width</b> and <b>height</b> dimensions to render an embedded object inside your app.  Specify the values in pixels or percentage.
+     */
+    frameParams?: FrameParams;
+    /**
+     * @hidden
+     */
+    theme?: string;
+    /**
+     * @hidden
+     */
+    styleSheet__unstable?: string;
+    /**
+     * The list of actions to disable from the primary menu, more menu
+     * (...), and the contextual menu.
+     */
+    disabledActions?: Action[];
+    /**
+     * The tooltip to display for disabled actions.
+     */
+    disabledActionReason?: string;
+    /**
+     * The list of actions to hide from the primary menu, more menu
+     * (...), and the contextual menu.
+     */
+    hiddenActions?: Action[];
+    /**
+     * The list of actions to display from the primary menu, more menu
+     * (...), and the contextual menu.
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
+     */
+    visibleActions?: Action[];
+    /**
+     * Show alert messages and toast messages in the embedded view.
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     */
+    showAlerts?: boolean;
+    /**
+     * The list of runtime filters to apply to a search answer,
+     * visualization, or Liveboard.
+     */
+    runtimeFilters?: RuntimeFilter[];
+    /**
+     * The locale/language to use for the embedded view.
+     * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
+     */
+    locale?: string;
+    /**
+     * 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.
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+     */
+    additionalFlags?: {
+        [key: string]: string | number | boolean;
+    };
+    /**
+     * Dynamic CSSUrl and customCSS to be injected in the loaded application.
+     * You would also need to set `style-src` in the CSP settings.
+     * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
+     * @default ''
+     */
+    customizations?: CustomisationsInterface;
+}
 /**
  * MessagePayload: Embed event payload: message type, data and status (start/end)
  */
@@ -738,7 +833,10 @@ export declare enum HostEvent {
      * Triggers the Pin action on an embedded object
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
-     * @example liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.Pin)
+     * searchEmbed.trigger(HostEvent.Pin)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Pin = "pin",
@@ -785,8 +883,11 @@ export declare enum HostEvent {
      */
     DownloadAsPdf = "downloadAsPdf",
     /**
-     * Triggers the Make a copy action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.MakeACopy)
+     * Triggers the Make a copy action on a Liveboard, search or visualization
+     * @example
+     * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.MakeACopy)
+     * searchEmbed.trigger(HostEvent.MakeACopy)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     MakeACopy = "makeACopy",
@@ -850,15 +951,74 @@ export declare enum HostEvent {
     /**
      * Get TML for the current search.
      * @example searchEmbed.trigger(HostEvent.GetTML)
-     * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+     * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
      */
     GetTML = "getTML",
+    /**
+     * Triggers the ShowUnderlyingData action on visualization or search
+     * @param - an object with vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
+     * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    ShowUnderlyingData = "showUnderlyingData",
+    /**
+     * Triggers the Delete action on visualization or search
+     * @param - incase of Liveboard embed, takes in an object with vizId as a key
+     * can be left empty for search and visualization embeds
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Delete, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.Delete)
+     * searchEmbed.trigger(HostEvent.Delete)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    Delete = "delete",
+    /**
+     * Triggers the SpotIQAnalyze action on visualization or search
+     * @param - incase of Liveboard embed, takes in an object with vizId as a key
+     * can be left empty for search and visualization embeds
+     * @example
+     * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
+     * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    SpotIQAnalyze = "spotIQAnalyze",
+    /**
+     * Triggers the Download action on visualization or search when Displaymode is Chart
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Download, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.Download)
+     * searchEmbed.trigger(HostEvent.Download)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    Download = "download",
+    /**
+     * Triggers the downloadAsCSV action on visualization or search when Displaymode is Table
+     * @example
+     * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.DownloadAsCsv)
+     * searchEmbed.trigger(HostEvent.DownloadAsCsv)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    DownloadAsCsv = "downloadAsCSV",
+    /**
+     * Triggers the downloadAsXLSX action on visualization or search when Displaymode is Table
+     * @example
+     * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
+     * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    DownloadAsXlsx = "downloadAsXLSX",
     /**
      * Triggers the Share action on a liveboard or answer
      * @example
      * liveboardEmbed.trigger(HostEvent.Share)
      * searchEmbed.trigger(HostEvent.Share)
-     * @version SDK: 1.19.0 | Thoughtspot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     Share = "share",
     /**
@@ -866,9 +1026,36 @@ export declare enum HostEvent {
      * @example
      * liveboardEmbed.trigger(HostEvent.Save)
      * searchEmbed.trigger(HostEvent.Save)
-     * @version SDK: 1.19.0 | Thoughtspot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    Save = "save",
+    /**
+     * Triggers the SyncToSheets action on visualization
+     * @param - an object with vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.SyncToSheets)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
-    Save = "save"
+    SyncToSheets = "sync-to-sheets",
+    /**
+     * Triggers the SyncToOtherApps action on visualization
+     * @param - an object with vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.SyncToOtherApps)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    SyncToOtherApps = "sync-to-other-apps",
+    /**
+     * Triggers the ManagePipelines action on visualization
+     * @param - an object with vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.ManagePipelines)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    ManagePipelines = "manage-pipeline"
 }
 /**
  * The different visual modes that the data sources panel within

package/dist/src/utils.d.ts

@@ -6,7 +6,7 @@
  * @summary Utils
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { EmbedConfig, QueryParams, RuntimeFilter, CustomisationsInterface, DOMSelector } from './types';
+import { EmbedConfig, QueryParams, RuntimeFilter, CustomisationsInterface, DOMSelector, ViewConfig } from './types';
 /**
  * Construct a runtime filters query string from the given filters.
  * Refer to the following docs for more details on runtime filter syntax:
@@ -43,7 +43,7 @@ export declare const setAttributes: (element: HTMLElement, attributes: {
     [key: string]: string | number | boolean;
 }) => void;
 export declare const checkReleaseVersionInBeta: (releaseVersion: string, suppressBetaWarning: boolean) => boolean;
-export declare const getCustomisations: (embedConfig: EmbedConfig) => CustomisationsInterface;
+export declare const getCustomisations: (embedConfig: EmbedConfig, viewConfig: ViewConfig) => CustomisationsInterface;
 /**
  * Gets a reference to the DOM node given
  * a selector.