@thoughtspot/visual-embed-sdk 1.40.1-alpha.3 → 1.40.2

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

@@ -1,254 +0,0 @@
-import React from 'react';
-import { SearchBarEmbed as _SearchBarEmbed, SearchBarViewConfig } from '../embed/search-bar';
-import { SageEmbed as _SageEmbed, SageViewConfig } from '../embed/sage';
-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 { EmbedProps } from './util';
-import { ConversationEmbed as _ConversationEmbed, ConversationViewConfig } from '../embed/conversation';
-interface SearchProps extends EmbedProps, SearchViewConfig {
-}
-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.
-     * @example
-     * ```js
-     * const embed = new LiveboardEmbed('#embed', {
-     *   ... // other liveboard view config
-     *   preRenderId: "preRenderId-123"
-     * });
-     * embed.showPreRender();
-     * ```
-     *
-     * Use PreRendered react component for pre rendering embed components.
-     * @example
-     * ```tsx
-     * function LandingPageComponent() {
-     *  return <PreRenderedLiveboardEmbed preRenderId="someId" liveboardId="libId" />
-     * }
-     * ```
-     * function MyComponent() {
-     *  return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
-     * }
-     * ```
-     * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
-     */
-    preRenderId: string;
-}
-/**
- * React component for Search Embed.
- * @example
- * ```tsx
- * function Search() {
- *  return <SearchEmbed
- *      dataSource="dataSourceId"
- *      searchOptions={{ searchTokenString: "[revenue]" }}
- *  />
- * }
- * ```
- */
-export declare const SearchEmbed: React.ForwardRefExoticComponent<SearchProps & React.RefAttributes<_SearchEmbed>>;
-export declare const PreRenderedSearchEmbed: React.ForwardRefExoticComponent<SearchProps & PreRenderProps & React.RefAttributes<_SearchEmbed>>;
-interface AppProps extends EmbedProps, AppViewConfig {
-}
-/**
- * React component for Full app Embed.
- * @example
- * ```tsx
- * function Search() {
- *  return <AppEmbed
- *      showPrimaryNavbar={false}
- *      pageId={Page.Liveboards}
- *      onError={(error) => console.error(error)}
- *  />
- * }
- * ```
- */
-export declare const AppEmbed: React.ForwardRefExoticComponent<AppProps & React.RefAttributes<_AppEmbed>>;
-/**
- * React component for PreRendered Liveboard embed.
- *
- * PreRenderedAppEmbed will preRender the SearchBarEmbed and will be hidden by
- * default.
- *
- * AppEmbed with preRenderId passed will call showPreRender on the embed.
- * @example
- * ```tsx
- * function LandingPageComponent() {
- *  return <PreRenderedAppEmbed preRenderId="someId" showPrimaryNavbar={false} />
- * }
- * ```
- * function MyComponent() {
- *  return <AppEmbed preRenderId="someId" showPrimaryNavbar={false} />
- * }
- * ```
- */
-export declare const PreRenderedAppEmbed: React.ForwardRefExoticComponent<AppProps & PreRenderProps & React.RefAttributes<_AppEmbed>>;
-interface LiveboardProps extends EmbedProps, LiveboardViewConfig {
-}
-/**
- * React component for Liveboard embed.
- * @example
- * ```tsx
- * function Liveboard() {
- *  return <LiveboardEmbed
- *      liveboardId="liveboardId"
- *      fullHeight={true} {/* default false *\/}
- *      onLiveboardRendered={() => console.log('Liveboard rendered')}
- *      vizId="vizId" {/* if doing viz embed *\/}
- *  />
- * }
- * ```
- */
-export declare const LiveboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
-export declare const PinboardEmbed: React.ForwardRefExoticComponent<LiveboardProps & React.RefAttributes<_LiveboardEmbed>>;
-/**
- * React component for PreRendered Liveboard embed.
- *
- * PreRenderedLiveboardEmbed will preRender the liveboard and will be hidden by default.
- *
- * 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
- * liveboardId to both the components.
- * @example
- * ```tsx
- * function LandingPageComponent() {
- *  return <PreRenderedLiveboardEmbed preRenderId="someId" liveboardId="libId" />
- * }
- * ```
- * function MyComponent() {
- *  return <LiveboardEmbed preRenderId="someId" liveboardId="libId" />
- * }
- * ```
- */
-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 {
-}
-/**
- * React component for Search bar embed.
- * @example
- * ```tsx
- * function SearchBar() {
- *  return <SearchBarEmbed
- *      dataSource="dataSourceId"
- *      searchOptions={{ searchTokenString: "[revenue]" }}
- *  />
- * }
- * ```
- */
-export declare const SearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & React.RefAttributes<_SearchBarEmbed>>;
-/**
- * React component for PreRendered Liveboard embed.
- *
- * PreRenderedSearchBarEmbed will preRender the SearchBarEmbed and will be hidden by
- * default.
- *
- * SearchBarEmbed with preRenderId passed will call showPreRender on the embed.
- * @example
- * ```tsx
- * function LandingPageComponent() {
- *  return <PreRenderedSearchBarEmbed preRenderId="someId"  dataSource="dataSourceId" />
- * }
- * ```
- * function MyComponent() {
- *  return <SearchBarEmbed preRenderId="someId"  dataSource="dataSourceId" />
- * }
- * ```
- */
-export declare const PreRenderedSearchBarEmbed: React.ForwardRefExoticComponent<SearchBarEmbedProps & PreRenderProps & React.RefAttributes<_SearchBarEmbed>>;
-interface SageEmbedProps extends EmbedProps, SageViewConfig {
-}
-/**
- * React component for LLM based search Sage embed.
- * @example
- * ```tsx
- * function Sage() {
- *  return <SageEmbed
- *      showObjectResults={true}
- *      ... other view config props or event listeners.
- *  />
- * }
- * ```
- */
-export declare const SageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & React.RefAttributes<_SageEmbed>>;
-/**
- * React component for PreRendered Liveboard embed.
- *
- * PreRenderedSageEmbed will preRender the SearchBarEmbed and will be hidden by
- * default.
- *
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
- * @example
- * ```tsx
- * function LandingPageComponent() {
- *  return <PreRenderedSageEmbed preRenderId="someId" showObjectResults={true} />
- * }
- * ```
- * function MyComponent() {
- *  return <SageEmbed preRenderId="someId" showObjectResults={true} />
- * }
- * ```
- */
-export declare const PreRenderedSageEmbed: React.ForwardRefExoticComponent<SageEmbedProps & PreRenderProps & React.RefAttributes<_SageEmbed>>;
-interface ConversationEmbedProps extends EmbedProps, ConversationViewConfig {
-}
-/**
- * React component for LLM based conversation BI.
- * @example
- * ```tsx
- * function Sage() {
- *  return <ConversationEmbed
- *      worksheetId="<worksheet-id-here>"
- *      searchOptions={{
- *          searchQuery: "<search query to start with>"
- *      }}
- *      ... other view config props or event listeners.
- *  />
- * }
- * ```
- */
-export declare const ConversationEmbed: React.ForwardRefExoticComponent<ConversationEmbedProps & React.RefAttributes<_ConversationEmbed>>;
-/**
- * React component for PreRendered Conversation embed.
- *
- * PreRenderedConversationEmbed will preRender the ConversationEmbed and will be hidden by
- * default.
- *
- * SageEmbed with preRenderId passed will call showPreRender on the embed.
- * @example
- * ```tsx
- * function LandingPageComponent() {
- *  return <PreRenderedConversationEmbed preRenderId="someId" worksheetId={"id-"} />
- * }
- * ```
- * function MyComponent() {
- *  return <ConversationEmbed preRenderId="someId" worksheetId="id" />
- * }
- * ```
- */
-export declare const PreRenderedConversationEmbed: React.ForwardRefExoticComponent<SageEmbedProps & PreRenderProps & React.RefAttributes<_ConversationEmbed>>;
-type EmbedComponent = typeof SearchEmbed | typeof AppEmbed | typeof LiveboardEmbed | typeof SearchBarEmbed | typeof SageEmbed | typeof ConversationEmbed;
-/**
- * Get a reference to the embed component to trigger events on the component.
- * @example
- * ```
- * function Component() {
- * const ref = useEmbedRef();
- * useEffect(() => {
- * ref.current.trigger(
- *  EmbedEvent.UpdateRuntimeFilter,
- *  [{ columnName: 'name', operator: 'EQ', values: ['value']}]);
- * }, [])
- * return <LiveboardEmbed ref={ref} liveboardId={<id>} />
- * }
- * ```
- * @returns {React.MutableRefObject<T extends TsEmbed>} ref
- */
-export declare function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<React.ComponentRef<T>>;
-export { LiveboardViewConfig, SearchViewConfig, AppViewConfig, Page, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, Action, FrameParams, HomeLeftNavItem, HomepageModule, LogLevel, getSessionInfo, } from '../index';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,EAAE,cAAc,IAAI,eAAe,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC7F,OAAO,EAAE,SAAS,IAAI,UAAU,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACxE,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;AAI5F,OAAO,EAAE,UAAU,EAA4B,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAsFxG,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,cAAe,SAAQ,UAAU,EAAE,cAAc;CAAI;AAE/D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,mFAErB,CAAC;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,oBAAoB,oGAId,CAAC;AAEpB,UAAU,sBAAuB,SAAQ,UAAU,EAAE,sBAAsB;CAAI;AAE/E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,iBAAiB,mGAGzB,CAAC;AAEN;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,4BAA4B,4GAId,CAAC;AAE5B,KAAK,cAAc,GAAG,OAAO,WAAW,GAClC,OAAO,QAAQ,GACf,OAAO,cAAc,GACrB,OAAO,cAAc,GACrB,OAAO,SAAS,GAChB,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,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,GACjB,MAAM,UAAU,CAAC"}

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

