@thoughtspot/visual-embed-sdk 1.33.3 → 1.33.4

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 (96) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/embed/app.d.ts +20 -6
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +3 -2
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/app.spec.js +10 -0
  7. package/cjs/src/embed/app.spec.js.map +1 -1
  8. package/cjs/src/embed/base.spec.js +13 -1
  9. package/cjs/src/embed/base.spec.js.map +1 -1
  10. package/cjs/src/embed/conversation.d.ts.map +1 -1
  11. package/cjs/src/embed/conversation.js +4 -0
  12. package/cjs/src/embed/conversation.js.map +1 -1
  13. package/cjs/src/embed/conversation.spec.js +13 -0
  14. package/cjs/src/embed/conversation.spec.js.map +1 -1
  15. package/cjs/src/embed/liveboard.js +1 -1
  16. package/cjs/src/embed/liveboard.js.map +1 -1
  17. package/cjs/src/embed/liveboard.spec.js +2 -2
  18. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  19. package/cjs/src/embed/search.js +1 -1
  20. package/cjs/src/embed/search.js.map +1 -1
  21. package/cjs/src/embed/search.spec.js +6 -6
  22. package/cjs/src/embed/search.spec.js.map +1 -1
  23. package/cjs/src/embed/ts-embed.spec.js +1 -1
  24. package/cjs/src/errors.d.ts +1 -0
  25. package/cjs/src/errors.d.ts.map +1 -1
  26. package/cjs/src/errors.js +10 -9
  27. package/cjs/src/errors.js.map +1 -1
  28. package/cjs/src/react/index.spec.js +1 -1
  29. package/cjs/src/react/index.spec.js.map +1 -1
  30. package/cjs/src/types.d.ts +34 -19
  31. package/cjs/src/types.d.ts.map +1 -1
  32. package/cjs/src/types.js +29 -14
  33. package/cjs/src/types.js.map +1 -1
  34. package/dist/{index-Ck3m4Sis.js → index-Cl8Rsh6W.js} +1 -1
  35. package/dist/src/embed/app.d.ts +20 -6
  36. package/dist/src/embed/app.d.ts.map +1 -1
  37. package/dist/src/embed/conversation.d.ts.map +1 -1
  38. package/dist/src/errors.d.ts +1 -0
  39. package/dist/src/errors.d.ts.map +1 -1
  40. package/dist/src/types.d.ts +34 -19
  41. package/dist/src/types.d.ts.map +1 -1
  42. package/dist/tsembed-react.es.js +50 -30
  43. package/dist/tsembed-react.js +49 -29
  44. package/dist/tsembed.es.js +50 -30
  45. package/dist/tsembed.js +49 -29
  46. package/dist/visual-embed-sdk-react-full.d.ts +54 -25
  47. package/dist/visual-embed-sdk-react.d.ts +54 -25
  48. package/dist/visual-embed-sdk.d.ts +54 -25
  49. package/lib/package.json +1 -1
  50. package/lib/src/embed/app.d.ts +20 -6
  51. package/lib/src/embed/app.d.ts.map +1 -1
  52. package/lib/src/embed/app.js +3 -2
  53. package/lib/src/embed/app.js.map +1 -1
  54. package/lib/src/embed/app.spec.js +10 -0
  55. package/lib/src/embed/app.spec.js.map +1 -1
  56. package/lib/src/embed/base.spec.js +13 -1
  57. package/lib/src/embed/base.spec.js.map +1 -1
  58. package/lib/src/embed/conversation.d.ts.map +1 -1
  59. package/lib/src/embed/conversation.js +4 -0
  60. package/lib/src/embed/conversation.js.map +1 -1
  61. package/lib/src/embed/conversation.spec.js +13 -0
  62. package/lib/src/embed/conversation.spec.js.map +1 -1
  63. package/lib/src/embed/liveboard.js +1 -1
  64. package/lib/src/embed/liveboard.js.map +1 -1
  65. package/lib/src/embed/liveboard.spec.js +2 -2
  66. package/lib/src/embed/liveboard.spec.js.map +1 -1
  67. package/lib/src/embed/search.js +1 -1
  68. package/lib/src/embed/search.js.map +1 -1
  69. package/lib/src/embed/search.spec.js +6 -6
  70. package/lib/src/embed/search.spec.js.map +1 -1
  71. package/lib/src/embed/ts-embed.spec.js +1 -1
  72. package/lib/src/errors.d.ts +1 -0
  73. package/lib/src/errors.d.ts.map +1 -1
  74. package/lib/src/errors.js +10 -9
  75. package/lib/src/errors.js.map +1 -1
  76. package/lib/src/react/index.spec.js +1 -1
  77. package/lib/src/react/index.spec.js.map +1 -1
  78. package/lib/src/types.d.ts +34 -19
  79. package/lib/src/types.d.ts.map +1 -1
  80. package/lib/src/types.js +29 -14
  81. package/lib/src/types.js.map +1 -1
  82. package/lib/src/visual-embed-sdk.d.ts +54 -25
  83. package/package.json +1 -1
  84. package/src/embed/app.spec.ts +15 -0
  85. package/src/embed/app.ts +23 -7
  86. package/src/embed/base.spec.ts +13 -1
  87. package/src/embed/conversation.spec.ts +16 -0
  88. package/src/embed/conversation.ts +4 -0
  89. package/src/embed/liveboard.spec.ts +2 -2
  90. package/src/embed/liveboard.ts +1 -1
  91. package/src/embed/search.spec.ts +6 -6
  92. package/src/embed/search.ts +1 -1
  93. package/src/embed/ts-embed.spec.ts +1 -1
  94. package/src/errors.ts +10 -9
  95. package/src/react/index.spec.tsx +1 -1
  96. package/src/types.ts +32 -17
