@thoughtspot/visual-embed-sdk 1.23.0 → 1.24.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/README.md +1 -1
  2. package/cjs/package.json +1 -8
  3. package/cjs/src/embed/sage.d.ts +14 -0
  4. package/cjs/src/embed/sage.d.ts.map +1 -1
  5. package/cjs/src/embed/sage.js +12 -3
  6. package/cjs/src/embed/sage.js.map +1 -1
  7. package/cjs/src/embed/sage.spec.js +1 -1
  8. package/cjs/src/embed/sage.spec.js.map +1 -1
  9. package/cjs/src/embed/search.d.ts +0 -4
  10. package/cjs/src/embed/search.d.ts.map +1 -1
  11. package/cjs/src/embed/search.js +1 -1
  12. package/cjs/src/embed/search.js.map +1 -1
  13. package/cjs/src/react/index.spec.js +0 -12
  14. package/cjs/src/react/index.spec.js.map +1 -1
  15. package/cjs/src/types.d.ts +340 -239
  16. package/cjs/src/types.d.ts.map +1 -1
  17. package/cjs/src/types.js +337 -236
  18. package/cjs/src/types.js.map +1 -1
  19. package/dist/src/embed/sage.d.ts +14 -0
  20. package/dist/src/embed/sage.d.ts.map +1 -1
  21. package/dist/src/embed/search.d.ts +0 -4
  22. package/dist/src/embed/search.d.ts.map +1 -1
  23. package/dist/src/types.d.ts +340 -239
  24. package/dist/src/types.d.ts.map +1 -1
  25. package/dist/tsembed-react.es.js +351 -241
  26. package/dist/tsembed-react.js +350 -240
  27. package/dist/tsembed.es.js +351 -241
  28. package/dist/tsembed.js +350 -240
  29. package/dist/visual-embed-sdk-react-full.d.ts +354 -243
  30. package/dist/visual-embed-sdk-react.d.ts +354 -243
  31. package/dist/visual-embed-sdk.d.ts +354 -243
  32. package/lib/package.json +1 -8
  33. package/lib/src/embed/sage.d.ts +14 -0
  34. package/lib/src/embed/sage.d.ts.map +1 -1
  35. package/lib/src/embed/sage.js +12 -3
  36. package/lib/src/embed/sage.js.map +1 -1
  37. package/lib/src/embed/sage.spec.js +1 -1
  38. package/lib/src/embed/sage.spec.js.map +1 -1
  39. package/lib/src/embed/search.d.ts +0 -4
  40. package/lib/src/embed/search.d.ts.map +1 -1
  41. package/lib/src/embed/search.js +1 -1
  42. package/lib/src/embed/search.js.map +1 -1
  43. package/lib/src/react/index.spec.js +0 -12
  44. package/lib/src/react/index.spec.js.map +1 -1
  45. package/lib/src/types.d.ts +340 -239
  46. package/lib/src/types.d.ts.map +1 -1
  47. package/lib/src/types.js +337 -236
  48. package/lib/src/types.js.map +1 -1
  49. package/lib/src/visual-embed-sdk.d.ts +354 -243
  50. package/package.json +1 -8
  51. package/src/embed/sage.spec.ts +1 -1
  52. package/src/embed/sage.ts +24 -2
  53. package/src/embed/search.ts +0 -5
  54. package/src/react/index.spec.tsx +0 -29
  55. package/src/types.ts +338 -238
@@ -469,10 +469,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search' {
469
469
  * using raw answer data.
470
470
  */
471
471
  hideResults?: boolean;
472
- /**
473
- * If set to true, expands all the data sources panel.
474
- */
475
- expandAllDataSource?: boolean;
476
472
  /**
477
473
  * If set to true, the Search Assist feature is enabled.
478
474
  *
@@ -2047,7 +2043,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2047
2043
  *
2048
2044
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
2049
2045
  */
2050
- FilterChanged = "filterChanged"
2046
+ FilterChanged = "filterChanged",
2047
+ /**
2048
+ * Emitted when a user click on Go button in Sage Embed
2049
+ *
2050
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2051
+ */
2052
+ SageEmbedQuery = "sageEmbedQuery",
2053
+ /**
2054
+ * Emitten when a user select data source in Sage Embed
2055
+ *
2056
+ * @version SDK : 1.27.0 | Thoughtspot: 9.7.0.cl
2057
+ */
2058
+ SageWorksheetUpdated = "sageWorksheetUpdated"
2051
2059
  }
2052
2060
  /**
2053
2061
  * Event types that can be triggered by the host application
@@ -2076,6 +2084,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2076
2084
  * Triggers a search query in AppEmbed and SearchEmbed
2077
2085
  * deployments.
2078
2086
  * Includes the following properties:
2087
+ *
2079
2088
  * @param - dataSourceIds - The data source GUID to Search on
2080
2089
  * - Although an array, only a single source
2081
2090
  * is supported.
@@ -2094,6 +2103,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2094
2103
  /**
2095
2104
  * Triggers a drill on certain points of the specified column
2096
2105
  * Includes the following properties:
2106
+ *
2097
2107
  * @param - points - an object containing selectedPoints/clickedPoints
2098
2108
  * to drill to. For example, { selectedPoints: []}
2099
2109
  * @param - columnGuid - Optional. GUID of the column to drill
@@ -2158,18 +2168,19 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2158
2168
  */
2159
2169
  SetActiveTab = "SetActiveTab",
