@thoughtspot/visual-embed-sdk 1.36.2 → 1.36.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (150) hide show
  1. package/cjs/package.json +1 -1
  2. package/cjs/src/authToken.d.ts.map +1 -1
  3. package/cjs/src/authToken.js +10 -3
  4. package/cjs/src/authToken.js.map +1 -1
  5. package/cjs/src/embed/app.d.ts +14 -0
  6. package/cjs/src/embed/app.d.ts.map +1 -1
  7. package/cjs/src/embed/app.js +4 -1
  8. package/cjs/src/embed/app.js.map +1 -1
  9. package/cjs/src/embed/app.spec.js +17 -0
  10. package/cjs/src/embed/app.spec.js.map +1 -1
  11. package/cjs/src/embed/embedConfig.d.ts +1 -1
  12. package/cjs/src/embed/embedConfig.d.ts.map +1 -1
  13. package/cjs/src/embed/embedConfig.js +5 -4
  14. package/cjs/src/embed/embedConfig.js.map +1 -1
  15. package/cjs/src/embed/liveboard.d.ts +4 -1
  16. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  17. package/cjs/src/embed/liveboard.js.map +1 -1
  18. package/cjs/src/types.d.ts +85 -66
  19. package/cjs/src/types.d.ts.map +1 -1
  20. package/cjs/src/types.js +78 -59
  21. package/cjs/src/types.js.map +1 -1
  22. package/cjs/src/utils.d.ts +12 -0
  23. package/cjs/src/utils.d.ts.map +1 -1
  24. package/cjs/src/utils.js +21 -1
  25. package/cjs/src/utils.js.map +1 -1
  26. package/cjs/src/utils.spec.js +15 -0
  27. package/cjs/src/utils.spec.js.map +1 -1
  28. package/dist/{index-B3hd6DTM.js → index-BJx3m5_V.js} +1 -1
  29. package/dist/src/authToken.d.ts.map +1 -1
  30. package/dist/src/embed/app.d.ts +14 -0
  31. package/dist/src/embed/app.d.ts.map +1 -1
  32. package/dist/src/embed/embedConfig.d.ts +1 -1
  33. package/dist/src/embed/embedConfig.d.ts.map +1 -1
  34. package/dist/src/embed/liveboard.d.ts +4 -1
  35. package/dist/src/embed/liveboard.d.ts.map +1 -1
  36. package/dist/src/types.d.ts +85 -66
  37. package/dist/src/types.d.ts.map +1 -1
  38. package/dist/src/utils.d.ts +12 -0
  39. package/dist/src/utils.d.ts.map +1 -1
  40. package/dist/tsembed-react.es.js +115 -69
  41. package/dist/tsembed-react.js +114 -68
  42. package/dist/tsembed.es.js +117 -71
  43. package/dist/tsembed.js +116 -70
  44. package/dist/visual-embed-sdk-react-full.d.ts +104 -68
  45. package/dist/visual-embed-sdk-react.d.ts +104 -68
  46. package/dist/visual-embed-sdk.d.ts +104 -68
  47. package/lib/package.json +1 -1
  48. package/lib/src/authToken.d.ts.map +1 -1
  49. package/lib/src/authToken.js +10 -3
  50. package/lib/src/authToken.js.map +1 -1
  51. package/lib/src/embed/app.d.ts +14 -0
  52. package/lib/src/embed/app.d.ts.map +1 -1
  53. package/lib/src/embed/app.js +4 -1
  54. package/lib/src/embed/app.js.map +1 -1
  55. package/lib/src/embed/app.spec.js +17 -0
  56. package/lib/src/embed/app.spec.js.map +1 -1
  57. package/lib/src/embed/embedConfig.d.ts +1 -1
  58. package/lib/src/embed/embedConfig.d.ts.map +1 -1
  59. package/lib/src/embed/embedConfig.js +5 -4
  60. package/lib/src/embed/embedConfig.js.map +1 -1
  61. package/lib/src/embed/liveboard.d.ts +4 -1
  62. package/lib/src/embed/liveboard.d.ts.map +1 -1
  63. package/lib/src/embed/liveboard.js.map +1 -1
  64. package/lib/src/types.d.ts +85 -66
  65. package/lib/src/types.d.ts.map +1 -1
  66. package/lib/src/types.js +78 -59
  67. package/lib/src/types.js.map +1 -1
  68. package/lib/src/utils.d.ts +12 -0
  69. package/lib/src/utils.d.ts.map +1 -1
  70. package/lib/src/utils.js +18 -0
  71. package/lib/src/utils.js.map +1 -1
  72. package/lib/src/utils.spec.js +16 -1
  73. package/lib/src/utils.spec.js.map +1 -1
  74. package/lib/src/visual-embed-sdk.d.ts +104 -68
  75. package/package.json +1 -1
  76. package/src/authToken.ts +11 -3
  77. package/src/embed/app.spec.ts +27 -0
  78. package/src/embed/app.ts +19 -0
  79. package/src/embed/embedConfig.ts +5 -4
  80. package/src/embed/liveboard.ts +4 -1
  81. package/src/types.ts +89 -70
  82. package/src/utils.spec.ts +21 -0
  83. package/src/utils.ts +21 -0
  84. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
  85. package/cjs/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
  86. package/cjs/src/embed/searchEmbed-basic-auth.spec.js +0 -104
  87. package/cjs/src/embed/searchEmbed-basic-auth.spec.js.map +0 -1
  88. package/cjs/src/hostEventsTypeMapping.d.ts +0 -2
  89. package/cjs/src/hostEventsTypeMapping.d.ts.map +0 -1
  90. package/cjs/src/hostEventsTypeMapping.js +0 -4
  91. package/cjs/src/hostEventsTypeMapping.js.map +0 -1
  92. package/cjs/src/utils/embedApi/contracts.d.ts +0 -101
  93. package/cjs/src/utils/embedApi/contracts.d.ts.map +0 -1
  94. package/cjs/src/utils/embedApi/contracts.js +0 -17
  95. package/cjs/src/utils/embedApi/contracts.js.map +0 -1
  96. package/cjs/src/utils/embedApi/embedApiClient.d.ts +0 -12
  97. package/cjs/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
  98. package/cjs/src/utils/embedApi/embedApiClient.js +0 -46
  99. package/cjs/src/utils/embedApi/embedApiClient.js.map +0 -1
  100. package/cjs/src/utils/embedApi/processEmbedApi.d.ts +0 -9
  101. package/cjs/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
  102. package/cjs/src/utils/embedApi/processEmbedApi.js +0 -18
  103. package/cjs/src/utils/embedApi/processEmbedApi.js.map +0 -1
  104. package/dist/index-BBBimG1x.js +0 -7370
  105. package/dist/index-BGnxP5NY.js +0 -7370
  106. package/dist/index-CENLvayL.js +0 -7370
  107. package/dist/index-CR5u7BMC.js +0 -7370
  108. package/dist/index-CbltIawo.js +0 -7370
  109. package/dist/index-CoQfqaHj.js +0 -7370
  110. package/dist/index-CzwzS0P4.js +0 -7370
  111. package/dist/index-D-9WUCUl.js +0 -7370
  112. package/dist/index-DFwi_pV_.js +0 -7370
  113. package/dist/index-DOIjN0N_.js +0 -7370
  114. package/dist/index-DYBx8SuE.js +0 -7370
  115. package/dist/index-DaLHJaLd.js +0 -7370
  116. package/dist/index-DnJX-gN2.js +0 -7370
  117. package/dist/index-DpuhnTj2.js +0 -7370
  118. package/dist/index-IDmSUe93.js +0 -7370
  119. package/dist/index-nWevLycs.js +0 -7370
  120. package/dist/index-vxW97_xb.js +0 -7370
  121. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
  122. package/dist/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
  123. package/dist/src/hostEventsTypeMapping.d.ts +0 -2
  124. package/dist/src/hostEventsTypeMapping.d.ts.map +0 -1
  125. package/dist/src/utils/embedApi/contracts.d.ts +0 -101
  126. package/dist/src/utils/embedApi/contracts.d.ts.map +0 -1
  127. package/dist/src/utils/embedApi/embedApiClient.d.ts +0 -12
  128. package/dist/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
  129. package/dist/src/utils/embedApi/processEmbedApi.d.ts +0 -9
  130. package/dist/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
  131. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts +0 -2
  132. package/lib/src/embed/searchEmbed-basic-auth.spec.d.ts.map +0 -1
  133. package/lib/src/embed/searchEmbed-basic-auth.spec.js +0 -101
  134. package/lib/src/embed/searchEmbed-basic-auth.spec.js.map +0 -1
  135. package/lib/src/hostEventsTypeMapping.d.ts +0 -2
  136. package/lib/src/hostEventsTypeMapping.d.ts.map +0 -1
  137. package/lib/src/hostEventsTypeMapping.js +0 -2
  138. package/lib/src/hostEventsTypeMapping.js.map +0 -1
  139. package/lib/src/utils/embedApi/contracts.d.ts +0 -101
  140. package/lib/src/utils/embedApi/contracts.d.ts.map +0 -1
  141. package/lib/src/utils/embedApi/contracts.js +0 -14
  142. package/lib/src/utils/embedApi/contracts.js.map +0 -1
  143. package/lib/src/utils/embedApi/embedApiClient.d.ts +0 -12
  144. package/lib/src/utils/embedApi/embedApiClient.d.ts.map +0 -1
  145. package/lib/src/utils/embedApi/embedApiClient.js +0 -42
  146. package/lib/src/utils/embedApi/embedApiClient.js.map +0 -1
  147. package/lib/src/utils/embedApi/processEmbedApi.d.ts +0 -9
  148. package/lib/src/utils/embedApi/processEmbedApi.d.ts.map +0 -1
  149. package/lib/src/utils/embedApi/processEmbedApi.js +0 -14
  150. package/lib/src/utils/embedApi/processEmbedApi.js.map +0 -1
