@thoughtspot/visual-embed-sdk 1.20.0 → 1.20.2

package/dist/tsembed.js

@@ -208,7 +208,47 @@
         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 +260,7 @@
         /**
          * 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 +273,18 @@
          * 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";
         /**
@@ -470,6 +523,12 @@
          * @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
@@ -635,11 +694,13 @@
          * @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";
         /**
@@ -648,10 +709,14 @@
          *              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";
@@ -690,7 +755,10 @@
          * 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";
@@ -698,27 +766,39 @@
          * 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";
@@ -727,87 +807,124 @@
          * @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";
@@ -825,9 +942,11 @@
          * 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";
@@ -835,15 +954,20 @@
          * 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";
@@ -1066,6 +1190,7 @@
         Action["ReplaySearch"] = "replaySearch";
         Action["ShowUnderlyingData"] = "showUnderlyingData";
         Action["Download"] = "download";
+        Action["DownloadAsPng"] = "downloadAsPng";
         Action["DownloadAsPdf"] = "downloadAsPdf";
         Action["DownloadAsCsv"] = "downloadAsCSV";
         Action["DownloadAsXlsx"] = "downloadAsXLSX";
@@ -8914,7 +9039,8 @@
     })(exports.AuthStatus || (exports.AuthStatus = {}));
     (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";
     })(exports.AuthEvent || (exports.AuthEvent = {}));
@@ -8974,8 +9100,9 @@
         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;
@@ -9212,6 +9339,13 @@
         authType: exports.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;
     /**
@@ -9242,6 +9376,7 @@
      * @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 === '') {
@@ -9288,13 +9423,24 @@
     }
     /**
      * 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;
@@ -9336,6 +9482,7 @@
      * @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) {
@@ -9525,7 +9672,7 @@
         });
     }
 
-    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$1={".":"./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$1,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$1={".":"./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$1,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
@@ -10004,6 +10151,20 @@
          * @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) {
@@ -10098,6 +10259,8 @@
      * 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) {
@@ -10105,13 +10268,30 @@
             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}`);
@@ -10161,7 +10341,7 @@
     })(exports.Page || (exports.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
@@ -10294,8 +10474,18 @@
      * @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
@@ -10438,7 +10628,7 @@
     /**
      * Embed ThoughtSpot search
      *
-     * @Category Search Embed
+     * @group Embed components
      */
     class SearchEmbed extends TsEmbed {
         constructor(domSelector, viewConfig) {
@@ -10530,8 +10720,8 @@
     /**
      * 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) {

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.20.0",
+    "version": "1.20.2",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -135,8 +135,7 @@
         "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",
+        "typedoc-plugin-toc-group": "thoughtspot/typedoc-plugin-toc-group",
         "typescript": "^4.9.4",
         "url-search-params-polyfill": "^8.1.0",
         "util": "^0.12.4"

package/lib/src/auth.d.ts

@@ -12,12 +12,21 @@ export declare const EndPoints: {
     BASIC_LOGIN: string;
     LOGOUT: string;
 };
+/**
+ * Enum for auth failure types. This is the parameter passed to the listner
+ * of {@link AuthStatus.FAILURE}.
+ * @group Authentication / Init
+ */
 export declare enum AuthFailureType {
     SDK = "SDK",
     NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
     EXPIRY = "EXPIRY",
     OTHER = "OTHER"
 }
+/**
+ * Enum for auth status emitted by the emitter returned from {@link init}.
+ * @group Authentication / Init
+ */
 export declare enum AuthStatus {
     /**
      * Emits when the SDK fails to authenticate
@@ -43,14 +52,38 @@ export declare enum AuthStatus {
      */
     WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
 }
+/**
+ * Event emitter returned from {@link init}.
+ * @group Authentication / Init
+ */
+export interface AuthEventEmitter {
+    /**
+     * Registed a listener on Auth failure.
+     * @param event
+     * @param listener
+     */
+    on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
+    on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+    on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
+    /**
+     * Trigger an event on the emitter returned from init.
+     * @param {@link AuthEvent}
+     */
+    emit(event: AuthEvent): void;
+}
+/**
+ * Events which can be triggered on the emitter returned from {@link init}.
+ * @group Authentication / Init
+ */
 export declare enum AuthEvent {
     /**
-     * Manually trigger the SSO popup.
+     * Manually trigger the SSO popup. This is useful with
+     * authStatus: SAMLRedirect/OIDCRedicre and inPopup: true
      */
     TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
 }
-export declare function getAuthEE(): EventEmitter;
-export declare function setAuthEE(eventEmitter: EventEmitter): void;
+export declare function getAuthEE(): EventEmitter<AuthStatus | AuthEvent>;
+export declare function setAuthEE(eventEmitter: EventEmitter<AuthStatus | AuthEvent>): void;
 export declare function notifyAuthSDKSuccess(): void;
 export declare function notifyAuthSuccess(): void;
 export declare function notifyAuthFailure(failureType: AuthFailureType): void;
@@ -60,8 +93,9 @@ export declare function notifyLogout(): void;
  */
 export declare function getReleaseVersion(): string;
 /**
- * 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
  */
 export declare function getSessionInfo(): Promise<any>;
 export declare function initSession(sessionDetails: any): void;