@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
@@ -3961,6 +4010,42 @@ export declare enum EmbedEvent {
3961
4010
  * @version SDK: 1.43.0 | ThoughtSpot: 10.15.0.cl
3962
4011
  */
3963
4012
  ApiIntercept = "ApiIntercept",
4013
+ /**
4014
+ * Emitted when a Spotter conversation is renamed.
4015
+ * @example
4016
+ * ```js
4017
+ * spotterEmbed.on(EmbedEvent.SpotterConversationRenamed, (payload) => {
4018
+ * console.log('Conversation renamed', payload);
4019
+ * // payload: { convId: string, oldTitle: string, newTitle: string }
4020
+ * })
4021
+ * ```
4022
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
4023
+ */
4024
+ SpotterConversationRenamed = "spotterConversationRenamed",
4025
+ /**
4026
+ * Emitted when a Spotter conversation is deleted.
4027
+ * @example
4028
+ * ```js
4029
+ * spotterEmbed.on(EmbedEvent.SpotterConversationDeleted, (payload) => {
4030
+ * console.log('Conversation deleted', payload);
4031
+ * // payload: { convId: string, title: string }
4032
+ * })
4033
+ * ```
4034
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
4035
+ */
4036
+ SpotterConversationDeleted = "spotterConversationDeleted",
4037
+ /**
4038
+ * Emitted when a Spotter conversation is selected/clicked.
4039
+ * @example
4040
+ * ```js
4041
+ * spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => {
4042
+ * console.log('Conversation selected', payload);
4043
+ * // payload: { convId: string, title: string, worksheetId: string }
4044
+ * })
4045
+ * ```
4046
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
4047
+ */
4048
+ SpotterConversationSelected = "spotterConversationSelected",
3964
4049
  /**
3965
4050
  * @hidden
3966
4051
  * Emitted when the auth token is about to get expired and needs to be refreshed.
@@ -6790,6 +6875,96 @@ export declare enum Action {
6790
6875
  * @version SDK: 1.44.0 | ThoughtSpot Cloud: 26.2.0.cl
6791
6876
  */
6792
6877
  UngroupLiveboardGroup = "ungroupLiveboardGroup",
6878
+ /**
6879
+ * Controls visibility of the sidebar header (title and toggle button)
6880
+ * in the Spotter past conversations sidebar.
6881
+ * @example
6882
+ * ```js
6883
+ * hiddenActions: [Action.SpotterSidebarHeader]
6884
+ * ```
6885
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6886
+ */
6887
+ SpotterSidebarHeader = "spotterSidebarHeader",
6888
+ /**
6889
+ * Controls visibility of the sidebar footer (documentation link)
6890
+ * in the Spotter past conversations sidebar.
6891
+ * @example
6892
+ * ```js
6893
+ * hiddenActions: [Action.SpotterSidebarFooter]
6894
+ * ```
6895
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6896
+ */
6897
+ SpotterSidebarFooter = "spotterSidebarFooter",
6898
+ /**
6899
+ * Controls visibility and disable state of the sidebar toggle/expand button
6900
+ * in the Spotter past conversations sidebar.
6901
+ * @example
6902
+ * ```js
6903
+ * disabledActions: [Action.SpotterSidebarToggle]
6904
+ * ```
6905
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6906
+ */
6907
+ SpotterSidebarToggle = "spotterSidebarToggle",
6908
+ /**
6909
+ * Controls visibility and disable state of the "New Chat" button
6910
+ * in the Spotter past conversations sidebar.
6911
+ * @example
6912
+ * ```js
6913
+ * disabledActions: [Action.SpotterNewChat]
6914
+ * ```
6915
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6916
+ */
6917
+ SpotterNewChat = "spotterNewChat",
6918
+ /**
6919
+ * Controls visibility of the past conversation banner alert
6920
+ * in the Spotter interface.
6921
+ * @example
6922
+ * ```js
6923
+ * hiddenActions: [Action.SpotterPastChatBanner]
6924
+ * ```
6925
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6926
+ */
6927
+ SpotterPastChatBanner = "spotterPastChatBanner",
6928
+ /**
6929
+ * Controls visibility and disable state of the conversation edit menu
6930
+ * (three-dot menu) in the Spotter past conversations sidebar.
6931
+ * @example
6932
+ * ```js
6933
+ * disabledActions: [Action.SpotterChatMenu]
6934
+ * ```
6935
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6936
+ */
6937
+ SpotterChatMenu = "spotterChatMenu",
6938
+ /**
6939
+ * Controls visibility and disable state of the rename action
6940
+ * in the Spotter conversation edit menu.
6941
+ * @example
6942
+ * ```js
6943
+ * disabledActions: [Action.SpotterChatRename]
6944
+ * ```
6945
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6946
+ */
6947
+ SpotterChatRename = "spotterChatRename",
6948
+ /**
6949
+ * Controls visibility and disable state of the delete action
6950
+ * in the Spotter conversation edit menu.
6951
+ * @example
6952
+ * ```js
6953
+ * disabledActions: [Action.SpotterChatDelete]
6954
+ * ```
6955
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6956
+ */
6957
+ SpotterChatDelete = "spotterChatDelete",
6958
+ /**
6959
+ * Controls visibility and disable state of the documentation/best practices
6960
+ * link in the Spotter sidebar footer.
6961
+ * @example
6962
+ * ```js
6963
+ * disabledActions: [Action.SpotterDocs]
6964
+ * ```
6965
+ * @version SDK: 1.46.0 | ThoughtSpot Cloud: 26.3.0.cl
6966
+ */
6967
+ SpotterDocs = "spotterDocs",
6793
6968
  /**
6794
6969
  * The **Include current period** checkbox for date filters.
6795
6970
  * Controls the visibility and availability of the option to include
@@ -6954,9 +7129,9 @@ declare enum EmbedErrorCodes {
6954
7129
  WORKSHEET_ID_NOT_FOUND = "WORKSHEET_ID_NOT_FOUND",
6955
7130
  /** Required Liveboard ID is missing from configuration */
6956
7131
  LIVEBOARD_ID_MISSING = "LIVEBOARD_ID_MISSING",
6957
- /** Conflicting action configuration detected (e.g., both hiddenActions and visibleActions specified) */
7132
+ /** Conflicting action configuration detected */
6958
7133
  CONFLICTING_ACTIONS_CONFIG = "CONFLICTING_ACTIONS_CONFIG",
6959
- /** Conflicting tab configuration detected (e.g., both hiddenTabs and visibleTabs specified) */
7134
+ /** Conflicting tab configuration detected */
6960
7135
  CONFLICTING_TABS_CONFIG = "CONFLICTING_TABS_CONFIG",
6961
7136
  /** Error during component initialization */
6962
7137
  INIT_ERROR = "INIT_ERROR",
@@ -6973,7 +7148,9 @@ declare enum EmbedErrorCodes {
6973
7148
  /** Error parsing api intercept body */
6974
7149
  PARSING_API_INTERCEPT_BODY_ERROR = "PARSING_API_INTERCEPT_BODY_ERROR",
6975
7150
  /** Failed to update embed parameters during pre-render */
6976
- UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED"
7151
+ UPDATE_PARAMS_FAILED = "UPDATE_PARAMS_FAILED",
7152
+ /** Invalid URL provided in configuration */
7153
+ INVALID_URL = "INVALID_URL"
6977
7154
  }
6978
7155
  /**
6979
7156
  * Error event object emitted when an error occurs in an embedded component.
@@ -6986,7 +7163,7 @@ declare enum EmbedErrorCodes {
6986
7163
  *
6987
7164
  * - **errorType**: One of the predefined {@link ErrorDetailsTypes} values
6988
7165
  * - **message**: Human-readable error description (string or array of strings for multiple errors)
6989
- * - **code**: Machine-readable error identifier for programmatic handling
7166
+ * - **code**: Machine-readable error identifier {@link EmbedErrorCodes} values
6990
7167
  * - **[key: string]**: Additional context-specific for backward compatibility
6991
7168
  *
6992
7169
  * ## Usage
@@ -6996,12 +7173,11 @@ declare enum EmbedErrorCodes {
6996
7173
  *
6997
7174
  * @version SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl
6998
7175
  * @group Error Handling
6999
- * @see {@link ErrorDetailsTypes} - Available error type values
7000
- * @see {@link EmbedEvent.Error} - The event that emits this object
7001
7176
  *
7002
7177
  * @example
7003
7178
  * Handle specific error types
7004
7179
  *
7180
+ * ```js
7005
7181
  * embed.on(EmbedEvent.Error, (error) => {
7006
7182
  * switch (error.code) {
7007
7183
  * case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
@@ -7011,30 +7187,18 @@ declare enum EmbedErrorCodes {
7011
7187
  * console.error('Unknown error:', error);
7012
7188
  * }
7013
7189
  * });
7014
- * *
7190
+ * ```
7015
7191
  * @example
7016
7192
  * Handle multiple error messages
7017
7193
  *
7194
+ * ```js
7018
7195
  * embed.on(EmbedEvent.Error, (error) => {
7019
7196
  * const messages = Array.isArray(error.message)
7020
7197
  * ? error.message
7021
7198
  * : [error.message];
7022
- *
7023
7199
  * messages.forEach(msg => console.error(msg));
7024
7200
  * });
7025
- * *
7026
- * @example
7027
- * Access additional error context
7028
- *
7029
- * embed.on(EmbedEvent.Error, (error) => {
7030
- * console.error('Error Details:', {
7031
- * type: error.errorType,
7032
- * message: error.message,
7033
- * code: error.code,
7034
- * // Additional context fields vary by error type
7035
- * ...error
7036
- * });
7037
- * });
7201
+ * ```
7038
7202
  * */
7039
7203
  export interface EmbedErrorDetailsEvent {
7040
7204
  /** The type of error that occurred */
@@ -8465,155 +8629,484 @@ declare class SageEmbed extends V1Embed {
8465
8629
  */
8466
8630
  render(): Promise<SageEmbed>;
8467
8631
  }
8468
- /**
8469
- * Pages within the ThoughtSpot app that can be embedded.
8470
- */
8471
- export declare enum Page {
8472
- /**
8473
- * Home page
8474
- */
8475
- Home = "home",
8476
- /**
8477
- * Search page
8478
- */
8479
- Search = "search",
8632
+ interface SearchOptions$2 {
8480
8633
  /**
8481
- * Saved answers listing page
8634
+ * The query string to pass to start the Conversation.
8482
8635
  */
8483
- Answers = "answers",
8636
+ searchQuery: string;
8637
+ }
8638
+ /**
8639
+ * Configuration for the Spotter sidebar.
8640
+ * Can be used in SpotterEmbed and AppEmbed.
8641
+ * @group Embed components
8642
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8643
+ */
8644
+ export interface SpotterSidebarViewConfig {
8484
8645
  /**
8485
- * Liveboards listing page
8646
+ * Controls the visibility of the past conversations sidebar.
8647
+ * @default false
8648
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
8486
8649
  */
8487
- Liveboards = "liveboards",
8650
+ enablePastConversationsSidebar?: boolean;
8488
8651
  /**
8489
- * @hidden
8652
+ * Custom title text for the sidebar header.
8653
+ * Defaults to translated "Spotter" text.
8654
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8490
8655
  */
8491
- Pinboards = "pinboards",
8656
+ spotterSidebarTitle?: string;
8492
8657
  /**
8493
- * Data management page
8658
+ * Boolean to set the default expanded state of the sidebar.
8659
+ * @default false
8660
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8494
8661
  */
8495
- Data = "data",
8662
+ spotterSidebarDefaultExpanded?: boolean;
8496
8663
  /**
8497
- * SpotIQ listing page
8664
+ * Custom label text for the rename action in the conversation edit menu.
8665
+ * Defaults to translated "Rename" text.
8666
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8498
8667
  */
8499
- SpotIQ = "insights",
8668
+ spotterChatRenameLabel?: string;
8500
8669
  /**
8501
- * Monitor Alerts Page
8670
+ * Custom label text for the delete action in the conversation edit menu.
8671
+ * Defaults to translated "DELETE" text.
8672
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8502
8673
  */
8503
- Monitor = "monitor"
8504
- }
8505
- declare enum DataPanelCustomColumnGroupsAccordionState$1 {
8674
+ spotterChatDeleteLabel?: string;
8506
8675
  /**
8507
- * Expand all the accordion initially in data panel v2.
8676
+ * Custom title text for the delete conversation confirmation modal.
8677
+ * Defaults to translated "Delete chat" text.
8678
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8508
8679
  */
8509
- EXPAND_ALL = "EXPAND_ALL",
8680
+ spotterDeleteConversationModalTitle?: string;
8510
8681
  /**
8511
- * Collapse all the accordions initially in data panel v2.
8682
+ * Custom message text for the past conversation banner alert.
8683
+ * Defaults to translated alert message.
8684
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8512
8685
  */
8513
- COLLAPSE_ALL = "COLLAPSE_ALL",
8686
+ spotterPastConversationAlertMessage?: string;
8514
8687
  /**
8515
- * Expand the first accordion and collapse the rest.
8688
+ * Custom URL for the documentation/best practices link.
8689
+ * Defaults to ThoughtSpot docs URL based on release version.
8690
+ * Note: URL must include the protocol (e.g., `https://www.example.com`).
8691
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8516
8692
  */
8517
- EXPAND_FIRST = "EXPAND_FIRST"
8518
- }
8519
- declare enum HomePageSearchBarMode {
8520
- OBJECT_SEARCH = "objectSearch",
8521
- AI_ANSWER = "aiAnswer",
8522
- NONE = "none"
8523
- }
8524
- declare enum PrimaryNavbarVersion {
8693
+ spotterDocumentationUrl?: string;
8525
8694
  /**
8526
- * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
8527
- * along with updates to the top navigation bar.
8528
- * It serves as the foundational version of the PrimaryNavBar.
8695
+ * Custom label text for the best practices button in the footer.
8696
+ * Defaults to translated "Best Practices" text.
8697
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8529
8698
  */
8530
- Sliding = "v3"
8531
- }
8532
- declare enum HomePage {
8699
+ spotterBestPracticesLabel?: string;
8533
8700
  /**
8534
- * Modular (v2) introduces the updated Modular Home Experience.
8535
- * It serves as the foundational version of the home page.
8701
+ * Number of conversations to fetch per batch when loading conversation history.
8702
+ * @default 30
8703
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8536
8704
  */
8537
- Modular = "v2",
8705
+ spotterConversationsBatchSize?: number;
8538
8706
  /**
8539
- * ModularWithStylingChanges (v3) introduces Modular Home Experience
8540
- * with styling changes.
8707
+ * Custom title text for the "New Chat" button in the sidebar.
8708
+ * Defaults to translated "New Chat" text.
8709
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8541
8710
  */
8542
- ModularWithStylingChanges = "v3"
8711
+ spotterNewChatButtonTitle?: string;
8543
8712
  }
8544
- declare enum ListPage {
8713
+ /**
8714
+ * Configuration for customizing Spotter chat UI branding.
8715
+ * @group Embed components
8716
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
8717
+ */
8718
+ export interface SpotterChatViewConfig {
8545
8719
  /**
8546
- * List (v2) is the traditional List Experience.
8547
- * It serves as the foundational version of the list page.
8720
+ * Hides the ThoughtSpot logo/icon in tool response
8721
+ * cards. The branding label prefix is controlled
8722
+ * separately via `toolResponseCardBrandingLabel`.
8723
+ * External MCP tool branding is not affected.
8724
+ * @default false
8548
8725
  */
8549
- List = "v2",
8726
+ hideToolResponseCardBranding?: boolean;
8550
8727
  /**
8551
- * ListWithUXChanges (v3) introduces the new updated list page with UX changes.
8728
+ * Custom label to replace the "ThoughtSpot" prefix
8729
+ * in tool response cards. Set to an empty string
8730
+ * `''` to hide the prefix entirely. Works
8731
+ * independently of `hideToolResponseCardBranding`.
8732
+ * External MCP tool branding is not affected.
8552
8733
  */
8553
- ListWithUXChanges = "v3"
8734
+ toolResponseCardBrandingLabel?: string;
8554
8735
  }
8555
8736
  /**
8556
- * Define the discovery experience
8557
- * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
8737
+ * The configuration for the embedded spotterEmbed options.
8738
+ * @group Embed components
8558
8739
  */
8559
- export interface DiscoveryExperience {
8740
+ export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
8560
8741
  /**
8561
- * primaryNavbarVersion determines the version of the navigation version.
8742
+ * The ID of the data source object. For example, Model, View, or Table. Spotter uses
8743
+ * this object to query data and generate Answers.
8562
8744
  */
8563
- primaryNavbarVersion?: PrimaryNavbarVersion;
8745
+ worksheetId: string;
8564
8746
  /**
8565
- * homePage determines the version of the home page.
8747
+ * Ability to pass a starting search query to the conversation.
8566
8748
  */
8567
- homePage?: HomePage;
8749
+ searchOptions?: SearchOptions$2;
8568
8750
  /**
8569
- * listPageVersion determines the version of the list page.
8751
+ * disableSourceSelection : Disables data source selection
8752
+ * but still display the selected data source.
8753
+ *
8754
+ * Supported embed types: `SpotterEmbed`
8755
+ * @example
8756
+ * ```js
8757
+ * const embed = new SpotterEmbed('#tsEmbed', {
8758
+ * ... //other embed view config
8759
+ * disableSourceSelection : true,
8760
+ * })
8761
+ * ```
8762
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8570
8763
  */
8571
- listPageVersion?: ListPage;
8572
- }
8573
- /**
8574
- * The view configuration for full app embedding.
8575
- * @group Embed components
8576
- */
8577
- export interface AppViewConfig extends AllEmbedViewConfig {
8764
+ disableSourceSelection?: boolean;
8578
8765
  /**
8579
- * If true, the top navigation bar within the ThoughtSpot app
8580
- * is displayed. By default, the navigation bar is hidden.
8581
- * This flag also controls the homepage left navigation bar.
8766
+ * hideSourceSelection : Hide data source selection
8582
8767
  *
8583
- * Supported embed types: `AppEmbed`
8584
- * @default true
8585
- * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
8768
+ * Supported embed types: `SpotterEmbed`
8586
8769
  * @example
8587
8770
  * ```js
8588
- * const embed = new AppEmbed('#tsEmbed', {
8589
- * ... // other embed view config
8590
- * showPrimaryNavbar:true,
8771
+ * const embed = new SpotterEmbed('#tsEmbed', {
8772
+ * ... //other embed view config
8773
+ * hideSourceSelection : true,
8591
8774
  * })
8592
8775
  * ```
8776
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8593
8777
  */
8594
- showPrimaryNavbar?: boolean;
8778
+ hideSourceSelection?: boolean;
8595
8779
  /**
8596
- * Control the visibility of the left navigation panel on the home page
8597
- * in the V2 and V3 navigation and home page experience.
8598
- * If `showPrimaryNavbar` is true, that is, if the Global and Homepage
8599
- * navigation bars are visible, this flag will only hide the left navigation bar
8600
- * on the home page.
8601
- * The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
8602
- *
8603
- * **Note**: This attribute is not supported in the classic (V1) experience.
8780
+ * Flag to control Data panel experience
8604
8781
  *
8605
- * Supported embed types: `AppEmbed`
8606
- * @default false
8607
- * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
8782
+ * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
8783
+ * @default true
8784
+ * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
8608
8785
  * @example
8609
8786
  * ```js
8610
- * const embed = new AppEmbed('#tsEmbed', {
8787
+ * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
8788
+ * const embed = new <EmbedComponent>('#tsEmbed', {
8611
8789
  * ... // other embed view config
8612
- * hideHomepageLeftNav : true,
8790
+ * dataPanelV2: true,
8613
8791
  * })
8614
8792
  * ```
8615
8793
  */
8616
- hideHomepageLeftNav?: boolean;
8794
+ dataPanelV2?: boolean;
8795
+ /**
8796
+ * showSpotterLimitations : show limitation text
8797
+ * of the spotter underneath the chat input.
8798
+ * default is false.
8799
+ *
8800
+ * Supported embed types: `SpotterEmbed`
8801
+ * @example
8802
+ * ```js
8803
+ * const embed = new SpotterEmbed('#tsEmbed', {
8804
+ * ... //other embed view config
8805
+ * showSpotterLimitations : true,
8806
+ * })
8807
+ * ```
8808
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
8809
+ */
8810
+ showSpotterLimitations?: boolean;
8811
+ /**
8812
+ * hideSampleQuestions : Hide sample questions on
8813
+ * the initial screen of the conversation.
8814
+ *
8815
+ * Supported embed types: `SpotterEmbed`
8816
+ * @example
8817
+ * ```js
8818
+ * const embed = new SpotterEmbed('#tsEmbed', {
8819
+ * ... //other embed view config
8820
+ * hideSampleQuestions : true,
8821
+ * })
8822
+ * ```
8823
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
8824
+ */
8825
+ hideSampleQuestions?: boolean;
8826
+ /**
8827
+ * The list of runtime filters to apply to a search Answer,
8828
+ * visualization, or Liveboard.
8829
+ *
8830
+ * Supported embed types: `SpotterEmbed`
8831
+ * @example
8832
+ * ```js
8833
+ * const embed = new SpotterEmbed('#tsEmbed', {
8834
+ * // other embed view config
8835
+ * runtimeFilters: [
8836
+ * {
8837
+ * columnName: 'color',
8838
+ * operator: RuntimeFilterOp.EQ,
8839
+ * values: ['red'],
8840
+ * },
8841
+ * ],
8842
+ * })
8843
+ * ```
8844
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8845
+ */
8846
+ runtimeFilters?: RuntimeFilter[];
8847
+ /**
8848
+ * Flag to control whether runtime filters should be included in the URL.
8849
+ * If true, filters will be passed via app initialization payload
8850
+ * (default behavior from SDK 1.45.0).
8851
+ * If false/undefined, filters are appended to the iframe URL instead.
8852
+ * (default behavior before SDK 1.45.0).
8853
+ *
8854
+ * Supported embed types: `SpotterEmbed`
8855
+ * @default true
8856
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8857
+ */
8858
+ excludeRuntimeFiltersfromURL?: boolean;
8859
+ /**
8860
+ * The list of runtime parameters to apply to the conversation.
8861
+ *
8862
+ * Supported embed types: `SpotterEmbed`
8863
+ * @example
8864
+ * ```js
8865
+ * const embed = new SpotterEmbed('#tsEmbed', {
8866
+ * // other embed view config
8867
+ * runtimeParameters: [
8868
+ * {
8869
+ * name: 'Integer Param',
8870
+ * value: 10,
8871
+ * },
8872
+ * ],
8873
+ * })
8874
+ * ```
8875
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8876
+ */
8877
+ runtimeParameters?: RuntimeParameter[];
8878
+ /**
8879
+ * Flag to control whether runtime parameters should be included in the URL.
8880
+ * If true, parameters will be passed via app
8881
+ * initialization payload (default behavior from SDK 1.45.0).
8882
+ * If false/undefined, parameters are appended to
8883
+ * the iframe URL instead (default behavior before SDK 1.45.0).
8884
+ *
8885
+ * Supported embed types: `SpotterEmbed`
8886
+ * @default true
8887
+ * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
8888
+ */
8889
+ excludeRuntimeParametersfromURL?: boolean;
8890
+ /**
8891
+ * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
8892
+ *
8893
+ * Supported embed types: `SpotterEmbed`
8894
+ * @default false
8895
+ * @example
8896
+ * ```js
8897
+ * const embed = new SpotterEmbed('#tsEmbed', {
8898
+ * ... //other embed view config
8899
+ * updatedSpotterChatPrompt : true,
8900
+ * })
8901
+ * ```
8902
+ * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
8903
+ */
8904
+ updatedSpotterChatPrompt?: boolean;
8905
+ /**
8906
+ * Configuration for the Spotter sidebar UI customization.
8907
+ *
8908
+ * Supported embed types: `SpotterEmbed`, `AppEmbed`
8909
+ * @example
8910
+ * ```js
8911
+ * const embed = new SpotterEmbed('#tsEmbed', {
8912
+ * ... //other embed view config
8913
+ * spotterSidebarConfig: {
8914
+ * enablePastConversationsSidebar: true,
8915
+ * spotterSidebarTitle: 'My Conversations',
8916
+ * spotterSidebarDefaultExpanded: true,
8917
+ * },
8918
+ * })
8919
+ * ```
8920
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
8921
+ */
8922
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
8923
+ /**
8924
+ * Configuration for customizing Spotter chat UI
8925
+ * branding in tool response cards.
8926
+ *
8927
+ * Supported embed types: `SpotterEmbed`
8928
+ * @example
8929
+ * ```js
8930
+ * const embed = new SpotterEmbed('#tsEmbed', {
8931
+ * ... //other embed view config
8932
+ * spotterChatConfig: {
8933
+ * hideToolResponseCardBranding: true,
8934
+ * toolResponseCardBrandingLabel: 'MyBrand',
8935
+ * },
8936
+ * })
8937
+ * ```
8938
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
8939
+ */
8940
+ spotterChatConfig?: SpotterChatViewConfig;
8941
+ }
8942
+ /**
8943
+ * The configuration for the embedded spotterEmbed options.
8944
+ * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
8945
+ * Use {@link SpotterEmbedViewConfig} instead
8946
+ * @group Embed components
8947
+ */
8948
+ export interface ConversationViewConfig extends SpotterEmbedViewConfig {
8949
+ }
8950
+ declare class SpotterEmbed extends TsEmbed {
8951
+ protected viewConfig: SpotterEmbedViewConfig;
8952
+ constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
8953
+ protected getEmbedParamsObject(): Record<any, any>;
8954
+ getIframeSrc(): string;
8955
+ render(): Promise<SpotterEmbed>;
8956
+ }
8957
+ declare class ConversationEmbed extends SpotterEmbed {
8958
+ protected viewConfig: ConversationViewConfig;
8959
+ constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
8960
+ }
8961
+ /**
8962
+ * Pages within the ThoughtSpot app that can be embedded.
8963
+ */
8964
+ export declare enum Page {
8965
+ /**
8966
+ * Home page
8967
+ */
8968
+ Home = "home",
8969
+ /**
8970
+ * Search page
8971
+ */
8972
+ Search = "search",
8973
+ /**
8974
+ * Saved answers listing page
8975
+ */
8976
+ Answers = "answers",
8977
+ /**
8978
+ * Liveboards listing page
8979
+ */
8980
+ Liveboards = "liveboards",
8981
+ /**
8982
+ * @hidden
8983
+ */
8984
+ Pinboards = "pinboards",
8985
+ /**
8986
+ * Data management page
8987
+ */
8988
+ Data = "data",
8989
+ /**
8990
+ * SpotIQ listing page
8991
+ */
8992
+ SpotIQ = "insights",
8993
+ /**
8994
+ * Monitor Alerts Page
8995
+ */
8996
+ Monitor = "monitor"
8997
+ }
8998
+ declare enum DataPanelCustomColumnGroupsAccordionState$1 {
8999
+ /**
9000
+ * Expand all the accordion initially in data panel v2.
9001
+ */
9002
+ EXPAND_ALL = "EXPAND_ALL",
9003
+ /**
9004
+ * Collapse all the accordions initially in data panel v2.
9005
+ */
9006
+ COLLAPSE_ALL = "COLLAPSE_ALL",
9007
+ /**
9008
+ * Expand the first accordion and collapse the rest.
9009
+ */
9010
+ EXPAND_FIRST = "EXPAND_FIRST"
9011
+ }
9012
+ declare enum HomePageSearchBarMode {
9013
+ OBJECT_SEARCH = "objectSearch",
9014
+ AI_ANSWER = "aiAnswer",
9015
+ NONE = "none"
9016
+ }
9017
+ declare enum PrimaryNavbarVersion {
9018
+ /**
9019
+ * Sliding (v3) introduces a new left-side navigation hub featuring a tab switcher,
9020
+ * along with updates to the top navigation bar.
9021
+ * It serves as the foundational version of the PrimaryNavBar.
9022
+ */
9023
+ Sliding = "v3"
9024
+ }
9025
+ declare enum HomePage {
9026
+ /**
9027
+ * Modular (v2) introduces the updated Modular Home Experience.
9028
+ * It serves as the foundational version of the home page.
9029
+ */
9030
+ Modular = "v2",
9031
+ /**
9032
+ * ModularWithStylingChanges (v3) introduces Modular Home Experience
9033
+ * with styling changes.
9034
+ */
9035
+ ModularWithStylingChanges = "v3"
9036
+ }
9037
+ declare enum ListPage {
9038
+ /**
9039
+ * List (v2) is the traditional List Experience.
9040
+ * It serves as the foundational version of the list page.
9041
+ */
9042
+ List = "v2",
9043
+ /**
9044
+ * ListWithUXChanges (v3) introduces the new updated list page with UX changes.
9045
+ */
9046
+ ListWithUXChanges = "v3"
9047
+ }
9048
+ /**
9049
+ * Define the discovery experience
9050
+ * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
9051
+ */
9052
+ export interface DiscoveryExperience {
9053
+ /**
9054
+ * primaryNavbarVersion determines the version of the navigation version.
9055
+ */
9056
+ primaryNavbarVersion?: PrimaryNavbarVersion;
9057
+ /**
9058
+ * homePage determines the version of the home page.
9059
+ */
9060
+ homePage?: HomePage;
9061
+ /**
9062
+ * listPageVersion determines the version of the list page.
9063
+ */
9064
+ listPageVersion?: ListPage;
9065
+ }
9066
+ /**
9067
+ * The view configuration for full app embedding.
9068
+ * @group Embed components
9069
+ */
9070
+ export interface AppViewConfig extends AllEmbedViewConfig {
9071
+ /**
9072
+ * If true, the top navigation bar within the ThoughtSpot app
9073
+ * is displayed. By default, the navigation bar is hidden.
9074
+ * This flag also controls the homepage left navigation bar.
9075
+ *
9076
+ * Supported embed types: `AppEmbed`
9077
+ * @default true
9078
+ * @version SDK: 1.2.0 | ThoughtSpot: 8.4.0.cl
9079
+ * @example
9080
+ * ```js
9081
+ * const embed = new AppEmbed('#tsEmbed', {
9082
+ * ... // other embed view config
9083
+ * showPrimaryNavbar:true,
9084
+ * })
9085
+ * ```
9086
+ */
9087
+ showPrimaryNavbar?: boolean;
9088
+ /**
9089
+ * Control the visibility of the left navigation panel on the home page
9090
+ * in the V2 and V3 navigation and home page experience.
9091
+ * If `showPrimaryNavbar` is true, that is, if the Global and Homepage
9092
+ * navigation bars are visible, this flag will only hide the left navigation bar
9093
+ * on the home page.
9094
+ * The `showPrimaryNavbar` flag takes precedence over the `hideHomepageLeftNav`.
9095
+ *
9096
+ * **Note**: This attribute is not supported in the classic (V1) experience.
9097
+ *
9098
+ * Supported embed types: `AppEmbed`
9099
+ * @default false
9100
+ * @version SDK: 1.28.0 | ThoughtSpot: 9.12.5.cl
9101
+ * @example
9102
+ * ```js
9103
+ * const embed = new AppEmbed('#tsEmbed', {
9104
+ * ... // other embed view config
9105
+ * hideHomepageLeftNav : true,
9106
+ * })
9107
+ * ```
9108
+ */
9109
+ hideHomepageLeftNav?: boolean;
8617
9110
  /**
8618
9111
  * Control the visibility of the help (?) and profile
8619
9112
  * buttons on the top navigation bar.
@@ -9086,6 +9579,42 @@ export interface AppViewConfig extends AllEmbedViewConfig {
9086
9579
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9087
9580
  */
9088
9581
  updatedSpotterChatPrompt?: boolean;
9582
+ /**
9583
+ * Configuration for the Spotter sidebar UI customization.
9584
+ * Only applicable when navigating to Spotter within the app.
9585
+ *
9586
+ * Supported embed types: `AppEmbed`
9587
+ * @example
9588
+ * ```js
9589
+ * const embed = new AppEmbed('#tsEmbed', {
9590
+ * ... //other embed view config
9591
+ * spotterSidebarConfig: {
9592
+ * enablePastConversationsSidebar: true,
9593
+ * spotterSidebarTitle: 'My Conversations',
9594
+ * },
9595
+ * })
9596
+ * ```
9597
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.3.0.cl
9598
+ */
9599
+ spotterSidebarConfig?: SpotterSidebarViewConfig;
9600
+ /**
9601
+ * Configuration for customizing Spotter chat UI
9602
+ * branding in tool response cards.
9603
+ *
9604
+ * Supported embed types: `AppEmbed`
9605
+ * @example
9606
+ * ```js
9607
+ * const embed = new AppEmbed('#tsEmbed', {
9608
+ * ... //other embed view config
9609
+ * spotterChatConfig: {
9610
+ * hideToolResponseCardBranding: true,
9611
+ * toolResponseCardBrandingLabel: 'MyBrand',
9612
+ * },
9613
+ * })
9614
+ * ```
9615
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9616
+ */
9617
+ spotterChatConfig?: SpotterChatViewConfig;
9089
9618
  /**
9090
9619
  * This is the minimum height (in pixels) for a full-height App.
9091
9620
  * Setting this height helps resolve issues with empty Apps and
@@ -9350,6 +9879,23 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9350
9879
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
9351
9880
  */
9352
9881
  activeTabId?: string;
9882
+ /**
9883
+ * The GUID of a saved personalized view to load.
9884
+ * A personalized view is a saved configuration of a Liveboard
9885
+ * that includes specific filter selections.
9886
+ *
9887
+ * Supported embed types: `LiveboardEmbed`
9888
+ * @example
9889
+ * ```js
9890
+ * const embed = new LiveboardEmbed('#tsEmbed', {
9891
+ * liveboardId: 'liveboard-guid',
9892
+ * personalizedViewId: 'view-guid',
9893
+ * activeTabId: 'tab-guid',
9894
+ * })
9895
+ * ```
9896
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
9897
+ */
9898
+ personalizedViewId?: string;
9353
9899
  /**
9354
9900
  * Show or hide the tab panel of the embedded Liveboard.
9355
9901
  *
@@ -9603,6 +10149,24 @@ export interface LiveboardViewConfig extends BaseViewConfig, SearchLiveboardComm
9603
10149
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9604
10150
  */
9605
10151
  updatedSpotterChatPrompt?: boolean;
10152
+ /**
10153
+ * Configuration for customizing Spotter chat UI
10154
+ * branding in tool response cards.
10155
+ *
10156
+ * Supported embed types: `LiveboardEmbed`
10157
+ * @example
10158
+ * ```js
10159
+ * const embed = new LiveboardEmbed('#tsEmbed', {
10160
+ * ... //other embed view config
10161
+ * spotterChatConfig: {
10162
+ * hideToolResponseCardBranding: true,
10163
+ * toolResponseCardBrandingLabel: 'MyBrand',
10164
+ * },
10165
+ * })
10166
+ * ```
10167
+ * @version SDK: 1.46.0 | ThoughtSpot: 26.4.0.cl
10168
+ */
10169
+ spotterChatConfig?: SpotterChatViewConfig;
9606
10170
  }
9607
10171
  declare class LiveboardEmbed extends V1Embed {
9608
10172
  protected viewConfig: LiveboardViewConfig;
@@ -9647,6 +10211,7 @@ declare class LiveboardEmbed extends V1Embed {
9647
10211
  liveboardId: string;
9648
10212
  vizId: string;
9649
10213
  activeTabId: string;
10214
+ personalizedViewId: string;
9650
10215
  };
9651
10216
  protected beforePrerenderVisible(): void;
9652
10217
  protected handleRenderForPrerender(): Promise<TsEmbed>;
@@ -9671,7 +10236,7 @@ declare class LiveboardEmbed extends V1Embed {
9671
10236
  * visualization ID and the runtime filters.
9672
10237
  */
9673
10238
  render(): Promise<LiveboardEmbed>;
9674
- navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
10239
+ navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string, personalizedViewId?: string): void;
9675
10240
  /**
9676
10241
  * Returns the full url of the Liveboard/visualization which can be used to open
9677
10242
  * this Liveboard inside the full ThoughtSpot application in a new tab.
@@ -9713,217 +10278,6 @@ export interface EmbedProps extends EmbedViewConfig {
9713
10278
  className?: string;
9714
10279
  style?: React$1.CSSProperties;
9715
10280
  }
9716
- interface SearchOptions$2 {
9717
- /**
9718
- * The query string to pass to start the Conversation.
9719
- */
9720
- searchQuery: string;
9721
- }
9722
- /**
9723
- * The configuration for the embedded spotterEmbed options.
9724
- * @group Embed components
9725
- */
9726
- export interface SpotterEmbedViewConfig extends Omit<BaseViewConfig, "primaryAction"> {
9727
- /**
9728
- * The ID of the data source object. For example, Model, View, or Table. Spotter uses
9729
- * this object to query data and generate Answers.
9730
- */
9731
- worksheetId: string;
9732
- /**
9733
- * Ability to pass a starting search query to the conversation.
9734
- */
9735
- searchOptions?: SearchOptions$2;
9736
- /**
9737
- * disableSourceSelection : Disables data source selection
9738
- * but still display the selected data source.
9739
- *
9740
- * Supported embed types: `SpotterEmbed`
9741
- * @example
9742
- * ```js
9743
- * const embed = new SpotterEmbed('#tsEmbed', {
9744
- * ... //other embed view config
9745
- * disableSourceSelection : true,
9746
- * })
9747
- * ```
9748
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9749
- */
9750
- disableSourceSelection?: boolean;
9751
- /**
9752
- * hideSourceSelection : Hide data source selection
9753
- *
9754
- * Supported embed types: `SpotterEmbed`
9755
- * @example
9756
- * ```js
9757
- * const embed = new SpotterEmbed('#tsEmbed', {
9758
- * ... //other embed view config
9759
- * hideSourceSelection : true,
9760
- * })
9761
- * ```
9762
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9763
- */
9764
- hideSourceSelection?: boolean;
9765
- /**
9766
- * Flag to control Data panel experience
9767
- *
9768
- * Supported embed types: `SageEmbed`, `AppEmbed`, `SearchBarEmbed`, `LiveboardEmbed`, `SearchEmbed`
9769
- * @default true
9770
- * @version SDK: 1.41.1 | ThoughtSpot Cloud: 10.14.0.cl
9771
- * @example
9772
- * ```js
9773
- * // Replace <EmbedComponent> with embed component name. For example, SageEmbed, AppEmbed, or SearchBarEmbed
9774
- * const embed = new <EmbedComponent>('#tsEmbed', {
9775
- * ... // other embed view config
9776
- * dataPanelV2: true,
9777
- * })
9778
- * ```
9779
- */
9780
- dataPanelV2?: boolean;
9781
- /**
9782
- * showSpotterLimitations : show limitation text
9783
- * of the spotter underneath the chat input.
9784
- * default is false.
9785
- *
9786
- * Supported embed types: `SpotterEmbed`
9787
- * @example
9788
- * ```js
9789
- * const embed = new SpotterEmbed('#tsEmbed', {
9790
- * ... //other embed view config
9791
- * showSpotterLimitations : true,
9792
- * })
9793
- * ```
9794
- * @version SDK: 1.36.0 | ThoughtSpot: 10.5.0.cl
9795
- */
9796
- showSpotterLimitations?: boolean;
9797
- /**
9798
- * hideSampleQuestions : Hide sample questions on
9799
- * the initial screen of the conversation.
9800
- *
9801
- * Supported embed types: `SpotterEmbed`
9802
- * @example
9803
- * ```js
9804
- * const embed = new SpotterEmbed('#tsEmbed', {
9805
- * ... //other embed view config
9806
- * hideSampleQuestions : true,
9807
- * })
9808
- * ```
9809
- * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
9810
- */
9811
- hideSampleQuestions?: boolean;
9812
- /**
9813
- * The list of runtime filters to apply to a search Answer,
9814
- * visualization, or Liveboard.
9815
- *
9816
- * Supported embed types: `SpotterEmbed`
9817
- * @example
9818
- * ```js
9819
- * const embed = new SpotterEmbed('#tsEmbed', {
9820
- * // other embed view config
9821
- * runtimeFilters: [
9822
- * {
9823
- * columnName: 'color',
9824
- * operator: RuntimeFilterOp.EQ,
9825
- * values: ['red'],
9826
- * },
9827
- * ],
9828
- * })
9829
- * ```
9830
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9831
- */
9832
- runtimeFilters?: RuntimeFilter[];
9833
- /**
9834
- * Flag to control whether runtime filters should be included in the URL.
9835
- * If true, filters will be passed via app initialization payload
9836
- * (default behavior from SDK 1.45.0).
9837
- * If false/undefined, filters are appended to the iframe URL instead.
9838
- * (default behavior before SDK 1.45.0).
9839
- *
9840
- * Supported embed types: `SpotterEmbed`
9841
- * @default true
9842
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9843
- */
9844
- excludeRuntimeFiltersfromURL?: boolean;
9845
- /**
9846
- * The list of runtime parameters to apply to the conversation.
9847
- *
9848
- * Supported embed types: `SpotterEmbed`
9849
- * @example
9850
- * ```js
9851
- * const embed = new SpotterEmbed('#tsEmbed', {
9852
- * // other embed view config
9853
- * runtimeParameters: [
9854
- * {
9855
- * name: 'Integer Param',
9856
- * value: 10,
9857
- * },
9858
- * ],
9859
- * })
9860
- * ```
9861
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9862
- */
9863
- runtimeParameters?: RuntimeParameter[];
9864
- /**
9865
- * Flag to control whether runtime parameters should be included in the URL.
9866
- * If true, parameters will be passed via app
9867
- * initialization payload (default behavior from SDK 1.45.0).
9868
- * If false/undefined, parameters are appended to
9869
- * the iframe URL instead (default behavior before SDK 1.45.0).
9870
- *
9871
- * Supported embed types: `SpotterEmbed`
9872
- * @default true
9873
- * @version SDK: 1.41.0 | ThoughtSpot: 10.13.0.cl
9874
- */
9875
- excludeRuntimeParametersfromURL?: boolean;
9876
- /**
9877
- * enablePastConversationsSidebar : Controls the visibility of the past conversations
9878
- * sidebar.
9879
- *
9880
- * Supported embed types: `SpotterEmbed`
9881
- * @default false
9882
- * @example
9883
- * ```js
9884
- * const embed = new SpotterEmbed('#tsEmbed', {
9885
- * ... //other embed view config
9886
- * enablePastConversationsSidebar : true,
9887
- * })
9888
- * ```
9889
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9890
- */
9891
- enablePastConversationsSidebar?: boolean;
9892
- /**
9893
- * updatedSpotterChatPrompt : Controls the updated spotter chat prompt.
9894
- *
9895
- * Supported embed types: `SpotterEmbed`
9896
- * @default false
9897
- * @example
9898
- * ```js
9899
- * const embed = new SpotterEmbed('#tsEmbed', {
9900
- * ... //other embed view config
9901
- * updatedSpotterChatPrompt : true,
9902
- * })
9903
- * ```
9904
- * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
9905
- */
9906
- updatedSpotterChatPrompt?: boolean;
9907
- }
9908
- /**
9909
- * The configuration for the embedded spotterEmbed options.
9910
- * @deprecated from SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
9911
- * Use {@link SpotterEmbedViewConfig} instead
9912
- * @group Embed components
9913
- */
9914
- export interface ConversationViewConfig extends SpotterEmbedViewConfig {
9915
- }
9916
- declare class SpotterEmbed extends TsEmbed {
9917
- protected viewConfig: SpotterEmbedViewConfig;
9918
- constructor(container: HTMLElement, viewConfig: SpotterEmbedViewConfig);
9919
- protected getEmbedParamsObject(): Record<any, any>;
9920
- getIframeSrc(): string;
9921
- render(): Promise<SpotterEmbed>;
9922
- }
9923
- declare class ConversationEmbed extends SpotterEmbed {
9924
- protected viewConfig: ConversationViewConfig;
9925
- constructor(container: HTMLElement, viewConfig: ConversationViewConfig);
9926
- }
9927
10281
  export type SessionInfo = {
9928
10282
  releaseVersion: string;
9929
10283
  userGUID: string;