@thoughtspot/visual-embed-sdk 1.13.0-alpha.4 → 1.14.0

package/CHANGELOG.md

@@ -6,10 +6,10 @@ This project follows Semantic Versioning.
 ## Unreleased
 
 ### New Features
-- Event for navigating to a specific page in App embed without any reload
-- Ability to turn on search assist in Search embed
 - Set of new Host events to drive interactions on the embed programatically 
-
+## 1.13.0 (07-19-2022)
+- Release to support TS version 8.5.0.cl
+- Please check the full list of changes [here](https://developers.thoughtspot.com/docs/?pageid=embed-sdk-changelog)
 ## 1.12.1 (06-21-2022)
 ### Fixed
 - Search embed beta warning check for TS cloud releases
@@ -21,6 +21,10 @@ This project follows Semantic Versioning.
 ### Fixed
 - Typescript build that was affecting some Angular project configurations
 
+## 1.11.2 (06-10-2022)
+### Fixed
+- Typescript build that was affecting some Angular project configurations
+
 ## 1.11.1 (05-30-2022)
 ### Fixed
 - Whitelabeling - new [action](https://developers.thoughtspot.com/docs/typedoc/enums/Action.html#ReportError) for the ability to turn off TS specific error reporting by end users.
@@ -69,12 +73,12 @@ This project follows Semantic Versioning.
 
 ## 1.9.3 (03-22-2022)
 
-### New Features 
+### New Features
 - `disableLoginRedirect` option in `EmbedConfig`
 
 ## 1.9.2 (03-17-2022)
 
-### New Features 
+### New Features
 - Ability to trigger events on React components
   - Added new `useEmbedRef` hook, check README for usage.
 

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

@@ -82,13 +82,13 @@ export interface AppViewConfig extends ViewConfig {
      * Render liveboards using the new v2 rendering mode
      * This is a transient flag which is primarily meant for internal use
      * @default false
-     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
+     * @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.
-     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
      */
     enableSearchAssist?: boolean;
 }
@@ -126,7 +126,8 @@ export declare class AppEmbed extends V1Embed {
      * @param path string | number The string, set to iframe src and navigate to new page
      * eg: appEmbed.navigateToPage('pinboards')
      * When used with `noReload` this can also be a number like 1/-1 to go forward/back.
-     * @param noReload boolean Trigger the navigation without reloading the page (version: 1.12.0 | 8.4.0.cl)
+     * @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;
     /**

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

@@ -47,7 +47,7 @@ export declare function disableAutoLogin(): void;
  *
  * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
  * @returns Promise which resolves when logout completes.
- * @version SDK: 1.10.1 | ThoughtSpot: *
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
  */
 export declare const logout: (doNotDisableAutoLogin?: boolean) => Promise<boolean>;
 /**

package/dist/src/embed/liveboard.d.ts

@@ -24,7 +24,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      * This is the minimum height(in pixels) for a full height Liveboard.
      * Setting this height helps resolves issues with empty Liveboards and
      * other screens navigable from a Liveboard.
-     * @version 1.5.0 or later
+     * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      * @default 500
      */
     defaultHeight?: number;
@@ -38,7 +38,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     liveboardId?: string;
     /**
-     * To support backward compatibilty
+     * To support backward compatibility
      * @hidden
      */
     pinboardId?: string;
@@ -55,7 +55,7 @@ export interface LiveboardViewConfig extends ViewConfig {
      * Array of viz ids which should be visible when the liveboard
      * first renders. This can be changed by triggering the "SetVisibleVizs"
      * event.
-     * @version 1.9.1 or later
+     * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     visibleVizs?: string[];
     /**
@@ -64,13 +64,16 @@ export interface LiveboardViewConfig extends ViewConfig {
      */
     preventPinboardFilterRemoval?: boolean;
     /**
-     * Render embedded liveboards and visualizations using the new v2 rendering mode
-     * This is a transient flag which is primarily meant for internal use
+     * Render embedded Liveboards and visualizations in the new Liveboard experience mode
      * @default false
-     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
-     * @hidden
+     * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
      */
     liveboardV2?: boolean;
+    /**
+     * Tab Id of the Liveboard that is supposed to be active
+     * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
+     */
+    activeTabId?: string;
 }
 /**
  * Embed a ThoughtSpot Liveboard or visualization

package/dist/src/embed/pinboard.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Copyright (c) 2021
+ *
+ * Embed a ThoughtSpot pinboard or visualization
+ * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
+ * https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
+ *
+ * @summary Pinboard & visualization embed
+ * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
+ */
+import { DOMSelector } from '../types';
+import { V1Embed, ViewConfig } from './ts-embed';
+/**
+ * The configuration for the embedded pinboard or visualization page view.
+ * @Category Pinboards and Charts
+ */
+export interface PinboardViewConfig extends ViewConfig {
+    /**
+     * If set to true, the embedded object container dynamically resizes
+     * according to the height of the pinboard.
+     */
+    fullHeight?: boolean;
+    /**
+     * This is the minimum height(in pixels) for a full height pinboard.
+     * Setting this height helps resolves issues with empty pinboards and
+     * other screens navigable from a pinboard.
+     * @default 500
+     * * _since 1.5.0_
+     */
+    defaultHeight?: number;
+    /**
+     * If set to true, the context menu in visualizations will be enabled.
+     */
+    enableVizTransformations?: boolean;
+    /**
+     * The pinboard to display in the embedded view.
+     */
+    pinboardId: string;
+    /**
+     * The visualization within the pinboard to display.
+     */
+    vizId?: string;
+    /**
+     * If set to true, all filter chips from a
+     * pinboard page will be read-only (no X buttons)
+     */
+    preventPinboardFilterRemoval?: boolean;
+    /**
+     * An array of vizids which should be visible when this pinboard loads.
+     * The ids not in this array are hidden from the pinboard.
+     * _since: 1.6.0_
+     */
+    pinboardVisibleVizs?: string[];
+}
+/**
+ * Embed a ThoughtSpot pinboard or visualization
+ * @Category Pinboards and Charts
+ */
+export declare class PinboardEmbed extends V1Embed {
+    protected viewConfig: PinboardViewConfig;
+    private defaultHeight;
+    constructor(domSelector: DOMSelector, viewConfig: PinboardViewConfig);
+    /**
+     * Construct a map of params to be passed on to the
+     * embedded pinboard or visualization.
+     */
+    private getEmbedParams;
+    /**
+     * Construct the URL of the embedded ThoughtSpot pinboard or visualization
+     * to be loaded within the iframe.
+     * @param pinboardId The GUID of the pinboard.
+     * @param vizId The optional GUID of a visualization within the pinboard.
+     * @param runtimeFilters A list of runtime filters to be applied to
+     * the pinboard or visualization on load.
+     */
+    private getIFrameSrc;
+    /**
+     * Set the iframe height as per the computed height received
+     * from the ThoughtSpot app.
+     * @param data The event payload
+     */
+    private updateIFrameHeight;
+    private embedIframeCenter;
+    private handleRouteChangeFullHeightPinboard;
+    /**
+     * Render an embedded ThoughtSpot pinboard or visualization
+     * @param renderOptions An object specifying the pinboard ID,
+     * visualization ID and the runtime filters.
+     */
+    render(): PinboardEmbed;
+}

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

@@ -44,9 +44,13 @@ export interface SearchViewConfig extends ViewConfig {
      * using raw answer data.
      */
     hideResults?: boolean;
+    /**
+     * If set to true, expands all the data sources panel.
+     */
+    expandAllDataSource?: boolean;
     /**
      * If set to true, the Search Assist feature is enabled.
-     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
+     * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
      */
     enableSearchAssist?: boolean;
     /**

package/dist/src/embed/ts-embed.d.ts

@@ -68,12 +68,12 @@ export interface ViewConfig {
     /**
      * The list of actions to display from the primary menu, more menu
      * (...), and the contextual menu.
-     * @version 1.6.0 or later
+     * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     visibleActions?: Action[];
     /**
      * Show alert messages and toast messages in the embedded view.
-     * @version 1.11.0 | ThoughtSpot: 8.3.0.cl
+     * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     showAlerts?: boolean;
     /**
@@ -83,7 +83,7 @@ export interface ViewConfig {
     runtimeFilters?: RuntimeFilter[];
     /**
      * The locale/language to use for the embedded view.
-     * @version 1.9.4 or later
+     * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1-sw
      */
     locale?: string;
     /**
@@ -93,7 +93,7 @@ export interface ViewConfig {
      * Warning: This option is for advanced use only and is used internally
      * to control embed behavior in non-regular ways. We do not publish the
      * list of supported keys and values associated with each.
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
+     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     additionalFlags?: {
         [key: string]: string | number | boolean;