@thoughtspot/visual-embed-sdk 1.28.2 → 1.28.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/cjs/package.json +2 -1
  2. package/cjs/src/embed/app.d.ts +38 -0
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +7 -1
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/app.spec.js +10 -0
  7. package/cjs/src/embed/app.spec.js.map +1 -1
  8. package/cjs/src/embed/liveboard.d.ts +16 -0
  9. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  10. package/cjs/src/embed/liveboard.js +8 -3
  11. package/cjs/src/embed/liveboard.js.map +1 -1
  12. package/cjs/src/embed/liveboard.spec.js +61 -4
  13. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  14. package/cjs/src/embed/sage.d.ts +4 -4
  15. package/cjs/src/embed/sage.d.ts.map +1 -1
  16. package/cjs/src/embed/sage.js +2 -18
  17. package/cjs/src/embed/sage.js.map +1 -1
  18. package/cjs/src/embed/sage.spec.js +20 -31
  19. package/cjs/src/embed/sage.spec.js.map +1 -1
  20. package/cjs/src/embed/search.d.ts +22 -0
  21. package/cjs/src/embed/search.d.ts.map +1 -1
  22. package/cjs/src/embed/search.js +3 -1
  23. package/cjs/src/embed/search.js.map +1 -1
  24. package/cjs/src/embed/search.spec.js +2 -1
  25. package/cjs/src/embed/search.spec.js.map +1 -1
  26. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  27. package/cjs/src/embed/ts-embed.js +9 -0
  28. package/cjs/src/embed/ts-embed.js.map +1 -1
  29. package/cjs/src/embed/ts-embed.spec.js +18 -0
  30. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  31. package/cjs/src/errors.js +1 -1
  32. package/cjs/src/errors.js.map +1 -1
  33. package/cjs/src/react/index.spec.js +1 -1
  34. package/cjs/src/react/index.spec.js.map +1 -1
  35. package/cjs/src/types.d.ts +106 -9
  36. package/cjs/src/types.d.ts.map +1 -1
  37. package/cjs/src/types.js +87 -4
  38. package/cjs/src/types.js.map +1 -1
  39. package/cjs/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
  40. package/cjs/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
  41. package/cjs/src/utils/authService/tokenizedAuthService.spec.js +32 -0
  42. package/cjs/src/utils/authService/tokenizedAuthService.spec.js.map +1 -0
  43. package/cjs/src/utils/sessionInfoService.d.ts +66 -0
  44. package/cjs/src/utils/sessionInfoService.d.ts.map +1 -0
  45. package/cjs/src/utils/sessionInfoService.js +92 -0
  46. package/cjs/src/utils/sessionInfoService.js.map +1 -0
  47. package/dist/src/embed/app.d.ts +38 -0
  48. package/dist/src/embed/app.d.ts.map +1 -1
  49. package/dist/src/embed/liveboard.d.ts +16 -0
  50. package/dist/src/embed/liveboard.d.ts.map +1 -1
  51. package/dist/src/embed/sage.d.ts +4 -4
  52. package/dist/src/embed/sage.d.ts.map +1 -1
  53. package/dist/src/embed/search.d.ts +22 -0
  54. package/dist/src/embed/search.d.ts.map +1 -1
  55. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  56. package/dist/src/types.d.ts +106 -9
  57. package/dist/src/types.d.ts.map +1 -1
  58. package/dist/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
  59. package/dist/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
  60. package/dist/src/utils/sessionInfoService.d.ts +66 -0
  61. package/dist/src/utils/sessionInfoService.d.ts.map +1 -0
  62. package/dist/tsembed-react.es.js +117 -28
  63. package/dist/tsembed-react.js +117 -28
  64. package/dist/tsembed.es.js +117 -28
  65. package/dist/tsembed.js +117 -28
  66. package/dist/visual-embed-sdk-react-full.d.ts +185 -12
  67. package/dist/visual-embed-sdk-react.d.ts +185 -12
  68. package/dist/visual-embed-sdk.d.ts +185 -12
  69. package/lib/package.json +2 -1
  70. package/lib/src/embed/app.d.ts +38 -0
  71. package/lib/src/embed/app.d.ts.map +1 -1
  72. package/lib/src/embed/app.js +7 -1
  73. package/lib/src/embed/app.js.map +1 -1
  74. package/lib/src/embed/app.spec.js +10 -0
  75. package/lib/src/embed/app.spec.js.map +1 -1
  76. package/lib/src/embed/liveboard.d.ts +16 -0
  77. package/lib/src/embed/liveboard.d.ts.map +1 -1
  78. package/lib/src/embed/liveboard.js +8 -3
  79. package/lib/src/embed/liveboard.js.map +1 -1
  80. package/lib/src/embed/liveboard.spec.js +61 -4
  81. package/lib/src/embed/liveboard.spec.js.map +1 -1
  82. package/lib/src/embed/sage.d.ts +4 -4
  83. package/lib/src/embed/sage.d.ts.map +1 -1
  84. package/lib/src/embed/sage.js +2 -18
  85. package/lib/src/embed/sage.js.map +1 -1
  86. package/lib/src/embed/sage.spec.js +20 -31
  87. package/lib/src/embed/sage.spec.js.map +1 -1
  88. package/lib/src/embed/search.d.ts +22 -0
  89. package/lib/src/embed/search.d.ts.map +1 -1
  90. package/lib/src/embed/search.js +3 -1
  91. package/lib/src/embed/search.js.map +1 -1
  92. package/lib/src/embed/search.spec.js +2 -1
  93. package/lib/src/embed/search.spec.js.map +1 -1
  94. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  95. package/lib/src/embed/ts-embed.js +9 -0
  96. package/lib/src/embed/ts-embed.js.map +1 -1
  97. package/lib/src/embed/ts-embed.spec.js +18 -0
  98. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  99. package/lib/src/errors.js +1 -1
  100. package/lib/src/errors.js.map +1 -1
  101. package/lib/src/react/index.spec.js +1 -1
  102. package/lib/src/react/index.spec.js.map +1 -1
  103. package/lib/src/types.d.ts +106 -9
  104. package/lib/src/types.d.ts.map +1 -1
  105. package/lib/src/types.js +87 -4
  106. package/lib/src/types.js.map +1 -1
  107. package/lib/src/utils/authService/tokenizedAuthService.spec.d.ts +2 -0
  108. package/lib/src/utils/authService/tokenizedAuthService.spec.d.ts.map +1 -0
  109. package/lib/src/utils/authService/tokenizedAuthService.spec.js +29 -0
  110. package/lib/src/utils/authService/tokenizedAuthService.spec.js.map +1 -0
  111. package/lib/src/utils/sessionInfoService.d.ts +66 -0
  112. package/lib/src/utils/sessionInfoService.d.ts.map +1 -0
  113. package/lib/src/utils/sessionInfoService.js +85 -0
  114. package/lib/src/utils/sessionInfoService.js.map +1 -0
  115. package/lib/src/visual-embed-sdk.d.ts +186 -13
  116. package/package.json +2 -1
  117. package/src/embed/app.spec.ts +15 -0
  118. package/src/embed/app.ts +48 -0
  119. package/src/embed/liveboard.spec.ts +82 -9
  120. package/src/embed/liveboard.ts +26 -2
  121. package/src/embed/sage.spec.ts +20 -35
  122. package/src/embed/sage.ts +4 -21
  123. package/src/embed/search.spec.ts +2 -1
  124. package/src/embed/search.ts +26 -0
  125. package/src/embed/ts-embed.spec.ts +22 -0
  126. package/src/embed/ts-embed.ts +9 -0
  127. package/src/errors.ts +1 -1
  128. package/src/react/index.spec.tsx +1 -1
  129. package/src/types.ts +106 -8
