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

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 (132) hide show
  1. package/cjs/package.json +23 -18
  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 +8 -3
  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 +81 -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-CpzF_6NO.js +7440 -0
  48. package/dist/index-Dg18PU5Z.js +7370 -0
  49. package/dist/index-Do_T8J8z.js +7370 -0
  50. package/dist/index-KdQfn0ah.js +7440 -0
  51. package/dist/src/embed/bodyless-conversation.d.ts +16 -0
  52. package/dist/src/embed/bodyless-conversation.d.ts.map +1 -1
  53. package/dist/src/embed/search-bar.d.ts +1 -1
  54. package/dist/src/embed/search.d.ts +1 -1
  55. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  56. package/dist/src/index.d.ts +2 -2
  57. package/dist/src/index.d.ts.map +1 -1
  58. package/dist/src/pages/embed-test.page.d.ts +8 -0
  59. package/dist/src/pages/embed-test.page.d.ts.map +1 -0
  60. package/dist/src/pages/home.page.d.ts +6 -0
  61. package/dist/src/pages/home.page.d.ts.map +1 -0
  62. package/dist/src/pages/login.page.d.ts +15 -0
  63. package/dist/src/pages/login.page.d.ts.map +1 -0
  64. package/dist/src/react/index.d.ts +1 -1
  65. package/dist/src/react/index.d.ts.map +1 -1
  66. package/dist/src/tests/auth.test.d.ts +1 -0
  67. package/dist/src/tests/auth.test.d.ts.map +1 -0
  68. package/dist/src/tests/e2e/auth.spec.d.ts +2 -0
  69. package/dist/src/tests/e2e/auth.spec.d.ts.map +1 -0
  70. package/dist/src/types.d.ts +81 -10
  71. package/dist/src/types.d.ts.map +1 -1
  72. package/dist/tsembed-react.es.js +68 -16
  73. package/dist/tsembed-react.js +252 -130
  74. package/dist/tsembed.es.js +63 -15
  75. package/dist/tsembed.js +246 -128
  76. package/dist/visual-embed-sdk-react-full.d.ts +99 -13
  77. package/dist/visual-embed-sdk-react.d.ts +99 -13
  78. package/dist/visual-embed-sdk.d.ts +99 -13
  79. package/lib/package.json +23 -18
  80. package/lib/src/embed/bodyless-conversation.d.ts +16 -0
  81. package/lib/src/embed/bodyless-conversation.d.ts.map +1 -1
  82. package/lib/src/embed/bodyless-conversation.js +1 -1
  83. package/lib/src/embed/bodyless-conversation.js.map +1 -1
  84. package/lib/src/embed/search-bar.d.ts +1 -1
  85. package/lib/src/embed/search.d.ts +1 -1
  86. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  87. package/lib/src/embed/ts-embed.js +14 -2
  88. package/lib/src/embed/ts-embed.js.map +1 -1
  89. package/lib/src/embed/ts-embed.spec.js +111 -0
  90. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  91. package/lib/src/index.d.ts +2 -2
  92. package/lib/src/index.d.ts.map +1 -1
  93. package/lib/src/index.js +2 -2
  94. package/lib/src/index.js.map +1 -1
  95. package/lib/src/pages/embed-test.page.d.ts +8 -0
  96. package/lib/src/pages/embed-test.page.d.ts.map +1 -0
  97. package/lib/src/pages/embed-test.page.js +16 -0
  98. package/lib/src/pages/embed-test.page.js.map +1 -0
  99. package/lib/src/pages/home.page.d.ts +6 -0
  100. package/lib/src/pages/home.page.d.ts.map +1 -0
  101. package/lib/src/pages/home.page.js +8 -0
  102. package/lib/src/pages/home.page.js.map +1 -0
  103. package/lib/src/pages/login.page.d.ts +15 -0
  104. package/lib/src/pages/login.page.d.ts.map +1 -0
  105. package/lib/src/pages/login.page.js +18 -0
  106. package/lib/src/pages/login.page.js.map +1 -0
  107. package/lib/src/react/index.d.ts +1 -1
  108. package/lib/src/react/index.d.ts.map +1 -1
  109. package/lib/src/react/index.js +7 -3
  110. package/lib/src/react/index.js.map +1 -1
  111. package/lib/src/tests/auth.test.d.ts +1 -0
  112. package/lib/src/tests/auth.test.d.ts.map +1 -0
  113. package/lib/src/tests/auth.test.js +1 -0
  114. package/lib/src/tests/auth.test.js.map +1 -0
  115. package/lib/src/tests/e2e/auth.spec.d.ts +2 -0
  116. package/lib/src/tests/e2e/auth.spec.d.ts.map +1 -0
  117. package/lib/src/tests/e2e/auth.spec.js +52 -0
  118. package/lib/src/tests/e2e/auth.spec.js.map +1 -0
  119. package/lib/src/types.d.ts +81 -10
  120. package/lib/src/types.d.ts.map +1 -1
  121. package/lib/src/types.js +44 -8
  122. package/lib/src/types.js.map +1 -1
  123. package/lib/src/visual-embed-sdk.d.ts +101 -14
  124. package/package.json +23 -18
  125. package/src/embed/bodyless-conversation.ts +1 -1
  126. package/src/embed/search-bar.tsx +1 -1
  127. package/src/embed/search.ts +1 -1
  128. package/src/embed/ts-embed.spec.ts +118 -0
  129. package/src/embed/ts-embed.ts +15 -0
  130. package/src/index.ts +2 -0
  131. package/src/react/index.tsx +10 -6
  132. package/src/types.ts +83 -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;
