@thoughtspot/visual-embed-sdk 1.45.2 → 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/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/liveboard.d.ts +38 -1
- package/cjs/src/embed/liveboard.d.ts.map +1 -1
- package/cjs/src/embed/liveboard.js +38 -10
- package/cjs/src/embed/liveboard.js.map +1 -1
- package/cjs/src/embed/liveboard.spec.js +179 -7
- package/cjs/src/embed/liveboard.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.map +1 -1
- package/cjs/src/types.d.ts +192 -40
- package/cjs/src/types.d.ts.map +1 -1
- package/cjs/src/types.js +184 -19
- 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.d.ts +15 -0
- package/cjs/src/utils.d.ts.map +1 -1
- package/cjs/src/utils.js +33 -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-BdkKLLo1.js → index-BuwECGdm.js} +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/liveboard.d.ts +38 -1
- package/dist/src/embed/liveboard.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 +192 -40
- 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.d.ts +15 -0
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/tsembed-react.es.js +364 -52
- package/dist/tsembed-react.js +363 -51
- package/dist/tsembed.es.js +364 -52
- package/dist/tsembed.js +363 -51
- package/dist/visual-embed-sdk-react-full.d.ts +696 -342
- package/dist/visual-embed-sdk-react.d.ts +685 -331
- package/dist/visual-embed-sdk.d.ts +757 -379
- package/lib/package.json +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/liveboard.d.ts +38 -1
- package/lib/src/embed/liveboard.d.ts.map +1 -1
- package/lib/src/embed/liveboard.js +39 -11
- package/lib/src/embed/liveboard.js.map +1 -1
- package/lib/src/embed/liveboard.spec.js +179 -7
- package/lib/src/embed/liveboard.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.map +1 -1
- package/lib/src/types.d.ts +192 -40
- package/lib/src/types.d.ts.map +1 -1
- package/lib/src/types.js +184 -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.d.ts +15 -0
- package/lib/src/utils.d.ts.map +1 -1
- package/lib/src/utils.js +30 -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/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/liveboard.spec.ts +264 -10
- package/src/embed/liveboard.ts +100 -11
- package/src/errors.ts +1 -0
- package/src/index.ts +5 -1
- package/src/types.ts +193 -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.spec.ts +56 -0
- package/src/utils.ts +36 -0
|
@@ -701,6 +701,54 @@ export interface CustomCssVariables {
|
|
|
701
701
|
* Width of the Spotter chat window.
|
|
702
702
|
*/
|
|
703
703
|
"--ts-var-spotter-chat-width"?: string;
|
|
704
|
+
/**
|
|
705
|
+
* Border color for the saved chats sidebar container.
|
|
706
|
+
*/
|
|
707
|
+
"--ts-var-saved-chats-border-color"?: string;
|
|
708
|
+
/**
|
|
709
|
+
* Background color for the saved chats sidebar container.
|
|
710
|
+
*/
|
|
711
|
+
"--ts-var-saved-chats-bg"?: string;
|
|
712
|
+
/**
|
|
713
|
+
* Text color for the saved chats sidebar container.
|
|
714
|
+
*/
|
|
715
|
+
"--ts-var-saved-chats-text-color"?: string;
|
|
716
|
+
/**
|
|
717
|
+
* Border color for the saved chats sidebar header.
|
|
718
|
+
*/
|
|
719
|
+
"--ts-var-saved-chats-header-border"?: string;
|
|
720
|
+
/**
|
|
721
|
+
* Color for the saved chats sidebar title text.
|
|
722
|
+
*/
|
|
723
|
+
"--ts-var-saved-chats-title-color"?: string;
|
|
724
|
+
/**
|
|
725
|
+
* Background color for buttons (new chat, toggle, footer) in the saved chats sidebar.
|
|
726
|
+
*/
|
|
727
|
+
"--ts-var-saved-chats-btn-bg"?: string;
|
|
728
|
+
/**
|
|
729
|
+
* Hover background color for buttons in the saved chats sidebar.
|
|
730
|
+
*/
|
|
731
|
+
"--ts-var-saved-chats-btn-hover-bg"?: string;
|
|
732
|
+
/**
|
|
733
|
+
* Text color for conversation items in the saved chats sidebar.
|
|
734
|
+
*/
|
|
735
|
+
"--ts-var-saved-chats-conv-text-color"?: string;
|
|
736
|
+
/**
|
|
737
|
+
* Background color for conversation items on hover in the saved chats sidebar.
|
|
738
|
+
*/
|
|
739
|
+
"--ts-var-saved-chats-conv-hover-bg"?: string;
|
|
740
|
+
/**
|
|
741
|
+
* Background color for the active/selected conversation in the saved chats sidebar.
|
|
742
|
+
*/
|
|
743
|
+
"--ts-var-saved-chats-conv-active-bg"?: string;
|
|
744
|
+
/**
|
|
745
|
+
* Border color for the saved chats sidebar footer.
|
|
746
|
+
*/
|
|
747
|
+
"--ts-var-saved-chats-footer-border"?: string;
|
|
748
|
+
/**
|
|
749
|
+
* Color for section title text (e.g., "Recent", "Older") in the saved chats sidebar.
|
|
750
|
+
*/
|
|
751
|
+
"--ts-var-saved-chats-section-title-color"?: string;
|
|
704
752
|
}
|
|
705
753
|
export interface SessionInterface {
|
|
706
754
|
sessionId: string;
|
|
@@ -817,7 +865,8 @@ export declare class AnswerService {
|
|
|
817
865
|
* @returns
|
|
818
866
|
*/
|
|
819
867
|
addFilter(columnName: string, operator: RuntimeFilterOp, values: RuntimeFilter["values"]): Promise<any>;
|
|
820
|
-
|
|
868
|
+
updateDisplayMode(displayMode?: string): Promise<any>;
|
|
869
|
+
getSQLQuery(fetchSQLWithAllColumns?: boolean): Promise<string>;
|
|
821
870
|
/**
|
|
822
871
|
* Fetch data from the answer.
|
|
823
872
|
* @param offset
|
|
@@ -2449,7 +2498,7 @@ export interface LiveboardAppEmbedViewConfig {
|
|
|
2449
2498
|
* To enable this feature on your instance, contact ThoughtSpot Support.
|
|
2450
2499
|
*
|
|
2451
2500
|
* Supported embed types: `AppEmbed`, `LiveboardEmbed`
|
|
2452
|
-
* @version SDK: 1.
|
|
2501
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
2453
2502
|
* @example
|
|
2454
2503
|
* ```js
|
|
2455
2504
|
* // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
|
|
@@ -4012,6 +4061,42 @@ export declare enum EmbedEvent {
|
|
|
4012
4061
|
* @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
|
|
4013
4062
|
*/
|
|
4014
4063
|
ApiIntercept = "ApiIntercept",
|
|
4064
|
+
/**
|
|
4065
|
+
* Emitted when a Spotter conversation is renamed.
|
|
4066
|
+
* @example
|
|
4067
|
+
* ```js
|
|
4068
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationRenamed, (payload) => {
|
|
4069
|
+
* console.log('Conversation renamed', payload);
|
|
4070
|
+
* // payload: { convId: string, oldTitle: string, newTitle: string }
|
|
4071
|
+
* })
|
|
4072
|
+
* ```
|
|
4073
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4074
|
+
*/
|
|
4075
|
+
SpotterConversationRenamed = "spotterConversationRenamed",
|
|
4076
|
+
/**
|
|
4077
|
+
* Emitted when a Spotter conversation is deleted.
|
|
4078
|
+
* @example
|
|
4079
|
+
* ```js
|
|
4080
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationDeleted, (payload) => {
|
|
4081
|
+
* console.log('Conversation deleted', payload);
|
|
4082
|
+
* // payload: { convId: string, title: string }
|
|
4083
|
+
* })
|
|
4084
|
+
* ```
|
|
4085
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4086
|
+
*/
|
|
4087
|
+
SpotterConversationDeleted = "spotterConversationDeleted",
|
|
4088
|
+
/**
|
|
4089
|
+
* Emitted when a Spotter conversation is selected/clicked.
|
|
4090
|
+
* @example
|
|
4091
|
+
* ```js
|
|
4092
|
+
* spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => {
|
|
4093
|
+
* console.log('Conversation selected', payload);
|
|
4094
|
+
* // payload: { convId: string, title: string, worksheetId: string }
|
|
4095
|
+
* })
|
|
4096
|
+
* ```
|
|
4097
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
4098
|
+
*/
|
|
4099
|
+
SpotterConversationSelected = "spotterConversationSelected",
|
|
4015
4100
|
/**
|
|
4016
4101
|
* @hidden
|
|
4017
4102
|
* Emitted when the auth token is about to get expired and needs to be refreshed.
|
|
@@ -6859,6 +6944,96 @@ export declare enum Action {
|
|
|
6859
6944
|
* @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
|
|
6860
6945
|
*/
|
|
6861
6946
|
UngroupLiveboardGroup = "ungroupLiveboardGroup",
|
|
6947
|
+
/**
|
|
6948
|
+
* Controls visibility of the sidebar header (title and toggle button)
|
|
6949
|
+
* in the Spotter past conversations sidebar.
|
|
6950
|
+
* @example
|
|
6951
|
+
* ```js
|
|
6952
|
+
* hiddenActions: [Action.SpotterSidebarHeader]
|
|
6953
|
+
* ```
|
|
6954
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6955
|
+
*/
|
|
6956
|
+
SpotterSidebarHeader = "spotterSidebarHeader",
|
|
6957
|
+
/**
|
|
6958
|
+
* Controls visibility of the sidebar footer (documentation link)
|
|
6959
|
+
* in the Spotter past conversations sidebar.
|
|
6960
|
+
* @example
|
|
6961
|
+
* ```js
|
|
6962
|
+
* hiddenActions: [Action.SpotterSidebarFooter]
|
|
6963
|
+
* ```
|
|
6964
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6965
|
+
*/
|
|
6966
|
+
SpotterSidebarFooter = "spotterSidebarFooter",
|
|
6967
|
+
/**
|
|
6968
|
+
* Controls visibility and disable state of the sidebar toggle/expand button
|
|
6969
|
+
* in the Spotter past conversations sidebar.
|
|
6970
|
+
* @example
|
|
6971
|
+
* ```js
|
|
6972
|
+
* disabledActions: [Action.SpotterSidebarToggle]
|
|
6973
|
+
* ```
|
|
6974
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6975
|
+
*/
|
|
6976
|
+
SpotterSidebarToggle = "spotterSidebarToggle",
|
|
6977
|
+
/**
|
|
6978
|
+
* Controls visibility and disable state of the "New Chat" button
|
|
6979
|
+
* in the Spotter past conversations sidebar.
|
|
6980
|
+
* @example
|
|
6981
|
+
* ```js
|
|
6982
|
+
* disabledActions: [Action.SpotterNewChat]
|
|
6983
|
+
* ```
|
|
6984
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6985
|
+
*/
|
|
6986
|
+
SpotterNewChat = "spotterNewChat",
|
|
6987
|
+
/**
|
|
6988
|
+
* Controls visibility of the past conversation banner alert
|
|
6989
|
+
* in the Spotter interface.
|
|
6990
|
+
* @example
|
|
6991
|
+
* ```js
|
|
6992
|
+
* hiddenActions: [Action.SpotterPastChatBanner]
|
|
6993
|
+
* ```
|
|
6994
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
6995
|
+
*/
|
|
6996
|
+
SpotterPastChatBanner = "spotterPastChatBanner",
|
|
6997
|
+
/**
|
|
6998
|
+
* Controls visibility and disable state of the conversation edit menu
|
|
6999
|
+
* (three-dot menu) in the Spotter past conversations sidebar.
|
|
7000
|
+
* @example
|
|
7001
|
+
* ```js
|
|
7002
|
+
* disabledActions: [Action.SpotterChatMenu]
|
|
7003
|
+
* ```
|
|
7004
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7005
|
+
*/
|
|
7006
|
+
SpotterChatMenu = "spotterChatMenu",
|
|
7007
|
+
/**
|
|
7008
|
+
* Controls visibility and disable state of the rename action
|
|
7009
|
+
* in the Spotter conversation edit menu.
|
|
7010
|
+
* @example
|
|
7011
|
+
* ```js
|
|
7012
|
+
* disabledActions: [Action.SpotterChatRename]
|
|
7013
|
+
* ```
|
|
7014
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7015
|
+
*/
|
|
7016
|
+
SpotterChatRename = "spotterChatRename",
|
|
7017
|
+
/**
|
|
7018
|
+
* Controls visibility and disable state of the delete action
|
|
7019
|
+
* in the Spotter conversation edit menu.
|
|
7020
|
+
* @example
|
|
7021
|
+
* ```js
|
|
7022
|
+
* disabledActions: [Action.SpotterChatDelete]
|
|
7023
|
+
* ```
|
|
7024
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7025
|
+
*/
|
|
7026
|
+
SpotterChatDelete = "spotterChatDelete",
|
|
7027
|
+
/**
|
|
7028
|
+
* Controls visibility and disable state of the documentation/best practices
|
|
7029
|
+
* link in the Spotter sidebar footer.
|
|
7030
|
+
* @example
|
|
7031
|
+
* ```js
|
|
7032
|
+
* disabledActions: [Action.SpotterDocs]
|
|
7033
|
+
* ```
|
|
7034
|
+
* @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
|
|
7035
|
+
*/
|
|
7036
|
+
SpotterDocs = "spotterDocs",
|
|
6862
7037
|
/**
|
|
6863
7038
|
* The **Include current period** checkbox for date filters.
|
|
6864
7039
|
* Controls the visibility and availability of the option to include
|
|
@@ -7050,13 +7225,30 @@ export declare enum LogLevel {
|
|
|
7050
7225
|
* Error types emitted by embedded components.
|
|
7051
7226
|
*
|
|
7052
7227
|
* These enum values categorize different types of errors that can occur during
|
|
7053
|
-
* the lifecycle of an embedded ThoughtSpot component.
|
|
7054
|
-
*
|
|
7055
|
-
*
|
|
7056
|
-
* @see {@link EmbedErrorDetailsEvent} - The error event object structure
|
|
7057
|
-
* @see {@link EmbedEvent.Error} - The event that emits these errors
|
|
7228
|
+
* the lifecycle of an embedded ThoughtSpot component.
|
|
7229
|
+
* Use {@link EmbedErrorDetailsEvent} and {@link EmbedErrorCodes} to handle specific errors.
|
|
7058
7230
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
7059
7231
|
* @group Error Handling
|
|
7232
|
+
*
|
|
7233
|
+
* @example
|
|
7234
|
+
* Handle specific error types
|
|
7235
|
+
* ```js
|
|
7236
|
+
* embed.on(EmbedEvent.Error, (error) => {
|
|
7237
|
+
* switch (error.errorType) {
|
|
7238
|
+
* case ErrorDetailsTypes.API:
|
|
7239
|
+
* console.error('API error:', error.message);
|
|
7240
|
+
* break;
|
|
7241
|
+
* case ErrorDetailsTypes.VALIDATION_ERROR:
|
|
7242
|
+
* console.error('Validation error:', error.message);
|
|
7243
|
+
* break;
|
|
7244
|
+
* case ErrorDetailsTypes.NETWORK:
|
|
7245
|
+
* console.error('Network error:', error.message);
|
|
7246
|
+
* break;
|
|
7247
|
+
* default:
|
|
7248
|
+
* console.error('Unknown error:', error);
|
|
7249
|
+
* }
|
|
7250
|
+
* });
|
|
7251
|
+
* ```
|
|
7060
7252
|
*/
|
|
7061
7253
|
export declare enum ErrorDetailsTypes {
|
|
7062
7254
|
/** API call failure */
|
|
@@ -7067,34 +7259,42 @@ export declare enum ErrorDetailsTypes {
|
|
|
7067
7259
|
NETWORK = "NETWORK"
|
|
7068
7260
|
}
|
|
7069
7261
|
/**
|
|
7070
|
-
* Error codes for identifying specific issues in embedded ThoughtSpot components.
|
|
7071
|
-
*
|
|
7072
|
-
* Use these codes for precise error handling and debugging. Each code maps to a
|
|
7073
|
-
* distinct failure scenario, enabling targeted recovery strategies.
|
|
7262
|
+
* Error codes for identifying specific issues in embedded ThoughtSpot components. Use {@link EmbedErrorDetailsEvent} and {@link ErrorDetailsTypes} codes for precise error handling and debugging.
|
|
7074
7263
|
*
|
|
7075
7264
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
7076
7265
|
* @group Error Handling
|
|
7077
|
-
|
|
7078
|
-
* @see {@link EmbedErrorDetailsEvent} - The error event object that includes these codes
|
|
7079
|
-
* @see {@link ErrorDetailsTypes} - General error type categories
|
|
7080
|
-
*
|
|
7266
|
+
|
|
7081
7267
|
* @example
|
|
7082
7268
|
* Handle specific error codes in the error event handler
|
|
7083
|
-
*
|
|
7269
|
+
* ```js
|
|
7084
7270
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
7085
|
-
*
|
|
7086
|
-
*
|
|
7271
|
+
* switch (error.code) {
|
|
7272
|
+
* case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
|
|
7273
|
+
* console.error('Worksheet ID not found:', error.message);
|
|
7274
|
+
* break;
|
|
7275
|
+
* case EmbedErrorCodes.LIVEBOARD_ID_MISSING:
|
|
7276
|
+
* console.error('Liveboard ID is missing:', error.message);
|
|
7277
|
+
* break;
|
|
7278
|
+
* case EmbedErrorCodes.CONFLICTING_ACTIONS_CONFIG:
|
|
7279
|
+
* console.error('Conflicting actions configuration:', error.message);
|
|
7280
|
+
* break;
|
|
7281
|
+
* case EmbedErrorCodes.CONFLICTING_TABS_CONFIG:
|
|
7282
|
+
* console.error('Conflicting tabs configuration:', error.message);
|
|
7283
|
+
* break;
|
|
7284
|
+
* default:
|
|
7285
|
+
* console.error('Unknown error:', error);
|
|
7087
7286
|
* }
|
|
7088
7287
|
* });
|
|
7089
|
-
*
|
|
7288
|
+
* ```
|
|
7289
|
+
* */
|
|
7090
7290
|
export declare enum EmbedErrorCodes {
|
|
7091
7291
|
/** Worksheet ID not found or does not exist */
|
|
7092
7292
|
WORKSHEET_ID_NOT_FOUND = "WORKSHEET_ID_NOT_FOUND",
|
|
7093
7293
|
/** Required Liveboard ID is missing from configuration */
|
|
7094
7294
|
LIVEBOARD_ID_MISSING = "LIVEBOARD_ID_MISSING",
|
|
7095
|
-
/** Conflicting action configuration detected
|
|
7295
|
+
/** Conflicting action configuration detected */
|
|
7096
7296
|
CONFLICTING_ACTIONS_CONFIG = "CONFLICTING_ACTIONS_CONFIG",
|
|
7097
|
-
/** Conflicting tab configuration detected
|
|
7297
|
+
/** Conflicting tab configuration detected */
|
|
7098
7298
|
CONFLICTING_TABS_CONFIG = "CONFLICTING_TABS_CONFIG",
|
|
7099
7299
|
/** Error during component initialization */
|
|
7100
7300
|
INIT_ERROR = "INIT_ERROR",
|
|
@@ -7111,7 +7311,9 @@ export declare enum EmbedErrorCodes {
|
|
|
7111
7311
|
/** Error parsing api intercept body */
|
|
7112
7312
|
PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
|
|
7113
7313
|
/** Failed to update embed parameters during pre-render */
|
|
7114
|
-
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
|
|
7314
|
+
UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
|
|
7315
|
+
/** Invalid URL provided in configuration */
|
|
7316
|
+
INVALID_URL = "INVALID_URL"
|
|
7115
7317
|
}
|
|
7116
7318
|
/**
|
|
7117
7319
|
* Error event object emitted when an error occurs in an embedded component.
|
|
@@ -7124,7 +7326,7 @@ export declare enum EmbedErrorCodes {
|
|
|
7124
7326
|
*
|
|
7125
7327
|
* - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
|
|
7126
7328
|
* - **message**: Human-readable error description (string or array of strings for multiple errors)
|
|
7127
|
-
* - **code**: Machine-readable error identifier
|
|
7329
|
+
* - **code**: Machine-readable error identifier {@link EmbedErrorCodes} values
|
|
7128
7330
|
* - **[key: string]**: Additional context-specific for backward compatibility
|
|
7129
7331
|
*
|
|
7130
7332
|
* ## Usage
|
|
@@ -7134,12 +7336,11 @@ export declare enum EmbedErrorCodes {
|
|
|
7134
7336
|
*
|
|
7135
7337
|
* @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
|
|
7136
7338
|
* @group Error Handling
|
|
7137
|
-
* @see {@link ErrorDetailsTypes} - Available error type values
|
|
7138
|
-
* @see {@link EmbedEvent.Error} - The event that emits this object
|
|
7139
7339
|
*
|
|
7140
7340
|
* @example
|
|
7141
7341
|
* Handle specific error types
|
|
7142
7342
|
*
|
|
7343
|
+
* ```js
|
|
7143
7344
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
7144
7345
|
* switch (error.code) {
|
|
7145
7346
|
* case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
|
|
@@ -7149,30 +7350,18 @@ export declare enum EmbedErrorCodes {
|
|
|
7149
7350
|
* console.error('Unknown error:', error);
|
|
7150
7351
|
* }
|
|
7151
7352
|
* });
|
|
7152
|
-
*
|
|
7353
|
+
* ```
|
|
7153
7354
|
* @example
|
|
7154
7355
|
* Handle multiple error messages
|
|
7155
7356
|
*
|
|
7357
|
+
* ```js
|
|
7156
7358
|
* embed.on(EmbedEvent.Error, (error) => {
|
|
7157
7359
|
* const messages = Array.isArray(error.message)
|
|
7158
7360
|
* ? error.message
|
|
7159
7361
|
* : [error.message];
|
|
7160
|
-
*
|
|
7161
7362
|
* messages.forEach(msg => console.error(msg));
|
|
7162
7363
|
* });
|
|
7163
|
-
*
|
|
7164
|
-
* @example
|
|
7165
|
-
* Access additional error context
|
|
7166
|
-
*
|
|
7167
|
-
* embed.on(EmbedEvent.Error, (error) => {
|
|
7168
|
-
* console.error('Error Details:', {
|
|
7169
|
-
* type: error.errorType,
|
|
7170
|
-
* message: error.message,
|
|
7171
|
-
* code: error.code,
|
|
7172
|
-
* // Additional context fields vary by error type
|
|
7173
|
-
* ...error
|
|
7174
|
-
* });
|
|
7175
|
-
* });
|
|
7364
|
+
* ```
|
|
7176
7365
|
* */
|
|
7177
7366
|
export interface EmbedErrorDetailsEvent {
|
|
7178
7367
|
/** The type of error that occurred */
|
|
@@ -7941,129 +8130,493 @@ declare class V1Embed extends TsEmbed {
|
|
|
7941
8130
|
test__executeCallbacks: (eventType: EmbedEvent, data: any, eventPort?: void | MessagePort) => void;
|
|
7942
8131
|
}
|
|
7943
8132
|
/**
|
|
7944
|
-
*
|
|
8133
|
+
* Configuration for search options
|
|
7945
8134
|
*/
|
|
7946
|
-
export
|
|
8135
|
+
export interface SearchOptions {
|
|
7947
8136
|
/**
|
|
7948
|
-
*
|
|
8137
|
+
* The query string to pass to start the Conversation.
|
|
7949
8138
|
*/
|
|
7950
|
-
|
|
8139
|
+
searchQuery: string;
|
|
8140
|
+
}
|
|
8141
|
+
/**
|
|
8142
|
+
* Configuration for the Spotter sidebar.
|
|
8143
|
+
* Can be used in SpotterEmbed and AppEmbed.
|
|
8144
|
+
* @group Embed components
|
|
8145
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8146
|
+
*/
|
|
8147
|
+
export interface SpotterSidebarViewConfig {
|
|
7951
8148
|
/**
|
|
7952
|
-
*
|
|
8149
|
+
* Controls the visibility of the past conversations sidebar.
|
|
8150
|
+
* @default false
|
|
8151
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
7953
8152
|
*/
|
|
7954
|
-
|
|
8153
|
+
enablePastConversationsSidebar?: boolean;
|
|
7955
8154
|
/**
|
|
7956
|
-
*
|
|
8155
|
+
* Custom title text for the sidebar header.
|
|
8156
|
+
* Defaults to translated "Spotter" text.
|
|
8157
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7957
8158
|
*/
|
|
7958
|
-
|
|
8159
|
+
spotterSidebarTitle?: string;
|
|
7959
8160
|
/**
|
|
7960
|
-
*
|
|
8161
|
+
* Boolean to set the default expanded state of the sidebar.
|
|
8162
|
+
* @default false
|
|
8163
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7961
8164
|
*/
|
|
7962
|
-
|
|
8165
|
+
spotterSidebarDefaultExpanded?: boolean;
|
|
7963
8166
|
/**
|
|
7964
|
-
*
|
|
8167
|
+
* Custom label text for the rename action in the conversation edit menu.
|
|
8168
|
+
* Defaults to translated "Rename" text.
|
|
8169
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7965
8170
|
*/
|
|
7966
|
-
|
|
8171
|
+
spotterChatRenameLabel?: string;
|
|
7967
8172
|
/**
|
|
7968
|
-
*
|
|
8173
|
+
* Custom label text for the delete action in the conversation edit menu.
|
|
8174
|
+
* Defaults to translated "DELETE" text.
|
|
8175
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7969
8176
|
*/
|
|
7970
|
-
|
|
8177
|
+
spotterChatDeleteLabel?: string;
|
|
7971
8178
|
/**
|
|
7972
|
-
*
|
|
8179
|
+
* Custom title text for the delete conversation confirmation modal.
|
|
8180
|
+
* Defaults to translated "Delete chat" text.
|
|
8181
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7973
8182
|
*/
|
|
7974
|
-
|
|
8183
|
+
spotterDeleteConversationModalTitle?: string;
|
|
7975
8184
|
/**
|
|
7976
|
-
*
|
|
8185
|
+
* Custom message text for the past conversation banner alert.
|
|
8186
|
+
* Defaults to translated alert message.
|
|
8187
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7977
8188
|
*/
|
|
7978
|
-
|
|
7979
|
-
}
|
|
7980
|
-
/**
|
|
7981
|
-
* Define the initial state os column custom group accordions
|
|
7982
|
-
* in data panel v2.
|
|
7983
|
-
*/
|
|
7984
|
-
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
8189
|
+
spotterPastConversationAlertMessage?: string;
|
|
7985
8190
|
/**
|
|
7986
|
-
*
|
|
8191
|
+
* Custom URL for the documentation/best practices link.
|
|
8192
|
+
* Defaults to ThoughtSpot docs URL based on release version.
|
|
8193
|
+
* Note: URL must include the protocol (e.g., `https://www.example.com`).
|
|
8194
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7987
8195
|
*/
|
|
7988
|
-
|
|
8196
|
+
spotterDocumentationUrl?: string;
|
|
7989
8197
|
/**
|
|
7990
|
-
*
|
|
8198
|
+
* Custom label text for the best practices button in the footer.
|
|
8199
|
+
* Defaults to translated "Best Practices" text.
|
|
8200
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7991
8201
|
*/
|
|
7992
|
-
|
|
8202
|
+
spotterBestPracticesLabel?: string;
|
|
7993
8203
|
/**
|
|
7994
|
-
*
|
|
8204
|
+
* Number of conversations to fetch per batch when loading conversation history.
|
|
8205
|
+
* @default 30
|
|
8206
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
7995
8207
|
*/
|
|
7996
|
-
|
|
7997
|
-
}
|
|
7998
|
-
export declare enum HomePageSearchBarMode {
|
|
7999
|
-
OBJECT_SEARCH = "objectSearch",
|
|
8000
|
-
AI_ANSWER = "aiAnswer",
|
|
8001
|
-
NONE = "none"
|
|
8002
|
-
}
|
|
8003
|
-
/**
|
|
8004
|
-
* Define the version of the primary navbar
|
|
8005
|
-
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
8006
|
-
*/
|
|
8007
|
-
export declare enum PrimaryNavbarVersion {
|
|
8208
|
+
spotterConversationsBatchSize?: number;
|
|
8008
8209
|
/**
|
|
8009
|
-
*
|
|
8010
|
-
*
|
|
8011
|
-
*
|
|
8210
|
+
* Custom title text for the "New Chat" button in the sidebar.
|
|
8211
|
+
* Defaults to translated "New Chat" text.
|
|
8212
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8012
8213
|
*/
|
|
8013
|
-
|
|
8214
|
+
spotterNewChatButtonTitle?: string;
|
|
8014
8215
|
}
|
|
8015
8216
|
/**
|
|
8016
|
-
*
|
|
8017
|
-
* @
|
|
8217
|
+
* Configuration for customizing Spotter chat UI branding.
|
|
8218
|
+
* @group Embed components
|
|
8219
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8018
8220
|
*/
|
|
8019
|
-
export
|
|
8221
|
+
export interface SpotterChatViewConfig {
|
|
8020
8222
|
/**
|
|
8021
|
-
*
|
|
8022
|
-
*
|
|
8223
|
+
* Hides the ThoughtSpot logo/icon in tool response
|
|
8224
|
+
* cards. The branding label prefix is controlled
|
|
8225
|
+
* separately via `toolResponseCardBrandingLabel`.
|
|
8226
|
+
* External MCP tool branding is not affected.
|
|
8227
|
+
* @default false
|
|
8023
8228
|
*/
|
|
8024
|
-
|
|
8229
|
+
hideToolResponseCardBranding?: boolean;
|
|
8025
8230
|
/**
|
|
8026
|
-
*
|
|
8027
|
-
*
|
|
8231
|
+
* Custom label to replace the "ThoughtSpot" prefix
|
|
8232
|
+
* in tool response cards. Set to an empty string
|
|
8233
|
+
* `''` to hide the prefix entirely. Works
|
|
8234
|
+
* independently of `hideToolResponseCardBranding`.
|
|
8235
|
+
* External MCP tool branding is not affected.
|
|
8028
8236
|
*/
|
|
8029
|
-
|
|
8237
|
+
toolResponseCardBrandingLabel?: string;
|
|
8030
8238
|
}
|
|
8031
8239
|
/**
|
|
8032
|
-
*
|
|
8033
|
-
* @
|
|
8240
|
+
* The configuration for the embedded spotterEmbed options.
|
|
8241
|
+
* @group Embed components
|
|
8034
8242
|
*/
|
|
8035
|
-
export
|
|
8036
|
-
/**
|
|
8037
|
-
* List (v2) is the traditional List Experience.
|
|
8038
|
-
* It serves as the foundational version of the list page.
|
|
8039
|
-
*/
|
|
8040
|
-
List = "v2",
|
|
8243
|
+
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
|
|
8041
8244
|
/**
|
|
8042
|
-
*
|
|
8245
|
+
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
8246
|
+
* this object to query data and generate Answers.
|
|
8043
8247
|
*/
|
|
8044
|
-
|
|
8045
|
-
}
|
|
8046
|
-
/**
|
|
8047
|
-
* Define the discovery experience
|
|
8048
|
-
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
8049
|
-
*/
|
|
8050
|
-
export interface DiscoveryExperience {
|
|
8248
|
+
worksheetId: string;
|
|
8051
8249
|
/**
|
|
8052
|
-
*
|
|
8250
|
+
* Ability to pass a starting search query to the conversation.
|
|
8053
8251
|
*/
|
|
8054
|
-
|
|
8252
|
+
searchOptions?: SearchOptions;
|
|
8055
8253
|
/**
|
|
8056
|
-
*
|
|
8254
|
+
* disableSourceSelection : Disables data source selection
|
|
8255
|
+
* but still display the selected data source.
|
|
8256
|
+
*
|
|
8257
|
+
* Supported embed types: `SpotterEmbed`
|
|
8258
|
+
* @example
|
|
8259
|
+
* ```js
|
|
8260
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8261
|
+
* ... //other embed view config
|
|
8262
|
+
* disableSourceSelection : true,
|
|
8263
|
+
* })
|
|
8264
|
+
* ```
|
|
8265
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8057
8266
|
*/
|
|
8058
|
-
|
|
8267
|
+
disableSourceSelection?: boolean;
|
|
8059
8268
|
/**
|
|
8060
|
-
*
|
|
8061
|
-
|
|
8062
|
-
|
|
8063
|
-
|
|
8064
|
-
|
|
8065
|
-
|
|
8066
|
-
|
|
8269
|
+
* hideSourceSelection : Hide data source selection
|
|
8270
|
+
*
|
|
8271
|
+
* Supported embed types: `SpotterEmbed`
|
|
8272
|
+
* @example
|
|
8273
|
+
* ```js
|
|
8274
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8275
|
+
* ... //other embed view config
|
|
8276
|
+
* hideSourceSelection : true,
|
|
8277
|
+
* })
|
|
8278
|
+
* ```
|
|
8279
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8280
|
+
*/
|
|
8281
|
+
hideSourceSelection?: boolean;
|
|
8282
|
+
/**
|
|
8283
|
+
* Flag to control Data panel experience
|
|
8284
|
+
*
|
|
8285
|
+
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
8286
|
+
* @default true
|
|
8287
|
+
* @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
|
|
8288
|
+
* @example
|
|
8289
|
+
* ```js
|
|
8290
|
+
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
8291
|
+
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
8292
|
+
* ... // other embed view config
|
|
8293
|
+
* dataPanelV2: true,
|
|
8294
|
+
* })
|
|
8295
|
+
* ```
|
|
8296
|
+
*/
|
|
8297
|
+
dataPanelV2?: boolean;
|
|
8298
|
+
/**
|
|
8299
|
+
* showSpotterLimitations : show limitation text
|
|
8300
|
+
* of the spotter underneath the chat input.
|
|
8301
|
+
* default is false.
|
|
8302
|
+
*
|
|
8303
|
+
* Supported embed types: `SpotterEmbed`
|
|
8304
|
+
* @example
|
|
8305
|
+
* ```js
|
|
8306
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8307
|
+
* ... //other embed view config
|
|
8308
|
+
* showSpotterLimitations : true,
|
|
8309
|
+
* })
|
|
8310
|
+
* ```
|
|
8311
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
8312
|
+
*/
|
|
8313
|
+
showSpotterLimitations?: boolean;
|
|
8314
|
+
/**
|
|
8315
|
+
* hideSampleQuestions : Hide sample questions on
|
|
8316
|
+
* the initial screen of the conversation.
|
|
8317
|
+
*
|
|
8318
|
+
* Supported embed types: `SpotterEmbed`
|
|
8319
|
+
* @example
|
|
8320
|
+
* ```js
|
|
8321
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8322
|
+
* ... //other embed view config
|
|
8323
|
+
* hideSampleQuestions : true,
|
|
8324
|
+
* })
|
|
8325
|
+
* ```
|
|
8326
|
+
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
8327
|
+
*/
|
|
8328
|
+
hideSampleQuestions?: boolean;
|
|
8329
|
+
/**
|
|
8330
|
+
* The list of runtime filters to apply to a search Answer,
|
|
8331
|
+
* visualization, or Liveboard.
|
|
8332
|
+
*
|
|
8333
|
+
* Supported embed types: `SpotterEmbed`
|
|
8334
|
+
* @example
|
|
8335
|
+
* ```js
|
|
8336
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8337
|
+
* // other embed view config
|
|
8338
|
+
* runtimeFilters: [
|
|
8339
|
+
* {
|
|
8340
|
+
* columnName: 'color',
|
|
8341
|
+
* operator: RuntimeFilterOp.EQ,
|
|
8342
|
+
* values: ['red'],
|
|
8343
|
+
* },
|
|
8344
|
+
* ],
|
|
8345
|
+
* })
|
|
8346
|
+
* ```
|
|
8347
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8348
|
+
*/
|
|
8349
|
+
runtimeFilters?: RuntimeFilter[];
|
|
8350
|
+
/**
|
|
8351
|
+
* Flag to control whether runtime filters should be included in the URL.
|
|
8352
|
+
* If true, filters will be passed via app initialization payload
|
|
8353
|
+
* (default behavior from SDK 1.45.0).
|
|
8354
|
+
* If false/undefined, filters are appended to the iframe URL instead.
|
|
8355
|
+
* (default behavior before SDK 1.45.0).
|
|
8356
|
+
*
|
|
8357
|
+
* Supported embed types: `SpotterEmbed`
|
|
8358
|
+
* @default true
|
|
8359
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8360
|
+
*/
|
|
8361
|
+
excludeRuntimeFiltersfromURL?: boolean;
|
|
8362
|
+
/**
|
|
8363
|
+
* The list of runtime parameters to apply to the conversation.
|
|
8364
|
+
*
|
|
8365
|
+
* Supported embed types: `SpotterEmbed`
|
|
8366
|
+
* @example
|
|
8367
|
+
* ```js
|
|
8368
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8369
|
+
* // other embed view config
|
|
8370
|
+
* runtimeParameters: [
|
|
8371
|
+
* {
|
|
8372
|
+
* name: 'Integer Param',
|
|
8373
|
+
* value: 10,
|
|
8374
|
+
* },
|
|
8375
|
+
* ],
|
|
8376
|
+
* })
|
|
8377
|
+
* ```
|
|
8378
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8379
|
+
*/
|
|
8380
|
+
runtimeParameters?: RuntimeParameter[];
|
|
8381
|
+
/**
|
|
8382
|
+
* Flag to control whether runtime parameters should be included in the URL.
|
|
8383
|
+
* If true, parameters will be passed via app
|
|
8384
|
+
* initialization payload (default behavior from SDK 1.45.0).
|
|
8385
|
+
* If false/undefined, parameters are appended to
|
|
8386
|
+
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
8387
|
+
*
|
|
8388
|
+
* Supported embed types: `SpotterEmbed`
|
|
8389
|
+
* @default true
|
|
8390
|
+
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
8391
|
+
*/
|
|
8392
|
+
excludeRuntimeParametersfromURL?: boolean;
|
|
8393
|
+
/**
|
|
8394
|
+
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
8395
|
+
*
|
|
8396
|
+
* Supported embed types: `SpotterEmbed`
|
|
8397
|
+
* @default false
|
|
8398
|
+
* @example
|
|
8399
|
+
* ```js
|
|
8400
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8401
|
+
* ... //other embed view config
|
|
8402
|
+
* updatedSpotterChatPrompt : true,
|
|
8403
|
+
* })
|
|
8404
|
+
* ```
|
|
8405
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8406
|
+
*/
|
|
8407
|
+
updatedSpotterChatPrompt?: boolean;
|
|
8408
|
+
/**
|
|
8409
|
+
* Configuration for the Spotter sidebar UI customization.
|
|
8410
|
+
*
|
|
8411
|
+
* Supported embed types: `SpotterEmbed`, `AppEmbed`
|
|
8412
|
+
* @example
|
|
8413
|
+
* ```js
|
|
8414
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8415
|
+
* ... //other embed view config
|
|
8416
|
+
* spotterSidebarConfig: {
|
|
8417
|
+
* enablePastConversationsSidebar: true,
|
|
8418
|
+
* spotterSidebarTitle: 'My Conversations',
|
|
8419
|
+
* spotterSidebarDefaultExpanded: true,
|
|
8420
|
+
* },
|
|
8421
|
+
* })
|
|
8422
|
+
* ```
|
|
8423
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
8424
|
+
*/
|
|
8425
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
8426
|
+
/**
|
|
8427
|
+
* Configuration for customizing Spotter chat UI
|
|
8428
|
+
* branding in tool response cards.
|
|
8429
|
+
*
|
|
8430
|
+
* Supported embed types: `SpotterEmbed`
|
|
8431
|
+
* @example
|
|
8432
|
+
* ```js
|
|
8433
|
+
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
8434
|
+
* ... //other embed view config
|
|
8435
|
+
* spotterChatConfig: {
|
|
8436
|
+
* hideToolResponseCardBranding: true,
|
|
8437
|
+
* toolResponseCardBrandingLabel: 'MyBrand',
|
|
8438
|
+
* },
|
|
8439
|
+
* })
|
|
8440
|
+
* ```
|
|
8441
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
8442
|
+
*/
|
|
8443
|
+
spotterChatConfig?: SpotterChatViewConfig;
|
|
8444
|
+
}
|
|
8445
|
+
/**
|
|
8446
|
+
* The configuration for the embedded spotterEmbed options.
|
|
8447
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8448
|
+
* Use {@link SpotterEmbedViewConfig} instead
|
|
8449
|
+
* @group Embed components
|
|
8450
|
+
*/
|
|
8451
|
+
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
8452
|
+
}
|
|
8453
|
+
/**
|
|
8454
|
+
* Embed ThoughtSpot AI Conversation.
|
|
8455
|
+
* @group Embed components
|
|
8456
|
+
* @example
|
|
8457
|
+
* ```js
|
|
8458
|
+
* const conversation = new SpotterEmbed('#tsEmbed', {
|
|
8459
|
+
* worksheetId: 'worksheetId',
|
|
8460
|
+
* searchOptions: {
|
|
8461
|
+
* searchQuery: 'searchQuery',
|
|
8462
|
+
* },
|
|
8463
|
+
* });
|
|
8464
|
+
* conversation.render();
|
|
8465
|
+
* ```
|
|
8466
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8467
|
+
*/
|
|
8468
|
+
export declare class SpotterEmbed extends TsEmbed {
|
|
8469
|
+
protected viewConfig: SpotterEmbedViewConfig;
|
|
8470
|
+
constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
|
|
8471
|
+
protected getEmbedParamsObject(): Record<any, any>;
|
|
8472
|
+
getIframeSrc(): string;
|
|
8473
|
+
render(): Promise<SpotterEmbed>;
|
|
8474
|
+
}
|
|
8475
|
+
/**
|
|
8476
|
+
* Embed ThoughtSpot AI Conversation.
|
|
8477
|
+
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
8478
|
+
* Use {@link SpotterEmbed} instead
|
|
8479
|
+
* @group Embed components
|
|
8480
|
+
* @example
|
|
8481
|
+
* ```js
|
|
8482
|
+
* const conversation = new SpotterEmbed('#tsEmbed', {
|
|
8483
|
+
* worksheetId: 'worksheetId',
|
|
8484
|
+
* searchOptions: {
|
|
8485
|
+
* searchQuery: 'searchQuery',
|
|
8486
|
+
* },
|
|
8487
|
+
* });
|
|
8488
|
+
* conversation.render();
|
|
8489
|
+
* ```
|
|
8490
|
+
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
8491
|
+
*/
|
|
8492
|
+
export declare class ConversationEmbed extends SpotterEmbed {
|
|
8493
|
+
protected viewConfig: ConversationViewConfig;
|
|
8494
|
+
constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
|
|
8495
|
+
}
|
|
8496
|
+
/**
|
|
8497
|
+
* Pages within the ThoughtSpot app that can be embedded.
|
|
8498
|
+
*/
|
|
8499
|
+
export declare enum Page {
|
|
8500
|
+
/**
|
|
8501
|
+
* Home page
|
|
8502
|
+
*/
|
|
8503
|
+
Home = "home",
|
|
8504
|
+
/**
|
|
8505
|
+
* Search page
|
|
8506
|
+
*/
|
|
8507
|
+
Search = "search",
|
|
8508
|
+
/**
|
|
8509
|
+
* Saved answers listing page
|
|
8510
|
+
*/
|
|
8511
|
+
Answers = "answers",
|
|
8512
|
+
/**
|
|
8513
|
+
* Liveboards listing page
|
|
8514
|
+
*/
|
|
8515
|
+
Liveboards = "liveboards",
|
|
8516
|
+
/**
|
|
8517
|
+
* @hidden
|
|
8518
|
+
*/
|
|
8519
|
+
Pinboards = "pinboards",
|
|
8520
|
+
/**
|
|
8521
|
+
* Data management page
|
|
8522
|
+
*/
|
|
8523
|
+
Data = "data",
|
|
8524
|
+
/**
|
|
8525
|
+
* SpotIQ listing page
|
|
8526
|
+
*/
|
|
8527
|
+
SpotIQ = "insights",
|
|
8528
|
+
/**
|
|
8529
|
+
* Monitor Alerts Page
|
|
8530
|
+
*/
|
|
8531
|
+
Monitor = "monitor"
|
|
8532
|
+
}
|
|
8533
|
+
/**
|
|
8534
|
+
* Define the initial state os column custom group accordions
|
|
8535
|
+
* in data panel v2.
|
|
8536
|
+
*/
|
|
8537
|
+
export declare enum DataPanelCustomColumnGroupsAccordionState {
|
|
8538
|
+
/**
|
|
8539
|
+
* Expand all the accordion initially in data panel v2.
|
|
8540
|
+
*/
|
|
8541
|
+
EXPAND_ALL = "EXPAND_ALL",
|
|
8542
|
+
/**
|
|
8543
|
+
* Collapse all the accordions initially in data panel v2.
|
|
8544
|
+
*/
|
|
8545
|
+
COLLAPSE_ALL = "COLLAPSE_ALL",
|
|
8546
|
+
/**
|
|
8547
|
+
* Expand the first accordion and collapse the rest.
|
|
8548
|
+
*/
|
|
8549
|
+
EXPAND_FIRST = "EXPAND_FIRST"
|
|
8550
|
+
}
|
|
8551
|
+
export declare enum HomePageSearchBarMode {
|
|
8552
|
+
OBJECT_SEARCH = "objectSearch",
|
|
8553
|
+
AI_ANSWER = "aiAnswer",
|
|
8554
|
+
NONE = "none"
|
|
8555
|
+
}
|
|
8556
|
+
/**
|
|
8557
|
+
* Define the version of the primary navbar
|
|
8558
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
8559
|
+
*/
|
|
8560
|
+
export declare enum PrimaryNavbarVersion {
|
|
8561
|
+
/**
|
|
8562
|
+
* Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
|
|
8563
|
+
* along with updates to the top navigation bar.
|
|
8564
|
+
* It serves as the foundational version of the PrimaryNavBar.
|
|
8565
|
+
*/
|
|
8566
|
+
Sliding = "v3"
|
|
8567
|
+
}
|
|
8568
|
+
/**
|
|
8569
|
+
* Define the version of the home page
|
|
8570
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
8571
|
+
*/
|
|
8572
|
+
export declare enum HomePage {
|
|
8573
|
+
/**
|
|
8574
|
+
* Modular (v2) introduces the updated Modular Home Experience.
|
|
8575
|
+
* It serves as the foundational version of the home page.
|
|
8576
|
+
*/
|
|
8577
|
+
Modular = "v2",
|
|
8578
|
+
/**
|
|
8579
|
+
* ModularWithStylingChanges (v3) introduces Modular Home Experience
|
|
8580
|
+
* with styling changes.
|
|
8581
|
+
*/
|
|
8582
|
+
ModularWithStylingChanges = "v3"
|
|
8583
|
+
}
|
|
8584
|
+
/**
|
|
8585
|
+
* Define the version of the list page
|
|
8586
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.12.0.cl
|
|
8587
|
+
*/
|
|
8588
|
+
export declare enum ListPage {
|
|
8589
|
+
/**
|
|
8590
|
+
* List (v2) is the traditional List Experience.
|
|
8591
|
+
* It serves as the foundational version of the list page.
|
|
8592
|
+
*/
|
|
8593
|
+
List = "v2",
|
|
8594
|
+
/**
|
|
8595
|
+
* ListWithUXChanges (v3) introduces the new updated list page with UX changes.
|
|
8596
|
+
*/
|
|
8597
|
+
ListWithUXChanges = "v3"
|
|
8598
|
+
}
|
|
8599
|
+
/**
|
|
8600
|
+
* Define the discovery experience
|
|
8601
|
+
* @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
|
|
8602
|
+
*/
|
|
8603
|
+
export interface DiscoveryExperience {
|
|
8604
|
+
/**
|
|
8605
|
+
* primaryNavbarVersion determines the version of the navigation version.
|
|
8606
|
+
*/
|
|
8607
|
+
primaryNavbarVersion?: PrimaryNavbarVersion;
|
|
8608
|
+
/**
|
|
8609
|
+
* homePage determines the version of the home page.
|
|
8610
|
+
*/
|
|
8611
|
+
homePage?: HomePage;
|
|
8612
|
+
/**
|
|
8613
|
+
* listPageVersion determines the version of the list page.
|
|
8614
|
+
*/
|
|
8615
|
+
listPageVersion?: ListPage;
|
|
8616
|
+
}
|
|
8617
|
+
/**
|
|
8618
|
+
* The view configuration for full app embedding.
|
|
8619
|
+
* @group Embed components
|
|
8067
8620
|
*/
|
|
8068
8621
|
export interface AppViewConfig extends AllEmbedViewConfig {
|
|
8069
8622
|
/**
|
|
@@ -8577,6 +9130,42 @@ export interface AppViewConfig extends AllEmbedViewConfig {
|
|
|
8577
9130
|
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
8578
9131
|
*/
|
|
8579
9132
|
updatedSpotterChatPrompt?: boolean;
|
|
9133
|
+
/**
|
|
9134
|
+
* Configuration for the Spotter sidebar UI customization.
|
|
9135
|
+
* Only applicable when navigating to Spotter within the app.
|
|
9136
|
+
*
|
|
9137
|
+
* Supported embed types: `AppEmbed`
|
|
9138
|
+
* @example
|
|
9139
|
+
* ```js
|
|
9140
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
9141
|
+
* ... //other embed view config
|
|
9142
|
+
* spotterSidebarConfig: {
|
|
9143
|
+
* enablePastConversationsSidebar: true,
|
|
9144
|
+
* spotterSidebarTitle: 'My Conversations',
|
|
9145
|
+
* },
|
|
9146
|
+
* })
|
|
9147
|
+
* ```
|
|
9148
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
|
|
9149
|
+
*/
|
|
9150
|
+
spotterSidebarConfig?: SpotterSidebarViewConfig;
|
|
9151
|
+
/**
|
|
9152
|
+
* Configuration for customizing Spotter chat UI
|
|
9153
|
+
* branding in tool response cards.
|
|
9154
|
+
*
|
|
9155
|
+
* Supported embed types: `AppEmbed`
|
|
9156
|
+
* @example
|
|
9157
|
+
* ```js
|
|
9158
|
+
* const embed = new AppEmbed('#tsEmbed', {
|
|
9159
|
+
* ... //other embed view config
|
|
9160
|
+
* spotterChatConfig: {
|
|
9161
|
+
* hideToolResponseCardBranding: true,
|
|
9162
|
+
* toolResponseCardBrandingLabel: 'MyBrand',
|
|
9163
|
+
* },
|
|
9164
|
+
* })
|
|
9165
|
+
* ```
|
|
9166
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9167
|
+
*/
|
|
9168
|
+
spotterChatConfig?: SpotterChatViewConfig;
|
|
8580
9169
|
/**
|
|
8581
9170
|
* This is the minimum height (in pixels) for a full-height App.
|
|
8582
9171
|
* Setting this height helps resolve issues with empty Apps and
|
|
@@ -9069,6 +9658,23 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9069
9658
|
* @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
|
|
9070
9659
|
*/
|
|
9071
9660
|
activeTabId?: string;
|
|
9661
|
+
/**
|
|
9662
|
+
* The GUID of a saved personalized view to load.
|
|
9663
|
+
* A personalized view is a saved configuration of a Liveboard
|
|
9664
|
+
* that includes specific filter selections.
|
|
9665
|
+
*
|
|
9666
|
+
* Supported embed types: `LiveboardEmbed`
|
|
9667
|
+
* @example
|
|
9668
|
+
* ```js
|
|
9669
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9670
|
+
* liveboardId: 'liveboard-guid',
|
|
9671
|
+
* personalizedViewId: 'view-guid',
|
|
9672
|
+
* activeTabId: 'tab-guid',
|
|
9673
|
+
* })
|
|
9674
|
+
* ```
|
|
9675
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9676
|
+
*/
|
|
9677
|
+
personalizedViewId?: string;
|
|
9072
9678
|
/**
|
|
9073
9679
|
* Show or hide the tab panel of the embedded Liveboard.
|
|
9074
9680
|
*
|
|
@@ -9311,17 +9917,35 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9311
9917
|
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
9312
9918
|
*
|
|
9313
9919
|
* Supported embed types: `LiveboardEmbed`
|
|
9314
|
-
* @default false
|
|
9920
|
+
* @default false
|
|
9921
|
+
* @example
|
|
9922
|
+
* ```js
|
|
9923
|
+
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9924
|
+
* ... //other embed view config
|
|
9925
|
+
* updatedSpotterChatPrompt : true,
|
|
9926
|
+
* })
|
|
9927
|
+
* ```
|
|
9928
|
+
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
9929
|
+
*/
|
|
9930
|
+
updatedSpotterChatPrompt?: boolean;
|
|
9931
|
+
/**
|
|
9932
|
+
* Configuration for customizing Spotter chat UI
|
|
9933
|
+
* branding in tool response cards.
|
|
9934
|
+
*
|
|
9935
|
+
* Supported embed types: `LiveboardEmbed`
|
|
9315
9936
|
* @example
|
|
9316
9937
|
* ```js
|
|
9317
9938
|
* const embed = new LiveboardEmbed('#tsEmbed', {
|
|
9318
9939
|
* ... //other embed view config
|
|
9319
|
-
*
|
|
9940
|
+
* spotterChatConfig: {
|
|
9941
|
+
* hideToolResponseCardBranding: true,
|
|
9942
|
+
* toolResponseCardBrandingLabel: 'MyBrand',
|
|
9943
|
+
* },
|
|
9320
9944
|
* })
|
|
9321
9945
|
* ```
|
|
9322
|
-
* @version SDK: 1.
|
|
9946
|
+
* @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
|
|
9323
9947
|
*/
|
|
9324
|
-
|
|
9948
|
+
spotterChatConfig?: SpotterChatViewConfig;
|
|
9325
9949
|
}
|
|
9326
9950
|
/**
|
|
9327
9951
|
* Embed a ThoughtSpot Liveboard or visualization. When rendered it already
|
|
@@ -9381,6 +10005,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
9381
10005
|
liveboardId: string;
|
|
9382
10006
|
vizId: string;
|
|
9383
10007
|
activeTabId: string;
|
|
10008
|
+
personalizedViewId: string;
|
|
9384
10009
|
};
|
|
9385
10010
|
protected beforePrerenderVisible(): void;
|
|
9386
10011
|
protected handleRenderForPrerender(): Promise<TsEmbed>;
|
|
@@ -9405,7 +10030,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
9405
10030
|
* visualization ID and the runtime filters.
|
|
9406
10031
|
*/
|
|
9407
10032
|
render(): Promise<LiveboardEmbed>;
|
|
9408
|
-
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
|
|
10033
|
+
navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, personalizedViewId?: string): void;
|
|
9409
10034
|
/**
|
|
9410
10035
|
* Returns the full url of the Liveboard/visualization which can be used to open
|
|
9411
10036
|
* this Liveboard inside the full ThoughtSpot application in a new tab.
|
|
@@ -9418,11 +10043,7 @@ export declare class LiveboardEmbed extends V1Embed {
|
|
|
9418
10043
|
*/
|
|
9419
10044
|
export declare class PinboardEmbed extends LiveboardEmbed {
|
|
9420
10045
|
}
|
|
9421
|
-
|
|
9422
|
-
* Configuration for search options.
|
|
9423
|
-
*
|
|
9424
|
-
*/
|
|
9425
|
-
export interface SearchOptions {
|
|
10046
|
+
interface SearchOptions$1 {
|
|
9426
10047
|
/**
|
|
9427
10048
|
* Search tokens to pass in the query.
|
|
9428
10049
|
*/
|
|
@@ -9599,7 +10220,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
9599
10220
|
* }
|
|
9600
10221
|
* ```
|
|
9601
10222
|
*/
|
|
9602
|
-
searchOptions?: SearchOptions;
|
|
10223
|
+
searchOptions?: SearchOptions$1;
|
|
9603
10224
|
/**
|
|
9604
10225
|
* Exclude the search token string from the URL.
|
|
9605
10226
|
* If set to true, the search token string is not appended to the URL.
|
|
@@ -9700,7 +10321,7 @@ export interface SearchViewConfig extends SearchLiveboardCommonViewConfig, Omit<
|
|
|
9700
10321
|
focusSearchBarOnRender?: boolean;
|
|
9701
10322
|
}
|
|
9702
10323
|
export interface SearchAppInitData extends DefaultAppInitData {
|
|
9703
|
-
searchOptions?: SearchOptions;
|
|
10324
|
+
searchOptions?: SearchOptions$1;
|
|
9704
10325
|
}
|
|
9705
10326
|
/**
|
|
9706
10327
|
* Embed ThoughtSpot search
|
|
@@ -9809,7 +10430,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9809
10430
|
* })
|
|
9810
10431
|
* ```
|
|
9811
10432
|
*/
|
|
9812
|
-
searchOptions?: SearchOptions;
|
|
10433
|
+
searchOptions?: SearchOptions$1;
|
|
9813
10434
|
/**
|
|
9814
10435
|
* Exclude the search token string from the URL.
|
|
9815
10436
|
* If set to true, the search token string is not appended to the URL.
|
|
@@ -9830,7 +10451,7 @@ export interface SearchBarViewConfig extends BaseViewConfig, SearchLiveboardComm
|
|
|
9830
10451
|
excludeSearchTokenStringFromURL?: boolean;
|
|
9831
10452
|
}
|
|
9832
10453
|
interface SearchAppInitData$1 extends DefaultAppInitData {
|
|
9833
|
-
searchOptions: SearchOptions;
|
|
10454
|
+
searchOptions: SearchOptions$1;
|
|
9834
10455
|
}
|
|
9835
10456
|
/**
|
|
9836
10457
|
* Embed ThoughtSpot search bar
|
|
@@ -9856,7 +10477,7 @@ export declare class SearchBarEmbed extends TsEmbed {
|
|
|
9856
10477
|
*/
|
|
9857
10478
|
render(): Promise<SearchBarEmbed>;
|
|
9858
10479
|
protected getSearchInitData(): {
|
|
9859
|
-
searchOptions: SearchOptions;
|
|
10480
|
+
searchOptions: SearchOptions$1;
|
|
9860
10481
|
};
|
|
9861
10482
|
protected getAppInitData(): Promise<SearchAppInitData$1>;
|
|
9862
10483
|
}
|
|
@@ -9968,249 +10589,6 @@ export declare class SpotterAgentEmbed {
|
|
|
9968
10589
|
export declare class BodylessConversation extends SpotterAgentEmbed {
|
|
9969
10590
|
constructor(viewConfig: BodylessConversationViewConfig);
|
|
9970
10591
|
}
|
|
9971
|
-
interface SearchOptions$1 {
|
|
9972
|
-
/**
|
|
9973
|
-
* The query string to pass to start the Conversation.
|
|
9974
|
-
*/
|
|
9975
|
-
searchQuery: string;
|
|
9976
|
-
}
|
|
9977
|
-
/**
|
|
9978
|
-
* The configuration for the embedded spotterEmbed options.
|
|
9979
|
-
* @group Embed components
|
|
9980
|
-
*/
|
|
9981
|
-
export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
|
|
9982
|
-
/**
|
|
9983
|
-
* The ID of the data source object. For example, Model, View, or Table. Spotter uses
|
|
9984
|
-
* this object to query data and generate Answers.
|
|
9985
|
-
*/
|
|
9986
|
-
worksheetId: string;
|
|
9987
|
-
/**
|
|
9988
|
-
* Ability to pass a starting search query to the conversation.
|
|
9989
|
-
*/
|
|
9990
|
-
searchOptions?: SearchOptions$1;
|
|
9991
|
-
/**
|
|
9992
|
-
* disableSourceSelection : Disables data source selection
|
|
9993
|
-
* but still display the selected data source.
|
|
9994
|
-
*
|
|
9995
|
-
* Supported embed types: `SpotterEmbed`
|
|
9996
|
-
* @example
|
|
9997
|
-
* ```js
|
|
9998
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
9999
|
-
* ... //other embed view config
|
|
10000
|
-
* disableSourceSelection : true,
|
|
10001
|
-
* })
|
|
10002
|
-
* ```
|
|
10003
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
10004
|
-
*/
|
|
10005
|
-
disableSourceSelection?: boolean;
|
|
10006
|
-
/**
|
|
10007
|
-
* hideSourceSelection : Hide data source selection
|
|
10008
|
-
*
|
|
10009
|
-
* Supported embed types: `SpotterEmbed`
|
|
10010
|
-
* @example
|
|
10011
|
-
* ```js
|
|
10012
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
10013
|
-
* ... //other embed view config
|
|
10014
|
-
* hideSourceSelection : true,
|
|
10015
|
-
* })
|
|
10016
|
-
* ```
|
|
10017
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
10018
|
-
*/
|
|
10019
|
-
hideSourceSelection?: boolean;
|
|
10020
|
-
/**
|
|
10021
|
-
* Flag to control Data panel experience
|
|
10022
|
-
*
|
|
10023
|
-
* Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
|
|
10024
|
-
* @default true
|
|
10025
|
-
* @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
|
|
10026
|
-
* @example
|
|
10027
|
-
* ```js
|
|
10028
|
-
* // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
|
|
10029
|
-
* const embed = new <EmbedComponent>('#tsEmbed', {
|
|
10030
|
-
* ... // other embed view config
|
|
10031
|
-
* dataPanelV2: true,
|
|
10032
|
-
* })
|
|
10033
|
-
* ```
|
|
10034
|
-
*/
|
|
10035
|
-
dataPanelV2?: boolean;
|
|
10036
|
-
/**
|
|
10037
|
-
* showSpotterLimitations : show limitation text
|
|
10038
|
-
* of the spotter underneath the chat input.
|
|
10039
|
-
* default is false.
|
|
10040
|
-
*
|
|
10041
|
-
* Supported embed types: `SpotterEmbed`
|
|
10042
|
-
* @example
|
|
10043
|
-
* ```js
|
|
10044
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
10045
|
-
* ... //other embed view config
|
|
10046
|
-
* showSpotterLimitations : true,
|
|
10047
|
-
* })
|
|
10048
|
-
* ```
|
|
10049
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
|
|
10050
|
-
*/
|
|
10051
|
-
showSpotterLimitations?: boolean;
|
|
10052
|
-
/**
|
|
10053
|
-
* hideSampleQuestions : Hide sample questions on
|
|
10054
|
-
* the initial screen of the conversation.
|
|
10055
|
-
*
|
|
10056
|
-
* Supported embed types: `SpotterEmbed`
|
|
10057
|
-
* @example
|
|
10058
|
-
* ```js
|
|
10059
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
10060
|
-
* ... //other embed view config
|
|
10061
|
-
* hideSampleQuestions : true,
|
|
10062
|
-
* })
|
|
10063
|
-
* ```
|
|
10064
|
-
* @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
|
|
10065
|
-
*/
|
|
10066
|
-
hideSampleQuestions?: boolean;
|
|
10067
|
-
/**
|
|
10068
|
-
* The list of runtime filters to apply to a search Answer,
|
|
10069
|
-
* visualization, or Liveboard.
|
|
10070
|
-
*
|
|
10071
|
-
* Supported embed types: `SpotterEmbed`
|
|
10072
|
-
* @example
|
|
10073
|
-
* ```js
|
|
10074
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
10075
|
-
* // other embed view config
|
|
10076
|
-
* runtimeFilters: [
|
|
10077
|
-
* {
|
|
10078
|
-
* columnName: 'color',
|
|
10079
|
-
* operator: RuntimeFilterOp.EQ,
|
|
10080
|
-
* values: ['red'],
|
|
10081
|
-
* },
|
|
10082
|
-
* ],
|
|
10083
|
-
* })
|
|
10084
|
-
* ```
|
|
10085
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
10086
|
-
*/
|
|
10087
|
-
runtimeFilters?: RuntimeFilter[];
|
|
10088
|
-
/**
|
|
10089
|
-
* Flag to control whether runtime filters should be included in the URL.
|
|
10090
|
-
* If true, filters will be passed via app initialization payload
|
|
10091
|
-
* (default behavior from SDK 1.45.0).
|
|
10092
|
-
* If false/undefined, filters are appended to the iframe URL instead.
|
|
10093
|
-
* (default behavior before SDK 1.45.0).
|
|
10094
|
-
*
|
|
10095
|
-
* Supported embed types: `SpotterEmbed`
|
|
10096
|
-
* @default true
|
|
10097
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
10098
|
-
*/
|
|
10099
|
-
excludeRuntimeFiltersfromURL?: boolean;
|
|
10100
|
-
/**
|
|
10101
|
-
* The list of runtime parameters to apply to the conversation.
|
|
10102
|
-
*
|
|
10103
|
-
* Supported embed types: `SpotterEmbed`
|
|
10104
|
-
* @example
|
|
10105
|
-
* ```js
|
|
10106
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
10107
|
-
* // other embed view config
|
|
10108
|
-
* runtimeParameters: [
|
|
10109
|
-
* {
|
|
10110
|
-
* name: 'Integer Param',
|
|
10111
|
-
* value: 10,
|
|
10112
|
-
* },
|
|
10113
|
-
* ],
|
|
10114
|
-
* })
|
|
10115
|
-
* ```
|
|
10116
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
10117
|
-
*/
|
|
10118
|
-
runtimeParameters?: RuntimeParameter[];
|
|
10119
|
-
/**
|
|
10120
|
-
* Flag to control whether runtime parameters should be included in the URL.
|
|
10121
|
-
* If true, parameters will be passed via app
|
|
10122
|
-
* initialization payload (default behavior from SDK 1.45.0).
|
|
10123
|
-
* If false/undefined, parameters are appended to
|
|
10124
|
-
* the iframe URL instead (default behavior before SDK 1.45.0).
|
|
10125
|
-
*
|
|
10126
|
-
* Supported embed types: `SpotterEmbed`
|
|
10127
|
-
* @default true
|
|
10128
|
-
* @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
|
|
10129
|
-
*/
|
|
10130
|
-
excludeRuntimeParametersfromURL?: boolean;
|
|
10131
|
-
/**
|
|
10132
|
-
* enablePastConversationsSidebar : Controls the visibility of the past conversations
|
|
10133
|
-
* sidebar.
|
|
10134
|
-
*
|
|
10135
|
-
* Supported embed types: `SpotterEmbed`
|
|
10136
|
-
* @default false
|
|
10137
|
-
* @example
|
|
10138
|
-
* ```js
|
|
10139
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
10140
|
-
* ... //other embed view config
|
|
10141
|
-
* enablePastConversationsSidebar : true,
|
|
10142
|
-
* })
|
|
10143
|
-
* ```
|
|
10144
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10145
|
-
*/
|
|
10146
|
-
enablePastConversationsSidebar?: boolean;
|
|
10147
|
-
/**
|
|
10148
|
-
* updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
|
|
10149
|
-
*
|
|
10150
|
-
* Supported embed types: `SpotterEmbed`
|
|
10151
|
-
* @default false
|
|
10152
|
-
* @example
|
|
10153
|
-
* ```js
|
|
10154
|
-
* const embed = new SpotterEmbed('#tsEmbed', {
|
|
10155
|
-
* ... //other embed view config
|
|
10156
|
-
* updatedSpotterChatPrompt : true,
|
|
10157
|
-
* })
|
|
10158
|
-
* ```
|
|
10159
|
-
* @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
|
|
10160
|
-
*/
|
|
10161
|
-
updatedSpotterChatPrompt?: boolean;
|
|
10162
|
-
}
|
|
10163
|
-
/**
|
|
10164
|
-
* The configuration for the embedded spotterEmbed options.
|
|
10165
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10166
|
-
* Use {@link SpotterEmbedViewConfig} instead
|
|
10167
|
-
* @group Embed components
|
|
10168
|
-
*/
|
|
10169
|
-
export interface ConversationViewConfig extends SpotterEmbedViewConfig {
|
|
10170
|
-
}
|
|
10171
|
-
/**
|
|
10172
|
-
* Embed ThoughtSpot AI Conversation.
|
|
10173
|
-
* @group Embed components
|
|
10174
|
-
* @example
|
|
10175
|
-
* ```js
|
|
10176
|
-
* const conversation = new SpotterEmbed('#tsEmbed', {
|
|
10177
|
-
* worksheetId: 'worksheetId',
|
|
10178
|
-
* searchOptions: {
|
|
10179
|
-
* searchQuery: 'searchQuery',
|
|
10180
|
-
* },
|
|
10181
|
-
* });
|
|
10182
|
-
* conversation.render();
|
|
10183
|
-
* ```
|
|
10184
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
10185
|
-
*/
|
|
10186
|
-
export declare class SpotterEmbed extends TsEmbed {
|
|
10187
|
-
protected viewConfig: SpotterEmbedViewConfig;
|
|
10188
|
-
constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
|
|
10189
|
-
protected getEmbedParamsObject(): Record<any, any>;
|
|
10190
|
-
getIframeSrc(): string;
|
|
10191
|
-
render(): Promise<SpotterEmbed>;
|
|
10192
|
-
}
|
|
10193
|
-
/**
|
|
10194
|
-
* Embed ThoughtSpot AI Conversation.
|
|
10195
|
-
* @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
|
|
10196
|
-
* Use {@link SpotterEmbed} instead
|
|
10197
|
-
* @group Embed components
|
|
10198
|
-
* @example
|
|
10199
|
-
* ```js
|
|
10200
|
-
* const conversation = new SpotterEmbed('#tsEmbed', {
|
|
10201
|
-
* worksheetId: 'worksheetId',
|
|
10202
|
-
* searchOptions: {
|
|
10203
|
-
* searchQuery: 'searchQuery',
|
|
10204
|
-
* },
|
|
10205
|
-
* });
|
|
10206
|
-
* conversation.render();
|
|
10207
|
-
* ```
|
|
10208
|
-
* @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
|
|
10209
|
-
*/
|
|
10210
|
-
export declare class ConversationEmbed extends SpotterEmbed {
|
|
10211
|
-
protected viewConfig: ConversationViewConfig;
|
|
10212
|
-
constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
|
|
10213
|
-
}
|
|
10214
10592
|
export type SessionInfo = {
|
|
10215
10593
|
releaseVersion: string;
|
|
10216
10594
|
userGUID: string;
|