@thoughtspot/visual-embed-sdk 1.53.1 → 1.53.2-beta

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 (97) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/auth.d.ts.map +1 -1
  3. package/cjs/src/auth.js +25 -6
  4. package/cjs/src/auth.js.map +1 -1
  5. package/cjs/src/auth.spec.js +40 -8
  6. package/cjs/src/auth.spec.js.map +1 -1
  7. package/cjs/src/contracts/contracts.spec.js +165 -2
  8. package/cjs/src/contracts/contracts.spec.js.map +1 -1
  9. package/cjs/src/contracts/embed-event-payloads.d.ts +212 -14
  10. package/cjs/src/contracts/embed-event-payloads.d.ts.map +1 -1
  11. package/cjs/src/contracts/host-event-contracts.d.ts +1 -0
  12. package/cjs/src/contracts/host-event-contracts.d.ts.map +1 -1
  13. package/cjs/src/css-variables.d.ts +140 -0
  14. package/cjs/src/css-variables.d.ts.map +1 -1
  15. package/cjs/src/embed/auto-frame-renderer.d.ts +14 -1
  16. package/cjs/src/embed/auto-frame-renderer.d.ts.map +1 -1
  17. package/cjs/src/embed/auto-frame-renderer.js +91 -2
  18. package/cjs/src/embed/auto-frame-renderer.js.map +1 -1
  19. package/cjs/src/embed/auto-frame-renderer.spec.js +112 -7
  20. package/cjs/src/embed/auto-frame-renderer.spec.js.map +1 -1
  21. package/cjs/src/embed/host-events.spec.js +18 -0
  22. package/cjs/src/embed/host-events.spec.js.map +1 -1
  23. package/cjs/src/embed/liveboard.spec.js +42 -0
  24. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  25. package/cjs/src/react/util.d.ts +8 -1
  26. package/cjs/src/react/util.d.ts.map +1 -1
  27. package/cjs/src/react/util.js.map +1 -1
  28. package/cjs/src/types.d.ts +181 -1
  29. package/cjs/src/types.d.ts.map +1 -1
  30. package/cjs/src/types.js +180 -0
  31. package/cjs/src/types.js.map +1 -1
  32. package/dist/{index-CrBnZBZv.js → index-DQ7r5f1z.js} +1 -1
  33. package/dist/src/auth.d.ts.map +1 -1
  34. package/dist/src/contracts/embed-event-payloads.d.ts +212 -14
  35. package/dist/src/contracts/embed-event-payloads.d.ts.map +1 -1
  36. package/dist/src/contracts/host-event-contracts.d.ts +1 -0
  37. package/dist/src/contracts/host-event-contracts.d.ts.map +1 -1
  38. package/dist/src/css-variables.d.ts +140 -0
  39. package/dist/src/css-variables.d.ts.map +1 -1
  40. package/dist/src/embed/auto-frame-renderer.d.ts +14 -1
  41. package/dist/src/embed/auto-frame-renderer.d.ts.map +1 -1
  42. package/dist/src/react/util.d.ts +8 -1
  43. package/dist/src/react/util.d.ts.map +1 -1
  44. package/dist/src/types.d.ts +181 -1
  45. package/dist/src/types.d.ts.map +1 -1
  46. package/dist/tsembed-react.es.js +230 -9
  47. package/dist/tsembed-react.js +229 -8
  48. package/dist/tsembed.es.js +298 -10
  49. package/dist/tsembed.js +297 -9
  50. package/dist/visual-embed-sdk-react-full.d.ts +534 -13
  51. package/dist/visual-embed-sdk-react.d.ts +531 -11
  52. package/dist/visual-embed-sdk.d.ts +527 -12
  53. package/lib/package.json +1 -1
  54. package/lib/src/auth.d.ts.map +1 -1
  55. package/lib/src/auth.js +25 -6
  56. package/lib/src/auth.js.map +1 -1
  57. package/lib/src/auth.spec.js +40 -8
  58. package/lib/src/auth.spec.js.map +1 -1
  59. package/lib/src/contracts/contracts.spec.js +165 -2
  60. package/lib/src/contracts/contracts.spec.js.map +1 -1
  61. package/lib/src/contracts/embed-event-payloads.d.ts +212 -14
  62. package/lib/src/contracts/embed-event-payloads.d.ts.map +1 -1
  63. package/lib/src/contracts/host-event-contracts.d.ts +1 -0
  64. package/lib/src/contracts/host-event-contracts.d.ts.map +1 -1
  65. package/lib/src/css-variables.d.ts +140 -0
  66. package/lib/src/css-variables.d.ts.map +1 -1
  67. package/lib/src/embed/auto-frame-renderer.d.ts +14 -1
  68. package/lib/src/embed/auto-frame-renderer.d.ts.map +1 -1
  69. package/lib/src/embed/auto-frame-renderer.js +91 -2
  70. package/lib/src/embed/auto-frame-renderer.js.map +1 -1
  71. package/lib/src/embed/auto-frame-renderer.spec.js +113 -8
  72. package/lib/src/embed/auto-frame-renderer.spec.js.map +1 -1
  73. package/lib/src/embed/host-events.spec.js +18 -0
  74. package/lib/src/embed/host-events.spec.js.map +1 -1
  75. package/lib/src/embed/liveboard.spec.js +42 -0
  76. package/lib/src/embed/liveboard.spec.js.map +1 -1
  77. package/lib/src/react/util.d.ts +8 -1
  78. package/lib/src/react/util.d.ts.map +1 -1
  79. package/lib/src/react/util.js.map +1 -1
  80. package/lib/src/types.d.ts +181 -1
  81. package/lib/src/types.d.ts.map +1 -1
  82. package/lib/src/types.js +180 -0
  83. package/lib/src/types.js.map +1 -1
  84. package/lib/src/visual-embed-sdk.d.ts +527 -12
  85. package/package.json +1 -1
  86. package/src/auth.spec.ts +47 -11
  87. package/src/auth.ts +35 -6
  88. package/src/contracts/contracts.spec.ts +182 -3
  89. package/src/contracts/embed-event-payloads.ts +281 -14
  90. package/src/contracts/host-event-contracts.ts +1 -0
  91. package/src/css-variables.ts +168 -0
  92. package/src/embed/auto-frame-renderer.spec.ts +134 -8
  93. package/src/embed/auto-frame-renderer.ts +103 -2
  94. package/src/embed/host-events.spec.ts +24 -0
  95. package/src/embed/liveboard.spec.ts +45 -0
  96. package/src/react/util.ts +13 -1
  97. package/src/types.ts +181 -0
