@antelopejs/dms-api 0.1.7 → 0.3.0

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 (346) hide show
  1. package/README.md +99 -8
  2. package/dist/automation/get-api-health.js +4 -3
  3. package/dist/automation/get-api-health.js.map +1 -1
  4. package/dist/automation/route-unhealthy.js +2 -2
  5. package/dist/automation/route-unhealthy.js.map +1 -1
  6. package/dist/automation/scope.d.ts +0 -1
  7. package/dist/automation/scope.js +0 -7
  8. package/dist/automation/scope.js.map +1 -1
  9. package/dist/config.d.ts +4 -0
  10. package/dist/config.js +15 -9
  11. package/dist/config.js.map +1 -1
  12. package/dist/db/models/request_log.model.d.ts +37 -2
  13. package/dist/db/models/request_log.model.js +130 -35
  14. package/dist/db/models/request_log.model.js.map +1 -1
  15. package/dist/db/models/request_log.search.d.ts +5 -0
  16. package/dist/db/models/request_log.search.js +35 -0
  17. package/dist/db/models/request_log.search.js.map +1 -0
  18. package/dist/db/models/request_log.status.d.ts +5 -0
  19. package/dist/db/models/request_log.status.js +9 -0
  20. package/dist/db/models/request_log.status.js.map +1 -0
  21. package/dist/db/models/routes.model.d.ts +1 -0
  22. package/dist/db/models/routes.model.js +5 -1
  23. package/dist/db/models/routes.model.js.map +1 -1
  24. package/dist/db/models/routes_statistics.model.js +1 -1
  25. package/dist/db/models/routes_statistics.model.js.map +1 -1
  26. package/dist/db/tables/api_settings.table.d.ts +1 -0
  27. package/dist/db/tables/api_settings.table.js +4 -0
  28. package/dist/db/tables/api_settings.table.js.map +1 -1
  29. package/dist/db/tables/request_log.table.d.ts +18 -3
  30. package/dist/db/tables/request_log.table.js +34 -1
  31. package/dist/db/tables/request_log.table.js.map +1 -1
  32. package/dist/db/tables/routes.table.d.ts +1 -2
  33. package/dist/db/tables/routes.table.js.map +1 -1
  34. package/dist/db/tables/routes_statistics.table.d.ts +4 -3
  35. package/dist/db/tables/routes_statistics.table.js +5 -1
  36. package/dist/db/tables/routes_statistics.table.js.map +1 -1
  37. package/dist/index.d.ts +1 -1
  38. package/dist/index.js +9 -1
  39. package/dist/index.js.map +1 -1
  40. package/dist/memo.d.ts +5 -0
  41. package/dist/memo.js +36 -0
  42. package/dist/memo.js.map +1 -0
  43. package/dist/pages/blocks.d.ts +3 -0
  44. package/dist/pages/blocks.js +31 -0
  45. package/dist/pages/blocks.js.map +1 -0
  46. package/dist/pages/displays.d.ts +7 -0
  47. package/dist/pages/displays.js +23 -0
  48. package/dist/pages/displays.js.map +1 -0
  49. package/dist/pages/index.d.ts +5 -2
  50. package/dist/pages/index.js +5 -2
  51. package/dist/pages/index.js.map +1 -1
  52. package/dist/pages/logs.d.ts +18 -0
  53. package/dist/pages/logs.js +112 -0
  54. package/dist/pages/logs.js.map +1 -0
  55. package/dist/pages/module.d.ts +3 -0
  56. package/dist/pages/module.js +102 -6
  57. package/dist/pages/module.js.map +1 -1
  58. package/dist/pages/overview.d.ts +14 -0
  59. package/dist/pages/overview.js +215 -0
  60. package/dist/pages/overview.js.map +1 -0
  61. package/dist/pages/period.d.ts +9 -0
  62. package/dist/pages/period.js +24 -0
  63. package/dist/pages/period.js.map +1 -0
  64. package/dist/pages/request-table.d.ts +11 -0
  65. package/dist/pages/request-table.js +187 -0
  66. package/dist/pages/request-table.js.map +1 -0
  67. package/dist/pages/routes.d.ts +15 -0
  68. package/dist/pages/routes.js +269 -0
  69. package/dist/pages/routes.js.map +1 -0
  70. package/dist/pages/scope-chip.d.ts +9 -0
  71. package/dist/pages/scope-chip.js +28 -0
  72. package/dist/pages/scope-chip.js.map +1 -0
  73. package/dist/pages/{logs/page.d.ts → settings.d.ts} +3 -3
  74. package/dist/pages/settings.js +218 -0
  75. package/dist/pages/settings.js.map +1 -0
  76. package/dist/pages/toolbar.d.ts +9 -0
  77. package/dist/pages/toolbar.js +33 -0
  78. package/dist/pages/toolbar.js.map +1 -0
  79. package/dist/realtime.d.ts +2 -0
  80. package/dist/realtime.js +21 -0
  81. package/dist/realtime.js.map +1 -0
  82. package/dist/routes/index.d.ts +2 -2
  83. package/dist/routes/index.js +2 -2
  84. package/dist/routes/index.js.map +1 -1
  85. package/dist/routes/logs.d.ts +173 -2
  86. package/dist/routes/logs.js +177 -86
  87. package/dist/routes/logs.js.map +1 -1
  88. package/dist/routes/overview.d.ts +27 -0
  89. package/dist/routes/overview.js +131 -0
  90. package/dist/routes/overview.js.map +1 -0
  91. package/dist/routes/routes.d.ts +92 -28
  92. package/dist/routes/routes.js +165 -97
  93. package/dist/routes/routes.js.map +1 -1
  94. package/dist/routes/settings.d.ts +16 -11
  95. package/dist/routes/settings.js +62 -54
  96. package/dist/routes/settings.js.map +1 -1
  97. package/dist/routes/tester.d.ts +7 -0
  98. package/dist/routes/tester.js +34 -0
  99. package/dist/routes/tester.js.map +1 -0
  100. package/dist/services/activity.d.ts +49 -0
  101. package/dist/services/activity.js +207 -0
  102. package/dist/services/activity.js.map +1 -0
  103. package/dist/services/aggregate-cache.d.ts +3 -0
  104. package/dist/services/aggregate-cache.js +16 -0
  105. package/dist/services/aggregate-cache.js.map +1 -0
  106. package/dist/services/api-origin.d.ts +1 -0
  107. package/dist/services/api-origin.js +9 -0
  108. package/dist/services/api-origin.js.map +1 -0
  109. package/dist/services/attention.d.ts +45 -0
  110. package/dist/services/attention.js +203 -0
  111. package/dist/services/attention.js.map +1 -0
  112. package/dist/services/composed-text.d.ts +6 -0
  113. package/dist/services/composed-text.js +23 -0
  114. package/dist/services/composed-text.js.map +1 -0
  115. package/dist/services/health-rules.d.ts +49 -0
  116. package/dist/services/health-rules.js +233 -0
  117. package/dist/services/health-rules.js.map +1 -0
  118. package/dist/services/index.d.ts +1 -3
  119. package/dist/services/index.js +3 -3
  120. package/dist/services/index.js.map +1 -1
  121. package/dist/services/introspection/decorators.d.ts +14 -0
  122. package/dist/services/introspection/decorators.js +192 -0
  123. package/dist/services/introspection/decorators.js.map +1 -0
  124. package/dist/services/introspection/errors.js +4 -4
  125. package/dist/services/introspection/errors.js.map +1 -1
  126. package/dist/services/introspection/index.d.ts +6 -8
  127. package/dist/services/introspection/index.js +96 -32
  128. package/dist/services/introspection/index.js.map +1 -1
  129. package/dist/services/introspection/probe.d.ts +2 -1
  130. package/dist/services/introspection/probe.js +11 -0
  131. package/dist/services/introspection/probe.js.map +1 -1
  132. package/dist/services/links.d.ts +25 -0
  133. package/dist/services/links.js +72 -0
  134. package/dist/services/links.js.map +1 -0
  135. package/dist/services/live-feed.d.ts +6 -0
  136. package/dist/services/live-feed.js +18 -0
  137. package/dist/services/live-feed.js.map +1 -0
  138. package/dist/services/live.d.ts +16 -0
  139. package/dist/services/live.js +32 -0
  140. package/dist/services/live.js.map +1 -0
  141. package/dist/services/overview.d.ts +122 -0
  142. package/dist/services/overview.js +324 -0
  143. package/dist/services/overview.js.map +1 -0
  144. package/dist/services/period.d.ts +0 -9
  145. package/dist/services/period.js +5 -52
  146. package/dist/services/period.js.map +1 -1
  147. package/dist/services/request-log/access.d.ts +5 -0
  148. package/dist/services/request-log/access.js +21 -0
  149. package/dist/services/request-log/access.js.map +1 -0
  150. package/dist/services/request-log/capture.d.ts +30 -0
  151. package/dist/services/request-log/capture.js +216 -39
  152. package/dist/services/request-log/capture.js.map +1 -1
  153. package/dist/services/request-log/list.d.ts +36 -0
  154. package/dist/services/request-log/list.js +201 -0
  155. package/dist/services/request-log/list.js.map +1 -0
  156. package/dist/services/request-log/read.d.ts +15 -2
  157. package/dist/services/request-log/read.js +47 -4
  158. package/dist/services/request-log/read.js.map +1 -1
  159. package/dist/services/request-log/redaction.d.ts +16 -3
  160. package/dist/services/request-log/redaction.js +149 -27
  161. package/dist/services/request-log/redaction.js.map +1 -1
  162. package/dist/services/request-log/util.d.ts +10 -3
  163. package/dist/services/request-log/util.js +39 -22
  164. package/dist/services/request-log/util.js.map +1 -1
  165. package/dist/services/route-catalog.d.ts +62 -0
  166. package/dist/services/route-catalog.js +163 -0
  167. package/dist/services/route-catalog.js.map +1 -0
  168. package/dist/services/route-contract.d.ts +66 -0
  169. package/dist/services/route-contract.js +266 -0
  170. package/dist/services/route-contract.js.map +1 -0
  171. package/dist/services/route-health.d.ts +35 -0
  172. package/dist/services/route-health.js +179 -0
  173. package/dist/services/route-health.js.map +1 -0
  174. package/dist/services/route-statistics.d.ts +68 -0
  175. package/dist/services/route-statistics.js +277 -0
  176. package/dist/services/route-statistics.js.map +1 -0
  177. package/dist/services/routes-sync.d.ts +7 -3
  178. package/dist/services/routes-sync.js +96 -20
  179. package/dist/services/routes-sync.js.map +1 -1
  180. package/dist/services/scope.d.ts +0 -1
  181. package/dist/services/scope.js +4 -17
  182. package/dist/services/scope.js.map +1 -1
  183. package/dist/services/settings-form.d.ts +131 -0
  184. package/dist/services/settings-form.js +210 -0
  185. package/dist/services/settings-form.js.map +1 -0
  186. package/dist/services/settings.d.ts +2 -0
  187. package/dist/services/settings.js +5 -0
  188. package/dist/services/settings.js.map +1 -1
  189. package/dist/services/statistics-aggregate.d.ts +6 -41
  190. package/dist/services/statistics-aggregate.js +55 -280
  191. package/dist/services/statistics-aggregate.js.map +1 -1
  192. package/dist/services/statistics-utils.d.ts +7 -12
  193. package/dist/services/statistics-utils.js +36 -51
  194. package/dist/services/statistics-utils.js.map +1 -1
  195. package/dist/services/statistics-write.js +64 -22
  196. package/dist/services/statistics-write.js.map +1 -1
  197. package/dist/services/tester-source.d.ts +11 -0
  198. package/dist/services/tester-source.js +48 -0
  199. package/dist/services/tester-source.js.map +1 -0
  200. package/dist/services/traffic-samples.d.ts +18 -0
  201. package/dist/services/traffic-samples.js +134 -0
  202. package/dist/services/traffic-samples.js.map +1 -0
  203. package/dist/services/traffic.d.ts +43 -0
  204. package/dist/services/traffic.js +270 -0
  205. package/dist/services/traffic.js.map +1 -0
  206. package/dist/services/window.d.ts +48 -0
  207. package/dist/services/window.js +179 -0
  208. package/dist/services/window.js.map +1 -0
  209. package/dist/types/constants.d.ts +11 -20
  210. package/dist/types/constants.js +15 -25
  211. package/dist/types/constants.js.map +1 -1
  212. package/dist/types/index.d.ts +0 -1
  213. package/dist/types/index.js +0 -1
  214. package/dist/types/index.js.map +1 -1
  215. package/dist/types/statistics.d.ts +5 -3
  216. package/dist/types/statistics.js +5 -0
  217. package/dist/types/statistics.js.map +1 -1
  218. package/frontend-vue/app/components/blocks/BetaBadge.vue +20 -0
  219. package/frontend-vue/app/components/blocks/HealthHero.vue +708 -0
  220. package/frontend-vue/app/components/blocks/LiveTraffic.vue +356 -0
  221. package/frontend-vue/app/components/blocks/LogsEmptyState.vue +228 -0
  222. package/frontend-vue/app/components/blocks/LogsFilters.vue +279 -0
  223. package/frontend-vue/app/components/blocks/RequestDetail.vue +722 -0
  224. package/frontend-vue/app/components/blocks/RetentionInput.vue +227 -0
  225. package/frontend-vue/app/components/blocks/RouteDocumentation.vue +611 -0
  226. package/frontend-vue/app/components/blocks/RouteHeader.vue +320 -0
  227. package/frontend-vue/app/components/blocks/RouteTester.vue +1879 -0
  228. package/frontend-vue/app/components/blocks/RouteTree.vue +676 -0
  229. package/frontend-vue/app/components/blocks/ScopeChip.vue +89 -0
  230. package/frontend-vue/app/components/blocks/SettingNumberInput.vue +65 -0
  231. package/frontend-vue/app/components/blocks/SplitLayout.vue +41 -0
  232. package/frontend-vue/app/components/internal/ApiBody.vue +129 -0
  233. package/frontend-vue/app/components/internal/ApiJsonTree.vue +82 -0
  234. package/frontend-vue/app/components/internal/ApiKeyValues.vue +41 -0
  235. package/frontend-vue/app/components/internal/ApiMethodBadge.vue +19 -19
  236. package/frontend-vue/app/components/internal/ApiPath.vue +33 -0
  237. package/frontend-vue/app/components/internal/ApiStatusBadge.vue +20 -15
  238. package/frontend-vue/app/components/internal/ApiTesterBadge.vue +17 -0
  239. package/frontend-vue/app/composables/useApiOrigin.ts +19 -0
  240. package/frontend-vue/app/composables/useApiPeriod.ts +19 -0
  241. package/frontend-vue/app/composables/useApiResource.ts +92 -0
  242. package/frontend-vue/app/composables/useDateFormat.ts +23 -0
  243. package/frontend-vue/app/composables/useLiveMissedErrors.ts +33 -0
  244. package/frontend-vue/app/composables/useRouteDetail.ts +253 -0
  245. package/frontend-vue/app/composables/useRouteSelection.ts +43 -0
  246. package/frontend-vue/app/config/shortcuts-registry.ts +30 -0
  247. package/frontend-vue/app/plugins/displays.ts +92 -0
  248. package/frontend-vue/app/utils/format.ts +281 -0
  249. package/frontend-vue/app/utils/http.ts +127 -0
  250. package/frontend-vue/app/utils/logsQuery.ts +261 -0
  251. package/frontend-vue/app/utils/minuteHistogram.ts +116 -0
  252. package/frontend-vue/app/utils/requestDrawer.ts +257 -0
  253. package/frontend-vue/app/utils/routeExplorer.ts +206 -0
  254. package/frontend-vue/app/utils/search.ts +45 -0
  255. package/frontend-vue/app/utils/settingsForm.ts +119 -0
  256. package/frontend-vue/app/utils/snippets.ts +501 -0
  257. package/frontend-vue/app/utils/testerHistory.ts +354 -0
  258. package/frontend-vue/app/utils/testerRequest.ts +632 -11
  259. package/frontend-vue/dms.frontend.build.ts +7 -0
  260. package/frontend-vue/dms.frontend.ts +10 -3
  261. package/frontend-vue/i18n/locales/api-en-GB.json +866 -0
  262. package/frontend-vue/i18n/locales/api-fr-FR.json +866 -0
  263. package/frontend-vue/package.json +2 -6
  264. package/frontend-vue/pnpm-lock.yaml +97 -3375
  265. package/frontend-vue/tests/format.test.ts +180 -0
  266. package/frontend-vue/tests/http.test.ts +61 -0
  267. package/frontend-vue/tests/logsQuery.test.ts +255 -0
  268. package/frontend-vue/tests/minuteHistogram.test.ts +94 -0
  269. package/frontend-vue/tests/registration.test.ts +24 -7
  270. package/frontend-vue/tests/requestDrawer.test.ts +179 -0
  271. package/frontend-vue/tests/routeExplorer.test.ts +206 -0
  272. package/frontend-vue/tests/settingsForm.test.ts +155 -0
  273. package/frontend-vue/tests/snippets.test.ts +285 -0
  274. package/frontend-vue/tests/testerHistory.test.ts +295 -0
  275. package/frontend-vue/tests/testerRequest.test.ts +471 -76
  276. package/package.json +9 -9
  277. package/dist/middlewares/index.d.ts +0 -1
  278. package/dist/middlewares/index.js +0 -18
  279. package/dist/middlewares/index.js.map +0 -1
  280. package/dist/middlewares/request-log-capture.d.ts +0 -1
  281. package/dist/middlewares/request-log-capture.js +0 -6
  282. package/dist/middlewares/request-log-capture.js.map +0 -1
  283. package/dist/pages/all.d.ts +0 -4
  284. package/dist/pages/all.js +0 -21
  285. package/dist/pages/all.js.map +0 -1
  286. package/dist/pages/logs/page.js +0 -29
  287. package/dist/pages/logs/page.js.map +0 -1
  288. package/dist/pages/routes/page.d.ts +0 -9
  289. package/dist/pages/routes/page.js +0 -29
  290. package/dist/pages/routes/page.js.map +0 -1
  291. package/dist/pages/settings/form.d.ts +0 -3
  292. package/dist/pages/settings/form.js +0 -80
  293. package/dist/pages/settings/form.js.map +0 -1
  294. package/dist/pages/settings/page.d.ts +0 -9
  295. package/dist/pages/settings/page.js +0 -26
  296. package/dist/pages/settings/page.js.map +0 -1
  297. package/dist/pages/summary/page.d.ts +0 -9
  298. package/dist/pages/summary/page.js +0 -29
  299. package/dist/pages/summary/page.js.map +0 -1
  300. package/dist/routes/monitoring.d.ts +0 -17
  301. package/dist/routes/monitoring.js +0 -101
  302. package/dist/routes/monitoring.js.map +0 -1
  303. package/dist/routes/summary.d.ts +0 -32
  304. package/dist/routes/summary.js +0 -181
  305. package/dist/routes/summary.js.map +0 -1
  306. package/dist/services/request-log/index.d.ts +0 -3
  307. package/dist/services/request-log/index.js +0 -12
  308. package/dist/services/request-log/index.js.map +0 -1
  309. package/dist/services/statistics-read.d.ts +0 -4
  310. package/dist/services/statistics-read.js +0 -48
  311. package/dist/services/statistics-read.js.map +0 -1
  312. package/dist/services/tree.d.ts +0 -10
  313. package/dist/services/tree.js +0 -128
  314. package/dist/services/tree.js.map +0 -1
  315. package/dist/types/charts.d.ts +0 -9
  316. package/dist/types/charts.js +0 -3
  317. package/dist/types/charts.js.map +0 -1
  318. package/frontend-vue/app/components/ConfigurationView.vue +0 -187
  319. package/frontend-vue/app/components/DocumentationView.vue +0 -224
  320. package/frontend-vue/app/components/LogDetailDrawer.vue +0 -178
  321. package/frontend-vue/app/components/LogsView.vue +0 -347
  322. package/frontend-vue/app/components/RouteDetailTabs.vue +0 -179
  323. package/frontend-vue/app/components/RouteTree.vue +0 -196
  324. package/frontend-vue/app/components/RoutesView.vue +0 -79
  325. package/frontend-vue/app/components/StatsView.vue +0 -268
  326. package/frontend-vue/app/components/SummaryView.vue +0 -657
  327. package/frontend-vue/app/components/TesterPanel.vue +0 -499
  328. package/frontend-vue/app/components/internal/PeriodSelect.vue +0 -58
  329. package/frontend-vue/app/components/internal/RouteTreeNode.vue +0 -168
  330. package/frontend-vue/app/components/internal/StatusBreakdownBars.vue +0 -162
  331. package/frontend-vue/app/components/internal/StatusDonut.vue +0 -84
  332. package/frontend-vue/app/components/internal/UnitAreaChart.vue +0 -73
  333. package/frontend-vue/app/composables/useApiIntrospection.ts +0 -350
  334. package/frontend-vue/app/composables/useLogDetailDrawer.ts +0 -50
  335. package/frontend-vue/app/composables/useSelectedPeriod.ts +0 -107
  336. package/frontend-vue/app/composables/useStatsPeriods.ts +0 -139
  337. package/frontend-vue/app/custom-layouts/.gitkeep +0 -0
  338. package/frontend-vue/app/custom-pages/.gitkeep +0 -0
  339. package/frontend-vue/app/utils/httpMethod.ts +0 -49
  340. package/frontend-vue/app/utils/statusClass.ts +0 -49
  341. package/frontend-vue/i18n/locales/en-GB.json +0 -240
  342. package/frontend-vue/i18n/locales/fr-FR.json +0 -240
  343. package/frontend-vue/public/.gitkeep +0 -0
  344. package/frontend-vue/server/.gitkeep +0 -0
  345. package/frontend-vue/tests/periods.test.ts +0 -145
  346. package/frontend-vue/tests/persistence.test.ts +0 -45
