@thoughtspot/visual-embed-sdk 1.39.1 → 1.39.2-alpha.1
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.map +1 -1
- package/cjs/src/embed/app.js +2 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +18 -8
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +60 -2
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +9 -1
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +130 -0
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +9 -7
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +9 -7
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +0 -17
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +2 -4
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +12 -11
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- 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 +34 -2
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +17 -1
- package/cjs/src/types.js.map +1 -1
- package/dist/{index-JaFaxrvQ.js → index-CmEQfuE3.js} +1 -1
- package/dist/index-DeFzsyFF.js +7371 -0
- package/dist/index-Dpf0rd6w.js +7371 -0
- package/dist/index-UuEbsISo.js +7447 -0
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +60 -2
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +9 -7
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +0 -17
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- 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 +34 -2
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +58 -18
- package/dist/tsembed-react.js +57 -17
- package/dist/tsembed.es.js +58 -18
- package/dist/tsembed.js +57 -17
- package/dist/visual-embed-sdk-react-full.d.ts +102 -27
- package/dist/visual-embed-sdk-react.d.ts +102 -27
- package/dist/visual-embed-sdk.d.ts +102 -27
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +2 -1
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +19 -9
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +60 -2
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +10 -2
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +133 -3
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +9 -7
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +9 -7
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +0 -17
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +2 -4
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +12 -11
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- 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 +34 -2
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +17 -1
- package/lib/src/types.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +103 -28
- package/package.json +1 -1
- package/src/embed/app.spec.ts +36 -23
- package/src/embed/app.ts +2 -0
- package/src/embed/conversation.spec.ts +170 -6
- package/src/embed/conversation.ts +82 -10
- package/src/embed/embedConfig.ts +10 -8
- package/src/embed/liveboard.spec.ts +5 -4
- package/src/embed/liveboard.ts +2 -22
- package/src/embed/ts-embed.spec.ts +225 -0
- package/src/embed/ts-embed.ts +19 -0
- package/src/types.ts +75 -43
package/dist/tsembed.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/* @thoughtspot/visual-embed-sdk version 1.39.1 */
|
|
1
|
+
/* @thoughtspot/visual-embed-sdk version 1.39.2-alpha.1 */
|
|
2
2
|
'use client';
|
|
3
3
|
(function (global, factory) {
|
|
4
4
|
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
|
|
@@ -3068,7 +3068,7 @@
|
|
|
3068
3068
|
Param["DataSourceId"] = "dataSourceId";
|
|
3069
3069
|
Param["preAuthCache"] = "preAuthCache";
|
|
3070
3070
|
Param["ShowSpotterLimitations"] = "showSpotterLimitations";
|
|
3071
|
-
Param["CoverAndFilterOptionInPDF"] = "
|
|
3071
|
+
Param["CoverAndFilterOptionInPDF"] = "arePdfCoverFilterPageCheckboxesEnabled";
|
|
3072
3072
|
Param["PrimaryAction"] = "primaryAction";
|
|
3073
3073
|
Param["isSpotterAgentEmbed"] = "isSpotterAgentEmbed";
|
|
3074
3074
|
Param["IsLiveboardStylingAndGroupingEnabled"] = "isLiveboardStylingAndGroupingEnabled";
|
|
@@ -4294,6 +4294,22 @@
|
|
|
4294
4294
|
* @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
4295
4295
|
*/
|
|
4296
4296
|
Action["CoverAndFilterOptionInPDF"] = "coverAndFilterOptionInPDF";
|
|
4297
|
+
/**
|
|
4298
|
+
* Action ID for hide or disable the
|
|
4299
|
+
* Spotter in conversation training widget.
|
|
4300
|
+
* The Add to Coaching feature is currently in beta
|
|
4301
|
+
* and is disabled by default on embed deployments.
|
|
4302
|
+
* To enable this feature on your instance,
|
|
4303
|
+
* contact ThoughtSpot Support.
|
|
4304
|
+
* @example
|
|
4305
|
+
* ```js
|
|
4306
|
+
* hiddenAction: [Action.InConversationTraining]
|
|
4307
|
+
* disabledActions: [Action.InConversationTraining]
|
|
4308
|
+
*
|
|
4309
|
+
* ```
|
|
4310
|
+
* @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
4311
|
+
*/
|
|
4312
|
+
Action["InConversationTraining"] = "InConversationTraining";
|
|
4297
4313
|
})(exports.Action || (exports.Action = {}));
|
|
4298
4314
|
exports.PrefetchFeatures = void 0;
|
|
4299
4315
|
(function (PrefetchFeatures) {
|
|
@@ -6967,13 +6983,14 @@
|
|
|
6967
6983
|
*
|
|
6968
6984
|
* @example
|
|
6969
6985
|
* ```js
|
|
6986
|
+
* import { getInitConfig } from '@thoughtspot/visual-embed-sdk';
|
|
6987
|
+
* // Call the getInitConfig method to retrieve the embed configuration
|
|
6970
6988
|
* const config = getInitConfig();
|
|
6989
|
+
* // Log the configuration settings
|
|
6971
6990
|
* console.log(config);
|
|
6972
6991
|
* ```
|
|
6973
|
-
*
|
|
6974
|
-
*
|
|
6975
|
-
* Returns the `EmbedConfig` object, which
|
|
6976
|
-
* contains the configuration settings used to
|
|
6992
|
+
* Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig]
|
|
6993
|
+
* object, which contains the configuration settings used to
|
|
6977
6994
|
* initialize the SDK, including the following:
|
|
6978
6995
|
*
|
|
6979
6996
|
* - `thoughtSpotHost` - ThoughtSpot host URL
|
|
@@ -6982,9 +6999,10 @@
|
|
|
6982
6999
|
* - `customizations` - Style, text, and icon customization settings
|
|
6983
7000
|
* that were applied during the SDK initialization.
|
|
6984
7001
|
*
|
|
6985
|
-
*
|
|
6986
|
-
*
|
|
7002
|
+
* The following JSON output shows the embed configuration
|
|
7003
|
+
* settings returned from the code in the previous example:
|
|
6987
7004
|
*
|
|
7005
|
+
* @example
|
|
6988
7006
|
* ```json
|
|
6989
7007
|
* {
|
|
6990
7008
|
* "thoughtSpotHost": "https://{ThoughtSpot-Host}",
|
|
@@ -7006,7 +7024,7 @@
|
|
|
7006
7024
|
* "authTriggerContainer": "#your-own-div"
|
|
7007
7025
|
* }
|
|
7008
7026
|
* ```
|
|
7009
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.
|
|
7027
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later
|
|
7010
7028
|
* @group Global methods
|
|
7011
7029
|
*/
|
|
7012
7030
|
const getEmbedConfig = () => getValueFromWindow(configKey) || {};
|
|
@@ -15548,7 +15566,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
15548
15566
|
return e;
|
|
15549
15567
|
}
|
|
15550
15568
|
|
|
15551
|
-
var name="@thoughtspot/visual-embed-sdk";var version$1="1.39.1";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};
|
|
15569
|
+
var name="@thoughtspot/visual-embed-sdk";var version$1="1.39.2-alpha.1";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};
|
|
15552
15570
|
|
|
15553
15571
|
/**
|
|
15554
15572
|
* Reloads the ThoughtSpot iframe.
|
|
@@ -15946,10 +15964,25 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
15946
15964
|
// - cached auth info would be for wrong org
|
|
15947
15965
|
// - info call response changes for each different overrideOrgId
|
|
15948
15966
|
// 2. disablePreauthCache is explicitly set to true
|
|
15967
|
+
// 3. FullAppEmbed has primary navbar visible since:
|
|
15968
|
+
// - primary navbar requires fresh auth state for navigation
|
|
15969
|
+
// - cached auth may not reflect current user permissions
|
|
15949
15970
|
const isDisabled = (this.viewConfig.overrideOrgId !== undefined
|
|
15950
|
-
|| this.embedConfig.disablePreauthCache === true
|
|
15971
|
+
|| this.embedConfig.disablePreauthCache === true
|
|
15972
|
+
|| this.isFullAppEmbedWithVisiblePrimaryNavbar());
|
|
15951
15973
|
return !isDisabled;
|
|
15952
15974
|
}
|
|
15975
|
+
/**
|
|
15976
|
+
* Checks if current embed is FullAppEmbed with visible primary navbar
|
|
15977
|
+
* @returns boolean
|
|
15978
|
+
*/
|
|
15979
|
+
isFullAppEmbedWithVisiblePrimaryNavbar() {
|
|
15980
|
+
const appViewConfig = this.viewConfig;
|
|
15981
|
+
// Check if this is a FullAppEmbed (AppEmbed)
|
|
15982
|
+
// showPrimaryNavbar defaults to true if not explicitly set to false
|
|
15983
|
+
return (appViewConfig.embedComponentType === 'AppEmbed'
|
|
15984
|
+
&& appViewConfig.showPrimaryNavbar === true);
|
|
15985
|
+
}
|
|
15953
15986
|
/**
|
|
15954
15987
|
* fix for ts7.sep.cl
|
|
15955
15988
|
* will be removed for ts7.oct.cl
|
|
@@ -17083,7 +17116,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
17083
17116
|
getEmbedParams() {
|
|
17084
17117
|
const { tag, hideObjects, liveboardV2, showPrimaryNavbar, disableProfileAndHelp, hideHamburger, hideObjectSearch, hideNotification, hideApplicationSwitcher, hideOrgSwitcher, enableSearchAssist, fullHeight, dataPanelV2 = false, hideLiveboardHeader = false, showLiveboardTitle = true, showLiveboardDescription = true, hideHomepageLeftNav = false, modularHomeExperience = false, isLiveboardHeaderSticky = true, enableAskSage, collapseSearchBarInitially = false, enable2ColumnLayout, enableCustomColumnGroups = false, isOnBeforeGetVizDataInterceptEnabled = false,
|
|
17085
17118
|
/* eslint-disable-next-line max-len */
|
|
17086
|
-
dataPanelCustomGroupsAccordionInitialState = exports.DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, enablePendoHelp = true, discoveryExperience, isLiveboardStylingAndGroupingEnabled, } = this.viewConfig;
|
|
17119
|
+
dataPanelCustomGroupsAccordionInitialState = exports.DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, enablePendoHelp = true, discoveryExperience, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, } = this.viewConfig;
|
|
17087
17120
|
let params = {};
|
|
17088
17121
|
params[Param.PrimaryNavHidden] = !showPrimaryNavbar;
|
|
17089
17122
|
params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
|
|
@@ -17099,6 +17132,7 @@ mutation GetUnsavedAnswerTML($session: BachSessionIdInput!, $exportDependencies:
|
|
|
17099
17132
|
params[Param.ShowLiveboardReverifyBanner] = showLiveboardReverifyBanner;
|
|
17100
17133
|
params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
|
|
17101
17134
|
params[Param.IsUnifiedSearchExperienceEnabled] = isUnifiedSearchExperienceEnabled;
|
|
17135
|
+
params[Param.CoverAndFilterOptionInPDF] = !!coverAndFilterOptionInPDF;
|
|
17102
17136
|
params = this.getBaseQueryParams(params);
|
|
17103
17137
|
if (hideObjectSearch) {
|
|
17104
17138
|
params[Param.HideObjectSearch] = !!hideObjectSearch;
|
|
@@ -17418,7 +17452,7 @@ query GetEurekaVizSnapshots(
|
|
|
17418
17452
|
getEmbedParams() {
|
|
17419
17453
|
let params = {};
|
|
17420
17454
|
params = this.getBaseQueryParams(params);
|
|
17421
|
-
const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, isLiveboardHeaderSticky = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, enableAskSage, enable2ColumnLayout, dataPanelV2 = false, enableCustomColumnGroups = false, oAuthPollingInterval, isForceRedirect, dataSourceId, coverAndFilterOptionInPDF, isLiveboardStylingAndGroupingEnabled, } = this.viewConfig;
|
|
17455
|
+
const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, isLiveboardHeaderSticky = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, enableAskSage, enable2ColumnLayout, dataPanelV2 = false, enableCustomColumnGroups = false, oAuthPollingInterval, isForceRedirect, dataSourceId, coverAndFilterOptionInPDF = false, isLiveboardStylingAndGroupingEnabled, } = this.viewConfig;
|
|
17422
17456
|
const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
|
|
17423
17457
|
|| this.viewConfig.preventPinboardFilterRemoval;
|
|
17424
17458
|
if (fullHeight === true) {
|
|
@@ -17470,9 +17504,6 @@ query GetEurekaVizSnapshots(
|
|
|
17470
17504
|
if (dataSourceId !== undefined) {
|
|
17471
17505
|
params[Param.DataSourceId] = dataSourceId;
|
|
17472
17506
|
}
|
|
17473
|
-
if (coverAndFilterOptionInPDF !== undefined) {
|
|
17474
|
-
params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
|
|
17475
|
-
}
|
|
17476
17507
|
if (isLiveboardStylingAndGroupingEnabled !== undefined) {
|
|
17477
17508
|
params[Param.IsLiveboardStylingAndGroupingEnabled] = isLiveboardStylingAndGroupingEnabled;
|
|
17478
17509
|
}
|
|
@@ -17483,6 +17514,7 @@ query GetEurekaVizSnapshots(
|
|
|
17483
17514
|
params[Param.HideIrrelevantFiltersInTab] = hideIrrelevantChipsInLiveboardTabs;
|
|
17484
17515
|
params[Param.DataPanelV2Enabled] = dataPanelV2;
|
|
17485
17516
|
params[Param.EnableCustomColumnGroups] = enableCustomColumnGroups;
|
|
17517
|
+
params[Param.CoverAndFilterOptionInPDF] = coverAndFilterOptionInPDF;
|
|
17486
17518
|
const queryParams = getQueryParamString(params, true);
|
|
17487
17519
|
return queryParams;
|
|
17488
17520
|
}
|
|
@@ -18408,7 +18440,7 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
18408
18440
|
this.viewConfig = viewConfig;
|
|
18409
18441
|
}
|
|
18410
18442
|
getIframeSrc() {
|
|
18411
|
-
const { worksheetId, searchOptions, disableSourceSelection, hideSourceSelection, dataPanelV2, showSpotterLimitations, hideSampleQuestions, } = this.viewConfig;
|
|
18443
|
+
const { worksheetId, searchOptions, disableSourceSelection, hideSourceSelection, dataPanelV2, showSpotterLimitations, hideSampleQuestions, runtimeFilters, excludeRuntimeFiltersfromURL, runtimeParameters, excludeRuntimeParametersfromURL, } = this.viewConfig;
|
|
18412
18444
|
const path = 'insights/conv-assist';
|
|
18413
18445
|
if (!worksheetId) {
|
|
18414
18446
|
this.handleError(ERROR_MESSAGE.SPOTTER_EMBED_WORKSHEED_ID_NOT_FOUND);
|
|
@@ -18435,6 +18467,14 @@ query SendMessage($params: Input_convassist_SendMessageRequest) {
|
|
|
18435
18467
|
if (queryParamsString) {
|
|
18436
18468
|
query = `?${queryParamsString}`;
|
|
18437
18469
|
}
|
|
18470
|
+
const filterQuery = getFilterQuery(runtimeFilters || []);
|
|
18471
|
+
if (filterQuery && !excludeRuntimeFiltersfromURL) {
|
|
18472
|
+
query += `&${filterQuery}`;
|
|
18473
|
+
}
|
|
18474
|
+
const parameterQuery = getRuntimeParameters(runtimeParameters || []);
|
|
18475
|
+
if (parameterQuery && !excludeRuntimeParametersfromURL) {
|
|
18476
|
+
query += `&${parameterQuery}`;
|
|
18477
|
+
}
|
|
18438
18478
|
const tsPostHashParams = this.getThoughtSpotPostUrlParams({
|
|
18439
18479
|
worksheet: worksheetId,
|
|
18440
18480
|
query: (searchOptions === null || searchOptions === void 0 ? void 0 : searchOptions.searchQuery) || '',
|
|
@@ -1910,23 +1910,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
1910
1910
|
* })
|
|
1911
1911
|
*/
|
|
1912
1912
|
dataSourceId?: string;
|
|
1913
|
-
/**
|
|
1914
|
-
* This flag is for show/hide checkboxes for include or exclude
|
|
1915
|
-
* cover page and filters in the Liveboard PDF.
|
|
1916
|
-
*
|
|
1917
|
-
* Supported embed types: `LiveboardEmbed`
|
|
1918
|
-
* @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
|
|
1919
|
-
* @default true
|
|
1920
|
-
* Supported embed types: `LiveboardEmbed`
|
|
1921
|
-
* @example
|
|
1922
|
-
* ```js
|
|
1923
|
-
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1924
|
-
* ... //other embed view config
|
|
1925
|
-
* coverAndFilterOptionInPDF: false,
|
|
1926
|
-
* })
|
|
1927
|
-
* ```
|
|
1928
|
-
*/
|
|
1929
|
-
coverAndFilterOptionInPDF?: boolean;
|
|
1930
1913
|
/**
|
|
1931
1914
|
* The list of tab IDs to hide from the embedded.
|
|
1932
1915
|
* This Tabs will be hidden from their respective LBs.
|
|
@@ -3480,6 +3463,22 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3480
3463
|
* ```
|
|
3481
3464
|
*/
|
|
3482
3465
|
enableAskSage?: boolean;
|
|
3466
|
+
/**
|
|
3467
|
+
* This flag is used to show or hide checkboxes for including or excluding
|
|
3468
|
+
* the cover and filters pages in the Liveboard PDF.
|
|
3469
|
+
*
|
|
3470
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3471
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
3472
|
+
* @example
|
|
3473
|
+
* ```js
|
|
3474
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3475
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3476
|
+
* ... // other embed view config
|
|
3477
|
+
* coverAndFilterOptionInPDF: false,
|
|
3478
|
+
* })
|
|
3479
|
+
* ```
|
|
3480
|
+
*/
|
|
3481
|
+
coverAndFilterOptionInPDF?: boolean;
|
|
3483
3482
|
}
|
|
3484
3483
|
export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
|
|
3485
3484
|
}
|
|
@@ -5951,7 +5950,7 @@ export declare enum Param {
|
|
|
5951
5950
|
DataSourceId = "dataSourceId",
|
|
5952
5951
|
preAuthCache = "preAuthCache",
|
|
5953
5952
|
ShowSpotterLimitations = "showSpotterLimitations",
|
|
5954
|
-
CoverAndFilterOptionInPDF = "
|
|
5953
|
+
CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
|
|
5955
5954
|
PrimaryAction = "primaryAction",
|
|
5956
5955
|
isSpotterAgentEmbed = "isSpotterAgentEmbed",
|
|
5957
5956
|
IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
|
|
@@ -7174,7 +7173,23 @@ export declare enum Action {
|
|
|
7174
7173
|
* ```
|
|
7175
7174
|
* @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
7176
7175
|
*/
|
|
7177
|
-
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
|
|
7176
|
+
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
7177
|
+
/**
|
|
7178
|
+
* Action ID for hide or disable the
|
|
7179
|
+
* Spotter in conversation training widget.
|
|
7180
|
+
* The Add to Coaching feature is currently in beta
|
|
7181
|
+
* and is disabled by default on embed deployments.
|
|
7182
|
+
* To enable this feature on your instance,
|
|
7183
|
+
* contact ThoughtSpot Support.
|
|
7184
|
+
* @example
|
|
7185
|
+
* ```js
|
|
7186
|
+
* hiddenAction: [Action.InConversationTraining]
|
|
7187
|
+
* disabledActions: [Action.InConversationTraining]
|
|
7188
|
+
*
|
|
7189
|
+
* ```
|
|
7190
|
+
* @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
7191
|
+
*/
|
|
7192
|
+
InConversationTraining = "InConversationTraining"
|
|
7178
7193
|
}
|
|
7179
7194
|
export interface AnswerServiceType {
|
|
7180
7195
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -7368,7 +7383,8 @@ export interface SearchOptions {
|
|
|
7368
7383
|
*/
|
|
7369
7384
|
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
7370
7385
|
/**
|
|
7371
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
7386
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
7387
|
+
* this object to query data and generate Answers.
|
|
7372
7388
|
*/
|
|
7373
7389
|
worksheetId: string;
|
|
7374
7390
|
/**
|
|
@@ -7451,6 +7467,63 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7451
7467
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7452
7468
|
*/
|
|
7453
7469
|
hideSampleQuestions?: boolean;
|
|
7470
|
+
/**
|
|
7471
|
+
* The list of runtime filters to apply to a search Answer,
|
|
7472
|
+
* visualization, or Liveboard.
|
|
7473
|
+
*
|
|
7474
|
+
* Supported embed types: `SpotterEmbed`
|
|
7475
|
+
* @example
|
|
7476
|
+
* ```js
|
|
7477
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7478
|
+
* ... // other embed view config
|
|
7479
|
+
* runtimeFilters: [
|
|
7480
|
+
* {
|
|
7481
|
+
* columnName: 'value',
|
|
7482
|
+
* operator: RuntimeFilterOp.EQ,
|
|
7483
|
+
* values: ['string' | 123 | true],
|
|
7484
|
+
* },
|
|
7485
|
+
* ],
|
|
7486
|
+
* })
|
|
7487
|
+
* ```
|
|
7488
|
+
*/
|
|
7489
|
+
runtimeFilters?: RuntimeFilter[];
|
|
7490
|
+
/**
|
|
7491
|
+
* Flag to control whether runtime filters should be included in the URL.
|
|
7492
|
+
* If true, filters will be passed via app initialization payload instead.
|
|
7493
|
+
* If false/undefined, filters will be added to URL (default behavior).
|
|
7494
|
+
*
|
|
7495
|
+
* Supported embed types: `SpotterEmbed`
|
|
7496
|
+
* @default false
|
|
7497
|
+
*/
|
|
7498
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
7499
|
+
/**
|
|
7500
|
+
* The list of runtime parameters to apply to the conversation.
|
|
7501
|
+
*
|
|
7502
|
+
* Supported embed types: `SpotterEmbed`
|
|
7503
|
+
* @example
|
|
7504
|
+
* ```js
|
|
7505
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7506
|
+
* ... // other embed view config
|
|
7507
|
+
* runtimeParameters: [
|
|
7508
|
+
* {
|
|
7509
|
+
* name: 'Parameter Name',
|
|
7510
|
+
* value: 'Parameter Value',
|
|
7511
|
+
* },
|
|
7512
|
+
* ],
|
|
7513
|
+
* })
|
|
7514
|
+
* ```
|
|
7515
|
+
*/
|
|
7516
|
+
runtimeParameters?: RuntimeParameter[];
|
|
7517
|
+
/**
|
|
7518
|
+
* Flag to control whether runtime parameters should be included in the URL.
|
|
7519
|
+
* If true, parameters will be passed via app initialization payload instead.
|
|
7520
|
+
* If false/undefined, parameters will be added to URL (default behavior).
|
|
7521
|
+
*
|
|
7522
|
+
* Supported embed types: `SpotterEmbed`
|
|
7523
|
+
* @default false
|
|
7524
|
+
*
|
|
7525
|
+
*/
|
|
7526
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
7454
7527
|
}
|
|
7455
7528
|
/**
|
|
7456
7529
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -8342,13 +8415,14 @@ export declare class AnswerService {
|
|
|
8342
8415
|
*
|
|
8343
8416
|
* @example
|
|
8344
8417
|
* ```js
|
|
8418
|
+
* import { getInitConfig } from '@thoughtspot/visual-embed-sdk';
|
|
8419
|
+
* // Call the getInitConfig method to retrieve the embed configuration
|
|
8345
8420
|
* const config = getInitConfig();
|
|
8421
|
+
* // Log the configuration settings
|
|
8346
8422
|
* console.log(config);
|
|
8347
8423
|
* ```
|
|
8348
|
-
*
|
|
8349
|
-
*
|
|
8350
|
-
* Returns the `EmbedConfig` object, which
|
|
8351
|
-
* contains the configuration settings used to
|
|
8424
|
+
* Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig]
|
|
8425
|
+
* object, which contains the configuration settings used to
|
|
8352
8426
|
* initialize the SDK, including the following:
|
|
8353
8427
|
*
|
|
8354
8428
|
* - `thoughtSpotHost` - ThoughtSpot host URL
|
|
@@ -8357,9 +8431,10 @@ export declare class AnswerService {
|
|
|
8357
8431
|
* - `customizations` - Style, text, and icon customization settings
|
|
8358
8432
|
* that were applied during the SDK initialization.
|
|
8359
8433
|
*
|
|
8360
|
-
*
|
|
8361
|
-
*
|
|
8434
|
+
* The following JSON output shows the embed configuration
|
|
8435
|
+
* settings returned from the code in the previous example:
|
|
8362
8436
|
*
|
|
8437
|
+
* @example
|
|
8363
8438
|
* ```json
|
|
8364
8439
|
* {
|
|
8365
8440
|
* "thoughtSpotHost": "https://{ThoughtSpot-Host}",
|
|
@@ -8381,7 +8456,7 @@ export declare class AnswerService {
|
|
|
8381
8456
|
* "authTriggerContainer": "#your-own-div"
|
|
8382
8457
|
* }
|
|
8383
8458
|
* ```
|
|
8384
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.
|
|
8459
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later
|
|
8385
8460
|
* @group Global methods
|
|
8386
8461
|
*/
|
|
8387
8462
|
export declare const getEmbedConfig: () => EmbedConfig;
|
|
@@ -1900,23 +1900,6 @@ export interface LiveboardViewConfig extends BaseViewConfig, LiveboardOtherViewC
|
|
|
1900
1900
|
* })
|
|
1901
1901
|
*/
|
|
1902
1902
|
dataSourceId?: string;
|
|
1903
|
-
/**
|
|
1904
|
-
* This flag is for show/hide checkboxes for include or exclude
|
|
1905
|
-
* cover page and filters in the Liveboard PDF.
|
|
1906
|
-
*
|
|
1907
|
-
* Supported embed types: `LiveboardEmbed`
|
|
1908
|
-
* @version SDK: 1.37.0 | ThoughtSpot:10.8.0.cl
|
|
1909
|
-
* @default true
|
|
1910
|
-
* Supported embed types: `LiveboardEmbed`
|
|
1911
|
-
* @example
|
|
1912
|
-
* ```js
|
|
1913
|
-
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
1914
|
-
* ... //other embed view config
|
|
1915
|
-
* coverAndFilterOptionInPDF: false,
|
|
1916
|
-
* })
|
|
1917
|
-
* ```
|
|
1918
|
-
*/
|
|
1919
|
-
coverAndFilterOptionInPDF?: boolean;
|
|
1920
1903
|
/**
|
|
1921
1904
|
* The list of tab IDs to hide from the embedded.
|
|
1922
1905
|
* This Tabs will be hidden from their respective LBs.
|
|
@@ -3470,6 +3453,22 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
3470
3453
|
* ```
|
|
3471
3454
|
*/
|
|
3472
3455
|
enableAskSage?: boolean;
|
|
3456
|
+
/**
|
|
3457
|
+
* This flag is used to show or hide checkboxes for including or excluding
|
|
3458
|
+
* the cover and filters pages in the Liveboard PDF.
|
|
3459
|
+
*
|
|
3460
|
+
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
3461
|
+
* @version SDK: 1.40.0 | ThoughtSpot:10.8.0.cl
|
|
3462
|
+
* @example
|
|
3463
|
+
* ```js
|
|
3464
|
+
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
3465
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
3466
|
+
* ... // other embed view config
|
|
3467
|
+
* coverAndFilterOptionInPDF: false,
|
|
3468
|
+
* })
|
|
3469
|
+
* ```
|
|
3470
|
+
*/
|
|
3471
|
+
coverAndFilterOptionInPDF?: boolean;
|
|
3473
3472
|
}
|
|
3474
3473
|
export interface AllEmbedViewConfig extends BaseViewConfig, SearchLiveboardCommonViewConfig, HomePageConfig, LiveboardAppEmbedViewConfig {
|
|
3475
3474
|
}
|
|
@@ -5941,7 +5940,7 @@ export declare enum Param {
|
|
|
5941
5940
|
DataSourceId = "dataSourceId",
|
|
5942
5941
|
preAuthCache = "preAuthCache",
|
|
5943
5942
|
ShowSpotterLimitations = "showSpotterLimitations",
|
|
5944
|
-
CoverAndFilterOptionInPDF = "
|
|
5943
|
+
CoverAndFilterOptionInPDF = "arePdfCoverFilterPageCheckboxesEnabled",
|
|
5945
5944
|
PrimaryAction = "primaryAction",
|
|
5946
5945
|
isSpotterAgentEmbed = "isSpotterAgentEmbed",
|
|
5947
5946
|
IsLiveboardStylingAndGroupingEnabled = "isLiveboardStylingAndGroupingEnabled"
|
|
@@ -7164,7 +7163,23 @@ export declare enum Action {
|
|
|
7164
7163
|
* ```
|
|
7165
7164
|
* @version SDK: 1.37.0 | ThoughtSpot Cloud: 10.8.0.cl
|
|
7166
7165
|
*/
|
|
7167
|
-
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
|
|
7166
|
+
CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
|
|
7167
|
+
/**
|
|
7168
|
+
* Action ID for hide or disable the
|
|
7169
|
+
* Spotter in conversation training widget.
|
|
7170
|
+
* The Add to Coaching feature is currently in beta
|
|
7171
|
+
* and is disabled by default on embed deployments.
|
|
7172
|
+
* To enable this feature on your instance,
|
|
7173
|
+
* contact ThoughtSpot Support.
|
|
7174
|
+
* @example
|
|
7175
|
+
* ```js
|
|
7176
|
+
* hiddenAction: [Action.InConversationTraining]
|
|
7177
|
+
* disabledActions: [Action.InConversationTraining]
|
|
7178
|
+
*
|
|
7179
|
+
* ```
|
|
7180
|
+
* @version SDK: 1.39.0 | ThoughtSpot Cloud: 10.10.0.cl
|
|
7181
|
+
*/
|
|
7182
|
+
InConversationTraining = "InConversationTraining"
|
|
7168
7183
|
}
|
|
7169
7184
|
export interface AnswerServiceType {
|
|
7170
7185
|
getAnswer?: (offset: number, batchSize: number) => any;
|
|
@@ -7358,7 +7373,8 @@ export interface SearchOptions {
|
|
|
7358
7373
|
*/
|
|
7359
7374
|
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAction'> {
|
|
7360
7375
|
/**
|
|
7361
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
7376
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
7377
|
+
* this object to query data and generate Answers.
|
|
7362
7378
|
*/
|
|
7363
7379
|
worksheetId: string;
|
|
7364
7380
|
/**
|
|
@@ -7441,6 +7457,63 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
7441
7457
|
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
7442
7458
|
*/
|
|
7443
7459
|
hideSampleQuestions?: boolean;
|
|
7460
|
+
/**
|
|
7461
|
+
* The list of runtime filters to apply to a search Answer,
|
|
7462
|
+
* visualization, or Liveboard.
|
|
7463
|
+
*
|
|
7464
|
+
* Supported embed types: `SpotterEmbed`
|
|
7465
|
+
* @example
|
|
7466
|
+
* ```js
|
|
7467
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7468
|
+
* ... // other embed view config
|
|
7469
|
+
* runtimeFilters: [
|
|
7470
|
+
* {
|
|
7471
|
+
* columnName: 'value',
|
|
7472
|
+
* operator: RuntimeFilterOp.EQ,
|
|
7473
|
+
* values: ['string' | 123 | true],
|
|
7474
|
+
* },
|
|
7475
|
+
* ],
|
|
7476
|
+
* })
|
|
7477
|
+
* ```
|
|
7478
|
+
*/
|
|
7479
|
+
runtimeFilters?: RuntimeFilter[];
|
|
7480
|
+
/**
|
|
7481
|
+
* Flag to control whether runtime filters should be included in the URL.
|
|
7482
|
+
* If true, filters will be passed via app initialization payload instead.
|
|
7483
|
+
* If false/undefined, filters will be added to URL (default behavior).
|
|
7484
|
+
*
|
|
7485
|
+
* Supported embed types: `SpotterEmbed`
|
|
7486
|
+
* @default false
|
|
7487
|
+
*/
|
|
7488
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
7489
|
+
/**
|
|
7490
|
+
* The list of runtime parameters to apply to the conversation.
|
|
7491
|
+
*
|
|
7492
|
+
* Supported embed types: `SpotterEmbed`
|
|
7493
|
+
* @example
|
|
7494
|
+
* ```js
|
|
7495
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
7496
|
+
* ... // other embed view config
|
|
7497
|
+
* runtimeParameters: [
|
|
7498
|
+
* {
|
|
7499
|
+
* name: 'Parameter Name',
|
|
7500
|
+
* value: 'Parameter Value',
|
|
7501
|
+
* },
|
|
7502
|
+
* ],
|
|
7503
|
+
* })
|
|
7504
|
+
* ```
|
|
7505
|
+
*/
|
|
7506
|
+
runtimeParameters?: RuntimeParameter[];
|
|
7507
|
+
/**
|
|
7508
|
+
* Flag to control whether runtime parameters should be included in the URL.
|
|
7509
|
+
* If true, parameters will be passed via app initialization payload instead.
|
|
7510
|
+
* If false/undefined, parameters will be added to URL (default behavior).
|
|
7511
|
+
*
|
|
7512
|
+
* Supported embed types: `SpotterEmbed`
|
|
7513
|
+
* @default false
|
|
7514
|
+
*
|
|
7515
|
+
*/
|
|
7516
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
7444
7517
|
}
|
|
7445
7518
|
/**
|
|
7446
7519
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -8733,13 +8806,14 @@ export declare function resetCachedPreauthInfo(): void;
|
|
|
8733
8806
|
*
|
|
8734
8807
|
* @example
|
|
8735
8808
|
* ```js
|
|
8809
|
+
* import { getInitConfig } from '@thoughtspot/visual-embed-sdk';
|
|
8810
|
+
* // Call the getInitConfig method to retrieve the embed configuration
|
|
8736
8811
|
* const config = getInitConfig();
|
|
8812
|
+
* // Log the configuration settings
|
|
8737
8813
|
* console.log(config);
|
|
8738
8814
|
* ```
|
|
8739
|
-
*
|
|
8740
|
-
*
|
|
8741
|
-
* Returns the `EmbedConfig` object, which
|
|
8742
|
-
* contains the configuration settings used to
|
|
8815
|
+
* Returns the link:https://developers.thoughtspot.com/docs/Interface_EmbedConfig[EmbedConfig]
|
|
8816
|
+
* object, which contains the configuration settings used to
|
|
8743
8817
|
* initialize the SDK, including the following:
|
|
8744
8818
|
*
|
|
8745
8819
|
* - `thoughtSpotHost` - ThoughtSpot host URL
|
|
@@ -8748,9 +8822,10 @@ export declare function resetCachedPreauthInfo(): void;
|
|
|
8748
8822
|
* - `customizations` - Style, text, and icon customization settings
|
|
8749
8823
|
* that were applied during the SDK initialization.
|
|
8750
8824
|
*
|
|
8751
|
-
*
|
|
8752
|
-
*
|
|
8825
|
+
* The following JSON output shows the embed configuration
|
|
8826
|
+
* settings returned from the code in the previous example:
|
|
8753
8827
|
*
|
|
8828
|
+
* @example
|
|
8754
8829
|
* ```json
|
|
8755
8830
|
* {
|
|
8756
8831
|
* "thoughtSpotHost": "https://{ThoughtSpot-Host}",
|
|
@@ -8772,7 +8847,7 @@ export declare function resetCachedPreauthInfo(): void;
|
|
|
8772
8847
|
* "authTriggerContainer": "#your-own-div"
|
|
8773
8848
|
* }
|
|
8774
8849
|
* ```
|
|
8775
|
-
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.
|
|
8850
|
+
* @version SDK: 1.19.0 | ThoughtSpot: 9.0.0.cl, 9.0.1.sw, and later
|
|
8776
8851
|
* @group Global methods
|
|
8777
8852
|
*/
|
|
8778
8853
|
export declare const getEmbedConfig: () => EmbedConfig;
|