@thoughtspot/visual-embed-sdk 1.7.0-alpha.0 → 1.7.0

package/README.md

@@ -163,4 +163,4 @@ const MyComponent = ({ dataSources }) => {
 <br/>
 <br/>
 
-Visual-Embed-SDK, © ThoughtSpot, Inc. 2021
+Visual-Embed-SDK, © ThoughtSpot, Inc. 2022

package/dist/src/auth.d.ts

@@ -6,7 +6,8 @@ export declare let sessionInfo: any;
 export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
 export declare const EndPoints: {
     AUTH_VERIFICATION: string;
-    SSO_LOGIN_TEMPLATE: (targetUrl: string) => string;
+    SAML_LOGIN_TEMPLATE: (targetUrl: string) => string;
+    OIDC_LOGIN_TEMPLATE: (targetUrl: string) => string;
     TOKEN_LOGIN: string;
     BASIC_LOGIN: string;
 };
@@ -29,11 +30,8 @@ export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<void>;
  * @param embedConfig The embed configuration
  */
 export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<void>;
-/**
- * Perform SAML authentication
- * @param embedConfig The embed configuration
- */
 export declare const doSamlAuth: (embedConfig: EmbedConfig) => Promise<void>;
+export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<void>;
 /**
  * Perform authentication on the ThoughtSpot cluster
  * @param embedConfig The embed configuration

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

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021
+ * Copyright (c) 2022
  *
  * Full application embedding
  * https://developers.thoughtspot.com/docs/?pageid=full-embed

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

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021
+ * Copyright (c) 2022
  *
  * Embed a ThoughtSpot Liveboard or visualization
  * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard

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

@@ -1,12 +1,12 @@
 /**
- * Copyright (c) 2021
+ * Copyright (c) 2022
  *
  * Embed ThoughtSpot search or a saved answer
  *
  * @summary Search embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import { DOMSelector } from '../types';
+import { DOMSelector, Action } from '../types';
 import { ViewConfig, TsEmbed } from './ts-embed';
 /**
  * Configuration for search options
@@ -44,6 +44,10 @@ 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.
      */
@@ -71,6 +75,7 @@ export interface SearchViewConfig extends ViewConfig {
      */
     answerId?: string;
 }
+export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
 /**
  * Embed ThoughtSpot search
  *

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

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2021
+ * Copyright (c) 2022
  *
  * Base classes
  *

package/dist/src/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020
+ * Copyright (c) 2022
  *
  * ThoughtSpot Visual Embed SDK for embedding ThoughtSpot analytics
  * in other web applications.

package/dist/src/test/test-utils.d.ts

@@ -24,4 +24,5 @@ export declare const executeAfterWait: (fn: (...args: any[]) => void, waitTime?:
  * Time (in milliseconds) to wait for async events to be triggered
  */
 export declare const EVENT_WAIT_TIME = 1000;
+export declare function fixedEncodeURI(str: string): string;
 export {};

package/dist/src/types.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020
+ * Copyright (c) 2022
  *
  * TypeScript type definitions for ThoughtSpot Visual Embed SDK
  *
@@ -19,6 +19,10 @@ export declare enum AuthType {
      * SSO using SAML
      */
     SSO = "SSO_SAML",
+    /**
+     * SSO using OIDC
+     */
+    OIDC = "SSO_OIDC",
     /**
      * Trusted authentication server
      */
@@ -331,6 +335,9 @@ export declare enum EmbedEvent {
 /**
  * Event types that can be triggered by the host application
  * to the embedded ThoughtSpot app
+ *
+ * To trigger an event use the corresponding
+ * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link SearchEmbed.trigger} method.
  */
 export declare enum HostEvent {
     /**
@@ -364,7 +371,13 @@ export declare enum HostEvent {
      *          will be hidden.
      * @version 1.6.0 or later
      */
-    SetVisibleVizs = "SetPinboardVisibleVizs"
+    SetVisibleVizs = "SetPinboardVisibleVizs",
+    /**
+     * Update the runtime filters
+     * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+     * @version 1.8.0 or later
+     */
+    UpdateRuntimeFilters = "UpdateRuntimeFilters"
 }
 /**
  * The different visual modes that the data sources panel within
@@ -391,6 +404,7 @@ export declare enum DataSourceVisualMode {
 export declare enum Param {
     DataSources = "dataSources",
     DataSourceMode = "dataSourceMode",
+    ExpandAllDataSource = "expandAllDataSource",
     DisableActions = "disableAction",
     DisableActionReason = "disableHint",
     ForceTable = "forceTable",
@@ -408,6 +422,7 @@ export declare enum Param {
     executeSearch = "executeSearch",
     fullHeight = "isFullHeightPinboard",
     livedBoardEmbed = "isLiveboardEmbed",
+    searchEmbed = "isSearchEmbed",
     Version = "sdkVersion",
     ViewPortHeight = "viewPortHeight",
     ViewPortWidth = "viewPortWidth",
@@ -427,7 +442,7 @@ export declare enum Action {
     EditACopy = "editACopy",
     CopyLink = "embedDocument",
     ResetLayout = "resetLayout",
-    Schedule = "schedule",
+    Schedule = "subscription",
     SchedulesList = "schedule-list",
     Share = "share",
     AddFilter = "addFilter",
@@ -476,6 +491,7 @@ export declare enum Action {
     DrillInclude = "context-menu-item-include",
     DrillExclude = "context-menu-item-exclude",
     CopyToClipboard = "context-menu-item-copy-to-clipboard",
+    CopyAndEdit = "context-menu-item-copy-and-edit",
     DrillEdit = "context-menu-item-edit",
     EditMeasure = "context-menu-item-edit-measure",
     Separator = "context-menu-item-separator",

package/dist/src/utils.d.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020
+ * Copyright (c) 2022
  *
  * Common utility functions for ThoughtSpot Visual Embed SDK
  *

package/dist/tsembed.es.js

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020
+ * Copyright (c) 2022
  *
  * Common utility functions for ThoughtSpot Visual Embed SDK
  *
@@ -111,7 +111,7 @@ const getOffsetTop = (element) => {
 };
 
 /**
- * Copyright (c) 2020
+ * Copyright (c) 2022
  *
  * TypeScript type definitions for ThoughtSpot Visual Embed SDK
  *
@@ -133,6 +133,10 @@ var AuthType;
      * SSO using SAML
      */
     AuthType["SSO"] = "SSO_SAML";
+    /**
+     * SSO using OIDC
+     */
+    AuthType["OIDC"] = "SSO_OIDC";
     /**
      * Trusted authentication server
      */
@@ -329,6 +333,9 @@ var EmbedEvent;
 /**
  * Event types that can be triggered by the host application
  * to the embedded ThoughtSpot app
+ *
+ * To trigger an event use the corresponding
+ * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link SearchEmbed.trigger} method.
  */
 // eslint-disable-next-line no-shadow
 var HostEvent;
@@ -365,6 +372,12 @@ var HostEvent;
      * @version 1.6.0 or later
      */
     HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
+    /**
+     * Update the runtime filters
+     * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+     * @version 1.8.0 or later
+     */
+    HostEvent["UpdateRuntimeFilters"] = "UpdateRuntimeFilters";
 })(HostEvent || (HostEvent = {}));
 /**
  * The different visual modes that the data sources panel within
@@ -395,6 +408,7 @@ var Param;
 (function (Param) {
     Param["DataSources"] = "dataSources";
     Param["DataSourceMode"] = "dataSourceMode";
+    Param["ExpandAllDataSource"] = "expandAllDataSource";
     Param["DisableActions"] = "disableAction";
     Param["DisableActionReason"] = "disableHint";
     Param["ForceTable"] = "forceTable";
@@ -412,6 +426,7 @@ var Param;
     Param["executeSearch"] = "executeSearch";
     Param["fullHeight"] = "isFullHeightPinboard";
     Param["livedBoardEmbed"] = "isLiveboardEmbed";
+    Param["searchEmbed"] = "isSearchEmbed";
     Param["Version"] = "sdkVersion";
     Param["ViewPortHeight"] = "viewPortHeight";
     Param["ViewPortWidth"] = "viewPortWidth";
@@ -433,7 +448,7 @@ var Action;
     Action["EditACopy"] = "editACopy";
     Action["CopyLink"] = "embedDocument";
     Action["ResetLayout"] = "resetLayout";
-    Action["Schedule"] = "schedule";
+    Action["Schedule"] = "subscription";
     Action["SchedulesList"] = "schedule-list";
     Action["Share"] = "share";
     Action["AddFilter"] = "addFilter";
@@ -482,6 +497,7 @@ var Action;
     Action["DrillInclude"] = "context-menu-item-include";
     Action["DrillExclude"] = "context-menu-item-exclude";
     Action["CopyToClipboard"] = "context-menu-item-copy-to-clipboard";
+    Action["CopyAndEdit"] = "context-menu-item-copy-and-edit";
     Action["DrillEdit"] = "context-menu-item-edit";
     Action["EditMeasure"] = "context-menu-item-edit-measure";
     Action["Separator"] = "context-menu-item-separator";
@@ -502,7 +518,7 @@ const ERROR_MESSAGE = {
 };
 
 /**
- * Copyright (c) 2020
+ * Copyright (c) 2022
  *
  * Utilities related to reading configuration objects
  *
@@ -8496,7 +8512,8 @@ let sessionInfo = null;
 const SSO_REDIRECTION_MARKER_GUID = '5e16222e-ef02-43e9-9fbd-24226bf3ce5b';
 const EndPoints = {
     AUTH_VERIFICATION: '/callosum/v1/session/info',
-    SSO_LOGIN_TEMPLATE: (targetUrl) => `/callosum/v1/saml/login?targetURLPath=${targetUrl}`,
+    SAML_LOGIN_TEMPLATE: (targetUrl) => `/callosum/v1/saml/login?targetURLPath=${targetUrl}`,
+    OIDC_LOGIN_TEMPLATE: (targetUrl) => `/callosum/v1/oidc/login?targetURLPath=${targetUrl}`,
     TOKEN_LOGIN: '/callosum/v1/session/login/token',
     BASIC_LOGIN: '/callosum/v1/session/login',
 };
@@ -8604,7 +8621,7 @@ async function samlPopupFlow(ssoURL) {
  * Perform SAML authentication
  * @param embedConfig The embed configuration
  */
-const doSamlAuth = async (embedConfig) => {
+const doSSOAuth = async (embedConfig, ssoEndPoint) => {
     const { thoughtSpotHost } = embedConfig;
     const loggedIn = await isLoggedIn(thoughtSpotHost);
     if (loggedIn) {
@@ -8621,13 +8638,6 @@ const doSamlAuth = async (embedConfig) => {
         loggedInStatus = false;
         return;
     }
-    // redirect for SSO, when the SSO authentication is done, this page will be loaded
-    // again and the same JS will execute again.
-    const ssoRedirectUrl = embedConfig.noRedirect
-        ? `${thoughtSpotHost}/v2/#/embed/saml-complete`
-        : appendToUrlHash(window.location.href, SSO_REDIRECTION_MARKER_GUID);
-    // bring back the page to the same URL
-    const ssoEndPoint = `${EndPoints.SSO_LOGIN_TEMPLATE(encodeURIComponent(ssoRedirectUrl))}`;
     const ssoURL = `${thoughtSpotHost}${ssoEndPoint}`;
     if (embedConfig.noRedirect) {
         await samlPopupFlow(ssoURL);
@@ -8635,6 +8645,28 @@ const doSamlAuth = async (embedConfig) => {
     }
     window.location.href = ssoURL;
 };
+const doSamlAuth = async (embedConfig) => {
+    const { thoughtSpotHost } = embedConfig;
+    // redirect for SSO, when the SSO authentication is done, this page will be loaded
+    // again and the same JS will execute again.
+    const ssoRedirectUrl = embedConfig.noRedirect
+        ? `${thoughtSpotHost}/v2/#/embed/saml-complete`
+        : appendToUrlHash(window.location.href, SSO_REDIRECTION_MARKER_GUID);
+    // bring back the page to the same URL
+    const ssoEndPoint = `${EndPoints.SAML_LOGIN_TEMPLATE(encodeURIComponent(ssoRedirectUrl))}`;
+    await doSSOAuth(embedConfig, ssoEndPoint);
+};
+const doOIDCAuth = async (embedConfig) => {
+    const { thoughtSpotHost } = embedConfig;
+    // redirect for SSO, when the SSO authentication is done, this page will be loaded
+    // again and the same JS will execute again.
+    const ssoRedirectUrl = embedConfig.noRedirect
+        ? `${thoughtSpotHost}/v2/#/embed/saml-complete`
+        : appendToUrlHash(window.location.href, SSO_REDIRECTION_MARKER_GUID);
+    // bring back the page to the same URL
+    const ssoEndPoint = `${EndPoints.OIDC_LOGIN_TEMPLATE(encodeURIComponent(ssoRedirectUrl))}`;
+    await doSSOAuth(embedConfig, ssoEndPoint);
+};
 /**
  * Perform authentication on the ThoughtSpot cluster
  * @param embedConfig The embed configuration
@@ -8644,6 +8676,8 @@ const authenticate = async (embedConfig) => {
     switch (authType) {
         case AuthType.SSO:
             return doSamlAuth(embedConfig);
+        case AuthType.OIDC:
+            return doOIDCAuth(embedConfig);
         case AuthType.AuthServer:
             return doTokenAuth(embedConfig);
         case AuthType.Basic:
@@ -8839,16 +8873,17 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
     }
 }
 
-var version="1.7.0-alpha.0";
+var name="@thoughtspot/visual-embed-sdk";var version="1.7.0";var description="ThoughtSpot Embed SDK";var module="lib/src/index.js";var main="dist/tsembed.js";var types="lib/src/index.d.ts";var files=["dist/**","lib/**","src/**"];var exports={".":"./lib/src/index.js","./react":"./lib/src/react/index.js"};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",tsc:"tsc -p . --incremental false",start:"gatsby develop","build:gatsby":"npm run clean:gatsby && gatsby build --prefix-paths","build:gatsby:noprefix":"npm run clean:gatsby && gatsby build","serve:gatsby":"gatsby serve","clean:gatsby":"gatsby clean","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts",build:"rollup -c",watch:"rollup -cw","docs-cmd":"node scripts/gatsby-commands.js",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme","test-sdk":"jest -c jest.config.sdk.js","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs && npx istanbul-merge --out ./coverage/coverage.json ./coverage/docs/coverage-final.json ./coverage/sdk/coverage-final.json && npx istanbul report --include ./coverage/coverage.json --dir ./coverage lcov",posttest:"cat ./coverage/lcov.info | coveralls",prepublishOnly:"npm run test; npm run tsc; npm run bundle-dts; npm run build","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1","mixpanel-browser":"^2.41.0"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@testing-library/dom":"^7.31.0","@testing-library/jest-dom":"^5.14.1","@testing-library/react":"^11.2.7","@testing-library/user-event":"^13.1.8","@types/jest":"^22.2.3","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^4.6.0","@typescript-eslint/parser":"^4.6.0",asciidoctor:"^2.2.1","babel-jest":"^26.6.3","babel-preset-gatsby":"^1.10.0",classnames:"^2.3.1","command-line-args":"^5.1.1",coveralls:"^3.1.0","dts-bundle":"0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.1.0","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"4.1.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^4.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-neo-theme":"^1.1.0","typedoc-plugin-toc-group":"0.0.5",typescript:"^4.1.0","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports,scripts:scripts,peerDependencies:peerDependencies,dependencies:dependencies,devDependencies:devDependencies,author:author,email:email,license:license,directories:directories,repository:repository,publishConfig:publishConfig,keywords:keywords,bugs:bugs,homepage:homepage,globals:globals};
 
 /**
- * Copyright (c) 2021
+ * Copyright (c) 2022
  *
  * Base classes
  *
  * @summary Base classes
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
+const { version: version$1 } = pkgInfo;
 /**
  * The event id map from v2 event names to v1 event id
  * v1 events are the classic embed events implemented in Blink v1
@@ -9000,7 +9035,7 @@ class TsEmbed {
         queryParams[Param.HostAppUrl] = encodeURIComponent(hostAppUrl);
         queryParams[Param.ViewPortHeight] = window.innerHeight;
         queryParams[Param.ViewPortWidth] = window.innerWidth;
-        queryParams[Param.Version] = version;
+        queryParams[Param.Version] = version$1;
         if (this.embedConfig.customCssUrl) {
             queryParams[Param.CustomCSSUrl] = this.embedConfig.customCssUrl;
         }
@@ -9272,7 +9307,7 @@ class V1Embed extends TsEmbed {
 }
 
 /**
- * Copyright (c) 2021
+ * Copyright (c) 2022
  *
  * Full application embedding
  * https://developers.thoughtspot.com/docs/?pageid=full-embed
@@ -9419,7 +9454,7 @@ class AppEmbed extends V1Embed {
 }
 
 /**
- * Copyright (c) 2021
+ * Copyright (c) 2022
  *
  * Embed a ThoughtSpot Liveboard or visualization
  * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
@@ -9530,13 +9565,17 @@ class PinboardEmbed extends LiveboardEmbed {
 }
 
 /**
- * Copyright (c) 2021
+ * Copyright (c) 2022
  *
  * Embed ThoughtSpot search or a saved answer
  *
  * @summary Search embed
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
+const HiddenActionItemByDefaultForSearchEmbed = [
+    Action.EditACopy,
+    Action.SaveAsView,
+];
 /**
  * Embed ThoughtSpot search
  *
@@ -9568,9 +9607,14 @@ class SearchEmbed extends TsEmbed {
      * @param dataSources A list of data source GUIDs
      */
     getIFrameSrc(answerId, dataSources) {
-        const { hideResults, enableSearchAssist, forceTable, searchOptions, } = this.viewConfig;
+        var _a;
+        const { hideResults, expandAllDataSource, enableSearchAssist, forceTable, searchOptions, } = this.viewConfig;
         const answerPath = answerId ? `saved-answer/${answerId}` : 'answer';
         const queryParams = this.getBaseQueryParams();
+        queryParams[Param.HideActions] = [
+            ...((_a = queryParams[Param.HideActions]) !== null && _a !== void 0 ? _a : []),
+            ...HiddenActionItemByDefaultForSearchEmbed,
+        ];
         if (dataSources && dataSources.length) {
             queryParams[Param.DataSources] = JSON.stringify(dataSources);
         }
@@ -9591,6 +9635,7 @@ class SearchEmbed extends TsEmbed {
         }
         queryParams[Param.DataSourceMode] = this.getDataSourceMode();
         queryParams[Param.UseLastSelectedDataSource] = false;
+        queryParams[Param.searchEmbed] = true;
         let query = '';
         const queryParamsString = getQueryParamString(queryParams, true);
         if (queryParamsString) {