@thoughtspot/visual-embed-sdk 1.28.4 → 1.28.5

package/lib/src/visual-embed-sdk.d.ts

@@ -2047,6 +2047,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
                 */
             currencyFormat?: string;
+            /**
+                * This flag is used to disable the token verification in the SDK.
+                * Enabling this flag will also disable the caching of the token.
+                *
+                * @hidden
+                *
+                * @example
+                * ```js
+                * init({
+                *   ...embedConfig,
+                *   disableTokenVerification : true
+                * })
+                * ```
+                *
+                * @version SDK: 1.28.5 | Thoughtspot: *
+                */
+            disableTokenVerification?: boolean;
     }
     export interface LayoutConfig {
     }
@@ -2697,6 +2714,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Authentication has either succeeded or failed.
                 *
+                * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+                *
                 * @example
                 *```js
                 * appEmbed.on(EmbedEvent.AuthInit, payload => {
@@ -2710,6 +2729,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * The embed object container has loaded.
                 *
                 * @returns timestamp - The timestamp when the event was generated.
+                *
+                * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
                 * @example
                 *```js
                 * liveboardEmbed.on(EmbedEvent.Load, hideLoader)
@@ -2724,6 +2745,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * Data pertaining to answer or Liveboard is received
                 *
                 * @return data - The answer or Liveboard data
+                *
+                * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
                 * @example
                 *```js
                 * liveboardEmbed.on(EmbedEvent.Data, payload => {
@@ -2742,6 +2765,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Search query has been updated by the user.
                 *
+                * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
                 * @example
                 *```js
                 * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
@@ -2751,12 +2775,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * A drill-down operation has been performed.
                 *
+                * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+                *
                 * @returns additionalFilters - Any additional filters applied
                 * @returns drillDownColumns - The columns on which drill down was performed
                 * @returns nonFilteredColumns - The columns that were not filtered
                 * @example
                 *```js
-                * searchEmbed.trigger(EmbedEvent.DrillDown, {
+                * searchEmbed.on(EmbedEvent.DrillDown, {
                 *    points: {
                 *        clickedPoint,
                 *        selectedPoints: selectedPoint
@@ -2789,6 +2815,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * One or more data sources have been selected.
                 *
                 * @returns dataSourceIds - the list of data sources
+                *
+                * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
                 * @example
                 * ```js
                 * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
@@ -2816,6 +2844,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @returns actionId - ID of the custom action
                 * @returns payload {@link CustomActionPayload} - Response payload with the
                 * Answer or Liveboard data
+                *
+                * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
                 * @example
                 * ```js
                 * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -2863,22 +2893,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * An error has occurred. This event is fired for the following error types:
                 *
-                *  API - API call failure error.
+                * `API`: API call failure error.
                 *
-                *  FULLSCREEN - Error when presenting a Liveboard or visualization in full screen
-                *  mode.
+                * `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.
+                * `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
                 *
-                *  NON_EXIST_FILTER - Error due to a non-existent filter.
+                * `NON_EXIST_FILTER`: Error due to a non-existent filter.
                 *
-                *  INVALID_DATE_VALUE - Invalid date value error.
+                * `INVALID_DATE_VALUE`: Invalid date value error.
                 *
-                *  INVALID_OPERATOR - Use of invalid operator during filter application.
+                * `INVALID_OPERATOR`: Use of invalid operator during filter application.
                 *
-                *  For more information, see [Developer Documentation](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
                 * ```js
                 * // API error
@@ -2904,6 +2935,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * The embedded object has sent an alert.
                 *
                 * @returns alert - An alert object
+                *
+                * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
+                *
                 * @example
                 * ```js
                 * searchEmbed.on(EmbedEvent.Alert)
@@ -2913,6 +2947,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * The ThoughtSpot auth session has expired.
                 *
+                * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
+                *
                 * @example
                 *```js
                 * appEmbed.on(EmbedEvent.AuthExpire, showAuthExpired)
@@ -2966,6 +3002,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Detects the route change.
                 *
+                * @version SDK: 1.7.0 | ThoughtSpot: 8.0.0.cl, 8.4.1.sw
                 * @example
                 *```js
                 * searchEmbed.on(EmbedEvent.RouteChange, payload =>
@@ -2982,7 +3019,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * 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. `NoCookieAccess` can trigger
+                * are blocked by default.
                 *
                 * @example
                 *```js
