@thoughtspot/visual-embed-sdk 1.32.0 → 1.32.2

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 (166) hide show
  1. package/cjs/package.json +4 -22
  2. package/cjs/src/auth.d.ts.map +1 -1
  3. package/cjs/src/auth.js +6 -5
  4. package/cjs/src/auth.js.map +1 -1
  5. package/cjs/src/authToken.d.ts.map +1 -1
  6. package/cjs/src/authToken.js +5 -7
  7. package/cjs/src/authToken.js.map +1 -1
  8. package/cjs/src/css-variables.d.ts +28 -0
  9. package/cjs/src/css-variables.d.ts.map +1 -1
  10. package/cjs/src/embed/app.d.ts +16 -14
  11. package/cjs/src/embed/app.d.ts.map +1 -1
  12. package/cjs/src/embed/app.js +19 -4
  13. package/cjs/src/embed/app.js.map +1 -1
  14. package/cjs/src/embed/app.spec.js +32 -0
  15. package/cjs/src/embed/app.spec.js.map +1 -1
  16. package/cjs/src/embed/base.d.ts.map +1 -1
  17. package/cjs/src/embed/base.js +2 -0
  18. package/cjs/src/embed/base.js.map +1 -1
  19. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  20. package/cjs/src/embed/liveboard.js +2 -1
  21. package/cjs/src/embed/liveboard.js.map +1 -1
  22. package/cjs/src/embed/liveboard.spec.js +10 -0
  23. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  24. package/cjs/src/embed/search.d.ts +14 -13
  25. package/cjs/src/embed/search.d.ts.map +1 -1
  26. package/cjs/src/embed/search.js +6 -4
  27. package/cjs/src/embed/search.js.map +1 -1
  28. package/cjs/src/embed/search.spec.js +9 -9
  29. package/cjs/src/embed/search.spec.js.map +1 -1
  30. package/cjs/src/embed/ts-embed.d.ts +1 -1
  31. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  32. package/cjs/src/embed/ts-embed.js +10 -6
  33. package/cjs/src/embed/ts-embed.js.map +1 -1
  34. package/cjs/src/errors.d.ts +11 -0
  35. package/cjs/src/errors.d.ts.map +1 -1
  36. package/cjs/src/errors.js +11 -0
  37. package/cjs/src/errors.js.map +1 -1
  38. package/cjs/src/mixpanel-service.d.ts +4 -0
  39. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  40. package/cjs/src/mixpanel-service.js +6 -1
  41. package/cjs/src/mixpanel-service.js.map +1 -1
  42. package/cjs/src/react/index.spec.js +1 -1
  43. package/cjs/src/react/index.spec.js.map +1 -1
  44. package/cjs/src/types.d.ts +178 -6
  45. package/cjs/src/types.d.ts.map +1 -1
  46. package/cjs/src/types.js +138 -3
  47. package/cjs/src/types.js.map +1 -1
  48. package/cjs/src/utils/processData.d.ts.map +1 -1
  49. package/cjs/src/utils/processData.js +2 -1
  50. package/cjs/src/utils/processData.js.map +1 -1
  51. package/cjs/src/utils/reporting.d.ts +16 -0
  52. package/cjs/src/utils/reporting.d.ts.map +1 -0
  53. package/cjs/src/utils/reporting.js +68 -0
  54. package/cjs/src/utils/reporting.js.map +1 -0
  55. package/cjs/src/utils/reporting.spec.d.ts +2 -0
  56. package/cjs/src/utils/reporting.spec.d.ts.map +1 -0
  57. package/cjs/src/utils/reporting.spec.js +76 -0
  58. package/cjs/src/utils/reporting.spec.js.map +1 -0
  59. package/dist/src/auth.d.ts.map +1 -1
  60. package/dist/src/authToken.d.ts.map +1 -1
  61. package/dist/src/css-variables.d.ts +28 -0
  62. package/dist/src/css-variables.d.ts.map +1 -1
  63. package/dist/src/embed/app.d.ts +16 -14
  64. package/dist/src/embed/app.d.ts.map +1 -1
  65. package/dist/src/embed/base.d.ts.map +1 -1
  66. package/dist/src/embed/liveboard.d.ts.map +1 -1
  67. package/dist/src/embed/search.d.ts +14 -13
  68. package/dist/src/embed/search.d.ts.map +1 -1
  69. package/dist/src/embed/ts-embed.d.ts +1 -1
  70. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  71. package/dist/src/errors.d.ts +11 -0
  72. package/dist/src/errors.d.ts.map +1 -1
  73. package/dist/src/mixpanel-service.d.ts +4 -0
  74. package/dist/src/mixpanel-service.d.ts.map +1 -1
  75. package/dist/src/types.d.ts +178 -6
  76. package/dist/src/types.d.ts.map +1 -1
  77. package/dist/src/utils/processData.d.ts.map +1 -1
  78. package/dist/src/utils/reporting.d.ts +16 -0
  79. package/dist/src/utils/reporting.d.ts.map +1 -0
  80. package/dist/src/utils/reporting.spec.d.ts +2 -0
  81. package/dist/src/utils/reporting.spec.d.ts.map +1 -0
  82. package/dist/tsembed-react.es.js +214 -39
  83. package/dist/tsembed-react.js +214 -39
  84. package/dist/tsembed.es.js +261 -40
  85. package/dist/tsembed.js +261 -40
  86. package/dist/visual-embed-sdk-react-full.d.ts +241 -34
  87. package/dist/visual-embed-sdk-react.d.ts +241 -34
  88. package/dist/visual-embed-sdk.d.ts +241 -34
  89. package/lib/package.json +4 -22
  90. package/lib/src/auth.d.ts.map +1 -1
  91. package/lib/src/auth.js +6 -5
  92. package/lib/src/auth.js.map +1 -1
  93. package/lib/src/authToken.d.ts.map +1 -1
  94. package/lib/src/authToken.js +5 -7
  95. package/lib/src/authToken.js.map +1 -1
  96. package/lib/src/css-variables.d.ts +28 -0
  97. package/lib/src/css-variables.d.ts.map +1 -1
  98. package/lib/src/embed/app.d.ts +16 -14
  99. package/lib/src/embed/app.d.ts.map +1 -1
  100. package/lib/src/embed/app.js +18 -3
  101. package/lib/src/embed/app.js.map +1 -1
  102. package/lib/src/embed/app.spec.js +33 -1
  103. package/lib/src/embed/app.spec.js.map +1 -1
  104. package/lib/src/embed/base.d.ts.map +1 -1
  105. package/lib/src/embed/base.js +2 -0
  106. package/lib/src/embed/base.js.map +1 -1
  107. package/lib/src/embed/liveboard.d.ts.map +1 -1
  108. package/lib/src/embed/liveboard.js +2 -1
  109. package/lib/src/embed/liveboard.js.map +1 -1
  110. package/lib/src/embed/liveboard.spec.js +10 -0
  111. package/lib/src/embed/liveboard.spec.js.map +1 -1
  112. package/lib/src/embed/search.d.ts +14 -13
  113. package/lib/src/embed/search.d.ts.map +1 -1
  114. package/lib/src/embed/search.js +6 -4
  115. package/lib/src/embed/search.js.map +1 -1
  116. package/lib/src/embed/search.spec.js +9 -9
  117. package/lib/src/embed/search.spec.js.map +1 -1
  118. package/lib/src/embed/ts-embed.d.ts +1 -1
  119. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  120. package/lib/src/embed/ts-embed.js +10 -6
  121. package/lib/src/embed/ts-embed.js.map +1 -1
  122. package/lib/src/errors.d.ts +11 -0
  123. package/lib/src/errors.d.ts.map +1 -1
  124. package/lib/src/errors.js +11 -0
  125. package/lib/src/errors.js.map +1 -1
  126. package/lib/src/mixpanel-service.d.ts +4 -0
  127. package/lib/src/mixpanel-service.d.ts.map +1 -1
  128. package/lib/src/mixpanel-service.js +6 -1
  129. package/lib/src/mixpanel-service.js.map +1 -1
  130. package/lib/src/react/index.spec.js +1 -1
  131. package/lib/src/react/index.spec.js.map +1 -1
  132. package/lib/src/types.d.ts +178 -6
  133. package/lib/src/types.d.ts.map +1 -1
  134. package/lib/src/types.js +138 -3
  135. package/lib/src/types.js.map +1 -1
  136. package/lib/src/utils/processData.d.ts.map +1 -1
  137. package/lib/src/utils/processData.js +2 -1
  138. package/lib/src/utils/processData.js.map +1 -1
  139. package/lib/src/utils/reporting.d.ts +16 -0
  140. package/lib/src/utils/reporting.d.ts.map +1 -0
  141. package/lib/src/utils/reporting.js +62 -0
  142. package/lib/src/utils/reporting.js.map +1 -0
  143. package/lib/src/utils/reporting.spec.d.ts +2 -0
  144. package/lib/src/utils/reporting.spec.d.ts.map +1 -0
  145. package/lib/src/utils/reporting.spec.js +74 -0
  146. package/lib/src/utils/reporting.spec.js.map +1 -0
  147. package/lib/src/visual-embed-sdk.d.ts +241 -34
  148. package/package.json +4 -22
  149. package/src/auth.ts +6 -5
  150. package/src/authToken.ts +5 -9
  151. package/src/css-variables.ts +28 -0
  152. package/src/embed/app.spec.ts +48 -0
  153. package/src/embed/app.ts +25 -15
  154. package/src/embed/base.ts +3 -1
  155. package/src/embed/liveboard.spec.ts +14 -0
  156. package/src/embed/liveboard.ts +2 -0
  157. package/src/embed/search.spec.ts +9 -9
  158. package/src/embed/search.ts +20 -16
  159. package/src/embed/ts-embed.ts +13 -6
  160. package/src/errors.ts +11 -0
  161. package/src/mixpanel-service.ts +6 -1
  162. package/src/react/index.spec.tsx +1 -1
  163. package/src/types.ts +192 -13
  164. package/src/utils/processData.ts +2 -3
  165. package/src/utils/reporting.spec.ts +91 -0
  166. package/src/utils/reporting.ts +71 -0
