@thoughtspot/visual-embed-sdk 1.6.0-alpha.2 → 1.6.0-alpha.3

package/lib/src/types.d.ts

@@ -112,12 +112,13 @@ export interface EmbedConfig {
      * When there are multiple embeds, queue the render of embed to start
      *  after the previous embed's render is complete. This helps in the load performance
      *  by decreasing the load on the browser.
+     * * _Version 1.5.0 or later _
      * @default false
      */
     queueMultiRenders?: boolean;
     /**
      * Dynamic CSS Url to be injected in the loaded application.
-     * _Since: 1.6.0_
+     * * _Version 1.6.0 or later _
      * @default ''
      */
     customCssUrl?: string;
@@ -193,7 +194,7 @@ export declare enum RuntimeFilterOp {
     IN = "IN"
 }
 /**
- * A filter that can be applied to ThoughtSpot answers, liveboards, or
+ * A filter that can be applied to ThoughtSpot answers, Liveboards, or
  * visualizations at runtime.
  */
 export interface RuntimeFilter {
@@ -231,12 +232,12 @@ export declare enum EmbedEvent {
      */
     Load = "load",
     /**
-     * Data pertaining to answer or liveboard is received
-     * @return data - The answer or liveboard data
+     * Data pertaining to answer or Liveboard is received
+     * @return data - The answer or Liveboard data
      */
     Data = "data",
     /**
-     * Search/answer/liveboard filters have been applied/updated
+     * Search/answer/Liveboard filters have been applied/updated
      * @hidden
      */
     FiltersChanged = "filtersChanged",
@@ -259,13 +260,13 @@ export declare enum EmbedEvent {
     /**
      * A custom action has been triggered
      * @return actionId - The id of the custom action
-     * @return data - The answer or liveboard data
+     * @return data - The answer or Liveboard data
      */
     CustomAction = "customAction",
     /**
      * A double click has been triggered on table/chart
      * @return ContextMenuInputPoints - data point that is double clicked
-     * * _since: 1.5.0_
+     * * _Version 1.5.0 or later _
      */
     VizPointDoubleClick = "vizPointDoubleClick",
     /**
@@ -283,8 +284,8 @@ export declare enum EmbedEvent {
      */
     AuthExpire = "ThoughtspotAuthExpired",
     /**
-     * The height of the embedded liveboard or visualization has been computed.
-     * @return data - The height of the embedded liveboard or visualization
+     * The height of the embedded Liveboard or visualization has been computed.
+     * @return data - The height of the embedded Liveboard or visualization
      * @hidden
      */
     EmbedHeight = "EMBED_HEIGHT",
@@ -296,7 +297,6 @@ export declare enum EmbedEvent {
     EmbedIframeCenter = "EmbedIframeCenter",
     /**
      * Detects the route change.
-     * @hidden
      */
     RouteChange = "ROUTE_CHANGE",
     /**
@@ -319,12 +319,12 @@ export declare enum EmbedEvent {
     SAMLComplete = "samlComplete",
     /**
      * Emitted when any modal is opened in the app
-     * * _since: 1.6.0_
+     * * _Version 1.6.0 or later _
      */
     DialogOpen = "dialog-open",
     /**
      * Emitted when any modal is closed in the app
-     * * _since: 1.6.0_
+     * * _Version 1.6.0 or later _
      */
     DialogClose = "dialog-close"
 }
@@ -345,7 +345,7 @@ export declare enum HostEvent {
      *              eg. { selectedPoints: []}
      * @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. \
-     * * _since: 1.5.0_
+     * * _Version 1.5.0 or later _
      */
     DrillDown = "triggerDrillDown",
     /**
@@ -359,10 +359,10 @@ export declare enum HostEvent {
      */
     Reload = "reload",
     /**
-     * Set the visible Vizs on a pinboard/liveboard.
-     * @param - an array of ids of vizs to show, the ids not passed
+     * Set the visible visualizations on a Liveboard.
+     * @param - an array of ids of visualizations to show, the ids not passed
      *          will be hidden.
-     * _since: 1.6.0_
+     * * _Version 1.6.0 or later _
      */
     SetVisibleVizs = "SetPinboardVisibleVizs"
 }
@@ -416,7 +416,7 @@ export declare enum Param {
 }
 /**
  * The list of actions that can be performed on visual ThoughtSpot
- * entities, such as answers and liveboards.
+ * entities, such as answers and Liveboards.
  */
 export declare enum Action {
     Save = "save",
@@ -426,11 +426,6 @@ export declare enum Action {
     MakeACopy = "makeACopy",
     EditACopy = "editACopy",
     CopyLink = "embedDocument",
-    /**
-     * @hidden
-     */
-    PinboardSnapshot = "pinboardSnapshot",
-    LiveboardSnapshot = "liveboardSnapshot",
     ResetLayout = "resetLayout",
     Schedule = "schedule",
     SchedulesList = "schedule-list",
@@ -467,7 +462,7 @@ export declare enum Action {
      * @hidden
      */
     PinboardInfo = "pinboardInfo",
-    LiveboardInfo = "liveboardInfo",
+    LiveboardInfo = "pinboardInfo",
     SendAnswerFeedback = "sendFeedback",
     /**
      * @deprecated Will be removed in next version

package/lib/src/types.js

@@ -118,12 +118,12 @@ export var EmbedEvent;
      */
     EmbedEvent["Load"] = "load";
     /**
-     * Data pertaining to answer or liveboard is received
-     * @return data - The answer or liveboard data
+     * Data pertaining to answer or Liveboard is received
+     * @return data - The answer or Liveboard data
      */
     EmbedEvent["Data"] = "data";
     /**
-     * Search/answer/liveboard filters have been applied/updated
+     * Search/answer/Liveboard filters have been applied/updated
      * @hidden
      */
     EmbedEvent["FiltersChanged"] = "filtersChanged";
@@ -146,13 +146,13 @@ export var EmbedEvent;
     /**
      * A custom action has been triggered
      * @return actionId - The id of the custom action
-     * @return data - The answer or liveboard data
+     * @return data - The answer or Liveboard data
      */
     EmbedEvent["CustomAction"] = "customAction";
     /**
      * A double click has been triggered on table/chart
      * @return ContextMenuInputPoints - data point that is double clicked
-     * * _since: 1.5.0_
+     * * _Version 1.5.0 or later _
      */
     EmbedEvent["VizPointDoubleClick"] = "vizPointDoubleClick";
     /**
@@ -170,8 +170,8 @@ export var EmbedEvent;
      */
     EmbedEvent["AuthExpire"] = "ThoughtspotAuthExpired";
     /**
-     * The height of the embedded liveboard or visualization has been computed.
-     * @return data - The height of the embedded liveboard or visualization
+     * The height of the embedded Liveboard or visualization has been computed.
+     * @return data - The height of the embedded Liveboard or visualization
      * @hidden
      */
     EmbedEvent["EmbedHeight"] = "EMBED_HEIGHT";
@@ -183,7 +183,6 @@ export var EmbedEvent;
     EmbedEvent["EmbedIframeCenter"] = "EmbedIframeCenter";
     /**
      * Detects the route change.
-     * @hidden
      */
     EmbedEvent["RouteChange"] = "ROUTE_CHANGE";
     /**
@@ -206,12 +205,12 @@ export var EmbedEvent;
     EmbedEvent["SAMLComplete"] = "samlComplete";
     /**
      * Emitted when any modal is opened in the app
-     * * _since: 1.6.0_
+     * * _Version 1.6.0 or later _
      */
     EmbedEvent["DialogOpen"] = "dialog-open";
     /**
      * Emitted when any modal is closed in the app
-     * * _since: 1.6.0_
+     * * _Version 1.6.0 or later _
      */
     EmbedEvent["DialogClose"] = "dialog-close";
 })(EmbedEvent || (EmbedEvent = {}));
@@ -234,7 +233,7 @@ export var HostEvent;
      *              eg. { selectedPoints: []}
      * @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. \
-     * * _since: 1.5.0_
+     * * _Version 1.5.0 or later _
      */
     HostEvent["DrillDown"] = "triggerDrillDown";
     /**
@@ -248,10 +247,10 @@ export var HostEvent;
      */
     HostEvent["Reload"] = "reload";
     /**
-     * Set the visible Vizs on a pinboard/liveboard.
-     * @param - an array of ids of vizs to show, the ids not passed
+     * Set the visible visualizations on a Liveboard.
+     * @param - an array of ids of visualizations to show, the ids not passed
      *          will be hidden.
-     * _since: 1.6.0_
+     * * _Version 1.6.0 or later _
      */
     HostEvent["SetVisibleVizs"] = "SetPinboardVisibleVizs";
 })(HostEvent || (HostEvent = {}));
@@ -309,7 +308,7 @@ export var Param;
 })(Param || (Param = {}));
 /**
  * The list of actions that can be performed on visual ThoughtSpot
- * entities, such as answers and liveboards.
+ * entities, such as answers and Liveboards.
  */
 // eslint-disable-next-line no-shadow
 export var Action;
@@ -321,11 +320,6 @@ export var Action;
     Action["MakeACopy"] = "makeACopy";
     Action["EditACopy"] = "editACopy";
     Action["CopyLink"] = "embedDocument";
-    /**
-     * @hidden
-     */
-    Action["PinboardSnapshot"] = "pinboardSnapshot";
-    Action["LiveboardSnapshot"] = "liveboardSnapshot";
     Action["ResetLayout"] = "resetLayout";
     Action["Schedule"] = "schedule";
     Action["SchedulesList"] = "schedule-list";
@@ -362,7 +356,7 @@ export var Action;
      * @hidden
      */
     Action["PinboardInfo"] = "pinboardInfo";
-    Action["LiveboardInfo"] = "liveboardInfo";
+    Action["LiveboardInfo"] = "pinboardInfo";
     Action["SendAnswerFeedback"] = "sendFeedback";
     /**
      * @deprecated Will be removed in next version

package/lib/src/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,QAoBX;AApBD,WAAY,QAAQ;IAChB;;OAEG;IACH,yBAAa,CAAA;IACb;;OAEG;IACH,4BAAgB,CAAA;IAChB;;OAEG;IACH,qCAAyB,CAAA;IACzB;;;;;OAKG;IACH,2BAAe,CAAA;AACnB,CAAC,EApBW,QAAQ,KAAR,QAAQ,QAoBnB;AAoHD;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,eAyDX;AAzDD,WAAY,eAAe;IACvB;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,wCAAqB,CAAA;IACrB;;OAEG;IACH,8CAA2B,CAAA;IAC3B;;OAEG;IACH,0CAAuB,CAAA;IACvB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;AACb,CAAC,EAzDW,eAAe,KAAf,eAAe,QAyD1B;AAsBD;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,UAiHX;AAjHD,WAAY,UAAU;IAClB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,mCAAqB,CAAA;IACrB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,+CAAiC,CAAA;IACjC;;OAEG;IACH,2CAA6B,CAAA;IAC7B;;;;;OAKG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,uDAAyC,CAAA;IACzC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;;;OAIG;IACH,yDAA2C,CAAA;IAC3C;;;OAGG;IACH,6BAAe,CAAA;IACf;;;OAGG;IACH,6BAAe,CAAA;IACf;;OAEG;IACH,mDAAqC,CAAA;IACrC;;;;OAIG;IACH,0CAA4B,CAAA;IAC5B;;;;OAIG;IACH,qDAAuC,CAAA;IACvC;;;OAGG;IACH,0CAA4B,CAAA;IAC5B;;;OAGG;IACH,8CAAgC,CAAA;IAChC;;;;;OAKG;IACH,+CAAiC,CAAA;IACjC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;;OAGG;IACH,wCAA0B,CAAA;IAC1B;;;OAGG;IACH,0CAA4B,CAAA;AAChC,CAAC,EAjHW,UAAU,KAAV,UAAU,QAiHrB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,SAiCX;AAjCD,WAAY,SAAS;IACjB;;;;OAIG;IACH,8BAAiB,CAAA;IACjB;;;;;;;OAOG;IACH,2CAA8B,CAAA;IAC9B;;;OAGG;IACH,8BAAiB,CAAA;IACjB;;;OAGG;IACH,8BAAiB,CAAA;IACjB;;;;;OAKG;IACH,sDAAyC,CAAA;AAC7C,CAAC,EAjCW,SAAS,KAAT,SAAS,QAiCpB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,oBAaX;AAbD,WAAY,oBAAoB;IAC5B;;OAEG;IACH,uCAAe,CAAA;IACf;;OAEG;IACH,8CAAsB,CAAA;IACtB;;OAEG;IACH,2CAAmB,CAAA;AACvB,CAAC,EAbW,oBAAoB,KAApB,oBAAoB,QAa/B;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,KAyBX;AAzBD,WAAY,KAAK;IACb,oCAA2B,CAAA;IAC3B,0CAAiC,CAAA;IACjC,yCAAgC,CAAA;IAChC,4CAAmC,CAAA;IACnC,kCAAyB,CAAA;IACzB,uEAA8D,CAAA;IAC9D,oCAA2B,CAAA;IAC3B,mCAA0B,CAAA;IAC1B,oCAA2B,CAAA;IAC3B,kCAAyB,CAAA;IACzB,wDAA+C,CAAA;IAC/C,kDAAyC,CAAA;IACzC,kCAAyB,CAAA;IACzB,6DAAoD,CAAA;IACpD,oBAAW,CAAA;IACX,gDAAuC,CAAA;IACvC,wCAA+B,CAAA;IAC/B,4CAAmC,CAAA;IACnC,6CAAoC,CAAA;IACpC,+BAAsB,CAAA;IACtB,0CAAiC,CAAA;IACjC,wCAA+B,CAAA;IAC/B,yCAAgC,CAAA;IAChC,sCAA6B,CAAA;AACjC,CAAC,EAzBW,KAAK,KAAL,KAAK,QAyBhB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,MAqEX;AArED,WAAY,MAAM;IACd,uBAAa,CAAA;IACb,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,oCAA0B,CAAA;IAC1B;;OAEG;IACH,+CAAqC,CAAA;IACrC,iDAAuC,CAAA;IACvC,qCAA2B,CAAA;IAC3B,+BAAqB,CAAA;IACrB,yCAA+B,CAAA;IAC/B,yBAAe,CAAA;IACf,iCAAuB,CAAA;IACvB,6CAAmC,CAAA;IACnC,mCAAyB,CAAA;IACzB,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2CAAiC,CAAA;IACjC,uCAA6B,CAAA;IAC7B,+BAAqB,CAAA;IACrB,uCAA6B,CAAA;IAC7B,mDAAyC,CAAA;IACzC,+BAAqB,CAAA;IACrB,yCAA+B,CAAA;IAC/B,yCAA+B,CAAA;IAC/B,2CAAiC,CAAA;IACjC,yCAA+B,CAAA;IAC/B,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;IACnB,mCAAyB,CAAA;IACzB,uBAAa,CAAA;IACb,iCAAuB,CAAA;IACvB,2BAAiB,CAAA;IACjB,6BAAmB,CAAA;IACnB,+BAAqB,CAAA;IACrB,2BAAiB,CAAA;IACjB,mDAAyC,CAAA;IACzC;;OAEG;IACH,uCAA6B,CAAA;IAC7B,yCAA+B,CAAA;IAC/B,6CAAmC,CAAA;IACnC;;OAEG;IACH,uCAA6B,CAAA;IAC7B,2DAAiD,CAAA;IACjD,qBAAW,CAAA;IACX,uCAA6B,CAAA;IAC7B,uCAA6B,CAAA;IAC7B,6BAAmB,CAAA;IACnB,oDAA0C,CAAA;IAC1C,oDAA0C,CAAA;IAC1C,iEAAuD,CAAA;IACvD,8CAAoC,CAAA;IACpC,wDAA8C,CAAA;IAC9C,mDAAyC,CAAA;IACzC,6BAAmB,CAAA;IACnB,yCAA+B,CAAA;IAC/B,qDAA2C,CAAA;AAC/C,CAAC,EArEW,MAAM,KAAN,MAAM,QAqEjB;AAQD,qCAAqC;AACrC,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,sDAAqC,CAAA;IACrC,sEAAqD,CAAA;AACzD,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,QAoBX;AApBD,WAAY,QAAQ;IAChB;;OAEG;IACH,yBAAa,CAAA;IACb;;OAEG;IACH,4BAAgB,CAAA;IAChB;;OAEG;IACH,qCAAyB,CAAA;IACzB;;;;;OAKG;IACH,2BAAe,CAAA;AACnB,CAAC,EApBW,QAAQ,KAAR,QAAQ,QAoBnB;AAqHD;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,eAyDX;AAzDD,WAAY,eAAe;IACvB;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,wCAAqB,CAAA;IACrB;;OAEG;IACH,8CAA2B,CAAA;IAC3B;;OAEG;IACH,0CAAuB,CAAA;IACvB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,4CAAyB,CAAA;IACzB;;OAEG;IACH,oCAAiB,CAAA;IACjB;;OAEG;IACH,4BAAS,CAAA;IACT;;OAEG;IACH,4BAAS,CAAA;AACb,CAAC,EAzDW,eAAe,KAAf,eAAe,QAyD1B;AAsBD;;GAEG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,UAgHX;AAhHD,WAAY,UAAU;IAClB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,mCAAqB,CAAA;IACrB;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,2BAAa,CAAA;IACb;;;OAGG;IACH,+CAAiC,CAAA;IACjC;;OAEG;IACH,2CAA6B,CAAA;IAC7B;;;;;OAKG;IACH,qCAAuB,CAAA;IACvB;;;OAGG;IACH,uDAAyC,CAAA;IACzC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;;;OAIG;IACH,yDAA2C,CAAA;IAC3C;;;OAGG;IACH,6BAAe,CAAA;IACf;;;OAGG;IACH,6BAAe,CAAA;IACf;;OAEG;IACH,mDAAqC,CAAA;IACrC;;;;OAIG;IACH,0CAA4B,CAAA;IAC5B;;;;OAIG;IACH,qDAAuC,CAAA;IACvC;;OAEG;IACH,0CAA4B,CAAA;IAC5B;;;OAGG;IACH,8CAAgC,CAAA;IAChC;;;;;OAKG;IACH,+CAAiC,CAAA;IACjC;;;;OAIG;IACH,2CAA6B,CAAA;IAC7B;;;OAGG;IACH,wCAA0B,CAAA;IAC1B;;;OAGG;IACH,0CAA4B,CAAA;AAChC,CAAC,EAhHW,UAAU,KAAV,UAAU,QAgHrB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,SAiCX;AAjCD,WAAY,SAAS;IACjB;;;;OAIG;IACH,8BAAiB,CAAA;IACjB;;;;;;;OAOG;IACH,2CAA8B,CAAA;IAC9B;;;OAGG;IACH,8BAAiB,CAAA;IACjB;;;OAGG;IACH,8BAAiB,CAAA;IACjB;;;;;OAKG;IACH,sDAAyC,CAAA;AAC7C,CAAC,EAjCW,SAAS,KAAT,SAAS,QAiCpB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,oBAaX;AAbD,WAAY,oBAAoB;IAC5B;;OAEG;IACH,uCAAe,CAAA;IACf;;OAEG;IACH,8CAAsB,CAAA;IACtB;;OAEG;IACH,2CAAmB,CAAA;AACvB,CAAC,EAbW,oBAAoB,KAApB,oBAAoB,QAa/B;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,KAyBX;AAzBD,WAAY,KAAK;IACb,oCAA2B,CAAA;IAC3B,0CAAiC,CAAA;IACjC,yCAAgC,CAAA;IAChC,4CAAmC,CAAA;IACnC,kCAAyB,CAAA;IACzB,uEAA8D,CAAA;IAC9D,oCAA2B,CAAA;IAC3B,mCAA0B,CAAA;IAC1B,oCAA2B,CAAA;IAC3B,kCAAyB,CAAA;IACzB,wDAA+C,CAAA;IAC/C,kDAAyC,CAAA;IACzC,kCAAyB,CAAA;IACzB,6DAAoD,CAAA;IACpD,oBAAW,CAAA;IACX,gDAAuC,CAAA;IACvC,wCAA+B,CAAA;IAC/B,4CAAmC,CAAA;IACnC,6CAAoC,CAAA;IACpC,+BAAsB,CAAA;IACtB,0CAAiC,CAAA;IACjC,wCAA+B,CAAA;IAC/B,yCAAgC,CAAA;IAChC,sCAA6B,CAAA;AACjC,CAAC,EAzBW,KAAK,KAAL,KAAK,QAyBhB;AAED;;;GAGG;AACH,qCAAqC;AACrC,MAAM,CAAN,IAAY,MAgEX;AAhED,WAAY,MAAM;IACd,uBAAa,CAAA;IACb,2BAAiB,CAAA;IACjB,uCAA6B,CAAA;IAC7B,mCAAyB,CAAA;IACzB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,oCAA0B,CAAA;IAC1B,qCAA2B,CAAA;IAC3B,+BAAqB,CAAA;IACrB,yCAA+B,CAAA;IAC/B,yBAAe,CAAA;IACf,iCAAuB,CAAA;IACvB,6CAAmC,CAAA;IACnC,mCAAyB,CAAA;IACzB,qCAA2B,CAAA;IAC3B,yCAA+B,CAAA;IAC/B,2CAAiC,CAAA;IACjC,uCAA6B,CAAA;IAC7B,+BAAqB,CAAA;IACrB,uCAA6B,CAAA;IAC7B,mDAAyC,CAAA;IACzC,+BAAqB,CAAA;IACrB,yCAA+B,CAAA;IAC/B,yCAA+B,CAAA;IAC/B,2CAAiC,CAAA;IACjC,yCAA+B,CAAA;IAC/B,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,iCAAuB,CAAA;IACvB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;IACnB,mCAAyB,CAAA;IACzB,uBAAa,CAAA;IACb,iCAAuB,CAAA;IACvB,2BAAiB,CAAA;IACjB,6BAAmB,CAAA;IACnB,+BAAqB,CAAA;IACrB,2BAAiB,CAAA;IACjB,mDAAyC,CAAA;IACzC;;OAEG;IACH,uCAA6B,CAAA;IAC7B,wCAA8B,CAAA;IAC9B,6CAAmC,CAAA;IACnC;;OAEG;IACH,uCAA6B,CAAA;IAC7B,2DAAiD,CAAA;IACjD,qBAAW,CAAA;IACX,uCAA6B,CAAA;IAC7B,uCAA6B,CAAA;IAC7B,6BAAmB,CAAA;IACnB,oDAA0C,CAAA;IAC1C,oDAA0C,CAAA;IAC1C,iEAAuD,CAAA;IACvD,8CAAoC,CAAA;IACpC,wDAA8C,CAAA;IAC9C,mDAAyC,CAAA;IACzC,6BAAmB,CAAA;IACnB,yCAA+B,CAAA;IAC/B,qDAA2C,CAAA;AAC/C,CAAC,EAhEW,MAAM,KAAN,MAAM,QAgEjB;AAQD,qCAAqC;AACrC,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,sDAAqC,CAAA;IACrC,sEAAqD,CAAA;AACzD,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB"}

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

@@ -88,7 +88,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
             pageId?: Page;
             /**
                 * This puts a filter tag on the application. All metadata lists in the application, such as
-                * liveboards and answers, would be filtered by this tag.
+                * Liveboards and answers, would be filtered by this tag.
                 */
             tag?: string;
             /**
@@ -103,6 +103,13 @@ declare module '@thoughtspot/visual-embed-sdk/embed/app' {
     export class AppEmbed extends V1Embed {
             protected viewConfig: AppViewConfig;
             constructor(domSelector: DOMSelector, viewConfig: AppViewConfig);
+            /**
+                * Navigate to particular page for app embed. eg:answers/pinboards/home
+                * This is used for embedding answers, pinboards, visualizations and full application only.
+                * @param path The string, set to iframe src and navigate to new page
+                * eg: appEmbed.navigateToPage('pinboards')
+                */
+            navigateToPage(path: string): void;
             /**
                 * Renders the embedded application pages in the ThoughtSpot app.
                 * @param renderOptions An object containing the page ID
@@ -144,7 +151,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
     /**
         * Copyright (c) 2021
         *
-        * Embed a ThoughtSpot liveboard or visualization
+        * Embed a ThoughtSpot Liveboard or visualization
         * https://developers.thoughtspot.com/docs/?pageid=embed-pinboard
         * https://developers.thoughtspot.com/docs/?pageid=embed-a-viz
         *
@@ -154,21 +161,21 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
     import { DOMSelector } from '@thoughtspot/visual-embed-sdk/types';
     import { V1Embed, ViewConfig } from '@thoughtspot/visual-embed-sdk/embed/ts-embed';
     /**
-        * The configuration for the embedded liveboard or visualization page view.
+        * The configuration for the embedded Liveboard or visualization page view.
         * @Category Liveboards and Charts
         */
     export interface LiveboardViewConfig extends ViewConfig {
             /**
                 * If set to true, the embedded object container dynamically resizes
-                * according to the height of the liveboard.
+                * according to the height of the Liveboard.
                 */
             fullHeight?: boolean;
             /**
-                * This is the minimum height(in pixels) for a full height liveboard.
-                * Setting this height helps resolves issues with empty liveboards and
-                * other screens navigable from a liveboard.
+                * This is the minimum height(in pixels) for a full height Liveboard.
+                * Setting this height helps resolves issues with empty Liveboards and
+                * other screens navigable from a Liveboard.
+                * *_since 1.5.0_
                 * @default 500
-                * * _since 1.5.0_
                 */
             defaultHeight?: number;
             /**
@@ -176,7 +183,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             enableVizTransformations?: boolean;
             /**
-                * The liveboard to display in the embedded view.
+                * The Liveboard to display in the embedded view.
                 * Use either of liveboardId or pinboardId to reference the Liveboard to embed.
                 */
             liveboardId?: string;
@@ -186,12 +193,12 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
                 */
             pinboardId?: string;
             /**
-                * The visualization within the liveboard to display.
+                * The visualization within the Liveboard to display.
                 */
             vizId?: string;
             /**
                 * If set to true, all filter chips from a
-                * liveboard page will be read-only (no X buttons)
+                * Liveboard page will be read-only (no X buttons)
                 */
             preventLiveboardFilterRemoval?: boolean;
             /**
@@ -201,15 +208,15 @@ declare module '@thoughtspot/visual-embed-sdk/embed/liveboard' {
             preventPinboardFilterRemoval?: boolean;
     }
     /**
-        * Embed a ThoughtSpot liveboard or visualization
+        * Embed a ThoughtSpot Liveboard or visualization
         * @Category Liveboards and Charts
         */
     export class LiveboardEmbed extends V1Embed {
             protected viewConfig: LiveboardViewConfig;
             constructor(domSelector: DOMSelector, viewConfig: LiveboardViewConfig);
             /**
-                * Render an embedded ThoughtSpot liveboard or visualization
-                * @param renderOptions An object specifying the liveboard ID,
+                * Render an embedded ThoughtSpot Liveboard or visualization
+                * @param renderOptions An object specifying the Liveboard ID,
                 * visualization ID and the runtime filters.
                 */
             render(): LiveboardEmbed;
@@ -421,12 +428,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * When there are multiple embeds, queue the render of embed to start
                 *  after the previous embed's render is complete. This helps in the load performance
                 *  by decreasing the load on the browser.
+                * * _Version 1.5.0 or later _
                 * @default false
                 */
             queueMultiRenders?: boolean;
             /**
                 * Dynamic CSS Url to be injected in the loaded application.
-                * _Since: 1.6.0_
+                * * _Version 1.6.0 or later _
                 * @default ''
                 */
             customCssUrl?: string;
@@ -502,7 +510,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             IN = "IN"
     }
     /**
-        * A filter that can be applied to ThoughtSpot answers, liveboards, or
+        * A filter that can be applied to ThoughtSpot answers, Liveboards, or
         * visualizations at runtime.
         */
     export interface RuntimeFilter {
@@ -540,12 +548,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             Load = "load",
             /**
-                * Data pertaining to answer or liveboard is received
-                * @return data - The answer or liveboard data
+                * Data pertaining to answer or Liveboard is received
+                * @return data - The answer or Liveboard data
                 */
             Data = "data",
             /**
-                * Search/answer/liveboard filters have been applied/updated
+                * Search/answer/Liveboard filters have been applied/updated
                 * @hidden
                 */
             FiltersChanged = "filtersChanged",
@@ -568,13 +576,13 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             /**
                 * A custom action has been triggered
                 * @return actionId - The id of the custom action
-                * @return data - The answer or liveboard data
+                * @return data - The answer or Liveboard data
                 */
             CustomAction = "customAction",
             /**
                 * A double click has been triggered on table/chart
                 * @return ContextMenuInputPoints - data point that is double clicked
-                * * _since: 1.5.0_
+                * * _Version 1.5.0 or later _
                 */
             VizPointDoubleClick = "vizPointDoubleClick",
             /**
@@ -592,8 +600,8 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             AuthExpire = "ThoughtspotAuthExpired",
             /**
-                * The height of the embedded liveboard or visualization has been computed.
-                * @return data - The height of the embedded liveboard or visualization
+                * The height of the embedded Liveboard or visualization has been computed.
+                * @return data - The height of the embedded Liveboard or visualization
                 * @hidden
                 */
             EmbedHeight = "EMBED_HEIGHT",
@@ -605,7 +613,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             EmbedIframeCenter = "EmbedIframeCenter",
             /**
                 * Detects the route change.
-                * @hidden
                 */
             RouteChange = "ROUTE_CHANGE",
             /**
@@ -628,12 +635,12 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             SAMLComplete = "samlComplete",
             /**
                 * Emitted when any modal is opened in the app
-                * * _since: 1.6.0_
+                * * _Version 1.6.0 or later _
                 */
             DialogOpen = "dialog-open",
             /**
                 * Emitted when any modal is closed in the app
-                * * _since: 1.6.0_
+                * * _Version 1.6.0 or later _
                 */
             DialogClose = "dialog-close"
     }
@@ -654,7 +661,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 *              eg. { selectedPoints: []}
                 * @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. \
-                * * _since: 1.5.0_
+                * * _Version 1.5.0 or later _
                 */
             DrillDown = "triggerDrillDown",
             /**
@@ -668,10 +675,10 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 */
             Reload = "reload",
             /**
-                * Set the visible Vizs on a pinboard/liveboard.
-                * @param - an array of ids of vizs to show, the ids not passed
+                * Set the visible visualizations on a Liveboard.
+                * @param - an array of ids of visualizations to show, the ids not passed
                 *          will be hidden.
-                * _since: 1.6.0_
+                * * _Version 1.6.0 or later _
                 */
             SetVisibleVizs = "SetPinboardVisibleVizs"
     }
@@ -725,7 +732,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
     }
     /**
         * The list of actions that can be performed on visual ThoughtSpot
-        * entities, such as answers and liveboards.
+        * entities, such as answers and Liveboards.
         */
     export enum Action {
             Save = "save",
@@ -735,11 +742,6 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
             MakeACopy = "makeACopy",
             EditACopy = "editACopy",
             CopyLink = "embedDocument",
-            /**
-                * @hidden
-                */
-            PinboardSnapshot = "pinboardSnapshot",
-            LiveboardSnapshot = "liveboardSnapshot",
             ResetLayout = "resetLayout",
             Schedule = "schedule",
             SchedulesList = "schedule-list",
@@ -776,7 +778,7 @@ declare module '@thoughtspot/visual-embed-sdk/types' {
                 * @hidden
                 */
             PinboardInfo = "pinboardInfo",
-            LiveboardInfo = "liveboardInfo",
+            LiveboardInfo = "pinboardInfo",
             SendAnswerFeedback = "sendFeedback",
             /**
                 * @deprecated Will be removed in next version
@@ -881,7 +883,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
             visibleActions?: Action[];
             /**
                 * The list of runtime filters to apply to a search answer,
-                * visualization, or liveboard.
+                * visualization, or Liveboard.
                 */
             runtimeFilters?: RuntimeFilter[];
     }
@@ -920,7 +922,7 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
             protected getBaseQueryParams(): {};
             /**
                 * Constructs the base URL string to load v1 of the ThoughtSpot app.
-                * This is used for embedding liveboards, visualizations, and full application.
+                * This is used for embedding Liveboards, visualizations, and full application.
                 * @param queryString The query string to append to the URL.
                 * @param isAppEmbed A Boolean parameter to specify if you are embedding
                 * the full application.
@@ -979,15 +981,6 @@ declare module '@thoughtspot/visual-embed-sdk/embed/ts-embed' {
                 * @param callback A callback function
                 */
             on(messageType: EmbedEvent, callback: MessageCallback): typeof TsEmbed.prototype;
-            /**
-                * Navigates users to the specified application page.
-                * Use this method to navigate users from the embedded
-                * ThoughtSpot context to a specific page in your app.
-                * @param path The page path string.
-                * For example, to navigate users to a liveboard page,
-                * define the method as navigateToPage('liveboard/<liveboardId>').
-                */
-            navigateToPage(path: string): void;
             /**
                 * Triggers an event to the embedded app
                 * @param messageType The event type

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@thoughtspot/visual-embed-sdk",
-    "version": "1.6.0-alpha.2",
+    "version": "1.6.0-alpha.3",
     "description": "ThoughtSpot Embed SDK",
     "module": "lib/src/index.js",
     "main": "dist/tsembed.js",

package/src/embed/app.spec.ts

@@ -8,6 +8,7 @@ import {
     getRootEl,
 } from '../test/test-utils';
 import { version } from '../../package.json';
+import * as config from '../config';
 
 const defaultViewConfig = {
     frameParams: {
@@ -17,6 +18,7 @@ const defaultViewConfig = {
 };
 const thoughtSpotHost = 'tshost';
 const defaultParams = `&hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
+const defaultParamsForPinboardEmbed = `hostAppUrl=local-host&viewPortHeight=768&viewPortWidth=1024&sdkVersion=${version}`;
 
 beforeAll(() => {
     init({
@@ -168,4 +170,42 @@ describe('App embed tests', () => {
             );
         });
     });
+
+    describe('Naviage to Page API', () => {
+        const path = 'pinboard/e0836cad-4fdf-42d4-bd97-567a6b2a6058';
+        beforeEach(() => {
+            jest.spyOn(config, 'getThoughtSpotHost').mockImplementation(
+                () => 'http://tshost',
+            );
+        });
+
+        test('when app is AppEmbed after navigateToPage function call, new path should be set to iframe', async () => {
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+            });
+            await appEmbed.render();
+            appEmbed.navigateToPage(path);
+            expect(getIFrameSrc()).toBe(
+                `http://${thoughtSpotHost}/?embedApp=true&primaryNavHidden=true&profileAndHelpInNavBarHidden=false&${defaultParamsForPinboardEmbed}#/${path}`,
+            );
+        });
+
+        test('navigateToPage function use before render', async () => {
+            spyOn(console, 'log');
+            const appEmbed = new AppEmbed(getRootEl(), {
+                frameParams: {
+                    width: '100%',
+                    height: '100%',
+                },
+            });
+            appEmbed.navigateToPage(path);
+            await appEmbed.render();
+            expect(console.log).toHaveBeenCalledWith(
+                'Please call render before invoking this method',
+            );
+        });
+    });
 });

package/src/embed/app.ts

@@ -72,7 +72,7 @@ export interface AppViewConfig extends ViewConfig {
     pageId?: Page;
     /**
      * This puts a filter tag on the application. All metadata lists in the application, such as
-     * liveboards and answers, would be filtered by this tag.
+     * Liveboards and answers, would be filtered by this tag.
      */
     tag?: string;
     /**
@@ -95,7 +95,7 @@ export class AppEmbed extends V1Embed {
 
     /**
      * Constructs a map of parameters to be passed on to the
-     * embedded liveboard or visualization.
+     * embedded Liveboard or visualization.
      */
     private getEmbedParams() {
         const params = this.getBaseQueryParams();
@@ -173,6 +173,25 @@ export class AppEmbed extends V1Embed {
         return path;
     }
 
+    /**
+     * Navigate to particular page for app embed. eg:answers/pinboards/home
+     * This is used for embedding answers, pinboards, visualizations and full application only.
+     * @param path The string, set to iframe src and navigate to new page
+     * eg: appEmbed.navigateToPage('pinboards')
+     */
+    public navigateToPage(path: string): void {
+        if (this.iFrame) {
+            const iframeSrc = this.iFrame.src;
+            const embedPath = '#/embed';
+            const currentPath = iframeSrc.includes(embedPath) ? embedPath : '#';
+            this.iFrame.src = `${
+                iframeSrc.split(currentPath)[0]
+            }${currentPath}/${path.replace(/^\/?#?\//, '')}`;
+        } else {
+            console.log('Please call render before invoking this method');
+        }
+    }
+
     /**
      * Renders the embedded application pages in the ThoughtSpot app.
      * @param renderOptions An object containing the page ID