@@ -363,7 +363,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
363
363
  showObjectResults?: boolean;
364
364
  /**
365
365
  * flag used by the TS product tour page to show the blue search bar
366
- * even after the search is completed. This is different from TSE Sage Embed
366
+ * even after the search is completed. This is different from Thoughtspot Embedded Sage Embed
367
367
  * experience where it mimics closer to the non-embed case.
368
368
  * The Sample questions container is collapsed when this value is set after
369
369
  * does a search.
@@ -374,8 +374,9 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
374
374
  isProductTour?: boolean;
375
375
  /**
376
376
  * Show or hide the search bar title.
377
+ * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
377
378
  *
378
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
379
+ * @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
379
380
  */
380
381
  hideSearchBarTitle?: boolean;
381
382
  /**
@@ -445,7 +446,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
445
446
  */
446
447
  searchOptions?: SearchOptions;
447
448
  }
448
- export declare const HiddenActionItemByDefaultForSageEmbed: Action[];
449
449
  /**
450
450
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
451
451
  *
@@ -686,6 +686,28 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
686
686
  * @version: SDK: 1.24.0
687
687
  */
688
688
  useLastSelectedSources?: boolean;
689
+ /**
690
+ * To set the initial state of the search bar in case of saved-answers.
691
+ *
692
+ * @default false
693
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
694
+ */
695
+ collapseSearchBarInitially?: boolean;
696
+ /**
697
+ * To enable custom column groups in data panel v2
698
+ *
699
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
700
+ * @default false
701
+ *
702
+ * @example
703
+ * ```js
704
+ * const embed = new SearchEmbed('#tsEmbed', {
705
+ * ... // other options
706
+ * enableCustomColumnGroups: true,
707
+ * });
708
+ * ```
709
+ */
710
+ enableCustomColumnGroups?: boolean;
689
711
  }
