@thoughtspot/visual-embed-sdk 1.27.0-logger → 1.27.8

package/src/react/index.spec.tsx

@@ -199,6 +199,35 @@ describe('React Components', () => {
             ).toBe(true);
             expect(containerSibling.querySelector('div')).toBe(null);
         });
+
+        it('Should have the correct container element', async () => {
+            const { container } = render(
+                <LiveboardEmbed liveboardId="abcd" className="def" />,
+            );
+
+            await waitFor(() => getIFrameEl(container));
+            expect(container.querySelector('div')).not.toBe(null);
+            expect(
+                container.querySelector('div').classList.contains('def'),
+            ).toBe(true);
+
+            const { container: containerSibling } = render(
+                <LiveboardEmbed
+                    liveboardId="abcd"
+                    className="def"
+                    insertAsSibling={true}
+                />,
+            );
+            await waitFor(() => getIFrameEl(containerSibling));
+            expect(containerSibling.querySelector('span')).not.toBe(null);
+            expect(containerSibling.querySelector('span').style.position).toBe(
+                'absolute',
+            );
+            expect(
+                getIFrameEl(containerSibling).classList.contains('def'),
+            ).toBe(true);
+            expect(containerSibling.querySelector('div')).toBe(null);
+        });
     });
 
     describe('SearchBarEmbed', () => {

package/src/react/index.tsx

@@ -380,4 +380,5 @@ export {
     FrameParams,
     HomeLeftNavItem,
     HomepageModule,
+    LogLevel,
 } from '../index';

package/src/types.ts

@@ -470,6 +470,7 @@ 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.
      *
@@ -549,8 +550,8 @@ export interface EmbedConfig {
 
     /**
      * Log level for the SDK.
-     * @default LogLevel.ERROR
      *
+     * @default LogLevel.ERROR
      * @example
      * ```js
      * init({
@@ -558,7 +559,7 @@ export interface EmbedConfig {
      *   logLevel: LogLevel.SILENT
      * })
      * ```
-     * @version SDK: 1.26.3 | ThoughtSpot: 9.10.0.cl
+     * @version SDK: 1.26.7 | ThoughtSpot: 9.10.0.cl
      */
     logLevel?: LogLevel;
 }
@@ -799,6 +800,7 @@ export interface ViewConfig {
      * ```js
      * hiddenHomeLeftNavItems = [HomeLeftNavItem.Home]
      * ```
+     *
      * @version SDK: 1.27.0 | Thoughtspot: 9.10.0.cl
      */
     hiddenHomeLeftNavItems?: HomeLeftNavItem[];
@@ -837,6 +839,12 @@ export interface ViewConfig {
      * const myComponent = new MyComponent(config);
      */
     doNotTrackPreRenderSize?: boolean;
+    /**
+     * For internal tracking of the embed component type.
+     *
+     * @hidden
+     */
+    embedComponentType?: string;
 }
 
 /**
@@ -1051,6 +1059,7 @@ export interface RuntimeParameter {
 export enum EmbedEvent {
     /**
      * Rendering has initialized.
+     *
      * @example
      *```js
      * liveboardEmbed.on(EmbedEvent.Init, showLoader)
@@ -1059,7 +1068,6 @@ export enum EmbedEvent {
      * document.getElementById("loader");
      * }
      *```
-     *
      * @returns timestamp - The timestamp when the event was generated.
      */
     Init = 'init',
@@ -1072,12 +1080,12 @@ export enum EmbedEvent {
      *    console.log('AuthInit', payload);
      * })
      *```
-     *
      * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
      */
     AuthInit = 'authInit',
     /**
      * The embed object container has loaded.
+     *
      * @returns timestamp - The timestamp when the event was generated.
      * @example
      *```js
@@ -1091,6 +1099,7 @@ export enum EmbedEvent {
     Load = 'load',
     /**
      * Data pertaining to answer or Liveboard is received
+     *
      * @return data - The answer or Liveboard data
      * @example
      *```js
@@ -1114,7 +1123,6 @@ export enum EmbedEvent {
      *```js
      * searchEmbed.on(EmbedEvent.QueryChanged, payload => console.log('data', payload))
      *```
-     *
      */
     QueryChanged = 'queryChanged',
     /**
@@ -1123,7 +1131,6 @@ export enum EmbedEvent {
      * @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(HostEvent.DrillDown, {
@@ -1137,7 +1144,6 @@ export enum EmbedEvent {
      * In this example, `VizPointDoubleClick` event is used for
      * triggering the `DrillDown` event when an area or specific
      * data point on a table or chart is double-clicked.
-     *
      * @example
      *```js
      * searchEmbed.on(EmbedEvent.VizPointDoubleClick, (payload) => {
@@ -1154,34 +1160,31 @@ export enum EmbedEvent {
      *     })
      * })
      *```
-     *
      */
     Drilldown = 'drillDown',
     /**
      * One or more data sources have been selected.
-     * @returns dataSourceIds - the list of data sources
      *
+     * @returns dataSourceIds - the list of data sources
      * @example
      * ```js
      * searchEmbed.on(EmbedEvent.DataSourceSelected, payload => {
      *    console.log('DataSourceSelected', payload);
      * })
      * ```
-     *
      */
     DataSourceSelected = 'dataSourceSelected',
     /**
      * One or more data columns have been selected.
+     *
      * @returns columnIds - the list of columns
      * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
-     *
      * @example
      * ```js
      * appEmbed.on(EmbedEvent.AddRemoveColumns, payload => {
      *   console.log('AddRemoveColumns', payload);
      * })
      * ```
-     *
      */
     AddRemoveColumns = 'addRemoveColumns',
     /**
@@ -1189,7 +1192,6 @@ export enum EmbedEvent {
      *
      * @returns actionId - ID of the custom action
      * @returns data - Response payload with the Answer or Liveboard data
-     *
      * @example
      * ```js
      * appEmbed.on(EmbedEvent.customAction, payload => {
@@ -1205,9 +1207,7 @@ export enum EmbedEvent {
      * Listen to double click actions on a visualization.
      *
      * @return ContextMenuInputPoints - Data point that is double-clicked
-     *
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
-     *
      * @example
      * ```js
      * livebaordEmbed.on(EmbedEvent.VizPointDoubleClick, payload => {
@@ -1222,7 +1222,6 @@ export enum EmbedEvent {
      * @return viz, clickedPoint - metadata about the point that is clicked
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @important
-     *
      * @example
      * ```js
      * embed.on(ThoughtSpotEmbed.Event.VizPointClick, ({data}) => {
@@ -1241,7 +1240,6 @@ export enum EmbedEvent {
      * An error has occurred.
      *
      * @returns error - An error object or message
-     *
      * @example
      * ```js
      * SearchEmbed.on(EmbedEvent.Error, showErrorMsg)
@@ -1249,19 +1247,16 @@ export enum EmbedEvent {
      *  function showErrorMsg() {
      *    document.getElementById("error");
      * ```
-     *
      */
     Error = 'Error',
     /**
      * The embedded object has sent an alert.
      *
      * @returns alert - An alert object
-     *
      * @example
      * ```js
      * searchEmbed.on(EmbedEvent.Alert)
      * ```
-     *
      */
     Alert = 'alert',
     /**
@@ -1308,7 +1303,6 @@ export enum EmbedEvent {
      * Applicable to `SearchBarEmbed` only.
      *
      * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
-     *
      * @example
      *```js
      * searchbarEmbed.on(EmbedEvent.GetDataClick)
@@ -1355,8 +1349,8 @@ export enum EmbedEvent {
     SAMLComplete = 'samlComplete',
     /**
      * Emitted when any modal is opened in the app
-     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      *
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      *```js
      * appEmbed.on(EmbedEvent.DialogOpen, payload => {
@@ -1367,8 +1361,8 @@ export enum EmbedEvent {
     DialogOpen = 'dialog-open',
     /**
      * Emitted when any modal is closed in the app
-     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      *
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
      * @example
      *```js
      * appEmbed.on(EmbedEvent.DialogClose, payload => {
@@ -1381,8 +1375,8 @@ export enum EmbedEvent {
      * Emitted when the Liveboard shell loads.
      * You can use this event as a hook to trigger
      * other events on the rendered Liveboard.
-     * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      *
+     * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      * @example
      *```js
      * liveboardEmbed.on(EmbedEvent.LiveboardRendered, payload => {
@@ -1391,7 +1385,6 @@ export enum EmbedEvent {
      *```
      * The following example shows how to trigger
      * `SetVisibleVizs` event using LiveboardRendered embed event:
-     *
      * @example
      *```js
      * const embedRef = useEmbedRef();
@@ -1404,8 +1397,8 @@ export enum EmbedEvent {
     /**
      * This can be used to register an event listener which
      * is triggered on all events.
-     * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      *
+     * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1.sw
      * @example
      *```js
      * appEmbed.on(EmbedEvent.ALL, payload => {
@@ -1416,6 +1409,7 @@ export enum EmbedEvent {
     ALL = '*',
     /**
      * Emitted when an Answer is saved in the app
+     *
      * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1441,7 +1435,6 @@ export enum EmbedEvent {
      * or `EmbedEvent.DownloadAsXLSX`
      *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-     *
      * @example
      *```js
      * liveboardEmbed.trigger(HostEvent.Download, {
@@ -1452,8 +1445,8 @@ export enum EmbedEvent {
     Download = 'download',
     /**
      * Emitted when the download action is triggered on an answer
-     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
      *
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
      * @example
      *```js
      * //trigger when action starts
@@ -1463,14 +1456,12 @@ export enum EmbedEvent {
      * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
      *   console.log('download PNG', payload)})
      *```
-     *
      */
     DownloadAsPng = 'downloadAsPng',
     /**
      * Emitted when the Download as PDF action is triggered on an answer
      *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-     *
      * @example
      *```js
      * //trigger when action starts
@@ -1480,7 +1471,6 @@ export enum EmbedEvent {
      * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
      *   console.log('download PDF', payload)})
      *```
-     *
      */
     DownloadAsPdf = 'downloadAsPdf',
     /**
@@ -1502,7 +1492,6 @@ export enum EmbedEvent {
      * Emitted when the Download as XLSX action is triggered on an answer
      *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-     *
      * @example
      *```js
      * //trigger when action starts
@@ -1518,7 +1507,6 @@ export enum EmbedEvent {
      * Emitted when an Answer is deleted in the app
      *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-     *
      * @example
      *```js
      * //trigger when action starts
@@ -1572,7 +1560,6 @@ export enum EmbedEvent {
      * Emitted when a user shares an object with another user or group
      *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
-     *
      * @example
      *```js
      * //trigger when action starts
@@ -1652,6 +1639,7 @@ export enum EmbedEvent {
     /**
      * Emitted when the **Export TML** action is triggered on an
      * an embedded object in the app
+     *
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
      * @example
      *```js
@@ -1789,7 +1777,6 @@ export enum EmbedEvent {
      *```js
      * liveboardEmbed.trigger(HostEvent.Present)
      *```
-     *
      * @example
      *```js
      * liveboardEmbed.on(EmbedEvent.Present, {
@@ -1807,77 +1794,65 @@ export enum EmbedEvent {
      * liveboardEmbed.trigger(HostEvent.Delete,
      *   {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
-     *
      */
     Delete = 'delete',
     /**
      * Emitted when a user clicks Manage schedules on a Liveboard
      *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-     *
      * @example
      *```js
      * liveboardEmbed.trigger(HostEvent.SchedulesList)
      *```
-     *
      */
     SchedulesList = 'schedule-list',
     /**
      * Emitted when a user clicks **Cancel** in edit mode on a Liveboard
      *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-     *
      * @example
      *```js
      * liveboardEmbed.trigger(HostEvent.Cancel)
      *```
-     *
      */
     Cancel = 'cancel',
     /**
      * Emitted when a user clicks **Explore** on a visualization
      *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-     *
      * @example
      *```js
      * liveboardEmbed.trigger(HostEvent.Explore,  {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
-     *
      */
     Explore = 'explore',
     /**
      * Emitted when a user clicks **Copy link** action on a visualization
      *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
-     *
      * @example
      *```js
      * liveboardEmbed.trigger(HostEvent.CopyLink, {
      *   vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
-     *
      */
     CopyLink = 'embedDocument',
     /**
      * Emitted when a user interacts with cross filters on a visualization or Liveboard
      *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
-     *
      * @example
      *```js
      * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
      *    vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      *```
-     *
      */
     CrossFilterChanged = 'cross-filter-changed',
     /**
      * Emitted when a user right clicks on a visualization (chart or table)
      *
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
-     *
      * @example
      *```js
      * LiveboardEmbed.on(EmbedEvent.VizPointRightClick, payload => {
@@ -1908,7 +1883,6 @@ export enum EmbedEvent {
      * Emitted when a user selects a data source.
      *
      * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
-     *
      */
     SageWorksheetUpdated = 'sageWorksheetUpdated',
     /**
@@ -1968,6 +1942,22 @@ export enum EmbedEvent {
      * @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
      */
     CreateWorksheet = 'createWorksheet',
+    /**
+     * Emitted when Ask Sage is initialized.
+     *
+     * @returns viewName: string
+     * @returns viewId: string
+     * @returns liveboardId: string
+     * @returns isPublic: boolean
+     * @version SDK : 1.29.0 | Thoughtspot: 9.12.0.cl
+     */
+    AskSageInit = 'AskSageInit',
+    /**
+     * Emitted when a LB/viz is renamed
+     *
+     * @version SDK : 1.28.0 | ThoughtSpot: 9.11.0.cl
+     */
+    Rename = 'rename',
 }
 
 /**
@@ -2058,7 +2048,7 @@ export enum HostEvent {
      *        clickedPoint,
      *        selectedPoints: selectedPoint
      *      },
-     *      autoDrillDown: true,
+     *      columnGuid: "<guid of the column to drill>",
      *      vizId: payload.data.vizId
      *    });
      *  })
@@ -2137,7 +2127,6 @@ export enum HostEvent {
      *
      * @param - `path` - the path to navigate to to go forward or back. The path value can
      * be a number; for example, `1`, `-1`.
-     *
      * @example
      * ```js
      * appEmbed.navigateToPage(-1)
@@ -2708,9 +2697,7 @@ export enum HostEvent {
      * Updates the search query string for Natural Language Search operations.
      *
      * @param - `queryString`: Text string in Natural Language format
-     *
      * @param - `executeSearch`: Boolean to execute search and update search query
-     *
      * @example
      * ```js
      * sageEmbed.trigger(HostEvent.UpdateSageQuery, {
@@ -2734,6 +2721,17 @@ export enum HostEvent {
      * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
      */
     GetAnswerSession = 'getAnswerSession',
+    /**
+     * Trigger Ask Sage for viz
+     *
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.AskSage,
+     * {vizId:'730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
+     * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+     */
+    AskSage = 'AskSage',
 }
 
 /**
@@ -2834,6 +2832,7 @@ export enum Param {
     HideSearchBar = 'hideSearchBar',
     ClientLogLevel = 'clientLogLevel',
     OverrideNativeConsole = 'overrideConsoleLogs',
+    enableAskSage = 'enableAskSage',
 }
 
 /**
@@ -3697,6 +3696,17 @@ export enum Action {
      *  @version SDK: 1.29.0 | Thoughtspot: 9.10.0.cl
      */
     VerifiedLiveboard = 'verifiedLiveboard',
+
+    /**
+     * Action ID for ask sage button
+     *
+     *  @example
+     * ```js
+     * hiddenAction: [Action.AskAi]
+     * ```
+     *  @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+     */
+    AskAi = 'AskAi',
 }
 
 export interface AnswerServiceType {
@@ -3764,10 +3774,83 @@ export interface CustomActionPayload {
 }
 
 export enum LogLevel {
-  SILENT = 'SILENT',
-  ERROR = 'ERROR',
-  WARN = 'WARN',
-  INFO = 'INFO',
-  DEBUG = 'DEBUG',
-  TRACE = 'TRACE',
+    /**
+     * No logs will be logged in the console.
+     *
+     * @example
+     * ```js
+     * init({
+     *   ... // other options,
+     *  logLevel: LogLevel.SILENT,
+     * })
+     * ```
+     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     */
+    SILENT = 'SILENT',
+    /**
+     * Only ERROR logs will be logged in the console.
+     *
+     * @example
+     * ```js
+     * init({
+     *   ... // other options,
+     *  logLevel: LogLevel.ERROR,
+     * })
+     * ```
+     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     */
+    ERROR = 'ERROR',
+    /**
+     * Only WARN and ERROR logs will be logged in the console.
+     *
+     * @example
+     * ```js
+     * init({
+     *   ... // other options,
+     *  logLevel: LogLevel.WARN,
+     * })
+     * ```
+     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     */
+    WARN = 'WARN',
+    /**
+     * Only INFO, WARN, and ERROR logs will be logged in the console.
+     *
+     * @example
+     * ```js
+     * init({
+     *   ... // other options,
+     *  logLevel: LogLevel.INFO,
+     * })
+     * ```
+     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     */
+    INFO = 'INFO',
+
+    /**
+     * Only DEBUG, INFO, WARN, and ERROR logs will be logged in the console.
+     *
+     * @example
+     * ```js
+     * init({
+     *   ... // other options,
+     *  logLevel: LogLevel.DEBUG,
+     * })
+     * ```
+     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     */
+    DEBUG = 'DEBUG',
+    /**
+     * All logs will be logged in the console.
+     *
+     * @example
+     * ```js
+     * init({
+     *   ... // other options,
+     *  logLevel: LogLevel.TRACE,
+     * })
+     * ```
+     * @version SDK: 1.26.7 | Thoughtspot: 9.10.0.cl
+     */
+    TRACE = 'TRACE',
 }

package/src/utils/authService/authService.spec.ts

@@ -1,11 +1,11 @@
 import {
-    fetchSessionInfoService,
-    fetchAuthTokenService,
+    EndPoints,
+    fetchAuthPostService,
     fetchAuthService,
+    fetchAuthTokenService,
     fetchBasicAuthService,
-    fetchAuthPostService,
+    fetchSessionInfoService,
     verifyTokenService,
-    EndPoints,
 } from '.';
 import { logger } from '../logger';
 

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

@@ -74,6 +74,8 @@ describe('Answer service tests', () => {
                     id: {},
                     answer: {
                         visualizations: [{
+                            id: 'vizId',
+                        }, {
                             columns: [{
                                 column: {
                                     id: 'id1',

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

@@ -88,7 +88,9 @@ export class AnswerService {
                 },
             },
         );
-        const { columns, data } = answer.visualizations[0];
+        const { columns, data } = answer.visualizations.find(
+            (viz: any) => !!viz.data,
+        ) || {};
         return {
             columns,
             data,