2160
2170
  /**
2161
- * Updates runtime filters applied on a Saved Answer or Liveboard. The
2162
- * runtime filters passed here are appended to the existing runtime
2163
- * filters.
2164
- * Pass an array of runtime filters with the following attributes:
2165
- * `columnName`
2166
- * _String_. The name of the column to filter on.
2167
- * `operator`
2168
- * Runtime filter operator to apply. For information,
2169
- * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2170
- * `values`
2171
- * List of operands. Some operators such as EQ, LE allow a single value, whereas operators
2172
- * such as BW and IN accept multiple operands.
2171
+ * Updates runtime filters applied on a Saved Answer or Liveboard. The
2172
+ * runtime filters passed here are appended to the existing runtime
2173
+ * filters.
2174
+ * Pass an array of runtime filters with the following attributes:
2175
+ * `columnName`
2176
+ * _String_. The name of the column to filter on.
2177
+ * `operator`
2178
+ * Runtime filter operator to apply. For information,
2179
+ * see [Runtime filter operators](https://developers.thoughtspot.com/docs/?pageid=runtime-filters#rtOperator).
2180
+ * `values`
2181
+ * List of operands. Some operators such as EQ, LE allow a single value, whereas
2182
+ * operators such as BW and IN accept multiple operands.
2183
+ *
2173
2184
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
2174
2185
  * @example
2175
2186
  * ```js
@@ -2185,6 +2196,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2185
2196
  /**
2186
2197
  * Navigate to a specific page in the embedded application without reloading the page.
2187
2198
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
2199
+ *
2188
2200
  * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
2189
2201
  * @example
2190
2202
  * ```js
@@ -2508,6 +2520,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2508
2520
  /**
2509
2521
  * Triggers the **SpotIQ analyze** action on visualization
2510
2522
  * or search.
2523
+ *
2511
2524
  * @param - Liveboard embed takes `vizId` as a
2512
2525
  * key. Can be left undefined when embedding Search or
2513
2526
  * visualization.
@@ -2547,6 +2560,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2547
2560
  /**
2548
2561
  * Triggers the **Download** > **PNG** action on
2549
2562
  * charts in the embedded view.
2563
+ *
2550
2564
  * @example
2551
2565
  * ```js
2552
2566
  * liveboardEmbed.trigger(HostEvent.DownloadAsPng,
@@ -2580,6 +2594,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2580
2594
  /**
2581
2595
  * Triggers the **Download** > **XLSX** action on tables
2582
2596
  * in the embedded view.
2597
+ *
2583
2598
  * @example
2584
2599
  * ```js
2585
2600
  * liveboardEmbed.trigger(HostEvent.DownloadAsXlsx, {vizId:
@@ -2611,6 +2626,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2611
2626
  /**
2612
2627
  * Triggers the **Save** action on a Liveboard or Answer.
2613
2628
  * Saves the changes.
2629
+ *
2614
2630
  * @example
2615
2631
  * ```js
2616
2632
  * liveboardEmbed.trigger(HostEvent.Save)
@@ -2624,6 +2640,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2624
2640
  /**
2625
2641
  * Triggers the **Sync to Sheets** action on an embedded visualization or Answer
2626
2642
  * Sends data from an Answer or Liveboard visualization to a Google sheet.
2643
+ *
2627
2644
  * @param - an object with `vizId` as a key
2628
2645
  * @example
2629
2646
  * ```js
@@ -2640,6 +2657,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2640
2657
  * Triggers the **Sync to Other Apps** action on an embedded visualization or Answer
2641
2658
  * Sends data from an Answer or Liveboard visualization to third-party apps such
2642
2659
  * as Slack, Salesforce, Microsoft Teams, ServiceNow and so on.
2660
+ *
2643
2661
  * @param - an object with vizId as a key
2644
2662
  * @example
2645
2663
  * ```js
@@ -2656,6 +2674,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2656
2674
  * Triggers the **Manage pipelines** action on an embedded
2657
2675
  * visualization or Answer.
2658
2676
  * Allows users to manage ThoughtSpot Sync pipelines.
2677
+ *
2659
2678
  * @param - an object with `vizId` as a key
2660
2679
  * @example
2661
2680
  * ```js
@@ -2808,7 +2827,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2808
2827
  ShowLiveboardTitle = "showLiveboardTitle",
2809
2828
  HiddenTabs = "hideTabs",
2810
2829
  VisibleTabs = "visibleTabs",
2811
- HideTabPanel = "hideTabPanel"
2830
+ HideTabPanel = "hideTabPanel",
2831
+ HideSampleQuestions = "hideSampleQuestions",
2832
+ WorksheetId = "worksheetId",
2833
+ Query = "query,"
2812
2834
  }
2813
2835
  /**
2814
2836
  * ThoughtSpot application pages include actions and menu commands
@@ -2817,6 +2839,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2817
2839
  * specific actions in the embedded view, define the Action
2818
2840
  * enumeration members in the `disabledActions`, `visibleActions`,
2819
2841
  * or `hiddenActions` array.
2842
+ *
2820
2843
  * @example
2821
2844
  * ```js
2822
2845
  * const embed = new LiveboardEmbed('#embed-container', {
@@ -2835,12 +2858,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2835
2858
  * hiddenActions: [Action.Edit, ActionAction.Explore],
2836
2859
  * })
2837
2860
  * ```
2838
-
2839
2861
  */
