@thoughtspot/visual-embed-sdk 1.29.2 → 1.30.0

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

@@ -1,45 +1,40 @@
 /* eslint-disable dot-notation */
-import * as authInstance from '../auth';
 import { resetCachedAuthToken } from '../authToken';
-import * as config from '../config';
 import {
-    AppEmbed,
     AuthType,
+    init,
     EmbedEvent,
-    LiveboardEmbed,
-    LiveboardViewConfig,
-    PinboardEmbed,
     SearchEmbed,
-    init,
+    PinboardEmbed,
+    LiveboardViewConfig,
+    AppEmbed,
+    LiveboardEmbed,
 } from '../index';
-import * as mixpanelInstance from '../mixpanel-service';
-import { MIXPANEL_EVENT } from '../mixpanel-service';
 import {
-    Action,
-    HomeLeftNavItem,
-    RuntimeFilter,
-    RuntimeFilterOp,
-    HomepageModule,
-    HostEvent,
+    Action, HomeLeftNavItem, RuntimeFilter, RuntimeFilterOp, HomepageModule, HostEvent,
     RuntimeParameter,
 } from '../types';
 import {
-    createRootEleForEmbed,
-    defaultParamsForPinboardEmbed,
     executeAfterWait,
-    expectUrlMatchesWithParams,
     getDocumentBody,
     getIFrameEl,
     getIFrameSrc,
     getRootEl,
-    mockMessageChannel,
     postMessageToParent,
+    defaultParamsForPinboardEmbed,
     waitFor,
+    expectUrlMatchesWithParams,
+    mockMessageChannel,
+    createRootEleForEmbed,
 } from '../test/test-utils';
+import * as config from '../config';
+import * as tsEmbedInstance from './ts-embed';
+import * as mixpanelInstance from '../mixpanel-service';
+import * as authInstance from '../auth';
+import * as baseInstance from './base';
+import { MIXPANEL_EVENT } from '../mixpanel-service';
 import * as authService from '../utils/authService/authService';
 import { logger } from '../utils/logger';
