@thoughtspot/visual-embed-sdk 1.36.8 → 1.36.9-primaryAction

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 (130) hide show
  1. package/cjs/package.json +15 -12
  2. package/cjs/src/embed/bodyless-conversation.d.ts +16 -0
  3. package/cjs/src/embed/bodyless-conversation.d.ts.map +1 -1
  4. package/cjs/src/embed/bodyless-conversation.js +1 -1
  5. package/cjs/src/embed/bodyless-conversation.js.map +1 -1
  6. package/cjs/src/embed/search-bar.d.ts +1 -1
  7. package/cjs/src/embed/search.d.ts +1 -1
  8. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  9. package/cjs/src/embed/ts-embed.js +14 -2
  10. package/cjs/src/embed/ts-embed.js.map +1 -1
  11. package/cjs/src/embed/ts-embed.spec.js +111 -0
  12. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  13. package/cjs/src/index.d.ts +2 -2
  14. package/cjs/src/index.d.ts.map +1 -1
  15. package/cjs/src/index.js +2 -1
  16. package/cjs/src/index.js.map +1 -1
  17. package/cjs/src/pages/embed-test.page.d.ts +8 -0
  18. package/cjs/src/pages/embed-test.page.d.ts.map +1 -0
  19. package/cjs/src/pages/embed-test.page.js +20 -0
  20. package/cjs/src/pages/embed-test.page.js.map +1 -0
  21. package/cjs/src/pages/home.page.d.ts +6 -0
  22. package/cjs/src/pages/home.page.d.ts.map +1 -0
  23. package/cjs/src/pages/home.page.js +12 -0
  24. package/cjs/src/pages/home.page.js.map +1 -0
  25. package/cjs/src/pages/login.page.d.ts +15 -0
  26. package/cjs/src/pages/login.page.d.ts.map +1 -0
  27. package/cjs/src/pages/login.page.js +22 -0
  28. package/cjs/src/pages/login.page.js.map +1 -0
  29. package/cjs/src/react/index.d.ts +1 -1
  30. package/cjs/src/react/index.d.ts.map +1 -1
  31. package/cjs/src/react/index.js +2 -1
  32. package/cjs/src/react/index.js.map +1 -1
  33. package/cjs/src/tests/auth.test.d.ts +1 -0
  34. package/cjs/src/tests/auth.test.d.ts.map +1 -0
  35. package/cjs/src/tests/auth.test.js +1 -0
  36. package/cjs/src/tests/auth.test.js.map +1 -0
  37. package/cjs/src/tests/e2e/auth.spec.d.ts +2 -0
  38. package/cjs/src/tests/e2e/auth.spec.d.ts.map +1 -0
  39. package/cjs/src/tests/e2e/auth.spec.js +54 -0
  40. package/cjs/src/tests/e2e/auth.spec.js.map +1 -0
  41. package/cjs/src/types.d.ts +83 -10
  42. package/cjs/src/types.d.ts.map +1 -1
  43. package/cjs/src/types.js +45 -9
  44. package/cjs/src/types.js.map +1 -1
  45. package/dist/index-BEyovSez.js +7370 -0
  46. package/dist/{index-BnVGyY5S.js → index-BJx3m5_V.js} +1 -1
  47. package/dist/index-Dg18PU5Z.js +7370 -0
  48. package/dist/index-Do_T8J8z.js +7370 -0
  49. package/dist/src/embed/bodyless-conversation.d.ts +16 -0
  50. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  51. package/dist/src/embed/search-bar.d.ts +1 -1
  52. package/dist/src/embed/search.d.ts +1 -1
  53. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  54. package/dist/src/index.d.ts +2 -2
  55. package/dist/src/index.d.ts.map +1 -1
  56. package/dist/src/pages/embed-test.page.d.ts +8 -0
  57. package/dist/src/pages/embed-test.page.d.ts.map +1 -0
  58. package/dist/src/pages/home.page.d.ts +6 -0
  59. package/dist/src/pages/home.page.d.ts.map +1 -0
  60. package/dist/src/pages/login.page.d.ts +15 -0
  61. package/dist/src/pages/login.page.d.ts.map +1 -0
  62. package/dist/src/react/index.d.ts +1 -1
  63. package/dist/src/react/index.d.ts.map +1 -1
  64. package/dist/src/tests/auth.test.d.ts +1 -0
  65. package/dist/src/tests/auth.test.d.ts.map +1 -0
  66. package/dist/src/tests/e2e/auth.spec.d.ts +2 -0
  67. package/dist/src/tests/e2e/auth.spec.d.ts.map +1 -0
  68. package/dist/src/types.d.ts +83 -10
  69. package/dist/src/types.d.ts.map +1 -1
  70. package/dist/tsembed-react.es.js +62 -14
  71. package/dist/tsembed-react.js +60 -12
  72. package/dist/tsembed.es.js +63 -15
  73. package/dist/tsembed.js +61 -13
  74. package/dist/visual-embed-sdk-react-full.d.ts +101 -13
  75. package/dist/visual-embed-sdk-react.d.ts +101 -13
  76. package/dist/visual-embed-sdk.d.ts +101 -13
  77. package/lib/package.json +15 -12
  78. package/lib/src/embed/bodyless-conversation.d.ts +16 -0
  79. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  80. package/lib/src/embed/bodyless-conversation.js +1 -1
  81. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  82. package/lib/src/embed/search-bar.d.ts +1 -1
  83. package/lib/src/embed/search.d.ts +1 -1
  84. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  85. package/lib/src/embed/ts-embed.js +14 -2
  86. package/lib/src/embed/ts-embed.js.map +1 -1
  87. package/lib/src/embed/ts-embed.spec.js +111 -0
  88. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  89. package/lib/src/index.d.ts +2 -2
  90. package/lib/src/index.d.ts.map +1 -1
  91. package/lib/src/index.js +2 -2
  92. package/lib/src/index.js.map +1 -1
  93. package/lib/src/pages/embed-test.page.d.ts +8 -0
  94. package/lib/src/pages/embed-test.page.d.ts.map +1 -0
  95. package/lib/src/pages/embed-test.page.js +16 -0
  96. package/lib/src/pages/embed-test.page.js.map +1 -0
  97. package/lib/src/pages/home.page.d.ts +6 -0
  98. package/lib/src/pages/home.page.d.ts.map +1 -0
  99. package/lib/src/pages/home.page.js +8 -0
  100. package/lib/src/pages/home.page.js.map +1 -0
  101. package/lib/src/pages/login.page.d.ts +15 -0
  102. package/lib/src/pages/login.page.d.ts.map +1 -0
  103. package/lib/src/pages/login.page.js +18 -0
  104. package/lib/src/pages/login.page.js.map +1 -0
  105. package/lib/src/react/index.d.ts +1 -1
  106. package/lib/src/react/index.d.ts.map +1 -1
  107. package/lib/src/react/index.js +1 -1
  108. package/lib/src/react/index.js.map +1 -1
  109. package/lib/src/tests/auth.test.d.ts +1 -0
  110. package/lib/src/tests/auth.test.d.ts.map +1 -0
  111. package/lib/src/tests/auth.test.js +1 -0
  112. package/lib/src/tests/auth.test.js.map +1 -0
  113. package/lib/src/tests/e2e/auth.spec.d.ts +2 -0
  114. package/lib/src/tests/e2e/auth.spec.d.ts.map +1 -0
  115. package/lib/src/tests/e2e/auth.spec.js +52 -0
  116. package/lib/src/tests/e2e/auth.spec.js.map +1 -0
  117. package/lib/src/types.d.ts +83 -10
  118. package/lib/src/types.d.ts.map +1 -1
  119. package/lib/src/types.js +44 -8
  120. package/lib/src/types.js.map +1 -1
  121. package/lib/src/visual-embed-sdk.d.ts +103 -14
  122. package/package.json +15 -12
  123. package/src/embed/bodyless-conversation.ts +1 -1
  124. package/src/embed/search-bar.tsx +1 -1
  125. package/src/embed/search.ts +1 -1
  126. package/src/embed/ts-embed.spec.ts +118 -0
  127. package/src/embed/ts-embed.ts +16 -0
  128. package/src/index.ts +2 -0
  129. package/src/react/index.tsx +1 -0
  130. package/src/types.ts +89 -10
