@thoughtspot/visual-embed-sdk 1.17.0-alpha.1 → 1.17.0-alpha.3

package/src/types.ts

@@ -17,23 +17,52 @@ export enum AuthType {
      * No authentication on the SDK. Passthrough to the embedded App. Alias for `Passthrough`.
      */
     None = 'None',
+    /**
+     * Passthrough SSO to the embedded App within the iframe. Requires least configuration, but may not
+     * be supported by all IDPs. This will behave like `None` if SSO is not configured on ThoughtSpot.
+     * @version: SDK: 1.15.0 | ThouhgtSpot: 8.8.0.cl
+     */
+    EmbeddedSSO = 'EmbeddedSSO',
     /**
      * SSO using SAML
-     * @deprecated Use {@link SAML} instead
+     * @deprecated Use {@link SAMLRedirect} instead
+     * @hidden
      */
     SSO = 'SSO_SAML',
     /**
      * SSO using SAML
+     * @deprecated Use {@link SAMLRedirect} instead
+     * @hidden
      */
     SAML = 'SSO_SAML',
+    /**
+     * SSO using SAML
+     * Will make the host application redirect to the SAML Idp.
+     */
+    SAMLRedirect = 'SSO_SAML',
     /**
      * SSO using OIDC
+     * @hidden
+     * @deprecated Use {@link OIDCRedirect} instead
      */
     OIDC = 'SSO_OIDC',
+    /**
+     * SSO using OIDC
+     * Will make the host application redirect to the OIDC Idp.
+     */
+    OIDCRedirect = 'SSO_OIDC',
     /**
      * Trusted authentication server
+     * @hidden
+     * @deprecated Use {@link TrustedAuth} instead
      */
     AuthServer = 'AuthServer',
+    /**
+     * Trusted authentication server, Use you own authentication server
+     * which returns a bearer token, generated using the secret_key obtained from
+     * ThoughtSpot.
+     */
+    TrustedAuthToken = 'AuthServer',
     /**
      * Use the ThoughtSpot login API to authenticate to the cluster directly.
      *
@@ -216,6 +245,20 @@ export interface EmbedConfig {
      * @version SDK: 1.17.0 | ThoughtSpot: 8.9.0.cl
      */
     customisations?: CustomisationsInterface;
+    /**
+     * For noRedirect SSO Auth, we need a button which the user
+     * click to trigger the flow. This is the containing element
+     * for that button.
+     *
+     * @version SDK: 1.17.0 | ThoughtSpot: *
+     */
+    authTriggerContainer?: string | HTMLElement;
+    /**
+     * Text to show in the button which triggers the popup auth flow.
+     * Default: "Authorize".
+     * @version SDK: 1.17.0 | ThoughtSpot: *
+     */
+    authTriggerText?: string;
 }
 
 /**
@@ -663,16 +706,25 @@ export enum EmbedEvent {
 export enum HostEvent {
     /**
      * Trigger a search
-     * @param dataSourceIds - The list of data source GUIDs
-     * @param searchQuery - The search query
+     * @param - dataSourceIds - The list of data source GUIDs
+     * @param - searchQuery - The search query
+     * @example
+     * searchEmbed.trigger(HostEvent.Search, {
+     * searchQuery: "[sales] by [item type],
+     * "dataSourceIds: ["cd252e5c-b552-49a8-821d-3eadaa049cca"]
+     * })
      */
     Search = 'search',
     /**
      * Trigger a drill on certain points by certain column
-     * @param points - an object containing selectedPoints/clickedPoints
+     * @param - points - an object containing selectedPoints/clickedPoints
      *              eg. { selectedPoints: []}
-     * @param columnGuid - a string guid of the column to drill by. This is optional,
+     * @param - columnGuid - a string guid of the column to drill by. This is optional,
      *                     if not provided it will auto drill by the configured column.
+     * @example searchEmbed.trigger(HostEvent.DrillDown, {
+     * points: clickedPointData,
+     * autoDrillDown: true,
+     * })
      * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
      */
     DrillDown = 'triggerDrillDown',