@@ -1466,6 +1466,146 @@ export interface CustomCssVariables {
1466
1466
  * Background color of the shimmer sweep animation's gradient mid-stop.
1467
1467
  */
1468
1468
  "--ts-var-shimmer-sweep-background"?: string;
1469
+ /**
1470
+ * Secondary accent color. Used as the background of cross-filter chips in the
1471
+ * filter panel and to highlight Liveboard visualizations and Answer headers
1472
+ * impacted by a cross filter.
1473
+ */
1474
+ "--ts-var-root-secondary-color"?: string;
1475
+ /**
1476
+ * Background color of the action items in the top navigation bar, such as the
1477
+ * search bar, Help menu, Org switcher, user menu, and notifications, on hover
1478
+ * or when selected.
1479
+ */
1480
+ "--ts-var-nav-action-item-background"?: string;
1481
+ /**
1482
+ * Border color of the action items in the top navigation bar, such as the
1483
+ * Org switcher and the search bar.
1484
+ */
1485
+ "--ts-var-nav-action-item-border-color"?: string;
1486
+ /**
1487
+ * Border color of the search bar in the top navigation bar on hover.
1488
+ */
1489
+ "--ts-var-nav-action-item-border-secondary-color"?: string;
1490
+ /**
1491
+ * Placeholder text color of the search bar and menus in the top navigation
1492
+ * bar. Also used as the background of the Help menu button when the menu
1493
+ * is open.
1494
+ */
1495
+ "--ts-var-nav-action-item-placeholder-color"?: string;
1496
+ /**
1497
+ * Background color of the natural language search bar header in Sage
1498
+ * embed.
1499
+ */
1500
+ "--ts-var-sage-bar-header-background-color"?: string;
1501
+ /**
1502
+ * Background color of the data source selector in the natural language
1503
+ * search bar.
1504
+ */
1505
+ "--ts-var-source-selector-background-color"?: string;
1506
+ /**
1507
+ * Background color of the data source selector in the natural language
1508
+ * search bar on hover.
1509
+ */
1510
+ "--ts-var-source-selector-hover-color"?: string;
1511
+ /**
1512
+ * Font color of the text in the natural language search box.
1513
+ */
1514
+ "--ts-var-sage-search-box-font-color"?: string;
1515
+ /**
1516
+ * Background color of the natural language search box.
1517
+ */
1518
+ "--ts-var-sage-search-box-background-color"?: string;
1519
+ /**
1520
+ * Background color of the AI-generated answer container in Sage embed.
1521
+ */
1522
+ "--ts-var-sage-embed-background-color"?: string;
1523
+ /**
1524
+ * Background color of the suggested (seed) questions shown in the natural
1525
+ * language search bar and Spotter.
1526
+ */
1527
+ "--ts-var-sage-seed-questions-background"?: string;
1528
+ /**
1529
+ * Font color of the suggested (seed) questions shown in the natural
1530
+ * language search bar and Spotter.
1531
+ */
1532
+ "--ts-var-sage-seed-questions-font-color"?: string;
1533
+ /**
1534
+ * Background color of the suggested (seed) questions shown in the natural
1535
+ * language search bar and Spotter on hover.
1536
+ */
1537
+ "--ts-var-sage-seed-questions-hover-background"?: string;
1538
+ /**
1539
+ * Background of the AI gradient border around the natural language search bar
1540
+ * and the Spotter prompt input. Accepts any CSS background value, for example,
1541
+ * a `linear-gradient(...)` or a solid color.
1542
+ */
1543
+ "--ts-var-ai-gradient-color"?: string;
1544
+ /**
1545
+ * Background color of the separator line between sections of a menu.
1546
+ */
1547
+ "--ts-var-menu-seperator-background"?: string;
1548
+ /**
1549
+ * Start color of the gradient background on the icon of custom menu items in
1550
+ * the navigation. Defaults to the value of `--ts-var-root-color`.
1551
+ */
1552
+ "--ts-var-home-card-color"?: string;
1553
+ /**
1554
+ * Font color of the heading text on the suggestion cards in the favorites
1555
+ * carousel on the Home page.
1556
+ */
1557
+ "--ts-var-home-favorite-suggestion-card-text-font-color"?: string;
1558
+ /**
1559
+ * Background color of a highlighted checkbox row on hover.
1560
+ */
1561
+ "--ts-var-checkbox-highlighted-hover-color"?: string;
1562
+ /**
1563
+ * Font family of the group title in a Liveboard. Defaults to the value of
1564
+ * `--ts-var-viz-title-font-family`.
1565
+ */
1566
+ "--ts-var-liveboard-group-title-font-family"?: string;
1567
+ /**
1568
+ * Font family of the group description in a Liveboard. Defaults to the value
1569
+ * of `--ts-var-viz-description-font-family`.
1570
+ */
1571
+ "--ts-var-liveboard-group-description-font-family"?: string;
1572
+ /**
1573
+ * Font family of the visualization titles inside a Liveboard group. Defaults
1574
+ * to the value of `--ts-var-viz-title-font-family`.
1575
+ */
1576
+ "--ts-var-liveboard-group-tile-title-font-family"?: string;
1577
+ /**
1578
+ * Font family of the visualization descriptions inside a Liveboard group.
1579
+ * Defaults to the value of `--ts-var-viz-description-font-family`.
1580
+ */
1581
+ "--ts-var-liveboard-group-tile-description-font-family"?: string;
1582
+ /**
1583
+ * Font color of the filter chips in a Liveboard on hover. Defaults to the
1584
+ * value of `--ts-var-chip--hover-color`.
1585
+ */
1586
+ "--ts-var-liveboard-chip--hover-color"?: string;
1587
+ /**
1588
+ * Font color of the filter chips in a Liveboard when active. Defaults to the
1589
+ * value of `--ts-var-chip--active-color`.
1590
+ */
1591
+ "--ts-var-liveboard-chip--active-color"?: string;
1592
+ /**
1593
+ * Background color of the styling panel in the Liveboard. Defaults to the
1594
+ * value of `--ts-var-liveboard-edit-bar-background`.
1595
+ */
1596
+ "--ts-var-liveboard-styling-panel-background"?: string;
1597
+ /**
1598
+ * Border radius of the visualization container on the Answer page. On a
1599
+ * Liveboard, this value is derived from `--ts-var-liveboard-tile-border-radius`
1600
+ * and `--ts-var-viz-border-radius`; use those to style Liveboard tiles.
1601
+ */
1602
+ "--ts-var-tile-viz-border-radius"?: string;
1603
+ /**
1604
+ * Color of the outline (halo) drawn around data labels on charts, which keeps
1605
+ * the labels readable over chart elements. Defaults to the value of
1606
+ * `--ts-var-root-color`.
1607
+ */
1608
+ "--ts-var-chart-data-label-stroke-color"?: string;
1469
1609
  }
1470
1610
  export interface SessionInterface {
1471
1611
  sessionId: string;
@@ -4543,6 +4683,7 @@ export declare enum EmbedEvent {
4543
4683
  * })
