@thoughtspot/visual-embed-sdk 1.27.9 → 1.27.11

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 (221) hide show
  1. package/cjs/package.json +2 -2
  2. package/cjs/src/embed/app.d.ts +144 -7
  3. package/cjs/src/embed/app.d.ts.map +1 -1
  4. package/cjs/src/embed/app.js +5 -5
  5. package/cjs/src/embed/app.js.map +1 -1
  6. package/cjs/src/embed/app.spec.js +19 -1
  7. package/cjs/src/embed/app.spec.js.map +1 -1
  8. package/cjs/src/embed/base.d.ts.map +1 -1
  9. package/cjs/src/embed/base.js +0 -3
  10. package/cjs/src/embed/base.js.map +1 -1
  11. package/cjs/src/embed/embed.spec.js +0 -15
  12. package/cjs/src/embed/embed.spec.js.map +1 -1
  13. package/cjs/src/embed/liveboard.d.ts +113 -4
  14. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  15. package/cjs/src/embed/liveboard.js +2 -2
  16. package/cjs/src/embed/liveboard.js.map +1 -1
  17. package/cjs/src/embed/liveboard.spec.js +20 -1
  18. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  19. package/cjs/src/embed/pinboard.spec.js +20 -1
  20. package/cjs/src/embed/pinboard.spec.js.map +1 -1
  21. package/cjs/src/embed/sage.d.ts +1 -1
  22. package/cjs/src/embed/sage.d.ts.map +1 -1
  23. package/cjs/src/embed/sage.js +2 -2
  24. package/cjs/src/embed/sage.js.map +1 -1
  25. package/cjs/src/embed/search-bar.d.ts +37 -6
  26. package/cjs/src/embed/search-bar.d.ts.map +1 -1
  27. package/cjs/src/embed/search-bar.js +2 -2
  28. package/cjs/src/embed/search-bar.js.map +1 -1
  29. package/cjs/src/embed/search.d.ts +80 -1
  30. package/cjs/src/embed/search.d.ts.map +1 -1
  31. package/cjs/src/embed/search.js +3 -3
  32. package/cjs/src/embed/search.js.map +1 -1
  33. package/cjs/src/embed/search.spec.js +25 -1
  34. package/cjs/src/embed/search.spec.js.map +1 -1
  35. package/cjs/src/embed/ts-embed-trigger.spec.d.ts +2 -0
  36. package/cjs/src/embed/ts-embed-trigger.spec.d.ts.map +1 -0
  37. package/cjs/src/embed/ts-embed-trigger.spec.js +34 -0
  38. package/cjs/src/embed/ts-embed-trigger.spec.js.map +1 -0
  39. package/cjs/src/embed/ts-embed.d.ts +1 -1
  40. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  41. package/cjs/src/embed/ts-embed.js +14 -11
  42. package/cjs/src/embed/ts-embed.js.map +1 -1
  43. package/cjs/src/embed/ts-embed.spec.js +50 -17
  44. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  45. package/cjs/src/index.d.ts +5 -3
  46. package/cjs/src/index.d.ts.map +1 -1
  47. package/cjs/src/index.js +6 -1
  48. package/cjs/src/index.js.map +1 -1
  49. package/cjs/src/mixpanel-service.d.ts +1 -0
  50. package/cjs/src/mixpanel-service.d.ts.map +1 -1
  51. package/cjs/src/mixpanel-service.js +1 -0
  52. package/cjs/src/mixpanel-service.js.map +1 -1
  53. package/cjs/src/react/all-types-export.d.ts +1 -1
  54. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  55. package/cjs/src/react/all-types-export.js +2 -1
  56. package/cjs/src/react/all-types-export.js.map +1 -1
  57. package/cjs/src/react/index.spec.js +1 -1
  58. package/cjs/src/react/index.spec.js.map +1 -1
  59. package/cjs/src/test/test-utils.d.ts +1 -0
  60. package/cjs/src/test/test-utils.d.ts.map +1 -1
  61. package/cjs/src/test/test-utils.js +10 -1
  62. package/cjs/src/test/test-utils.js.map +1 -1
  63. package/cjs/src/tokenizedFetch.d.ts +9 -0
  64. package/cjs/src/tokenizedFetch.d.ts.map +1 -1
  65. package/cjs/src/tokenizedFetch.js +9 -0
  66. package/cjs/src/tokenizedFetch.js.map +1 -1
  67. package/cjs/src/types.d.ts +295 -44
  68. package/cjs/src/types.d.ts.map +1 -1
  69. package/cjs/src/types.js +119 -21
  70. package/cjs/src/types.js.map +1 -1
  71. package/cjs/src/utils/authService/authService.d.ts.map +1 -1
  72. package/cjs/src/utils/authService/authService.js +8 -2
  73. package/cjs/src/utils/authService/authService.js.map +1 -1
  74. package/cjs/src/utils/authService/authService.spec.js +22 -0
  75. package/cjs/src/utils/authService/authService.spec.js.map +1 -1
  76. package/cjs/src/utils/graphql/answerService/answerService.d.ts +56 -2
  77. package/cjs/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  78. package/cjs/src/utils/graphql/answerService/answerService.js +55 -0
  79. package/cjs/src/utils/graphql/answerService/answerService.js.map +1 -1
  80. package/dist/src/embed/app.d.ts +144 -7
  81. package/dist/src/embed/app.d.ts.map +1 -1
  82. package/dist/src/embed/base.d.ts.map +1 -1
  83. package/dist/src/embed/liveboard.d.ts +113 -4
  84. package/dist/src/embed/liveboard.d.ts.map +1 -1
  85. package/dist/src/embed/sage.d.ts +1 -1
  86. package/dist/src/embed/sage.d.ts.map +1 -1
  87. package/dist/src/embed/search-bar.d.ts +37 -6
  88. package/dist/src/embed/search-bar.d.ts.map +1 -1
  89. package/dist/src/embed/search.d.ts +80 -1
  90. package/dist/src/embed/search.d.ts.map +1 -1
  91. package/dist/src/embed/ts-embed-trigger.spec.d.ts +2 -0
  92. package/dist/src/embed/ts-embed-trigger.spec.d.ts.map +1 -0
  93. package/dist/src/embed/ts-embed.d.ts +1 -1
  94. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  95. package/dist/src/index.d.ts +5 -3
  96. package/dist/src/index.d.ts.map +1 -1
  97. package/dist/src/mixpanel-service.d.ts +1 -0
  98. package/dist/src/mixpanel-service.d.ts.map +1 -1
  99. package/dist/src/react/all-types-export.d.ts +1 -1
  100. package/dist/src/react/all-types-export.d.ts.map +1 -1
  101. package/dist/src/test/test-utils.d.ts +1 -0
  102. package/dist/src/test/test-utils.d.ts.map +1 -1
  103. package/dist/src/tokenizedFetch.d.ts +9 -0
  104. package/dist/src/tokenizedFetch.d.ts.map +1 -1
  105. package/dist/src/types.d.ts +295 -44
  106. package/dist/src/types.d.ts.map +1 -1
  107. package/dist/src/utils/authService/authService.d.ts.map +1 -1
  108. package/dist/src/utils/graphql/answerService/answerService.d.ts +56 -2
  109. package/dist/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  110. package/dist/tsembed-react.es.js +219 -47
  111. package/dist/tsembed-react.js +212 -47
  112. package/dist/tsembed.es.js +336 -167
  113. package/dist/tsembed.js +15335 -15170
  114. package/dist/visual-embed-sdk-react-full.d.ts +769 -66
  115. package/dist/visual-embed-sdk-react.d.ts +769 -66
  116. package/dist/visual-embed-sdk.d.ts +769 -66
  117. package/lib/package.json +2 -2
  118. package/lib/src/embed/app.d.ts +144 -7
  119. package/lib/src/embed/app.d.ts.map +1 -1
  120. package/lib/src/embed/app.js +5 -5
  121. package/lib/src/embed/app.js.map +1 -1
  122. package/lib/src/embed/app.spec.js +19 -1
  123. package/lib/src/embed/app.spec.js.map +1 -1
  124. package/lib/src/embed/base.d.ts.map +1 -1
  125. package/lib/src/embed/base.js +0 -3
  126. package/lib/src/embed/base.js.map +1 -1
  127. package/lib/src/embed/embed.spec.js +2 -17
  128. package/lib/src/embed/embed.spec.js.map +1 -1
  129. package/lib/src/embed/liveboard.d.ts +113 -4
  130. package/lib/src/embed/liveboard.d.ts.map +1 -1
  131. package/lib/src/embed/liveboard.js +3 -3
  132. package/lib/src/embed/liveboard.js.map +1 -1
  133. package/lib/src/embed/liveboard.spec.js +20 -1
  134. package/lib/src/embed/liveboard.spec.js.map +1 -1
  135. package/lib/src/embed/pinboard.spec.js +20 -1
  136. package/lib/src/embed/pinboard.spec.js.map +1 -1
  137. package/lib/src/embed/sage.d.ts +1 -1
  138. package/lib/src/embed/sage.d.ts.map +1 -1
  139. package/lib/src/embed/sage.js +2 -2
  140. package/lib/src/embed/sage.js.map +1 -1
  141. package/lib/src/embed/search-bar.d.ts +37 -6
  142. package/lib/src/embed/search-bar.d.ts.map +1 -1
  143. package/lib/src/embed/search-bar.js +2 -2
  144. package/lib/src/embed/search-bar.js.map +1 -1
  145. package/lib/src/embed/search.d.ts +80 -1
  146. package/lib/src/embed/search.d.ts.map +1 -1
  147. package/lib/src/embed/search.js +3 -3
  148. package/lib/src/embed/search.js.map +1 -1
  149. package/lib/src/embed/search.spec.js +25 -1
  150. package/lib/src/embed/search.spec.js.map +1 -1
  151. package/lib/src/embed/ts-embed-trigger.spec.d.ts +2 -0
  152. package/lib/src/embed/ts-embed-trigger.spec.d.ts.map +1 -0
  153. package/lib/src/embed/ts-embed-trigger.spec.js +32 -0
  154. package/lib/src/embed/ts-embed-trigger.spec.js.map +1 -0
  155. package/lib/src/embed/ts-embed.d.ts +1 -1
  156. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  157. package/lib/src/embed/ts-embed.js +14 -11
  158. package/lib/src/embed/ts-embed.js.map +1 -1
  159. package/lib/src/embed/ts-embed.spec.js +44 -11
  160. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  161. package/lib/src/index.d.ts +5 -3
  162. package/lib/src/index.d.ts.map +1 -1
  163. package/lib/src/index.js +3 -3
  164. package/lib/src/index.js.map +1 -1
  165. package/lib/src/mixpanel-service.d.ts +1 -0
  166. package/lib/src/mixpanel-service.d.ts.map +1 -1
  167. package/lib/src/mixpanel-service.js +1 -0
  168. package/lib/src/mixpanel-service.js.map +1 -1
  169. package/lib/src/react/all-types-export.d.ts +1 -1
  170. package/lib/src/react/all-types-export.d.ts.map +1 -1
  171. package/lib/src/react/all-types-export.js +1 -1
  172. package/lib/src/react/all-types-export.js.map +1 -1
  173. package/lib/src/react/index.spec.js +1 -1
  174. package/lib/src/react/index.spec.js.map +1 -1
  175. package/lib/src/test/test-utils.d.ts +1 -0
  176. package/lib/src/test/test-utils.d.ts.map +1 -1
  177. package/lib/src/test/test-utils.js +8 -0
  178. package/lib/src/test/test-utils.js.map +1 -1
  179. package/lib/src/tokenizedFetch.d.ts +9 -0
  180. package/lib/src/tokenizedFetch.d.ts.map +1 -1
  181. package/lib/src/tokenizedFetch.js +9 -0
  182. package/lib/src/tokenizedFetch.js.map +1 -1
  183. package/lib/src/types.d.ts +295 -44
  184. package/lib/src/types.d.ts.map +1 -1
  185. package/lib/src/types.js +119 -21
  186. package/lib/src/types.js.map +1 -1
  187. package/lib/src/utils/authService/authService.d.ts.map +1 -1
  188. package/lib/src/utils/authService/authService.js +8 -2
  189. package/lib/src/utils/authService/authService.js.map +1 -1
  190. package/lib/src/utils/authService/authService.spec.js +22 -0
  191. package/lib/src/utils/authService/authService.spec.js.map +1 -1
  192. package/lib/src/utils/graphql/answerService/answerService.d.ts +56 -2
  193. package/lib/src/utils/graphql/answerService/answerService.d.ts.map +1 -1
  194. package/lib/src/utils/graphql/answerService/answerService.js +55 -0
  195. package/lib/src/utils/graphql/answerService/answerService.js.map +1 -1
  196. package/lib/src/visual-embed-sdk.d.ts +778 -69
  197. package/package.json +2 -2
  198. package/src/embed/app.spec.ts +24 -1
  199. package/src/embed/app.ts +148 -13
  200. package/src/embed/base.ts +1 -5
  201. package/src/embed/embed.spec.ts +0 -18
  202. package/src/embed/liveboard.spec.ts +24 -1
  203. package/src/embed/liveboard.ts +121 -15
  204. package/src/embed/pinboard.spec.ts +24 -1
  205. package/src/embed/sage.ts +2 -2
  206. package/src/embed/search-bar.tsx +38 -7
  207. package/src/embed/search.spec.ts +29 -1
  208. package/src/embed/search.ts +82 -3
  209. package/src/embed/ts-embed-trigger.spec.ts +39 -0
  210. package/src/embed/ts-embed.spec.ts +46 -11
  211. package/src/embed/ts-embed.ts +18 -14
  212. package/src/index.ts +12 -1
  213. package/src/mixpanel-service.ts +1 -0
  214. package/src/react/all-types-export.ts +1 -0
  215. package/src/react/index.spec.tsx +1 -0
  216. package/src/test/test-utils.ts +9 -0
  217. package/src/tokenizedFetch.ts +9 -0
  218. package/src/types.ts +296 -42
  219. package/src/utils/authService/authService.spec.ts +27 -0
  220. package/src/utils/authService/authService.ts +13 -12
  221. package/src/utils/graphql/answerService/answerService.ts +56 -1
