@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.
Files changed (140) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/css-variables.d.ts +48 -0
  3. package/cjs/src/css-variables.d.ts.map +1 -1
  4. package/cjs/src/embed/app.d.ts +37 -0
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +37 -1
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/app.spec.js +24 -0
  9. package/cjs/src/embed/app.spec.js.map +1 -1
  10. package/cjs/src/embed/conversation.d.ts +127 -9
  11. package/cjs/src/embed/conversation.d.ts.map +1 -1
  12. package/cjs/src/embed/conversation.js +41 -18
  13. package/cjs/src/embed/conversation.js.map +1 -1
  14. package/cjs/src/embed/conversation.spec.js +96 -3
  15. package/cjs/src/embed/conversation.spec.js.map +1 -1
  16. package/cjs/src/embed/liveboard.d.ts +38 -1
  17. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  18. package/cjs/src/embed/liveboard.js +38 -10
  19. package/cjs/src/embed/liveboard.js.map +1 -1
  20. package/cjs/src/embed/liveboard.spec.js +179 -7
  21. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  22. package/cjs/src/errors.d.ts +1 -0
  23. package/cjs/src/errors.d.ts.map +1 -1
  24. package/cjs/src/errors.js +1 -0
  25. package/cjs/src/errors.js.map +1 -1
  26. package/cjs/src/index.d.ts +3 -3
  27. package/cjs/src/index.d.ts.map +1 -1
  28. package/cjs/src/index.js.map +1 -1
  29. package/cjs/src/types.d.ts +192 -40
  30. package/cjs/src/types.d.ts.map +1 -1
  31. package/cjs/src/types.js +184 -19
  32. package/cjs/src/types.js.map +1 -1
  33. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  34. package/cjs/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  35. package/cjs/src/utils/graphql/answerService/answer-queries.js +23 -1
  36. package/cjs/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  37. package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -1
  38. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  39. package/cjs/src/utils/graphql/answerService/answerService.js +9 -1
  40. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  41. package/cjs/src/utils/graphql/answerService/answerService.spec.js +73 -0
  42. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  43. package/cjs/src/utils.d.ts +15 -0
  44. package/cjs/src/utils.d.ts.map +1 -1
  45. package/cjs/src/utils.js +33 -1
  46. package/cjs/src/utils.js.map +1 -1
  47. package/cjs/src/utils.spec.js +49 -0
  48. package/cjs/src/utils.spec.js.map +1 -1
  49. package/dist/{index-BdkKLLo1.js → index-BuwECGdm.js} +1 -1
  50. package/dist/src/css-variables.d.ts +48 -0
  51. package/dist/src/css-variables.d.ts.map +1 -1
  52. package/dist/src/embed/app.d.ts +37 -0
  53. package/dist/src/embed/app.d.ts.map +1 -1
  54. package/dist/src/embed/conversation.d.ts +127 -9
  55. package/dist/src/embed/conversation.d.ts.map +1 -1
  56. package/dist/src/embed/liveboard.d.ts +38 -1
  57. package/dist/src/embed/liveboard.d.ts.map +1 -1
  58. package/dist/src/errors.d.ts +1 -0
  59. package/dist/src/errors.d.ts.map +1 -1
  60. package/dist/src/index.d.ts +3 -3
  61. package/dist/src/index.d.ts.map +1 -1
  62. package/dist/src/types.d.ts +192 -40
  63. package/dist/src/types.d.ts.map +1 -1
  64. package/dist/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  65. package/dist/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  66. package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -1
  67. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  68. package/dist/src/utils.d.ts +15 -0
  69. package/dist/src/utils.d.ts.map +1 -1
  70. package/dist/tsembed-react.es.js +364 -52
  71. package/dist/tsembed-react.js +363 -51
  72. package/dist/tsembed.es.js +364 -52
  73. package/dist/tsembed.js +363 -51
  74. package/dist/visual-embed-sdk-react-full.d.ts +696 -342
  75. package/dist/visual-embed-sdk-react.d.ts +685 -331
  76. package/dist/visual-embed-sdk.d.ts +757 -379
  77. package/lib/package.json +1 -1
  78. package/lib/src/css-variables.d.ts +48 -0
  79. package/lib/src/css-variables.d.ts.map +1 -1
  80. package/lib/src/embed/app.d.ts +37 -0
  81. package/lib/src/embed/app.d.ts.map +1 -1
  82. package/lib/src/embed/app.js +39 -3
  83. package/lib/src/embed/app.js.map +1 -1
  84. package/lib/src/embed/app.spec.js +24 -0
  85. package/lib/src/embed/app.spec.js.map +1 -1
  86. package/lib/src/embed/conversation.d.ts +127 -9
  87. package/lib/src/embed/conversation.d.ts.map +1 -1
  88. package/lib/src/embed/conversation.js +42 -19
  89. package/lib/src/embed/conversation.js.map +1 -1
  90. package/lib/src/embed/conversation.spec.js +96 -3
  91. package/lib/src/embed/conversation.spec.js.map +1 -1
  92. package/lib/src/embed/liveboard.d.ts +38 -1
  93. package/lib/src/embed/liveboard.d.ts.map +1 -1
  94. package/lib/src/embed/liveboard.js +39 -11
  95. package/lib/src/embed/liveboard.js.map +1 -1
  96. package/lib/src/embed/liveboard.spec.js +179 -7
  97. package/lib/src/embed/liveboard.spec.js.map +1 -1
  98. package/lib/src/errors.d.ts +1 -0
  99. package/lib/src/errors.d.ts.map +1 -1
  100. package/lib/src/errors.js +1 -0
  101. package/lib/src/errors.js.map +1 -1
  102. package/lib/src/index.d.ts +3 -3
  103. package/lib/src/index.d.ts.map +1 -1
  104. package/lib/src/index.js.map +1 -1
  105. package/lib/src/types.d.ts +192 -40
  106. package/lib/src/types.d.ts.map +1 -1
  107. package/lib/src/types.js +184 -19
  108. package/lib/src/types.js.map +1 -1
  109. package/lib/src/utils/graphql/answerService/answer-queries.d.ts +1 -0
  110. package/lib/src/utils/graphql/answerService/answer-queries.d.ts.map +1 -1
  111. package/lib/src/utils/graphql/answerService/answer-queries.js +22 -0
  112. package/lib/src/utils/graphql/answerService/answer-queries.js.map +1 -1
  113. package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -1
  114. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  115. package/lib/src/utils/graphql/answerService/answerService.js +9 -1
  116. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  117. package/lib/src/utils/graphql/answerService/answerService.spec.js +73 -0
  118. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  119. package/lib/src/utils.d.ts +15 -0
  120. package/lib/src/utils.d.ts.map +1 -1
  121. package/lib/src/utils.js +30 -0
  122. package/lib/src/utils.js.map +1 -1
  123. package/lib/src/utils.spec.js +50 -1
  124. package/lib/src/utils.spec.js.map +1 -1
  125. package/package.json +1 -1
  126. package/src/css-variables.ts +60 -0
  127. package/src/embed/app.spec.ts +32 -0
  128. package/src/embed/app.ts +97 -1
  129. package/src/embed/conversation.spec.ts +117 -3
  130. package/src/embed/conversation.ts +188 -29
  131. package/src/embed/liveboard.spec.ts +264 -10
  132. package/src/embed/liveboard.ts +100 -11
  133. package/src/errors.ts +1 -0
  134. package/src/index.ts +5 -1
  135. package/src/types.ts +193 -40
  136. package/src/utils/graphql/answerService/answer-queries.ts +23 -0
  137. package/src/utils/graphql/answerService/answerService.spec.ts +87 -0
  138. package/src/utils/graphql/answerService/answerService.ts +13 -1
  139. package/src/utils.spec.ts +56 -0
  140. package/src/utils.ts +36 -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
