npm - @thoughtspot/visual-embed-sdk - Versions diffs - 1.49.1 → 1.49.3 - Mend

@thoughtspot/visual-embed-sdk 1.49.1 → 1.49.3

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 (151) hide show

package/cjs/package.json +4 -10
package/cjs/src/css-variables.d.ts +17 -0
package/cjs/src/css-variables.d.ts.map +1 -1
package/cjs/src/embed/app.d.ts +7 -1
package/cjs/src/embed/app.d.ts.map +1 -1
package/cjs/src/embed/app.js +4 -1
package/cjs/src/embed/app.js.map +1 -1
package/cjs/src/embed/app.spec.js +97 -0
package/cjs/src/embed/app.spec.js.map +1 -1
package/cjs/src/embed/conversation.d.ts +8 -0
package/cjs/src/embed/conversation.d.ts.map +1 -1
package/cjs/src/embed/conversation.js +2 -1
package/cjs/src/embed/conversation.js.map +1 -1
package/cjs/src/embed/conversation.spec.js +12 -0
package/cjs/src/embed/conversation.spec.js.map +1 -1
package/cjs/src/embed/events.spec.js +5 -0
package/cjs/src/embed/events.spec.js.map +1 -1
package/cjs/src/embed/liveboard.d.ts +6 -0
package/cjs/src/embed/liveboard.d.ts.map +1 -1
package/cjs/src/embed/liveboard.js +4 -1
package/cjs/src/embed/liveboard.js.map +1 -1
package/cjs/src/embed/liveboard.spec.js +11 -0
package/cjs/src/embed/liveboard.spec.js.map +1 -1
package/cjs/src/embed/spotter-viz-utils.d.ts +29 -0
package/cjs/src/embed/spotter-viz-utils.d.ts.map +1 -1
package/cjs/src/embed/spotter-viz-utils.js.map +1 -1
package/cjs/src/embed/ts-embed.d.ts +38 -0
package/cjs/src/embed/ts-embed.d.ts.map +1 -1
package/cjs/src/embed/ts-embed.js +166 -9
package/cjs/src/embed/ts-embed.js.map +1 -1
package/cjs/src/embed/ts-embed.spec.js +237 -0
package/cjs/src/embed/ts-embed.spec.js.map +1 -1
package/cjs/src/index.d.ts +2 -2
package/cjs/src/index.d.ts.map +1 -1
package/cjs/src/index.js.map +1 -1
package/cjs/src/types.d.ts +87 -4
package/cjs/src/types.d.ts.map +1 -1
package/cjs/src/types.js +47 -3
package/cjs/src/types.js.map +1 -1
package/cjs/src/utils/graphql/answerService/answerService.spec.js +15 -0
package/cjs/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
package/cjs/src/utils/processTrigger.d.ts.map +1 -1
package/cjs/src/utils/processTrigger.js +6 -5
package/cjs/src/utils/processTrigger.js.map +1 -1
package/cjs/src/utils/processTrigger.spec.js +13 -0
package/cjs/src/utils/processTrigger.spec.js.map +1 -1
package/cjs/src/utils.d.ts +10 -0
package/cjs/src/utils.d.ts.map +1 -1
package/cjs/src/utils.js +25 -4
package/cjs/src/utils.js.map +1 -1
package/cjs/src/utils.spec.js +48 -0
package/cjs/src/utils.spec.js.map +1 -1
package/dist/{index-B6Rn561t.js → index-DsSQndIB.js} +303 -187
package/dist/src/css-variables.d.ts +17 -0
package/dist/src/css-variables.d.ts.map +1 -1
package/dist/src/embed/app.d.ts +7 -1
package/dist/src/embed/app.d.ts.map +1 -1
package/dist/src/embed/conversation.d.ts +8 -0
package/dist/src/embed/conversation.d.ts.map +1 -1
package/dist/src/embed/liveboard.d.ts +6 -0
package/dist/src/embed/liveboard.d.ts.map +1 -1
package/dist/src/embed/spotter-viz-utils.d.ts +29 -0
package/dist/src/embed/spotter-viz-utils.d.ts.map +1 -1
package/dist/src/embed/ts-embed.d.ts +38 -0
package/dist/src/embed/ts-embed.d.ts.map +1 -1
package/dist/src/index.d.ts +2 -2
package/dist/src/index.d.ts.map +1 -1
package/dist/src/types.d.ts +87 -4
package/dist/src/types.d.ts.map +1 -1
package/dist/src/utils/processTrigger.d.ts.map +1 -1
package/dist/src/utils.d.ts +10 -0
package/dist/src/utils.d.ts.map +1 -1
package/dist/tsembed-react.es.js +282 -35
package/dist/tsembed-react.js +583 -220
package/dist/tsembed.es.js +282 -35
package/dist/tsembed.js +583 -220
package/dist/visual-embed-sdk-react-full.d.ts +190 -4
package/dist/visual-embed-sdk-react.d.ts +190 -4
package/dist/visual-embed-sdk.d.ts +190 -4
package/lib/package.json +4 -10
package/lib/src/css-variables.d.ts +17 -0
package/lib/src/css-variables.d.ts.map +1 -1
package/lib/src/embed/app.d.ts +7 -1
package/lib/src/embed/app.d.ts.map +1 -1
package/lib/src/embed/app.js +4 -1
package/lib/src/embed/app.js.map +1 -1
package/lib/src/embed/app.spec.js +97 -0
package/lib/src/embed/app.spec.js.map +1 -1
package/lib/src/embed/conversation.d.ts +8 -0
package/lib/src/embed/conversation.d.ts.map +1 -1
package/lib/src/embed/conversation.js +2 -1
package/lib/src/embed/conversation.js.map +1 -1
package/lib/src/embed/conversation.spec.js +12 -0
package/lib/src/embed/conversation.spec.js.map +1 -1
package/lib/src/embed/events.spec.js +5 -0
package/lib/src/embed/events.spec.js.map +1 -1
package/lib/src/embed/liveboard.d.ts +6 -0
package/lib/src/embed/liveboard.d.ts.map +1 -1
package/lib/src/embed/liveboard.js +4 -1
package/lib/src/embed/liveboard.js.map +1 -1
package/lib/src/embed/liveboard.spec.js +11 -0
package/lib/src/embed/liveboard.spec.js.map +1 -1
package/lib/src/embed/spotter-viz-utils.d.ts +29 -0
package/lib/src/embed/spotter-viz-utils.d.ts.map +1 -1
package/lib/src/embed/spotter-viz-utils.js.map +1 -1
package/lib/src/embed/ts-embed.d.ts +38 -0
package/lib/src/embed/ts-embed.d.ts.map +1 -1
package/lib/src/embed/ts-embed.js +167 -10
package/lib/src/embed/ts-embed.js.map +1 -1
package/lib/src/embed/ts-embed.spec.js +237 -0
package/lib/src/embed/ts-embed.spec.js.map +1 -1
package/lib/src/index.d.ts +2 -2
package/lib/src/index.d.ts.map +1 -1
package/lib/src/index.js.map +1 -1
package/lib/src/types.d.ts +87 -4
package/lib/src/types.d.ts.map +1 -1
package/lib/src/types.js +47 -3
package/lib/src/types.js.map +1 -1
package/lib/src/utils/graphql/answerService/answerService.spec.js +15 -0
package/lib/src/utils/graphql/answerService/answerService.spec.js.map +1 -1
package/lib/src/utils/processTrigger.d.ts.map +1 -1
package/lib/src/utils/processTrigger.js +6 -5
package/lib/src/utils/processTrigger.js.map +1 -1
package/lib/src/utils/processTrigger.spec.js +13 -0
package/lib/src/utils/processTrigger.spec.js.map +1 -1
package/lib/src/utils.d.ts +10 -0
package/lib/src/utils.d.ts.map +1 -1
package/lib/src/utils.js +22 -1
package/lib/src/utils.js.map +1 -1
package/lib/src/utils.spec.js +49 -1
package/lib/src/utils.spec.js.map +1 -1
package/lib/src/visual-embed-sdk.d.ts +190 -4
package/package.json +4 -10
package/src/css-variables.ts +20 -0
package/src/embed/app.spec.ts +109 -0
package/src/embed/app.ts +11 -1
package/src/embed/conversation.spec.ts +17 -0
package/src/embed/conversation.ts +10 -0
package/src/embed/events.spec.ts +7 -0
package/src/embed/liveboard.spec.ts +15 -0
package/src/embed/liveboard.ts +10 -0
package/src/embed/spotter-viz-utils.ts +30 -0
package/src/embed/ts-embed.spec.ts +294 -0
package/src/embed/ts-embed.ts +180 -9
package/src/index.ts +2 -1
package/src/types.ts +86 -3
package/src/utils/graphql/answerService/answerService.spec.ts +18 -0
package/src/utils/processTrigger.spec.ts +23 -0
package/src/utils/processTrigger.ts +8 -6
package/src/utils.spec.ts +63 -0
package/src/utils.ts +25 -1