690
712
  export declare const HiddenActionItemByDefaultForSearchEmbed: Action[];
691
713
  /**
@@ -1047,6 +1069,44 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
1047
1069
  * @default false
1048
1070
  */
1049
1071
  enableAskSage?: boolean;
1072
+ /**
1073
+ * To set the initial state of the search bar in case of saved-answers.
1074
+ *
1075
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1076
+ * @default false
1077
+ */
1078
+ collapseSearchBarInitially?: boolean;
1079
+ /**
1080
+ * To enable custom column groups in data panel v2
1081
+ *
1082
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1083
+ * @default false
1084
+ *
1085
+ * @example
1086
+ * ```js
1087
+ * const embed = new AppEmbed('#embed', {
1088
+ * ... // other app view config
1089
+ * enableCustomColumnGroups: true,
1090
+ * });
1091
+ * ```
1092
+ */
1093
+ enableCustomColumnGroups?: boolean;
1094
+ /**
1095
+ * This flag is used to enable the 2 column layout in liveboard
1096
+ *
1097
+ * @type {boolean}
1098
+ * @default false
1099
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1100
+ *
1101
+ * @example
1102
+ * ```js
1103
+ * const embed = new LiveboardEmbed('#embed-container', {
1104
+ * ... // other options
1105
+ * enable2ColumnLayout: true,
1106
+ * })
1107
+ * ```
1108
+ */
1109
+ enable2ColumnLayout?: boolean;
1050
1110
  }
1051
1111
  /**
1052
1112
  * Embeds full ThoughtSpot experience in a host application.
@@ -1342,6 +1402,22 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
1342
1402
  * ```
1343
1403
  */
1344
1404
  enableAskSage?: boolean;
1405
+ /**
1406
+ * This flag is used to enable the 2 column layout in liveboard
1407
+ *
1408
+ * @type {boolean}
1409
+ * @default false
1410
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
1411
+ *
1412
+ * @example
1413
+ * ```js
1414
+ * const embed = new LiveboardEmbed('#embed-container', {
1415
+ * ... // other options
1416
+ * enable2ColumnLayout: true,
1417
+ * })
1418
+ * ```
1419
+ */
1420
+ enable2ColumnLayout?: boolean;
1345
1421
  }
1346
1422
  /**
1347
1423
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1987,6 +2063,24 @@ export interface EmbedConfig {
1987
2063
  * @version SDK: 1.27.9
1988
2064
  */
1989
2065
  disableSDKTracking?: boolean;
2066
+ /**
2067
+ * Overrides default/user preffered locale for date formatting
2068
+ *
2069
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2070
+ */
2071
+ dateFormatLocale?: string;
2072
+ /**
2073
+ * Overrides default/user preffered locale for number formatting
2074
+ *
2075
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2076
+ */
2077
+ numberFormatLocale?: string;
2078
+ /**
2079
+ * Format to be used for currency when currency format is set to infer from browser
2080
+ *
2081
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2082
+ */
2083
+ currencyFormat?: string;
1990
2084
  }
1991
2085
  export interface LayoutConfig {
1992
2086
  }