@@ -273,7 +273,7 @@ export function useInit(config: EmbedConfig): React.MutableRefObject<AuthEventEm
273
273
  * @summary ThoughtSpot Visual Embed SDK
274
274
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
275
275
  */
276
- export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, };
276
+ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
277
277
 
278
278
  export declare let loggedInStatus: boolean;
279
279
  export declare let samlAuthWindow: Window;
@@ -518,7 +518,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
518
518
  /**
519
519
  * Exclude the search token string from the URL.
520
520
  * If set to true, the search token string is not appended to the URL.
521
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.7.0.cl
521
+ * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
522
522
  * @example
523
523
  * ```js
524
524
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -880,7 +880,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
880
880
  /**
881
881
  * Exclude the search token string from the URL.
882
882
  * If set to true, the search token string is not appended to the URL.
883
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.7.0.cl
883
+ * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
884
884
  * @example
885
885
  * ```js
886
886
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -2234,6 +2234,8 @@ export interface CustomisationsInterface {
2234
2234
  * @version SDK: 1.26.0 | 9.7.0.cl
2235
2235
  */
2236
2236
  strings?: Record<string, any>;
2237
+ stringIDs?: Record<string, string>;
2238
+ stringIDsUrl?: string;
2237
2239
  [key: string]: any;
2238
2240
  };
