@thoughtspot/visual-embed-sdk 1.29.1 → 1.30.0-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/README.md +1 -1
- package/cjs/package.json +1 -1
- package/cjs/src/auth.d.ts +15 -0
- package/cjs/src/auth.d.ts.map +1 -1
- package/cjs/src/auth.js +13 -2
- package/cjs/src/auth.js.map +1 -1
- package/cjs/src/authToken.d.ts +2 -1
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +2 -1
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/config.d.ts +1 -0
- package/cjs/src/config.d.ts.map +1 -1
- package/cjs/src/config.js +2 -0
- package/cjs/src/config.js.map +1 -1
- package/cjs/src/embed/app.d.ts +50 -4
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +10 -2
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/base.d.ts +7 -1
- package/cjs/src/embed/base.d.ts.map +1 -1
- package/cjs/src/embed/base.js +13 -6
- package/cjs/src/embed/base.js.map +1 -1
- package/cjs/src/embed/base.spec.js +1 -1
- package/cjs/src/embed/base.spec.js.map +1 -1
- package/cjs/src/embed/embedConfig.d.ts +2 -0
- package/cjs/src/embed/embedConfig.d.ts.map +1 -1
- package/cjs/src/embed/embedConfig.js +2 -0
- package/cjs/src/embed/embedConfig.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +30 -0
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +5 -0
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/sage.d.ts +18 -2
- package/cjs/src/embed/sage.d.ts.map +1 -1
- package/cjs/src/embed/sage.js +5 -0
- package/cjs/src/embed/sage.js.map +1 -1
- package/cjs/src/embed/search-bar.d.ts +11 -0
- package/cjs/src/embed/search-bar.d.ts.map +1 -1
- package/cjs/src/embed/search-bar.js +2 -0
- package/cjs/src/embed/search-bar.js.map +1 -1
- package/cjs/src/embed/search.d.ts +34 -5
- package/cjs/src/embed/search.d.ts.map +1 -1
- package/cjs/src/embed/search.js +7 -4
- package/cjs/src/embed/search.js.map +1 -1
- package/cjs/src/embed/search.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +31 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +37 -6
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +9 -18
- package/cjs/src/embed/ts-embed.spec.js.map +1 -1
- package/cjs/src/index.d.ts +1 -0
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +1 -0
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +1 -0
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +1 -0
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/react/index.d.ts +12 -1
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +11 -1
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +2 -14
- package/cjs/src/react/index.spec.js.map +1 -1
- package/cjs/src/test/test-utils.d.ts +2 -0
- package/cjs/src/test/test-utils.d.ts.map +1 -1
- package/cjs/src/test/test-utils.js +2 -0
- package/cjs/src/test/test-utils.js.map +1 -1
- package/cjs/src/tokenizedFetch.d.ts +1 -0
- package/cjs/src/tokenizedFetch.d.ts.map +1 -1
- package/cjs/src/tokenizedFetch.js +1 -0
- package/cjs/src/tokenizedFetch.js.map +1 -1
- package/cjs/src/types.d.ts +372 -59
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +297 -51
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/authService/authService.d.ts +1 -0
- package/cjs/src/utils/authService/authService.d.ts.map +1 -1
- package/cjs/src/utils/authService/authService.js +1 -0
- package/cjs/src/utils/authService/authService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +12 -0
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +12 -0
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/processTrigger.d.ts +1 -0
- package/cjs/src/utils/processTrigger.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.js +2 -0
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils.d.ts +9 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +11 -0
- package/cjs/src/utils.js.map +1 -1
- package/dist/src/auth.d.ts +15 -0
- package/dist/src/auth.d.ts.map +1 -1
- package/dist/src/authToken.d.ts +2 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/config.d.ts +1 -0
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +50 -4
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +7 -1
- package/dist/src/embed/base.d.ts.map +1 -1
- package/dist/src/embed/embedConfig.d.ts +2 -0
- package/dist/src/embed/embedConfig.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +30 -0
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/sage.d.ts +18 -2
- package/dist/src/embed/sage.d.ts.map +1 -1
- package/dist/src/embed/search-bar.d.ts +11 -0
- package/dist/src/embed/search-bar.d.ts.map +1 -1
- package/dist/src/embed/search.d.ts +34 -5
- package/dist/src/embed/search.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +31 -1
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/index.d.ts +1 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +1 -0
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/react/index.d.ts +12 -1
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/test/test-utils.d.ts +2 -0
- package/dist/src/test/test-utils.d.ts.map +1 -1
- package/dist/src/tokenizedFetch.d.ts +1 -0
- package/dist/src/tokenizedFetch.d.ts.map +1 -1
- package/dist/src/types.d.ts +372 -59
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/authService/authService.d.ts +1 -0
- package/dist/src/utils/authService/authService.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +12 -0
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +1 -0
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +9 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +7426 -7073
- package/dist/tsembed-react.js +7441 -7092
- package/dist/tsembed.es.js +8781 -8431
- package/dist/tsembed.js +12901 -12559
- package/dist/visual-embed-sdk-react-full.d.ts +584 -70
- package/dist/visual-embed-sdk-react.d.ts +584 -70
- package/dist/visual-embed-sdk.d.ts +572 -69
- package/lib/package.json +1 -1
- package/lib/src/auth.d.ts +15 -0
- package/lib/src/auth.d.ts.map +1 -1
- package/lib/src/auth.js +14 -3
- package/lib/src/auth.js.map +1 -1
- package/lib/src/authToken.d.ts +2 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +2 -1
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/config.d.ts +1 -0
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +2 -0
- package/lib/src/config.js.map +1 -1
- package/lib/src/embed/app.d.ts +50 -4
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +10 -2
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/base.d.ts +7 -1
- package/lib/src/embed/base.d.ts.map +1 -1
- package/lib/src/embed/base.js +12 -5
- package/lib/src/embed/base.js.map +1 -1
- package/lib/src/embed/base.spec.js +2 -2
- package/lib/src/embed/base.spec.js.map +1 -1
- package/lib/src/embed/embedConfig.d.ts +2 -0
- package/lib/src/embed/embedConfig.d.ts.map +1 -1
- package/lib/src/embed/embedConfig.js +2 -0
- package/lib/src/embed/embedConfig.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +30 -0
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +6 -1
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/sage.d.ts +18 -2
- package/lib/src/embed/sage.d.ts.map +1 -1
- package/lib/src/embed/sage.js +5 -0
- package/lib/src/embed/sage.js.map +1 -1
- package/lib/src/embed/search-bar.d.ts +11 -0
- package/lib/src/embed/search-bar.d.ts.map +1 -1
- package/lib/src/embed/search-bar.js +2 -0
- package/lib/src/embed/search-bar.js.map +1 -1
- package/lib/src/embed/search.d.ts +34 -5
- package/lib/src/embed/search.d.ts.map +1 -1
- package/lib/src/embed/search.js +8 -5
- package/lib/src/embed/search.js.map +1 -1
- package/lib/src/embed/search.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +31 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +40 -9
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +9 -18
- package/lib/src/embed/ts-embed.spec.js.map +1 -1
- package/lib/src/index.d.ts +1 -0
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +1 -0
- package/lib/src/index.js.map +1 -1
- package/lib/src/mixpanel-service.d.ts +1 -0
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +1 -0
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/react/index.d.ts +12 -1
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +11 -1
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +3 -15
- package/lib/src/react/index.spec.js.map +1 -1
- package/lib/src/test/test-utils.d.ts +2 -0
- package/lib/src/test/test-utils.d.ts.map +1 -1
- package/lib/src/test/test-utils.js +2 -0
- package/lib/src/test/test-utils.js.map +1 -1
- package/lib/src/tokenizedFetch.d.ts +1 -0
- package/lib/src/tokenizedFetch.d.ts.map +1 -1
- package/lib/src/tokenizedFetch.js +1 -0
- package/lib/src/tokenizedFetch.js.map +1 -1
- package/lib/src/types.d.ts +372 -59
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +297 -51
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/authService/authService.d.ts +1 -0
- package/lib/src/utils/authService/authService.d.ts.map +1 -1
- package/lib/src/utils/authService/authService.js +1 -0
- package/lib/src/utils/authService/authService.js.map +1 -1
- package/lib/src/utils/authService/authService.spec.js +1 -1
- package/lib/src/utils/authService/authService.spec.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +12 -0
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +12 -0
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/processTrigger.d.ts +1 -0
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +2 -0
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils.d.ts +9 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +11 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +576 -73
- package/package.json +1 -1
- package/src/auth.ts +23 -6
- package/src/authToken.ts +2 -1
- package/src/config.ts +2 -0
- package/src/embed/app.ts +63 -16
- package/src/embed/base.spec.ts +3 -3
- package/src/embed/base.ts +21 -15
- package/src/embed/embedConfig.ts +2 -0
- package/src/embed/liveboard.ts +38 -1
- package/src/embed/sage.ts +18 -2
- package/src/embed/search-bar.tsx +11 -0
- package/src/embed/search.spec.ts +1 -2
- package/src/embed/search.ts +48 -21
- package/src/embed/ts-embed.spec.ts +24 -37
- package/src/embed/ts-embed.ts +72 -38
- package/src/index.ts +1 -0
- package/src/mixpanel-service.ts +1 -0
- package/src/react/index.spec.tsx +59 -47
- package/src/react/index.tsx +12 -1
- package/src/test/test-utils.ts +2 -0
- package/src/tokenizedFetch.ts +1 -0
- package/src/types.ts +377 -65
- package/src/utils/authService/authService.spec.ts +4 -4
- package/src/utils/authService/authService.ts +1 -0
- package/src/utils/graphql/answerService/answerService.ts +12 -0
- package/src/utils/processTrigger.ts +2 -0
- package/src/utils.ts +11 -0
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
* Embed a ThoughtSpot Liveboard or visualization
|
|
5
5
|
* https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
|
|
6
6
|
* https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
|
|
7
|
+
*
|
|
7
8
|
* @summary Liveboard & visualization embed
|
|
8
9
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
9
10
|
*/
|
|
@@ -11,6 +12,7 @@ import { DOMSelector, HostEvent, ViewConfig } from '../types';
|
|
|
11
12
|
import { V1Embed } from './ts-embed';
|
|
12
13
|
/**
|
|
13
14
|
* The configuration for the embedded Liveboard or visualization page view.
|
|
15
|
+
*
|
|
14
16
|
* @group Embed components
|
|
15
17
|
*/
|
|
16
18
|
export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'reorderedHomepageModules'> {
|
|
@@ -23,7 +25,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
23
25
|
* visualizations to display on the screen.
|
|
24
26
|
* Setting `fullHeight` to `false` fetches visualizations
|
|
25
27
|
* incrementally as users scroll the page to view the charts and tables.
|
|
28
|
+
*
|
|
26
29
|
* @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
|
|
30
|
+
*
|
|
27
31
|
* @example
|
|
28
32
|
* ```js
|
|
29
33
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -37,6 +41,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
37
41
|
* This is the minimum height(in pixels) for a full-height Liveboard.
|
|
38
42
|
* Setting this height helps resolve issues with empty Liveboards and
|
|
39
43
|
* other screens navigable from a Liveboard.
|
|
44
|
+
*
|
|
40
45
|
* @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
|
|
41
46
|
* @default 500
|
|
42
47
|
* @example
|
|
@@ -51,6 +56,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
51
56
|
defaultHeight?: number;
|
|
52
57
|
/**
|
|
53
58
|
* @Deprecated If set to true, the context menu in visualizations will be enabled.
|
|
59
|
+
*
|
|
54
60
|
* @example
|
|
55
61
|
* ```js
|
|
56
62
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -58,12 +64,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
58
64
|
* enableVizTransformations:true,
|
|
59
65
|
* })
|
|
60
66
|
* ```
|
|
67
|
+
*
|
|
61
68
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
62
69
|
*/
|
|
63
70
|
enableVizTransformations?: boolean;
|
|
64
71
|
/**
|
|
65
72
|
* The Liveboard to display in the embedded view.
|
|
66
73
|
* Use either liveboardId or pinboardId to reference the Liveboard to embed.
|
|
74
|
+
*
|
|
67
75
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
|
|
68
76
|
* @example
|
|
69
77
|
* ```js
|
|
@@ -75,12 +83,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
75
83
|
liveboardId?: string;
|
|
76
84
|
/**
|
|
77
85
|
* To support backward compatibility
|
|
86
|
+
*
|
|
78
87
|
* @hidden
|
|
79
88
|
*/
|
|
80
89
|
pinboardId?: string;
|
|
81
90
|
/**
|
|
82
91
|
* The visualization within the Liveboard to display.
|
|
92
|
+
*
|
|
83
93
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
94
|
+
*
|
|
84
95
|
* @example
|
|
85
96
|
* ```js
|
|
86
97
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -93,6 +104,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
93
104
|
/**
|
|
94
105
|
* If set to true, all filter chips from a
|
|
95
106
|
* Liveboard page will be read-only (no X buttons)
|
|
107
|
+
*
|
|
96
108
|
* @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
|
|
97
109
|
* @example
|
|
98
110
|
* ```js
|
|
@@ -107,7 +119,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
107
119
|
* Array of visualization IDs which should be visible when the Liveboard
|
|
108
120
|
* renders. This can be changed by triggering the `SetVisibleVizs`
|
|
109
121
|
* event.
|
|
122
|
+
*
|
|
110
123
|
* @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
|
|
124
|
+
*
|
|
111
125
|
* @example
|
|
112
126
|
* ```js
|
|
113
127
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -121,12 +135,14 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
121
135
|
visibleVizs?: string[];
|
|
122
136
|
/**
|
|
123
137
|
* To support backward compatibility
|
|
138
|
+
*
|
|
124
139
|
* @hidden
|
|
125
140
|
*/
|
|
126
141
|
preventPinboardFilterRemoval?: boolean;
|
|
127
142
|
/**
|
|
128
143
|
* Render embedded Liveboards and visualizations in the
|
|
129
144
|
* new Liveboard experience mode.
|
|
145
|
+
*
|
|
130
146
|
* @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
|
|
131
147
|
* @example
|
|
132
148
|
* ```js
|
|
@@ -140,6 +156,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
140
156
|
/**
|
|
141
157
|
* Set a Liveboard tab as an active tab.
|
|
142
158
|
* Specify the tab ID.
|
|
159
|
+
*
|
|
143
160
|
* @example
|
|
144
161
|
* ```js
|
|
145
162
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
@@ -152,7 +169,9 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
152
169
|
activeTabId?: string;
|
|
153
170
|
/**
|
|
154
171
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
172
|
+
*
|
|
155
173
|
* @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
|
|
174
|
+
*
|
|
156
175
|
* @example
|
|
157
176
|
* ```js
|
|
158
177
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -164,6 +183,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
164
183
|
hideTabPanel?: boolean;
|
|
165
184
|
/**
|
|
166
185
|
* Show or hide the Liveboard header.
|
|
186
|
+
*
|
|
167
187
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
168
188
|
* @default false
|
|
169
189
|
* @example
|
|
@@ -179,6 +199,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
179
199
|
* Show or hide the Liveboard title.
|
|
180
200
|
* @default false
|
|
181
201
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
202
|
+
*
|
|
182
203
|
* @example
|
|
183
204
|
* ```js
|
|
184
205
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -192,6 +213,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
192
213
|
* Show or hide the Liveboard description.
|
|
193
214
|
* @default false
|
|
194
215
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
|
|
216
|
+
*
|
|
195
217
|
* @example
|
|
196
218
|
* ```js
|
|
197
219
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -205,6 +227,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
205
227
|
* Control the position and visibility of
|
|
206
228
|
* the Liveboard header as the users scroll down the
|
|
207
229
|
* embedded Liveboard page.
|
|
230
|
+
*
|
|
208
231
|
* @example
|
|
209
232
|
* ```js
|
|
210
233
|
* const embed = new LiveboardEmbed('#embed', {
|
|
@@ -217,6 +240,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
217
240
|
isLiveboardHeaderSticky?: boolean;
|
|
218
241
|
/**
|
|
219
242
|
* enable or disable ask sage
|
|
243
|
+
*
|
|
220
244
|
* @default false
|
|
221
245
|
* @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
|
|
222
246
|
* @example
|
|
@@ -230,9 +254,11 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
230
254
|
enableAskSage?: boolean;
|
|
231
255
|
/**
|
|
232
256
|
* This flag is used to enable the 2 column layout in liveboard
|
|
257
|
+
*
|
|
233
258
|
* @type {boolean}
|
|
234
259
|
* @default false
|
|
235
260
|
* @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
|
|
261
|
+
*
|
|
236
262
|
* @example
|
|
237
263
|
* ```js
|
|
238
264
|
* const embed = new LiveboardEmbed('#embed-container', {
|
|
@@ -247,6 +273,7 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
|
|
|
247
273
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
248
274
|
* waits for the authentication to complete, so you need not wait for
|
|
249
275
|
* `AuthStatus.SUCCESS`.
|
|
276
|
+
*
|
|
250
277
|
* @example
|
|
251
278
|
* ```js
|
|
252
279
|
* import { .. } from '@thoughtspot/visual-embed-sdk';
|
|
@@ -276,6 +303,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
276
303
|
/**
|
|
277
304
|
* Set the iframe height as per the computed height received
|
|
278
305
|
* from the ThoughtSpot app.
|
|
306
|
+
*
|
|
279
307
|
* @param data The event payload
|
|
280
308
|
*/
|
|
281
309
|
private updateIFrameHeight;
|
|
@@ -286,12 +314,14 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
286
314
|
protected handleRenderForPrerender(): void;
|
|
287
315
|
/**
|
|
288
316
|
* Triggers an event to the embedded app
|
|
317
|
+
*
|
|
289
318
|
* @param messageType The event type
|
|
290
319
|
* @param data The payload to send with the message
|
|
291
320
|
*/
|
|
292
321
|
trigger(messageType: HostEvent, data?: any): Promise<any>;
|
|
293
322
|
/**
|
|
294
323
|
* Render an embedded ThoughtSpot Liveboard or visualization
|
|
324
|
+
*
|
|
295
325
|
* @param renderOptions An object specifying the Liveboard ID,
|
|
296
326
|
* visualization ID and the runtime filters.
|
|
297
327
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,UAAU,EACb,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,0BAA0B,CAClF;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IAUrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAwExB,OAAO,CAAC,kBAAkB;IAa1B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAcpB;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAQzC;IAEF,OAAO,CAAC,YAAY;IAQpB,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAcxC,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAQ1C;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpE;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;IASvC,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAavF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAG"}
|
package/dist/src/embed/sage.d.ts
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
* Copyright (c) 2023
|
|
3
3
|
*
|
|
4
4
|
* Embed ThoughtSpot Sage
|
|
5
|
+
*
|
|
5
6
|
* @summary TS Sage embed
|
|
6
7
|
* @author Mourya Balabhadra <mourya.balabhadra@thoughtspot.com>
|
|
7
8
|
*/
|
|
@@ -26,6 +27,7 @@ export interface SearchOptions {
|
|
|
26
27
|
/**
|
|
27
28
|
* The configuration attributes for the embedded Natural language search view. Based on
|
|
28
29
|
* GPT and LLM.
|
|
30
|
+
*
|
|
29
31
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
|
|
30
32
|
* @group Embed components
|
|
31
33
|
*/
|
|
@@ -34,6 +36,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
34
36
|
* If set to true, a list of Liveboard and Answers related
|
|
35
37
|
* to the natural language search will be shown below the
|
|
36
38
|
* AI generated answer.
|
|
39
|
+
*
|
|
37
40
|
* @deprecated Currently Liveboard and Answers related
|
|
38
41
|
* to the natural language search will not be shown for sage
|
|
39
42
|
* embed
|
|
@@ -41,10 +44,11 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
41
44
|
showObjectResults?: boolean;
|
|
42
45
|
/**
|
|
43
46
|
* flag used by the TS product tour page to show the blue search bar
|
|
44
|
-
* even after the search is completed. This is different from Thoughtspot Embedded
|
|
45
|
-
*
|
|
47
|
+
* even after the search is completed. This is different from Thoughtspot Embedded Sage Embed
|
|
48
|
+
* experience where it mimics closer to the non-embed case.
|
|
46
49
|
* The Sample questions container is collapsed when this value is set after
|
|
47
50
|
* does a search.
|
|
51
|
+
*
|
|
48
52
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl
|
|
49
53
|
* @hidden
|
|
50
54
|
*/
|
|
@@ -52,32 +56,38 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
52
56
|
/**
|
|
53
57
|
* Show or hide the search bar title.
|
|
54
58
|
* @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
59
|
+
*
|
|
55
60
|
* @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
|
|
56
61
|
*/
|
|
57
62
|
hideSearchBarTitle?: boolean;
|
|
58
63
|
/**
|
|
59
64
|
* Show or hide the Answer header, that is, the `AI Answer` title
|
|
60
65
|
* at the top of the Answer page.
|
|
66
|
+
*
|
|
61
67
|
* @version SDK: 1.26.0 | Thoughtspot: 9.10.0.cl
|
|
62
68
|
*/
|
|
63
69
|
hideSageAnswerHeader?: boolean;
|
|
64
70
|
/**
|
|
65
71
|
* Disable the worksheet selection option.
|
|
72
|
+
*
|
|
66
73
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
67
74
|
*/
|
|
68
75
|
disableWorksheetChange?: boolean;
|
|
69
76
|
/**
|
|
70
77
|
* Hide the worksheet selection panel.
|
|
78
|
+
*
|
|
71
79
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
72
80
|
*/
|
|
73
81
|
hideWorksheetSelector?: boolean;
|
|
74
82
|
/**
|
|
75
83
|
* Show or hide autocomplete suggestions for the search query string.
|
|
84
|
+
*
|
|
76
85
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
77
86
|
*/
|
|
78
87
|
hideAutocompleteSuggestions?: boolean;
|
|
79
88
|
/**
|
|
80
89
|
* Show or hide autocomplete suggestions for the search query string.
|
|
90
|
+
*
|
|
81
91
|
* @deprecated
|
|
82
92
|
* Currently, the object suggestions will not be shown for Natural Language Search.
|
|
83
93
|
* You can use {@link hideAutocompleteSuggestions} instead.
|
|
@@ -87,6 +97,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
87
97
|
* Show or hide sample questions.
|
|
88
98
|
* The sample questions are autogenerated based on the worksheet
|
|
89
99
|
* selected for the search operation.
|
|
100
|
+
*
|
|
90
101
|
* @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
|
|
91
102
|
*/
|
|
92
103
|
hideSampleQuestions?: boolean;
|
|
@@ -104,6 +115,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
104
115
|
* If it is executed, the focus is placed on the results.
|
|
105
116
|
* If it’s not executed, the focus is placed at the end of
|
|
106
117
|
* the token string in the search bar.
|
|
118
|
+
*
|
|
107
119
|
* @example
|
|
108
120
|
* ```js
|
|
109
121
|
* searchOptions: {
|
|
@@ -117,6 +129,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
|
|
|
117
129
|
}
|
|
118
130
|
/**
|
|
119
131
|
* Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
|
|
132
|
+
*
|
|
120
133
|
* @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
|
|
121
134
|
* @group Embed components
|
|
122
135
|
*/
|
|
@@ -130,17 +143,20 @@ export declare class SageEmbed extends V1Embed {
|
|
|
130
143
|
/**
|
|
131
144
|
* Constructs a map of parameters to be passed on to the
|
|
132
145
|
* embedded Eureka or Sage search page.
|
|
146
|
+
*
|
|
133
147
|
* @returns {string} query string
|
|
134
148
|
*/
|
|
135
149
|
protected getEmbedParams(): string;
|
|
136
150
|
/**
|
|
137
151
|
* Construct the URL of the embedded ThoughtSpot sage to be
|
|
138
152
|
* loaded in the iframe
|
|
153
|
+
*
|
|
139
154
|
* @returns {string} iframe url
|
|
140
155
|
*/
|
|
141
156
|
getIFrameSrc(): string;
|
|
142
157
|
/**
|
|
143
158
|
* Render the embedded ThoughtSpot Sage
|
|
159
|
+
*
|
|
144
160
|
* @returns {SageEmbed} Eureka/Sage embed
|
|
145
161
|
*/
|
|
146
162
|
render(): Promise<SageEmbed>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sage.d.ts","sourceRoot":"","sources":["sage.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"sage.d.ts","sourceRoot":"","sources":["sage.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,WAAW,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,YAAY,GAAG,aAAa,GAAG,0BAA0B,CACjH;IACD;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AACD;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,OAAO;IAClC;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;gBAGzB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc;IAKhE;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM;IA4BlC;;;;;OAKG;IACI,YAAY,IAAI,MAAM;IAqB7B;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;CAQ5C"}
|
|
@@ -8,8 +8,11 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
8
8
|
/**
|
|
9
9
|
* The array of data source GUIDs to set on load.
|
|
10
10
|
* Only a single data source is supported currently.
|
|
11
|
+
*
|
|
11
12
|
* @deprecated Use `dataSource` instead
|
|
13
|
+
*
|
|
12
14
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.1-sw
|
|
15
|
+
*
|
|
13
16
|
* @example
|
|
14
17
|
* ```js
|
|
15
18
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -21,7 +24,9 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
21
24
|
dataSources?: string[];
|
|
22
25
|
/**
|
|
23
26
|
* Pass the ID of the source to be selected.
|
|
27
|
+
*
|
|
24
28
|
* @version: SDK: 1.19.0, ThoughtSpot 9.0.0.cl, 9.0.1.sw
|
|
29
|
+
*
|
|
25
30
|
* @example
|
|
26
31
|
* ```js
|
|
27
32
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -33,7 +38,9 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
33
38
|
dataSource?: string;
|
|
34
39
|
/**
|
|
35
40
|
* Boolean to define if the last selected data source should be used
|
|
41
|
+
*
|
|
36
42
|
* @version: SDK: 1.24.0, ThoughtSpot 9.5.0.cl, 9.5.0.sw
|
|
43
|
+
*
|
|
37
44
|
* @example
|
|
38
45
|
* ```js
|
|
39
46
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -53,7 +60,9 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
53
60
|
* If it is executed, the focus is placed on the results.
|
|
54
61
|
* If it’s not executed, the focus is placed at the end of
|
|
55
62
|
* the token string in the search bar.
|
|
63
|
+
*
|
|
56
64
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.4.0.sw
|
|
65
|
+
*
|
|
57
66
|
* @example
|
|
58
67
|
* ```js
|
|
59
68
|
* const embed = new SearchBarEmbed('#tsEmbed', {
|
|
@@ -69,6 +78,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
|
|
|
69
78
|
}
|
|
70
79
|
/**
|
|
71
80
|
* Embed ThoughtSpot search bar
|
|
81
|
+
*
|
|
72
82
|
* @version: SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl, 9.0.1-sw
|
|
73
83
|
* @group Embed components
|
|
74
84
|
*/
|
|
@@ -82,6 +92,7 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
82
92
|
/**
|
|
83
93
|
* Construct the URL of the embedded ThoughtSpot search to be
|
|
84
94
|
* loaded in the iframe
|
|
95
|
+
*
|
|
85
96
|
* @param dataSources A list of data source GUIDs
|
|
86
97
|
*/
|
|
87
98
|
private getIFrameSrc;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search-bar.d.ts","sourceRoot":"","sources":["search-bar.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAE7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACR,gBAAgB,GAChB,YAAY,GACZ,aAAa,GACb,uBAAuB,GACvB,wBAAwB,GACxB,YAAY,GACZ,aAAa,GACb,0BAA0B,CAC/B;IACD
|
|
1
|
+
{"version":3,"file":"search-bar.d.ts","sourceRoot":"","sources":["search-bar.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAS,UAAU,EAAE,MAAM,UAAU,CAAC;AAE7C,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACR,gBAAgB,GAChB,YAAY,GACZ,aAAa,GACb,uBAAuB,GACvB,wBAAwB,GACxB,YAAY,GACZ,aAAa,GACb,0BAA0B,CAC/B;IACD;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;OAYG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,SAAS,CAAC,kBAAkB,SAAoB;gBAEpC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB;IAKhE;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IA2CpB;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;CAOjD"}
|
|
@@ -2,10 +2,11 @@
|
|
|
2
2
|
* Copyright (c) 2022
|
|
3
3
|
*
|
|
4
4
|
* Embed ThoughtSpot search or a saved answer
|
|
5
|
+
*
|
|
5
6
|
* @summary Search embed
|
|
6
7
|
* @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
|
|
7
8
|
*/
|
|
8
|
-
import {
|
|
9
|
+
import { DOMSelector, Action, ViewConfig } from '../types';
|
|
9
10
|
import { TsEmbed } from './ts-embed';
|
|
10
11
|
/**
|
|
11
12
|
* Configuration for search options.
|
|
@@ -44,13 +45,16 @@ export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
|
44
45
|
}
|
|
45
46
|
/**
|
|
46
47
|
* The configuration attributes for the embedded search view.
|
|
48
|
+
*
|
|
47
49
|
* @group Embed components
|
|
48
50
|
*/
|
|
49
51
|
export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules' | 'hiddenHomeLeftNavItems' | 'hiddenTabs' | 'visibleTabs' | 'reorderedHomepageModules'> {
|
|
50
52
|
/**
|
|
51
53
|
* If set to true, the data sources panel is collapsed on load,
|
|
52
54
|
* but can be expanded manually.
|
|
55
|
+
*
|
|
53
56
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
57
|
+
*
|
|
54
58
|
* @example
|
|
55
59
|
* ```js
|
|
56
60
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -62,7 +66,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
62
66
|
collapseDataSources?: boolean;
|
|
63
67
|
/**
|
|
64
68
|
* Show or hide the data sources panel.
|
|
69
|
+
*
|
|
65
70
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
71
|
+
*
|
|
66
72
|
* @example
|
|
67
73
|
* ```js
|
|
68
74
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -76,7 +82,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
76
82
|
* Show or hide the charts and tables in search answers.
|
|
77
83
|
* This attribute can be used to create a custom visualization
|
|
78
84
|
* using raw answer data.
|
|
85
|
+
*
|
|
79
86
|
* @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
|
|
87
|
+
*
|
|
80
88
|
* @example
|
|
81
89
|
* ```js
|
|
82
90
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -86,13 +94,11 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
86
94
|
* ```
|
|
87
95
|
*/
|
|
88
96
|
hideResults?: boolean;
|
|
89
|
-
/**
|
|
90
|
-
* If set to true, expands all the data sources panel.
|
|
91
|
-
*/
|
|
92
|
-
expandAllDataSource?: boolean;
|
|
93
97
|
/**
|
|
94
98
|
* If set to true, the Search Assist feature is enabled.
|
|
99
|
+
*
|
|
95
100
|
* @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
|
|
101
|
+
*
|
|
96
102
|
* @example
|
|
97
103
|
* ```js
|
|
98
104
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -105,7 +111,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
105
111
|
/**
|
|
106
112
|
* If set to true, the tabular view is set as the default
|
|
107
113
|
* format for presenting search data.
|
|
114
|
+
*
|
|
108
115
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
116
|
+
*
|
|
109
117
|
* @example
|
|
110
118
|
* ```js
|
|
111
119
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -117,7 +125,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
117
125
|
/**
|
|
118
126
|
* The array of data source GUIDs to set on load.
|
|
119
127
|
* Only a single data source is supported currently.
|
|
128
|
+
*
|
|
120
129
|
* @deprecated Use `dataSource` instead.
|
|
130
|
+
*
|
|
121
131
|
* @example
|
|
122
132
|
* ```js
|
|
123
133
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -129,7 +139,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
129
139
|
dataSources?: string[];
|
|
130
140
|
/**
|
|
131
141
|
* The array of data source GUIDs to set on load.
|
|
142
|
+
*
|
|
132
143
|
* @version: SDK: 1.19.0
|
|
144
|
+
*
|
|
133
145
|
* @example
|
|
134
146
|
* ```js
|
|
135
147
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -141,6 +153,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
141
153
|
dataSource?: string;
|
|
142
154
|
/**
|
|
143
155
|
* The initial search query to load the answer with.
|
|
156
|
+
*
|
|
144
157
|
* @deprecated
|
|
145
158
|
*
|
|
146
159
|
* Use {@link searchOptions} instead.
|
|
@@ -156,6 +169,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
156
169
|
* If it is executed, the focus is placed on the results.
|
|
157
170
|
* If it’s not executed, the focus is placed at the end of
|
|
158
171
|
* the token string in the search bar.
|
|
172
|
+
*
|
|
159
173
|
* @example
|
|
160
174
|
* ```js
|
|
161
175
|
* searchOptions: {
|
|
@@ -167,7 +181,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
167
181
|
searchOptions?: SearchOptions;
|
|
168
182
|
/**
|
|
169
183
|
* The GUID of a saved answer to load initially.
|
|
184
|
+
*
|
|
170
185
|
* @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
|
|
186
|
+
*
|
|
171
187
|
* @example
|
|
172
188
|
* ```js
|
|
173
189
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -180,7 +196,9 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
180
196
|
/**
|
|
181
197
|
* If set to true, the search page will render without the Search Bar
|
|
182
198
|
* The chart/table should still be visible.
|
|
199
|
+
*
|
|
183
200
|
* @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
|
|
201
|
+
*
|
|
184
202
|
* @example
|
|
185
203
|
* ```js
|
|
186
204
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -192,8 +210,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
192
210
|
hideSearchBar?: boolean;
|
|
193
211
|
/**
|
|
194
212
|
* Flag to control Data panel experience
|
|
213
|
+
*
|
|
195
214
|
* @default false
|
|
196
215
|
* @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
|
|
216
|
+
*
|
|
197
217
|
* @example
|
|
198
218
|
* ```js
|
|
199
219
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -205,19 +225,23 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
205
225
|
dataPanelV2?: boolean;
|
|
206
226
|
/**
|
|
207
227
|
* Flag to set if last selected dataSource should be used
|
|
228
|
+
*
|
|
208
229
|
* @version: SDK: 1.24.0
|
|
209
230
|
*/
|
|
210
231
|
useLastSelectedSources?: boolean;
|
|
211
232
|
/**
|
|
212
233
|
* To set the initial state of the search bar in case of saved-answers.
|
|
234
|
+
*
|
|
213
235
|
* @default false
|
|
214
236
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
215
237
|
*/
|
|
216
238
|
collapseSearchBarInitially?: boolean;
|
|
217
239
|
/**
|
|
218
240
|
* To enable custom column groups in data panel v2
|
|
241
|
+
*
|
|
219
242
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
220
243
|
* @default false
|
|
244
|
+
*
|
|
221
245
|
* @example
|
|
222
246
|
* ```js
|
|
223
247
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -229,6 +253,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
229
253
|
enableCustomColumnGroups?: boolean;
|
|
230
254
|
/**
|
|
231
255
|
* Flag to enable onBeforeSearchExecute Embed Event
|
|
256
|
+
*
|
|
232
257
|
* @version: SDK: 1.29.0 | Thoughtspot: 10.1.0.cl
|
|
233
258
|
*/
|
|
234
259
|
isOnBeforeGetVizDataInterceptEnabled?: boolean;
|
|
@@ -239,8 +264,10 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
239
264
|
* - EXPAND_ALL: Expand all the accordion initially in data panel v2.
|
|
240
265
|
* - COLLAPSE_ALL: Collapse all the accordions initially in data panel v2.
|
|
241
266
|
* - EXPAND_FIRST: Expand the first accordion and collapse the rest.
|
|
267
|
+
*
|
|
242
268
|
* @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
|
|
243
269
|
* @default DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL
|
|
270
|
+
*
|
|
244
271
|
* @example
|
|
245
272
|
* ```js
|
|
246
273
|
* const embed = new SearchEmbed('#tsEmbed', {
|
|
@@ -255,6 +282,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
|
|
|
255
282
|
export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
|
|
256
283
|
/**
|
|
257
284
|
* Embed ThoughtSpot search
|
|
285
|
+
*
|
|
258
286
|
* @group Embed components
|
|
259
287
|
*/
|
|
260
288
|
export declare class SearchEmbed extends TsEmbed {
|
|
@@ -272,6 +300,7 @@ export declare class SearchEmbed extends TsEmbed {
|
|
|
272
300
|
/**
|
|
273
301
|
* Construct the URL of the embedded ThoughtSpot search to be
|
|
274
302
|
* loaded in the iframe
|
|
303
|
+
*
|
|
275
304
|
* @param answerId The GUID of a saved answer
|
|
276
305
|
* @param dataSources A list of data source GUIDs
|
|
277
306
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["search.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAEH,WAAW,EAEX,MAAM,EACN,UAAU,EACb,MAAM,UAAU,CAAC;AAOlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAMrC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBACb,SAAQ,IAAI,CACR,UAAU,EACR,uBAAuB,GACvB,wBAAwB,GACxB,YAAY,GACZ,aAAa,GACb,0BAA0B,CAC/B;IACD;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;;;;;;;;;OAaG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;OAIG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0CAA0C,CAAC,EAAE,yCAAyC,CAAC;CAC1F;AAED,eAAO,MAAM,uCAAuC,UAMnD,CAAC;AAEF;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,OAAO;IACpC;;OAEG;IACH,SAAS,CAAC,UAAU,EAAE,gBAAgB,CAAC;gBAE3B,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,gBAAgB;IAKlE;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAYzB,SAAS,CAAC,cAAc,IAAI,MAAM;IAoGlC;;;;;;OAMG;IACI,YAAY,IAAI,MAAM;IAQ7B;;OAEG;IACU,MAAM,IAAI,OAAO,CAAC,WAAW,CAAC;CAmB9C"}
|