@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.3

package/src/embed/ts-embed.ts

@@ -34,7 +34,7 @@ import {
     setStyleProperties,
     removeStyleProperties,
     isUndefined,
-} from '../utils';
+ getHostEventsConfig } from '../utils';
 import { getCustomActions } from '../utils/custom-actions';
 import {
     getThoughtSpotHost,
@@ -78,7 +78,6 @@ import { ERROR_MESSAGE } from '../errors';
 import { getPreauthInfo } from '../utils/sessionInfoService';
 import { HostEventClient } from './hostEventClient/host-event-client';
 import { getInterceptInitData, handleInterceptEvent, processApiInterceptResponse, processLegacyInterceptResponse } from '../api-intercept';
-import { getHostEventsConfig } from '../utils';
 
 const { version } = pkgInfo;
 
@@ -174,9 +173,9 @@ export class TsEmbed {
     private isPreRendered: boolean;
 
     /**
-     * Should we encode URL Query Params using base64 encoding which thoughtspot
+     * Should we encode URL Query Params using base64 encoding which ThoughtSpot
      * will generate for embedding. This provides additional security to
-     * thoughtspot clusters against Cross site scripting attacks.
+     * ThoughtSpot clusters against Cross site scripting attacks.
      * @default false
      */
     private shouldEncodeUrlQueryParams = false;
@@ -562,7 +561,8 @@ export class TsEmbed {
      */
     private updateAuthToken = async (_: MessagePayload, responder: any) => {
         const { authType, autoLogin: autoLoginConfig } = this.embedConfig;
-        // Default autoLogin: true for cookieless if undefined/null, otherwise false
+        // Default autoLogin: true for cookieless if undefined/null, otherwise
+        // false
         const autoLogin = autoLoginConfig ?? (authType === AuthType.TrustedAuthTokenCookieless);
         
         try {
@@ -699,6 +699,7 @@ export class TsEmbed {
             customizations,
             contextMenuTrigger,
             linkOverride,
+            enableLinkOverridesV2,
             insertInToSlide,
             disableRedirectionLinksInNewTab,
             overrideOrgId,
@@ -786,8 +787,12 @@ export class TsEmbed {
         if (locale !== undefined) {
             queryParams[Param.Locale] = locale;
         }
-
-        if (linkOverride) {
+        // TODO: Once V2 is stable, send both flags when
+        // linkOverride is true (remove the else-if).
+        if (enableLinkOverridesV2) {
+            queryParams[Param.EnableLinkOverridesV2] = true;
+            queryParams[Param.LinkOverride] = true;
+        } else if (linkOverride) {
             queryParams[Param.LinkOverride] = linkOverride;
         }
         if (insertInToSlide) {
@@ -867,7 +872,7 @@ export class TsEmbed {
         iFrame.mozallowfullscreen = true;
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
-        iFrame.allow = 'clipboard-read; clipboard-write; fullscreen;';
+        iFrame.allow = 'clipboard-read; clipboard-write; fullscreen; local-network-access;';
 
         const frameParams = this.viewConfig.frameParams;
         const { height: frameHeight, width: frameWidth, ...restParams } = frameParams || {};
@@ -1751,7 +1756,7 @@ export class TsEmbed {
      * Returns the answerService which can be used to make arbitrary graphql calls on top
      * session.
      * @param vizId [Optional] to get for a specific viz in case of a Liveboard.
-     * @version SDK: 1.25.0 / ThoughtSpot 9.10.0
+     * @version SDK: 1.25.0 | ThoughtSpot: 9.10.0
      */
     public async getAnswerService(vizId?: string): Promise<AnswerService> {
         const { session } = await this.trigger(HostEvent.GetAnswerSession, vizId ? { vizId } : {});

package/src/index.ts

@@ -70,6 +70,7 @@ import {
     EmbedErrorDetailsEvent, 
     ErrorDetailsTypes,
     ContextType,
+    AutoMCPFrameRendererViewConfig,
 } from './types';
 import { CustomCssVariables } from './css-variables';
 import { SageEmbed, SageViewConfig } from './embed/sage';
@@ -166,6 +167,8 @@ export {
     EmbedErrorCodes,
     EmbedErrorDetailsEvent,
     ErrorDetailsTypes,
+    AutoMCPFrameRendererViewConfig,
 };
 
 export { resetCachedAuthToken } from './authToken';
+export { startAutoMCPFrameRenderer } from './embed/auto-frame-renderer';

package/src/react/index.spec.tsx

@@ -288,7 +288,8 @@ describe('React Components', () => {
             ).toBe(true);
         });
 
-        // Note: insertAsSibling is not supported for SpotterMessage as it's not part of the allowed props
+        // Note: insertAsSibling is not supported for SpotterMessage as it's
+        // not part of the allowed props
     });
 
     describe('Component Factory Coverage', () => {
@@ -416,7 +417,8 @@ describe('React Components', () => {
             const TestComponent = () => {
                 const { sendMessage } = useSpotterAgent({ worksheetId: 'test-worksheet' });
                 
-                // Call sendMessage immediately before service has time to initialize
+                // Call sendMessage immediately before service has time to
+                // initialize
                 sendMessageResult = sendMessage('test query');
                 
                 return <div>Test</div>;
@@ -727,7 +729,8 @@ describe('React Components', () => {
 
              const { rerender } = render(<TestComponent worksheetId="worksheet1" />);
              
-             // This should trigger the "if (serviceRef.current)" branch in useEffect
+             // This should trigger the "if (serviceRef.current)" branch in
+             // useEffect
              rerender(<TestComponent worksheetId="worksheet1" />);
              rerender(<TestComponent worksheetId="worksheet2" />);
              rerender(<TestComponent worksheetId="worksheet3" />);

package/src/react/index.tsx

@@ -86,7 +86,7 @@ const componentFactory = <T extends typeof TsEmbed, U extends EmbedProps, V exte
             });
             handleRendering(tsEmbed);
             if (forwardedRef) {
-                // eslint-disable-next-line no-param-reassign
+                 
                 forwardedRef.current = tsEmbed;
             }
             return () => {
@@ -111,6 +111,9 @@ interface PreRenderProps {
      * PreRender id to be used for PreRendering the embed.
      * Use PreRender to render the embed in the background and then
      * show or hide the rendered embed using showPreRender or hidePreRender respectively.
+     *
+     * Use PreRendered react component for pre rendering embed components.
+     * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
      * @example
      * ```js
      * const embed = new LiveboardEmbed('#embed', {
@@ -119,8 +122,6 @@ interface PreRenderProps {
      * });
      * embed.showPreRender();
      * ```
-     *
-     * Use PreRendered react component for pre rendering embed components.
      * @example
      * ```tsx
      * function LandingPageComponent() {
@@ -131,7 +132,6 @@ interface PreRenderProps {
      *  return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
      * }
      * ```
-     * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
      */
     preRenderId: string;
 }
@@ -164,7 +164,7 @@ interface AppProps extends EmbedProps, AppViewConfig { }
  * React component for Full app Embed.
  * @example
  * ```tsx
- * function Search() {
+ * function App() {
  *  return <AppEmbed
  *      showPrimaryNavbar={false}
  *      pageId={Page.Liveboards}
@@ -176,9 +176,9 @@ interface AppProps extends EmbedProps, AppViewConfig { }
 export const AppEmbed = componentFactory<typeof _AppEmbed, AppProps, AppViewConfig>(_AppEmbed);
 
 /**
- * React component for PreRendered Liveboard embed.
+ * React component for PreRendered App embed.
  *
- * PreRenderedAppEmbed will preRender the SearchBarEmbed and will be hidden by
+ * PreRenderedAppEmbed will preRender the AppEmbed and will be hidden by
  * default.
  *
  * AppEmbed with preRenderId passed will call showPreRender on the embed.
@@ -231,7 +231,7 @@ export const PinboardEmbed = LiveboardEmbed;
  * LiveboardEmbed with preRenderId passed will call showPreRender on the embed.
  *
  * If LiveboardEmbed is rendered before PreRenderedLiveboardEmbed is rendered it
- * tries to preRender the LiveboardEmbed, so it is recommended to use pass the
+ * tries to preRender the LiveboardEmbed, so it is recommended to pass the
  * liveboardId to both the components.
  * @example
  * ```tsx
@@ -273,7 +273,7 @@ export const SearchBarEmbed = componentFactory<
 >(_SearchBarEmbed);
 
 /**
- * React component for PreRendered Liveboard embed.
+ * React component for PreRendered SearchBar embed.
  *
  * PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
  * default.
@@ -315,9 +315,9 @@ export const SageEmbed = componentFactory<typeof _SageEmbed, SageEmbedProps, Sag
 );
 
 /**
- * React component for PreRendered Liveboard embed.
+ * React component for PreRendered Sage embed.
  *
- * PreRenderedSageEmbed will preRender the SearchBarEmbed and will be hidden by
+ * PreRenderedSageEmbed will preRender the SageEmbed and will be hidden by
  * default.
  *
  * SageEmbed with preRenderId passed will call showPreRender on the embed.
@@ -365,8 +365,8 @@ export const SpotterEmbed = componentFactory<
 
 /**
  * React component for LLM based conversation BI.
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
  * Use {@link SpotterEmbed} instead
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
  * @example
  * ```tsx
  * function Sage() {
@@ -410,6 +410,7 @@ type SpotterMessageProps = {
  * This component renders a single message response from your ThoughtSpot conversation,
  * showing charts, visualizations, or text responses based on the user's query.
  * 
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
  * @example
  * ```tsx
  * const { sendMessage } = useSpotterAgent({ worksheetId: 'worksheetId' });
@@ -426,7 +427,6 @@ type SpotterMessageProps = {
  *   />
  * }
  * ```
- * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
  */
 export const SpotterMessage = React.forwardRef<
     React.ComponentRef<typeof ConversationMessage>,
@@ -449,7 +449,7 @@ export const SpotterMessage = React.forwardRef<
  * PreRenderedConversationEmbed will preRender the SpotterEmbed and will be hidden by
  * default.
  *
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
+ * SpotterEmbed with preRenderId passed will call showPreRender on the embed.
  * @example
  * ```tsx
  * function LandingPageComponent() {
@@ -500,6 +500,7 @@ export function useEmbedRef<T extends EmbedComponent>():
 
 /**
  *
+ * @version SDK: 1.36.2 | ThoughtSpot: *
  * @param config - EmbedConfig
  * @returns AuthEventEmitter
  * @example
@@ -509,7 +510,6 @@ export function useEmbedRef<T extends EmbedComponent>():
  *  return <LiveboardEmbed ref={ref} liveboardId={<id>} />
  * }
  * ```
- * @version SDK: 1.36.2 | ThoughtSpot: *
  */
 export function useInit(config: EmbedConfig) {
     const ref = useRef<AuthEventEmitter | null>(null);
@@ -527,6 +527,7 @@ export function useInit(config: EmbedConfig) {
  * This hook provides a sendMessage function that allows you to send natural language
  * queries to your data and get back AI-generated responses with visualizations.
  * 
+ * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
  * @param config - Configuration object containing worksheetId and other options
  * @returns Object with sendMessage function that returns conversation results
  * @example
@@ -544,7 +545,6 @@ export function useInit(config: EmbedConfig) {
  *   }
  * };
  * ```
- * @version SDK: 1.39.0 | ThoughtSpot: 10.11.0.cl
  */
 export function useSpotterAgent(config: SpotterAgentEmbedViewConfig) {
     const serviceRef = useRef<_SpotterAgentEmbed | null>(null);

package/src/tokenizedFetch.ts

@@ -14,7 +14,7 @@ import { AuthType } from './types';
  * tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
  *   // .. fetch options ..
  * });
- *```
+ * ```
  * @version SDK: 1.28.0
  * @group Global methods
  */