@@ -1,3 +0,0 @@
-import '@testing-library/jest-dom';
-import '@testing-library/jest-dom/extend-expect';
-//# sourceMappingURL=index.spec.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.spec.d.ts","sourceRoot":"","sources":["index.spec.tsx"],"names":[],"mappings":"AACA,OAAO,2BAA2B,CAAC;AACnC,OAAO,yCAAyC,CAAC"}

package/dist/es/src/react/util.d.ts

@@ -1,19 +0,0 @@
-import { EmbedEvent, MessageCallback, ViewConfig } from '../types';
-export type EmbedEventHandlers = {
-    [key in keyof typeof EmbedEvent as `on${Capitalize<key>}`]?: MessageCallback;
-};
-export interface EmbedProps extends ViewConfig, EmbedEventHandlers {
-    className?: string;
-}
-export interface ViewConfigAndListeners<T extends ViewConfig> {
-    viewConfig: T;
-    listeners: {
-        [key in EmbedEvent]?: MessageCallback;
-    };
-}
-/**
- *
- * @param props
- */
-export declare function getViewPropsAndListeners<T extends EmbedProps, U extends ViewConfig>(props: T): ViewConfigAndListeners<U>;
-//# sourceMappingURL=util.d.ts.map

package/dist/es/src/react/util.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEnE,MAAM,MAAM,kBAAkB,GAAG;KAAG,GAAG,IAAI,MAAM,OAAO,UAAU,IAAI,KAAK,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe;CAAE,CAAC;AAElH,MAAM,WAAW,UAAW,SAAQ,UAAU,EAAE,kBAAkB;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,UAAU;IACxD,UAAU,EAAE,CAAC,CAAC;IACd,SAAS,EAAE;SAAG,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,eAAe;KAAE,CAAC;CACxD;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACpC,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAgB7D"}

