@thoughtspot/visual-embed-sdk 1.51.2 → 1.52.1

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 (316) hide show
  1. package/cjs/package.json +9 -1
  2. package/cjs/src/api-intercept.d.ts.map +1 -1
  3. package/cjs/src/api-intercept.js +1 -0
  4. package/cjs/src/api-intercept.js.map +1 -1
  5. package/cjs/src/contracts/contracts.spec.d.ts +2 -0
  6. package/cjs/src/contracts/contracts.spec.d.ts.map +1 -0
  7. package/cjs/src/contracts/contracts.spec.js +345 -0
  8. package/cjs/src/contracts/contracts.spec.js.map +1 -0
  9. package/cjs/src/contracts/embed-event-payloads.d.ts +73 -0
  10. package/cjs/src/contracts/embed-event-payloads.d.ts.map +1 -0
  11. package/cjs/src/contracts/embed-event-payloads.js +3 -0
  12. package/cjs/src/contracts/embed-event-payloads.js.map +1 -0
  13. package/cjs/src/contracts/host-event-contracts.d.ts +378 -0
  14. package/cjs/src/contracts/host-event-contracts.d.ts.map +1 -0
  15. package/cjs/src/contracts/host-event-contracts.js +3 -0
  16. package/cjs/src/contracts/host-event-contracts.js.map +1 -0
  17. package/cjs/src/contracts/index.d.ts +22 -0
  18. package/cjs/src/contracts/index.d.ts.map +1 -0
  19. package/cjs/src/contracts/index.js +33 -0
  20. package/cjs/src/contracts/index.js.map +1 -0
  21. package/cjs/src/contracts/ui-passthrough-contracts.d.ts +277 -0
  22. package/cjs/src/contracts/ui-passthrough-contracts.d.ts.map +1 -0
  23. package/cjs/src/{embed/hostEventClient/contracts.js → contracts/ui-passthrough-contracts.js} +6 -2
  24. package/cjs/src/contracts/ui-passthrough-contracts.js.map +1 -0
  25. package/cjs/src/css-variables.d.ts +1 -1
  26. package/cjs/src/embed/app.d.ts +17 -140
  27. package/cjs/src/embed/app.d.ts.map +1 -1
  28. package/cjs/src/embed/app.js +20 -120
  29. package/cjs/src/embed/app.js.map +1 -1
  30. package/cjs/src/embed/app.spec.js +70 -26
  31. package/cjs/src/embed/app.spec.js.map +1 -1
  32. package/cjs/src/embed/conversation.d.ts +5 -5
  33. package/cjs/src/embed/events.spec.js +12 -2
  34. package/cjs/src/embed/events.spec.js.map +1 -1
  35. package/cjs/src/embed/hostEventClient/host-event-client.d.ts +3 -2
  36. package/cjs/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  37. package/cjs/src/embed/hostEventClient/host-event-client.js +23 -18
  38. package/cjs/src/embed/hostEventClient/host-event-client.js.map +1 -1
  39. package/cjs/src/embed/hostEventClient/host-event-client.spec.js +36 -36
  40. package/cjs/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  41. package/cjs/src/embed/hostEventClient/utils.d.ts +1 -1
  42. package/cjs/src/embed/hostEventClient/utils.d.ts.map +1 -1
  43. package/cjs/src/embed/hostEventClient/utils.js +3 -3
  44. package/cjs/src/embed/hostEventClient/utils.js.map +1 -1
  45. package/cjs/src/embed/liveboard.d.ts +9 -161
  46. package/cjs/src/embed/liveboard.d.ts.map +1 -1
  47. package/cjs/src/embed/liveboard.js +68 -135
  48. package/cjs/src/embed/liveboard.js.map +1 -1
  49. package/cjs/src/embed/liveboard.spec.js +215 -32
  50. package/cjs/src/embed/liveboard.spec.js.map +1 -1
  51. package/cjs/src/embed/search.d.ts +14 -0
  52. package/cjs/src/embed/search.d.ts.map +1 -1
  53. package/cjs/src/embed/search.js +4 -1
  54. package/cjs/src/embed/search.js.map +1 -1
  55. package/cjs/src/embed/search.spec.js +65 -0
  56. package/cjs/src/embed/search.spec.js.map +1 -1
  57. package/cjs/src/embed/ts-embed.d.ts +21 -25
  58. package/cjs/src/embed/ts-embed.d.ts.map +1 -1
  59. package/cjs/src/embed/ts-embed.js +105 -72
  60. package/cjs/src/embed/ts-embed.js.map +1 -1
  61. package/cjs/src/embed/ts-embed.spec.d.ts.map +1 -1
  62. package/cjs/src/embed/ts-embed.spec.js +380 -33
  63. package/cjs/src/embed/ts-embed.spec.js.map +1 -1
  64. package/cjs/src/full-height.d.ts +137 -0
  65. package/cjs/src/full-height.d.ts.map +1 -0
  66. package/cjs/src/full-height.js +272 -0
  67. package/cjs/src/full-height.js.map +1 -0
  68. package/cjs/src/full-height.spec.d.ts +2 -0
  69. package/cjs/src/full-height.spec.d.ts.map +1 -0
  70. package/cjs/src/full-height.spec.js +835 -0
  71. package/cjs/src/full-height.spec.js.map +1 -0
  72. package/cjs/src/index.d.ts +4 -3
  73. package/cjs/src/index.d.ts.map +1 -1
  74. package/cjs/src/index.js +5 -4
  75. package/cjs/src/index.js.map +1 -1
  76. package/cjs/src/react/all-types-export.d.ts +1 -1
  77. package/cjs/src/react/all-types-export.d.ts.map +1 -1
  78. package/cjs/src/react/all-types-export.js +2 -1
  79. package/cjs/src/react/all-types-export.js.map +1 -1
  80. package/cjs/src/react/all-types-export.parity.spec.js +55 -3
  81. package/cjs/src/react/all-types-export.parity.spec.js.map +1 -1
  82. package/cjs/src/react/index.d.ts +8 -8
  83. package/cjs/src/react/index.d.ts.map +1 -1
  84. package/cjs/src/react/index.js +1 -1
  85. package/cjs/src/react/index.js.map +1 -1
  86. package/cjs/src/react/index.spec.js +7 -7
  87. package/cjs/src/react/index.spec.js.map +1 -1
  88. package/cjs/src/types.d.ts +664 -39
  89. package/cjs/src/types.d.ts.map +1 -1
  90. package/cjs/src/types.js +406 -13
  91. package/cjs/src/types.js.map +1 -1
  92. package/cjs/src/utils/processTrigger.d.ts +3 -1
  93. package/cjs/src/utils/processTrigger.d.ts.map +1 -1
  94. package/cjs/src/utils/processTrigger.js +19 -51
  95. package/cjs/src/utils/processTrigger.js.map +1 -1
  96. package/cjs/src/utils/transport/iframe-transport.d.ts +55 -0
  97. package/cjs/src/utils/transport/iframe-transport.d.ts.map +1 -0
  98. package/cjs/src/utils/transport/iframe-transport.js +108 -0
  99. package/cjs/src/utils/transport/iframe-transport.js.map +1 -0
  100. package/cjs/src/utils/transport/iframe-transport.spec.d.ts +2 -0
  101. package/cjs/src/utils/transport/iframe-transport.spec.d.ts.map +1 -0
  102. package/cjs/src/utils/transport/iframe-transport.spec.js +140 -0
  103. package/cjs/src/utils/transport/iframe-transport.spec.js.map +1 -0
  104. package/cjs/src/utils.d.ts +18 -0
  105. package/cjs/src/utils.d.ts.map +1 -1
  106. package/cjs/src/utils.js +39 -1
  107. package/cjs/src/utils.js.map +1 -1
  108. package/cjs/src/utils.spec.js +62 -0
  109. package/cjs/src/utils.spec.js.map +1 -1
  110. package/dist/{index-D8_Zs-Nr.js → index-C1pmYb5H.js} +1 -1
  111. package/dist/src/api-intercept.d.ts.map +1 -1
  112. package/dist/src/contracts/contracts.spec.d.ts +2 -0
  113. package/dist/src/contracts/contracts.spec.d.ts.map +1 -0
  114. package/dist/src/contracts/embed-event-payloads.d.ts +73 -0
  115. package/dist/src/contracts/embed-event-payloads.d.ts.map +1 -0
  116. package/dist/src/contracts/host-event-contracts.d.ts +378 -0
  117. package/dist/src/contracts/host-event-contracts.d.ts.map +1 -0
  118. package/dist/src/contracts/index.d.ts +22 -0
  119. package/dist/src/contracts/index.d.ts.map +1 -0
  120. package/dist/src/contracts/ui-passthrough-contracts.d.ts +277 -0
  121. package/dist/src/contracts/ui-passthrough-contracts.d.ts.map +1 -0
  122. package/dist/src/css-variables.d.ts +1 -1
  123. package/dist/src/embed/app.d.ts +17 -140
  124. package/dist/src/embed/app.d.ts.map +1 -1
  125. package/dist/src/embed/conversation.d.ts +5 -5
  126. package/dist/src/embed/hostEventClient/host-event-client.d.ts +3 -2
  127. package/dist/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  128. package/dist/src/embed/hostEventClient/utils.d.ts +1 -1
  129. package/dist/src/embed/hostEventClient/utils.d.ts.map +1 -1
  130. package/dist/src/embed/liveboard.d.ts +9 -161
  131. package/dist/src/embed/liveboard.d.ts.map +1 -1
  132. package/dist/src/embed/search.d.ts +14 -0
  133. package/dist/src/embed/search.d.ts.map +1 -1
  134. package/dist/src/embed/ts-embed.d.ts +21 -25
  135. package/dist/src/embed/ts-embed.d.ts.map +1 -1
  136. package/dist/src/embed/ts-embed.spec.d.ts.map +1 -1
  137. package/dist/src/full-height.d.ts +137 -0
  138. package/dist/src/full-height.d.ts.map +1 -0
  139. package/dist/src/full-height.spec.d.ts +2 -0
  140. package/dist/src/full-height.spec.d.ts.map +1 -0
  141. package/dist/src/index.d.ts +4 -3
  142. package/dist/src/index.d.ts.map +1 -1
  143. package/dist/src/react/all-types-export.d.ts +1 -1
  144. package/dist/src/react/all-types-export.d.ts.map +1 -1
  145. package/dist/src/react/index.d.ts +8 -8
  146. package/dist/src/react/index.d.ts.map +1 -1
  147. package/dist/src/types.d.ts +664 -39
  148. package/dist/src/types.d.ts.map +1 -1
  149. package/dist/src/utils/processTrigger.d.ts +3 -1
  150. package/dist/src/utils/processTrigger.d.ts.map +1 -1
  151. package/dist/src/utils/transport/iframe-transport.d.ts +55 -0
  152. package/dist/src/utils/transport/iframe-transport.d.ts.map +1 -0
  153. package/dist/src/utils/transport/iframe-transport.spec.d.ts +2 -0
  154. package/dist/src/utils/transport/iframe-transport.spec.d.ts.map +1 -0
  155. package/dist/src/utils.d.ts +18 -0
  156. package/dist/src/utils.d.ts.map +1 -1
  157. package/dist/tsembed-react.es.js +1031 -392
  158. package/dist/tsembed-react.js +1030 -391
  159. package/dist/tsembed.es.js +1031 -392
  160. package/dist/tsembed.js +1029 -390
  161. package/dist/visual-embed-sdk-react-full.d.ts +1483 -693
  162. package/dist/visual-embed-sdk-react.d.ts +1364 -647
  163. package/dist/visual-embed-sdk.d.ts +1426 -659
  164. package/lib/package.json +9 -1
  165. package/lib/src/api-intercept.d.ts.map +1 -1
  166. package/lib/src/api-intercept.js +2 -1
  167. package/lib/src/api-intercept.js.map +1 -1
  168. package/lib/src/contracts/contracts.spec.d.ts +2 -0
  169. package/lib/src/contracts/contracts.spec.d.ts.map +1 -0
  170. package/lib/src/contracts/contracts.spec.js +342 -0
  171. package/lib/src/contracts/contracts.spec.js.map +1 -0
  172. package/lib/src/contracts/embed-event-payloads.d.ts +73 -0
  173. package/lib/src/contracts/embed-event-payloads.d.ts.map +1 -0
  174. package/lib/src/contracts/embed-event-payloads.js +2 -0
  175. package/lib/src/contracts/embed-event-payloads.js.map +1 -0
  176. package/lib/src/contracts/host-event-contracts.d.ts +378 -0
  177. package/lib/src/contracts/host-event-contracts.d.ts.map +1 -0
  178. package/lib/src/contracts/host-event-contracts.js +2 -0
  179. package/lib/src/contracts/host-event-contracts.js.map +1 -0
  180. package/lib/src/contracts/index.d.ts +22 -0
  181. package/lib/src/contracts/index.d.ts.map +1 -0
  182. package/lib/src/contracts/index.js +22 -0
  183. package/lib/src/contracts/index.js.map +1 -0
  184. package/lib/src/contracts/ui-passthrough-contracts.d.ts +277 -0
  185. package/lib/src/contracts/ui-passthrough-contracts.d.ts.map +1 -0
  186. package/lib/src/{embed/hostEventClient/contracts.js → contracts/ui-passthrough-contracts.js} +6 -2
  187. package/lib/src/contracts/ui-passthrough-contracts.js.map +1 -0
  188. package/lib/src/css-variables.d.ts +1 -1
  189. package/lib/src/embed/app.d.ts +17 -140
  190. package/lib/src/embed/app.d.ts.map +1 -1
  191. package/lib/src/embed/app.js +22 -122
  192. package/lib/src/embed/app.js.map +1 -1
  193. package/lib/src/embed/app.spec.js +70 -26
  194. package/lib/src/embed/app.spec.js.map +1 -1
  195. package/lib/src/embed/conversation.d.ts +5 -5
  196. package/lib/src/embed/events.spec.js +12 -2
  197. package/lib/src/embed/events.spec.js.map +1 -1
  198. package/lib/src/embed/hostEventClient/host-event-client.d.ts +3 -2
  199. package/lib/src/embed/hostEventClient/host-event-client.d.ts.map +1 -1
  200. package/lib/src/embed/hostEventClient/host-event-client.js +6 -1
  201. package/lib/src/embed/hostEventClient/host-event-client.js.map +1 -1
  202. package/lib/src/embed/hostEventClient/host-event-client.spec.js +1 -1
  203. package/lib/src/embed/hostEventClient/host-event-client.spec.js.map +1 -1
  204. package/lib/src/embed/hostEventClient/utils.d.ts +1 -1
  205. package/lib/src/embed/hostEventClient/utils.d.ts.map +1 -1
  206. package/lib/src/embed/hostEventClient/utils.js +1 -1
  207. package/lib/src/embed/hostEventClient/utils.js.map +1 -1
  208. package/lib/src/embed/liveboard.d.ts +9 -161
  209. package/lib/src/embed/liveboard.d.ts.map +1 -1
  210. package/lib/src/embed/liveboard.js +70 -137
  211. package/lib/src/embed/liveboard.js.map +1 -1
  212. package/lib/src/embed/liveboard.spec.js +215 -32
  213. package/lib/src/embed/liveboard.spec.js.map +1 -1
  214. package/lib/src/embed/search.d.ts +14 -0
  215. package/lib/src/embed/search.d.ts.map +1 -1
  216. package/lib/src/embed/search.js +4 -1
  217. package/lib/src/embed/search.js.map +1 -1
  218. package/lib/src/embed/search.spec.js +65 -0
  219. package/lib/src/embed/search.spec.js.map +1 -1
  220. package/lib/src/embed/ts-embed.d.ts +21 -25
  221. package/lib/src/embed/ts-embed.d.ts.map +1 -1
  222. package/lib/src/embed/ts-embed.js +106 -73
  223. package/lib/src/embed/ts-embed.js.map +1 -1
  224. package/lib/src/embed/ts-embed.spec.d.ts.map +1 -1
  225. package/lib/src/embed/ts-embed.spec.js +378 -31
  226. package/lib/src/embed/ts-embed.spec.js.map +1 -1
  227. package/lib/src/full-height.d.ts +137 -0
  228. package/lib/src/full-height.d.ts.map +1 -0
  229. package/lib/src/full-height.js +268 -0
  230. package/lib/src/full-height.js.map +1 -0
  231. package/lib/src/full-height.spec.d.ts +2 -0
  232. package/lib/src/full-height.spec.d.ts.map +1 -0
  233. package/lib/src/full-height.spec.js +833 -0
  234. package/lib/src/full-height.spec.js.map +1 -0
  235. package/lib/src/index.d.ts +4 -3
  236. package/lib/src/index.d.ts.map +1 -1
  237. package/lib/src/index.js +3 -3
  238. package/lib/src/index.js.map +1 -1
  239. package/lib/src/react/all-types-export.d.ts +1 -1
  240. package/lib/src/react/all-types-export.d.ts.map +1 -1
  241. package/lib/src/react/all-types-export.js +1 -1
  242. package/lib/src/react/all-types-export.js.map +1 -1
  243. package/lib/src/react/all-types-export.parity.spec.js +55 -3
  244. package/lib/src/react/all-types-export.parity.spec.js.map +1 -1
  245. package/lib/src/react/index.d.ts +8 -8
  246. package/lib/src/react/index.d.ts.map +1 -1
  247. package/lib/src/react/index.js +1 -1
  248. package/lib/src/react/index.js.map +1 -1
  249. package/lib/src/react/index.spec.js +7 -7
  250. package/lib/src/react/index.spec.js.map +1 -1
  251. package/lib/src/types.d.ts +664 -39
  252. package/lib/src/types.d.ts.map +1 -1
  253. package/lib/src/types.js +405 -12
  254. package/lib/src/types.js.map +1 -1
  255. package/lib/src/utils/processTrigger.d.ts +3 -1
  256. package/lib/src/utils/processTrigger.d.ts.map +1 -1
  257. package/lib/src/utils/processTrigger.js +19 -51
  258. package/lib/src/utils/processTrigger.js.map +1 -1
  259. package/lib/src/utils/transport/iframe-transport.d.ts +55 -0
  260. package/lib/src/utils/transport/iframe-transport.d.ts.map +1 -0
  261. package/lib/src/utils/transport/iframe-transport.js +101 -0
  262. package/lib/src/utils/transport/iframe-transport.js.map +1 -0
  263. package/lib/src/utils/transport/iframe-transport.spec.d.ts +2 -0
  264. package/lib/src/utils/transport/iframe-transport.spec.d.ts.map +1 -0
  265. package/lib/src/utils/transport/iframe-transport.spec.js +138 -0
  266. package/lib/src/utils/transport/iframe-transport.spec.js.map +1 -0
  267. package/lib/src/utils.d.ts +18 -0
  268. package/lib/src/utils.d.ts.map +1 -1
  269. package/lib/src/utils.js +37 -0
  270. package/lib/src/utils.js.map +1 -1
  271. package/lib/src/utils.spec.js +63 -1
  272. package/lib/src/utils.spec.js.map +1 -1
  273. package/lib/src/visual-embed-sdk.d.ts +1426 -659
  274. package/package.json +9 -1
  275. package/src/api-intercept.ts +2 -1
  276. package/src/contracts/contracts.spec.ts +392 -0
  277. package/src/contracts/embed-event-payloads.ts +83 -0
  278. package/src/contracts/host-event-contracts.ts +456 -0
  279. package/src/contracts/index.ts +53 -0
  280. package/src/contracts/ui-passthrough-contracts.ts +301 -0
  281. package/src/css-variables.ts +1 -1
  282. package/src/embed/app.spec.ts +86 -34
  283. package/src/embed/app.ts +37 -264
  284. package/src/embed/conversation.ts +5 -5
  285. package/src/embed/events.spec.ts +14 -2
  286. package/src/embed/hostEventClient/host-event-client.spec.ts +2 -2
  287. package/src/embed/hostEventClient/host-event-client.ts +18 -5
  288. package/src/embed/hostEventClient/utils.ts +2 -1
  289. package/src/embed/liveboard.spec.ts +261 -42
  290. package/src/embed/liveboard.ts +78 -297
  291. package/src/embed/search.spec.ts +80 -0
  292. package/src/embed/search.ts +20 -0
  293. package/src/embed/ts-embed.spec.ts +518 -31
  294. package/src/embed/ts-embed.ts +133 -82
  295. package/src/full-height.spec.ts +1008 -0
  296. package/src/full-height.ts +361 -0
  297. package/src/index.ts +95 -5
  298. package/src/react/all-types-export.parity.spec.ts +63 -3
  299. package/src/react/all-types-export.ts +46 -0
  300. package/src/react/index.spec.tsx +7 -7
  301. package/src/react/index.tsx +9 -9
  302. package/src/types.ts +665 -37
  303. package/src/utils/processTrigger.ts +28 -58
  304. package/src/utils/transport/iframe-transport.spec.ts +177 -0
  305. package/src/utils/transport/iframe-transport.ts +122 -0
  306. package/src/utils.spec.ts +71 -0
  307. package/src/utils.ts +38 -0
  308. package/cjs/src/embed/hostEventClient/contracts.d.ts +0 -231
  309. package/cjs/src/embed/hostEventClient/contracts.d.ts.map +0 -1
  310. package/cjs/src/embed/hostEventClient/contracts.js.map +0 -1
  311. package/dist/src/embed/hostEventClient/contracts.d.ts +0 -231
  312. package/dist/src/embed/hostEventClient/contracts.d.ts.map +0 -1
  313. package/lib/src/embed/hostEventClient/contracts.d.ts +0 -231
  314. package/lib/src/embed/hostEventClient/contracts.d.ts.map +0 -1
  315. package/lib/src/embed/hostEventClient/contracts.js.map +0 -1
  316. package/src/embed/hostEventClient/contracts.ts +0 -262