2239
2241
  iconSpriteUrl?: string;
@@ -2544,7 +2546,7 @@ export interface EmbedConfig {
2544
2546
  * }
2545
2547
  * });
2546
2548
  * ```
2547
- * @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
2549
+ * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
2548
2550
  */
2549
2551
  customVariablesForThirdPartyTools?: Record<string, any>;
2550
2552
  disablePreauthCache?: boolean;
@@ -2651,6 +2653,21 @@ export interface ViewConfig {
2651
2653
  * @important
2652
2654
  */
2653
2655
  hiddenActions?: Action[];
2656
+ /**
2657
+ * The primary action to display from the embedded.
2658
+ * This action will be displayed from the embedded.
2659
+ * Use this to set the primary action.
2660
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2661
+ * @example
2662
+ * ```js
2663
+ * const embed = new LiveboardEmbed('#embed', {
2664
+ * ... // other liveboard view config
2665
+ * primaryAction: 'download'
2666
+ * });
2667
+ * ```
2668
+ * @important
2669
+ */
2670
+ primaryAction?: string;
2654
2671
  /**
2655
2672
  * The list of actions to display from the primary menu, more menu
2656
2673
  * (...), and the contextual menu. These will be only actions that
@@ -2985,6 +3002,12 @@ export interface ViewConfig {
2985
3002
  * });
2986
3003
  */
2987
3004
  collapseSearchBar?: boolean;
3005
+ /**
3006
+ * This flag can be used to expose translation IDs on the embedded app.
3007
+ * @default false
3008
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
3009
+ */
3010
+ exposeTranslationIDs?: boolean;
2988
3011
  /**
2989
3012
  * This flag can be used to disable links inside the embedded app,
2990
3013
  * and disable redirection of links in a new tab.
@@ -3039,6 +3062,21 @@ export interface ViewConfig {
3039
3062
  * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3040
3063
  */
3041
3064
  overrideOrgId?: number;
3065
+ /**
3066
+ * Hide list page columns
3067
+ * For example: hiddenListColumns = [ListPageColumns.Author]
3068
+ *
3069
+ * **Note**: This option is appplicable only in full app embedding.
3070
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3071
+ * @example
3072
+ * ```js
3073
+ * const embed = new AppEmbed('#tsEmbed', {
3074
+ * ... // other options
3075
+ * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3076
+ * })
3077
+ * ```
3078
+ */
3079
+ hiddenListColumns?: ListPageColumns[];
3042
3080
  }
3043
3081
  /**
3044
3082
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3184,6 +3222,33 @@ export declare enum HomepageModule {
3184
3222
  */
3185
3223
  Learning = "LEARNING"
3186
3224
  }
3225
+ /**
3226
+ * List page columns that can be hidden.
3227
+ * **Note**: This option is applicable only in full app embedding.
3228
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3229
+ */
3230
+ export declare enum ListPageColumns {
3231
+ /**
3232
+ * Favourite
3233
+ */
3234
+ Favourite = "FAVOURITE",
3235
+ /**
3236
+ * Tags
3237
+ */
3238
+ Tags = "TAGS",
3239
+ /**
3240
+ * Author
3241
+ */
3242
+ Author = "AUTHOR",
3243
+ /**
3244
+ * Last viewed/Last modified
3245
+ */
3246
+ DateSort = "DATE_SORT",
3247
+ /**
3248
+ * Share
3249
+ */
3250
+ Share = "SHARE"
3251
+ }
3187
3252
  /**
3188
3253
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
3189
3254
  * visualizations at runtime.
@@ -4206,16 +4271,19 @@ export declare enum EmbedEvent {
4206
4271
  /**
4207
4272
  * Emits when a table visualization is rendered in
4208
4273
  * the ThoughtSpot embedded app.
4274
+ *
4209
4275
  * You can also use this event as a hook to trigger host events
4210
4276
  * such as `HostEvent.TransformTableVizData` on the table visualization.
4211
4277
  * The event payload contains the data used in the rendered table.
4212
4278
  * You can extract the relevant data from the payload
4213
4279
  * stored in `payload.data.data.columnDataLite`.
4280
+ *
4214
4281
  * `columnDataLite` is a multidimensional array that contains
4215
4282
  * data values for each column, which was used in the query to
4216
4283
  * generate the table visualization. To find and modify specific cell data,
4217
4284
  * you can either loop through the array or directly access a cell if
4218
4285
  * you know its position and data index.
4286
+ *
4219
4287
  * In the following code sample, the first cell in the first column
4220
4288
  * (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
4221
4289
  * Note that any changes made to the data in the payload will only update the
@@ -4225,6 +4293,7 @@ export declare enum EmbedEvent {
4225
4293
  * payload in the `columnDataLite` is passed on to
4226
4294
  * `HostEvent.TransformTableVizData` and trigger an update to
4227
4295
  * the table visualization.
4296
+ *
4228
4297
  * If the Row-Level Security (RLS) rules are applied on the
4229
4298
  * Worksheet or Model, exercise caution when changing column
4230
4299
  * or table cell values to maintain data security.
@@ -4239,7 +4308,7 @@ export declare enum EmbedEvent {
4239
4308
  * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
4240
4309
  * })
4241
4310
  * ```
