@thoughtspot/visual-embed-sdk 1.32.6 → 1.32.8

package/lib/src/visual-embed-sdk.d.ts

@@ -587,21 +587,22 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
     /**
         * Imports TML representation of the metadata objects into ThoughtSpot.
         * @param data
+        * @returns imports TML data into ThoughtSpot
         * @example
         * ```js
-        *   executeTML({
-        * //Array of metadata Tmls
-            metadata_tmls: [
-                "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
-                \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
-            ],
-            import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
-            create_new: false, // If selected, creates TML objects with new GUIDs.
-        }).then(result => {
-            console.log(result);
-        }).catch(error => {
-            console.error(error);
-        });
+        *  executeTML({
+        * //Array of metadata Tmls in string format
+        *      metadata_tmls: [
+        *          "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
+        *          \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
+        *      ],
+        *      import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
+        *      create_new: false, // If selected, creates TML objects with new GUIDs.
+        *  }).then(result => {
+        *      console.log(result);
+        *  }).catch(error => {
+        *      console.error(error);
+        *  });
         *```
         * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
         * @group Global methods
@@ -611,27 +612,28 @@ declare module '@thoughtspot/visual-embed-sdk/embed/base' {
         * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
         * format.
         * @param data
+        * @returns exports TML data
         * @example
         * ```js
-        exportTML({
-            metadata: [
-                {
-                    type: "LIVEBOARD", //Metadata Type
-                    identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
-                }
-            ],
-            export_associated: false,//indicates whether to export associated metadata objects
-            export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
-                                                 //exporting a Liveboard and its associated objects, the API
-                                                 //returns the Liveboard TML data with the FQNs of the referenced
-                                                 //worksheet. If the exported TML data includes FQNs, you don't need
-                                                 //to manually add FQNs of the referenced objects during TML import.
-            edoc_format: "JSON" //It takes JSON or YAML value
-        }).then(result => {
-            console.log(result);
-        }).catch(error => {
-            console.error(error);
-        });
+        * exportTML({
+        *   metadata: [
+        *     {
+        *       type: "LIVEBOARD", //Metadata Type
+        *       identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
+        *     }
+        *   ],
+        *   export_associated: false,//indicates whether to export associated metadata objects
+        *   export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
+        *                      //exporting a Liveboard and its associated objects, the API
+        *                      //returns the Liveboard TML data with the FQNs of the referenced
+        *                      //worksheet. If the exported TML data includes FQNs, you don't need
+        *                      //to manually add FQNs of the referenced objects during TML import.
+        *   edoc_format: "JSON" //It takes JSON or YAML value
+        * }).then(result => {
+        *   console.log(result);
+        * }).catch(error => {
+        *   console.error(error);
+        * });
         * ```
         * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
         * @group Global methods
@@ -3716,15 +3718,20 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
                 * for this embed event to get emitted.
                 *
-                * Parameter: payload
-                * Parameter: responder
+                * @param: payload
+                * @param: responder
                 * Contains elements that lets developers define whether ThoughtSpot
                 * will run the search or not, and if not, which error message to provide.
+                *
                 * execute: When execute returns true, the search will be run.
                 * When execute returns false, the search will not be executed.
+                *
                 * error: Developers can customize the user facing message when execute is
                 * set to false using the error parameter in responder
                 *
+                * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+                *
+                * @example
                 *```js
                 * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
                 * (payload, responder) => {
@@ -3760,8 +3767,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *  }})
                 * })
                 *```
-                *
-                * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
                 */
             OnBeforeGetVizDataIntercept = "onBeforeGetVizDataIntercept",
             /**
@@ -5953,9 +5958,12 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
                 */
             '--ts-var-root-text-transform'?: string;
             /**
-                * application color, it replaces #2770EF which is rd-color(blue,base) and
-                * its similar colors like rd-color(blue,60), rd-color(accent, base) and
-                * rd-color(text, accent) in the app.
+                * Font color of the text on toggle buttons such as
+                * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience),
+                * the text color of the chart and table tiles on Home page (New modular Homepage experience),
+                * and title text on the AI-generated charts and tables.
+                * The default color code is #2770EF.
+                *
                 */
             '--ts-var-application-color'?: string;
             /**
@@ -6066,6 +6074,10 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
                 * Background color of the primary buttons on hover.
                 */
             '--ts-var-button--primary--hover-background'?: string;
+            /**
+                * Backgroud color of the primary buttons when active.
+                */
+            '--ts-var-button--primary--active-background'?: string;
             /**
                 * Font color of the text on the secondary buttons.
                 */