@@ -690,6 +742,8 @@ export enum HostEvent {
      * Set the visible visualizations on a Liveboard.
      * @param - an array of ids of visualizations to show, the ids not passed
      *          will be hidden.
+     * @example
+     * liveboardEmbed.trigger(HostEvent.SetVisibleVizs, ['730496d6-6903-4601-937e-2c691821af3c', 'd547ec54-2a37-4516-a222-2b06719af726'])
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     SetVisibleVizs = 'SetPinboardVisibleVizs',
@@ -697,18 +751,25 @@ export enum HostEvent {
      * Update the runtime filters. The runtime filters passed here are extended
      * on to the existing runtime filters if they exist.
      * @param - {@link RuntimeFilter}[] an array of {@link RuntimeFilter} Types.
+     * @example
+     * liveboardEmbed.trigger(HostEvent.UpdateRuntimeFilters, [
+     * {columnName: "state",operator: "EQ",values: ["michigan"]},
+     * {columnName: "item type",operator: "EQ",values: ["Jackets"]}
+     * ])
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     UpdateRuntimeFilters = 'UpdateRuntimeFilters',
     /**
      * Navigate to a specific page in App embed without any reload.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`
-     * @param path - the path to navigate to (can be a number[1/-1] to go forward/back)
+     * @param - path - the path to navigate to (can be a number[1/-1] to go forward/back)
+     * @example appEmbed.navigateToPage(-1)
      * @version SDK: 1.12.0 | ThoughtSpot 8.4.0.cl, 8.4.1-sw
      */
     Navigate = 'Navigate',
     /**
      * Gets the current pinboard content.
+     * @example liveboardEmbed.trigger(HostEvent.getExportRequestForCurrentPinboard)
      * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
      */
     getExportRequestForCurrentPinboard = 'getExportRequestForCurrentPinboard',
@@ -716,70 +777,82 @@ export enum HostEvent {
      * Triggers the Pin action on an embedded object
      * @param - incase of Liveboard embed, takes in an object with vizId as a key
      * can be left empty for search and visualization embeds
+     * @example liveboardEmbed.trigger(HostEvent.Pin, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Pin = 'pin',
     /**
      * Triggers the Show Liveboard details action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.LiveboardInfo)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     LiveboardInfo = 'pinboardInfo',
     /**
      * Triggers the Schedule action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.Schedule)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Schedule = 'subscription',
     /**
      * Triggers the Manage schedule action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.ScheduleList)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     SchedulesList = 'schedule-list',
     /**
      * Triggers the Export TML action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.ExportTML)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     ExportTML = 'exportTSL',
     /**
      * Triggers the Edit TML action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.EditTML)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     EditTML = 'editTSL',
     /**
      * Triggers the Update TML action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.UpdateTML)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     UpdateTML = 'updateTSL',
     /**
      * Triggers the Download PDF action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.DownloadAsPDF)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     DownloadAsPdf = 'downloadAsPdf',
     /**
      * Triggers the Make a copy action on a Liveboard
+     * @example liveboardEmbed.trigger(HostEvent.MakeACopy)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     MakeACopy = 'makeACopy',
     /**
      * Triggers the Delete action on a Liveboard
+     * @example appEmbed.trigger(HostEvent.Remove)
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Remove = 'delete',
     /**
      * Triggers the Explore action on a visualization
      * @param - an object with vizId as a key
-     * eg: {vizId: '730496d6-6903-4601-937e-2c691821af3c'}
+     * @example liveboardEmbed.trigger(HostEvent.Explore, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     Explore = 'explore',
     /**
      * Triggers the Create alert action on a visualization
      * @param - an object with vizId as a key
+     * @example liveboardEmbed.trigger(HostEvent.CreateMonitor {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     CreateMonitor = 'createMonitor',
     /**
      * Triggers the Manage alert action on a visualization
      * @param - an object with vizId as a key
+     * @example liveboardEmbed.trigger(HostEvent.ManageMonitor, {vizId: '730496d6-6903-4601-937e-2c691821af3c'})
      * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
      */
     ManageMonitor = 'manageMonitor',
@@ -815,9 +888,26 @@ export enum HostEvent {
     Present = 'present',
     /**
      * Get TML for the current search.
+     * @example searchEmbed.trigger(HostEvent.GetTML)
      * @version SDK: 1.18.0 | ThoughtSpot: 8.10.0.cl
      */
     GetTML = 'getTML',
+    /**
+     * Triggers the Share action on a liveboard or answer
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Share)
+     * searchEmbed.trigger(HostEvent.Share)
+     * @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
+     */
+    Share = 'share',
+    /**
+     * Trigger the Save action on a liveboard or answer
+     * @example
+     * liveboardEmbed.trigger(HostEvent.Save)
+     * searchEmbed.trigger(HostEvent.Save)
+     * @version SDK: 1.18.0 | Thoughtspot: 9.0.0.cl
+     */
+    Save = 'save',
 }
 
 /**
@@ -878,6 +968,9 @@ export enum Param {
     ShowAlerts = 'showAlerts',
     Locale = 'locale',
     CustomStyle = 'customStyle',
+    ForceSAMLAutoRedirect = 'forceSAMLAutoRedirect',
+    // eslint-disable-next-line @typescript-eslint/no-shadow
+    AuthType = 'authType',
 }
 
 /**

package/src/utils.ts

@@ -12,6 +12,7 @@ import {
     QueryParams,
     RuntimeFilter,
     CustomisationsInterface,
+    DOMSelector,
 } from './types';
 
 /**
@@ -187,3 +188,14 @@ export const getCustomisations = (
         customisations.style.customCSSUrl || customCssUrl;
     return customisations;
 };
+
+/**
+ * Gets a reference to the DOM node given
+ * a selector.
+ * @param domSelector
+ */
+export function getDOMNode(domSelector: DOMSelector): HTMLElement {
+    return typeof domSelector === 'string'
+        ? document.querySelector(domSelector)
+        : domSelector;
+}