4242
- * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
4311
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
4243
4312
  */
4244
4313
  TableVizRendered = "TableVizRendered",
4245
4314
  /**
@@ -4252,7 +4321,7 @@ export declare enum EmbedEvent {
4252
4321
  * console.log('payload', payload);
4253
4322
  * })
4254
4323
  *```
4255
- * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
4324
+ * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
4256
4325
  */
4257
4326
  CreateLiveboard = "createLiveboard",
4258
4327
  /**
@@ -4699,7 +4768,7 @@ export declare enum HostEvent {
4699
4768
  * ```js
4700
4769
  * liveboardEmbed.trigger(HostEvent.Remove)
4701
4770
  * ```
4702
- * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4771
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4703
4772
  */
4704
4773
  Remove = "delete",
4705
4774
  /**
@@ -5247,7 +5316,7 @@ export declare enum HostEvent {
5247
5316
  * ```js
5248
5317
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
5249
5318
  *```
5250
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5319
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5251
5320
  */
5252
5321
  InfoSuccess = "InfoSuccess",
5253
5322
  /**
@@ -5294,7 +5363,7 @@ export declare enum HostEvent {
5294
5363
  * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
5295
5364
  * })
5296
5365
  * ```
5297
- * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
5366
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
5298
5367
  */
5299
5368
  TransformTableVizData = "TransformTableVizData"
5300
5369
  }