@@ -72,7 +72,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
72
72
  /**
73
73
  * SpotIQ listing page
74
74
  */
75
- SpotIQ = "insights"
75
+ SpotIQ = "insights",
76
+ /**
77
+ * Monitor Alerts Page
78
+ */
79
+ Monitor = "monitor"
76
80
  }
77
81
  /**
78
82
  * Define the initial state os column custom group accordions
@@ -92,6 +96,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
92
96
  */
93
97
  EXPAND_FIRST = "EXPAND_FIRST"
94
98
  }
99
+ export enum HomePageSearchBarMode {
100
+ OBJECT_SEARCH = "objectSearch",
101
+ AI_ANSWER = "aiAnswer",
102
+ NONE = "none"
103
+ }
95
104
  /**
96
105
  * The view configuration for full app embedding.
97
106
  * @group Embed components
@@ -278,19 +287,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
278
287
  * ```
279
288
  */
280
289
  fullHeight?: boolean;
281
- /**
282
- * Flag to control Data panel experience
283
- * @default false
284
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
285
- * @example
286
- * ```js
287
- * const embed = new AppEmbed('#tsEmbed', {
288
- * ... // other options
289
- * dataPanelV2: true,
290
- * })
291
- * ```
292
- */
293
- dataPanelV2?: boolean;
294
290
  /**
295
291
  * Show or hide Liveboard header
296
292
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
@@ -365,6 +361,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
365
361
  * To set the initial state of the search bar in case of saved-answers.
366
362
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
367
363
  * @default false
364
+ * @deprecated Use {@link collapseSearchBar} instead
368
365
  */