package/src/types.ts CHANGED Viewed

@@ -1108,6 +1108,45 @@ export interface BaseViewConfig extends ApiInterceptFlags {
      * ```
      */
     doNotTrackPreRenderSize?: boolean;
+    /**
+     * The DOM element or CSS selector string specifying the container into which
+     * the pre-rendered wrapper is inserted. Defaults to `document.body` when not
+     * specified.
+     *
+     * **When to use a target container:** set this when the pre-render should
+     * live somewhere other than `document.body` — for example when `<body>` has
+     * `overflow: hidden` and scrolling is handled by an inner element, or when
+     * you need the wrapper to sit inside a specific stacking/positioning context.
+     * The wrapper is positioned to track the embedding element within this
+     * container, so choose the scrollable/positioned ancestor you want it
+     * aligned to.
+     *
+     * **Pass a stable container:** the wrapper is mounted into the resolved
+     * container once, during `preRender()`. The container must stay mounted for
+     * the lifetime of the pre-render — if the host app unmounts and remounts it
+     * (for example React replacing the node), the wrapper is orphaned on the
+     * detached node. Mount the container above the part of the tree that
+     * re-renders so its identity is stable. Prefer a CSS selector string over a
+     * raw element: a selector can be re-resolved to the fresh node on the next
+     * reposition, whereas an element reference cannot be recovered once detached.
+     *
+     * When the embed host lives inside a Shadow DOM, a selector string is
+     * resolved against that shadow root as well (since `document.querySelector`
+     * cannot pierce shadow boundaries); pass the element directly if the
+     * container lives in a different root.
+     *
+     * @type {string | HTMLElement}
+     * @version SDK: 1.49.2 | ThoughtSpot: *
+     * @example
+     * ```js
+     * const embed = new LiveboardEmbed('#tsEmbed', {
+     *   preRenderId: 'my-liveboard',
+     *   // Prefer a selector for a stable, scrollable container.
+     *   preRenderContainer: '#my-scroll-container',
+     * });
+     * ```
+     */
+    preRenderContainer?: string | HTMLElement;
     /**
      * Enable the V2 shell. This can provide performance benefits
      * due to a lighter-weight shell.
@@ -4150,11 +4189,30 @@ export enum HostEvent {
     /**
      * Navigate to a specific page in the embedded ThoughtSpot application.
      * This is the same as calling `appEmbed.navigateToPage(path, true)`.
-     * @param - `path` - the path to navigate to go forward or back. The path value can
-     * be a number; for example, `1`, `-1`.
+     *
+     * Accepts either a plain value or an object with `path`
+     * and an optional `replace` flag.
+     *
+     * @param data - A string path, a numeric history delta, or an object
+     *   `{ path: string | number, replace?: boolean }`.
+     *   - `path` — the route to navigate to, or a history delta such as `1`
+     *     or `-1` (calls `window.history.go()`).
+     *   - `replace` — when `true`, replaces the current history entry instead
+     *     of pushing a new one (uses `window.location.replace`).
+     *
      * @example
      * ```js
-     * appEmbed.navigateToPage(-1)
+     * // Preferred: use navigateToPage directly
+     * appEmbed.navigateToPage(-1);
+     *
+     * // Numeric delta — go back one step
+     * appEmbed.trigger(HostEvent.Navigate, -1);
+     *
+     * // String path — push a new history entry
+     * appEmbed.trigger(HostEvent.Navigate, 'home');
+     *
+     * // Object format — replace current history entry
+     * appEmbed.trigger(HostEvent.Navigate, { path: 'home', replace: true }); // SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
      * ```
      * @version SDK: 1.12.0 | ThoughtSpot: 8.4.0.cl, 8.4.1.sw
      */
@@ -6149,6 +6207,7 @@ export enum Param {
     EnableLiveboardDataCache = 'enableLiveboardDataCache',
     SpotterFileUploadEnabled = 'spotterFileUploadEnabled',
     SpotterFileUploadFileTypes = 'spotterFileUploadFileTypes',
+    IsStarterPromptsEnabled = 'enableStarterPrompts',
 }
 /**
@@ -6801,6 +6860,16 @@ export enum Action {
      * @version SDK: 1.9.0 | ThoughtSpot: 8.1.0.cl, 8.4.1.sw
      */
     AddToFavorites = 'addToFavorites',
+    /**
+     * Remove from Favorites option in home page v3 sidebar.
+     * Allows removing an object from the user's favorites list from home-page v3 sidebar.
+     * @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
+     * @example
+     * ```js
+     * disabledActions: [Action.RemoveFromFavorites]
+     * ```
+     */
+    RemoveFromFavorites = 'removeFromFavorites',
     /**
      * The edit icon on Liveboards (Classic experience).
      * @example
@@ -7879,6 +7948,20 @@ export enum Action {
      * ```
      */
     SpotterViz = 'spotterViz',
+    /**
+     * The reference-mode toggle button inside the SpotterViz chat input.
+     * When users enable reference mode, clicking tiles, filters, or
+     * parameters adds them as chat context. Hide this action to remove
+     * the reference-mode capability entirely.
+     * Visible by default.
+     * @version SDK: 1.51.0 | ThoughtSpot Cloud: 26.8.0.cl
+     * @example
+     * ```js
+     * hiddenActions: [Action.SpotterVizReferenceMode]
+     * disabledActions: [Action.SpotterVizReferenceMode]
+     * ```
+     */
+    SpotterVizReferenceMode = 'spotterVizReferenceMode',
     /**
      * Clears browser cache and fetches new data for liveboard ChartViz Containers.
      * Requires `enableLiveboardDataCache` to be enabled.

package/src/utils/graphql/answerService/answerService.spec.ts CHANGED Viewed

@@ -707,4 +707,22 @@ describe('Answer service tests', () => {
         expect(answer.name).toBe('name');
         expect(answer.id).toBe('bar');
     });
+    test('getTML parses nested objects and arrays from the YAML edoc', async () => {
+        const edoc = [
+            'answer:',
+            '  name: Revenue answer',
+            '  visualizations:',
+            '    - id: viz-1',
+            '      type: TABLE',
+        ].join('\n');
+        fetchMock.mockResponseOnce(JSON.stringify({
+            data: { UnsavedAnswer_getTML: { object: [{ edoc }] } },
+        }));
+        const { answer } = await createAnswerService().getTML();
+        expect(answer.name).toBe('Revenue answer');
+        expect(answer.visualizations).toEqual([{ id: 'viz-1', type: 'TABLE' }]);
+    });
 });

package/src/utils/processTrigger.spec.ts CHANGED Viewed

@@ -94,6 +94,29 @@ describe('Unit test for processTrigger', () => {
         await expect(triggerPromise).resolves.toEqual(null);
     });
+    test('should clear the timeout when response arrives before TRIGGER_TIMEOUT', async () => {
+        const messageType = HostEvent.Search;
+        const thoughtSpotHost = 'http://localhost:3000';
+        const data = {};
+        mockMessageChannel();
+        const clearTimeoutSpy = jest.spyOn(global, 'clearTimeout');
+        const triggerPromise = _processTriggerInstance.processTrigger(
+            iFrame,
+            messageType,
+            thoughtSpotHost,
+            data,
+        );
+        const res = { data: { test: '123' } };
+        messageChannelMock.port1.onmessage(res);
+        expect(clearTimeoutSpy).toHaveBeenCalled();
+        await expect(triggerPromise).resolves.toEqual(res.data);
+        clearTimeoutSpy.mockRestore();
+    });
     test('should close channel.port1 when timeout exceeds TRIGGER_TIMEOUT', async () => {
         const messageType = HostEvent.Search;
         const thoughtSpotHost = 'http://localhost:3000';

package/src/utils/processTrigger.ts CHANGED Viewed

@@ -70,7 +70,15 @@ export function processTrigger(
         }
         const channel = new MessageChannel();
+        // Close the messageChannel and resolve the promise if timeout.
+        const timeoutId = setTimeout(() => {
+            channel.port1.close();
+            res(new Error(ERROR_MESSAGE.TRIGGER_TIMED_OUT));
+        }, TRIGGER_TIMEOUT);
         channel.port1.onmessage = ({ data: responseData }) => {
+            clearTimeout(timeoutId);
             channel.port1.close();
             const error = responseData?.error || responseData?.data?.error;
             if (error) {
@@ -80,12 +88,6 @@ export function processTrigger(
             }
         };
-        // Close the messageChannel and resolve the promise if timeout.
-        setTimeout(() => {
-            channel.port1.close();
-            res(new Error(ERROR_MESSAGE.TRIGGER_TIMED_OUT));
-        }, TRIGGER_TIMEOUT);
         return postIframeMessage(iFrame, { type: messageType, data, context }, thoughtSpotHost, channel);
     });
 }

package/src/utils.spec.ts CHANGED Viewed

@@ -26,6 +26,7 @@ import {
     resetValueFromWindow,
     validateHttpUrl,
     setParamIfDefined,
+    querySelectorAcrossShadowRoot,
 } from './utils';
 import { RuntimeFilterOp } from './types';
 import { logger } from './utils/logger';
@@ -855,6 +856,68 @@ describe('getClippingAncestors', () => {
     });
 });
+describe('querySelectorAcrossShadowRoot', () => {
+    it('should resolve a selector from the light DOM document', () => {
+        const el = document.createElement('div');
+        el.id = 'light-dom-target';
+        document.body.appendChild(el);
+        expect(querySelectorAcrossShadowRoot('#light-dom-target')).toBe(el);
+        el.remove();
+    });
+    it('should resolve a selector inside the reference node shadow root when the document misses', () => {
+        const host = document.createElement('div');
+        document.body.appendChild(host);
+        const shadow = host.attachShadow({ mode: 'open' });
+        const container = document.createElement('div');
+        container.id = 'shadow-target';
+        const reference = document.createElement('div');
+        shadow.appendChild(container);
+        shadow.appendChild(reference);
+        // document.querySelector cannot see into the shadow root.
+        expect(document.querySelector('#shadow-target')).toBeNull();
+        expect(querySelectorAcrossShadowRoot('#shadow-target', reference)).toBe(container);
+        host.remove();
+    });
+    it('should prefer the document match over the shadow root', () => {
+        const lightEl = document.createElement('div');
+        lightEl.id = 'shared-id';
+        document.body.appendChild(lightEl);
+        const host = document.createElement('div');
+        document.body.appendChild(host);
+        const shadow = host.attachShadow({ mode: 'open' });
+        const shadowEl = document.createElement('div');
+        shadowEl.id = 'shared-id';
+        const reference = document.createElement('div');
+        shadow.appendChild(shadowEl);
+        shadow.appendChild(reference);
+        expect(querySelectorAcrossShadowRoot('#shared-id', reference)).toBe(lightEl);
+        lightEl.remove();
+        host.remove();
+    });
+    it('should return null when nothing matches and the reference node is in the light DOM', () => {
+        const reference = document.createElement('div');
+        document.body.appendChild(reference);
+        expect(querySelectorAcrossShadowRoot('#does-not-exist', reference)).toBeNull();
+        reference.remove();
+    });
+    it('should return null when no reference node is provided and the document misses', () => {
+        expect(querySelectorAcrossShadowRoot('#does-not-exist')).toBeNull();
+    });
+});
 describe('getEffectiveClippingAncestors', () => {
     it('should return an empty list when element is missing', () => {
         expect(getEffectiveClippingAncestors(null as unknown as HTMLElement)).toEqual([]);

package/src/utils.ts CHANGED Viewed

@@ -6,7 +6,7 @@
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
  */
-import merge from 'ts-deepmerge';
+import { merge } from 'ts-deepmerge';
 import {
     EmbedConfig,
     QueryParams,
@@ -291,6 +291,30 @@ export function getDOMNode(domSelector: DOMSelector): HTMLElement {
     return typeof domSelector === 'string' ? document.querySelector(domSelector) : domSelector;
 }
+/**
+ * Resolves a CSS selector to an element. `document.querySelector` cannot pierce
+ * shadow boundaries, so when the document lookup misses and a reference node is
+ * provided, this also searches the shadow root the reference node lives in —
+ * letting a selector target an element inside the same shadow root as the embed
+ * instead of silently falling back to the light DOM.
+ * @param selector CSS selector string.
+ * @param referenceNode Node whose shadow root is searched when the document lookup misses.
+ */
+export function querySelectorAcrossShadowRoot(
+    selector: string,
+    referenceNode?: Node | null,
+): Element | null {
+    const fromDocument = document.querySelector(selector);
+    if (fromDocument) {
+        return fromDocument;
+    }
+    const rootNode = referenceNode?.getRootNode?.();
+    if (typeof ShadowRoot !== 'undefined' && rootNode instanceof ShadowRoot) {
+        return rootNode.querySelector(selector);
+    }
+    return null;
+}
 export const deepMerge = (target: any, source: any) => merge(target, source);
 export const getOperationNameFromQuery = (query: string) => {