- getSQLQuery(): Promise<string>;
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
@@ -2398,7 +2447,7 @@ export interface LiveboardAppEmbedViewConfig {
2398
2447
  * To enable this feature on your instance, contact ThoughtSpot Support.
2399
2448
  *
2400
2449
  * Supported embed types: `AppEmbed`, `LiveboardEmbed`
2401
- * @version SDK: 1.42.0 | ThoughtSpot: 10.15.0.cl
2450
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
2402
2451
  * @example
2403
2452
  * ```js
2404
2453
  * // Replace <EmbedComponent> with embed component name. For example, AppEmbed or LiveboardEmbed
@@ -3948,6 +3997,42 @@ export declare enum EmbedEvent {
3948
3997
  * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
3949
3998
  */
3950
3999
  ApiIntercept = "ApiIntercept",
4000
+ /**
4001
+ * Emitted when a Spotter conversation is renamed.
4002
+ * @example
4003
+ * ```js
4004
+ * spotterEmbed.on(EmbedEvent.SpotterConversationRenamed, (payload) => {
4005
+ * console.log('Conversation renamed', payload);
4006
+ * // payload: { convId: string, oldTitle: string, newTitle: string }
4007
+ * })
4008
+ * ```
4009
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
4010
+ */
4011
+ SpotterConversationRenamed = "spotterConversationRenamed",
4012
+ /**
4013
+ * Emitted when a Spotter conversation is deleted.
4014
+ * @example
4015
+ * ```js
4016
+ * spotterEmbed.on(EmbedEvent.SpotterConversationDeleted, (payload) => {
4017
+ * console.log('Conversation deleted', payload);
4018
+ * // payload: { convId: string, title: string }
4019
+ * })
4020
+ * ```
4021
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
4022
+ */
4023
+ SpotterConversationDeleted = "spotterConversationDeleted",
4024
+ /**
4025
+ * Emitted when a Spotter conversation is selected/clicked.
4026
+ * @example
4027
+ * ```js
4028
+ * spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => {
4029
+ * console.log('Conversation selected', payload);
4030
+ * // payload: { convId: string, title: string, worksheetId: string }
4031
+ * })
4032
+ * ```
4033
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
4034
+ */
4035
+ SpotterConversationSelected = "spotterConversationSelected",
3951
4036
  /**
3952
4037
  * @hidden
3953
4038
  * Emitted when the auth token is about to get expired and needs to be refreshed.
@@ -6795,6 +6880,96 @@ export declare enum Action {
6795
6880
  * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
6796
6881
  */
6797
6882
  UngroupLiveboardGroup = "ungroupLiveboardGroup",
6883
+ /**
6884
+ * Controls visibility of the sidebar header (title and toggle button)
6885
+ * in the Spotter past conversations sidebar.
6886
+ * @example
6887
+ * ```js
6888
+ * hiddenActions: [Action.SpotterSidebarHeader]
6889
+ * ```
6890
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6891
+ */
6892
+ SpotterSidebarHeader = "spotterSidebarHeader",
6893
+ /**
6894
+ * Controls visibility of the sidebar footer (documentation link)
6895
+ * in the Spotter past conversations sidebar.
6896
+ * @example
6897
+ * ```js
6898
+ * hiddenActions: [Action.SpotterSidebarFooter]
6899
+ * ```
6900
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6901
+ */
6902
+ SpotterSidebarFooter = "spotterSidebarFooter",
6903
+ /**
6904
+ * Controls visibility and disable state of the sidebar toggle/expand button
6905
+ * in the Spotter past conversations sidebar.
6906
+ * @example
6907
+ * ```js
6908
+ * disabledActions: [Action.SpotterSidebarToggle]
6909
+ * ```
6910
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6911
+ */
6912
+ SpotterSidebarToggle = "spotterSidebarToggle",
6913
+ /**
6914
+ * Controls visibility and disable state of the "New Chat" button
6915
+ * in the Spotter past conversations sidebar.
6916
+ * @example
6917
+ * ```js
6918
+ * disabledActions: [Action.SpotterNewChat]
6919
+ * ```
6920
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6921
+ */
6922
+ SpotterNewChat = "spotterNewChat",
6923
+ /**
6924
+ * Controls visibility of the past conversation banner alert
6925
+ * in the Spotter interface.
6926
+ * @example
6927
+ * ```js
6928
+ * hiddenActions: [Action.SpotterPastChatBanner]
6929
+ * ```
6930
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6931
+ */
6932
+ SpotterPastChatBanner = "spotterPastChatBanner",
6933
+ /**
6934
+ * Controls visibility and disable state of the conversation edit menu
6935
+ * (three-dot menu) in the Spotter past conversations sidebar.
6936
+ * @example
6937
+ * ```js
6938
+ * disabledActions: [Action.SpotterChatMenu]
6939
+ * ```
6940
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6941
+ */
6942
+ SpotterChatMenu = "spotterChatMenu",
6943
+ /**
6944
+ * Controls visibility and disable state of the rename action
6945
+ * in the Spotter conversation edit menu.
6946
+ * @example
6947
+ * ```js
6948
+ * disabledActions: [Action.SpotterChatRename]
6949
+ * ```
6950
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6951
+ */
6952
+ SpotterChatRename = "spotterChatRename",
6953
+ /**
6954
+ * Controls visibility and disable state of the delete action
6955
+ * in the Spotter conversation edit menu.
6956
+ * @example
6957
+ * ```js
6958
+ * disabledActions: [Action.SpotterChatDelete]
6959
+ * ```
6960
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6961
+ */
6962
+ SpotterChatDelete = "spotterChatDelete",
6963
+ /**
6964
+ * Controls visibility and disable state of the documentation/best practices
6965
+ * link in the Spotter sidebar footer.
6966
+ * @example
6967
+ * ```js
6968
+ * disabledActions: [Action.SpotterDocs]
6969
+ * ```
6970
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6971
+ */
6972
+ SpotterDocs = "spotterDocs",
6798
6973
  /**
6799
6974
  * The **Include current period** checkbox for date filters.
6800
6975
  * Controls the visibility and availability of the option to include
@@ -6962,9 +7137,9 @@ declare enum EmbedErrorCodes {
6962
7137
  WORKSHEET_ID_NOT_FOUND = "WORKSHEET_ID_NOT_FOUND",
6963
7138
  /** Required Liveboard ID is missing from configuration */
6964
7139
  LIVEBOARD_ID_MISSING = "LIVEBOARD_ID_MISSING",
6965
- /** Conflicting action configuration detected (e.g., both hiddenActions and visibleActions specified) */
7140
+ /** Conflicting action configuration detected */
6966
7141
  CONFLICTING_ACTIONS_CONFIG = "CONFLICTING_ACTIONS_CONFIG",
6967
- /** Conflicting tab configuration detected (e.g., both hiddenTabs and visibleTabs specified) */
7142
+ /** Conflicting tab configuration detected */
6968
7143
  CONFLICTING_TABS_CONFIG = "CONFLICTING_TABS_CONFIG",
6969
7144
  /** Error during component initialization */
6970
7145
  INIT_ERROR = "INIT_ERROR",
@@ -6981,7 +7156,9 @@ declare enum EmbedErrorCodes {
6981
7156
  /** Error parsing api intercept body */
6982
7157
  PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
6983
7158
  /** Failed to update embed parameters during pre-render */
6984
- UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
7159
+ UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
7160
+ /** Invalid URL provided in configuration */
7161
+ INVALID_URL = "INVALID_URL"
6985
7162
  }
6986
7163
  /**
6987
7164
  * Error event object emitted when an error occurs in an embedded component.
@@ -6994,7 +7171,7 @@ declare enum EmbedErrorCodes {
6994
7171
  *
6995
7172
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
6996
7173
  * - **message**: Human-readable error description (string or array of strings for multiple errors)
6997
- * - **code**: Machine-readable error identifier for programmatic handling
7174
+ * - **code**: Machine-readable error identifier {@link EmbedErrorCodes} values
6998
7175
  * - **[key: string]**: Additional context-specific for backward compatibility
6999
7176
  *
7000
7177
  * ## Usage
@@ -7004,12 +7181,11 @@ declare enum EmbedErrorCodes {
7004
7181
  *
7005
7182
  * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
7006
7183
  * @group Error Handling
7007
- * @see {@link ErrorDetailsTypes} - Available error type values
7008
- * @see {@link EmbedEvent.Error} - The event that emits this object
7009
7184
  *
7010
7185
  * @example
7011
7186
  * Handle specific error types
7012
7187
  *
7188
+ * ```js
7013
7189
  * embed.on(EmbedEvent.Error, (error) => {
7014
7190
  * switch (error.code) {
7015
7191
  * case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
@@ -7019,30 +7195,18 @@ declare enum EmbedErrorCodes {
7019
7195
  * console.error('Unknown error:', error);
7020
7196
  * }
7021
7197
  * });
7022
- * *
7198
+ * ```
7023
7199
  * @example
7024
7200
  * Handle multiple error messages
7025
7201
  *
7202
+ * ```js
7026
7203
  * embed.on(EmbedEvent.Error, (error) => {
7027
7204
  * const messages = Array.isArray(error.message)
7028
7205
  * ? error.message
7029
7206
  * : [error.message];
7030
- *
7031
7207
  * messages.forEach(msg => console.error(msg));
7032
7208
  * });
7033
- * *
7034
- * @example
7035
- * Access additional error context
7036
- *
7037
- * embed.on(EmbedEvent.Error, (error) => {
7038
- * console.error('Error Details:', {
7039
- * type: error.errorType,
7040
- * message: error.message,
7041
- * code: error.code,
7042
- * // Additional context fields vary by error type
7043
- * ...error
7044
- * });
7045
- * });
7209
+ * ```
7046
7210
  * */
7047
7211
  export interface EmbedErrorDetailsEvent {
7048
7212
  /** The type of error that occurred */
@@ -8489,164 +8653,493 @@ declare class SageEmbed extends V1Embed {
8489
8653
  */
8490
8654
  render(): Promise<SageEmbed>;
8491
8655
  }
8492
- /**
8493
- * Pages within the ThoughtSpot app that can be embedded.
8494
- */
8495
- export declare enum Page {
8496
- /**
8497
- * Home page
8498
- */
8499
- Home = "home",
8500
- /**
8501
- * Search page
8502
- */
8503
- Search = "search",
8656
+ interface SearchOptions$2 {
8504
8657
  /**
8505
- * Saved answers listing page
8658
+ * The query string to pass to start the Conversation.
8506
8659
  */
8507
- Answers = "answers",
8660
+ searchQuery: string;
8661
+ }
8662
+ /**
8663
+ * Configuration for the Spotter sidebar.
8664
+ * Can be used in SpotterEmbed and AppEmbed.
8665
+ * @group Embed components
8666
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8667
+ */
8668
+ export interface SpotterSidebarViewConfig {
8508
8669
  /**
8509
- * Liveboards listing page
8670
+ * Controls the visibility of the past conversations sidebar.
8671
+ * @default false
8672
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
8510
8673
  */
8511
- Liveboards = "liveboards",
8674
+ enablePastConversationsSidebar?: boolean;
8512
8675
  /**
8513
- * @hidden
8676
+ * Custom title text for the sidebar header.
8677
+ * Defaults to translated "Spotter" text.
8678
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8514
8679
  */
8515
- Pinboards = "pinboards",
8680
+ spotterSidebarTitle?: string;
8516
8681
  /**
8517
- * Data management page
8682
+ * Boolean to set the default expanded state of the sidebar.
8683
+ * @default false
8684
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8518
8685
  */
8519
- Data = "data",
8686
+ spotterSidebarDefaultExpanded?: boolean;
8520
8687
  /**
8521
- * SpotIQ listing page
8688
+ * Custom label text for the rename action in the conversation edit menu.
8689
+ * Defaults to translated "Rename" text.
8690
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8522
8691
  */
8523
- SpotIQ = "insights",
8692
+ spotterChatRenameLabel?: string;
8524
8693
  /**
8525
- * Monitor Alerts Page
8694
+ * Custom label text for the delete action in the conversation edit menu.
8695
+ * Defaults to translated "DELETE" text.
8696
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8526
8697
  */
8527
- Monitor = "monitor"
8528
- }
8529
- /**
8530
- * Define the initial state os column custom group accordions
8531
- * in data panel v2.
8532
- */
8533
- declare enum DataPanelCustomColumnGroupsAccordionState$1 {
8698
+ spotterChatDeleteLabel?: string;
8534
8699
  /**
8535
- * Expand all the accordion initially in data panel v2.
8700
+ * Custom title text for the delete conversation confirmation modal.
8701
+ * Defaults to translated "Delete chat" text.
8702
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8536
8703
  */
8537
- EXPAND_ALL = "EXPAND_ALL",
8704
+ spotterDeleteConversationModalTitle?: string;
8538
8705
  /**
8539
- * Collapse all the accordions initially in data panel v2.
8706
+ * Custom message text for the past conversation banner alert.
8707
+ * Defaults to translated alert message.
8708
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8540
8709
  */
8541
- COLLAPSE_ALL = "COLLAPSE_ALL",
8710
+ spotterPastConversationAlertMessage?: string;
8542
8711
  /**
8543
- * Expand the first accordion and collapse the rest.
8712
+ * Custom URL for the documentation/best practices link.
8713
+ * Defaults to ThoughtSpot docs URL based on release version.
8714
+ * Note: URL must include the protocol (e.g., `https://www.example.com`).
8715
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8544
8716
  */
8545
- EXPAND_FIRST = "EXPAND_FIRST"
8546
- }
8547
- declare enum HomePageSearchBarMode {
8548
- OBJECT_SEARCH = "objectSearch",
8549
- AI_ANSWER = "aiAnswer",
8550
- NONE = "none"
8551
- }
8552
- declare enum PrimaryNavbarVersion {
8717
+ spotterDocumentationUrl?: string;
8553
8718
  /**
8554
- * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
8555
- * along with updates to the top navigation bar.
8556
- * It serves as the foundational version of the PrimaryNavBar.
8719
+ * Custom label text for the best practices button in the footer.
8720
+ * Defaults to translated "Best Practices" text.
8721
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8557
8722
  */
8558
- Sliding = "v3"
8559
- }
8560
- declare enum HomePage {
8723
+ spotterBestPracticesLabel?: string;
8561
8724
  /**
8562
- * Modular (v2) introduces the updated Modular Home Experience.
8563
- * It serves as the foundational version of the home page.
8725
+ * Number of conversations to fetch per batch when loading conversation history.
8726
+ * @default 30
8727
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8564
8728
  */
8565
- Modular = "v2",
8729
+ spotterConversationsBatchSize?: number;
8566
8730
  /**
8567
- * ModularWithStylingChanges (v3) introduces Modular Home Experience
8568
- * with styling changes.
8731
+ * Custom title text for the "New Chat" button in the sidebar.
8732
+ * Defaults to translated "New Chat" text.
8733
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8569
8734
  */
8570
- ModularWithStylingChanges = "v3"
8735
+ spotterNewChatButtonTitle?: string;
8571
8736
  }