@@ -1118,7 +1118,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1118
1118
  */
1119
1119
  dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
1120
1120
  /**
1121
- * This flag is used to enable the 2 column layout in liveboard
1121
+ * This attribute can be used to enable the two-column layout on an embedded Liveboard
1122
1122
  * @type {boolean}
1123
1123
  * @default false
1124
1124
  * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -1132,17 +1132,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1132
1132
  */
1133
1133
  enable2ColumnLayout?: boolean;
1134
1134
  /**
1135
- * Flag to use OnBeforeSearchExecute embed event
1135
+ * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
1136
1136
  * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
1137
1137
  */
1138
1138
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
1139
1139
  /**
1140
1140
  * Flag to use home page search bar mode
1141
- * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
1141
+ * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
1142
1142
  */
1143
1143
  homePageSearchBarMode?: HomePageSearchBarMode;
1144
1144
  /**
1145
- * This flag is used to enable the compact header in liveboard
1145
+ * This flag can be used to enable the compact header in Liveboard
1146
1146
  * @type {boolean}
1147
1147
  * @default false
1148
1148
  * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -1156,7 +1156,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1156
1156
  */
1157
1157
  isLiveboardCompactHeaderEnabled?: boolean;
1158
1158
  /**
1159
- * This flag is used to show/hide verified Icon in liveboard compact header
1159
+ * This flag can be used to show or hide the Liveboard verified icon in the compact header.
1160
1160
  * @type {boolean}
1161
1161
  * @default true
1162
1162
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1170,7 +1170,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1170
1170
  */
1171
1171
  showLiveboardVerifiedBadge?: boolean;
1172
1172
  /**
1173
- * This flag is used to show/hide re-verify banner in liveboard compact header
1173
+ * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
1174
1174
  * @type {boolean}
1175
1175
  * @default true
1176
1176
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1183,6 +1183,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1183
1183
  * ```
1184
1184
  */
1185
1185
  showLiveboardReverifyBanner?: boolean;
1186
+ /**
1187
+ * This flag is used to enable unified search experience for full app embed.
1188
+ * @type {boolean}
1189
+ * @default true
1190
+ * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
1191
+ * @example
1192
+ * ```js
1193
+ * const embed = new AppEmbed('#embed-container', {
1194
+ * ... // other options
1195
+ * isUnifiedSearchExperienceEnabled: true,
1196
+ * })
1197
+ * ```
1198
+ */
1199
+ isUnifiedSearchExperienceEnabled?: boolean;
1186
1200
  }
