@antelopejs/dms-api 0.1.6 → 0.2.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 (347) 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 +4 -5
  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/frontend-vue/tests/tooltipTriggers.test.ts +51 -0
  277. package/package.json +8 -8
  278. package/dist/middlewares/index.d.ts +0 -1
  279. package/dist/middlewares/index.js +0 -18
  280. package/dist/middlewares/index.js.map +0 -1
  281. package/dist/middlewares/request-log-capture.d.ts +0 -1
  282. package/dist/middlewares/request-log-capture.js +0 -6
  283. package/dist/middlewares/request-log-capture.js.map +0 -1
  284. package/dist/pages/all.d.ts +0 -4
  285. package/dist/pages/all.js +0 -21
  286. package/dist/pages/all.js.map +0 -1
  287. package/dist/pages/logs/page.js +0 -29
  288. package/dist/pages/logs/page.js.map +0 -1
  289. package/dist/pages/routes/page.d.ts +0 -9
  290. package/dist/pages/routes/page.js +0 -29
  291. package/dist/pages/routes/page.js.map +0 -1
  292. package/dist/pages/settings/form.d.ts +0 -3
  293. package/dist/pages/settings/form.js +0 -80
  294. package/dist/pages/settings/form.js.map +0 -1
  295. package/dist/pages/settings/page.d.ts +0 -9
  296. package/dist/pages/settings/page.js +0 -26
  297. package/dist/pages/settings/page.js.map +0 -1
  298. package/dist/pages/summary/page.d.ts +0 -9
  299. package/dist/pages/summary/page.js +0 -29
  300. package/dist/pages/summary/page.js.map +0 -1
  301. package/dist/routes/monitoring.d.ts +0 -17
  302. package/dist/routes/monitoring.js +0 -101
  303. package/dist/routes/monitoring.js.map +0 -1
  304. package/dist/routes/summary.d.ts +0 -32
  305. package/dist/routes/summary.js +0 -181
  306. package/dist/routes/summary.js.map +0 -1
  307. package/dist/services/request-log/index.d.ts +0 -3
  308. package/dist/services/request-log/index.js +0 -12
  309. package/dist/services/request-log/index.js.map +0 -1
  310. package/dist/services/statistics-read.d.ts +0 -4
  311. package/dist/services/statistics-read.js +0 -48
  312. package/dist/services/statistics-read.js.map +0 -1
  313. package/dist/services/tree.d.ts +0 -10
  314. package/dist/services/tree.js +0 -128
  315. package/dist/services/tree.js.map +0 -1
  316. package/dist/types/charts.d.ts +0 -9
  317. package/dist/types/charts.js +0 -3
  318. package/dist/types/charts.js.map +0 -1
  319. package/frontend-vue/app/components/ConfigurationView.vue +0 -187
  320. package/frontend-vue/app/components/DocumentationView.vue +0 -224
  321. package/frontend-vue/app/components/LogDetailDrawer.vue +0 -178
  322. package/frontend-vue/app/components/LogsView.vue +0 -347
  323. package/frontend-vue/app/components/RouteDetailTabs.vue +0 -179
  324. package/frontend-vue/app/components/RouteTree.vue +0 -196
  325. package/frontend-vue/app/components/RoutesView.vue +0 -79
  326. package/frontend-vue/app/components/StatsView.vue +0 -268
  327. package/frontend-vue/app/components/SummaryView.vue +0 -657
  328. package/frontend-vue/app/components/TesterPanel.vue +0 -499
  329. package/frontend-vue/app/components/internal/PeriodSelect.vue +0 -58
  330. package/frontend-vue/app/components/internal/RouteTreeNode.vue +0 -168
  331. package/frontend-vue/app/components/internal/StatusBreakdownBars.vue +0 -162
  332. package/frontend-vue/app/components/internal/StatusDonut.vue +0 -84
  333. package/frontend-vue/app/components/internal/UnitAreaChart.vue +0 -73
  334. package/frontend-vue/app/composables/useApiIntrospection.ts +0 -350
  335. package/frontend-vue/app/composables/useLogDetailDrawer.ts +0 -50
  336. package/frontend-vue/app/composables/useSelectedPeriod.ts +0 -107
  337. package/frontend-vue/app/composables/useStatsPeriods.ts +0 -139
  338. package/frontend-vue/app/custom-layouts/.gitkeep +0 -0
  339. package/frontend-vue/app/custom-pages/.gitkeep +0 -0
  340. package/frontend-vue/app/utils/httpMethod.ts +0 -49
  341. package/frontend-vue/app/utils/statusClass.ts +0 -49
  342. package/frontend-vue/i18n/locales/en-GB.json +0 -240
  343. package/frontend-vue/i18n/locales/fr-FR.json +0 -240
  344. package/frontend-vue/public/.gitkeep +0 -0
  345. package/frontend-vue/server/.gitkeep +0 -0
  346. package/frontend-vue/tests/periods.test.ts +0 -145
  347. package/frontend-vue/tests/persistence.test.ts +0 -45
