@thoughtspot/visual-embed-sdk 1.33.0-dc.1 → 1.33.0

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

@@ -1,141 +0,0 @@
-import 'jest-fetch-mock';
-import { BodylessConversation, BodylessConversationViewConfig } from './bodyless-conversation';
-import * as authInstance from '../auth';
-import { init } from '../index';
-import { Action, AuthType, RuntimeFilterOp } from '../types';
-import {
-    executeAfterWait,
-    getDocumentBody,
-    getIFrameSrc,
-    getRootEl,
-    fixedEncodeURI,
-    defaultParamsWithoutHiddenActions as defaultParams,
-    expectUrlMatchesWithParams,
-    expectUrlToHaveParamsWithValues,
-} from '../test/test-utils';
-
-describe('BodylessConversation', () => {
-    const thoughtSpotHost = 'tshost';
-
-    beforeAll(() => {
-        init({
-            thoughtSpotHost,
-            authType: AuthType.None,
-        });
-        jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve({}));
-        spyOn(window, 'alert');
-        document.body.innerHTML = getDocumentBody();
-    });
-
-    beforeEach(() => {
-        fetchMock.resetMocks();
-    });
-
-    test('should render the bodyless conversation embed', async () => {
-        fetchMock.mockResponses(
-            JSON.stringify({
-                data: {
-                    ConvAssist__createConversation: {
-                        convId: 'conversationId',
-                        initialCtx: {
-                            type: 'TS_ANSWER',
-                            tsAnsCtx: {
-                                sessionId: 'sessionId',
-                                genNo: 1,
-                                stateKey: {
-                                    transactionId: 'transactionId',
-                                    generationNumber: 1,
-                                },
-                                worksheet: {
-                                    worksheetId: 'worksheetId',
-                                    worksheetName: 'GTM',
-                                },
-                            },
-                        },
-                    },
-                },
-            }),
-            JSON.stringify({
-                data: {
-                    ConvAssist__sendMessage: {
-                        responses: [
-                            {
-                                msgId: 'msgId',
-                                data: {
-                                    asstRespData: {
-                                        tool: 'TS_NLS',
-                                        asstRespText: '',
-                                        nlsAnsData: {
-                                            sageQuerySuggestions: [
-                                                {
-                                                    llmReasoning: {
-                                                        assumptions: 'You want the total [COL|sales] for [COL|item_type] [VAL|jackets] for [VAL|this year].',
-                                                        clarifications: '',
-                                                        interpretation: '',
-                                                        __typename: 'eureka_SageQuerySuggestion_LLMReasoning',
-                                                    },
-                                                    tokens: [
-                                                        'sum sales',
-                                                        "item type = 'jackets'",
-                                                        "date = 'this year'",
-                                                    ],
-                                                    tmlTokens: [
-                                                        'sum [sales]',
-                                                        "[date] = [date].'this year'",
-                                                        "[item type] = [item type].'jackets'",
-                                                    ],
-                                                    worksheetId: 'worksheetId',
-                                                    description: '',
-                                                    title: '',
-                                                    cached: false,
-                                                    sqlQuery: "SELECT SUM(sales) FROM __Sample_Retail_Apparel WHERE item_type = 'jackets' AND date = _this_year();",
-                                                    sessionId: 'sessionId',
-                                                    genNo: 2,
-                                                    formulaInfo: [],
-                                                    tmlPhrases: [],
-                                                    stateKey: {
-                                                        transactionId: 'transactionId',
-                                                        generationNumber: 1,
-                                                        __typename: 'sage_auto_complete_v2_ACStateKey',
-                                                    },
-                                                    __typename: 'eureka_SageQuerySuggestion',
-                                                },
-                                            ],
-                                            responseType: 'ANSWER',
-                                            __typename: 'convassist_nls_tool_NLSToolAsstRespData',
-                                        },
-                                        __typename: 'convassist_AsstResponseData',
-                                    },
-                                    __typename: 'convassist_MessageData',
-                                },
-                                type: 'ASST_RESPONSE',
-                                __typename: 'convassist_MessagePayload',
-                            },
-                        ],
-                        __typename: 'convassist_SendMessageResponse',
-                    },
-                },
-            }),
-        );
-        const viewConfig: BodylessConversationViewConfig = {
-            worksheetId: 'worksheetId',
-        };
-
-        const conversationEmbed = new BodylessConversation(viewConfig);
-        const result = await conversationEmbed.sendMessage('userMessage');
-        console.log(result.container);
-        const iframeSrc = getIFrameSrc(result.container);
-        expectUrlToHaveParamsWithValues(iframeSrc, {
-            sessionId: 'sessionId',
-            genNo: 2,
-            acSessionId: 'transactionId',
-            acGenNo: 1,
-        });
-
-        fetchMock.mockRejectOnce(
-            new Error('error'),
-        );
-        const errorResult = await conversationEmbed.sendMessage('userMessage');
-        expect(errorResult.error instanceof Error).toBeTruthy();
-    });
-});

