import { randomBytes } from "node:crypto"; import { parseEnabledLocales } from "@hivegrid/i18n"; import { Hono, type Context } from "hono"; import type { ApiEnv } from "../api-types.js"; import { getApiRuntimeConfig } from "../config.js"; import { createOpenApiDocument } from "../openapi.js"; import { apiLogger } from "../logger.js"; import { escapeHtml } from "./shared.js"; import { checkCachedApiReadiness } from "../readiness-cache.js"; import { getApiDocsCopy } from "./api-docs-i18n.js"; function apiHealthResponse(c: Context) { return c.json({ status: "ok", service: "api", revision: getApiRuntimeConfig().revision, requestId: c.get("requestId"), }); } export function registerSystemRoutes(app: Hono) { app.get("/healthz", apiHealthResponse); app.get("/v1/health", apiHealthResponse); app.get("/readyz", async (c) => { try { await checkCachedApiReadiness(); return c.json({ status: "ready", service: "api", revision: getApiRuntimeConfig().revision, requestId: c.get("requestId"), }); } catch (error) { const code = error && typeof error === "object" && "code" in error && typeof error.code === "string" ? error.code : undefined; apiLogger.error( { dependency: "database", error: { name: error instanceof Error ? error.name : "Error", ...(code ? { code } : {}) } }, "API readiness dependency unavailable" ); return c.json( { status: "not_ready", service: "api", requestId: c.get("requestId"), error: { code: "dependency_unavailable", message: "A required dependency is unavailable.", }, }, 503 ); } }); app.get("/v1/openapi.json", (c) => { return c.json(createOpenApiDocument(getApiRuntimeConfig())); }); app.get("/v1/docs", (c) => { const runtimeConfig = getApiRuntimeConfig(); const appName = runtimeConfig.appName; const enabledLocales = parseEnabledLocales(process.env.I18N_ENABLED_LOCALES, { allowReviewLocales: runtimeConfig.nodeEnv !== "production" || process.env.SENTRY_ENVIRONMENT?.trim().toLowerCase() === "staging", }); const { locale, copy } = getApiDocsCopy(c.req.header("accept-language"), enabledLocales); const browserCopy = JSON.stringify(copy).replaceAll("<", "\\u003c"); const nonce = randomBytes(18).toString("base64url"); c.header("cache-control", "no-store"); c.header("content-language", locale); c.header( "content-security-policy", [ "default-src 'none'", "base-uri 'none'", "connect-src 'self'", "font-src 'self'", "form-action 'none'", "frame-ancestors 'none'", "img-src 'self' data:", `script-src 'nonce-${nonce}' 'strict-dynamic'`, "script-src-attr 'none'", `style-src 'nonce-${nonce}'`, "style-src-attr 'none'", ].join("; ") ); return c.html(` ${escapeHtml(copy.pageTitle)} | ${escapeHtml(appName)}

${escapeHtml(copy.heading)}

${escapeHtml(copy.description)} OpenAPI JSON
${escapeHtml(copy.rawSpec)}

        
`); }); }