4544
4684
  * ```
4545
4685
  * @returns isLoggedIn - A Boolean specifying whether authentication was successful.
4686
+ * Payload: {@link AuthInitPayload}.
4546
4687
  */
4547
4688
  AuthInit = "authInit",
4548
4689
  /**
@@ -4562,6 +4703,7 @@ export declare enum EmbedEvent {
4562
4703
  /**
4563
4704
  * Data pertaining to an Answer, Liveboard or Spotter visualization is received.
4564
4705
  * The event payload includes the raw data of the object.
4706
+ * Payload: {@link DataEventPayload}.
4565
4707
  * @return data - Answer of Liveboard data
4566
4708
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
4567
4709
  * @example
@@ -4575,6 +4717,7 @@ export declare enum EmbedEvent {
4575
4717
  Data = "data",
4576
4718
  /**
4577
4719
  * Search query has been updated by the user.
4720
+ * Payload: {@link QueryChangedPayload} or a string.
4578
4721
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
4579
4722
  * @example
4580
4723
  * ```js
@@ -4617,6 +4760,7 @@ export declare enum EmbedEvent {
4617
4760
  * })
4618
4761
  * })
4619
4762
  * ```
4763
+ * Payload: {@link DrilldownPayload}.
4620
4764
  */
4621
4765
  Drilldown = "drillDown",
4622
4766
  /**
@@ -4629,6 +4773,7 @@ export declare enum EmbedEvent {
4629
4773
  * console.log('DataSourceSelected', payload);
4630
4774
  * })
4631
4775
  * ```
4776
+ * Payload: {@link DataSourceSelectedPayload} or string[].
4632
4777
  */
4633
4778
  DataSourceSelected = "dataSourceSelected",
4634
4779
  /**
@@ -4641,6 +4786,7 @@ export declare enum EmbedEvent {
4641
4786
  * console.log('AddRemoveColumns', payload);
4642
4787
  * })
4643
4788
  * ```
4789
+ * Payload: string[].
4644
4790
  */
4645
4791
  AddRemoveColumns = "addRemoveColumns",
4646
4792
  /**
@@ -4658,6 +4804,7 @@ export declare enum EmbedEvent {
4658
4804
  * }
4659
4805
  * })
4660
4806
  * ```
4807
+ * Payload: {@link CustomActionPayload} (on() enriches it to {@link CustomActionEventPayload}).
4661
4808
  */
4662
4809
  CustomAction = "customAction",
4663
4810
  /**
@@ -4670,6 +4817,7 @@ export declare enum EmbedEvent {
4670
4817
  * console.log('VizPointDoubleClick', payload);
4671
4818
  * })
4672
4819
  * ```
4820
+ * Payload: {@link VizInteractionPayload}.
4673
4821
  */
4674
4822
  VizPointDoubleClick = "vizPointDoubleClick",
4675
4823
  /**
@@ -4689,6 +4837,7 @@ export declare enum EmbedEvent {
4689
4837
  * )
4690
4838
  * });
4691
4839
  * ```
4840
+ * Payload: {@link VizInteractionPayload}.
4692
4841
  */
4693
4842
  VizPointClick = "vizPointClick",
4694
4843
  /**
@@ -4741,6 +4890,7 @@ export declare enum EmbedEvent {
4741
4890
  * // { errorType: "API", message: '...', code: '...' }
4742
4891
  * });
4743
4892
  * ```
4893
+ * Payload: {@link EmbedErrorPayload} or a string.
4744
4894
  */
4745
4895
  Error = "Error",
4746
4896
  /**
@@ -4791,6 +4941,7 @@ export declare enum EmbedEvent {
4791
4941
  * The center of visible iframe viewport is calculated.
4792
4942
  * @returns data - The center of the visible Iframe viewport.
4793
4943
  * @hidden
4944
+ * Payload: none.
4794
4945
  */
4795
4946
  EmbedIframeCenter = "EmbedIframeCenter",
4796
4947
  /**
@@ -4847,6 +4998,7 @@ export declare enum EmbedEvent {
4847
4998
  * console.log('dialog open', payload);
4848
4999
  * })
4849
5000
  * ```
5001
+ * Payload: none.
4850
5002
  */
4851
5003
  DialogOpen = "dialog-open",
4852
5004
  /**
@@ -4858,6 +5010,7 @@ export declare enum EmbedEvent {
4858
5010
  * console.log('dialog close', payload);
4859
5011
  * })
4860
5012
  * ```
5013
+ * Payload: none.
4861
5014
  */
4862
5015
  DialogClose = "dialog-close",
4863
5016
  /**
@@ -4880,6 +5033,7 @@ export declare enum EmbedEvent {
4880
5033
  * embed.trigger(HostEvent.SetVisibleVizs, ['viz1', 'viz2']);
4881
5034
  * };
4882
5035
  * ```
5036
+ * Payload: none.
4883
5037
  */
4884
5038
  LiveboardRendered = "PinboardRendered",
4885
5039
  /**
@@ -4910,6 +5064,7 @@ export declare enum EmbedEvent {
4910
5064
  * console.log('Save', payload)
4911
5065
  * })
4912
5066
  * ```
5067
+ * Payload: {@link SaveEventPayload}.
4913
5068
  */
4914
5069
  Save = "save",
4915
5070
  /**
@@ -4926,6 +5081,7 @@ export declare enum EmbedEvent {
4926
5081
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
4927
5082
  * })
4928
5083
  * ```
5084
+ * Payload: {@link VizScope}.
4929
5085
  */
4930
5086
  Download = "download",
4931
5087
  /**
@@ -4945,6 +5101,7 @@ export declare enum EmbedEvent {
4945
5101
  * searchEmbed.on(EmbedEvent.DownloadAsPng, payload => {
4946
5102
  * console.log('download PNG', payload)})
4947
5103
  * ```
5104
+ * Payload: {@link DownloadEventPayload}.
4948
5105
  */
4949
5106
  DownloadAsPng = "downloadAsPng",
4950
5107
  /**
@@ -4964,6 +5121,7 @@ export declare enum EmbedEvent {
4964
5121
  * searchEmbed.on(EmbedEvent.DownloadAsPdf, payload => {
4965
5122
  * console.log('download PDF', payload)})
4966
5123
  * ```
5124
+ * Payload: {@link DownloadEventPayload}.
4967
5125
  */
4968
5126
  DownloadAsPdf = "downloadAsPdf",
4969
5127
  /**
@@ -4983,6 +5141,7 @@ export declare enum EmbedEvent {
4983
5141
  * searchEmbed.on(EmbedEvent.DownloadAsCsv, payload => {
4984
5142
  * console.log('download CSV', payload)})
4985
5143
  * ```
5144
+ * Payload: {@link DownloadEventPayload}.
4986
5145
  */
4987
5146
  DownloadAsCsv = "downloadAsCsv",
