@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0
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/css-variables.d.ts +95 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +136 -15
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +59 -37
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +419 -149
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +230 -1
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +30 -16
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +221 -17
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/events.spec.js +635 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.js +151 -0
- package/cjs/src/embed/host-events.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +51 -14
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js +11 -1
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +9 -0
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +218 -0
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.d.ts +2 -0
- package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.js +32 -2
- package/cjs/src/embed/hostEventClient/utils.js.map +1 -1
- package/cjs/src/embed/hostEventClient/utils.spec.js +178 -0
- package/cjs/src/embed/hostEventClient/utils.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +42 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +26 -6
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +83 -2
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +8 -1
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-utils.js +14 -1
- package/cjs/src/embed/spotter-utils.js.map +1 -1
- package/cjs/src/embed/spotter-utils.spec.js +61 -0
- package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.d.ts +34 -0
- package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.spec.js +17 -0
- package/cjs/src/embed/spotter-viz-utils.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +29 -7
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +146 -0
- 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/index.d.ts +2 -2
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +3 -2
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/mixpanel-service.d.ts +4 -0
- package/cjs/src/mixpanel-service.d.ts.map +1 -1
- package/cjs/src/mixpanel-service.js +4 -0
- package/cjs/src/mixpanel-service.js.map +1 -1
- package/cjs/src/react/util.spec.js +251 -0
- package/cjs/src/react/util.spec.js.map +1 -1
- package/cjs/src/types.d.ts +573 -11
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +519 -2
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/processData.spec.js +93 -0
- package/cjs/src/utils/processData.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.spec.js +61 -0
- package/cjs/src/utils/processTrigger.spec.js.map +1 -1
- package/dist/{index-B5xoN6Cp.js → index-aBzH5ZwF.js} +1 -1
- package/dist/src/css-variables.d.ts +95 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +136 -15
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +230 -1
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +51 -14
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/utils.d.ts +2 -0
- package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +42 -1
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +8 -1
- package/dist/src/embed/spotter-utils.d.ts.map +1 -1
- package/dist/src/embed/spotter-viz-utils.d.ts +34 -0
- package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.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/index.d.ts +2 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/mixpanel-service.d.ts +4 -0
- package/dist/src/mixpanel-service.d.ts.map +1 -1
- package/dist/src/types.d.ts +573 -11
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +936 -142
- package/dist/tsembed-react.js +935 -141
- package/dist/tsembed.es.js +935 -142
- package/dist/tsembed.js +933 -140
- package/dist/visual-embed-sdk-react-full.d.ts +1147 -44
- package/dist/visual-embed-sdk-react.d.ts +1153 -46
- package/dist/visual-embed-sdk.d.ts +1161 -46
- package/lib/package.json +1 -1
- package/lib/src/css-variables.d.ts +95 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +136 -15
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +60 -38
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +420 -150
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +230 -1
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +31 -17
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +222 -18
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/events.spec.js +635 -0
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.js +152 -1
- package/lib/src/embed/host-events.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +51 -14
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js +10 -0
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts +1 -0
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +10 -1
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +218 -0
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.d.ts +2 -0
- package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/utils.js +28 -1
- package/lib/src/embed/hostEventClient/utils.js.map +1 -1
- package/lib/src/embed/hostEventClient/utils.spec.js +179 -1
- package/lib/src/embed/hostEventClient/utils.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +42 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +26 -6
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +83 -2
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +8 -1
- package/lib/src/embed/spotter-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-utils.js +12 -0
- package/lib/src/embed/spotter-utils.js.map +1 -1
- package/lib/src/embed/spotter-utils.spec.js +62 -1
- package/lib/src/embed/spotter-utils.spec.js.map +1 -1
- package/lib/src/embed/spotter-viz-utils.d.ts +34 -0
- package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-viz-utils.js.map +1 -1
- package/lib/src/embed/spotter-viz-utils.spec.js +17 -0
- package/lib/src/embed/spotter-viz-utils.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +29 -7
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +146 -0
- 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/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/mixpanel-service.d.ts +4 -0
- package/lib/src/mixpanel-service.d.ts.map +1 -1
- package/lib/src/mixpanel-service.js +4 -0
- package/lib/src/mixpanel-service.js.map +1 -1
- package/lib/src/react/util.spec.js +251 -0
- package/lib/src/react/util.spec.js.map +1 -1
- package/lib/src/types.d.ts +573 -11
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +519 -2
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/processData.spec.js +93 -0
- package/lib/src/utils/processData.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.spec.js +61 -0
- package/lib/src/utils/processTrigger.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +1161 -46
- package/package.json +1 -1
- package/src/css-variables.ts +118 -0
- package/src/embed/app.spec.ts +530 -183
- package/src/embed/app.ts +209 -66
- package/src/embed/conversation.spec.ts +275 -21
- package/src/embed/conversation.ts +262 -17
- package/src/embed/events.spec.ts +757 -1
- package/src/embed/host-events.spec.ts +194 -0
- package/src/embed/hostEventClient/contracts.ts +57 -14
- package/src/embed/hostEventClient/host-event-client.spec.ts +338 -0
- package/src/embed/hostEventClient/host-event-client.ts +16 -0
- package/src/embed/hostEventClient/utils.spec.ts +204 -0
- package/src/embed/hostEventClient/utils.ts +37 -10
- package/src/embed/liveboard.spec.ts +108 -2
- package/src/embed/liveboard.ts +82 -14
- package/src/embed/spotter-utils.spec.ts +68 -1
- package/src/embed/spotter-utils.ts +16 -1
- package/src/embed/spotter-viz-utils.spec.ts +17 -0
- package/src/embed/spotter-viz-utils.ts +34 -0
- package/src/embed/ts-embed.spec.ts +186 -0
- package/src/embed/ts-embed.ts +30 -4
- package/src/errors.ts +1 -0
- package/src/index.ts +3 -1
- package/src/mixpanel-service.ts +4 -0
- package/src/react/util.spec.tsx +255 -0
- package/src/types.ts +575 -8
- package/src/utils/processData.spec.ts +97 -0
- package/src/utils/processTrigger.spec.ts +91 -0
package/dist/src/embed/app.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
*/
|
|
10
10
|
import { DOMSelector, MessagePayload, AllEmbedViewConfig, DefaultAppInitData, VisualizationOverrides } from '../types';
|
|
11
11
|
import { V1Embed } from './ts-embed';
|
|
12
|
-
import { SpotterChatViewConfig, SpotterSidebarViewConfig } from './conversation';
|
|
12
|
+
import { SpotterChatViewConfig, SpotterSidebarViewConfig, SpotterQueryMode, SpotterShareConversationConfig } from './conversation';
|
|
13
13
|
import { SpotterVizConfig } from './spotter-viz-utils';
|
|
14
14
|
/**
|
|
15
15
|
* Pages within the ThoughtSpot app that can be embedded.
|
|
@@ -46,7 +46,11 @@ export declare enum Page {
|
|
|
46
46
|
/**
|
|
47
47
|
* Monitor Alerts Page
|
|
48
48
|
*/
|
|
49
|
-
Monitor = "monitor"
|
|
49
|
+
Monitor = "monitor",
|
|
50
|
+
/**
|
|
51
|
+
* Collections listing page
|
|
52
|
+
*/
|
|
53
|
+
Collections = "collections"
|
|
50
54
|
}
|
|
51
55
|
/**
|
|
52
56
|
* Define the initial state of column custom group accordions
|
|
@@ -91,6 +95,9 @@ export declare enum HomePage {
|
|
|
91
95
|
/**
|
|
92
96
|
* Modular (v2) introduces the updated Modular Home Experience.
|
|
93
97
|
* It serves as the foundational version of the home page.
|
|
98
|
+
* Use {@link HomePage.ModularWithStylingChanges} (V3) or
|
|
99
|
+
* {@link HomePage.Focused} (V4) instead.
|
|
100
|
+
* @deprecated V1 and V2 home page experiences are deprecated.
|
|
94
101
|
*/
|
|
95
102
|
Modular = "v2",
|
|
96
103
|
/**
|
|
@@ -164,13 +171,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
164
171
|
showPrimaryNavbar?: boolean;
|
|
165
172
|
/**
|
|
166
173
|
* Control the visibility of the left navigation panel on the home page
|
|
167
|
-
* in the
|
|
174
|
+
* in the V3 and V4 navigation and home page experience.
|
|
168
175
|
* If `showPrimaryNavbar` is true, that is, if the Global and Homepage
|
|
169
176
|
* navigation bars are visible, this flag will only hide the left navigation bar
|
|
170
177
|
* on the home page.
|
|
171
178
|
* The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
|
|
172
179
|
*
|
|
173
|
-
* **Note**:
|
|
180
|
+
* **Note**: The classic (V1) and Modular (V2) home page experiences are
|
|
181
|
+
* deprecated. This attribute applies to V3 and V4 home page experiences.
|
|
174
182
|
*
|
|
175
183
|
* Supported embed types: `AppEmbed`
|
|
176
184
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -236,11 +244,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
236
244
|
hideHamburger?: boolean;
|
|
237
245
|
/**
|
|
238
246
|
* Control the visibility of the object search
|
|
239
|
-
* on the top navigation bar in the
|
|
240
|
-
* V2 and V3 navigation experience.
|
|
247
|
+
* on the top navigation bar in the V3 navigation experience.
|
|
241
248
|
*
|
|
242
|
-
* **Note**:
|
|
243
|
-
*
|
|
249
|
+
* **Note**: The classic (V1) and V2 navigation experiences are
|
|
250
|
+
* deprecated. This attribute applies to the V3 navigation experience.
|
|
244
251
|
*
|
|
245
252
|
* Supported embed types: `AppEmbed`
|
|
246
253
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -258,8 +265,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
258
265
|
* Control the visibility of the notification icon
|
|
259
266
|
* on the top navigation bar in V3 navigation experience.
|
|
260
267
|
*
|
|
261
|
-
* **Note**:
|
|
262
|
-
*
|
|
268
|
+
* **Note**: The classic (V1) and V2 experience modes are deprecated.
|
|
269
|
+
* This attribute applies to the V3 experience.
|
|
263
270
|
*
|
|
264
271
|
* Supported embed types: `AppEmbed`
|
|
265
272
|
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
@@ -274,14 +281,14 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
274
281
|
*/
|
|
275
282
|
hideNotification?: boolean;
|
|
276
283
|
/**
|
|
277
|
-
* Control the visibility of the application selection menu
|
|
278
|
-
* in the top navigation bar in the V2 experience.
|
|
284
|
+
* Control the visibility of the application selection menu.
|
|
279
285
|
* In the V3 experience, it shows or hides application selection
|
|
280
286
|
* icons on the left navigation panel.
|
|
281
287
|
* By default, the application selection menu and icons are
|
|
282
288
|
* shown in the UI.
|
|
283
289
|
*
|
|
284
|
-
* **Note**:
|
|
290
|
+
* **Note**: The classic (V1) and V2 experiences are deprecated.
|
|
291
|
+
* This attribute applies to the V3 experience.
|
|
285
292
|
*
|
|
286
293
|
* Supported embed types: `AppEmbed`
|
|
287
294
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -299,7 +306,8 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
299
306
|
* Control the visibility of the Org switcher button on the nav-bar.
|
|
300
307
|
* By default, the Org switcher button is shown.
|
|
301
308
|
*
|
|
302
|
-
* **Note**:
|
|
309
|
+
* **Note**: The classic (V1) experience is deprecated. This attribute
|
|
310
|
+
* applies to V2 (deprecated), V3 and V4 experiences.
|
|
303
311
|
*
|
|
304
312
|
* Supported embed types: `AppEmbed`
|
|
305
313
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
@@ -458,6 +466,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
458
466
|
* Supported embed types: `AppEmbed`
|
|
459
467
|
* @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
|
|
460
468
|
* @default false
|
|
469
|
+
* Use the discoveryExperience.homePage option with
|
|
470
|
+
* {@link HomePage.ModularWithStylingChanges} (V3) or
|
|
471
|
+
* {@link HomePage.Focused} (V4) instead.
|
|
472
|
+
* @deprecated The V1 and V2 home page experiences are deprecated.
|
|
461
473
|
* @example
|
|
462
474
|
* ```js
|
|
463
475
|
* const embed = new AppEmbed('#tsEmbed', {
|
|
@@ -589,11 +601,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
589
601
|
/**
|
|
590
602
|
* Enables the 'what you see is what you get' PDF export for Liveboards. Each tab is rendered on a single page
|
|
591
603
|
* following the exact UI layout, instead of splitting visualizations across multiple A4 pages.
|
|
592
|
-
* This feature is GA from version
|
|
604
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.8.0.cl.
|
|
593
605
|
*
|
|
594
606
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
595
607
|
* @type {boolean}
|
|
596
608
|
* @version SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
|
|
609
|
+
* @default true
|
|
597
610
|
* @example
|
|
598
611
|
* ```js
|
|
599
612
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -606,10 +619,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
606
619
|
isContinuousLiveboardPDFEnabled?: boolean;
|
|
607
620
|
/**
|
|
608
621
|
* This flag is used to enable/disable the XLSX/CSV download option for Liveboards
|
|
622
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
|
|
609
623
|
*
|
|
610
624
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
611
625
|
* @type {boolean}
|
|
612
626
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
627
|
+
* @default true
|
|
613
628
|
* @example
|
|
614
629
|
* ```js
|
|
615
630
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -622,10 +637,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
622
637
|
isLiveboardXLSXCSVDownloadEnabled?: boolean;
|
|
623
638
|
/**
|
|
624
639
|
* This flag is used to enable/disable the granular XLSX/CSV schedules feature
|
|
640
|
+
* This feature is GA from SDK version 1.51.0 and ThoughtSpot version 26.6.0.cl
|
|
625
641
|
*
|
|
626
642
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
627
643
|
* @type {boolean}
|
|
628
644
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
645
|
+
* @default true
|
|
629
646
|
* @example
|
|
630
647
|
* ```js
|
|
631
648
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -701,6 +718,40 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
701
718
|
* ```
|
|
702
719
|
*/
|
|
703
720
|
updatedSpotterChatPrompt?: boolean;
|
|
721
|
+
/**
|
|
722
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
723
|
+
*
|
|
724
|
+
* Supported embed types: `AppEmbed`
|
|
725
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
726
|
+
* @default false
|
|
727
|
+
* @example
|
|
728
|
+
* ```js
|
|
729
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
730
|
+
* ... //other embed view config
|
|
731
|
+
* showSpotterRadiance : true,
|
|
732
|
+
* })
|
|
733
|
+
* ```
|
|
734
|
+
*/
|
|
735
|
+
showSpotterRadiance?: boolean;
|
|
736
|
+
/**
|
|
737
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
738
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
739
|
+
* instance only; it does not persist as a user preference and does
|
|
740
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
741
|
+
* Only applicable when navigating to Spotter within the app.
|
|
742
|
+
*
|
|
743
|
+
* Supported embed types: `AppEmbed`
|
|
744
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
745
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
746
|
+
* @example
|
|
747
|
+
* ```js
|
|
748
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
749
|
+
* ... //other embed view config
|
|
750
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
751
|
+
* })
|
|
752
|
+
* ```
|
|
753
|
+
*/
|
|
754
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
704
755
|
/**
|
|
705
756
|
* Controls the visibility of the past conversations sidebar.
|
|
706
757
|
*
|
|
@@ -726,6 +777,10 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
726
777
|
* spotterSidebarConfig: {
|
|
727
778
|
* enablePastConversationsSidebar: true,
|
|
728
779
|
* spotterSidebarTitle: 'My Conversations',
|
|
780
|
+
* // Opt in to pin/unpin conversations in embedded Spotter
|
|
781
|
+
* spotterChatPinConfig: {
|
|
782
|
+
* enabled: true,
|
|
783
|
+
* },
|
|
729
784
|
* },
|
|
730
785
|
* })
|
|
731
786
|
* ```
|
|
@@ -749,6 +804,49 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
749
804
|
* ```
|
|
750
805
|
*/
|
|
751
806
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
807
|
+
/**
|
|
808
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
809
|
+
*
|
|
810
|
+
* Supported embed types: `AppEmbed`
|
|
811
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
812
|
+
* @example
|
|
813
|
+
* ```js
|
|
814
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
815
|
+
* ... //other embed view config
|
|
816
|
+
* spotterShareConversationConfig: {
|
|
817
|
+
* enableShareConversation: true,
|
|
818
|
+
* },
|
|
819
|
+
* })
|
|
820
|
+
* ```
|
|
821
|
+
*/
|
|
822
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
823
|
+
/**
|
|
824
|
+
* Sets the default data sources (Models) for the Spotter experience shown on
|
|
825
|
+
* the home page of the full app embed. Accepts a list of Model GUIDs to
|
|
826
|
+
* preselect the data sources available to Spotter, or the literal
|
|
827
|
+
* `'auto_mode'` sentinel to load Spotter with the "Auto" model selected by
|
|
828
|
+
* default. This is consistent with how `worksheetId: 'auto_mode'` enables
|
|
829
|
+
* Auto mode in `SpotterEmbed`.
|
|
830
|
+
*
|
|
831
|
+
* **Note**: If `'auto_mode'` is included alongside one or more Model GUIDs,
|
|
832
|
+
* `'auto_mode'` takes precedence and is selected by default.
|
|
833
|
+
*
|
|
834
|
+
* **Note**: `'auto_mode'` requires the Spotter 3 experience with data source
|
|
835
|
+
* discovery enabled on your instance, and a Spotter-enabled home page (for
|
|
836
|
+
* example, `discoveryExperience.homePage: HomePage.Focused`).
|
|
837
|
+
*
|
|
838
|
+
* Supported embed types: `AppEmbed`
|
|
839
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
840
|
+
* @example
|
|
841
|
+
* ```js
|
|
842
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
843
|
+
* ... // other embed view config
|
|
844
|
+
* discoveryExperience: { homePage: HomePage.Focused },
|
|
845
|
+
* spotterDataSources: ['model-guid-1', 'model-guid-2'], // or ['auto_mode']
|
|
846
|
+
* })
|
|
847
|
+
* ```
|
|
848
|
+
*/
|
|
849
|
+
spotterDataSources?: string[];
|
|
752
850
|
/**
|
|
753
851
|
* Configuration for the SpotterViz interface shown on the Liveboard.
|
|
754
852
|
* Customize the brand name, description, chat input placeholder,
|
|
@@ -773,6 +871,12 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
773
871
|
* { label: 'Tip', text: 'try asking about revenue by region' },
|
|
774
872
|
* { label: 'Tip', text: 'use natural language' },
|
|
775
873
|
* ],
|
|
874
|
+
* // liveboardBrandName, spotterBrandName, insightTileBrandName, insightTileViewPlanLabel and insightTileLoaderText require SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
875
|
+
* liveboardBrandName: 'Reports',
|
|
876
|
+
* spotterBrandName: 'Analyst',
|
|
877
|
+
* insightTileBrandName: 'Insight card',
|
|
878
|
+
* insightTileViewPlanLabel: 'View plan',
|
|
879
|
+
* insightTileLoaderText: 'Generating insight',
|
|
776
880
|
* },
|
|
777
881
|
* })
|
|
778
882
|
* ```
|
|
@@ -838,6 +942,21 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
838
942
|
* @version SDK: 1.49.0 | ThoughtSpot: 26.6.0.cl
|
|
839
943
|
*/
|
|
840
944
|
visualOverrides?: VisualizationOverrides;
|
|
945
|
+
/**
|
|
946
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
947
|
+
*
|
|
948
|
+
* Supported embed types: `AppEmbed`
|
|
949
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
950
|
+
* @default false
|
|
951
|
+
* @example
|
|
952
|
+
* ```js
|
|
953
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
954
|
+
* ... //other embed view config
|
|
955
|
+
* updatedSpotterExperience : true,
|
|
956
|
+
* })
|
|
957
|
+
* ```
|
|
958
|
+
*/
|
|
959
|
+
updatedSpotterExperience?: boolean;
|
|
841
960
|
}
|
|
842
961
|
/**
|
|
843
962
|
* APP_INIT data shape for AppEmbed.
|
|
@@ -847,6 +966,7 @@ export interface AppEmbedAppInitData extends DefaultAppInitData {
|
|
|
847
966
|
embedParams?: {
|
|
848
967
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
849
968
|
spotterVizConfig?: SpotterVizConfig;
|
|
969
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
850
970
|
};
|
|
851
971
|
}
|
|
852
972
|
/**
|
|
@@ -877,6 +997,7 @@ export declare class AppEmbed extends V1Embed {
|
|
|
877
997
|
* embedded Liveboard or visualization.
|
|
878
998
|
*/
|
|
879
999
|
protected getEmbedParams(): string;
|
|
1000
|
+
protected getEmbedParamsObject(): any;
|
|
880
1001
|
private sendFullHeightLazyLoadData;
|
|
881
1002
|
/**
|
|
882
1003
|
* This is a handler for the RequestVisibleEmbedCoordinates event.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAGX,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EAEzB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;
|
|
1
|
+
{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAGX,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EAEzB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,8BAA8B,EAAE,MAAM,gBAAgB,CAAC;AAEnI,OAAO,EAAE,gBAAgB,EAA8B,MAAM,qBAAqB,CAAC;AAEnF;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,aAAa;IACnB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,WAAW,gBAAgB;CAC9B;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED,oBAAY,qBAAqB;IAC7B,aAAa,iBAAiB;IAC9B,SAAS,aAAa;IACtB,IAAI,SAAS;CAChB;AAED;;;GAGG;AACH,oBAAY,oBAAoB;IAC5B;;;;OAIG;IACH,OAAO,OAAO;CACjB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAChB;;;;;;OAMG;IACH,OAAO,OAAO;IACd;;;OAGG;IACH,yBAAyB,OAAO;IAChC;;;;;;OAMG;IACH,OAAO,OAAO;CACjB;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAChB;;;OAGG;IACH,IAAI,OAAO;IACX;;OAEG;IACH,iBAAiB,OAAO;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC;;OAEG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,eAAe,CAAC,EAAE,QAAQ,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACrD;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;OAcG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;;OAiBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;;;;;OAkBG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;;;;;;OAkBG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0CAA0C,CAAC,EAAE,yCAAyC,CAAC;IACvF;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C;;;;;;;;;;;;;OAaG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAE3C;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;;;;;;;;;;;;;OAeG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAE/C;;;;;;;;;;;;;;;OAeG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IAExC;;;;;;;;;;;;;;;;;OAiBG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAE1C;;;;;;;;;;;;;;;;OAgBG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;;;;;;;;;;;;;;;OAgBG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;;;;;;;;;;;;;OAcG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;OASG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAE/C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;;;;;;OAQG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;IAChD;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAC1C;;;;;;;;;;;;;;OAcG;IACH,8BAA8B,CAAC,EAAE,8BAA8B,CAAC;IAChE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;;;;;OAOG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;;;;;;;OAcG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,eAAe,CAAC,EAAE,sBAAsB,CAAC;IAEzC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC3D,WAAW,CAAC,EAAE;QACV,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;QAChD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;QACpC,8BAA8B,CAAC,EAAE,8BAA8B,CAAC;KACnE,CAAC;CACL;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAO;IAE5B,OAAO,CAAC,wBAAwB,CAAqB;IAErD,OAAO,CAAC,sBAAsB,CAA6B;gBAE/C,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAc/D;;;;;;;;;;;OAWG;cACa,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAW9D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAKxB,SAAS,CAAC,oBAAoB;IAoT9B,OAAO,CAAC,0BAA0B,CASjC;IAED;;;;;OAKG;IACH,OAAO,CAAC,qCAAqC,CAO5C;IAED;;;OAGG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAGlD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAqBzC;IAEF;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAwBpB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;OAUG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAuBpE;;;OAGG;IACI,OAAO;IAKd,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,sBAAsB;IA6B9B,OAAO,CAAC,wBAAwB;IAahC;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAS3C"}
|
|
@@ -9,6 +9,45 @@ export interface SearchOptions {
|
|
|
9
9
|
*/
|
|
10
10
|
searchQuery: string;
|
|
11
11
|
}
|
|
12
|
+
/**
|
|
13
|
+
* The query mode Spotter uses when answering a question.
|
|
14
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
15
|
+
*/
|
|
16
|
+
export declare enum SpotterQueryMode {
|
|
17
|
+
FAST_SEARCH = "fastSearch",
|
|
18
|
+
RESEARCH = "research"
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* Configuration for the pin/unpin conversation feature in the Spotter sidebar.
|
|
22
|
+
* Grouped into one object because pin exposes several related settings
|
|
23
|
+
* (enable + label overrides), unlike single-item actions like rename or
|
|
24
|
+
* delete.
|
|
25
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
26
|
+
*/
|
|
27
|
+
export interface SpotterChatPinConfig {
|
|
28
|
+
/**
|
|
29
|
+
* Enables the pin/unpin conversation feature in embedded Spotter. Disabled
|
|
30
|
+
* by default — hosts must opt in. When off, the Pin/Unpin menu entry and
|
|
31
|
+
* the pin glyph are hidden and the PinSpotterConversation /
|
|
32
|
+
* UnpinSpotterConversation host events are no-ops. Native (non-embedded)
|
|
33
|
+
* Spotter is unaffected and ships pin enabled.
|
|
34
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
35
|
+
* @default false
|
|
36
|
+
*/
|
|
37
|
+
enabled?: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Custom label text for the pin action in the conversation edit menu.
|
|
40
|
+
* Defaults to translated "Pin" text.
|
|
41
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
42
|
+
*/
|
|
43
|
+
pinLabel?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Custom label text for the unpin action in the conversation edit menu.
|
|
46
|
+
* Defaults to translated "Unpin" text.
|
|
47
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
48
|
+
*/
|
|
49
|
+
unpinLabel?: string;
|
|
50
|
+
}
|
|
12
51
|
/**
|
|
13
52
|
* Configuration for the Spotter sidebar.
|
|
14
53
|
* Can be used in SpotterEmbed and AppEmbed.
|
|
@@ -46,6 +85,12 @@ export interface SpotterSidebarViewConfig {
|
|
|
46
85
|
* @version SDK: 1.47.0 | ThoughtSpot: 26.4.0.cl
|
|
47
86
|
*/
|
|
48
87
|
spotterChatDeleteLabel?: string;
|
|
88
|
+
/**
|
|
89
|
+
* Pin/unpin conversation feature config (enable + label overrides).
|
|
90
|
+
* Off by default in embed — hosts opt in via `enabled`.
|
|
91
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
92
|
+
*/
|
|
93
|
+
spotterChatPinConfig?: SpotterChatPinConfig;
|
|
49
94
|
/**
|
|
50
95
|
* Custom title text for the delete conversation confirmation modal.
|
|
51
96
|
* Defaults to translated "Delete chat" text.
|
|
@@ -96,6 +141,84 @@ export interface SpotterSidebarViewConfig {
|
|
|
96
141
|
*/
|
|
97
142
|
spotterAnalystsLabel?: string;
|
|
98
143
|
}
|
|
144
|
+
/**
|
|
145
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
146
|
+
* Can be used in SpotterEmbed and AppEmbed.
|
|
147
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
148
|
+
* @group Embed components
|
|
149
|
+
*/
|
|
150
|
+
export interface SpotterShareConversationConfig {
|
|
151
|
+
/**
|
|
152
|
+
* Enables sharing of the conversation.
|
|
153
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
154
|
+
* @default false
|
|
155
|
+
*/
|
|
156
|
+
enableShareConversation?: boolean;
|
|
157
|
+
/**
|
|
158
|
+
* Header Share button + sidebar Share item label.
|
|
159
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
160
|
+
* @default "Share"
|
|
161
|
+
*/
|
|
162
|
+
spotterShareLabel?: string;
|
|
163
|
+
/**
|
|
164
|
+
* Share modal title.
|
|
165
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
166
|
+
*/
|
|
167
|
+
spotterShareModalTitle?: string;
|
|
168
|
+
/**
|
|
169
|
+
* Modal confirm button label.
|
|
170
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
171
|
+
* @default "Share"
|
|
172
|
+
*/
|
|
173
|
+
spotterShareConfirmLabel?: string;
|
|
174
|
+
/**
|
|
175
|
+
* Modal cancel button label.
|
|
176
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
177
|
+
* @default "Cancel"
|
|
178
|
+
*/
|
|
179
|
+
spotterShareCancelLabel?: string;
|
|
180
|
+
/**
|
|
181
|
+
* "Add users or groups" label.
|
|
182
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
183
|
+
*/
|
|
184
|
+
spotterShareAddUsersLabel?: string;
|
|
185
|
+
/**
|
|
186
|
+
* Empty-state title ("No users added yet").
|
|
187
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
188
|
+
*/
|
|
189
|
+
spotterShareEmptyTitle?: string;
|
|
190
|
+
/**
|
|
191
|
+
* Empty-state subtitle ("Not shared with any user").
|
|
192
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
193
|
+
*/
|
|
194
|
+
spotterShareEmptySubtitle?: string;
|
|
195
|
+
/**
|
|
196
|
+
* "Include new messages since last shared version" checkbox label.
|
|
197
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
198
|
+
*/
|
|
199
|
+
spotterShareIncludeNewMessagesLabel?: string;
|
|
200
|
+
/**
|
|
201
|
+
* Footer note when the snapshot is current ("…up to the current moment…").
|
|
202
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
203
|
+
*/
|
|
204
|
+
spotterShareUpToCurrentLabel?: string;
|
|
205
|
+
/**
|
|
206
|
+
* Stale-snapshot info banner text ("All added users and groups will receive…").
|
|
207
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
208
|
+
*/
|
|
209
|
+
spotterShareStaleInfoLabel?: string;
|
|
210
|
+
/**
|
|
211
|
+
* Read-only shared-view data-access banner message.
|
|
212
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
213
|
+
*/
|
|
214
|
+
spotterSharedConversationBannerMessage?: string;
|
|
215
|
+
/**
|
|
216
|
+
* Read-only shared-view Exit button label.
|
|
217
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
218
|
+
* @default "Exit"
|
|
219
|
+
*/
|
|
220
|
+
spotterSharedConversationExitLabel?: string;
|
|
221
|
+
}
|
|
99
222
|
/**
|
|
100
223
|
* Configuration for customizing Spotter chat UI branding.
|
|
101
224
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
@@ -150,8 +273,27 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
150
273
|
/**
|
|
151
274
|
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
152
275
|
* this object to query data and generate Answers.
|
|
276
|
+
* This field is optional. If not provided, Spotter loads using the
|
|
277
|
+
* previously selected user data source.
|
|
278
|
+
*/
|
|
279
|
+
worksheetId?: string;
|
|
280
|
+
/**
|
|
281
|
+
* The array of data source GUIDs to set on load. Spotter uses
|
|
282
|
+
* these GUIDs to query data and generate Answers.
|
|
283
|
+
* dataSources is preferred over worksheetId if both are provided.
|
|
284
|
+
* The feature is currently behind a feature flag.
|
|
285
|
+
*
|
|
286
|
+
* Supported embed types: `SpotterEmbed`
|
|
287
|
+
* @example
|
|
288
|
+
* ```js
|
|
289
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
290
|
+
* // ...other embed view config
|
|
291
|
+
* dataSources: ['id-2345', 'id-2345'],
|
|
292
|
+
* });
|
|
293
|
+
* ```
|
|
294
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
153
295
|
*/
|
|
154
|
-
|
|
296
|
+
dataSources?: string[];
|
|
155
297
|
/**
|
|
156
298
|
* Ability to pass a starting search query to the conversation.
|
|
157
299
|
*/
|
|
@@ -311,6 +453,39 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
311
453
|
* ```
|
|
312
454
|
*/
|
|
313
455
|
updatedSpotterChatPrompt?: boolean;
|
|
456
|
+
/**
|
|
457
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
458
|
+
*
|
|
459
|
+
* Supported embed types: `SpotterEmbed`
|
|
460
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
461
|
+
* @default false
|
|
462
|
+
* @example
|
|
463
|
+
* ```js
|
|
464
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
465
|
+
* ... //other embed view config
|
|
466
|
+
* showSpotterRadiance : true,
|
|
467
|
+
* })
|
|
468
|
+
* ```
|
|
469
|
+
*/
|
|
470
|
+
showSpotterRadiance?: boolean;
|
|
471
|
+
/**
|
|
472
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
473
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
474
|
+
* instance only; it does not persist as a user preference and does
|
|
475
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
476
|
+
*
|
|
477
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
478
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
479
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
480
|
+
* @example
|
|
481
|
+
* ```js
|
|
482
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
483
|
+
* ... //other embed view config
|
|
484
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
485
|
+
* })
|
|
486
|
+
* ```
|
|
487
|
+
*/
|
|
488
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
314
489
|
/**
|
|
315
490
|
* Enables the stop answer generation button in the Spotter embed UI,
|
|
316
491
|
* allowing users to interrupt an ongoing answer generation.
|
|
@@ -369,6 +544,59 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
369
544
|
* ```
|
|
370
545
|
*/
|
|
371
546
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
547
|
+
/**
|
|
548
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
549
|
+
*
|
|
550
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
551
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
552
|
+
* @example
|
|
553
|
+
* ```js
|
|
554
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
555
|
+
* ... //other embed view config
|
|
556
|
+
* spotterShareConversationConfig: {
|
|
557
|
+
* enableShareConversation: true,
|
|
558
|
+
* },
|
|
559
|
+
* })
|
|
560
|
+
* ```
|
|
561
|
+
*/
|
|
562
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
563
|
+
/**
|
|
564
|
+
* The ID of a shared Spotter conversation to open directly in the read-only
|
|
565
|
+
* reader view. Use this to land a share recipient in the shared conversation
|
|
566
|
+
* when they open a host-configured `CONVERSATION_URL` share link: read the
|
|
567
|
+
* `{conversation-id}` from your page URL and pass it here.
|
|
568
|
+
*
|
|
569
|
+
* Requires the Spotter conversation-sharing feature to be enabled
|
|
570
|
+
* (`spotterShareConversationConfig.enableShareConversation`). The recipient
|
|
571
|
+
* must be an authorized sharee — the server returns access-denied otherwise.
|
|
572
|
+
*
|
|
573
|
+
* Supported embed types: `SpotterEmbed`
|
|
574
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
575
|
+
* @example
|
|
576
|
+
* ```js
|
|
577
|
+
* const convId = new URLSearchParams(window.location.search).get('conversation-id');
|
|
578
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
579
|
+
* ... //other embed view config
|
|
580
|
+
* sharedConversationId: convId,
|
|
581
|
+
* })
|
|
582
|
+
* ```
|
|
583
|
+
*/
|
|
584
|
+
sharedConversationId?: string;
|
|
585
|
+
/**
|
|
586
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
587
|
+
*
|
|
588
|
+
* Supported embed types: `SpotterEmbed`
|
|
589
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
590
|
+
* @default false
|
|
591
|
+
* @example
|
|
592
|
+
* ```js
|
|
593
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
594
|
+
* ... //other embed view config
|
|
595
|
+
* updatedSpotterExperience : true,
|
|
596
|
+
* })
|
|
597
|
+
* ```
|
|
598
|
+
*/
|
|
599
|
+
updatedSpotterExperience?: boolean;
|
|
372
600
|
}
|
|
373
601
|
/**
|
|
374
602
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -385,6 +613,7 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
385
613
|
export interface SpotterAppInitData extends DefaultAppInitData {
|
|
386
614
|
embedParams?: {
|
|
387
615
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
616
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
388
617
|
visualOverridesParams?: VisualizationOverrides | null;
|
|
389
618
|
};
|
|
390
619
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"conversation.d.ts","sourceRoot":"","sources":["conversation.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"conversation.d.ts","sourceRoot":"","sources":["conversation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,cAAc,EAAE,aAAa,EAAE,gBAAgB,EAAsC,kBAAkB,EAAE,sBAAsB,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAC9L,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAIrC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACvB;AAED;;;GAGG;AACH,oBAAY,gBAAgB;IACxB,WAAW,eAAe;IAC1B,QAAQ,aAAa;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;;;OAIG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C;;;;OAIG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B;IAC3C;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;OAGG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;IAC7C;;;OAGG;IACH,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC;;;OAGG;IACH,sCAAsC,CAAC,EAAE,MAAM,CAAC;IAChD;;;;OAIG;IACH,kCAAkC,CAAC,EAAE,MAAM,CAAC;CAC/C;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;;;OAMG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;OAMG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,0BAA0B,CAAC;IACxD;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAuB,SAAQ,IAAI,CAAC,cAAc,EAAE,eAAe,CAAC;IACjF;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;;;OAcG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC;;;;;;;;;;OAUG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;;;;;;;;;;;;OAiBG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IACvC;;;;;;;;;;OAUG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;;;;OAgBG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;;;;;OAOG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;;;;OAQG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IACzC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;IAChD;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,CAAC,EAAE,qBAAqB,CAAC;IAC1C;;;;;;;;;;;;;;OAcG;IACH,8BAA8B,CAAC,EAAE,8BAA8B,CAAC;IAChE;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;;GAKG;AAEH,MAAM,WAAW,sBAAuB,SAAQ,sBAAsB;CAAG;AAEzE;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,kBAAkB;IAC1D,WAAW,CAAC,EAAE;QACV,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;QAChD,8BAA8B,CAAC,EAAE,8BAA8B,CAAC;QAChE,qBAAqB,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;KACzD,CAAC;CACL;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAa,SAAQ,OAAO;IACD,SAAS,CAAC,UAAU,EAAE,sBAAsB;gBAApE,SAAS,EAAE,WAAW,EAAY,UAAU,EAAE,sBAAsB;IAUhF;;;;;;;;;;;OAWG;cACa,cAAc,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAU7D,SAAS,CAAC,oBAAoB;IA0DvB,YAAY,IAAI,MAAM;IA+ChB,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC;CAO/C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACX,SAAS,CAAC,UAAU,EAAE,sBAAsB;gBAApE,SAAS,EAAE,WAAW,EAAY,UAAU,EAAE,sBAAsB;CASnF"}
|