@thoughtspot/visual-embed-sdk 1.17.2-customcss → 1.18.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.17.2-customcss",
+    "version": "1.18.0-alpha.0",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -12,12 +12,16 @@
     ],
     "exports": {
         ".": "./lib/src/index.js",
-        "./react": "./lib/src/react/index.js"
+        "./react": {
+            "import": "./lib/src/react/index.js",
+            "require": "./cjs/src/react.index.js",
+            "types": "./lib/src/react/index.d.ts"
+        }
     },
     "scripts": {
         "lint": "eslint 'src/**'",
         "lint:fix": "eslint 'src/**/*.*' --fix",
-        "tsc": "tsc -p . --incremental false",
+        "tsc": "tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",
         "start": "gatsby develop",
         "build:gatsby": "npm run clean:gatsby && gatsby build --prefix-paths",
         "build:gatsby:noprefix": "npm run clean:gatsby && gatsby build",
@@ -117,7 +121,7 @@
         "typedoc": "0.21.6",
         "typedoc-neo-theme": "^1.1.0",
         "typedoc-plugin-toc-group": "0.0.5",
-        "typescript": "^4.1.0",
+        "typescript": "^4.9.4",
         "url-search-params-polyfill": "^8.1.0",
         "util": "^0.12.4"
     },

package/src/embed/base.ts

@@ -171,11 +171,11 @@ export const init = (embedConfig: EmbedConfig): EventEmitter => {
         authType: config.authType,
         host: config.thoughtSpotHost,
         usedCustomizationSheet:
-            embedConfig.customisations?.style?.customCSSUrl != null,
+            embedConfig.customizations?.style?.customCSSUrl != null,
         usedCustomizationVariables:
-            embedConfig.customisations?.style?.customCss?.variables != null,
+            embedConfig.customizations?.style?.customCSS?.variables != null,
         usedCustomizationRules:
-            embedConfig.customisations?.style?.customCss?.rules_UNSTABLE !=
+            embedConfig.customizations?.style?.customCSS?.rules_UNSTABLE !=
             null,
     });
 

package/src/embed/search-bar.tsx