4988
5147
  /**
@@ -5002,6 +5161,7 @@ export declare enum EmbedEvent {
5002
5161
  * searchEmbed.on(EmbedEvent.DownloadAsXlsx, payload => {
5003
5162
  * console.log('download Xlsx', payload)})
5004
5163
  * ```
5164
+ * Payload: {@link DownloadEventPayload}.
5005
5165
  */
5006
5166
  DownloadAsXlsx = "downloadAsXlsx",
5007
5167
  /**
@@ -5013,6 +5173,7 @@ export declare enum EmbedEvent {
5013
5173
  * liveboardEmbed.on(EmbedEvent.DownloadLiveboardAsContinuousPDF, payload => {
5014
5174
  * console.log('download liveboard as continuous PDF', payload)})
5015
5175
  * ```
5176
+ * Payload: {@link LiveboardScope}.
5016
5177
  */
5017
5178
  DownloadLiveboardAsContinuousPDF = "downloadLiveboardAsContinuousPDF",
5018
5179
  /**
@@ -5029,6 +5190,7 @@ export declare enum EmbedEvent {
5029
5190
  * appEmbed.on(EmbedEvent.AnswerDelete, payload => {
5030
5191
  * console.log('delete answer', payload)})
5031
5192
  * ```
5193
+ * Payload: {@link AnswerScope}.
5032
5194
  */
5033
5195
  AnswerDelete = "answerDelete",
5034
5196
  /**
@@ -5040,6 +5202,7 @@ export declare enum EmbedEvent {
5040
5202
  * console.log('AI Highlights', payload);
5041
5203
  * })
5042
5204
  * ```
5205
+ * Payload: {@link LiveboardScope}.
5043
5206
  */
5044
5207
  AIHighlights = "AIHighlights",
5045
5208
  /**
@@ -5061,6 +5224,7 @@ export declare enum EmbedEvent {
5061
5224
  * console.log('pin', payload)
5062
5225
  * })
5063
5226
  * ```
5227
+ * Payload: {@link PinEventPayload}.
5064
5228
  */
5065
5229
  Pin = "pin",
5066
5230
  /**
@@ -5079,6 +5243,7 @@ export declare enum EmbedEvent {
5079
5243
  * console.log('SpotIQ analyze', payload)
5080
5244
  * })
5081
5245
  * ```
5246
+ * Payload: {@link AnswerScope}.
5082
5247
  */
5083
5248
  SpotIQAnalyze = "spotIQAnalyze",
5084
5249
  /**
@@ -5132,6 +5297,7 @@ export declare enum EmbedEvent {
5132
5297
  * console.log('copy to clipboard', payload);
5133
5298
  * })
5134
5299
  * ```
5300
+ * Payload: {@link CopyToClipboardPayload}.
5135
5301
  */
5136
5302
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
5137
5303
  /**
@@ -5143,6 +5309,7 @@ export declare enum EmbedEvent {
5143
5309
  * liveboardEmbed.on(EmbedEvent.UpdateTML)
5144
5310
  * })
5145
5311
  * ```
5312
+ * Payload: {@link TmlEventPayload}.
5146
5313
  */
5147
5314
  UpdateTML = "updateTSL",
5148
5315
  /**
@@ -5155,6 +5322,7 @@ export declare enum EmbedEvent {
5155
5322
  * console.log('Edit TML', payload);
5156
5323
  * })
5157
5324
  * ```
5325
+ * Payload: {@link TmlEventPayload}.
5158
5326
  */
5159
5327
  EditTML = "editTSL",
5160
5328
  /**
@@ -5172,6 +5340,7 @@ export declare enum EmbedEvent {
5172
5340
  * searchEmbed.on(EmbedEvent.ExportTML, payload => {
5173
5341
  * console.log('Export TML', payload)})
5174
5342
  * ```
5343
+ * Payload: {@link TmlEventPayload}.
5175
5344
  */
5176
5345
  ExportTML = "exportTSL",
5177
5346
  /**
@@ -5210,6 +5379,7 @@ export declare enum EmbedEvent {
5210
5379
  * console.log('show data', payload);
5211
5380
  * })
5212
5381
  * ```
5382
+ * Payload: {@link AnswerScope}.
5213
5383
  */
5214
5384
  ShowUnderlyingData = "showUnderlyingData",
5215
5385
  /**
@@ -5221,6 +5391,7 @@ export declare enum EmbedEvent {
5221
5391
  * console.log('switch view', payload);
5222
5392
  * })
5223
5393
  * ```
5394
+ * Payload: {@link AnswerChartSwitcherPayload}.
5224
5395
  */
5225
5396
  AnswerChartSwitcher = "answerChartSwitcher",
5226
5397
  /**
@@ -5242,6 +5413,7 @@ export declare enum EmbedEvent {
5242
5413
  * console.log('Liveboard details', payload);
5243
5414
  * })
5244
5415
  * ```
5416
+ * Payload: {@link LiveboardScope}.
5245
5417
  */
5246
5418
  LiveboardInfo = "pinboardInfo",
5247
5419
  /**
@@ -5253,6 +5425,7 @@ export declare enum EmbedEvent {
5253
5425
  * console.log('favorites', payload);
5254
5426
  * })
5255
5427
  * ```
5428
+ * Payload: {@link FavoritePayload}.
5256
5429
  */
5257
5430
  AddToFavorites = "addToFavorites",
5258
5431
  /**
@@ -5264,6 +5437,7 @@ export declare enum EmbedEvent {
5264
5437
  * console.log('Liveboard schedule', payload);
5265
5438
  * })
5266
5439
  * ```
5440
+ * Payload: {@link LiveboardScope}.
5267
5441
  */
5268
5442
  Schedule = "subscription",
5269
5443
  /**
@@ -5278,6 +5452,7 @@ export declare enum EmbedEvent {
5278
5452
  * console.log('Liveboard edit', payload);
5279
5453
  * })
5280
5454
  * ```
5455
+ * Payload: {@link LiveboardVizScope}.
5281
5456
  */
5282
5457
  Edit = "edit",
5283
5458
  /**
@@ -5319,6 +5494,7 @@ export declare enum EmbedEvent {
5319
5494
  * console.log('Copy', payload);
5320
5495
  * })
5321
5496
  * ```
5497
+ * Payload: {@link MakeACopyPayload}.
5322
5498
  */
5323
5499
  MakeACopy = "makeACopy",
5324
5500
  /**
@@ -5334,6 +5510,7 @@ export declare enum EmbedEvent {
5334
5510
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
5335
5511
  * })
5336
5512
  * ```
5513
+ * Payload: {@link LiveboardVizScope}.
5337
5514
  */
5338
5515
  Present = "present",
5339
5516
  /**
@@ -5344,6 +5521,7 @@ export declare enum EmbedEvent {
5344
5521
  * liveboardEmbed.on(EmbedEvent.Delete,
5345
5522
  * {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
5346
5523
  * ```
5524
+ * Payload: {@link LiveboardScope}.
5347
5525
  */
