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

package/dist/es/react/src/embed/app.d.ts

@@ -0,0 +1,478 @@
+/**
+ * Copyright (c) 2022
+ *
+ * Full application embedding
+ * https://developers.thoughtspot.com/docs/?pageid=full-embed
+ * @summary Full app embed
+ * @module
+ * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+ */
+import { DOMSelector, ViewConfig, MessagePayload } from '../types';
+import { V1Embed } from './ts-embed';
+/**
+ * Pages within the ThoughtSpot app that can be embedded.
+ */
+export declare enum Page {
+    /**
+     * Home page
+     */
+    Home = "home",
+    /**
+     * Search page
+     */
+    Search = "search",
+    /**
+     * Saved answers listing page
+     */
+    Answers = "answers",
+    /**
+     * Liveboards listing page
+     */
+    Liveboards = "liveboards",
+    /**
+     * @hidden
+     */
+    Pinboards = "pinboards",
+    /**
+     * Data management page
+     */
+    Data = "data",
+    /**
+     * SpotIQ listing page
+     */
+    SpotIQ = "insights",
+    /**
+     *  Monitor Alerts Page
+     */
+    Monitor = "monitor"
+}
+/**
+ * Define the initial state os column custom group accordions
+ * in data panel v2.
+ */
+export declare enum DataPanelCustomColumnGroupsAccordionState {
+    /**
+     * Expand all the accordion initially in data panel v2.
+     */
+    EXPAND_ALL = "EXPAND_ALL",
+    /**
+     * Collapse all the accordions initially in data panel v2.
+     */
+    COLLAPSE_ALL = "COLLAPSE_ALL",
+    /**
+     * Expand the first accordion and collapse the rest.
+     */
+    EXPAND_FIRST = "EXPAND_FIRST"
+}
+export declare enum HomePageSearchBarMode {
+    OBJECT_SEARCH = "objectSearch",
+    AI_ANSWER = "aiAnswer",
+    NONE = "none"
+}
+/**
+ * The view configuration for full app embedding.
+ * @group Embed components
+ */
+export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
+    /**
+     * If true, the top navigation bar within the ThoughtSpot app
+     * is displayed. By default, the navigation bar is hidden.
+     * This flag also controls the homepage left navigation bar.
+     * @default true
+     * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showPrimaryNavbar:true,
+     * })
+     * ```
+     */
+    showPrimaryNavbar?: boolean;
+    /**
+     * Control the visibility of the left navigation bar on the Homepage.
+     * If showPrimaryNavbar is true, that is, if the Global and Homepage
+     * nav-bars are visible, this flag will only hide the homepage left nav-bar.
+     * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     * @default false
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideHomepageLeftNav : true,
+     * })
+     * ```
+     */
+    hideHomepageLeftNav?: boolean;
+    /**
+     * Control the visibility of the help (?) and profile buttons on the
+     * Global nav-bar. By default, these buttons are visible on the nav-bar.
+     * @default false
+     * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    disableProfileAndHelp: true,
+     * })
+     * ```
+     */
+    disableProfileAndHelp?: boolean;
+    /**
+     * Control the visibility of the application switcher button on the nav-bar.
+     * By default, the application switcher is shown.
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideApplicationSwitcher : true,
+     * })
+     * ```
+     */
+    hideApplicationSwitcher?: boolean;
+    /**
+     * Control the visibility of the Org switcher button on the nav-bar.
+     * By default, the Org switcher button is shown.
+     *
+     * **Note**: This option does not apply to the classic homepage.
+     * To access the updated modular homepage, set
+     * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @default true
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideOrgSwitcher : true,
+     * })
+     * ```
+     */
+    hideOrgSwitcher?: boolean;
+    /**
+     * A URL path to the embedded application page
+     * If both path and pageId attributes are defined, the path definition
+     * takes precedence. This is the path post the `#/` in the URL of the standalone
+     * ThoughtSpot app. Use this to open the embedded view to a specific path.
+     *
+     * For eg, if you want the component to open to a specific Liveboard
+     * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    path:"pinboard/1234/tab/7464"
+     * })
+     * ```
+     */
+    path?: string;
+    /**
+     * The application page to set as the start page
+     * in the embedded view.
+     *
+     * Use this to open to particular page in the app. To open to a specific
+     * path within the app, use the `path` attribute which is more flexible.
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    pageId : Page.Answers | Page.Data
+     * })
+     * ```
+     */
+    pageId?: Page;
+    /**
+     * This puts a filter tag on the application. All metadata lists in the
+     * application, such as Liveboards and answers, would be filtered by this
+     * tag.
+     * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    tag:'value',
+     * })
+     * ```
+     */
+    tag?: string;
+    /**
+     * The array of GUIDs to be hidden
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideObjects: [
+     *       '430496d6-6903-4601-937e-2c691821af3c',
+     *       'f547ec54-2a37-4516-a222-2b06719af726'
+     *     ]
+     * })
+     * ```
+     */
+    hideObjects?: string[];
+    /**
+     * Render liveboards using the new v2 rendering mode
+     * This is a transient flag which is primarily meant for internal use
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
+     * @hidden
+     */
+    liveboardV2?: boolean;
+    /**
+     * If set to true, the Search Assist feature is enabled.
+     * @default true
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    enableSearchAssist: true,
+     * })
+     * ```
+     */
+    enableSearchAssist?: boolean;
+    /**
+     * If set to true, the embedded object container dynamically resizes
+     * according to the height of the pages which support fullHeight mode.
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    fullHeight: true,
+     * })
+     * ```
+     */
+    fullHeight?: boolean;
+    /**
+     * Show or hide Liveboard header
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideLiveboardHeader : true,
+     * })
+     * ```
+     */
+    hideLiveboardHeader?: boolean;
+    /**
+     * Show or hide Liveboard title
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showLiveboardTitle:true,
+     * })
+     * ```
+     */
+    showLiveboardTitle?: boolean;
+    /**
+     * Show or hide Liveboard description
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     * @default false
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    showLiveboardDescription:true,
+     * })
+     * ```
+     */
+    showLiveboardDescription?: boolean;
+    /**
+     * Flag to control new Modular Home experience.
+     * @default false
+     * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#tsEmbed', {
+     *    ... // other options
+     *    modularHomeExperience : true,
+     * })
+     * ```
+     */
+    modularHomeExperience?: boolean;
+    /**
+     * Boolean to control if Liveboard header is sticky or not.
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed', {
+     *   ... // other app view config
+     *   isLiveboardHeaderSticky: true,
+     * });
+     * ```
+     * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
+     */
+    isLiveboardHeaderSticky?: boolean;
+    /**
+     * enable or disable ask sage
+     * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
+     * @default false
+     */
+    enableAskSage?: boolean;
+    /**
+     * To set the initial state of the search bar in case of saved-answers.
+     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @default false
+     * @deprecated Use {@link collapseSearchBar} instead
+     */
+    collapseSearchBarInitially?: boolean;
+    /**
+     * This controls the initial behaviour of custom column groups accordion.
+     * It takes DataPanelCustomColumnGroupsAccordionState enum values as input.
+     * List of different enum values:-
+     * - EXPAND_ALL: Expand all the accordion initially in data panel v2.
+     * - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
+     * - EXPAND_FIRST: Expand the first accordion and collapse the rest.
+     * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
+     * @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed', {
+     *   ... // other app view config
+     *   dataPanelCustomGroupsAccordionInitialState:
+     *      DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
+     * });
+     * ```
+     */
+    dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
+    /**
+     * This flag is used to enable the 2 column layout in liveboard
+     * @type {boolean}
+     * @default false
+     * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#embed-container', {
+     *    ... // other options
+     *    enable2ColumnLayout: true,
+     * })
+     * ```
+     */
+    enable2ColumnLayout?: boolean;
+    /**
+     * Flag to use OnBeforeSearchExecute embed event
+     * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
+     */
+    isOnBeforeGetVizDataInterceptEnabled?: boolean;
+    /**
+     * Flag to use home page search bar mode
+     * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
+     */
+    homePageSearchBarMode?: HomePageSearchBarMode;
+    /**
+     * This flag is used to enable the compact header in liveboard
+     * @type {boolean}
+     * @default false
+     * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed-container', {
+     *    ... // other options
+     *    isLiveboardCompactHeaderEnabled: true,
+     * })
+     * ```
+     */
+    isLiveboardCompactHeaderEnabled?: boolean;
+    /**
+     * This flag is used to show/hide verified Icon in liveboard compact header
+     * @type {boolean}
+     * @default true
+     * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed-container', {
+     *    ... // other options
+     *    showLiveboardVerifiedBadge: true,
+     * })
+     * ```
+     */
+    showLiveboardVerifiedBadge?: boolean;
+    /**
+     * This flag is used to show/hide re-verify banner in liveboard compact header
+     * @type {boolean}
+     * @default true
+     * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
+     * @example
+     * ```js
+     * const embed = new AppEmbed('#embed-container', {
+     *    ... // other options
+     *    showLiveboardReverifyBanner: true,
+     * })
+     * ```
+     */
+    showLiveboardReverifyBanner?: boolean;
+}
+/**
+ * Embeds full ThoughtSpot experience in a host application.
+ * @group Embed components
+ */
+export declare class AppEmbed extends V1Embed {
+    protected viewConfig: AppViewConfig;
+    private defaultHeight;
+    constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
+    /**
+     * Constructs a map of parameters to be passed on to the
+     * embedded Liveboard or visualization.
+     */
+    protected getEmbedParams(): string;
+    /**
+     * Constructs the URL of the ThoughtSpot app page to be rendered.
+     * @param pageId The ID of the page to be embedded.
+     */
+    getIFrameSrc(): string;
+    /**
+     * Set the iframe height as per the computed height received
+     * from the ThoughtSpot app.
+     * @param data The event payload
+     */
+    protected updateIFrameHeight: (data: MessagePayload) => void;
+    private embedIframeCenter;
+    private setIframeHeightForNonEmbedLiveboard;
+    /**
+     * Gets the ThoughtSpot route of the page for a particular page ID.
+     * @param pageId The identifier for a page in the ThoughtSpot app.
+     * @param modularHomeExperience
+     */
+    private getPageRoute;
+    /**
+     * Formats the path provided by the user.
+     * @param path The URL path.
+     * @returns The URL path that the embedded app understands.
+     */
+    private formatPath;
+    /**
+     * Navigate to particular page for app embed. eg:answers/pinboards/home
+     * This is used for embedding answers, pinboards, visualizations and full application
+     * only.
+     * @param path string | number The string, set to iframe src and navigate to new page
+     * eg: appEmbed.navigateToPage('pinboards')
+     * When used with `noReload` (default: true) this can also be a number
+     * like 1/-1 to go forward/back.
+     * @param noReload boolean Trigger the navigation without reloading the page
+     * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw
+     */
+    navigateToPage(path: string | number, noReload?: boolean): void;
+    /**
+     * Renders the embedded application pages in the ThoughtSpot app.
+     * @param renderOptions An object containing the page ID
+     * to be embedded.
+     */
+    render(): Promise<AppEmbed>;
+}
+//# sourceMappingURL=app.d.ts.map