@@ -0,0 +1,320 @@
1
+ <script setup lang="ts">
2
+ import { computed, watch } from 'vue'
3
+ import { routeSnippetRequest, toCurl } from '../../utils/snippets'
4
+ import { hasRequestBody } from '../../utils/http'
5
+ import { windowParts } from '../../utils/routeExplorer'
6
+ import { linkedPeriod } from '../../utils/logsQuery'
7
+ import ApiMethodBadge from '../internal/ApiMethodBadge.vue'
8
+ import ApiPath from '../internal/ApiPath.vue'
9
+
10
+ // The selected route, above its tabs: what it is, who may call it, where it
11
+ // comes from, and the two ways out — its requests over the page's period and
12
+ // a cURL to replay it. It names the route in the tab title and the
13
+ // breadcrumb, so two open routes can be told apart.
14
+ defineOptions({ inheritAttrs: false })
15
+
16
+ const props = withDefaults(
17
+ defineProps<{
18
+ fetchUrl: string
19
+ queryKey?: string
20
+ settingsUrl?: string
21
+ /**
22
+ * Query key of the page's tabs, and the slots of the Statistics tab
23
+ * (the first, which the URL names by its slot or not at all) and of the
24
+ * tester (it has its own cURL).
25
+ */
26
+ tabKey?: string
27
+ statisticsTab?: string
28
+ testerTab?: string
29
+ /** The live feed (`LIVE_REQUESTS_TOPIC`): the state is read again on it. */
30
+ realtimeTopic?: string
31
+ }>(),
32
+ {
33
+ queryKey: 'route',
34
+ settingsUrl: '/modules/api/settings',
35
+ tabKey: 'tab',
36
+ statisticsTab: 'statistics',
37
+ testerTab: 'tester',
38
+ },
39
+ )
40
+
41
+ /**
42
+ * How sure the console is that a call needs a session: a guard in the code,
43
+ * signs of one (401 answers), or nothing to tell. Never "public": no guard
44
+ * found does not mean anyone may call it.
45
+ */
46
+ const AUTH_DISPLAY = {
47
+ required: { icon: 'i-ph-lock-simple', label: 'api.routes.header.auth' },
48
+ probable: {
49
+ icon: 'i-ph-shield-check',
50
+ label: 'api.routes.header.auth_probable',
51
+ },
52
+ unknown: { icon: 'i-ph-question', label: 'api.routes.header.auth_unknown' },
53
+ } as const
54
+
55
+ const STATE_TONE = {
56
+ failing: 'error',
57
+ slow: 'warning',
58
+ 'client-errors': 'warning',
59
+ recovered: 'info',
60
+ healthy: 'success',
61
+ idle: 'neutral',
62
+ } as const
63
+
64
+ const { t } = useI18n()
65
+ const dateFormat = useDateFormat()
66
+ const toast = useToast()
67
+ const page = useDmsRoute()
68
+ const recordLabel = usePageRecordLabel()
69
+ const {
70
+ data: route,
71
+ pending,
72
+ missing,
73
+ selection,
74
+ refresh,
75
+ error,
76
+ } = useRouteDetail(props.fetchUrl, props.queryKey)
77
+ const apiOrigin = useApiOrigin(() => route.value?.apiOrigin)
78
+ const period = useApiPeriod()
79
+ const auth = computed(() =>
80
+ route.value ? AUTH_DISPLAY[route.value.auth?.status ?? 'unknown'] : null,
81
+ )
82
+
83
+ const requestsLink = computed(() => {
84
+ if (!route.value) return ''
85
+ // The page's period, which the request logs' selector reads the same.
86
+ const query = new URLSearchParams({
87
+ route: route.value.ref,
88
+ ...linkedPeriod(period.value),
89
+ })
90
+ return `/modules/api/logs?${query}`
91
+ })
92
+
93
+ /** "Failing · last 24 h": the state, with the window it is judged on. */
94
+ const stateLabel = computed(() => {
95
+ if (!route.value) return ''
96
+ const label = t(`api.routes.state.${route.value.state.replace('-', '_')}`)
97
+ const minutes = route.value.healthWindowMinutes
98
+ if (!minutes) return label
99
+ const { unit, amount } = windowParts(minutes)
100
+ return t('api.routes.header.state_window', {
101
+ state: label,
102
+ window: t(`api.routes.window.${unit}`, { amount }),
103
+ })
104
+ })
105
+
106
+ // The breadcrumb label is held with the page's path: it never shows on
107
+ // another page, so it needs no clearing when the page goes.
108
+ const opened = computed(() => route.value?.ref ?? null)
109
+ useHead({
110
+ title: computed(() =>
111
+ opened.value ? `${opened.value} · ${t('api.routes.title')}` : undefined,
112
+ ),
113
+ })
114
+ watch(
115
+ opened,
116
+ (ref) =>
117
+ recordLabel.setLabel(
118
+ page.path,
119
+ ref ? t('api.routes.header.crumb', { route: ref }) : undefined,
120
+ ),
121
+ { immediate: true },
122
+ )
123
+
124
+ const source = computed(() => {
125
+ if (!route.value) return ''
126
+ if (route.value.own) return t('api.routes.header.own')
127
+ return route.value.module
128
+ ? t('api.routes.header.module', { module: route.value.module })
129
+ : t('api.routes.header.unknown_source')
130
+ })
131
+
132
+ const FIRST_SEEN: Intl.DateTimeFormatOptions = { dateStyle: 'medium' }
133
+
134
+ /** The day the route first answered, as far back as the statistics go. */
135
+ const firstSeen = computed(() => {
136
+ const at = route.value?.firstCallAt
137
+ if (!at) return ''
138
+ return t('api.routes.header.first_seen', {
139
+ date: dateFormat.value(FIRST_SEEN).format(new Date(at)),
140
+ })
141
+ })
142
+
143
+ // The tester copies the cURL of the request it is building: a second one,
144
+ // of the bare route, would be a different command under the same name.
145
+ const onTester = computed(() => page.query[props.tabKey] === props.testerTab)
146
+
147
+ // Live, the route's state is read again on the Statistics tab only: the
148
+ // documentation and the tester read the same detail, and must not move.
149
+ usePageLiveRefresh(
150
+ () => {
151
+ const tab = page.query[props.tabKey]
152
+ if (!tab || tab === props.statisticsTab) void refresh()
153
+ },
154
+ { realtimeTopic: props.realtimeTopic },
155
+ )
156
+
157
+ async function copyCurl() {
158
+ if (!route.value) return
159
+ const curl = toCurl(
160
+ routeSnippetRequest(
161
+ route.value,
162
+ apiOrigin.value,
163
+ hasRequestBody(route.value.method),
164
+ ),
165
+ )
166
+ try {
167
+ await navigator.clipboard.writeText(curl)
168
+ toast.add({
169
+ title: t('api.request.curl_copied'),
170
+ color: 'success',
171
+ icon: 'i-ph-check',
172
+ })
173
+ } catch {
174
+ toast.add({
175
+ title: t('api.request.copy_failed'),
176
+ color: 'error',
177
+ icon: 'i-ph-warning',
178
+ })
179
+ }
180
+ }
181
+ </script>
182
+
183
+ <template>
184
+ <div class="flex scroll-mt-4 flex-col gap-3">
185
+ <DmsCard v-if="!selection.ref.value" :padded="false" class="px-5 py-8">
186
+ <DmsEmptyState
187
+ icon="i-ph-tree-structure"
188
+ :title="t('api.routes.header.pick_title')"
189
+ :description="t('api.routes.header.pick_description')"
190
+ />
191
+ </DmsCard>
192
+
193
+ <DmsCard v-else-if="pending" :padded="false" class="px-5 py-4">
194
+ <USkeleton class="h-3 w-40" />
195
+ <USkeleton class="mt-3 h-7 w-72" />
196
+ <USkeleton class="mt-3 h-3 w-96" />
197
+ </DmsCard>
198
+
199
+ <DmsCard v-else-if="!route" :padded="false" class="px-5 py-6">
200
+ <DmsEmptyState
201
+ :variant="missing ? 'no-result' : 'error'"
202
+ :title="
203
+ missing
204
+ ? t('api.routes.header.missing_title', {
205
+ route: selection.ref.value,
206
+ })
207
+ : t('api.routes.header.error_title')
208
+ "
209
+ :description="
210
+ missing
211
+ ? t('api.routes.header.missing_description')
212
+ : String((error as Error)?.message ?? '')
213
+ "
214
+ :actions="
215
+ missing
216
+ ? [
217
+ {
218
+ label: t('api.routes.header.clear'),
219
+ color: 'neutral',
220
+ variant: 'outline',
221
+ onClick: () => selection.select(null),
222
+ },
223
+ ]
224
+ : [{ label: t('api.common.retry'), onClick: () => refresh() }]
225
+ "
226
+ />
227
+ </DmsCard>
228
+
229
+ <DmsCard v-else :padded="false" class="px-5 py-4">
230
+ <p class="text-dimmed flex items-center gap-1.5 font-mono text-[11.5px]">
231
+ <UIcon name="i-ph-folder-simple" class="size-3.5" />
232
+ {{ route.folder }}
233
+ <template v-if="route.controller">· {{ route.controller }}</template>
234
+ </p>
235
+ <div class="mt-2 flex flex-wrap items-center gap-3">
236
+ <ApiMethodBadge :method="route.method" />
237
+ <ApiPath
238
+ :path="route.path"
239
+ class="text-highlighted text-xl font-semibold tracking-tight"
240
+ />
241
+ <DmsCopyButton :value="route.path" />
242
+ <span class="grow" />
243
+ <UButton
244
+ :to="requestsLink"
245
+ size="sm"
246
+ color="neutral"
247
+ variant="outline"
248
+ icon="i-ph-list-magnifying-glass"
249
+ :label="t('api.routes.header.requests')"
250
+ />
251
+ <UButton
252
+ v-if="!onTester"
253
+ size="sm"
254
+ color="neutral"
255
+ variant="outline"
256
+ icon="i-ph-terminal"
257
+ :label="t('api.request.copy_curl')"
258
+ @click="copyCurl"
259
+ />
260
+ </div>
261
+ <div
262
+ class="text-muted mt-3 flex flex-wrap items-center gap-x-4 gap-y-1.5 text-[12.5px]"
263
+ >
264
+ <DmsStatusPill
265
+ :tone="STATE_TONE[route.state]"
266
+ :label="stateLabel"
267
+ :dot="route.state === 'idle' ? 'static' : 'live'"
268
+ :mono="false"
269
+ variant="text"
270
+ />
271
+ <span class="inline-flex items-center gap-1.5 font-mono text-[12px]">
272
+ <UIcon name="i-ph-code" class="size-3.5" />
273
+ {{
274
+ route.controller
275
+ ? `${route.controller}.${route.handler}`
276
+ : route.handler
277
+ }}
278
+ </span>
279
+ <span
280
+ v-if="auth"
281
+ class="inline-flex items-center gap-1.5"
282
+ :title="route.auth?.guards.join(', ') || undefined"
283
+ >
284
+ <UIcon :name="auth.icon" class="size-3.5" />
285
+ {{ t(auth.label) }}
286
+ </span>
287
+ <span class="inline-flex items-center gap-1.5">
288
+ <UIcon name="i-ph-cube" class="size-3.5" />
289
+ {{ source }}
290
+ </span>
291
+ <span
292
+ v-if="firstSeen"
293
+ class="inline-flex items-center gap-1.5"
294
+ :title="t('api.routes.header.first_seen_hint')"
295
+ >
296
+ <UIcon name="i-ph-calendar-blank" class="size-3.5" />
297
+ {{ firstSeen }}
298
+ </span>
299
+ </div>
300
+ </DmsCard>
301
+
302
+ <UAlert
303
+ v-if="route && route.inScope === false"
304
+ color="neutral"
305
+ variant="subtle"
306
+ icon="i-ph-funnel"
307
+ :title="t('api.routes.header.out_of_scope_title')"
308
+ :description="t('api.routes.header.out_of_scope_description')"
309
+ :actions="[
310
+ {
311
+ label: t('api.routes.header.out_of_scope_action'),
312
+ to: settingsUrl,
313
+ color: 'neutral',
314
+ variant: 'outline',
315
+ size: 'xs',
316
+ },
317
+ ]"
318
+ />
319
+ </div>
320
+ </template>