@@ -2304,11 +2398,7 @@ export interface ViewConfig {
2304
2398
  *
2305
2399
  * **Note**: This option does not apply to the classic homepage.
2306
2400
  * To access the updated modular homepage, set
2307
- <<<<<<< HEAD
2308
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.0.cl).
2309
- =======
2310
2401
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2311
- >>>>>>> 64e22666... typo fixes
2312
2402
  *
2313
2403
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2314
2404
  * @example
@@ -4451,7 +4541,14 @@ export declare enum Param {
4451
4541
  HideSearchBar = "hideSearchBar",
4452
4542
  ClientLogLevel = "clientLogLevel",
4453
4543
  OverrideNativeConsole = "overrideConsoleLogs",
4454
- enableAskSage = "enableAskSage"
4544
+ enableAskSage = "enableAskSage",
4545
+ CollapseSearchBarInitially = "collapseSearchBarInitially",
4546
+ EnableCustomColumnGroups = "enableCustomColumnGroups",
4547
+ DateFormatLocale = "dateFormatLocale",
4548
+ NumberFormatLocale = "numberFormatLocale",
4549
+ CurrencyFormat = "currencyFormat",
4550
+ Enable2ColumnLayout = "enable2ColumnLayout",
4551
+ IsFullAppEmbed = "isFullAppEmbed"
4455
4552
  }
4456
4553
  /**
4457
4554
  * ThoughtSpot application pages include actions and menu commands
@@ -4587,6 +4684,18 @@ export declare enum Action {
4587
4684
  * ```
4588
4685
  */
4589
4686
  AddFilter = "addFilter",
4687
+ /**
4688
+ * The **Add Data Panel Objects** action on the data panel v2.
4689
+ * Allows to show action menu to add different objects (like
4690
+ * formulas, parameters) in data panel v2.
4691
+ *
4692
+ * @example
4693
+ * ```js
4694
+ * disabledActions: [Action.AddDataPanelObjects]
4695
+ * ```
4696
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4697
+ */
4698
+ AddDataPanelObjects = "addDataPanelObjects",
4590
4699
  /**
4591
4700
  * Filter configuration options on a Liveboard and Search page.
4592
4701
  * Allows configuring filter options when adding filters to a
@@ -4629,6 +4738,28 @@ export declare enum Action {
4629
4738
  * ```
4630
4739
  */
4631
4740
  AddParameter = "addParameter",
4741
+ /**
4742
+ * The **Add Column Set** action on a Answer.
4743
+ * Allows adding column sets to a Answer.
4744
+ *
4745
+ * @example
4746
+ * ```js
4747
+ * disabledActions: [Action.AddColumnSet]
4748
+ * ```
4749
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4750
+ */
4751
+ AddColumnSet = "addSimpleCohort",
4752
+ /**
4753
+ * The **Add Query Set** action on a Answer.
4754
+ * Allows adding query sets to a Answer.
4755
+ *
4756
+ * @example
4757
+ * ```js
4758
+ * disabledActions: [Action.AddQuerySet]
4759
+ * ```
4760
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4761
+ */
4762
+ AddQuerySet = "addAdvancedCohort",
4632
4763
  /**
4633
4764
  * @hidden
4634
4765
  */