-import * as baseInstance from './base';
-import * as tsEmbedInstance from './ts-embed';
 
 const defaultViewConfig = {
     frameParams: {
@@ -471,10 +466,8 @@ describe('Unit test case for ts embed', () => {
                     hostConfig: undefined,
                     runtimeFilterParams: null,
                     runtimeParameterParams: null,
-                    hiddenHomeLeftNavItems: [
-                        HomeLeftNavItem.Home,
-                        HomeLeftNavItem.MonitorSubscription,
-                    ],
+                    hiddenHomeLeftNavItems:
+                        [HomeLeftNavItem.Home, HomeLeftNavItem.MonitorSubscription],
                     hiddenHomepageModules: [],
                     reorderedHomepageModules: [],
                 },
@@ -704,10 +697,7 @@ describe('Unit test case for ts embed', () => {
                 type: EmbedEvent.APP_INIT,
                 data: {},
             };
-            const searchEmbed = new SearchEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                preRenderId: 'test',
-            });
+            const searchEmbed = new SearchEmbed(getRootEl(), { ...defaultViewConfig, preRenderId: 'test' });
             searchEmbed.preRender();
             const mockPort: any = {
                 postMessage: jest.fn(),
@@ -764,10 +754,7 @@ describe('Unit test case for ts embed', () => {
                 type: EmbedEvent.AuthExpire,
                 data: {},
             };
-            const searchEmbed = new SearchEmbed(getRootEl(), {
-                ...defaultViewConfig,
-                preRenderId: 'test',
-            });
+            const searchEmbed = new SearchEmbed(getRootEl(), { ...defaultViewConfig, preRenderId: 'test' });
             jest.spyOn(baseInstance, 'notifyAuthFailure');
             searchEmbed.preRender();
             const mockPort: any = {
@@ -1271,7 +1258,7 @@ describe('Unit test case for ts embed', () => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
-                    + `&foo=bar&baz=1&bool=true${defaultParamsPost}#/home`,
+                + `&foo=bar&baz=1&bool=true${defaultParamsPost}#/home`,
             );
         });
 
@@ -1287,7 +1274,7 @@ describe('Unit test case for ts embed', () => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
-                    + `&showAlerts=true${defaultParamsPost}#/home`,
+                + `&showAlerts=true${defaultParamsPost}#/home`,
             );
         });
         it('Sets the locale param', async () => {
@@ -1302,7 +1289,7 @@ describe('Unit test case for ts embed', () => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
-                    + `&locale=ja-JP${defaultParamsPost}#/home`,
+                + `&locale=ja-JP${defaultParamsPost}#/home`,
             );
         });
         it('Sets the iconSprite url', async () => {
@@ -1319,7 +1306,7 @@ describe('Unit test case for ts embed', () => {
             expectUrlMatchesWithParams(
                 getIFrameSrc(),
                 `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}`
-                    + `&iconSprite=iconSprite.com${defaultParamsPost}#/home`,
+                + `&iconSprite=iconSprite.com${defaultParamsPost}#/home`,
             );
         });
 

package/src/types.ts

@@ -136,7 +136,6 @@ export enum AuthType {
      *      .then((data) => data.token);
      *  }
      * });
-     * });
      * ```
      */
     TrustedAuthToken = 'AuthServer',
@@ -468,7 +467,6 @@ export interface EmbedConfig {
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw*
      */
     suppressSearchEmbedBetaWarning?: boolean;
-
     /**
      * Hide `beta` alert warning message for SageEmbed.
      *
@@ -529,7 +527,6 @@ export interface EmbedConfig {
     /**
      * Pendo API key to enable Pendo tracking to your own subscription, the key
      * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
-     *
      * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
      */
     pendoTrackingKey?: string;
@@ -884,8 +881,6 @@ export interface ViewConfig {
      * Hide the home page modules
      * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
      *
-     *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -903,7 +898,6 @@ export interface ViewConfig {
      * reordering the home page modules
      * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
      *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -947,8 +941,6 @@ export interface ViewConfig {
      * })
      * ```
      *
-     *
-     *
      * **Note**: This option does not apply to the classic homepage.
      * To access the updated modular homepage, set
      * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -1125,6 +1117,10 @@ export enum RuntimeFilterOp {
      * Is included in this list of values
      */
     IN = 'IN',
+    /**
+     * Is not included in this list of values
+     */
+    NOT_IN = 'NOT_IN',
 }
 
 /**
@@ -1396,20 +1392,14 @@ export enum EmbedEvent {
     /**
      * An error has occurred. This event is fired for the following error types:
      *
-     * `API`: API call failure error.
-     *
-     * `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
-     * mode.
+     * `API` - API call failure error.
+     * `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
+     * mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
+     * filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
+     * `INVALID_DATE_VALUE` - Invalid date value error.
+     * `INVALID_OPERATOR` - Use of invalid operator during filter application.
      *
-     * `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
-     *
-     * `NON_EXIST_FILTER`: Error due to a non-existent filter.
-     *
-     * `INVALID_DATE_VALUE`: Invalid date value error.
-     *
-     * `INVALID_OPERATOR`: Use of invalid operator during filter application.
-     *
-     * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
+     * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
      * @returns error - An error object or message
      * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
      * @example
@@ -1509,7 +1499,7 @@ export enum EmbedEvent {
     /**
      * Emitted when the embed does not have cookie access. This happens
      * when Safari and other Web browsers block third-party cookies
-     * are blocked by default.
+     * are blocked by default. `NoCookieAccess` can trigger
      * @example
      *```js
      * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -1548,7 +1538,7 @@ export enum EmbedEvent {
     /**
      * Emitted when the Liveboard shell loads.
      * You can use this event as a hook to trigger
-     * actions on the rendered Liveboard.
+     * other events on the rendered Liveboard.
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1599,7 +1589,7 @@ export enum EmbedEvent {
     /**
      * Emitted when the download action is triggered on an answer
      *
-     * **Note**:  This event is deprecated in v1.21.0.
+     * **Note**: This event is deprecated in v1.21.0.
      * To fire an event when a download action is initiated on a chart or table,
      * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
      * or `EmbedEvent.DownloadAsXLSX`
@@ -1676,7 +1666,7 @@ export enum EmbedEvent {
      * //emit when action starts
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)}, {start: true })
-     * //emit when action is completed
+     * //trigger when action is completed
      * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
      *    console.log('delete answer', payload)})
      *```
@@ -1774,7 +1764,6 @@ export enum EmbedEvent {
     /**
      * Emitted when a user clicks the **Update TML** action on
      * embedded Liveboard.
-     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1786,7 +1775,6 @@ export enum EmbedEvent {
     /**
      * Emitted when a user clicks the **Edit TML** action
      * on an embedded Liveboard.
-     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1986,7 +1974,7 @@ export enum EmbedEvent {
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
      * @example
      *```js
-     * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
+     * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
      *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
      */
