@thoughtspot/visual-embed-sdk 1.20.0 → 1.20.2

package/dist/tsembed.es.js

@@ -180,6 +180,7 @@ function getDOMNode(domSelector) {
 /**
  * The authentication mechanism for allowing access to the
  * the embedded app
+ * @group Authentication / Init
  */
 // eslint-disable-next-line no-shadow
 var AuthType;
@@ -208,7 +209,47 @@ var AuthType;
     AuthType["SAML"] = "SSO_SAML";
     /**
      * SSO using SAML
-     * Will make the host application redirect to the SAML Idp.
+     * Will make the host application redirect to the SAML Idp. Use this
+     * when the idp does not allow itself to be embedded.
+     *
+     * This redirects the host application to the SAML Idp. The host application
+     * will be redirected back to the ThoughtSpot app after authentication.
+     * @example
+     * ```js
+     * init({
+     *   // ...
+     *   authType: AuthType.SAMLRedirect,
+     *  });
+     * ```
+     *
+     * This opens the SAML Idp in a popup window. The popup is triggered
+     * when the user clicks the trigger button. The popup window will be
+     * closed automatically after authentication.
+     * @example
+     * ```js
+     * init({
+     *   // ...
+     *   authType: AuthType.SAMLRedirect,
+     *   authTriggerText: 'Login with SAML',
+     *   authTriggerContainer: '#embed-container',
+     *   inPopup: true,
+     * });
+     * ```
+     *
+     * Can also use event to trigger the popup flow. Works the same
+     * as above example.
+     * @example
+     * ```js
+     * const authEE = init({
+     *  // ...
+     *  authType: AuthType.SAMLRedirect,
+     *  inPopup: true,
+     * });
+     *
+     * someButtonOnYourPage.addEventListener('click', () => {
+     *  authEE.emit(AuthEvent.TRIGGER_SSO_POPUP);
+     * });
+     * ```
      */
     AuthType["SAMLRedirect"] = "SSO_SAML";
     /**
@@ -220,6 +261,7 @@ var AuthType;
     /**
      * SSO using OIDC
      * Will make the host application redirect to the OIDC Idp.
+     * See code samples in {@link SAMLRedirect}.
      */
     AuthType["OIDCRedirect"] = "SSO_OIDC";
     /**
@@ -232,6 +274,18 @@ var AuthType;
      * Trusted authentication server, Use your own authentication server
      * which returns a bearer token, generated using the secret_key obtained from
      * ThoughtSpot.
+     *
+     * @example
+     * ```js
+     * init({
+     *  // ...
+     *  authType: AuthType.TrustedAuthToken,
+     *  getAuthToken: () => {
+     *    return fetch('https://my-backend.app/ts-token')
+     *      .then((response) => response.json())
+     *      .then((data) => data.token);
+     *  }
+     * ```
      */
     AuthType["TrustedAuthToken"] = "AuthServer";
     /**
@@ -314,6 +368,10 @@ var RuntimeFilterOp;
 })(RuntimeFilterOp || (RuntimeFilterOp = {}));
 /**
  * Event types emitted by the embedded ThoughtSpot application.
+ *
+ * To add an event listener use the corresponding
+ * {@link LiveboardEmbed.on} or {@link AppEmbed.on} or {@link SearchEmbed.on} method.
+ * @group Events
  */
 // eslint-disable-next-line no-shadow
 var EmbedEvent;
@@ -480,6 +538,12 @@ var EmbedEvent;
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
      */
     EmbedEvent["Download"] = "download";
+    /**
+     * Emitted when the download action is triggered on an answer
+     *
+     * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0-sw
+     */
+    EmbedEvent["DownloadAsPng"] = "downloadAsPng";
     /**
      * Emitted when the Download as PDF action is triggered on an answer
      * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
@@ -642,6 +706,7 @@ var EmbedEvent;
  *
  * To trigger an event use the corresponding
  * {@link LiveboardEmbed.trigger} or {@link AppEmbed.trigger} or {@link SearchEmbed.trigger} method.
+ * @group Events
  */
 // eslint-disable-next-line no-shadow
 var HostEvent;
@@ -654,11 +719,13 @@ var HostEvent;
      * @param - searchQuery - The search query
      * @param - execute - execute the existing / updated query
      * @example
+     * ```js
      * searchEmbed.trigger(HostEvent.Search, {
-     * searchQuery: "[sales] by [item type],
-     * "dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
-     * "execute": true
+     *   searchQuery: "[sales] by [item type],
+     *   dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
+     *   execute: true
      * })
+     * ```
      */
     HostEvent["Search"] = "search";
     /**
@@ -667,10 +734,14 @@ var HostEvent;
      *              eg. { selectedPoints: []}
      * @param - columnGuid - a string guid of the column to drill by. This is optional,
      *                     if not provided it will auto drill by the configured column.
-     * @example searchEmbed.trigger(HostEvent.DrillDown, {
-     * points: clickedPointData,
-     * autoDrillDown: true,
+     * @example
+     * ```js
+     * searchEmbed.trigger(HostEvent.DrillDown, {
+     *   points: clickedPointData,
+     *   autoDrillDown: true,
      * })
+     * ```
+     *
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      */
     HostEvent["DrillDown"] = "triggerDrillDown";
@@ -709,7 +780,10 @@ var HostEvent;
      * Navigate to a specific page in App embed without any reload.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`
      * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
-     * @example appEmbed.navigateToPage(-1)
+     * @example
+     * ```js
+     * appEmbed.navigateToPage(-1)
+     * ```
      * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
      */
     HostEvent["Navigate"] = "Navigate";
@@ -717,27 +791,39 @@ var HostEvent;
      * Opens the filter panel for a particular column.
      * Works with Search embed.
      * @param - { columnId: string, name: string, type: INT64/CHAR/DATE, dataType: ATTRIBUTE/MEASURE }
-     * @example searchEmbed.trigger(HostEvent.OpenFilter, { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
+     * @example
+     * ```js
+     * searchEmbed.trigger(HostEvent.OpenFilter, { columnId: '123', name: 'column name', type: 'INT64', dataType: 'ATTRIBUTE' })
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     HostEvent["OpenFilter"] = "openFilter";
     /**
      * Adds the columns to the current Search.
      * @param - { columnIds: string[] }
-     * @example searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
+     * @example
+     * ```js
+     * searchEmbed.trigger(HostEvent.AddColumns, { columnIds: ['123', '456'] })
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     HostEvent["AddColumns"] = "addColumns";
     /**
      * Removes a column from the current Search.
      * @param - { columnId: string }
-     * @example - searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
+     * @example
+     * ```js
+     * searchEmbed.trigger(HostEvent.RemoveColumn, { columnId: '123' })
+     * ```
      * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
      */
     HostEvent["RemoveColumn"] = "removeColumn";
     /**
      * Gets the current pinboard content.
-     * @example liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
+     * ```
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
      */
     HostEvent["getExportRequestForCurrentPinboard"] = "getExportRequestForCurrentPinboard";
@@ -746,87 +832,124 @@ var HostEvent;
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
      * @example
+     * ```js
      * 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
      */
     HostEvent["Pin"] = "pin";
     /**
      * Triggers the Show Liveboard details action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.LiveboardInfo)
+     * @example
+     * ```js
+     *  liveboardEmbed.trigger(HostEvent.LiveboardInfo)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["LiveboardInfo"] = "pinboardInfo";
     /**
      * Triggers the Schedule action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.Schedule)
+     * @example
+     * ```js
+     *  liveboardEmbed.trigger(HostEvent.Schedule)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["Schedule"] = "subscription";
     /**
      * Triggers the Manage schedule action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.ScheduleList)
+     * @example
+     * ```js
+     *  liveboardEmbed.trigger(HostEvent.ScheduleList)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["SchedulesList"] = "schedule-list";
     /**
      * Triggers the Export TML action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.ExportTML)
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.ExportTML)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["ExportTML"] = "exportTSL";
     /**
      * Triggers the Edit TML action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.EditTML)
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.EditTML)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["EditTML"] = "editTSL";
     /**
      * Triggers the Update TML action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.UpdateTML)
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.UpdateTML)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["UpdateTML"] = "updateTSL";
     /**
      * Triggers the Download PDF action on a Liveboard
-     * @example liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["DownloadAsPdf"] = "downloadAsPdf";
     /**
      * Triggers the Make a copy action on a Liveboard, search or visualization
      * @example
+     * ```js
      * 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
      */
     HostEvent["MakeACopy"] = "makeACopy";
     /**
      * Triggers the Delete action on a Liveboard
-     * @example appEmbed.trigger(HostEvent.Remove)
+     * @example
+     * ```js
+     * appEmbed.trigger(HostEvent.Remove)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["Remove"] = "delete";
     /**
      * Triggers the Explore action on a visualization
      * @param - an object with vizId as a key
-     * @example liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["Explore"] = "explore";
     /**
      * Triggers the Create alert action on a visualization
      * @param - an object with vizId as a key
-     * @example liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["CreateMonitor"] = "createMonitor";
     /**
      * Triggers the Manage alert action on a visualization
      * @param - an object with vizId as a key
-     * @example liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * @example
+     * ```js
+     * liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["ManageMonitor"] = "manageMonitor";
@@ -844,9 +967,11 @@ var HostEvent;
      * Triggers the Copy link action on a Liveboard or visualization
      * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.CopyLink)
      * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * vizEmbed.trigger((HostEvent.CopyLink)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["CopyLink"] = "embedDocument";
@@ -854,15 +979,20 @@ var HostEvent;
      * Triggers the Present action on a Liveboard or visualization
      * @param - object - to trigger the action for a specfic visualization in Liveboard embed, pass in vizId as a key
      * @example
+     * ```js
      * liveboardEmbed.trigger(HostEvent.Present)
      * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * vizEmbed.trigger((HostEvent.Present)
+     * ```
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     HostEvent["Present"] = "present";
     /**
      * Get TML for the current search.
-     * @example searchEmbed.trigger(HostEvent.GetTML)
+     * @example
+     * ```js
+     * searchEmbed.trigger(HostEvent.GetTML)
+     * ```
      * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
      */
     HostEvent["GetTML"] = "getTML";
@@ -1097,6 +1227,7 @@ var Action;
     Action["ReplaySearch"] = "replaySearch";
     Action["ShowUnderlyingData"] = "showUnderlyingData";
     Action["Download"] = "download";
+    Action["DownloadAsPng"] = "downloadAsPng";
     Action["DownloadAsPdf"] = "downloadAsPdf";
     Action["DownloadAsCsv"] = "downloadAsCSV";
     Action["DownloadAsXlsx"] = "downloadAsXLSX";
@@ -8913,6 +9044,11 @@ const EndPoints = {
     BASIC_LOGIN: '/callosum/v1/session/login',
     LOGOUT: '/callosum/v1/session/logout',
 };
+/**
+ * Enum for auth failure types. This is the parameter passed to the listner
+ * of {@link AuthStatus.FAILURE}.
+ * @group Authentication / Init
+ */
 var AuthFailureType;
 (function (AuthFailureType) {
     AuthFailureType["SDK"] = "SDK";
@@ -8920,6 +9056,10 @@ var AuthFailureType;
     AuthFailureType["EXPIRY"] = "EXPIRY";
     AuthFailureType["OTHER"] = "OTHER";
 })(AuthFailureType || (AuthFailureType = {}));
+/**
+ * Enum for auth status emitted by the emitter returned from {@link init}.
+ * @group Authentication / Init
+ */
 var AuthStatus;
 (function (AuthStatus) {
     /**
@@ -8946,10 +9086,15 @@ var AuthStatus;
      */
     AuthStatus["WAITING_FOR_POPUP"] = "WAITING_FOR_POPUP";
 })(AuthStatus || (AuthStatus = {}));
+/**
+ * Events which can be triggered on the emitter returned from {@link init}.
+ * @group Authentication / Init
+ */
 var AuthEvent;
 (function (AuthEvent) {
     /**
-     * Manually trigger the SSO popup.
+     * Manually trigger the SSO popup. This is useful with
+     * authStatus: SAMLRedirect/OIDCRedicre and inPopup: true
      */
     AuthEvent["TRIGGER_SSO_POPUP"] = "TRIGGER_SSO_POPUP";
 })(AuthEvent || (AuthEvent = {}));
@@ -9009,8 +9154,9 @@ function getReleaseVersion() {
     return releaseVersion;
 }
 /**
- * Return a promise that resolves with the session info when authentication is
+ * Return a promise that resolves with the session information when authentication is
  * successful. And info is available.
+ * @group Global methods
  */
 function getSessionInfo() {
     return sessionInfoPromise;
@@ -9247,6 +9393,13 @@ const CONFIG_DEFAULTS = {
     authType: AuthType.None,
 };
 let authPromise;
+/**
+ * Gets the configuration embed was initialized with.
+ *
+ * @returns {@link EmbedConfig} The configuration embed was initialized with.
+ * @version SDK: 1.19.0 | ThoughtSpot: *
+ * @group Global methods
+ */
 const getEmbedConfig = () => config;
 const getAuthPromise = () => authPromise;
 /**
@@ -9277,6 +9430,7 @@ const hostUrlToFeatureUrl = {
  * @param url The URL provided for prefetch
  * @param prefetchFeatures Specify features which needs to be prefetched.
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 7.2.1
+ * @group Global methods
  */
 const prefetch = (url, prefetchFeatures) => {
     if (url === '') {
@@ -9323,13 +9477,24 @@ function backwardCompat(embedConfig) {
 }
 /**
  * Initializes the Visual Embed SDK globally and perform
- * authentication if applicable.
+ * authentication if applicable. This function needs to be called before any ThoughtSpot
+ * component like liveboard etc can be embedded. But need not wait for AuthEvent.SUCCESS
+ * to actually embed. That is handled internally.
  * @param embedConfig The configuration object containing ThoughtSpot host,
  * authentication mechanism and so on.
- * example: authStatus = init(config);
- * authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
- * @returns event emitter which emits events on authentication success, failure and logout. See {@link AuthStatus}
+ *
+ * @example
+ * ```js
+ *   const authStatus = init({
+ *     thoughtSpotHost: 'https://my.thoughtspot.cloud',
+ *     authType: AuthType.None,
+ *   });
+ *   authStatus.on(AuthStatus.FAILURE, (reason) => { // do something here });
+ * ```
+ *
+ * @returns {@link AuthEventEmitter} event emitter which emits events on authentication success, failure and logout. See {@link AuthStatus}
  * @version SDK: 1.0.0 | ThoughtSpot ts7.april.cl, 7.2.1
+ * @group Authentication / Init
  */
 const init = (embedConfig) => {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
@@ -9371,6 +9536,7 @@ function disableAutoLogin() {
  * @param doNotDisableAutoLogin This flag when passed will not disable autoLogin
  * @returns Promise which resolves when logout completes.
  * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
+ * @group Global methods
  */
 const logout$1 = (doNotDisableAutoLogin = false) => {
     if (!doNotDisableAutoLogin) {
@@ -9560,7 +9726,7 @@ function processTrigger(iFrame, messageType, thoughtSpotHost, data) {
     });
 }
 
-var name="@thoughtspot/visual-embed-sdk";var version="1.20.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":{"import":"./lib/src/react/index.js",require:"./cjs/src/react.index.js",types:"./lib/src/react/index.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/index.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",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","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 --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/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",dompurify:"^2.3.4",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2","use-deep-compare-effect":"^1.8.1"};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","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.13.1","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":"6.7.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":"^8.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.9.4","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,typesVersions:typesVersions,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};
+var name="@thoughtspot/visual-embed-sdk";var version="1.20.2";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":{"import":"./lib/src/react/index.js",require:"./cjs/src/react.index.js",types:"./lib/src/react/index.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/index.d.ts"]}};var scripts={lint:"eslint 'src/**'","lint:fix":"eslint 'src/**/*.*' --fix",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","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 --runInBand","test-docs":"jest -c jest.config.docs.js",test:"npm run test-sdk && npm run test-docs",posttest:"cat ./coverage/sdk/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",dompurify:"^2.3.4",eventemitter3:"^4.0.7","gatsby-plugin-vercel":"^1.0.3","html-react-parser":"^1.4.12",lodash:"^4.17.21","mixpanel-browser":"^2.45.0","ts-deepmerge":"^6.0.2","use-deep-compare-effect":"^1.8.1"};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","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.13.1","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":"6.7.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":"^8.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-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","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,typesVersions:typesVersions,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) 2022
@@ -10039,6 +10205,20 @@ class TsEmbed {
      * @param messageType The message type
      * @param callback A callback as a function
      * @param options The message options
+     * @example
+     * ```js
+     * tsEmbed.on(EmbedEvent.Error, (data) => {
+     *   console.error(data);
+     * });
+     * ```
+     * @example
+     * ```js
+     * tsEmbed.on(EmbedEvent.Save, (data) => {
+     *   console.log("Answer save clicked", data);
+     * }, {
+     *   start: true // This will trigger the callback on start of save
+     * });
+     * ```
      */
     on(messageType, callback, options = { start: false }) {
         if (this.isRendered) {
@@ -10133,6 +10313,8 @@ class TsEmbed {
  * Base class for embedding v1 experience
  * Note: The v1 version of ThoughtSpot Blink works on the AngularJS stack
  * which is currently under migration to v2
+ *
+ * @inheritdoc
  */
 class V1Embed extends TsEmbed {
     constructor(domSelector, viewConfig) {
@@ -10140,13 +10322,30 @@ class V1Embed extends TsEmbed {
         this.viewConfig = viewConfig;
     }
     /**
-     * Render the app in an iframe and set up event handlers
+     * Render the ap    p in an iframe and set up event handlers
      * @param iframeSrc
      */
     renderV1Embed(iframeSrc) {
         return this.renderIFrame(iframeSrc, this.viewConfig.frameParams);
     }
-    // @override
+    /**
+     * @inheritdoc TsEmbed.on
+     *
+     * @example
+     * ```js
+     * tsEmbed.on(EmbedEvent.Error, (data) => {
+     *   console.error(data);
+     * });
+     * ```
+     * @example
+     * ```js
+     * tsEmbed.on(EmbedEvent.Save, (data) => {
+     *   console.log("Answer save clicked", data);
+     * }, {
+     *   start: true // This will trigger the callback on start of save
+     * });
+     * ```
+     */
     on(messageType, callback, options = { start: false }) {
         const eventType = this.getCompatibleEventType(messageType);
         uploadMixpanelEvent(`${MIXPANEL_EVENT.VISUAL_SDK_ON}-${messageType}`);
@@ -10201,7 +10400,7 @@ var Page;
 })(Page || (Page = {}));
 /**
  * Embeds full ThoughtSpot experience in a host application.
- * @Category App Embed
+ * @group Embed components
  */
 class AppEmbed extends V1Embed {
     // eslint-disable-next-line no-useless-constructor
@@ -10334,8 +10533,18 @@ class AppEmbed extends V1Embed {
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
 /**
- * Embed a ThoughtSpot Liveboard or visualization
- * @Category Liveboards and Charts
+ * Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
+ * waits for the authentication to complete, so no need to wait for AuthStatus.SUCCESS.
+ * @example
+ * ```js
+ * import { .. } from '@thoughtspot/visual-embed-sdk';
+ * init({ ... });
+ * const embed = new LiveboardEmbed("#container", {
+ *   liveboardId: <your-id-here>,
+ * // .. other params here.
+ * })
+ * ```
+ * @group Embed components
  */
 class LiveboardEmbed extends V1Embed {
     // eslint-disable-next-line no-useless-constructor
@@ -10478,7 +10687,7 @@ const HiddenActionItemByDefaultForSearchEmbed = [
 /**
  * Embed ThoughtSpot search
  *
- * @Category Search Embed
+ * @group Embed components
  */
 class SearchEmbed extends TsEmbed {
     constructor(domSelector, viewConfig) {
@@ -10570,8 +10779,8 @@ class SearchEmbed extends TsEmbed {
 /**
  * Embed ThoughtSpot search bar
  *
- * @Category Search Embed
  * @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
+ * @group Embed components
  */
 class SearchBarEmbed extends TsEmbed {
     constructor(domSelector, viewConfig) {