1187
1201
  /**
1188
1202
  * Embeds full ThoughtSpot experience in a host application.
@@ -3016,7 +3030,7 @@ export interface ViewConfig {
3016
3030
  */
3017
3031
  enableV2Shell_experimental?: boolean;
3018
3032
  /**
3019
- * To set the initial state of the search bar in case of saved-answers.
3033
+ * To set the initial state of the search bar in case of saved Answers.
3020
3034
  * @default true
3021
3035
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3022
3036
  * @example
@@ -3029,7 +3043,7 @@ export interface ViewConfig {
3029
3043
  collapseSearchBar?: boolean;
3030
3044
  /**
3031
3045
  * This flag can be used to disable links inside the embedded app,
3032
- * and disables redirection of links in a new tab.
3046
+ * and disable redirection of links in a new tab.
3033
3047
  * @example
3034
3048
  * ```js
3035
3049
  * const embed = new LiveboardEmbed('#embed', {
@@ -3041,7 +3055,7 @@ export interface ViewConfig {
3041
3055
  disableRedirectionLinksInNewTab?: boolean;
3042
3056
  /**
3043
3057
  * Flag to control Data panel experience
3044
- * @default true
3058
+ * @default false
3045
3059
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
3046
3060
  * @example
3047
3061
  * ```js
@@ -4149,22 +4163,26 @@ export declare enum EmbedEvent {
4149
4163
  */
4150
4164
  Rename = "rename",
4151
4165
  /**
4152
- * Emitted if the user wants to intercept the search execution
4153
- * and implement logic to decide whether to run the search or not
4154
4166
  *
4155
- * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
4167
+ * This event can be emitted to intercept search execution initiated by
4168
+ * the users and implement the logic to allow or restrict search execution.
4169
+ * You can can also show custom error text if the search query must be
4170
+ * restricted due to your application or business requirements.
4171
+
4172
+ * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
4156
4173
  * for this embed event to get emitted.
4157
4174
  * @param: payload
4158
4175
  * @param: responder
4159
4176
  * Contains elements that lets developers define whether ThoughtSpot
4160
- * will run the search or not, and if not, which error message to provide.
4177
+ * should run the search, and if not, what error message
4178
+ * should be shown to the user.
4161
4179
  *
4162
- * execute: When execute returns true, the search will be run.
4163
- * When execute returns false, the search will not be executed.
4180
+ * execute: When execute returns `true`, the search will be run.
4181
+ * When execute returns `false`, the search will not be executed.
4164
4182
  *
4165
- * error: Developers can customize the user facing message when execute is
4166
- * set to false using the error parameter in responder
4167
- * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
4183
+ * error: Developers can customize the error message text when `execute`
4184
+ * returns `false` using the error parameter in responder.
4185
+ * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4168
4186
  * @example
4169
4187
  *```js
4170
4188
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -4204,15 +4222,15 @@ export declare enum EmbedEvent {
4204
4222
  */
4205
4223
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
4206
4224
  /**
4207
- * Emitted when parameter changes in an answer
4208
- * or liveboard
4225
+ * Emitted when parameter changes in an Answer
4226
+ * or Liveboard
4209
4227
  *
4210
4228
  * ```js
4211
4229
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
4212
4230
  * console.log('payload', payload);
4213
4231
  * })
4214
4232
  *```
4215
- * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
4233
+ * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
4216
4234
  */
4217
4235
  ParameterChanged = "parameterChanged"
4218
4236
  }
@@ -4942,7 +4960,8 @@ export declare enum HostEvent {
4942
4960
  *
4943
4961
  * `values` - An array of one or several values. The value definition on the
4944
4962
  * data type you choose to filter on. For a complete list of supported data types, see
4945
- * link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types]
4963
+ * link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types].
4964
+ *
4946
4965
  * `type` - To update filters for date time, specify the date format type.
4947
4966
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
4948
4967
  *
@@ -5230,7 +5249,8 @@ export declare enum Param {
5230
5249
  ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
5231
5250
  ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
5232
5251
  LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled",
5233
- SpotterEnabled = "isSpotterExperienceEnabled"
5252
+ SpotterEnabled = "isSpotterExperienceEnabled",
5253
+ IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled"
5234
5254
  }
