@thoughtspot/visual-embed-sdk 1.14.0-alpha.0 → 1.15.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/CHANGELOG.md +5 -2
  2. package/dist/src/embed/app.d.ts +4 -3
  3. package/dist/src/embed/base.d.ts +1 -1
  4. package/dist/src/embed/liveboard.d.ts +6 -8
  5. package/dist/src/embed/pinboard.d.ts +91 -0
  6. package/dist/src/embed/search.d.ts +1 -1
  7. package/dist/src/embed/ts-embed.d.ts +4 -4
  8. package/dist/src/types.d.ts +79 -76
  9. package/dist/src/utils/authService.d.ts +1 -0
  10. package/dist/src/utils/plugin.d.ts +0 -0
  11. package/dist/src/v1/api.d.ts +19 -0
  12. package/dist/tsembed.es.js +99 -76
  13. package/dist/tsembed.js +99 -76
  14. package/lib/package.json +1 -1
  15. package/lib/src/auth.js +8 -2
  16. package/lib/src/auth.js.map +1 -1
  17. package/lib/src/auth.spec.js +18 -0
  18. package/lib/src/auth.spec.js.map +1 -1
  19. package/lib/src/embed/app.d.ts +4 -3
  20. package/lib/src/embed/app.js +2 -1
  21. package/lib/src/embed/app.js.map +1 -1
  22. package/lib/src/embed/base.d.ts +1 -1
  23. package/lib/src/embed/base.js +1 -1
  24. package/lib/src/embed/liveboard.d.ts +6 -8
  25. package/lib/src/embed/liveboard.js.map +1 -1
  26. package/lib/src/embed/pinboard.d.ts +91 -0
  27. package/lib/src/embed/pinboard.js +110 -0
  28. package/lib/src/embed/pinboard.js.map +1 -0
  29. package/lib/src/embed/search.d.ts +1 -1
  30. package/lib/src/embed/ts-embed.d.ts +4 -4
  31. package/lib/src/types.d.ts +79 -76
  32. package/lib/src/types.js +69 -68
  33. package/lib/src/types.js.map +1 -1
  34. package/lib/src/utils/authService.d.ts +1 -0
  35. package/lib/src/utils/authService.js +13 -0
  36. package/lib/src/utils/authService.js.map +1 -1
  37. package/lib/src/utils/authService.spec.js +15 -1
  38. package/lib/src/utils/authService.spec.js.map +1 -1
  39. package/lib/src/utils/plugin.d.ts +0 -0
  40. package/lib/src/utils/plugin.js +1 -0
  41. package/lib/src/utils/plugin.js.map +1 -0
  42. package/lib/src/utils/processData.js +7 -5
  43. package/lib/src/utils/processData.js.map +1 -1
  44. package/lib/src/utils/processData.spec.js +14 -0
  45. package/lib/src/utils/processData.spec.js.map +1 -1
  46. package/lib/src/visual-embed-sdk.d.ts +95 -93
  47. package/package.json +2 -2
  48. package/src/auth.spec.ts +39 -0
  49. package/src/auth.ts +11 -5
  50. package/src/embed/app.ts +4 -3
  51. package/src/embed/base.ts +1 -1
  52. package/src/embed/liveboard.ts +6 -8
  53. package/src/embed/search.ts +1 -1
  54. package/src/embed/ts-embed.ts +4 -4
  55. package/src/types.ts +79 -76
  56. package/src/utils/authService.spec.ts +21 -0
  57. package/src/utils/authService.ts +20 -0
  58. package/src/utils/processData.spec.ts +17 -0
  59. package/src/utils/processData.ts +7 -5
@@ -12,7 +12,7 @@
12
12
  */
