@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0-test

package/dist/src/react/index.d.ts

@@ -5,40 +5,74 @@ import { SearchEmbed as _SearchEmbed, SearchViewConfig } from '../embed/search';
 import { AppEmbed as _AppEmbed, AppViewConfig } from '../embed/app';
 import { LiveboardEmbed as _LiveboardEmbed, LiveboardViewConfig } from '../embed/liveboard';
 import { SpotterAgentEmbedViewConfig, ConversationMessage as _ConversationMessage, SpotterAgentMessageViewConfig } from '../embed/bodyless-conversation';
-import { EmbedConfig } from '../types';
+import { EmbedConfig, PreRenderConfig } from '../types';
 import { EmbedProps } from './util';
 import { SpotterEmbed as _SpotterEmbed, SpotterEmbedViewConfig, ConversationEmbed as _ConversationEmbed, ConversationViewConfig } from '../embed/conversation';
 interface SearchProps extends EmbedProps, SearchViewConfig {
 }
-interface PreRenderProps {
+/**
+ * The PreRendered components require a preRender id. It can be supplied either
+ * through `preRenderConfig.preRenderId` (SDK: 1.52.0 and later) or through the
+ * top-level `preRenderId` prop (SDK: 1.25.0 and later, now deprecated).
+ * `preRenderConfig.preRenderId` takes precedence when both are set.
+ *
+ * Use PreRender to render the embed in the background and then
+ * show or hide the rendered embed using showPreRender or hidePreRender respectively.
+ * @example
+ * ```tsx
+ * // Preferred, SDK: 1.52.0 and later.
+ * function LandingPageComponent() {
+ *  return <PreRenderedLiveboardEmbed
+ *      preRenderConfig={{ preRenderId: "someId" }}
+ *      liveboardId="libId"
+ *  />
+ * }
+ *
+ * function MyComponent() {
+ *  return <LiveboardEmbed
+ *      preRenderConfig={{ preRenderId: "someId" }}
+ *      liveboardId="libId"
+ *  />
+ * }
+ * ```
+ * @example
+ * ```tsx
+ * // Deprecated top-level preRenderId, still supported.
+ * function LandingPageComponent() {
+ *  return <PreRenderedLiveboardEmbed preRenderId="someId" liveboardId="libId" />
+ * }
+ * ```
+ */
+type 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', {
-     *   ... // other liveboard view config
-     *   preRenderId: "preRenderId-123"
-     * });
-     * embed.showPreRender();
-     * ```
-     * @example
-     * ```tsx
-     * function LandingPageComponent() {
-     *  return <PreRenderedLiveboardEmbed preRenderId="someId" liveboardId="libId" />
-     * }
-     * ```
-     * function MyComponent() {
-     *  return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
-     * }
-     * ```
+     * @deprecated Use `preRenderConfig.preRenderId` instead.
      */
     preRenderId: string;
-}
+    /**
+     * Configuration for the pre-render wrapper element.
+     * See {@link PreRenderConfig} for available options.
+     * @version SDK: 1.52.0
+     */
+    preRenderConfig?: PreRenderConfig;
+} | {
+    /**
+     * PreRender id to be used for PreRendering the embed.
+     * @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl
+     * @deprecated Use `preRenderConfig.preRenderId` instead.
+     */
+    preRenderId?: string;
+    /**
+     * Configuration for the pre-render wrapper element. `preRenderId` is
+     * required here when the top-level `preRenderId` prop is not passed.
+     * See {@link PreRenderConfig} for available options.
+     * @version SDK: 1.52.0
+     */
+    preRenderConfig: PreRenderConfig & {
+        preRenderId: string;
+    };
+};
 /**
  * React component for Search Embed.
  * @example
@@ -52,7 +86,7 @@ interface PreRenderProps {
  * ```
  */
 export declare const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<_SearchEmbed>>;
-export declare const PreRenderedSearchEmbed: React.ForwardRefExoticComponent<SearchProps & PreRenderProps & React.RefAttributes<_SearchEmbed>>;
+export declare const PreRenderedSearchEmbed: React.ForwardRefExoticComponent<(SearchProps & PreRenderProps) & React.RefAttributes<_SearchEmbed>>;
 interface AppProps extends EmbedProps, AppViewConfig {
 }
 /**
@@ -87,7 +121,7 @@ export declare const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.
  * }
  * ```
  */
-export declare const PreRenderedAppEmbed: React.ForwardRefExoticComponent<AppProps & PreRenderProps & React.RefAttributes<_AppEmbed>>;
+export declare const PreRenderedAppEmbed: React.ForwardRefExoticComponent<(AppProps & PreRenderProps) & React.RefAttributes<_AppEmbed>>;
 interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
 }
 /**
@@ -127,8 +161,8 @@ export declare const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardPro
  * }
  * ```
  */
