@thoughtspot/visual-embed-sdk 1.36.2 → 1.36.4
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/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +10 -3
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/embed/app.d.ts +14 -0
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +5 -2
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +17 -0
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +4 -0
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +27 -1
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/cjs/src/embed/bodyless-conversation.js +1 -1
- package/cjs/src/embed/bodyless-conversation.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +1 -1
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +1 -1
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +5 -4
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +6 -3
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +4 -5
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +11 -11
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +1 -1
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js +1 -1
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +1 -1
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +4 -3
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +25 -16
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +71 -5
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/errors.d.ts +1 -0
- package/cjs/src/errors.d.ts.map +1 -1
- package/cjs/src/errors.js +1 -0
- package/cjs/src/errors.js.map +1 -1
- package/cjs/src/react/all-types-export.d.ts +1 -1
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +2 -1
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/react/index.d.ts +16 -0
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +25 -2
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/types.d.ts +85 -66
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +78 -59
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/with-resolvers-polyfill.d.ts +1 -0
- package/cjs/src/utils/with-resolvers-polyfill.d.ts.map +1 -0
- package/cjs/src/utils/with-resolvers-polyfill.js +12 -0
- package/cjs/src/utils/with-resolvers-polyfill.js.map +1 -0
- package/cjs/src/utils.d.ts +27 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +45 -1
- package/cjs/src/utils.js.map +1 -1
- package/cjs/src/utils.spec.js +15 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/{index-B3hd6DTM.js → index-NZYq1Tu3.js} +1 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +14 -0
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +4 -0
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +1 -1
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +6 -3
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +4 -3
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/dist/src/errors.d.ts +1 -0
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/react/all-types-export.d.ts +1 -1
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +16 -0
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +85 -66
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/with-resolvers-polyfill.d.ts +1 -0
- package/dist/src/utils/with-resolvers-polyfill.d.ts.map +1 -0
- package/dist/src/utils.d.ts +27 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +458 -108
- package/dist/tsembed-react.js +456 -105
- package/dist/tsembed.es.js +197 -98
- package/dist/tsembed.js +196 -97
- package/dist/visual-embed-sdk-react-full.d.ts +1324 -1269
- package/dist/visual-embed-sdk-react.d.ts +814 -759
- package/dist/visual-embed-sdk.d.ts +113 -72
- package/lib/package.json +1 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +10 -3
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/embed/app.d.ts +14 -0
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +5 -2
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +17 -0
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +4 -0
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +24 -1
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
- package/lib/src/embed/bodyless-conversation.js +1 -1
- package/lib/src/embed/bodyless-conversation.js.map +1 -1
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +1 -1
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +1 -1
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +5 -4
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +6 -3
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +4 -5
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +11 -11
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +1 -1
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +1 -1
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +1 -1
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +4 -3
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +26 -17
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +71 -5
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/errors.d.ts +1 -0
- package/lib/src/errors.d.ts.map +1 -1
- package/lib/src/errors.js +1 -0
- package/lib/src/errors.js.map +1 -1
- package/lib/src/react/all-types-export.d.ts +1 -1
- package/lib/src/react/all-types-export.d.ts.map +1 -1
- package/lib/src/react/all-types-export.js +1 -1
- package/lib/src/react/all-types-export.js.map +1 -1
- package/lib/src/react/index.d.ts +16 -0
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +23 -1
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/types.d.ts +85 -66
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +78 -59
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/with-resolvers-polyfill.d.ts +1 -0
- package/lib/src/utils/with-resolvers-polyfill.d.ts.map +1 -0
- package/lib/src/utils/with-resolvers-polyfill.js +12 -0
- package/lib/src/utils/with-resolvers-polyfill.js.map +1 -0
- package/lib/src/utils.d.ts +27 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +41 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/utils.spec.js +16 -1
- package/lib/src/utils.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +114 -73
- package/package.json +1 -1
- package/src/authToken.ts +11 -3
- package/src/embed/app.spec.ts +27 -0
- package/src/embed/app.ts +21 -1
- package/src/embed/base.ts +41 -1
- package/src/embed/bodyless-conversation.ts +2 -1
- package/src/embed/conversation.ts +2 -1
- package/src/embed/embedConfig.ts +5 -4
- package/src/embed/liveboard.spec.ts +11 -11
- package/src/embed/liveboard.ts +9 -7
- package/src/embed/sage.ts +1 -2
- package/src/embed/search-bar.tsx +1 -2
- package/src/embed/search.ts +1 -2
- package/src/embed/ts-embed.spec.ts +83 -5
- package/src/embed/ts-embed.ts +33 -17
- package/src/errors.ts +1 -0
- package/src/react/all-types-export.ts +1 -0
- package/src/react/index.tsx +27 -2
- package/src/types.ts +89 -70
- package/src/utils/with-resolvers-polyfill.ts +11 -0
- package/src/utils.spec.ts +21 -0
- package/src/utils.ts +52 -0
- package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
- package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
- package/cjs/src/embed/searchEmbed-basic-auth.spec.js +0 -104
- package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +0 -1
- package/cjs/src/hostEventsTypeMapping.d.ts +0 -2
- package/cjs/src/hostEventsTypeMapping.d.ts.map +0 -1
- package/cjs/src/hostEventsTypeMapping.js +0 -4
- package/cjs/src/hostEventsTypeMapping.js.map +0 -1
- package/cjs/src/utils/embedApi/contracts.d.ts +0 -101
- package/cjs/src/utils/embedApi/contracts.d.ts.map +0 -1
- package/cjs/src/utils/embedApi/contracts.js +0 -17
- package/cjs/src/utils/embedApi/contracts.js.map +0 -1
- package/cjs/src/utils/embedApi/embedApiClient.d.ts +0 -12
- package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
- package/cjs/src/utils/embedApi/embedApiClient.js +0 -46
- package/cjs/src/utils/embedApi/embedApiClient.js.map +0 -1
- package/cjs/src/utils/embedApi/processEmbedApi.d.ts +0 -9
- package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
- package/cjs/src/utils/embedApi/processEmbedApi.js +0 -18
- package/cjs/src/utils/embedApi/processEmbedApi.js.map +0 -1
- package/dist/index-BBBimG1x.js +0 -7370
- package/dist/index-BGnxP5NY.js +0 -7370
- package/dist/index-CENLvayL.js +0 -7370
- package/dist/index-CR5u7BMC.js +0 -7370
- package/dist/index-CbltIawo.js +0 -7370
- package/dist/index-CoQfqaHj.js +0 -7370
- package/dist/index-CzwzS0P4.js +0 -7370
- package/dist/index-D-9WUCUl.js +0 -7370
- package/dist/index-DFwi_pV_.js +0 -7370
- package/dist/index-DOIjN0N_.js +0 -7370
- package/dist/index-DYBx8SuE.js +0 -7370
- package/dist/index-DaLHJaLd.js +0 -7370
- package/dist/index-DnJX-gN2.js +0 -7370
- package/dist/index-DpuhnTj2.js +0 -7370
- package/dist/index-IDmSUe93.js +0 -7370
- package/dist/index-nWevLycs.js +0 -7370
- package/dist/index-vxW97_xb.js +0 -7370
- package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
- package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
- package/dist/src/hostEventsTypeMapping.d.ts +0 -2
- package/dist/src/hostEventsTypeMapping.d.ts.map +0 -1
- package/dist/src/utils/embedApi/contracts.d.ts +0 -101
- package/dist/src/utils/embedApi/contracts.d.ts.map +0 -1
- package/dist/src/utils/embedApi/embedApiClient.d.ts +0 -12
- package/dist/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
- package/dist/src/utils/embedApi/processEmbedApi.d.ts +0 -9
- package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
- package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
- package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
- package/lib/src/embed/searchEmbed-basic-auth.spec.js +0 -101
- package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +0 -1
- package/lib/src/hostEventsTypeMapping.d.ts +0 -2
- package/lib/src/hostEventsTypeMapping.d.ts.map +0 -1
- package/lib/src/hostEventsTypeMapping.js +0 -2
- package/lib/src/hostEventsTypeMapping.js.map +0 -1
- package/lib/src/utils/embedApi/contracts.d.ts +0 -101
- package/lib/src/utils/embedApi/contracts.d.ts.map +0 -1
- package/lib/src/utils/embedApi/contracts.js +0 -14
- package/lib/src/utils/embedApi/contracts.js.map +0 -1
- package/lib/src/utils/embedApi/embedApiClient.d.ts +0 -12
- package/lib/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
- package/lib/src/utils/embedApi/embedApiClient.js +0 -42
- package/lib/src/utils/embedApi/embedApiClient.js.map +0 -1
- package/lib/src/utils/embedApi/processEmbedApi.d.ts +0 -9
- package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
- package/lib/src/utils/embedApi/processEmbedApi.js +0 -14
- package/lib/src/utils/embedApi/processEmbedApi.js.map +0 -1
|
@@ -137,6 +137,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
137
137
|
* ```
|
|
138
138
|
*/
|
|
139
139
|
disableProfileAndHelp?: boolean;
|
|
140
|
+
/**
|
|
141
|
+
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
142
|
+
* @default true
|
|
143
|
+
* Whether the help menu in the top nav bar should be served
|
|
144
|
+
* from Pendo or ThoughtSpot's internal help items.
|
|
145
|
+
* @example
|
|
146
|
+
* ```js
|
|
147
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
148
|
+
* ... // other options
|
|
149
|
+
* enablePendoHelp: false,
|
|
150
|
+
* });
|
|
151
|
+
* ```
|
|
152
|
+
*/
|
|
153
|
+
enablePendoHelp?: boolean;
|
|
140
154
|
/**
|
|
141
155
|
* Control the visibility of the application switcher button on the nav-bar.
|
|
142
156
|
* By default, the application switcher is shown.
|
|
@@ -512,6 +526,7 @@ export class AppEmbed extends V1Embed {
|
|
|
512
526
|
render(): Promise<AppEmbed>;
|
|
513
527
|
}
|
|
514
528
|
|
|
529
|
+
import '../utils/with-resolvers-polyfill';
|
|
515
530
|
export interface executeTMLInput {
|
|
516
531
|
metadata_tmls: string[];
|
|
517
532
|
import_policy?: 'PARTIAL' | 'ALL_OR_NONE' | 'VALIDATE_ONLY';
|
|
@@ -546,6 +561,9 @@ export const handleAuth: () => Promise<boolean>;
|
|
|
546
561
|
export const prefetch: (url?: string, prefetchFeatures?: PrefetchFeatures[], additionalFlags?: {
|
|
547
562
|
[key: string]: string | number | boolean;
|
|
548
563
|
}) => void;
|
|
564
|
+
export const createAndSetInitPromise: () => void;
|
|
565
|
+
export const getInitPromise: () => Promise<ReturnType<typeof init>>;
|
|
566
|
+
export const getIsInitCalled: () => boolean;
|
|
549
567
|
/**
|
|
550
568
|
* Initializes the Visual Embed SDK globally and perform
|
|
551
569
|
* authentication if applicable. This function needs to be called before any ThoughtSpot
|
|
@@ -915,7 +933,10 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
915
933
|
*/
|
|
916
934
|
showPreviewLoader?: boolean;
|
|
917
935
|
/**
|
|
918
|
-
*
|
|
936
|
+
* Enables or disables the compact header feature on a Liveboard.
|
|
937
|
+
* Compact Liveboard header is turned off by default on Liveboards in
|
|
938
|
+
* ThoughtSpot Embedded apps.
|
|
939
|
+
*
|
|
919
940
|
* @type {boolean}
|
|
920
941
|
* @default false
|
|
921
942
|
* @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
|
|
@@ -1032,7 +1053,7 @@ export class LiveboardEmbed extends V1Embed {
|
|
|
1032
1053
|
*/
|
|
1033
1054
|
protected getEmbedParams(): string;
|
|
1034
1055
|
protected beforePrerenderVisible(): void;
|
|
1035
|
-
protected handleRenderForPrerender():
|
|
1056
|
+
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
1036
1057
|
/**
|
|
1037
1058
|
* Triggers an event to the embedded app
|
|
1038
1059
|
* @param {HostEvent} messageType The event type
|
|
@@ -2106,9 +2127,9 @@ export type DOMSelector = string | HTMLElement;
|
|
|
2106
2127
|
export interface customCssInterface {
|
|
2107
2128
|
/**
|
|
2108
2129
|
* The custom css variables, which can be set.
|
|
2109
|
-
* The
|
|
2130
|
+
* The variables are available in the {@link CustomCssVariables}
|
|
2110
2131
|
* interface. For more information, see
|
|
2111
|
-
* link:https://developers.thoughtspot.com/docs/css-variables-reference
|
|
2132
|
+
* link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
|
|
2112
2133
|
*/
|
|
2113
2134
|
variables?: CustomCssVariables;
|
|
2114
2135
|
/**
|
|
@@ -2635,7 +2656,7 @@ export interface ViewConfig {
|
|
|
2635
2656
|
*/
|
|
2636
2657
|
showAlerts?: boolean;
|
|
2637
2658
|
/**
|
|
2638
|
-
* The list of runtime filters to apply to a search
|
|
2659
|
+
* The list of runtime filters to apply to a search Answer,
|
|
2639
2660
|
* visualization, or Liveboard.
|
|
2640
2661
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2641
2662
|
* @example
|
|
@@ -2654,7 +2675,7 @@ export interface ViewConfig {
|
|
|
2654
2675
|
*/
|
|
2655
2676
|
runtimeFilters?: RuntimeFilter[];
|
|
2656
2677
|
/**
|
|
2657
|
-
* The list of parameter override to apply to a search
|
|
2678
|
+
* The list of parameter override to apply to a search Answer,
|
|
2658
2679
|
* visualization, or Liveboard.
|
|
2659
2680
|
* @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
2660
2681
|
* @example
|
|
@@ -2672,7 +2693,7 @@ export interface ViewConfig {
|
|
|
2672
2693
|
*/
|
|
2673
2694
|
runtimeParameters?: RuntimeParameter[];
|
|
2674
2695
|
/**
|
|
2675
|
-
* The locale
|
|
2696
|
+
* The locale settings to apply to the embedded view.
|
|
2676
2697
|
* @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
|
|
2677
2698
|
* @example
|
|
2678
2699
|
* ```js
|
|
@@ -2739,7 +2760,7 @@ export interface ViewConfig {
|
|
|
2739
2760
|
*/
|
|
2740
2761
|
contextMenuTrigger?: ContextMenuTriggerOptions;
|
|
2741
2762
|
/**
|
|
2742
|
-
* Flag to override
|
|
2763
|
+
* Flag to override the *Open Link in New Tab* context menu option.
|
|
2743
2764
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
|
|
2744
2765
|
* @example
|
|
2745
2766
|
* ```js
|
|
@@ -2878,7 +2899,7 @@ export interface ViewConfig {
|
|
|
2878
2899
|
*/
|
|
2879
2900
|
preRenderId?: string;
|
|
2880
2901
|
/**
|
|
2881
|
-
* Determines
|
|
2902
|
+
* Determines if the PreRender component should dynamically track the size
|
|
2882
2903
|
* of its embedding element and adjust its own size accordingly.
|
|
2883
2904
|
* Enabling this option allows the PreRender component to automatically adapt
|
|
2884
2905
|
* its dimensions based on changes to the size of the embedding element.
|
|
@@ -3250,8 +3271,8 @@ export enum EmbedEvent {
|
|
|
3250
3271
|
*/
|
|
3251
3272
|
Load = "load",
|
|
3252
3273
|
/**
|
|
3253
|
-
* Data pertaining to
|
|
3254
|
-
* @return data - The
|
|
3274
|
+
* Data pertaining to an Answer or Liveboard is received
|
|
3275
|
+
* @return data - The Answer or Liveboard data
|
|
3255
3276
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
|
|
3256
3277
|
* @example
|
|
3257
3278
|
*```js
|
|
@@ -3425,7 +3446,7 @@ export enum EmbedEvent {
|
|
|
3425
3446
|
*/
|
|
3426
3447
|
Alert = "alert",
|
|
3427
3448
|
/**
|
|
3428
|
-
* The ThoughtSpot
|
|
3449
|
+
* The ThoughtSpot authentication session has expired.
|
|
3429
3450
|
* @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
|
|
3430
3451
|
* @example
|
|
3431
3452
|
*```js
|
|
@@ -3495,7 +3516,7 @@ export enum EmbedEvent {
|
|
|
3495
3516
|
/**
|
|
3496
3517
|
* Emitted when the embed does not have cookie access. This happens
|
|
3497
3518
|
* when Safari and other Web browsers block third-party cookies
|
|
3498
|
-
* are blocked by default. `NoCookieAccess` can trigger
|
|
3519
|
+
* are blocked by default. `NoCookieAccess` can trigger.
|
|
3499
3520
|
* @example
|
|
3500
3521
|
*```js
|
|
3501
3522
|
* appEmbed.on(EmbedEvent.NoCookieAccess)
|
|
@@ -3583,7 +3604,7 @@ export enum EmbedEvent {
|
|
|
3583
3604
|
*/
|
|
3584
3605
|
Save = "save",
|
|
3585
3606
|
/**
|
|
3586
|
-
* Emitted when the download action is triggered on an
|
|
3607
|
+
* Emitted when the download action is triggered on an Answer.
|
|
3587
3608
|
*
|
|
3588
3609
|
* **Note**: This event is deprecated in v1.21.0.
|
|
3589
3610
|
* To fire an event when a download action is initiated on a chart or table,
|
|
@@ -3599,7 +3620,7 @@ export enum EmbedEvent {
|
|
|
3599
3620
|
*/
|
|
3600
3621
|
Download = "download",
|
|
3601
3622
|
/**
|
|
3602
|
-
* Emitted when the download action is triggered on an
|
|
3623
|
+
* Emitted when the download action is triggered on an Answer.
|
|
3603
3624
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
|
|
3604
3625
|
* @example
|
|
3605
3626
|
*```js
|
|
@@ -3613,7 +3634,7 @@ export enum EmbedEvent {
|
|
|
3613
3634
|
*/
|
|
3614
3635
|
DownloadAsPng = "downloadAsPng",
|
|
3615
3636
|
/**
|
|
3616
|
-
* Emitted when the Download as PDF action is triggered on an
|
|
3637
|
+
* Emitted when the Download as PDF action is triggered on an Answer
|
|
3617
3638
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3618
3639
|
* @example
|
|
3619
3640
|
*```js
|
|
@@ -3627,7 +3648,7 @@ export enum EmbedEvent {
|
|
|
3627
3648
|
*/
|
|
3628
3649
|
DownloadAsPdf = "downloadAsPdf",
|
|
3629
3650
|
/**
|
|
3630
|
-
* Emitted when the Download as CSV action is triggered on an
|
|
3651
|
+
* Emitted when the Download as CSV action is triggered on an Answer.
|
|
3631
3652
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3632
3653
|
* @example
|
|
3633
3654
|
*```js
|
|
@@ -3641,7 +3662,7 @@ export enum EmbedEvent {
|
|
|
3641
3662
|
*/
|
|
3642
3663
|
DownloadAsCsv = "downloadAsCsv",
|
|
3643
3664
|
/**
|
|
3644
|
-
* Emitted when the Download as XLSX action is triggered on an
|
|
3665
|
+
* Emitted when the Download as XLSX action is triggered on an Answer.
|
|
3645
3666
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3646
3667
|
* @example
|
|
3647
3668
|
*```js
|
|
@@ -3669,7 +3690,8 @@ export enum EmbedEvent {
|
|
|
3669
3690
|
*/
|
|
3670
3691
|
AnswerDelete = "answerDelete",
|
|
3671
3692
|
/**
|
|
3672
|
-
* Emitted when
|
|
3693
|
+
* Emitted when a user initiates the Pin action to
|
|
3694
|
+
* add an Answer to a Liveboard.
|
|
3673
3695
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3674
3696
|
* @example
|
|
3675
3697
|
*```js
|
|
@@ -3807,7 +3829,7 @@ export enum EmbedEvent {
|
|
|
3807
3829
|
*/
|
|
3808
3830
|
SaveAsView = "saveAsView",
|
|
3809
3831
|
/**
|
|
3810
|
-
* Emitted when the user creates a copy of an Answer
|
|
3832
|
+
* Emitted when the user creates a copy of an Answer.
|
|
3811
3833
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3812
3834
|
* @example
|
|
3813
3835
|
*```js
|
|
@@ -3821,7 +3843,7 @@ export enum EmbedEvent {
|
|
|
3821
3843
|
*/
|
|
3822
3844
|
CopyAEdit = "copyAEdit",
|
|
3823
3845
|
/**
|
|
3824
|
-
* Emitted when a user clicks Show underlying data on an Answer
|
|
3846
|
+
* Emitted when a user clicks *Show underlying data* on an Answer.
|
|
3825
3847
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3826
3848
|
* @example
|
|
3827
3849
|
*```js
|
|
@@ -3832,7 +3854,7 @@ export enum EmbedEvent {
|
|
|
3832
3854
|
*/
|
|
3833
3855
|
ShowUnderlyingData = "showUnderlyingData",
|
|
3834
3856
|
/**
|
|
3835
|
-
* Emitted when an
|
|
3857
|
+
* Emitted when an Answer is switched to a chart or table view.
|
|
3836
3858
|
* @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
|
|
3837
3859
|
* @example
|
|
3838
3860
|
*```js
|
|
@@ -3966,11 +3988,12 @@ export enum EmbedEvent {
|
|
|
3966
3988
|
*/
|
|
3967
3989
|
CopyLink = "embedDocument",
|
|
3968
3990
|
/**
|
|
3969
|
-
* Emitted when a user interacts with cross filters on a
|
|
3991
|
+
* Emitted when a user interacts with cross filters on a
|
|
3992
|
+
* visualization or Liveboard.
|
|
3970
3993
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
3971
3994
|
* @example
|
|
3972
3995
|
*```js
|
|
3973
|
-
* liveboardEmbed.
|
|
3996
|
+
* liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
|
|
3974
3997
|
* vizId: '730496d6-6903-4601-937e-2c691821af3c'})
|
|
3975
3998
|
*```
|
|
3976
3999
|
*/
|
|
@@ -4064,8 +4087,8 @@ export enum EmbedEvent {
|
|
|
4064
4087
|
*/
|
|
4065
4088
|
DeletePersonalisedView = "deletePersonalisedView",
|
|
4066
4089
|
/**
|
|
4067
|
-
* Emitted when a user creates a
|
|
4068
|
-
* @version SDK : 1.27.0 | ThoughtSpot
|
|
4090
|
+
* Emitted when a user creates a Worksheet.
|
|
4091
|
+
* @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
4069
4092
|
*/
|
|
4070
4093
|
CreateWorksheet = "createWorksheet",
|
|
4071
4094
|
/**
|
|
@@ -4078,8 +4101,8 @@ export enum EmbedEvent {
|
|
|
4078
4101
|
*/
|
|
4079
4102
|
AskSageInit = "AskSageInit",
|
|
4080
4103
|
/**
|
|
4081
|
-
* Emitted when a
|
|
4082
|
-
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
|
|
4104
|
+
* Emitted when a Liveboard or visualization is renamed.
|
|
4105
|
+
* @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
|
|
4083
4106
|
*/
|
|
4084
4107
|
Rename = "rename",
|
|
4085
4108
|
/**
|
|
@@ -4143,8 +4166,7 @@ export enum EmbedEvent {
|
|
|
4143
4166
|
OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
|
|
4144
4167
|
/**
|
|
4145
4168
|
* Emitted when parameter changes in an Answer
|
|
4146
|
-
* or Liveboard
|
|
4147
|
-
*
|
|
4169
|
+
* or Liveboard.
|
|
4148
4170
|
* ```js
|
|
4149
4171
|
* liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
|
|
4150
4172
|
* console.log('payload', payload);
|
|
@@ -4171,7 +4193,7 @@ export enum EmbedEvent {
|
|
|
4171
4193
|
*/
|
|
4172
4194
|
TableVizRendered = "TableVizRendered",
|
|
4173
4195
|
/**
|
|
4174
|
-
* Emitted when the liveboard is created from pin modal or
|
|
4196
|
+
* Emitted when the liveboard is created from pin modal or Liveboard list page.
|
|
4175
4197
|
* You can use this event as a hook to trigger
|
|
4176
4198
|
* other events on liveboard creation.
|
|
4177
4199
|
*
|
|
@@ -4314,7 +4336,7 @@ export enum HostEvent {
|
|
|
4314
4336
|
*/
|
|
4315
4337
|
Filter = "filter",
|
|
4316
4338
|
/**
|
|
4317
|
-
* Reload the
|
|
4339
|
+
* Reload the Answer or visualization
|
|
4318
4340
|
* @hidden
|
|
4319
4341
|
*/
|
|
4320
4342
|
Reload = "reload",
|
|
@@ -4364,12 +4386,10 @@ export enum HostEvent {
|
|
|
4364
4386
|
* and `AppEmbed` only. In full application embedding, this event updates
|
|
4365
4387
|
* the runtime filters applied on the Liveboard and saved Answer objects.
|
|
4366
4388
|
*
|
|
4367
|
-
*
|
|
4368
|
-
* Pass an array of runtime filters with the following attributes:
|
|
4369
|
-
*
|
|
4389
|
+
* @param - Pass an array of {@link RuntimeFilter} with the following attributes:
|
|
4370
4390
|
* `columnName` - _String_. The name of the column to filter on.
|
|
4371
4391
|
*
|
|
4372
|
-
* `operator` -
|
|
4392
|
+
* `operator` - {@link RuntimeFilterOp} to apply. For more information,
|
|
4373
4393
|
* see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
|
|
4374
4394
|
*
|
|
4375
4395
|
* `values` - List of operands. Some operators such as EQ and LE allow a
|
|
@@ -4381,7 +4401,7 @@ export enum HostEvent {
|
|
|
4381
4401
|
* will be cleared, restoring the original visualization
|
|
4382
4402
|
* with the updated filters.
|
|
4383
4403
|
*
|
|
4384
|
-
|
|
4404
|
+
|
|
4385
4405
|
* @example
|
|
4386
4406
|
* ```js
|
|
4387
4407
|
* liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
|
|
@@ -4620,6 +4640,11 @@ export enum HostEvent {
|
|
|
4620
4640
|
* appEmbed.trigger(HostEvent.Remove)
|
|
4621
4641
|
* ```
|
|
4622
4642
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
|
|
4643
|
+
* * @example
|
|
4644
|
+
* ```js
|
|
4645
|
+
* liveboardEmbed.trigger(HostEvent.Remove)
|
|
4646
|
+
* ```
|
|
4647
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
|
|
4623
4648
|
*/
|
|
4624
4649
|
Remove = "delete",
|
|
4625
4650
|
/**
|
|
@@ -5030,7 +5055,7 @@ export enum HostEvent {
|
|
|
5030
5055
|
* ```js
|
|
5031
5056
|
* liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
|
|
5032
5057
|
* console.log(
|
|
5033
|
-
* tabDetails // TabDetails of current
|
|
5058
|
+
* tabDetails // TabDetails of current Liveboard
|
|
5034
5059
|
* );
|
|
5035
5060
|
* })
|
|
5036
5061
|
* ```
|
|
@@ -5078,7 +5103,7 @@ export enum HostEvent {
|
|
|
5078
5103
|
*/
|
|
5079
5104
|
UpdateSageQuery = "updateSageQuery",
|
|
5080
5105
|
/**
|
|
5081
|
-
* Get the
|
|
5106
|
+
* Get the Answer session for a Search or
|
|
5082
5107
|
* Liveboard visualization.
|
|
5083
5108
|
* @example
|
|
5084
5109
|
* ```js
|
|
@@ -5253,6 +5278,7 @@ export enum Param {
|
|
|
5253
5278
|
HostAppUrl = "hostAppUrl",
|
|
5254
5279
|
EnableVizTransformations = "enableVizTransform",
|
|
5255
5280
|
EnableSearchAssist = "enableSearchAssist",
|
|
5281
|
+
EnablePendoHelp = "enablePendoHelp",
|
|
5256
5282
|
HideResult = "hideResult",
|
|
5257
5283
|
UseLastSelectedDataSource = "useLastSelectedSources",
|
|
5258
5284
|
Tag = "tag",
|
|
@@ -5477,9 +5503,10 @@ export enum Action {
|
|
|
5477
5503
|
*/
|
|
5478
5504
|
AddDataPanelObjects = "addDataPanelObjects",
|
|
5479
5505
|
/**
|
|
5480
|
-
*
|
|
5481
|
-
*
|
|
5482
|
-
* Liveboard.
|
|
5506
|
+
* The filter configuration options for a Liveboard.
|
|
5507
|
+
* The configuration options are available when adding
|
|
5508
|
+
* filters on a Liveboard.
|
|
5509
|
+
*
|
|
5483
5510
|
* @example
|
|
5484
5511
|
* ```js
|
|
5485
5512
|
* disabledActions: [Action.ConfigureFilter]
|
|
@@ -5577,14 +5604,17 @@ export enum Action {
|
|
|
5577
5604
|
* @hidden
|
|
5578
5605
|
*/
|
|
5579
5606
|
SpotIQFollow = "spotIQFollow",
|
|
5607
|
+
/**
|
|
5608
|
+
* The Share action for a Liveboard visualization.
|
|
5609
|
+
*/
|
|
5580
5610
|
ShareViz = "shareViz",
|
|
5581
5611
|
/**
|
|
5582
5612
|
* @hidden
|
|
5583
5613
|
*/
|
|
5584
5614
|
ReplaySearch = "replaySearch",
|
|
5585
5615
|
/**
|
|
5586
|
-
* The **Show underlying data** menu action on a
|
|
5587
|
-
* Answer page.
|
|
5616
|
+
* The **Show underlying data** menu action on a
|
|
5617
|
+
* visualization or Answer page.
|
|
5588
5618
|
* Displays detailed information and raw data
|
|
5589
5619
|
* for a given visualization.
|
|
5590
5620
|
* @example
|
|
@@ -5594,8 +5624,8 @@ export enum Action {
|
|
|
5594
5624
|
*/
|
|
5595
5625
|
ShowUnderlyingData = "showUnderlyingData",
|
|
5596
5626
|
/**
|
|
5597
|
-
* The **Download** menu action on Liveboard
|
|
5598
|
-
* and Answers.
|
|
5627
|
+
* The **Download** menu action on Liveboard
|
|
5628
|
+
* visualizations and Answers.
|
|
5599
5629
|
* Allows downloading a visualization or Answer.
|
|
5600
5630
|
* @example
|
|
5601
5631
|
* ```js
|
|
@@ -5616,11 +5646,10 @@ export enum Action {
|
|
|
5616
5646
|
/**
|
|
5617
5647
|
*
|
|
5618
5648
|
*The **Download PDF** action that downloads a Liveboard,
|
|
5619
|
-
*visualization, or Answer as a PDF file.
|
|
5620
|
-
*
|
|
5649
|
+
* visualization, or Answer as a PDF file.
|
|
5621
5650
|
*
|
|
5622
|
-
|
|
5623
|
-
*visualizations and Answers
|
|
5651
|
+
* **NOTE**: The **Download** > **PDF** option is available for
|
|
5652
|
+
* tables in visualizations and Answers.
|
|
5624
5653
|
* @example
|
|
5625
5654
|
* ```js
|
|
5626
5655
|
* disabledActions: [Action.DownloadAsPdf]
|
|
@@ -5652,9 +5681,11 @@ export enum Action {
|
|
|
5652
5681
|
*/
|
|
5653
5682
|
DownloadTrace = "downloadTrace",
|
|
5654
5683
|
/**
|
|
5655
|
-
* The **Export TML** menu action on Liveboard,
|
|
5656
|
-
*
|
|
5657
|
-
*
|
|
5684
|
+
* The **Export TML** menu action on a Liveboard, Answer, and
|
|
5685
|
+
* the Data Workspace pages for data objects and connections.
|
|
5686
|
+
*
|
|
5687
|
+
* Allows exporting an object as a TML file.
|
|
5688
|
+
*
|
|
5658
5689
|
* @example
|
|
5659
5690
|
* ```js
|
|
5660
5691
|
* disabledActions: [Action.ExportTML]
|
|
@@ -5662,7 +5693,8 @@ export enum Action {
|
|
|
5662
5693
|
*/
|
|
5663
5694
|
ExportTML = "exportTSL",
|
|
5664
5695
|
/**
|
|
5665
|
-
* The **Import TML** menu action
|
|
5696
|
+
* The **Import TML** menu action on the
|
|
5697
|
+
* *Data Workspace* > *Utilities* page.
|
|
5666
5698
|
* Imports TML representation of ThoughtSpot objects.
|
|
5667
5699
|
* @example
|
|
5668
5700
|
* ```js
|
|
@@ -5672,7 +5704,7 @@ export enum Action {
|
|
|
5672
5704
|
ImportTML = "importTSL",
|
|
5673
5705
|
/**
|
|
5674
5706
|
* The **Update TML** menu action for Liveboards and Answers.
|
|
5675
|
-
*
|
|
5707
|
+
* Updates TML representation of ThoughtSpot objects.
|
|
5676
5708
|
* @example
|
|
5677
5709
|
* ```js
|
|
5678
5710
|
* disabledActions: [Action.UpdateTML]
|
|
@@ -5699,8 +5731,11 @@ export enum Action {
|
|
|
5699
5731
|
*/
|
|
5700
5732
|
Present = "present",
|
|
5701
5733
|
/**
|
|
5702
|
-
* The tile resize
|
|
5703
|
-
*
|
|
5734
|
+
* The visualization tile resize option.
|
|
5735
|
+
* Also available via More `...` options menu on a visualization.
|
|
5736
|
+
* Allows resizing visualization tiles and switching
|
|
5737
|
+
* between different preset layout option.
|
|
5738
|
+
*
|
|
5704
5739
|
* @example
|
|
5705
5740
|
* ```js
|
|
5706
5741
|
* disabledActions: [Action.ToggleSize]
|
|
@@ -5726,8 +5761,9 @@ export enum Action {
|
|
|
5726
5761
|
*/
|
|
5727
5762
|
EditTitle = "editTitle",
|
|
5728
5763
|
/**
|
|
5729
|
-
* The **Delete**
|
|
5730
|
-
*
|
|
5764
|
+
* The **Delete** action on a Liveboard, *Liveboards* and
|
|
5765
|
+
* *Answers* list pages in full application embedding.
|
|
5766
|
+
*
|
|
5731
5767
|
* @example
|
|
5732
5768
|
* ```js
|
|
5733
5769
|
* disabledActions: [Action.Remove]
|
|
@@ -5804,8 +5840,9 @@ export enum Action {
|
|
|
5804
5840
|
*/
|
|
5805
5841
|
Explore = "explore",
|
|
5806
5842
|
/**
|
|
5807
|
-
* The action to include
|
|
5808
|
-
* or
|
|
5843
|
+
* The contextual menu action to include a specific data point
|
|
5844
|
+
* when drilling down a table or chart on an Answer.
|
|
5845
|
+
*
|
|
5809
5846
|
* @example
|
|
5810
5847
|
* ```js
|
|
5811
5848
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5813,8 +5850,8 @@ export enum Action {
|
|
|
5813
5850
|
*/
|
|
5814
5851
|
DrillInclude = "context-menu-item-include",
|
|
5815
5852
|
/**
|
|
5816
|
-
* The action to exclude
|
|
5817
|
-
* or
|
|
5853
|
+
* The contextual menu action to exclude a specific data point
|
|
5854
|
+
* when drilling down a table or chart on an Answer.
|
|
5818
5855
|
* @example
|
|
5819
5856
|
* ```js
|
|
5820
5857
|
* disabledActions: [Action.DrillInclude]
|
|
@@ -5961,7 +5998,7 @@ export enum Action {
|
|
|
5961
5998
|
* Allows users to manage data sync pipelines to third-party apps.
|
|
5962
5999
|
* @example
|
|
5963
6000
|
* ```js
|
|
5964
|
-
* disabledActions: [Action.
|
|
6001
|
+
* disabledActions: [Action.ManagePipelines]
|
|
5965
6002
|
* ```
|
|
5966
6003
|
* @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
|
|
5967
6004
|
*/
|
|
@@ -6280,7 +6317,7 @@ export enum Action {
|
|
|
6280
6317
|
/**
|
|
6281
6318
|
* Action ID for the Parent TML action
|
|
6282
6319
|
* The parent action **TML** must be included to access TML-related options
|
|
6283
|
-
* within the cascading menu (specific to the
|
|
6320
|
+
* within the cascading menu (specific to the Answer page)
|
|
6284
6321
|
* @example
|
|
6285
6322
|
* ```js
|
|
6286
6323
|
* // to include specific TML actions
|
|
@@ -6319,8 +6356,10 @@ export enum Action {
|
|
|
6319
6356
|
*/
|
|
6320
6357
|
VerifiedLiveboard = "verifiedLiveboard",
|
|
6321
6358
|
/**
|
|
6322
|
-
*
|
|
6323
|
-
*
|
|
6359
|
+
* Action ID for the *Ask Sage* In Natural Language Search embed,
|
|
6360
|
+
* *Spotter* in Liveboard, full app, and Spotter embed.
|
|
6361
|
+
*
|
|
6362
|
+
* Allows initiating a conversation with ThoughtSpot AI analyst.
|
|
6324
6363
|
*
|
|
6325
6364
|
* @example
|
|
6326
6365
|
* ```js
|
|
@@ -6516,7 +6555,8 @@ export enum Action {
|
|
|
6516
6555
|
*/
|
|
6517
6556
|
DeletePreviousPrompt = "deletePreviousPrompt",
|
|
6518
6557
|
/**
|
|
6519
|
-
* Action ID for hide
|
|
6558
|
+
* Action ID for hide or disable editing tokens generated from
|
|
6559
|
+
* Spotter results.
|
|
6520
6560
|
* @example
|
|
6521
6561
|
* ```js
|
|
6522
6562
|
* hiddenAction: [Action.EditTokens]
|
|
@@ -7405,7 +7445,7 @@ export const getEmbedConfig: () => EmbedConfig;
|
|
|
7405
7445
|
* @version SDK: 1.27.0 | ThoughtSpot: *
|
|
7406
7446
|
* @group Global methods
|
|
7407
7447
|
*/
|
|
7408
|
-
export const setEmbedConfig: (newConfig: EmbedConfig) =>
|
|
7448
|
+
export const setEmbedConfig: (newConfig: EmbedConfig) => any;
|
|
7409
7449
|
|
|
7410
7450
|
export const EndPoints: {
|
|
7411
7451
|
CONFIG: string;
|
|
@@ -7638,6 +7678,7 @@ export class TsEmbed {
|
|
|
7638
7678
|
*/
|
|
7639
7679
|
protected isRendered: boolean;
|
|
7640
7680
|
protected hostEventClient: HostEventClient;
|
|
7681
|
+
protected isReadyForRenderPromise: Promise<void>;
|
|
7641
7682
|
constructor(domSelector: DOMSelector, viewConfig?: ViewConfig);
|
|
7642
7683
|
/**
|
|
7643
7684
|
* Handles errors within the SDK
|
|
@@ -7781,12 +7822,12 @@ export class TsEmbed {
|
|
|
7781
7822
|
*/
|
|
7782
7823
|
render(): Promise<TsEmbed>;
|
|
7783
7824
|
getIframeSrc(): string;
|
|
7784
|
-
protected handleRenderForPrerender():
|
|
7825
|
+
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
7785
7826
|
/**
|
|
7786
7827
|
* Creates the preRender shell
|
|
7787
7828
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
7788
7829
|
*/
|
|
7789
|
-
preRender(showPreRenderByDefault?: boolean): TsEmbed
|
|
7830
|
+
preRender(showPreRenderByDefault?: boolean): Promise<TsEmbed>;
|
|
7790
7831
|
/**
|
|
7791
7832
|
* Get the Post Url Params for THOUGHTSPOT from the current
|
|
7792
7833
|
* host app URL.
|
|
@@ -7817,7 +7858,7 @@ export class TsEmbed {
|
|
|
7817
7858
|
* Also, synchronizes the style of the PreRender component with the embedding
|
|
7818
7859
|
* element.
|
|
7819
7860
|
*/
|
|
7820
|
-
showPreRender():
|
|
7861
|
+
showPreRender(): Promise<TsEmbed>;
|
|
7821
7862
|
/**
|
|
7822
7863
|
* Synchronizes the style properties of the PreRender component with the embedding
|
|
7823
7864
|
* element. This function adjusts the position, width, and height of the PreRender
|
package/lib/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"authToken.d.ts","sourceRoot":"","sources":["../../src/authToken.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;
|
|
1
|
+
{"version":3,"file":"authToken.d.ts","sourceRoot":"","sources":["../../src/authToken.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAatC;;;GAGG;AACH,wBAAsB,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAmCtF;AA8BD;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,QAAO,IAEvC,CAAC"}
|
package/lib/src/authToken.js
CHANGED
|
@@ -1,13 +1,19 @@
|
|
|
1
1
|
import { ERROR_MESSAGE } from './errors';
|
|
2
|
+
import { getValueFromWindow, storeValueInWindow } from './utils';
|
|
2
3
|
import { fetchAuthTokenService, verifyTokenService } from './utils/authService/authService';
|
|
3
4
|
import { logger } from './utils/logger';
|
|
4
|
-
|
|
5
|
+
const cacheAuthTokenKey = 'cachedAuthToken';
|
|
6
|
+
const getCacheAuthToken = () => getValueFromWindow(cacheAuthTokenKey);
|
|
7
|
+
const storeAuthTokenInCache = (token) => {
|
|
8
|
+
storeValueInWindow(cacheAuthTokenKey, token);
|
|
9
|
+
};
|
|
5
10
|
// This method can be used to get the authToken using the embedConfig
|
|
6
11
|
/**
|
|
7
12
|
*
|
|
8
13
|
* @param embedConfig
|
|
9
14
|
*/
|
|
10
15
|
export async function getAuthenticationToken(embedConfig) {
|
|
16
|
+
const cachedAuthToken = getCacheAuthToken();
|
|
11
17
|
// Since we don't have token validation enabled , we cannot tell if the
|
|
12
18
|
// cached token is valid or not. So we will always fetch a new token.
|
|
13
19
|
if (cachedAuthToken && !embedConfig.disableTokenVerification) {
|
|
@@ -38,10 +44,11 @@ export async function getAuthenticationToken(embedConfig) {
|
|
|
38
44
|
logger.error(`${ERROR_MESSAGE.INVALID_TOKEN_ERROR} Error : ${e.message}`);
|
|
39
45
|
throw e;
|
|
40
46
|
}
|
|
41
|
-
|
|
47
|
+
storeAuthTokenInCache(authToken);
|
|
42
48
|
return authToken;
|
|
43
49
|
}
|
|
44
50
|
const validateAuthToken = async (embedConfig, authToken, suppressAlert) => {
|
|
51
|
+
const cachedAuthToken = getCacheAuthToken();
|
|
45
52
|
if (embedConfig.disableTokenVerification) {
|
|
46
53
|
logger.info('Token verification is disabled. Assuming token is valid.');
|
|
47
54
|
return true;
|
|
@@ -75,6 +82,6 @@ const validateAuthToken = async (embedConfig, authToken, suppressAlert) => {
|
|
|
75
82
|
* @group Authentication / Init
|
|
76
83
|
*/
|
|
77
84
|
export const resetCachedAuthToken = () => {
|
|
78
|
-
|
|
85
|
+
storeAuthTokenInCache(null);
|
|
79
86
|
};
|
|
80
87
|
//# sourceMappingURL=authToken.js.map
|
package/lib/src/authToken.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"authToken.js","sourceRoot":"","sources":["../../src/authToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,
|
|
1
|
+
{"version":3,"file":"authToken.js","sourceRoot":"","sources":["../../src/authToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAE5C,MAAM,iBAAiB,GAAG,GAAkB,EAAE,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;AACrF,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAQ,EAAE;IAClD,kBAAkB,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,qEAAqE;AACrE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,WAAwB;IACjE,MAAM,eAAe,GAAG,iBAAiB,EAAE,CAAC;IAC5C,uEAAuE;IACvE,qEAAqE;IACrE,IAAI,eAAe,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE;QAC1D,IAAI,uBAAuB,CAAC;QAC5B,IAAI;YACA,uBAAuB,GAAG,MAAM,iBAAiB,CAAC,WAAW,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;SACzF;QAAC,MAAM;YACJ,uBAAuB,GAAG,KAAK,CAAC;SACnC;QAED,IAAI,uBAAuB;YAAE,OAAO,eAAe,CAAC;KACvD;IAED,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC;IAEnD,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,YAAY,EAAE;QACd,SAAS,GAAG,MAAM,YAAY,EAAE,CAAC;KACpC;SAAM;QACH,MAAM,QAAQ,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAC3D,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;KACrC;IAED,IAAI;QACA,kDAAkD;QAClD,MAAM,iBAAiB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;KACnD;IAAC,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,mBAAmB,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1E,MAAM,CAAC,CAAC;KACX;IAED,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACjC,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,MAAM,iBAAiB,GAAG,KAAK,EAC3B,WAAwB,EACxB,SAAiB,EACjB,aAAuB,EACP,EAAE;IAClB,MAAM,eAAe,GAAG,iBAAiB,EAAE,CAAC;IAC5C,IAAI,WAAW,CAAC,wBAAwB,EAAE;QACtC,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;KACf;IACD,IAAI;QACA,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAAC,WAAW,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;QACtF,IAAI,YAAY;YAAE,OAAO,IAAI,CAAC;KACjC;IAAC,MAAM;QACJ,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,eAAe,IAAI,eAAe,KAAK,SAAS,EAAE;QAClD,IAAI,CAAC,WAAW,CAAC,mBAAmB,IAAI,CAAC,aAAa,EAAE;YACpD,oCAAoC;YACpC,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;SAC5C;QACD,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;KACtD;SAAM;QACH,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;KACtD;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAS,EAAE;IAC3C,qBAAqB,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC,CAAC"}
|
package/lib/src/embed/app.d.ts
CHANGED
|
@@ -123,6 +123,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
|
|
|
123
123
|
* ```
|
|
124
124
|
*/
|
|
125
125
|
disableProfileAndHelp?: boolean;
|
|
126
|
+
/**
|
|
127
|
+
* @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
|
|
128
|
+
* @default true
|
|
129
|
+
* Whether the help menu in the top nav bar should be served
|
|
130
|
+
* from Pendo or ThoughtSpot's internal help items.
|
|
131
|
+
* @example
|
|
132
|
+
* ```js
|
|
133
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
134
|
+
* ... // other options
|
|
135
|
+
* enablePendoHelp: false,
|
|
136
|
+
* });
|
|
137
|
+
* ```
|
|
138
|
+
*/
|
|
139
|
+
enablePendoHelp?: boolean;
|
|
126
140
|
/**
|
|
127
141
|
* Control the visibility of the application switcher button on the nav-bar.
|
|
128
142
|
* By default, the application switcher is shown.
|