5348
5526
  Delete = "delete",
5349
5527
  /**
@@ -5353,6 +5531,7 @@ export declare enum EmbedEvent {
5353
5531
  * ```js
5354
5532
  * liveboardEmbed.on(EmbedEvent.SchedulesList)
5355
5533
  * ```
5534
+ * Payload: {@link LiveboardScope}.
5356
5535
  */
5357
5536
  SchedulesList = "schedule-list",
5358
5537
  /**
@@ -5362,6 +5541,7 @@ export declare enum EmbedEvent {
5362
5541
  * ```js
5363
5542
  * liveboardEmbed.on(EmbedEvent.Cancel)
5364
5543
  * ```
5544
+ * Payload: {@link LiveboardScope}.
5365
5545
  */
5366
5546
  Cancel = "cancel",
5367
5547
  /**
@@ -5372,6 +5552,7 @@ export declare enum EmbedEvent {
5372
5552
  * liveboardEmbed.on(EmbedEvent.Explore, {
5373
5553
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
5374
5554
  * ```
5555
+ * Payload: {@link LiveboardVizScope}.
5375
5556
  */
5376
5557
  Explore = "explore",
5377
5558
  /**
@@ -5382,6 +5563,7 @@ export declare enum EmbedEvent {
5382
5563
  * liveboardEmbed.on(EmbedEvent.CopyLink, {
5383
5564
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
5384
5565
  * ```
5566
+ * Payload: {@link CopyLinkPayload}.
5385
5567
  */
5386
5568
  CopyLink = "embedDocument",
5387
5569
  /**
@@ -5393,6 +5575,7 @@ export declare enum EmbedEvent {
5393
5575
  * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
5394
5576
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
5395
5577
  * ```
5578
+ * Payload: {@link CrossFilterChangedPayload}.
5396
5579
  */
5397
5580
  CrossFilterChanged = "cross-filter-changed",
5398
5581
  /**
@@ -5404,6 +5587,7 @@ export declare enum EmbedEvent {
5404
5587
  * console.log('VizPointClick', payload)
5405
5588
  * })
5406
5589
  * ```
5590
+ * Payload: {@link VizInteractionPayload}.
5407
5591
  */
5408
5592
  VizPointRightClick = "vizPointRightClick",
5409
5593
  /**
@@ -5431,6 +5615,7 @@ export declare enum EmbedEvent {
5431
5615
  * })
5432
5616
  * ```
5433
5617
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.0.sw
5618
+ * Payload: {@link FilterChangedPayload}.
5434
5619
  */
5435
5620
  FilterChanged = "filterChanged",
5436
5621
  /**
@@ -5453,6 +5638,7 @@ export declare enum EmbedEvent {
5453
5638
  * @returns isPublic: boolean
5454
5639
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5455
5640
  * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5641
+ * Payload: {@link PersonalisedViewPayload}.
5456
5642
  */
5457
5643
  UpdatePersonalisedView = "updatePersonalisedView",
5458
5644
  /**
@@ -5474,6 +5660,7 @@ export declare enum EmbedEvent {
5474
5660
  * @returns isPublic: boolean
5475
5661
  * @version SDK: 1.26.0 | ThoughtSpot: 9.7.0.cl, 9.8.0.sw
5476
5662
  * @deprecated SDK: 1.48.0 | ThoughtSpot: 26.5.0.cl
5663
+ * Payload: {@link PersonalisedViewPayload}.
5477
5664
  */
5478
5665
  SavePersonalisedView = "savePersonalisedView",
5479
5666
  /**
@@ -5548,6 +5735,7 @@ export declare enum EmbedEvent {
5548
5735
  /**
5549
5736
  * Emitted when a Liveboard or visualization is renamed.
5550
5737
  * @version SDK: 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
5738
+ * Payload: {@link RenamePayload}.
5551
5739
  */
5552
5740
  Rename = "rename",
5553
5741
  /**
@@ -5633,6 +5821,7 @@ export declare enum EmbedEvent {
5633
5821
  * })
5634
5822
  * ```
5635
5823
  * @version SDK: 1.29.0 | ThoughtSpot: 10.3.0.cl
5824
+ * Payload: {@link ParameterChangedPayload}.
5636
5825
  */
5637
5826
  ParameterChanged = "parameterChanged",
5638
5827
  /**
@@ -5676,6 +5865,7 @@ export declare enum EmbedEvent {
5676
5865
  * })
5677
5866
  * ```
5678
5867
  * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl
5868
+ * Payload: {@link TableVizRenderedPayload}.
5679
5869
  */
5680
5870
  TableVizRendered = "TableVizRendered",
5681
5871
  /**
@@ -5700,12 +5890,14 @@ export declare enum EmbedEvent {
5700
5890
  * @hidden
5701
5891
  * Emitted when a user exits present mode.
5702
5892
  * @version SDK: 1.40.0 | ThoughtSpot: 10.11.0.cl
5893
+ * Payload: {@link ExitPresentModePayload}.
5703
5894
  */
5704
5895
  ExitPresentMode = "exitPresentMode",
5705
5896
  /**
5706
5897
  * Emitted when a user requests the full height lazy load data.
5707
5898
  * @version SDK: 1.39.0 | ThoughtSpot: 10.10.0.cl
5708
5899
  * @hidden
5900
+ * Payload: none.
5709
5901
  */
5710
5902
  RequestVisibleEmbedCoordinates = "requestVisibleEmbedCoordinates",
5711
5903
  /**
@@ -5739,6 +5931,7 @@ export declare enum EmbedEvent {
5739
5931
  * })
5740
5932
  * ```
5741
5933
  * @version SDK: 1.45.0 | ThoughtSpot: 26.2.0.cl
5934
+ * Payload: {@link VizScope}.
5742
5935
  */
5743
5936
  AddToCoaching = "addToCoaching",
5744
5937
  /**
@@ -5828,6 +6021,7 @@ export declare enum EmbedEvent {
5828
6021
  * console.log('EmbedListenerReady');
5829
6022
  * })
5830
6023
  * ```
6024
+ * Payload: none.
5831
6025
  */
5832
6026
  EmbedListenerReady = "EmbedListenerReady",
5833
6027
  /**
@@ -6202,6 +6396,7 @@ export declare enum EmbedEvent {
6202
6396
  * })
6203
6397
  * ```
6204
6398
  * @version SDK: 1.48.0 | ThoughtSpot Cloud: 26.5.0.cl
6399
+ * Payload: {@link TestScheduleEmailPayload}.
6205
6400
  */
6206
6401
  SendTestScheduleEmail = "sendTestScheduleEmail",
6207
6402
  /**
@@ -6712,6 +6907,19 @@ export declare enum HostEvent {
6712
6907
  * ```
6713
6908
  */
6714
6909
  OpenAddParameterModal = "openAddParameterModal",