369
366
  collapseSearchBarInitially?: boolean;
370
367
  /**
@@ -418,6 +415,11 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
418
415
  * @version SDK : 1.29.0 | Thoughtspot : 10.1.0.cl
419
416
  */
420
417
  isOnBeforeGetVizDataInterceptEnabled?: boolean;
418
+ /**
419
+ * Flag to use home page search bar mode
420
+ * @version SDK : 1.33.0 | Thoughtspot : 10.2.0.cl
421
+ */
422
+ homePageSearchBarMode?: HomePageSearchBarMode;
421
423
  }
422
424
  /**
423
425
  * Embeds full ThoughtSpot experience in a host application.
@@ -977,6 +979,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
977
979
  * ```
978
980
  */
979
981
  collapseDataSources?: boolean;
982
+ /**
983
+ * If set to true, the data panel is collapsed on load,
984
+ * but can be expanded manually.
985
+ * @version: SDK: 1.34.0 | ThoughtSpot: 10.3.0.cl
986
+ * @example
987
+ * ```js
988
+ * const embed = new SearchEmbed('#tsEmbed', {
989
+ * ... // other options
990
+ * collapseDataPanel:true,
991
+ * })
992
+ * ```
993
+ */
994
+ collapseDataPanel?: boolean;
980
995
  /**
981
996
  * Show or hide the data sources panel.
982
997
  * @version: SDK: 1.2.0 | ThoughtSpot: 9.1.0.sw
@@ -1103,19 +1118,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1103
1118
  * ```
1104
1119
  */
1105
1120
  hideSearchBar?: boolean;
1106
- /**
1107
- * Flag to control Data panel experience
1108
- * @default false
1109
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
1110
- * @example
1111
- * ```js
1112
- * const embed = new SearchEmbed('#tsEmbed', {
1113
- * ... // other options
1114
- * dataPanelV2:false,
1115
- * })
1116
- * ```
1117
- */
1118
- dataPanelV2?: boolean;
1119
1121
  /**
1120
1122
  * Flag to set if last selected dataSource should be used
1121
1123
  * @version: SDK: 1.24.0
@@ -1125,6 +1127,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
1125
1127
  * To set the initial state of the search bar in case of saved-answers.
1126
1128
  * @default false
1127
1129
  * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1130
+ * @deprecated Use {@link collapseSearchBar} instead
1128
1131
  */
1129
1132
  collapseSearchBarInitially?: boolean;
