@thoughtspot/visual-embed-sdk 1.29.2 → 1.30.0

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 (93) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/authToken.d.ts +1 -1
  3. package/cjs/src/authToken.js +1 -1
  4. package/cjs/src/embed/app.d.ts +1 -4
  5. package/cjs/src/embed/app.d.ts.map +1 -1
  6. package/cjs/src/embed/app.js +2 -2
  7. package/cjs/src/embed/app.js.map +1 -1
  8. package/cjs/src/embed/base.d.ts +1 -1
  9. package/cjs/src/embed/base.d.ts.map +1 -1
  10. package/cjs/src/embed/base.js +6 -6
  11. package/cjs/src/embed/base.js.map +1 -1
  12. package/cjs/src/embed/search.d.ts +1 -5
  13. package/cjs/src/embed/search.d.ts.map +1 -1
  14. package/cjs/src/embed/search.js +4 -4
  15. package/cjs/src/embed/search.js.map +1 -1
  16. package/cjs/src/embed/search.spec.js.map +1 -1
  17. package/cjs/src/embed/ts-embed.spec.js +9 -18
  18. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  19. package/cjs/src/types.d.ts +21 -54
  20. package/cjs/src/types.d.ts.map +1 -1
  21. package/cjs/src/types.js +20 -47
  22. package/cjs/src/types.js.map +1 -1
  23. package/cjs/src/utils/graphql/answerService/answerService.d.ts +2 -2
  24. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  25. package/cjs/src/utils/graphql/answerService/answerService.js +2 -2
  26. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  27. package/cjs/src/utils/graphql/answerService/answerService.spec.js +43 -0
  28. package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  29. package/cjs/src/utils/graphql/graphql-request.d.ts.map +1 -1
  30. package/cjs/src/utils/graphql/graphql-request.js +2 -1
  31. package/cjs/src/utils/graphql/graphql-request.js.map +1 -1
  32. package/dist/src/authToken.d.ts +1 -1
  33. package/dist/src/embed/app.d.ts +1 -4
  34. package/dist/src/embed/app.d.ts.map +1 -1
  35. package/dist/src/embed/base.d.ts +1 -1
  36. package/dist/src/embed/base.d.ts.map +1 -1
  37. package/dist/src/embed/search.d.ts +1 -5
  38. package/dist/src/embed/search.d.ts.map +1 -1
  39. package/dist/src/types.d.ts +21 -54
  40. package/dist/src/types.d.ts.map +1 -1
  41. package/dist/src/utils/graphql/answerService/answerService.d.ts +2 -2
  42. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  43. package/dist/src/utils/graphql/graphql-request.d.ts.map +1 -1
  44. package/dist/tsembed-react.es.js +26 -53
  45. package/dist/tsembed-react.js +26 -53
  46. package/dist/tsembed.es.js +1563 -1590
  47. package/dist/tsembed.js +3139 -3166
  48. package/dist/visual-embed-sdk-react-full.d.ts +24 -64
  49. package/dist/visual-embed-sdk-react.d.ts +24 -64
  50. package/dist/visual-embed-sdk.d.ts +24 -64
  51. package/lib/package.json +1 -1
  52. package/lib/src/authToken.d.ts +1 -1
  53. package/lib/src/authToken.js +1 -1
  54. package/lib/src/embed/app.d.ts +1 -4
  55. package/lib/src/embed/app.d.ts.map +1 -1
  56. package/lib/src/embed/app.js +2 -2
  57. package/lib/src/embed/app.js.map +1 -1
  58. package/lib/src/embed/base.d.ts +1 -1
  59. package/lib/src/embed/base.d.ts.map +1 -1
  60. package/lib/src/embed/base.js +5 -5
  61. package/lib/src/embed/base.js.map +1 -1
  62. package/lib/src/embed/search.d.ts +1 -5
  63. package/lib/src/embed/search.d.ts.map +1 -1
  64. package/lib/src/embed/search.js +5 -5
  65. package/lib/src/embed/search.js.map +1 -1
  66. package/lib/src/embed/search.spec.js.map +1 -1
  67. package/lib/src/embed/ts-embed.spec.js +9 -18
  68. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  69. package/lib/src/types.d.ts +21 -54
  70. package/lib/src/types.d.ts.map +1 -1
  71. package/lib/src/types.js +20 -47
  72. package/lib/src/types.js.map +1 -1
  73. package/lib/src/utils/graphql/answerService/answerService.d.ts +2 -2
  74. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  75. package/lib/src/utils/graphql/answerService/answerService.js +2 -2
  76. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  77. package/lib/src/utils/graphql/answerService/answerService.spec.js +44 -1
  78. package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
  79. package/lib/src/utils/graphql/graphql-request.d.ts.map +1 -1
  80. package/lib/src/utils/graphql/graphql-request.js +2 -1
  81. package/lib/src/utils/graphql/graphql-request.js.map +1 -1
  82. package/lib/src/visual-embed-sdk.d.ts +27 -67
  83. package/package.json +1 -1
  84. package/src/authToken.ts +1 -1
  85. package/src/embed/app.ts +14 -16
  86. package/src/embed/base.ts +14 -15
  87. package/src/embed/search.spec.ts +1 -2
  88. package/src/embed/search.ts +15 -21
  89. package/src/embed/ts-embed.spec.ts +24 -37
  90. package/src/types.ts +26 -60
  91. package/src/utils/graphql/answerService/answerService.spec.ts +53 -1
  92. package/src/utils/graphql/answerService/answerService.ts +2 -2
  93. package/src/utils/graphql/graphql-request.ts +2 -1