6910
+ /**
6911
+ * Add a tab to the Liveboard, the same action as the *Tab* option in the
6912
+ * *Add* dropdown in the Liveboard edit header.
6913
+ *
6914
+ * The Liveboard must be in edit mode; the event is ignored otherwise.
6915
+ *
6916
+ * @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
6917
+ * @example
6918
+ * ```js
6919
+ * liveboardEmbed.trigger(HostEvent.OpenAddTabModal);
6920
+ * ```
6921
+ */
6922
+ OpenAddTabModal = "openAddTabModal",
6715
6923
  /**
6716
6924
  * Open the parameter panel for a particular parameter on a Liveboard.
6717
6925
  * Mirrors {@link HostEvent.OpenFilter} for parameters.
@@ -8947,6 +9155,21 @@ export type SpotterFileUploadFileTypes = {
8947
9155
  */
8948
9156
  export declare enum Action {
8949
9157
  /**
9158
+ * The **Add** button on a Liveboard in edit mode.
9159
+ * Controls the visibility and disabled state of the Add panel button
9160
+ * in the Liveboard edit toolbar, which allows users to add
9161
+ * visualizations, filters, parameters, and tabs.
9162
+ * @example
9163
+ * ```js
9164
+ * hiddenActions: [Action.LiveboardAddPanel]
9165
+ * // or
9166
+ * disabledActions: [Action.LiveboardAddPanel]
9167
+ * ```
9168
+ * @version SDK: 1.56.0 | ThoughtSpot Cloud: 27.1.0.cl
9169
+ */
9170
+ LiveboardAddPanel = "liveboardAddPanel",
9171
+ /**
9172
+ *
8950
9173
  * The **Save** action on an Answer or Liveboard.
8951
9174
  * Allows users to save the changes.
8952
9175
  * @example
@@ -11197,7 +11420,103 @@ export declare enum Action {
11197
11420
  * });
11198
11421
  * ```
11199
11422
  */
11200
- Cancel = "cancel"
11423
+ Cancel = "cancel",
11424
+ /**
11425
+ * Controls the visibility and disabled state of the "Version history" menu item for a Liveboard or Answer.
11426
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
11427
+ * @example
11428
+ * ```js
11429
+ * {
11430
+ * hiddenActions: [Action.ShowVersionHistory],
11431
+ * disabledActions: [Action.ShowVersionHistory],
11432
+ * }
11433
+ * ```
11434
+ */
11435
+ ShowVersionHistory = "showVersionHistory",
11436
+ /**
11437
+ * Controls the visibility and disabled state of the "Enable version control" menu item for a Liveboard or Answer.
11438
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
11439
+ * @example
11440
+ * ```js
11441
+ * {
11442
+ * hiddenActions: [Action.EnableVersionControl],
11443
+ * disabledActions: [Action.EnableVersionControl],
11444
+ * }
11445
+ * ```
11446
+ */
11447
+ EnableVersionControl = "enableVersionControl",
11448
+ /**
11449
+ * Controls the visibility and disabled state of the "Disable version control" menu item for a Liveboard or Answer.
11450
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.10.0.cl
11451
+ * @example
11452
+ * ```js
11453
+ * {
11454
+ * hiddenActions: [Action.DisableVersionControl],
11455
+ * disabledActions: [Action.DisableVersionControl],
11456
+ * }
11457
+ * ```
11458
+ */
11459
+ DisableVersionControl = "disableVersionControl",
11460
+ /**
11461
+ * Controls the visibility and disabled state of the "Withdraw verification" menu item for a verified Liveboard.
11462
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 9.8.0.cl
11463
+ * @example
11464
+ * ```js
11465
+ * {
11466
+ * hiddenActions: [Action.WithdrawVerification],
11467
+ * disabledActions: [Action.WithdrawVerification],
11468
+ * }
11469
+ * ```
11470
+ */
11471
+ WithdrawVerification = "withdrawVerification",
11472
+ /**
11473
+ * Controls the visibility and disabled state of the "Switch to new chart experience" menu item on an Answer.
11474
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
11475
+ * @example
11476
+ * ```js
11477
+ * {
11478
+ * hiddenActions: [Action.SwitchToNewChartExperience],
11479
+ * disabledActions: [Action.SwitchToNewChartExperience],
11480
+ * }
11481
+ * ```
11482
+ */
11483
+ SwitchToNewChartExperience = "switchToNewChartExperience",
11484
+ /**
11485
+ * Controls the visibility and disabled state of the "Switch to classic chart experience" menu item on an Answer.
11486
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.10.0.cl
11487
+ * @example
11488
+ * ```js
11489
+ * {
11490
+ * hiddenActions: [Action.SwitchToClassicChartExperience],
11491
+ * disabledActions: [Action.SwitchToClassicChartExperience],
11492
+ * }
11493
+ * ```
11494
+ */
11495
+ SwitchToClassicChartExperience = "switchToClassicChartExperience",
11496
+ /**
11497
+ * Controls the visibility and disabled state of the "Monitor" menu item on an Answer, which includes the alert options.
11498
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 10.5.0.cl
11499
+ * @example
11500
+ * ```js
11501
+ * {
11502
+ * hiddenActions: [Action.Monitor],
11503
+ * disabledActions: [Action.Monitor],
11504
+ * }
11505
+ * ```
11506
+ */
11507
+ Monitor = "monitor",
11508
+ /**
11509
+ * Controls the visibility and disabled state of the "View explanation" button in the footer of a Spotter answer, which opens the explanation and verification details.
11510
+ * @version SDK: 1.54.0 | ThoughtSpot Cloud: 26.11.0.cl
11511
+ * @example
11512
+ * ```js
11513
+ * {
11514
+ * hiddenActions: [Action.SpotterViewExplanation],
11515
+ * disabledActions: [Action.SpotterViewExplanation],
11516
+ * }
11517
+ * ```
11518
+ */
11519
+ SpotterViewExplanation = "spotterViewExplanation"
11201
11520
  }