package/dist/es/react/src/embed/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAEX,UAAU,EAEV,cAAc,EACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,aAAa;IACnB;;OAEG;IACH,OAAO,YAAY;CACtB;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED,oBAAY,qBAAqB;IAC7B,aAAa,iBAAiB;IAC9B,SAAS,aAAa;IACtB,IAAI,SAAS;CAChB;AACD;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,0CAA0C,CAAC,EAAE,yCAAyC,CAAC;IACvF;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C;;;;;;;;;;;;OAYG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;;;;;;;;OAYG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;OAYG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACzC;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAU;gBAGnB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAU/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IA6GxB;;;OAGG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAKzC;IAEF;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAsBpB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;OAUG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAO3C"}

package/dist/es/react/src/embed/app.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=app.spec.d.ts.map

package/dist/es/react/src/embed/app.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.spec.d.ts","sourceRoot":"","sources":["app.spec.ts"],"names":[],"mappings":""}

package/dist/es/react/src/embed/base.d.ts

@@ -0,0 +1,136 @@
+import { EmbedConfig, PrefetchFeatures } from '../types';
+import { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, AuthEventEmitter } from '../auth';
+export interface executeTMLInput {
+    metadata_tmls: string[];
+    import_policy?: 'PARTIAL' | 'ALL_OR_NONE' | 'VALIDATE_ONLY';
+    create_new?: boolean;
+}
+export interface exportTMLInput {
+    metadata: {
+        identifier: string;
+        type?: 'LIVEBOARD' | 'ANSWER' | 'LOGICAL_TABLE' | 'CONNECTION';
+    }[];
+    export_associated?: boolean;
+    export_fqn?: boolean;
+    edoc_format?: 'YAML' | 'JSON';
+}
+export declare let authPromise: Promise<boolean>;
+export declare const getAuthPromise: () => Promise<boolean>;
+export { notifyAuthFailure, notifyAuthSDKSuccess, notifyAuthSuccess, notifyLogout, };
+/**
+ * Perform authentication on the ThoughtSpot app as applicable.
+ */
+export declare const handleAuth: () => Promise<boolean>;
+/**
+ * Prefetches static resources from the specified URL. Web browsers can then cache the
+ * prefetched resources and serve them from the user's local disk to provide faster access
+ * to your app.
+ * @param url The URL provided for prefetch
+ * @param prefetchFeatures Specify features which needs to be prefetched.
+ * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
+ * @group Global methods
+ */
+export declare const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[]) => void;
+/**
+ * Initializes the Visual Embed SDK globally and perform
+ * authentication if applicable. This function needs to be called before any ThoughtSpot
+ * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+ * to actually embed. That is handled internally.
+ * @param embedConfig The configuration object containing ThoughtSpot host,
+ * authentication mechanism and so on.
+ * @example
+ * ```js
+ *   const authStatus = init({
+ *     thoughtSpotHost: 'https://my.thoughtspot.cloud',
+ *     authType: AuthType.None,
+ *   });
+ *   authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
+ * ```
+ * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success,
+ *      failure and logout. See {@link AuthStatus}
+ * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
+ * @group Authentication / Init
+ */
+export declare const init: (embedConfig: EmbedConfig) => AuthEventEmitter;
+/**
+ *
+ */
+export declare function disableAutoLogin(): void;
+/**
+ * Logs out from ThoughtSpot. This also sets the autoLogin flag to false, to
+ * prevent the SDK from automatically logging in again.
+ *
+ * You can call the `init` method again to re login, if autoLogin is set to
+ * true in this second call it will be honored.
+ * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
+ * @returns Promise which resolves when logout completes.
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
+ * @group Global methods
+ */
+export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
+/**
+ * Renders functions in a queue, resolves to next function only after the callback next
+ * is called
+ * @param fn The function being registered
+ */
+export declare const renderInQueue: (fn: (next?: (val?: any) => void) => Promise<any>) => Promise<any>;
+/**
+ * Imports TML representation of the metadata objects into ThoughtSpot.
+ * @param data
+ * @returns imports TML data into ThoughtSpot
+ * @example
+ * ```js
+ *  executeTML({
+ * //Array of metadata Tmls in string format
+ *      metadata_tmls: [
+ *          "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
+ *          \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
+ *      ],
+ *      import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
+ *      create_new: false, // If selected, creates TML objects with new GUIDs.
+ *  }).then(result => {
+ *      console.log(result);
+ *  }).catch(error => {
+ *      console.error(error);
+ *  });
+ *```
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+ * @group Global methods
+ */
+export declare const executeTML: (data: executeTMLInput) => Promise<any>;
+/**
+ * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
+ * format.
+ * @param data
+ * @returns exports TML data
+ * @example
+ * ```js
+ * exportTML({
+ *   metadata: [
+ *     {
+ *       type: "LIVEBOARD", //Metadata Type
+ *       identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
+ *     }
+ *   ],
+ *   export_associated: false,//indicates whether to export associated metadata objects
+ *   export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
+ *                      //exporting a Liveboard and its associated objects, the API
+ *                      //returns the Liveboard TML data with the FQNs of the referenced
+ *                      //worksheet. If the exported TML data includes FQNs, you don't need
+ *                      //to manually add FQNs of the referenced objects during TML import.
+ *   edoc_format: "JSON" //It takes JSON or YAML value
+ * }).then(result => {
+ *   console.log(result);
+ * }).catch(error => {
+ *   console.error(error);
+ * });
+ * ```
+ * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
+ * @group Global methods
+ */
+export declare const exportTML: (data: exportTMLInput) => Promise<any>;
+/**
+ *
+ */
+export declare function reset(): void;
+//# sourceMappingURL=base.d.ts.map