@@ -3025,7 +3062,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * Emitted when the Liveboard shell loads.
                 * You can use this event as a hook to trigger
-                * other events on the rendered Liveboard.
+                * actions on the rendered Liveboard.
                 *
                 * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
                 * @example
@@ -3046,8 +3083,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             LiveboardRendered = "PinboardRendered",
             /**
-                * This can be used to register an event listener which
-                * is triggered on all events.
+                * Emits all events.
                 *
                 * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
                 * @example
@@ -3064,13 +3100,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //Emit when action starts
                 *  searchEmbed.on(EmbedEvent.Save, payload => {
                 *    console.log('Save', payload)
                 *  }, {
                 *    start: true
                 * })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.Save, payload => {
                 *    console.log('Save', payload)
                 * })
@@ -3080,7 +3116,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * 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`
@@ -3088,7 +3124,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.Download, {
+                * liveboardEmbed.on(EmbedEvent.Download, {
                 * vizId: '730496d6-6903-4601-937e-2c691821af3c'
                 * })
                 *```
@@ -3100,10 +3136,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
                 *   console.log('download PNG', payload)}, {start: true })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
                 *   console.log('download PNG', payload)})
                 *```
@@ -3115,10 +3151,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
                 *   console.log('download PDF', payload)}, {start: true })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
                 *   console.log('download PDF', payload)})
                 *```
@@ -3130,10 +3166,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
                 *   console.log('download CSV', payload)}, {start: true })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.DownloadAsCSV, payload => {
                 *    console.log('download CSV', payload)})
                 *```
@@ -3145,10 +3181,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
                 *   console.log('download Xlsx', payload)}, { start: true })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
                 *   console.log('download Xlsx', payload)})
                 *```
@@ -3160,10 +3196,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
                 *    console.log('delete answer', payload)}, {start: true })
-                * //trigger when action is completed
+                * //emit when action is completed
                 * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
                 *    console.log('delete answer', payload)})
                 *```
@@ -3175,13 +3211,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * searchEmbed.on(EmbedEvent.Pin, payload => {
                 *    console.log('pin', payload)
                 * }, {
                 * start: true
                 * })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.Pin, payload => {
                 *    console.log('pin', payload)
                 * })
@@ -3194,13 +3230,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
                 *   console.log('SpotIQAnalyze', payload)
                 * }, {
                 * start: true
                 * })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.SpotIQAnalyze, payload => {
                 *   console.log('SpotIQ analyze', payload)
                 * })
@@ -3213,13 +3249,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * searchEmbed.on(EmbedEvent.Share, payload => {
                 *    console.log('Share', payload)
                 * }, {
                 * start: true
                 * })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.Share, payload => {
                 *   console.log('Share', payload)
                 * })
@@ -3294,10 +3330,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * searchEmbed.on(EmbedEvent.ExportTML, payload => {
                 *     console.log('Export TML', payload)}, { start: true })
-                * //trigger when action ends
+                * //emit when action ends
                 * searchEmbed.on(EmbedEvent.ExportTML, payload => {
                 *     console.log('Export TML', payload)})
                 *```
@@ -3321,10 +3357,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
                 * @example
                 *```js
-                * //trigger when action starts
+                * //emit when action starts
                 * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
                 *    console.log('Copy and edit', payload)}, {start: true })
-                * //trigger when action ends
+                * //emit when action ends
                 * appEmbed.on(EmbedEvent.CopyAEdit, payload => {
                 *    console.log('Copy and edit', payload)})
                 *```
@@ -3426,7 +3462,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.Present)
+                * liveboardEmbed.on(EmbedEvent.Present)
                 *```
                 * @example
                 *```js
@@ -3442,7 +3478,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(EmbedEvent.Delete,
+                * liveboardEmbed.on(EmbedEvent.Delete,
                 *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -3453,7 +3489,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(EmbedEvent.SchedulesList)
+                * liveboardEmbed.on(EmbedEvent.SchedulesList)
                 *```
                 */
             SchedulesList = "schedule-list",
@@ -3463,7 +3499,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(EmbedEvent.Cancel)
+                * liveboardEmbed.on(EmbedEvent.Cancel)
                 *```
                 */
             Cancel = "cancel",
@@ -3473,7 +3509,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(EmbedEvent.Explore,  {
+                * liveboardEmbed.on(EmbedEvent.Explore,  {
                 *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -3484,7 +3520,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(EmbedEvent.CopyLink, {
+                * liveboardEmbed.on(EmbedEvent.CopyLink, {
                 *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -3495,7 +3531,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
                 * @example
                 *```js
