@thoughtspot/visual-embed-sdk 1.33.0 → 1.33.1-dc.2

package/dist/es/src/embed/search-bar.d.ts

@@ -0,0 +1,93 @@
+import { ViewConfig } from '../types';
+import { TsEmbed } from './ts-embed';
+import { SearchOptions } from './search';
+/**
+ * @group Embed components
+ */
+export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' | 'showAlerts' | 'dataPanelV2' | 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
+    /**
+     * The array of data source GUIDs to set on load.
+     * Only a single data source is supported currently.
+     * @deprecated Use `dataSource` instead
+     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
+     * @example
+     * ```js
+     * const embed = new SearchBarEmbed('#tsEmbed', {
+     *    ... // other options
+     *    dataSources:['id-2345','id-2345'],
+     * })
+     * ```
+     */
+    dataSources?: string[];
+    /**
+     * Pass the ID of the source to be selected.
+     * @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
+     * @example
+     * ```js
+     * const embed = new SearchBarEmbed('#tsEmbed', {
+     *    ... // other options
+     *    dataSource:'id-2345',
+     * })
+     * ```
+     */
+    dataSource?: string;
+    /**
+     * Boolean to define if the last selected data source should be used
+     * @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
+     * @example
+     * ```js
+     * const embed = new SearchBarEmbed('#tsEmbed', {
+     *    ... // other options
+     *    useLastSelectedSources:false,
+     * })
+     * ```
+     */
+    useLastSelectedSources?: boolean;
+    /**
+     * Configuration for search options.
+     * Includes the following properties:
+     *
+     * `searchTokenString`: Search tokens to pass in the query.
+     *
+     * `executeSearch`: Boolean to define if the search should be executed or not.
+     * If it is executed, the focus is placed on the results.
+     * If it’s not executed, the focus is placed at the end of
+     * the token string in the search bar.
+     * @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
+     * @example
+     * ```js
+     * const embed = new SearchBarEmbed('#tsEmbed', {
+     *    ... // other options
+     *    searchOptions: {
+     *        searchTokenString: '[quantity purchased] [region]',
+     *        executeSearch: true,
+     *    }
+     * })
+     * ```
+     */
+    searchOptions?: SearchOptions;
+}
+/**
+ * Embed ThoughtSpot search bar
+ * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+ * @group Embed components
+ */
+export declare class SearchBarEmbed extends TsEmbed {
+    /**
+     * The view configuration for the embedded ThoughtSpot search bar.
+     */
+    protected viewConfig: SearchBarViewConfig;
+    protected embedComponentType: string;
+    constructor(domSelector: string, viewConfig: SearchBarViewConfig);
+    /**
+     * Construct the URL of the embedded ThoughtSpot search to be
+     * loaded in the iframe
+     * @param dataSources A list of data source GUIDs
+     */
+    private getIFrameSrc;
+    /**
+     * Render the embedded ThoughtSpot search
+     */
+    render(): Promise<SearchBarEmbed>;
+}
+//# sourceMappingURL=search-bar.d.ts.map

package/dist/es/src/embed/search-bar.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-bar.d.ts","sourceRoot":"","sources":["search-bar.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAE7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACR,gBAAgB,GAChB,YAAY,GACZ,aAAa,GACb,uBAAuB,GACvB,wBAAwB,GACxB,YAAY,GACZ,aAAa,GACb,0BAA0B,CAC/B;IACD;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;OAUG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,SAAS,CAAC,kBAAkB,SAAoB;gBAEpC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB;IAKhE;;;;OAIG;IACH,OAAO,CAAC,YAAY;IA2CpB;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;CAOjD"}

package/dist/es/src/embed/search.d.ts