package/dist/es/src/test/test-utils.d.ts

@@ -1,61 +0,0 @@
-export declare const defaultParamsWithoutHiddenActions: string;
-export declare const defaultParams: string;
-export declare const defaultParamsForPinboardEmbed: string;
-export declare const getDocumentBody: () => string;
-type DOMElement = HTMLElement | Document;
-export declare const getRootEl: () => HTMLElement;
-export declare const getRootEl2: () => HTMLElement;
-export declare const getIFrameEl: (container?: DOMElement) => HTMLIFrameElement;
-export declare const getAllIframeEl: () => NodeListOf<HTMLIFrameElement>;
-export declare const getIFrameSrc: (container?: DOMElement) => string;
-export declare const waitFor: (fn: () => boolean) => Promise<void>;
-/**
- * jsdom does not set event source, therefore we do it
- * programmatically and use dispatchEvent instead of the
- * postMessage API
- * Reference: https://github.com/jsdom/jsdom/issues/2745
- * @param window
- * @param data
- * @param port
- */
-export declare const postMessageToParent: (window: WindowProxy, data: any, port?: any) => void;
-/**
- * Execute a given function after a certain time has elapsed
- * @param fn The function to be executed after the wait period
- * @param waitTime The wait period in milliseconds
- */
-export declare const executeAfterWait: (fn: (...args: any[]) => void, waitTime?: number) => Promise<unknown>;
-/**
- * Time (in milliseconds) to wait for async events to be triggered
- */
-export declare const EVENT_WAIT_TIME = 1000;
-/**
- *
- * @param str
- */
-export declare function fixedEncodeURI(str: string): string;
-/**
- * MessageChannel is available in Node > 15.0.0. Since the current node
- * environment's used for github actions is not above 14, we are mocking this
- * for the current unit tests.
- */
-export declare const messageChannelMock: any;
-export declare const mockMessageChannel: () => void;
-export declare const expectUrlMatchesWithParams: (source: string, target: string) => void;
-export declare const expectUrlToHaveParamsWithValues: (url: string, paramsWithValues: Record<string, any>) => void;
-export declare const expectUrlMatch: (source: string, target: string) => void;
-export declare const createRootEleForEmbed: () => void;
-export declare const getHashQueryParams: (hash: string) => any;
-export declare const mockSessionInfo: {
-    userGUID: string;
-    mixpanelToken: string;
-    isPublicUser: boolean;
-    sessionId: string;
-    genNo: number;
-    acSession: {
-        sessionId: string;
-        genNo: number;
-    };
-};
-export {};
-//# sourceMappingURL=test-utils.d.ts.map

