@thoughtspot/visual-embed-sdk 1.21.0-alpha.8 → 1.21.0-react.0

package/src/types.ts

@@ -18,6 +18,14 @@ export enum AuthType {
     /**
      * No authentication on the SDK. Passthrough to the embedded App. Alias for
      * `Passthrough`.
+     *
+     * @example
+     * ```js
+     * init({
+     *   // ...
+     *   authType: AuthType.None,
+     *  });
+     * ```
      */
     None = 'None',
     /**
@@ -25,6 +33,18 @@ export enum AuthType {
      * configuration, but may not be supported by all IDPs. This will behave like `None`
      * if SSO is not configured on ThoughtSpot.
      *
+     * @example
+     * ```js
+     * init({
+     *   // ...
+     *   authType: AuthType.EmbeddedSSO,
+     *  });
+     * ```
+     * Set authentication type as Embedded SSO.
+     *
+     * To use this:
+     * Your SAML or OpenID provider must allow iframe redirects.
+     * eg. If you are using okta as IdP, you can enable iFrame embedding.
      * @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
      */
     EmbeddedSSO = 'EmbeddedSSO',
@@ -132,6 +152,19 @@ export enum AuthType {
      * obtained from ThoughtSpot. This uses a cookieless authentication
      * approach, recommended to by pass third-party cookie-blocking restriction
      * implemented by some browsers
+     *
+     * @example
+     * ```js
+     * init({
+     *  // ...
+     *  authType: AuthType.TrustedAuthTokenCookieless,
+     *  getAuthToken: () => {
+     *    return fetch('https://my-backend.app/ts-token')
+     *      .then((response) => response.json())
+     *      .then((data) => data.token);
+     *  }
+     * ```
+     * @version SDK: 1.22.0| ThouhgtSpot: 9.3.0.cl, 9.5.1-sw
      */
     TrustedAuthTokenCookieless = 'AuthServerCookieless',
     /**
@@ -266,6 +299,9 @@ export interface EmbedConfig {
      * [SSO] For SSO Authentication, if `inPopup` is set to true, it will open
      * the SAML auth flow in a popup, instead of redirecting browser in place.
      *
+     * Need to use this with authTriggerContainer. Or manually trigger
+     * the AuthEvent.TRIGGER_SSO_POPUP event on a user interaction.
+     *
      * @default false
      * @version SDK: 1.18.0
      */
@@ -378,13 +414,28 @@ export interface EmbedConfig {
      */
     customizations?: CustomisationsInterface;
     /**
-     * For noRedirect SSO Auth, we need a button which the user
+     * For inPopup SAMLRedirect or OIDCRedirect Auth, we need a button which the user
      * click to trigger the flow. This is the containing element
      * for that button.
      *
+     * @example
+     * ```js
+     * init({
+     *   authType: AuthType.SAMLRedirect,
+     *   inPopup: true,
+     *   authTriggerContainer: '#auth-trigger-container'
+     * })
+     * ```
      * @version SDK: 1.17.0 | ThoughtSpot: *
      */
     authTriggerContainer?: string | HTMLElement;
+    /**
+     * Specify that we want to use the AuthEvent.TRIGGER_SSO_POPUP event to trigger
+     * SAML popup. This is useful when you want to trigger the popup on a custom user
+     * action.
+     *
+     */
+    useEventForSAMLPopup?: boolean;
     /**
      * Text to show in the button which triggers the popup auth flow.
      * Default: "Authorize".
@@ -392,6 +443,22 @@ export interface EmbedConfig {
      * @version SDK: 1.17.0 | ThoughtSpot: *
      */
     authTriggerText?: string;
+    /**
+     * Disable Full App access of Embedded app outside of the iFrame.
+     *
+     * @default true
+     * @version SDK: 1.22.0 | ThoughtSpot: 9.3.0.cl, 9.5.1-sw
+     */
+    blockNonEmbedFullAppAccess?: boolean;
+
+    /**
+     * Host config incase embedded app is inside TS app itself
+     */
+    hostConfig?: {
+        hostUserGuid: string;
+        hostClusterId: string;
+        hostClusterName: string;
+    }
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -450,6 +517,7 @@ export interface ViewConfig {
      * The list of actions to disable from the primary menu, more menu
      * (...), and the contextual menu. These actions will be disabled
      * for the user.
+     * Use this to disable actions.
      *
      * @example
      * ```js
@@ -467,6 +535,7 @@ export interface ViewConfig {
     /**
      * The list of actions to hide from the embedded.
      * This actions will be hidden from the user.
+     * Use this to hide an action.
      *
      * @example
      * ```js
@@ -475,12 +544,16 @@ export interface ViewConfig {
      *   hiddenActions: [Action.Download, Action.Export]
      * });
      * ```
+     * @important
      */
     hiddenActions?: Action[];
     /**
      * The list of actions to display from the primary menu, more menu
      * (...), and the contextual menu. These will be only actions that
      * are visible to the user.
+     * Use this to hide all actions except the ones you want to show.
+     *
+     * Use either this or hiddenActions.
      *
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      * @important
@@ -550,9 +623,19 @@ export interface ViewConfig {
      * Use a pre-rendered iframe from a pool of pre-rendered iframes
      * if available and matches the configuration.
      *
+     * @version SDK: 1.22.0
+     * @hidden
+     *
      * See [docs]() on how to create a prerender pool.
      */
     usePrerenderedIfAvailable?: boolean;
+    /**
+     * Boolean to exclude runtimeFilters in the URL
+     *
+     * @default false
+     * @hidden
+     */
+    excludeRuntimeFiltersfromURL?: boolean;
 }
 
 /**
@@ -805,7 +888,7 @@ export enum EmbedEvent {
      *   )
      * });
      * ```
-     * @return {vizId, clickedPoint} - metadata about point that is clicked
+     * @return viz, clickedPoint - metadata about point that is clicked
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      * @important
      */
@@ -1160,7 +1243,7 @@ export enum HostEvent {
      * ```js
      * searchEmbed.trigger(HostEvent.Search, {
      *   searchQuery: "[sales] by [item type],
-     *   dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
+     *   dataSources: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
      *   execute: true
      * })
      * ```
@@ -1176,9 +1259,18 @@ export enum HostEvent {
      *                     column.
      * @example
      * ```js
-     * searchEmbed.trigger(HostEvent.DrillDown, {
-     *   points: clickedPointData,
-     *   autoDrillDown: true,
+     * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
+     *       console.log(payload);
+     *       const clickedPoint = payload.data.clickedPoint;
+     *       const selectedPoint = payload.data.selectedPoints;
+     *       console.log('>>> called', clickedPoint);
+     *       searchEmbed.trigger(HostEvent.DrillDown, {
+     *             points: {
+     *                  clickedPoint,
+     *                  selectedPoints: selectedPoint
+     *             },
+     *             autoDrillDown: true,
+     *       });
      * })
      * ```
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
@@ -1202,9 +1294,11 @@ export enum HostEvent {
      * @param - an array of ids of visualizations to show, the ids not passed
      *          will be hidden.
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, [
      *  '730496d6-6903-4601-937e-2c691821af3c',
      *  'd547ec54-2a37-4516-a222-2b06719af726'])
+     * ```
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     SetVisibleVizs = 'SetPinboardVisibleVizs',
@@ -1214,10 +1308,12 @@ export enum HostEvent {
      *
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
      *   {columnName: "state",operator: RuntimeFilterOp.EQ,values: ["michigan"]},
      *   {columnName: "item type",operator: RuntimeFilterOp.EQ,values: ["Jackets"]}
      * ])
+     * ```
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      * @important
      */
@@ -1361,7 +1457,7 @@ export enum HostEvent {
      *
      * @example
      * ```js
-     * liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
+     * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
      * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
@@ -1431,10 +1527,14 @@ export enum HostEvent {
      * @param - object - to trigger the action for a specfic visualization
      *   in Liveboard embed, pass in vizId as a key
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Edit)
+     *
      * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger((HostEvent.Edit)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Edit = 'edit',
@@ -1486,10 +1586,14 @@ export enum HostEvent {
      *
      * @param - an object with vizId as a key
      * @example
+     * ```js
      * 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',
@@ -1499,23 +1603,31 @@ export enum HostEvent {
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
      * @example
+     * ```js
      * 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',
+    Delete = 'onDeleteAnswer',
     /**
      * 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
+     * ```js
      * 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',
@@ -1523,11 +1635,15 @@ export enum HostEvent {
      * Triggers the Download action on visualization or search when Displaymode is Chart
      *
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Download, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
+     *
      * vizEmbed.trigger(HostEvent.Download)
+     *
      * searchEmbed.trigger(HostEvent.Download)
-     * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw, Please use DownloadAsPng
+     * ```
+     * @deprecated from SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl ,9.4.1-sw ,Use {@link DownloadAsPng}
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     Download = 'downloadAsPng',
@@ -1538,11 +1654,9 @@ export enum HostEvent {
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
      * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
-     * ```
-     * ```js
+     *
      * vizEmbed.trigger(HostEvent.DownloadAsPng)
-     * ```
-     * ```js
+     *
      * searchEmbed.trigger(HostEvent.DownloadAsPng)
      * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.1-sw
@@ -1552,10 +1666,14 @@ export enum HostEvent {
      * Triggers the downloadAsCSV action on visualization or search
      *
      * @example
+     * ```js
      * 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',
@@ -1563,10 +1681,14 @@ export enum HostEvent {
      * Triggers the downloadAsXLSX action on visualization or search
      *
      * @example
+     * ```js
      * 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',
@@ -1574,8 +1696,11 @@ export enum HostEvent {
      * Triggers the Share action on a liveboard or answer
      *
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Share)
+     *
      * searchEmbed.trigger(HostEvent.Share)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     Share = 'share',
@@ -1583,8 +1708,11 @@ export enum HostEvent {
      * Trigger the Save action on a liveboard or answer
      *
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Save)
+     *
      * searchEmbed.trigger(HostEvent.Save)
+     * ```
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     Save = 'save',
@@ -1593,9 +1721,12 @@ export enum HostEvent {
      *
      * @param - an object with vizId as a key
      * @example
+     * ```js
      * 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
      */
     SyncToSheets = 'sync-to-sheets',
@@ -1604,9 +1735,12 @@ export enum HostEvent {
      *
      * @param - an object with vizId as a key
      * @example
+     * ```js
      * 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',
@@ -1615,9 +1749,12 @@ export enum HostEvent {
      *
      * @param - an object with vizId as a key
      * @example
+     * ```js
      * 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',
@@ -1625,7 +1762,9 @@ export enum HostEvent {
      * Triggers the Reset search in answer
      *
      * @example
-     * searchEmbed.trigger(HostEvent.SearchReset
+     * ```js
+     * searchEmbed.trigger(HostEvent.ResetSearch)
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.0.1-sw
      */
     ResetSearch = 'resetSearch',
@@ -1697,9 +1836,12 @@ export enum Param {
     cookieless = 'cookieless',
     ContextMenuTrigger = 'isContextMenuEnabledOnLeftClick',
     LinkOverride = 'linkOverride',
+    blockNonEmbedFullAppAccess = 'blockNonEmbedFullAppAccess',
     ShowInsertToSlide = 'insertInToSlide',
     PrimaryNavHidden = 'primaryNavHidden',
     HideProfleAndHelp = 'profileAndHelpInNavBarHidden',
+    HideApplicationSwitcher= 'applicationSwitcherHidden',
+    HideOrgSwitcher= 'orgSwitcherHidden',
 }
 
 /**
@@ -1715,7 +1857,7 @@ export enum Param {
  *    ... // other options
  *    visibleActions: [Action.Save, Action.Explore],
  *    disableActions: [Action.Save],
- *    hiddenActions: [Action.Download],
+ *    hiddenActions: [Action.Download], // Set either this or visibleActions
  * })
  * ```
  */
@@ -1836,9 +1978,6 @@ export enum Action {
     DrillEdit = 'context-menu-item-edit',
     EditMeasure = 'context-menu-item-edit-measure',
     Separator = 'context-menu-item-separator',
-    /**
-     * @hidden
-     */
     DrillDown = 'DRILL',
     RequestAccess = 'requestAccess',
     QueryDetailsButtons = 'queryDetailsButtons',
@@ -1929,6 +2068,11 @@ export enum Action {
      * @hidden
      */
     InsertInToSlide = 'insertInToSlide',
+
+    /**
+     * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+     */
+    RenameModalTitleDescription = 'renameModalTitleDescription',
 }
 
 export interface SessionInterface {
@@ -1954,6 +2098,9 @@ export enum PrefetchFeatures {
     VizEmbed = 'VizEmbed',
 }
 
+/**
+ * Enum for options to change context trigger
+ */
 export enum ContextMenuTriggerOptions {
     LEFT_CLICK = 'left-click',
     RIGHT_CLICK = 'right-click',

package/src/utils/processTrigger.spec.ts

@@ -8,7 +8,8 @@ describe('Unit test for processTrigger', () => {
             postMessage: jest.fn(),
         },
     };
-    test('when hostevent is reload, childNode should not be the same as iFrame', async () => {
+    test('when hostevent is reload, reload function should be called with iFrame', async () => {
+        jest.useFakeTimers();
         const iFrameElement = document.createElement('iframe');
         const html = '<body>Foo</body>';
         iFrameElement.src = `data:text/html;charset=utf-8,${encodeURI(html)}`;
@@ -16,9 +17,11 @@ describe('Unit test for processTrigger', () => {
         divFrame.appendChild(iFrameElement);
         const messageType = HostEvent.Reload;
         const thoughtSpotHost = 'http://localhost:3000';
+        const spyReload = jest.spyOn(_processTriggerInstance, 'reload');
         const data = {};
         _processTriggerInstance.processTrigger(iFrameElement, messageType, thoughtSpotHost, data);
-        expect(divFrame.childNodes[0]).not.toBe(iFrameElement);
+        jest.advanceTimersByTime(200);
+        expect(spyReload).toBeCalledWith(iFrameElement);
     });
 
     test('when hostevent is search, postMessage should be called', async () => {

package/src/utils/processTrigger.ts

@@ -6,12 +6,13 @@ import { HostEvent } from '../types';
  *
  * @param iFrame
  */
-function reload(iFrame: HTMLIFrameElement) {
-    const oldFrame = iFrame.cloneNode();
-    const parent = iFrame.parentNode;
-    parent.removeChild(iFrame);
-    parent.appendChild(oldFrame);
-}
+export const reload = (iFrame: HTMLIFrameElement) => {
+    const src = iFrame.src;
+    iFrame.src = '';
+    setTimeout(() => {
+        iFrame.src = src;
+    }, 100);
+};
 
 /**
  * Post Iframe message.

package/src/utils.ts

@@ -212,6 +212,8 @@ export const getCustomisations = (
     return customizations;
 };
 
+export const getRuntimeFilters = (runtimefilters: any) => getFilterQuery(runtimefilters || []);
+
 /**
  * Gets a reference to the DOM node given
  * a selector.