-                * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
+                * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
                 *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
                 *```
                 */
@@ -3519,9 +3555,18 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             InsertIntoSlide = "insertInToSlide",
             /**
-                * @hidden
                 * Emitted when a user changes any filter on a Liveboard.
+                * Returns filter type and name, column name and ID, and runtime
+                * filter details.
+                *
                 * @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",
             /**
@@ -4056,7 +4101,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * ```js
                 * searchEmbed.trigger(HostEvent.GetTML).then((tml) => {
                 *   console.log(
-                *      tml.search_query // TML representation of the search query
+                *      tml.answer.search_query // TML representation of the search query
                 *   );
                 * })
                 * ```
@@ -4299,7 +4344,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *
                 * ```js
                 * liveboardEmbed.trigger(HostEvent.UpdateFilters, {
-                *  filter: { column: 'column name', oper: 'IN', values: [1,2,3], is_mandatory: false }
+                *  filter: { column: 'column name', oper: 'IN', values: [1,2,3]}
                 * })
                 * ```
                 * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
@@ -5437,7 +5482,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * disabledActions: [Action.TML] // to disable all TML actions
                 * ```
                 *
-                * @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
+                * @version SDK : 1.28.3 | Thoughtspot: 9.12.0.cl
                 */
             TML = "tml",
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.28.4",
+    "version": "1.28.5",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

package/src/authToken.spec.ts

@@ -0,0 +1,31 @@
+import { getAuthenticationToken, resetCachedAuthToken } from './authToken';
+import * as authServiceInstance from './utils/authService/authService';
+import { EmbedConfig } from './types';
+
+describe('AuthToken Unit tests', () => {
+    test('getAuthenticationToken: When verification is disabled', async () => {
+        jest.spyOn(authServiceInstance, 'verifyTokenService');
+
+        const token = await getAuthenticationToken({
+            getAuthToken: async () => 'abc3',
+            disableTokenVerification: true,
+        } as EmbedConfig);
+
+        expect(token).toBe('abc3');
+        expect(authServiceInstance.verifyTokenService).not.toBeCalled();
+    });
+
+    test.only('getAuthenticationToken: When verification is enabled', async () => {
+        resetCachedAuthToken();
+        jest.clearAllMocks();
+        jest.spyOn(authServiceInstance, 'verifyTokenService').mockImplementation(() => true);
+        const token = await getAuthenticationToken({
+            thoughtSpotHost: 'test',
+            getAuthToken: async () => 'abc2',
+            disableTokenVerification: false,
+        } as EmbedConfig);
+
+        expect(token).toBe('abc2');
+        expect(authServiceInstance.verifyTokenService).toBeCalledWith('test', 'abc2');
+    });
+});

package/src/authToken.ts

@@ -1,5 +1,6 @@
 import { EmbedConfig } from './types';
 import { fetchAuthTokenService, verifyTokenService } from './utils/authService/authService';
+import { logger } from './utils/logger';
 
 const DUPLICATE_TOKEN_ERR = 'Duplicate token, please issue a new token every time getAuthToken callback is called.'
     + 'See https://developers.thoughtspot.com/docs/?pageid=embed-auth#trusted-auth-embed for more details.';
@@ -10,7 +11,9 @@ let cachedAuthToken: string | null = null;
 
 // This method can be used to get the authToken using the embedConfig
 export const getAuthenticationToken = async (embedConfig: EmbedConfig): Promise<string> => {
-    if (cachedAuthToken) {
+    // Since we don't have token validation enabled , we cannot tell if the
+    // cached token is valid or not. So we will always fetch a new token.
+    if (cachedAuthToken && !embedConfig.disableTokenVerification) {
         let isCachedTokenStillValid;
         try {
             isCachedTokenStillValid = await validateAuthToken(embedConfig, cachedAuthToken, true);
@@ -43,6 +46,10 @@ const validateAuthToken = async (
     authToken: string,
     suppressAlert?: boolean,
 ): Promise<boolean> => {
+    if (embedConfig.disableTokenVerification) {
+        logger.info('Token verification is disabled. Assuming token is valid.');
+        return true;
+    }
     try {
         const isTokenValid = await verifyTokenService(embedConfig.thoughtSpotHost, authToken);
         if (isTokenValid) return true;