@@ -22,7 +22,7 @@ export interface SearchBarViewConfig extends ViewConfig {
  * Embed ThoughtSpot search bar
  *
  * @Category Search Embed
- * @version: SDK: 1.17.0 | ThoughtSpot 8.10.0.cl, 9.0.1-sw
+ * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
  */
 export class SearchBarEmbed extends TsEmbed {
     /**

package/src/embed/search.ts

@@ -52,10 +52,6 @@ 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, 8.8.1-sw
@@ -134,7 +130,6 @@ export class SearchEmbed extends TsEmbed {
     private getIFrameSrc(answerId: string, dataSources?: string[]) {
         const {
             hideResults,
-            expandAllDataSource,
             enableSearchAssist,
             forceTable,
             searchOptions,

package/src/embed/ts-embed.spec.ts

@@ -66,7 +66,7 @@ describe('Unit test case for ts embed', () => {
             init({
                 thoughtSpotHost: 'tshost',
                 authType: AuthType.None,
-                customisations,
+                customizations: customisations,
             });
         });
 

package/src/embed/ts-embed.ts

@@ -148,13 +148,6 @@ export interface ViewConfig {
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     additionalFlags?: { [key: string]: string | number | boolean };
-    /**
-     * Dynamic CSS Url to be injected in the loaded application.
-     * You would also need to set `style-src` in the CSP settings.
-     * @version SDK: 1.17.2 | ThoughtSpot: 8.4.1-sw, 8.4.0.cl
-     * @default ''
-     */
-    customCssUrl?: string;
 }
 
 /**
@@ -376,6 +369,10 @@ export class TsEmbed {
         ) {
             queryParams[Param.DisableLoginRedirect] = true;
         }
+        // TODO remove this
+        if (this.embedConfig.customCssUrl) {
+            queryParams[Param.CustomCSSUrl] = this.embedConfig.customCssUrl;
+        }
         if (this.embedConfig.authType === AuthType.EmbeddedSSO) {
             queryParams[Param.ForceSAMLAutoRedirect] = true;
         }
@@ -388,7 +385,6 @@ export class TsEmbed {
             showAlerts,
             additionalFlags,
             locale,
-            customCssUrl,
         } = this.viewConfig;
 
         if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
@@ -398,16 +394,6 @@ export class TsEmbed {
             return queryParams;
         }
 
-        // TODO remove this
-        if (this.embedConfig.customCssUrl) {
-            queryParams[Param.CustomCSSUrl] = this.embedConfig.customCssUrl;
-        }
-
-        // If you need to override customCSS URL for a specific embed liveboard
-        if (customCssUrl) {
-            queryParams[Param.CustomCSSUrl] = customCssUrl;
-        }
-
         if (disabledActions?.length) {
             queryParams[Param.DisableActions] = disabledActions;
         }
@@ -733,7 +719,7 @@ export class TsEmbed {
      * @param messageType The event type
      * @param data The payload to send with the message
      */
-    public trigger(messageType: HostEvent, data: any): Promise<any> {
+    public trigger(messageType: HostEvent, data: any = {}): Promise<any> {
         uploadMixpanelEvent(
             `${MIXPANEL_EVENT.VISUAL_SDK_TRIGGER}-${messageType}`,
         );

package/src/types.ts

@@ -87,11 +87,11 @@ interface customCssInterface {
 }
 interface CustomStyles {
     customCSSUrl?: string;
-    customCss?: customCssInterface;
+    customCSS?: customCssInterface;
 }
 export interface CustomisationsInterface {
-    style: CustomStyles;
-    content: {
+    style?: CustomStyles;
+    content?: {
         [key: string]: string;
     };
 }
@@ -239,13 +239,12 @@ export interface EmbedConfig {
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
      */
     suppressSearchEmbedBetaWarning?: boolean;
-
     /**
      * Custom style params for embed Config.
      *
      * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
      */
-    customisations?: CustomisationsInterface;
+    customizations?: CustomisationsInterface;
     /**
      * For noRedirect SSO Auth, we need a button which the user
      * click to trigger the flow. This is the containing element
@@ -778,7 +777,10 @@ export enum HostEvent {
      * Triggers the Pin action on an embedded object
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
-     * @example liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.Pin)
+     * searchEmbed.trigger(HostEvent.Pin)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Pin = 'pin',
@@ -825,8 +827,11 @@ export enum HostEvent {
      */
     DownloadAsPdf = 'downloadAsPdf',
     /**
-     * Triggers the Make a copy action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.MakeACopy)
+     * Triggers the Make a copy action on a Liveboard, search or visualization
+     * @example
+     * liveboardEmbed.trigger(HostEvent.MakeACopy, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.MakeACopy)
+     * searchEmbed.trigger(HostEvent.MakeACopy)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     MakeACopy = 'makeACopy',
@@ -890,15 +895,74 @@ export enum HostEvent {
     /**
      * Get TML for the current search.
      * @example searchEmbed.trigger(HostEvent.GetTML)
-     * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+     * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
      */
     GetTML = 'getTML',
+    /**
+     * Triggers the ShowUnderlyingData action on visualization or search
+     * @param - an object with vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.ShowUnderlyingData, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.ShowUnderlyingData)
+     * searchEmbed.trigger(HostEvent.ShowUnderlyingData)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    ShowUnderlyingData = 'showUnderlyingData',
+    /**
+     * Triggers the Delete action on visualization or search
+     * @param - incase of Liveboard embed, takes in an object with vizId as a key
+     * can be left empty for search and visualization embeds
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Delete, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.Delete)
+     * searchEmbed.trigger(HostEvent.Delete)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    Delete = 'delete',
+    /**
+     * Triggers the SpotIQAnalyze action on visualization or search
+     * @param - incase of Liveboard embed, takes in an object with vizId as a key
+     * can be left empty for search and visualization embeds
+     * @example
+     * liveboardEmbed.trigger(HostEvent.SpotIQAnalyze, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.SpotIQAnalyze)
+     * searchEmbed.trigger(HostEvent.SpotIQAnalyze)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    SpotIQAnalyze = 'spotIQAnalyze',
+    /**
+     * Triggers the Download action on visualization or search when Displaymode is Chart
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Download, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.Download)
+     * searchEmbed.trigger(HostEvent.Download)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    Download = 'download',
+    /**
+     * Triggers the downloadAsCSV action on visualization or search when Displaymode is Table
+     * @example
+     * liveboardEmbed.trigger(HostEvent.DownloadAsCsv, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.DownloadAsCsv)
+     * searchEmbed.trigger(HostEvent.DownloadAsCsv)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    DownloadAsCsv = 'downloadAsCSV',
+    /**
+     * Triggers the downloadAsXLSX action on visualization or search when Displaymode is Table
+     * @example
+     * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.DownloadAsXlsx)
+     * searchEmbed.trigger(HostEvent.DownloadAsXlsx)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    DownloadAsXlsx = 'downloadAsXLSX',
     /**
      * Triggers the Share action on a liveboard or answer
      * @example
      * liveboardEmbed.trigger(HostEvent.Share)
      * searchEmbed.trigger(HostEvent.Share)
-     * @version SDK: 1.19.0 | Thoughtspot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     Share = 'share',
     /**
@@ -906,9 +970,36 @@ export enum HostEvent {
      * @example
      * liveboardEmbed.trigger(HostEvent.Save)
      * searchEmbed.trigger(HostEvent.Save)
-     * @version SDK: 1.19.0 | Thoughtspot: 9.0.0.cl, 9.0.1-sw
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
      */
     Save = 'save',
+    /**
+     * Triggers the SyncToSheets action on visualization
+     * @param - an object with vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.SyncToSheets, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.SyncToSheets)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    SyncToSheets = 'sync-to-sheets',
+    /**
+     * Triggers the SyncToOtherApps action on visualization
+     * @param - an object with vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.SyncToOtherApps, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.SyncToOtherApps)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    SyncToOtherApps = 'sync-to-other-apps',
+    /**
+     * Triggers the ManagePipelines action on visualization
+     * @param - an object with vizId as a key
+     * @example
+     * liveboardEmbed.trigger(HostEvent.ManagePipelines, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * vizEmbed.trigger(HostEvent.ManagePipelines)
+     * @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1-sw
+     */
+    ManagePipelines = 'manage-pipeline',
 }
 
 /**

package/src/utils.ts

@@ -181,12 +181,14 @@ export const getCustomisations = (
     embedConfig: EmbedConfig,
 ): CustomisationsInterface => {
     const { customCssUrl } = embedConfig;
-    let { customisations } = embedConfig;
-    customisations = customisations || ({} as CustomisationsInterface);
-    customisations.style = customisations.style || {};
-    customisations.style.customCSSUrl =
-        customisations.style.customCSSUrl || customCssUrl;
-    return customisations;
+    let customizations =
+        embedConfig.customizations ||
+        ((embedConfig as any).customisations as CustomisationsInterface);
+    customizations = customizations || ({} as CustomisationsInterface);
+    customizations.style = customizations.style || {};
+    customizations.style.customCSSUrl =
+        customizations.style.customCSSUrl || customCssUrl;
+    return customizations;
 };
 
 /**