5235
5255
  /**
5236
5256
  * ThoughtSpot application pages include actions and menu commands
@@ -6200,7 +6220,7 @@ export declare enum Action {
6200
6220
  */
6201
6221
  AIHighlights = "AIHighlights",
6202
6222
  /**
6203
- * Action ID for edit schedule action on schedule on homepage
6223
+ * Action ID for edit the schedule action on schedule on homepage
6204
6224
  * @example
6205
6225
  * ```js
6206
6226
  * disabledActions: [Action.EditScheduleHomepage]
@@ -6261,7 +6281,16 @@ export declare enum Action {
6261
6281
  * ```
6262
6282
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
6263
6283
  */
6264
- KPIAnalysisCTA = "kpiAnalysisCTA"
6284
+ KPIAnalysisCTA = "kpiAnalysisCTA",
6285
+ /**
6286
+ * Action ID for disabling chip reorder in Answer and Liveboard
6287
+ * @example
6288
+ * ```js
6289
+ * const disabledActions = [Action.DisableChipReorder]
6290
+ * ```
6291
+ * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
6292
+ */
6293
+ DisableChipReorder = "disableChipReorder"
6265
6294
  }
6266
6295
  export interface AnswerServiceType {
6267
6296
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -1108,7 +1108,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1108
1108
  */
1109
1109
  dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
1110
1110
  /**
1111
- * This flag is used to enable the 2 column layout in liveboard
1111
+ * This attribute can be used to enable the two-column layout on an embedded Liveboard
1112
1112
  * @type {boolean}
1113
1113
  * @default false
1114
1114
  * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -1122,17 +1122,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1122
1122
  */
1123
1123
  enable2ColumnLayout?: boolean;
1124
1124
  /**
1125
- * Flag to use OnBeforeSearchExecute embed event
1125
+ * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
1126
1126
  * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
1127
1127
  */
1128
1128
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
1129
1129
  /**
1130
1130
  * Flag to use home page search bar mode
1131
- * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
1131
+ * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
1132
1132
  */
1133
1133
  homePageSearchBarMode?: HomePageSearchBarMode;
1134
1134
  /**
1135
- * This flag is used to enable the compact header in liveboard
1135
+ * This flag can be used to enable the compact header in Liveboard
1136
1136
  * @type {boolean}
1137
1137
  * @default false
1138
1138
  * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -1146,7 +1146,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1146
1146
  */
1147
1147
  isLiveboardCompactHeaderEnabled?: boolean;
1148
1148
  /**
1149
- * This flag is used to show/hide verified Icon in liveboard compact header
1149
+ * This flag can be used to show or hide the Liveboard verified icon in the compact header.
1150
1150
  * @type {boolean}
1151
1151
  * @default true
1152
1152
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1160,7 +1160,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1160
1160
  */
1161
1161
  showLiveboardVerifiedBadge?: boolean;
1162
1162
  /**
1163
- * This flag is used to show/hide re-verify banner in liveboard compact header
1163
+ * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
1164
1164
  * @type {boolean}
1165
1165
  * @default true
1166
1166
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -1173,6 +1173,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1173
1173
  * ```
1174
1174
  */
1175
1175
  showLiveboardReverifyBanner?: boolean;
1176
+ /**
1177
+ * This flag is used to enable unified search experience for full app embed.
1178
+ * @type {boolean}
1179
+ * @default true
1180
+ * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
1181
+ * @example
1182
+ * ```js
1183
+ * const embed = new AppEmbed('#embed-container', {
1184
+ * ... // other options
1185
+ * isUnifiedSearchExperienceEnabled: true,
1186
+ * })
1187
+ * ```
1188
+ */
1189
+ isUnifiedSearchExperienceEnabled?: boolean;
1176
1190
  }
1177
1191
  /**
1178
1192
  * Embeds full ThoughtSpot experience in a host application.
@@ -2628,7 +2642,7 @@ export interface ViewConfig {
2628
2642
  */
2629
2643
  enableV2Shell_experimental?: boolean;