8572
- declare enum ListPage {
8737
+ /**
8738
+ * Configuration for customizing Spotter chat UI branding.
8739
+ * @group Embed components
8740
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
8741
+ */
8742
+ export interface SpotterChatViewConfig {
8573
8743
  /**
8574
- * List (v2) is the traditional List Experience.
8575
- * It serves as the foundational version of the list page.
8744
+ * Hides the ThoughtSpot logo/icon in tool response
8745
+ * cards. The branding label prefix is controlled
8746
+ * separately via `toolResponseCardBrandingLabel`.
8747
+ * External MCP tool branding is not affected.
8748
+ * @default false
8576
8749
  */
8577
- List = "v2",
8750
+ hideToolResponseCardBranding?: boolean;
8578
8751
  /**
8579
- * ListWithUXChanges (v3) introduces the new updated list page with UX changes.
8752
+ * Custom label to replace the "ThoughtSpot" prefix
8753
+ * in tool response cards. Set to an empty string
8754
+ * `''` to hide the prefix entirely. Works
8755
+ * independently of `hideToolResponseCardBranding`.
8756
+ * External MCP tool branding is not affected.
8580
8757
  */
8581
- ListWithUXChanges = "v3"
8758
+ toolResponseCardBrandingLabel?: string;
8582
8759
  }
8583
8760
  /**
8584
- * Define the discovery experience
8585
- * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
8761
+ * The configuration for the embedded spotterEmbed options.
8762
+ * @group Embed components
8586
8763
  */
8587
- export interface DiscoveryExperience {
8588
- /**
8589
- * primaryNavbarVersion determines the version of the navigation version.
8590
- */
8591
- primaryNavbarVersion?: PrimaryNavbarVersion;
8764
+ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
8592
8765
  /**
8593
- * homePage determines the version of the home page.
8766
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses
8767
+ * this object to query data and generate Answers.
8594
8768
  */
8595
- homePage?: HomePage;
8769
+ worksheetId: string;
8596
8770
  /**
8597
- * listPageVersion determines the version of the list page.
8771
+ * Ability to pass a starting search query to the conversation.
8598
8772
  */
8599
- listPageVersion?: ListPage;
8600
- }
8601
- /**
8602
- * The view configuration for full app embedding.
8603
- * @group Embed components
8604
- */
8605
- export interface AppViewConfig extends AllEmbedViewConfig {
8773
+ searchOptions?: SearchOptions$2;
8606
8774
  /**
8607
- * If true, the top navigation bar within the ThoughtSpot app
8608
- * is displayed. By default, the navigation bar is hidden.
8609
- * This flag also controls the homepage left navigation bar.
8775
+ * disableSourceSelection : Disables data source selection
8776
+ * but still display the selected data source.
8610
8777
  *
8611
- * Supported embed types: `AppEmbed`
8612
- * @default true
8613
- * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
8778
+ * Supported embed types: `SpotterEmbed`
8614
8779
  * @example
8615
8780
  * ```js
8616
- * const embed = new AppEmbed('#tsEmbed', {
8617
- * ... // other embed view config
8618
- * showPrimaryNavbar:true,
8781
+ * const embed = new SpotterEmbed('#tsEmbed', {
8782
+ * ... //other embed view config
8783
+ * disableSourceSelection : true,
8619
8784
  * })
8620
8785
  * ```
8786
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8621
8787
  */
8622
- showPrimaryNavbar?: boolean;
8788
+ disableSourceSelection?: boolean;
8623
8789
  /**
8624
- * Control the visibility of the left navigation panel on the home page
8625
- * in the V2 and V3 navigation and home page experience.
8626
- * If `showPrimaryNavbar` is true, that is, if the Global and Homepage
8627
- * navigation bars are visible, this flag will only hide the left navigation bar
8628
- * on the home page.
8629
- * The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
8630
- *
8631
- * **Note**: This attribute is not supported in the classic (V1) experience.
8790
+ * hideSourceSelection : Hide data source selection
8632
8791
  *
8633
- * Supported embed types: `AppEmbed`
8634
- * @default false
8635
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
8792
+ * Supported embed types: `SpotterEmbed`
8636
8793
  * @example
8637
8794
  * ```js
8638
- * const embed = new AppEmbed('#tsEmbed', {
8639
- * ... // other embed view config
8640
- * hideHomepageLeftNav : true,
8795
+ * const embed = new SpotterEmbed('#tsEmbed', {
8796
+ * ... //other embed view config
8797
+ * hideSourceSelection : true,
8641
8798
  * })
8642
8799
  * ```
8800
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8643
8801
  */
8644
- hideHomepageLeftNav?: boolean;
8802
+ hideSourceSelection?: boolean;
8645
8803
  /**
8646
- * Control the visibility of the help (?) and profile
8647
- * buttons on the top navigation bar.
8648
- * These buttons are visible if the
8649
- * navigation bar is not hidden via `showPrimaryNavbar`.
8804
+ * Flag to control Data panel experience
8805
+ *
8806
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
8807
+ * @default true
8808
+ * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
8809
+ * @example
8810
+ * ```js
8811
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
8812
+ * const embed = new <EmbedComponent>('#tsEmbed', {
8813
+ * ... // other embed view config
8814
+ * dataPanelV2: true,
8815
+ * })
8816
+ * ```
8817
+ */
8818
+ dataPanelV2?: boolean;
8819
+ /**
8820
+ * showSpotterLimitations : show limitation text
8821
+ * of the spotter underneath the chat input.
8822
+ * default is false.
8823
+ *
8824
+ * Supported embed types: `SpotterEmbed`
8825
+ * @example
8826
+ * ```js
8827
+ * const embed = new SpotterEmbed('#tsEmbed', {
8828
+ * ... //other embed view config
8829
+ * showSpotterLimitations : true,
8830
+ * })
8831
+ * ```
8832
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
8833
+ */
8834
+ showSpotterLimitations?: boolean;
8835
+ /**
8836
+ * hideSampleQuestions : Hide sample questions on
8837
+ * the initial screen of the conversation.
8838
+ *
8839
+ * Supported embed types: `SpotterEmbed`
8840
+ * @example
8841
+ * ```js
8842
+ * const embed = new SpotterEmbed('#tsEmbed', {
8843
+ * ... //other embed view config
8844
+ * hideSampleQuestions : true,
8845
+ * })
8846
+ * ```
8847
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8848
+ */
8849
+ hideSampleQuestions?: boolean;
8850
+ /**
8851
+ * The list of runtime filters to apply to a search Answer,
8852
+ * visualization, or Liveboard.
8853
+ *
8854
+ * Supported embed types: `SpotterEmbed`
8855
+ * @example
8856
+ * ```js
8857
+ * const embed = new SpotterEmbed('#tsEmbed', {
8858
+ * // other embed view config
8859
+ * runtimeFilters: [
8860
+ * {
8861
+ * columnName: 'color',
8862
+ * operator: RuntimeFilterOp.EQ,
8863
+ * values: ['red'],
8864
+ * },
8865
+ * ],
8866
+ * })
8867
+ * ```
8868
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8869
+ */
8870
+ runtimeFilters?: RuntimeFilter[];
8871
+ /**
8872
+ * Flag to control whether runtime filters should be included in the URL.
8873
+ * If true, filters will be passed via app initialization payload
8874
+ * (default behavior from SDK 1.45.0).
8875
+ * If false/undefined, filters are appended to the iframe URL instead.
8876
+ * (default behavior before SDK 1.45.0).
8877
+ *
8878
+ * Supported embed types: `SpotterEmbed`
8879
+ * @default true
8880
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8881
+ */
8882
+ excludeRuntimeFiltersfromURL?: boolean;
8883
+ /**
8884
+ * The list of runtime parameters to apply to the conversation.
8885
+ *
8886
+ * Supported embed types: `SpotterEmbed`
8887
+ * @example
8888
+ * ```js
8889
+ * const embed = new SpotterEmbed('#tsEmbed', {
8890
+ * // other embed view config
8891
+ * runtimeParameters: [
8892
+ * {
8893
+ * name: 'Integer Param',
8894
+ * value: 10,
8895
+ * },
8896
+ * ],
8897
+ * })
8898
+ * ```
8899
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8900
+ */
8901
+ runtimeParameters?: RuntimeParameter[];
8902
+ /**
8903
+ * Flag to control whether runtime parameters should be included in the URL.
8904
+ * If true, parameters will be passed via app
8905
+ * initialization payload (default behavior from SDK 1.45.0).
8906
+ * If false/undefined, parameters are appended to
8907
+ * the iframe URL instead (default behavior before SDK 1.45.0).
8908
+ *
8909
+ * Supported embed types: `SpotterEmbed`
8910
+ * @default true
8911
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8912
+ */
8913
+ excludeRuntimeParametersfromURL?: boolean;
8914
+ /**
8915
+ * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
8916
+ *
8917
+ * Supported embed types: `SpotterEmbed`
8918
+ * @default false
8919
+ * @example
8920
+ * ```js
8921
+ * const embed = new SpotterEmbed('#tsEmbed', {
8922
+ * ... //other embed view config
8923
+ * updatedSpotterChatPrompt : true,
8924
+ * })
8925
+ * ```
8926
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
8927
+ */
8928
+ updatedSpotterChatPrompt?: boolean;
8929
+ /**
8930
+ * Configuration for the Spotter sidebar UI customization.
8931
+ *
8932
+ * Supported embed types: `SpotterEmbed`, `AppEmbed`
8933
+ * @example
8934
+ * ```js
8935
+ * const embed = new SpotterEmbed('#tsEmbed', {
8936
+ * ... //other embed view config
8937
+ * spotterSidebarConfig: {
8938
+ * enablePastConversationsSidebar: true,
8939
+ * spotterSidebarTitle: 'My Conversations',
8940
+ * spotterSidebarDefaultExpanded: true,
8941
+ * },
8942
+ * })
8943
+ * ```
8944
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8945
+ */
8946
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
8947
+ /**
8948
+ * Configuration for customizing Spotter chat UI
8949
+ * branding in tool response cards.
8950
+ *
8951
+ * Supported embed types: `SpotterEmbed`
8952
+ * @example
8953
+ * ```js
8954
+ * const embed = new SpotterEmbed('#tsEmbed', {
8955
+ * ... //other embed view config
8956
+ * spotterChatConfig: {
8957
+ * hideToolResponseCardBranding: true,
8958
+ * toolResponseCardBrandingLabel: 'MyBrand',
8959
+ * },
8960
+ * })
8961
+ * ```
8962
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
8963
+ */
8964
+ spotterChatConfig?: SpotterChatViewConfig;
8965
+ }
8966
+ /**
8967
+ * The configuration for the embedded spotterEmbed options.
8968
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
8969
+ * Use {@link SpotterEmbedViewConfig} instead
8970
+ * @group Embed components
8971
+ */
8972
+ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
8973
+ }
8974
+ declare class SpotterEmbed extends TsEmbed {
8975
+ protected viewConfig: SpotterEmbedViewConfig;
8976
+ constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
8977
+ protected getEmbedParamsObject(): Record<any, any>;
8978
+ getIframeSrc(): string;
8979
+ render(): Promise<SpotterEmbed>;
8980
+ }
8981
+ declare class ConversationEmbed extends SpotterEmbed {
8982
+ protected viewConfig: ConversationViewConfig;
8983
+ constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
8984
+ }
8985
+ /**
8986
+ * Pages within the ThoughtSpot app that can be embedded.
8987
+ */
8988
+ export declare enum Page {
8989
+ /**
8990
+ * Home page
8991
+ */
8992
+ Home = "home",
8993
+ /**
8994
+ * Search page
8995
+ */
8996
+ Search = "search",
8997
+ /**
8998
+ * Saved answers listing page
8999
+ */
9000
+ Answers = "answers",
9001
+ /**
9002
+ * Liveboards listing page
9003
+ */
9004
+ Liveboards = "liveboards",
9005
+ /**
9006
+ * @hidden
9007
+ */
9008
+ Pinboards = "pinboards",
9009
+ /**
9010
+ * Data management page
9011
+ */
9012
+ Data = "data",
9013
+ /**
9014
+ * SpotIQ listing page
9015
+ */
9016
+ SpotIQ = "insights",
9017
+ /**
9018
+ * Monitor Alerts Page
9019
+ */
9020
+ Monitor = "monitor"
9021
+ }
9022
+ /**
9023
+ * Define the initial state os column custom group accordions
9024
+ * in data panel v2.
9025
+ */
9026
+ declare enum DataPanelCustomColumnGroupsAccordionState$1 {
9027
+ /**
9028
+ * Expand all the accordion initially in data panel v2.
9029
+ */
9030
+ EXPAND_ALL = "EXPAND_ALL",
9031
+ /**
9032
+ * Collapse all the accordions initially in data panel v2.
9033
+ */
9034
+ COLLAPSE_ALL = "COLLAPSE_ALL",
9035
+ /**
9036
+ * Expand the first accordion and collapse the rest.
9037
+ */
9038
+ EXPAND_FIRST = "EXPAND_FIRST"
9039
+ }
9040
+ declare enum HomePageSearchBarMode {
9041
+ OBJECT_SEARCH = "objectSearch",
9042
+ AI_ANSWER = "aiAnswer",
9043
+ NONE = "none"
9044
+ }
9045
+ declare enum PrimaryNavbarVersion {
9046
+ /**
9047
+ * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
9048
+ * along with updates to the top navigation bar.
9049
+ * It serves as the foundational version of the PrimaryNavBar.
9050
+ */
9051
+ Sliding = "v3"
9052
+ }
9053
+ declare enum HomePage {
9054
+ /**
9055
+ * Modular (v2) introduces the updated Modular Home Experience.
9056
+ * It serves as the foundational version of the home page.
9057
+ */
9058
+ Modular = "v2",
9059
+ /**
9060
+ * ModularWithStylingChanges (v3) introduces Modular Home Experience
9061
+ * with styling changes.
9062
+ */
9063
+ ModularWithStylingChanges = "v3"
9064
+ }
9065
+ declare enum ListPage {
9066
+ /**
9067
+ * List (v2) is the traditional List Experience.
9068
+ * It serves as the foundational version of the list page.
9069
+ */
9070
+ List = "v2",
9071
+ /**
9072
+ * ListWithUXChanges (v3) introduces the new updated list page with UX changes.
9073
+ */
9074
+ ListWithUXChanges = "v3"
9075
+ }
9076
+ /**
9077
+ * Define the discovery experience
9078
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9079
+ */
9080
+ export interface DiscoveryExperience {
9081
+ /**
9082
+ * primaryNavbarVersion determines the version of the navigation version.
9083
+ */
9084
+ primaryNavbarVersion?: PrimaryNavbarVersion;
9085
+ /**
9086
+ * homePage determines the version of the home page.
9087
+ */
9088
+ homePage?: HomePage;
9089
+ /**
9090
+ * listPageVersion determines the version of the list page.
9091
+ */
9092
+ listPageVersion?: ListPage;
9093
+ }
9094
+ /**
9095
+ * The view configuration for full app embedding.
9096
+ * @group Embed components
9097
+ */
9098
+ export interface AppViewConfig extends AllEmbedViewConfig {
9099
+ /**
9100
+ * If true, the top navigation bar within the ThoughtSpot app
9101
+ * is displayed. By default, the navigation bar is hidden.
9102
+ * This flag also controls the homepage left navigation bar.
9103
+ *
9104
+ * Supported embed types: `AppEmbed`
9105
+ * @default true
9106
+ * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
9107
+ * @example
9108
+ * ```js
9109
+ * const embed = new AppEmbed('#tsEmbed', {
9110
+ * ... // other embed view config
9111
+ * showPrimaryNavbar:true,
9112
+ * })
9113
+ * ```
9114
+ */
9115
+ showPrimaryNavbar?: boolean;
9116
+ /**
9117
+ * Control the visibility of the left navigation panel on the home page
9118
+ * in the V2 and V3 navigation and home page experience.
9119
+ * If `showPrimaryNavbar` is true, that is, if the Global and Homepage
9120
+ * navigation bars are visible, this flag will only hide the left navigation bar
9121
+ * on the home page.
9122
+ * The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
9123
+ *
9124
+ * **Note**: This attribute is not supported in the classic (V1) experience.
9125
+ *
9126
+ * Supported embed types: `AppEmbed`
9127
+ * @default false
9128
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
9129
+ * @example
9130
+ * ```js
9131
+ * const embed = new AppEmbed('#tsEmbed', {
9132
+ * ... // other embed view config
9133
+ * hideHomepageLeftNav : true,
9134
+ * })
9135
+ * ```
9136
+ */
9137
+ hideHomepageLeftNav?: boolean;
9138
+ /**
9139
+ * Control the visibility of the help (?) and profile
9140
+ * buttons on the top navigation bar.
9141
+ * These buttons are visible if the
9142
+ * navigation bar is not hidden via `showPrimaryNavbar`.
8650
9143
  *
8651
9144
  * Supported embed types: `AppEmbed`
8652
9145
  * @default false
@@ -9114,6 +9607,42 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9114
9607
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9115
9608
  */
9116
9609
  updatedSpotterChatPrompt?: boolean;
9610
+ /**
9611
+ * Configuration for the Spotter sidebar UI customization.
9612
+ * Only applicable when navigating to Spotter within the app.
9613
+ *
9614
+ * Supported embed types: `AppEmbed`
9615
+ * @example
9616
+ * ```js
9617
+ * const embed = new AppEmbed('#tsEmbed', {
9618
+ * ... //other embed view config
9619
+ * spotterSidebarConfig: {
9620
+ * enablePastConversationsSidebar: true,
9621
+ * spotterSidebarTitle: 'My Conversations',
9622
+ * },
9623
+ * })
9624
+ * ```
9625
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9626
+ */
9627
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
9628
+ /**
9629
+ * Configuration for customizing Spotter chat UI
9630
+ * branding in tool response cards.
9631
+ *
9632
+ * Supported embed types: `AppEmbed`
9633
+ * @example
9634
+ * ```js
9635
+ * const embed = new AppEmbed('#tsEmbed', {
9636
+ * ... //other embed view config
9637
+ * spotterChatConfig: {
9638
+ * hideToolResponseCardBranding: true,
9639
+ * toolResponseCardBrandingLabel: 'MyBrand',
9640
+ * },
9641
+ * })
9642
+ * ```
9643
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9644
+ */
9645
+ spotterChatConfig?: SpotterChatViewConfig;
9117
9646
  /**
9118
9647
  * This is the minimum height (in pixels) for a full-height App.
9119
9648
  * Setting this height helps resolve issues with empty Apps and
@@ -9378,6 +9907,23 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9378
9907
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
9379
9908
  */
9380
9909
  activeTabId?: string;
9910
+ /**
9911
+ * The GUID of a saved personalized view to load.
9912
+ * A personalized view is a saved configuration of a Liveboard
9913
+ * that includes specific filter selections.
9914
+ *
9915
+ * Supported embed types: `LiveboardEmbed`
9916
+ * @example
9917
+ * ```js
9918
+ * const embed = new LiveboardEmbed('#tsEmbed', {
9919
+ * liveboardId: 'liveboard-guid',
9920
+ * personalizedViewId: 'view-guid',
9921
+ * activeTabId: 'tab-guid',
9922
+ * })
9923
+ * ```
9924
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9925
+ */
9926
+ personalizedViewId?: string;
9381
9927
  /**
9382
9928
  * Show or hide the tab panel of the embedded Liveboard.
9383
9929
  *
@@ -9631,6 +10177,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9631
10177
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9632
10178
  */
9633
10179
  updatedSpotterChatPrompt?: boolean;
10180
+ /**
10181
+ * Configuration for customizing Spotter chat UI
10182
+ * branding in tool response cards.
10183
+ *
10184
+ * Supported embed types: `LiveboardEmbed`
10185
+ * @example
10186
+ * ```js
10187
+ * const embed = new LiveboardEmbed('#tsEmbed', {
10188
+ * ... //other embed view config
10189
+ * spotterChatConfig: {
10190
+ * hideToolResponseCardBranding: true,
10191
+ * toolResponseCardBrandingLabel: 'MyBrand',
10192
+ * },
10193
+ * })
10194
+ * ```
10195
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10196
+ */
10197
+ spotterChatConfig?: SpotterChatViewConfig;
9634
10198
  }