@@ -5345,6 +5414,7 @@ export declare enum Param {
5345
5414
  livedBoardEmbed = "isLiveboardEmbed",
5346
5415
  searchEmbed = "isSearchEmbed",
5347
5416
  vizEmbed = "isVizEmbed",
5417
+ StringIDsUrl = "overrideStringIDsUrl",
5348
5418
  Version = "sdkVersion",
5349
5419
  ViewPortHeight = "viewPortHeight",
5350
5420
  ViewPortWidth = "viewPortWidth",
@@ -5394,6 +5464,7 @@ export declare enum Param {
5394
5464
  HideSageAnswerHeader = "hideSageAnswerHeader",
5395
5465
  HideSearchBar = "hideSearchBar",
5396
5466
  ClientLogLevel = "clientLogLevel",
5467
+ ExposeTranslationIDs = "exposeTranslationIDs",
5397
5468
  OverrideNativeConsole = "overrideConsoleLogs",
5398
5469
  enableAskSage = "enableAskSage",
5399
5470
  CollapseSearchBarInitially = "collapseSearchBarInitially",
@@ -5420,7 +5491,8 @@ export declare enum Param {
5420
5491
  DataSourceId = "dataSourceId",
5421
5492
  preAuthCache = "preAuthCache",
5422
5493
  ShowSpotterLimitations = "showSpotterLimitations",
5423
- CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
5494
+ CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
5495
+ PrimaryAction = "primaryAction"
5424
5496
  }
5425
5497
  /**
5426
5498
  * ThoughtSpot application pages include actions and menu commands
@@ -5585,7 +5657,7 @@ export declare enum Action {
5585
5657
  * The **Collapse data panel** icon on the Search page.
5586
5658
  * Collapses the data panel view.
5587
5659
  *
5588
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
5660
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5589
5661
  *
5590
5662
  * @example
5591
5663
  * ```js
@@ -6651,8 +6723,8 @@ export declare enum PrefetchFeatures {
6651
6723
  VizEmbed = "VizEmbed"
6652
6724
  }
6653
6725
  /**
6654
- * Enum for options to change context trigger
6655
- * BOTH_CLICKS option is introduced in 10.7
6726
+ * Enum for options to change context trigger.
6727
+ * The `BOTH_CLICKS` option is available from 10.8.0.cl.
6656
6728
  */
6657
6729
  export declare enum ContextMenuTriggerOptions {
6658
6730
  LEFT_CLICK = "left-click",
@@ -6793,6 +6865,7 @@ export interface DefaultAppInitData {
6793
6865
  hostConfig: Record<string, any>;
6794
6866
  hiddenHomeLeftNavItems: string[];
6795
6867
  customVariablesForThirdPartyTools: Record<string, any>;
6868
+ hiddenListColumns: ListPageColumns[];
6796
6869
  }
6797
6870
 
6798
6871
  export type EmbedEventHandlers = {
@@ -7075,6 +7148,18 @@ export interface BodylessConversationViewConfig extends ViewConfig {
7075
7148
  */
7076
7149
  worksheetId: string;
7077
7150
  }
7151
+ interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
7152
+ sessionId: string;
7153
+ genNo: number;
7154
+ acSessionId: string;
7155
+ acGenNo: number;
7156
+ }
7157
+ declare class ConversationMessage extends TsEmbed {
7158
+ protected viewConfig: ConversationMessageViewConfig;
7159
+ constructor(container: HTMLElement, viewConfig: ConversationMessageViewConfig);
7160
+ getIframeSrc(): string;
7161
+ render(): Promise<ConversationMessage>;
7162
+ }
7078
7163
  /**
7079
7164
  * Create a conversation embed, which can be integrated inside
7080
7165
  * chatbots or other conversational interfaces.
@@ -7099,11 +7184,14 @@ export declare class BodylessConversation {
7099
7184
  sendMessage(userMessage: string): Promise<{
7100
7185
  error: any;
7101
7186
  container?: undefined;
7187
+ viz?: undefined;
7102
7188
  } | {
7103
7189
  container: HTMLDivElement;
7190
+ viz: ConversationMessage;
7104
7191
  error?: undefined;
7105
7192
  }>;
7106
7193
  }
7194
+ export {};
7107
7195
 
7108
7196
  export type SessionInfo = {
7109
7197
  releaseVersion: string;
@@ -508,7 +508,7 @@ export interface SearchBarViewConfig extends Omit<ViewConfig, 'runtimeFilters' |
508
508
  /**
509
509
  * Exclude the search token string from the URL.
510
510
  * If set to true, the search token string is not appended to the URL.
511
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.7.0.cl
511
+ * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
512
512
  * @example
513
513
  * ```js
514
514
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -870,7 +870,7 @@ export interface SearchViewConfig extends Omit<ViewConfig, 'hiddenHomepageModule
870
870
  /**
871
871
  * Exclude the search token string from the URL.
872
872
  * If set to true, the search token string is not appended to the URL.
873
- * @version: SDK: 1.35.7 | ThoughtSpot: 10.7.0.cl
873
+ * @version: SDK: 1.35.7 | ThoughtSpot: 10.8.0.cl
874
874
  * @example
875
875
  * ```js
876
876
  * const embed = new SearchEmbed('#tsEmbed', {
@@ -2224,6 +2224,8 @@ export interface CustomisationsInterface {
2224
2224
  * @version SDK: 1.26.0 | 9.7.0.cl
2225
2225
  */
2226
2226
  strings?: Record<string, any>;
2227
+ stringIDs?: Record<string, string>;
2228
+ stringIDsUrl?: string;
2227
2229
  [key: string]: any;
2228
2230
  };
2229
2231
  iconSpriteUrl?: string;
@@ -2534,7 +2536,7 @@ export interface EmbedConfig {
2534
2536
  * }
2535
2537
  * });