@@ -0,0 +1,282 @@
+/**
+ * Copyright (c) 2022
+ *
+ * Embed ThoughtSpot search or a saved answer
+ * @summary Search embed
+ * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+ */
+import { DOMSelector, Action, ViewConfig } from '../types';
+import { TsEmbed } from './ts-embed';
+/**
+ * Configuration for search options.
+ *
+ */
+export interface SearchOptions {
+    /**
+     * Search tokens to pass in the query.
+     */
+    searchTokenString: string;
+    /**
+     * Boolean to define if the search should be executed or not.
+     * If it is executed, the focus is placed on the results.
+     * If it’s not executed, the focus is placed at the end of
+     * the token string in the search bar.
+     */
+    executeSearch?: boolean;
+}
+/**
+ * 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"
+}
+/**
+ * The configuration attributes for the embedded search view.
+ * @group Embed components
+ */
+export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
+    /**
+     * If set to true, the data sources panel is collapsed on load,
+     * but can be expanded manually.
+     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    collapseDataSources:true,
+     * })
+     * ```
+     */
+    collapseDataSources?: boolean;
+    /**
+     * If set to true, the data panel is collapsed on load,
+     * but can be expanded manually.
+     * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    collapseDataPanel:true,
+     * })
+     * ```
+     */
+    collapseDataPanel?: boolean;
+    /**
+     * Show or hide the data sources panel.
+     * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideDataSources:true,
+     * })
+     * ```
+     */
+    hideDataSources?: boolean;
+    /**
+     * Show or hide the charts and tables in search answers.
+     * This attribute can be used to create a custom visualization
+     * using raw answer data.
+     * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideResults:true,
+     * })
+     * ```
+     */
+    hideResults?: boolean;
+    /**
+     * If set to true, the Search Assist feature is enabled.
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    enableSearchAssist:true,
+     * })
+     * ```
+     */
+    enableSearchAssist?: boolean;
+    /**
+     * If set to true, the tabular view is set as the default
+     * format for presenting search data.
+     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    forceTable:true,
+     * })
+     */
+    forceTable?: boolean;
+    /**
+     * The array of data source GUIDs to set on load.
+     * Only a single data source is supported currently.
+     * @deprecated Use `dataSource` instead.
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    dataSources:['id-234','id-456'],
+     * })
+     * ```
+     */
+    dataSources?: string[];
+    /**
+     * The array of data source GUIDs to set on load.
+     * @version: SDK: 1.19.0
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    dataSource:'id-234',
+     * })
+     * ```
+     */
+    dataSource?: string;
+    /**
+     * The initial search query to load the answer with.
+     * @deprecated
+     *
+     * Use {@link searchOptions} instead.
+     */
+    searchQuery?: string;
+    /**
+     * Configuration for search options.
+     * Includes the following properties:
+     *
+     * `searchTokenString`: Search tokens to pass in the query.
+     *
+     * `executeSearch`: Boolean to define if the search should be executed or not.
+     * If it is executed, the focus is placed on the results.
+     * If it’s not executed, the focus is placed at the end of
+     * the token string in the search bar.
+     * @example
+     * ```js
+     * searchOptions: {
+     *    searchTokenString: '[quantity purchased] [region]',
+     *    executeSearch: true,
+     * }
+     * ```
+     */
+    searchOptions?: SearchOptions;
+    /**
+     * The GUID of a saved answer to load initially.
+     * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    answerId:'sed-1234',
+     * })
+     * ```
+     */
+    answerId?: string;
+    /**
+     * If set to true, the search page will render without the Search Bar
+     * The chart/table should still be visible.
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *    ... // other options
+     *    hideSearchBar:true,
+     * })
+     * ```
+     */
+    hideSearchBar?: boolean;
+    /**
+     * Flag to set if last selected dataSource should be used
+     * @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
+     */
+    collapseSearchBarInitially?: boolean;
+    /**
+     * Flag to enable onBeforeSearchExecute Embed Event
+     * @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
+     */
+    isOnBeforeGetVizDataInterceptEnabled?: 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 SearchEmbed('#tsEmbed', {
+     *   ... // other options
+     *   dataPanelCustomGroupsAccordionInitialState:
+     *      DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL,
+     * });
+     * ```
+     */
+    dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
+    /**
+     * Flag to remove focus from search bar initially when user
+     * lands on search embed page.
+     * @version SDK: 1.32.0 | Thoughtspot: 10.3.0.cl
+     * @default true
+     * @example
+     * ```js
+     * const embed = new SearchEmbed('#tsEmbed', {
+     *  ... // other options
+     * focusSearchBarOnRender: false,
+     * });
+     * ```
+     */
+    focusSearchBarOnRender?: boolean;
+}
+export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
+/**
+ * Embed ThoughtSpot search
+ * @group Embed components
+ */
+export declare class SearchEmbed extends TsEmbed {
+    /**
+     * The view configuration for the embedded ThoughtSpot search.
+     */
+    protected viewConfig: SearchViewConfig;
+    constructor(domSelector: DOMSelector, viewConfig: SearchViewConfig);
+    /**
+     * Get the state of the data sources panel that the embedded
+     * ThoughtSpot search will be initialized with.
+     */
+    private getDataSourceMode;
+    protected getEmbedParams(): string;
+    /**
+     * Construct the URL of the embedded ThoughtSpot search to be
+     * loaded in the iframe
+     * @param answerId The GUID of a saved answer
+     * @param dataSources A list of data source GUIDs
+     */
+    getIFrameSrc(): string;
+    /**
+     * Render the embedded ThoughtSpot search
+     */
+    render(): Promise<SearchEmbed>;
+}
+//# sourceMappingURL=search.d.ts.map

package/dist/es/src/embed/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAEH,WAAW,EAEX,MAAM,EACN,UAAU,EACb,MAAM,UAAU,CAAC;AAOlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAMrC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,gBACb,SAAQ,IAAI,CACR,UAAU,EACR,uBAAuB,GACvB,wBAAwB,GACxB,YAAY,GACZ,aAAa,GACb,0BAA0B,CAC/B;IACD;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;OAUG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;OAUG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;;;;;;;OAiBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;;;;;;;;;;;;;;;OAiBG;IACH,0CAA0C,CAAC,EAAE,yCAAyC,CAAC;IACvF;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CACpC;AAED,eAAO,MAAM,uCAAuC,UAMnD,CAAC;AAEF;;;GAGG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACpC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBAE3B,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB;IAKlE;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAazB,SAAS,CAAC,cAAc,IAAI,MAAM;IA2GlC;;;;;OAKG;IACI,YAAY,IAAI,MAAM;IAQ7B;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;CAmB9C"}

package/dist/es/src/embed/search.spec.d.ts

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

package/dist/es/src/embed/search.spec.d.ts.map

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

package/dist/es/src/embed/ts-embed-trigger.spec.d.ts

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

package/dist/es/src/embed/ts-embed-trigger.spec.d.ts.map

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