@thoughtspot/visual-embed-sdk 1.8.0-plugins.6 → 1.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.8.0-plugins.6",
+    "version": "1.8.0",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -34,7 +34,7 @@
         "test": "npm run test-sdk && npm run test-docs && npx istanbul-merge --out ./coverage/coverage.json ./coverage/docs/coverage-final.json ./coverage/sdk/coverage-final.json && npx istanbul report --include ./coverage/coverage.json --dir ./coverage lcov",
         "posttest": "cat ./coverage/lcov.info | coveralls",
         "prepublishOnly": "npm run test; npm run tsc; npm run bundle-dts; npm run build",
-        "publish-dev": "npm publish --tag plugins",
+        "publish-dev": "npm publish --tag dev",
         "publish-prod": "npm publish --tag latest"
     },
     "peerDependencies": {
@@ -65,6 +65,7 @@
         "asciidoctor": "^2.2.1",
         "babel-jest": "^26.6.3",
         "babel-preset-gatsby": "^1.10.0",
+        "classnames": "^2.3.1",
         "command-line-args": "^5.1.1",
         "coveralls": "^3.1.0",
         "dts-bundle": "0.7.3",

package/src/embed/base.ts

@@ -19,12 +19,13 @@ export let authPromise: Promise<void>;
 /**
  * Perform authentication on the ThoughtSpot app as applicable.
  */
-export const handleAuth = (): void => {
+export const handleAuth = (): Promise<void> => {
     const authConfig = {
         ...config,
         thoughtSpotHost: getThoughtSpotHost(config),
     };
     authPromise = authenticate(authConfig);
+    return authPromise;
 };
 
 export const getEmbedConfig = (): EmbedConfig => config;
@@ -55,8 +56,10 @@ export const prefetch = (url?: string): void => {
  * authentication if applicable.
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.
+ *
+ * @returns authPromise Promise which resolves when authentication is complete.
  */
-export const init = (embedConfig: EmbedConfig): void => {
+export const init = (embedConfig: EmbedConfig): Promise<void> => {
     config = embedConfig;
     handleAuth();
 
@@ -68,6 +71,7 @@ export const init = (embedConfig: EmbedConfig): void => {
     if (config.callPrefetch) {
         prefetch(config.thoughtSpotHost);
     }
+    return authPromise;
 };
 
 let renderQueue: Promise<any> = Promise.resolve();

package/src/embed/liveboard.ts

@@ -35,7 +35,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      * This is the minimum height(in pixels) for a full height Liveboard.
      * Setting this height helps resolves issues with empty Liveboards and
      * other screens navigable from a Liveboard.
-     * @version 1.5.0 or later
+     * *_since 1.5.0_
      * @default 500
      */
     defaultHeight?: number;

package/src/embed/search.ts

@@ -49,6 +49,10 @@ 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.
      */
@@ -80,9 +84,6 @@ export interface SearchViewConfig extends ViewConfig {
 export const HiddenActionItemByDefaultForSearchEmbed = [
     Action.EditACopy,
     Action.SaveAsView,
-    Action.UpdateTML,
-    Action.EditTML,
-    Action.AnswerDelete,
 ];
 
 /**
@@ -126,6 +127,7 @@ export class SearchEmbed extends TsEmbed {
     private getIFrameSrc(answerId: string, dataSources?: string[]) {
         const {
             hideResults,
+            expandAllDataSource,
             enableSearchAssist,
             forceTable,
             searchOptions,

package/src/embed/ts-embed.spec.ts

@@ -34,9 +34,6 @@ describe('Unit test case for ts embed', () => {
         mixpanelInstance,
         'uploadMixpanelEvent',
     );
-    beforeEach(() => {
-        document.body.innerHTML = getDocumentBody();
-    });
     describe('when thoughtSpotHost have value and authPromise return success response', () => {
         beforeAll(() => {
             init({
@@ -46,6 +43,7 @@ describe('Unit test case for ts embed', () => {
         });
 
         beforeEach(() => {
+            document.body.innerHTML = getDocumentBody();
             jest.spyOn(window, 'addEventListener').mockImplementationOnce(
                 (event, handler, options) => {
                     handler({
@@ -100,6 +98,7 @@ describe('Unit test case for ts embed', () => {
         });
 
         beforeEach(() => {
+            document.body.innerHTML = getDocumentBody();
             jest.spyOn(
                 baseInstance,
                 'getAuthPromise',
@@ -207,6 +206,10 @@ describe('Unit test case for ts embed', () => {
             });
         });
 
+        beforeEach(() => {
+            document.body.innerHTML = getDocumentBody();
+        });
+
         test('Error should be true', async () => {
             const tsEmbed = new SearchEmbed(getRootEl(), {});
             tsEmbed.render();
@@ -297,30 +300,4 @@ describe('Unit test case for ts embed', () => {
             );
         });
     });
-
-    describe('additionalFlags config', () => {
-        beforeEach(() => {
-            jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
-                () => 'http://tshost',
-            );
-        });
-        it('should set the additional flags correctly on the iframe src', async () => {
-            const appEmbed = new AppEmbed(getRootEl(), {
-                frameParams: {
-                    width: '100%',
-                    height: '100%',
-                },
-                additionalFlags: {
-                    foo: 'bar',
-                    baz: 1,
-                    bool: true,
-                },
-            });
-            await appEmbed.render();
-            expect(getIFrameSrc()).toBe(
-                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}` +
-                    '&foo=bar&baz=1&bool=true#/home',
-            );
-        });
-    });
 });

package/src/embed/ts-embed.ts

@@ -28,12 +28,10 @@ import {
     RuntimeFilter,
     Param,
     EmbedConfig,
-    Plugin,
 } from '../types';
 import { uploadMixpanelEvent, MIXPANEL_EVENT } from '../mixpanel-service';
 import { getProcessData } from '../utils/processData';
 import { processTrigger } from '../utils/processTrigger';
-// eslint-disable-next-line import/no-cycle
 import pkgInfo from '../../package.json';
 import { getAuthPromise, getEmbedConfig, renderInQueue } from './base';
 
@@ -104,7 +102,7 @@ export interface ViewConfig {
     /**
      * The list of actions to display from the primary menu, more menu
      * (...), and the contextual menu.
-     * @version 1.6.0 or later
+     * * _since 1.6.0_
      */
     visibleActions?: Action[];
     /**
@@ -112,20 +110,6 @@ export interface ViewConfig {
      * visualization, or Liveboard.
      */
     runtimeFilters?: RuntimeFilter[];
-    /**
-     * 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.
-     * @version 1.8.0
-     */
-    additionalFlags?: { [key: string]: string | number | boolean };
-    /**
-     * Provide a list of plugins, the plugins are executed in the order
-     * provided below,
-     *
-     * @version alpha
-     */
-    plugins?: Plugin[];
 }
 
 /**
@@ -149,8 +133,6 @@ export class TsEmbed {
 
     protected embedConfig: EmbedConfig;
 
-    protected hasVizConfigOverride: boolean;
-
     /**
      * The ThoughtSpot hostname or IP address
      */
@@ -196,8 +178,6 @@ export class TsEmbed {
         this.isError = false;
         this.viewConfig = viewConfig;
         this.shouldEncodeUrlQueryParams = this.embedConfig.shouldEncodeUrlQueryParams;
-        this.registerPlugins(viewConfig?.plugins);
-
         if (!this.embedConfig.suppressNoCookieAccessAlert) {
             this.on(EmbedEvent.NoCookieAccess, () => {
                 // eslint-disable-next-line no-alert
@@ -208,18 +188,6 @@ export class TsEmbed {
         }
     }
 
-    private registerPlugins(plugins: Plugin[]) {
-        if (!plugins) {
-            return;
-        }
-        plugins.forEach((plugin) => {
-            Object.keys(plugin.handlers).forEach((eventName: EmbedEvent) => {
-                const listener = plugin.handlers[eventName];
-                this.on(eventName, listener);
-            });
-        });
-    }
-
     /**
      * Gets a reference to the root DOM node where
      * the embedded content will appear.
@@ -359,7 +327,6 @@ export class TsEmbed {
             disabledActionReason,
             hiddenActions,
             visibleActions,
-            additionalFlags,
         } = this.viewConfig;
 
         if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
@@ -381,12 +348,6 @@ export class TsEmbed {
         if (Array.isArray(visibleActions)) {
             queryParams[Param.VisibleActions] = visibleActions;
         }
-        if (this.hasVizConfigOverride) {
-            queryParams[Param.hasVizConfigOverride] = true;
-        }
-        if (additionalFlags && additionalFlags.constructor.name === 'Object') {
-            Object.assign(queryParams, additionalFlags);
-        }
         return queryParams;
     }
 
@@ -540,7 +501,7 @@ export class TsEmbed {
     ): void {
         const callbacks = this.eventHandlerMap.get(eventType) || [];
         callbacks.forEach((callback) =>
-            callback.call(this, data, (payload) => {
+            callback(data, (payload) => {
                 this.triggerEventOnPort(eventPort, payload);
             }),
         );
@@ -622,10 +583,6 @@ export class TsEmbed {
             );
         }
 
-        if (messageType === EmbedEvent.GetVizConfigOverrides) {
-            this.hasVizConfigOverride = true;
-        }
-
         const callbacks = this.eventHandlerMap.get(messageType) || [];
         callbacks.push(callback);
         this.eventHandlerMap.set(messageType, callbacks);

package/src/index.ts

@@ -25,7 +25,6 @@ import {
     DataSourceVisualMode,
     Action,
     EmbedConfig,
-    Plugin,
 } from './types';
 
 export {
@@ -48,5 +47,4 @@ export {
     SearchViewConfig,
     LiveboardViewConfig,
     AppViewConfig,
-    Plugin,
 };

package/src/react/index.spec.tsx

@@ -31,7 +31,7 @@ describe('React Components', () => {
             await waitFor(() => getIFrameEl(container));
 
             expect(getIFrameSrc(container)).toBe(
-                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22editACopy%22,%22saveAsView%22,%22updateTSL%22,%22editTSL%22,%22onDeleteAnswer%22]&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`,
+                `http://${thoughtSpotHost}/?hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}&hideAction=[%22editACopy%22,%22saveAsView%22]&dataSourceMode=hide&useLastSelectedSources=false&isSearchEmbed=true#/embed/answer`,
             );
         });
 

package/src/types.ts

@@ -68,6 +68,11 @@ export interface EmbedConfig {
      * and returns a Promise that resolves to the `auth token` string.
      * For trusted authentication, the `authEndpoint` or `getAuthToken`
      * attribute is required.
+     *
+     * It is advisable to fetch a new token inside this method and not
+     * reuse and older issued token, as because when auth expires this is
+     * called again and if it is called with an older token the authentication
+     * will not succeed.
      */
     getAuthToken?: () => Promise<string>;
     /**
@@ -114,7 +119,7 @@ export interface EmbedConfig {
 
     /**
      * Re-login when session expires with the previous login options
-     * @default true
+     * @default false
      */
     autoLogin?: boolean;
 
@@ -135,7 +140,6 @@ export interface EmbedConfig {
 
     /**
      * Dynamic CSS Url to be injected in the loaded application.
-     * You would also need to set `style-src` in the CSP settings.
      * @version 1.6.0 or later
      * @default ''
      */
@@ -283,39 +287,18 @@ export enum EmbedEvent {
      * @return dataSourceIds - the list of data sources
      */
     DataSourceSelected = 'dataSourceSelected',
-    /**
-     * One or more data columns have been selected.
-     * @return columnIds - the list of columns
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.2.0.cl
-     */
-    AddRemoveColumns = 'addRemoveColumns',
     /**
      * A custom action has been triggered
      * @return actionId - The id of the custom action
      * @return data - The answer or Liveboard data
      */
     CustomAction = 'customAction',
-    /**
-     * A click has been triggered on table/chart
-     * @return ContextMenuInputPoints - data point that is double clicked
-     * @version 1.10.0
-     */
-    VizPointClick = 'vizPointClick',
-
     /**
      * A double click has been triggered on table/chart
      * @return ContextMenuInputPoints - data point that is double clicked
      * @version 1.5.0 or later
      */
     VizPointDoubleClick = 'vizPointDoubleClick',
-
-    /**
-     * Event troggered when rendering a chart, call the supplied
-     * callback with the config overrides.
-     * @version 1.10.0
-     */
-    GetVizConfigOverrides = 'getVizConfigOverrides',
-
     /**
      * An error has occurred.
      * @return error - An error object or message
@@ -418,17 +401,11 @@ export enum HostEvent {
      */
     SetVisibleVizs = 'SetPinboardVisibleVizs',
     /**
-     * Update the runtime filters. The runtime filters passed here are extended
-     * on to the existing runtime filters if they exist.
+     * Update the runtime filters
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
      * @version 1.8.0 or later
      */
     UpdateRuntimeFilters = 'UpdateRuntimeFilters',
-    /**
-     * Highlight the point in the chart defined by the InputPoint passed.
-     * @verion 1.10.0
-     */
-    HighlightPoint = 'HighlightPoint',
 }
 
 /**
@@ -459,6 +436,7 @@ export enum DataSourceVisualMode {
 export enum Param {
     DataSources = 'dataSources',
     DataSourceMode = 'dataSourceMode',
+    ExpandAllDataSource = 'expandAllDataSource',
     DisableActions = 'disableAction',
     DisableActionReason = 'disableHint',
     ForceTable = 'forceTable',
@@ -482,7 +460,6 @@ export enum Param {
     ViewPortWidth = 'viewPortWidth',
     VisibleActions = 'visibleAction',
     CustomCSSUrl = 'customCssUrl',
-    hasVizConfigOverride = 'hasVizConfigOverride',
 }
 
 /**
@@ -536,6 +513,10 @@ export enum Action {
     PinboardInfo = 'pinboardInfo',
     LiveboardInfo = 'pinboardInfo',
     SendAnswerFeedback = 'sendFeedback',
+    /**
+     * @deprecated Will be removed in next version
+     */
+    CustomAction = 'customAction',
     DownloadEmbraceQueries = 'downloadEmbraceQueries',
     Pin = 'pin',
     AnalysisInfo = 'analysisInfo',
@@ -551,26 +532,6 @@ export enum Action {
     DrillDown = 'DRILL',
     RequestAccess = 'requestAccess',
     QueryDetailsButtons = 'queryDetailsButtons',
-    /**
-     * @version SDK: 1.8.0 | ThoughtSpot: 8.1.0.cl
-     */
-    Monitor = 'createMonitor',
-    /**
-     * @version SDK: 1.8.0 | ThoughtSpot: 8.1.0.cl
-     */
-    AnswerDelete = 'onDeleteAnswer',
-    /**
-     * @version SDK: 1.8.0 | ThoughtSpot: 8.1.0.cl
-     */
-    AnswerChartSwitcher = 'answerChartSwitcher',
-    /**
-     * @version SDK: 1.8.0 | ThoughtSpot: 8.1.0.cl
-     */
-    AddToFavorites = 'addToFavorites',
-    /**
-     * @version SDK: 1.8.0 | ThoughtSpot: 8.1.0.cl
-     */
-    EditDetails = 'editDetails',
 }
 
 export interface SessionInterface {
@@ -588,10 +549,3 @@ export enum OperationType {
 export interface AnswerServiceType {
     getAnswer?: (offset: number, batchSize: number) => any;
 }
-
-export interface Plugin {
-    name: string;
-    handlers: {
-        [key in EmbedEvent]?: (payload: any, cb: (data: any) => void) => void;
-    };
-}

package/src/utils/processData.ts

@@ -39,7 +39,7 @@ function processAuthInit(e: any) {
 }
 
 function processAuthExpire(e: any) {
-    const { autoLogin = true } = getEmbedConfig(); // Set default to true
+    const { autoLogin = false } = getEmbedConfig(); // Set default to false
     if (autoLogin) {
         handleAuth();
     }

package/src/utils/plugin.ts

@@ -1,2 +0,0 @@
-
-