@@ -137,6 +137,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
137
137
  * ```
138
138
  */
139
139
  disableProfileAndHelp?: boolean;
140
+ /**
141
+ * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
142
+ * @default true
143
+ * Whether the help menu in the top nav bar should be served
144
+ * from Pendo or ThoughtSpot's internal help items.
145
+ * @example
146
+ * ```js
147
+ * const embed = new AppEmbed('#tsEmbed', {
148
+ * ... // other options
149
+ * enablePendoHelp: false,
150
+ * });
151
+ * ```
152
+ */
153
+ enablePendoHelp?: boolean;
140
154
  /**
141
155
  * Control the visibility of the application switcher button on the nav-bar.
142
156
  * By default, the application switcher is shown.
@@ -915,7 +929,10 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
915
929
  */
916
930
  showPreviewLoader?: boolean;
917
931
  /**
918
- * This flag is used to enable the compact header on a Liveboard
932
+ * Enables or disables the compact header feature on a Liveboard.
933
+ * Compact Liveboard header is turned off by default on Liveboards in
934
+ * ThoughtSpot Embedded apps.
935
+ *
919
936
  * @type {boolean}
920
937
  * @default false
921
938
  * @version SDK: 1.35.0 | ThoughtSpot:10.3.0.cl
@@ -2106,9 +2123,9 @@ export type DOMSelector = string | HTMLElement;
2106
2123
  export interface customCssInterface {
2107
2124
  /**
2108
2125
  * The custom css variables, which can be set.
2109
- * The allowed list is in the CustomCssVariables
2126
+ * The variables are available in the {@link CustomCssVariables}
2110
2127
  * interface. For more information, see
2111
- * link:https://developers.thoughtspot.com/docs/css-variables-reference
2128
+ * link:https://developers.thoughtspot.com/docs/css-variables-reference[CSS variable reference].
2112
2129
  */
2113
2130
  variables?: CustomCssVariables;
2114
2131
  /**
@@ -2635,7 +2652,7 @@ export interface ViewConfig {
2635
2652
  */
2636
2653
  showAlerts?: boolean;
2637
2654
  /**
2638
- * The list of runtime filters to apply to a search answer,
2655
+ * The list of runtime filters to apply to a search Answer,
2639
2656
  * visualization, or Liveboard.
2640
2657
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2641
2658
  * @example
@@ -2654,7 +2671,7 @@ export interface ViewConfig {
2654
2671
  */
2655
2672
  runtimeFilters?: RuntimeFilter[];
2656
2673
  /**
2657
- * The list of parameter override to apply to a search answer,
2674
+ * The list of parameter override to apply to a search Answer,
2658
2675
  * visualization, or Liveboard.
2659
2676
  * @version SDK : 1.25.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
2660
2677
  * @example
@@ -2672,7 +2689,7 @@ export interface ViewConfig {
2672
2689
  */
2673
2690
  runtimeParameters?: RuntimeParameter[];
2674
2691
  /**
2675
- * The locale/language to use for the embedded view.
2692
+ * The locale settings to apply to the embedded view.
2676
2693
  * @version SDK: 1.9.4 | ThoughtSpot 8.1.0.cl, 8.4.1.sw
2677
2694
  * @example
2678
2695
  * ```js
