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

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

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

package/src/utils/authService/authService.ts

@@ -28,6 +28,7 @@ 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/answerService.ts

@@ -29,6 +29,7 @@ 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 => {
@@ -56,6 +57,7 @@ export class AnswerService {
 
     /**
      * Should not need to be called directly.
+     *
      * @param session
      * @param answer
      * @param thoughtSpotHost
@@ -92,6 +94,7 @@ export class AnswerService {
 
     /**
      * Remove columnIds and return updated answer session.
+     *
      * @param columnIds
      * @returns
      */
@@ -106,6 +109,7 @@ export class AnswerService {
 
     /**
      * Add columnIds and return updated answer session.
+     *
      * @param columnIds
      * @returns
      */
@@ -120,6 +124,7 @@ export class AnswerService {
 
     /**
      * Add columns by names and return updated answer session.
+     *
      * @param columnNames
      * @returns
      * @example
@@ -141,6 +146,7 @@ export class AnswerService {
 
     /**
      * Add a filter to the answer.
+     *
      * @param columnName
      * @param operator
      * @param values
@@ -175,6 +181,7 @@ export class AnswerService {
 
     /**
      * Fetch data from the answer.
+     *
      * @param offset
      * @param size
      * @returns
@@ -203,6 +210,7 @@ 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
@@ -217,6 +225,7 @@ export class AnswerService {
     /**
      * Just get the internal URL for this answer's data
      * as a CSV blob.
+     *
      * @param userLocale
      * @param includeInfo
      * @returns
@@ -229,6 +238,7 @@ 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
@@ -293,6 +303,7 @@ export class AnswerService {
 
     /**
      * Execute a custom graphql query in the context of the answer.
+     *
      * @param query graphql query
      * @param variables graphql variables
      * @returns
@@ -314,6 +325,7 @@ export class AnswerService {
 
     /**
      * Get the internal session details for the answer.
+     *
      * @returns
      */
     public getSession() {

package/src/utils/processTrigger.ts

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

package/src/utils.ts

@@ -2,6 +2,7 @@
  * Copyright (c) 2023
  *
  * Common utility functions for ThoughtSpot Visual Embed SDK
+ *
  * @summary Utils
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
@@ -22,6 +23,7 @@ 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 => {
@@ -49,6 +51,7 @@ 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 => {
@@ -71,6 +74,7 @@ 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) => {
@@ -86,12 +90,14 @@ 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
  */
@@ -121,6 +127,7 @@ 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 => {
@@ -133,6 +140,7 @@ 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
  */
@@ -237,6 +245,7 @@ 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 {
@@ -271,6 +280,7 @@ 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.
@@ -294,6 +304,7 @@ 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