package/src/embed/bodyless-conversation.ts

@@ -1,95 +0,0 @@
-import { ViewConfig, Param } from '../types';
-import { TsEmbed } from './ts-embed';
-import { Conversation as ConversationService } from '../utils/graphql/nlsService/conversation-service';
-import { getEmbedConfig } from './embedConfig';
-import { getQueryParamString } from '../utils';
-
-export interface BodylessConversationViewConfig extends ViewConfig {
-    /**
-     * The ID of the worksheet to use for the conversation.
-     */
-    worksheetId: string;
-}
-
-interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
-    sessionId: string;
-    genNo: number;
-    acSessionId: string;
-    acGenNo: number;
-}
-
-class ConversationMessage extends TsEmbed {
-    constructor(container: HTMLElement, protected viewConfig: ConversationMessageViewConfig) {
-        super(container, viewConfig);
-    }
-
-    public getIframeSrc() {
-        const {
-            sessionId,
-            genNo,
-            acSessionId,
-            acGenNo,
-        } = this.viewConfig;
-        const path = 'conv-assist-answer';
-        const queryParams = this.getBaseQueryParams();
-
-        queryParams[Param.HideActions] = [...(queryParams[Param.HideActions] ?? [])];
-        let query = '';
-        const queryParamsString = getQueryParamString(queryParams, true);
-        if (queryParamsString) {
-            query = `?${queryParamsString}`;
-        }
-        const tsPostHashParams = this.getThoughtSpotPostUrlParams({
-            sessionId,
-            genNo,
-            acSessionId,
-            acGenNo,
-        });
-
-        return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
-    }
-
-    public async render(): Promise<ConversationMessage> {
-        super.render();
-        const src = this.getIframeSrc();
-        await this.renderIFrame(src);
-        return this;
-    }
-}
-
-/**
- * Create a conversation embed, which can be integrated inside
- * chatbots or other conversational interfaces.
- * @group Embed components
- * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
- */
-export class BodylessConversation {
-    private conversationService: ConversationService;
-
-    constructor(private viewConfig: BodylessConversationViewConfig) {
-        const embedConfig = getEmbedConfig();
-
-        this.conversationService = new ConversationService(
-            embedConfig.thoughtSpotHost,
-            viewConfig.worksheetId,
-        );
-    }
-
-    public async sendMessage(userMessage: string) {
-        const { data, error } = await this.conversationService.sendMessage(userMessage);
-        if (error) {
-            return { error };
-        }
-
-        const container = document.createElement('div');
-        const embed = new ConversationMessage(container, {
-            ...this.viewConfig,
-            sessionId: data.sessionId,
-            genNo: data.genNo,
-            acSessionId: data.stateKey.transactionId,
-            acGenNo: data.stateKey.generationNumber,
-        });
-        await embed.render();
-        return { container };
-    }
-}

package/src/embed/conversation.spec.ts