2630
2644
  /**
2631
- * To set the initial state of the search bar in case of saved-answers.
2645
+ * To set the initial state of the search bar in case of saved Answers.
2632
2646
  * @default true
2633
2647
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2634
2648
  * @example
@@ -2641,7 +2655,7 @@ export interface ViewConfig {
2641
2655
  collapseSearchBar?: boolean;
2642
2656
  /**
2643
2657
  * This flag can be used to disable links inside the embedded app,
2644
- * and disables redirection of links in a new tab.
2658
+ * and disable redirection of links in a new tab.
2645
2659
  * @example
2646
2660
  * ```js
2647
2661
  * const embed = new LiveboardEmbed('#embed', {
@@ -2653,7 +2667,7 @@ export interface ViewConfig {
2653
2667
  disableRedirectionLinksInNewTab?: boolean;
2654
2668
  /**
2655
2669
  * Flag to control Data panel experience
2656
- * @default true
2670
+ * @default false
2657
2671
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2658
2672
  * @example
2659
2673
  * ```js
@@ -3761,22 +3775,26 @@ export declare enum EmbedEvent {
3761
3775
  */
3762
3776
  Rename = "rename",
3763
3777
  /**
3764
- * Emitted if the user wants to intercept the search execution
3765
- * and implement logic to decide whether to run the search or not
3766
3778
  *
3767
- * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
3779
+ * This event can be emitted to intercept search execution initiated by
3780
+ * the users and implement the logic to allow or restrict search execution.
3781
+ * You can can also show custom error text if the search query must be
3782
+ * restricted due to your application or business requirements.
3783
+
3784
+ * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
3768
3785
  * for this embed event to get emitted.
3769
3786
  * @param: payload
3770
3787
  * @param: responder
3771
3788
  * Contains elements that lets developers define whether ThoughtSpot
3772
- * will run the search or not, and if not, which error message to provide.
3789
+ * should run the search, and if not, what error message
3790
+ * should be shown to the user.
3773
3791
  *
3774
- * execute: When execute returns true, the search will be run.
3775
- * When execute returns false, the search will not be executed.
3792
+ * execute: When execute returns `true`, the search will be run.
3793
+ * When execute returns `false`, the search will not be executed.
3776
3794
  *
3777
- * error: Developers can customize the user facing message when execute is
3778
- * set to false using the error parameter in responder
3779
- * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
3795
+ * error: Developers can customize the error message text when `execute`
3796
+ * returns `false` using the error parameter in responder.
3797
+ * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
3780
3798
  * @example
3781
3799
  *```js
3782
3800
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -3816,15 +3834,15 @@ export declare enum EmbedEvent {
3816
3834
  */
3817
3835
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
3818
3836
  /**
3819
- * Emitted when parameter changes in an answer
3820
- * or liveboard
3837
+ * Emitted when parameter changes in an Answer
3838
+ * or Liveboard
3821
3839
  *
3822
3840
  * ```js
3823
3841
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
3824
3842
  * console.log('payload', payload);
3825
3843
  * })
3826
3844
  *```
3827
- * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
3845
+ * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
3828
3846
  */
3829
3847
  ParameterChanged = "parameterChanged"
3830
3848
  }
@@ -4554,7 +4572,8 @@ export declare enum HostEvent {
4554
4572
  *
4555
4573
  * `values` - An array of one or several values. The value definition on the
4556
4574
  * data type you choose to filter on. For a complete list of supported data types, see
4557
- * link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types]
4575
+ * link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types].
4576
+ *
4558
4577
  * `type` - To update filters for date time, specify the date format type.
4559
4578
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
4560
4579
  *
@@ -4842,7 +4861,8 @@ export declare enum Param {
4842
4861
  ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
4843
4862
  ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
4844
4863
  LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled",
4845
- SpotterEnabled = "isSpotterExperienceEnabled"
4864
+ SpotterEnabled = "isSpotterExperienceEnabled",
4865
+ IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled"
4846
4866
  }
4847
4867
  /**
4848
4868
  * ThoughtSpot application pages include actions and menu commands
@@ -5812,7 +5832,7 @@ export declare enum Action {
5812
5832
  */
