@thoughtspot/visual-embed-sdk 1.20.1 → 1.20.3

package/README.md

@@ -41,7 +41,7 @@ import { LiveboardEmbed } from '@thoughtspot/visual-embed-sdk';
 
 // NPM <script>
 <script src="https://cdn.jsdelivr.net/npm/@thoughtspot/visual-embed-sdk/dist/tsembed.js"></script>;
-// Make the SDK available on global namespace window.tsembed
+// Makes the SDK available on global namespace window.tsembed
 
 // ES6 from web
 import {

package/cjs/package.json

@@ -0,0 +1,171 @@
+{
+    "name": "@thoughtspot/visual-embed-sdk",
+    "version": "1.20.3",
+    "description": "ThoughtSpot Embed SDK",
+    "module": "lib/src/index.js",
+    "main": "dist/tsembed.js",
+    "types": "lib/src/index.d.ts",
+    "files": [
+        "dist/**",
+        "lib/**",
+        "src/**",
+        "cjs/**"
+    ],
+    "exports": {
+        ".": {
+            "import": "./lib/src/index.js",
+            "require": "./dist/tsembed.js",
+            "types": "./lib/src/index.d.ts"
+        },
+        "./react": {
+            "import": "./lib/src/react/index.js",
+            "require": "./cjs/src/react/index.js",
+            "types": "./lib/src/react/index.d.ts"
+        }
+    },
+    "typesVersions": {
+        "*": {
+            "react": [
+                "./lib/src/react/index.d.ts"
+            ]
+        }
+    },
+    "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 ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true",
+        "bundle-dts-react": "dts-bundle --name ../../../dist/visual-embed-sdk-react --main lib/src/react/index.d.ts --outputAsModuleFolder=true",
+        "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 bundle-dts-react; npm run build",
+        "publish-dev": "npm publish --tag dev",
+        "publish-prod": "npm publish --tag latest"
+    },
+    "peerDependencies": {
+        "react": "> 16.8.0",
+        "react-dom": "> 16.8.0"
+    },
+    "dependencies": {
+        "algoliasearch": "^4.10.5",
+        "classnames": "^2.3.1",
+        "dompurify": "^2.3.4",
+        "eslint-plugin-comment-length": "^0.9.2",
+        "eslint-plugin-jsdoc": "^40.1.0",
+        "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"
+    },
+    "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"
+    },
+    "author": "ThoughtSpot",
+    "email": "support@thoughtspot.com",
+    "license": "ThoughtSpot Development Tools End User License Agreement",
+    "directories": {
+        "lib": "lib"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/thoughtspot/visual-embed-sdk.git"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org"
+    },
+    "keywords": [
+        "thoughtspot",
+        "everywhere",
+        "embed",
+        "sdk",
+        "analytics"
+    ],
+    "bugs": {
+        "url": "https://github.com/thoughtspot/visual-embed-sdk/issues"
+    },
+    "homepage": "https://github.com/thoughtspot/visual-embed-sdk#readme",
+    "globals": {
+        "window": {}
+    }
+}

package/cjs/src/auth.d.ts

