@thoughtspot/visual-embed-sdk 1.10.0-alpha.1 → 1.10.0-alpha.2

package/src/embed/ts-embed.ts

@@ -11,6 +11,7 @@ import {
     getEncodedQueryParamsString,
     getCssDimension,
     getOffsetTop,
+    setAttributes,
 } from '../utils';
 import {
     getThoughtSpotHost,
@@ -37,6 +38,11 @@ import { getAuthPromise, getEmbedConfig, renderInQueue } from './base';
 
 const { version } = pkgInfo;
 
+/**
+ * Global prefix for all Thoughtspot postHash Params.
+ */
+export const THOUGHTSPOT_PARAM_PREFIX = 'ts-';
+
 /**
  * The event id map from v2 event names to v1 event id
  * v1 events are the classic embed events implemented in Blink v1
@@ -62,6 +68,11 @@ export interface FrameParams {
      * The height of the iFrame (unit is pixels if numeric).
      */
     height?: number | string;
+    /**
+     * This parameters will be passed on the iframe
+     * as is.
+     */
+    [key: string]: string | number | boolean;
 }
 
 /**
@@ -403,7 +414,7 @@ export class TsEmbed {
      * @param url
      * @param frameOptions
      */
-    protected renderIFrame(url: string, frameOptions: FrameParams): void {
+    protected renderIFrame(url: string, frameOptions: FrameParams = {}): void {
         if (this.isError) {
             return;
         }
@@ -445,12 +456,19 @@ export class TsEmbed {
                     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                     // @ts-ignore
                     this.iFrame.mozallowfullscreen = true;
+                    const {
+                        height: frameHeight,
+                        width: frameWidth,
+                        ...restParams
+                    } = frameOptions;
                     const width = getCssDimension(
-                        frameOptions?.width || DEFAULT_EMBED_WIDTH,
+                        frameWidth || DEFAULT_EMBED_WIDTH,
                     );
                     const height = getCssDimension(
-                        frameOptions?.height || DEFAULT_EMBED_HEIGHT,
+                        frameWidth || DEFAULT_EMBED_HEIGHT,
                     );
+                    setAttributes(this.iFrame, restParams);
+
                     this.iFrame.style.width = `${width}`;
                     this.iFrame.style.height = `${height}`;
                     this.iFrame.style.border = '0';
@@ -653,6 +671,34 @@ export class TsEmbed {
 
         return this;
     }
+
+    /**
+     * Get the Post Url Params for THOUGHTSPOT from the current
+     * host app URL.
+     * THOUGHTSPOT URL params starts with a prefix "ts-"
+     */
+    public getThoughtSpotPostUrlParams(): string {
+        const urlHash = window.location.hash;
+        const queryParams = window.location.search;
+        const postHashParams = urlHash.split('?');
+        const postURLParams = postHashParams[postHashParams.length - 1];
+        const queryParamsObj = new URLSearchParams(queryParams);
+        const postURLParamsObj = new URLSearchParams(postURLParams);
+        const params = new URLSearchParams();
+
+        const addKeyValuePairCb = (value: string, key: string): void => {
+            if (key.startsWith(THOUGHTSPOT_PARAM_PREFIX)) {
+                params.append(key, value);
+            }
+        };
+        queryParamsObj.forEach(addKeyValuePairCb);
+        postURLParamsObj.forEach(addKeyValuePairCb);
+
+        let tsParams = params.toString();
+        tsParams = tsParams ? `?${tsParams}` : '';
+
+        return tsParams;
+    }
 }
 
 /**

package/src/types.ts

@@ -484,6 +484,7 @@ export enum Param {
     CustomCSSUrl = 'customCssUrl',
     DisableLoginRedirect = 'disableLoginRedirect',
     visibleVizs = 'pinboardVisibleVizs',
+    LiveboardV2Enabled = 'isPinboardV2Enabled',
 }
 
 /**
@@ -493,30 +494,57 @@ export enum Param {
 // eslint-disable-next-line no-shadow
 export enum Action {
     Save = 'save',
+    /**
+     * @hidden
+     */
     Update = 'update',
+    /**
+     * @hidden
+     */
     SaveUntitled = 'saveUntitled',
     SaveAsView = 'saveAsView',
     MakeACopy = 'makeACopy',
     EditACopy = 'editACopy',
     CopyLink = 'embedDocument',
+    /**
+     * @hidden
+     */
     ResetLayout = 'resetLayout',
     Schedule = 'subscription',
     SchedulesList = 'schedule-list',
     Share = 'share',
     AddFilter = 'addFilter',
     ConfigureFilter = 'configureFilter',
+    /**
+     * @hidden
+     */
     AddFormula = 'addFormula',
+    /**
+     * @hidden
+     */
     SearchOnTop = 'searchOnTop',
     SpotIQAnalyze = 'spotIQAnalyze',
+    /**
+     * @hidden
+     */
     ExplainInsight = 'explainInsight',
+    /**
+     * @hidden
+     */
     SpotIQFollow = 'spotIQFollow',
     ShareViz = 'shareViz',
+    /**
+     * @hidden
+     */
     ReplaySearch = 'replaySearch',
     ShowUnderlyingData = 'showUnderlyingData',
     Download = 'download',
     DownloadAsPdf = 'downloadAsPdf',
     DownloadAsCsv = 'downloadAsCSV',
     DownloadAsXlsx = 'downloadAsXLSX',
+    /**
+     * @hidden
+     */
     DownloadTrace = 'downloadTrace',
     ExportTML = 'exportTSL',
     ImportTML = 'importTSL',
@@ -527,18 +555,39 @@ export enum Action {
     Edit = 'edit',
     EditTitle = 'editTitle',
     Remove = 'delete',
+    /**
+     * @hidden
+     */
     Ungroup = 'ungroup',
+    /**
+     * @hidden
+     */
     Describe = 'describe',
+    /**
+     * @hidden
+     */
     Relate = 'relate',
+    /**
+     * @hidden
+     */
     CustomizeHeadlines = 'customizeHeadlines',
     /**
      * @hidden
      */
     PinboardInfo = 'pinboardInfo',
     LiveboardInfo = 'pinboardInfo',
+    /**
+     * @hidden
+     */
     SendAnswerFeedback = 'sendFeedback',
+    /**
+     * @hidden
+     */
     DownloadEmbraceQueries = 'downloadEmbraceQueries',
     Pin = 'pin',
+    /**
+     * @hidden
+     */
     AnalysisInfo = 'analysisInfo',
     Subscription = 'subscription',
     Explore = 'explore',
@@ -546,16 +595,18 @@ export enum Action {
     DrillExclude = 'context-menu-item-exclude',
     CopyToClipboard = 'context-menu-item-copy-to-clipboard',
     CopyAndEdit = 'context-menu-item-copy-and-edit',
+    /**
+     * @hidden
+     */
     DrillEdit = 'context-menu-item-edit',
     EditMeasure = 'context-menu-item-edit-measure',
     Separator = 'context-menu-item-separator',
+    /**
+     * @hidden
+     */
     DrillDown = 'DRILL',
     RequestAccess = 'requestAccess',
     QueryDetailsButtons = 'queryDetailsButtons',
-    /**
-     * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
-     */
-    Monitor = 'createMonitor',
     /**
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
      */

package/src/utils.ts

@@ -135,3 +135,12 @@ export const getOffsetTop = (element: any) => {
     const rect = element.getBoundingClientRect();
     return rect.top + window.scrollY;
 };
+
+export const setAttributes = (
+    element: HTMLElement,
+    attributes: { [key: string]: string | number | boolean },
+): void => {
+    Object.keys(attributes).forEach((key) => {
+        element.setAttribute(key, attributes[key].toString());
+    });
+};