5813
5833
  AIHighlights = "AIHighlights",
5814
5834
  /**
5815
- * Action ID for edit schedule action on schedule on homepage
5835
+ * Action ID for edit the schedule action on schedule on homepage
5816
5836
  * @example
5817
5837
  * ```js
5818
5838
  * disabledActions: [Action.EditScheduleHomepage]
@@ -5873,7 +5893,16 @@ export declare enum Action {
5873
5893
  * ```
5874
5894
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5875
5895
  */
5876
- KPIAnalysisCTA = "kpiAnalysisCTA"
5896
+ KPIAnalysisCTA = "kpiAnalysisCTA",
5897
+ /**
5898
+ * Action ID for disabling chip reorder in Answer and Liveboard
5899
+ * @example
5900
+ * ```js
5901
+ * const disabledActions = [Action.DisableChipReorder]
5902
+ * ```
5903
+ * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
5904
+ */
5905
+ DisableChipReorder = "disableChipReorder"
5877
5906
  }
5878
5907
  export interface AnswerServiceType {
5879
5908
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -366,7 +366,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
366
366
  */
367
367
  dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
368
368
  /**
369
- * This flag is used to enable the 2 column layout in liveboard
369
+ * This attribute can be used to enable the two-column layout on an embedded Liveboard
370
370
  * @type {boolean}
371
371
  * @default false
372
372
  * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -380,17 +380,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
380
380
  */
381
381
  enable2ColumnLayout?: boolean;
382
382
  /**
383
- * Flag to use OnBeforeSearchExecute embed event
383
+ * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
384
384
  * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
385
385
  */
386
386
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
387
387
  /**
388
388
  * Flag to use home page search bar mode
389
- * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
389
+ * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
390
390
  */
391
391
  homePageSearchBarMode?: HomePageSearchBarMode;
392
392
  /**
393
- * This flag is used to enable the compact header in liveboard
393
+ * This flag can be used to enable the compact header in Liveboard
394
394
  * @type {boolean}
395
395
  * @default false
396
396
  * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -404,7 +404,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
404
404
  */
405
405
  isLiveboardCompactHeaderEnabled?: boolean;
406
406
  /**
407
- * This flag is used to show/hide verified Icon in liveboard compact header
407
+ * This flag can be used to show or hide the Liveboard verified icon in the compact header.
408
408
  * @type {boolean}
409
409
  * @default true
410
410
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -418,7 +418,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
418
418
  */
419
419
  showLiveboardVerifiedBadge?: boolean;
420
420
  /**
421
- * This flag is used to show/hide re-verify banner in liveboard compact header
421
+ * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
422
422
  * @type {boolean}
423
423
  * @default true
424
424
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -431,6 +431,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
431
431
  * ```
432
432
  */
433
433
  showLiveboardReverifyBanner?: boolean;
434
+ /**
435
+ * This flag is used to enable unified search experience for full app embed.
436
+ * @type {boolean}
437
+ * @default true
438
+ * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
439
+ * @example
440
+ * ```js
441
+ * const embed = new AppEmbed('#embed-container', {
442
+ * ... // other options
443
+ * isUnifiedSearchExperienceEnabled: true,
444
+ * })
445
+ * ```
446
+ */
447
+ isUnifiedSearchExperienceEnabled?: boolean;
434
448
  }
435
449
  /**
436
450
  * Embeds full ThoughtSpot experience in a host application.
@@ -2605,7 +2619,7 @@ export interface ViewConfig {
2605
2619
  */
2606
2620
  enableV2Shell_experimental?: boolean;
