@thoughtspot/visual-embed-sdk 1.39.0 → 1.39.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/embed/app.d.ts +13 -13
- package/cjs/src/embed/conversation.d.ts +4 -4
- package/cjs/src/embed/embedConfig.d.ts +47 -4
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +47 -4
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +2 -2
- package/cjs/src/embed/liveboard.js +1 -1
- package/cjs/src/embed/sage.d.ts +10 -10
- package/cjs/src/embed/search.d.ts +4 -4
- package/cjs/src/embed/ts-embed.d.ts +5 -0
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +16 -1
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +164 -0
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/types.d.ts +7 -6
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +6 -5
- package/cjs/src/types.js.map +1 -1
- package/dist/{index-sSREbWM-.js → index-CmEQfuE3.js} +1 -1
- package/dist/src/embed/app.d.ts +13 -13
- package/dist/src/embed/conversation.d.ts +4 -4
- package/dist/src/embed/embedConfig.d.ts +47 -4
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +2 -2
- package/dist/src/embed/sage.d.ts +10 -10
- package/dist/src/embed/search.d.ts +4 -4
- package/dist/src/embed/ts-embed.d.ts +5 -0
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/types.d.ts +7 -6
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +73 -14
- package/dist/tsembed-react.js +72 -13
- package/dist/tsembed.es.js +73 -14
- package/dist/tsembed.js +72 -13
- package/dist/visual-embed-sdk-react-full.d.ts +87 -43
- package/dist/visual-embed-sdk-react.d.ts +87 -43
- package/dist/visual-embed-sdk.d.ts +87 -43
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +13 -13
- package/lib/src/embed/conversation.d.ts +4 -4
- package/lib/src/embed/embedConfig.d.ts +47 -4
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +47 -4
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +2 -2
- package/lib/src/embed/liveboard.js +1 -1
- package/lib/src/embed/sage.d.ts +10 -10
- package/lib/src/embed/search.d.ts +4 -4
- package/lib/src/embed/ts-embed.d.ts +5 -0
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +16 -1
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +164 -0
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/types.d.ts +7 -6
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +6 -5
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +87 -43
- package/package.json +1 -1
- package/src/embed/app.ts +13 -13
- package/src/embed/conversation.ts +4 -4
- package/src/embed/embedConfig.ts +48 -5
- package/src/embed/liveboard.ts +2 -2
- package/src/embed/sage.ts +10 -10
- package/src/embed/search.ts +4 -4
- package/src/embed/ts-embed.spec.ts +225 -0
- package/src/embed/ts-embed.ts +19 -0
- package/src/types.ts +7 -6
package/dist/tsembed.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/* @thoughtspot/visual-embed-sdk version 1.39.
|
|
1
|
+
/* @thoughtspot/visual-embed-sdk version 1.39.2 */
|
|
2
2
|
'use client';
|
|
3
3
|
(function (global, factory) {
|
|
4
4
|
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
|
|
@@ -1728,7 +1728,7 @@
|
|
|
1728
1728
|
*
|
|
1729
1729
|
* error: Developers can customize the error message text when `execute`
|
|
1730
1730
|
* returns `false` using the error parameter in responder.
|
|
1731
|
-
* @version SDK : 1.29.0 | ThoughtSpot
|
|
1731
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1732
1732
|
* @example
|
|
1733
1733
|
*```js
|
|
1734
1734
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -1775,7 +1775,7 @@
|
|
|
1775
1775
|
* console.log('payload', payload);
|
|
1776
1776
|
* })
|
|
1777
1777
|
*```
|
|
1778
|
-
* @version SDK : 1.29.0 | ThoughtSpot
|
|
1778
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
1779
1779
|
*/
|
|
1780
1780
|
EmbedEvent["ParameterChanged"] = "parameterChanged";
|
|
1781
1781
|
/**
|
|
@@ -1831,18 +1831,18 @@
|
|
|
1831
1831
|
* console.log('payload', payload);
|
|
1832
1832
|
* })
|
|
1833
1833
|
*```
|
|
1834
|
-
* @version SDK : 1.37.0 | ThoughtSpot
|
|
1834
|
+
* @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1835
1835
|
*/
|
|
1836
1836
|
EmbedEvent["CreateLiveboard"] = "createLiveboard";
|
|
1837
1837
|
/**
|
|
1838
1838
|
* Emitted when a user creates a Model.
|
|
1839
|
-
* @version SDK : 1.37.0 | ThoughtSpot
|
|
1839
|
+
* @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
1840
1840
|
*/
|
|
1841
1841
|
EmbedEvent["CreateModel"] = "createModel";
|
|
1842
1842
|
/**
|
|
1843
1843
|
* @hidden
|
|
1844
1844
|
* Emitted when a user exits present mode.
|
|
1845
|
-
* @version SDK : 1.40.0 | ThoughtSpot
|
|
1845
|
+
* @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
1846
1846
|
*/
|
|
1847
1847
|
EmbedEvent["ExitPresentMode"] = "exitPresentMode";
|
|
1848
1848
|
})(exports.EmbedEvent || (exports.EmbedEvent = {}));
|
|
@@ -3098,6 +3098,7 @@
|
|
|
3098
3098
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
3099
3099
|
* })
|
|
3100
3100
|
* ```
|
|
3101
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
|
|
3101
3102
|
*/
|
|
3102
3103
|
// eslint-disable-next-line no-shadow
|
|
3103
3104
|
exports.Action = void 0;
|
|
@@ -6960,9 +6961,52 @@
|
|
|
6960
6961
|
|
|
6961
6962
|
const configKey = 'embedConfig';
|
|
6962
6963
|
/**
|
|
6963
|
-
* Gets the configuration
|
|
6964
|
-
*
|
|
6965
|
-
* @
|
|
6964
|
+
* Gets the embed configuration settings that were used to
|
|
6965
|
+
* initialize the SDK.
|
|
6966
|
+
* @returns {@link EmbedConfig}
|
|
6967
|
+
*
|
|
6968
|
+
* @example
|
|
6969
|
+
* ```js
|
|
6970
|
+
* const config = getInitConfig();
|
|
6971
|
+
* console.log(config);
|
|
6972
|
+
* ```
|
|
6973
|
+
* @example
|
|
6974
|
+
*
|
|
6975
|
+
* Returns the `EmbedConfig` object, which
|
|
6976
|
+
* contains the configuration settings used to
|
|
6977
|
+
* initialize the SDK, including the following:
|
|
6978
|
+
*
|
|
6979
|
+
* - `thoughtSpotHost` - ThoughtSpot host URL
|
|
6980
|
+
* - `authType`: The authentication method used. For example,
|
|
6981
|
+
* `AuthServerCookieless` for `AuthType.TrustedAuthTokenCookieless`
|
|
6982
|
+
* - `customizations` - Style, text, and icon customization settings
|
|
6983
|
+
* that were applied during the SDK initialization.
|
|
6984
|
+
*
|
|
6985
|
+
* For a comprehensive list of embed configuration settings,
|
|
6986
|
+
* see link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[Developer Documentation].
|
|
6987
|
+
*
|
|
6988
|
+
* ```json
|
|
6989
|
+
* {
|
|
6990
|
+
* "thoughtSpotHost": "https://{ThoughtSpot-Host}",
|
|
6991
|
+
* "authType": "AuthServerCookieless",
|
|
6992
|
+
* "customizations": {
|
|
6993
|
+
* "style": {
|
|
6994
|
+
* "customCSS": {
|
|
6995
|
+
* "variables": {
|
|
6996
|
+
* "--ts-var-button--secondary-background": "#7492d5",
|
|
6997
|
+
* "--ts-var-button--secondary--hovers-background": "#aac2f8",
|
|
6998
|
+
* "--ts-var-root-background": "#f1f4f8"
|
|
6999
|
+
* }
|
|
7000
|
+
* }
|
|
7001
|
+
* }
|
|
7002
|
+
* },
|
|
7003
|
+
* "loginFailedMessage": "Login failed, please try again",
|
|
7004
|
+
* "authTriggerText": "Authorize",
|
|
7005
|
+
* "disableTokenVerification": true,
|
|
7006
|
+
* "authTriggerContainer": "#your-own-div"
|
|
7007
|
+
* }
|
|
7008
|
+
* ```
|
|
7009
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.cl, and later
|
|
6966
7010
|
* @group Global methods
|
|
6967
7011
|
*/
|
|
6968
7012
|
const getEmbedConfig = () => getValueFromWindow(configKey) || {};
|
|
@@ -6970,7 +7014,7 @@
|
|
|
6970
7014
|
* Sets the configuration embed was initialized with.
|
|
6971
7015
|
* And returns the new configuration.
|
|
6972
7016
|
* @param newConfig The configuration to set.
|
|
6973
|
-
* @version SDK: 1.27.0 | ThoughtSpot:
|
|
7017
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.1.sw, and later
|
|
6974
7018
|
* @group Global methods
|
|
6975
7019
|
*/
|
|
6976
7020
|
const setEmbedConfig = (newConfig) => {
|
|
@@ -15504,7 +15548,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
15504
15548
|
return e;
|
|
15505
15549
|
}
|
|
15506
15550
|
|
|
15507
|
-
var name="@thoughtspot/visual-embed-sdk";var version$1="1.39.
|
|
15551
|
+
var name="@thoughtspot/visual-embed-sdk";var version$1="1.39.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/**","cjs/**"];var exports$1={".":{"import":"./lib/src/index.js",require:"./cjs/src/index.js",types:"./lib/src/index.d.ts"},"./react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"},"./lib/src/react":{"import":"./lib/src/react/all-types-export.js",require:"./cjs/src/react/all-types-export.js",types:"./lib/src/react/all-types-export.d.ts"}};var typesVersions={"*":{react:["./lib/src/react/all-types-export.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","build-and-publish":"npm run build:gatsby && npm run publish","bundle-dts-file":"dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts","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","bundle-dts-react-full":"dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",build:"rollup -c",watch:"rollup -cw",docgen:"typedoc --tsconfig tsconfig.json --theme typedoc-theme --json static/typedoc/typedoc.json --disableOutputCheck","test-sdk":"jest -c jest.config.sdk.js --runInBand",test:"npm run test-sdk",posttest:"cat ./coverage/sdk/lcov.info | coveralls","is-publish-allowed":"node scripts/is-publish-allowed.js",prepublishOnly:"npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build","check-size":"npm run build && size-limit","publish-dev":"npm publish --tag dev","publish-prod":"npm publish --tag latest",dev:"vite -c vite.local.config.ts"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={classnames:"^2.3.1",eventemitter3:"^4.0.7",lodash:"^4.17.21","mixpanel-browser":"2.47.0","ts-deepmerge":"^6.0.2",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1",yaml:"^2.5.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","@rollup/plugin-replace":"^5.0.2","@size-limit/preset-big-lib":"^8.2.6","@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/lodash":"^4.17.0","@types/mixpanel-browser":"^2.35.6","@types/react-test-renderer":"^17.0.1","@typescript-eslint/eslint-plugin":"^8.28.0","@typescript-eslint/parser":"^8.28.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",crypto:"^1.0.1","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^9.23.0","eslint-config-airbnb-base":"^15.0.0","eslint-config-prettier":"^10.1.1","eslint-import-resolver-typescript":"^4.2.5","eslint-plugin-comment-length":"2.2.1","eslint-plugin-import":"^2.31.0","eslint-plugin-jsdoc":"^50.6.9","eslint-plugin-prettier":"^5.2.5","eslint-plugin-react":"^7.37.5","eslint-plugin-react-hooks":"^5.2.0","fs-extra":"^10.0.0","gh-pages":"6.3.0",globals:"^16.0.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-fetch-mock":"^3.0.3",jsdom:"^17.0.0",prettier:"2.1.2",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:"4.24.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","typescript-eslint":"^8.29.1","url-search-params-polyfill":"^8.1.0",util:"^0.12.4",vite:"^6.3.5"};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","embedded","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$1,description:description,module:module,main:main,types:types,files:files,exports:exports$1,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.es.js",limit:"31 kB"}],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};
|
|
15508
15552
|
|
|
15509
15553
|
/**
|
|
15510
15554
|
* Reloads the ThoughtSpot iframe.
|
|
@@ -15902,10 +15946,25 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
15902
15946
|
// - cached auth info would be for wrong org
|
|
15903
15947
|
// - info call response changes for each different overrideOrgId
|
|
15904
15948
|
// 2. disablePreauthCache is explicitly set to true
|
|
15949
|
+
// 3. FullAppEmbed has primary navbar visible since:
|
|
15950
|
+
// - primary navbar requires fresh auth state for navigation
|
|
15951
|
+
// - cached auth may not reflect current user permissions
|
|
15905
15952
|
const isDisabled = (this.viewConfig.overrideOrgId !== undefined
|
|
15906
|
-
|| this.embedConfig.disablePreauthCache === true
|
|
15953
|
+
|| this.embedConfig.disablePreauthCache === true
|
|
15954
|
+
|| this.isFullAppEmbedWithVisiblePrimaryNavbar());
|
|
15907
15955
|
return !isDisabled;
|
|
15908
15956
|
}
|
|
15957
|
+
/**
|
|
15958
|
+
* Checks if current embed is FullAppEmbed with visible primary navbar
|
|
15959
|
+
* @returns boolean
|
|
15960
|
+
*/
|
|
15961
|
+
isFullAppEmbedWithVisiblePrimaryNavbar() {
|
|
15962
|
+
const appViewConfig = this.viewConfig;
|
|
15963
|
+
// Check if this is a FullAppEmbed (AppEmbed)
|
|
15964
|
+
// showPrimaryNavbar defaults to true if not explicitly set to false
|
|
15965
|
+
return (appViewConfig.embedComponentType === 'AppEmbed'
|
|
15966
|
+
&& appViewConfig.showPrimaryNavbar === true);
|
|
15967
|
+
}
|
|
15909
15968
|
/**
|
|
15910
15969
|
* fix for ts7.sep.cl
|
|
15911
15970
|
* will be removed for ts7.oct.cl
|
|
@@ -17565,7 +17624,7 @@ query GetEurekaVizSnapshots(
|
|
|
17565
17624
|
}
|
|
17566
17625
|
/**
|
|
17567
17626
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
17568
|
-
* this Liveboard inside the full
|
|
17627
|
+
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
17569
17628
|
* @returns url string
|
|
17570
17629
|
*/
|
|
17571
17630
|
getLiveboardUrl() {
|
|
@@ -662,39 +662,39 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
662
662
|
showObjectResults?: boolean;
|
|
663
663
|
/**
|
|
664
664
|
* flag used by the TS product tour page to show the blue search bar
|
|
665
|
-
* even after the search is completed. This is different from
|
|
665
|
+
* even after the search is completed. This is different from ThoughtSpot Embedded
|
|
666
666
|
* Sage Embed experience where it mimics closer to the non-embed case.
|
|
667
667
|
* The Sample questions container is collapsed when this value is set after
|
|
668
668
|
* does a search.
|
|
669
|
-
* @version SDK: 1.26.0 |
|
|
669
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl
|
|
670
670
|
* @hidden
|
|
671
671
|
*/
|
|
672
672
|
isProductTour?: boolean;
|
|
673
673
|
/**
|
|
674
674
|
* Show or hide the search bar title.
|
|
675
|
-
* @version SDK: 1.29.0 |
|
|
676
|
-
* @deprecated
|
|
675
|
+
* @version SDK: 1.29.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
676
|
+
* @deprecated ThoughtSpot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
677
677
|
*/
|
|
678
678
|
hideSearchBarTitle?: boolean;
|
|
679
679
|
/**
|
|
680
680
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
681
681
|
* at the top of the Answer page.
|
|
682
|
-
* @version SDK: 1.26.0 |
|
|
682
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.10.0.cl
|
|
683
683
|
*/
|
|
684
684
|
hideSageAnswerHeader?: boolean;
|
|
685
685
|
/**
|
|
686
686
|
* Disable the worksheet selection option.
|
|
687
|
-
* @version SDK: 1.26.0 |
|
|
687
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
688
688
|
*/
|
|
689
689
|
disableWorksheetChange?: boolean;
|
|
690
690
|
/**
|
|
691
691
|
* Hide the worksheet selection panel.
|
|
692
|
-
* @version SDK: 1.26.0 |
|
|
692
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
693
693
|
*/
|
|
694
694
|
hideWorksheetSelector?: boolean;
|
|
695
695
|
/**
|
|
696
696
|
* Show or hide autocomplete suggestions for the search query string.
|
|
697
|
-
* @version SDK: 1.26.0 |
|
|
697
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
698
698
|
*/
|
|
699
699
|
hideAutocompleteSuggestions?: boolean;
|
|
700
700
|
/**
|
|
@@ -710,7 +710,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
710
710
|
* selected for the search operation.
|
|
711
711
|
*
|
|
712
712
|
* Supported embed types: `SageEmbed`
|
|
713
|
-
* @version SDK: 1.26.0 |
|
|
713
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
714
714
|
* @example
|
|
715
715
|
* ```js
|
|
716
716
|
* const embed = new SageEmbed('#tsEmbed', {
|
|
@@ -743,7 +743,7 @@ export interface SageViewConfig extends SearchLiveboardCommonViewConfig, Omit<Ba
|
|
|
743
743
|
* executeSearch: true,
|
|
744
744
|
* }
|
|
745
745
|
* ```
|
|
746
|
-
* @version SDK: 1.26.0 |
|
|
746
|
+
* @version SDK: 1.26.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
747
747
|
*/
|
|
748
748
|
searchOptions?: SearchOptions;
|
|
749
749
|
}
|
|
@@ -1029,7 +1029,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1029
1029
|
/**
|
|
1030
1030
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1031
1031
|
* @default false
|
|
1032
|
-
* @version SDK: 1.32.0 |
|
|
1032
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1033
1033
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
1034
1034
|
*/
|
|
1035
1035
|
collapseSearchBarInitially?: boolean;
|
|
@@ -1037,7 +1037,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1037
1037
|
* Flag to enable onBeforeSearchExecute Embed Event
|
|
1038
1038
|
*
|
|
1039
1039
|
* Supported embed types: `SearchEmbed`
|
|
1040
|
-
* @version: SDK: 1.29.0 |
|
|
1040
|
+
* @version: SDK: 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1041
1041
|
*/
|
|
1042
1042
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1043
1043
|
/**
|
|
@@ -1049,7 +1049,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1049
1049
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1050
1050
|
*
|
|
1051
1051
|
* Supported embed types: `SearchEmbed`
|
|
1052
|
-
* @version SDK: 1.32.0 |
|
|
1052
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1053
1053
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1054
1054
|
* @example
|
|
1055
1055
|
* ```js
|
|
@@ -1066,7 +1066,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
1066
1066
|
* lands on search embed page.
|
|
1067
1067
|
*
|
|
1068
1068
|
* Supported embed types: `SearchEmbed`
|
|
1069
|
-
* @version SDK: 1.32.0 |
|
|
1069
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.3.0.cl
|
|
1070
1070
|
* @default true
|
|
1071
1071
|
* @example
|
|
1072
1072
|
* ```js
|
|
@@ -1230,7 +1230,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1230
1230
|
*
|
|
1231
1231
|
* Supported embed types: `AppEmbed`
|
|
1232
1232
|
* @default true
|
|
1233
|
-
* @version SDK: 1.2.0 |
|
|
1233
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
1234
1234
|
* @example
|
|
1235
1235
|
* ```js
|
|
1236
1236
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1252,7 +1252,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1252
1252
|
*
|
|
1253
1253
|
* Supported embed types: `AppEmbed`
|
|
1254
1254
|
* @default false
|
|
1255
|
-
* @version SDK: 1.28.0 |
|
|
1255
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1256
1256
|
* @example
|
|
1257
1257
|
* ```js
|
|
1258
1258
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1268,7 +1268,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1268
1268
|
*
|
|
1269
1269
|
* Supported embed types: `AppEmbed`
|
|
1270
1270
|
* @default false
|
|
1271
|
-
* @version SDK: 1.2.0 |
|
|
1271
|
+
* @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
|
|
1272
1272
|
* @example
|
|
1273
1273
|
* ```js
|
|
1274
1274
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1351,7 +1351,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1351
1351
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1352
1352
|
*
|
|
1353
1353
|
* Supported embed types: `AppEmbed`
|
|
1354
|
-
* @version SDK: 1.28.0 |
|
|
1354
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1355
1355
|
* @default false
|
|
1356
1356
|
* @example
|
|
1357
1357
|
* ```js
|
|
@@ -1371,7 +1371,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1371
1371
|
* `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
|
|
1372
1372
|
*
|
|
1373
1373
|
* Supported embed types: `AppEmbed`
|
|
1374
|
-
* @version SDK: 1.28.0 |
|
|
1374
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1375
1375
|
* @default true
|
|
1376
1376
|
* @example
|
|
1377
1377
|
* ```js
|
|
@@ -1392,7 +1392,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1392
1392
|
* you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
|
|
1393
1393
|
*
|
|
1394
1394
|
* Supported embed types: `AppEmbed`
|
|
1395
|
-
* @version SDK: 1.1.0 |
|
|
1395
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1396
1396
|
* @example
|
|
1397
1397
|
* ```js
|
|
1398
1398
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1410,7 +1410,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1410
1410
|
* path within the app, use the `path` attribute which is more flexible.
|
|
1411
1411
|
*
|
|
1412
1412
|
* Supported embed types: `AppEmbed`
|
|
1413
|
-
* @version SDK: 1.1.0 |
|
|
1413
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1414
1414
|
* @example
|
|
1415
1415
|
* ```js
|
|
1416
1416
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1426,7 +1426,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1426
1426
|
* tag.
|
|
1427
1427
|
*
|
|
1428
1428
|
* Supported embed types: `AppEmbed`
|
|
1429
|
-
* @version SDK: 1.1.0 |
|
|
1429
|
+
* @version SDK: 1.1.0 | ThoughtSpot: 9.4.0.cl
|
|
1430
1430
|
* @example
|
|
1431
1431
|
* ```js
|
|
1432
1432
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1505,7 +1505,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1505
1505
|
*
|
|
1506
1506
|
* Supported embed types: `AppEmbed`
|
|
1507
1507
|
* @default false
|
|
1508
|
-
* @version SDK: 1.28.0 |
|
|
1508
|
+
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
1509
1509
|
* @example
|
|
1510
1510
|
* ```js
|
|
1511
1511
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -1535,7 +1535,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1535
1535
|
discoveryExperience?: DiscoveryExperience;
|
|
1536
1536
|
/**
|
|
1537
1537
|
* To set the initial state of the search bar in case of saved-answers.
|
|
1538
|
-
* @version SDK: 1.32.0 |
|
|
1538
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1539
1539
|
* @default false
|
|
1540
1540
|
* @deprecated Use {@link collapseSearchBar} instead
|
|
1541
1541
|
*/
|
|
@@ -1549,7 +1549,7 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1549
1549
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
1550
1550
|
*
|
|
1551
1551
|
* Supported embed types: `AppEmbed`
|
|
1552
|
-
* @version SDK: 1.32.0 |
|
|
1552
|
+
* @version SDK: 1.32.0 | ThoughtSpot: 10.0.0.cl
|
|
1553
1553
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
1554
1554
|
* @example
|
|
1555
1555
|
* ```js
|
|
@@ -1563,14 +1563,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
1563
1563
|
dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
|
|
1564
1564
|
/**
|
|
1565
1565
|
* Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
|
|
1566
|
-
* @version SDK : 1.29.0 |
|
|
1566
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.1.0.cl
|
|
1567
1567
|
*/
|
|
1568
1568
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
1569
1569
|
/**
|
|
1570
1570
|
* Flag to use home page search bar mode
|
|
1571
1571
|
*
|
|
1572
1572
|
* Supported embed types: `AppEmbed`
|
|
1573
|
-
* @version SDK : 1.33.0 |
|
|
1573
|
+
* @version SDK : 1.33.0 | ThoughtSpot: 10.3.0.cl
|
|
1574
1574
|
*/
|
|
1575
1575
|
homePageSearchBarMode?: HomePageSearchBarMode;
|
|
1576
1576
|
/**
|
|
@@ -1835,7 +1835,7 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
1835
1835
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
1836
1836
|
*
|
|
1837
1837
|
* Supported embed types: `LiveboardEmbed`
|
|
1838
|
-
* @version SDK: 1.25.0 |
|
|
1838
|
+
* @version SDK: 1.25.0 | ThoughtSpot: 9.6.0.cl, 9.8.0.sw
|
|
1839
1839
|
* @example
|
|
1840
1840
|
* ```js
|
|
1841
1841
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -2024,7 +2024,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
2024
2024
|
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
2025
2025
|
/**
|
|
2026
2026
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
2027
|
-
* this Liveboard inside the full
|
|
2027
|
+
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
2028
2028
|
* @returns url string
|
|
2029
2029
|
*/
|
|
2030
2030
|
getLiveboardUrl(): string;
|
|
@@ -2393,7 +2393,7 @@ export interface CustomStyles {
|
|
|
2393
2393
|
* Configuration to define the customization on the Embedded
|
|
2394
2394
|
* ThoughtSpot components.
|
|
2395
2395
|
* You can customize styles, text strings, and icons.
|
|
2396
|
-
* For more information, see https://developers.thoughtspot.com/docs/custom-css.
|
|
2396
|
+
* For more information, see link:https://developers.thoughtspot.com/docs/custom-css[CSS customization framework].
|
|
2397
2397
|
* @example
|
|
2398
2398
|
* ```js
|
|
2399
2399
|
* init({
|
|
@@ -4623,7 +4623,7 @@ export declare enum EmbedEvent {
|
|
|
4623
4623
|
*
|
|
4624
4624
|
* error: Developers can customize the error message text when `execute`
|
|
4625
4625
|
* returns `false` using the error parameter in responder.
|
|
4626
|
-
* @version SDK : 1.29.0 | ThoughtSpot
|
|
4626
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4627
4627
|
* @example
|
|
4628
4628
|
*```js
|
|
4629
4629
|
* .on(EmbedEvent.OnBeforeGetVizDataIntercept,
|
|
@@ -4670,7 +4670,7 @@ export declare enum EmbedEvent {
|
|
|
4670
4670
|
* console.log('payload', payload);
|
|
4671
4671
|
* })
|
|
4672
4672
|
*```
|
|
4673
|
-
* @version SDK : 1.29.0 | ThoughtSpot
|
|
4673
|
+
* @version SDK : 1.29.0 | ThoughtSpot: 10.3.0.cl
|
|
4674
4674
|
*/
|
|
4675
4675
|
ParameterChanged = "parameterChanged",
|
|
4676
4676
|
/**
|
|
@@ -4726,18 +4726,18 @@ export declare enum EmbedEvent {
|
|
|
4726
4726
|
* console.log('payload', payload);
|
|
4727
4727
|
* })
|
|
4728
4728
|
*```
|
|
4729
|
-
* @version SDK : 1.37.0 | ThoughtSpot
|
|
4729
|
+
* @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4730
4730
|
*/
|
|
4731
4731
|
CreateLiveboard = "createLiveboard",
|
|
4732
4732
|
/**
|
|
4733
4733
|
* Emitted when a user creates a Model.
|
|
4734
|
-
* @version SDK : 1.37.0 | ThoughtSpot
|
|
4734
|
+
* @version SDK : 1.37.0 | ThoughtSpot: 10.8.0.cl
|
|
4735
4735
|
*/
|
|
4736
4736
|
CreateModel = "createModel",
|
|
4737
4737
|
/**
|
|
4738
4738
|
* @hidden
|
|
4739
4739
|
* Emitted when a user exits present mode.
|
|
4740
|
-
* @version SDK : 1.40.0 | ThoughtSpot
|
|
4740
|
+
* @version SDK : 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
4741
4741
|
*/
|
|
4742
4742
|
ExitPresentMode = "exitPresentMode"
|
|
4743
4743
|
}
|
|
@@ -5981,6 +5981,7 @@ export declare enum Param {
|
|
|
5981
5981
|
* hiddenActions: [Action.Edit, ActionAction.Explore],
|
|
5982
5982
|
* })
|
|
5983
5983
|
* ```
|
|
5984
|
+
* See also link:https://developers.thoughtspot.com/docs/actions[Action IDs in the SDK]
|
|
5984
5985
|
*/
|
|
5985
5986
|
export declare enum Action {
|
|
5986
5987
|
/**
|
|
@@ -7386,7 +7387,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7386
7387
|
* disableSourceSelection : true,
|
|
7387
7388
|
* })
|
|
7388
7389
|
* ```
|
|
7389
|
-
* @version SDK: 1.36.0 |
|
|
7390
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7390
7391
|
*/
|
|
7391
7392
|
disableSourceSelection?: boolean;
|
|
7392
7393
|
/**
|
|
@@ -7400,7 +7401,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7400
7401
|
* hideSourceSelection : true,
|
|
7401
7402
|
* })
|
|
7402
7403
|
* ```
|
|
7403
|
-
* @version SDK: 1.36.0 |
|
|
7404
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7404
7405
|
*/
|
|
7405
7406
|
hideSourceSelection?: boolean;
|
|
7406
7407
|
/**
|
|
@@ -7432,7 +7433,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7432
7433
|
* showSpotterLimitations : true,
|
|
7433
7434
|
* })
|
|
7434
7435
|
* ```
|
|
7435
|
-
* @version SDK: 1.36.0 |
|
|
7436
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
7436
7437
|
*/
|
|
7437
7438
|
showSpotterLimitations?: boolean;
|
|
7438
7439
|
/**
|
|
@@ -7447,7 +7448,7 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7447
7448
|
* hideSampleQuestions : true,
|
|
7448
7449
|
* })
|
|
7449
7450
|
* ```
|
|
7450
|
-
* @version SDK: 1.36.0 |
|
|
7451
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7451
7452
|
*/
|
|
7452
7453
|
hideSampleQuestions?: boolean;
|
|
7453
7454
|
}
|
|
@@ -8335,9 +8336,52 @@ export declare class AnswerService {
|
|
|
8335
8336
|
}
|
|
8336
8337
|
|
|
8337
8338
|
/**
|
|
8338
|
-
* Gets the configuration
|
|
8339
|
-
*
|
|
8340
|
-
* @
|
|
8339
|
+
* Gets the embed configuration settings that were used to
|
|
8340
|
+
* initialize the SDK.
|
|
8341
|
+
* @returns {@link EmbedConfig}
|
|
8342
|
+
*
|
|
8343
|
+
* @example
|
|
8344
|
+
* ```js
|
|
8345
|
+
* const config = getInitConfig();
|
|
8346
|
+
* console.log(config);
|
|
8347
|
+
* ```
|
|
8348
|
+
* @example
|
|
8349
|
+
*
|
|
8350
|
+
* Returns the `EmbedConfig` object, which
|
|
8351
|
+
* contains the configuration settings used to
|
|
8352
|
+
* initialize the SDK, including the following:
|
|
8353
|
+
*
|
|
8354
|
+
* - `thoughtSpotHost` - ThoughtSpot host URL
|
|
8355
|
+
* - `authType`: The authentication method used. For example,
|
|
8356
|
+
* `AuthServerCookieless` for `AuthType.TrustedAuthTokenCookieless`
|
|
8357
|
+
* - `customizations` - Style, text, and icon customization settings
|
|
8358
|
+
* that were applied during the SDK initialization.
|
|
8359
|
+
*
|
|
8360
|
+
* For a comprehensive list of embed configuration settings,
|
|
8361
|
+
* see link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[Developer Documentation].
|
|
8362
|
+
*
|
|
8363
|
+
* ```json
|
|
8364
|
+
* {
|
|
8365
|
+
* "thoughtSpotHost": "https://{ThoughtSpot-Host}",
|
|
8366
|
+
* "authType": "AuthServerCookieless",
|
|
8367
|
+
* "customizations": {
|
|
8368
|
+
* "style": {
|
|
8369
|
+
* "customCSS": {
|
|
8370
|
+
* "variables": {
|
|
8371
|
+
* "--ts-var-button--secondary-background": "#7492d5",
|
|
8372
|
+
* "--ts-var-button--secondary--hovers-background": "#aac2f8",
|
|
8373
|
+
* "--ts-var-root-background": "#f1f4f8"
|
|
8374
|
+
* }
|
|
8375
|
+
* }
|
|
8376
|
+
* }
|
|
8377
|
+
* },
|
|
8378
|
+
* "loginFailedMessage": "Login failed, please try again",
|
|
8379
|
+
* "authTriggerText": "Authorize",
|
|
8380
|
+
* "disableTokenVerification": true,
|
|
8381
|
+
* "authTriggerContainer": "#your-own-div"
|
|
8382
|
+
* }
|
|
8383
|
+
* ```
|
|
8384
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.cl, and later
|
|
8341
8385
|
* @group Global methods
|
|
8342
8386
|
*/
|
|
8343
8387
|
export declare const getEmbedConfig: () => EmbedConfig;
|
|
@@ -8345,7 +8389,7 @@ export declare const getEmbedConfig: () => EmbedConfig;
|
|
|
8345
8389
|
* Sets the configuration embed was initialized with.
|
|
8346
8390
|
* And returns the new configuration.
|
|
8347
8391
|
* @param newConfig The configuration to set.
|
|
8348
|
-
* @version SDK: 1.27.0 | ThoughtSpot:
|
|
8392
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.1.sw, and later
|
|
8349
8393
|
* @group Global methods
|
|
8350
8394
|
*/
|
|
8351
8395
|
export declare const setEmbedConfig: (newConfig: EmbedConfig) => any;
|