2536
2538
  * ```
2537
- * @version SDK 1.37.0 | ThoughtSpot: 10.7.0.cl
2539
+ * @version SDK 1.37.0 | ThoughtSpot: 10.8.0.cl
2538
2540
  */
2539
2541
  customVariablesForThirdPartyTools?: Record<string, any>;
2540
2542
  disablePreauthCache?: boolean;
@@ -2641,6 +2643,21 @@ export interface ViewConfig {
2641
2643
  * @important
2642
2644
  */
2643
2645
  hiddenActions?: Action[];
2646
+ /**
2647
+ * The primary action to display from the embedded.
2648
+ * This action will be displayed from the embedded.
2649
+ * Use this to set the primary action.
2650
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
2651
+ * @example
2652
+ * ```js
2653
+ * const embed = new LiveboardEmbed('#embed', {
2654
+ * ... // other liveboard view config
2655
+ * primaryAction: 'download'
2656
+ * });
2657
+ * ```
2658
+ * @important
2659
+ */
2660
+ primaryAction?: string;
2644
2661
  /**
2645
2662
  * The list of actions to display from the primary menu, more menu
2646
2663
  * (...), and the contextual menu. These will be only actions that
@@ -2975,6 +2992,12 @@ export interface ViewConfig {
2975
2992
  * });
2976
2993
  */
2977
2994
  collapseSearchBar?: boolean;
2995
+ /**
2996
+ * This flag can be used to expose translation IDs on the embedded app.
2997
+ * @default false
2998
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2999
+ */
3000
+ exposeTranslationIDs?: boolean;
2978
3001
  /**
2979
3002
  * This flag can be used to disable links inside the embedded app,
2980
3003
  * and disable redirection of links in a new tab.
@@ -3029,6 +3052,21 @@ export interface ViewConfig {
3029
3052
  * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3030
3053
  */
3031
3054
  overrideOrgId?: number;
3055
+ /**
3056
+ * Hide list page columns
3057
+ * For example: hiddenListColumns = [ListPageColumns.Author]
3058
+ *
3059
+ * **Note**: This option is appplicable only in full app embedding.
3060
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3061
+ * @example
3062
+ * ```js
3063
+ * const embed = new AppEmbed('#tsEmbed', {
3064
+ * ... // other options
3065
+ * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3066
+ * })
3067
+ * ```
3068
+ */
3069
+ hiddenListColumns?: ListPageColumns[];
3032
3070
  }
3033
3071
  /**
3034
3072
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3174,6 +3212,33 @@ export declare enum HomepageModule {
3174
3212
  */
3175
3213
  Learning = "LEARNING"
3176
3214
  }
3215
+ /**
3216
+ * List page columns that can be hidden.
3217
+ * **Note**: This option is applicable only in full app embedding.
3218
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3219
+ */
3220
+ export declare enum ListPageColumns {
3221
+ /**
3222
+ * Favourite
3223
+ */
3224
+ Favourite = "FAVOURITE",
3225
+ /**
3226
+ * Tags
3227
+ */
3228
+ Tags = "TAGS",
3229
+ /**
3230
+ * Author
3231
+ */
3232
+ Author = "AUTHOR",
3233
+ /**
3234
+ * Last viewed/Last modified
3235
+ */
3236
+ DateSort = "DATE_SORT",
3237
+ /**
3238
+ * Share
3239
+ */
3240
+ Share = "SHARE"
3241
+ }
3177
3242
  /**
3178
3243
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
3179
3244
  * visualizations at runtime.
@@ -4196,16 +4261,19 @@ export declare enum EmbedEvent {
4196
4261
  /**
4197
4262
  * Emits when a table visualization is rendered in
4198
4263
  * the ThoughtSpot embedded app.
4264
+ *
4199
4265
  * You can also use this event as a hook to trigger host events
4200
4266
  * such as `HostEvent.TransformTableVizData` on the table visualization.
4201
4267
  * The event payload contains the data used in the rendered table.
4202
4268
  * You can extract the relevant data from the payload
4203
4269
  * stored in `payload.data.data.columnDataLite`.
4270
+ *
4204
4271
  * `columnDataLite` is a multidimensional array that contains
4205
4272
  * data values for each column, which was used in the query to
4206
4273
  * generate the table visualization. To find and modify specific cell data,
4207
4274
  * you can either loop through the array or directly access a cell if
4208
4275
  * you know its position and data index.
4276
+ *
4209
4277
  * In the following code sample, the first cell in the first column
4210
4278
  * (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
4211
4279
  * Note that any changes made to the data in the payload will only update the
@@ -4215,6 +4283,7 @@ export declare enum EmbedEvent {
4215
4283
  * payload in the `columnDataLite` is passed on to
4216
4284
  * `HostEvent.TransformTableVizData` and trigger an update to
4217
4285
  * the table visualization.
4286
+ *
4218
4287
  * If the Row-Level Security (RLS) rules are applied on the
4219
4288
  * Worksheet or Model, exercise caution when changing column
4220
4289
  * or table cell values to maintain data security.
@@ -4229,7 +4298,7 @@ export declare enum EmbedEvent {
4229
4298
  * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
4230
4299
  * })
4231
4300
  * ```