@@ -540,10 +540,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
540
540
  * ```
541
541
  */
542
542
  hideResults?: boolean;
543
- /**
544
- * If set to true, expands all the data sources panel.
545
- */
546
- expandAllDataSource?: boolean;
547
543
  /**
548
544
  * If set to true, the Search Assist feature is enabled.
549
545
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
@@ -817,7 +813,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
817
813
  * nav-bars are visible, this flag will only hide the homepage left nav-bar.
818
814
  * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
819
815
  *
820
- *
821
816
  * **Note**: This option does not apply to the classic homepage.
822
817
  * To access the updated modular homepage, set
823
818
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -850,7 +845,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
850
845
  * Control the visibility of the application switcher button on the nav-bar.
851
846
  * By default, the application switcher is shown.
852
847
  *
853
- *
854
848
  * **Note**: This option does not apply to the classic homepage.
855
849
  * To access the updated modular homepage, set
856
850
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -869,7 +863,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
869
863
  * Control the visibility of the Org switcher button on the nav-bar.
870
864
  * By default, the Org switcher button is shown.
871
865
  *
872
- *
873
866
  * **Note**: This option does not apply to the classic homepage.
874
867
  * To access the updated modular homepage, set
875
868
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -1901,7 +1894,6 @@ export declare enum AuthType {
1901
1894
  * .then((data) => data.token);
1902
1895
  * }
1903
1896
  * });
1904
- * });
1905
1897
  * ```
1906
1898
  */
1907
1899
  TrustedAuthToken = "AuthServer",