@@ -5060,6 +5191,28 @@ export declare enum Action {
5060
5191
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
5061
5192
  */
5062
5193
  CrossFilter = "context-menu-item-cross-filter",
5194
+ /**
5195
+ * The **Sync to Slack** action on Liveboard visualizations.
5196
+ * Allows sending data to third-party apps Slack
5197
+ *
5198
+ * @example
5199
+ * ```js
5200
+ * disabledActions: [Action.SyncToSlack]
5201
+ * ```
5202
+ * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5203
+ */
5204
+ SyncToSlack = "syncToSlack",
5205
+ /**
5206
+ * The **Sync to Teams** action on Liveboard visualizations.
5207
+ * Allows sending data to third-party apps Team
5208
+ *
5209
+ * @example
5210
+ * ```js
5211
+ * disabledActions: [Action.SyncToTeams]
5212
+ * ```
5213
+ * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5214
+ */
5215
+ SyncToTeams = "syncToTeams",
5063
5216
  /**
5064
5217
  * The **Remove** action that appears when cross filters are applied
5065
5218
  * on a Liveboard.
@@ -5301,6 +5454,26 @@ export declare enum Action {
5301
5454
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
5302
5455
  */
5303
5456
  LiveboardUsers = "liveboardUsers",
5457
+ /**
5458
+ * Action ID for the Parent TML action
5459
+ * The parent action **TML** must be included to access TML-related options
5460
+ * within the cascading menu (specific to the answer page)
5461
+ *
5462
+ * @example
5463
+ * ```js
5464
+ * // to include specific TML actions
5465
+ * visibleActions: [Action.TML, Action.ExportTML, Action.EditTML]
5466
+ *
5467
+ * ```
5468
+ * @example
5469
+ * ```js
5470
+ * hiddenAction: [Action.TML] // hide all TML actions
5471
+ * disabledActions: [Action.TML] // to disable all TML actions
5472
+ * ```
5473
+ *
5474
+ * @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
5475
+ */
5476
+ TML = "tml",
5304
5477
  /**
5305
5478
  * Action ID for to hide Verified Liveboard Banner
5306
5479
  *
@@ -5342,15 +5515,15 @@ export declare enum Action {
5342
5515
  */
5343
5516
  RemoveFromWatchlist = "removeFromWatchlist",
5344
5517
  /**
5345
- * The **Copy KPI Link** menu action on KPI watchlist.
5518
+ * The **Organise Favourites** action on Homepage Favourite Module.
5346
5519
  *
5347
5520
  * @example
5348
5521
  * ```js
5349
- * disabledActions: [Action.CopyKpiLink]
5522
+ * disabledActions: [Action.OrganiseFavourites]
5350
5523
  * ```
5351
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
5524
+ * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
5352
5525
  */
5353
- CopyKpiLink = "copyKpiLink",
5526
+ OrganiseFavourites = "organiseFavourites",
5354
5527
  /**
5355
5528
  * Action ID for AI Highlights button
5356
5529
  *
@@ -348,6 +348,44 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
348
348
  * @default false
349
349
  */
350
350
  enableAskSage?: boolean;
351
+ /**
352
+ * To set the initial state of the search bar in case of saved-answers.
353
+ *
354
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
355
+ * @default false
356
+ */
357
+ collapseSearchBarInitially?: boolean;
358
+ /**
359
+ * To enable custom column groups in data panel v2
360
+ *
361
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
362
+ * @default false
363
+ *
364
+ * @example
365
+ * ```js
366
+ * const embed = new AppEmbed('#embed', {
367
+ * ... // other app view config
368
+ * enableCustomColumnGroups: true,
369
+ * });
370
+ * ```
371
+ */
372
+ enableCustomColumnGroups?: boolean;
373
+ /**
374
+ * This flag is used to enable the 2 column layout in liveboard
375
+ *
376
+ * @type {boolean}
377
+ * @default false
378
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
379
+ *
380
+ * @example
381
+ * ```js
382
+ * const embed = new LiveboardEmbed('#embed-container', {
383
+ * ... // other options
384
+ * enable2ColumnLayout: true,
385
+ * })
386
+ * ```
387
+ */
388
+ enable2ColumnLayout?: boolean;
351
389
  }
352
390
  /**
353
391
  * Embeds full ThoughtSpot experience in a host application.
@@ -781,6 +819,22 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
781
819
  * ```
782
820
  */
783
821
  enableAskSage?: boolean;
822
+ /**
823
+ * This flag is used to enable the 2 column layout in liveboard
824
+ *
825
+ * @type {boolean}
826
+ * @default false
827
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
828
+ *
829
+ * @example
830
+ * ```js
831
+ * const embed = new LiveboardEmbed('#embed-container', {
832
+ * ... // other options
833
+ * enable2ColumnLayout: true,
834
+ * })
835
+ * ```
836
+ */
837
+ enable2ColumnLayout?: boolean;
784
838
  }
785
839
  /**
786
840
  * Embed a ThoughtSpot Liveboard or visualization. When rendered it already
@@ -1035,6 +1089,28 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
1035
1089
  * @version: SDK: 1.24.0
1036
1090
  */
1037
1091
  useLastSelectedSources?: boolean;
