@thoughtspot/visual-embed-sdk 1.32.3 → 1.32.4-dc.0

package/src/types.ts

@@ -255,7 +255,6 @@ export interface customCssInterface {
  * Styles within the {@link CustomisationsInterface}.
  */
 export interface CustomStyles {
-    customCSSUrl?: string;
     customCSS?: customCssInterface;
 }
 
@@ -449,13 +448,6 @@ export interface EmbedConfig {
      */
     queueMultiRenders?: boolean;
 
-    /**
-     * Dynamic CSS URL to be injected in the loaded application.
-     * You would also need to set `style-src` in the CSP settings.
-     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
-     * @default ''
-     */
-    customCssUrl?: string;
     /**
      * [AuthServer|Basic] Detect if third-party party cookies are enabled by doing an
      * additional call. This is slower and should be avoided. Listen to the
@@ -2476,28 +2468,23 @@ export enum HostEvent {
     /**
      * Trigger the **Make a copy** action on a Liveboard,
      * visualization, or Answer page.
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.MakeACopy)
      * ```
-     *
      * @example
      * ```js
      * liveboardEmbed.trigger(HostEvent.MakeACopy, {
      * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * ```
-     *
      * @example
      * ```js
      * vizEmbed.trigger(HostEvent.MakeACopy)
      * ```
-     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.MakeACopy)
      * ```
-     *
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
      */
     MakeACopy = 'makeACopy',
@@ -2523,7 +2510,6 @@ export enum HostEvent {
     /**
      * Trigger the **Create alert** action on a KPI chart
      * in a Liveboard or saved Answer.
-     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2531,7 +2517,6 @@ export enum HostEvent {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
-     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.CreateMonitor)
@@ -2542,7 +2527,6 @@ export enum HostEvent {
     /**
      * Trigger the **Manage alerts** action on a KPI chart
      * in a visualization or saved Answer.
-     *
      * @param - an object with `vizId` as a key
      * @example
      * ```js
@@ -2550,12 +2534,10 @@ export enum HostEvent {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
-     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.ManageMonitor)
      * ```
-     *
      * @example
      * ```js
      * vizEmbed.trigger(HostEvent.ManageMonitor)
@@ -2953,7 +2935,6 @@ export enum HostEvent {
     /**
      * Get the answer session for a Search or
      * Liveboard visualization.
-     *
      * @example
      * ```js
      * const {session} = await embed.trigger(
@@ -2961,12 +2942,10 @@ export enum HostEvent {
      *      vizId: '123', // For Liveboard Visualization.
      *  })
      * ```
-     *
      * @example
      * ```js
      * const {session} = await embed.trigger( HostEvent.GetAnswerSession )
      * ```
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
      */
     GetAnswerSession = 'getAnswerSession',
@@ -3080,7 +3059,6 @@ export enum Param {
     ViewPortHeight = 'viewPortHeight',
     ViewPortWidth = 'viewPortWidth',
     VisibleActions = 'visibleAction',
-    CustomCSSUrl = 'customCssUrl',
     DisableLoginRedirect = 'disableLoginRedirect',
     visibleVizs = 'pinboardVisibleVizs',
     LiveboardV2Enabled = 'isPinboardV2Enabled',
@@ -3694,7 +3672,6 @@ export enum Action {
     /**
      * @deprecated
      * Reports errors
-     *
      * @example
      * ```js
      * disabledActions: [Action.ReportError]
@@ -3924,14 +3901,12 @@ export enum Action {
      * ```js
      * disabledActions: [Action.RequestVerification]
      * ```
-     *
      * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
      */
     RequestVerification = 'requestVerification',
     /**
      *
-     * Allows users to mark a Liveboard as verified.
-     *
+     *Allows users to mark a Liveboard as verified.
      * @example
      * ```js
      * disabledActions: [Action.MarkAsVerified]
@@ -3942,7 +3917,6 @@ export enum Action {
     /**
      * The **Add Tab** action on a Liveboard.
      * Allows adding a new tab to a Liveboard view.
-     *
      * @example
      * ```js
      * disabledActions: [Action.AddTab]
@@ -3952,8 +3926,7 @@ export enum Action {
     AddTab = 'addTab',
     /**
      *
-     * Initiates contextual change analysis on KPI charts.
-     *
+     *Initiates contextual change analysis on KPI charts.
      * @example
      * ```js
      * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -3967,7 +3940,6 @@ export enum Action {
      * ```js
      * disabledActions: [Action.ShowSageQuery]
      * ```
-     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     ShowSageQuery = 'showSageQuery',
@@ -3982,8 +3954,7 @@ export enum Action {
     EditSageAnswer = 'editSageAnswer',
     /**
      *
-     * This action allows users to send feedback on AI-generated Answers.
-     *
+     *This action allows users to send feedback on AI-generated Answers.
      * @example
      * ```js
      * disabledActions: [Action.SageAnswerFeedback]
@@ -4062,7 +4033,6 @@ export enum Action {
      * hiddenAction: [Action.CreateLiveboard]
      * disabledActions: [Action.CreateLiveboard]
      * ```
-     *
      * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
      */
     CreateLiveboard = 'createLiveboard',
@@ -4169,7 +4139,6 @@ export enum Action {
 
     /**
      * The **Manage Tags** action on Homepage Favourite Module.
-     *
      * @example
      * ```js
      * disabledActions: [Action.ManageTags]

package/src/utils/authService/tokenizedAuthService.ts

@@ -18,7 +18,6 @@ function tokenizedFailureLoggedFetch(url: string, options: RequestInit = {}): Pr
 
 /**
  * Fetches the session info from the ThoughtSpot server.
- *
  * @param thoughtspotHost
  * @returns {Promise<any>}
  * @example
@@ -52,7 +51,6 @@ export async function fetchLogoutService(thoughtSpotHost: string): Promise<any>
 
 /**
  * Is active service to check if the user is logged in.
- *
  * @param thoughtSpotHost
  * @version SDK: 1.28.4 | ThoughtSpot: *
  */

package/src/utils/graphql/answerService/answer-queries.ts

@@ -101,7 +101,6 @@ export const getAnswer = `
                     isDiscoverable
                     isHidden
                     modifiedAt
-                    tags
                 }
                 visualizations {
                     ... on TableViz {
@@ -164,3 +163,12 @@ export const addVizToLiveboard = `
         }
     }
 `;
+
+export const getSQLQuery = `
+    mutation GetSQLQuery($session: BachSessionIdInput!) {
+        Answer__getQuery(session: $session) {
+            ${bachSessionId}
+            sql
+        }
+    }
+`;

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

@@ -3,7 +3,9 @@ import { AuthType, RuntimeFilterOp, VizPoint } from '../../../types';
 import { AnswerService } from './answerService';
 import {
     getAnswerData, removeColumns, addFilter, addColumns,
+    getSQLQuery,
 } from './answer-queries';
+import * as queries from './answer-queries';
 import * as authTokenInstance from '../../../authToken';
 import * as tokenizedFetch from '../../../tokenizedFetch';
 import * as embedConfigInstance from '../../../embed/embedConfig';
@@ -34,6 +36,23 @@ describe('Answer service tests', () => {
     beforeEach(() => {
         fetchMock.resetMocks();
     });
+
+    test('should call executeQuery with correct parameters to add columns', async () => {
+        const service = createAnswerService();
+        const executeQuerySpy = jest.spyOn(service, 'executeQuery').mockResolvedValue({
+            id: { genNo: 2 },
+
+        });
+
+        const columnIds = ['col1', 'col2'];
+        const result = await service.addColumns(columnIds);
+
+        expect(executeQuerySpy).toHaveBeenCalledWith(queries.addColumns, {
+            columns: columnIds.map((colId) => ({ logicalColumnId: colId })),
+        });
+        expect(result.id.genNo).toBe(2);
+    });
+
     test('Execute query should execute the supplied graphql on the session', async () => {
         fetchMock.mockResponseOnce(JSON.stringify({
             data: {
@@ -404,4 +423,30 @@ describe('Answer service tests', () => {
             }),
         );
     });
+
+    test('Get SQL query should call the right API', async () => {
+        fetchMock.mockResponseOnce(JSON.stringify({
+            data: {
+                Answer__getQuery: {
+                    id: {},
+                    sql: 'SELECT * FROM table',
+                },
+            },
+        }));
+        const answerService = createAnswerService();
+        const sql = await answerService.getSQLQuery();
+        expect(fetchMock).toHaveBeenCalledWith(
+            'https://tshost/prism/?op=GetSQLQuery',
+            expect.objectContaining({
+                body: JSON.stringify({
+                    operationName: 'GetSQLQuery',
+                    query: getSQLQuery,
+                    variables: {
+                        session: defaultSession,
+                    },
+                }),
+            }),
+        );
+        expect(sql).toBe('SELECT * FROM table');
+    });
 });

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

@@ -173,6 +173,14 @@ export class AnswerService {
         );
     }
 
+    public async getSQLQuery(): Promise<string> {
+        const { sql } = await this.executeQuery(
+            queries.getSQLQuery,
+            {},
+        );
+        return sql;
+    }
+
     /**
      * Fetch data from the answer.
      * @param offset

package/src/utils/graphql/conversationService/conversation-queries.ts

@@ -0,0 +1,315 @@
+export const createConversation = `
+mutation CreateConversation($params: Input_convassist_CreateConversationRequest) {
+  ConvAssist__createConversation(request: $params) {
+    convId
+    initialCtx {
+      type
+      tsAnsCtx {
+        sessionId
+        genNo
+        stateKey {
+          transactionId
+          generationNumber
+          __typename
+        }
+        worksheet {
+          worksheetId
+          worksheetName
+          __typename
+        }
+        __typename
+      }
+      __typename
+    }
+    __typename
+  }
+}
+`;
+
+export const sendMessage = `
+query SendMessage($params: Input_convassist_SendMessageRequest) {
+  ConvAssist__sendMessage(request: $params) {
+    responses {
+      timestamp
+      msgId
+      data {
+        asstRespData {
+          tool
+          asstRespText
+          nlsAnsData {
+            sageQuerySuggestions {
+              sageQueryTokens {
+                additions {
+                  phrase {
+                    isCompletePhrase
+                    numTokens
+                    phraseType
+                    startIndex
+                    __typename
+                  }
+                  tokens {
+                    token
+                    dataType
+                    typeEnum
+                    guid
+                    tokenMetadata {
+                      name
+                      __typename
+                    }
+                    __typename
+                  }
+                  __typename
+                }
+                phrases {
+                  isCompletePhrase
+                  numTokens
+                  phraseType
+                  startIndex
+                  __typename
+                }
+                removals {
+                  phrase {
+                    isCompletePhrase
+                    numTokens
+                    phraseType
+                    startIndex
+                    __typename
+                  }
+                  tokens {
+                    token
+                    dataType
+                    typeEnum
+                    guid
+                    tokenMetadata {
+                      name
+                      __typename
+                    }
+                    __typename
+                  }
+                  __typename
+                }
+                tokens {
+                  token
+                  dataType
+                  typeEnum
+                  guid
+                  tokenMetadata {
+                    name
+                    __typename
+                  }
+                  __typename
+                }
+                __typename
+              }
+              llmReasoning {
+                assumptions
+                clarifications
+                interpretation
+                __typename
+              }
+              tokens
+              tmlTokens
+              worksheetId
+              tokens
+              description
+              title
+              tmlTokens
+              cached
+              sqlQuery
+              sessionId
+              genNo
+              formulaInfo {
+                name
+                expression
+                __typename
+              }
+              tmlPhrases
+              ambiguousPhrases {
+                alternativePhrases {
+                  phraseType
+                  token {
+                    token
+                    dataType
+                    typeEnum
+                    guid
+                    tokenMetadata {
+                      name
+                      __typename
+                    }
+                    __typename
+                  }
+                  __typename
+                }
+                ambiguityType
+                token {
+                  token
+                  dataType
+                  typeEnum
+                  guid
+                  tokenMetadata {
+                    name
+                    __typename
+                  }
+                  __typename
+                }
+                __typename
+              }
+              ambiguousTokens {
+                alternativeTokens {
+                  token
+                  dataType
+                  typeEnum
+                  guid
+                  tokenMetadata {
+                    name
+                    deprecatedTableGuid
+                    deprecatedTableName
+                    isFormula
+                    rootTables {
+                      created
+                      description
+                      guid
+                      indexVersion
+                      modified
+                      name
+                      __typename
+                    }
+                    schemaTableUserDefinedName
+                    table {
+                      created
+                      description
+                      guid
+                      indexVersion
+                      modified
+                      name
+                      __typename
+                    }
+                    __typename
+                  }
+                  __typename
+                }
+                ambiguityType
+                token {
+                  token
+                  dataType
+                  typeEnum
+                  guid
+                  tokenMetadata {
+                    name
+                    __typename
+                  }
+                  __typename
+                }
+                __typename
+              }
+              stateKey {
+                transactionId
+                generationNumber
+                transactionId
+                __typename
+              }
+              subQueries {
+                tokens
+                cohortConfig {
+                  anchorColumnId
+                  cohortAnswerGuid
+                  cohortGroupingType
+                  cohortGuid
+                  cohortType
+                  combineNonGroupValues
+                  description
+                  groupExcludedQueryValues
+                  hideExcludedQueryValues
+                  isEditable
+                  name
+                  nullOutputValue
+                  returnColumnId
+                  __typename
+                }
+                formulas {
+                  name
+                  expression
+                  __typename
+                }
+                __typename
+              }
+              visualizationSuggestion {
+                chartType
+                displayMode
+                axisConfigs {
+                  category
+                  color
+                  hidden
+                  size
+                  sort
+                  x
+                  y
+                  __typename
+                }
+                usersVizIntentApplied
+                customChartConfigs {
+                  dimensions {
+                    columns
+                    key
+                    __typename
+                  }
+                  key
+                  __typename
+                }
+                customChartGuid
+                __typename
+              }
+              tableData {
+                columnDataLite {
+                  columnId
+                  columnDataType
+                  dataValue
+                  columnName
+                  __typename
+                }
+                __typename
+              }
+              warningType
+              cached
+              __typename
+            }
+            debugInfo {
+              fewShotExamples {
+                chartType
+                id
+                mappingId
+                nlQuery
+                nlQueryConcepts
+                sageQuery
+                scope
+                sql
+                tml
+                __typename
+              }
+              __typename
+            }
+            __typename
+          }
+          __typename
+        }
+        errorData {
+          tool
+          errCode
+          errTxt
+          toolErrCode
+          __typename
+        }
+        __typename
+      }
+      type
+      __typename
+    }
+    prevCtx {
+      genNo
+      sessionId
+      __typename
+    }
+    __typename
+  }
+}
+`;

package/src/utils/graphql/conversationService/conversation-service.ts

@@ -0,0 +1,93 @@
+import { graphqlQuery } from '../graphql-request';
+import * as queries from './conversation-queries';
+
+export class Conversation {
+    private conversationId: string;
+
+    private inProgress = false;
+
+    constructor(private thoughtSpotHost: string, private worksheetId: string) {
+        this.init();
+    }
+
+    async init() {
+        try {
+            this.inProgress = true;
+            const { convId } = await this.createConversation();
+            this.conversationId = convId;
+        } finally {
+            this.inProgress = false;
+        }
+    }
+
+    createConversation(): Promise<any> {
+        return this.executeQuery(
+            queries.createConversation,
+            {
+                params: {
+                    initialCtx: {
+                        tsWorksheetCtx: {
+                            worksheet: {
+                                worksheetId: this.worksheetId,
+                            },
+                        },
+                        type: 'TS_WORKSHEET',
+                    },
+                    userInfo: {
+                        tenantUrl: `${this.thoughtSpotHost}/prism`,
+                    },
+                },
+            },
+        );
+    }
+
+    public async sendMessage(userMessage: string): Promise<any> {
+        if (this.inProgress) {
+            console.warn('Previous message still in progress');
+            return { error: 'Previous message still in progress' };
+        }
+
+        try {
+            this.inProgress = true;
+            const { responses } = await this.executeQuery(
+                queries.sendMessage,
+                {
+                    params: {
+                        convId: this.conversationId,
+                        msg: {
+                            data: {
+                                userCmdData: {
+                                    cmdText: userMessage,
+                                    nlsData: {
+                                        worksheetId: this.worksheetId,
+                                    },
+                                },
+                            },
+                            msgId: crypto.randomUUID(),
+                            type: 'USER_COMMAND',
+                        },
+                    },
+                },
+            );
+            this.inProgress = false;
+            const data = responses[0].data;
+            return {
+                data: data.asstRespData.nlsAnsData.sageQuerySuggestions[0],
+                error: null,
+            };
+        } catch (error) {
+            return { error };
+        } finally {
+            this.inProgress = false;
+        }
+    }
+
+    public async executeQuery(query: string, variables: any) {
+        return graphqlQuery({
+            query,
+            variables,
+            thoughtSpotHost: this.thoughtSpotHost,
+            isCompositeQuery: false,
+        });
+    }
+}