-export declare const PreRenderedLiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & PreRenderProps & React.RefAttributes<_LiveboardEmbed>>;
-export declare const PreRenderedPinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & PreRenderProps & React.RefAttributes<_LiveboardEmbed>>;
+export declare const PreRenderedLiveboardEmbed: React.ForwardRefExoticComponent<(LiveboardProps & PreRenderProps) & React.RefAttributes<_LiveboardEmbed>>;
+export declare const PreRenderedPinboardEmbed: React.ForwardRefExoticComponent<(LiveboardProps & PreRenderProps) & React.RefAttributes<_LiveboardEmbed>>;
 interface SearchBarEmbedProps extends EmbedProps, SearchBarViewConfig {
 }
 /**
@@ -162,7 +196,7 @@ export declare const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEm
  * }
  * ```
  */
-export declare const PreRenderedSearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & PreRenderProps & React.RefAttributes<_SearchBarEmbed>>;
+export declare const PreRenderedSearchBarEmbed: React.ForwardRefExoticComponent<(SearchBarEmbedProps & PreRenderProps) & React.RefAttributes<_SearchBarEmbed>>;
 interface SpotterEmbedProps extends EmbedProps, SpotterEmbedViewConfig {
 }
 interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
@@ -255,7 +289,7 @@ export declare const SpotterMessage: React.ForwardRefExoticComponent<{
  * }
  * ```
  */
-export declare const PreRenderedConversationEmbed: React.ForwardRefExoticComponent<SpotterEmbedProps & PreRenderProps & React.RefAttributes<_SpotterEmbed>>;
+export declare const PreRenderedConversationEmbed: React.ForwardRefExoticComponent<(SpotterEmbedProps & PreRenderProps) & React.RefAttributes<_SpotterEmbed>>;
 type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof ConversationMessage | typeof SpotterMessage | typeof SpotterEmbed | typeof ConversationEmbed;
 /**
  * Get a reference to the embed component to trigger events on the component.
@@ -265,7 +299,7 @@ type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmb
  * const ref = useEmbedRef();
  * useEffect(() => {
  * ref.current.trigger(
- *  EmbedEvent.UpdateRuntimeFilter,
+ *  HostEvent.UpdateRuntimeFilters,
  *  [{ columnName: 'name', operator: 'EQ', values: ['value']}]);
  * }, [])
  * return <LiveboardEmbed ref={ref} liveboardId={<id>} />

package/dist/src/react/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAEnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,OAAO,EAAE,cAAc,IAAI,eAAe,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,WAAW,IAAI,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,cAAc,IAAI,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE5F,OAAO,EAA2C,2BAA2B,EAAE,mBAAmB,IAAI,oBAAoB,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAElM,OAAO,EAAE,WAAW,EAAkC,MAAM,UAAU,CAAC;AACvE,OAAO,EAAE,UAAU,EAA4B,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,YAAY,IAAI,aAAa,EAAE,sBAAsB,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAgG/J,UAAU,WAAY,SAAQ,UAAU,EAAE,gBAAgB;CAAI;AAE9D,UAAU,cAAc;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,kFAEvB,CAAC;AAEF,eAAO,MAAM,sBAAsB,mGAId,CAAC;AAEtB,UAAU,QAAS,SAAQ,UAAU,EAAE,aAAa;CAAI;AAExD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,4EAAyE,CAAC;AAE/F;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,6FAId,CAAC;AAEnB,UAAU,cAAe,SAAQ,UAAU,EAAE,mBAAmB;CAAI;AAEpE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,wFAIT,CAAC;AAEnB,eAAO,MAAM,aAAa,wFAAiB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,yBAAyB,yGAId,CAAC;AAEzB,eAAO,MAAM,wBAAwB,yGAA4B,CAAC;AAElE,UAAU,mBAAoB,SAAQ,UAAU,EAAE,mBAAmB;CAAI;AAEzE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,6FAIT,CAAC;AAEnB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,yBAAyB,8GAId,CAAC;AAEzB,UAAU,iBAAkB,SAAQ,UAAU,EAAE,sBAAsB;CAAI;AAC1E,UAAU,sBAAuB,SAAQ,UAAU,EAAE,sBAAsB;CAAI;AAE/E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY,yFAIT,CAAC;AAGjB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB,mGAIT,CAAC;AAEtB;;;;GAIG;AACH,UAAU,wBAAyB,SAAQ,UAAU,EAAE,6BAA6B;CAAG;AAEvF,eAAO,MAAM,mBAAmB,uGAIT,CAAC;AAOxB;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,cAAc;aA5Bd,6BAA6B;YAC9B,MAAM;sGAwChB,CAAC;AAGH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,4BAA4B,0GAInB,CAAC;AAEvB,KAAK,cAAc,GAAG,OAAO,WAAW,GAClC,OAAO,QAAQ,GACf,OAAO,cAAc,GACrB,OAAO,cAAc,GACrB,OAAO,mBAAmB,GAC1B,OAAO,cAAc,GACrB,OAAO,YAAY,GACnB,OAAO,iBAAiB,CAAC;AAE/B;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,cAAc,KAChD,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAEhD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,WAAW,4CAQ1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,2BAA2B;yBAejB,MAAM;;;;;;;;;;;;;;;;;EAuBvD;AAED,OAAO,EACH,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,IAAI,EACJ,aAAa,EACb,eAAe,EACf,UAAU,EACV,SAAS,EACT,MAAM,EACN,WAAW,EACX,eAAe,EACf,cAAc,EACd,QAAQ,EACR,cAAc,EACd,eAAe,EACf,qBAAqB,GACxB,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAA8B,MAAM,OAAO,CAAC;AAEnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,OAAO,EAAE,cAAc,IAAI,eAAe,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,WAAW,IAAI,YAAY,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,QAAQ,IAAI,SAAS,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,cAAc,IAAI,eAAe,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAE5F,OAAO,EAA2C,2BAA2B,EAAE,mBAAmB,IAAI,oBAAoB,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAC;AAElM,OAAO,EACH,WAAW,EAAkC,eAAe,EAC/D,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,UAAU,EAA4B,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,YAAY,IAAI,aAAa,EAAE,sBAAsB,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAiG/J,UAAU,WAAY,SAAQ,UAAU,EAAE,gBAAgB;CAAI;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,KAAK,cAAc,GACb;IACE;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACrC,GACC;IACE;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,eAAe,EAAE,eAAe,GAAG;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9D,CAAC;AAEN;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,kFAEvB,CAAC;AAEF,eAAO,MAAM,sBAAsB,qGAId,CAAC;AAEtB,UAAU,QAAS,SAAQ,UAAU,EAAE,aAAa;CAAI;AAExD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,QAAQ,4EAAyE,CAAC;AAE/F;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mBAAmB,+FAId,CAAC;AAEnB,UAAU,cAAe,SAAQ,UAAU,EAAE,mBAAmB;CAAI;AAEpE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,cAAc,wFAIT,CAAC;AAEnB,eAAO,MAAM,aAAa,wFAAiB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,yBAAyB,2GAId,CAAC;AAEzB,eAAO,MAAM,wBAAwB,2GAA4B,CAAC;AAElE,UAAU,mBAAoB,SAAQ,UAAU,EAAE,mBAAmB;CAAI;AAEzE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,6FAIT,CAAC;AAEnB;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,yBAAyB,gHAId,CAAC;AAEzB,UAAU,iBAAkB,SAAQ,UAAU,EAAE,sBAAsB;CAAI;AAC1E,UAAU,sBAAuB,SAAQ,UAAU,EAAE,sBAAsB;CAAI;AAE/E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY,yFAIT,CAAC;AAGjB;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,iBAAiB,mGAIT,CAAC;AAEtB;;;;GAIG;AACH,UAAU,wBAAyB,SAAQ,UAAU,EAAE,6BAA6B;CAAG;AAEvF,eAAO,MAAM,mBAAmB,uGAIT,CAAC;AAOxB;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,cAAc;aA5Bd,6BAA6B;YAC9B,MAAM;sGAwChB,CAAC;AAGH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,4BAA4B,4GAInB,CAAC;AAEvB,KAAK,cAAc,GAAG,OAAO,WAAW,GAClC,OAAO,QAAQ,GACf,OAAO,cAAc,GACrB,OAAO,cAAc,GACrB,OAAO,mBAAmB,GAC1B,OAAO,cAAc,GACrB,OAAO,YAAY,GACnB,OAAO,iBAAiB,CAAC;AAE/B;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,cAAc,KAChD,KAAK,CAAC,gBAAgB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAEhD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,WAAW,4CAQ1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,2BAA2B;yBAejB,MAAM;;;;;;;;;;;;;;;;;EAuBvD;AAED,OAAO,EACH,mBAAmB,EACnB,gBAAgB,EAChB,aAAa,EACb,IAAI,EACJ,aAAa,EACb,eAAe,EACf,UAAU,EACV,SAAS,EACT,MAAM,EACN,WAAW,EACX,eAAe,EACf,cAAc,EACd,QAAQ,EACR,cAAc,EACd,eAAe,EACf,qBAAqB,GACxB,MAAM,UAAU,CAAC"}