@@ -2623,6 +2625,19 @@ export interface ViewConfig {
2623
2625
  * ```
2624
2626
  */
2625
2627
  disabledActions?: Action[];
2628
+ /**
2629
+ * The primary action to display on top of the viz for Liveboard and App Embed.
2630
+ * Use this to set the primary action.
2631
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2632
+ * @example
2633
+ * ```js
2634
+ * const embed = new LiveboardEmbed('#embed', {
2635
+ * ... // other liveboard view config
2636
+ * primaryAction: Action.Download
2637
+ * });
2638
+ * ```
2639
+ */
2640
+ primaryAction?: Action | string;
2626
2641
  /**
2627
2642
  * The tooltip to display for disabled actions.
2628
2643
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
@@ -2985,6 +3000,12 @@ export interface ViewConfig {
2985
3000
  * });
2986
3001
  */
2987
3002
  collapseSearchBar?: boolean;
3003
+ /**
3004
+ * This flag can be used to expose translation IDs on the embedded app.
3005
+ * @default false
3006
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
3007
+ */
3008
+ exposeTranslationIDs?: boolean;
2988
3009
  /**
2989
3010
  * This flag can be used to disable links inside the embedded app,
2990
3011
  * and disable redirection of links in a new tab.
@@ -3039,6 +3060,21 @@ export interface ViewConfig {
3039
3060
  * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3040
3061
  */
3041
3062
  overrideOrgId?: number;
3063
+ /**
3064
+ * Hide list page columns
3065
+ * For example: hiddenListColumns = [ListPageColumns.Author]
3066
+ *
3067
+ * **Note**: This option is appplicable only in full app embedding.
3068
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3069
+ * @example
3070
+ * ```js
3071
+ * const embed = new AppEmbed('#tsEmbed', {
3072
+ * ... // other options
3073
+ * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3074
+ * })
3075
+ * ```
3076
+ */
3077
+ hiddenListColumns?: ListPageColumns[];
3042
3078
  }
3043
3079
  /**
3044
3080
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3184,6 +3220,33 @@ export declare enum HomepageModule {
3184
3220
  */
3185
3221
  Learning = "LEARNING"
3186
3222
  }
3223
+ /**
3224
+ * List page columns that can be hidden.
3225
+ * **Note**: This option is applicable only in full app embedding.
3226
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3227
+ */
3228
+ export declare enum ListPageColumns {
3229
+ /**
3230
+ * Favourite
3231
+ */
3232
+ Favourite = "FAVOURITE",
3233
+ /**
3234
+ * Tags
3235
+ */
3236
+ Tags = "TAGS",
3237
+ /**
3238
+ * Author
3239
+ */
3240
+ Author = "AUTHOR",
3241
+ /**
3242
+ * Last viewed/Last modified
3243
+ */
3244
+ DateSort = "DATE_SORT",
3245
+ /**
3246
+ * Share
3247
+ */
3248
+ Share = "SHARE"
3249
+ }
3187
3250
  /**
3188
3251
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
3189
3252
  * visualizations at runtime.
@@ -4206,16 +4269,19 @@ export declare enum EmbedEvent {
4206
4269
  /**
4207
4270
  * Emits when a table visualization is rendered in
4208
4271
  * the ThoughtSpot embedded app.
4272
+ *
4209
4273
  * You can also use this event as a hook to trigger host events
4210
4274
  * such as `HostEvent.TransformTableVizData` on the table visualization.
4211
4275
  * The event payload contains the data used in the rendered table.
4212
4276
  * You can extract the relevant data from the payload
4213
4277
  * stored in `payload.data.data.columnDataLite`.
4278
+ *
4214
4279
  * `columnDataLite` is a multidimensional array that contains
4215
4280
  * data values for each column, which was used in the query to
4216
4281
  * generate the table visualization. To find and modify specific cell data,
4217
4282
  * you can either loop through the array or directly access a cell if
4218
4283
  * you know its position and data index.
4284
+ *
4219
4285
  * In the following code sample, the first cell in the first column
4220
4286
  * (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
4221
4287
  * Note that any changes made to the data in the payload will only update the
@@ -4225,6 +4291,7 @@ export declare enum EmbedEvent {
4225
4291
  * payload in the `columnDataLite` is passed on to
4226
4292
  * `HostEvent.TransformTableVizData` and trigger an update to
4227
4293
  * the table visualization.
4294
+ *
4228
4295
  * If the Row-Level Security (RLS) rules are applied on the
4229
4296
  * Worksheet or Model, exercise caution when changing column
4230
4297
  * or table cell values to maintain data security.
@@ -4239,7 +4306,7 @@ export declare enum EmbedEvent {
4239
4306
  * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
4240
4307
  * })
4241
4308
  * ```
4242
- * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
4309
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
4243
4310
  */
4244
4311
  TableVizRendered = "TableVizRendered",
4245
4312
  /**
@@ -4252,7 +4319,7 @@ export declare enum EmbedEvent {
4252
4319
  * console.log('payload', payload);
4253
4320
  * })
4254
4321
  *```
4255
- * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
4322
+ * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
4256
4323
  */
4257
4324
  CreateLiveboard = "createLiveboard",
4258
4325
  /**
@@ -4699,7 +4766,7 @@ export declare enum HostEvent {
4699
4766
  * ```js
4700
4767
  * liveboardEmbed.trigger(HostEvent.Remove)
4701
4768
  * ```
4702
- * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4769
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4703
4770
  */
4704
4771
  Remove = "delete",
4705
4772
  /**
@@ -5247,7 +5314,7 @@ export declare enum HostEvent {
5247
5314
  * ```js
5248
5315
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
5249
5316
  *```
5250
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5317
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5251
5318
  */
5252
5319
  InfoSuccess = "InfoSuccess",
5253
5320
  /**
@@ -5294,7 +5361,7 @@ export declare enum HostEvent {
5294
5361
  * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
5295
5362
  * })
5296
5363
  * ```
5297
- * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
5364
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
5298
5365
  */
5299
5366
  TransformTableVizData = "TransformTableVizData"
5300
5367
  }