@@ -2739,7 +2756,7 @@ export interface ViewConfig {
2739
2756
  */
2740
2757
  contextMenuTrigger?: ContextMenuTriggerOptions;
2741
2758
  /**
2742
- * Flag to override openNew tab context menu link
2759
+ * Flag to override the *Open Link in New Tab* context menu option.
2743
2760
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
2744
2761
  * @example
2745
2762
  * ```js
@@ -2878,7 +2895,7 @@ export interface ViewConfig {
2878
2895
  */
2879
2896
  preRenderId?: string;
2880
2897
  /**
2881
- * Determines whether the PreRender component should not dynamically track the size
2898
+ * Determines if the PreRender component should dynamically track the size
2882
2899
  * of its embedding element and adjust its own size accordingly.
2883
2900
  * Enabling this option allows the PreRender component to automatically adapt
2884
2901
  * its dimensions based on changes to the size of the embedding element.
@@ -3250,8 +3267,8 @@ export enum EmbedEvent {
3250
3267
  */
3251
3268
  Load = "load",
3252
3269
  /**
3253
- * Data pertaining to answer or Liveboard is received
3254
- * @return data - The answer or Liveboard data
3270
+ * Data pertaining to an Answer or Liveboard is received
3271
+ * @return data - The Answer or Liveboard data
3255
3272
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 8.4.1.sw
3256
3273
  * @example
3257
3274
  *```js
@@ -3425,7 +3442,7 @@ export enum EmbedEvent {
3425
3442
  */
3426
3443
  Alert = "alert",
3427
3444
  /**
3428
- * The ThoughtSpot auth session has expired.
3445
+ * The ThoughtSpot authentication session has expired.
3429
3446
  * @version SDK: 1.4.0 | ThoughtSpot: ts7.sep.cl, 8.4.1.sw
3430
3447
  * @example
3431
3448
  *```js
@@ -3495,7 +3512,7 @@ export enum EmbedEvent {
3495
3512
  /**
3496
3513
  * Emitted when the embed does not have cookie access. This happens
3497
3514
  * when Safari and other Web browsers block third-party cookies
3498
- * are blocked by default. `NoCookieAccess` can trigger
3515
+ * are blocked by default. `NoCookieAccess` can trigger.
3499
3516
  * @example
3500
3517
  *```js
3501
3518
  * appEmbed.on(EmbedEvent.NoCookieAccess)
@@ -3583,7 +3600,7 @@ export enum EmbedEvent {
3583
3600
  */
3584
3601
  Save = "save",
3585
3602
  /**
3586
- * Emitted when the download action is triggered on an answer
3603
+ * Emitted when the download action is triggered on an Answer.
3587
3604
  *
3588
3605
  * **Note**: This event is deprecated in v1.21.0.
3589
3606
  * To fire an event when a download action is initiated on a chart or table,
@@ -3599,7 +3616,7 @@ export enum EmbedEvent {
3599
3616
  */
3600
3617
  Download = "download",
3601
3618
  /**
3602
- * Emitted when the download action is triggered on an answer
3619
+ * Emitted when the download action is triggered on an Answer.
3603
3620
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.4.0.sw
3604
3621
  * @example
3605
3622
  *```js
@@ -3613,7 +3630,7 @@ export enum EmbedEvent {
3613
3630
  */
3614
3631
  DownloadAsPng = "downloadAsPng",
3615
3632
  /**
3616
- * Emitted when the Download as PDF action is triggered on an answer
3633
+ * Emitted when the Download as PDF action is triggered on an Answer
3617
3634
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3618
3635
  * @example
3619
3636
  *```js
@@ -3627,7 +3644,7 @@ export enum EmbedEvent {
3627
3644
  */
3628
3645
  DownloadAsPdf = "downloadAsPdf",
3629
3646
  /**
3630
- * Emitted when the Download as CSV action is triggered on an answer
3647
+ * Emitted when the Download as CSV action is triggered on an Answer.
3631
3648
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3632
3649
  * @example
3633
3650
  *```js
@@ -3641,7 +3658,7 @@ export enum EmbedEvent {
3641
3658
  */
3642
3659
  DownloadAsCsv = "downloadAsCsv",
3643
3660
  /**
3644
- * Emitted when the Download as XLSX action is triggered on an answer
3661
+ * Emitted when the Download as XLSX action is triggered on an Answer.
3645
3662
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3646
3663
  * @example
3647
3664
  *```js
@@ -3669,7 +3686,8 @@ export enum EmbedEvent {
3669
3686
  */
3670
3687
  AnswerDelete = "answerDelete",
3671
3688
  /**
3672
- * Emitted when an answer is pinned to a Liveboard
3689
+ * Emitted when a user initiates the Pin action to
3690
+ * add an Answer to a Liveboard.
3673
3691
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3674
3692
  * @example
3675
3693
  *```js
@@ -3807,7 +3825,7 @@ export enum EmbedEvent {
3807
3825
  */
3808
3826
  SaveAsView = "saveAsView",
3809
3827
  /**
3810
- * Emitted when the user creates a copy of an Answer
3828
+ * Emitted when the user creates a copy of an Answer.
3811
3829
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3812
3830
  * @example
3813
3831
  *```js
@@ -3821,7 +3839,7 @@ export enum EmbedEvent {
3821
3839
  */
3822
3840
  CopyAEdit = "copyAEdit",
3823
3841
  /**
3824
- * Emitted when a user clicks Show underlying data on an Answer
3842
+ * Emitted when a user clicks *Show underlying data* on an Answer.
3825
3843
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3826
3844
  * @example
3827
3845
  *```js
@@ -3832,7 +3850,7 @@ export enum EmbedEvent {
3832
3850
  */
3833
3851
  ShowUnderlyingData = "showUnderlyingData",
3834
3852
  /**
3835
- * Emitted when an answer is switched to a chart or table view.
3853
+ * Emitted when an Answer is switched to a chart or table view.
3836
3854
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
3837
3855
  * @example
3838
3856
  *```js
@@ -3966,11 +3984,12 @@ export enum EmbedEvent {
3966
3984
  */
3967
3985
  CopyLink = "embedDocument",
3968
3986
  /**
3969
- * Emitted when a user interacts with cross filters on a visualization or Liveboard
3987
+ * Emitted when a user interacts with cross filters on a
3988
+ * visualization or Liveboard.
3970
3989
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl, 9.5.0.sw
3971
3990
  * @example
3972
3991
  *```js
3973
- * liveboardEmbed.trigger(HostEvent.CrossFilterChanged, {
3992
+ * liveboardEmbed.on(EmbedEvent.CrossFilterChanged, {
3974
3993
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'})
3975
3994
  *```
3976
3995
  */
@@ -4064,8 +4083,8 @@ export enum EmbedEvent {
4064
4083
  */
4065
4084
  DeletePersonalisedView = "deletePersonalisedView",
4066
4085
  /**
4067
- * Emitted when a user creates a new worksheet
4068
- * @version SDK : 1.27.0 | ThoughtSpot Cloud: 9.8.0.cl
4086
+ * Emitted when a user creates a Worksheet.
4087
+ * @version SDK : 1.27.0 | ThoughtSpot: 9.8.0.cl, 9.8.0.sw
4069
4088
  */
4070
4089
  CreateWorksheet = "createWorksheet",
4071
4090
  /**
@@ -4078,8 +4097,8 @@ export enum EmbedEvent {
4078
4097
  */
4079
4098
  AskSageInit = "AskSageInit",
4080
4099
  /**
4081
- * Emitted when a LB/viz is renamed
4082
- * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl
4100
+ * Emitted when a Liveboard or visualization is renamed.
4101
+ * @version SDK : 1.28.0 | ThoughtSpot: 9.10.5.cl, 10.1.0.sw
4083
4102
  */
4084
4103
  Rename = "rename",
4085
4104
  /**
@@ -4143,8 +4162,7 @@ export enum EmbedEvent {
4143
4162
  OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
4144
4163
  /**
4145
4164
  * Emitted when parameter changes in an Answer
4146
- * or Liveboard
4147
- *
4165
+ * or Liveboard.
4148
4166
  * ```js
4149
4167
  * liveboardEmbed.on(EmbedEvent.ParameterChanged, (payload) => {
4150
4168
  * console.log('payload', payload);
@@ -4171,7 +4189,7 @@ export enum EmbedEvent {
4171
4189
  */
4172
4190
  TableVizRendered = "TableVizRendered",
4173
4191
  /**
4174
- * Emitted when the liveboard is created from pin modal or liveboard list page.
4192
+ * Emitted when the liveboard is created from pin modal or Liveboard list page.
4175
4193
  * You can use this event as a hook to trigger
4176
4194
  * other events on liveboard creation.
4177
4195
  *
@@ -4314,7 +4332,7 @@ export enum HostEvent {
4314
4332
  */
4315
4333
  Filter = "filter",
4316
4334
  /**
4317
- * Reload the answer or visualization
4335
+ * Reload the Answer or visualization
4318
4336
  * @hidden
4319
4337
  */
4320
4338
  Reload = "reload",
@@ -4364,12 +4382,10 @@ export enum HostEvent {
4364
4382
  * and `AppEmbed` only. In full application embedding, this event updates
4365
4383
  * the runtime filters applied on the Liveboard and saved Answer objects.
4366
4384
  *
4367
- *
4368
- * Pass an array of runtime filters with the following attributes:
4369
- *
4385
+ * @param - Pass an array of {@link RuntimeFilter} with the following attributes:
4370
4386
  * `columnName` - _String_. The name of the column to filter on.
4371
4387
  *
4372
- * `operator` - Runtime filter operator to apply. For more information,
4388
+ * `operator` - {@link RuntimeFilterOp} to apply. For more information,
4373
4389
  * see link:https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator[Developer Documentation].
4374
4390
  *
4375
4391
  * `values` - List of operands. Some operators such as EQ and LE allow a
@@ -4381,7 +4397,7 @@ export enum HostEvent {
4381
4397
  * will be cleared, restoring the original visualization
4382
4398
  * with the updated filters.
4383
4399
  *
4384
- * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
4400
+
4385
4401
  * @example
4386
4402
  * ```js
4387
4403
  * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
@@ -4620,6 +4636,11 @@ export enum HostEvent {
4620
4636
  * appEmbed.trigger(HostEvent.Remove)
4621
4637
  * ```
4622
4638
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4639
+ * * @example
4640
+ * ```js
4641
+ * liveboardEmbed.trigger(HostEvent.Remove)
4642
+ * ```
4643
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4623
4644
  */
4624
4645
  Remove = "delete",
4625
4646
  /**
@@ -5030,7 +5051,7 @@ export enum HostEvent {
5030
5051
  * ```js
5031
5052
  * liveboardEmbed.trigger(HostEvent.GetTabs).then((tabDetails) => {
5032
5053
  * console.log(
5033
- * tabDetails // TabDetails of current LB
5054
+ * tabDetails // TabDetails of current Liveboard
5034
5055
  * );
5035
5056
  * })
5036
5057
  * ```
@@ -5078,7 +5099,7 @@ export enum HostEvent {
5078
5099
  */
5079
5100
  UpdateSageQuery = "updateSageQuery",
5080
5101
  /**
5081
- * Get the answer session for a Search or
5102
+ * Get the Answer session for a Search or
5082
5103
  * Liveboard visualization.
5083
5104
  * @example
5084
5105
  * ```js
@@ -5253,6 +5274,7 @@ export enum Param {
5253
5274
  HostAppUrl = "hostAppUrl",
5254
5275
  EnableVizTransformations = "enableVizTransform",
5255
5276
  EnableSearchAssist = "enableSearchAssist",
5277
+ EnablePendoHelp = "enablePendoHelp",
5256
5278
  HideResult = "hideResult",
5257
5279
  UseLastSelectedDataSource = "useLastSelectedSources",
5258
5280
  Tag = "tag",
@@ -5477,9 +5499,10 @@ export enum Action {
5477
5499
  */
5478
5500
  AddDataPanelObjects = "addDataPanelObjects",
5479
5501
  /**
5480
- * Filter configuration options on a Liveboard page.
5481
- * Allows configuring filters on a
5482
- * Liveboard.
5502
+ * The filter configuration options for a Liveboard.
5503
+ * The configuration options are available when adding
5504
+ * filters on a Liveboard.
5505
+ *
5483
5506
  * @example
5484
5507
  * ```js
5485
5508
  * disabledActions: [Action.ConfigureFilter]
@@ -5577,14 +5600,17 @@ export enum Action {
5577
5600
  * @hidden
5578
5601
  */
5579
5602
  SpotIQFollow = "spotIQFollow",
5603
+ /**
5604
+ * The Share action for a Liveboard visualization.
5605
+ */
5580
5606
  ShareViz = "shareViz",
5581
5607
  /**
5582
5608
  * @hidden
5583
5609
  */
5584
5610
  ReplaySearch = "replaySearch",
5585
5611
  /**
5586
- * The **Show underlying data** menu action on a visualization or
5587
- * Answer page.
5612
+ * The **Show underlying data** menu action on a
5613
+ * visualization or Answer page.
5588
5614
  * Displays detailed information and raw data
5589
5615
  * for a given visualization.
5590
5616
  * @example
@@ -5594,8 +5620,8 @@ export enum Action {
5594
5620
  */
5595
5621
  ShowUnderlyingData = "showUnderlyingData",
5596
5622
  /**
5597
- * The **Download** menu action on Liveboard visualizations
5598
- * and Answers.
5623
+ * The **Download** menu action on Liveboard
5624
+ * visualizations and Answers.
5599
5625
  * Allows downloading a visualization or Answer.
5600
5626
  * @example
5601
5627
  * ```js
@@ -5616,11 +5642,10 @@ export enum Action {
5616
5642
  /**
5617
5643
  *
5618
5644
  *The **Download PDF** action that downloads a Liveboard,
5619
- *visualization, or Answer as a PDF file.
5620
- *
5645
+ * visualization, or Answer as a PDF file.
5621
5646
  *
5622
- ***NOTE**: The **Download** > **PDF** action is available on
5623
- *visualizations and Answers if the data is in tabular format.
5647
+ * **NOTE**: The **Download** > **PDF** option is available for
5648
+ * tables in visualizations and Answers.
5624
5649
  * @example
5625
5650
  * ```js
5626
5651
  * disabledActions: [Action.DownloadAsPdf]
@@ -5652,9 +5677,11 @@ export enum Action {
5652
5677
  */
5653
5678
  DownloadTrace = "downloadTrace",
5654
5679
  /**
5655
- * The **Export TML** menu action on Liveboard, Answers
5656
- * Worksheets and Data Connections page.
5657
- * Exports an object as a TML file.
5680
+ * The **Export TML** menu action on a Liveboard, Answer, and
5681
+ * the Data Workspace pages for data objects and connections.
5682
+ *
5683
+ * Allows exporting an object as a TML file.
5684
+ *
5658
5685
  * @example
5659
5686
  * ```js
5660
5687
  * disabledActions: [Action.ExportTML]
@@ -5662,7 +5689,8 @@ export enum Action {
5662
5689
  */
5663
5690
  ExportTML = "exportTSL",
5664
5691
  /**
5665
- * The **Import TML** menu action for Liveboards and Answers.
5692
+ * The **Import TML** menu action on the
5693
+ * *Data Workspace* > *Utilities* page.
5666
5694
  * Imports TML representation of ThoughtSpot objects.
5667
5695
  * @example
5668
5696
  * ```js
@@ -5672,7 +5700,7 @@ export enum Action {
5672
5700
  ImportTML = "importTSL",
5673
5701
  /**
5674
5702
  * The **Update TML** menu action for Liveboards and Answers.
5675
- * Update TML representation of ThoughtSpot objects.
5703
+ * Updates TML representation of ThoughtSpot objects.
5676
5704
  * @example
5677
5705
  * ```js
5678
5706
  * disabledActions: [Action.UpdateTML]
@@ -5699,8 +5727,11 @@ export enum Action {
5699
5727
  */
5700
5728
  Present = "present",
5701
5729
  /**
5702
- * The tile resize options in the visualization menu.
5703
- * Allows switching between different preset layouts.
5730
+ * The visualization tile resize option.
5731
+ * Also available via More `...` options menu on a visualization.
5732
+ * Allows resizing visualization tiles and switching
5733
+ * between different preset layout option.
5734
+ *
5704
5735
  * @example
5705
5736
  * ```js
5706
5737
  * disabledActions: [Action.ToggleSize]
@@ -5726,8 +5757,9 @@ export enum Action {
5726
5757
  */
5727
5758
  EditTitle = "editTitle",
5728
5759
  /**
5729
- * The **Delete** menu action on Liveboards and visualizations.
5730
- * Deletes a Liveboard or a visualization from a Liveboard.
5760
+ * The **Delete** action on a Liveboard, *Liveboards* and
5761
+ * *Answers* list pages in full application embedding.
5762
+ *
5731
5763
  * @example
5732
5764
  * ```js
5733
5765
  * disabledActions: [Action.Remove]
@@ -5804,8 +5836,9 @@ export enum Action {
5804
5836
  */
5805
5837
  Explore = "explore",
5806
5838
  /**
5807
- * The action to include data points on a drilled-down Answer
5808
- * or visualization
5839
+ * The contextual menu action to include a specific data point
5840
+ * when drilling down a table or chart on an Answer.
5841
+ *
5809
5842
  * @example
5810
5843
  * ```js
5811
5844
  * disabledActions: [Action.DrillInclude]
@@ -5813,8 +5846,8 @@ export enum Action {
5813
5846
  */
5814
5847
  DrillInclude = "context-menu-item-include",
5815
5848
  /**
5816
- * The action to exclude data points on a drilled-down Answer
5817
- * or visualization
5849
+ * The contextual menu action to exclude a specific data point
5850
+ * when drilling down a table or chart on an Answer.
5818
5851
  * @example
5819
5852
  * ```js
5820
5853
  * disabledActions: [Action.DrillInclude]
@@ -5961,7 +5994,7 @@ export enum Action {
5961
5994
  * Allows users to manage data sync pipelines to third-party apps.
5962
5995
  * @example
5963
5996
  * ```js
5964
- * disabledActions: [Action.SyncToOtherApps]
5997
+ * disabledActions: [Action.ManagePipelines]
5965
5998
  * ```
5966
5999
  * @version SDK: 1.18.0| ThoughtSpot: 8.10.0.cl, 9.0.1.sw
5967
6000
  */
@@ -6280,7 +6313,7 @@ export enum Action {
6280
6313
  /**
6281
6314
  * Action ID for the Parent TML action
6282
6315
  * The parent action **TML** must be included to access TML-related options
6283
- * within the cascading menu (specific to the answer page)
6316
+ * within the cascading menu (specific to the Answer page)
6284
6317
  * @example
6285
6318
  * ```js
6286
6319
  * // to include specific TML actions
@@ -6319,8 +6352,10 @@ export enum Action {
6319
6352
  */
6320
6353
  VerifiedLiveboard = "verifiedLiveboard",
6321
6354
  /**
6322
- * The *Ask Sage* action for Answers and visualizations.
6323
- * Allows initiating a Natural Language Search query.
6355
+ * Action ID for the *Ask Sage* In Natural Language Search embed,
6356
+ * *Spotter* in Liveboard, full app, and Spotter embed.
6357
+ *
6358
+ * Allows initiating a conversation with ThoughtSpot AI analyst.
6324
6359
  *
6325
6360
  * @example
6326
6361
  * ```js
@@ -6516,7 +6551,8 @@ export enum Action {
6516
6551
  */
6517
6552
  DeletePreviousPrompt = "deletePreviousPrompt",
6518
6553
  /**
6519
- * Action ID for hide/disable edit of tokens on spotter results.
6554
+ * Action ID for hide or disable editing tokens generated from
6555
+ * Spotter results.
6520
6556
  * @example
6521
6557
  * ```js
6522
6558
  * hiddenAction: [Action.EditTokens]
@@ -7405,7 +7441,7 @@ export const getEmbedConfig: () => EmbedConfig;
7405
7441
  * @version SDK: 1.27.0 | ThoughtSpot: *
7406
7442
  * @group Global methods
7407
7443
  */
7408
- export const setEmbedConfig: (newConfig: EmbedConfig) => EmbedConfig;
7444
+ export const setEmbedConfig: (newConfig: EmbedConfig) => any;
7409
7445
 
7410
7446
  export const EndPoints: {
7411
7447
  CONFIG: string;
package/lib/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.36.2",
3
+ "version": "1.36.3",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
@@ -1 +1 @@
1
- {"version":3,"file":"authToken.d.ts","sourceRoot":"","sources":["../../src/authToken.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAOtC;;;GAGG;AACH,wBAAsB,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAkCtF;AA6BD;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,QAAO,IAEvC,CAAC"}
1
+ {"version":3,"file":"authToken.d.ts","sourceRoot":"","sources":["../../src/authToken.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAatC;;;GAGG;AACH,wBAAsB,sBAAsB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAmCtF;AA8BD;;;;;;;;GAQG;AACH,eAAO,MAAM,oBAAoB,QAAO,IAEvC,CAAC"}
@@ -1,13 +1,19 @@
1
1
  import { ERROR_MESSAGE } from './errors';
2
+ import { getValueFromWindow, storeValueInWindow } from './utils';
2
3
  import { fetchAuthTokenService, verifyTokenService } from './utils/authService/authService';
3
4
  import { logger } from './utils/logger';
4
- let cachedAuthToken = null;
5
+ const cacheAuthTokenKey = 'cachedAuthToken';
6
+ const getCacheAuthToken = () => getValueFromWindow(cacheAuthTokenKey);
7
+ const storeAuthTokenInCache = (token) => {
8
+ storeValueInWindow(cacheAuthTokenKey, token);
9
+ };
5
10
  // This method can be used to get the authToken using the embedConfig
6
11
  /**
7
12
  *
8
13
  * @param embedConfig
9
14
  */
10
15
  export async function getAuthenticationToken(embedConfig) {
16
+ const cachedAuthToken = getCacheAuthToken();
11
17
  // Since we don't have token validation enabled , we cannot tell if the
12
18
  // cached token is valid or not. So we will always fetch a new token.
13
19
  if (cachedAuthToken && !embedConfig.disableTokenVerification) {
@@ -38,10 +44,11 @@ export async function getAuthenticationToken(embedConfig) {
38
44
  logger.error(`${ERROR_MESSAGE.INVALID_TOKEN_ERROR} Error : ${e.message}`);
39
45
  throw e;
40
46
  }
41
- cachedAuthToken = authToken;
47
+ storeAuthTokenInCache(authToken);
42
48
  return authToken;
43
49
  }
44
50
  const validateAuthToken = async (embedConfig, authToken, suppressAlert) => {
51
+ const cachedAuthToken = getCacheAuthToken();
45
52
  if (embedConfig.disableTokenVerification) {
46
53
  logger.info('Token verification is disabled. Assuming token is valid.');
47
54
  return true;
@@ -75,6 +82,6 @@ const validateAuthToken = async (embedConfig, authToken, suppressAlert) => {
75
82
  * @group Authentication / Init
76
83
  */
77
84
  export const resetCachedAuthToken = () => {
78
- cachedAuthToken = null;
85
+ storeAuthTokenInCache(null);
79
86
  };
80
87
  //# sourceMappingURL=authToken.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"authToken.js","sourceRoot":"","sources":["../../src/authToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,IAAI,eAAe,GAAkB,IAAI,CAAC;AAE1C,qEAAqE;AACrE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,WAAwB;IACjE,uEAAuE;IACvE,qEAAqE;IACrE,IAAI,eAAe,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE;QAC1D,IAAI,uBAAuB,CAAC;QAC5B,IAAI;YACA,uBAAuB,GAAG,MAAM,iBAAiB,CAAC,WAAW,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;SACzF;QAAC,MAAM;YACJ,uBAAuB,GAAG,KAAK,CAAC;SACnC;QAED,IAAI,uBAAuB;YAAE,OAAO,eAAe,CAAC;KACvD;IAED,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC;IAEnD,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,YAAY,EAAE;QACd,SAAS,GAAG,MAAM,YAAY,EAAE,CAAC;KACpC;SAAM;QACH,MAAM,QAAQ,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAC3D,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;KACrC;IAED,IAAI;QACA,kDAAkD;QAClD,MAAM,iBAAiB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;KACnD;IAAC,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,mBAAmB,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1E,MAAM,CAAC,CAAC;KACX;IAED,eAAe,GAAG,SAAS,CAAC;IAC5B,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,MAAM,iBAAiB,GAAG,KAAK,EAC3B,WAAwB,EACxB,SAAiB,EACjB,aAAuB,EACP,EAAE;IAClB,IAAI,WAAW,CAAC,wBAAwB,EAAE;QACtC,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;KACf;IACD,IAAI;QACA,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAAC,WAAW,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;QACtF,IAAI,YAAY;YAAE,OAAO,IAAI,CAAC;KACjC;IAAC,MAAM;QACJ,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,eAAe,IAAI,eAAe,KAAK,SAAS,EAAE;QAClD,IAAI,CAAC,WAAW,CAAC,mBAAmB,IAAI,CAAC,aAAa,EAAE;YACpD,oCAAoC;YACpC,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;SAC5C;QACD,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;KACtD;SAAM;QACH,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;KACtD;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAS,EAAE;IAC3C,eAAe,GAAG,IAAI,CAAC;AAC3B,CAAC,CAAC"}
1
+ {"version":3,"file":"authToken.js","sourceRoot":"","sources":["../../src/authToken.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC5F,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;AAE5C,MAAM,iBAAiB,GAAG,GAAkB,EAAE,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;AACrF,MAAM,qBAAqB,GAAG,CAAC,KAAa,EAAQ,EAAE;IAClD,kBAAkB,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF,qEAAqE;AACrE;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,WAAwB;IACjE,MAAM,eAAe,GAAG,iBAAiB,EAAE,CAAC;IAC5C,uEAAuE;IACvE,qEAAqE;IACrE,IAAI,eAAe,IAAI,CAAC,WAAW,CAAC,wBAAwB,EAAE;QAC1D,IAAI,uBAAuB,CAAC;QAC5B,IAAI;YACA,uBAAuB,GAAG,MAAM,iBAAiB,CAAC,WAAW,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC;SACzF;QAAC,MAAM;YACJ,uBAAuB,GAAG,KAAK,CAAC;SACnC;QAED,IAAI,uBAAuB;YAAE,OAAO,eAAe,CAAC;KACvD;IAED,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC;IAEnD,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,IAAI,YAAY,EAAE;QACd,SAAS,GAAG,MAAM,YAAY,EAAE,CAAC;KACpC;SAAM;QACH,MAAM,QAAQ,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAC3D,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;KACrC;IAED,IAAI;QACA,kDAAkD;QAClD,MAAM,iBAAiB,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;KACnD;IAAC,OAAO,CAAC,EAAE;QACR,MAAM,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,mBAAmB,YAAY,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1E,MAAM,CAAC,CAAC;KACX;IAED,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACjC,OAAO,SAAS,CAAC;AACrB,CAAC;AAED,MAAM,iBAAiB,GAAG,KAAK,EAC3B,WAAwB,EACxB,SAAiB,EACjB,aAAuB,EACP,EAAE;IAClB,MAAM,eAAe,GAAG,iBAAiB,EAAE,CAAC;IAC5C,IAAI,WAAW,CAAC,wBAAwB,EAAE;QACtC,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAC;QACxE,OAAO,IAAI,CAAC;KACf;IACD,IAAI;QACA,MAAM,YAAY,GAAG,MAAM,kBAAkB,CAAC,WAAW,CAAC,eAAe,EAAE,SAAS,CAAC,CAAC;QACtF,IAAI,YAAY;YAAE,OAAO,IAAI,CAAC;KACjC;IAAC,MAAM;QACJ,OAAO,KAAK,CAAC;KAChB;IAED,IAAI,eAAe,IAAI,eAAe,KAAK,SAAS,EAAE;QAClD,IAAI,CAAC,WAAW,CAAC,mBAAmB,IAAI,CAAC,aAAa,EAAE;YACpD,oCAAoC;YACpC,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;SAC5C;QACD,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;KACtD;SAAM;QACH,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;KACtD;AACL,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAS,EAAE;IAC3C,qBAAqB,CAAC,IAAI,CAAC,CAAC;AAChC,CAAC,CAAC"}
@@ -123,6 +123,20 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
123
123
  * ```
124
124
  */
125
125
  disableProfileAndHelp?: boolean;
126
+ /**
127
+ * @version SDK: 1.36.3 | ThoughtSpot: 10.1.0.cl
128
+ * @default true
129
+ * Whether the help menu in the top nav bar should be served
130
+ * from Pendo or ThoughtSpot's internal help items.
131
+ * @example
132
+ * ```js
133
+ * const embed = new AppEmbed('#tsEmbed', {
134
+ * ... // other options
135
+ * enablePendoHelp: false,
136
+ * });
137
+ * ```
138
+ */
139
+ enablePendoHelp?: boolean;
126
140
  /**
127
141
  * Control the visibility of the application switcher button on the nav-bar.
128
142
  * By default, the application switcher is shown.
@@ -1 +1 @@
1
- {"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAEX,UAAU,EAEV,cAAc,EACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,aAAa;IACnB;;OAEG;IACH,OAAO,YAAY;CACtB;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED,oBAAY,qBAAqB;IAC7B,aAAa,iBAAiB;IAC9B,SAAS,aAAa;IACtB,IAAI,SAAS;CAChB;AACD;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,0CAA0C,CAAC,EAAE,yCAAyC,CAAC;IACvF;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C;;;;;;;;;;;;OAYG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;;;;;;;;OAYG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;OAYG;IACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;IAC7C;;;;;;;;;;;;OAYG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;;;;;;;OAYG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;CAC9C;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAU;gBAGnB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAU/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAgHxB;;;OAGG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAqBzC;IAEF;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAsBpB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;OAUG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAO3C"}
1
+ {"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EAEH,WAAW,EAEX,UAAU,EAEV,cAAc,EACjB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,aAAa;IACnB;;OAEG;IACH,OAAO,YAAY;CACtB;AAED;;;GAGG;AACH,oBAAY,yCAAyC;IACjD;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,YAAY,iBAAiB;IAC7B;;OAEG;IACH,YAAY,iBAAiB;CAChC;AAED,oBAAY,qBAAqB;IAC7B,aAAa,iBAAiB;IAC9B,SAAS,aAAa;IACtB,IAAI,SAAS;CAChB;AACD;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;OAaG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;OAYG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;;;;;;;;;;;;;OAgBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;OAUG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;;;;;;OAiBG;IACH,0CAA0C,CAAC,EAAE,yCAAyC,CAAC;IACvF;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAC;IAC/C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C;;;;;;;;;;;;OAYG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;;;;;;;;;OAYG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;OAYG;IACH,kCAAkC,CAAC,EAAE,OAAO,CAAC;IAC7C;;;;;;;;;;;;OAYG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;;;;;;;OAYG;IACH,gCAAgC,CAAC,EAAE,OAAO,CAAC;CAC9C;AAED;;;GAGG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAU;gBAGnB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAU/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAqHxB;;;OAGG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;OAIG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAqBzC;IAEF;;;;OAIG;IACH,OAAO,CAAC,YAAY;IAsBpB;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;OAUG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAO3C"}
@@ -131,7 +131,7 @@ export class AppEmbed extends V1Embed {
131
131
  getEmbedParams() {
132
132
  const { tag, hideObjects, liveboardV2, showPrimaryNavbar, disableProfileAndHelp, hideApplicationSwitcher, hideOrgSwitcher, enableSearchAssist, fullHeight, dataPanelV2 = false, hideLiveboardHeader = false, showLiveboardTitle = true, showLiveboardDescription = true, hideHomepageLeftNav = false, modularHomeExperience = false, isLiveboardHeaderSticky = true, enableAskSage, collapseSearchBarInitially = false, enable2ColumnLayout, enableCustomColumnGroups = false, isOnBeforeGetVizDataInterceptEnabled = false,
133
133
  /* eslint-disable-next-line max-len */
134
- dataPanelCustomGroupsAccordionInitialState = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, } = this.viewConfig;
134
+ dataPanelCustomGroupsAccordionInitialState = DataPanelCustomColumnGroupsAccordionState.EXPAND_ALL, collapseSearchBar = true, isLiveboardCompactHeaderEnabled = false, showLiveboardVerifiedBadge = true, showLiveboardReverifyBanner = true, hideIrrelevantChipsInLiveboardTabs = false, homePageSearchBarMode, isUnifiedSearchExperienceEnabled = true, enablePendoHelp = true, } = this.viewConfig;
135
135
  let params = {};
136
136
  params[Param.PrimaryNavHidden] = !showPrimaryNavbar;
137
137
  params[Param.HideProfleAndHelp] = !!disableProfileAndHelp;
@@ -176,6 +176,9 @@ export class AppEmbed extends V1Embed {
176
176
  if (homePageSearchBarMode) {
177
177
  params[Param.HomePageSearchBarMode] = homePageSearchBarMode;
178
178
  }
179
+ if (enablePendoHelp !== undefined) {
180
+ params[Param.EnablePendoHelp] = enablePendoHelp;
181
+ }
179
182
  params[Param.DataPanelV2Enabled] = dataPanelV2;
180
183
  params[Param.HideHomepageLeftNav] = hideHomepageLeftNav;
181
184
  params[Param.ModularHomeExperienceEnabled] = modularHomeExperience;