@@ -0,0 +1,183 @@
+import EventEmitter from 'eventemitter3';
+import { EmbedConfig } from './types';
+export declare let loggedInStatus: boolean;
+export declare let samlAuthWindow: Window;
+export declare let samlCompletionPromise: Promise<void>;
+export declare const SSO_REDIRECTION_MARKER_GUID = "5e16222e-ef02-43e9-9fbd-24226bf3ce5b";
+export declare const EndPoints: {
+    AUTH_VERIFICATION: string;
+    SAML_LOGIN_TEMPLATE: (targetUrl: string) => string;
+    OIDC_LOGIN_TEMPLATE: (targetUrl: string) => string;
+    TOKEN_LOGIN: string;
+    BASIC_LOGIN: string;
+    LOGOUT: string;
+};
+interface sessionInfoInterface {
+    userGUID: any;
+    isPublicUser: any;
+    mixpanelToken: any;
+    [key: string]: any;
+}
+/**
+ * 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
+     */
+    FAILURE = "FAILURE",
+    /**
+     * Emits when the SDK authenticates successfully
+     */
+    SDK_SUCCESS = "SDK_SUCCESS",
+    /**
+     * Emits when the app sends an authentication success message
+     */
+    SUCCESS = "SUCCESS",
+    /**
+     * Emits when a user logs out
+     */
+    LOGOUT = "LOGOUT",
+    /**
+     * Emitted when inPopup: true in the SAMLRedirect flow.
+     * And, we are waiting for popup to be triggered either programatically
+     * or by the trigger button.
+     *
+     * @version SDK: 1.19.0
+     */
+    WAITING_FOR_POPUP = "WAITING_FOR_POPUP"
+}
+/**
+ * Event emitter returned from {@link init}.
+ *
+ * @group Authentication / Init
+ */
+export interface AuthEventEmitter {
+    /**
+     * Register a listener on Auth failure.
+     *
+     * @param event
+     * @param listener
+     */
+    on(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
+    /**
+     * Register a listener on Auth SDK success.
+     *
+     * @param event
+     * @param listener
+     */
+    on(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+    on(event: AuthStatus.SUCCESS, listener: (sessionInfo: any) => void): this;
+    once(event: AuthStatus.FAILURE, listener: (failureType: AuthFailureType) => void): this;
+    once(event: AuthStatus.SDK_SUCCESS | AuthStatus.LOGOUT | AuthStatus.WAITING_FOR_POPUP, listener: () => void): this;
+    once(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. This is useful with
+     * authStatus: SAMLRedirect/OIDCRedicre and inPopup: true
+     */
+    TRIGGER_SSO_POPUP = "TRIGGER_SSO_POPUP"
+}
+/**
+ *
+ */
+export declare function getAuthEE(): EventEmitter<AuthStatus | AuthEvent>;
+/**
+ *
+ * @param eventEmitter
+ */
+export declare function setAuthEE(eventEmitter: EventEmitter<AuthStatus | AuthEvent>): void;
+/**
+ *
+ */
+export declare function notifyAuthSDKSuccess(): void;
+/**
+ *
+ */
+export declare function notifyAuthSuccess(): void;
+/**
+ *
+ * @param failureType
+ */
+export declare function notifyAuthFailure(failureType: AuthFailureType): void;
+/**
+ *
+ */
+export declare function notifyLogout(): void;
+export declare const initSession: (sessionDetails: sessionInfoInterface) => void;
+export declare const getSessionDetails: (sessionInfoResp: any) => sessionInfoInterface;
+/**
+ * Return releaseVersion if available
+ */
+export declare function getReleaseVersion(): string;
+/**
+ * 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<sessionInfoInterface>;
+export declare const getAuthenticaionToken: (embedConfig: EmbedConfig) => Promise<any>;
+/**
+ * Perform token based authentication
+ *
+ * @param embedConfig The embed configuration
+ */
+export declare const doTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
+/**
+ * Validate embedConfig parameters required for cookielessTokenAuth
+ *
+ * @param embedConfig The embed configuration
+ */
+export declare const doCookielessTokenAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
+/**
+ * Perform basic authentication to the ThoughtSpot cluster using the cluster
+ * credentials.
+ *
+ * Warning: This feature is primarily intended for developer testing. It is
+ * strongly advised not to use this authentication method in production.
+ *
+ * @param embedConfig The embed configuration
+ */
+export declare const doBasicAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
+export declare const doSamlAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
+export declare const doOIDCAuth: (embedConfig: EmbedConfig) => Promise<boolean>;
+export declare const logout: (embedConfig: EmbedConfig) => Promise<boolean>;
+/**
+ * Perform authentication on the ThoughtSpot cluster
+ *
+ * @param embedConfig The embed configuration
+ */
+export declare const authenticate: (embedConfig: EmbedConfig) => Promise<boolean>;
+/**
+ * Check if we are authenticated to the ThoughtSpot cluster
+ */
+export declare const isAuthenticated: () => boolean;
+export {};
+//# sourceMappingURL=auth.d.ts.map

package/cjs/src/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/auth.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,eAAe,CAAC;AAGzC,OAAO,EACoB,WAAW,EACrC,MAAM,SAAS,CAAC;AAajB,eAAO,IAAI,cAAc,SAAQ,CAAC;AAElC,eAAO,IAAI,cAAc,EAAE,MAAa,CAAC;AAEzC,eAAO,IAAI,qBAAqB,EAAE,OAAO,CAAC,IAAI,CAAQ,CAAC;AAQvD,eAAO,MAAM,2BAA2B,yCAAyC,CAAC;AAElF,eAAO,MAAM,SAAS;;qCAEe,MAAM;qCACN,MAAM;;;;CAI1C,CAAC;AAEF,UAAU,oBAAoB;IAC1B,QAAQ,EAAE,GAAG,CAAC;IACd,YAAY,EAAE,GAAG,CAAC;IAClB,aAAa,EAAE,GAAG,CAAC;IACnB,CAAC,GAAG,EAAC,MAAM,GAAE,GAAG,CAAC;CACpB;AAED;;;;;GAKG;AACH,oBAAY,eAAe;IACvB,GAAG,QAAQ;IACX,gBAAgB,qBAAqB;IACrC,MAAM,WAAW;IACjB,KAAK,UAAU;CAClB;AAED;;;;GAIG;AACH,oBAAY,UAAU;IAClB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,MAAM,WAAW;IACjB;;;;;;OAMG;IACH,iBAAiB,sBAAsB;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC7B;;;;;OAKG;IACH,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACtF;;;;;OAKG;IACH,EAAE,CACE,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAChF,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC1E,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI,CAAC;IACxF,IAAI,CACA,KAAK,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,iBAAiB,EAChF,QAAQ,EAAE,MAAM,IAAI,GACrB,IAAI,CAAC;IACR,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,CAAC;IAC5E;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;CAChC;AAED;;;;GAIG;AACH,oBAAY,SAAS;IACjB;;;OAGG;IACH,iBAAiB,sBAAsB;CAC1C;AAID;;GAEG;AACH,wBAAgB,SAAS,IAAI,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,CAEhE;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,UAAU,GAAG,SAAS,CAAC,GAAG,IAAI,CAElF;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAM3C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,IAAI,CAMxC;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,WAAW,EAAE,eAAe,GAAG,IAAI,CAMpE;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,IAAI,CAMnC;AAED,eAAO,MAAM,WAAW,mBAAoB,oBAAoB,SAM/D,CAAC;AAEF,eAAO,MAAM,iBAAiB,oBAAqB,GAAG,KAAE,oBAYvD,CAAC;AAuBF;;GAEG;AACH,wBAAgB,iBAAiB,WAEhC;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAE9D;AAqCD,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,GAAG,CAWjF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAyB3E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAMrF,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,WAAW,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAa3E,CAAC;AAiFF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,UAAU,gBAAuB,WAAW,qBAiBxD,CAAC;AAEF,eAAO,MAAM,MAAM,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAKtE,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,gBAAuB,WAAW,KAAG,QAAQ,OAAO,CAoB5E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,QAAO,OAAyB,CAAC"}