@@ -32,6 +32,14 @@ var OperationType;
32
32
  * @group Events
33
33
  */
34
34
  class AnswerService {
35
+ /**
36
+ * Should not need to be called directly.
37
+ *
38
+ * @param session
39
+ * @param answer
40
+ * @param thoughtSpotHost
41
+ * @param selectedPoints
42
+ */
35
43
  constructor(session, answer, thoughtSpotHost, selectedPoints) {
36
44
  this.session = session;
37
45
  this.answer = answer;
@@ -39,20 +47,43 @@ class AnswerService {
39
47
  this.selectedPoints = selectedPoints;
40
48
  this.session = (0, utils_1.removeTypename)(session);
41
49
  }
50
+ /**
51
+ * Get the details about the source used in the answer.
52
+ * This can be used to get the list of all columns in the data source for example.
53
+ */
42
54
  async getSourceDetail() {
43
55
  const sourceId = this.answer.sources[0].header.guid;
44
56
  return (0, sourceService_1.getSourceDetail)(this.thoughtSpotHost, sourceId);
45
57
  }
58
+ /**
59
+ * Remove columnIds and return updated answer session.
60
+ *
61
+ * @param columnIds
62
+ * @returns
63
+ */
46
64
  async removeColumns(columnIds) {
47
65
  return this.executeQuery(queries.removeColumns, {
48
66
  logicalColumnIds: columnIds,
49
67
  });
50
68
  }
69
+ /**
70
+ * Add columnIds and return updated answer session.
71
+ *
72
+ * @param columnIds
73
+ * @returns
74
+ */
51
75
  async addColumns(columnIds) {
52
76
  return this.executeQuery(queries.addColumns, {
53
77
  columns: columnIds.map((colId) => ({ logicalColumnId: colId })),
54
78
  });
55
79
  }
80
+ /**
81
+ * Fetch data from the answer.
82
+ *
83
+ * @param offset
84
+ * @param size
85
+ * @returns
86
+ */
56
87
  async fetchData(offset = 0, size = 1000) {
57
88
  const { answer } = await this.executeQuery(queries.getAnswerData, {
58
89
  deadline: 0,
@@ -69,6 +100,8 @@ class AnswerService {
69
100
  };
70
101
  }
71
102
  /**
103
+ * Fetch the data for the answer as a CSV blob. This might be
104
+ * quicker for larger data.
72
105
  *
73
106
  * @param userLocale
74
107
  * @param includeInfo Include the CSV header in the output
@@ -80,11 +113,21 @@ class AnswerService {
80
113
  credentials: 'include',
81
114
  });
82
115
  }
116
+ /**
117
+ * Just get the internal URL for this answer's data
118
+ * as a CSV blob.
119
+ *
120
+ * @param userLocale
121
+ * @param includeInfo
122
+ * @returns
123
+ */
83
124
  getFetchCSVBlobUrl(userLocale = 'en-us', includeInfo = false) {
84
125
  return `${this.thoughtSpotHost}/prism/download/answer/csv?sessionId=${this.session.sessionId}&genNo=${this.session.genNo}&userLocale=${userLocale}&exportFileName=data&hideCsvHeader=${!includeInfo}`;
85
126
  }
86
127
  /**
87
128
  * Get underlying data given a point and the output column names.
129
+ * In case of a context menu action, the selectedPoints are
130
+ * automatically passed.
88
131
  *
89
132
  * @param outputColumnNames
90
133
  * @param selectedPoints
@@ -129,6 +172,13 @@ class AnswerService {
129
172
  }
130
173
  return unaggAnswerSession;
131
174
  }
175
+ /**
176
+ * Execute a custom graphql query in the context of the answer.
177
+ *
178
+ * @param query graphql query
179
+ * @param variables graphql variables
180
+ * @returns
181
+ */
132
182
  async executeQuery(query, variables) {
133
183
  const data = await (0, graphql_request_1.graphqlQuery)({
134
184
  query,
@@ -142,6 +192,11 @@ class AnswerService {
142
192
  this.session = (0, utils_1.deepMerge)(this.session, (data === null || data === void 0 ? void 0 : data.id) || {});
143
193
  return data;
144
194
  }
195
+ /**
196
+ * Get the internal session details for the answer.
197
+ *
198
+ * @returns
199
+ */
145
200
  getSession() {
146
201
  return this.session;
147
202
  }
@@ -1 +1 @@
1
- {"version":3,"file":"answerService.js","sourceRoot":"","sources":["../../../../../src/utils/graphql/answerService/answerService.ts"],"names":[],"mappings":";;;;AAAA,4DAAyD;AAEzD,0CAA2D;AAC3D,wDAAkD;AAClD,oDAAmD;AACnD,kEAA4C;AAQ5C,qCAAqC;AACrC,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,sDAAqC,CAAA;IACrC,sEAAqD,CAAA;AACzD,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAOD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,aAAa;IACtB,YACY,OAAyB,EACzB,MAAW,EACX,eAAuB,EACvB,cAA2B;QAH3B,YAAO,GAAP,OAAO,CAAkB;QACzB,WAAM,GAAN,MAAM,CAAK;QACX,oBAAe,GAAf,eAAe,CAAQ;QACvB,mBAAc,GAAd,cAAc,CAAa;QAEnC,IAAI,CAAC,OAAO,GAAG,IAAA,sBAAc,EAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAEM,KAAK,CAAC,eAAe;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QACpD,OAAO,IAAA,+BAAe,EAClB,IAAI,CAAC,eAAe,EACpB,QAAQ,CACX,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAAmB;QAC1C,OAAO,IAAI,CAAC,YAAY,CACpB,OAAO,CAAC,aAAa,EACrB;YACI,gBAAgB,EAAE,SAAS;SAC9B,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,SAAmB;QACvC,OAAO,IAAI,CAAC,YAAY,CACpB,OAAO,CAAC,UAAU,EAClB;YACI,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;SAClE,CACJ,CAAC;IACN,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI;QAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CACtC,OAAO,CAAC,aAAa,EACrB;YACI,QAAQ,EAAE,CAAC;YACX,oBAAoB,EAAE;gBAClB,iBAAiB,EAAE,IAAI;gBACvB,MAAM;gBACN,IAAI;aACP;SACJ,CACJ,CAAC;QACF,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAChD,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAC3B,IAAI,EAAE,CAAC;QACR,OAAO;YACH,OAAO;YACP,IAAI;SACP,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,YAAY,CAAC,UAAU,GAAG,OAAO,EAAE,WAAW,GAAG,KAAK;QAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAClE,OAAO,IAAA,+BAAc,EAAC,QAAQ,EAAE;YAC5B,WAAW,EAAE,SAAS;SACzB,CAAC,CAAC;IACP,CAAC;IAEM,kBAAkB,CAAC,UAAU,GAAG,OAAO,EAAE,WAAW,GAAG,KAAK;QAC/D,OAAO,GAAG,IAAI,CAAC,eAAe,wCAAwC,IAAI,CAAC,OAAO,CAAC,SAAS,UAAU,IAAI,CAAC,OAAO,CAAC,KAAK,eAAe,UAAU,sCAAsC,CAAC,WAAW,EAAE,CAAC;IAC1M,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,yBAAyB,CAClC,iBAA2B,EAC3B,cAAsC;QAEtC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,cAAc,EAAE;YACjB,cAAc,GAAG,uCAAuC,CACpD,IAAI,CAAC,cAAc,CACtB,CAAC;SACL;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAClD,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;QAClF,MAAM,WAAW,GAAG,MAAM,IAAA,8BAAY,EAAC;YACnC,KAAK,EAAE,OAAO,CAAC,4BAA4B;YAC3C,SAAS,EAAE;gBACP,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,cAAc;aAC1B;YACD,eAAe,EAAE,IAAI,CAAC,eAAe;SACxC,CAAC,CAAC;QACH,MAAM,kBAAkB,GAAG,IAAI,aAAa,CACxC,WAAW,CAAC,EAAE,EACd,WAAW,CAAC,MAAM,EAClB,IAAI,CAAC,eAAe,CACvB,CAAC;QACF,MAAM,cAAc,GAAgB,IAAI,GAAG,CACvC,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO;aACvC,GAAG,CACA,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CACjD,CACR,CAAC;QAEF,MAAM,YAAY,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACrF,IAAI,YAAY,CAAC,MAAM,EAAE;YACrB,MAAM,kBAAkB,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;SACrD;QAED,MAAM,eAAe,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACxF,IAAI,eAAe,CAAC,MAAM,EAAE;YACxB,MAAM,kBAAkB,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;SAC3D;QAED,OAAO,kBAAkB,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,SAAc;QACnD,MAAM,IAAI,GAAG,MAAM,IAAA,8BAAY,EAAC;YAC5B,KAAK;YACL,SAAS,EAAE;gBACP,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,GAAG,SAAS;aACf;YACD,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,gBAAgB,EAAE,KAAK;SAC1B,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAA,iBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,KAAI,EAAE,CAAgC,CAAC;QACtF,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,UAAU;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;CACJ;AA7JD,sCA6JC;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAAC,YAAiB,EAAE,QAAkB;IAClE,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAW,EAAE,GAAQ,EAAE,EAAE;QAC/D,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,GAAG,CAAC,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;GAGG;AACH,SAAS,uCAAuC,CAC5C,cAA0B;IAE1B,MAAM,mBAAmB,GAA0B,EAAE,CAAC;IACtD;;;OAGG;IACH,SAAS,kBAAkB,CAAC,MAAmB;;QAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACxC,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,IAAI,SAAS,CAAC;QACd,IAAI,QAAQ,KAAK,MAAM,EAAE;YACrB,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;gBAC/B,SAAS,GAAG,CAAC;wBACT,UAAU,EAAE;4BACR,UAAU,EAAE,MAAM,CAAC,KAAK;yBAC3B;qBACJ,CAAC,CAAC;gBACH,4BAA4B;aAC/B;iBAAM,IAAI,MAAC,MAAM,CAAC,KAAa,0CAAE,CAAC,EAAE;gBACjC,SAAS,GAAG,CAAC;wBACT,UAAU,EAAE;4BACR,UAAU,EAAG,MAAM,CAAC,KAAa,CAAC,CAAC,CAAC,CAAC;4BACrC,QAAQ,EAAG,MAAM,CAAC,KAAa,CAAC,CAAC,CAAC,CAAC;yBACtC;qBACJ,CAAC,CAAC;aACN;SACJ;aAAM;YACH,SAAS,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;SACzC;QACD,mBAAmB,CAAC,IAAI,CAAC;YACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE;YAC1B,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACzB,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IACH,OAAO,mBAAmB,CAAC;AAC/B,CAAC"}
1
+ {"version":3,"file":"answerService.js","sourceRoot":"","sources":["../../../../../src/utils/graphql/answerService/answerService.ts"],"names":[],"mappings":";;;;AAAA,4DAAyD;AAEzD,0CAA2D;AAC3D,wDAAkD;AAClD,oDAAmD;AACnD,kEAA4C;AAQ5C,qCAAqC;AACrC,IAAY,aAGX;AAHD,WAAY,aAAa;IACrB,sDAAqC,CAAA;IACrC,sEAAqD,CAAA;AACzD,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAOD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,aAAa;IACtB;;;;;;;OAOG;IACH,YACY,OAAyB,EACzB,MAAW,EACX,eAAuB,EACvB,cAA2B;QAH3B,YAAO,GAAP,OAAO,CAAkB;QACzB,WAAM,GAAN,MAAM,CAAK;QACX,oBAAe,GAAf,eAAe,CAAQ;QACvB,mBAAc,GAAd,cAAc,CAAa;QAEnC,IAAI,CAAC,OAAO,GAAG,IAAA,sBAAc,EAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,eAAe;QACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QACpD,OAAO,IAAA,+BAAe,EAClB,IAAI,CAAC,eAAe,EACpB,QAAQ,CACX,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,SAAmB;QAC1C,OAAO,IAAI,CAAC,YAAY,CACpB,OAAO,CAAC,aAAa,EACrB;YACI,gBAAgB,EAAE,SAAS;SAC9B,CACJ,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,SAAmB;QACvC,OAAO,IAAI,CAAC,YAAY,CACpB,OAAO,CAAC,UAAU,EAClB;YACI,OAAO,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;SAClE,CACJ,CAAC;IACN,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,GAAG,IAAI;QAC1C,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,CACtC,OAAO,CAAC,aAAa,EACrB;YACI,QAAQ,EAAE,CAAC;YACX,oBAAoB,EAAE;gBAClB,iBAAiB,EAAE,IAAI;gBACvB,MAAM;gBACN,IAAI;aACP;SACJ,CACJ,CAAC;QACF,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CAChD,CAAC,GAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAC3B,IAAI,EAAE,CAAC;QACR,OAAO;YACH,OAAO;YACP,IAAI;SACP,CAAC;IACN,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,YAAY,CAAC,UAAU,GAAG,OAAO,EAAE,WAAW,GAAG,KAAK;QAC/D,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAClE,OAAO,IAAA,+BAAc,EAAC,QAAQ,EAAE;YAC5B,WAAW,EAAE,SAAS;SACzB,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,UAAU,GAAG,OAAO,EAAE,WAAW,GAAG,KAAK;QAC/D,OAAO,GAAG,IAAI,CAAC,eAAe,wCAAwC,IAAI,CAAC,OAAO,CAAC,SAAS,UAAU,IAAI,CAAC,OAAO,CAAC,KAAK,eAAe,UAAU,sCAAsC,CAAC,WAAW,EAAE,CAAC;IAC1M,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,yBAAyB,CAClC,iBAA2B,EAC3B,cAAsC;QAEtC,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;YACzC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;SAClE;QAED,IAAI,CAAC,cAAc,EAAE;YACjB,cAAc,GAAG,uCAAuC,CACpD,IAAI,CAAC,cAAc,CACtB,CAAC;SACL;QAED,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAClD,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,YAAY,EAAE,iBAAiB,CAAC,CAAC;QAClF,MAAM,WAAW,GAAG,MAAM,IAAA,8BAAY,EAAC;YACnC,KAAK,EAAE,OAAO,CAAC,4BAA4B;YAC3C,SAAS,EAAE;gBACP,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,cAAc;aAC1B;YACD,eAAe,EAAE,IAAI,CAAC,eAAe;SACxC,CAAC,CAAC;QACH,MAAM,kBAAkB,GAAG,IAAI,aAAa,CACxC,WAAW,CAAC,EAAE,EACd,WAAW,CAAC,MAAM,EAClB,IAAI,CAAC,eAAe,CACvB,CAAC;QACF,MAAM,cAAc,GAAgB,IAAI,GAAG,CACvC,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO;aACvC,GAAG,CACA,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CACjD,CACR,CAAC;QAEF,MAAM,YAAY,GAAG,CAAC,GAAG,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACrF,IAAI,YAAY,CAAC,MAAM,EAAE;YACrB,MAAM,kBAAkB,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;SACrD;QAED,MAAM,eAAe,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QACxF,IAAI,eAAe,CAAC,MAAM,EAAE;YACxB,MAAM,kBAAkB,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;SAC3D;QAED,OAAO,kBAAkB,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,KAAa,EAAE,SAAc;QACnD,MAAM,IAAI,GAAG,MAAM,IAAA,8BAAY,EAAC;YAC5B,KAAK;YACL,SAAS,EAAE;gBACP,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,GAAG,SAAS;aACf;YACD,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,gBAAgB,EAAE,KAAK;SAC1B,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAA,iBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,KAAI,EAAE,CAAgC,CAAC;QACtF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,UAAU;QACb,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;CACJ;AApND,sCAoNC;AAED;;;;GAIG;AACH,SAAS,uBAAuB,CAAC,YAAiB,EAAE,QAAkB;IAClE,MAAM,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAW,EAAE,GAAQ,EAAE,EAAE;QAC/D,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;QACvB,OAAO,MAAM,CAAC;IAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACpC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,GAAG,CAAC,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC,CAAC;AACR,CAAC;AAED;;;GAGG;AACH,SAAS,uCAAuC,CAC5C,cAA0B;IAE1B,MAAM,mBAAmB,GAA0B,EAAE,CAAC;IACtD;;;OAGG;IACH,SAAS,kBAAkB,CAAC,MAAmB;;QAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACxC,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,IAAI,SAAS,CAAC;QACd,IAAI,QAAQ,KAAK,MAAM,EAAE;YACrB,IAAI,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;gBAC/B,SAAS,GAAG,CAAC;wBACT,UAAU,EAAE;4BACR,UAAU,EAAE,MAAM,CAAC,KAAK;yBAC3B;qBACJ,CAAC,CAAC;gBACH,4BAA4B;aAC/B;iBAAM,IAAI,MAAC,MAAM,CAAC,KAAa,0CAAE,CAAC,EAAE;gBACjC,SAAS,GAAG,CAAC;wBACT,UAAU,EAAE;4BACR,UAAU,EAAG,MAAM,CAAC,KAAa,CAAC,CAAC,CAAC,CAAC;4BACrC,QAAQ,EAAG,MAAM,CAAC,KAAa,CAAC,CAAC,CAAC,CAAC;yBACtC;qBACJ,CAAC,CAAC;aACN;SACJ;aAAM;YACH,SAAS,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;SACzC;QACD,mBAAmB,CAAC,IAAI,CAAC;YACrB,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE;YAC1B,SAAS;SACZ,CAAC,CAAC;IACP,CAAC;IAED,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;QACzB,CAAC,CAAC,kBAAkB,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IACH,OAAO,mBAAmB,CAAC;AAC/B,CAAC"}
@@ -8,7 +8,7 @@
8
8
  * @module
9
9
  * @author Ayon Ghosh <ayon.ghosh@thoughtspot.com>
10
10
  */
11
- import { DOMSelector, ViewConfig, MessagePayload } from '../types';
11
+ import { DOMSelector, MessagePayload, ViewConfig } from '../types';
12
12
  import { V1Embed } from './ts-embed';
13
13
  /**
14
14
  * Pages within the ThoughtSpot app that can be embedded.
@@ -53,6 +53,16 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
53
53
  * If true, the top navigation bar within the ThoughtSpot app
54
54
  * is displayed. By default, the navigation bar is hidden.
55
55
  * This flag also controls the homepage left navigation bar.
56
+ *
57
+ * @default true
58
+ * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
59
+ * @example
60
+ * ```js
61
+ * const embed = new AppEmbed('#tsEmbed', {
62
+ * ... // other options
63
+ * showPrimaryNavbar:true,
64
+ * })
65
+ * ```
56
66
  */
57
67
  showPrimaryNavbar?: boolean;
58
68
  /**
@@ -61,23 +71,73 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
61
71
  * nav-bars are visible, this flag will only hide the homepage left nav-bar.
62
72
  * The showPrimaryNavbar flag takes precedence over the hideHomepageLeftNav.
63
73
  *
74
+ * **Note**: This option does not apply to the classic homepage.
75
+ * To access the updated modular homepage, set
76
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
77
+ *
64
78
  * @default false
65
- * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
79
+ * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
80
+ * @example
81
+ * ```js
82
+ * const embed = new AppEmbed('#tsEmbed', {
83
+ * ... // other options
84
+ * hideHomepageLeftNav : true,
85
+ * })
86
+ * ```
66
87
  */
67
88
  hideHomepageLeftNav?: boolean;
68
89
  /**
69
90
  * Control the visibility of the help (?) and profile buttons on the
70
91
  * Global nav-bar. By default, these buttons are visible on the nav-bar.
92
+ *
93
+ * @default false
94
+ * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
95
+ * @example
96
+ * ```js
97
+ * const embed = new AppEmbed('#tsEmbed', {
98
+ * ... // other options
99
+ * disableProfileAndHelp: true,
100
+ * })
101
+ * ```
71
102
  */
72
103
  disableProfileAndHelp?: boolean;
73
104
  /**
74
105
  * Control the visibility of the application switcher button on the nav-bar.
75
106
  * By default, the application switcher is shown.
107
+ *
108
+ * **Note**: This option does not apply to the classic homepage.
109
+ * To access the updated modular homepage, set
110
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
111
+ *
112
+ * @default false
113
+ * @version SDK: 1.2.0 | Thoughtspot: 8.4.0.cl
114
+ * @example
115
+ * ```js
116
+ * const embed = new AppEmbed('#tsEmbed', {
117
+ * ... // other options
118
+ * hideApplicationSwitcher : true,
119
+ * })
120
+ * ```
76
121
  */
77
122
  hideApplicationSwitcher?: boolean;
78
123
  /**
79
124
  * Control the visibility of the Org switcher button on the nav-bar.
80
125
  * By default, the Org switcher button is shown.
126
+ *
127
+ * **Note**: This option does not apply to the classic homepage.
128
+ * To access the updated modular homepage, set
129
+ * `modularHomeExperience` to `true` (available in Early Access from 9.12 forward).
130
+ *
131
+ *
132
+ * @default true
133
+ * @version SDK: 1.2.0 | Thoughtspot: 9.4.0.cl
134
+ * @example
135
+ * ```js
136
+ * const embed = new AppEmbed('#tsEmbed', {
137
+ * ... // other options
138
+ * hideOrgSwitcher : true,
139
+ * })
140
+ * ```
81
141
  */
82
142
  hideOrgSwitcher?: boolean;
83
143
  /**
@@ -89,9 +149,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
89
149
  * For eg, if you want the component to open to a specific Liveboard
90
150
  * you could set the path to `pinboard/<liveboardId>/tab/<tabId>`.
91
151
  *
152
+ * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
92
153
  * @example
93
- * ```
94
- * <AppEmbed path="pinboard/1234/tab/7464" />
154
+ * ```js
155
+ * const embed = new AppEmbed('#tsEmbed', {
156
+ * ... // other options
157
+ * path:"pinboard/1234/tab/7464"
158
+ * })
95
159
  * ```
96
160
  */
97
161
  path?: string;
@@ -101,16 +165,46 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
101
165
  *
102
166
  * Use this to open to particular page in the app. To open to a specific
103
167
  * path within the app, use the `path` attribute which is more flexible.
168
+ *
169
+ * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
170
+ * @example
171
+ * ```js
172
+ * const embed = new AppEmbed('#tsEmbed', {
173
+ * ... // other options
174
+ * pageId : Page.Answers | Page.Data
175
+ * })
176
+ * ```
104
177
  */
105
178
  pageId?: Page;
106
179
  /**
107
180
  * This puts a filter tag on the application. All metadata lists in the
108
181
  * application, such as Liveboards and answers, would be filtered by this
109
182
  * tag.
183
+ *
184
+ * @version SDK: 1.1.0 | Thoughtspot: 9.4.0.cl
185
+ * @example
186
+ * ```js
187
+ * const embed = new AppEmbed('#tsEmbed', {
188
+ * ... // other options
189
+ * tag:'value',
190
+ * })
191
+ * ```
110
192
  */
111
193
  tag?: string;
112
194
  /**
113
195
  * The array of GUIDs to be hidden
196
+ *
197
+ * @version SDK: 1.11.0 | ThoughtSpot: 8.3.0.cl, 8.4.1-sw
198
+ * @example
199
+ * ```js
200
+ * const embed = new AppEmbed('#tsEmbed', {
201
+ * ... // other options
202
+ * hideObjects: [
203
+ * '430496d6-6903-4601-937e-2c691821af3c',
204
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
205
+ * ]
206
+ * })
207
+ * ```
114
208
  */
115
209
  hideObjects?: string[];
116
210
  /**
@@ -124,7 +218,15 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
124
218
  /**
125
219
  * If set to true, the Search Assist feature is enabled.
126
220
  *
221
+ * @default true
127
222
  * @version SDK: 1.13.0 | ThoughtSpot: 8.5.0.cl, 8.8.1-sw
223
+ * @example
224
+ * ```js
225
+ * const embed = new AppEmbed('#tsEmbed', {
226
+ * ... // other options
227
+ * enableSearchAssist: true,
228
+ * })
229
+ * ```
128
230
  */
129
231
  enableSearchAssist?: boolean;
130
232
  /**
@@ -132,6 +234,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
132
234
  * according to the height of the pages which support fullHeight mode.
133
235
  *
134
236
  * @version SDK: 1.21.0 | ThoughtSpot: 9.4.0.cl, 9.4.0-sw
237
+ * @example
238
+ * ```js
239
+ * const embed = new AppEmbed('#tsEmbed', {
240
+ * ... // other options
241
+ * fullHeight: true,
242
+ * })
243
+ * ```
135
244
  */
136
245
  fullHeight?: boolean;
137
246
  /**
@@ -147,6 +256,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
147
256
  *
148
257
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
149
258
  * @default false
259
+ * @example
260
+ * ```js
261
+ * const embed = new AppEmbed('#tsEmbed', {
262
+ * ... // other options
263
+ * hideLiveboardHeader : true,
264
+ * })
265
+ * ```
150
266
  */
151
267
  hideLiveboardHeader?: boolean;
152
268
  /**
@@ -154,6 +270,13 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
154
270
  *
155
271
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
156
272
  * @default false
273
+ * @example
274
+ * ```js
275
+ * const embed = new AppEmbed('#tsEmbed', {
276
+ * ... // other options
277
+ * showLiveboardTitle:true,
278
+ * })
279
+ * ```
157
280
  */
158
281
  showLiveboardTitle?: boolean;
159
282
  /**
@@ -161,13 +284,27 @@ export interface AppViewConfig extends Omit<ViewConfig, 'visibleTabs'> {
161
284
  *
162
285
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl
163
286
  * @default false
287
+ * @example
288
+ * ```js
289
+ * const embed = new AppEmbed('#tsEmbed', {
290
+ * ... // other options
291
+ * showLiveboardDescription:true,
292
+ * })
293
+ * ```
164
294
  */
165
295
  showLiveboardDescription?: boolean;
166
296
  /**
167
- * Flag to control new Modular Home experience
297
+ * Flag to control new Modular Home experience.
168
298
  *
169
299
  * @default false
170
- * @version SDK: 1.27.0 | Thoughtspot: 9.8.0.cl
300
+ * @version SDK: 1.27.9 | Thoughtspot: 9.12.0.cl
301
+ * @example
302
+ * ```js
303
+ * const embed = new AppEmbed('#tsEmbed', {
304
+ * ... // other options
305
+ * modularHomeExperience : true,
306
+ * })
307
+ * ```
171
308
  */
172
309
  modularHomeExperience?: boolean;
173
310
  /**
@@ -253,6 +390,6 @@ export declare class AppEmbed extends V1Embed {
253
390
  * @param renderOptions An object containing the page ID
254
391
  * to be embedded.
255
392
  */
256
- render(): AppEmbed;
393
+ render(): Promise<AppEmbed>;
257
394
  }
258
395
  //# sourceMappingURL=app.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAIH,OAAO,EACI,WAAW,EAAa,UAAU,EAAc,cAAc,EACxE,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,aAAa;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAU;gBAGnB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAU/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAgExB;;;;OAIG;IACI,YAAY,IAAI,MAAM;IAa7B;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAKzC;IAEF;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;;OAWG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;;OAKG;IACI,MAAM,IAAI,QAAQ;CAO5B"}
1
+ {"version":3,"file":"app.d.ts","sourceRoot":"","sources":["app.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EACH,WAAW,EAAyB,cAAc,EAAS,UAAU,EACxE,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AAEH,oBAAY,IAAI;IACZ;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,OAAO,YAAY;IACnB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,SAAS,cAAc;IACvB;;OAEG;IACH,IAAI,SAAS;IACb;;OAEG;IACH,MAAM,aAAa;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC;IAClE;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;;OAaG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;;;;;;;OAiBG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;;;;;;;OAkBG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC;IACd;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,QAAS,SAAQ,OAAO;IACjC,SAAS,CAAC,UAAU,EAAE,aAAa,CAAC;IAEpC,OAAO,CAAC,aAAa,CAAU;gBAGnB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa;IAU/D;;;OAGG;IACH,SAAS,CAAC,cAAc;IAgExB;;;;OAIG;IACI,YAAY,IAAI,MAAM;IAW7B;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,SAAU,cAAc,UAElD;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAKzC;IAEF;;;;;OAKG;IACH,OAAO,CAAC,YAAY;IAoBpB;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAalB;;;;;;;;;;;OAWG;IACI,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,UAAQ,GAAG,IAAI;IAsBpE;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC;CAO3C"}
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AAYA,OAAO,EAEH,gBAAgB,EAKhB,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEf,MAAM,SAAS,CAAC;AAIjB,OAAO,EACO,WAAW,EAAY,gBAAgB,EACpD,MAAM,UAAU,CAAC;AAYlB,MAAM,WAAW,eAAe;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,eAAe,CAAC;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE;QACN,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,YAAY,CAAC;KAClE,EAAE,CAAC;IACJ,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACjC;AAED,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEzC,eAAO,MAAM,cAAc,QAAO,QAAQ,OAAO,CAAgB,CAAC;AAElE,OAAO,EACH,iBAAiB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,YAAY,GAC3E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,QAAO,QAAQ,OAAO,CAe5C,CAAC;AASF;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,SAAU,MAAM,qBAAqB,gBAAgB,EAAE,KAAG,IAqB9E,CAAC;AAiCF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,gBA+B/C,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,MAAM,uCAAoC,QAAQ,OAAO,CAQrE,CAAC;AAIF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,sBAAuB,GAAG,KAAK,IAAI,KAAK,QAAQ,GAAG,CAAC,KAAG,QAAQ,GAAG,CAQ3F,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,SAAgB,eAAe,KAAG,QAAQ,GAAG,CAmCnE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,SAAS,SAAgB,cAAc,KAAG,QAAQ,GAAG,CAoCjE,CAAC;AAGF;;GAEG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["base.ts"],"names":[],"mappings":"AAYA,OAAO,EAEH,gBAAgB,EAKhB,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,EAEf,MAAM,SAAS,CAAC;AAIjB,OAAO,EACO,WAAW,EAAY,gBAAgB,EACpD,MAAM,UAAU,CAAC;AAYlB,MAAM,WAAW,eAAe;IAC5B,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,aAAa,CAAC,EAAE,SAAS,GAAG,aAAa,GAAG,eAAe,CAAC;IAC5D,UAAU,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC3B,QAAQ,EAAE;QACN,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,eAAe,GAAG,YAAY,CAAC;KAClE,EAAE,CAAC;IACJ,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACjC;AAED,eAAO,IAAI,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEzC,eAAO,MAAM,cAAc,QAAO,QAAQ,OAAO,CAAgB,CAAC;AAElE,OAAO,EACH,iBAAiB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,YAAY,GAC3E,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU,QAAO,QAAQ,OAAO,CAe5C,CAAC;AASF;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,SAAU,MAAM,qBAAqB,gBAAgB,EAAE,KAAG,IAqB9E,CAAC;AA6BF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,IAAI,gBAAiB,WAAW,KAAG,gBA+B/C,CAAC;AAEF;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,MAAM,uCAAoC,QAAQ,OAAO,CAQrE,CAAC;AAIF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,sBAAuB,GAAG,KAAK,IAAI,KAAK,QAAQ,GAAG,CAAC,KAAG,QAAQ,GAAG,CAQ3F,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,SAAgB,eAAe,KAAG,QAAQ,GAAG,CAmCnE,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,SAAS,SAAgB,cAAc,KAAG,QAAQ,GAAG,CAoCjE,CAAC;AAGF;;GAEG;AACH,wBAAgB,KAAK,IAAI,IAAI,CAI5B"}
@@ -19,8 +19,21 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
19
19
  /**
20
20
  * If set to true, the embedded object container dynamically resizes
21
21
  * according to the height of the Liveboard.
22
+ * **Note**: Using fullHeight loads all visualizations on the
23
+ * Liveboard simultaneously, which results in multiple warehouse
24
+ * queries and potentially a longer wait for the topmost
25
+ * visualizations to display on the screen.
26
+ * Setting `fullHeight` to `false` fetches visualizations
27
+ * incrementally as users scroll the page to view the charts and tables.
22
28
  *
23
29
  * @version SDK: 1.1.0 | ThoughtSpot: ts7.may.cl, 7.2.1
30
+ * @example
31
+ * ```js
32
+ * const embed = new LiveboardEmbed('#embed', {
33
+ * ... // other liveboard view config
34
+ * fullHeight: true,
35
+ * });
36
+ * ```
24
37
  */
25
38
  fullHeight?: boolean;
26
39
  /**
@@ -30,10 +43,26 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
30
43
  *
31
44
  * @version SDK: 1.5.0 | ThoughtSpot: ts7.oct.cl, 7.2.1
32
45
  * @default 500
46
+ * @example
47
+ * ```js
48
+ * const embed = new LiveboardEmbed('#embed', {
49
+ * ... // other liveboard view config
50
+ * fullHeight: true,
51
+ * defaultHeight: 600,
52
+ * });
53
+ * ```
33
54
  */
34
55
  defaultHeight?: number;
35
56
  /**
36
57
  * @Deprecated If set to true, the context menu in visualizations will be enabled.
58
+ * @example
59
+ * ```js
60
+ * const embed = new LiveboardEmbed('#tsEmbed', {
61
+ * ... // other options
62
+ * enableVizTransformations:true,
63
+ * })
64
+ * ```
65
+ * @version: SDK: 1.1.0 | ThoughtSpot: 8.1.0.sw
37
66
  */
38
67
  enableVizTransformations?: boolean;
39
68
  /**
@@ -41,6 +70,12 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
41
70
  * Use either liveboardId or pinboardId to reference the Liveboard to embed.
42
71
  *
43
72
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1
73
+ * @example
74
+ * ```js
75
+ * const embed = new LiveboardEmbed('#embed-container', {
76
+ * ... // other options
77
+ * liveboardId:id of liveboard,
78
+ * })
44
79
  */
45
80
  liveboardId?: string;
46
81
  /**
@@ -51,6 +86,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
51
86
  pinboardId?: string;
52
87
  /**
53
88
  * The visualization within the Liveboard to display.
89
+ *
90
+ * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
91
+ * @example
92
+ * ```js
93
+ * const embed = new LiveboardEmbed('#embed-container', {
94
+ * ... // other options
95
+ * vizId:'430496d6-6903-4601-937e-2c691821af3c',
96
+ * })
97
+ * ```
54
98
  */
55
99
  vizId?: string;
56
100
  /**
@@ -58,6 +102,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
58
102
  * Liveboard page will be read-only (no X buttons)
59
103
  *
60
104
  * @version SDK: 1.3.0 | ThoughtSpot ts7.aug.cl, 7.2.1.sw
105
+ * @example
106
+ * ```js
107
+ * const embed = new LiveboardEmbed('#embed-container', {
108
+ * ... // other options
109
+ * preventLiveboardFilterRemoval:true,
110
+ * })
111
+ * ```
61
112
  */
62
113
  preventLiveboardFilterRemoval?: boolean;
63
114
  /**
@@ -66,6 +117,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
66
117
  * event.
67
118
  *
68
119
  * @version SDK: 1.9.1 | ThoughtSpot: 8.1.0.cl, 8.4.1-sw
120
+ * @example
121
+ * ```js
122
+ * const embed = new LiveboardEmbed('#embed-container', {
123
+ * ... // other options
124
+ * visibleVizs: [
125
+ * '430496d6-6903-4601-937e-2c691821af3c',
126
+ * 'f547ec54-2a37-4516-a222-2b06719af726'
127
+ * ]
128
+ * })
69
129
  */
70
130
  visibleVizs?: string[];
71
131
  /**
@@ -79,12 +139,26 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
79
139
  * new Liveboard experience mode.
80
140
  *
81
141
  * @version SDK: 1.14.0 | ThoughtSpot: 8.6.0.cl, 8.8.1-sw
142
+ * @example
143
+ * ```js
144
+ * const embed = new LiveboardEmbed('#embed-container', {
145
+ * ... // other options
146
+ * liveboardV2:true,
147
+ * })
148
+ * ```
82
149
  */
83
150
  liveboardV2?: boolean;
84
151
  /**
85
152
  * Set a Liveboard tab as an active tab.
86
153
  * Specify the tab ID.
87
154
  *
155
+ * @example
156
+ * ```js
157
+ * const embed = new LiveboardEmbed('#tsEmbed', {
158
+ * ... // other options
159
+ * activeTabId:'id-1234',
160
+ * })
161
+ * ```
88
162
  * @version SDK: 1.15.0 | ThoughtSpot: 8.7.0.cl, 8.8.1-sw
89
163
  */
90
164
  activeTabId?: string;
@@ -92,6 +166,13 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
92
166
  * Show or hide the tab panel of the embedded Liveboard.
93
167
  *
94
168
  * @version SDK: 1.25.0 | Thoughtspot: 9.6.0.cl, 9.8.0.sw
169
+ * @example
170
+ * ```js
171
+ * const embed = new LiveboardEmbed('#embed-container', {
172
+ * ... // other options
173
+ * hideTabPanel:true,
174
+ * })
175
+ * ```
95
176
  */
96
177
  hideTabPanel?: boolean;
97
178
  /**
@@ -99,20 +180,41 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
99
180
  *
100
181
  * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
101
182
  * @default false
183
+ * @example
184
+ * ```js
185
+ * const embed = new LiveboardEmbed('#embed', {
186
+ * ... // other liveboard view config
187
+ * hideLiveboardHeader:true,
188
+ * });
189
+ * ```
102
190
  */
103
191
  hideLiveboardHeader?: boolean;
104
192
  /**
105
193
  * Show or hide the Liveboard title.
106
194
  *
107
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
108
195
  * @default false
196
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
197
+ * @example
198
+ * ```js
199
+ * const embed = new LiveboardEmbed('#embed-container', {
200
+ * ... // other options
201
+ * showLiveboardTitle:true,
202
+ * })
203
+ * ```
109
204
  */
110
205
  showLiveboardTitle?: boolean;
111
206
  /**
112
207
  * Show or hide the Liveboard description.
113
208
  *
114
- * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
115
209
  * @default false
210
+ * @version SDK: 1.26.0 | Thoughtspot: 9.7.0.cl, 9.8.0.sw
211
+ * @example
212
+ * ```js
213
+ * const embed = new LiveboardEmbed('#embed-container', {
214
+ * ... // other options
215
+ * showLiveboardDescription:true,
216
+ * })
217
+ * ```
116
218
  */
117
219
  showLiveboardDescription?: boolean;
118
220
  /**
@@ -133,8 +235,15 @@ export interface LiveboardViewConfig extends Omit<ViewConfig, 'hiddenHomepageMod
133
235
  /**
134
236
  * enable or disable ask sage
135
237
  *
136
- * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
137
238
  * @default false
239
+ * @version SDK: 1.29.0 | Thoughtspot: 9.12.0.cl
240
+ * @example
241
+ * ```js
242
+ * const embed = new SearchEmbed('#tsEmbed', {
243
+ * ... // other options
244
+ * enableAskSage:true,
245
+ * })
246
+ * ```
138
247
  */
139
248
  enableAskSage?: boolean;
140
249
  }
@@ -194,7 +303,7 @@ export declare class LiveboardEmbed extends V1Embed {
194
303
  * @param renderOptions An object specifying the Liveboard ID,
195
304
  * visualization ID and the runtime filters.
196
305
  */
197
- render(): LiveboardEmbed;
306
+ render(): Promise<LiveboardEmbed>;
198
307
  navigateToLiveboard(liveboardId: string, vizId?: string, activeTabId?: string): void;
199
308
  }
200
309
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EAKH,WAAW,EACX,SAAS,EACT,UAAU,EACb,MAAM,UAAU,CAAC;AAGlB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,UAAU,EAAE,uBAAuB,GAAG,wBAAwB,GAAG,0BAA0B,CAAC;IAC1I;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IAUrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAoExB,OAAO,CAAC,kBAAkB;IAa1B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAcpB;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAIzC;IAEF,OAAO,CAAC,YAAY;IAQpB,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAcxC,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAQ1C;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpE;;;;;OAKG;IACI,MAAM,IAAI,cAAc;IASxB,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAavF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAI"}
1
+ {"version":3,"file":"liveboard.d.ts","sourceRoot":"","sources":["liveboard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,OAAO,EACH,WAAW,EAAc,SAAS,EAAyB,UAAU,EACxE,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;;;GAIG;AACH,MAAM,WAAW,mBACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,0BAA0B,CAClF;IACD;;;;;;;;;;;;;;;;;;OAkBG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;;;;;;;OAUG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;;;;;OAYG;IACH,6BAA6B,CAAC,EAAE,OAAO,CAAC;IACxC;;;;;;;;;;;;;;;OAeG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;;;;;;;;OAYG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;;;;;;;;OAYG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;;;;;;;;;;;;OAaG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,cAAe,SAAQ,OAAO;IACvC,SAAS,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAE1C,OAAO,CAAC,aAAa,CAAO;gBAGhB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,mBAAmB;IAUrE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAoExB,OAAO,CAAC,kBAAkB;IAa1B;;;OAGG;IACH,OAAO,CAAC,YAAY;IAcpB;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB,CAExB;IAEF,OAAO,CAAC,iBAAiB,CAGvB;IAEF,OAAO,CAAC,mCAAmC,CAIzC;IAEF,OAAO,CAAC,YAAY;IAQpB,SAAS,CAAC,sBAAsB,IAAI,IAAI;IAcxC,SAAS,CAAC,wBAAwB,IAAI,IAAI;IAQ1C;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,GAAE,GAAQ,GAAG,OAAO,CAAC,GAAG,CAAC;IAYpE;;;;;OAKG;IACU,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC;IASvC,mBAAmB,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM;CAavF;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,cAAc;CAAG"}
@@ -159,6 +159,6 @@ export declare class SageEmbed extends V1Embed {
159
159
  *
160
160
  * @returns {SageEmbed} Eureka/Sage embed
161
161
  */
162
- render(): SageEmbed;
162
+ render(): Promise<SageEmbed>;
163
163
  }
164
164
  //# sourceMappingURL=sage.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"sage.d.ts","sourceRoot":"","sources":["sage.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACH,MAAM,EAAE,WAAW,EAAS,UAAU,EACzC,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,YAAY,GAAG,aAAa,GAAG,0BAA0B,CACjH;IACD;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AACD,eAAO,MAAM,qCAAqC,UASjD,CAAC;AACF;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,OAAO;IAClC;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;gBAGzB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc;IAKhE;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM;IAkClC;;;;;OAKG;IACI,YAAY,IAAI,MAAM;IAqB7B;;;;OAIG;IACI,MAAM,IAAI,SAAS;CAQ7B"}
1
+ {"version":3,"file":"sage.d.ts","sourceRoot":"","sources":["sage.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACH,MAAM,EAAE,WAAW,EAAS,UAAU,EACzC,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cACb,SAAQ,IAAI,CACR,UAAU,EACV,uBAAuB,GAAG,wBAAwB,GAAG,YAAY,GAAG,aAAa,GAAG,0BAA0B,CACjH;IACD;;;;;;;;OAQG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;;;;;OAMG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;CACjC;AACD,eAAO,MAAM,qCAAqC,UASjD,CAAC;AACF;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,OAAO;IAClC;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;gBAGzB,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,cAAc;IAKhE;;;;;OAKG;IACH,SAAS,CAAC,cAAc,IAAI,MAAM;IAkClC;;;;;OAKG;IACI,YAAY,IAAI,MAAM;IAqB7B;;;;OAIG;IACU,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC;CAQ5C"}