2840
2862
  export enum Action {
2841
2863
  /**
2842
2864
  * The **Save** action on an Answer or Liveboard.
2843
2865
  * Allows users to save the changes.
2866
+ *
2844
2867
  * @example
2845
2868
  * ```js
2846
2869
  * disabledActions: [Action.SaveAsView]
@@ -2856,136 +2879,146 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
2856
2879
  */
2857
2880
  SaveUntitled = "saveUntitled",
2858
2881
  /**
2859
- * The **Save as View** action on the Answer
2860
- * page. Saves an Answer as a View object.
2861
- *
2862
- * @example
2863
- * ```js
2864
- * disabledActions: [Action.SaveAsView]
2865
- * ```
2866
- */
2882
+ * The **Save as View** action on the Answer
2883
+ * page. Saves an Answer as a View object.
2884
+ *
2885
+ * @example
2886
+ * ```js
2887
+ * disabledActions: [Action.SaveAsView]
2888
+ * ```
2889
+ */
2867
2890
  SaveAsView = "saveAsView",
2868
2891
  /**
2869
- * The **Make a copy** action on a Liveboard or Answer
2870
- * page.
2871
- * Creates a copy of the Liveboard, visualization,
2872
- * or Answer.
2873
- *
2874
- * @example
2875
- * ```js
2876
- * disabledActions: [Action.MakeACopy]
2877
- * ```
2878
- */
2892
+ * The **Make a copy** action on a Liveboard or Answer
2893
+ * page.
2894
+ * Creates a copy of the Liveboard, visualization,
2895
+ * or Answer.
2896
+ *
2897
+ * @example
2898
+ * ```js
2899
+ * disabledActions: [Action.MakeACopy]
2900
+ * ```
2901
+ */
2879
2902
  MakeACopy = "makeACopy",
2880
2903
  /**
2881
- * The **Copy and Edit** action on a Liveboard.
2882
- * This action is now replaced with `Action.MakeACopy`.
2883
- *
2884
- * @example
2885
- * ```js
2886
- * disabledActions: [Action.EditACopy]
2887
- * ```
2888
- */
2904
+ * The **Copy and Edit** action on a Liveboard.
2905
+ * This action is now replaced with `Action.MakeACopy`.
2906
+ *
2907
+ * @example
2908
+ * ```js
2909
+ * disabledActions: [Action.EditACopy]
2910
+ * ```
2911
+ */
2889
2912
  EditACopy = "editACopy",
2890
2913
  /**
2891
- * The **Copy link** menu action on a Liveboard visualization.
2892
- * Copies the visualization URL
2893
- * @example
2894
- * ```js
2895
- * disabledActions: [Action.CopyLink]
2896
- * ```
2897
- */
2914
+ * The **Copy link** menu action on a Liveboard visualization.
2915
+ * Copies the visualization URL
2916
+ *
2917
+ * @example
2918
+ * ```js
2919
+ * disabledActions: [Action.CopyLink]
2920
+ * ```
2921
+ */
2898
2922
  CopyLink = "embedDocument",
2899
2923
  /**
2900
2924
  * @hidden
2901
2925
  */
2902
2926
  ResetLayout = "resetLayout",
2903
2927
  /**
2904
- * The **Schedule** menu action on a Liveboard.
2905
- * Allows scheduling a Liveboard notification.
2906
- * @example
2907
- * ```js
2908
- * disabledActions: [Action.Schedule]
2909
- * ```
2910
- */
2928
+ * The **Schedule** menu action on a Liveboard.
2929
+ * Allows scheduling a Liveboard notification.
2930
+ *
2931
+ * @example
2932
+ * ```js
2933
+ * disabledActions: [Action.Schedule]
2934
+ * ```
2935
+ */
2911
2936
  Schedule = "subscription",
2912
2937
  /**
2913
- * The **Manage schedules** menu action on a Liveboard.
2914
- * Allows users to manage scheduled Liveboard jobs.
2915
- * @example
2916
- * ```js
2917
- * disabledActions: [Action.SchedulesList]
2918
- * ```
2919
- */
2938
+ * The **Manage schedules** menu action on a Liveboard.
2939
+ * Allows users to manage scheduled Liveboard jobs.
2940
+ *
2941
+ * @example
2942
+ * ```js
2943
+ * disabledActions: [Action.SchedulesList]
2944
+ * ```
2945
+ */
2920
2946
  SchedulesList = "schedule-list",
2921
2947
  /**
2922
- * The **Share** action on a Liveboard, Answer, or Worksheet.
2923
- * Allows users to share an object with other users and groups.
2924
- * @example
2925
- * ```js
2926
- * disabledActions: [Action.Share]
2927
- * ```
2928
- */
2948
+ * The **Share** action on a Liveboard, Answer, or Worksheet.
2949
+ * Allows users to share an object with other users and groups.
2950
+ *
2951
+ * @example
2952
+ * ```js
2953
+ * disabledActions: [Action.Share]
2954
+ * ```
2955
+ */
2929
2956
  Share = "share",
2930
2957
  /**
2931
- * The **Add filter** action on a Liveboard and Search page.
2932
- * Allows adding filters to Answers and visualizations on a Liveboard.
2933
- * @example
2934
- * ```js
2935
- * disabledActions: [Action.AddFilter]
2936
- * ```
2937
- */
2958
+ * The **Add filter** action on a Liveboard and Search page.
2959
+ * Allows adding filters to Answers and visualizations on a Liveboard.
2960
+ *
2961
+ * @example
2962
+ * ```js
2963
+ * disabledActions: [Action.AddFilter]
2964
+ * ```
2965
+ */
2938
2966
  AddFilter = "addFilter",
2939
2967
  /**
2940
- * Filter configuration options on a Liveboard and Search page.
2941
- * Allows configuring filter options when adding filters to a
2942
- * Liveboard or Answer.
2943
- * @example
2944
- * ```js
2945
- * disabledActions: [Action.ConfigureFilter]
2946
- * ```
2947
- */
2968
+ * Filter configuration options on a Liveboard and Search page.
2969
+ * Allows configuring filter options when adding filters to a
2970
+ * Liveboard or Answer.
2971
+ *
2972
+ * @example
2973
+ * ```js
2974
+ * disabledActions: [Action.ConfigureFilter]
2975
+ * ```
2976
+ */
2948
2977
  ConfigureFilter = "configureFilter",
2949
2978
  CollapseDataSources = "collapseDataSources",
2950
2979
  /**
2951
- * The **Choose sources** button on Search page.
2952
- * Allows selecting data sources for search queries.
2953
- * @example
2954
- * ```js
2955
- * disabledActions: [Action.ChooseDataSources]
2956
- * ```
2957
- */
2980
+ * The **Choose sources** button on Search page.
2981
+ * Allows selecting data sources for search queries.
2982
+ *
2983
+ * @example
2984
+ * ```js
2985
+ * disabledActions: [Action.ChooseDataSources]
2986
+ * ```
2987
+ */
2958
2988
  ChooseDataSources = "chooseDataSources",
2959
2989
  /**
2960
- * The **Create formula** action on a Search or Answer page.
2961
- * Allows adding formulas to an Answer.
2962
- * @example
2963
- * ```js
2964
- * disabledActions: [Action.AddFormula]
2965
- * ```
2966
- */
2990
+ * The **Create formula** action on a Search or Answer page.
2991
+ * Allows adding formulas to an Answer.
2992
+ *
2993
+ * @example
2994
+ * ```js
2995
+ * disabledActions: [Action.AddFormula]
2996
+ * ```
2997
+ */
2967
2998
  AddFormula = "addFormula",
2968
2999
  /**
2969
- * The **Add parameter** action on a Liveboard or Answer.
2970
- * Allows adding Parameters to a Liveboard or Answer.
2971
- * @example
2972
- * ```js
2973
- * disabledActions: [Action.AddParameter]
2974
- * ```
2975
- */
3000
+ * The **Add parameter** action on a Liveboard or Answer.
3001
+ * Allows adding Parameters to a Liveboard or Answer.
3002
+ *
3003
+ * @example
3004
+ * ```js
3005
+ * disabledActions: [Action.AddParameter]
3006
+ * ```
3007
+ */
2976
3008
  AddParameter = "addParameter",
2977
3009
  /**
2978
3010
  * @hidden
2979
3011
  */
2980
3012
  SearchOnTop = "searchOnTop",
2981
3013
  /**
2982
- * The **SpotIQ analyze** menu action on a visualization or
2983
- * Answer page.
2984
- * @example
2985
- * ```js
2986
- * disabledActions: [Action.SpotIQAnalyze]
2987
- * ```
2988
- */
3014
+ * The **SpotIQ analyze** menu action on a visualization or
3015
+ * Answer page.
3016
+ *
3017
+ * @example
3018
+ * ```js
3019
+ * disabledActions: [Action.SpotIQAnalyze]
3020
+ * ```
3021
+ */
2989
3022
  SpotIQAnalyze = "spotIQAnalyze",
2990
3023
  /**
2991
3024
  * @hidden
@@ -3001,89 +3034,98 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3001
3034
  */
3002
3035
  ReplaySearch = "replaySearch",
3003
3036
  /**
3004
- * The **Show underlying data** menu action on a visualization or
3005
- * Answer page.
3006
- * @example
3007
- * ```js
3008
- * disabledActions: [Action.ShowUnderlyingData]
3009
- * ```
3010
- */
3037
+ * The **Show underlying data** menu action on a visualization or
3038
+ * Answer page.
3039
+ *
3040
+ * @example
3041
+ * ```js
3042
+ * disabledActions: [Action.ShowUnderlyingData]
3043
+ * ```
3044
+ */
3011
3045
  ShowUnderlyingData = "showUnderlyingData",
3012
3046
  /**
3013
- * The **Download** menu action on Liveboard visualizations
3014
- * and Answers.
3015
- * Allows downloading a visualization or Answer.
3016
- * @example
3017
- * ```js
3018
- * disabledActions: [Action.DownloadAsPng]
3019
- * ```
3020
- */
3047
+ * The **Download** menu action on Liveboard visualizations
3048
+ * and Answers.
3049
+ * Allows downloading a visualization or Answer.
3050
+ *
3051
+ * @example
3052
+ * ```js
3053
+ * disabledActions: [Action.DownloadAsPng]
3054
+ * ```
3055
+ */
3021
3056
  Download = "download",
3022
3057
  /**
3023
- * The **Download** > **PNG** menu action for charts on a Liveboard
3024
- * or Answer page.
3025
- * Downloads a visualization or Answer as a PNG file.
3026
- * @example
3027
- * ```js
3028
- * disabledActions: [Action.DownloadAsPng]
3029
- * ```
3030
- */
3058
+ * The **Download** > **PNG** menu action for charts on a Liveboard
3059
+ * or Answer page.
3060
+ * Downloads a visualization or Answer as a PNG file.
3061
+ *
3062
+ * @example
3063
+ * ```js
3064
+ * disabledActions: [Action.DownloadAsPng]
3065
+ * ```
3066
+ */
3031
3067
  DownloadAsPng = "downloadAsPng",
3032
3068
  /**
3033
- * The **Download** > **PDF** menu action on a Liveboard.
3034
- * Downloads a visualization or Answer as a PDF file.
3035
- * @example
3036
- * ```js
3037
- * disabledActions: [Action.DownloadAsPdf]
3038
- * ```
3039
- */
3069
+ * The **Download** > **PDF** menu action on a Liveboard.
3070
+ * Downloads a visualization or Answer as a PDF file.
3071
+ *
3072
+ * @example
3073
+ * ```js
3074
+ * disabledActions: [Action.DownloadAsPdf]
3075
+ * ```
3076
+ */
3040
3077
  DownloadAsPdf = "downloadAsPdf",
3041
3078
  /**
3042
- * The **Download** > **CSV** menu action for tables on a Liveboard
3043
- * or Answer page.
3044
- * Downloads a visualization or Answer in the XLSX format.
3045
- * @example
3046
- * ```js
3047
- * disabledActions: [Action.DownloadAsCsv]
3048
- * ```
3049
- */
3079
+ * The **Download** > **CSV** menu action for tables on a Liveboard
3080
+ * or Answer page.
3081
+ * Downloads a visualization or Answer in the XLSX format.
3082
+ *
3083
+ * @example
3084
+ * ```js
3085
+ * disabledActions: [Action.DownloadAsCsv]
3086
+ * ```
3087
+ */
3050
3088
  DownloadAsCsv = "downloadAsCSV",
3051
3089
  /**
3052
- * The **Download** > **XLSX** menu action for tables on a Liveboard
3053
- * or Answer page.
3054
- * Downloads a visualization or Answer in the XLSX format.
3055
- * @example
3056
- * ```js
3057
- * disabledActions: [Action.DownloadAsXlsx]
3058
- * ```
3059
- */
3090
+ * The **Download** > **XLSX** menu action for tables on a Liveboard
3091
+ * or Answer page.
3092
+ * Downloads a visualization or Answer in the XLSX format.
3093
+ *
3094
+ * @example
3095
+ * ```js
3096
+ * disabledActions: [Action.DownloadAsXlsx]
3097
+ * ```
3098
+ */
3060
3099
  DownloadAsXlsx = "downloadAsXLSX",
3061
3100
  /**
3062
3101
  * @hidden
3063
3102
  */
3064
3103
  DownloadTrace = "downloadTrace",
3065
3104
  /**
3066
- * The **Export TML** menu action on Liveboard, Answers
3067
- * Worksheets and Data Connections page.
3068
- * Exports an object as a TML file.
3069
- * @example
3070
- * ```js
3071
- * disabledActions: [Action.ExportTML]
3072
- * ```
3073
- */
3105
+ * The **Export TML** menu action on Liveboard, Answers
3106
+ * Worksheets and Data Connections page.
3107
+ * Exports an object as a TML file.
3108
+ *
3109
+ * @example
3110
+ * ```js
3111
+ * disabledActions: [Action.ExportTML]
3112
+ * ```
3113
+ */
3074
3114
  ExportTML = "exportTSL",
3075
3115
  /**
3076
- * The **Import TML** menu action for Liveboards and Answers.
3077
- * Imports TML representation of ThoughtSpot objects.
3078
- * @example
3079
- * ```js
3080
- * disabledActions: [Action.ImportTML]
3081
- * ```
3082
- */
3116
+ * The **Import TML** menu action for Liveboards and Answers.
3117
+ * Imports TML representation of ThoughtSpot objects.
3118
+ *
3119
+ * @example
3120
+ * ```js
3121
+ * disabledActions: [Action.ImportTML]
3122
+ * ```
3123
+ */
3083
3124
  ImportTML = "importTSL",
3084
3125
  /**
3085
3126
  * The **Update TML** menu action for Liveboards and Answers.
3086
3127
  * Update TML representation of ThoughtSpot objects.
3128
+ *
3087
3129
  * @example
3088
3130
  * ```js
3089
3131
  * disabledActions: [Action.UpdateTML]
@@ -3093,6 +3135,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3093
3135
  /**
3094
3136
  * The **Edit TML** menu action for Liveboards and Answers.
3095
3137
  * Opens the TML editor.
3138
+ *
3096
3139
  * @example
3097
3140
  * ```js
3098
3141
  * disabledActions: [Action.EditTML]
@@ -3100,50 +3143,55 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3100
3143
  */
3101
3144
  EditTML = "editTSL",
3102
3145
  /**
3103
- * The **Present** menu action for Liveboards and Answers.
3104
- * Allows presenting a Liveboard or visualization in
3105
- * slideshow mode.
3106
- * @example
3107
- * ```js
3108
- * disabledActions: [Action.Present]
3109
- * ```
3110
- */
3146
+ * The **Present** menu action for Liveboards and Answers.
3147
+ * Allows presenting a Liveboard or visualization in
3148
+ * slideshow mode.
3149
+ *
3150
+ * @example
3151
+ * ```js
3152
+ * disabledActions: [Action.Present]
3153
+ * ```
3154
+ */
3111
3155
  Present = "present",
3112
3156
  /**
3113
- * The tile resize options in the visualization menu.
3114
- * Allows switching between different preset layouts.
3115
- * @example
3116
- * ```js
3117
- * disabledActions: [Action.ToggleSize]
3118
- * ```
3119
- */
3157
+ * The tile resize options in the visualization menu.
3158
+ * Allows switching between different preset layouts.
3159
+ *
3160
+ * @example
3161
+ * ```js
3162
+ * disabledActions: [Action.ToggleSize]
3163
+ * ```
3164
+ */
3120
3165
  ToggleSize = "toggleSize",
3121
3166
  /**
3122
- * The *Edit* action on the Liveboard page and in the
3123
- * visualization menu.
3124
- * Opens a Liveboard or visualization in edit mode.
3125
- * @example
3126
- * ```js
3127
- * disabledActions: [Action.Edit]
3128
- * ```
3129
- */
3167
+ * The *Edit* action on the Liveboard page and in the
3168
+ * visualization menu.
3169
+ * Opens a Liveboard or visualization in edit mode.
3170
+ *
3171
+ * @example
3172
+ * ```js
3173
+ * disabledActions: [Action.Edit]
3174
+ * ```
3175
+ */
3130
3176
  Edit = "edit",
3131
3177
  /**
3132
- * The text edit option for Liveboard and visualization titles.
3133
- * @example
3134
- * ```js
3135
- * disabledActions: [Action.EditTitle]
3136
- * ```
3137
- */
3178
+ * The text edit option for Liveboard and visualization titles.
3179
+ *
3180
+ * @example
3181
+ * ```js
3182
+ * disabledActions: [Action.EditTitle]
3183
+ * ```
3184
+ */
3138
3185
  EditTitle = "editTitle",
3139
3186
  /**
3140
- * The **Delete** menu action on Liveboards and visualizations.
3141
- * Deletes a Liveboard or a visualization from a Liveboard.
3142
- * @example
3143
- * ```js
3144
- * disabledActions: [Action.Remove]
3145
- * ```
3146
- */
3187
+ * The **Delete** menu action on Liveboards and visualizations.
3188
+ * Deletes a Liveboard or a visualization from a Liveboard.
3189
+ *
3190
+ * @example
3191
+ * ```js
3192
+ * disabledActions: [Action.Remove]
3193
+ * ```
3194
+ */
3147
3195
  Remove = "delete",
3148
3196
  /**
3149
3197
  * @hidden
@@ -3166,15 +3214,16 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3166
3214
  */
3167
3215
  PinboardInfo = "pinboardInfo",
3168
3216
  /**
3169
- * The **Show Liveboard details** menu action on a Liveboard.
3170
- * Displays details such as the name, description, and
3171
- * author of the Liveboard, and timestamp of Liveboard creation
3172
- * and update.
3173
- * @example
3174
- * ```js
3175
- * disabledActions: [Action.LiveboardInfo]
3176
- * ```
3177
- */
3217
+ * The **Show Liveboard details** menu action on a Liveboard.
3218
+ * Displays details such as the name, description, and
3219
+ * author of the Liveboard, and timestamp of Liveboard creation
3220
+ * and update.
3221
+ *
3222
+ * @example
3223
+ * ```js
3224
+ * disabledActions: [Action.LiveboardInfo]
3225
+ * ```
3226
+ */
3178
3227
  LiveboardInfo = "pinboardInfo",
3179
3228
  /**
3180
3229
  * @hidden
@@ -3185,13 +3234,14 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3185
3234
  */
3186
3235
  DownloadEmbraceQueries = "downloadEmbraceQueries",
3187
3236
  /**
3188
- * The **Pin** menu action on an Answer or
3189
- * Search results page.
3190
- * @example
3191
- * ```js
3192
- * disabledActions: [Action.Pin]
3193
- * ```
3194
- */
3237
+ * The **Pin** menu action on an Answer or
3238
+ * Search results page.
3239
+ *
3240
+ * @example
3241
+ * ```js
3242
+ * disabledActions: [Action.Pin]
3243
+ * ```
3244
+ */
3195
3245
  Pin = "pin",
3196
3246
  /**
3197
3247
  * @hidden
@@ -3199,6 +3249,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3199
3249
  AnalysisInfo = "analysisInfo",
3200
3250
  /**
3201
3251
  * The **Schedule** menu action on a Liveboard.
3252
+ *
3202
3253
  * @example
3203
3254
  * ```js
3204
3255
  * disabledActions: [Action.Subscription]
@@ -3206,25 +3257,28 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3206
3257
  */
3207
3258
  Subscription = "subscription",
3208
3259
  /**
3209
- * The **Explore** action on Liveboard visualizations
3210
- * @example
3211
- * ```js
3212
- * disabledActions: [Action.Explore]
3213
- * ```
3214
- */
3260
+ * The **Explore** action on Liveboard visualizations
3261
+ *
3262
+ * @example
3263
+ * ```js
3264
+ * disabledActions: [Action.Explore]
3265
+ * ```
3266
+ */
3215
3267
  Explore = "explore",
3216
3268
  /**
3217
- * The action to include data points on a drilled-down Answer
3218
- * or visualization
3219
- * @example
3220
- * ```js
3221
- * disabledActions: [Action.DrillInclude]
3222
- * ```
3223
- */
3269
+ * The action to include data points on a drilled-down Answer
3270
+ * or visualization
3271
+ *
3272
+ * @example
3273
+ * ```js
3274
+ * disabledActions: [Action.DrillInclude]
3275
+ * ```
3276
+ */
3224
3277
  DrillInclude = "context-menu-item-include",
3225
3278
  /**
3226
3279
  * The action to exclude data points on a drilled-down Answer
3227
3280
  * or visualization
3281
+ *
3228
3282
  * @example
3229
3283
  * ```js
3230
3284
  * disabledActions: [Action.DrillInclude]
@@ -3235,6 +3289,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3235
3289
  * The **Copy to clipboard** menu action on tables in an Answer
3236
3290
  * or Liveboard.
3237
3291
  * Copies the selected data point.
3292
+ *
3238
3293
  * @example
3239
3294
  * ```js
3240
3295
  * disabledActions: [Action.CopyToClipboard]
@@ -3252,6 +3307,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3252
3307
  * The **Drill down** menu action on Answers and Liveboard
3253
3308
  * visualizations.
3254
3309
  * Allows drilling down to a specific data point on a chart or table.
3310
+ *
3255
3311
  * @example
3256
3312
  * ```js
3257
3313
  * disabledActions: [Action.DrillDown]
@@ -3261,6 +3317,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3261
3317
  /**
3262
3318
  * The request access action on Liveboards.
3263
3319
  * Allows users with view permissions to request edit access to a Liveboard.
3320
+ *
3264
3321
  * @example
3265
3322
  * ```js
3266
3323
  * disabledActions: [Action.RequestAccess]
@@ -3270,6 +3327,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3270
3327
  /**
3271
3328
  * The **Query visualizer** and **Query SQL** buttons in Query details panel
3272
3329
  * of the Answer page
3330
+ *
3273
3331
  * @example
3274
3332
  * ```js
3275
3333
  * disabledActions: [Action.QueryDetailsButtons]
@@ -3278,6 +3336,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3278
3336
  QueryDetailsButtons = "QueryDetailsButtons",
3279
3337
  /**
3280
3338
  * The **Delete** action for Answers.
3339
+ *
3281
3340
  * @example
3282
3341
  * ```js
3283
3342
  * disabledActions: [Action.AnswerDelete]
@@ -3287,6 +3346,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3287
3346
  AnswerDelete = "onDeleteAnswer",
3288
3347
  /**
3289
3348
  * The Chart switcher icon on Answer and visualization pages.
3349
+ *
3290
3350
  * @example
3291
3351
  * ```js
3292
3352
  * disabledActions: [Action.AnswerChartSwitcher]
@@ -3296,6 +3356,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3296
3356
  AnswerChartSwitcher = "answerChartSwitcher",
3297
3357
  /**
3298
3358
  * Favorites icon (*) on Answers, Liveboard, and Data pages
3359
+ *
3299
3360
  * @example
3300
3361
  * ```js
3301
3362
  * disabledActions: [Action.AddToFavorites]
@@ -3305,6 +3366,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3305
3366
  AddToFavorites = "addToFavorites",
3306
3367
  /**
3307
3368
  * The edit icon on Liveboards (Classic experience).
3369
+ *
3308
3370
  * @example
3309
3371
  * ```js
3310
3372
  * disabledActions: [Action.EditDetails]
@@ -3314,6 +3376,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3314
3376
  EditDetails = "editDetails",
3315
3377
  /**
3316
3378
  * The Create alert action on KPI charts.
3379
+ *
3317
3380
  * @example
3318
3381
  * ```js
3319
3382
  * disabledActions: [Action.CreateMonitor ]
@@ -3332,6 +3395,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3332
3395
  /**
3333
3396
  * The **Sync to sheets** action on Answers and Liveboard visualizations.
3334
3397
  * Allows sending data to a Google Sheet.
3398
+ *
3335
3399
  * @example
3336
3400
  * ```js
3337
3401
  * disabledActions: [Action.SyncToSheets]
@@ -3343,6 +3407,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3343
3407
  * The **Sync to other apps** action on Answers and Liveboard visualizations.
3344
3408
  * Allows sending data to third-party apps like Slack, Salesforce,
3345
3409
  * Microsoft Teams, and so on.
3410
+ *
3346
3411
  * @example
3347
3412
  * ```js
3348
3413
  * disabledActions: [Action.SyncToOtherApps]
@@ -3353,6 +3418,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3353
3418
  /**
3354
3419
  * The **Manage pipelines** action on Answers and Liveboard visualizations.
3355
3420
  * Allows users to manage data sync pipelines to third-party apps.
3421
+ *
3356
3422
  * @example
3357
3423
  * ```js
3358
3424
  * disabledActions: [Action.SyncToOtherApps]
@@ -3363,6 +3429,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3363
3429
  /**
3364
3430
  * The **Filter** action on Liveboard visualizations.
3365
3431
  * Allows users to apply cross-filters on a Liveboard.
3432
+ *
3366
3433
  * @example
3367
3434
  * ```js
3368
3435
  * disabledActions: [Action.CrossFilter]
@@ -3374,6 +3441,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3374
3441
  * The **Remove** action that appears when cross filters are applied
3375
3442
  * on a Liveboard.
3376
3443
  * Removes filters applied o a visualization.
3444
+ *
3377
3445
  * @example
3378
3446
  * ```js
3379
3447
  * disabledActions: [Action.RemoveCrossFilter]
@@ -3385,6 +3453,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3385
3453
  * The **Aggregate** option in the chart axis or the
3386
3454
  * table column customization menu.
3387
3455
  * Provides aggregation options to analyze the data on a chart or table.
3456
+ *
3388
3457
  * @example
3389
3458
  * ```js
3390
3459
  * disabledActions: [Action.AxisMenuAggregate]
@@ -3396,6 +3465,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3396
3465
  * The **Time bucket** option in the chart axis or table column
3397
3466
  * customization menu.
3398
3467
  * Allows defining time metric for date comparison.
3468
+ *
3399
3469
  * @example
3400
3470
  * ```js
3401
3471
  * disabledActions: [Action.AxisMenuTimeBucket]
@@ -3406,6 +3476,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3406
3476
  /**
3407
3477
  * The **Filter** action in the chart axis or table column
3408
3478
  * customization menu.
3479
+ *
3409
3480
  * @example
3410
3481
  * ```js
3411
3482
  * disabledActions: [Action.AxisMenuFilter]
@@ -3417,6 +3488,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3417
3488
  * The **Conditional formatting** action on chart or table.
3418
3489
  * Allows adding rules for conditional formatting of data
3419
3490
  * points on a chart or table.
3491
+ *
3420
3492
  * @example
3421
3493
  * ```js
3422
3494
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3428,6 +3500,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3428
3500
  * The **Sort** menu action on a table or chart axis
3429
3501
  * Sorts data in ascending or descending order.
3430
3502
  * Allows adding, editing, or removing filters.
3503
+ *
3431
3504
  * @example
3432
3505
  * ```js
3433
3506
  * disabledActions: [Action.AxisMenuConditionalFormat]
@@ -3440,6 +3513,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3440
3513
  * customization menu.
3441
3514
  * Allows grouping data points if the axes use the same
3442
3515
  * unit of measurement and a similar scale.
3516
+ *
3443
3517
  * @example
3444
3518
  * ```js
3445
3519
  * disabledActions: [Action.AxisMenuGroup]
@@ -3451,6 +3525,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3451
3525
  * The **Position** option in the axis customization menu.
3452
3526
  * Allows changing the position of the axis to the
3453
3527
  * left or right side of the chart.
3528
+ *
3454
3529
  * @example
3455
3530
  * ```js
3456
3531
  * disabledActions: [Action.AxisMenuPosition]
@@ -3461,6 +3536,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3461
3536
  /**
3462
3537
  * The **Rename** option in the chart axis or table column customization menu.
3463
3538
  * Renames the axis label on a chart or the column header on a table.
3539
+ *
3464
3540
  * @example
3465
3541
  * ```js
3466
3542
  * disabledActions: [Action.AxisMenuRename]
@@ -3472,6 +3548,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3472
3548
  * The **Edit** action in the axis customization menu.
3473
3549
  * Allows editing the axis name, position, minimum and maximum values,
3474
3550
  * and format of a column.
3551
+ *
3475
3552
  * @example
3476
3553
  * ```js
3477
3554
  * disabledActions: [Action.AxisMenuEdit]
@@ -3482,6 +3559,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3482
3559
  /**
3483
3560
  * The **Number format** action to customize the format of
3484
3561
  * the data labels on a chart or table.
3562
+ *
3485
3563
  * @example
3486
3564
  * ```js
3487
3565
  * disabledActions: [Action.AxisMenuNumberFormat]
@@ -3492,6 +3570,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3492
3570
  /**
3493
3571
  * The **Text wrapping** action on a table.
3494
3572
  * Wraps or clips column text on a table.
3573
+ *
3495
3574
  * @example
3496
3575
  * ```js
3497
3576
  * disabledActions: [Action.AxisMenuTextWrapping]
@@ -3504,6 +3583,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3504
3583
  * customization menu.
3505
3584
  * Removes the data labels from a chart or the column of a
3506
3585
  * table visualization.
3586
+ *
3507
3587
  * @example
3508
3588
  * ```js
3509
3589
  * disabledActions: [Action.AxisMenuRemove]
@@ -3518,6 +3598,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3518
3598
  /**
3519
3599
  * The **Rename** menu action on Liveboards and visualizations.
3520
3600
  * Allows renaming a Liveboard or visualization.
3601
+ *
3521
3602
  * @example
3522
3603
  * ```js
3523
3604
  * disabledActions: [Action.RenameModalTitleDescription]
@@ -3540,7 +3621,23 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
3540
3621
  /**
3541
3622
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl
3542
3623
  */
3543
- EnableContextualChangeAnalysis = "enableContextualChangeAnalysis"
3624
+ EnableContextualChangeAnalysis = "enableContextualChangeAnalysis",
3625
+ /**
3626
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3627
+ */
3628
+ ShowSageQuery = "showSageQuery",
3629
+ /**
3630
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3631
+ */
3632
+ EditSageAnswer = "editSageAnswer",
3633
+ /**
3634
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3635
+ */
3636
+ SageAnswerFeedback = "sageAnswerFeedback",
3637
+ /**
3638
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
3639
+ */
3640
+ ModifySageAnswer = "modifySageAnswer"
3544
3641
  }
3545
3642
  export interface SessionInterface {
3546
3643
  sessionId: string;
@@ -3892,6 +3989,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
3892
3989
  * The configuration attributes for the embedded Natural language search view. Based on
3893
3990
  * GPT and LLM.
3894
3991
  *
3992
+ * @version: SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl, 9.5.1-sw
3895
3993
  * @group Embed components
3896
3994
  */
3897
3995
  export interface SageViewConfig extends ViewConfig {
@@ -3912,6 +4010,19 @@ declare module '@thoughtspot/visual-embed-sdk/embed/sage' {
3912
4010
  *
3913
4011
  */
3914
4012
  showObjectSuggestions?: boolean;
4013
+ /**
4014
+ * The query string to pre-fill in natual language search bar
4015
+ */
4016
+ searchQuery?: string;
4017
+ /**
4018
+ * If set to true, sample questions would be hidden to user.
4019
+ * These sample questions are autogenerated based on selected datasource.
4020
+ */
4021
+ hideSampleQuestions?: boolean;
4022
+ /**
4023
+ * The data source GUID to set on load.
4024
+ */
4025
+ dataSource?: string;
3915
4026
  }
3916
4027
  export const HiddenActionItemByDefaultForSageEmbed: Action[];
3917
4028
  /**