package/dist/es/src/test/test-utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["test-utils.ts"],"names":[],"mappings":"AAcA,eAAO,MAAM,iCAAiC,QAAgJ,CAAC;AAC/L,eAAO,MAAM,aAAa,QAAmF,CAAC;AAC9G,eAAO,MAAM,6BAA6B,QAA6K,CAAC;AACxN,eAAO,MAAM,eAAe,cAAyD,CAAC;AAEtF,KAAK,UAAU,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEzC,eAAO,MAAM,SAAS,mBAAyC,CAAC;AAEhE,eAAO,MAAM,UAAU,mBAA2C,CAAC;AAEnE,eAAO,MAAM,WAAW,eAAe,UAAU,sBAAiD,CAAC;AAEnG,eAAO,MAAM,cAAc,qCAA4C,CAAC;AAExE,eAAO,MAAM,YAAY,eAAe,UAAU,WAA0C,CAAC;AAE7F,eAAO,MAAM,OAAO,OAAQ,MAAM,OAAO,KAAG,QAAQ,IAAI,CAQtD,CAAC;AAEH;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,WAAY,WAAW,QAAQ,GAAG,SAAS,GAAG,SAO7E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,iBACX,GAAG,EAAE,KAAK,IAAI,wCAO9B,CAAC;AAEH;;GAEG;AACH,eAAO,MAAM,eAAe,OAAO,CAAC;AAEpC;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,UAEzC;AAED;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,EAAE,GAGhC,CAAC;AACF,eAAO,MAAM,kBAAkB,YAM9B,CAAC;AAEF,eAAO,MAAM,0BAA0B,WAAY,MAAM,UAAU,MAAM,SAYxE,CAAC;AAEF,eAAO,MAAM,+BAA+B,QACnC,MAAM,oBAAoB,OAAO,MAAM,EAAE,GAAG,CAAC,SAcrD,CAAC;AAEF,eAAO,MAAM,cAAc,WAAY,MAAM,UAAU,MAAM,SAK5D,CAAC;AAEF,eAAO,MAAM,qBAAqB,YAOjC,CAAC;AAEF,eAAO,MAAM,kBAAkB,SAAU,MAAM,KAAG,GAIjD,CAAC;AAEF,eAAO,MAAM,eAAe;;;;;;;;;;CAU3B,CAAC"}

package/dist/es/src/tokenizedFetch.d.ts

@@ -1,18 +0,0 @@
-/**
- * Fetch wrapper that adds the authentication token to the request.
- * Use this to call the ThoughtSpot APIs when using the visual embed sdk.
- * The interface for this method is the same as Web `Fetch`.
- *
- * @param input
- * @param init
- * @example
- * ```js
- * tokenizedFetch("<TS_ORIGIN>/api/rest/2.0/auth/session/user", {
- *   // .. fetch options ..
- * });
- *```
- * @version SDK: 1.28.0
- * @group Global methods
- */
-export declare const tokenizedFetch: typeof fetch;
-//# sourceMappingURL=tokenizedFetch.d.ts.map

package/dist/es/src/tokenizedFetch.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokenizedFetch.d.ts","sourceRoot":"","sources":["tokenizedFetch.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,cAAc,EAAE,OAAO,KAgBnC,CAAC"}