1130
1133
  /**
@@ -1735,7 +1738,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
1735
1738
  /**
1736
1739
  * @version SDK: 1.28.0| ThoughtSpot: 9.12.5.cl
1737
1740
  */
1738
- SpotIQAnalysis = "spotiq-analysis"
1741
+ SpotIQAnalysis = "spotiq-analysis",
1742
+ /**
1743
+ * @version SDK: 1.34.0| ThoughtSpot: 10.3.0.cl
1744
+ */
1745
+ LiveboardSchedules = "liveboard-schedules"
1739
1746
  }
1740
1747
  export type DOMSelector = string | HTMLElement;
1741
1748
  /**
@@ -2520,6 +2527,43 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2520
2527
  * @version SDK: 1.31.2 | ThoughtSpot: 10.0.0.cl
2521
2528
  */
2522
2529
  enableV2Shell_experimental?: boolean;
2530
+ /**
2531
+ * To set the initial state of the search bar in case of saved-answers.
2532
+ * @default true
2533
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2534
+ * @example
2535
+ * ```js
2536
+ * const embed = new LiveboardEmbed('#embed', {
2537
+ * liveboardId: '123',
2538
+ * collapseSearchBar: true
2539
+ * });
2540
+ */
2541
+ collapseSearchBar?: boolean;
2542
+ /**
2543
+ * This flag can be used to disable links inside the embedded app,
2544
+ * and disables redirection of links in a new tab.
2545
+ * @example
2546
+ * ```js
2547
+ * const embed = new LiveboardEmbed('#embed', {
2548
+ * disableRedirectionLinksInNewTab: true
2549
+ * });
2550
+ * ```
2551
+ * @version SDK: 1.32.1 | ThoughtSpot: 10.3.0.cl
2552
+ */
2553
+ disableRedirectionLinksInNewTab?: boolean;
2554
+ /**
2555
+ * Flag to control Data panel experience
2556
+ * @default true
2557
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
2558
+ * @example
2559
+ * ```js
2560
+ * const embed = new AppEmbed('#tsEmbed', {
2561
+ * ... // other options
2562
+ * dataPanelV2: true,
2563
+ * })
2564
+ * ```
2565
+ */
2566
+ dataPanelV2?: boolean;
2523
2567
  }
2524
2568
  /**
2525
2569
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3982,13 +4026,15 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3982
4026
  *
3983
4027
  * @example
3984
4028
  * ```js
3985
- * appEmbed.trigger(HostEvent.CreateMonitor)
4029
+ * searchEmbed.trigger(HostEvent.CreateMonitor)
3986
4030
  * ```
3987
4031
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
3988
4032
  */
3989
4033
  CreateMonitor = "createMonitor",
3990
4034
  /**
3991
- * Trigger the **Manage alerts** action on a visualization
4035
+ * Trigger the **Manage alerts** action on a KPI chart
4036
+ * in a visualization or saved Answer.
4037
+ *
3992
4038
  * @param - an object with `vizId` as a key
3993
4039
  * @example
3994
4040
  * ```js
@@ -3996,6 +4042,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3996
4042
  * vizId: '730496d6-6903-4601-937e-2c691821af3c'
3997
4043
  * })
3998
4044
  * ```
4045
+ *
4046
+ * @example
4047
+ * ```js
4048
+ * searchEmbed.trigger(HostEvent.ManageMonitor)
4049
+ * ```
4050
+ *
4051
+ * @example
4052
+ * ```js
4053
+ * vizEmbed.trigger(HostEvent.ManageMonitor)
4054
+ * ```
3999
4055
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1.sw
4000
4056
  */
4001
4057
  ManageMonitor = "manageMonitor",
@@ -4567,7 +4623,9 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4567
4623
  Enable2ColumnLayout = "enable2ColumnLayout",
4568
4624
  IsFullAppEmbed = "isFullAppEmbed",
4569
4625
  IsOnBeforeGetVizDataInterceptEnabled = "isOnBeforeGetVizDataInterceptEnabled",
4570
- FocusSearchBarOnRender = "focusSearchBarOnRender"
4626
+ FocusSearchBarOnRender = "focusSearchBarOnRender",
4627
+ DisableRedirectionLinksInNewTab = "disableRedirectionLinksInNewTab",
4628
+ HomePageSearchBarMode = "homePageSearchBarMode"
4571
4629
  }
4572
4630
  /**
4573
4631
  * ThoughtSpot application pages include actions and menu commands
@@ -4716,6 +4774,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
4716
4774
  */
4717
4775
  ConfigureFilter = "configureFilter",
4718
4776
  CollapseDataSources = "collapseDataSources",
