@thoughtspot/visual-embed-sdk 1.45.1 → 1.45.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cjs/package.json +1 -1
- package/cjs/src/authToken.d.ts +1 -1
- package/cjs/src/authToken.d.ts.map +1 -1
- package/cjs/src/authToken.js +2 -2
- package/cjs/src/authToken.js.map +1 -1
- package/cjs/src/authToken.spec.js +71 -0
- package/cjs/src/authToken.spec.js.map +1 -1
- package/cjs/src/css-variables.d.ts +48 -0
- package/cjs/src/css-variables.d.ts.map +1 -1
- package/cjs/src/embed/app.d.ts +37 -0
- package/cjs/src/embed/app.d.ts.map +1 -1
- package/cjs/src/embed/app.js +37 -1
- package/cjs/src/embed/app.js.map +1 -1
- package/cjs/src/embed/app.spec.js +24 -0
- package/cjs/src/embed/app.spec.js.map +1 -1
- package/cjs/src/embed/conversation.d.ts +127 -9
- package/cjs/src/embed/conversation.d.ts.map +1 -1
- package/cjs/src/embed/conversation.js +41 -18
- package/cjs/src/embed/conversation.js.map +1 -1
- package/cjs/src/embed/conversation.spec.js +96 -3
- package/cjs/src/embed/conversation.spec.js.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.d.ts +3 -3
- package/cjs/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/contracts.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts +8 -8
- package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.js +18 -18
- package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js +7 -7
- package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/cjs/src/embed/liveboard.d.ts +40 -3
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +40 -12
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +180 -8
- package/cjs/src/embed/liveboard.spec.js.map +1 -1
- package/cjs/src/embed/ts-embed.d.ts +23 -2
- package/cjs/src/embed/ts-embed.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.js +64 -22
- package/cjs/src/embed/ts-embed.js.map +1 -1
- package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/cjs/src/embed/ts-embed.spec.js +138 -19
- 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 +3 -2
- package/cjs/src/index.js.map +1 -1
- package/cjs/src/types.d.ts +356 -42
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +227 -20
- package/cjs/src/types.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js +23 -1
- package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.js +9 -1
- package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/cjs/src/utils/graphql/answerService/answerService.spec.js +73 -0
- package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/cjs/src/utils/processTrigger.d.ts +3 -2
- package/cjs/src/utils/processTrigger.d.ts.map +1 -1
- package/cjs/src/utils/processTrigger.js +4 -2
- package/cjs/src/utils/processTrigger.js.map +1 -1
- package/cjs/src/utils.d.ts +20 -1
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +40 -1
- package/cjs/src/utils.js.map +1 -1
- package/cjs/src/utils.spec.js +49 -0
- package/cjs/src/utils.spec.js.map +1 -1
- package/dist/{index-Dgzjq7qH.js → index-BuwECGdm.js} +1 -1
- package/dist/src/authToken.d.ts +1 -1
- package/dist/src/authToken.d.ts.map +1 -1
- package/dist/src/css-variables.d.ts +48 -0
- package/dist/src/css-variables.d.ts.map +1 -1
- package/dist/src/embed/app.d.ts +37 -0
- package/dist/src/embed/app.d.ts.map +1 -1
- package/dist/src/embed/conversation.d.ts +127 -9
- package/dist/src/embed/conversation.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/contracts.d.ts +3 -3
- package/dist/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/dist/src/embed/hostEventClient/host-event-client.d.ts +8 -8
- package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/dist/src/embed/liveboard.d.ts +40 -3
- package/dist/src/embed/liveboard.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.d.ts +23 -2
- package/dist/src/embed/ts-embed.d.ts.map +1 -1
- package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/dist/src/errors.d.ts +1 -0
- package/dist/src/errors.d.ts.map +1 -1
- package/dist/src/index.d.ts +3 -3
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/types.d.ts +356 -42
- package/dist/src/types.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/dist/src/utils/processTrigger.d.ts +3 -2
- package/dist/src/utils/processTrigger.d.ts.map +1 -1
- package/dist/src/utils.d.ts +20 -1
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +501 -98
- package/dist/tsembed-react.js +500 -97
- package/dist/tsembed.es.js +516 -113
- package/dist/tsembed.js +29956 -29553
- package/dist/visual-embed-sdk-react-full.d.ts +819 -282
- package/dist/visual-embed-sdk-react.d.ts +818 -281
- package/dist/visual-embed-sdk.d.ts +882 -321
- package/lib/package.json +1 -1
- package/lib/src/authToken.d.ts +1 -1
- package/lib/src/authToken.d.ts.map +1 -1
- package/lib/src/authToken.js +2 -2
- package/lib/src/authToken.js.map +1 -1
- package/lib/src/authToken.spec.js +72 -1
- package/lib/src/authToken.spec.js.map +1 -1
- package/lib/src/css-variables.d.ts +48 -0
- package/lib/src/css-variables.d.ts.map +1 -1
- package/lib/src/embed/app.d.ts +37 -0
- package/lib/src/embed/app.d.ts.map +1 -1
- package/lib/src/embed/app.js +39 -3
- package/lib/src/embed/app.js.map +1 -1
- package/lib/src/embed/app.spec.js +24 -0
- package/lib/src/embed/app.spec.js.map +1 -1
- package/lib/src/embed/conversation.d.ts +127 -9
- package/lib/src/embed/conversation.d.ts.map +1 -1
- package/lib/src/embed/conversation.js +42 -19
- package/lib/src/embed/conversation.js.map +1 -1
- package/lib/src/embed/conversation.spec.js +96 -3
- package/lib/src/embed/conversation.spec.js.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.d.ts +3 -3
- package/lib/src/embed/hostEventClient/contracts.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/contracts.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.d.ts +8 -8
- package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.js +18 -18
- package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
- package/lib/src/embed/hostEventClient/host-event-client.spec.js +7 -7
- package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
- package/lib/src/embed/liveboard.d.ts +40 -3
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +41 -13
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +180 -8
- package/lib/src/embed/liveboard.spec.js.map +1 -1
- package/lib/src/embed/ts-embed.d.ts +23 -2
- package/lib/src/embed/ts-embed.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.js +64 -22
- package/lib/src/embed/ts-embed.js.map +1 -1
- package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
- package/lib/src/embed/ts-embed.spec.js +139 -20
- 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 +2 -2
- package/lib/src/index.js.map +1 -1
- package/lib/src/types.d.ts +356 -42
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +226 -19
- package/lib/src/types.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
- package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answer-queries.js +22 -0
- package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -1
- package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.js +9 -1
- package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
- package/lib/src/utils/graphql/answerService/answerService.spec.js +73 -0
- package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
- package/lib/src/utils/processTrigger.d.ts +3 -2
- package/lib/src/utils/processTrigger.d.ts.map +1 -1
- package/lib/src/utils/processTrigger.js +4 -2
- package/lib/src/utils/processTrigger.js.map +1 -1
- package/lib/src/utils.d.ts +20 -1
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +36 -0
- package/lib/src/utils.js.map +1 -1
- package/lib/src/utils.spec.js +50 -1
- package/lib/src/utils.spec.js.map +1 -1
- package/package.json +1 -1
- package/src/authToken.spec.ts +91 -2
- package/src/authToken.ts +2 -2
- package/src/css-variables.ts +60 -0
- package/src/embed/app.spec.ts +32 -0
- package/src/embed/app.ts +97 -1
- package/src/embed/conversation.spec.ts +117 -3
- package/src/embed/conversation.ts +188 -29
- package/src/embed/hostEventClient/contracts.ts +4 -4
- package/src/embed/hostEventClient/host-event-client.spec.ts +7 -1
- package/src/embed/hostEventClient/host-event-client.ts +22 -11
- package/src/embed/liveboard.spec.ts +264 -10
- package/src/embed/liveboard.ts +105 -14
- package/src/embed/ts-embed.spec.ts +184 -8
- package/src/embed/ts-embed.ts +81 -24
- package/src/errors.ts +1 -0
- package/src/index.ts +7 -1
- package/src/types.ts +364 -40
- package/src/utils/graphql/answerService/answer-queries.ts +23 -0
- package/src/utils/graphql/answerService/answerService.spec.ts +87 -0
- package/src/utils/graphql/answerService/answerService.ts +13 -1
- package/src/utils/processTrigger.ts +6 -3
- package/src/utils.spec.ts +56 -0
- package/src/utils.ts +44 -0
|
@@ -703,6 +703,54 @@ export interface CustomCssVariables {
|
|
|
703
703
|
* Width of the Spotter chat window.
|
|
704
704
|
*/
|
|
705
705
|
"--ts-var-spotter-chat-width"?: string;
|
|
706
|
+
/**
|
|
707
|
+
* Border color for the saved chats sidebar container.
|
|
708
|
+
*/
|
|
709
|
+
"--ts-var-saved-chats-border-color"?: string;
|
|
710
|
+
/**
|
|
711
|
+
* Background color for the saved chats sidebar container.
|
|
712
|
+
*/
|
|
713
|
+
"--ts-var-saved-chats-bg"?: string;
|
|
714
|
+
/**
|
|
715
|
+
* Text color for the saved chats sidebar container.
|
|
716
|
+
*/
|
|
717
|
+
"--ts-var-saved-chats-text-color"?: string;
|
|
718
|
+
/**
|
|
719
|
+
* Border color for the saved chats sidebar header.
|
|
720
|
+
*/
|
|
721
|
+
"--ts-var-saved-chats-header-border"?: string;
|
|
722
|
+
/**
|
|
723
|
+
* Color for the saved chats sidebar title text.
|
|
724
|
+
*/
|
|
725
|
+
"--ts-var-saved-chats-title-color"?: string;
|
|
726
|
+
/**
|
|
727
|
+
* Background color for buttons (new chat, toggle, footer) in the saved chats sidebar.
|
|
728
|
+
*/
|
|
729
|
+
"--ts-var-saved-chats-btn-bg"?: string;
|
|
730
|
+
/**
|
|
731
|
+
* Hover background color for buttons in the saved chats sidebar.
|
|
732
|
+
*/
|
|
733
|
+
"--ts-var-saved-chats-btn-hover-bg"?: string;
|
|
734
|
+
/**
|
|
735
|
+
* Text color for conversation items in the saved chats sidebar.
|
|
736
|
+
*/
|
|
737
|
+
"--ts-var-saved-chats-conv-text-color"?: string;
|
|
738
|
+
/**
|
|
739
|
+
* Background color for conversation items on hover in the saved chats sidebar.
|
|
740
|
+
*/
|
|
741
|
+
"--ts-var-saved-chats-conv-hover-bg"?: string;
|
|
742
|
+
/**
|
|
743
|
+
* Background color for the active/selected conversation in the saved chats sidebar.
|
|
744
|
+
*/
|
|
745
|
+
"--ts-var-saved-chats-conv-active-bg"?: string;
|
|
746
|
+
/**
|
|
747
|
+
* Border color for the saved chats sidebar footer.
|
|
748
|
+
*/
|
|
749
|
+
"--ts-var-saved-chats-footer-border"?: string;
|
|
750
|
+
/**
|
|
751
|
+
* Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar.
|
|
752
|
+
*/
|
|
753
|
+
"--ts-var-saved-chats-section-title-color"?: string;
|
|
706
754
|
}
|
|
707
755
|
export interface SessionInterface {
|
|
708
756
|
sessionId: string;
|
|
@@ -771,7 +819,8 @@ declare class AnswerService {
|
|
|
771
819
|
* @returns
|
|
772
820
|
*/
|
|
773
821
|
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter["values"]): Promise<any>;
|
|
774
|
-
|
|
822
|
+
updateDisplayMode(displayMode?: string): Promise<any>;
|
|
823
|
+
getSQLQuery(fetchSQLWithAllColumns?: boolean): Promise<string>;
|
|
775
824
|
/**
|
|
776
825
|
* Fetch data from the answer.
|
|
777
826
|
* @param offset
|
|
@@ -1925,6 +1974,44 @@ export interface BaseViewConfig extends ApiInterceptFlags {
|
|
|
1925
1974
|
* ```
|
|
1926
1975
|
*/
|
|
1927
1976
|
customActions?: CustomAction[];
|
|
1977
|
+
/**
|
|
1978
|
+
* Refresh the auth token when the token is near expiry.
|
|
1979
|
+
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
1980
|
+
* @example
|
|
1981
|
+
* ```js
|
|
1982
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
1983
|
+
* ... // other embed view config
|
|
1984
|
+
* refreshAuthTokenOnNearExpiry: true,
|
|
1985
|
+
* })
|
|
1986
|
+
* ```
|
|
1987
|
+
*/
|
|
1988
|
+
refreshAuthTokenOnNearExpiry?: boolean;
|
|
1989
|
+
/**
|
|
1990
|
+
* This flag skips payload validation so events can be processed even if the payload is old, incomplete, or from a trusted system.
|
|
1991
|
+
* @default false
|
|
1992
|
+
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
1993
|
+
* @example
|
|
1994
|
+
* ```js
|
|
1995
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
1996
|
+
* ... // other embed view config
|
|
1997
|
+
* shouldBypassPayloadValidation:true,
|
|
1998
|
+
* })
|
|
1999
|
+
* ```
|
|
2000
|
+
*/
|
|
2001
|
+
shouldBypassPayloadValidation?: boolean;
|
|
2002
|
+
/**
|
|
2003
|
+
* Flag to use host events v2. This is used to enable the new host events v2 API.
|
|
2004
|
+
* @default false
|
|
2005
|
+
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
2006
|
+
* @example
|
|
2007
|
+
* ```js
|
|
2008
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
2009
|
+
* ... // other embed view config
|
|
2010
|
+
* useHostEventsV2:true,
|
|
2011
|
+
* })
|
|
2012
|
+
* ```
|
|
2013
|
+
*/
|
|
2014
|
+
useHostEventsV2?: boolean;
|
|
1928
2015
|
}
|
|
1929
2016
|
/**
|
|
1930
2017
|
* The configuration object for Home page embeds configs.
|
|
@@ -2360,7 +2447,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2360
2447
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
2361
2448
|
*
|
|
2362
2449
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2363
|
-
* @version SDK: 1.
|
|
2450
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
2364
2451
|
* @example
|
|
2365
2452
|
* ```js
|
|
2366
2453
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -3922,7 +4009,55 @@ export declare enum EmbedEvent {
|
|
|
3922
4009
|
* ```
|
|
3923
4010
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
3924
4011
|
*/
|
|
3925
|
-
ApiIntercept = "ApiIntercept"
|
|
4012
|
+
ApiIntercept = "ApiIntercept",
|
|
4013
|
+
/**
|
|
4014
|
+
* Emitted when a Spotter conversation is renamed.
|
|
4015
|
+
* @example
|
|
4016
|
+
* ```js
|
|
4017
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationRenamed, (payload) => {
|
|
4018
|
+
* console.log('Conversation renamed', payload);
|
|
4019
|
+
* // payload: { convId: string, oldTitle: string, newTitle: string }
|
|
4020
|
+
* })
|
|
4021
|
+
* ```
|
|
4022
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4023
|
+
*/
|
|
4024
|
+
SpotterConversationRenamed = "spotterConversationRenamed",
|
|
4025
|
+
/**
|
|
4026
|
+
* Emitted when a Spotter conversation is deleted.
|
|
4027
|
+
* @example
|
|
4028
|
+
* ```js
|
|
4029
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationDeleted, (payload) => {
|
|
4030
|
+
* console.log('Conversation deleted', payload);
|
|
4031
|
+
* // payload: { convId: string, title: string }
|
|
4032
|
+
* })
|
|
4033
|
+
* ```
|
|
4034
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4035
|
+
*/
|
|
4036
|
+
SpotterConversationDeleted = "spotterConversationDeleted",
|
|
4037
|
+
/**
|
|
4038
|
+
* Emitted when a Spotter conversation is selected/clicked.
|
|
4039
|
+
* @example
|
|
4040
|
+
* ```js
|
|
4041
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => {
|
|
4042
|
+
* console.log('Conversation selected', payload);
|
|
4043
|
+
* // payload: { convId: string, title: string, worksheetId: string }
|
|
4044
|
+
* })
|
|
4045
|
+
* ```
|
|
4046
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4047
|
+
*/
|
|
4048
|
+
SpotterConversationSelected = "spotterConversationSelected",
|
|
4049
|
+
/**
|
|
4050
|
+
* @hidden
|
|
4051
|
+
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
4052
|
+
* @example
|
|
4053
|
+
* ```js
|
|
4054
|
+
* embed.on(EmbedEvent.RefreshAuthToken, (payload) => {
|
|
4055
|
+
* console.log('payload', payload);
|
|
4056
|
+
* })
|
|
4057
|
+
* ```
|
|
4058
|
+
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
4059
|
+
*/
|
|
4060
|
+
RefreshAuthToken = "RefreshAuthToken"
|
|
3926
4061
|
}
|
|
3927
4062
|
/**
|
|
3928
4063
|
* Event types that can be triggered by the host application
|
|
@@ -5304,7 +5439,18 @@ export declare enum HostEvent {
|
|
|
5304
5439
|
* ```
|
|
5305
5440
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5306
5441
|
*/
|
|
5307
|
-
StartNewSpotterConversation = "StartNewSpotterConversation"
|
|
5442
|
+
StartNewSpotterConversation = "StartNewSpotterConversation",
|
|
5443
|
+
/**
|
|
5444
|
+
* @hidden
|
|
5445
|
+
* Get the current context of the embedded page.
|
|
5446
|
+
*
|
|
5447
|
+
* @example
|
|
5448
|
+
* ```js
|
|
5449
|
+
* const context = await liveboardEmbed.trigger(HostEvent.GetPageContext);
|
|
5450
|
+
* ```
|
|
5451
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
5452
|
+
*/
|
|
5453
|
+
GetPageContext = "GetPageContext"
|
|
5308
5454
|
}
|
|
5309
5455
|
/**
|
|
5310
5456
|
* ThoughtSpot application pages include actions and menu commands
|
|
@@ -6729,6 +6875,96 @@ export declare enum Action {
|
|
|
6729
6875
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6730
6876
|
*/
|
|
6731
6877
|
UngroupLiveboardGroup = "ungroupLiveboardGroup",
|
|
6878
|
+
/**
|
|
6879
|
+
* Controls visibility of the sidebar header (title and toggle button)
|
|
6880
|
+
* in the Spotter past conversations sidebar.
|
|
6881
|
+
* @example
|
|
6882
|
+
* ```js
|
|
6883
|
+
* hiddenActions: [Action.SpotterSidebarHeader]
|
|
6884
|
+
* ```
|
|
6885
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6886
|
+
*/
|
|
6887
|
+
SpotterSidebarHeader = "spotterSidebarHeader",
|
|
6888
|
+
/**
|
|
6889
|
+
* Controls visibility of the sidebar footer (documentation link)
|
|
6890
|
+
* in the Spotter past conversations sidebar.
|
|
6891
|
+
* @example
|
|
6892
|
+
* ```js
|
|
6893
|
+
* hiddenActions: [Action.SpotterSidebarFooter]
|
|
6894
|
+
* ```
|
|
6895
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6896
|
+
*/
|
|
6897
|
+
SpotterSidebarFooter = "spotterSidebarFooter",
|
|
6898
|
+
/**
|
|
6899
|
+
* Controls visibility and disable state of the sidebar toggle/expand button
|
|
6900
|
+
* in the Spotter past conversations sidebar.
|
|
6901
|
+
* @example
|
|
6902
|
+
* ```js
|
|
6903
|
+
* disabledActions: [Action.SpotterSidebarToggle]
|
|
6904
|
+
* ```
|
|
6905
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6906
|
+
*/
|
|
6907
|
+
SpotterSidebarToggle = "spotterSidebarToggle",
|
|
6908
|
+
/**
|
|
6909
|
+
* Controls visibility and disable state of the "New Chat" button
|
|
6910
|
+
* in the Spotter past conversations sidebar.
|
|
6911
|
+
* @example
|
|
6912
|
+
* ```js
|
|
6913
|
+
* disabledActions: [Action.SpotterNewChat]
|
|
6914
|
+
* ```
|
|
6915
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6916
|
+
*/
|
|
6917
|
+
SpotterNewChat = "spotterNewChat",
|
|
6918
|
+
/**
|
|
6919
|
+
* Controls visibility of the past conversation banner alert
|
|
6920
|
+
* in the Spotter interface.
|
|
6921
|
+
* @example
|
|
6922
|
+
* ```js
|
|
6923
|
+
* hiddenActions: [Action.SpotterPastChatBanner]
|
|
6924
|
+
* ```
|
|
6925
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6926
|
+
*/
|
|
6927
|
+
SpotterPastChatBanner = "spotterPastChatBanner",
|
|
6928
|
+
/**
|
|
6929
|
+
* Controls visibility and disable state of the conversation edit menu
|
|
6930
|
+
* (three-dot menu) in the Spotter past conversations sidebar.
|
|
6931
|
+
* @example
|
|
6932
|
+
* ```js
|
|
6933
|
+
* disabledActions: [Action.SpotterChatMenu]
|
|
6934
|
+
* ```
|
|
6935
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6936
|
+
*/
|
|
6937
|
+
SpotterChatMenu = "spotterChatMenu",
|
|
6938
|
+
/**
|
|
6939
|
+
* Controls visibility and disable state of the rename action
|
|
6940
|
+
* in the Spotter conversation edit menu.
|
|
6941
|
+
* @example
|
|
6942
|
+
* ```js
|
|
6943
|
+
* disabledActions: [Action.SpotterChatRename]
|
|
6944
|
+
* ```
|
|
6945
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6946
|
+
*/
|
|
6947
|
+
SpotterChatRename = "spotterChatRename",
|
|
6948
|
+
/**
|
|
6949
|
+
* Controls visibility and disable state of the delete action
|
|
6950
|
+
* in the Spotter conversation edit menu.
|
|
6951
|
+
* @example
|
|
6952
|
+
* ```js
|
|
6953
|
+
* disabledActions: [Action.SpotterChatDelete]
|
|
6954
|
+
* ```
|
|
6955
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6956
|
+
*/
|
|
6957
|
+
SpotterChatDelete = "spotterChatDelete",
|
|
6958
|
+
/**
|
|
6959
|
+
* Controls visibility and disable state of the documentation/best practices
|
|
6960
|
+
* link in the Spotter sidebar footer.
|
|
6961
|
+
* @example
|
|
6962
|
+
* ```js
|
|
6963
|
+
* disabledActions: [Action.SpotterDocs]
|
|
6964
|
+
* ```
|
|
6965
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6966
|
+
*/
|
|
6967
|
+
SpotterDocs = "spotterDocs",
|
|
6732
6968
|
/**
|
|
6733
6969
|
* The **Include current period** checkbox for date filters.
|
|
6734
6970
|
* Controls the visibility and availability of the option to include
|
|
@@ -6893,9 +7129,9 @@ declare enum EmbedErrorCodes {
|
|
|
6893
7129
|
WORKSHEET_ID_NOT_FOUND = "WORKSHEET_ID_NOT_FOUND",
|
|
6894
7130
|
/** Required Liveboard ID is missing from configuration */
|
|
6895
7131
|
LIVEBOARD_ID_MISSING = "LIVEBOARD_ID_MISSING",
|
|
6896
|
-
/** Conflicting action configuration detected
|
|
7132
|
+
/** Conflicting action configuration detected */
|
|
6897
7133
|
CONFLICTING_ACTIONS_CONFIG = "CONFLICTING_ACTIONS_CONFIG",
|
|
6898
|
-
/** Conflicting tab configuration detected
|
|
7134
|
+
/** Conflicting tab configuration detected */
|
|
6899
7135
|
CONFLICTING_TABS_CONFIG = "CONFLICTING_TABS_CONFIG",
|
|
6900
7136
|
/** Error during component initialization */
|
|
6901
7137
|
INIT_ERROR = "INIT_ERROR",
|
|
@@ -6912,7 +7148,9 @@ declare enum EmbedErrorCodes {
|
|
|
6912
7148
|
/** Error parsing api intercept body */
|
|
6913
7149
|
PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
|
|
6914
7150
|
/** Failed to update embed parameters during pre-render */
|
|
6915
|
-
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
|
|
7151
|
+
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
|
|
7152
|
+
/** Invalid URL provided in configuration */
|
|
7153
|
+
INVALID_URL = "INVALID_URL"
|
|
6916
7154
|
}
|
|
6917
7155
|
/**
|
|
6918
7156
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -6925,7 +7163,7 @@ declare enum EmbedErrorCodes {
|
|
|
6925
7163
|
*
|
|
6926
7164
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
6927
7165
|
* - **message**: Human-readable error description (string or array of strings for multiple errors)
|
|
6928
|
-
* - **code**: Machine-readable error identifier
|
|
7166
|
+
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes} values
|
|
6929
7167
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
6930
7168
|
*
|
|
6931
7169
|
* ## Usage
|
|
@@ -6935,12 +7173,11 @@ declare enum EmbedErrorCodes {
|
|
|
6935
7173
|
*
|
|
6936
7174
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
6937
7175
|
* @group Error Handling
|
|
6938
|
-
* @see {@link ErrorDetailsTypes} - Available error type values
|
|
6939
|
-
* @see {@link EmbedEvent.Error} - The event that emits this object
|
|
6940
7176
|
*
|
|
6941
7177
|
* @example
|
|
6942
7178
|
* Handle specific error types
|
|
6943
7179
|
*
|
|
7180
|
+
* ```js
|
|
6944
7181
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6945
7182
|
* switch (error.code) {
|
|
6946
7183
|
* case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
|
|
@@ -6950,30 +7187,18 @@ declare enum EmbedErrorCodes {
|
|
|
6950
7187
|
* console.error('Unknown error:', error);
|
|
6951
7188
|
* }
|
|
6952
7189
|
* });
|
|
6953
|
-
*
|
|
7190
|
+
* ```
|
|
6954
7191
|
* @example
|
|
6955
7192
|
* Handle multiple error messages
|
|
6956
7193
|
*
|
|
7194
|
+
* ```js
|
|
6957
7195
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
6958
7196
|
* const messages = Array.isArray(error.message)
|
|
6959
7197
|
* ? error.message
|
|
6960
7198
|
* : [error.message];
|
|
6961
|
-
*
|
|
6962
7199
|
* messages.forEach(msg => console.error(msg));
|
|
6963
7200
|
* });
|
|
6964
|
-
*
|
|
6965
|
-
* @example
|
|
6966
|
-
* Access additional error context
|
|
6967
|
-
*
|
|
6968
|
-
* embed.on(EmbedEvent.Error, (error) => {
|
|
6969
|
-
* console.error('Error Details:', {
|
|
6970
|
-
* type: error.errorType,
|
|
6971
|
-
* message: error.message,
|
|
6972
|
-
* code: error.code,
|
|
6973
|
-
* // Additional context fields vary by error type
|
|
6974
|
-
* ...error
|
|
6975
|
-
* });
|
|
6976
|
-
* });
|
|
7201
|
+
* ```
|
|
6977
7202
|
* */
|
|
6978
7203
|
export interface EmbedErrorDetailsEvent {
|
|
6979
7204
|
/** The type of error that occurred */
|
|
@@ -6985,6 +7210,24 @@ export interface EmbedErrorDetailsEvent {
|
|
|
6985
7210
|
/** Additional context-specific for backward compatibility */
|
|
6986
7211
|
[key: string]: any;
|
|
6987
7212
|
}
|
|
7213
|
+
declare enum ContextType {
|
|
7214
|
+
/**
|
|
7215
|
+
* Search answer context for search page or edit viz dialog on liveboard page.
|
|
7216
|
+
*/
|
|
7217
|
+
Search = "search-answer",
|
|
7218
|
+
/**
|
|
7219
|
+
* Liveboard context for liveboard page.
|
|
7220
|
+
*/
|
|
7221
|
+
Liveboard = "liveboard",
|
|
7222
|
+
/**
|
|
7223
|
+
* Answer context for explore modal/page on liveboard page.
|
|
7224
|
+
*/
|
|
7225
|
+
Answer = "answer",
|
|
7226
|
+
/**
|
|
7227
|
+
* Spotter context for spotter modal/page.
|
|
7228
|
+
*/
|
|
7229
|
+
Spotter = "spotter"
|
|
7230
|
+
}
|
|
6988
7231
|
export interface DefaultAppInitData {
|
|
6989
7232
|
customisations: CustomisationsInterface;
|
|
6990
7233
|
authToken: string;
|
|
@@ -7057,6 +7300,89 @@ export type ApiInterceptFlags = {
|
|
|
7057
7300
|
*/
|
|
7058
7301
|
interceptTimeout?: number;
|
|
7059
7302
|
};
|
|
7303
|
+
/**
|
|
7304
|
+
* Object IDs for the embedded component.
|
|
7305
|
+
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
7306
|
+
*/
|
|
7307
|
+
export interface ObjectIds {
|
|
7308
|
+
/**
|
|
7309
|
+
* Liveboard ID.
|
|
7310
|
+
*/
|
|
7311
|
+
liveboardId?: string;
|
|
7312
|
+
/**
|
|
7313
|
+
* Answer ID.
|
|
7314
|
+
*/
|
|
7315
|
+
answerId?: string;
|
|
7316
|
+
/**
|
|
7317
|
+
* Viz IDs.
|
|
7318
|
+
*/
|
|
7319
|
+
vizIds?: string[];
|
|
7320
|
+
/**
|
|
7321
|
+
* Data model IDs.
|
|
7322
|
+
*/
|
|
7323
|
+
dataModelIds?: string[];
|
|
7324
|
+
/**
|
|
7325
|
+
* Modal title.
|
|
7326
|
+
*/
|
|
7327
|
+
modalTitle?: string;
|
|
7328
|
+
}
|
|
7329
|
+
/**
|
|
7330
|
+
* Context object for the embedded component.
|
|
7331
|
+
* @example
|
|
7332
|
+
* ```js
|
|
7333
|
+
* const context = await embed.getCurrentContext();
|
|
7334
|
+
* console.log(context);
|
|
7335
|
+
* {
|
|
7336
|
+
* stack: [
|
|
7337
|
+
* {
|
|
7338
|
+
* name: 'Liveboard',
|
|
7339
|
+
* type: ContextType.Liveboard,
|
|
7340
|
+
* objectIds: {
|
|
7341
|
+
* liveboardId: '123',
|
|
7342
|
+
* },
|
|
7343
|
+
* },
|
|
7344
|
+
* ],
|
|
7345
|
+
* currentContext: {
|
|
7346
|
+
* name: 'Liveboard',
|
|
7347
|
+
* type: ContextType.Liveboard,
|
|
7348
|
+
* objectIds: {
|
|
7349
|
+
* liveboardId: '123',
|
|
7350
|
+
* },
|
|
7351
|
+
* },
|
|
7352
|
+
* }
|
|
7353
|
+
* ```
|
|
7354
|
+
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
7355
|
+
*/
|
|
7356
|
+
export interface ContextObject {
|
|
7357
|
+
/**
|
|
7358
|
+
* Stack of context objects.
|
|
7359
|
+
*/
|
|
7360
|
+
stack: Array<{
|
|
7361
|
+
/**
|
|
7362
|
+
* Name of the context object.
|
|
7363
|
+
*/
|
|
7364
|
+
name: string;
|
|
7365
|
+
/**
|
|
7366
|
+
* Type of the context object.
|
|
7367
|
+
*/
|
|
7368
|
+
type: ContextType;
|
|
7369
|
+
/**
|
|
7370
|
+
* Object IDs of the context object.
|
|
7371
|
+
*/
|
|
7372
|
+
objectIds: ObjectIds;
|
|
7373
|
+
}>;
|
|
7374
|
+
/**
|
|
7375
|
+
* Current context object.
|
|
7376
|
+
*/
|
|
7377
|
+
currentContext: {
|
|
7378
|
+
/**
|
|
7379
|
+
* Name of the current context object.
|
|
7380
|
+
*/
|
|
7381
|
+
name: string;
|
|
7382
|
+
type: ContextType;
|
|
7383
|
+
objectIds: ObjectIds;
|
|
7384
|
+
};
|
|
7385
|
+
}
|
|
7060
7386
|
declare enum AuthFailureType {
|
|
7061
7387
|
SDK = "SDK",
|
|
7062
7388
|
NO_COOKIE_ACCESS = "NO_COOKIE_ACCESS",
|
|
@@ -7230,9 +7556,9 @@ export type EmbedApiHostEventMapping = {
|
|
|
7230
7556
|
[HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
|
|
7231
7557
|
};
|
|
7232
7558
|
export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7233
|
-
export type HostEventResponse<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7559
|
+
export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
|
|
7234
7560
|
export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
|
|
7235
|
-
export type TriggerResponse<PayloadT, HostEventT extends HostEvent> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT> : any;
|
|
7561
|
+
export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
|
|
7236
7562
|
declare class HostEventClient {
|
|
7237
7563
|
iFrame: HTMLIFrameElement;
|
|
7238
7564
|
constructor(iFrame?: HTMLIFrameElement);
|
|
@@ -7242,18 +7568,18 @@ declare class HostEventClient {
|
|
|
7242
7568
|
* @param {any} data Data to send with the host event
|
|
7243
7569
|
* @returns {Promise<any>} - the response from the process trigger
|
|
7244
7570
|
*/
|
|
7245
|
-
protected processTrigger(message: HostEvent, data: any): Promise<any>;
|
|
7246
|
-
handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT
|
|
7247
|
-
hostEventFallback(hostEvent: HostEvent, data: any): Promise<any>;
|
|
7571
|
+
protected processTrigger(message: HostEvent, data: any, context?: ContextType): Promise<any>;
|
|
7572
|
+
handleHostEventWithParam<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughResponse<UIPassthroughEventT>>;
|
|
7573
|
+
hostEventFallback(hostEvent: HostEvent, data: any, context?: ContextType): Promise<any>;
|
|
7248
7574
|
/**
|
|
7249
7575
|
* Setter for the iframe element used for host events
|
|
7250
7576
|
* @param {HTMLIFrameElement} iFrame - the iframe element to set
|
|
7251
7577
|
*/
|
|
7252
7578
|
setIframeElement(iFrame: HTMLIFrameElement): void;
|
|
7253
|
-
triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT
|
|
7254
|
-
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin
|
|
7255
|
-
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer
|
|
7256
|
-
triggerHostEvent<HostEventT extends HostEvent, PayloadT>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT
|
|
7579
|
+
triggerUIPassthroughApi<UIPassthroughEventT extends UIPassthroughEvent>(apiName: UIPassthroughEventT, parameters: UIPassthroughRequest<UIPassthroughEventT>, context?: ContextType): Promise<UIPassthroughArrayResponse<UIPassthroughEventT>>;
|
|
7580
|
+
protected handlePinEvent(payload: HostEventRequest<HostEvent.Pin>, context?: ContextType): Promise<HostEventResponse<HostEvent.Pin, ContextType>>;
|
|
7581
|
+
protected handleSaveAnswerEvent(payload: HostEventRequest<HostEvent.SaveAnswer>, context?: ContextType): Promise<any>;
|
|
7582
|
+
triggerHostEvent<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(hostEvent: HostEventT, payload?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextType>>;
|
|
7257
7583
|
}
|
|
7258
7584
|
declare class TsEmbed {
|
|
7259
7585
|
/**
|
|
@@ -7400,6 +7726,21 @@ declare class TsEmbed {
|
|
|
7400
7726
|
* @param responder
|
|
7401
7727
|
*/
|
|
7402
7728
|
private appInitCb;
|
|
7729
|
+
/**
|
|
7730
|
+
* Helper method to refresh/update auth token for TrustedAuthTokenCookieless auth type
|
|
7731
|
+
* @param responder - Function to send response back
|
|
7732
|
+
* @param eventType - The embed event type to send
|
|
7733
|
+
* @param forceRefresh - Whether to force refresh the token
|
|
7734
|
+
* @returns Promise that resolves if token was refreshed, rejects otherwise
|
|
7735
|
+
*/
|
|
7736
|
+
private refreshAuthTokenForCookieless;
|
|
7737
|
+
private handleAuthFailure;
|
|
7738
|
+
/**
|
|
7739
|
+
* Refresh the auth token if the autoLogin is true and the authType is TrustedAuthTokenCookieless
|
|
7740
|
+
* @param _
|
|
7741
|
+
* @param responder
|
|
7742
|
+
*/
|
|
7743
|
+
private tokenRefresh;
|
|
7403
7744
|
/**
|
|
7404
7745
|
* Sends updated auth token to the iFrame to avoid user logout
|
|
7405
7746
|
* @param _
|
|
@@ -7575,7 +7916,7 @@ declare class TsEmbed {
|
|
|
7575
7916
|
* @param {any} data The payload to send with the message
|
|
7576
7917
|
* @returns A promise that resolves with the response from the embedded app
|
|
7577
7918
|
*/
|
|
7578
|
-
trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT
|
|
7919
|
+
trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
|
|
7579
7920
|
/**
|
|
7580
7921
|
* Triggers an event to the embedded app, skipping the UI flow.
|
|
7581
7922
|
* @param {UIPassthroughEvent} apiName - The name of the API to be triggered.
|
|
@@ -7593,6 +7934,12 @@ declare class TsEmbed {
|
|
|
7593
7934
|
render(): Promise<TsEmbed>;
|
|
7594
7935
|
getIframeSrc(): string;
|
|
7595
7936
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
7937
|
+
/**
|
|
7938
|
+
* Get the current context of the embedded TS component.
|
|
7939
|
+
* @returns The current context object containing the page type and object ids.
|
|
7940
|
+
* @version SDK: 1.45.2 | ThoughtSpot: 26.3.0.cl
|
|
7941
|
+
*/
|
|
7942
|
+
getCurrentContext(): Promise<ContextObject>;
|
|
7596
7943
|
/**
|
|
7597
7944
|
* Creates the preRender shell
|
|
7598
7945
|
* @param showPreRenderByDefault - Show the preRender after render, hidden by default
|
|
@@ -8282,65 +8629,394 @@ declare class SageEmbed extends V1Embed {
|
|
|
8282
8629
|
*/
|
|
8283
8630
|
render(): Promise<SageEmbed>;
|
|
8284
8631
|
}
|
|
8632
|
+
interface SearchOptions$2 {
|
|
8633
|
+
/**
|
|
8634
|
+
* The query string to pass to start the Conversation.
|
|
8635
|
+
*/
|
|
8636
|
+
searchQuery: string;
|
|
8637
|
+
}
|
|
8285
8638
|
/**
|
|
8286
|
-
*
|
|
8639
|
+
* Configuration for the Spotter sidebar.
|
|
8640
|
+
* Can be used in SpotterEmbed and AppEmbed.
|
|
8641
|
+
* @group Embed components
|
|
8642
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8287
8643
|
*/
|
|
8288
|
-
export
|
|
8644
|
+
export interface SpotterSidebarViewConfig {
|
|
8289
8645
|
/**
|
|
8290
|
-
*
|
|
8646
|
+
* Controls the visibility of the past conversations sidebar.
|
|
8647
|
+
* @default false
|
|
8648
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8291
8649
|
*/
|
|
8292
|
-
|
|
8650
|
+
enablePastConversationsSidebar?: boolean;
|
|
8293
8651
|
/**
|
|
8294
|
-
*
|
|
8652
|
+
* Custom title text for the sidebar header.
|
|
8653
|
+
* Defaults to translated "Spotter" text.
|
|
8654
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8295
8655
|
*/
|
|
8296
|
-
|
|
8656
|
+
spotterSidebarTitle?: string;
|
|
8297
8657
|
/**
|
|
8298
|
-
*
|
|
8658
|
+
* Boolean to set the default expanded state of the sidebar.
|
|
8659
|
+
* @default false
|
|
8660
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8299
8661
|
*/
|
|
8300
|
-
|
|
8662
|
+
spotterSidebarDefaultExpanded?: boolean;
|
|
8301
8663
|
/**
|
|
8302
|
-
*
|
|
8664
|
+
* Custom label text for the rename action in the conversation edit menu.
|
|
8665
|
+
* Defaults to translated "Rename" text.
|
|
8666
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8303
8667
|
*/
|
|
8304
|
-
|
|
8668
|
+
spotterChatRenameLabel?: string;
|
|
8305
8669
|
/**
|
|
8306
|
-
*
|
|
8670
|
+
* Custom label text for the delete action in the conversation edit menu.
|
|
8671
|
+
* Defaults to translated "DELETE" text.
|
|
8672
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8307
8673
|
*/
|
|
8308
|
-
|
|
8674
|
+
spotterChatDeleteLabel?: string;
|
|
8309
8675
|
/**
|
|
8310
|
-
*
|
|
8676
|
+
* Custom title text for the delete conversation confirmation modal.
|
|
8677
|
+
* Defaults to translated "Delete chat" text.
|
|
8678
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8311
8679
|
*/
|
|
8312
|
-
|
|
8680
|
+
spotterDeleteConversationModalTitle?: string;
|
|
8313
8681
|
/**
|
|
8314
|
-
*
|
|
8682
|
+
* Custom message text for the past conversation banner alert.
|
|
8683
|
+
* Defaults to translated alert message.
|
|
8684
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8315
8685
|
*/
|
|
8316
|
-
|
|
8686
|
+
spotterPastConversationAlertMessage?: string;
|
|
8317
8687
|
/**
|
|
8318
|
-
*
|
|
8688
|
+
* Custom URL for the documentation/best practices link.
|
|
8689
|
+
* Defaults to ThoughtSpot docs URL based on release version.
|
|
8690
|
+
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
8691
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8319
8692
|
*/
|
|
8320
|
-
|
|
8321
|
-
}
|
|
8322
|
-
declare enum DataPanelCustomColumnGroupsAccordionState$1 {
|
|
8693
|
+
spotterDocumentationUrl?: string;
|
|
8323
8694
|
/**
|
|
8324
|
-
*
|
|
8695
|
+
* Custom label text for the best practices button in the footer.
|
|
8696
|
+
* Defaults to translated "Best Practices" text.
|
|
8697
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8325
8698
|
*/
|
|
8326
|
-
|
|
8699
|
+
spotterBestPracticesLabel?: string;
|
|
8327
8700
|
/**
|
|
8328
|
-
*
|
|
8701
|
+
* Number of conversations to fetch per batch when loading conversation history.
|
|
8702
|
+
* @default 30
|
|
8703
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8329
8704
|
*/
|
|
8330
|
-
|
|
8705
|
+
spotterConversationsBatchSize?: number;
|
|
8331
8706
|
/**
|
|
8332
|
-
*
|
|
8707
|
+
* Custom title text for the "New Chat" button in the sidebar.
|
|
8708
|
+
* Defaults to translated "New Chat" text.
|
|
8709
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8333
8710
|
*/
|
|
8334
|
-
|
|
8335
|
-
}
|
|
8336
|
-
declare enum HomePageSearchBarMode {
|
|
8337
|
-
OBJECT_SEARCH = "objectSearch",
|
|
8338
|
-
AI_ANSWER = "aiAnswer",
|
|
8339
|
-
NONE = "none"
|
|
8711
|
+
spotterNewChatButtonTitle?: string;
|
|
8340
8712
|
}
|
|
8341
|
-
|
|
8713
|
+
/**
|
|
8714
|
+
* Configuration for customizing Spotter chat UI branding.
|
|
8715
|
+
* @group Embed components
|
|
8716
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8717
|
+
*/
|
|
8718
|
+
export interface SpotterChatViewConfig {
|
|
8342
8719
|
/**
|
|
8343
|
-
*
|
|
8720
|
+
* Hides the ThoughtSpot logo/icon in tool response
|
|
8721
|
+
* cards. The branding label prefix is controlled
|
|
8722
|
+
* separately via `toolResponseCardBrandingLabel`.
|
|
8723
|
+
* External MCP tool branding is not affected.
|
|
8724
|
+
* @default false
|
|
8725
|
+
*/
|
|
8726
|
+
hideToolResponseCardBranding?: boolean;
|
|
8727
|
+
/**
|
|
8728
|
+
* Custom label to replace the "ThoughtSpot" prefix
|
|
8729
|
+
* in tool response cards. Set to an empty string
|
|
8730
|
+
* `''` to hide the prefix entirely. Works
|
|
8731
|
+
* independently of `hideToolResponseCardBranding`.
|
|
8732
|
+
* External MCP tool branding is not affected.
|
|
8733
|
+
*/
|
|
8734
|
+
toolResponseCardBrandingLabel?: string;
|
|
8735
|
+
}
|
|
8736
|
+
/**
|
|
8737
|
+
* The configuration for the embedded spotterEmbed options.
|
|
8738
|
+
* @group Embed components
|
|
8739
|
+
*/
|
|
8740
|
+
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
|
|
8741
|
+
/**
|
|
8742
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
8743
|
+
* this object to query data and generate Answers.
|
|
8744
|
+
*/
|
|
8745
|
+
worksheetId: string;
|
|
8746
|
+
/**
|
|
8747
|
+
* Ability to pass a starting search query to the conversation.
|
|
8748
|
+
*/
|
|
8749
|
+
searchOptions?: SearchOptions$2;
|
|
8750
|
+
/**
|
|
8751
|
+
* disableSourceSelection : Disables data source selection
|
|
8752
|
+
* but still display the selected data source.
|
|
8753
|
+
*
|
|
8754
|
+
* Supported embed types: `SpotterEmbed`
|
|
8755
|
+
* @example
|
|
8756
|
+
* ```js
|
|
8757
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8758
|
+
* ... //other embed view config
|
|
8759
|
+
* disableSourceSelection : true,
|
|
8760
|
+
* })
|
|
8761
|
+
* ```
|
|
8762
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8763
|
+
*/
|
|
8764
|
+
disableSourceSelection?: boolean;
|
|
8765
|
+
/**
|
|
8766
|
+
* hideSourceSelection : Hide data source selection
|
|
8767
|
+
*
|
|
8768
|
+
* Supported embed types: `SpotterEmbed`
|
|
8769
|
+
* @example
|
|
8770
|
+
* ```js
|
|
8771
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8772
|
+
* ... //other embed view config
|
|
8773
|
+
* hideSourceSelection : true,
|
|
8774
|
+
* })
|
|
8775
|
+
* ```
|
|
8776
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8777
|
+
*/
|
|
8778
|
+
hideSourceSelection?: boolean;
|
|
8779
|
+
/**
|
|
8780
|
+
* Flag to control Data panel experience
|
|
8781
|
+
*
|
|
8782
|
+
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
8783
|
+
* @default true
|
|
8784
|
+
* @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
|
|
8785
|
+
* @example
|
|
8786
|
+
* ```js
|
|
8787
|
+
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
8788
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8789
|
+
* ... // other embed view config
|
|
8790
|
+
* dataPanelV2: true,
|
|
8791
|
+
* })
|
|
8792
|
+
* ```
|
|
8793
|
+
*/
|
|
8794
|
+
dataPanelV2?: boolean;
|
|
8795
|
+
/**
|
|
8796
|
+
* showSpotterLimitations : show limitation text
|
|
8797
|
+
* of the spotter underneath the chat input.
|
|
8798
|
+
* default is false.
|
|
8799
|
+
*
|
|
8800
|
+
* Supported embed types: `SpotterEmbed`
|
|
8801
|
+
* @example
|
|
8802
|
+
* ```js
|
|
8803
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8804
|
+
* ... //other embed view config
|
|
8805
|
+
* showSpotterLimitations : true,
|
|
8806
|
+
* })
|
|
8807
|
+
* ```
|
|
8808
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8809
|
+
*/
|
|
8810
|
+
showSpotterLimitations?: boolean;
|
|
8811
|
+
/**
|
|
8812
|
+
* hideSampleQuestions : Hide sample questions on
|
|
8813
|
+
* the initial screen of the conversation.
|
|
8814
|
+
*
|
|
8815
|
+
* Supported embed types: `SpotterEmbed`
|
|
8816
|
+
* @example
|
|
8817
|
+
* ```js
|
|
8818
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8819
|
+
* ... //other embed view config
|
|
8820
|
+
* hideSampleQuestions : true,
|
|
8821
|
+
* })
|
|
8822
|
+
* ```
|
|
8823
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8824
|
+
*/
|
|
8825
|
+
hideSampleQuestions?: boolean;
|
|
8826
|
+
/**
|
|
8827
|
+
* The list of runtime filters to apply to a search Answer,
|
|
8828
|
+
* visualization, or Liveboard.
|
|
8829
|
+
*
|
|
8830
|
+
* Supported embed types: `SpotterEmbed`
|
|
8831
|
+
* @example
|
|
8832
|
+
* ```js
|
|
8833
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8834
|
+
* // other embed view config
|
|
8835
|
+
* runtimeFilters: [
|
|
8836
|
+
* {
|
|
8837
|
+
* columnName: 'color',
|
|
8838
|
+
* operator: RuntimeFilterOp.EQ,
|
|
8839
|
+
* values: ['red'],
|
|
8840
|
+
* },
|
|
8841
|
+
* ],
|
|
8842
|
+
* })
|
|
8843
|
+
* ```
|
|
8844
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8845
|
+
*/
|
|
8846
|
+
runtimeFilters?: RuntimeFilter[];
|
|
8847
|
+
/**
|
|
8848
|
+
* Flag to control whether runtime filters should be included in the URL.
|
|
8849
|
+
* If true, filters will be passed via app initialization payload
|
|
8850
|
+
* (default behavior from SDK 1.45.0).
|
|
8851
|
+
* If false/undefined, filters are appended to the iframe URL instead.
|
|
8852
|
+
* (default behavior before SDK 1.45.0).
|
|
8853
|
+
*
|
|
8854
|
+
* Supported embed types: `SpotterEmbed`
|
|
8855
|
+
* @default true
|
|
8856
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8857
|
+
*/
|
|
8858
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
8859
|
+
/**
|
|
8860
|
+
* The list of runtime parameters to apply to the conversation.
|
|
8861
|
+
*
|
|
8862
|
+
* Supported embed types: `SpotterEmbed`
|
|
8863
|
+
* @example
|
|
8864
|
+
* ```js
|
|
8865
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8866
|
+
* // other embed view config
|
|
8867
|
+
* runtimeParameters: [
|
|
8868
|
+
* {
|
|
8869
|
+
* name: 'Integer Param',
|
|
8870
|
+
* value: 10,
|
|
8871
|
+
* },
|
|
8872
|
+
* ],
|
|
8873
|
+
* })
|
|
8874
|
+
* ```
|
|
8875
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8876
|
+
*/
|
|
8877
|
+
runtimeParameters?: RuntimeParameter[];
|
|
8878
|
+
/**
|
|
8879
|
+
* Flag to control whether runtime parameters should be included in the URL.
|
|
8880
|
+
* If true, parameters will be passed via app
|
|
8881
|
+
* initialization payload (default behavior from SDK 1.45.0).
|
|
8882
|
+
* If false/undefined, parameters are appended to
|
|
8883
|
+
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
8884
|
+
*
|
|
8885
|
+
* Supported embed types: `SpotterEmbed`
|
|
8886
|
+
* @default true
|
|
8887
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8888
|
+
*/
|
|
8889
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
8890
|
+
/**
|
|
8891
|
+
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
8892
|
+
*
|
|
8893
|
+
* Supported embed types: `SpotterEmbed`
|
|
8894
|
+
* @default false
|
|
8895
|
+
* @example
|
|
8896
|
+
* ```js
|
|
8897
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8898
|
+
* ... //other embed view config
|
|
8899
|
+
* updatedSpotterChatPrompt : true,
|
|
8900
|
+
* })
|
|
8901
|
+
* ```
|
|
8902
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8903
|
+
*/
|
|
8904
|
+
updatedSpotterChatPrompt?: boolean;
|
|
8905
|
+
/**
|
|
8906
|
+
* Configuration for the Spotter sidebar UI customization.
|
|
8907
|
+
*
|
|
8908
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
8909
|
+
* @example
|
|
8910
|
+
* ```js
|
|
8911
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8912
|
+
* ... //other embed view config
|
|
8913
|
+
* spotterSidebarConfig: {
|
|
8914
|
+
* enablePastConversationsSidebar: true,
|
|
8915
|
+
* spotterSidebarTitle: 'My Conversations',
|
|
8916
|
+
* spotterSidebarDefaultExpanded: true,
|
|
8917
|
+
* },
|
|
8918
|
+
* })
|
|
8919
|
+
* ```
|
|
8920
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8921
|
+
*/
|
|
8922
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
8923
|
+
/**
|
|
8924
|
+
* Configuration for customizing Spotter chat UI
|
|
8925
|
+
* branding in tool response cards.
|
|
8926
|
+
*
|
|
8927
|
+
* Supported embed types: `SpotterEmbed`
|
|
8928
|
+
* @example
|
|
8929
|
+
* ```js
|
|
8930
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8931
|
+
* ... //other embed view config
|
|
8932
|
+
* spotterChatConfig: {
|
|
8933
|
+
* hideToolResponseCardBranding: true,
|
|
8934
|
+
* toolResponseCardBrandingLabel: 'MyBrand',
|
|
8935
|
+
* },
|
|
8936
|
+
* })
|
|
8937
|
+
* ```
|
|
8938
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8939
|
+
*/
|
|
8940
|
+
spotterChatConfig?: SpotterChatViewConfig;
|
|
8941
|
+
}
|
|
8942
|
+
/**
|
|
8943
|
+
* The configuration for the embedded spotterEmbed options.
|
|
8944
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8945
|
+
* Use {@link SpotterEmbedViewConfig} instead
|
|
8946
|
+
* @group Embed components
|
|
8947
|
+
*/
|
|
8948
|
+
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
8949
|
+
}
|
|
8950
|
+
declare class SpotterEmbed extends TsEmbed {
|
|
8951
|
+
protected viewConfig: SpotterEmbedViewConfig;
|
|
8952
|
+
constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
|
|
8953
|
+
protected getEmbedParamsObject(): Record<any, any>;
|
|
8954
|
+
getIframeSrc(): string;
|
|
8955
|
+
render(): Promise<SpotterEmbed>;
|
|
8956
|
+
}
|
|
8957
|
+
declare class ConversationEmbed extends SpotterEmbed {
|
|
8958
|
+
protected viewConfig: ConversationViewConfig;
|
|
8959
|
+
constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
|
|
8960
|
+
}
|
|
8961
|
+
/**
|
|
8962
|
+
* Pages within the ThoughtSpot app that can be embedded.
|
|
8963
|
+
*/
|
|
8964
|
+
export declare enum Page {
|
|
8965
|
+
/**
|
|
8966
|
+
* Home page
|
|
8967
|
+
*/
|
|
8968
|
+
Home = "home",
|
|
8969
|
+
/**
|
|
8970
|
+
* Search page
|
|
8971
|
+
*/
|
|
8972
|
+
Search = "search",
|
|
8973
|
+
/**
|
|
8974
|
+
* Saved answers listing page
|
|
8975
|
+
*/
|
|
8976
|
+
Answers = "answers",
|
|
8977
|
+
/**
|
|
8978
|
+
* Liveboards listing page
|
|
8979
|
+
*/
|
|
8980
|
+
Liveboards = "liveboards",
|
|
8981
|
+
/**
|
|
8982
|
+
* @hidden
|
|
8983
|
+
*/
|
|
8984
|
+
Pinboards = "pinboards",
|
|
8985
|
+
/**
|
|
8986
|
+
* Data management page
|
|
8987
|
+
*/
|
|
8988
|
+
Data = "data",
|
|
8989
|
+
/**
|
|
8990
|
+
* SpotIQ listing page
|
|
8991
|
+
*/
|
|
8992
|
+
SpotIQ = "insights",
|
|
8993
|
+
/**
|
|
8994
|
+
* Monitor Alerts Page
|
|
8995
|
+
*/
|
|
8996
|
+
Monitor = "monitor"
|
|
8997
|
+
}
|
|
8998
|
+
declare enum DataPanelCustomColumnGroupsAccordionState$1 {
|
|
8999
|
+
/**
|
|
9000
|
+
* Expand all the accordion initially in data panel v2.
|
|
9001
|
+
*/
|
|
9002
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
9003
|
+
/**
|
|
9004
|
+
* Collapse all the accordions initially in data panel v2.
|
|
9005
|
+
*/
|
|
9006
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
9007
|
+
/**
|
|
9008
|
+
* Expand the first accordion and collapse the rest.
|
|
9009
|
+
*/
|
|
9010
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
9011
|
+
}
|
|
9012
|
+
declare enum HomePageSearchBarMode {
|
|
9013
|
+
OBJECT_SEARCH = "objectSearch",
|
|
9014
|
+
AI_ANSWER = "aiAnswer",
|
|
9015
|
+
NONE = "none"
|
|
9016
|
+
}
|
|
9017
|
+
declare enum PrimaryNavbarVersion {
|
|
9018
|
+
/**
|
|
9019
|
+
* Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
|
|
8344
9020
|
* along with updates to the top navigation bar.
|
|
8345
9021
|
* It serves as the foundational version of the PrimaryNavBar.
|
|
8346
9022
|
*/
|
|
@@ -8903,6 +9579,42 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8903
9579
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8904
9580
|
*/
|
|
8905
9581
|
updatedSpotterChatPrompt?: boolean;
|
|
9582
|
+
/**
|
|
9583
|
+
* Configuration for the Spotter sidebar UI customization.
|
|
9584
|
+
* Only applicable when navigating to Spotter within the app.
|
|
9585
|
+
*
|
|
9586
|
+
* Supported embed types: `AppEmbed`
|
|
9587
|
+
* @example
|
|
9588
|
+
* ```js
|
|
9589
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
9590
|
+
* ... //other embed view config
|
|
9591
|
+
* spotterSidebarConfig: {
|
|
9592
|
+
* enablePastConversationsSidebar: true,
|
|
9593
|
+
* spotterSidebarTitle: 'My Conversations',
|
|
9594
|
+
* },
|
|
9595
|
+
* })
|
|
9596
|
+
* ```
|
|
9597
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9598
|
+
*/
|
|
9599
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9600
|
+
/**
|
|
9601
|
+
* Configuration for customizing Spotter chat UI
|
|
9602
|
+
* branding in tool response cards.
|
|
9603
|
+
*
|
|
9604
|
+
* Supported embed types: `AppEmbed`
|
|
9605
|
+
* @example
|
|
9606
|
+
* ```js
|
|
9607
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
9608
|
+
* ... //other embed view config
|
|
9609
|
+
* spotterChatConfig: {
|
|
9610
|
+
* hideToolResponseCardBranding: true,
|
|
9611
|
+
* toolResponseCardBrandingLabel: 'MyBrand',
|
|
9612
|
+
* },
|
|
9613
|
+
* })
|
|
9614
|
+
* ```
|
|
9615
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9616
|
+
*/
|
|
9617
|
+
spotterChatConfig?: SpotterChatViewConfig;
|
|
8906
9618
|
/**
|
|
8907
9619
|
* This is the minimum height (in pixels) for a full-height App.
|
|
8908
9620
|
* Setting this height helps resolve issues with empty Apps and
|
|
@@ -9167,6 +9879,23 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9167
9879
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
9168
9880
|
*/
|
|
9169
9881
|
activeTabId?: string;
|
|
9882
|
+
/**
|
|
9883
|
+
* The GUID of a saved personalized view to load.
|
|
9884
|
+
* A personalized view is a saved configuration of a Liveboard
|
|
9885
|
+
* that includes specific filter selections.
|
|
9886
|
+
*
|
|
9887
|
+
* Supported embed types: `LiveboardEmbed`
|
|
9888
|
+
* @example
|
|
9889
|
+
* ```js
|
|
9890
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9891
|
+
* liveboardId: 'liveboard-guid',
|
|
9892
|
+
* personalizedViewId: 'view-guid',
|
|
9893
|
+
* activeTabId: 'tab-guid',
|
|
9894
|
+
* })
|
|
9895
|
+
* ```
|
|
9896
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9897
|
+
*/
|
|
9898
|
+
personalizedViewId?: string;
|
|
9170
9899
|
/**
|
|
9171
9900
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
9172
9901
|
*
|
|
@@ -9420,6 +10149,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9420
10149
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9421
10150
|
*/
|
|
9422
10151
|
updatedSpotterChatPrompt?: boolean;
|
|
10152
|
+
/**
|
|
10153
|
+
* Configuration for customizing Spotter chat UI
|
|
10154
|
+
* branding in tool response cards.
|
|
10155
|
+
*
|
|
10156
|
+
* Supported embed types: `LiveboardEmbed`
|
|
10157
|
+
* @example
|
|
10158
|
+
* ```js
|
|
10159
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
10160
|
+
* ... //other embed view config
|
|
10161
|
+
* spotterChatConfig: {
|
|
10162
|
+
* hideToolResponseCardBranding: true,
|
|
10163
|
+
* toolResponseCardBrandingLabel: 'MyBrand',
|
|
10164
|
+
* },
|
|
10165
|
+
* })
|
|
10166
|
+
* ```
|
|
10167
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
10168
|
+
*/
|
|
10169
|
+
spotterChatConfig?: SpotterChatViewConfig;
|
|
9423
10170
|
}
|
|
9424
10171
|
declare class LiveboardEmbed extends V1Embed {
|
|
9425
10172
|
protected viewConfig: LiveboardViewConfig;
|
|
@@ -9464,6 +10211,7 @@ declare class LiveboardEmbed extends V1Embed {
|
|
|
9464
10211
|
liveboardId: string;
|
|
9465
10212
|
vizId: string;
|
|
9466
10213
|
activeTabId: string;
|
|
10214
|
+
personalizedViewId: string;
|
|
9467
10215
|
};
|
|
9468
10216
|
protected beforePrerenderVisible(): void;
|
|
9469
10217
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
@@ -9473,7 +10221,7 @@ declare class LiveboardEmbed extends V1Embed {
|
|
|
9473
10221
|
* @param {any} data The payload to send with the message
|
|
9474
10222
|
* @returns A promise that resolves with the response from the embedded app
|
|
9475
10223
|
*/
|
|
9476
|
-
trigger<HostEventT extends HostEvent, PayloadT>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT
|
|
10224
|
+
trigger<HostEventT extends HostEvent, PayloadT, ContextT extends ContextType>(messageType: HostEventT, data?: TriggerPayload<PayloadT, HostEventT>, context?: ContextT): Promise<TriggerResponse<PayloadT, HostEventT, ContextT>>;
|
|
9477
10225
|
/**
|
|
9478
10226
|
* Destroys the ThoughtSpot embed, and remove any nodes from the DOM.
|
|
9479
10227
|
* @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
@@ -9488,7 +10236,7 @@ declare class LiveboardEmbed extends V1Embed {
|
|
|
9488
10236
|
* visualization ID and the runtime filters.
|
|
9489
10237
|
*/
|
|
9490
10238
|
render(): Promise<LiveboardEmbed>;
|
|
9491
|
-
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
10239
|
+
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, personalizedViewId?: string): void;
|
|
9492
10240
|
/**
|
|
9493
10241
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
9494
10242
|
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
@@ -9530,217 +10278,6 @@ export interface EmbedProps extends EmbedViewConfig {
|
|
|
9530
10278
|
className?: string;
|
|
9531
10279
|
style?: React$1.CSSProperties;
|
|
9532
10280
|
}
|
|
9533
|
-
interface SearchOptions$2 {
|
|
9534
|
-
/**
|
|
9535
|
-
* The query string to pass to start the Conversation.
|
|
9536
|
-
*/
|
|
9537
|
-
searchQuery: string;
|
|
9538
|
-
}
|
|
9539
|
-
/**
|
|
9540
|
-
* The configuration for the embedded spotterEmbed options.
|
|
9541
|
-
* @group Embed components
|
|
9542
|
-
*/
|
|
9543
|
-
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
|
|
9544
|
-
/**
|
|
9545
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
9546
|
-
* this object to query data and generate Answers.
|
|
9547
|
-
*/
|
|
9548
|
-
worksheetId: string;
|
|
9549
|
-
/**
|
|
9550
|
-
* Ability to pass a starting search query to the conversation.
|
|
9551
|
-
*/
|
|
9552
|
-
searchOptions?: SearchOptions$2;
|
|
9553
|
-
/**
|
|
9554
|
-
* disableSourceSelection : Disables data source selection
|
|
9555
|
-
* but still display the selected data source.
|
|
9556
|
-
*
|
|
9557
|
-
* Supported embed types: `SpotterEmbed`
|
|
9558
|
-
* @example
|
|
9559
|
-
* ```js
|
|
9560
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9561
|
-
* ... //other embed view config
|
|
9562
|
-
* disableSourceSelection : true,
|
|
9563
|
-
* })
|
|
9564
|
-
* ```
|
|
9565
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9566
|
-
*/
|
|
9567
|
-
disableSourceSelection?: boolean;
|
|
9568
|
-
/**
|
|
9569
|
-
* hideSourceSelection : Hide data source selection
|
|
9570
|
-
*
|
|
9571
|
-
* Supported embed types: `SpotterEmbed`
|
|
9572
|
-
* @example
|
|
9573
|
-
* ```js
|
|
9574
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9575
|
-
* ... //other embed view config
|
|
9576
|
-
* hideSourceSelection : true,
|
|
9577
|
-
* })
|
|
9578
|
-
* ```
|
|
9579
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9580
|
-
*/
|
|
9581
|
-
hideSourceSelection?: boolean;
|
|
9582
|
-
/**
|
|
9583
|
-
* Flag to control Data panel experience
|
|
9584
|
-
*
|
|
9585
|
-
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
9586
|
-
* @default true
|
|
9587
|
-
* @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
|
|
9588
|
-
* @example
|
|
9589
|
-
* ```js
|
|
9590
|
-
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
9591
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
9592
|
-
* ... // other embed view config
|
|
9593
|
-
* dataPanelV2: true,
|
|
9594
|
-
* })
|
|
9595
|
-
* ```
|
|
9596
|
-
*/
|
|
9597
|
-
dataPanelV2?: boolean;
|
|
9598
|
-
/**
|
|
9599
|
-
* showSpotterLimitations : show limitation text
|
|
9600
|
-
* of the spotter underneath the chat input.
|
|
9601
|
-
* default is false.
|
|
9602
|
-
*
|
|
9603
|
-
* Supported embed types: `SpotterEmbed`
|
|
9604
|
-
* @example
|
|
9605
|
-
* ```js
|
|
9606
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9607
|
-
* ... //other embed view config
|
|
9608
|
-
* showSpotterLimitations : true,
|
|
9609
|
-
* })
|
|
9610
|
-
* ```
|
|
9611
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
9612
|
-
*/
|
|
9613
|
-
showSpotterLimitations?: boolean;
|
|
9614
|
-
/**
|
|
9615
|
-
* hideSampleQuestions : Hide sample questions on
|
|
9616
|
-
* the initial screen of the conversation.
|
|
9617
|
-
*
|
|
9618
|
-
* Supported embed types: `SpotterEmbed`
|
|
9619
|
-
* @example
|
|
9620
|
-
* ```js
|
|
9621
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9622
|
-
* ... //other embed view config
|
|
9623
|
-
* hideSampleQuestions : true,
|
|
9624
|
-
* })
|
|
9625
|
-
* ```
|
|
9626
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
9627
|
-
*/
|
|
9628
|
-
hideSampleQuestions?: boolean;
|
|
9629
|
-
/**
|
|
9630
|
-
* The list of runtime filters to apply to a search Answer,
|
|
9631
|
-
* visualization, or Liveboard.
|
|
9632
|
-
*
|
|
9633
|
-
* Supported embed types: `SpotterEmbed`
|
|
9634
|
-
* @example
|
|
9635
|
-
* ```js
|
|
9636
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9637
|
-
* // other embed view config
|
|
9638
|
-
* runtimeFilters: [
|
|
9639
|
-
* {
|
|
9640
|
-
* columnName: 'color',
|
|
9641
|
-
* operator: RuntimeFilterOp.EQ,
|
|
9642
|
-
* values: ['red'],
|
|
9643
|
-
* },
|
|
9644
|
-
* ],
|
|
9645
|
-
* })
|
|
9646
|
-
* ```
|
|
9647
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9648
|
-
*/
|
|
9649
|
-
runtimeFilters?: RuntimeFilter[];
|
|
9650
|
-
/**
|
|
9651
|
-
* Flag to control whether runtime filters should be included in the URL.
|
|
9652
|
-
* If true, filters will be passed via app initialization payload
|
|
9653
|
-
* (default behavior from SDK 1.45.0).
|
|
9654
|
-
* If false/undefined, filters are appended to the iframe URL instead.
|
|
9655
|
-
* (default behavior before SDK 1.45.0).
|
|
9656
|
-
*
|
|
9657
|
-
* Supported embed types: `SpotterEmbed`
|
|
9658
|
-
* @default true
|
|
9659
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9660
|
-
*/
|
|
9661
|
-
excludeRuntimeFiltersfromURL?: boolean;
|
|
9662
|
-
/**
|
|
9663
|
-
* The list of runtime parameters to apply to the conversation.
|
|
9664
|
-
*
|
|
9665
|
-
* Supported embed types: `SpotterEmbed`
|
|
9666
|
-
* @example
|
|
9667
|
-
* ```js
|
|
9668
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9669
|
-
* // other embed view config
|
|
9670
|
-
* runtimeParameters: [
|
|
9671
|
-
* {
|
|
9672
|
-
* name: 'Integer Param',
|
|
9673
|
-
* value: 10,
|
|
9674
|
-
* },
|
|
9675
|
-
* ],
|
|
9676
|
-
* })
|
|
9677
|
-
* ```
|
|
9678
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9679
|
-
*/
|
|
9680
|
-
runtimeParameters?: RuntimeParameter[];
|
|
9681
|
-
/**
|
|
9682
|
-
* Flag to control whether runtime parameters should be included in the URL.
|
|
9683
|
-
* If true, parameters will be passed via app
|
|
9684
|
-
* initialization payload (default behavior from SDK 1.45.0).
|
|
9685
|
-
* If false/undefined, parameters are appended to
|
|
9686
|
-
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
9687
|
-
*
|
|
9688
|
-
* Supported embed types: `SpotterEmbed`
|
|
9689
|
-
* @default true
|
|
9690
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
9691
|
-
*/
|
|
9692
|
-
excludeRuntimeParametersfromURL?: boolean;
|
|
9693
|
-
/**
|
|
9694
|
-
* enablePastConversationsSidebar : Controls the visibility of the past conversations
|
|
9695
|
-
* sidebar.
|
|
9696
|
-
*
|
|
9697
|
-
* Supported embed types: `SpotterEmbed`
|
|
9698
|
-
* @default false
|
|
9699
|
-
* @example
|
|
9700
|
-
* ```js
|
|
9701
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9702
|
-
* ... //other embed view config
|
|
9703
|
-
* enablePastConversationsSidebar : true,
|
|
9704
|
-
* })
|
|
9705
|
-
* ```
|
|
9706
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9707
|
-
*/
|
|
9708
|
-
enablePastConversationsSidebar?: boolean;
|
|
9709
|
-
/**
|
|
9710
|
-
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9711
|
-
*
|
|
9712
|
-
* Supported embed types: `SpotterEmbed`
|
|
9713
|
-
* @default false
|
|
9714
|
-
* @example
|
|
9715
|
-
* ```js
|
|
9716
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9717
|
-
* ... //other embed view config
|
|
9718
|
-
* updatedSpotterChatPrompt : true,
|
|
9719
|
-
* })
|
|
9720
|
-
* ```
|
|
9721
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9722
|
-
*/
|
|
9723
|
-
updatedSpotterChatPrompt?: boolean;
|
|
9724
|
-
}
|
|
9725
|
-
/**
|
|
9726
|
-
* The configuration for the embedded spotterEmbed options.
|
|
9727
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
9728
|
-
* Use {@link SpotterEmbedViewConfig} instead
|
|
9729
|
-
* @group Embed components
|
|
9730
|
-
*/
|
|
9731
|
-
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
9732
|
-
}
|
|
9733
|
-
declare class SpotterEmbed extends TsEmbed {
|
|
9734
|
-
protected viewConfig: SpotterEmbedViewConfig;
|
|
9735
|
-
constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
|
|
9736
|
-
protected getEmbedParamsObject(): Record<any, any>;
|
|
9737
|
-
getIframeSrc(): string;
|
|
9738
|
-
render(): Promise<SpotterEmbed>;
|
|
9739
|
-
}
|
|
9740
|
-
declare class ConversationEmbed extends SpotterEmbed {
|
|
9741
|
-
protected viewConfig: ConversationViewConfig;
|
|
9742
|
-
constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
|
|
9743
|
-
}
|
|
9744
10281
|
export type SessionInfo = {
|
|
9745
10282
|
releaseVersion: string;
|
|
9746
10283
|
userGUID: string;
|