@@ -0,0 +1,611 @@
1
+ <script setup lang="ts">
2
+ import { computed, ref } from 'vue'
3
+ import { formatCount, formatMs, formatRelativeDay } from '../../utils/format'
4
+ import { hasRequestBody, statusText } from '../../utils/http'
5
+ import { listedMessages } from '../../utils/routeExplorer'
6
+ import { routeSnippetRequest, toCurl, toFetch } from '../../utils/snippets'
7
+ import ApiStatusBadge from '../internal/ApiStatusBadge.vue'
8
+
9
+ // The contract of a route, read first: how to call it, who may, what it
10
+ // expects and what it answers. Everything is inferred, and the block says so:
11
+ // statuses, fields and examples from the last days of captured requests (the
12
+ // tester's left out), guards and error codes from the handler's code. The
13
+ // controller's internals stay folded at the end.
14
+ defineOptions({ inheritAttrs: false })
15
+
16
+ const props = withDefaults(
17
+ defineProps<{ fetchUrl: string; queryKey?: string }>(),
18
+ {
19
+ queryKey: 'route',
20
+ },
21
+ )
22
+
23
+ type SnippetKind = 'curl' | 'fetch'
24
+
25
+ interface ResponseRow {
26
+ status: number
27
+ label: string
28
+ detail: string
29
+ /** The messages the status came with, most frequent first, each counted. */
30
+ messages: Array<{ message: string; count: number }>
31
+ /** Distinct messages left out of `messages`. */
32
+ moreMessages: number
33
+ }
34
+
35
+ /** Messages listed under a status; the others are counted. */
36
+ const LISTED_MESSAGES = 5
37
+
38
+ const { t } = useI18n()
39
+ const { formatLocale: locale } = useRegionalFormat({ locale: 'format' })
40
+ const dateFormat = useDateFormat()
41
+ const currentRoute = useDmsRoute()
42
+ const router = useDmsRouter()
43
+ const {
44
+ data: route,
45
+ pending,
46
+ selection,
47
+ } = useRouteDetail(props.fetchUrl, props.queryKey)
48
+ const apiOrigin = useApiOrigin(() => route.value?.apiOrigin)
49
+
50
+ const snippetKind = ref<SnippetKind>('curl')
51
+ const snippetItems = [
52
+ { label: 'cURL', value: 'curl' },
53
+ { label: 'fetch', value: 'fetch' },
54
+ ]
55
+
56
+ const withBody = computed(() => hasRequestBody(route.value?.method))
57
+ const days = computed(() => route.value?.contract.windowDays ?? 7)
58
+
59
+ const snippet = computed(() => {
60
+ const value = route.value
61
+ if (!value) return ''
62
+ const request = routeSnippetRequest(value, apiOrigin.value, withBody.value)
63
+ return snippetKind.value === 'curl' ? toCurl(request) : toFetch(request)
64
+ })
65
+
66
+ const auth = computed(() => {
67
+ const value = route.value?.auth
68
+ if (!value) return null
69
+ if (value.status === 'required') {
70
+ return {
71
+ tone: 'info' as const,
72
+ icon: 'i-ph-lock-simple',
73
+ title: t('api.routes.docs.auth_title'),
74
+ description: t('api.routes.docs.auth_description', {
75
+ guards: value.guards.join(', '),
76
+ }),
77
+ }
78
+ }
79
+ if (value.status === 'probable') {
80
+ return {
81
+ tone: 'info' as const,
82
+ icon: 'i-ph-shield-warning',
83
+ title: t('api.routes.docs.probable_title'),
84
+ description: t(
85
+ 'api.routes.docs.probable_description',
86
+ {
87
+ count: formatCount(value.unauthorized, locale.value),
88
+ days: days.value,
89
+ },
90
+ value.unauthorized,
91
+ ),
92
+ }
93
+ }
94
+ return null
95
+ })
96
+
97
+ const parameterGroups = computed(() => {
98
+ const parameters = route.value?.parameters ?? []
99
+ return (['path', 'query', 'header'] as const)
100
+ .map((where) => ({
101
+ where,
102
+ parameters: parameters.filter((parameter) => parameter.in === where),
103
+ }))
104
+ .filter((group) => group.parameters.length > 0)
105
+ })
106
+
107
+ const responses = computed<ResponseRow[]>(() => {
108
+ const value = route.value
109
+ if (!value) return []
110
+ const rows = new Map<number, ResponseRow>()
111
+ for (const observed of value.contract.statuses) {
112
+ const seen = t(
113
+ 'api.routes.docs.observed',
114
+ {
115
+ count: formatCount(observed.count, locale.value),
116
+ days: days.value,
117
+ },
118
+ observed.count,
119
+ )
120
+ const last = t('api.routes.docs.last_seen', {
121
+ time: formatRelativeDay(observed.lastSeen, dateFormat.value),
122
+ })
123
+ const { messages, more } = listedMessages(observed, LISTED_MESSAGES)
124
+ rows.set(observed.status, {
125
+ status: observed.status,
126
+ label: statusText(observed.status) || String(observed.status),
127
+ detail: `${seen} · ${last}`,
128
+ messages,
129
+ moreMessages: more,
130
+ })
131
+ }
132
+ for (const inferred of value.inspection.errorCodes) {
133
+ const existing = rows.get(inferred.status)
134
+ const source = t(
135
+ `api.routes.docs.source_${inferred.source === 'assert' ? 'assert' : 'result'}`,
136
+ )
137
+ rows.set(inferred.status, {
138
+ status: inferred.status,
139
+ label: existing?.label || inferred.reason || statusText(inferred.status),
140
+ detail: existing ? `${existing.detail} · ${source}` : source,
141
+ messages: existing?.messages ?? [],
142
+ moreMessages: existing?.moreMessages ?? 0,
143
+ })
144
+ }
145
+ return [...rows.values()].sort((a, b) => a.status - b.status)
146
+ })
147
+
148
+ const latency = computed(() => {
149
+ const value = route.value?.contract.latency
150
+ if (!value) return ''
151
+ return t('api.routes.docs.latency', {
152
+ p50: formatMs(value.p50, locale.value),
153
+ p95: formatMs(value.p95, locale.value),
154
+ })
155
+ })
156
+
157
+ const exampleResponse = computed(() => route.value?.contract.exampleResponse)
158
+
159
+ // Internals worth a row: a parameter the introspection could name or place,
160
+ // a class member. An unnamed `unknown` row says nothing.
161
+ const internalParameters = computed(() =>
162
+ (route.value?.inspection.parameters ?? []).filter(
163
+ (parameter) => parameter.name || parameter.source !== 'unknown',
164
+ ),
165
+ )
166
+ const internalProperties = computed(
167
+ () => route.value?.inspection.properties ?? [],
168
+ )
169
+
170
+ const PIPELINE_TONE = {
171
+ prefix: 'info',
172
+ handler: 'primary',
173
+ postfix: 'neutral',
174
+ monitor: 'neutral',
175
+ } as const
176
+
177
+ function openTester() {
178
+ void router.push({ query: { ...currentRoute.query, tab: '2' } })
179
+ }
180
+
181
+ function exampleOf(value: string | number | boolean | null | undefined) {
182
+ return value === undefined ? '' : JSON.stringify(value)
183
+ }
184
+ </script>
185
+
186
+ <template>
187
+ <div v-if="!selection.ref.value" />
188
+ <div v-else-if="pending" class="flex flex-col gap-4">
189
+ <USkeleton class="h-40" />
190
+ <USkeleton class="h-56" />
191
+ </div>
192
+ <div v-else-if="route" class="flex flex-col gap-4">
193
+ <DmsBanner
194
+ tone="primary"
195
+ size="sm"
196
+ icon="i-ph-flask"
197
+ :title="t('api.routes.docs.beta_title')"
198
+ :description="t('api.routes.docs.beta_description', { days })"
199
+ />
200
+
201
+ <div class="grid gap-4 2xl:grid-cols-[minmax(0,1.1fr)_minmax(0,1fr)]">
202
+ <div class="flex min-w-0 flex-col gap-4">
203
+ <DmsCard :title="t('api.routes.docs.example')">
204
+ <template #actions>
205
+ <DmsSegmented
206
+ v-model="snippetKind"
207
+ :items="snippetItems"
208
+ size="xs"
209
+ variant="mono"
210
+ />
211
+ <UButton
212
+ size="xs"
213
+ icon="i-ph-paper-plane-tilt"
214
+ :label="t('api.routes.docs.try')"
215
+ @click="openTester"
216
+ />
217
+ </template>
218
+ <DmsCodeSnippet :code="snippet" max-height="20rem" wrap="anywhere" />
219
+ <p v-if="!apiOrigin" class="text-warning mt-2 text-xs">
220
+ {{ t('api.routes.docs.origin_unknown') }}
221
+ </p>
222
+ </DmsCard>
223
+
224
+ <DmsBanner
225
+ v-if="auth"
226
+ :tone="auth.tone"
227
+ size="sm"
228
+ :icon="auth.icon"
229
+ :title="auth.title"
230
+ :description="auth.description"
231
+ />
232
+ <div
233
+ v-else
234
+ class="border-default text-muted flex items-start gap-2.5 rounded-lg border px-3.5 py-2.5 text-sm"
235
+ >
236
+ <UIcon
237
+ name="i-ph-question"
238
+ class="text-dimmed mt-0.5 size-4 shrink-0"
239
+ />
240
+ <span>
241
+ <span class="text-default font-medium">
242
+ {{ t('api.routes.docs.unknown_title') }}
243
+ </span>
244
+ · {{ t('api.routes.docs.unknown_description') }}
245
+ </span>
246
+ </div>
247
+
248
+ <DmsCard v-if="withBody" :title="t('api.routes.docs.body')">
249
+ <template #actions>
250
+ <DmsStatusPill
251
+ v-if="route.contract.bodyFields.length"
252
+ tone="info"
253
+ dot="none"
254
+ size="sm"
255
+ :label="
256
+ t(
257
+ 'api.routes.docs.inferred',
258
+ { count: formatCount(route.contract.sampled, locale) },
259
+ route.contract.sampled,
260
+ )
261
+ "
262
+ />
263
+ </template>
264
+ <p
265
+ v-if="route.contract.bodyFields.length === 0"
266
+ class="text-dimmed text-sm"
267
+ >
268
+ {{ t('api.routes.docs.no_body', { days }) }}
269
+ </p>
270
+ <ul v-else class="divide-default divide-y">
271
+ <li
272
+ v-for="field in route.contract.bodyFields"
273
+ :key="field.name"
274
+ class="flex items-center gap-3 py-2"
275
+ >
276
+ <span class="text-highlighted font-mono text-[13px]">
277
+ {{ field.name }}
278
+ </span>
279
+ <DmsStatusPill
280
+ :tone="field.required ? 'warning' : 'neutral'"
281
+ dot="none"
282
+ size="sm"
283
+ :label="
284
+ field.required
285
+ ? t('api.routes.docs.required')
286
+ : t('api.routes.docs.optional')
287
+ "
288
+ />
289
+ <span class="grow" />
290
+ <span
291
+ v-if="field.example !== undefined"
292
+ class="text-dimmed max-w-[14rem] truncate font-mono text-[12px]"
293
+ :title="exampleOf(field.example)"
294
+ >
295
+ {{
296
+ t('api.routes.docs.example_value', {
297
+ value: exampleOf(field.example),
298
+ })
299
+ }}
300
+ </span>
301
+ <span class="text-muted font-mono text-[12px]">
302
+ {{ field.types.join(' | ') }}
303
+ </span>
304
+ </li>
305
+ </ul>
306
+ </DmsCard>
307
+
308
+ <DmsCard :title="t('api.routes.docs.parameters')">
309
+ <p v-if="parameterGroups.length === 0" class="text-dimmed text-sm">
310
+ {{ t('api.routes.docs.no_parameters') }}
311
+ </p>
312
+ <dl v-else class="grid gap-3 text-sm">
313
+ <div v-for="group in parameterGroups" :key="group.where">
314
+ <dt
315
+ class="text-dimmed font-mono text-[10.5px] uppercase tracking-[0.08em]"
316
+ >
317
+ {{ t(`api.routes.docs.in_${group.where}`) }}
318
+ </dt>
319
+ <dd class="divide-default mt-1 divide-y">
320
+ <div
321
+ v-for="parameter in group.parameters"
322
+ :key="parameter.name"
323
+ class="flex flex-wrap items-center gap-x-3 gap-y-1 py-1.5"
324
+ >
325
+ <code
326
+ class="bg-elevated rounded px-1.5 py-0.5 font-mono text-[12px]"
327
+ :class="group.where === 'path' && 'text-primary'"
328
+ >
329
+ {{
330
+ group.where === 'path'
331
+ ? `:${parameter.name}`
332
+ : parameter.name
333
+ }}
334
+ </code>
335
+ <span class="text-muted font-mono text-[12px]">
336
+ {{ parameter.type }}
337
+ </span>
338
+ <DmsStatusPill
339
+ v-if="parameter.required"
340
+ tone="warning"
341
+ dot="none"
342
+ size="sm"
343
+ :label="t('api.routes.docs.required')"
344
+ />
345
+ <span
346
+ v-if="!parameter.declared"
347
+ class="text-dimmed text-[11px]"
348
+ >
349
+ {{ t('api.routes.docs.seen_only') }}
350
+ </span>
351
+ <span class="grow" />
352
+ <span
353
+ class="text-dimmed max-w-[16rem] truncate font-mono text-[12px]"
354
+ :title="parameter.example ?? undefined"
355
+ >
356
+ {{
357
+ parameter.example
358
+ ? t('api.routes.docs.example_value', {
359
+ value: parameter.example,
360
+ })
361
+ : t('api.routes.docs.no_example')
362
+ }}
363
+ </span>
364
+ </div>
365
+ </dd>
366
+ </div>
367
+ </dl>
368
+ </DmsCard>
369
+ </div>
370
+
371
+ <div class="flex min-w-0 flex-col gap-4">
372
+ <DmsCard :title="t('api.routes.docs.responses')" :padded="false">
373
+ <template v-if="latency" #actions>
374
+ <DmsStatusPill
375
+ tone="neutral"
376
+ dot="none"
377
+ size="sm"
378
+ :label="latency"
379
+ />
380
+ </template>
381
+ <p
382
+ v-if="responses.length === 0"
383
+ class="text-dimmed px-4 py-4 text-sm"
384
+ >
385
+ {{ t('api.routes.docs.no_responses', { days }) }}
386
+ </p>
387
+ <ul v-else class="divide-default divide-y">
388
+ <li
389
+ v-for="response in responses"
390
+ :key="response.status"
391
+ class="flex items-start gap-3 px-4 py-2.5"
392
+ >
393
+ <ApiStatusBadge
394
+ :status="response.status"
395
+ size="sm"
396
+ class="mt-0.5"
397
+ />
398
+ <span class="flex min-w-0 flex-col">
399
+ <span class="text-highlighted text-sm">
400
+ {{ response.label }}
401
+ </span>
402
+ <span class="text-dimmed font-mono text-[11px]">
403
+ {{ response.detail }}
404
+ </span>
405
+ <span
406
+ v-for="other in response.messages"
407
+ :key="other.message"
408
+ class="text-muted truncate text-xs"
409
+ :title="other.message"
410
+ >
411
+ {{ other.message }}
412
+ <span class="text-dimmed font-mono text-[11px]">
413
+ × {{ formatCount(other.count, locale) }}
414
+ </span>
415
+ </span>
416
+ <span
417
+ v-if="response.moreMessages > 0"
418
+ class="text-dimmed font-mono text-[11px]"
419
+ >
420
+ {{
421
+ t(
422
+ 'api.routes.docs.more_messages',
423
+ { count: formatCount(response.moreMessages, locale) },
424
+ response.moreMessages,
425
+ )
426
+ }}
427
+ </span>
428
+ </span>
429
+ </li>
430
+ </ul>
431
+ </DmsCard>
432
+
433
+ <DmsCard
434
+ v-if="exampleResponse || route.contract.responseFields.length"
435
+ :title="t('api.routes.docs.response')"
436
+ >
437
+ <ul
438
+ v-if="route.contract.responseFields.length"
439
+ class="divide-default mb-3 divide-y"
440
+ >
441
+ <li
442
+ v-for="field in route.contract.responseFields"
443
+ :key="field.name"
444
+ class="flex items-center gap-3 py-1.5"
445
+ >
446
+ <span class="text-highlighted font-mono text-[12.5px]">
447
+ {{
448
+ route.contract.responseKind === 'array'
449
+ ? `[].${field.name}`
450
+ : field.name
451
+ }}
452
+ </span>
453
+ <span class="grow" />
454
+ <span class="text-muted font-mono text-[12px]">
455
+ {{ field.types.join(' | ') }}
456
+ </span>
457
+ </li>
458
+ </ul>
459
+ <DmsCodeSnippet
460
+ v-if="exampleResponse"
461
+ :code="exampleResponse.body"
462
+ :title="
463
+ t('api.routes.docs.example_response', {
464
+ status: exampleResponse.status,
465
+ })
466
+ "
467
+ max-height="16rem"
468
+ wrap="anywhere"
469
+ />
470
+ <p v-if="exampleResponse?.truncated" class="text-dimmed mt-2 text-xs">
471
+ {{ t('api.routes.docs.response_truncated') }}
472
+ </p>
473
+ </DmsCard>
474
+
475
+ <DmsCard :title="t('api.routes.docs.pipeline')" :padded="false">
476
+ <p class="text-dimmed px-4 pt-3 text-xs">
477
+ {{ t('api.routes.docs.pipeline_description') }}
478
+ </p>
479
+ <ol class="flex flex-col gap-0 px-4 py-3">
480
+ <li
481
+ v-for="(step, index) in route.pipeline"
482
+ :key="`${step.kind}-${step.name}-${index}`"
483
+ class="flex items-center gap-3 py-1.5"
484
+ >
485
+ <span class="text-dimmed w-5 text-right font-mono text-[11px]">
486
+ {{ index + 1 }}
487
+ </span>
488
+ <span class="min-w-0 grow">
489
+ <span
490
+ class="text-highlighted block truncate font-mono text-[12.5px]"
491
+ :class="
492
+ step.kind === 'handler' && 'text-primary font-semibold'
493
+ "
494
+ >
495
+ {{ step.name }}
496
+ </span>
497
+ <span class="text-dimmed font-mono text-[11px]">
498
+ {{ t(`api.routes.docs.kind_${step.kind}`) }} ·
499
+ {{ step.location }}
500
+ </span>
501
+ </span>
502
+ <DmsStatusPill
503
+ v-if="step.isAuth"
504
+ tone="info"
505
+ size="sm"
506
+ dot="none"
507
+ icon="i-ph-lock-simple"
508
+ :label="t('api.routes.docs.auth')"
509
+ />
510
+ <DmsStatusPill
511
+ :tone="PIPELINE_TONE[step.kind]"
512
+ size="sm"
513
+ dot="none"
514
+ :label="t(`api.routes.docs.kind_${step.kind}`)"
515
+ />
516
+ </li>
517
+ </ol>
518
+ </DmsCard>
519
+
520
+ <details
521
+ v-if="internalParameters.length || internalProperties.length"
522
+ class="dms-card group overflow-hidden rounded-lg"
523
+ >
524
+ <summary
525
+ class="text-muted hover:text-default flex cursor-pointer list-none items-center gap-2 px-4 py-3 text-sm"
526
+ >
527
+ <UIcon
528
+ name="i-ph-caret-right"
529
+ class="size-3.5 transition-transform group-open:rotate-90"
530
+ />
531
+ {{ t('api.routes.docs.internals') }}
532
+ <span class="text-dimmed text-xs">
533
+ ·
534
+ {{
535
+ t(
536
+ 'api.routes.docs.internals_parameters',
537
+ { count: internalParameters.length },
538
+ internalParameters.length,
539
+ )
540
+ }},
541
+ {{
542
+ t(
543
+ 'api.routes.docs.internals_members',
544
+ { count: internalProperties.length },
545
+ internalProperties.length,
546
+ )
547
+ }}
548
+ </span>
549
+ </summary>
550
+ <div class="border-default overflow-x-auto border-t">
551
+ <table class="w-full text-[12px]">
552
+ <thead class="text-dimmed font-mono text-[10.5px] uppercase">
553
+ <tr>
554
+ <th class="px-4 py-2 text-left font-medium">#</th>
555
+ <th class="px-2 py-2 text-left font-medium">
556
+ {{ t('api.routes.docs.internal_name') }}
557
+ </th>
558
+ <th class="px-2 py-2 text-left font-medium">
559
+ {{ t('api.routes.docs.internal_source') }}
560
+ </th>
561
+ <th class="px-2 py-2 text-left font-medium">
562
+ {{ t('api.routes.docs.internal_type') }}
563
+ </th>
564
+ <th class="px-4 py-2 text-right font-medium">
565
+ {{ t('api.routes.docs.internal_modifiers') }}
566
+ </th>
567
+ </tr>
568
+ </thead>
569
+ <tbody class="divide-default divide-y font-mono">
570
+ <tr
571
+ v-for="parameter in internalParameters"
572
+ :key="`p-${parameter.index}`"
573
+ >
574
+ <td class="text-dimmed px-4 py-1.5">{{ parameter.index }}</td>
575
+ <td class="px-2 py-1.5">
576
+ {{ parameter.name ?? parameter.decorator ?? '—' }}
577
+ </td>
578
+ <td class="text-muted px-2 py-1.5">
579
+ {{ parameter.hint ?? parameter.source }}
580
+ </td>
581
+ <td class="text-muted px-2 py-1.5">
582
+ {{ parameter.inferredType }}
583
+ </td>
584
+ <td class="text-muted px-4 py-1.5 text-right">
585
+ {{ parameter.modifierCount }}
586
+ </td>
587
+ </tr>
588
+ <tr
589
+ v-for="property in internalProperties"
590
+ :key="`m-${property.key}`"
591
+ >
592
+ <td class="text-dimmed px-4 py-1.5">—</td>
593
+ <td class="px-2 py-1.5">{{ property.key }}</td>
594
+ <td class="text-muted px-2 py-1.5">
595
+ {{ property.decorator }}
596
+ </td>
597
+ <td class="text-muted px-2 py-1.5">
598
+ {{ t('api.routes.docs.class_member') }}
599
+ </td>
600
+ <td class="text-muted px-4 py-1.5 text-right">
601
+ {{ property.modifierCount }}
602
+ </td>
603
+ </tr>
604
+ </tbody>
605
+ </table>
606
+ </div>
607
+ </details>
608
+ </div>
609
+ </div>
610
+ </div>
611
+ </template>