4777
+ CollapseDataPanel = "collapseDataPanel",
4719
4778
  /**
4720
4779
  * The **Choose sources** button on Search page.
4721
4780
  * Allows selecting data sources for search queries.
@@ -5111,12 +5170,15 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5111
5170
  * The Create alert action on KPI charts.
5112
5171
  * @example
5113
5172
  * ```js
5114
- * disabledActions: [Action.CreateMonitor ]
5173
+ * disabledActions: [Action.CreateMonitor]
5115
5174
  * ```
5116
5175
  * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1.sw
5117
5176
  */
5118
5177
  CreateMonitor = "createMonitor",
5119
5178
  /**
5179
+ * @deprecated
5180
+ * Reports errors
5181
+ *
5120
5182
  * @example
5121
5183
  * ```js
5122
5184
  * disabledActions: [Action.ReportError]
@@ -5341,35 +5403,84 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5341
5403
  */
5342
5404
  RenameModalTitleDescription = "renameModalTitleDescription",
5343
5405
  /**
5406
+ *
5407
+ * @example
5408
+ * ```js
5409
+ * disabledActions: [Action.RequestVerification]
5410
+ * ```
5344
5411
  *
5345
5412
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5346
5413
  */
5347
5414
  RequestVerification = "requestVerification",
5348
5415
  /**
5416
+ *
5417
+ * Allows users to mark a Liveboard as verified.
5418
+ *
5419
+ * @example
5420
+ * ```js
5421
+ * disabledActions: [Action.MarkAsVerified]
5422
+ * ```
5349
5423
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5350
5424
  */
5351
5425
  MarkAsVerified = "markAsVerified",
5352
5426
  /**
5427
+ * The **Add Tab** action on a Liveboard.
5428
+ * Allows adding a new tab to a Liveboard view.
5429
+ *
5430
+ * @example
5431
+ * ```js
5432
+ * disabledActions: [Action.AddTab]
5433
+ * ```
5353
5434
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5354
5435
  */
5355
5436
  AddTab = "addTab",
5356
5437
  /**
5438
+ *
5439
+ * Initiates contextual change analysis on KPI charts.
5440
+ *
5441
+ * @example
5442
+ * ```js
5443
+ * disabledActions: [Action.EnableContextualChangeAnalysis]
5444
+ * ```
5357
5445
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
5358
5446
  */
5359
5447
  EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
5360
5448
  /**
5449
+ *
5450
+ * @example
5451
+ * ```js
5452
+ * disabledActions: [Action.ShowSageQuery]
5453
+ * ```
5454
+ *
5361
5455
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5362
5456
  */
5363
5457
  ShowSageQuery = "showSageQuery",
5364
5458
  /**
5459
+ *
5460
+ * @example
5461
+ * ```js
5462
+ * disabledActions: [Action.EditSageAnswer]
5463
+ * ```
5365
5464
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5366
5465
  */
5367
5466
  EditSageAnswer = "editSageAnswer",
5368
5467
  /**
5468
+ *
5469
+ * This action allows users to send feedback on AI-generated Answers.
5470
+ *
5471
+ * @example
5472
+ * ```js
5473
+ * disabledActions: [Action.SageAnswerFeedback]
5474
+ * ```
5369
5475
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5370
5476
  */
5371
5477
  SageAnswerFeedback = "sageAnswerFeedback",
5372
5478
  /**
5479
+ *
5480
+ * @example
5481
+ * ```js
5482
+ * disabledActions: [Action.ModifySageAnswer]
5483
+ * ```
5373
5484
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
5374
5485
  */
5375
5486
  ModifySageAnswer = "modifySageAnswer",