@@ -2019,13 +2007,6 @@ export enum EmbedEvent {
      * })
      *
      * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
-     * @example
-     *
-     *```js
-     * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
-     *    console.log('payload', payload);
-     * })
-     *```
      */
     FilterChanged = 'filterChanged',
     /**
@@ -2119,12 +2100,12 @@ export enum EmbedEvent {
      *```
      * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
      */
-    OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
-    /**
-     * Emitted when runtime parameters changes
-     * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
-     */
-    ParameterChanged = 'ParameterChanged',
+     OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
+     /**
+      * Emitted when runtime parameters changes
+      * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
+      */
+     ParameterChanged = 'ParameterChanged'
 }
 
 /**
@@ -2265,8 +2246,8 @@ export enum HostEvent {
      * _String_. The name of the column to filter on.
      *
      * `operator`
-     *  Runtime filter operator to apply. For information,
-     *  see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
+     * Runtime filter operator to apply. For information,
+     * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
      *
      * `values`
      * List of operands. Some operators such as EQ, LE allow a single value, whereas
@@ -2396,20 +2377,16 @@ export enum HostEvent {
     /**
      * Trigger the **Export TML** action on an embedded Liveboard or
      * Answer.
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.ExportTML)
      * ```
-     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     ExportTML = 'exportTSL',
     /**
      * Trigger the **Edit TML** action on an embedded Liveboard or
      * saved Answers in the full application embedding.
-     *
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -2432,7 +2409,6 @@ export enum HostEvent {
      *
      * **NOTE**: The **Download** > **PDF** action is available on
      * visualizations and Answers if the data is in tabular format.
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -2504,15 +2480,12 @@ export enum HostEvent {
      * on a Liveboard.
      *
      * This event is not supported in visualization embed and search embed.
-     *
      * @param - object - To trigger the action for a specific visualization
      * in Liveboard embed, pass in `vizId` as a key.
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Edit)
      * ```
-     * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
      * '730496d6-6903-4601-937e-2c691821af3c'})
@@ -2775,7 +2748,6 @@ export enum HostEvent {
     /**
      * Get details of filters applied on the Liveboard.
      * Returns arrays containing Liveboard filter and runtime filter elements.
-     *
      * @example
      * ```js
      * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -2802,7 +2774,6 @@ export enum HostEvent {
      * `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[Developer Documentation].
-     *
      * @example
      * ```js
      *
@@ -3127,7 +3098,6 @@ export enum Action {
      * The **Save as View** action on the Answer
      * page. Saves an Answer as a View object in the full
      * application embedding mode.
-     *
      * @example
      * ```js
      * disabledActions: [Action.SaveAsView]
@@ -3331,13 +3301,10 @@ export enum Action {
     DownloadAsPng = 'downloadAsPng',
     /**
      *
-     * The **Download PDF** action that downloads a Liveboard,
-     * visualization, or Answer as a PDF file.
+     *The **Download PDF** action that downloads a Liveboard,
+     *visualization, or Answer as a PDF file.
      *
      *
-     * **NOTE**: The **Download** > **PDF** action is available on
-     * visualizations and Answers if the data is in tabular format.
-     *
      ***NOTE**: The **Download** > **PDF** action is available on
      *visualizations and Answers if the data is in tabular format.
      * @example
@@ -3588,7 +3555,6 @@ export enum Action {
     /**
      * The **Delete** action for Answers in the full application
      * embedding mode.
-     *
      * @example
      * ```js
      * disabledActions: [Action.AnswerDelete]

package/src/utils/graphql/answerService/answerService.spec.ts

@@ -1,7 +1,9 @@
 import 'jest-fetch-mock';
 import { AuthType, RuntimeFilterOp, VizPoint } from '../../../types';
 import { AnswerService } from './answerService';
-import { getAnswerData, removeColumns, addFilter } from './answer-queries';
+import {
+    getAnswerData, removeColumns, addFilter, addColumns,
+} from './answer-queries';
 import * as authTokenInstance from '../../../authToken';
 import * as tokenizedFetch from '../../../tokenizedFetch';
 import * as embedConfigInstance from '../../../embed/embedConfig';
@@ -352,4 +354,54 @@ describe('Answer service tests', () => {
         const answer = await answerService.getAnswer();
         expect(answer.sources[0].header.guid).toBe('source1');
     });
+
+    test('Add columns by name should call the right API', async () => {
+        fetchMock.mockResponses(
+            JSON.stringify({
+                data: {
+                    getSourceDetailById: [{
+                        columns: [{
+                            id: 'id1',
+                            name: 'col1',
+                        }, {
+                            id: 'id2',
+                            name: 'col2',
+                        }],
+                    }],
+                },
+            }),
+            JSON.stringify({
+                data: {
+                    Answer__addColumn: {
+                        id: {
+                            genNo: 2,
+                        },
+                    },
+                },
+            }),
+        );
+        const answerService = createAnswerService({
+            sources: [{
+                header: {
+                    guid: 'source1',
+                },
+            }],
+        });
+        const session = await answerService.addColumnsByName(['col1']);
+        expect(fetchMock).toHaveBeenCalledWith(
+            'https://tshost/prism/?op=AddColumns',
+            expect.objectContaining({
+                body: JSON.stringify({
+                    operationName: 'AddColumns',
+                    query: addColumns,
+                    variables: {
+                        session: defaultSession,
+                        columns: [{
+                            logicalColumnId: 'id1',
+                        }],
+                    },
+                }),
+            }),
+        );
+    });
 });

package/src/utils/graphql/answerService/answerService.ts

@@ -126,14 +126,14 @@ export class AnswerService {
      * ```js
      * embed.on(EmbedEvent.Data, async (e) => {
      *    const service = await embed.getAnswerService();
-     *    await service.addColumnsByNames([
+     *    await service.addColumnsByName([
      *      "col name 1",
      *      "col name 2"
      *    ]);
      *    console.log(await service.fetchData());
      * });
      */
-    public async addColumnsByNames(columnNames: string[]) {
+    public async addColumnsByName(columnNames: string[]) {
         const sourceDetail = await this.getSourceDetail();
         const columnGuids = getGuidsFromColumnNames(sourceDetail, columnNames);
         return this.addColumns([...columnGuids]);

package/src/utils/graphql/graphql-request.ts

@@ -1,3 +1,4 @@
+import { tokenizedFetch } from '../../tokenizedFetch';
 import { getOperationNameFromQuery } from '../../utils';
 
 /**
@@ -21,7 +22,7 @@ export async function graphqlQuery({
 }) {
     const operationName = getOperationNameFromQuery(query);
     try {
-        const response = await fetch(`${thoughtSpotHost}/prism/?op=${operationName}`, {
+        const response = await tokenizedFetch(`${thoughtSpotHost}/prism/?op=${operationName}`, {
             method: 'POST',
             headers: {
                 'content-type': 'application/json;charset=UTF-8',