11202
11521
  export declare enum PrefetchFeatures {
11203
11522
  FullApp = "FullApp",
@@ -12756,6 +13075,7 @@ export interface HostEventRequestMap {
12756
13075
  [HostEvent.AIHighlights]: void;
12757
13076
  [HostEvent.SendTestScheduleEmail]: ScheduleEmailRequest;
12758
13077
  [HostEvent.RefreshLiveboardBrowserCache]: ScheduleEmailRequest;
13078
+ [HostEvent.OpenAddTabModal]: void;
12759
13079
  [HostEvent.SpotterSearch]: SpotterSearchRequest;
12760
13080
  [HostEvent.ResetSpotterConversation]: void;
12761
13081
  [HostEvent.ShareSpotterConversation]: ConversationScopedRequest;
@@ -12817,22 +13137,216 @@ export type TriggerData<HostEventT extends HostEvent> = HostEventRequest<HostEve
12817
13137
  */
12818
13138
  export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType = ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
12819
13139
  /**
12820
- * Typed `data` field per embed event. Seed with audited events only.
13140
+ * Base for every payload. Known fields are declared on the interfaces below;
13141
+ * additional fields the host may send stay `any`, so a callback reading one
13142
+ * keeps compiling.
12821
13143
  */
12822
- export interface EmbedEventDataExtension {
12823
- [EmbedEvent.AuthInit]: {
12824
- /**
12825
- * Whether authentication was successful.
12826
- */
12827
- isLoggedIn?: boolean;
12828
- [key: string]: any;
13144
+ export interface EmbedEventPayloadBase {
13145
+ [key: string]: any;
13146
+ }
13147
+ /** Present on events raised from a Spotter conversation. */
13148
+ export interface ConversationScope extends EmbedEventPayloadBase {
13149
+ convId?: string;
13150
+ messageId?: string;
13151
+ }
13152
+ /** Scoped to a single visualization (optionally within a conversation). */
13153
+ export interface VizScope extends ConversationScope {
13154
+ vizId?: string;
13155
+ }
13156
+ /** Scoped to a Liveboard. */
13157
+ export interface LiveboardScope extends EmbedEventPayloadBase {
13158
+ liveboardId?: string;
13159
+ }
13160
+ /** Scoped to an Answer. */
13161
+ export interface AnswerScope extends EmbedEventPayloadBase {
13162
+ answerId?: string;
13163
+ vizId?: string;
13164
+ }
13165
+ /** Actions available on a viz within a Liveboard. */
13166
+ export interface LiveboardVizScope extends LiveboardScope, VizScope {
13167
+ }
13168
+ /** An empty payload — the event carries no data. */
13169
+ export type EmptyPayload = Record<string, never>;
13170
+ /** The answer data backing the embed, delivered with {@link EmbedEvent.Data}. */
13171
+ export interface DataEventPayload extends VizScope {
13172
+ embedAnswerData?: any;
13173
+ }
13174
+ /** {@link EmbedEvent.Error}. `message` may be a single string or a list. */
13175
+ export interface EmbedErrorPayload extends EmbedEventPayloadBase {
13176
+ errorType?: any;
13177
+ message?: string | string[];
13178
+ code?: any;
13179
+ error?: {
13180
+ message?: string;
12829
13181
  };
13182
+ errors?: string[];
13183
+ }
13184
+ export interface FilterChangedPayload extends EmbedEventPayloadBase {
13185
+ liveboardFilters?: any[];
13186
+ runtimeFilters?: RuntimeFilter[];
13187
+ }
13188
+ export interface CrossFilterChangedPayload extends EmbedEventPayloadBase {
13189
+ action?: string;
13190
+ filterContentList?: any;
13191
+ filterRemoved?: string[];
13192
+ removableColumnsFilterContent?: any;
13193
+ }
13194
+ export interface ParameterChangedPayload extends ConversationScope {
13195
+ parameters?: any[];
13196
+ }
13197
+ export interface QueryChangedPayload extends VizScope {
13198
+ search?: string;
13199
+ }
13200
+ /**
13201
+ * Data-source(s) chosen in the picker. The host sends an object; older hosts may
13202
+ * send a bare list of worksheet ids, so {@link EmbedEvent.DataSourceSelected}
13203
+ * resolves to `string[] | DataSourceSelectedPayload`.
13204
+ */
13205
+ export interface DataSourceSelectedPayload extends EmbedEventPayloadBase {
13206
+ worksheetId?: string;
13207
+ worksheetName?: string;
13208
+ worksheetIds?: string[];
13209
+ }
13210
+ /** Shared by {@link EmbedEvent.VizPointClick} and its siblings. */
13211
+ export interface VizInteractionPayload extends VizScope {
13212
+ clickedPoint?: any;
13213
+ selectedPoints?: any[];
13214
+ embedAnswerData?: any;
13215
+ }
13216
+ export interface DrilldownPayload extends ConversationScope {
13217
+ drillColumn?: any;
13218
+ clickedPoint?: any;
13219
+ selectedPoints?: any[];
13220
+ }
13221
+ export interface TableVizRenderedPayload extends VizScope {
13222
+ id?: string;
13223
+ data?: any;
13224
+ }
13225
+ export interface SaveEventPayload extends LiveboardVizScope {
13226
+ answerId?: string;
13227
+ }
13228
+ export interface MakeACopyPayload extends LiveboardVizScope {
13229
+ newLiveboardId?: string;
13230
+ }
13231
+ /** Downloads, either viz/answer scoped or Liveboard scoped. */
13232
+ export interface DownloadEventPayload extends VizScope {
13233
+ answerId?: string;
13234
+ liveboardId?: string;
13235
+ }
13236
+ /** TML export/edit/update — answer or Liveboard scoped. */
13237
+ export interface TmlEventPayload extends EmbedEventPayloadBase {
13238
+ answerId?: string;
13239
+ liveboardId?: string;
13240
+ vizId?: string;
13241
+ }
13242
+ export interface AnswerChartSwitcherPayload extends ConversationScope {
13243
+ answerId?: string;
13244
+ /** The mode switched to (chart or table). */
13245
+ chartType?: string;
13246
+ }
13247
+ export interface CopyToClipboardPayload extends ConversationScope {
13248
+ answerId?: string;
13249
+ }
13250
+ export interface PinEventPayload extends VizScope {
13251
+ liveboardId?: string;
13252
+ containerId?: string;
13253
+ answerId?: string;
13254
+ }
13255
+ export interface CopyLinkPayload extends LiveboardScope {
13256
+ vizId?: string;
13257
+ metricId?: any;
13258
+ }
13259
+ export interface FavoritePayload extends LiveboardScope {
13260
+ isFavorite?: boolean;
13261
+ }
13262
+ export interface TestScheduleEmailPayload extends LiveboardScope {
13263
+ sendToSelf?: boolean;
13264
+ }
13265
+ /** Note: the app sends `liveboardID` (capital ID) for this event. */
13266
+ export interface RenamePayload extends EmbedEventPayloadBase {
13267
+ liveboardID?: string;
13268
+ vizId?: string;
13269
+ title?: string;
13270
+ description?: string;
13271
+ }
13272
+ export interface PersonalisedViewPayload extends LiveboardScope {
13273
+ viewName?: string;
13274
+ viewId?: string;
13275
+ isPublic?: boolean;
13276
+ }
13277
+ export interface ExitPresentModePayload extends EmbedEventPayloadBase {
13278
+ type?: string;
13279
+ data?: any;
13280
+ }
13281
+ /** {@link EmbedEvent.AuthInit}. */
13282
+ export interface AuthInitPayload extends EmbedEventPayloadBase {
13283
+ /** Whether authentication was successful. */
13284
+ isLoggedIn?: boolean;
13285
+ }
13286
+ /**
13287
+ * Typed `data` field per embed event. Events not listed resolve to `any`.
13288
+ */
13289
+ export interface EmbedEventDataExtension {
13290
+ [EmbedEvent.AuthInit]: AuthInitPayload;
12830
13291
  [EmbedEvent.EmbedListenerReady]: Record<string, any>;
13292
+ [EmbedEvent.Error]: EmbedErrorPayload | string;
12831
13293
  /**
12832
13294
  * Fired when a callback-type custom action is triggered. Use
12833
- * `payload.data.id` to identify which action fired.
13295
+ * `payload.data.id` to identify which action fired; see also
13296
+ * {@link CustomActionEventPayload} for the `answerService` enrichment.
12834
13297
  */
12835
13298
  [EmbedEvent.CustomAction]: CustomActionPayload;
13299
+ [EmbedEvent.FilterChanged]: FilterChangedPayload;
13300
+ [EmbedEvent.CrossFilterChanged]: CrossFilterChangedPayload;
13301
+ [EmbedEvent.ParameterChanged]: ParameterChangedPayload;
13302
+ [EmbedEvent.VizPointClick]: VizInteractionPayload;
13303
+ [EmbedEvent.VizPointDoubleClick]: VizInteractionPayload;
13304
+ [EmbedEvent.VizPointRightClick]: VizInteractionPayload;
13305
+ [EmbedEvent.Drilldown]: DrilldownPayload;
13306
+ [EmbedEvent.TableVizRendered]: TableVizRenderedPayload;
13307
+ [EmbedEvent.Data]: DataEventPayload;
13308
+ [EmbedEvent.QueryChanged]: string | QueryChangedPayload;
13309
+ [EmbedEvent.Save]: SaveEventPayload;
13310
+ [EmbedEvent.Edit]: LiveboardVizScope;
13311
+ [EmbedEvent.Present]: LiveboardVizScope;
13312
+ [EmbedEvent.Explore]: LiveboardVizScope;
13313
+ [EmbedEvent.MakeACopy]: MakeACopyPayload;
13314
+ [EmbedEvent.AnswerDelete]: AnswerScope;
13315
+ [EmbedEvent.AnswerChartSwitcher]: AnswerChartSwitcherPayload;
13316
+ [EmbedEvent.CopyToClipboard]: CopyToClipboardPayload;
13317
+ [EmbedEvent.SpotIQAnalyze]: AnswerScope;
13318
+ [EmbedEvent.ShowUnderlyingData]: AnswerScope;
13319
+ [EmbedEvent.AddToCoaching]: VizScope;
13320
+ [EmbedEvent.Pin]: PinEventPayload;
13321
+ [EmbedEvent.Download]: VizScope;
13322
+ [EmbedEvent.DownloadAsPng]: DownloadEventPayload;
13323
+ [EmbedEvent.DownloadAsCsv]: DownloadEventPayload;
13324
+ [EmbedEvent.DownloadAsXlsx]: DownloadEventPayload;
13325
+ [EmbedEvent.DownloadAsPdf]: DownloadEventPayload;
13326
+ [EmbedEvent.DownloadLiveboardAsContinuousPDF]: LiveboardScope;
13327
+ [EmbedEvent.ExportTML]: TmlEventPayload;
13328
+ [EmbedEvent.EditTML]: TmlEventPayload;
13329
+ [EmbedEvent.UpdateTML]: TmlEventPayload;
13330
+ [EmbedEvent.Cancel]: LiveboardScope;
13331
+ [EmbedEvent.Delete]: LiveboardScope;
13332
+ [EmbedEvent.Schedule]: LiveboardScope;
13333
+ [EmbedEvent.SchedulesList]: LiveboardScope;
13334
+ [EmbedEvent.SendTestScheduleEmail]: TestScheduleEmailPayload;
13335
+ [EmbedEvent.LiveboardInfo]: LiveboardScope;
13336
+ [EmbedEvent.AIHighlights]: LiveboardScope;
13337
+ [EmbedEvent.Rename]: RenamePayload;
13338
+ [EmbedEvent.AddToFavorites]: FavoritePayload;
13339
+ [EmbedEvent.CopyLink]: CopyLinkPayload;
13340
+ [EmbedEvent.ExitPresentMode]: ExitPresentModePayload;
13341
+ [EmbedEvent.SavePersonalisedView]: PersonalisedViewPayload;
13342
+ [EmbedEvent.UpdatePersonalisedView]: PersonalisedViewPayload;
13343
+ [EmbedEvent.AddRemoveColumns]: string[];
13344
+ [EmbedEvent.DataSourceSelected]: string[] | DataSourceSelectedPayload;
13345
+ [EmbedEvent.DialogOpen]: EmptyPayload;
13346
+ [EmbedEvent.DialogClose]: EmptyPayload;
13347
+ [EmbedEvent.LiveboardRendered]: EmptyPayload;
13348
+ [EmbedEvent.RequestVisibleEmbedCoordinates]: EmptyPayload;
13349
+ [EmbedEvent.EmbedIframeCenter]: EmptyPayload;
12836
13350
  }
12837
13351
  /**
12838
13352
  * Resolves the typed `data` payload for an embed event; `any` when the
@@ -17311,7 +17825,7 @@ export interface FilterChangedFilterGroup {
17311
17825
  /**
17312
17826
  * Shape of the payload received via `LiveboardEmbed.on(EmbedEvent.FilterChanged, ...)`.
17313
17827
  */
17314
- export interface FilterChangedPayload {
17828
+ interface FilterChangedPayload$1 {
17315
17829
  liveboardFilters?: FilterChangedFilterGroup[];
17316
17830
  runtimeFilters?: RuntimeFilter[];
17317
17831
  }
@@ -17359,7 +17873,7 @@ export interface UpdateFiltersPayload {
17359
17873
  * liveboardEmbed.trigger(HostEvent.UpdateFilters, savedFilters);
17360
17874
  * ```
17361
17875
  */
17362
- export declare function convertFilterChangedToUpdateFiltersPayload(filterChangedPayload: FilterChangedPayload): UpdateFiltersPayload;
17876
+ export declare function convertFilterChangedToUpdateFiltersPayload(filterChangedPayload: FilterChangedPayload$1): UpdateFiltersPayload;
17363
17877
  /**
17364
17878
  * Resets the auth token and a new token will be fetched on the next request.
17365
17879
  * @example
@@ -17411,6 +17925,7 @@ export declare const resetCachedAuthToken: () => void;
17411
17925
  export declare function startAutoMCPFrameRenderer(viewConfig?: AutoMCPFrameRendererViewConfig): MutationObserver;
17412
17926
 
17413
17927
  export {
17928
+ FilterChangedPayload$1 as FilterChangedPayload,
17414
17929
  getEmbedConfig as getInitConfig,
17415
17930
  };
17416
17931