@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0-test
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/config.d.ts +1 -0
- package/cjs/src/config.d.ts.map +1 -1
- package/cjs/src/config.js +2 -1
- package/cjs/src/config.js.map +1 -1
- package/cjs/src/css-variables.d.ts +122 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +176 -24
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +86 -38
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +672 -150
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/base.d.ts +1 -1
- package/cjs/src/embed/base.js +1 -1
- package/cjs/src/embed/conversation.d.ts +401 -2
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +32 -16
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +346 -17
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/events.spec.js +638 -0
- package/cjs/src/embed/events.spec.js.map +1 -1
- package/cjs/src/embed/host-events.spec.js +187 -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 +2 -1
- 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 +236 -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 +81 -13
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +50 -9
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +432 -4
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/spotter-utils.d.ts +15 -1
- package/cjs/src/embed/spotter-utils.d.ts.map +1 -1
- package/cjs/src/embed/spotter-utils.js +28 -1
- package/cjs/src/embed/spotter-utils.js.map +1 -1
- package/cjs/src/embed/spotter-utils.spec.js +129 -0
- package/cjs/src/embed/spotter-utils.spec.js.map +1 -1
- package/cjs/src/embed/spotter-viz-utils.d.ts +37 -4
- 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 +16 -8
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +96 -37
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +683 -3
- 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 +3 -3
- package/cjs/src/index.d.ts.map +1 -1
- package/cjs/src/index.js +4 -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/all-types-export.d.ts +1 -1
- package/cjs/src/react/all-types-export.d.ts.map +1 -1
- package/cjs/src/react/all-types-export.js +2 -1
- package/cjs/src/react/all-types-export.js.map +1 -1
- package/cjs/src/react/all-types-export.parity.spec.d.ts +2 -0
- package/cjs/src/react/all-types-export.parity.spec.d.ts.map +1 -0
- package/cjs/src/react/all-types-export.parity.spec.js +194 -0
- package/cjs/src/react/all-types-export.parity.spec.js.map +1 -0
- package/cjs/src/react/index.d.ts +66 -32
- package/cjs/src/react/index.d.ts.map +1 -1
- package/cjs/src/react/index.js +5 -3
- package/cjs/src/react/index.js.map +1 -1
- package/cjs/src/react/index.spec.js +101 -0
- package/cjs/src/react/index.spec.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 +902 -28
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +701 -14
- 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/cjs/src/utils.spec.js +4 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/{index-B5xoN6Cp.js → index-Bivg-mDx.js} +1 -1
- package/dist/src/config.d.ts +1 -0
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +122 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +176 -24
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/base.d.ts +1 -1
- package/dist/src/embed/conversation.d.ts +401 -2
- 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 +2 -1
- 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 +81 -13
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/spotter-utils.d.ts +15 -1
- package/dist/src/embed/spotter-utils.d.ts.map +1 -1
- package/dist/src/embed/spotter-viz-utils.d.ts +37 -4
- package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +16 -8
- 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 +3 -3
- 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/react/all-types-export.d.ts +1 -1
- package/dist/src/react/all-types-export.d.ts.map +1 -1
- package/dist/src/react/all-types-export.parity.spec.d.ts +2 -0
- package/dist/src/react/all-types-export.parity.spec.d.ts.map +1 -0
- package/dist/src/react/index.d.ts +66 -32
- package/dist/src/react/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +902 -28
- package/dist/src/types.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +1269 -206
- package/dist/tsembed-react.js +1268 -205
- package/dist/tsembed.es.js +1364 -304
- package/dist/tsembed.js +1362 -302
- package/dist/visual-embed-sdk-react-full.d.ts +1867 -157
- package/dist/visual-embed-sdk-react.d.ts +1872 -161
- package/dist/visual-embed-sdk.d.ts +1815 -127
- package/lib/package.json +1 -1
- package/lib/src/config.d.ts +1 -0
- package/lib/src/config.d.ts.map +1 -1
- package/lib/src/config.js +1 -0
- package/lib/src/config.js.map +1 -1
- package/lib/src/css-variables.d.ts +122 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +176 -24
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +87 -39
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +673 -151
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/base.d.ts +1 -1
- package/lib/src/embed/base.js +1 -1
- package/lib/src/embed/conversation.d.ts +401 -2
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +33 -17
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +347 -18
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/events.spec.js +638 -0
- package/lib/src/embed/events.spec.js.map +1 -1
- package/lib/src/embed/host-events.spec.js +188 -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 +2 -1
- 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 +236 -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 +81 -13
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +50 -9
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +432 -4
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/spotter-utils.d.ts +15 -1
- package/lib/src/embed/spotter-utils.d.ts.map +1 -1
- package/lib/src/embed/spotter-utils.js +25 -0
- package/lib/src/embed/spotter-utils.js.map +1 -1
- package/lib/src/embed/spotter-utils.spec.js +130 -1
- package/lib/src/embed/spotter-utils.spec.js.map +1 -1
- package/lib/src/embed/spotter-viz-utils.d.ts +37 -4
- 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 +16 -8
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +96 -37
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +683 -3
- 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 +3 -3
- package/lib/src/index.d.ts.map +1 -1
- package/lib/src/index.js +3 -3
- 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/all-types-export.d.ts +1 -1
- package/lib/src/react/all-types-export.d.ts.map +1 -1
- package/lib/src/react/all-types-export.js +1 -1
- package/lib/src/react/all-types-export.js.map +1 -1
- package/lib/src/react/all-types-export.parity.spec.d.ts +2 -0
- package/lib/src/react/all-types-export.parity.spec.d.ts.map +1 -0
- package/lib/src/react/all-types-export.parity.spec.js +191 -0
- package/lib/src/react/all-types-export.parity.spec.js.map +1 -0
- package/lib/src/react/index.d.ts +66 -32
- package/lib/src/react/index.d.ts.map +1 -1
- package/lib/src/react/index.js +5 -3
- package/lib/src/react/index.js.map +1 -1
- package/lib/src/react/index.spec.js +102 -1
- package/lib/src/react/index.spec.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 +902 -28
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +701 -14
- 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/utils.spec.js +4 -0
- package/lib/src/utils.spec.js.map +1 -1
- package/lib/src/visual-embed-sdk.d.ts +1815 -127
- package/package.json +1 -1
- package/src/config.ts +1 -0
- package/src/css-variables.ts +150 -0
- package/src/embed/app.spec.ts +877 -196
- package/src/embed/app.ts +276 -75
- package/src/embed/base.ts +1 -1
- package/src/embed/conversation.spec.ts +411 -21
- package/src/embed/conversation.ts +441 -18
- package/src/embed/events.spec.ts +761 -1
- package/src/embed/host-events.spec.ts +242 -0
- package/src/embed/hostEventClient/contracts.ts +57 -14
- package/src/embed/hostEventClient/host-event-client.spec.ts +372 -0
- package/src/embed/hostEventClient/host-event-client.ts +18 -2
- package/src/embed/hostEventClient/utils.spec.ts +204 -0
- package/src/embed/hostEventClient/utils.ts +37 -10
- package/src/embed/liveboard.spec.ts +565 -4
- package/src/embed/liveboard.ts +155 -28
- package/src/embed/spotter-utils.spec.ts +140 -1
- package/src/embed/spotter-utils.ts +36 -1
- package/src/embed/spotter-viz-utils.spec.ts +17 -0
- package/src/embed/spotter-viz-utils.ts +37 -4
- package/src/embed/ts-embed.spec.ts +885 -3
- package/src/embed/ts-embed.ts +111 -39
- package/src/errors.ts +1 -0
- package/src/index.ts +45 -2
- package/src/mixpanel-service.ts +4 -0
- package/src/react/all-types-export.parity.spec.ts +208 -0
- package/src/react/all-types-export.ts +22 -0
- package/src/react/index.spec.tsx +158 -0
- package/src/react/index.tsx +70 -33
- package/src/react/util.spec.tsx +255 -0
- package/src/types.ts +904 -24
- package/src/utils/processData.spec.ts +97 -0
- package/src/utils/processTrigger.spec.ts +91 -0
- package/src/utils.spec.ts +5 -0
|
@@ -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,165 @@ 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
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* A single starter prompt question shown under a category pill.
|
|
224
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
225
|
+
* @group Embed components
|
|
226
|
+
*/
|
|
227
|
+
export interface StarterPromptQuestion {
|
|
228
|
+
/**
|
|
229
|
+
* Short label shown as a clickable suggestion. Falls back to `prompt` when
|
|
230
|
+
* omitted. ThoughtSpot truncates it beyond 80 characters.
|
|
231
|
+
*/
|
|
232
|
+
label?: string;
|
|
233
|
+
/**
|
|
234
|
+
* Prompt text sent to Spotter on click. ThoughtSpot truncates it beyond
|
|
235
|
+
* 300 characters.
|
|
236
|
+
*/
|
|
237
|
+
prompt: string;
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* Configuration for a starter prompt category with questions
|
|
241
|
+
* (`quick` and `research`).
|
|
242
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
243
|
+
* @group Embed components
|
|
244
|
+
*/
|
|
245
|
+
export interface StarterPromptCategory {
|
|
246
|
+
/**
|
|
247
|
+
* Overrides the default category pill label. ThoughtSpot truncates it
|
|
248
|
+
* beyond 30 characters.
|
|
249
|
+
*/
|
|
250
|
+
label?: string;
|
|
251
|
+
/**
|
|
252
|
+
* Replaces the backend-generated prompts. ThoughtSpot renders the first 4
|
|
253
|
+
* and drops any entry without a `prompt`.
|
|
254
|
+
*/
|
|
255
|
+
questions?: StarterPromptQuestion[];
|
|
256
|
+
}
|
|
257
|
+
/**
|
|
258
|
+
* Configuration for the Data Literacy starter prompt category.
|
|
259
|
+
* Only the label is customizable; the prompt text comes from the backend.
|
|
260
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
261
|
+
* @group Embed components
|
|
262
|
+
*/
|
|
263
|
+
export interface StarterPreviewDataCategory {
|
|
264
|
+
/**
|
|
265
|
+
* Overrides the default category pill label. ThoughtSpot truncates it
|
|
266
|
+
* beyond 30 characters.
|
|
267
|
+
*/
|
|
268
|
+
label?: string;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* Content configuration for the Spotter starter prompts.
|
|
272
|
+
* Keys are fixed: `quick` (Basic Search), `research` (Deep Analysis),
|
|
273
|
+
* `previewData` (Data Literacy) and `liveboard` (Liveboard chat panel).
|
|
274
|
+
*
|
|
275
|
+
* Note: this controls the Spotter chat interface only. The starter prompts on
|
|
276
|
+
* the Liveboard SpotterViz surface are configured separately through
|
|
277
|
+
* {@link SpotterVizConfig.customStarterPrompts}.
|
|
278
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
279
|
+
* @group Embed components
|
|
280
|
+
*/
|
|
281
|
+
export interface StarterPromptsConfig {
|
|
282
|
+
/**
|
|
283
|
+
* Turns the starter prompts surface on. Must be set explicitly, an
|
|
284
|
+
* unset flag leaves the surface off.
|
|
285
|
+
*
|
|
286
|
+
* Either this or `enableStarterPrompts` turns the surface on, so `false`
|
|
287
|
+
* here does not switch it off while `enableStarterPrompts` is `true`.
|
|
288
|
+
* @default false
|
|
289
|
+
*/
|
|
290
|
+
enable?: boolean;
|
|
291
|
+
/** Basic Search category configuration. */
|
|
292
|
+
quick?: StarterPromptCategory;
|
|
293
|
+
/** Deep Analysis category configuration. */
|
|
294
|
+
research?: StarterPromptCategory;
|
|
295
|
+
/** Data Literacy category configuration. */
|
|
296
|
+
previewData?: StarterPreviewDataCategory;
|
|
297
|
+
/**
|
|
298
|
+
* Starter prompts for the Spotter chat panel on a Liveboard.
|
|
299
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
300
|
+
*/
|
|
301
|
+
liveboard?: StarterPromptQuestion[];
|
|
302
|
+
}
|
|
99
303
|
/**
|
|
100
304
|
* Configuration for customizing Spotter chat UI branding.
|
|
101
305
|
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
@@ -136,11 +340,83 @@ export interface SpotterChatViewConfig {
|
|
|
136
340
|
/**
|
|
137
341
|
* Enables starter prompts in the Spotter chat interface.
|
|
138
342
|
*
|
|
139
|
-
*
|
|
343
|
+
* Either this or `starterPrompts.enable` turns the surface on, so it stays
|
|
344
|
+
* on while this is `true` even if `starterPrompts.enable` is `false`.
|
|
345
|
+
*
|
|
346
|
+
* Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
|
|
140
347
|
* @version SDK: 1.51.0 | ThoughtSpot: 26.8.0.cl
|
|
141
348
|
* @default false
|
|
142
349
|
*/
|
|
143
350
|
enableStarterPrompts?: boolean;
|
|
351
|
+
/**
|
|
352
|
+
* Customizes the labels and questions of the Spotter starter prompts.
|
|
353
|
+
* Individual pills are hidden or shown with `hiddenActions` /
|
|
354
|
+
* `visibleActions` using `Action.QuickSearchPill`,
|
|
355
|
+
* `Action.DeepAnalysisPill` and `Action.DataLiteracyPill`.
|
|
356
|
+
*
|
|
357
|
+
* Supported embed types: `SpotterEmbed`, `LiveboardEmbed`, `AppEmbed`
|
|
358
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
359
|
+
* @example
|
|
360
|
+
* ```js
|
|
361
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
362
|
+
* worksheetId: 'worksheet-id',
|
|
363
|
+
* hiddenActions: [Action.DeepAnalysisPill],
|
|
364
|
+
* spotterChatConfig: {
|
|
365
|
+
* starterPrompts: {
|
|
366
|
+
* enable: true,
|
|
367
|
+
* quick: {
|
|
368
|
+
* label: 'Quick questions',
|
|
369
|
+
* questions: [
|
|
370
|
+
* { label: 'Top products', prompt: 'What are the top products by revenue?' },
|
|
371
|
+
* ],
|
|
372
|
+
* },
|
|
373
|
+
* previewData: { label: 'Explore your data' },
|
|
374
|
+
* },
|
|
375
|
+
* },
|
|
376
|
+
* })
|
|
377
|
+
* ```
|
|
378
|
+
*/
|
|
379
|
+
starterPrompts?: StarterPromptsConfig;
|
|
380
|
+
/**
|
|
381
|
+
* Opens the Spotter chat panel when the Liveboard loads.
|
|
382
|
+
*
|
|
383
|
+
* Supported embed types: `LiveboardEmbed`, `AppEmbed`
|
|
384
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
385
|
+
* @default true
|
|
386
|
+
* @example
|
|
387
|
+
* ```js
|
|
388
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
389
|
+
* liveboardId: 'liveboard-id',
|
|
390
|
+
* spotterChatConfig: {
|
|
391
|
+
* openSpotterOnLiveboardByDefault: false,
|
|
392
|
+
* },
|
|
393
|
+
* })
|
|
394
|
+
* ```
|
|
395
|
+
*/
|
|
396
|
+
openSpotterOnLiveboardByDefault?: boolean;
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* Configuration for the Spotter Analyst experience.
|
|
400
|
+
* Can be used in SpotterEmbed.
|
|
401
|
+
* @group Embed components
|
|
402
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
403
|
+
* @example
|
|
404
|
+
* ```js
|
|
405
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
406
|
+
* ... //other embed view config
|
|
407
|
+
* spotterAnalystConfig: {
|
|
408
|
+
* analystId: 'analyst-id-1234',
|
|
409
|
+
* },
|
|
410
|
+
* })
|
|
411
|
+
* ```
|
|
412
|
+
*/
|
|
413
|
+
export interface SpotterAnalystConfig {
|
|
414
|
+
/**
|
|
415
|
+
* Pins the embed to a single spotter analyst. Implies no default Spotter
|
|
416
|
+
* and no "Show all".
|
|
417
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
418
|
+
*/
|
|
419
|
+
analystId?: string;
|
|
144
420
|
}
|
|
145
421
|
/**
|
|
146
422
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -150,8 +426,43 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
150
426
|
/**
|
|
151
427
|
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
152
428
|
* this object to query data and generate Answers.
|
|
429
|
+
* This field is optional. If not provided, Spotter loads using the
|
|
430
|
+
* previously selected user data source.
|
|
431
|
+
*/
|
|
432
|
+
worksheetId?: string;
|
|
433
|
+
/**
|
|
434
|
+
* The array of data source GUIDs to set on load. Spotter uses
|
|
435
|
+
* these GUIDs to query data and generate Answers.
|
|
436
|
+
* dataSources is preferred over worksheetId if both are provided.
|
|
437
|
+
* The feature is currently behind a feature flag.
|
|
438
|
+
*
|
|
439
|
+
* Supported embed types: `SpotterEmbed`
|
|
440
|
+
* @example
|
|
441
|
+
* ```js
|
|
442
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
443
|
+
* // ...other embed view config
|
|
444
|
+
* dataSources: ['id-2345', 'id-2345'],
|
|
445
|
+
* });
|
|
446
|
+
* ```
|
|
447
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
153
448
|
*/
|
|
154
|
-
|
|
449
|
+
dataSources?: string[];
|
|
450
|
+
/**
|
|
451
|
+
* Configuration for the Spotter Analyst experience.
|
|
452
|
+
*
|
|
453
|
+
* Supported embed types: `SpotterEmbed`
|
|
454
|
+
* @version SDK: 1.53.0 | ThoughtSpot Cloud: 26.10.0.cl
|
|
455
|
+
* @example
|
|
456
|
+
* ```js
|
|
457
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
458
|
+
* ... //other embed view config
|
|
459
|
+
* spotterAnalystConfig: {
|
|
460
|
+
* analystId: 'analyst-id-1234',
|
|
461
|
+
* },
|
|
462
|
+
* })
|
|
463
|
+
* ```
|
|
464
|
+
*/
|
|
465
|
+
spotterAnalystConfig?: SpotterAnalystConfig;
|
|
155
466
|
/**
|
|
156
467
|
* Ability to pass a starting search query to the conversation.
|
|
157
468
|
*/
|
|
@@ -311,6 +622,39 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
311
622
|
* ```
|
|
312
623
|
*/
|
|
313
624
|
updatedSpotterChatPrompt?: boolean;
|
|
625
|
+
/**
|
|
626
|
+
* showSpotterRadiance : Controls the radiance on the Spotter page.
|
|
627
|
+
*
|
|
628
|
+
* Supported embed types: `SpotterEmbed`
|
|
629
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
630
|
+
* @default false
|
|
631
|
+
* @example
|
|
632
|
+
* ```js
|
|
633
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
634
|
+
* ... //other embed view config
|
|
635
|
+
* showSpotterRadiance : true,
|
|
636
|
+
* })
|
|
637
|
+
* ```
|
|
638
|
+
*/
|
|
639
|
+
showSpotterRadiance?: boolean;
|
|
640
|
+
/**
|
|
641
|
+
* Sets the default query mode when Spotter loads — Fast Search or
|
|
642
|
+
* Research Mode. Applies fresh on every new session for this embed
|
|
643
|
+
* instance only; it does not persist as a user preference and does
|
|
644
|
+
* not affect other embeds or native ThoughtSpot usage.
|
|
645
|
+
*
|
|
646
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
647
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
648
|
+
* @default SpotterQueryMode.FAST_SEARCH
|
|
649
|
+
* @example
|
|
650
|
+
* ```js
|
|
651
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
652
|
+
* ... //other embed view config
|
|
653
|
+
* defaultQueryMode: SpotterQueryMode.RESEARCH,
|
|
654
|
+
* })
|
|
655
|
+
* ```
|
|
656
|
+
*/
|
|
657
|
+
defaultQueryMode?: SpotterQueryMode;
|
|
314
658
|
/**
|
|
315
659
|
* Enables the stop answer generation button in the Spotter embed UI,
|
|
316
660
|
* allowing users to interrupt an ongoing answer generation.
|
|
@@ -369,6 +713,59 @@ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, 'primaryAct
|
|
|
369
713
|
* ```
|
|
370
714
|
*/
|
|
371
715
|
spotterChatConfig?: SpotterChatViewConfig;
|
|
716
|
+
/**
|
|
717
|
+
* Configuration for the Spotter conversation sharing feature.
|
|
718
|
+
*
|
|
719
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
720
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
721
|
+
* @example
|
|
722
|
+
* ```js
|
|
723
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
724
|
+
* ... //other embed view config
|
|
725
|
+
* spotterShareConversationConfig: {
|
|
726
|
+
* enableShareConversation: true,
|
|
727
|
+
* },
|
|
728
|
+
* })
|
|
729
|
+
* ```
|
|
730
|
+
*/
|
|
731
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
732
|
+
/**
|
|
733
|
+
* The ID of a shared Spotter conversation to open directly in the read-only
|
|
734
|
+
* reader view. Use this to land a share recipient in the shared conversation
|
|
735
|
+
* when they open a host-configured `CONVERSATION_URL` share link: read the
|
|
736
|
+
* `{conversation-id}` from your page URL and pass it here.
|
|
737
|
+
*
|
|
738
|
+
* Requires the Spotter conversation-sharing feature to be enabled
|
|
739
|
+
* (`spotterShareConversationConfig.enableShareConversation`). The recipient
|
|
740
|
+
* must be an authorized sharee — the server returns access-denied otherwise.
|
|
741
|
+
*
|
|
742
|
+
* Supported embed types: `SpotterEmbed`
|
|
743
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
744
|
+
* @example
|
|
745
|
+
* ```js
|
|
746
|
+
* const convId = new URLSearchParams(window.location.search).get('conversation-id');
|
|
747
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
748
|
+
* ... //other embed view config
|
|
749
|
+
* sharedConversationId: convId,
|
|
750
|
+
* })
|
|
751
|
+
* ```
|
|
752
|
+
*/
|
|
753
|
+
sharedConversationId?: string;
|
|
754
|
+
/**
|
|
755
|
+
* updatedSpotterExperience : Controls the updated Spotter experience.
|
|
756
|
+
*
|
|
757
|
+
* Supported embed types: `SpotterEmbed`
|
|
758
|
+
* @version SDK: 1.52.0 | ThoughtSpot Cloud: 26.9.0.cl
|
|
759
|
+
* @default false
|
|
760
|
+
* @example
|
|
761
|
+
* ```js
|
|
762
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
763
|
+
* ... //other embed view config
|
|
764
|
+
* updatedSpotterExperience : true,
|
|
765
|
+
* })
|
|
766
|
+
* ```
|
|
767
|
+
*/
|
|
768
|
+
updatedSpotterExperience?: boolean;
|
|
372
769
|
}
|
|
373
770
|
/**
|
|
374
771
|
* The configuration for the embedded spotterEmbed options.
|
|
@@ -385,7 +782,9 @@ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
|
385
782
|
export interface SpotterAppInitData extends DefaultAppInitData {
|
|
386
783
|
embedParams?: {
|
|
387
784
|
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
785
|
+
spotterShareConversationConfig?: SpotterShareConversationConfig;
|
|
388
786
|
visualOverridesParams?: VisualizationOverrides | null;
|
|
787
|
+
starterPrompts?: StarterPromptsConfig;
|
|
389
788
|
};
|
|
390
789
|
}
|
|
391
790
|
/**
|
|
@@ -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;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,SAAS,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACvC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,4CAA4C;IAC5C,WAAW,CAAC,EAAE,0BAA0B,CAAC;IACzC;;;OAGG;IACH,SAAS,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACvC;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;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,cAAc,CAAC,EAAE,oBAAoB,CAAC;IACtC;;;;;;;;;;;;;;;OAeG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;CAC7C;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;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;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;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;QACtD,cAAc,CAAC,EAAE,oBAAoB,CAAC;KACzC,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;IAW7D,SAAS,CAAC,oBAAoB;IA4DvB,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"}
|
|
@@ -5,6 +5,43 @@ export interface LiveboardTab {
|
|
|
5
5
|
name: string;
|
|
6
6
|
[key: string]: any;
|
|
7
7
|
}
|
|
8
|
+
export interface LiveboardGroup {
|
|
9
|
+
id: string;
|
|
10
|
+
name: string;
|
|
11
|
+
[key: string]: any;
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Levels at which a filter or parameter can be applied.
|
|
15
|
+
*/
|
|
16
|
+
export declare enum ApplicabilityLevel {
|
|
17
|
+
Liveboard = "LIVEBOARD",
|
|
18
|
+
Tab = "TAB",
|
|
19
|
+
Group = "GROUP"
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Scopes a filter or parameter to a specific target.
|
|
23
|
+
* At `LIVEBOARD` level the filter applies to the whole Liveboard, so `targetId`
|
|
24
|
+
* is not required.
|
|
25
|
+
*/
|
|
26
|
+
export interface Applicability {
|
|
27
|
+
level: ApplicabilityLevel;
|
|
28
|
+
targetId?: string;
|
|
29
|
+
}
|
|
30
|
+
export interface FilterUpdate {
|
|
31
|
+
column: string;
|
|
32
|
+
oper: string;
|
|
33
|
+
values: string[];
|
|
34
|
+
type?: string;
|
|
35
|
+
applicability?: Applicability;
|
|
36
|
+
}
|
|
37
|
+
export interface LiveboardFilter {
|
|
38
|
+
applicability?: Applicability;
|
|
39
|
+
[key: string]: any;
|
|
40
|
+
}
|
|
41
|
+
export interface LiveboardParameter {
|
|
42
|
+
applicability?: Applicability;
|
|
43
|
+
[key: string]: any;
|
|
44
|
+
}
|
|
8
45
|
export declare enum UIPassthroughEvent {
|
|
9
46
|
PinAnswerToLiveboard = "addVizToPinboard",
|
|
10
47
|
SaveAnswer = "saveAnswer",
|
|
@@ -21,6 +58,7 @@ export declare enum UIPassthroughEvent {
|
|
|
21
58
|
GetParameters = "getParameters",
|
|
22
59
|
GetTML = "getTML",
|
|
23
60
|
GetTabs = "getTabs",
|
|
61
|
+
GetGroups = "getGroups",
|
|
24
62
|
GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
|
|
25
63
|
}
|
|
26
64
|
export type UIPassthroughContractBase = {
|
|
@@ -99,7 +137,7 @@ export type UIPassthroughContractBase = {
|
|
|
99
137
|
vizId?: string;
|
|
100
138
|
};
|
|
101
139
|
response: {
|
|
102
|
-
liveboardFilters:
|
|
140
|
+
liveboardFilters: LiveboardFilter[];
|
|
103
141
|
runtimeFilters: RuntimeFilter[];
|
|
104
142
|
};
|
|
105
143
|
};
|
|
@@ -112,7 +150,7 @@ export type UIPassthroughContractBase = {
|
|
|
112
150
|
[UIPassthroughEvent.GetParameters]: {
|
|
113
151
|
request: Record<string, never>;
|
|
114
152
|
response: {
|
|
115
|
-
parameters:
|
|
153
|
+
parameters: LiveboardParameter[];
|
|
116
154
|
};
|
|
117
155
|
};
|
|
118
156
|
[UIPassthroughEvent.GetTML]: {
|
|
@@ -130,6 +168,14 @@ export type UIPassthroughContractBase = {
|
|
|
130
168
|
Tabs: LiveboardTab[];
|
|
131
169
|
};
|
|
132
170
|
};
|
|
171
|
+
[UIPassthroughEvent.GetGroups]: {
|
|
172
|
+
request: Record<string, never>;
|
|
173
|
+
response: {
|
|
174
|
+
orderedGroupIds: string[];
|
|
175
|
+
numberOfGroups: number;
|
|
176
|
+
Groups: LiveboardGroup[];
|
|
177
|
+
};
|
|
178
|
+
};
|
|
133
179
|
[UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
|
|
134
180
|
request: Record<string, never>;
|
|
135
181
|
response: {
|
|
@@ -141,18 +187,8 @@ export type UIPassthroughContractBase = {
|
|
|
141
187
|
};
|
|
142
188
|
[UIPassthroughEvent.UpdateFilters]: {
|
|
143
189
|
request: {
|
|
144
|
-
filter?:
|
|
145
|
-
|
|
146
|
-
oper: string;
|
|
147
|
-
values: string[];
|
|
148
|
-
type?: string;
|
|
149
|
-
};
|
|
150
|
-
filters?: {
|
|
151
|
-
column: string;
|
|
152
|
-
oper: string;
|
|
153
|
-
values: string[];
|
|
154
|
-
type?: string;
|
|
155
|
-
}[];
|
|
190
|
+
filter?: FilterUpdate;
|
|
191
|
+
filters?: FilterUpdate[];
|
|
156
192
|
};
|
|
157
193
|
response: unknown;
|
|
158
194
|
};
|
|
@@ -185,6 +221,7 @@ export type EmbedApiHostEventMapping = {
|
|
|
185
221
|
[HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
|
|
186
222
|
[HostEvent.GetTML]: UIPassthroughEvent.GetTML;
|
|
187
223
|
[HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
|
|
224
|
+
[HostEvent.GetGroups]: UIPassthroughEvent.GetGroups;
|
|
188
225
|
[HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
|
|
189
226
|
};
|
|
190
227
|
export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAC;AAEnF,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,oBAAY,kBAAkB;IAC5B,oBAAoB,qBAAqB;IACzC,UAAU,eAAe;IACzB,wBAAwB,6BAA6B;IACrD,0BAA0B,+BAA+B;IACzD,eAAe,wBAAwB;IACvC,kBAAkB,0BAA0B;IAC5C,mBAAmB,wBAAwB;IAC3C,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,kCAAkC,uCAAuC;CAC1E;AAGD,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,EAAE;QACzC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,MAAM,CAAC;YACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,QAAQ,EAAE;YACR,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC/B,OAAO,EAAE;YACP,IAAI,EAAE,MAAM,CAAC;YACb,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,cAAc,CAAC,EAAE,OAAO,CAAC;SAC1B,CAAC;QACF,QAAQ,EAAE;YACR,QAAQ,EAAE,MAAM,CAAC;YACjB,YAAY,CAAC,EAAE,GAAG,CAAC;YACnB,aAAa,CAAC,EAAE,GAAG,CAAC;SACrB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,EAAE;QAC7C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,yBAAyB,EAAE,OAAO,CAAC;YACnC,yCAAyC,EAAE,OAAO,CAAC;SACpD,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,EAAE;QAC/C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,IAAI,EAAE,MAAM,EAAE,CAAC;SAChB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAE;QACpC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;IACF,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE;QACvC,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;IACF,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,EAAE;QACxC,OAAO,EAAE;YACP,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,GAAG,EAAE,MAAM,CAAC;SACb,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE;QACrC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,OAAO,EAAE,gBAAgB,CAAC;YAC1B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvC,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC/B,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,gBAAgB,EAAE,
|
|
1
|
+
{"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAC;AAEnF,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,SAAS,cAAc;IACvB,GAAG,QAAQ;IACX,KAAK,UAAU;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,oBAAY,kBAAkB;IAC5B,oBAAoB,qBAAqB;IACzC,UAAU,eAAe;IACzB,wBAAwB,6BAA6B;IACrD,0BAA0B,+BAA+B;IACzD,eAAe,wBAAwB;IACvC,kBAAkB,0BAA0B;IAC5C,mBAAmB,wBAAwB;IAC3C,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,kCAAkC,uCAAuC;CAC1E;AAGD,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,EAAE;QACzC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,MAAM,CAAC;YACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,QAAQ,EAAE;YACR,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC/B,OAAO,EAAE;YACP,IAAI,EAAE,MAAM,CAAC;YACb,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,cAAc,CAAC,EAAE,OAAO,CAAC;SAC1B,CAAC;QACF,QAAQ,EAAE;YACR,QAAQ,EAAE,MAAM,CAAC;YACjB,YAAY,CAAC,EAAE,GAAG,CAAC;YACnB,aAAa,CAAC,EAAE,GAAG,CAAC;SACrB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,EAAE;QAC7C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,yBAAyB,EAAE,OAAO,CAAC;YACnC,yCAAyC,EAAE,OAAO,CAAC;SACpD,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,EAAE;QAC/C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,IAAI,EAAE,MAAM,EAAE,CAAC;SAChB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAE;QACpC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;IACF,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE;QACvC,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;IACF,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,EAAE;QACxC,OAAO,EAAE;YACP,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,GAAG,EAAE,MAAM,CAAC;SACb,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE;QACrC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,OAAO,EAAE,gBAAgB,CAAC;YAC1B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvC,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC/B,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,gBAAgB,EAAE,eAAe,EAAE,CAAC;YACpC,cAAc,EAAE,aAAa,EAAE,CAAC;SACjC,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE;QACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,SAAS,EAAE,MAAM,CAAC;SACnB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE;QAClC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,UAAU,EAAE,kBAAkB,EAAE,CAAC;SAClC,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE;QAC3B,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,8BAA8B,CAAC,EAAE,OAAO,CAAC;SAC1C,CAAC;QACF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC/B,CAAC;IACF,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE;QAC5B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,aAAa,EAAE,MAAM,EAAE,CAAC;YACxB,YAAY,EAAE,MAAM,CAAC;YACrB,IAAI,EAAE,YAAY,EAAE,CAAC;SACtB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE;QAC9B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,eAAe,EAAE,MAAM,EAAE,CAAC;YAC1B,cAAc,EAAE,MAAM,CAAC;YACvB,MAAM,EAAE,cAAc,EAAE,CAAC;SAC1B,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,kCAAkC,CAAC,EAAE;QACvD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,IAAI,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAA;aAAE,CAAC;YAC5B,IAAI,EAAE,kBAAkB,CAAC,kCAAkC,CAAC;SAC7D,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE;QAClC,OAAO,EAAE;YACP,MAAM,CAAC,EAAE,YAAY,CAAC;YACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;SAC1B,CAAC;QACF,QAAQ,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE;QAC9B,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;gBAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;aACvB,CAAC;YACF,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE,OAAO,CAAC;KACnB,CAAC;CACH,CAAC;AAGF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SACxB,MAAM,yBAAyB,IACrC,yBAAyB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAE5C,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,MAAM,yBAAyB,IACvC,yBAAyB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;AAE7C,MAAM,MAAM,0BAA0B,CAAC,OAAO,SAAS,MAAM,yBAAyB,IACpF,KAAK,CAAC;IACJ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACvC,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC,CAAA;AAGJ,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC;IACzD,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IACtD,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC;IAClE,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IACtD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC;IAC1D,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC;IAC5D,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC;IAC9C,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAChD,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;IACpD,CAAC,SAAS,CAAC,kCAAkC,CAAC,EAAE,kBAAkB,CAAC,kCAAkC,CAAC;CACvG,CAAA;AAGD,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,SAAS,IACvD,UAAU,SAAS,MAAM,wBAAwB,GAC7C,oBAAoB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,GAC1D,GAAG,CAAC;AAEV,MAAM,MAAM,iBAAiB,CAAC,UAAU,SAAS,SAAS,EAAE,QAAQ,SAAS,WAAW,IACtF,UAAU,SAAS,MAAM,wBAAwB,GAC7C,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,GAC3D,GAAG,CAAC;AAGV,MAAM,MAAM,cAAc,CAAC,QAAQ,EAAE,UAAU,SAAS,SAAS,IAC/D,QAAQ,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAC1C,MAAM,MAAM,eAAe,CAAC,QAAQ,EAAE,UAAU,SAAS,SAAS,EAAE,QAAQ,SAAS,WAAW,IAC9F,QAAQ,SAAS,gBAAgB,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,GAAG,CAAC"}
|
|
@@ -38,6 +38,7 @@ export declare class HostEventClient {
|
|
|
38
38
|
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
39
39
|
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
40
40
|
protected handleUpdateFiltersEvent(payload: HostEventRequest<HostEvent.UpdateFilters>, context?: ContextType): Promise<any>;
|
|
41
|
+
protected handleUpdateParametersEvent(payload: HostEventRequest<HostEvent.UpdateParameters>, context?: ContextType): Promise<any>;
|
|
41
42
|
protected handleDrillDownEvent(payload: HostEventRequest<HostEvent.DrillDown>, context?: ContextType): Promise<any>;
|
|
42
43
|
/**
|
|
43
44
|
* Dispatches a host event using the appropriate channel:
|
|
@@ -48,6 +49,6 @@ export declare class HostEventClient {
|
|
|
48
49
|
* @param payload - Optional payload for the event
|
|
49
50
|
* @param context - Optional context (e.g. vizId) for scoped operations
|
|
50
51
|
*/
|
|
51
|
-
triggerHostEvent<HostEventT extends HostEvent, PayloadT
|
|
52
|
+
triggerHostEvent<HostEventT extends HostEvent, PayloadT = HostEventRequest<HostEventT>, ContextT extends ContextType = ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
|
|
52
53
|
}
|
|
53
54
|
//# sourceMappingURL=host-event-client.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"host-event-client.d.ts","sourceRoot":"","sources":["host-event-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"host-event-client.d.ts","sourceRoot":"","sources":["host-event-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAWrD,OAAO,EACH,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACd,eAAe,EAClB,MAAM,aAAa,CAAC;AAwBrB,qBAAa,eAAe;IAC1B,MAAM,EAAE,iBAAiB,CAAC;IAE1B,yEAAyE;IACzE,OAAO,CAAC,6BAA6B,CAAyB;IAE9D;;uDAEmD;IACnD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAE7B;gBAEU,MAAM,CAAC,EAAE,iBAAiB;IAWtC;;;;;OAKG;cACa,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAerF,wBAAwB,CAAC,mBAAmB,SAAS,kBAAkB,EAChF,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,EACrD,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,CAAC;IAqBzC,iBAAiB,CAC1B,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,GAAG,EACT,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,GAAG,CAAC;IAIf;;;;OAIG;YACW,8BAA8B;IAyB5C;;;OAGG;IACI,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAIxD;;;OAGG;YACW,6BAA6B;IAiB9B,uBAAuB,CAAC,mBAAmB,SAAS,kBAAkB,EAC/E,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,oBAAoB,CAAC,mBAAmB,CAAC,EACrD,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,0BAA0B,CAAC,mBAAmB,CAAC,CAAC;cAS3C,cAAc,CAC1B,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG,CAAC,EACxC,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,iBAAiB,CAAC,SAAS,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;cAsBzC,qBAAqB,CACjC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,UAAU,CAAC,EAC/C,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,GAAG,CAAC;IAgBf,SAAS,CAAC,wBAAwB,CAChC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,aAAa,CAAC,EAClD,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,GAAG,CAAC;IAQf,SAAS,CAAC,2BAA2B,CACnC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,gBAAgB,CAAC,EACrD,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,GAAG,CAAC;IASf,SAAS,CAAC,oBAAoB,CAC5B,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,SAAS,CAAC,EAC9C,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,GAAG,CAAC;IAQf;;;;;;;;OAQG;IACU,gBAAgB,CAC3B,UAAU,SAAS,SAAS,EAC5B,QAAQ,GAAG,gBAAgB,CAAC,UAAU,CAAC,EACvC,QAAQ,SAAS,WAAW,GAAG,WAAW,EAExC,SAAS,EAAE,UAAU,EACrB,OAAO,CAAC,EAAE,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,EAC9C,OAAO,CAAC,EAAE,QAAQ,GACnB,OAAO,CAAC,eAAe,CAAC,QAAQ,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;CAkB/D"}
|
|
@@ -2,6 +2,7 @@ import { EmbedErrorCodes, EmbedEvent, ErrorDetailsTypes, HostEvent } from '../..
|
|
|
2
2
|
import { HostEventRequest } from './contracts';
|
|
3
3
|
import { embedEventStatus } from '../../utils';
|
|
4
4
|
export declare function isValidUpdateFiltersPayload(payload: HostEventRequest<HostEvent.UpdateFilters> | undefined): boolean;
|
|
5
|
+
export declare function isValidUpdateParametersPayload(payload: unknown): boolean;
|
|
5
6
|
export declare function isValidDrillDownPayload(payload: HostEventRequest<HostEvent.DrillDown> | undefined): boolean;
|
|
6
7
|
export type ValidationError = Error & {
|
|
7
8
|
isValidationError?: boolean;
|
|
@@ -19,4 +20,5 @@ export type ValidationError = Error & {
|
|
|
19
20
|
export declare function createValidationError(message: string): never;
|
|
20
21
|
export declare function throwUpdateFiltersValidationError(): never;
|
|
21
22
|
export declare function throwDrillDownValidationError(): never;
|
|
23
|
+
export declare function throwUpdateParametersValidationError(): never;
|
|
22
24
|
//# sourceMappingURL=utils.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExF,OAAO,EAAsB,gBAAgB,EAAE,MAAM,aAAa,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAU/C,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,SAAS,GAC7D,OAAO,CAwBT;AAED,wBAAgB,8BAA8B,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAQxE;AAED,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,GACzD,OAAO,CAUT;AAED,MAAM,MAAM,eAAe,GAAG,KAAK,GAAG;IACpC,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,iBAAiB,CAAC,EAAE;QAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC;QAAC,IAAI,EAAE;YAAE,SAAS,EAAE,iBAAiB,CAAC;YAAC,OAAO,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,eAAe,CAAC;YAAC,KAAK,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,MAAM,EAAE,OAAO,gBAAgB,CAAC,GAAG,CAAA;KAAE,CAAC;CACpL,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAc5D;AAED,wBAAgB,iCAAiC,IAAI,KAAK,CAEzD;AAED,wBAAgB,6BAA6B,IAAI,KAAK,CAErD;AAED,wBAAgB,oCAAoC,IAAI,KAAK,CAE5D"}
|