2607
2621
  /**
2608
- * To set the initial state of the search bar in case of saved-answers.
2622
+ * To set the initial state of the search bar in case of saved Answers.
2609
2623
  * @default true
2610
2624
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2611
2625
  * @example
@@ -2618,7 +2632,7 @@ export interface ViewConfig {
2618
2632
  collapseSearchBar?: boolean;
2619
2633
  /**
2620
2634
  * This flag can be used to disable links inside the embedded app,
2621
- * and disables redirection of links in a new tab.
2635
+ * and disable redirection of links in a new tab.
2622
2636
  * @example
2623
2637
  * ```js
2624
2638
  * const embed = new LiveboardEmbed('#embed', {
@@ -2630,7 +2644,7 @@ export interface ViewConfig {
2630
2644
  disableRedirectionLinksInNewTab?: boolean;
2631
2645
  /**
2632
2646
  * Flag to control Data panel experience
2633
- * @default true
2647
+ * @default false
2634
2648
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2635
2649
  * @example
2636
2650
  * ```js
@@ -3738,22 +3752,26 @@ export enum EmbedEvent {
3738
3752
  */
3739
3753
  Rename = "rename",
3740
3754
  /**
3741
- * Emitted if the user wants to intercept the search execution
3742
- * and implement logic to decide whether to run the search or not
3743
3755
  *
3744
- * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
3756
+ * This event can be emitted to intercept search execution initiated by
3757
+ * the users and implement the logic to allow or restrict search execution.
3758
+ * You can can also show custom error text if the search query must be
3759
+ * restricted due to your application or business requirements.
3760
+
3761
+ * Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
3745
3762
  * for this embed event to get emitted.
3746
3763
  * @param: payload
3747
3764
  * @param: responder
3748
3765
  * Contains elements that lets developers define whether ThoughtSpot
3749
- * will run the search or not, and if not, which error message to provide.
3766
+ * should run the search, and if not, what error message
3767
+ * should be shown to the user.
3750
3768
  *
3751
- * execute: When execute returns true, the search will be run.
3752
- * When execute returns false, the search will not be executed.
3769
+ * execute: When execute returns `true`, the search will be run.
3770
+ * When execute returns `false`, the search will not be executed.
3753
3771
  *
3754
- * error: Developers can customize the user facing message when execute is
3755
- * set to false using the error parameter in responder
3756
- * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
3772
+ * error: Developers can customize the error message text when `execute`
3773
+ * returns `false` using the error parameter in responder.
3774
+ * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
3757
3775
  * @example
3758
3776
  *```js
3759
3777
  * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
@@ -3793,15 +3811,15 @@ export enum EmbedEvent {
3793
3811
  */
3794
3812
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
3795
3813
  /**
3796
- * Emitted when parameter changes in an answer
3797
- * or liveboard
3814
+ * Emitted when parameter changes in an Answer
3815
+ * or Liveboard
3798
3816
  *
3799
3817
  * ```js
3800
3818
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
3801
3819
  * console.log('payload', payload);
3802
3820
  * })
3803
3821
  *```
3804
- * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
3822
+ * @version SDK : 1.29.0 | Thoughtspot : 10.3.0.cl
3805
3823
  */
3806
3824
  ParameterChanged = "parameterChanged"
3807
3825
  }
@@ -4531,7 +4549,8 @@ export enum HostEvent {
4531
4549
  *
4532
4550
  * `values` - An array of one or several values. The value definition on the
4533
4551
  * data type you choose to filter on. For a complete list of supported data types, see
4534
- * link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types]
4552
+ * link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Supported data types].
4553
+ *
4535
4554
  * `type` - To update filters for date time, specify the date format type.
4536
4555
  * For more information and examples, see link:https://developers.thoughtspot.com/docs/embed-liveboard#_date_filters[Date filters].
4537
4556
  *
@@ -4819,7 +4838,8 @@ export enum Param {
4819
4838
  ShowLiveboardVerifiedBadge = "showLiveboardVerifiedBadge",
4820
4839
  ShowLiveboardReverifyBanner = "showLiveboardReverifyBanner",
4821
4840
  LiveboardHeaderV2 = "isLiveboardHeaderV2Enabled",
4822
- SpotterEnabled = "isSpotterExperienceEnabled"
4841
+ SpotterEnabled = "isSpotterExperienceEnabled",
4842
+ IsUnifiedSearchExperienceEnabled = "isUnifiedSearchExperienceEnabled"
4823
4843
  }
4824
4844
  /**
4825
4845
  * ThoughtSpot application pages include actions and menu commands
@@ -5789,7 +5809,7 @@ export enum Action {
5789
5809
  */