@@ -1,46 +0,0 @@
-import {
-    ConversationEmbed,
-    ConversationViewConfig,
-} from './conversation';
-import * as authInstance from '../auth';
-import { init } from '../index';
-import { Action, AuthType, RuntimeFilterOp } from '../types';
-import {
-    executeAfterWait,
-    getDocumentBody,
-    getIFrameSrc,
-    getRootEl,
-    fixedEncodeURI,
-    defaultParamsWithoutHiddenActions as defaultParams,
-    expectUrlMatchesWithParams,
-} from '../test/test-utils';
-
-const thoughtSpotHost = 'tshost';
-
-beforeAll(() => {
-    init({
-        thoughtSpotHost,
-        authType: AuthType.None,
-    });
-    jest.spyOn(authInstance, 'postLoginService').mockImplementation(() => Promise.resolve({}));
-    spyOn(window, 'alert');
-    document.body.innerHTML = getDocumentBody();
-});
-
-describe('ConversationEmbed', () => {
-    it('should render the conversation embed', async () => {
-        const viewConfig: ConversationViewConfig = {
-            worksheetId: 'worksheetId',
-            searchOptions: {
-                searchQuery: 'searchQuery',
-            },
-        };
-
-        const conversationEmbed = new ConversationEmbed(getRootEl(), viewConfig);
-        await conversationEmbed.render();
-        expectUrlMatchesWithParams(
-            getIFrameSrc(),
-            `http://${thoughtSpotHost}/v2/?${defaultParams}#/embed/insights/conv-assist?worksheet=worksheetId&query=searchQuery`,
-        );
-    });
-});

package/src/embed/conversation.ts

@@ -1,58 +0,0 @@
-import { ViewConfig, Param } from '../types';
-import { TsEmbed } from './ts-embed';
-import { getQueryParamString } from '../utils';
-
-/**
- * Configuration for search options
- */
-export interface SearchOptions {
-    /**
-     * The query string to pass to start the Conversation.
-     */
-    searchQuery: string;
-}
-
-export interface ConversationViewConfig extends ViewConfig {
-    /**
-     * The ID of the worksheet to use for the conversation.
-     */
-    worksheetId: string;
-    /**
-     * Ability to pass a starting search query to the conversation.
-     */
-    searchOptions?: SearchOptions;
-}
-
-export class ConversationEmbed extends TsEmbed {
-    constructor(container: HTMLElement, protected viewConfig: ConversationViewConfig) {
-        super(container, viewConfig);
-    }
-
-    public getIframeSrc() {
-        const {
-            worksheetId,
-            searchOptions,
-        } = this.viewConfig;
-        const path = 'insights/conv-assist';
-        const queryParams = this.getBaseQueryParams();
-
-        let query = '';
-        const queryParamsString = getQueryParamString(queryParams, true);
-        if (queryParamsString) {
-            query = `?${queryParamsString}`;
-        }
-        const tsPostHashParams = this.getThoughtSpotPostUrlParams({
-            worksheet: worksheetId,
-            query: searchOptions.searchQuery,
-        });
-
-        return `${this.getEmbedBasePath(query)}/embed/${path}${tsPostHashParams}`;
-    }
-
-    public async render(): Promise<ConversationEmbed> {
-        super.render();
-        const src = this.getIframeSrc();
-        await this.renderIFrame(src);
-        return this;
-    }
-}

package/src/utils/global-styles.spec.ts

@@ -1,20 +0,0 @@
-import { getDocumentBody } from '../test/test-utils';
-import { addPreviewStylesIfNotPresent } from './global-styles';
-
-describe('addPreviewStylesIfNotPresent', () => {
-    afterEach(() => {
-        document.body.innerHTML = getDocumentBody();
-    });
-    it('should not add preview styles if present', () => {
-        document.body.innerHTML = '<div id="ts-preview-style">test</div>';
-        addPreviewStylesIfNotPresent();
-        const styleEl = document.getElementById('ts-preview-style');
-        expect(styleEl.innerHTML).toBe('test');
-    });
-
-    it('should add preview styles if not present', () => {
-        addPreviewStylesIfNotPresent();
-        const styleEl = document.getElementById('ts-preview-style');
-        expect(styleEl).not.toBeNull();
-    });
-});

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

@@ -1,310 +0,0 @@
-export const createConversation = `
-mutation CreateConversation($params: Input_convassist_CreateConversationRequest) {
-  ConvAssist__createConversation(request: $params) {
-    convId
-    initialCtx {
-      type
-      tsAnsCtx {
-        sessionId
-        genNo
-        stateKey {
-          transactionId
-          generationNumber
-        }
-        worksheet {
-          worksheetId
-          worksheetName
-        }
-      }
-    }
-  }
-}
-`;
-
-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
-  }
-}
-`;