@@ -5345,6 +5412,7 @@ export declare enum Param {
5345
5412
  livedBoardEmbed = "isLiveboardEmbed",
5346
5413
  searchEmbed = "isSearchEmbed",
5347
5414
  vizEmbed = "isVizEmbed",
5415
+ StringIDsUrl = "overrideStringIDsUrl",
5348
5416
  Version = "sdkVersion",
5349
5417
  ViewPortHeight = "viewPortHeight",
5350
5418
  ViewPortWidth = "viewPortWidth",
@@ -5394,6 +5462,7 @@ export declare enum Param {
5394
5462
  HideSageAnswerHeader = "hideSageAnswerHeader",
5395
5463
  HideSearchBar = "hideSearchBar",
5396
5464
  ClientLogLevel = "clientLogLevel",
5465
+ ExposeTranslationIDs = "exposeTranslationIDs",
5397
5466
  OverrideNativeConsole = "overrideConsoleLogs",
5398
5467
  enableAskSage = "enableAskSage",
5399
5468
  CollapseSearchBarInitially = "collapseSearchBarInitially",
@@ -5420,7 +5489,8 @@ export declare enum Param {
5420
5489
  DataSourceId = "dataSourceId",
5421
5490
  preAuthCache = "preAuthCache",
5422
5491
  ShowSpotterLimitations = "showSpotterLimitations",
5423
- CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
5492
+ CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
5493
+ PrimaryAction = "primaryAction"
5424
5494
  }
5425
5495
  /**
5426
5496
  * ThoughtSpot application pages include actions and menu commands
@@ -5585,7 +5655,7 @@ export declare enum Action {
5585
5655
  * The **Collapse data panel** icon on the Search page.
5586
5656
  * Collapses the data panel view.
5587
5657
  *
5588
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
5658
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5589
5659
  *
5590
5660
  * @example
5591
5661
  * ```js
@@ -6651,8 +6721,8 @@ export declare enum PrefetchFeatures {
6651
6721
  VizEmbed = "VizEmbed"
6652
6722
  }
6653
6723
  /**
6654
- * Enum for options to change context trigger
6655
- * BOTH_CLICKS option is introduced in 10.7
6724
+ * Enum for options to change context trigger.
6725
+ * The `BOTH_CLICKS` option is available from 10.8.0.cl.
6656
6726
  */
6657
6727
  export declare enum ContextMenuTriggerOptions {
6658
6728
  LEFT_CLICK = "left-click",
@@ -6793,6 +6863,7 @@ export interface DefaultAppInitData {
6793
6863
  hostConfig: Record<string, any>;
6794
6864
  hiddenHomeLeftNavItems: string[];
6795
6865
  customVariablesForThirdPartyTools: Record<string, any>;
6866
+ hiddenListColumns: ListPageColumns[];
6796
6867
  }
6797
6868
 
6798
6869
  export type EmbedEventHandlers = {
@@ -7075,6 +7146,18 @@ export interface BodylessConversationViewConfig extends ViewConfig {
7075
7146
  */
7076
7147
  worksheetId: string;
7077
7148
  }
7149
+ interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
7150
+ sessionId: string;
7151
+ genNo: number;
7152
+ acSessionId: string;
7153
+ acGenNo: number;
7154
+ }
7155
+ declare class ConversationMessage extends TsEmbed {
7156
+ protected viewConfig: ConversationMessageViewConfig;
7157
+ constructor(container: HTMLElement, viewConfig: ConversationMessageViewConfig);
7158
+ getIframeSrc(): string;
7159
+ render(): Promise<ConversationMessage>;
7160
+ }
7078
7161
  /**
7079
7162
  * Create a conversation embed, which can be integrated inside
7080
7163
  * chatbots or other conversational interfaces.
@@ -7099,11 +7182,14 @@ export declare class BodylessConversation {
7099
7182
  sendMessage(userMessage: string): Promise<{
7100
7183
  error: any;
7101
7184
  container?: undefined;
7185
+ viz?: undefined;
7102
7186
  } | {
7103
7187
  container: HTMLDivElement;
7188
+ viz: ConversationMessage;
7104
7189
  error?: undefined;
7105
7190
  }>;
7106
7191
  }
7192
+ export {};
7107
7193
 
7108
7194
  export type SessionInfo = {
7109
7195
  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;
@@ -2613,6 +2615,19 @@ export interface ViewConfig {
2613
2615
  * ```
2614
2616
  */
2615
2617
  disabledActions?: Action[];
2618
+ /**
2619
+ * The primary action to display on top of the viz for Liveboard and App Embed.
2620
+ * Use this to set the primary action.
2621
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2622
+ * @example
2623
+ * ```js
2624
+ * const embed = new LiveboardEmbed('#embed', {
2625
+ * ... // other liveboard view config
2626
+ * primaryAction: Action.Download
2627
+ * });
2628
+ * ```
2629
+ */
2630
+ primaryAction?: Action | string;
2616
2631
  /**
2617
2632
  * The tooltip to display for disabled actions.
2618
2633
  * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1.sw
@@ -2975,6 +2990,12 @@ export interface ViewConfig {
2975
2990
  * });
2976
2991
  */
2977
2992
  collapseSearchBar?: boolean;
2993
+ /**
2994
+ * This flag can be used to expose translation IDs on the embedded app.
2995
+ * @default false
2996
+ * @version SDK: 1.37.0 | ThoughtSpot: 10.9.0.cl
2997
+ */
2998
+ exposeTranslationIDs?: boolean;
2978
2999
  /**
2979
3000
  * This flag can be used to disable links inside the embedded app,
2980
3001
  * and disable redirection of links in a new tab.
@@ -3029,6 +3050,21 @@ export interface ViewConfig {
3029
3050
  * @version SDK: 1.35.0 | ThoughtSpot: 10.5.0.cl
3030
3051
  */
3031
3052
  overrideOrgId?: number;
3053
+ /**
3054
+ * Hide list page columns
3055
+ * For example: hiddenListColumns = [ListPageColumns.Author]
3056
+ *
3057
+ * **Note**: This option is appplicable only in full app embedding.
3058
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3059
+ * @example
3060
+ * ```js
3061
+ * const embed = new AppEmbed('#tsEmbed', {
3062
+ * ... // other options
3063
+ * hiddenListColumns : [ListPageColumns.Favorite,ListPageColumns.Author],
3064
+ * })
3065
+ * ```
3066
+ */
3067
+ hiddenListColumns?: ListPageColumns[];
3032
3068
  }
3033
3069
  /**
3034
3070
  * MessagePayload: Embed event payload: message type, data and status (start/end)
@@ -3174,6 +3210,33 @@ export declare enum HomepageModule {
3174
3210
  */
3175
3211
  Learning = "LEARNING"
3176
3212
  }
3213
+ /**
3214
+ * List page columns that can be hidden.
3215
+ * **Note**: This option is applicable only in full app embedding.
3216
+ * @version SDK: 1.38.0 | ThoughtSpot: 9.12.5.cl, 10.1.0.sw
3217
+ */
3218
+ export declare enum ListPageColumns {
3219
+ /**
3220
+ * Favourite
3221
+ */
3222
+ Favourite = "FAVOURITE",
3223
+ /**
3224
+ * Tags
3225
+ */
3226
+ Tags = "TAGS",
3227
+ /**
3228
+ * Author
3229
+ */
3230
+ Author = "AUTHOR",
3231
+ /**
3232
+ * Last viewed/Last modified
3233
+ */
3234
+ DateSort = "DATE_SORT",
3235
+ /**
3236
+ * Share
3237
+ */
3238
+ Share = "SHARE"
3239
+ }
3177
3240
  /**
3178
3241
  * A filter that can be applied to ThoughtSpot answers, Liveboards, or
3179
3242
  * visualizations at runtime.
@@ -4196,16 +4259,19 @@ export declare enum EmbedEvent {
4196
4259
  /**
4197
4260
  * Emits when a table visualization is rendered in
4198
4261
  * the ThoughtSpot embedded app.
4262
+ *
4199
4263
  * You can also use this event as a hook to trigger host events
4200
4264
  * such as `HostEvent.TransformTableVizData` on the table visualization.
4201
4265
  * The event payload contains the data used in the rendered table.
4202
4266
  * You can extract the relevant data from the payload
4203
4267
  * stored in `payload.data.data.columnDataLite`.
4268
+ *
4204
4269
  * `columnDataLite` is a multidimensional array that contains
4205
4270
  * data values for each column, which was used in the query to
4206
4271
  * generate the table visualization. To find and modify specific cell data,
4207
4272
  * you can either loop through the array or directly access a cell if
4208
4273
  * you know its position and data index.
4274
+ *
4209
4275
  * In the following code sample, the first cell in the first column
4210
4276
  * (`columnDataLite[0].dataValue[0]`) is set to `new fob`.
4211
4277
  * Note that any changes made to the data in the payload will only update the
@@ -4215,6 +4281,7 @@ export declare enum EmbedEvent {
4215
4281
  * payload in the `columnDataLite` is passed on to
4216
4282
  * `HostEvent.TransformTableVizData` and trigger an update to
4217
4283
  * the table visualization.
4284
+ *
4218
4285
  * If the Row-Level Security (RLS) rules are applied on the
4219
4286
  * Worksheet or Model, exercise caution when changing column
4220
4287
  * or table cell values to maintain data security.
@@ -4229,7 +4296,7 @@ export declare enum EmbedEvent {
4229
4296
  * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
4230
4297
  * })
4231
4298
  * ```
4232
- * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
4299
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
4233
4300
  */
4234
4301
  TableVizRendered = "TableVizRendered",
4235
4302
  /**
@@ -4242,7 +4309,7 @@ export declare enum EmbedEvent {
4242
4309
  * console.log('payload', payload);
4243
4310
  * })
4244
4311
  *```
4245
- * @version SDK : 1.36.0 | ThoughtSpot : 10.8.0.cl
4312
+ * @version SDK : 1.38.0 | ThoughtSpot : 10.8.0.cl
4246
4313
  */
4247
4314
  CreateLiveboard = "createLiveboard",
4248
4315
  /**
@@ -4689,7 +4756,7 @@ export declare enum HostEvent {
4689
4756
  * ```js
4690
4757
  * liveboardEmbed.trigger(HostEvent.Remove)
4691
4758
  * ```
4692
- * @version SDK: 1.37.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4759
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl, 10.10.0.sw
4693
4760
  */
4694
4761
  Remove = "delete",
4695
4762
  /**
@@ -5237,7 +5304,7 @@ export declare enum HostEvent {
5237
5304
  * ```js
5238
5305
  * liveboardEmbed.trigger(HostEvent.InfoSuccess, data);
5239
5306
  *```
5240
- * @version SDK: 1.36.0 | Thoughtspot: 10.6.0.cl
5307
+ * @version SDK: 1.36.0 | ThoughtSpot: 10.6.0.cl
5241
5308
  */
5242
5309
  InfoSuccess = "InfoSuccess",
5243
5310
  /**
@@ -5284,7 +5351,7 @@ export declare enum HostEvent {
5284
5351
  * searchEmbed.trigger(HostEvent.TransformTableVizData, columnDataLite);
5285
5352
  * })
5286
5353
  * ```
5287
- * @version SDK: 1.35.12 | ThoughtSpot: 10.7.0.cl
5354
+ * @version SDK: 1.38.0 | ThoughtSpot: 10.8.0.cl
5288
5355
  */
5289
5356
  TransformTableVizData = "TransformTableVizData"
5290
5357
  }