5790
5810
  AIHighlights = "AIHighlights",
5791
5811
  /**
5792
- * Action ID for edit schedule action on schedule on homepage
5812
+ * Action ID for edit the schedule action on schedule on homepage
5793
5813
  * @example
5794
5814
  * ```js
5795
5815
  * disabledActions: [Action.EditScheduleHomepage]
@@ -5850,7 +5870,16 @@ export enum Action {
5850
5870
  * ```
5851
5871
  * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5852
5872
  */
5853
- KPIAnalysisCTA = "kpiAnalysisCTA"
5873
+ KPIAnalysisCTA = "kpiAnalysisCTA",
5874
+ /**
5875
+ * Action ID for disabling chip reorder in Answer and Liveboard
5876
+ * @example
5877
+ * ```js
5878
+ * const disabledActions = [Action.DisableChipReorder]
5879
+ * ```
5880
+ * @version SDK: 1.35.0 | Thoughtspot: 10.5.0.cl
5881
+ */
5882
+ DisableChipReorder = "disableChipReorder"
5854
5883
  }
5855
5884
  export interface AnswerServiceType {
5856
5885
  getAnswer?: (offset: number, batchSize: number) => any;
package/lib/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.33.3",
3
+ "version": "1.33.4",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
@@ -352,7 +352,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
352
352
  */
353
353
  dataPanelCustomGroupsAccordionInitialState?: DataPanelCustomColumnGroupsAccordionState;
354
354
  /**
355
- * This flag is used to enable the 2 column layout in liveboard
355
+ * This attribute can be used to enable the two-column layout on an embedded Liveboard
356
356
  * @type {boolean}
357
357
  * @default false
358
358
  * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
@@ -366,17 +366,17 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
366
366
  */
367
367
  enable2ColumnLayout?: boolean;
368
368
  /**
369
- * Flag to use OnBeforeSearchExecute embed event
369
+ * Flag that allows using `EmbedEvent.OnBeforeGetVizDataIntercept`.
370
370
  * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
371
371
  */
372
372
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
373
373
  /**
374
374
  * Flag to use home page search bar mode
375
- * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
375
+ * @version SDK : 1.33.0 | Thoughtspot : 10.3.0.cl
376
376
  */
377
377
  homePageSearchBarMode?: HomePageSearchBarMode;
378
378
  /**
379
- * This flag is used to enable the compact header in liveboard
379
+ * This flag can be used to enable the compact header in Liveboard
380
380
  * @type {boolean}
381
381
  * @default false
382
382
  * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -390,7 +390,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
390
390
  */
391
391
  isLiveboardCompactHeaderEnabled?: boolean;
392
392
  /**
393
- * This flag is used to show/hide verified Icon in liveboard compact header
393
+ * This flag can be used to show or hide the Liveboard verified icon in the compact header.
394
394
  * @type {boolean}
395
395
  * @default true
396
396
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -404,7 +404,7 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
404
404
  */
405
405
  showLiveboardVerifiedBadge?: boolean;
406
406
  /**
407
- * This flag is used to show/hide re-verify banner in liveboard compact header
407
+ * This flag can be used to show or hide the re-verify banner on the Liveboard compact header
408
408
  * @type {boolean}
409
409
  * @default true
410
410
  * @version SDK: 1.35.0 | ThoughtSpot:10.4.0.cl
@@ -417,6 +417,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
417
417
  * ```
418
418
  */
419
419
  showLiveboardReverifyBanner?: boolean;
420
+ /**
421
+ * This flag is used to enable unified search experience for full app embed.
422
+ * @type {boolean}
423
+ * @default true
424
+ * @version SDK: 1.34.0 | ThoughtSpot:10.5.0.cl
425
+ * @example
426
+ * ```js
427
+ * const embed = new AppEmbed('#embed-container', {
428
+ * ... // other options
429
+ * isUnifiedSearchExperienceEnabled: true,
430
+ * })
431
+ * ```
432
+ */
433
+ isUnifiedSearchExperienceEnabled?: boolean;
420
434
  }
421
435
  /**
422
436
  * Embeds full ThoughtSpot experience in a host application.