1092
+ /**
1093
+ * To set the initial state of the search bar in case of saved-answers.
1094
+ *
1095
+ * @default false
1096
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1097
+ */
1098
+ collapseSearchBarInitially?: boolean;
1099
+ /**
1100
+ * To enable custom column groups in data panel v2
1101
+ *
1102
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
1103
+ * @default false
1104
+ *
1105
+ * @example
1106
+ * ```js
1107
+ * const embed = new SearchEmbed('#tsEmbed', {
1108
+ * ... // other options
1109
+ * enableCustomColumnGroups: true,
1110
+ * });
1111
+ * ```
1112
+ */
1113
+ enableCustomColumnGroups?: boolean;
1038
1114
  }
1039
1115
  export const HiddenActionItemByDefaultForSearchEmbed: Action[];
1040
1116
  /**
@@ -1911,6 +1987,24 @@ export interface EmbedConfig {
1911
1987
  * @version SDK: 1.27.9
1912
1988
  */
1913
1989
  disableSDKTracking?: boolean;
1990
+ /**
1991
+ * Overrides default/user preffered locale for date formatting
1992
+ *
1993
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
1994
+ */
1995
+ dateFormatLocale?: string;
1996
+ /**
1997
+ * Overrides default/user preffered locale for number formatting
1998
+ *
1999
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2000
+ */
2001
+ numberFormatLocale?: string;
2002
+ /**
2003
+ * Format to be used for currency when currency format is set to infer from browser
2004
+ *
2005
+ * @version SDK: 1.28.4 | Thoughtspot: 10.0.0.cl, 9.5.0.sw
2006
+ */
2007
+ currencyFormat?: string;
1914
2008
  }
1915
2009
  export interface LayoutConfig {
1916
2010
  }
@@ -2228,11 +2322,7 @@ export interface ViewConfig {
2228
2322
  *
2229
2323
  * **Note**: This option does not apply to the classic homepage.
2230
2324
  * To access the updated modular homepage, set
2231
- <<<<<<< HEAD
2232
- * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.0.cl).
2233
- =======
2234
2325
  * `modularHomeExperience` to `true` (available as Early Access feature in 9.12.5.cl).
2235
- >>>>>>> 64e22666... typo fixes
2236
2326
  *
2237
2327
  * @version SDK: 1.28.0 | Thoughtspot: 9.12.5.cl
2238
2328
  * @example
@@ -4375,7 +4465,14 @@ export enum Param {
4375
4465
  HideSearchBar = "hideSearchBar",
4376
4466
  ClientLogLevel = "clientLogLevel",
4377
4467
  OverrideNativeConsole = "overrideConsoleLogs",
4378
- enableAskSage = "enableAskSage"
4468
+ enableAskSage = "enableAskSage",
4469
+ CollapseSearchBarInitially = "collapseSearchBarInitially",
4470
+ EnableCustomColumnGroups = "enableCustomColumnGroups",
4471
+ DateFormatLocale = "dateFormatLocale",
4472
+ NumberFormatLocale = "numberFormatLocale",
4473
+ CurrencyFormat = "currencyFormat",
4474
+ Enable2ColumnLayout = "enable2ColumnLayout",
4475
+ IsFullAppEmbed = "isFullAppEmbed"
4379
4476
  }
4380
4477
  /**
4381
4478
  * ThoughtSpot application pages include actions and menu commands
@@ -4511,6 +4608,18 @@ export enum Action {
4511
4608
  * ```
4512
4609
  */
4513
4610
  AddFilter = "addFilter",
4611
+ /**
4612
+ * The **Add Data Panel Objects** action on the data panel v2.
4613
+ * Allows to show action menu to add different objects (like
4614
+ * formulas, parameters) in data panel v2.
4615
+ *
4616
+ * @example
4617
+ * ```js
4618
+ * disabledActions: [Action.AddDataPanelObjects]
4619
+ * ```
4620
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4621
+ */
4622
+ AddDataPanelObjects = "addDataPanelObjects",
4514
4623
  /**
4515
4624
  * Filter configuration options on a Liveboard and Search page.
4516
4625
  * Allows configuring filter options when adding filters to a
@@ -4553,6 +4662,28 @@ export enum Action {
4553
4662
  * ```
4554
4663
  */
4555
4664
  AddParameter = "addParameter",
