@thoughtspot/visual-embed-sdk 1.24.0-alpha.5 → 1.24.0-alpha.7
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 +1 -0
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +8 -7
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +26 -0
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +5 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +5 -2
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +23 -7
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/search.d.ts +5 -1
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +4 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js +15 -0
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +8 -2
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +54 -1
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +3 -1
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/react/index.d.ts +1 -1
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +3 -1
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/types.d.ts +90 -8
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +62 -5
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils.d.ts +7 -1
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +20 -1
- package/cjs/src/utils.js.map +1 -1
- package/cjs/src/utils.spec.js +24 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/src/embed/app.d.ts +1 -0
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +5 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +5 -1
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +1 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +90 -8
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils.d.ts +7 -1
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +107 -19
- package/dist/tsembed-react.js +108 -26
- package/dist/tsembed.es.js +107 -19
- package/dist/tsembed.js +108 -26
- package/dist/visual-embed-sdk-react-full.d.ts +99 -9
- package/dist/visual-embed-sdk-react.d.ts +99 -9
- package/dist/visual-embed-sdk.d.ts +99 -9
- package/lib/package.json +1 -1
- package/lib/src/embed/app.d.ts +1 -0
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +8 -7
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +26 -0
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +5 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +6 -3
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +23 -7
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/search.d.ts +5 -1
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +5 -2
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js +15 -0
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +8 -2
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +54 -1
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +2 -2
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/react/index.d.ts +1 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +1 -1
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/types.d.ts +90 -8
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +62 -5
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils.d.ts +7 -1
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +18 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/utils.spec.js +25 -1
- package/lib/src/utils.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +102 -12
- package/package.json +1 -1
- package/src/embed/app.spec.ts +33 -0
- package/src/embed/app.ts +8 -7
- package/src/embed/liveboard.spec.ts +29 -10
- package/src/embed/liveboard.ts +11 -2
- package/src/embed/search.spec.ts +18 -0
- package/src/embed/search.ts +16 -1
- package/src/embed/ts-embed.spec.ts +59 -1
- package/src/embed/ts-embed.ts +8 -2
- package/src/index.ts +4 -0
- package/src/react/index.tsx +2 -0
- package/src/types.ts +173 -90
- package/src/utils.spec.ts +31 -0
- package/src/utils.ts +23 -0
package/dist/tsembed.js
CHANGED
|
@@ -34,6 +34,24 @@
|
|
|
34
34
|
}
|
|
35
35
|
return null;
|
|
36
36
|
};
|
|
37
|
+
/**
|
|
38
|
+
* Construct a runtime parameter override query string from the given option.
|
|
39
|
+
*
|
|
40
|
+
* @param runtimeParameters
|
|
41
|
+
*/
|
|
42
|
+
const getRuntimeParameters = (runtimeParameters) => {
|
|
43
|
+
if (runtimeParameters && runtimeParameters.length) {
|
|
44
|
+
const params = runtimeParameters.map((param, valueIndex) => {
|
|
45
|
+
const index = valueIndex + 1;
|
|
46
|
+
const filterExpr = [];
|
|
47
|
+
filterExpr.push(`param${index}=${encodeURIComponent(param.name)}`);
|
|
48
|
+
filterExpr.push(`paramVal${index}=${encodeURIComponent(param.value)}`);
|
|
49
|
+
return filterExpr.join('&');
|
|
50
|
+
});
|
|
51
|
+
return `${params.join('&')}`;
|
|
52
|
+
}
|
|
53
|
+
return null;
|
|
54
|
+
};
|
|
37
55
|
/**
|
|
38
56
|
* Convert a value to a string representation to be sent as a query
|
|
39
57
|
* parameter to the ThoughtSpot app.
|
|
@@ -352,8 +370,8 @@
|
|
|
352
370
|
*/
|
|
353
371
|
AuthType["Basic"] = "Basic";
|
|
354
372
|
})(exports.AuthType || (exports.AuthType = {}));
|
|
355
|
-
var HomeLeftNavItem;
|
|
356
373
|
(function (HomeLeftNavItem) {
|
|
374
|
+
HomeLeftNavItem["QueryBuilder"] = "query-builder";
|
|
357
375
|
HomeLeftNavItem["Home"] = "insights-home";
|
|
358
376
|
HomeLeftNavItem["Liveboards"] = "liveboards";
|
|
359
377
|
HomeLeftNavItem["Answers"] = "answers";
|
|
@@ -362,7 +380,7 @@
|
|
|
362
380
|
HomeLeftNavItem["Tutorials"] = "tutorials";
|
|
363
381
|
HomeLeftNavItem["Documentation"] = "documentation";
|
|
364
382
|
HomeLeftNavItem["Community"] = "community";
|
|
365
|
-
})(HomeLeftNavItem || (HomeLeftNavItem = {}));
|
|
383
|
+
})(exports.HomeLeftNavItem || (exports.HomeLeftNavItem = {}));
|
|
366
384
|
(function (RuntimeFilterOp) {
|
|
367
385
|
/**
|
|
368
386
|
* Equals
|
|
@@ -421,11 +439,6 @@
|
|
|
421
439
|
*/
|
|
422
440
|
RuntimeFilterOp["IN"] = "IN";
|
|
423
441
|
})(exports.RuntimeFilterOp || (exports.RuntimeFilterOp = {}));
|
|
424
|
-
/**
|
|
425
|
-
* Home page module that can be hide
|
|
426
|
-
*/
|
|
427
|
-
// eslint-disable-next-line no-shadow
|
|
428
|
-
var HomepageModule;
|
|
429
442
|
(function (HomepageModule) {
|
|
430
443
|
/**
|
|
431
444
|
* Search bar
|
|
@@ -451,7 +464,7 @@
|
|
|
451
464
|
* Learning videos
|
|
452
465
|
*/
|
|
453
466
|
HomepageModule["Learning"] = "learning";
|
|
454
|
-
})(HomepageModule || (HomepageModule = {}));
|
|
467
|
+
})(exports.HomepageModule || (exports.HomepageModule = {}));
|
|
455
468
|
(function (EmbedEvent) {
|
|
456
469
|
/**
|
|
457
470
|
* Rendering has initialized.
|
|
@@ -856,21 +869,21 @@
|
|
|
856
869
|
*/
|
|
857
870
|
EmbedEvent["InsertIntoSlide"] = "insertInToSlide";
|
|
858
871
|
/**
|
|
872
|
+
* @hidden
|
|
859
873
|
* Emitted when a user changes any filter on a Liveboard.
|
|
860
|
-
*
|
|
861
874
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
862
875
|
*/
|
|
863
876
|
EmbedEvent["FilterChanged"] = "filterChanged";
|
|
864
877
|
/**
|
|
865
878
|
* Emitted when a user click on Go button in Sage Embed
|
|
866
879
|
*
|
|
867
|
-
* @version SDK : 1.
|
|
880
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
868
881
|
*/
|
|
869
882
|
EmbedEvent["SageEmbedQuery"] = "sageEmbedQuery";
|
|
870
883
|
/**
|
|
871
884
|
* Emitten when a user select data source in Sage Embed
|
|
872
885
|
*
|
|
873
|
-
* @version SDK : 1.
|
|
886
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
874
887
|
*/
|
|
875
888
|
EmbedEvent["SageWorksheetUpdated"] = "sageWorksheetUpdated";
|
|
876
889
|
/**
|
|
@@ -879,6 +892,51 @@
|
|
|
879
892
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
880
893
|
*/
|
|
881
894
|
EmbedEvent["UpdateConnection"] = "updateConnection";
|
|
895
|
+
/**
|
|
896
|
+
* Emitted when name, status (private or public) or filter values of a
|
|
897
|
+
* PersonalisedView is updated.
|
|
898
|
+
*
|
|
899
|
+
* @returns viewName: string
|
|
900
|
+
* @returns viewId: string
|
|
901
|
+
* @returns liveboardId: string
|
|
902
|
+
* @returns isPublic: boolean
|
|
903
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
904
|
+
*/
|
|
905
|
+
EmbedEvent["UpdatePersonalisedView"] = "updatePersonalisedView";
|
|
906
|
+
/**
|
|
907
|
+
* Emitted when a PersonalisedView is saved.
|
|
908
|
+
*
|
|
909
|
+
* @returns viewName: string
|
|
910
|
+
* @returns viewId: string
|
|
911
|
+
* @returns liveboardId: string
|
|
912
|
+
* @returns isPublic: boolean
|
|
913
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
914
|
+
*/
|
|
915
|
+
EmbedEvent["SavePersonalisedView"] = "savePersonalisedView";
|
|
916
|
+
/**
|
|
917
|
+
* Emitted when a Liveboard is reset.
|
|
918
|
+
*
|
|
919
|
+
* @returns viewName: string
|
|
920
|
+
* @returns viewId: string
|
|
921
|
+
* @returns liveboardId: string
|
|
922
|
+
* @returns isPublic: boolean
|
|
923
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
924
|
+
*/
|
|
925
|
+
EmbedEvent["ResetLiveboard"] = "resetLiveboard";
|
|
926
|
+
/**
|
|
927
|
+
* Emitted when a PersonalisedView is deleted.
|
|
928
|
+
*
|
|
929
|
+
* @returns views: string[]
|
|
930
|
+
* @returns liveboardId: string
|
|
931
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
932
|
+
*/
|
|
933
|
+
EmbedEvent["DeletePersonalisedView"] = "deletePersonalisedView";
|
|
934
|
+
/**
|
|
935
|
+
* Emitten when a user creates a new worksheet
|
|
936
|
+
*
|
|
937
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
938
|
+
*/
|
|
939
|
+
EmbedEvent["CreateWorksheet"] = "createWorksheet";
|
|
882
940
|
})(exports.EmbedEvent || (exports.EmbedEvent = {}));
|
|
883
941
|
(function (HostEvent) {
|
|
884
942
|
/**
|
|
@@ -1499,16 +1557,16 @@
|
|
|
1499
1557
|
*/
|
|
1500
1558
|
HostEvent["ResetSearch"] = "resetSearch";
|
|
1501
1559
|
/**
|
|
1560
|
+
* @hidden
|
|
1502
1561
|
* Gets the currents visible and runtime filters applied on a Liveboard
|
|
1503
|
-
*
|
|
1504
1562
|
* @example
|
|
1505
1563
|
* liveboardEmbed.trigger(HostEvent.GetFilters)
|
|
1506
1564
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
1507
1565
|
*/
|
|
1508
1566
|
HostEvent["GetFilters"] = "getFilters";
|
|
1509
1567
|
/**
|
|
1568
|
+
* @hidden
|
|
1510
1569
|
* Updates the visible filters on the Liveboard.
|
|
1511
|
-
*
|
|
1512
1570
|
* @param - filter: filter object containing column name and filter operation and values
|
|
1513
1571
|
* @example
|
|
1514
1572
|
*
|
|
@@ -1661,6 +1719,7 @@
|
|
|
1661
1719
|
Param["Query"] = "query";
|
|
1662
1720
|
Param["HideHomepageLeftNav"] = "hideHomepageLeftNav";
|
|
1663
1721
|
Param["ModularHomeExperienceEnabled"] = "modularHomeExperience";
|
|
1722
|
+
Param["PendoTrackingKey"] = "additionalPendoKey";
|
|
1664
1723
|
})(Param || (Param = {}));
|
|
1665
1724
|
(function (Action) {
|
|
1666
1725
|
/**
|
|
@@ -2460,6 +2519,16 @@
|
|
|
2460
2519
|
* ```
|
|
2461
2520
|
*/
|
|
2462
2521
|
Action["ManageMonitor"] = "ManageMonitor";
|
|
2522
|
+
/**
|
|
2523
|
+
* Action ID for Liveboard Personalised Views dropdown
|
|
2524
|
+
*
|
|
2525
|
+
* @example
|
|
2526
|
+
* ```js
|
|
2527
|
+
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
2528
|
+
* ```
|
|
2529
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2530
|
+
*/
|
|
2531
|
+
Action["PersonalisedViewsDropdown"] = "personalisedViewsDropdown";
|
|
2463
2532
|
})(exports.Action || (exports.Action = {}));
|
|
2464
2533
|
// eslint-disable-next-line no-shadow
|
|
2465
2534
|
var OperationType;
|
|
@@ -11069,7 +11138,7 @@
|
|
|
11069
11138
|
});
|
|
11070
11139
|
}
|
|
11071
11140
|
|
|
11072
|
-
var name="@thoughtspot/visual-embed-sdk";var version="1.24.0-alpha.
|
|
11141
|
+
var name="@thoughtspot/visual-embed-sdk";var version="1.24.0-alpha.7";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",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-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","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","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"};var peerDependencies={react:"> 16.8.0","react-dom":"> 16.8.0"};var dependencies={algoliasearch:"^4.10.5",classnames:"^2.3.1",dompurify:"^2.3.4","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",tslib:"^2.5.3","use-deep-compare-effect":"^1.8.1"};var devDependencies={"@mdx-js/mdx":"^1.6.22","@mdx-js/react":"^1.6.22","@react-icons/all-files":"^4.1.0","@rollup/plugin-commonjs":"^18.0.0","@rollup/plugin-json":"^4.1.0","@rollup/plugin-node-resolve":"^11.2.1","@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/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","current-git-branch":"^1.1.0","dts-bundle":"^0.7.3",eslint:"^7.12.1","eslint-config-airbnb-base":"^14.2.0","eslint-config-prettier":"^6.15.0","eslint-import-resolver-typescript":"^2.3.0","eslint-plugin-import":"^2.22.1","eslint-plugin-prettier":"^3.1.4","eslint-plugin-react-hooks":"^4.2.0","fs-extra":"^10.0.0",gatsby:"3.13.1","gatsby-plugin-algolia":"^0.22.2","gatsby-plugin-catch-links":"^3.1.0","gatsby-plugin-env-variables":"^2.1.0","gatsby-plugin-intl":"^0.3.3","gatsby-plugin-manifest":"^3.2.0","gatsby-plugin-output":"^0.1.3","gatsby-plugin-sass":"6.7.0","gatsby-plugin-sitemap":"^4.10.0","gatsby-source-filesystem":"3.1.0","gatsby-transformer-asciidoc":"2.1.0","gatsby-transformer-rehype":"2.0.0","gh-pages":"^3.1.0","highlight.js":"^10.6.0","html-to-text":"^8.0.0","identity-obj-proxy":"^3.0.0","istanbul-merge":"^1.1.1",jest:"^26.6.3","jest-puppeteer":"^4.4.0",jsdom:"^17.0.0","node-sass":"^8.0.0",prettier:"2.1.2",puppeteer:"^7.0.1",react:"^16.14.0","react-dom":"^16.14.0","react-resizable":"^1.11.0","react-resize-detector":"^6.6.0","react-test-renderer":"^17.0.2","react-use-flexsearch":"^0.1.1",rollup:"2.30.0","rollup-plugin-typescript2":"0.27.3","ts-jest":"^26.5.5","ts-loader":"8.0.4",typedoc:"0.21.6","typedoc-plugin-toc-group":"thoughtspot/typedoc-plugin-toc-group",typescript:"^4.9.4","url-search-params-polyfill":"^8.1.0",util:"^0.12.4"};var author="ThoughtSpot";var email="support@thoughtspot.com";var license="ThoughtSpot Development Tools End User License Agreement";var directories={lib:"lib"};var repository={type:"git",url:"git+https://github.com/thoughtspot/visual-embed-sdk.git"};var publishConfig={registry:"https://registry.npmjs.org"};var keywords=["thoughtspot","everywhere","embed","sdk","analytics"];var bugs={url:"https://github.com/thoughtspot/visual-embed-sdk/issues"};var homepage="https://github.com/thoughtspot/visual-embed-sdk#readme";var globals={window:{}};var pkgInfo = {name:name,version:version,description:description,module:module,main:main,types:types,files:files,exports:exports$1,typesVersions:typesVersions,"size-limit":[{path:"dist/tsembed.js",limit:"40 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};
|
|
11073
11142
|
|
|
11074
11143
|
/**
|
|
11075
11144
|
* Copyright (c) 2022
|
|
@@ -11128,11 +11197,14 @@
|
|
|
11128
11197
|
data: {
|
|
11129
11198
|
customisations: getCustomisations(this.embedConfig, this.viewConfig),
|
|
11130
11199
|
authToken,
|
|
11131
|
-
runtimeFilterParams:
|
|
11200
|
+
runtimeFilterParams: this.viewConfig.excludeRuntimeFiltersfromURL
|
|
11201
|
+
? getRuntimeFilters(this.viewConfig.runtimeFilters)
|
|
11202
|
+
: null,
|
|
11132
11203
|
hiddenHomepageModules: this.viewConfig.hiddenHomepageModules || [],
|
|
11133
11204
|
hostConfig: this.embedConfig.hostConfig,
|
|
11134
11205
|
hiddenHomeLeftNavItems: ((_a = this.viewConfig) === null || _a === void 0 ? void 0 : _a.hiddenHomeLeftNavItems)
|
|
11135
|
-
? (_b = this.viewConfig) === null || _b === void 0 ? void 0 : _b.hiddenHomeLeftNavItems
|
|
11206
|
+
? (_b = this.viewConfig) === null || _b === void 0 ? void 0 : _b.hiddenHomeLeftNavItems
|
|
11207
|
+
: [],
|
|
11136
11208
|
},
|
|
11137
11209
|
});
|
|
11138
11210
|
};
|
|
@@ -11309,6 +11381,9 @@
|
|
|
11309
11381
|
if (this.embedConfig.authType === exports.AuthType.TrustedAuthTokenCookieless) {
|
|
11310
11382
|
queryParams[Param.cookieless] = true;
|
|
11311
11383
|
}
|
|
11384
|
+
if (this.embedConfig.pendoTrackingKey) {
|
|
11385
|
+
queryParams[Param.PendoTrackingKey] = this.embedConfig.pendoTrackingKey;
|
|
11386
|
+
}
|
|
11312
11387
|
const { disabledActions, disabledActionReason, hiddenActions, visibleActions, hiddenTabs, visibleTabs, showAlerts, additionalFlags, locale, customizations, contextMenuTrigger, linkOverride, insertInToSlide, hideLiveboardHeader, showLiveboardDescription, showLiveboardTitle, } = this.viewConfig;
|
|
11313
11388
|
if (Array.isArray(visibleActions) && Array.isArray(hiddenActions)) {
|
|
11314
11389
|
this.handleError('You cannot have both hidden actions and visible actions');
|
|
@@ -11937,8 +12012,8 @@
|
|
|
11937
12012
|
* @param pageId The ID of the page to be embedded.
|
|
11938
12013
|
*/
|
|
11939
12014
|
getIFrameSrc() {
|
|
11940
|
-
const { pageId, path } = this.viewConfig;
|
|
11941
|
-
const pageRoute = this.formatPath(path) || this.getPageRoute(pageId);
|
|
12015
|
+
const { pageId, path, modularHomeExperience } = this.viewConfig;
|
|
12016
|
+
const pageRoute = this.formatPath(path) || this.getPageRoute(pageId, modularHomeExperience);
|
|
11942
12017
|
let url = `${this.getRootIframeSrc()}/${pageRoute}`;
|
|
11943
12018
|
const tsPostHashParams = this.getThoughtSpotPostUrlParams();
|
|
11944
12019
|
url = `${url}${tsPostHashParams}`;
|
|
@@ -11948,21 +12023,22 @@
|
|
|
11948
12023
|
* Gets the ThoughtSpot route of the page for a particular page ID.
|
|
11949
12024
|
*
|
|
11950
12025
|
* @param pageId The identifier for a page in the ThoughtSpot app.
|
|
12026
|
+
* @param modularHomeExperience
|
|
11951
12027
|
*/
|
|
11952
|
-
getPageRoute(pageId) {
|
|
12028
|
+
getPageRoute(pageId, modularHomeExperience = false) {
|
|
11953
12029
|
switch (pageId) {
|
|
11954
12030
|
case exports.Page.Search:
|
|
11955
12031
|
return 'answer';
|
|
11956
12032
|
case exports.Page.Answers:
|
|
11957
|
-
return 'answers';
|
|
12033
|
+
return modularHomeExperience ? 'home/answers' : 'answers';
|
|
11958
12034
|
case exports.Page.Liveboards:
|
|
11959
|
-
return 'pinboards';
|
|
12035
|
+
return modularHomeExperience ? 'home/liveboards' : 'pinboards';
|
|
11960
12036
|
case exports.Page.Pinboards:
|
|
11961
|
-
return 'pinboards';
|
|
12037
|
+
return modularHomeExperience ? 'home/liveboards' : 'pinboards';
|
|
11962
12038
|
case exports.Page.Data:
|
|
11963
12039
|
return 'data/tables';
|
|
11964
12040
|
case exports.Page.SpotIQ:
|
|
11965
|
-
return 'insights/results';
|
|
12041
|
+
return modularHomeExperience ? 'home/spotiq-analysis' : 'insights/results';
|
|
11966
12042
|
case exports.Page.Home:
|
|
11967
12043
|
default:
|
|
11968
12044
|
return 'home';
|
|
@@ -12091,7 +12167,7 @@
|
|
|
12091
12167
|
let params = {};
|
|
12092
12168
|
params[Param.EmbedApp] = true;
|
|
12093
12169
|
params = this.getBaseQueryParams(params);
|
|
12094
|
-
const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, } = this.viewConfig;
|
|
12170
|
+
const { enableVizTransformations, fullHeight, defaultHeight, visibleVizs, liveboardV2, vizId, hideTabPanel, activeTabId, runtimeParameters, } = this.viewConfig;
|
|
12095
12171
|
const preventLiveboardFilterRemoval = this.viewConfig.preventLiveboardFilterRemoval
|
|
12096
12172
|
|| this.viewConfig.preventPinboardFilterRemoval;
|
|
12097
12173
|
if (fullHeight === true) {
|
|
@@ -12119,7 +12195,10 @@
|
|
|
12119
12195
|
if (hideTabPanel) {
|
|
12120
12196
|
params[Param.HideTabPanel] = hideTabPanel;
|
|
12121
12197
|
}
|
|
12122
|
-
|
|
12198
|
+
let queryParams = getQueryParamString(params, true);
|
|
12199
|
+
const parameterQuery = getRuntimeParameters(runtimeParameters || []);
|
|
12200
|
+
if (parameterQuery)
|
|
12201
|
+
queryParams += `&${parameterQuery}`;
|
|
12123
12202
|
return queryParams;
|
|
12124
12203
|
}
|
|
12125
12204
|
getIframeSuffixSrc(liveboardId, vizId, activeTabId) {
|
|
@@ -12243,7 +12322,7 @@
|
|
|
12243
12322
|
}
|
|
12244
12323
|
getEmbedParams() {
|
|
12245
12324
|
var _a;
|
|
12246
|
-
const { hideResults, enableSearchAssist, forceTable, searchOptions, runtimeFilters, dataSource, dataSources, excludeRuntimeFiltersfromURL, dataPanelV2 = false, useLastSelectedSources = false, } = this.viewConfig;
|
|
12325
|
+
const { hideResults, enableSearchAssist, forceTable, searchOptions, runtimeFilters, dataSource, dataSources, excludeRuntimeFiltersfromURL, dataPanelV2 = false, useLastSelectedSources = false, runtimeParameters, } = this.viewConfig;
|
|
12247
12326
|
const queryParams = this.getBaseQueryParams();
|
|
12248
12327
|
queryParams[Param.HideActions] = [
|
|
12249
12328
|
...((_a = queryParams[Param.HideActions]) !== null && _a !== void 0 ? _a : []),
|
|
@@ -12282,6 +12361,9 @@
|
|
|
12282
12361
|
if (queryParamsString) {
|
|
12283
12362
|
query = `?${queryParamsString}`;
|
|
12284
12363
|
}
|
|
12364
|
+
const parameterQuery = getRuntimeParameters(runtimeParameters || []);
|
|
12365
|
+
if (parameterQuery)
|
|
12366
|
+
query += `&${parameterQuery}`;
|
|
12285
12367
|
const filterQuery = getFilterQuery(runtimeFilters || []);
|
|
12286
12368
|
if (filterQuery && !excludeRuntimeFiltersfromURL) {
|
|
12287
12369
|
query += `&${filterQuery}`;
|
|
@@ -119,7 +119,7 @@ export function useEmbedRef<T extends EmbedComponent>(): React.MutableRefObject<
|
|
|
119
119
|
* @summary ThoughtSpot Visual Embed SDK
|
|
120
120
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
121
121
|
*/
|
|
122
|
-
export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
|
|
122
|
+
export { init, logout, prefetch, executeTML, exportTML, getEmbedConfig as getInitConfig, getSessionInfo, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, };
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
125
|
* @group Embed components
|
|
@@ -369,6 +369,10 @@ export interface SearchViewConfig extends ViewConfig {
|
|
|
369
369
|
* @version: SDK: 1.24.0
|
|
370
370
|
*/
|
|
371
371
|
useLastSelectedSources?: boolean;
|
|
372
|
+
/**
|
|
373
|
+
* The list of parameter override to apply to a search answer.
|
|
374
|
+
*/
|
|
375
|
+
runtimeParameters?: RuntimeParameter[];
|
|
372
376
|
}
|
|
373
377
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
374
378
|
/**
|
|
@@ -673,6 +677,10 @@ export interface LiveboardViewConfig extends ViewConfig {
|
|
|
673
677
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
|
|
674
678
|
*/
|
|
675
679
|
hideTabPanel?: boolean;
|
|
680
|
+
/**
|
|
681
|
+
* The list of parameter override to apply to a Liveboard.
|
|
682
|
+
*/
|
|
683
|
+
runtimeParameters?: RuntimeParameter[];
|
|
676
684
|
}
|
|
677
685
|
/**
|
|
678
686
|
* Embed a ThoughtSpot Liveboard or a Thoughtspot visualization. When rendered it already
|
|
@@ -1202,6 +1210,7 @@ export declare enum AuthType {
|
|
|
1202
1210
|
Basic = "Basic"
|
|
1203
1211
|
}
|
|
1204
1212
|
export declare enum HomeLeftNavItem {
|
|
1213
|
+
QueryBuilder = "query-builder",
|
|
1205
1214
|
Home = "insights-home",
|
|
1206
1215
|
Liveboards = "liveboards",
|
|
1207
1216
|
Answers = "answers",
|
|
@@ -1516,12 +1525,21 @@ export interface EmbedConfig {
|
|
|
1516
1525
|
blockNonEmbedFullAppAccess?: boolean;
|
|
1517
1526
|
/**
|
|
1518
1527
|
* Host config incase embedded app is inside TS app itself
|
|
1528
|
+
*
|
|
1529
|
+
* @hidden
|
|
1519
1530
|
*/
|
|
1520
1531
|
hostConfig?: {
|
|
1521
1532
|
hostUserGuid: string;
|
|
1522
1533
|
hostClusterId: string;
|
|
1523
1534
|
hostClusterName: string;
|
|
1524
1535
|
};
|
|
1536
|
+
/**
|
|
1537
|
+
* Pendo API key to enable Pendo tracking to your own subscription, the key
|
|
1538
|
+
* is added as an additional key to the embed, as per this [doc](https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions).
|
|
1539
|
+
*
|
|
1540
|
+
* @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
|
|
1541
|
+
*/
|
|
1542
|
+
pendoTrackingKey?: string;
|
|
1525
1543
|
}
|
|
1526
1544
|
export interface LayoutConfig {
|
|
1527
1545
|
}
|
|
@@ -1738,6 +1756,7 @@ export interface ViewConfig {
|
|
|
1738
1756
|
/**
|
|
1739
1757
|
* Hide the home page modules
|
|
1740
1758
|
* eg: hiddenHomepageModules = [HomepageModule.MyLibrary]
|
|
1759
|
+
*
|
|
1741
1760
|
* @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
1742
1761
|
*/
|
|
1743
1762
|
hiddenHomepageModules?: HomepageModule[];
|
|
@@ -1765,6 +1784,7 @@ export interface ViewConfig {
|
|
|
1765
1784
|
* There are 8 home nav list items, we will send those item as list
|
|
1766
1785
|
* which we want to hide for TSE.
|
|
1767
1786
|
* eg: hiddenHomeLeftNavItems = [HomeLeftNavItem.Home] to hide home.
|
|
1787
|
+
*
|
|
1768
1788
|
* @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
1769
1789
|
*/
|
|
1770
1790
|
hiddenHomeLeftNavItems?: HomeLeftNavItem[];
|
|
@@ -1928,6 +1948,20 @@ export interface RuntimeFilter {
|
|
|
1928
1948
|
*/
|
|
1929
1949
|
values: (number | boolean | string)[];
|
|
1930
1950
|
}
|
|
1951
|
+
/**
|
|
1952
|
+
* A filter that can be applied to ThoughtSpot answers, Liveboards, or
|
|
1953
|
+
* visualizations at runtime.
|
|
1954
|
+
*/
|
|
1955
|
+
export interface RuntimeParameter {
|
|
1956
|
+
/**
|
|
1957
|
+
* The name of the runtime parameter to filter on (case-sensitive)
|
|
1958
|
+
*/
|
|
1959
|
+
name: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* Values
|
|
1962
|
+
*/
|
|
1963
|
+
value: number | boolean | string;
|
|
1964
|
+
}
|
|
1931
1965
|
/**
|
|
1932
1966
|
* Event types emitted by the embedded ThoughtSpot application.
|
|
1933
1967
|
*
|
|
@@ -2352,21 +2386,21 @@ export declare enum EmbedEvent {
|
|
|
2352
2386
|
*/
|
|
2353
2387
|
InsertIntoSlide = "insertInToSlide",
|
|
2354
2388
|
/**
|
|
2389
|
+
* @hidden
|
|
2355
2390
|
* Emitted when a user changes any filter on a Liveboard.
|
|
2356
|
-
*
|
|
2357
2391
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
2358
2392
|
*/
|
|
2359
2393
|
FilterChanged = "filterChanged",
|
|
2360
2394
|
/**
|
|
2361
2395
|
* Emitted when a user click on Go button in Sage Embed
|
|
2362
2396
|
*
|
|
2363
|
-
* @version SDK : 1.
|
|
2397
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2364
2398
|
*/
|
|
2365
2399
|
SageEmbedQuery = "sageEmbedQuery",
|
|
2366
2400
|
/**
|
|
2367
2401
|
* Emitten when a user select data source in Sage Embed
|
|
2368
2402
|
*
|
|
2369
|
-
* @version SDK : 1.
|
|
2403
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2370
2404
|
*/
|
|
2371
2405
|
SageWorksheetUpdated = "sageWorksheetUpdated",
|
|
2372
2406
|
/**
|
|
@@ -2374,7 +2408,52 @@ export declare enum EmbedEvent {
|
|
|
2374
2408
|
*
|
|
2375
2409
|
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2376
2410
|
*/
|
|
2377
|
-
UpdateConnection = "updateConnection"
|
|
2411
|
+
UpdateConnection = "updateConnection",
|
|
2412
|
+
/**
|
|
2413
|
+
* Emitted when name, status (private or public) or filter values of a
|
|
2414
|
+
* PersonalisedView is updated.
|
|
2415
|
+
*
|
|
2416
|
+
* @returns viewName: string
|
|
2417
|
+
* @returns viewId: string
|
|
2418
|
+
* @returns liveboardId: string
|
|
2419
|
+
* @returns isPublic: boolean
|
|
2420
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2421
|
+
*/
|
|
2422
|
+
UpdatePersonalisedView = "updatePersonalisedView",
|
|
2423
|
+
/**
|
|
2424
|
+
* Emitted when a PersonalisedView is saved.
|
|
2425
|
+
*
|
|
2426
|
+
* @returns viewName: string
|
|
2427
|
+
* @returns viewId: string
|
|
2428
|
+
* @returns liveboardId: string
|
|
2429
|
+
* @returns isPublic: boolean
|
|
2430
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2431
|
+
*/
|
|
2432
|
+
SavePersonalisedView = "savePersonalisedView",
|
|
2433
|
+
/**
|
|
2434
|
+
* Emitted when a Liveboard is reset.
|
|
2435
|
+
*
|
|
2436
|
+
* @returns viewName: string
|
|
2437
|
+
* @returns viewId: string
|
|
2438
|
+
* @returns liveboardId: string
|
|
2439
|
+
* @returns isPublic: boolean
|
|
2440
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2441
|
+
*/
|
|
2442
|
+
ResetLiveboard = "resetLiveboard",
|
|
2443
|
+
/**
|
|
2444
|
+
* Emitted when a PersonalisedView is deleted.
|
|
2445
|
+
*
|
|
2446
|
+
* @returns views: string[]
|
|
2447
|
+
* @returns liveboardId: string
|
|
2448
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
2449
|
+
*/
|
|
2450
|
+
DeletePersonalisedView = "deletePersonalisedView",
|
|
2451
|
+
/**
|
|
2452
|
+
* Emitten when a user creates a new worksheet
|
|
2453
|
+
*
|
|
2454
|
+
* @version SDK : 1.27.0 | Thoughtspot: 9.8.0.cl
|
|
2455
|
+
*/
|
|
2456
|
+
CreateWorksheet = "createWorksheet"
|
|
2378
2457
|
}
|
|
2379
2458
|
/**
|
|
2380
2459
|
* Event types that can be triggered by the host application
|
|
@@ -3017,16 +3096,16 @@ export declare enum HostEvent {
|
|
|
3017
3096
|
*/
|
|
3018
3097
|
ResetSearch = "resetSearch",
|
|
3019
3098
|
/**
|
|
3099
|
+
* @hidden
|
|
3020
3100
|
* Gets the currents visible and runtime filters applied on a Liveboard
|
|
3021
|
-
*
|
|
3022
3101
|
* @example
|
|
3023
3102
|
* liveboardEmbed.trigger(HostEvent.GetFilters)
|
|
3024
3103
|
* @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
|
|
3025
3104
|
*/
|
|
3026
3105
|
GetFilters = "getFilters",
|
|
3027
3106
|
/**
|
|
3107
|
+
* @hidden
|
|
3028
3108
|
* Updates the visible filters on the Liveboard.
|
|
3029
|
-
*
|
|
3030
3109
|
* @param - filter: filter object containing column name and filter operation and values
|
|
3031
3110
|
* @example
|
|
3032
3111
|
*
|
|
@@ -3179,7 +3258,8 @@ export declare enum Param {
|
|
|
3179
3258
|
WorksheetId = "worksheet",
|
|
3180
3259
|
Query = "query",
|
|
3181
3260
|
HideHomepageLeftNav = "hideHomepageLeftNav",
|
|
3182
|
-
ModularHomeExperienceEnabled = "modularHomeExperience"
|
|
3261
|
+
ModularHomeExperienceEnabled = "modularHomeExperience",
|
|
3262
|
+
PendoTrackingKey = "additionalPendoKey"
|
|
3183
3263
|
}
|
|
3184
3264
|
/**
|
|
3185
3265
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -4005,7 +4085,17 @@ export declare enum Action {
|
|
|
4005
4085
|
* disabledActions: [Action.ManageMonitor]
|
|
4006
4086
|
* ```
|
|
4007
4087
|
*/
|
|
4008
|
-
ManageMonitor = "ManageMonitor"
|
|
4088
|
+
ManageMonitor = "ManageMonitor",
|
|
4089
|
+
/**
|
|
4090
|
+
* Action ID for Liveboard Personalised Views dropdown
|
|
4091
|
+
*
|
|
4092
|
+
* @example
|
|
4093
|
+
* ```js
|
|
4094
|
+
* disabledActions: [Action.PersonalisedViewsDropdown]
|
|
4095
|
+
* ```
|
|
4096
|
+
* @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
4097
|
+
*/
|
|
4098
|
+
PersonalisedViewsDropdown = "personalisedViewsDropdown"
|
|
4009
4099
|
}
|
|
4010
4100
|
export interface SessionInterface {
|
|
4011
4101
|
sessionId: string;
|