@@ -2272,7 +2264,6 @@ export interface EmbedConfig {
2272
2264
  /**
2273
2265
  * Pendo API key to enable Pendo tracking to your own subscription, the key
2274
2266
  * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
2275
- *
2276
2267
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
2277
2268
  */
2278
2269
  pendoTrackingKey?: string;
@@ -2622,8 +2613,6 @@ export interface ViewConfig {
2622
2613
  * Hide the home page modules
2623
2614
  * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
2624
2615
  *
2625
- *
2626
- *
2627
2616
  * **Note**: This option does not apply to the classic homepage.
2628
2617
  * To access the updated modular homepage, set
2629
2618
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2641,7 +2630,6 @@ export interface ViewConfig {
2641
2630
  * reordering the home page modules
2642
2631
  * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
2643
2632
  *
2644
- *
2645
2633
  * **Note**: This option does not apply to the classic homepage.
2646
2634
  * To access the updated modular homepage, set
2647
2635
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2685,8 +2673,6 @@ export interface ViewConfig {
2685
2673
  * })
2686
2674
  * ```
2687
2675
  *
2688
- *
2689
- *
2690
2676
  * **Note**: This option does not apply to the classic homepage.
2691
2677
  * To access the updated modular homepage, set
2692
2678
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2849,7 +2835,11 @@ export declare enum RuntimeFilterOp {
2849
2835
  /**
2850
2836
  * Is included in this list of values
2851
2837
  */
2852
- IN = "IN"
2838
+ IN = "IN",
2839
+ /**
2840
+ * Is not included in this list of values
2841
+ */
2842
+ NOT_IN = "NOT_IN"
2853
2843
  }
2854
2844
  /**
2855
2845
  * Home page module that can be hidden.
@@ -3116,20 +3106,14 @@ export declare enum EmbedEvent {
3116
3106
  /**
3117
3107
  * An error has occurred. This event is fired for the following error types:
3118
3108
  *
3119
- * `API`: API call failure error.
3120
- *
3121
- * `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
3122
- * mode.
3123
- *
3124
- * `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
3125
- *
3126
- * `NON_EXIST_FILTER`: Error due to a non-existent filter.
3109
+ * `API` - API call failure error.
3110
+ * `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
3111
+ * mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
3112
+ * filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
3113
+ * `INVALID_DATE_VALUE` - Invalid date value error.
3114
+ * `INVALID_OPERATOR` - Use of invalid operator during filter application.
3127
3115
  *
3128
- * `INVALID_DATE_VALUE`: Invalid date value error.
3129
- *
3130
- * `INVALID_OPERATOR`: Use of invalid operator during filter application.
3131
- *
3132
- * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
3116
+ * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
3133
3117
  * @returns error - An error object or message
3134
3118
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3135
3119
  * @example
@@ -3229,7 +3213,7 @@ export declare enum EmbedEvent {
3229
3213
  /**
3230
3214
  * Emitted when the embed does not have cookie access. This happens
3231
3215
  * when Safari and other Web browsers block third-party cookies
3232
- * are blocked by default.
3216
+ * are blocked by default. `NoCookieAccess` can trigger
3233
3217
  * @example
3234
3218
  *```js
3235
3219
  * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -3268,7 +3252,7 @@ export declare enum EmbedEvent {
3268
3252
  /**
3269
3253
  * Emitted when the Liveboard shell loads.
3270
3254
  * You can use this event as a hook to trigger
3271
- * actions on the rendered Liveboard.
3255
+ * other events on the rendered Liveboard.
3272
3256
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
3273
3257
  * @example
3274
3258
  *```js
@@ -3319,7 +3303,7 @@ export declare enum EmbedEvent {
3319
3303
  /**
3320
3304
  * Emitted when the download action is triggered on an answer
3321
3305
  *
3322
- * **Note**: This event is deprecated in v1.21.0.
3306
+ * **Note**: This event is deprecated in v1.21.0.
3323
3307
  * To fire an event when a download action is initiated on a chart or table,
3324
3308
  * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
3325
3309
  * or `EmbedEvent.DownloadAsXLSX`
@@ -3396,7 +3380,7 @@ export declare enum EmbedEvent {
3396
3380
  * //emit when action starts
3397
3381
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3398
3382
  * console.log('delete answer', payload)}, {start: true })
3399
- * //emit when action is completed
3383
+ * //trigger when action is completed
3400
3384
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3401
3385
  * console.log('delete answer', payload)})
3402
3386
  *```
@@ -3494,7 +3478,6 @@ export declare enum EmbedEvent {
3494
3478
  /**
3495
3479
  * Emitted when a user clicks the **Update TML** action on
3496
3480
  * embedded Liveboard.
3497
- *
3498
3481
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3499
3482
  * @example
3500
3483
  *```js
@@ -3506,7 +3489,6 @@ export declare enum EmbedEvent {
3506
3489
  /**
3507
3490
  * Emitted when a user clicks the **Edit TML** action
3508
3491
  * on an embedded Liveboard.
3509
- *
3510
3492
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3511
3493
  * @example
3512
3494
  *```js
@@ -3706,7 +3688,7 @@ export declare enum EmbedEvent {
3706
3688
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3707
3689
  * @example
3708
3690
  *```js
3709
- * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
3691
+ * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
3710
3692
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3711
3693
  *```
3712
3694
  */
@@ -3739,13 +3721,6 @@ export declare enum EmbedEvent {
3739
3721
  * })
3740
3722
  *
3741
3723
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3742
- * @example
3743
- *
3744
- *```js
3745
- * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3746
- * console.log('payload', payload);
3747
- * })
3748
- *```
3749
3724
  */
3750
3725
  FilterChanged = "filterChanged",
3751
3726
  /**
@@ -3983,8 +3958,8 @@ export declare enum HostEvent {
3983
3958
  * _String_. The name of the column to filter on.
3984
3959
  *
3985
3960
  * `operator`
3986
- * Runtime filter operator to apply. For information,
3987
- * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
3961
+ * Runtime filter operator to apply. For information,
3962
+ * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
3988
3963
  *
3989
3964
  * `values`
3990
3965
  * List of operands. Some operators such as EQ, LE allow a single value, whereas
@@ -4114,20 +4089,16 @@ export declare enum HostEvent {
4114
4089
  /**
4115
4090
  * Trigger the **Export TML** action on an embedded Liveboard or
4116
4091
  * Answer.
4117
- *
4118
4092
  * @example
4119
4093
  * ```js
4120
4094
  * liveboardEmbed.trigger(HostEvent.ExportTML)
4121
4095
  * ```
4122
- *
4123
4096
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4124
4097
  */
4125
4098
  ExportTML = "exportTSL",
4126
4099
  /**
4127
4100
  * Trigger the **Edit TML** action on an embedded Liveboard or
4128
4101
  * saved Answers in the full application embedding.
4129
- *
4130
- *
4131
4102
  * @example
4132
4103
  * ```js
4133
4104
  * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -4150,7 +4121,6 @@ export declare enum HostEvent {
4150
4121
  *
4151
4122
  * **NOTE**: The **Download** > **PDF** action is available on
4152
4123
  * visualizations and Answers if the data is in tabular format.
4153
- *
4154
4124
  * @example
4155
4125
  * ```js
4156
4126
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -4222,15 +4192,12 @@ export declare enum HostEvent {
4222
4192
  * on a Liveboard.
4223
4193
  *
4224
4194
  * This event is not supported in visualization embed and search embed.
4225
- *
4226
4195
  * @param - object - To trigger the action for a specific visualization
4227
4196
  * in Liveboard embed, pass in `vizId` as a key.
4228
- *
4229
4197
  * @example
4230
4198
  * ```js
4231
4199
  * liveboardEmbed.trigger(HostEvent.Edit)
4232
4200
  * ```
4233
- * @example
4234
4201
  * ```js
4235
4202
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
4236
4203
  * '730496d6-6903-4601-937e-2c691821af3c'})
@@ -4493,7 +4460,6 @@ export declare enum HostEvent {
4493
4460
  /**
4494
4461
  * Get details of filters applied on the Liveboard.
4495
4462
  * Returns arrays containing Liveboard filter and runtime filter elements.
4496
- *
4497
4463
  * @example
4498
4464
  * ```js
4499
4465
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -4520,7 +4486,6 @@ export declare enum HostEvent {
4520
4486
  * `values` - An array of one or several values. The value definition on the
4521
4487
  * data type you choose to filter on. For a complete list of supported data types,
4522
4488
  * see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
4523
- *
4524
4489
  * @example
4525
4490
  * ```js
4526
4491
  *
@@ -4838,7 +4803,6 @@ export declare enum Action {
4838
4803
  * The **Save as View** action on the Answer
4839
4804
  * page. Saves an Answer as a View object in the full
4840
4805
  * application embedding mode.
4841
- *
4842
4806
  * @example
4843
4807
  * ```js
4844
4808
  * disabledActions: [Action.SaveAsView]
@@ -5042,13 +5006,10 @@ export declare enum Action {
5042
5006
  DownloadAsPng = "downloadAsPng",
5043
5007
  /**
5044
5008
  *
5045
- * The **Download PDF** action that downloads a Liveboard,
5046
- * visualization, or Answer as a PDF file.
5009
+ *The **Download PDF** action that downloads a Liveboard,
5010
+ *visualization, or Answer as a PDF file.
5047
5011
  *
5048
5012
  *
5049
- * **NOTE**: The **Download** > **PDF** action is available on
5050
- * visualizations and Answers if the data is in tabular format.
5051
- *
5052
5013
  ***NOTE**: The **Download** > **PDF** action is available on
5053
5014
  *visualizations and Answers if the data is in tabular format.
5054
5015
  * @example
@@ -5298,7 +5259,6 @@ export declare enum Action {
5298
5259
  /**
5299
5260
  * The **Delete** action for Answers in the full application
5300
5261
  * embedding mode.
5301
- *
5302
5262
  * @example
5303
5263
  * ```js
5304
5264
  * disabledActions: [Action.AnswerDelete]
@@ -6257,14 +6217,14 @@ export declare class AnswerService {
6257
6217
  * ```js
6258
6218
  * embed.on(EmbedEvent.Data, async (e) => {
6259
6219
  * const service = await embed.getAnswerService();
6260
- * await service.addColumnsByNames([
6220
+ * await service.addColumnsByName([
6261
6221
  * "col name 1",
6262
6222
  * "col name 2"
6263
6223
  * ]);
6264
6224
  * console.log(await service.fetchData());
6265
6225
  * });
6266
6226
  */
6267
- addColumnsByNames(columnNames: string[]): Promise<any>;
6227
+ addColumnsByName(columnNames: string[]): Promise<any>;
6268
6228
  /**
6269
6229
  * Add a filter to the answer.
6270
6230
  * @param columnName
@@ -6395,7 +6355,7 @@ export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promi
6395
6355
  * ```js
6396
6356
  * resetCachedAuthToken();
6397
6357
  * ```
6398
- * @version SDK: 1.28.2 | ThoughtSpot: *
6358
+ * @version SDK: 1.28.0 | ThoughtSpot: *
6399
6359
  * @group Authentication / Init
6400
6360
  */
6401
6361
  export declare const resetCachedAuthToken: () => void;
@@ -530,10 +530,6 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
530
530
  * ```
531
531
  */
532
532
  hideResults?: boolean;
533
- /**
534
- * If set to true, expands all the data sources panel.
535
- */
536
- expandAllDataSource?: boolean;
537
533
  /**
538
534
  * If set to true, the Search Assist feature is enabled.
539
535
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
@@ -807,7 +803,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
807
803
  * nav-bars are visible, this flag will only hide the homepage left nav-bar.
808
804
  * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
809
805
  *
810
- *
811
806
  * **Note**: This option does not apply to the classic homepage.
812
807
  * To access the updated modular homepage, set
813
808
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -840,7 +835,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
840
835
  * Control the visibility of the application switcher button on the nav-bar.
841
836
  * By default, the application switcher is shown.
842
837
  *
843
- *
844
838
  * **Note**: This option does not apply to the classic homepage.
845
839
  * To access the updated modular homepage, set
846
840
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -859,7 +853,6 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
859
853
  * Control the visibility of the Org switcher button on the nav-bar.
860
854
  * By default, the Org switcher button is shown.
861
855
  *
862
- *
863
856
  * **Note**: This option does not apply to the classic homepage.
864
857
  * To access the updated modular homepage, set
865
858
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -1597,7 +1590,6 @@ export declare enum AuthType {
1597
1590
  * .then((data) => data.token);
1598
1591
  * }
1599
1592
  * });
1600
- * });
1601
1593
  * ```
1602
1594
  */
1603
1595
  TrustedAuthToken = "AuthServer",
@@ -1968,7 +1960,6 @@ export interface EmbedConfig {
1968
1960
  /**
1969
1961
  * Pendo API key to enable Pendo tracking to your own subscription, the key
1970
1962
  * is added as an additional key to the embed, as per this link:https://support.pendo.io/hc/en-us/articles/360032201951-Send-data-to-multiple-subscriptions[document].
1971
- *
1972
1963
  * @version SDK: 1.27.0 | ThoughtSpot: 9.8.0.cl
1973
1964
  */
1974
1965
  pendoTrackingKey?: string;
@@ -2318,8 +2309,6 @@ export interface ViewConfig {
2318
2309
  * Hide the home page modules
2319
2310
  * For example: hiddenHomepageModules = [HomepageModule.MyLibrary]
2320
2311
  *
2321
- *
2322
- *
2323
2312
  * **Note**: This option does not apply to the classic homepage.
2324
2313
  * To access the updated modular homepage, set
2325
2314
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2337,7 +2326,6 @@ export interface ViewConfig {
2337
2326
  * reordering the home page modules
2338
2327
  * eg: reorderedHomepageModules = [HomepageModule.MyLibrary, HomepageModule.Watchlist]
2339
2328
  *
2340
- *
2341
2329
  * **Note**: This option does not apply to the classic homepage.
2342
2330
  * To access the updated modular homepage, set
2343
2331
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2381,8 +2369,6 @@ export interface ViewConfig {
2381
2369
  * })
2382
2370
  * ```
2383
2371
  *
2384
- *
2385
- *
2386
2372
  * **Note**: This option does not apply to the classic homepage.
2387
2373
  * To access the updated modular homepage, set
2388
2374
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
@@ -2545,7 +2531,11 @@ export declare enum RuntimeFilterOp {
2545
2531
  /**
2546
2532
  * Is included in this list of values
2547
2533
  */
2548
- IN = "IN"
2534
+ IN = "IN",
2535
+ /**
2536
+ * Is not included in this list of values
2537
+ */
2538
+ NOT_IN = "NOT_IN"
2549
2539
  }
2550
2540
  /**
2551
2541
  * Home page module that can be hidden.
@@ -2812,20 +2802,14 @@ export declare enum EmbedEvent {
2812
2802
  /**
2813
2803
  * An error has occurred. This event is fired for the following error types:
2814
2804
  *
2815
- * `API`: API call failure error.
2816
- *
2817
- * `FULLSCREEN`: Error when presenting a Liveboard or visualization in full screen
2818
- * mode.
2819
- *
2820
- * `SINGLE_VALUE_FILTER`: Error due to multiple values in the single value filter.
2821
- *
2822
- * `NON_EXIST_FILTER`: Error due to a non-existent filter.
2805
+ * `API` - API call failure error.
2806
+ * `FULLSCREEN` - Error when presenting a Liveboard or visualization in full screen
2807
+ * mode. `SINGLE_VALUE_FILTER` - Error due to multiple values in the single value
2808
+ * filter. `NON_EXIST_FILTER` - Error due to a non-existent filter.
2809
+ * `INVALID_DATE_VALUE` - Invalid date value error.
2810
+ * `INVALID_OPERATOR` - Use of invalid operator during filter application.
2823
2811
  *
2824
- * `INVALID_DATE_VALUE`: Invalid date value error.
2825
- *
2826
- * `INVALID_OPERATOR`: Use of invalid operator during filter application.
2827
- *
2828
- * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType.
2812
+ * For more information, see https://developers.thoughtspot.com/docs/events-app-integration#errorType
2829
2813
  * @returns error - An error object or message
2830
2814
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
2831
2815
  * @example
@@ -2925,7 +2909,7 @@ export declare enum EmbedEvent {
2925
2909
  /**
2926
2910
  * Emitted when the embed does not have cookie access. This happens
2927
2911
  * when Safari and other Web browsers block third-party cookies
2928
- * are blocked by default.
2912
+ * are blocked by default. `NoCookieAccess` can trigger
2929
2913
  * @example
2930
2914
  *```js
2931
2915
  * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -2964,7 +2948,7 @@ export declare enum EmbedEvent {
2964
2948
  /**
2965
2949
  * Emitted when the Liveboard shell loads.
2966
2950
  * You can use this event as a hook to trigger
2967
- * actions on the rendered Liveboard.
2951
+ * other events on the rendered Liveboard.
2968
2952
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
2969
2953
  * @example
2970
2954
  *```js
@@ -3015,7 +2999,7 @@ export declare enum EmbedEvent {
3015
2999
  /**
3016
3000
  * Emitted when the download action is triggered on an answer
3017
3001
  *
3018
- * **Note**: This event is deprecated in v1.21.0.
3002
+ * **Note**: This event is deprecated in v1.21.0.
3019
3003
  * To fire an event when a download action is initiated on a chart or table,
3020
3004
  * use `EmbedEvent.DownloadAsPng`, `EmbedEvent.DownloadAsPDF`, `EmbedEvent.DownloadAsCSV`,
3021
3005
  * or `EmbedEvent.DownloadAsXLSX`
@@ -3092,7 +3076,7 @@ export declare enum EmbedEvent {
3092
3076
  * //emit when action starts
3093
3077
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3094
3078
  * console.log('delete answer', payload)}, {start: true })
3095
- * //emit when action is completed
3079
+ * //trigger when action is completed
3096
3080
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
3097
3081
  * console.log('delete answer', payload)})
3098
3082
  *```
@@ -3190,7 +3174,6 @@ export declare enum EmbedEvent {
3190
3174
  /**
3191
3175
  * Emitted when a user clicks the **Update TML** action on
3192
3176
  * embedded Liveboard.
3193
- *
3194
3177
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3195
3178
  * @example
3196
3179
  *```js
@@ -3202,7 +3185,6 @@ export declare enum EmbedEvent {
3202
3185
  /**
3203
3186
  * Emitted when a user clicks the **Edit TML** action
3204
3187
  * on an embedded Liveboard.
3205
- *
3206
3188
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3207
3189
  * @example
3208
3190
  *```js
@@ -3402,7 +3384,7 @@ export declare enum EmbedEvent {
3402
3384
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3403
3385
  * @example
3404
3386
  *```js
3405
- * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
3387
+ * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
3406
3388
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3407
3389
  *```
3408
3390
  */
@@ -3435,13 +3417,6 @@ export declare enum EmbedEvent {
3435
3417
  * })
3436
3418
  *
3437
3419
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
3438
- * @example
3439
- *
3440
- *```js
3441
- * LiveboardEmbed.on(EmbedEvent.FilterChanged, (payload) => {
3442
- * console.log('payload', payload);
3443
- * })
3444
- *```
3445
3420
  */
3446
3421
  FilterChanged = "filterChanged",
3447
3422
  /**
@@ -3679,8 +3654,8 @@ export declare enum HostEvent {
3679
3654
  * _String_. The name of the column to filter on.
3680
3655
  *
3681
3656
  * `operator`
3682
- * Runtime filter operator to apply. For information,
3683
- * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
3657
+ * Runtime filter operator to apply. For information,
3658
+ * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
3684
3659
  *
3685
3660
  * `values`
3686
3661
  * List of operands. Some operators such as EQ, LE allow a single value, whereas
@@ -3810,20 +3785,16 @@ export declare enum HostEvent {
3810
3785
  /**
3811
3786
  * Trigger the **Export TML** action on an embedded Liveboard or
3812
3787
  * Answer.
3813
- *
3814
3788
  * @example
3815
3789
  * ```js
3816
3790
  * liveboardEmbed.trigger(HostEvent.ExportTML)
3817
3791
  * ```
3818
- *
3819
3792
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3820
3793
  */
3821
3794
  ExportTML = "exportTSL",
3822
3795
  /**
3823
3796
  * Trigger the **Edit TML** action on an embedded Liveboard or
3824
3797
  * saved Answers in the full application embedding.
3825
- *
3826
- *
3827
3798
  * @example
3828
3799
  * ```js
3829
3800
  * liveboardEmbed.trigger(HostEvent.EditTML)
@@ -3846,7 +3817,6 @@ export declare enum HostEvent {
3846
3817
  *
3847
3818
  * **NOTE**: The **Download** > **PDF** action is available on
3848
3819
  * visualizations and Answers if the data is in tabular format.
3849
- *
3850
3820
  * @example
3851
3821
  * ```js
3852
3822
  * liveboardEmbed.trigger(HostEvent.DownloadAsPdf)
@@ -3918,15 +3888,12 @@ export declare enum HostEvent {
3918
3888
  * on a Liveboard.
3919
3889
  *
3920
3890
  * This event is not supported in visualization embed and search embed.
3921
- *
3922
3891
  * @param - object - To trigger the action for a specific visualization
3923
3892
  * in Liveboard embed, pass in `vizId` as a key.
3924
- *
3925
3893
  * @example
3926
3894
  * ```js
3927
3895
  * liveboardEmbed.trigger(HostEvent.Edit)
3928
3896
  * ```
3929
- * @example
3930
3897
  * ```js
3931
3898
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId:
3932
3899
  * '730496d6-6903-4601-937e-2c691821af3c'})
@@ -4189,7 +4156,6 @@ export declare enum HostEvent {
4189
4156
  /**
4190
4157
  * Get details of filters applied on the Liveboard.
4191
4158
  * Returns arrays containing Liveboard filter and runtime filter elements.
4192
- *
4193
4159
  * @example
4194
4160
  * ```js
4195
4161
  * const data = await liveboardEmbed.trigger(HostEvent.GetFilters);
@@ -4216,7 +4182,6 @@ export declare enum HostEvent {
4216
4182
  * `values` - An array of one or several values. The value definition on the
4217
4183
  * data type you choose to filter on. For a complete list of supported data types,
4218
4184
  * see link:https://developers.thoughtspot.com/docs/runtime-filters#_supported_data_types[Developer Documentation].
4219
- *
4220
4185
  * @example
4221
4186
  * ```js
4222
4187
  *
@@ -4534,7 +4499,6 @@ export declare enum Action {
4534
4499
  * The **Save as View** action on the Answer
4535
4500
  * page. Saves an Answer as a View object in the full
4536
4501
  * application embedding mode.
4537
- *
4538
4502
  * @example
4539
4503
  * ```js
4540
4504
  * disabledActions: [Action.SaveAsView]
@@ -4738,13 +4702,10 @@ export declare enum Action {
4738
4702
  DownloadAsPng = "downloadAsPng",
4739
4703
  /**
4740
4704
  *
4741
- * The **Download PDF** action that downloads a Liveboard,
4742
- * visualization, or Answer as a PDF file.
4705
+ *The **Download PDF** action that downloads a Liveboard,
4706
+ *visualization, or Answer as a PDF file.
4743
4707
  *
4744
4708
  *
4745
- * **NOTE**: The **Download** > **PDF** action is available on
4746
- * visualizations and Answers if the data is in tabular format.
4747
- *
4748
4709
  ***NOTE**: The **Download** > **PDF** action is available on
4749
4710
  *visualizations and Answers if the data is in tabular format.
4750
4711
  * @example
@@ -4994,7 +4955,6 @@ export declare enum Action {
4994
4955
  /**
4995
4956
  * The **Delete** action for Answers in the full application
4996
4957
  * embedding mode.
4997
- *
4998
4958
  * @example
4999
4959
  * ```js
5000
4960
  * disabledActions: [Action.AnswerDelete]
@@ -6540,14 +6500,14 @@ export declare class AnswerService {
6540
6500
  * ```js
6541
6501
  * embed.on(EmbedEvent.Data, async (e) => {
6542
6502
  * const service = await embed.getAnswerService();
6543
- * await service.addColumnsByNames([
6503
+ * await service.addColumnsByName([
6544
6504
  * "col name 1",
6545
6505
  * "col name 2"
6546
6506
  * ]);
6547
6507
  * console.log(await service.fetchData());
6548
6508
  * });
6549
6509
  */
6550
- addColumnsByNames(columnNames: string[]): Promise<any>;
6510
+ addColumnsByName(columnNames: string[]): Promise<any>;
6551
6511
  /**
6552
6512
  * Add a filter to the answer.
6553
6513
  * @param columnName
@@ -6678,7 +6638,7 @@ export declare const getAuthenticationToken: (embedConfig: EmbedConfig) => Promi
6678
6638
  * ```js
6679
6639
  * resetCachedAuthToken();
6680
6640
  * ```
6681
- * @version SDK: 1.28.2 | ThoughtSpot: *
6641
+ * @version SDK: 1.28.0 | ThoughtSpot: *
6682
6642
  * @group Authentication / Init
6683
6643
  */
6684
6644
  export declare const resetCachedAuthToken: () => void;