package/dist/es/react/src/embed/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AAgBA,OAAO,EACO,WAAW,EAAY,gBAAgB,EACpD,MAAM,UAAU,CAAC;AAClB,OAAO,EAMH,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEZ,gBAAgB,EAEnB,MAAM,SAAS,CAAC;AAWjB,MAAM,WAAW,eAAe;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,eAAe,CAAC;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE;QACN,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,YAAY,CAAC;KAClE,EAAE,CAAC;IACJ,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACjC;AAED,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEzC,eAAO,MAAM,cAAc,QAAO,QAAQ,OAAO,CAAgB,CAAC;AAElE,OAAO,EACH,iBAAiB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,YAAY,GAC3E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,QAAO,QAAQ,OAAO,CAiB5C,CAAC;AASF;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ,SAAU,MAAM,qBAAqB,gBAAgB,EAAE,KAAG,IAyB9E,CAAC;AA6BF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,gBAiC/C,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,MAAM,uCAAoC,QAAQ,OAAO,CAQrE,CAAC;AAIF;;;;GAIG;AACH,eAAO,MAAM,aAAa,sBAAuB,GAAG,KAAK,IAAI,KAAK,QAAQ,GAAG,CAAC,KAAG,QAAQ,GAAG,CAQ3F,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,SAAgB,eAAe,KAAG,QAAQ,GAAG,CAmCnE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,SAAS,SAAgB,cAAc,KAAG,QAAQ,GAAG,CAoCjE,CAAC;AAGF;;GAEG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}

