@thoughtspot/visual-embed-sdk 1.17.3 → 1.17.5

package/lib/src/utils/authService.d.ts

@@ -4,3 +4,4 @@ export declare function fetchAuthService(thoughtSpotHost: string, username: stri
 export declare function fetchAuthPostService(thoughtSpotHost: string, username: string, authToken: string): Promise<any>;
 export declare function fetchBasicAuthService(thoughtSpotHost: string, username: string, password: string): Promise<any>;
 export declare function fetchLogoutService(thoughtSpotHost: string): Promise<any>;
+//# sourceMappingURL=authService.d.ts.map

package/lib/src/utils/authService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authService.d.ts","sourceRoot":"","sources":["../../../src/utils/authService.ts"],"names":[],"mappings":"AAeA,wBAAgB,uBAAuB,CACnC,mBAAmB,EAAE,MAAM,GAC5B,OAAO,CAAC,GAAG,CAAC,CAId;AAED,wBAAsB,qBAAqB,CACvC,YAAY,EAAE,MAAM,GACrB,OAAO,CAAC,GAAG,CAAC,CAEd;AAED,wBAAsB,gBAAgB,CAClC,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAClB,OAAO,CAAC,GAAG,CAAC,CASd;AAED,wBAAsB,oBAAoB,CACtC,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAClB,OAAO,CAAC,GAAG,CAAC,CAcd;AAED,wBAAsB,qBAAqB,CACvC,eAAe,EAAE,MAAM,EACvB,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACjB,OAAO,CAAC,GAAG,CAAC,CAYd;AAED,wBAAsB,kBAAkB,CACpC,eAAe,EAAE,MAAM,GACxB,OAAO,CAAC,GAAG,CAAC,CAQd"}

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

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=authService.spec.d.ts.map

package/lib/src/utils/authService.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authService.spec.d.ts","sourceRoot":"","sources":["../../../src/utils/authService.spec.ts"],"names":[],"mappings":""}

package/lib/src/utils/processData.d.ts

@@ -1,3 +1,4 @@
 import { EmbedEvent } from '../types';
 export declare function processCustomAction(e: any, thoughtSpotHost: string): any;
 export declare function processEventData(type: EmbedEvent, e: any, thoughtSpotHost: string, containerEl: Element): any;
+//# sourceMappingURL=processData.d.ts.map

package/lib/src/utils/processData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processData.d.ts","sourceRoot":"","sources":["../../../src/utils/processData.ts"],"names":[],"mappings":"AASA,OAAO,EAAY,UAAU,EAAiB,MAAM,UAAU,CAAC;AAG/D,wBAAgB,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,eAAe,EAAE,MAAM,OAoBlE;AA6DD,wBAAgB,gBAAgB,CAC5B,IAAI,EAAE,UAAU,EAChB,CAAC,EAAE,GAAG,EACN,eAAe,EAAE,MAAM,EACvB,WAAW,EAAE,OAAO,GACrB,GAAG,CAiBL"}

package/lib/src/utils/processData.spec.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=processData.spec.d.ts.map

package/lib/src/utils/processData.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processData.spec.d.ts","sourceRoot":"","sources":["../../../src/utils/processData.spec.ts"],"names":[],"mappings":""}

package/lib/src/utils/processTrigger.d.ts

@@ -1,2 +1,3 @@
 import { HostEvent } from '../types';
 export declare function processTrigger(iFrame: HTMLIFrameElement, messageType: HostEvent, thoughtSpotHost: string, data: any): Promise<any>;
+//# sourceMappingURL=processTrigger.d.ts.map

package/lib/src/utils/processTrigger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processTrigger.d.ts","sourceRoot":"","sources":["../../../src/utils/processTrigger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AA4BrC,wBAAgB,cAAc,CAC1B,MAAM,EAAE,iBAAiB,EACzB,WAAW,EAAE,SAAS,EACtB,eAAe,EAAE,MAAM,EACvB,IAAI,EAAE,GAAG,GACV,OAAO,CAAC,GAAG,CAAC,CA6Bd"}

package/lib/src/utils/processTrigger.spec.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=processTrigger.spec.d.ts.map

package/lib/src/utils/processTrigger.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"processTrigger.spec.d.ts","sourceRoot":"","sources":["../../../src/utils/processTrigger.spec.ts"],"names":[],"mappings":""}

