@thoughtspot/visual-embed-sdk 1.32.4-dc.14 → 1.32.4-dc.16

package/src/types.ts

@@ -2468,23 +2468,28 @@ 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',
@@ -2510,6 +2515,7 @@ 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
@@ -2517,6 +2523,7 @@ export enum HostEvent {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
+     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.CreateMonitor)
@@ -2527,6 +2534,7 @@ 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
@@ -2534,10 +2542,12 @@ export enum HostEvent {
      *  vizId: '730496d6-6903-4601-937e-2c691821af3c'
      * })
      * ```
+     *
      * @example
      * ```js
      * searchEmbed.trigger(HostEvent.ManageMonitor)
      * ```
+     *
      * @example
      * ```js
      * vizEmbed.trigger(HostEvent.ManageMonitor)
@@ -2935,6 +2945,7 @@ export enum HostEvent {
     /**
      * Get the answer session for a Search or
      * Liveboard visualization.
+     *
      * @example
      * ```js
      * const {session} = await embed.trigger(
@@ -2942,10 +2953,12 @@ 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',
@@ -3672,6 +3685,7 @@ export enum Action {
     /**
      * @deprecated
      * Reports errors
+     *
      * @example
      * ```js
      * disabledActions: [Action.ReportError]
@@ -3901,12 +3915,14 @@ 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]
@@ -3917,6 +3933,7 @@ export enum Action {
     /**
      * The **Add Tab** action on a Liveboard.
      * Allows adding a new tab to a Liveboard view.
+     *
      * @example
      * ```js
      * disabledActions: [Action.AddTab]
@@ -3926,7 +3943,8 @@ export enum Action {
     AddTab = 'addTab',
     /**
      *
-     *Initiates contextual change analysis on KPI charts.
+     * Initiates contextual change analysis on KPI charts.
+     *
      * @example
      * ```js
      * disabledActions: [Action.EnableContextualChangeAnalysis]
@@ -3940,6 +3958,7 @@ export enum Action {
      * ```js
      * disabledActions: [Action.ShowSageQuery]
      * ```
+     *
      * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
      */
     ShowSageQuery = 'showSageQuery',
@@ -3954,7 +3973,8 @@ 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]
@@ -4033,6 +4053,7 @@ export enum Action {
      * hiddenAction: [Action.CreateLiveboard]
      * disabledActions: [Action.CreateLiveboard]
      * ```
+     *
      * @version SDK: 1.32.0 | Thoughtspot: 10.1.0.cl
      */
     CreateLiveboard = 'createLiveboard',
@@ -4139,6 +4160,7 @@ export enum Action {
 
     /**
      * The **Manage Tags** action on Homepage Favourite Module.
+     *
      * @example
      * ```js
      * disabledActions: [Action.ManageTags]

package/src/utils/authService/tokenizedAuthService.ts

@@ -18,6 +18,7 @@ function tokenizedFailureLoggedFetch(url: string, options: RequestInit = {}): Pr
 
 /**
  * Fetches the session info from the ThoughtSpot server.
+ *
  * @param thoughtspotHost
  * @returns {Promise<any>}
  * @example
@@ -51,6 +52,7 @@ 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/liveboardService/liveboardService.ts

@@ -24,7 +24,7 @@ export const createLiveboardWithAnswers = async (
     },
     );
     const lbList = await resp.json();
-    const liveboardId = lbList[0].metadata_id;
+    const liveboardId = lbList[0]?.metadata_id;
 
     const answerTMLs = (await Promise.all(answers.map((a) => a.getTML())))
         .filter((tml: any) => tml.answer.search_query);

package/src/utils/processData.ts

@@ -32,6 +32,7 @@ export function processCustomAction(e: any, thoughtSpotHost: string) {
 
 /**
  * Responds to AuthInit sent from host signifying successful authentication in host.
+ *
  * @param e
  * @returns {any}
  */

package/src/utils/sessionInfoService.ts

@@ -19,6 +19,7 @@ let sessionInfo: null | SessionInfo = null;
  * Returns the session info object and caches it for future use.
  * Once fetched the session info object is cached and returned from the cache on
  * subsequent calls.
+ *
  * @example ```js
  * const sessionInfo = await getSessionInfo();
  * console.log(sessionInfo);
@@ -39,6 +40,7 @@ export async function getSessionInfo(): Promise<SessionInfo> {
 /**
  * Returns the cached session info object. If the client is not authenticated the
  * function will return null.
+ *
  * @example ```js
  * const sessionInfo = getCachedSessionInfo();
  * if (sessionInfo) {
@@ -56,6 +58,7 @@ export function getCachedSessionInfo(): SessionInfo | null {
 
 /**
  * Processes the session info response and returns the session info object.
+ *
  *  @param sessionInfoResp {any} Response from the session info API.
  *  @returns {SessionInfo} The session info object.
  *  @example ```js
@@ -84,6 +87,7 @@ export const getSessionDetails = (sessionInfoResp: any): SessionInfo => {
 
 /**
  * Resets the cached session info object and forces a new fetch on the next call.
+ *
  * @example ```js
  * resetCachedSessionInfo();
  * const sessionInfo = await getSessionInfo();