package/dist/es/react/src/embed/base.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=base.spec.d.ts.map

package/dist/es/react/src/embed/base.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.spec.d.ts","sourceRoot":"","sources":["base.spec.ts"],"names":[],"mappings":""}

package/dist/es/react/src/embed/bodyless-conversation.d.ts

@@ -0,0 +1,26 @@
+import { ViewConfig } from '../types';
+export interface BodylessConversationViewConfig extends ViewConfig {
+    /**
+     * The ID of the worksheet to use for the conversation.
+     */
+    worksheetId: string;
+}
+/**
+ * Create a conversation embed, which can be integrated inside
+ * chatbots or other conversational interfaces.
+ * @group Embed components
+ * @version SDK: 1.33.1 | ThoughtSpot: 10.5.0.cl
+ */
+export declare class BodylessConversation {
+    private viewConfig;
+    private conversationService;
+    constructor(viewConfig: BodylessConversationViewConfig);
+    sendMessage(userMessage: string): Promise<{
+        error: any;
+        container?: undefined;
+    } | {
+        container: HTMLDivElement;
+        error?: undefined;
+    }>;
+}
+//# sourceMappingURL=bodyless-conversation.d.ts.map

package/dist/es/react/src/embed/bodyless-conversation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bodyless-conversation.d.ts","sourceRoot":"","sources":["bodyless-conversation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAS,MAAM,UAAU,CAAC;AAM7C,MAAM,WAAW,8BAA+B,SAAQ,UAAU;IAC9D;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAgDD;;;;;GAKG;AACH,qBAAa,oBAAoB;IAGjB,OAAO,CAAC,UAAU;IAF9B,OAAO,CAAC,mBAAmB,CAAsB;gBAE7B,UAAU,EAAE,8BAA8B;IASjD,WAAW,CAAC,WAAW,EAAE,MAAM;;;;;;;CAiB/C"}

package/dist/es/react/src/embed/bodyless-conversation.spec.d.ts

@@ -0,0 +1,2 @@
+import 'jest-fetch-mock';
+//# sourceMappingURL=bodyless-conversation.spec.d.ts.map

package/dist/es/react/src/embed/bodyless-conversation.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bodyless-conversation.spec.d.ts","sourceRoot":"","sources":["bodyless-conversation.spec.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,CAAC"}