4665
+ /**
4666
+ * The **Add Column Set** action on a Answer.
4667
+ * Allows adding column sets to a Answer.
4668
+ *
4669
+ * @example
4670
+ * ```js
4671
+ * disabledActions: [Action.AddColumnSet]
4672
+ * ```
4673
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4674
+ */
4675
+ AddColumnSet = "addSimpleCohort",
4676
+ /**
4677
+ * The **Add Query Set** action on a Answer.
4678
+ * Allows adding query sets to a Answer.
4679
+ *
4680
+ * @example
4681
+ * ```js
4682
+ * disabledActions: [Action.AddQuerySet]
4683
+ * ```
4684
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
4685
+ */
4686
+ AddQuerySet = "addAdvancedCohort",
4556
4687
  /**
4557
4688
  * @hidden
4558
4689
  */
@@ -4984,6 +5115,28 @@ export enum Action {
4984
5115
  * @version SDK: 1.21.0 | ThoughtSpot: 9.2.0.cl
4985
5116
  */
4986
5117
  CrossFilter = "context-menu-item-cross-filter",
5118
+ /**
5119
+ * The **Sync to Slack** action on Liveboard visualizations.
5120
+ * Allows sending data to third-party apps Slack
5121
+ *
5122
+ * @example
5123
+ * ```js
5124
+ * disabledActions: [Action.SyncToSlack]
5125
+ * ```
5126
+ * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5127
+ */
5128
+ SyncToSlack = "syncToSlack",
5129
+ /**
5130
+ * The **Sync to Teams** action on Liveboard visualizations.
5131
+ * Allows sending data to third-party apps Team
5132
+ *
5133
+ * @example
5134
+ * ```js
5135
+ * disabledActions: [Action.SyncToTeams]
5136
+ * ```
5137
+ * @version @version SDK : 1.32.0 | Thoughtspot: 10.1.0.cl
5138
+ */
5139
+ SyncToTeams = "syncToTeams",
4987
5140
  /**
4988
5141
  * The **Remove** action that appears when cross filters are applied
4989
5142
  * on a Liveboard.
@@ -5225,6 +5378,26 @@ export enum Action {
5225
5378
  * @version SDK : 1.26.0 | Thoughtspot: 9.7.0.cl
5226
5379
  */
5227
5380
  LiveboardUsers = "liveboardUsers",
5381
+ /**
5382
+ * Action ID for the Parent TML action
5383
+ * The parent action **TML** must be included to access TML-related options
5384
+ * within the cascading menu (specific to the answer page)
5385
+ *
5386
+ * @example
5387
+ * ```js
5388
+ * // to include specific TML actions
5389
+ * visibleActions: [Action.TML, Action.ExportTML, Action.EditTML]
5390
+ *
5391
+ * ```
5392
+ * @example
5393
+ * ```js
5394
+ * hiddenAction: [Action.TML] // hide all TML actions
5395
+ * disabledActions: [Action.TML] // to disable all TML actions
5396
+ * ```
5397
+ *
5398
+ * @version SDK : 1.28.2 | Thoughtspot: 9.10.5.cl
5399
+ */
5400
+ TML = "tml",
5228
5401
  /**
5229
5402
  * Action ID for to hide Verified Liveboard Banner
5230
5403
  *
@@ -5266,15 +5439,15 @@ export enum Action {
5266
5439
  */
5267
5440
  RemoveFromWatchlist = "removeFromWatchlist",
5268
5441
  /**
5269
- * The **Copy KPI Link** menu action on KPI watchlist.
5442
+ * The **Organise Favourites** action on Homepage Favourite Module.
5270
5443
  *
5271
5444
  * @example
5272
5445
  * ```js
5273
- * disabledActions: [Action.CopyKpiLink]
5446
+ * disabledActions: [Action.OrganiseFavourites]
5274
5447
  * ```
5275
- * @version SDK : 1.27.9 | Thoughtspot: 9.12.5.cl
5448
+ * @version SDK : 1.32.0 | Thoughtspot: 10.0.0.cl
5276
5449
  */
5277
- CopyKpiLink = "copyKpiLink",
5450
+ OrganiseFavourites = "organiseFavourites",
5278
5451
  /**
5279
5452
  * Action ID for AI Highlights button
5280
5453
  *
@@ -5809,7 +5982,7 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
5809
5982
  showObjectResults?: boolean;
5810
5983
  /**
5811
5984
  * flag used by the TS product tour page to show the blue search bar
5812
- * even after the search is completed. This is different from TSE Sage Embed
5985
+ * even after the search is completed. This is different from Thoughtspot Embedded Sage Embed
5813
5986
  * experience where it mimics closer to the non-embed case.
5814
5987
  * The Sample questions container is collapsed when this value is set after
5815
5988
  * does a search.
@@ -5820,8 +5993,9 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
5820
5993
  isProductTour?: boolean;
5821
5994
  /**
5822
5995
  * Show or hide the search bar title.
5996
+ * @version SDK: 1.29.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
5823
5997
  *
5824
- * @version SDK: 1.26.0 | Thoughtspot: 9.8.0.cl, 9.8.0.sw
5998
+ * @deprecated Thoughtspot: 9.10.0.cl | search bar doesn't have the title from 9.10.0.cl
5825
5999
  */
5826
6000
  hideSearchBarTitle?: boolean;
5827
6001
  /**
@@ -5891,7 +6065,6 @@ export interface SageViewConfig extends Omit<ViewConfig, 'hiddenHomepageModules'
5891
6065
  */
5892
6066
  searchOptions?: SearchOptions;
5893
6067
  }
