@thoughtspot/visual-embed-sdk 1.46.1 → 1.46.2

package/src/embed/sage.ts

@@ -30,7 +30,7 @@ export interface SearchOptions {
 /**
  * The configuration attributes for the embedded Natural language search view. Based on
  * GPT and LLM.
- * @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
  * 
  * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
  * @group Embed components
@@ -85,14 +85,14 @@ export interface SageViewConfig
     hideAutocompleteSuggestions?: boolean;
     /**
      * Show or hide autocomplete suggestions for the search query string.
+     * You can use {@link hideAutocompleteSuggestions} instead.
      * @deprecated
      * Currently, the object suggestions will not be shown for Natural Language Search.
-     * You can use {@link hideAutocompleteSuggestions} instead.
      */
     showObjectSuggestions?: boolean;
     /**
      * Show or hide sample questions.
-     * The sample questions are autogenerated based on the data Model.
+     * The sample questions are autogenerated based on the data model
      * selected for the search operation.
      * 
      * Supported embed types: `SageEmbed`
@@ -122,6 +122,7 @@ export interface SageViewConfig
      * the token string in the search bar.
      * 
      * Supported embed types: `SageEmbed`
+     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      * @example
      * ```js
      * searchOptions: {
@@ -129,13 +130,12 @@ export interface SageViewConfig
      *    executeSearch: true,
      * }
      * ```
-     * @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
      */
     searchOptions?: SearchOptions;
 }
 /**
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
- * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
  * 
  * Note: This embed will be deprecated from SDK: 1.40.0 | ThoughtSpot: 10.13.0.cl
  * @group Embed components

package/src/embed/search-bar.tsx

@@ -12,8 +12,8 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
      * Only a single data source is supported currently.
      * 
      * Supported embed types: `SearchBarEmbed`
+     * @version SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
      * @deprecated Use `dataSource` instead
-     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -27,7 +27,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
      * Pass the ID of the source to be selected.
      * 
      * Supported embed types: `SearchBarEmbed`
-     * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -41,7 +41,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
      * Boolean to define if the last selected data source should be used
      * 
      * Supported embed types: `SearchBarEmbed`
-     * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
+     * @version SDK: 1.24.0 | ThoughtSpot: 9.5.0.cl, 9.5.0.sw
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -63,7 +63,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
      * the token string in the search bar.
      * 
      * Supported embed types: `SearchBarEmbed`
-     * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
+     * @version SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
      * @example
      * ```js
      * const embed = new SearchBarEmbed('#tsEmbed', {
@@ -81,10 +81,10 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
      * If set to true, the search token string is not appended to the URL.
      * 
      * Supported embed types: `SearchBarEmbed`
-     * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
+     * @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
      * @example
      * ```js
-     * const embed = new SearchEmbed('#tsEmbed', {
+     * const embed = new SearchBarEmbed('#tsEmbed', {
      *  searchOptions: {
      *    searchTokenString: '[quantity purchased] [region]',
      *    executeSearch: true,
@@ -102,7 +102,7 @@ export interface SearchAppInitData extends DefaultAppInitData {
 
 /**
  * Embed ThoughtSpot search bar
- * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+ * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
  * @group Embed components
  */
 export class SearchBarEmbed extends TsEmbed {

package/src/embed/search.ts

@@ -77,7 +77,7 @@ export interface SearchViewConfig
      * but can be expanded manually.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -92,7 +92,7 @@ export interface SearchViewConfig
      * but can be expanded manually.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
+     * @version SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -106,7 +106,7 @@ export interface SearchViewConfig
      * Show or hide the data sources panel.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
+     * @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -122,7 +122,7 @@ export interface SearchViewConfig
      * using raw answer data.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
+     * @version SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -151,7 +151,7 @@ export interface SearchViewConfig
      * format for presenting search data.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -164,6 +164,7 @@ export interface SearchViewConfig
     /**
      * The array of data source GUIDs to set on load.
      * Only a single data source is supported currently.
+     * Use {@link dataSource} instead.
      * @deprecated Use `dataSource` instead.
      * 
      * Supported embed types: `SearchEmbed`
@@ -177,10 +178,10 @@ export interface SearchViewConfig
      */
     dataSources?: string[];
     /**
-     * The array of data source GUIDs to set on load.
+     * The data source GUID to set on load.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.19.0
+     * @version SDK: 1.19.0
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -192,9 +193,9 @@ export interface SearchViewConfig
     dataSource?: string;
     /**
      * The initial search query to load the answer with.
+     * Use {@link searchOptions} instead.
      * @deprecated
      *
-     * Use {@link searchOptions} instead.
      */
     searchQuery?: string;
     /**
@@ -223,7 +224,7 @@ export interface SearchViewConfig
      * If set to true, the search token string is not appended to the URL.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
+     * @version SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -240,7 +241,7 @@ export interface SearchViewConfig
      * The GUID of a saved answer to load initially.
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     * @version SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
      * @example
      * ```js
      * const embed = new SearchEmbed('#tsEmbed', {
@@ -269,14 +270,14 @@ export interface SearchViewConfig
      * Flag to set if last selected dataSource should be used
      * 
      * Supported embed types: `SearchEmbed`
-     * @version: SDK: 1.24.0
+     * @version SDK: 1.24.0
      */
     useLastSelectedSources?: boolean;
     /**
      * To set the initial state of the search bar in case of saved-answers.
-     * @default false
      * @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
      * @deprecated Use {@link collapseSearchBar} instead
+     * @default false
      */
     collapseSearchBarInitially?: boolean;
     /**

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

@@ -2034,6 +2034,36 @@ describe('Unit test case for ts embed', () => {
                 + `&locale=ja-JP${defaultParamsPost}#/home`,
             );
         });
+        it('Sets both params when enableLinkOverridesV2 is set', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+                liveboardId: 'test-lb',
+                enableLinkOverridesV2: true,
+            });
+            await liveboardEmbed.render();
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&${defaultParamsForPinboardEmbed}&enableLinkOverridesV2=true&linkOverride=true${defaultParamsPost}#/embed/viz/test-lb`,
+            );
+        });
+        it('Sets only linkOverride when enableLinkOverridesV2 is not set', async () => {
+            const liveboardEmbed = new LiveboardEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+                liveboardId: 'test-lb',
+                linkOverride: true,
+            });
+            await liveboardEmbed.render();
+            expectUrlMatchesWithParams(
+                getIFrameSrc(),
+                `http://${thoughtSpotHost}/?embedApp=true&${defaultParamsForPinboardEmbed}&linkOverride=true${defaultParamsPost}#/embed/viz/test-lb`,
+            );
+        });
         it('Sets the iconSprite url', async () => {
             const appEmbed = new AppEmbed(getRootEl(), {
                 frameParams: {
@@ -4513,4 +4543,16 @@ describe('ShowPreRender with UpdateEmbedParams', () => {
 
         handleErrorSpy.mockRestore();
     });
+
+    test('should set allow "local-network-access" correctly on the iframe', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            frameParams: { width: '100%', height: '100%' },
+        });
+        await appEmbed.render();
+        const iframe = getIFrameEl();
+        expect(iframe.allow).toContain('local-network-access');
+        expect(iframe.allow).toContain('fullscreen');
+        expect(iframe.allow).toContain('clipboard-read');
+        expect(iframe.allow).toContain('clipboard-write');
+    });
 });

package/src/embed/ts-embed.ts

@@ -174,9 +174,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;
@@ -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/react/index.tsx

@@ -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
  */