13
13
  export declare enum AuthType {
14
14
  /**
15
- * No authentication. Use this only for testing purposes.
15
+ * No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
16
16
  */
17
17
  None = "None",
18
18
  /**
@@ -121,7 +121,7 @@ export interface EmbedConfig {
121
121
  * terminated.
122
122
  *
123
123
  * Eg: "/dashboard", "#/foo" [Do not include the host]
124
- * @version SDK: 1.10.2 | ThoughtSpot: *
124
+ * @version SDK: 1.10.2 | 8.2.0.cl, 8.4.1-sw
125
125
  */
126
126
  redirectPath?: string;
127
127
  /** @internal */
@@ -149,13 +149,13 @@ export interface EmbedConfig {
149
149
  /**
150
150
  * Disable redirection to the login page when the embedded session expires
151
151
  * This flag is typically used alongside the combination of auth modes such as {@link AuthType.AuthServer} and auto login behavior {@link EmbedConfig.autoLogin}
152
- * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl
152
+ * @version SDK: 1.9.3 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
153
153
  * @default false
154
154
  */
155
155
  disableLoginRedirect?: boolean;
156
156
  /**
157
157
  * This message is displayed on the embed view when the login fails.
158
- * @version 1.10.1 | ThoughtSpot: *
158
+ * @version SDK: 1.10.1 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
159
159
  */
160
160
  loginFailedMessage?: string;
161
161
  /**
@@ -167,14 +167,14 @@ export interface EmbedConfig {
167
167
  * When there are multiple embeds, queue the render of embed to start
168
168
  * after the previous embed's render is complete. This helps in the load performance
169
169
  * by decreasing the load on the browser.
170
- * @version 1.5.0 or later
170
+ * @Version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
171
171
  * @default false
172
172
  */
173
173
  queueMultiRenders?: boolean;
174
174
  /**
175
175
  * Dynamic CSS Url to be injected in the loaded application.
176
176
  * You would also need to set `style-src` in the CSP settings.
177
- * @version 1.6.0 or later
177
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
178
178
  * @default ''
179
179
  */
180
180
  customCssUrl?: string;
@@ -183,17 +183,19 @@ export interface EmbedConfig {
183
183
  * and should be avoided. Listen to the NO_COOKIE_ACCESS event to handle the situation.
184
184
  *
185
185
  * This is slightly slower than letting the browser handle the cookie check, as it involves an extra network call.
186
- * @version SDK: 1.10.4 | ThoughtSpot: *
186
+ * @version SDK: 1.10.4 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
187
187
  */
188
188
  detectCookieAccessSlow?: boolean;
189
189
  /**
190
190
  * Hide beta alert warning message for SearchEmbed.
191
191
  *
192
- * @version SDK: 1.12.0 | ThoughtSpot: *
192
+ * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1-sw*
193
193
  */
194
194
  suppressSearchEmbedBetaWarning?: boolean;
195
195
  /**
196
- * Custom style params for embed Config
196
+ * Custom style params for embed Config.
197
+ *
198
+ * @version SDK: 1.16.0 | ThoughtSpot: 8.8.0.cl, 8.8.1-sw
197
199
  */
198
200
  customisations?: CustomisationsInterface;
199
201
  }
@@ -354,7 +356,7 @@ export declare enum EmbedEvent {
354
356
  /**
355
357
  * One or more data columns have been selected.
356
358
  * @return columnIds - the list of columns
357
- * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl
359
+ * @version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
358
360
  */
359
361
  AddRemoveColumns = "addRemoveColumns",
360
362
  /**
@@ -366,13 +368,13 @@ export declare enum EmbedEvent {
366
368
  /**
367
369
  * A double click has been triggered on table/chart
368
370
  * @return ContextMenuInputPoints - data point that is double clicked
369
- * @version 1.5.0 or later
371
+ * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
370
372
  */
371
373
  VizPointDoubleClick = "vizPointDoubleClick",
372
374
  /**
373
375
  * A click has been triggered on table/chart
374
376
  * @return ContextMenuInputPoints - data point that is clicked
375
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
377
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
376
378
  */
377
379
  VizPointClick = "vizPointClick",
378
380
  /**
@@ -424,7 +426,7 @@ export declare enum EmbedEvent {
424
426
  * Emitted when the embed does not have cookie access. This
425
427
  * happens on Safari where third-party cookies are blocked by default.
426
428
  *
427
- * @version 1.1.0 or later
429
+ * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
428
430
  */
429
431
  NoCookieAccess = "noCookieAccess",
430
432
  /**
@@ -435,179 +437,180 @@ export declare enum EmbedEvent {
435
437
  SAMLComplete = "samlComplete",
436
438
  /**
437
439
  * Emitted when any modal is opened in the app
438
- * @version 1.6.0 or later
440
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
439
441
  */
440
442
  DialogOpen = "dialog-open",
441
443
  /**
442
444
  * Emitted when any modal is closed in the app
443
- * @version 1.6.0 or later
445
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
444
446
  */
445
447
  DialogClose = "dialog-close",
446
448
  /**
447
449
  * Emitted when a liveboard has completed rendering,
448
450
  * this event can be used as a hook to trigger events on the
449
451
  * rendered liveboard
450
- * @version 1.9.1 or later
452
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
451
453
  */
452
454
  LiveboardRendered = "PinboardRendered",
453
455
  /**
454
456
  * This can be used to register an event listener which
455
457
  * is triggered on all events.
456
- * @version SDK: 1.10.0 | ThoughtSpot: any
458
+ * @Version SDK: 1.10.0 | ThoughtSpot: 8.2.0.cl, 8.4.1-sw
457
459
  */
458
460
  ALL = "*",
459
461
  /**
460
462
  * Emitted when answer is saved in the app
461
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
463
+ * @Version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
462
464
  */
463
465
  Save = "save",
464
466
  /**
465
467
  * Emitted when the download action is triggered on an answer
466
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
468
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
467
469
  */
468
470
  Download = "download",
469
471
  /**
470
472
  * Emitted when the Download as PDF action is triggered on an answer
471
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
473
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
472
474
  */
473
475
  DownloadAsPdf = "downloadAsPdf",
474
476
  /**
475
477
  * Emitted when the Download as CSV action is triggered on an answer
476
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
478
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
477
479
  */
478
480
  DownloadAsCsv = "downloadAsCsv",
479
481
  /**
480
482
  * Emitted when the Download as XLSX action is triggered on an answer
481
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
483
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
482
484
  */
483
485
  DownloadAsXlsx = "downloadAsXlsx",
484
486
  /**
485
487
  * Emitted when an answer is deleted in the app
486
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
488
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
487
489
  */
488
490
  AnswerDelete = "answerDelete",
489
491
  /**
490
492
  * Emitted when an answer is pinned to a Liveboard
491
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
493
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
492
494
  */
493
495
  Pin = "pin",
494
496
  /**
495
497
  * Emitted when SpotIQ analysis is triggered
496
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
498
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
497
499
  */
498
500
  SpotIQAnalyze = "spotIQAnalyze",
499
501
  /**
500
502
  * Emitted when a user shares an object with another user or group
501
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
503
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
502
504
  */
503
505
  Share = "share",
504
506
  /**
505
507
  * Emitted when a user clicks the Include action to include a specific value or data on a chart or table
506
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
508
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
507
509
  */
508
510
  DrillInclude = "context-menu-item-include",
509
511
  /**
510
512
  * Emitted when a user clicks the Exclude action to exclude a specific value or data on a chart or table
511
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
513
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
512
514
  */
513
515
  DrillExclude = "context-menu-item-exclude",
514
516
  /**
515
517
  * Emitted when copied column value on the app
516
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
518
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
517
519
  */
518
520
  CopyToClipboard = "context-menu-item-copy-to-clipboard",
519
521
  /**
520
522
  * Emitted when a user clicks the Update TML action
521
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
523
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
522
524
  */
523
525
  UpdateTML = "updateTSL",
524
526
  /**
525
527
  * Emitted when a user clicks the Edit TML action
526
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
528
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
527
529
  */
528
530
  EditTML = "editTSL",
529
531
  /**
530
532
  * Emitted when ExportTML trigger in answer on the app
531
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
533
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
532
534
  */
533
535
  ExportTML = "exportTSL",
534
536
  /**
535
537
  * Emitted when an answer is saved as a view
536
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
538
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
537
539
  */
538
540
  SaveAsView = "saveAsView",
539
541
  /**
540
542
  * Emitted when copy of existing answer on the app
541
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
543
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
542
544
  */
543
545
  CopyAEdit = "copyAEdit",
544
546
  /**
545
547
  * Emitted when a user clicks Show underlying data on an answe
546
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
548
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
547
549
  */
548
550
  ShowUnderlyingData = "showUnderlyingData",
549
551
  /**
550
552
  * Emitted when an answer is switched to a chart or table view
551
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
553
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
552
554
  */
553
555
  AnswerChartSwitcher = "answerChartSwitcher",
554
556
  /**
555
- *
557
+ * Internal event to communicate the initial settings back to the TS APP
558
+ * @hidden
556
559
  */
557
560
  APP_INIT = "appInit",
558
561
  /**
559
562
  * Emitted when a user clicks Show Liveboard details on a Liveboard
560
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
563
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
561
564
  */
562
565
  LiveboardInfo = "pinboardInfo",
563
566
  /**
564
567
  * Emitted when a user clicks on the Favorite icon on a Liveboard
565
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
568
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
566
569
  */
567
570
  AddToFavorites = "addToFavorites",
568
571
  /**
569
572
  * Emitted when a user clicks Schedule on a Liveboard
570
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
573
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
571
574
  */
572
575
  Schedule = "subscription",
573
576
  /**
574
577
  * Emitted when a user clicks Edit on a Liveboard or visualization
575
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
578
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
576
579
  */
577
580
  Edit = "edit",
578
581
  /**
579
582
  * Emitted when a user clicks Make a copy on a Liveboard
580
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
583
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
581
584
  */
582
585
  MakeACopy = "makeACopy",
583
586
  /**
584
587
  * Emitted when a user clicks Present on a Liveboard or visualization
585
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
588
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
586
589
  */
587
590
  Present = "present",
588
591
  /**
589
592
  * Emitted when a user clicks Delete on a Liveboard
590
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
593
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
591
594
  */
592
595
  Delete = "delete",
593
596
  /**
594
597
  * Emitted when a user clicks Manage schedules on a Liveboard
595
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
598
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
596
599
  */
597
600
  SchedulesList = "schedule-list",
598
601
  /**
599
602
  * Emitted when a user clicks Cancel in edit mode on a Liveboard
600
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
603
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
601
604
  */
602
605
  Cancel = "cancel",
603
606
  /**
604
607
  * Emitted when a user clicks Explore on a visualization
605
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
608
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
606
609
  */
607
610
  Explore = "explore",
608
611
  /**
609
612
  * Emitted when a user clicks Copy link action on a visualization
610
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
613
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
611
614
  */
612
615
  CopyLink = "embedDocument"
613
616
  }
@@ -630,8 +633,8 @@ export declare enum HostEvent {
630
633
  * @param points - an object containing selectedPoints/clickedPoints
631
634
  * eg. { selectedPoints: []}
632
635
  * @param columnGuid - a string guid of the column to drill by. This is optional,
633
- * if not provided it will auto drill by the configured column. \
634
- * @version 1.5.0 or later
636
+ * if not provided it will auto drill by the configured column.
637
+ * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
635
638
  */
636
639
  DrillDown = "triggerDrillDown",
637
640
  /**
@@ -648,97 +651,97 @@ export declare enum HostEvent {
648
651
  * Set the visible visualizations on a Liveboard.
649
652
  * @param - an array of ids of visualizations to show, the ids not passed
650
653
  * will be hidden.
651
- * @version 1.6.0 or later
654
+ * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
652
655
  */
653
656
  SetVisibleVizs = "SetPinboardVisibleVizs",
654
657
  /**
655
658
  * Update the runtime filters. The runtime filters passed here are extended
656
659
  * on to the existing runtime filters if they exist.
657
660
  * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
658
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
661
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
659
662
  */
660
663
  UpdateRuntimeFilters = "UpdateRuntimeFilters",
661
664
  /**
662
665
  * Navigate to a specific page in App embed without any reload.
663
666
  * This is the same as calling `appEmbed.navigateToPage(path, true)`
664
667
  * @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
665
- * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl
668
+ * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
666
669
  */
667
670
  Navigate = "Navigate",
668
671
  /**
669
672
  * Gets the current pinboard content.
670
- * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl
673
+ * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
671
674
  */
672
675
  getExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard",
673
676
  /**
674
677
  * Triggers the Pin action on an embedded object
675
678
  * @param - incase of Liveboard embed, takes in an object with vizId as a key
676
679
  * can be left empty for search and visualization embeds
677
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
680
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
678
681
  */
679
682
  Pin = "pin",
680
683
  /**
681
684
  * Triggers the Show Liveboard details action on a Liveboard
682
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
685
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
683
686
  */
684
687
  LiveboardInfo = "pinboardInfo",
685
688
  /**
686
689
  * Triggers the Schedule action on a Liveboard
687
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
690
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
688
691
  */
689
692
  Schedule = "subscription",
690
693
  /**
691
694
  * Triggers the Manage schedule action on a Liveboard
692
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
695
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
693
696
  */
694
697
  SchedulesList = "schedule-list",
695
698
  /**
696
699
  * Triggers the Export TML action on a Liveboard
697
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
700
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
698
701
  */
699
702
  ExportTML = "exportTSL",
700
703
  /**
701
704
  * Triggers the Edit TML action on a Liveboard
702
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
705
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
703
706
  */
704
707
  EditTML = "editTSL",
705
708
  /**
706
709
  * Triggers the Update TML action on a Liveboard
707
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
710
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
708
711
  */
709
712
  UpdateTML = "updateTSL",
710
713
  /**
711
714
  * Triggers the Download PDF action on a Liveboard
712
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
715
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
713
716
  */
714
717
  DownloadAsPdf = "downloadAsPdf",
715
718
  /**
716
719
  * Triggers the Make a copy action on a Liveboard
717
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
720
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
718
721
  */
719
722
  MakeACopy = "makeACopy",
720
723
  /**
721
724
  * Triggers the Delete action on a Liveboard
722
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
725
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
723
726
  */
724
727
  Remove = "delete",
725
728
  /**
726
729
  * Triggers the Explore action on a visualization
727
730
  * @param - an object with vizId as a key
728
731
  * eg: {vizId: '730496d6-6903-4601-937e-2c691821af3c'}
729
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
732
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
730
733
  */
731
734
  Explore = "explore",
732
735
  /**
733
736
  * Triggers the Create alert action on a visualization
734
737
  * @param - an object with vizId as a key
735
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
738
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
736
739
  */
737
740
  CreateMonitor = "createMonitor",
738
741
  /**
739
742
  * Triggers the Manage alert action on a visualization
740
743
  * @param - an object with vizId as a key
741
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
744
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
742
745
  */
743
746
  ManageMonitor = "manageMonitor",
744
747
  /**
@@ -748,7 +751,7 @@ export declare enum HostEvent {
748
751
  * liveboardEmbed.trigger(HostEvent.Edit)
749
752
  * liveboardEmbed.trigger(HostEvent.Edit, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
750
753
  * vizEmbed.trigger((HostEvent.Edit)
751
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
754
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
752
755
  */
753
756
  Edit = "edit",
754
757
  /**
@@ -758,7 +761,7 @@ export declare enum HostEvent {
758
761
  * liveboardEmbed.trigger(HostEvent.CopyLink)
759
762
  * liveboardEmbed.trigger(HostEvent.CopyLink, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
760
763
  * vizEmbed.trigger((HostEvent.CopyLink)
761
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
764
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
762
765
  */
763
766
  CopyLink = "embedDocument",
764
767
  /**
@@ -768,7 +771,7 @@ export declare enum HostEvent {
768
771
  * liveboardEmbed.trigger(HostEvent.Present)
769
772
  * liveboardEmbed.trigger(HostEvent.Present, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
770
773
  * vizEmbed.trigger((HostEvent.Present)
771
- * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl
774
+ * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
772
775
  */
773
776
  Present = "present"
774
777
  }
@@ -948,27 +951,27 @@ export declare enum Action {
948
951
  RequestAccess = "requestAccess",
949
952
  QueryDetailsButtons = "queryDetailsButtons",
950
953
  /**
951
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
954
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
952
955
  */
953
956
  AnswerDelete = "onDeleteAnswer",
954
957
  /**
955
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
958
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
956
959
  */
957
960
  AnswerChartSwitcher = "answerChartSwitcher",
958
961
  /**
959
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
962
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
960
963
  */
961
964
  AddToFavorites = "addToFavorites",
962
965
  /**
963
- * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl
966
+ * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
964
967
  */
965
968
  EditDetails = "editDetails",
966
969
  /**
967
- * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl
970
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
968
971
  */
969
972
  CreateMonitor = "createMonitor",
970
973
  /**
971
- * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl
974
+ * @version SDK: 1.11.1 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
972
975
  */
973
976
  ReportError = "reportError"
974
977
  }
@@ -1,5 +1,6 @@
1
1
  export declare function fetchSessionInfoService(authVerificationUrl: string): Promise<any>;
2
2
  export declare function fetchAuthTokenService(authEndpoint: string): Promise<any>;
3
3
  export declare function fetchAuthService(thoughtSpotHost: string, username: string, authToken: string): Promise<any>;
4
+ export declare function fetchAuthPostService(thoughtSpotHost: string, username: string, authToken: string): Promise<any>;
4
5
  export declare function fetchBasicAuthService(thoughtSpotHost: string, username: string, password: string): Promise<any>;
5
6
  export declare function fetchLogoutService(thoughtSpotHost: string): Promise<any>;
File without changes
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Copyright: ThoughtSpot Inc. 2012-2016
3
+ * Author: Shashank Singh (sunny@thoughtspot.com)
4
+ *
5
+ * @fileoverview ThoughtSpot Javascript API for use of ThoughtSpot in external webpages.
6
+ */
7
+ import { AuthType } from '../types';
8
+ export declare enum Events {
9
+ THOUGHTSPOT_AUTH_EXPIRED = "ThoughtspotAuthExpired",
10
+ EXPORT_VIZ_DATA_TO_PARENT = "exportVizDataToParent",
11
+ ALERT = "alert",
12
+ EXPORT_VIZ_DATA_TO_CHILD = "exportVizDataToChild",
13
+ GET_DATA = "getData"
14
+ }
15
+ declare type Callback = (...args: any[]) => void;
16
+ declare function checkIfLoggedIn(tsHost: string, callback: Callback): void;
17
+ declare function initialize(onInitialized: Callback, onAuthExpiration: Callback, _thoughtspotHost: string, authType: AuthType): void;
18
+ declare function notifyOnAuthExpiration(): void;
19
+ export { initialize, checkIfLoggedIn, notifyOnAuthExpiration };