@thoughtspot/visual-embed-sdk 1.30.0-alpha.1 → 1.30.0

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/authService/authService.ts

@@ -28,7 +28,6 @@ function failureLoggedFetch(url: string, options: RequestInit = {}): Promise<Res
 
 /**
  * Service to validate a auth token against a ThoughtSpot host.
- *
  * @param thoughtSpotHost : ThoughtSpot host to verify the token against.
  * @param authToken : Auth token to verify.
  */

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

@@ -67,6 +67,9 @@ export const getAnswer = `
             ${bachSessionId}
             answer {
                 id
+                name
+                description
+                displayMode
                 sources {
                     header {
                         guid
@@ -136,3 +139,19 @@ export const getAnswerData = `
         }
     }
 `;
+
+export const addVizToLiveboard = `
+    mutation AddVizToLiveboard(liveboardId: GUID!, session: BachSessionIdInput!, tabId: GUID, vizId: GUID!) {
+        Answer__addVizToPinboard(
+            pinboardId: liveboardId
+
+            session: $session
+
+            tabId: $tabId
+
+            vizId: $vizId
+        ) {
+            ${bachSessionId}
+        }
+    }
+`;

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

@@ -29,7 +29,6 @@ export interface UnderlyingDataPoint {
  * custom action payload. This service could be used to run
  * graphql queries in the context of the answer on which the
  * custom action was triggered.
- *
  * @example
  * ```js
  *  embed.on(EmbedEvent.CustomAction, e => {
@@ -57,7 +56,6 @@ export class AnswerService {
 
     /**
      * Should not need to be called directly.
-     *
      * @param session
      * @param answer
      * @param thoughtSpotHost
@@ -94,7 +92,6 @@ export class AnswerService {
 
     /**
      * Remove columnIds and return updated answer session.
-     *
      * @param columnIds
      * @returns
      */
@@ -109,7 +106,6 @@ export class AnswerService {
 
     /**
      * Add columnIds and return updated answer session.
-     *
      * @param columnIds
      * @returns
      */
@@ -124,21 +120,20 @@ export class AnswerService {
 
     /**
      * Add columns by names and return updated answer session.
-     *
      * @param columnNames
      * @returns
      * @example
      * ```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]);
@@ -146,7 +141,6 @@ export class AnswerService {
 
     /**
      * Add a filter to the answer.
-     *
      * @param columnName
      * @param operator
      * @param values
@@ -181,7 +175,6 @@ export class AnswerService {
 
     /**
      * Fetch data from the answer.
-     *
      * @param offset
      * @param size
      * @returns
@@ -210,7 +203,6 @@ export class AnswerService {
     /**
      * Fetch the data for the answer as a CSV blob. This might be
      * quicker for larger data.
-     *
      * @param userLocale
      * @param includeInfo Include the CSV header in the output
      * @returns Response
@@ -225,7 +217,6 @@ export class AnswerService {
     /**
      * Just get the internal URL for this answer's data
      * as a CSV blob.
-     *
      * @param userLocale
      * @param includeInfo
      * @returns
@@ -238,7 +229,6 @@ export class AnswerService {
      * Get underlying data given a point and the output column names.
      * In case of a context menu action, the selectedPoints are
      * automatically passed.
-     *
      * @param outputColumnNames
      * @param selectedPoints
      * @example
@@ -303,7 +293,6 @@ export class AnswerService {
 
     /**
      * Execute a custom graphql query in the context of the answer.
-     *
      * @param query graphql query
      * @param variables graphql variables
      * @returns
@@ -325,7 +314,6 @@ export class AnswerService {
 
     /**
      * Get the internal session details for the answer.
-     *
      * @returns
      */
     public getSession() {

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',

package/src/utils/processTrigger.ts

@@ -3,7 +3,6 @@ import { HostEvent } from '../types';
 
 /**
  * Reloads the ThoughtSpot iframe.
- *
  * @param iFrame
  */
 export const reload = (iFrame: HTMLIFrameElement) => {
@@ -16,7 +15,6 @@ export const reload = (iFrame: HTMLIFrameElement) => {
 
 /**
  * Post iframe message.
- *
  * @param iFrame
  * @param message
  * @param message.type

package/src/utils.ts

@@ -2,7 +2,6 @@
  * Copyright (c) 2023
  *
  * Common utility functions for ThoughtSpot Visual Embed SDK
- *
  * @summary Utils
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
@@ -23,7 +22,6 @@ import {
  * Refer to the following docs for more details on runtime filter syntax:
  * https://cloud-docs.thoughtspot.com/admin/ts-cloud/apply-runtime-filter.html
  * https://cloud-docs.thoughtspot.com/admin/ts-cloud/runtime-filter-operators.html
- *
  * @param runtimeFilters
  */
 export const getFilterQuery = (runtimeFilters: RuntimeFilter[]): string | null => {
@@ -51,7 +49,6 @@ export const getFilterQuery = (runtimeFilters: RuntimeFilter[]): string | null =
 
 /**
  * Construct a runtime parameter override query string from the given option.
- *
  * @param runtimeParameters
  */
 export const getRuntimeParameters = (runtimeParameters: RuntimeParameter[]): string => {
@@ -74,7 +71,6 @@ export const getRuntimeParameters = (runtimeParameters: RuntimeParameter[]): str
 /**
  * Convert a value to a string representation to be sent as a query
  * parameter to the ThoughtSpot app.
- *
  * @param value Any parameter value
  */
 const serializeParam = (value: any) => {
@@ -90,14 +86,12 @@ const serializeParam = (value: any) => {
  * Convert a value to a string:
  * in case of an array, we convert it to CSV.
  * in case of any other type, we directly return the value.
- *
  * @param value
  */
 const paramToString = (value: any) => (Array.isArray(value) ? value.join(',') : value);
 
 /**
  * Return a query param string composed from the given params object
- *
  * @param queryParams
  * @param shouldSerializeParamValues
  */
@@ -127,7 +121,6 @@ export const getQueryParamString = (
 /**
  * Get a string representation of a dimension value in CSS
  * If numeric, it is considered in pixels.
- *
  * @param value
  */
 export const getCssDimension = (value: number | string): string => {
@@ -140,7 +133,6 @@ export const getCssDimension = (value: number | string): string => {
 
 /**
  * Append a string to a URL's hash fragment
- *
  * @param url A URL
  * @param stringToAppend The string to append to the URL hash
  */
@@ -245,7 +237,6 @@ export const getRuntimeFilters = (runtimefilters: any) => getFilterQuery(runtime
 /**
  * Gets a reference to the DOM node given
  * a selector.
- *
  * @param domSelector
  */
 export function getDOMNode(domSelector: DOMSelector): HTMLElement {
@@ -280,7 +271,6 @@ export function removeTypename(obj: any) {
 
 /**
  * Sets the specified style properties on an HTML element.
- *
  * @param {HTMLElement} element - The HTML element to which the styles should be applied.
  * @param {Partial<CSSStyleDeclaration>} styleProperties - An object containing style
  * property names and their values.
@@ -304,7 +294,6 @@ export const setStyleProperties = (
 };
 /**
  * Removes specified style properties from an HTML element.
- *
  * @param {HTMLElement} element - The HTML element from which the styles should be removed.
  * @param {string[]} styleProperties - An array of style property names to be removed.
  * @example