package/lib/src/utils.d.ts

@@ -50,3 +50,4 @@ export declare const getCustomisations: (embedConfig: EmbedConfig, viewConfig: V
  * @param domSelector
  */
 export declare function getDOMNode(domSelector: DOMSelector): HTMLElement;
+//# sourceMappingURL=utils.d.ts.map

package/lib/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACH,WAAW,EACX,WAAW,EACX,aAAa,EACb,uBAAuB,EACvB,WAAW,EACX,UAAU,EACb,MAAM,SAAS,CAAC;AAEjB;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,mBAAoB,aAAa,EAAE,KAAG,MAkBhE,CAAC;AA6BF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,gBACf,WAAW,2CAEzB,MAkBF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,UAAW,MAAM,GAAG,MAAM,KAAG,MAMxD,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAS,MAAM,kBAAkB,MAAM,WAWlE,CAAC;AAEF,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,IAAI,SAAK,UAG5E;AAED,eAAO,MAAM,2BAA2B,gBAAiB,MAAM,WAQ9D,CAAC;AAEF,eAAO,MAAM,YAAY,YAAa,GAAG,QAGxC,CAAC;AAEF,eAAO,MAAM,gBAAgB;;;CAG5B,CAAC;AAEF,eAAO,MAAM,aAAa,YACb,WAAW;;MAErB,IAIF,CAAC;AAKF,eAAO,MAAM,yBAAyB,mBAClB,MAAM,uBACD,OAAO,KAC7B,OAQF,CAAC;AAEF,eAAO,MAAM,iBAAiB,gBACb,WAAW,cACZ,UAAU,KACvB,uBA0BF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,WAAW,EAAE,WAAW,GAAG,WAAW,CAIhE"}

package/lib/src/utils.spec.d.ts

@@ -2,3 +2,4 @@
  * @jest-environment node
  */
 export {};
+//# sourceMappingURL=utils.spec.d.ts.map

package/lib/src/utils.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.spec.d.ts","sourceRoot":"","sources":["../../src/utils.spec.ts"],"names":[],"mappings":"AAAA;;GAEG"}

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

@@ -413,11 +413,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/search-bar' {
     import { ViewConfig } from '@thoughtspot/visual-embed-sdk/types';
     import { TsEmbed } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     import { SearchOptions } from '@thoughtspot/visual-embed-sdk/embed/search';
-    export interface SearchBarViewConfig extends ViewConfig {
-            /**
-                * If set to true, hides the data sources panel.
-                */
-            hideDataSources?: boolean;
+    export interface SearchBarViewConfig extends Omit<ViewConfig, 'disabledActions' | 'hiddenActions' | 'visibleActions' | 'disabledActionReason' | 'runtimeFilters' | 'showAlerts'> {
             /**
                 * The array of data source GUIDs to set on load.
                 */
@@ -1100,11 +1096,11 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             DialogClose = "dialog-close",
             /**
-                * Emitted when a liveboard has completed rendering,
-                * this event can be used as a hook to trigger events on the
-                * rendered liveboard
-                * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
-                */
+             * Emitted when the Liveboard shell loads. You
+             * can use this event as a hook to trigger
+             * other events on the rendered Liveboard.
+             * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
+             */
             LiveboardRendered = "PinboardRendered",
             /**
                 * This can be used to register an event listener which

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.17.3",
+    "version": "1.17.5",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",
@@ -14,6 +14,13 @@
         ".": "./lib/src/index.js",
         "./react": "./lib/src/react/index.js"
     },
+    "typesVersions": {
+        "*": {
+            "react": [
+                "./lib/src/react/index.d.ts"
+            ]
+        }
+    },
     "scripts": {
         "lint": "eslint 'src/**'",
         "lint:fix": "eslint 'src/**/*.*' --fix",

package/src/embed/search-bar.tsx

@@ -3,11 +3,16 @@ import { getQueryParamString } from '../utils';
 import { TsEmbed } from './ts-embed';
 import { SearchOptions } from './search';
 
-export interface SearchBarViewConfig extends ViewConfig {
-    /**
-     * If set to true, hides the data sources panel.
-     */
-    hideDataSources?: boolean;
+export interface SearchBarViewConfig
+    extends Omit<
+        ViewConfig,
+        | 'disabledActions'
+        | 'hiddenActions'
+        | 'visibleActions'
+        | 'disabledActionReason'
+        | 'runtimeFilters'
+        | 'showAlerts'
+    > {
     /**
      * The array of data source GUIDs to set on load.
      */

package/src/embed/search.spec.ts

@@ -1,7 +1,7 @@
 import { SearchEmbed, HiddenActionItemByDefaultForSearchEmbed } from './search';
 import * as authInstance from '../auth';
 import { init } from '../index';
-import { Action, AuthType } from '../types';
+import { Action, AuthType, RuntimeFilterOp } from '../types';
 import {
     executeAfterWait,
     getDocumentBody,
@@ -158,6 +158,32 @@ describe('Search embed tests', () => {
         });
     });
 
+    test('should add runtime filters', async () => {
+        const dataSources = ['data-source-1'];
+        const searchOptions = {
+            searchTokenString: '[commit date][revenue]',
+        };
+        const searchEmbed = new SearchEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            hideDataSources: true,
+            dataSources,
+            searchOptions,
+            runtimeFilters: [
+                {
+                    columnName: 'city',
+                    operator: RuntimeFilterOp.EQ,
+                    values: ['berkeley'],
+                },
+            ],
+        });
+        searchEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/v2/?${defaultParamsWithHiddenActions}&dataSources=[%22data-source-1%22]&searchTokenString=%5Bcommit%20date%5D%5Brevenue%5D&dataSourceMode=hide&useLastSelectedSources=false${prefixParams}&col1=city&op1=EQ&val1=berkeley#/embed/answer`,
+            );
+        });
+    });
+
     test('should disable actions', async () => {
         const dataSources = ['data-source-1'];
         const searchOptions = {

package/src/embed/search.ts

@@ -13,8 +13,13 @@ import {
     Param,
     Action,
     ViewConfig,
+    RuntimeFilter,
 } from '../types';
-import { getQueryParamString, checkReleaseVersionInBeta } from '../utils';
+import {
+    getQueryParamString,
+    checkReleaseVersionInBeta,
+    getFilterQuery,
+} from '../utils';
 import { TsEmbed } from './ts-embed';
 import { version } from '../../package.json';
 import { ERROR_MESSAGE } from '../errors';
@@ -144,6 +149,7 @@ export class SearchEmbed extends TsEmbed {
             enableSearchAssist,
             forceTable,
             searchOptions,
+            runtimeFilters,
         } = this.viewConfig;
         const answerPath = answerId ? `saved-answer/${answerId}` : 'answer';
         const queryParams = this.getBaseQueryParams();
@@ -183,6 +189,10 @@ export class SearchEmbed extends TsEmbed {
         if (queryParamsString) {
             query = `?${queryParamsString}`;
         }
+        const filterQuery = getFilterQuery(runtimeFilters || []);
+        if (filterQuery) {
+            query += `&${filterQuery}`;
+        }
         const tsPostHashParams = this.getThoughtSpotPostUrlParams();
 
         return `${this.getEmbedBasePath(

package/src/react/index.spec.tsx

@@ -129,7 +129,6 @@ describe('React Components', () => {
         it('Should Render the Iframe with props', async () => {
             const { container } = render(
                 <SearchBarEmbed
-                    hideDataSources={true}
                     className="embedClass"
                     dataSources={['test']}
                     searchOptions={{

package/src/types.ts

@@ -623,10 +623,10 @@ export enum EmbedEvent {
      * @version SDK: 1.6.0 | ThoughtSpot: ts8.nov.cl, 8.4.1-sw
      */
     DialogClose = 'dialog-close',
-    /**
-     * Emitted when a liveboard has completed rendering,
-     * this event can be used as a hook to trigger events on the
-     * rendered liveboard
+     /**
+     * Emitted when the Liveboard shell loads. You
+     * can use this event as a hook to trigger
+     * other events on the rendered Liveboard.
      * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
      */
     LiveboardRendered = 'PinboardRendered',