4232
- * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
4301
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
4233
4302
  */
4234
4303
  TableVizRendered = "TableVizRendered",
4235
4304
  /**
@@ -4242,7 +4311,7 @@ export declare enum EmbedEvent {
4242
4311
  * console.log('payload', payload);
4243
4312
  * })
4244
4313
  *```
4245
- * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
4314
+ * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
4246
4315
  */
4247
4316
  CreateLiveboard = "createLiveboard",
4248
4317
  /**
@@ -4689,7 +4758,7 @@ export declare enum HostEvent {
4689
4758
  * ```js
4690
4759
  * liveboardEmbed.trigger(HostEvent.Remove)
4691
4760
  * ```
4692
- * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4761
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4693
4762
  */
4694
4763
  Remove = "delete",
4695
4764
  /**
@@ -5237,7 +5306,7 @@ export declare enum HostEvent {
5237
5306
  * ```js
5238
5307
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
5239
5308
  *```
5240
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5309
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5241
5310
  */
5242
5311
  InfoSuccess = "InfoSuccess",
5243
5312
  /**
@@ -5284,7 +5353,7 @@ export declare enum HostEvent {
5284
5353
  * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
5285
5354
  * })
5286
5355
  * ```
5287
- * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
5356
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
5288
5357
  */
5289
5358
  TransformTableVizData = "TransformTableVizData"
5290
5359
  }
