@thoughtspot/visual-embed-sdk 1.46.0 → 1.46.2

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