9635
10199
  declare class LiveboardEmbed extends V1Embed {
9636
10200
  protected viewConfig: LiveboardViewConfig;
@@ -9675,6 +10239,7 @@ declare class LiveboardEmbed extends V1Embed {
9675
10239
  liveboardId: string;
9676
10240
  vizId: string;
9677
10241
  activeTabId: string;
10242
+ personalizedViewId: string;
9678
10243
  };
9679
10244
  protected beforePrerenderVisible(): void;
9680
10245
  protected handleRenderForPrerender(): Promise<TsEmbed>;
@@ -9699,7 +10264,7 @@ declare class LiveboardEmbed extends V1Embed {
9699
10264
  * visualization ID and the runtime filters.
9700
10265
  */
9701
10266
  render(): Promise<LiveboardEmbed>;
9702
- navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
10267
+ navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, personalizedViewId?: string): void;
9703
10268
  /**
9704
10269
  * Returns the full url of the Liveboard/visualization which can be used to open
9705
10270
  * this Liveboard inside the full ThoughtSpot application in a new tab.
@@ -9746,217 +10311,6 @@ export interface EmbedProps extends EmbedViewConfig {
9746
10311
  className?: string;
9747
10312
  style?: React$1.CSSProperties;
9748
10313
  }
9749
- interface SearchOptions$2 {
9750
- /**
9751
- * The query string to pass to start the Conversation.
9752
- */
9753
- searchQuery: string;
9754
- }
9755
- /**
9756
- * The configuration for the embedded spotterEmbed options.
9757
- * @group Embed components
9758
- */
9759
- export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
9760
- /**
9761
- * The ID of the data source object. For example, Model, View, or Table. Spotter uses
9762
- * this object to query data and generate Answers.
9763
- */
9764
- worksheetId: string;
9765
- /**
9766
- * Ability to pass a starting search query to the conversation.
9767
- */
9768
- searchOptions?: SearchOptions$2;
9769
- /**
9770
- * disableSourceSelection : Disables data source selection
9771
- * but still display the selected data source.
9772
- *
9773
- * Supported embed types: `SpotterEmbed`
9774
- * @example
9775
- * ```js
9776
- * const embed = new SpotterEmbed('#tsEmbed', {
9777
- * ... //other embed view config
9778
- * disableSourceSelection : true,
9779
- * })
9780
- * ```
9781
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9782
- */
9783
- disableSourceSelection?: boolean;
9784
- /**
9785
- * hideSourceSelection : Hide data source selection
9786
- *
9787
- * Supported embed types: `SpotterEmbed`
9788
- * @example
9789
- * ```js
9790
- * const embed = new SpotterEmbed('#tsEmbed', {
9791
- * ... //other embed view config
9792
- * hideSourceSelection : true,
9793
- * })
9794
- * ```
9795
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9796
- */
9797
- hideSourceSelection?: boolean;
9798
- /**
9799
- * Flag to control Data panel experience
9800
- *
9801
- * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
9802
- * @default true
9803
- * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
9804
- * @example
9805
- * ```js
9806
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
9807
- * const embed = new <EmbedComponent>('#tsEmbed', {
9808
- * ... // other embed view config
9809
- * dataPanelV2: true,
9810
- * })
9811
- * ```
9812
- */
9813
- dataPanelV2?: boolean;
9814
- /**
9815
- * showSpotterLimitations : show limitation text
9816
- * of the spotter underneath the chat input.
9817
- * default is false.
9818
- *
9819
- * Supported embed types: `SpotterEmbed`
9820
- * @example
9821
- * ```js
9822
- * const embed = new SpotterEmbed('#tsEmbed', {
9823
- * ... //other embed view config
9824
- * showSpotterLimitations : true,
9825
- * })
9826
- * ```
9827
- * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
9828
- */
9829
- showSpotterLimitations?: boolean;
9830
- /**
9831
- * hideSampleQuestions : Hide sample questions on
9832
- * the initial screen of the conversation.
9833
- *
9834
- * Supported embed types: `SpotterEmbed`
9835
- * @example
9836
- * ```js
9837
- * const embed = new SpotterEmbed('#tsEmbed', {
9838
- * ... //other embed view config
9839
- * hideSampleQuestions : true,
9840
- * })
9841
- * ```
9842
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9843
- */
9844
- hideSampleQuestions?: boolean;
9845
- /**
9846
- * The list of runtime filters to apply to a search Answer,
9847
- * visualization, or Liveboard.
9848
- *
9849
- * Supported embed types: `SpotterEmbed`
9850
- * @example
9851
- * ```js
9852
- * const embed = new SpotterEmbed('#tsEmbed', {
9853
- * // other embed view config
9854
- * runtimeFilters: [
9855
- * {
9856
- * columnName: 'color',
9857
- * operator: RuntimeFilterOp.EQ,
9858
- * values: ['red'],
9859
- * },
9860
- * ],
9861
- * })
9862
- * ```
9863
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9864
- */
9865
- runtimeFilters?: RuntimeFilter[];
9866
- /**
9867
- * Flag to control whether runtime filters should be included in the URL.
9868
- * If true, filters will be passed via app initialization payload
9869
- * (default behavior from SDK 1.45.0).
9870
- * If false/undefined, filters are appended to the iframe URL instead.
9871
- * (default behavior before SDK 1.45.0).
9872
- *
9873
- * Supported embed types: `SpotterEmbed`
9874
- * @default true
9875
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9876
- */
9877
- excludeRuntimeFiltersfromURL?: boolean;
9878
- /**
9879
- * The list of runtime parameters to apply to the conversation.
9880
- *
9881
- * Supported embed types: `SpotterEmbed`
9882
- * @example
9883
- * ```js
9884
- * const embed = new SpotterEmbed('#tsEmbed', {
9885
- * // other embed view config
9886
- * runtimeParameters: [
9887
- * {
9888
- * name: 'Integer Param',
9889
- * value: 10,
9890
- * },
9891
- * ],
9892
- * })
9893
- * ```
9894
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9895
- */
9896
- runtimeParameters?: RuntimeParameter[];
9897
- /**
9898
- * Flag to control whether runtime parameters should be included in the URL.
9899
- * If true, parameters will be passed via app
9900
- * initialization payload (default behavior from SDK 1.45.0).
9901
- * If false/undefined, parameters are appended to
9902
- * the iframe URL instead (default behavior before SDK 1.45.0).
9903
- *
9904
- * Supported embed types: `SpotterEmbed`
9905
- * @default true
9906
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9907
- */
9908
- excludeRuntimeParametersfromURL?: boolean;
9909
- /**
9910
- * enablePastConversationsSidebar : Controls the visibility of the past conversations
9911
- * sidebar.
9912
- *
9913
- * Supported embed types: `SpotterEmbed`
9914
- * @default false
9915
- * @example
9916
- * ```js
9917
- * const embed = new SpotterEmbed('#tsEmbed', {
9918
- * ... //other embed view config
9919
- * enablePastConversationsSidebar : true,
9920
- * })
9921
- * ```
9922
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9923
- */
9924
- enablePastConversationsSidebar?: boolean;
9925
- /**
9926
- * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
9927
- *
9928
- * Supported embed types: `SpotterEmbed`
9929
- * @default false
9930
- * @example
9931
- * ```js
9932
- * const embed = new SpotterEmbed('#tsEmbed', {
9933
- * ... //other embed view config
9934
- * updatedSpotterChatPrompt : true,
9935
- * })
9936
- * ```
9937
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9938
- */
9939
- updatedSpotterChatPrompt?: boolean;
9940
- }
9941
- /**
9942
- * The configuration for the embedded spotterEmbed options.
9943
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
9944
- * Use {@link SpotterEmbedViewConfig} instead
9945
- * @group Embed components
9946
- */
9947
- export interface ConversationViewConfig extends SpotterEmbedViewConfig {
9948
- }
9949
- declare class SpotterEmbed extends TsEmbed {
9950
- protected viewConfig: SpotterEmbedViewConfig;
9951
- constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
9952
- protected getEmbedParamsObject(): Record<any, any>;
9953
- getIframeSrc(): string;
9954
- render(): Promise<SpotterEmbed>;
9955
- }
9956
- declare class ConversationEmbed extends SpotterEmbed {
9957
- protected viewConfig: ConversationViewConfig;
9958
- constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
9959
- }
9960
10314
  /**
9961
10315
  * Prefetches static resources from the specified URL. Web browsers can then cache the
9962
10316
  * prefetched resources and serve them from the user's local disk to provide faster access