@@ -6082,6 +6094,10 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
                 * Background color of the secondary button on hover.
                 */
             '--ts-var-button--secondary--hover-background'?: string;
+            /**
+                * Backgroud color of the secondary buttons when active.
+                */
+            '--ts-var-button--secondary--active-background'?: string;
             /**
                 * Font color of the tertiary button. For example, the *Undo*, *Redo*, and *Reset*
                 * buttons on the *Search* page.
@@ -6095,6 +6111,10 @@ declare module '@thoughtspot/visual-embed-sdk/css-variables' {
                 * Background color of the tertiary button when a user hovers over these buttons.
                 */
             '--ts-var-button--tertiary--hover-background'?: string;
+            /**
+                * Backgroud color of the tertiary buttons when active.
+                */
+            '--ts-var-button--tertiary--active-background'?: string;
             /**
                 * Font color of the title text of a visualization or Answer.
                 */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.32.6",
+    "version": "1.32.8",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -38,7 +38,7 @@
     "size-limit": [
         {
             "path": "dist/tsembed.js",
-            "limit": "48 kB"
+            "limit": "49 kB"
         }
     ],
     "scripts": {
@@ -77,7 +77,7 @@
         "gatsby-plugin-vercel": "^1.0.3",
         "html-react-parser": "^1.4.12",
         "lodash": "^4.17.21",
-        "mixpanel-browser": "^2.45.0",
+        "mixpanel-browser": "2.47.0",
         "ts-deepmerge": "^6.0.2",
         "tslib": "^2.5.3",
         "use-deep-compare-effect": "^1.8.1"

package/src/css-variables.ts

@@ -24,9 +24,12 @@ export interface CustomCssVariables {
     '--ts-var-root-text-transform'?: string;
 
     /**
-     * application color, it replaces #2770EF which is rd-color(blue,base) and
-     * its similar colors like rd-color(blue,60), rd-color(accent, base) and
-     * rd-color(text, accent) in the app.
+     * Font color of the text on toggle buttons such as
+     * **All**, **Answers**, and **Liveboards** on the Home page (Classic experience),
+     * the text color of the chart and table tiles on Home page (New modular Homepage experience),
+     * and title text on the AI-generated charts and tables.
+     * The default color code is #2770EF.
+     *
      */
     '--ts-var-application-color'?: string;
 
@@ -163,6 +166,11 @@ export interface CustomCssVariables {
      */
     '--ts-var-button--primary--hover-background'?: string;
 
+    /**
+     * Backgroud color of the primary buttons when active.
+     */
+    '--ts-var-button--primary--active-background'?: string;
+
     /**
      * Font color of the text on the secondary buttons.
      */
@@ -183,6 +191,11 @@ export interface CustomCssVariables {
      */
     '--ts-var-button--secondary--hover-background'?: string;
 
+    /**
+     * Backgroud color of the secondary buttons when active.
+     */
+    '--ts-var-button--secondary--active-background'?: string;
+
     /**
      * Font color of the tertiary button. For example, the *Undo*, *Redo*, and *Reset*
      * buttons on the *Search* page.
@@ -199,6 +212,11 @@ export interface CustomCssVariables {
      */
     '--ts-var-button--tertiary--hover-background'?: string;
 
+    /**
+     * Backgroud color of the tertiary buttons when active.
+     */
+    '--ts-var-button--tertiary--active-background'?: string;
+
     /**
      * Font color of the title text of a visualization or Answer.
      */

package/src/embed/base.ts

@@ -259,21 +259,22 @@ export const renderInQueue = (fn: (next?: (val?: any) => void) => Promise<any>):
 /**
  * Imports TML representation of the metadata objects into ThoughtSpot.
  * @param data
+ * @returns imports TML data into ThoughtSpot
  * @example
  * ```js
- *   executeTML({
- * //Array of metadata Tmls
-    metadata_tmls: [
-      "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
-      \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
-    ],
-    import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
-    create_new: false, // If selected, creates TML objects with new GUIDs.
-  }).then(result => {
-    console.log(result);
-  }).catch(error => {
-    console.error(error);
-  });
+ *  executeTML({
+ * //Array of metadata Tmls in string format
+ *      metadata_tmls: [
+ *          "'\''{\"guid\":\"9bd202f5-d431-44bf-9a07-b4f7be372125\",
+ *          \"liveboard\":{\"name\":\"Parameters Liveboard\"}}'\''"
+ *      ],
+ *      import_policy: 'PARTIAL', // Specifies the import policy for the TML import.
+ *      create_new: false, // If selected, creates TML objects with new GUIDs.
+ *  }).then(result => {
+ *      console.log(result);
+ *  }).catch(error => {
+ *      console.error(error);
+ *  });
  *```
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
  * @group Global methods
@@ -319,27 +320,28 @@ export const executeTML = async (data: executeTMLInput): Promise<any> => {
  * Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML
  * format.
  * @param data
+ * @returns exports TML data
  * @example
  * ```js
-  exportTML({
-    metadata: [
-      {
-        type: "LIVEBOARD", //Metadata Type
-        identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
-      }
-    ],
-    export_associated: false,//indicates whether to export associated metadata objects
-    export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
-                       //exporting a Liveboard and its associated objects, the API
-                       //returns the Liveboard TML data with the FQNs of the referenced
-                       //worksheet. If the exported TML data includes FQNs, you don't need
-                       //to manually add FQNs of the referenced objects during TML import.
-    edoc_format: "JSON" //It takes JSON or YAML value
-  }).then(result => {
-    console.log(result);
-  }).catch(error => {
-    console.error(error);
-  });
+ * exportTML({
+ *   metadata: [
+ *     {
+ *       type: "LIVEBOARD", //Metadata Type
+ *       identifier: "9bd202f5-d431-44bf-9a07-b4f7be372125" //Metadata Id
+ *     }
+ *   ],
+ *   export_associated: false,//indicates whether to export associated metadata objects
+ *   export_fqn: false, //Adds FQNs of the referenced objects.For example, if you are
+ *                      //exporting a Liveboard and its associated objects, the API
+ *                      //returns the Liveboard TML data with the FQNs of the referenced
+ *                      //worksheet. If the exported TML data includes FQNs, you don't need
+ *                      //to manually add FQNs of the referenced objects during TML import.
+ *   edoc_format: "JSON" //It takes JSON or YAML value
+ * }).then(result => {
+ *   console.log(result);
+ * }).catch(error => {
+ *   console.error(error);
+ * });
  * ```
  * @version SDK: 1.23.0 | ThoughtSpot: 9.4.0.cl
  * @group Global methods

package/src/tokenizedFetch.ts

@@ -22,7 +22,11 @@ import { AuthType } from './types';
 export const tokenizedFetch: typeof fetch = async (input, init): Promise<Response> => {
     const embedConfig = getEmbedConfig();
     if (embedConfig.authType !== AuthType.TrustedAuthTokenCookieless) {
-        return fetch(input, init);
+        return fetch(input, {
+            // ensure cookies are included for the non cookie-less api calls.
+            credentials: 'include',
+            ...init,
+        });
     }
 
     const req = new Request(input, init);

package/src/types.ts

@@ -2139,15 +2139,20 @@ export enum EmbedEvent {
      * Prerequisite: Set isOnBeforeGetVizDataInterceptEnabled : true
      * for this embed event to get emitted.
      *
-     * Parameter: payload
-     * Parameter: responder
+     * @param: payload
+     * @param: responder
      * Contains elements that lets developers define whether ThoughtSpot
      * will run the search or not, and if not, which error message to provide.
+     *
      * execute: When execute returns true, the search will be run.
      * When execute returns false, the search will not be executed.
+     *
      * error: Developers can customize the user facing message when execute is
      * set to false using the error parameter in responder
      *
+     * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
+     *
+     * @example
      *```js
      * .on(EmbedEvent.OnBeforeGetVizDataIntercept,
      * (payload, responder) => {
@@ -2183,8 +2188,6 @@ export enum EmbedEvent {
      *  }})
      * })
      *```
-     *
-     * @version SDK : 1.29.0 | Thoughtspot : 10.2.0.cl
      */
     OnBeforeGetVizDataIntercept = 'onBeforeGetVizDataIntercept',
     /**

package/src/utils/authService/authService.spec.ts

@@ -29,7 +29,9 @@ describe('Unit test for authService', () => {
         const response = await fetchSessionInfoService(thoughtSpotHost);
         expect(response.success).toBe(true);
         expect(fetch).toHaveBeenCalledTimes(1);
-        expect(fetch).toBeCalledWith(`${thoughtSpotHost}${EndPoints.SESSION_INFO}`, {});
+        expect(fetch).toBeCalledWith(`${thoughtSpotHost}${EndPoints.SESSION_INFO}`, {
+            credentials: 'include',
+        });
     });
 
     test('fetchAuthTokenService', async () => {