@@ -5335,6 +5404,7 @@ export declare enum Param {
5335
5404
  livedBoardEmbed = "isLiveboardEmbed",
5336
5405
  searchEmbed = "isSearchEmbed",
5337
5406
  vizEmbed = "isVizEmbed",
5407
+ StringIDsUrl = "overrideStringIDsUrl",
5338
5408
  Version = "sdkVersion",
5339
5409
  ViewPortHeight = "viewPortHeight",
5340
5410
  ViewPortWidth = "viewPortWidth",
@@ -5384,6 +5454,7 @@ export declare enum Param {
5384
5454
  HideSageAnswerHeader = "hideSageAnswerHeader",
5385
5455
  HideSearchBar = "hideSearchBar",
5386
5456
  ClientLogLevel = "clientLogLevel",
5457
+ ExposeTranslationIDs = "exposeTranslationIDs",
5387
5458
  OverrideNativeConsole = "overrideConsoleLogs",
5388
5459
  enableAskSage = "enableAskSage",
5389
5460
  CollapseSearchBarInitially = "collapseSearchBarInitially",
@@ -5410,7 +5481,8 @@ export declare enum Param {
5410
5481
  DataSourceId = "dataSourceId",
5411
5482
  preAuthCache = "preAuthCache",
5412
5483
  ShowSpotterLimitations = "showSpotterLimitations",
5413
- CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
5484
+ CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
5485
+ PrimaryAction = "primaryAction"
5414
5486
  }
5415
5487
  /**
5416
5488
  * ThoughtSpot application pages include actions and menu commands
@@ -5575,7 +5647,7 @@ export declare enum Action {
5575
5647
  * The **Collapse data panel** icon on the Search page.
5576
5648
  * Collapses the data panel view.
5577
5649
  *
5578
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
5650
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5579
5651
  *
5580
5652
  * @example
5581
5653
  * ```js
@@ -6641,8 +6713,8 @@ export declare enum PrefetchFeatures {
6641
6713
  VizEmbed = "VizEmbed"
6642
6714
  }
6643
6715
  /**
6644
- * Enum for options to change context trigger
6645
- * BOTH_CLICKS option is introduced in 10.7
6716
+ * Enum for options to change context trigger.
6717
+ * The `BOTH_CLICKS` option is available from 10.8.0.cl.
6646
6718
  */
6647
6719
  export declare enum ContextMenuTriggerOptions {
6648
6720
  LEFT_CLICK = "left-click",
@@ -6783,6 +6855,7 @@ export interface DefaultAppInitData {
6783
6855
  hostConfig: Record<string, any>;
6784
6856
  hiddenHomeLeftNavItems: string[];
6785
6857
  customVariablesForThirdPartyTools: Record<string, any>;
6858
+ hiddenListColumns: ListPageColumns[];
6786
6859
  }
6787
6860
 
6788
6861
  export type EmbedEventHandlers = {
@@ -6922,7 +6995,7 @@ export declare class ConversationEmbed extends TsEmbed {
6922
6995
  * @summary ThoughtSpot Visual Embed SDK
6923
6996
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
6924
6997
  */
6925
- export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, };
6998
+ export { init, logout, prefetch, executeTML, exportTML, executeTMLInput, exportTMLInput, getEmbedConfig as getInitConfig, getSessionInfo, tokenizedFetch, getAnswerFromQuery, createLiveboardWithAnswers, SearchEmbed, SearchBarEmbed, PinboardEmbed, LiveboardEmbed, SageEmbed, AppEmbed, BodylessConversation, BodylessConversationViewConfig, ConversationEmbed, ConversationViewConfig, AuthFailureType, AuthStatus, AuthEvent, AuthEventEmitter, AnswerService, SessionInterface, UnderlyingDataPoint, Page, AuthType, RuntimeFilter, RuntimeFilterOp, EmbedEvent, HostEvent, DataSourceVisualMode, Action, ContextMenuTriggerOptions, EmbedConfig, SearchViewConfig, SearchBarViewConfig, LiveboardViewConfig, SageViewConfig, AppViewConfig, PrefetchFeatures, FrameParams, HomeLeftNavItem, HomepageModule, DOMSelector, MessageOptions, MessageCallback, MessagePayload, CustomisationsInterface, CustomStyles, customCssInterface, CustomCssVariables, RuntimeParameter, LogLevel, uploadMixpanelEvent, MIXPANEL_EVENT, HomePageSearchBarMode, VizPoint, CustomActionPayload, UIPassthroughEvent, ListPageColumns, };
6926
6999
 
6927
7000
  /**
6928
7001
  * Copyright (c) 2022
@@ -8028,6 +8101,18 @@ export interface BodylessConversationViewConfig extends ViewConfig {
8028
8101
  */
8029
8102
  worksheetId: string;
8030
8103
  }
8104
+ interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
8105
+ sessionId: string;
8106
+ genNo: number;
8107
+ acSessionId: string;
8108
+ acGenNo: number;
8109
+ }
8110
+ declare class ConversationMessage extends TsEmbed {
8111
+ protected viewConfig: ConversationMessageViewConfig;
8112
+ constructor(container: HTMLElement, viewConfig: ConversationMessageViewConfig);
8113
+ getIframeSrc(): string;
8114
+ render(): Promise<ConversationMessage>;
8115
+ }
8031
8116
  /**
8032
8117
  * Create a conversation embed, which can be integrated inside
8033
8118
  * chatbots or other conversational interfaces.
@@ -8052,11 +8137,14 @@ export declare class BodylessConversation {
8052
8137
  sendMessage(userMessage: string): Promise<{
8053
8138
  error: any;
8054
8139
  container?: undefined;
8140
+ viz?: undefined;
8055
8141
  } | {
8056
8142
  container: HTMLDivElement;
8143
+ viz: ConversationMessage;
8057
8144
  error?: undefined;
8058
8145
  }>;
8059
8146
  }
8147
+ export {};
8060
8148
 
8061
8149
  export type SessionInfo = {
8062
8150
  releaseVersion: string;