@thoughtspot/visual-embed-sdk 1.36.8 → 1.36.9-primary-actions

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