Add Tags Support

thoughtspot · Mar 29, 2021 · 008f5dd · 008f5dd
1 parent dd23d19
commit 008f5dd
Show file tree

Hide file tree

Showing 21 changed files with 202 additions and 157 deletions.
diff --git a/src/embed/app.spec.ts b/src/embed/app.spec.ts
@@ -137,4 +137,19 @@ describe('App embed tests', () => {
             );
         });
     });
+
+    test('Should add the tag to the iframe src', async () => {
+        const appEmbed = new AppEmbed(getRootEl(), {
+            ...defaultViewConfig,
+            showPrimaryNavbar: false,
+            tag: 'Finance',
+        } as AppViewConfig);
+
+        appEmbed.render();
+        await executeAfterWait(() => {
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&tag=Finance#/home`,
+            );
+        });
+    });
 });
diff --git a/src/embed/app.ts b/src/embed/app.ts
@@ -61,6 +61,11 @@ export interface AppViewConfig extends ViewConfig {
      * in the embedded view.
      */
     pageId?: Page;
+    /**
+     * This puts a filter tag on the Application, all metadata lists in the app
+     * like pinboards, Answers etc would be filtered by this tag.
+     */
+    tag?: string;
 }
 
 /**
@@ -85,6 +90,7 @@ export class AppEmbed extends V1Embed {
             disabledActions,
             disabledActionReason,
             hiddenActions,
+            tag,
         } = this.viewConfig;
 
         if (disabledActions?.length) {
@@ -96,6 +102,9 @@ export class AppEmbed extends V1Embed {
         if (hiddenActions?.length) {
             params[Param.HideActions] = hiddenActions;
         }
+        if (!!tag) {
+            params[Param.Tag] = tag;
+        }
 
         const queryParams = getQueryParamString(params);
 

diff --git a/src/types.ts b/src/types.ts
@@ -315,6 +315,7 @@ export enum Param {
     EnableSearchAssist = 'enableSearchAssist',
     HideResult = 'hideResult',
     UseLastSelectedDataSource = 'useLastSelectedSources',
+    Tag = 'tag',
 }
 
 /**

diff --git a/static/typedoc/assets/js/search.js b/static/typedoc/assets/js/search.js
diff --git a/static/typedoc/classes/appembed.html b/static/typedoc/classes/appembed.html
@@ -198,7 +198,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/app.ts#L71">embed/app.ts:71</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/app.ts#L76">embed/app.ts:76</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -227,7 +227,7 @@ <h3>on</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/base.ts#L437">embed/base.ts:437</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/base.ts#L437">embed/base.ts:437</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -253,7 +253,7 @@ <h3>render</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/app.ts#L167">embed/app.ts:167</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/app.ts#L176">embed/app.ts:176</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -275,7 +275,7 @@ <h3>trigger</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/base.ts#L387">embed/base.ts:387</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/base.ts#L387">embed/base.ts:387</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/static/typedoc/classes/pinboardembed.html b/static/typedoc/classes/pinboardembed.html
@@ -198,7 +198,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/pinboard.ts#L51">embed/pinboard.ts:51</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/pinboard.ts#L51">embed/pinboard.ts:51</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -227,7 +227,7 @@ <h3>on</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/base.ts#L437">embed/base.ts:437</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/base.ts#L437">embed/base.ts:437</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -253,7 +253,7 @@ <h3>render</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/pinboard.ts#L135">embed/pinboard.ts:135</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/pinboard.ts#L135">embed/pinboard.ts:135</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -275,7 +275,7 @@ <h3>trigger</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/base.ts#L387">embed/base.ts:387</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/base.ts#L387">embed/base.ts:387</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">

diff --git a/static/typedoc/classes/searchembed.html b/static/typedoc/classes/searchembed.html
@@ -198,7 +198,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/search.ts#L62">embed/search.ts:62</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/search.ts#L62">embed/search.ts:62</a></li>
 								</ul>
 							</aside>
 							<h4 class="tsd-parameters-title">Parameters</h4>
@@ -227,7 +227,7 @@ <h3>on</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/base.ts#L365">embed/base.ts:365</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/base.ts#L365">embed/base.ts:365</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -265,7 +265,7 @@ <h3>render</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/search.ts#L143">embed/search.ts:143</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/search.ts#L143">embed/search.ts:143</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -287,7 +287,7 @@ <h3>trigger</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/22cb1ea/src/embed/base.ts#L387">embed/base.ts:387</a></li>
+									<li>Defined in <a href="https://github.com/thoughtspot/visual-embed-sdk/blob/df40a37/src/embed/base.ts#L387">embed/base.ts:387</a></li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">