@@ -5335,6 +5402,7 @@ export declare enum Param {
5335
5402
  livedBoardEmbed = "isLiveboardEmbed",
5336
5403
  searchEmbed = "isSearchEmbed",
5337
5404
  vizEmbed = "isVizEmbed",
5405
+ StringIDsUrl = "overrideStringIDsUrl",
5338
5406
  Version = "sdkVersion",
5339
5407
  ViewPortHeight = "viewPortHeight",
5340
5408
  ViewPortWidth = "viewPortWidth",
@@ -5384,6 +5452,7 @@ export declare enum Param {
5384
5452
  HideSageAnswerHeader = "hideSageAnswerHeader",
5385
5453
  HideSearchBar = "hideSearchBar",
5386
5454
  ClientLogLevel = "clientLogLevel",
5455
+ ExposeTranslationIDs = "exposeTranslationIDs",
5387
5456
  OverrideNativeConsole = "overrideConsoleLogs",
5388
5457
  enableAskSage = "enableAskSage",
5389
5458
  CollapseSearchBarInitially = "collapseSearchBarInitially",
@@ -5410,7 +5479,8 @@ export declare enum Param {
5410
5479
  DataSourceId = "dataSourceId",
5411
5480
  preAuthCache = "preAuthCache",
5412
5481
  ShowSpotterLimitations = "showSpotterLimitations",
5413
- CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF"
5482
+ CoverAndFilterOptionInPDF = "coverAndFilterOptionInPDF",
5483
+ PrimaryAction = "primaryAction"
5414
5484
  }
5415
5485
  /**
5416
5486
  * ThoughtSpot application pages include actions and menu commands
@@ -5575,7 +5645,7 @@ export declare enum Action {
5575
5645
  * The **Collapse data panel** icon on the Search page.
5576
5646
  * Collapses the data panel view.
5577
5647
  *
5578
- * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl, 10.7.0.sw
5648
+ * @version: SDK: 1.34.0 | ThoughtSpot Cloud: 10.3.0.cl
5579
5649
  *
5580
5650
  * @example
5581
5651
  * ```js
@@ -6641,8 +6711,8 @@ export declare enum PrefetchFeatures {
6641
6711
  VizEmbed = "VizEmbed"
6642
6712
  }
6643
6713
  /**
6644
- * Enum for options to change context trigger
6645
- * BOTH_CLICKS option is introduced in 10.7
6714
+ * Enum for options to change context trigger.
6715
+ * The `BOTH_CLICKS` option is available from 10.8.0.cl.
6646
6716
  */
6647
6717
  export declare enum ContextMenuTriggerOptions {
6648
6718
  LEFT_CLICK = "left-click",
@@ -6783,6 +6853,7 @@ export interface DefaultAppInitData {
6783
6853
  hostConfig: Record<string, any>;
6784
6854
  hiddenHomeLeftNavItems: string[];
6785
6855
  customVariablesForThirdPartyTools: Record<string, any>;
6856
+ hiddenListColumns: ListPageColumns[];
6786
6857
  }
6787
6858
 
6788
6859
  export type EmbedEventHandlers = {
@@ -6922,7 +6993,7 @@ export declare class ConversationEmbed extends TsEmbed {
6922
6993
  * @summary ThoughtSpot Visual Embed SDK
6923
6994
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
6924
6995
  */
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, };
6996
+ 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
6997
 
6927
6998
  /**
6928
6999
  * Copyright (c) 2022
@@ -8028,6 +8099,18 @@ export interface BodylessConversationViewConfig extends ViewConfig {
8028
8099
  */
8029
8100
  worksheetId: string;
8030
8101
  }
8102
+ interface ConversationMessageViewConfig extends BodylessConversationViewConfig {
8103
+ sessionId: string;
8104
+ genNo: number;
8105
+ acSessionId: string;
8106
+ acGenNo: number;
8107
+ }
8108
+ declare class ConversationMessage extends TsEmbed {
8109
+ protected viewConfig: ConversationMessageViewConfig;
8110
+ constructor(container: HTMLElement, viewConfig: ConversationMessageViewConfig);
8111
+ getIframeSrc(): string;
8112
+ render(): Promise<ConversationMessage>;
8113
+ }
8031
8114
  /**
8032
8115
  * Create a conversation embed, which can be integrated inside
8033
8116
  * chatbots or other conversational interfaces.
@@ -8052,11 +8135,14 @@ export declare class BodylessConversation {
8052
8135
  sendMessage(userMessage: string): Promise<{
8053
8136
  error: any;
8054
8137
  container?: undefined;
8138
+ viz?: undefined;
8055
8139
  } | {
8056
8140
  container: HTMLDivElement;
8141
+ viz: ConversationMessage;
8057
8142
  error?: undefined;
8058
8143
  }>;
8059
8144
  }
8145
+ export {};
8060
8146
 
8061
8147
  export type SessionInfo = {
8062
8148
  releaseVersion: string;