5894
- export const HiddenActionItemByDefaultForSageEmbed: Action[];
5895
6068
  /**
5896
6069
  * Embed ThoughtSpot LLM and GPT-based Natural Language Search component.
5897
6070
  *
package/lib/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thoughtspot/visual-embed-sdk",
3
- "version": "1.28.2",
3
+ "version": "1.28.4",
4
4
  "description": "ThoughtSpot Embed SDK",
5
5
  "module": "lib/src/index.js",
6
6
  "main": "dist/tsembed.js",
@@ -175,6 +175,7 @@
175
175
  "keywords": [
176
176
  "thoughtspot",
177
177
  "everywhere",
178
+ "embedded",
178
179
  "embed",
179
180
  "sdk",
180
181
  "analytics"
@@ -333,6 +333,44 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
333
333
  * @default false
334
334
  */
335
335
  enableAskSage?: boolean;
336
+ /**
337
+ * To set the initial state of the search bar in case of saved-answers.
338
+ *
339
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
340
+ * @default false
341
+ */
342
+ collapseSearchBarInitially?: boolean;
343
+ /**
344
+ * To enable custom column groups in data panel v2
345
+ *
346
+ * @version SDK: 1.32.0 | Thoughtspot: 10.0.0.cl
347
+ * @default false
348
+ *
349
+ * @example
350
+ * ```js
351
+ * const embed = new AppEmbed('#embed', {
352
+ * ... // other app view config
353
+ * enableCustomColumnGroups: true,
354
+ * });
355
+ * ```
356
+ */
357
+ enableCustomColumnGroups?: boolean;
358
+ /**
359
+ * This flag is used to enable the 2 column layout in liveboard
360
+ *
361
+ * @type {boolean}
362
+ * @default false
363
+ * @version SDK: 1.32.0 | ThoughtSpot:10.1.0.cl
364
+ *
365
+ * @example
366
+ * ```js
367
+ * const embed = new LiveboardEmbed('#embed-container', {
368
+ * ... // other options
369
+ * enable2ColumnLayout: true,
370
+ * })
371
+ * ```
372
+ */
373
+ enable2ColumnLayout?: boolean;
336
374
  }
337
375
  /**
338
376
  * Embeds full ThoughtSpot experience in a host application.
@@ -1 +1 @@
1
- {"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EACH,WAAW,EAAyB,cAAc,EAAS,UAAU,EACxE,MAAM,UAAU,CAAC;AAGlB,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;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;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;IAgExB;;;;OAIG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAKzC;IAEF;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;;OAWG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAO3C"}
1
+ {"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/embed/app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EACH,WAAW,EAAyB,cAAc,EAAS,UAAU,EACxE,MAAM,UAAU,CAAC;AAGlB,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;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;;OAcG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;;;GAIG;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;IA0ExB;;;;OAIG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAKzC;IAEF;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;;OAWG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAO3C"}