@@ -1,231 +0,0 @@
1
- import { ContextType, HostEvent, RuntimeFilter } from '../../types';
2
- import { SessionInterface } from '../../utils/graphql/answerService/answerService';
3
- export interface LiveboardTab {
4
- id: string;
5
- name: string;
6
- [key: string]: any;
7
- }
8
- export interface LiveboardGroup {
9
- id: string;
10
- name: string;
11
- [key: string]: any;
12
- }
13
- /**
14
- * Levels at which a filter or parameter can be applied.
15
- */
16
- export declare enum ApplicabilityLevel {
17
- Liveboard = "LIVEBOARD",
18
- Tab = "TAB",
19
- Group = "GROUP"
20
- }
21
- /**
22
- * Scopes a filter or parameter to a specific target.
23
- * At `LIVEBOARD` level the filter applies to the whole Liveboard, so `targetId`
24
- * is not required.
25
- */
26
- export interface Applicability {
27
- level: ApplicabilityLevel;
28
- targetId?: string;
29
- }
30
- export interface FilterUpdate {
31
- column: string;
32
- oper: string;
33
- values: string[];
34
- type?: string;
35
- applicability?: Applicability;
36
- }
37
- export interface LiveboardFilter {
38
- applicability?: Applicability;
39
- [key: string]: any;
40
- }
41
- export interface LiveboardParameter {
42
- applicability?: Applicability;
43
- [key: string]: any;
44
- }
45
- export declare enum UIPassthroughEvent {
46
- PinAnswerToLiveboard = "addVizToPinboard",
47
- SaveAnswer = "saveAnswer",
48
- GetDiscoverabilityStatus = "getDiscoverabilityStatus",
49
- GetAvailableUIPassthroughs = "getAvailableUiPassthroughs",
50
- GetAnswerConfig = "getAnswerPageConfig",
51
- GetLiveboardConfig = "getPinboardPageConfig",
52
- GetUnsavedAnswerTML = "getUnsavedAnswerTML",
53
- UpdateFilters = "updateFilters",
54
- Drilldown = "drillDown",
55
- GetAnswerSession = "getAnswerSession",
56
- GetFilters = "getFilters",
57
- GetIframeUrl = "getIframeUrl",
58
- GetParameters = "getParameters",
59
- GetTML = "getTML",
60
- GetTabs = "getTabs",
61
- GetGroups = "getGroups",
62
- GetExportRequestForCurrentPinboard = "getExportRequestForCurrentPinboard"
63
- }
64
- export type UIPassthroughContractBase = {
65
- [UIPassthroughEvent.PinAnswerToLiveboard]: {
66
- request: {
67
- vizId?: string;
68
- newVizName: string;
69
- newVizDescription?: string;
70
- liveboardId?: string;
71
- tabId?: string;
72
- newLiveboardName?: string;
73
- newTabName?: string;
74
- };
75
- response: {
76
- liveboardId: string;
77
- tabId: string;
78
- vizId: string;
79
- };
80
- };
81
- [UIPassthroughEvent.SaveAnswer]: {
82
- request: {
83
- name: string;
84
- description: string;
85
- vizId?: string;
86
- isDiscoverable?: boolean;
87
- };
88
- response: {
89
- answerId: string;
90
- saveResponse?: any;
91
- shareResponse?: any;
92
- };
93
- };
94
- [UIPassthroughEvent.GetDiscoverabilityStatus]: {
95
- request: any;
96
- response: {
97
- shouldShowDiscoverability: boolean;
98
- isDiscoverabilityCheckboxUnselectedPerOrg: boolean;
99
- };
100
- };
101
- [UIPassthroughEvent.GetAvailableUIPassthroughs]: {
102
- request: any;
103
- response: {
104
- keys: string[];
105
- };
106
- };
107
- [UIPassthroughEvent.GetAnswerConfig]: {
108
- request: {
109
- vizId?: string;
110
- };
111
- response: any;
112
- };
113
- [UIPassthroughEvent.GetLiveboardConfig]: {
114
- request: any;
115
- response: any;
116
- };
117
- [UIPassthroughEvent.GetUnsavedAnswerTML]: {
118
- request: {
119
- sessionId?: string;
120
- vizId?: string;
121
- };
122
- response: {
123
- tml: string;
124
- };
125
- };
126
- [UIPassthroughEvent.GetAnswerSession]: {
127
- request: {
128
- vizId?: string;
129
- };
130
- response: {
131
- session: SessionInterface;
132
- embedAnswerData?: Record<string, any>;
133
- };
134
- };
135
- [UIPassthroughEvent.GetFilters]: {
136
- request: {
137
- vizId?: string;
138
- };
139
- response: {
140
- liveboardFilters: LiveboardFilter[];
141
- runtimeFilters: RuntimeFilter[];
142
- };
143
- };
144
- [UIPassthroughEvent.GetIframeUrl]: {
145
- request: Record<string, never>;
146
- response: {
147
- iframeUrl: string;
148
- };
149
- };
150
- [UIPassthroughEvent.GetParameters]: {
151
- request: Record<string, never>;
152
- response: {
153
- parameters: LiveboardParameter[];
154
- };
155
- };
156
- [UIPassthroughEvent.GetTML]: {
157
- request: {
158
- vizId?: string;
159
- includeNonExecutedSearchTokens?: boolean;
160
- };
161
- response: Record<string, any>;
162
- };
163
- [UIPassthroughEvent.GetTabs]: {
164
- request: Record<string, never>;
165
- response: {
166
- orderedTabIds: string[];
167
- numberOfTabs: number;
168
- Tabs: LiveboardTab[];
169
- };
170
- };
171
- [UIPassthroughEvent.GetGroups]: {
172
- request: Record<string, never>;
173
- response: {
174
- orderedGroupIds: string[];
175
- numberOfGroups: number;
176
- Groups: LiveboardGroup[];
177
- };
178
- };
179
- [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
180
- request: Record<string, never>;
181
- response: {
182
- data: {
183
- v2Content: string;
184
- };
185
- type: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
186
- };
187
- };
188
- [UIPassthroughEvent.UpdateFilters]: {
189
- request: {
190
- filter?: FilterUpdate;
191
- filters?: FilterUpdate[];
192
- };
193
- response: unknown;
194
- };
195
- [UIPassthroughEvent.Drilldown]: {
196
- request: {
197
- points: {
198
- selectedPoints?: string[];
199
- clickedPoint?: string;
200
- };
201
- columnGuid?: string;
202
- autoDrillDown?: boolean;
203
- vizId?: string;
204
- };
205
- response: unknown;
206
- };
207
- };
208
- export type UIPassthroughRequest<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]['request'];
209
- export type UIPassthroughResponse<T extends keyof UIPassthroughContractBase> = UIPassthroughContractBase[T]['response'];
210
- export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> = Array<{
211
- refId?: string;
212
- value?: UIPassthroughResponse<ApiName>;
213
- error?: any;
214
- }>;
215
- export type EmbedApiHostEventMapping = {
216
- [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
217
- [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
218
- [HostEvent.GetAnswerSession]: UIPassthroughEvent.GetAnswerSession;
219
- [HostEvent.GetFilters]: UIPassthroughEvent.GetFilters;
220
- [HostEvent.GetIframeUrl]: UIPassthroughEvent.GetIframeUrl;
221
- [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
222
- [HostEvent.GetTML]: UIPassthroughEvent.GetTML;
223
- [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
224
- [HostEvent.GetGroups]: UIPassthroughEvent.GetGroups;
225
- [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
226
- };
227
- export type HostEventRequest<HostEventT extends HostEvent> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]> : any;
228
- export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> = HostEventT extends keyof EmbedApiHostEventMapping ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]> : any;
229
- export type TriggerPayload<PayloadT, HostEventT extends HostEvent> = PayloadT | HostEventRequest<HostEventT>;
230
- export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> = PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;
231
- //# sourceMappingURL=contracts.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"contracts.d.ts","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iDAAiD,CAAC;AAEnF,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,SAAS,cAAc;IACvB,GAAG,QAAQ;IACX,KAAK,UAAU;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,oBAAY,kBAAkB;IAC5B,oBAAoB,qBAAqB;IACzC,UAAU,eAAe;IACzB,wBAAwB,6BAA6B;IACrD,0BAA0B,+BAA+B;IACzD,eAAe,wBAAwB;IACvC,kBAAkB,0BAA0B;IAC5C,mBAAmB,wBAAwB;IAC3C,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,gBAAgB,qBAAqB;IACrC,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,aAAa,kBAAkB;IAC/B,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,kCAAkC,uCAAuC;CAC1E;AAGD,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,kBAAkB,CAAC,oBAAoB,CAAC,EAAE;QACzC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,UAAU,EAAE,MAAM,CAAC;YACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB,CAAC;QACF,QAAQ,EAAE;YACR,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,EAAE,MAAM,CAAC;YACd,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC/B,OAAO,EAAE;YACP,IAAI,EAAE,MAAM,CAAC;YACb,WAAW,EAAE,MAAM,CAAC;YACpB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,cAAc,CAAC,EAAE,OAAO,CAAC;SAC1B,CAAC;QACF,QAAQ,EAAE;YACR,QAAQ,EAAE,MAAM,CAAC;YACjB,YAAY,CAAC,EAAE,GAAG,CAAC;YACnB,aAAa,CAAC,EAAE,GAAG,CAAC;SACrB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,EAAE;QAC7C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,yBAAyB,EAAE,OAAO,CAAC;YACnC,yCAAyC,EAAE,OAAO,CAAC;SACpD,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,0BAA0B,CAAC,EAAE;QAC/C,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE;YACR,IAAI,EAAE,MAAM,EAAE,CAAC;SAChB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAAE;QACpC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;IACF,CAAC,kBAAkB,CAAC,kBAAkB,CAAC,EAAE;QACvC,OAAO,EAAE,GAAG,CAAC;QACb,QAAQ,EAAE,GAAG,CAAC;KACf,CAAC;IACF,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,EAAE;QACxC,OAAO,EAAE;YACP,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,GAAG,EAAE,MAAM,CAAC;SACb,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,EAAE;QACrC,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,OAAO,EAAE,gBAAgB,CAAC;YAC1B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SACvC,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;QAC/B,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE;YACR,gBAAgB,EAAE,eAAe,EAAE,CAAC;YACpC,cAAc,EAAE,aAAa,EAAE,CAAC;SACjC,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE;QACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,SAAS,EAAE,MAAM,CAAC;SACnB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE;QAClC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,UAAU,EAAE,kBAAkB,EAAE,CAAC;SAClC,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE;QAC3B,OAAO,EAAE;YACP,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,8BAA8B,CAAC,EAAE,OAAO,CAAC;SAC1C,CAAC;QACF,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC/B,CAAC;IACF,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE;QAC5B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,aAAa,EAAE,MAAM,EAAE,CAAC;YACxB,YAAY,EAAE,MAAM,CAAC;YACrB,IAAI,EAAE,YAAY,EAAE,CAAC;SACtB,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE;QAC9B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,eAAe,EAAE,MAAM,EAAE,CAAC;YAC1B,cAAc,EAAE,MAAM,CAAC;YACvB,MAAM,EAAE,cAAc,EAAE,CAAC;SAC1B,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,kCAAkC,CAAC,EAAE;QACvD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,QAAQ,EAAE;YACR,IAAI,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAA;aAAE,CAAC;YAC5B,IAAI,EAAE,kBAAkB,CAAC,kCAAkC,CAAC;SAC7D,CAAC;KACH,CAAC;IACF,CAAC,kBAAkB,CAAC,aAAa,CAAC,EAAE;QAClC,OAAO,EAAE;YACP,MAAM,CAAC,EAAE,YAAY,CAAC;YACtB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;SAC1B,CAAC;QACF,QAAQ,EAAE,OAAO,CAAC;KACnB,CAAC;IACF,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE;QAC9B,OAAO,EAAE;YACP,MAAM,EAAE;gBACN,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;gBAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;aACvB,CAAC;YACF,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,aAAa,CAAC,EAAE,OAAO,CAAC;YACxB,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB,CAAC;QACF,QAAQ,EAAE,OAAO,CAAC;KACnB,CAAC;CACH,CAAC;AAGF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SACxB,MAAM,yBAAyB,IACrC,yBAAyB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAE5C,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,MAAM,yBAAyB,IACvC,yBAAyB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;AAE7C,MAAM,MAAM,0BAA0B,CAAC,OAAO,SAAS,MAAM,yBAAyB,IACpF,KAAK,CAAC;IACJ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACvC,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC,CAAA;AAGJ,MAAM,MAAM,wBAAwB,GAAG;IACrC,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,kBAAkB,CAAC,oBAAoB,CAAC;IACzD,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IACtD,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,gBAAgB,CAAC;IAClE,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC;IACtD,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,kBAAkB,CAAC,YAAY,CAAC;IAC1D,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,kBAAkB,CAAC,aAAa,CAAC;IAC5D,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC;IAC9C,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC;IAChD,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;IACpD,CAAC,SAAS,CAAC,kCAAkC,CAAC,EAAE,kBAAkB,CAAC,kCAAkC,CAAC;CACvG,CAAA;AAGD,MAAM,MAAM,gBAAgB,CAAC,UAAU,SAAS,SAAS,IACvD,UAAU,SAAS,MAAM,wBAAwB,GAC7C,oBAAoB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,GAC1D,GAAG,CAAC;AAEV,MAAM,MAAM,iBAAiB,CAAC,UAAU,SAAS,SAAS,EAAE,QAAQ,SAAS,WAAW,IACtF,UAAU,SAAS,MAAM,wBAAwB,GAC7C,qBAAqB,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,GAC3D,GAAG,CAAC;AAGV,MAAM,MAAM,cAAc,CAAC,QAAQ,EAAE,UAAU,SAAS,SAAS,IAC/D,QAAQ,GAAG,gBAAgB,CAAC,UAAU,CAAC,CAAC;AAC1C,MAAM,MAAM,eAAe,CAAC,QAAQ,EAAE,UAAU,SAAS,SAAS,EAAE,QAAQ,SAAS,WAAW,IAC9F,QAAQ,SAAS,gBAAgB,CAAC,UAAU,CAAC,GAAG,iBAAiB,CAAC,UAAU,EAAE,QAAQ,CAAC,GAAG,GAAG,CAAC"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"contracts.js","sourceRoot":"","sources":["../../../../src/embed/hostEventClient/contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,SAAS,EAAiB,MAAM,aAAa,CAAC;AAepE;;GAEG;AACH,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,iCAAW,CAAA;IACX,qCAAe,CAAA;AACjB,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B;AA8BD,MAAM,CAAN,IAAY,kBAkBX;AAlBD,WAAY,kBAAkB;IAC5B,+DAAyC,CAAA;IACzC,+CAAyB,CAAA;IACzB,2EAAqD,CAAA;IACrD,+EAAyD,CAAA;IACzD,6DAAuC,CAAA;IACvC,kEAA4C,CAAA;IAC5C,iEAA2C,CAAA;IAC3C,qDAA+B,CAAA;IAC/B,6CAAuB,CAAA;IACvB,2DAAqC,CAAA;IACrC,+CAAyB,CAAA;IACzB,mDAA6B,CAAA;IAC7B,qDAA+B,CAAA;IAC/B,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;IACnB,6CAAuB,CAAA;IACvB,+FAAyE,CAAA;AAC3E,CAAC,EAlBW,kBAAkB,KAAlB,kBAAkB,QAkB7B"}
@@ -1,262 +0,0 @@
1
- import { ContextType, HostEvent, RuntimeFilter } from '../../types';
2
- import { SessionInterface } from '../../utils/graphql/answerService/answerService';
3
-
4
- export interface LiveboardTab {
5
- id: string;
6
- name: string;
7
- [key: string]: any;
8
- }
9
-
10
- export interface LiveboardGroup {
11
- id: string;
12
- name: string;
13
- [key: string]: any;
14
- }
15
-
16
- /**
17
- * Levels at which a filter or parameter can be applied.
18
- */
19
- export enum ApplicabilityLevel {
20
- Liveboard = 'LIVEBOARD',
21
- Tab = 'TAB',
22
- Group = 'GROUP',
23
- }
24
-
25
- /**
26
- * Scopes a filter or parameter to a specific target.
27
- * At `LIVEBOARD` level the filter applies to the whole Liveboard, so `targetId`
28
- * is not required.
29
- */
30
- export interface Applicability {
31
- level: ApplicabilityLevel;
32
- targetId?: string;
33
- }
34
-
35
- export interface FilterUpdate {
36
- column: string;
37
- oper: string;
38
- values: string[];
39
- type?: string;
40
- applicability?: Applicability;
41
- }
42
-
43
- export interface LiveboardFilter {
44
- applicability?: Applicability;
45
- [key: string]: any;
46
- }
47
-
48
- export interface LiveboardParameter {
49
- applicability?: Applicability;
50
- [key: string]: any;
51
- }
52
-
53
- export enum UIPassthroughEvent {
54
- PinAnswerToLiveboard = 'addVizToPinboard',
55
- SaveAnswer = 'saveAnswer',
56
- GetDiscoverabilityStatus = 'getDiscoverabilityStatus',
57
- GetAvailableUIPassthroughs = 'getAvailableUiPassthroughs',
58
- GetAnswerConfig = 'getAnswerPageConfig',
59
- GetLiveboardConfig = 'getPinboardPageConfig',
60
- GetUnsavedAnswerTML = 'getUnsavedAnswerTML',
61
- UpdateFilters = 'updateFilters',
62
- Drilldown = 'drillDown',
63
- GetAnswerSession = 'getAnswerSession',
64
- GetFilters = 'getFilters',
65
- GetIframeUrl = 'getIframeUrl',
66
- GetParameters = 'getParameters',
67
- GetTML = 'getTML',
68
- GetTabs = 'getTabs',
69
- GetGroups = 'getGroups',
70
- GetExportRequestForCurrentPinboard = 'getExportRequestForCurrentPinboard',
71
- }
72
-
73
- // UI Passthrough Contract
74
- export type UIPassthroughContractBase = {
75
- [UIPassthroughEvent.PinAnswerToLiveboard]: {
76
- request: {
77
- vizId?: string;
78
- newVizName: string;
79
- newVizDescription?: string;
80
- liveboardId?: string;
81
- tabId?: string;
82
- newLiveboardName?: string;
83
- newTabName?: string;
84
- };
85
- response: {
86
- liveboardId: string;
87
- tabId: string;
88
- vizId: string;
89
- };
90
- };
91
- [UIPassthroughEvent.SaveAnswer]: {
92
- request: {
93
- name: string;
94
- description: string;
95
- vizId?: string;
96
- isDiscoverable?: boolean;
97
- };
98
- response: {
99
- answerId: string,
100
- saveResponse?: any;
101
- shareResponse?: any;
102
- };
103
- };
104
- [UIPassthroughEvent.GetDiscoverabilityStatus]: {
105
- request: any;
106
- response: {
107
- shouldShowDiscoverability: boolean;
108
- isDiscoverabilityCheckboxUnselectedPerOrg: boolean;
109
- };
110
- };
111
- [UIPassthroughEvent.GetAvailableUIPassthroughs]: {
112
- request: any;
113
- response: {
114
- keys: string[];
115
- };
116
- };
117
- [UIPassthroughEvent.GetAnswerConfig]: {
118
- request: {
119
- vizId?: string;
120
- };
121
- response: any;
122
- };
123
- [UIPassthroughEvent.GetLiveboardConfig]: {
124
- request: any;
125
- response: any;
126
- };
127
- [UIPassthroughEvent.GetUnsavedAnswerTML]: {
128
- request: {
129
- sessionId?: string;
130
- vizId?: string;
131
- };
132
- response: {
133
- tml: string;
134
- };
135
- };
136
- [UIPassthroughEvent.GetAnswerSession]: {
137
- request: {
138
- vizId?: string;
139
- };
140
- response: {
141
- session: SessionInterface;
142
- embedAnswerData?: Record<string, any>;
143
- };
144
- };
145
- [UIPassthroughEvent.GetFilters]: {
146
- request: {
147
- vizId?: string;
148
- };
149
- response: {
150
- liveboardFilters: LiveboardFilter[];
151
- runtimeFilters: RuntimeFilter[];
152
- };
153
- };
154
- [UIPassthroughEvent.GetIframeUrl]: {
155
- request: Record<string, never>;
156
- response: {
157
- iframeUrl: string;
158
- };
159
- };
160
- [UIPassthroughEvent.GetParameters]: {
161
- request: Record<string, never>;
162
- response: {
163
- parameters: LiveboardParameter[];
164
- };
165
- };
166
- [UIPassthroughEvent.GetTML]: {
167
- request: {
168
- vizId?: string;
169
- includeNonExecutedSearchTokens?: boolean;
170
- };
171
- response: Record<string, any>;
172
- };
173
- [UIPassthroughEvent.GetTabs]: {
174
- request: Record<string, never>;
175
- response: {
176
- orderedTabIds: string[];
177
- numberOfTabs: number;
178
- Tabs: LiveboardTab[];
179
- };
180
- };
181
- [UIPassthroughEvent.GetGroups]: {
182
- request: Record<string, never>;
183
- response: {
184
- orderedGroupIds: string[];
185
- numberOfGroups: number;
186
- Groups: LiveboardGroup[];
187
- };
188
- };
189
- [UIPassthroughEvent.GetExportRequestForCurrentPinboard]: {
190
- request: Record<string, never>;
191
- response: {
192
- data: { v2Content: string };
193
- type: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
194
- };
195
- };
196
- [UIPassthroughEvent.UpdateFilters]: {
197
- request: {
198
- filter?: FilterUpdate;
199
- filters?: FilterUpdate[];
200
- };
201
- response: unknown;
202
- };
203
- [UIPassthroughEvent.Drilldown]: {
204
- request: {
205
- points: {
206
- selectedPoints?: string[];
207
- clickedPoint?: string;
208
- };
209
- columnGuid?: string;
210
- autoDrillDown?: boolean;
211
- vizId?: string;
212
- };
213
- response: unknown;
214
- };
215
- };
216
-
217
- // UI Passthrough Request and Response
218
- export type UIPassthroughRequest<T
219
- extends keyof UIPassthroughContractBase
220
- > = UIPassthroughContractBase[T]['request'];
221
-
222
- export type UIPassthroughResponse<
223
- T extends keyof UIPassthroughContractBase
224
- > = UIPassthroughContractBase[T]['response'];
225
-
226
- export type UIPassthroughArrayResponse<ApiName extends keyof UIPassthroughContractBase> =
227
- Array<{
228
- refId?: string;
229
- value?: UIPassthroughResponse<ApiName>;
230
- error?: any;
231
- }>
232
-
233
- // Host event and UI Passthrough Event Mapping
234
- export type EmbedApiHostEventMapping = {
235
- [HostEvent.Pin]: UIPassthroughEvent.PinAnswerToLiveboard;
236
- [HostEvent.SaveAnswer]: UIPassthroughEvent.SaveAnswer;
237
- [HostEvent.GetAnswerSession]: UIPassthroughEvent.GetAnswerSession;
238
- [HostEvent.GetFilters]: UIPassthroughEvent.GetFilters;
239
- [HostEvent.GetIframeUrl]: UIPassthroughEvent.GetIframeUrl;
240
- [HostEvent.GetParameters]: UIPassthroughEvent.GetParameters;
241
- [HostEvent.GetTML]: UIPassthroughEvent.GetTML;
242
- [HostEvent.GetTabs]: UIPassthroughEvent.GetTabs;
243
- [HostEvent.GetGroups]: UIPassthroughEvent.GetGroups;
244
- [HostEvent.getExportRequestForCurrentPinboard]: UIPassthroughEvent.GetExportRequestForCurrentPinboard;
245
- }
246
-
247
- // Host Event Request and Response
248
- export type HostEventRequest<HostEventT extends HostEvent> =
249
- HostEventT extends keyof EmbedApiHostEventMapping
250
- ? UIPassthroughRequest<EmbedApiHostEventMapping[HostEventT]>
251
- : any;
252
-
253
- export type HostEventResponse<HostEventT extends HostEvent, ContextT extends ContextType> =
254
- HostEventT extends keyof EmbedApiHostEventMapping
255
- ? UIPassthroughResponse<EmbedApiHostEventMapping[HostEventT]>
256
- : any;
257
-
258
- // trigger response and request
259
- export type TriggerPayload<PayloadT, HostEventT extends HostEvent> =
260
- PayloadT | HostEventRequest<HostEventT>;
261
- export type TriggerResponse<PayloadT, HostEventT extends HostEvent, ContextT extends ContextType> =
262
- PayloadT extends HostEventRequest<HostEventT> ? HostEventResponse<HostEventT, ContextT> : any;