@@ -5490,7 +5601,71 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
5490
5601
  * ```
5491
5602
  * @version SDK: 1.27.10 | Thoughtspot: 9.12.5.cl
5492
5603
  */
5493
- AIHighlights = "AIHighlights"
5604
+ AIHighlights = "AIHighlights",
5605
+ /**
5606
+ * Action ID for edit schedule action on schedule on homepage
5607
+ * @example
5608
+ * ```js
5609
+ * disabledActions: [Action.EditScheduleHomepage]
5610
+ * ```
5611
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5612
+ */
5613
+ EditScheduleHomepage = "editScheduleHomepage",
5614
+ /**
5615
+ * Action ID for pause schedule action on schedule on homepage
5616
+ * @example
5617
+ * ```js
5618
+ * disabledActions: [Action.PauseScheduleHomepage]
5619
+ * ```
5620
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5621
+ */
5622
+ PauseScheduleHomepage = "pauseScheduleHomepage",
5623
+ /**
5624
+ * Action ID for view schedule run action on schedule on homepage
5625
+ * @example
5626
+ * ```js
5627
+ * disabledActions: [Action.ViewScheduleRunHomepage]
5628
+ * ```
5629
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5630
+ */
5631
+ ViewScheduleRunHomepage = "viewScheduleRunHomepage",
5632
+ /**
5633
+ * Action ID for unsubscribe schedule action on schedule on homepage
5634
+ * @example
5635
+ * ```js
5636
+ * disabledActions: [Action.UnsubscribeScheduleHomepage]
5637
+ * ```
5638
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5639
+ */
5640
+ UnsubscribeScheduleHomepage = "unsubscribeScheduleHomepage",
5641
+ /**
5642
+ * The **Manage Tags** action on Homepage Favourite Module.
5643
+ *
5644
+ * @example
5645
+ * ```js
5646
+ * disabledActions: [Action.ManageTags]
5647
+ * ```
5648
+ * @version SDK : 1.34.0 | Thoughtspot: 10.3.0.cl
5649
+ */
5650
+ ManageTags = "manageTags",
5651
+ /**
5652
+ * Action ID for delete schedule action on schedule on homepage
5653
+ * @example
5654
+ * ```js
5655
+ * disabledActions: [Action.DeleteScheduleHomepage]
5656
+ * ```
5657
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5658
+ */
5659
+ DeleteScheduleHomepage = "deleteScheduleHomepage",
5660
+ /**
5661
+ * The **Analyze CTA** action on KPI chart.
5662
+ * @example
5663
+ * ```js
5664
+ * disabledActions: [Action.KPIAnalysisCTA]
5665
+ * ```
5666
+ * @version SDK: 1.34.0 | Thoughtspot: 10.3.0.cl
5667
+ */
5668
+ KPIAnalysisCTA = "kpiAnalysisCTA"
5494
5669
  }
5495
5670
  export interface AnswerServiceType {
5496
5671
  getAnswer?: (offset: number, batchSize: number) => any;
@@ -5965,6 +6140,34 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
5965
6140
  * Background for favorite carousel find your favorites card in modular home.
5966
6141
  */
5967
6142
  '--ts-var-home-favorite-suggestion-card-background'?: string;
6143
+ /**
6144
+ * Border color of checkbox in error state.
6145
+ */
6146
+ '--ts-var-checkbox-error-border'?: string;
6147
+ /**
6148
+ * Border color of checkbox.
6149
+ */
6150
+ '--ts-var-checkbox-border-color'?: string;
6151
+ /**
6152
+ * Border color of checkbox in hover state.
6153
+ */
6154
+ '--ts-var-checkbox-hover-border'?: string;
6155
+ /**
6156
+ * Border and font color of checkbox in active state.
6157
+ */
6158
+ '--ts-var-checkbox-active-color'?: string;
6159
+ /**
6160
+ * Border color and font color of checkbox in checked state.
6161
+ */
6162
+ '--ts-var-checkbox-checked-color'?: string;
6163
+ /**
6164
+ * Border and font color of checkbox in disabled state.
6165
+ */
6166
+ '--ts-var-checkbox-checked-disabled'?: string;
6167
+ /**
6168
+ * Background color of checkbox.
6169
+ */
6170
+ '--ts-var-checkbox-background-color'?: string;
5968
6171
  }
5969
6172
  }
5970
6173
 
@@ -6297,6 +6500,10 @@ declare module '@thoughtspot/visual-embed-sdk/mixpanel-service' {
6297
6500
  export const EndPoints: {
6298
6501
  CONFIG: string;
6299
6502
  };
6503
+ /**
6504
+ * Enum of mixpanel events
6505
+ * @hidden
6506
+ */
6300
6507
  export const MIXPANEL_EVENT: {
6301
6508
  VISUAL_SDK_RENDER_START: string;
6302
6509
  VISUAL_SDK_CALLED_INIT: string;
@@ -6428,7 +6635,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
6428
6635
  * @param queryParams
6429
6636
  * @returns queryParams
6430
6637
  */
6431
- protected getBaseQueryParams(queryParams?: {}): {};
6638
+ protected getBaseQueryParams(queryParams?: Record<any, any>): Record<any, any>;
6432
6639
  /**
6433
6640
  * Constructs the base URL string to load v1 of the ThoughtSpot app.
6434
6641
  * This is used for embedding Liveboards, visualizations, and full application.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.32.0",
3
+ "version": "1.32.2",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
@@ -45,11 +45,6 @@
45
45
  "lint": "eslint 'src/**'",
46
46
  "lint:fix": "eslint 'src/**/*.*' --fix",
47
47
  "tsc": "tsc -p . --incremental false; tsc -p . --incremental false --module commonjs --outDir cjs",
48
- "start": "gatsby develop",
49
- "build:gatsby": "npm run clean:gatsby && gatsby build --prefix-paths",
50
- "build:gatsby:noprefix": "npm run clean:gatsby && gatsby build",
51
- "serve:gatsby": "gatsby serve",
52
- "clean:gatsby": "gatsby clean",
53
48
  "build-and-publish": "npm run build:gatsby && npm run publish",
54
49
  "bundle-dts-file": "dts-bundle --name @thoughtspot/visual-embed-sdk --out visual-embed-sdk.d.ts --main lib/src/index.d.ts",
55
50
  "bundle-dts": "dts-bundle --name ../../dist/visual-embed-sdk --main lib/src/index.d.ts --outputAsModuleFolder=true",
@@ -57,11 +52,9 @@
57
52
  "bundle-dts-react-full": "dts-bundle --name ../../../dist/visual-embed-sdk-react-full --main lib/src/react/all-types-export.d.ts --outputAsModuleFolder=true",
58
53
  "build": "rollup -c",
59
54
  "watch": "rollup -cw",
60
- "docs-cmd": "node scripts/gatsby-commands.js",
61
- "docgen": "typedoc --tsconfig tsconfig.json --theme typedoc-theme",
55
+ "docgen": "typedoc --tsconfig tsconfig.json --theme typedoc-theme --json static/typedoc/typedoc.json --disableOutputCheck",
62
56
  "test-sdk": "jest -c jest.config.sdk.js --runInBand",
63
- "test-docs": "jest -c jest.config.docs.js",
64
- "test": "npm run test-sdk && npm run test-docs",
57
+ "test": "npm run test-sdk",
65
58
  "posttest": "cat ./coverage/sdk/lcov.info | coveralls",
66
59
  "is-publish-allowed": "node scripts/is-publish-allowed.js",
67
60
  "prepublishOnly": "npm run is-publish-allowed && npm run test && npm run tsc && npm run bundle-dts-file && npm run bundle-dts && npm run bundle-dts-react && npm run bundle-dts-react-full && npm run build",
@@ -104,6 +97,7 @@
104
97
  "@testing-library/user-event": "^13.1.8",
105
98
  "@types/jest": "^22.2.3",
106
99
  "@types/mixpanel-browser": "^2.35.6",
100
+ "@types/lodash": "^4.17.0",
107
101
  "@types/react-test-renderer": "^17.0.1",
108
102
  "@typescript-eslint/eslint-plugin": "^4.6.0",
109
103
  "@typescript-eslint/parser": "^4.6.0",
@@ -122,18 +116,6 @@
122
116
  "eslint-plugin-prettier": "^3.1.4",
123
117
  "eslint-plugin-react-hooks": "^4.2.0",
124
118
  "fs-extra": "^10.0.0",
125
- "gatsby": "3.13.1",
126
- "gatsby-plugin-algolia": "^0.22.2",
127
- "gatsby-plugin-catch-links": "^3.1.0",
128
- "gatsby-plugin-env-variables": "^2.1.0",
129
- "gatsby-plugin-intl": "^0.3.3",
130
- "gatsby-plugin-manifest": "^3.2.0",
131
- "gatsby-plugin-output": "^0.1.3",
132
- "gatsby-plugin-sass": "6.7.0",
133
- "gatsby-plugin-sitemap": "^4.10.0",
134
- "gatsby-source-filesystem": "3.1.0",
135
- "gatsby-transformer-asciidoc": "2.1.0",
136
- "gatsby-transformer-rehype": "2.0.0",
137
119
  "gh-pages": "^3.1.0",
138
120
  "highlight.js": "^10.6.0",
139
121
  "html-to-text": "^8.0.0",
package/src/auth.ts CHANGED
@@ -16,6 +16,7 @@ import {
16
16
  import { isActiveService } from './utils/authService/tokenizedAuthService';
17
17
  import { logger } from './utils/logger';
18
18
  import { getSessionInfo } from './utils/sessionInfoService';
19
+ import { ERROR_MESSAGE } from './errors';
19
20
 
20
21
  // eslint-disable-next-line import/no-mutable-exports
21
22
  export let loggedInStatus = false;
@@ -151,7 +152,7 @@ export function setAuthEE(eventEmitter: EventEmitter<AuthStatus | AuthEvent>): v
151
152
  */
152
153
  export function notifyAuthSDKSuccess(): void {
153
154
  if (!authEE) {
154
- logger.error('SDK not initialized');
155
+ logger.error(ERROR_MESSAGE.SDK_NOT_INITIALIZED);
155
156
  return;
156
157
  }
157
158
  authEE.emit(AuthStatus.SDK_SUCCESS);
@@ -162,14 +163,14 @@ export function notifyAuthSDKSuccess(): void {
162
163
  */
163
164
  export async function notifyAuthSuccess(): Promise<void> {
164
165
  if (!authEE) {
165
- logger.error('SDK not initialized');
166
+ logger.error(ERROR_MESSAGE.SDK_NOT_INITIALIZED);
166
167
  return;
167
168
  }
168
169
  try {
169
170
  const sessionInfo = await getSessionInfo();
170
171
  authEE.emit(AuthStatus.SUCCESS, sessionInfo);
171
172
  } catch (e) {
172
- logger.error('Failed to get session info');
173
+ logger.error(ERROR_MESSAGE.SESSION_INFO_FAILED);
173
174
  }
174
175
  }
175
176
 
@@ -179,7 +180,7 @@ export async function notifyAuthSuccess(): Promise<void> {
179
180
  */
180
181
  export function notifyAuthFailure(failureType: AuthFailureType): void {
181
182
  if (!authEE) {
182
- logger.error('SDK not initialized');
183
+ logger.error(ERROR_MESSAGE.SDK_NOT_INITIALIZED);
183
184
  return;
184
185
  }
185
186
  authEE.emit(AuthStatus.FAILURE, failureType);
@@ -190,7 +191,7 @@ export function notifyAuthFailure(failureType: AuthFailureType): void {
190
191
  */
191
192
  export function notifyLogout(): void {
192
193
  if (!authEE) {
193
- logger.error('SDK not initialized');
194
+ logger.error(ERROR_MESSAGE.SDK_NOT_INITIALIZED);
194
195
  return;
195
196
  }
196
197
  authEE.emit(AuthStatus.LOGOUT);
package/src/authToken.ts CHANGED
@@ -1,12 +1,8 @@
1
+ import { ERROR_MESSAGE } from './errors';
1
2
  import { EmbedConfig } from './types';
2
3
  import { fetchAuthTokenService, verifyTokenService } from './utils/authService/authService';
3
4
  import { logger } from './utils/logger';
4
5
 
5
- const DUPLICATE_TOKEN_ERR = 'Duplicate token, please issue a new token every time getAuthToken callback is called.'
6
- + 'See https://developers.thoughtspot.com/docs/?pageid=embed-auth#trusted-auth-embed for more details.';
7
-
8
- const INVALID_TOKEN_ERR = 'Invalid token received form token callback or authToken endpoint.';
9
-
10
6
  let cachedAuthToken: string | null = null;
11
7
 
12
8
  // This method can be used to get the authToken using the embedConfig
@@ -38,7 +34,7 @@ export async function getAuthenticationToken(embedConfig: EmbedConfig): Promise<
38
34
  // this will throw error if the token is not valid
39
35
  await validateAuthToken(embedConfig, authToken);
40
36
  } catch (e) {
41
- logger.error(`Received invalid token from getAuthToken callback or authToken endpoint. Error : ${e.message}`);
37
+ logger.error(`${ERROR_MESSAGE.INVALID_TOKEN_ERROR} Error : ${e.message}`);
42
38
  throw e;
43
39
  }
44
40
 
@@ -65,11 +61,11 @@ const validateAuthToken = async (
65
61
  if (cachedAuthToken && cachedAuthToken === authToken) {
66
62
  if (!embedConfig.suppressErrorAlerts && !suppressAlert) {
67
63
  // eslint-disable-next-line no-alert
68
- alert(DUPLICATE_TOKEN_ERR);
64
+ alert(ERROR_MESSAGE.DUPLICATE_TOKEN_ERR);
69
65
  }
70
- throw new Error(DUPLICATE_TOKEN_ERR);
66
+ throw new Error(ERROR_MESSAGE.DUPLICATE_TOKEN_ERR);
71
67
  } else {
72
- throw new Error(INVALID_TOKEN_ERR);
68
+ throw new Error(ERROR_MESSAGE.INVALID_TOKEN_ERROR);
73
69
  }
74
70
  };
75
71
 
@@ -416,4 +416,32 @@ export interface CustomCssVariables {
416
416
  * Background for favorite carousel find your favorites card in modular home.
417
417
  */
418
418
  '--ts-var-home-favorite-suggestion-card-background'?: string;
419
+ /**
420
+ * Border color of checkbox in error state.
421
+ */
422
+ '--ts-var-checkbox-error-border'?: string;
423
+ /**
424
+ * Border color of checkbox.
425
+ */
426
+ '--ts-var-checkbox-border-color'?: string;
427
+ /**
428
+ * Border color of checkbox in hover state.
429
+ */
430
+ '--ts-var-checkbox-hover-border'?: string;
431
+ /**
432
+ * Border and font color of checkbox in active state.
433
+ */
434
+ '--ts-var-checkbox-active-color'?: string;
435
+ /**
436
+ * Border color and font color of checkbox in checked state.
437
+ */
438
+ '--ts-var-checkbox-checked-color'?: string;
439
+ /**
440
+ * Border and font color of checkbox in disabled state.
441
+ */
442
+ '--ts-var-checkbox-checked-disabled'?: string;
443
+ /**
444
+ * Background color of checkbox.
445
+ */
446
+ '--ts-var-checkbox-background-color'?: string;
419
447
  }