@raiyyan/brisk 0.0.0-stage → 0.2.0

package/dist/src/http/instance.js

@@ -0,0 +1,377 @@
+import { randomUUID } from "node:crypto";
+import { createServer } from "node:http";
+import express, { Router } from "express";
+import { createLogger, Logger } from "../config/logger.js";
+import { Container, lifecycleFailure, provide } from "../di/container.js";
+import { NotFoundError } from "../errors/http-errors.js";
+import { createRequestContext, getContext } from "./context.js";
+import { joinPath, methodGuard } from "./controller.js";
+import { defaultErrorFormatter, ErrorTranslator, errorHandler, toHttpError } from "./error-handler.js";
+import { ExpressMiddleware, resolveMiddleware, securityOf } from "./middleware.js";
+import { buildOpenApi } from "./openapi.js";
+import { HttpServer } from "./server.js";
+const DEFAULT_SECURITY_HEADERS = {
+    "x-content-type-options": "nosniff",
+    "x-frame-options": "DENY",
+    "referrer-policy": "no-referrer",
+    "cross-origin-resource-policy": "same-origin",
+    "content-security-policy": "default-src 'none'; frame-ancestors 'none'",
+};
+/** Accepts a caller's `x-request-id` only when it is short and plain, so it cannot forge log lines. */
+const SAFE_REQUEST_ID = /^[\w.:-]{1,128}$/;
+/**
+ * Builds one instance of an app: security headers, request ids and logging, health check and OpenAPI routes,
+ * the app's `use`, controllers (each parsing its own JSON bodies), mounts, 404 and error handling, and the container that runs every
+ * lifecycle hook. `overrides` come after the app's own providers, so they win.
+ */
+export function createInstance(options, overrides = []) {
+    const logger = options.logger ?? createLogger();
+    const hooks = options.hooks ?? {};
+    const http = options.http ?? {};
+    const errors = options.errors ?? {};
+    const controllers = Object.entries(options.controllers ?? {});
+    const container = new Container([
+        provide(Logger, logger),
+        provide(ErrorTranslator, (error) => {
+            const translated = toHttpError(error, { mappers: errors.mappers ?? [], exposeInternalErrors: errors.exposeInternal ?? false }, logger);
+            const { status, code, message, details } = translated;
+            return { status, code, message, details };
+        }),
+        ...controllers.flatMap(([, controller]) => controller.providers),
+        ...(options.providers ?? []),
+        ...overrides,
+    ]);
+    const app = express();
+    const draining = { active: false, responses: new Map() };
+    app.disable("x-powered-by");
+    app.set("query parser", "simple");
+    for (const [name, value] of Object.entries(http.settings ?? {}))
+        app.set(name, value);
+    const allRoutes = [];
+    let document;
+    const openapi = () => (document ??= buildOpenApi(allRoutes, options.openapi ?? { title: "API", version: "0.0.0" }));
+    app.use(prelude({ logger, hooks, draining, container, headers: securityHeaders(http.securityHeaders) }));
+    // System routes come before the app's own middleware, so a rate limit or an auth check never blocks a probe.
+    if (http.healthPath !== false) {
+        app.get(http.healthPath ?? "/health", (_req, res) => {
+            if (draining.active)
+                res.status(503).json({ status: "shutting down" });
+            else
+                res.json({ status: "ok" });
+        });
+    }
+    const openapiPath = options.openapi?.path ?? "/openapi.json";
+    if (options.openapi && openapiPath !== false) {
+        app.get(openapiPath, (_req, res) => {
+            res.json(openapi());
+        });
+    }
+    const use = options.use ?? [];
+    for (const middleware of use) {
+        app.use(middleware instanceof ExpressMiddleware ? middleware.handler : runEach(middleware));
+    }
+    const router = Router();
+    const parseBody = express.json({
+        limit: http.bodyLimit ?? "1mb",
+        type: ["application/json", "application/*+json"],
+    });
+    const appSecurity = securityOf(use);
+    const manifest = {};
+    for (const [name, controller] of controllers) {
+        const basePath = joinPath(options.prefix ?? "/", controller.prefix);
+        const mounted = controller.mount({ container, router, basePath, parseBody });
+        for (const endpoint of mounted.endpoints) {
+            const security = appSecurity ? { ...appSecurity, ...endpoint.security } : endpoint.security;
+            allRoutes.push({ ...endpoint, security, tag: name });
+        }
+        if (mounted.manifest)
+            manifest[name] = mounted.manifest;
+    }
+    assertUniqueRoutes(allRoutes);
+    const mounts = Object.entries(options.mount ?? {});
+    const routes = [
+        ...allRoutes.map(({ method, path }) => `${method.toUpperCase()} ${path}`),
+        ...mounts.map(([path]) => `MOUNT ${path}`),
+    ];
+    const guard = methodGuard(allRoutes);
+    app.use((req, res, next) => {
+        if (req.method === "OPTIONS")
+            guard(req, res, next);
+        else
+            next();
+    });
+    app.use(router);
+    app.use(guard);
+    for (const [path, handlers] of mounts) {
+        if (!path.startsWith("/"))
+            throw new TypeError(`Mount path "${path}" must start with "/"`);
+        app.use(path, ...[handlers].flat());
+    }
+    app.use((req) => {
+        throw new NotFoundError(`Cannot ${req.method} ${req.path}`, { code: "ROUTE_NOT_FOUND" });
+    });
+    app.use(errorHandler({
+        mappers: errors.mappers ?? [],
+        format: errors.format ?? defaultErrorFormatter,
+        exposeInternalErrors: errors.exposeInternal ?? false,
+        onError: hooks.onError,
+    }));
+    let initializing;
+    let stopping;
+    let server;
+    const sockets = new Set();
+    const signals = ["SIGINT", "SIGTERM"];
+    const shutdownTimeoutMs = http.shutdownTimeoutMs ?? 10_000;
+    /** Shuts down and exits; a hook that never settles cannot keep the process alive past the deadline. */
+    const exitAfterShutdown = (code) => {
+        setTimeout(() => {
+            logger.fatal("shutdown did not finish in time, exiting");
+            process.exit(1);
+        }, shutdownTimeoutMs + 10_000).unref();
+        void shutdown().then(() => process.exit(code));
+    };
+    let firstSignal;
+    /**
+     * The first signal starts a graceful shutdown. While it runs, the listeners stay installed: tools often send a
+     * second, different signal (`node --watch` and some init systems forward SIGTERM right after the terminal's
+     * SIGINT), and without a listener Node would kill the process mid-drain. Repeating the same signal (Ctrl+C
+     * twice) is a person asking to stop now, so it exits immediately.
+     */
+    const onSignal = (signal) => {
+        if (firstSignal === undefined) {
+            firstSignal = signal;
+            logger.info({ signal }, "shutting down");
+            exitAfterShutdown(0);
+        }
+        else if (signal === firstSignal) {
+            logger.warn({ signal }, "second signal, exiting without waiting");
+            process.exit(1);
+        }
+        else {
+            logger.info({ signal }, "already shutting down");
+        }
+    };
+    const onCrash = (reason) => {
+        if (stopping) {
+            logger.error({ err: reason }, "unhandled error during shutdown");
+            return;
+        }
+        logger.fatal({ err: reason }, "unhandled error, shutting down");
+        exitAfterShutdown(1);
+    };
+    const reportHookError = (hook) => (error, provider) => {
+        logger.error({ err: error, provider }, `${hook} failed`);
+    };
+    const init = () => (initializing ??= container.init());
+    const becomeReady = async (manageProcess) => {
+        await container.ready();
+        if (manageProcess) {
+            for (const signal of signals)
+                process.on(signal, onSignal);
+            process.on("unhandledRejection", onCrash);
+            process.on("uncaughtException", onCrash);
+        }
+    };
+    /**
+     * Boots, and when booting fails logs why (naming the provider and hook when one threw), then shuts down
+     * whatever already started and rethrows.
+     */
+    const boot = async (run) => {
+        try {
+            return await run();
+        }
+        catch (error) {
+            logger.fatal({ err: error, ...lifecycleFailure(error) }, "startup failed");
+            await shutdown();
+            throw error;
+        }
+    };
+    const start = ({ manageProcess = true }) => boot(async () => {
+        await init();
+        await becomeReady(manageProcess);
+        logger.info("started without an HTTP server");
+    });
+    const listen = (port, listenOptions) => boot(() => serve(port, listenOptions));
+    const serve = async (port, { host, server: custom, manageProcess = true }) => {
+        await init();
+        const target = custom ?? createServer();
+        target.on("request", app);
+        target.on("connection", (socket) => {
+            sockets.add(socket);
+            draining.responses.set(socket, undefined);
+            socket.once("close", () => {
+                sockets.delete(socket);
+                draining.responses.delete(socket);
+            });
+        });
+        await new Promise((resolve, reject) => {
+            target.once("error", reject);
+            const onListening = () => {
+                target.off("error", reject);
+                resolve();
+            };
+            if (host === undefined)
+                target.listen(port, onListening);
+            else
+                target.listen(port, host, onListening);
+        });
+        server = target;
+        container.set(HttpServer, target);
+        await becomeReady(manageProcess);
+        const address = target.address();
+        const boundPort = typeof address === "object" && address ? address.port : port;
+        logger.info({ port: boundPort, routes }, `listening on http://${host ?? "localhost"}:${boundPort}`);
+    };
+    const shutdown = () => (stopping ??= (async () => {
+        draining.active = true;
+        for (const res of draining.responses.values()) {
+            if (res && !res.headersSent)
+                res.setHeader("connection", "close");
+        }
+        const closed = server?.listening ? closeServer(server, sockets, shutdownTimeoutMs) : undefined;
+        await container.drain(reportHookError("onDrain"));
+        await closed;
+        await container.shutdown(reportHookError("onShutdown"));
+        for (const signal of signals)
+            process.off(signal, onSignal);
+        process.off("unhandledRejection", onCrash);
+        process.off("uncaughtException", onCrash);
+        logger.info("shutdown complete");
+    })());
+    return {
+        manifest,
+        openapi,
+        express: app,
+        logger,
+        container,
+        get server() {
+            return server;
+        },
+        init,
+        listen,
+        start,
+        shutdown,
+    };
+}
+/** The security headers to send, computed once; `undefined` when they are turned off. */
+function securityHeaders(option) {
+    if (option === false)
+        return undefined;
+    const merged = { ...DEFAULT_SECURITY_HEADERS, ...(typeof option === "object" ? option : {}) };
+    const headers = new Map();
+    for (const [name, value] of Object.entries(merged))
+        if (value !== false)
+            headers.set(name, value);
+    return headers;
+}
+const proceed = (next) => next();
+/**
+ * Everything brisk does before your Express code, in one layer: security headers, the request id and context
+ * (with its lazy logger), the response log and `onResponse`, shutdown's `Connection: close`, and the app's
+ * dependency scope, so `inject()` works for the rest of the request, the app's `use` and `mount` included.
+ *
+ * The response is logged on `close`, which also fires for requests the client abandoned (`finish` would not).
+ * The listener exists only when something consumes it: the `info` log level or an `onResponse` hook.
+ */
+function prelude({ logger, hooks, draining, container, headers }) {
+    return (req, res, next) => {
+        if (headers)
+            res.setHeaders(headers);
+        const incoming = req.get("x-request-id");
+        const requestId = incoming && SAFE_REQUEST_ID.test(incoming) ? incoming : randomUUID();
+        const ctx = createRequestContext(req, res, requestId, logger);
+        res.setHeader("x-request-id", requestId);
+        if (draining.active)
+            res.setHeader("connection", "close");
+        else if (draining.responses.has(req.socket))
+            draining.responses.set(req.socket, res);
+        const log = logger.isLevelEnabled("info");
+        if (log || hooks.onResponse) {
+            const started = performance.now();
+            res.once("close", () => {
+                const durationMs = Math.round(performance.now() - started);
+                const aborted = !res.writableFinished;
+                if (log) {
+                    const line = {
+                        method: req.method,
+                        url: pathOf(req.originalUrl),
+                        status: res.statusCode,
+                        durationMs,
+                    };
+                    ctx.log.info(aborted ? { ...line, aborted } : line, "request");
+                }
+                hooks.onResponse?.(ctx, { status: res.statusCode, durationMs, aborted });
+            });
+        }
+        container.run(proceed, next);
+    };
+}
+/**
+ * The URL without its query string. Query strings carry secrets often enough (reset tokens, OAuth codes, API
+ * keys) that brisk never writes them to logs; log what you need from `ctx.req.query` in `onResponse`.
+ */
+function pathOf(url) {
+    const query = url.indexOf("?");
+    return query === -1 ? url : url.slice(0, query);
+}
+/**
+ * One app-level `defineMiddleware` as an Express layer. Its result is memoized for the request, so a route that
+ * lists it again, or reads it with `run(ctx)`, does not run it twice. Allocates only when it is async.
+ */
+function runEach(middleware) {
+    return (req, res, next) => {
+        const out = resolveMiddleware(middleware, getContext(req));
+        if (out instanceof Promise)
+            return continueAfter(out, res, next);
+        next();
+        return undefined;
+    };
+}
+/** Express 5 sends a rejected promise to the error handler; a middleware that answered stops the request. */
+async function continueAfter(out, res, next) {
+    await out;
+    if (!res.headersSent)
+        next();
+}
+/**
+ * Stops accepting connections and resolves once every in-flight request has finished. Keep-alive sockets
+ * close as soon as they go idle; after `timeoutMs` every remaining socket is destroyed, including upgraded
+ * WebSocket connections, which Node's `closeAllConnections` does not track.
+ */
+function closeServer(server, sockets, timeoutMs) {
+    return new Promise((resolve) => {
+        const sweep = setInterval(() => server.closeIdleConnections(), 10);
+        const force = setTimeout(() => {
+            server.closeAllConnections();
+            for (const socket of sockets)
+                socket.destroy();
+        }, timeoutMs);
+        server.close(() => {
+            clearInterval(sweep);
+            clearTimeout(force);
+            resolve();
+        });
+        server.closeIdleConnections();
+    });
+}
+/**
+ * Two routes that answer the same requests are a mistake: Express only ever runs the first, while the typed
+ * client and the OpenAPI document would both still list the second. Paths that differ only in parameter names
+ * (`:id` and `:userId`) match the same requests.
+ */
+function assertUniqueRoutes(endpoints) {
+    const seen = new Map();
+    for (const endpoint of endpoints) {
+        const key = `${endpoint.method} ${endpoint.path.replace(/([:*])[\w$]+/g, "$1")}`;
+        const first = seen.get(key);
+        if (!first) {
+            seen.set(key, endpoint);
+            continue;
+        }
+        throw new Error(`${describeRoute(endpoint)} can never run: ${describeRoute(first)} answers the same requests. Remove or change one.`);
+    }
+}
+function describeRoute({ method, path, tag, name }) {
+    return `${method.toUpperCase()} ${path} (${tag}.${name ?? "unnamed route"})`;
+}
+//# sourceMappingURL=instance.js.map

package/dist/src/http/instance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance.js","sourceRoot":"","sources":["../../../src/http/instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,OAAO,EAAE,EAAE,MAAM,EAAyD,MAAM,SAAS,CAAC;AACjG,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,OAAO,EAAsB,MAAM,oBAAoB,CAAC;AAC9F,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAUzD,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACvG,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,UAAU,EAAmB,MAAM,iBAAiB,CAAC;AACpG,OAAO,EAAE,YAAY,EAA2B,MAAM,cAAc,CAAC;AAErE,OAAO,EAAE,UAAU,EAAmB,MAAM,aAAa,CAAC;AAE1D,MAAM,wBAAwB,GAAqC;IACjE,wBAAwB,EAAE,SAAS;IACnC,iBAAiB,EAAE,MAAM;IACzB,iBAAiB,EAAE,aAAa;IAChC,8BAA8B,EAAE,aAAa;IAC7C,yBAAyB,EAAE,4CAA4C;CACxE,CAAC;AAEF,uGAAuG;AACvG,MAAM,eAAe,GAAG,kBAAkB,CAAC;AAQ3C;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAsB,EACtB,SAAS,GAA6B,EAAE;IAExC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,YAAY,EAAE,CAAC;IAChD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;IAClC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC;IAChC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;IACpC,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC;QAC9B,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC;QACvB,OAAO,CAAC,eAAe,EAAE,CAAC,KAAc,EAAE,EAAE;YAC1C,MAAM,UAAU,GAAG,WAAW,CAC5B,KAAK,EACL,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE,EAAE,oBAAoB,EAAE,MAAM,CAAC,cAAc,IAAI,KAAK,EAAE,EACvF,MAAM,CACP,CAAC;YACF,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC;YACtD,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QAC5C,CAAC,CAAC;QACF,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC;QAChE,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC;QAC5B,GAAG,SAAS;KACb,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IACtB,MAAM,QAAQ,GAAa,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IAEnE,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC5B,GAAG,CAAC,GAAG,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;IAClC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;QAAE,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACtF,MAAM,SAAS,GAAyB,EAAE,CAAC;IAC3C,IAAI,QAA6C,CAAC;IAClD,MAAM,OAAO,GAAG,GAA4B,EAAE,CAC5C,CAAC,QAAQ,KAAK,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,OAAO,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC;IACzG,6GAA6G;IAC7G,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;QAC9B,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,IAAI,SAAS,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YAClD,IAAI,QAAQ,CAAC,MAAM;gBAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC;;gBAClE,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,IAAI,eAAe,CAAC;IAC7D,IAAI,OAAO,CAAC,OAAO,IAAI,WAAW,KAAK,KAAK,EAAE,CAAC;QAC7C,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACjC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACtB,CAAC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC;IAC9B,KAAK,MAAM,UAAU,IAAI,GAAG,EAAE,CAAC;QAC7B,GAAG,CAAC,GAAG,CAAC,UAAU,YAAY,iBAAiB,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;IAC9F,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;IACxB,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;QAC7B,KAAK,EAAE,IAAI,CAAC,SAAS,IAAI,KAAK;QAC9B,IAAI,EAAE,CAAC,kBAAkB,EAAE,oBAAoB,CAAC;KACjD,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAC9C,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,WAAW,EAAE,CAAC;QAC7C,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAI,GAAG,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;QAC7E,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,QAAQ,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC5F,SAAS,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QACvD,CAAC;QACD,IAAI,OAAO,CAAC,QAAQ;YAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;IAC1D,CAAC;IACD,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG;QACb,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC;QACzE,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC;KAC3C,CAAC;IACF,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IACrC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACzB,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS;YAAE,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;;YAC/C,IAAI,EAAE,CAAC;IACd,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAChB,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACf,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,MAAM,IAAI,SAAS,CAAC,eAAe,IAAI,uBAAuB,CAAC,CAAC;QAC3F,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACtC,CAAC;IACD,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACd,MAAM,IAAI,aAAa,CAAC,UAAU,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,GAAG,CACL,YAAY,CAAC;QACX,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE;QAC7B,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,qBAAqB;QAC9C,oBAAoB,EAAE,MAAM,CAAC,cAAc,IAAI,KAAK;QACpD,OAAO,EAAE,KAAK,CAAC,OAAO;KACvB,CAAC,CACH,CAAC;IAEF,IAAI,YAAuC,CAAC;IAC5C,IAAI,QAAmC,CAAC;IACxC,IAAI,MAA8B,CAAC;IACnC,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,MAAM,OAAO,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAU,CAAC;IAE/C,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,IAAI,MAAM,CAAC;IAE3D,uGAAuG;IACvG,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAQ,EAAE;QAC/C,UAAU,CAAC,GAAG,EAAE;YACd,MAAM,CAAC,KAAK,CAAC,0CAA0C,CAAC,CAAC;YACzD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC,EAAE,iBAAiB,GAAG,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;QACvC,KAAK,QAAQ,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF,IAAI,WAAuC,CAAC;IAE5C;;;;;OAKG;IACH,MAAM,QAAQ,GAAG,CAAC,MAAsB,EAAQ,EAAE;QAChD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;YAC9B,WAAW,GAAG,MAAM,CAAC;YACrB,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,eAAe,CAAC,CAAC;YACzC,iBAAiB,CAAC,CAAC,CAAC,CAAC;QACvB,CAAC;aAAM,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,wCAAwC,CAAC,CAAC;YAClE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,uBAAuB,CAAC,CAAC;QACnD,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,CAAC,MAAe,EAAQ,EAAE;QACxC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,iCAAiC,CAAC,CAAC;YACjE,OAAO;QACT,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,gCAAgC,CAAC,CAAC;QAChE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,KAAc,EAAE,QAAgB,EAAE,EAAE;QAC7E,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,GAAG,IAAI,SAAS,CAAC,CAAC;IAC3D,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,GAAkB,EAAE,CAAC,CAAC,YAAY,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;IAEtE,MAAM,WAAW,GAAG,KAAK,EAAE,aAAsB,EAAiB,EAAE;QAClE,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;QACxB,IAAI,aAAa,EAAE,CAAC;YAClB,KAAK,MAAM,MAAM,IAAI,OAAO;gBAAE,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAC3D,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;YAC1C,OAAO,CAAC,EAAE,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;IACH,CAAC,CAAC;IAEF;;;OAGG;IACH,MAAM,IAAI,GAAG,KAAK,EAAK,GAAqB,EAAc,EAAE;QAC1D,IAAI,CAAC;YACH,OAAO,MAAM,GAAG,EAAE,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,gBAAgB,CAAC,KAAK,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC;YAC3E,MAAM,QAAQ,EAAE,CAAC;YACjB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,KAAK,GAAuB,CAAC,EAAE,aAAa,GAAG,IAAI,EAAE,EAAE,EAAE,CAC7D,IAAI,CAAC,KAAK,IAAI,EAAE;QACd,MAAM,IAAI,EAAE,CAAC;QACb,MAAM,WAAW,CAAC,aAAa,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEL,MAAM,MAAM,GAAwB,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;IAEpG,MAAM,KAAK,GAAG,KAAK,EACjB,IAAY,EACZ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,IAAI,EAAoC,EACjE,EAAE;QACjB,MAAM,IAAI,EAAE,CAAC;QACb,MAAM,MAAM,GAAG,MAAM,IAAI,YAAY,EAAE,CAAC;QACxC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAC1B,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,MAAc,EAAE,EAAE;YACzC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpB,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;gBACxB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACvB,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACpC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC1C,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC7B,MAAM,WAAW,GAAG,GAAG,EAAE;gBACvB,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC5B,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC;YACF,IAAI,IAAI,KAAK,SAAS;gBAAE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;;gBACpD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QACH,MAAM,GAAG,MAAM,CAAC;QAChB,SAAS,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAClC,MAAM,WAAW,CAAC,aAAa,CAAC,CAAC;QAEjC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAC/E,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,uBAAuB,IAAI,IAAI,WAAW,IAAI,SAAS,EAAE,CAAC,CAAC;IACtG,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,GAAkB,EAAE,CACnC,CAAC,QAAQ,KAAK,CAAC,KAAK,IAAI,EAAE;QACxB,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC;QACvB,KAAK,MAAM,GAAG,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;YAC9C,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW;gBAAE,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/F,MAAM,SAAS,CAAC,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;QAClD,MAAM,MAAM,CAAC;QACb,MAAM,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,CAAC;QACxD,KAAK,MAAM,MAAM,IAAI,OAAO;YAAE,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC5D,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACnC,CAAC,CAAC,EAAE,CAAC,CAAC;IAER,OAAO;QACL,QAAQ;QACR,OAAO;QACP,OAAO,EAAE,GAAG;QACZ,MAAM;QACN,SAAS;QACT,IAAI,MAAM;YACR,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,IAAI;QACJ,MAAM;QACN,KAAK;QACL,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,yFAAyF;AACzF,SAAS,eAAe,CAAC,MAAsC;IAC7D,IAAI,MAAM,KAAK,KAAK;QAAE,OAAO,SAAS,CAAC;IACvC,MAAM,MAAM,GAAG,EAAE,GAAG,wBAAwB,EAAE,GAAG,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC9F,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,IAAI,KAAK,KAAK,KAAK;YAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClG,OAAO,OAAO,CAAC;AACjB,CAAC;AAoBD,MAAM,OAAO,GAAG,CAAC,IAAkB,EAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;AAErD;;;;;;;GAOG;AACH,SAAS,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAkB;IAC9E,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACxB,IAAI,OAAO;YAAE,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,QAAQ,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,CAAC;QACvF,MAAM,GAAG,GAAG,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC9D,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;QACzC,IAAI,QAAQ,CAAC,MAAM;YAAE,GAAG,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;aACrD,IAAI,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC;YAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACrF,MAAM,GAAG,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,GAAG,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;YAC5B,MAAM,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAClC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;gBACrB,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC;gBAC3D,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,gBAAgB,CAAC;gBACtC,IAAI,GAAG,EAAE,CAAC;oBACR,MAAM,IAAI,GAAG;wBACX,MAAM,EAAE,GAAG,CAAC,MAAM;wBAClB,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC;wBAC5B,MAAM,EAAE,GAAG,CAAC,UAAU;wBACtB,UAAU;qBACX,CAAC;oBACF,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBACjE,CAAC;gBACD,KAAK,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC;YAC3E,CAAC,CAAC,CAAC;QACL,CAAC;QACD,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC/B,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,MAAM,CAAC,GAAW;IACzB,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC/B,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,SAAS,OAAO,CAAC,UAAsB;IACrC,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACxB,MAAM,GAAG,GAAG,iBAAiB,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3D,IAAI,GAAG,YAAY,OAAO;YAAE,OAAO,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACjE,IAAI,EAAE,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AAED,6GAA6G;AAC7G,KAAK,UAAU,aAAa,CAAC,GAAoB,EAAE,GAAa,EAAE,IAAkB;IAClF,MAAM,GAAG,CAAC;IACV,IAAI,CAAC,GAAG,CAAC,WAAW;QAAE,IAAI,EAAE,CAAC;AAC/B,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,MAAkB,EAAE,OAAoB,EAAE,SAAiB;IAC9E,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,oBAAoB,EAAE,EAAE,EAAE,CAAC,CAAC;QACnE,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,MAAM,CAAC,mBAAmB,EAAE,CAAC;YAC7B,KAAK,MAAM,MAAM,IAAI,OAAO;gBAAE,MAAM,CAAC,OAAO,EAAE,CAAC;QACjD,CAAC,EAAE,SAAS,CAAC,CAAC;QACd,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE;YAChB,aAAa,CAAC,KAAK,CAAC,CAAC;YACrB,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,oBAAoB,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,SAAwC;IAClE,MAAM,IAAI,GAAG,IAAI,GAAG,EAA8B,CAAC;IACnD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,GAAG,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,CAAC;QACjF,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACxB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,KAAK,CACb,GAAG,aAAa,CAAC,QAAQ,CAAC,mBAAmB,aAAa,CAAC,KAAK,CAAC,mDAAmD,CACrH,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAsB;IACpE,OAAO,GAAG,MAAM,CAAC,WAAW,EAAE,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,IAAI,eAAe,GAAG,CAAC;AAC/E,CAAC"}

package/dist/src/http/middleware.d.ts

@@ -0,0 +1,141 @@
+import type { RequestHandler } from "express";
+import type { z } from "zod";
+import { type RequestContext } from "./context.ts";
+/** An OpenAPI security scheme, in OpenAPI's own words: `{ type: "http", scheme: "bearer" }` and the like. */
+export type SecurityScheme = {
+    type: "http";
+    scheme: string;
+    bearerFormat?: string;
+    description?: string;
+} | {
+    type: "apiKey";
+    in: "header" | "query" | "cookie";
+    name: string;
+    description?: string;
+} | {
+    type: "oauth2";
+    flows: Readonly<Record<string, unknown>>;
+    description?: string;
+} | {
+    type: "openIdConnect";
+    openIdConnectUrl: string;
+    description?: string;
+};
+/** Security schemes by name, such as `{ bearer: { type: "http", scheme: "bearer" } }`. */
+export type SecuritySchemes = Readonly<Record<string, SecurityScheme>>;
+/**
+ * Per-request logic shared by many routes, as {@link defineMiddleware} makes it. `run(ctx)` resolves to its
+ * output, computing it at most once per request.
+ */
+export interface Middleware<Out extends object = object> {
+    /** The security schemes it enforces; the OpenAPI document lists them on every operation behind it. */
+    readonly security?: SecuritySchemes | undefined;
+    run(ctx: RequestContext): Promise<Out>;
+}
+/** Options for {@link defineMiddleware}. */
+export interface MiddlewareOptions<P, Q> {
+    /** Path params the middleware reads, validated (400 when invalid) and typed before it runs. */
+    params?: P;
+    /** Query fields the middleware reads, validated and typed before it runs. */
+    query?: Q;
+    /** The security schemes it enforces, for the OpenAPI document. */
+    security?: SecuritySchemes;
+}
+/**
+ * Names a middleware may not return: the request basics and validated input share the handler's ctx, and a
+ * middleware field with one of these names would be silently replaced. `log` is allowed, to enrich the logger.
+ */
+type ReservedKey = "req" | "res" | "requestId" | "params" | "query" | "body" | "headers";
+/** Rejects outputs that use a {@link ReservedKey}; the error names the offending key. */
+type NoReservedKeys<Out> = {
+    [K in keyof Out]: K extends ReservedKey ? `"${K}" is reserved on ctx` : Out[K];
+};
+/** The middleware's output, or a type error naming any {@link ReservedKey} it uses. */
+type Checked<Out> = Out extends object ? Out & NoReservedKeys<Out> : Out;
+type Result<Out> = Out extends object ? Out : {};
+/** The ctx of a middleware that declares input: the request basics plus the validated `params` and `query`. */
+export type MiddlewareInput<P, Q> = RequestContext & (P extends z.ZodType ? {
+    params: z.output<P>;
+} : {}) & (Q extends z.ZodType ? {
+    query: z.output<Q>;
+} : {});
+/**
+ * Declares per-request logic shared by many routes, as `(fn)` or `(options, fn)`. Return an object to add
+ * typed fields to the handler's ctx, return nothing for a pure check, or throw an error class to stop the
+ * request. Sync or async.
+ *
+ * Middlewares run before the route validates its input, so authentication rejects a request first. A
+ * middleware that needs input, such as the id its permission check depends on, declares `params` or `query`:
+ * they are validated (400 when invalid) and typed before it runs.
+ *
+ * Each runs at most once per request: another middleware, or a handler, can `await other.run(ctx)` to reuse
+ * its result. The names `req`, `res`, `requestId`, `params`, `query`, `body` and `headers` are reserved on ctx
+ * and rejected at compile time; returning `log` replaces the request logger.
+ *
+ * @example
+ * ```ts
+ * export const authenticate = defineMiddleware(
+ *   { security: { bearer: { type: "http", scheme: "bearer" } } },
+ *   async ({ req, log }) => {
+ *     const user = await inject(Sessions).verify(req.get("authorization"));
+ *     if (!user) throw new UnauthorizedError();
+ *     return { user, log: log.child({ userId: user.id }) };
+ *   },
+ * );
+ *
+ * export const requireProjectRole = (role: Role) =>
+ *   defineMiddleware(
+ *     { params: z.object({ projectId: z.uuid() }), security: authenticate.security },
+ *     async (ctx) => {
+ *       const { user } = await authenticate.run(ctx);
+ *       const member = await inject(Members).find(ctx.params.projectId, user.id);
+ *       if (!member) throw new NotFoundError("Project not found");
+ *       if (!allows(member.role, role)) throw new ForbiddenError();
+ *       return { member };
+ *     },
+ *   );
+ * ```
+ */
+export declare function defineMiddleware<Out extends object | void>(fn: (ctx: RequestContext) => Checked<Out> | Promise<Checked<Out>>): Middleware<Result<Out>>;
+export declare function defineMiddleware<Out extends object | void, P extends z.ZodType | undefined = undefined, Q extends z.ZodType | undefined = undefined>(options: MiddlewareOptions<P, Q>, fn: (ctx: MiddlewareInput<P, Q>) => Checked<Out> | Promise<Checked<Out>>): Middleware<Result<Out>>;
+/**
+ * Runs an Express middleware as a brisk middleware, in order with the others in `use`: a body parser such as
+ * multer then runs after authentication, on the one route that needs it. An error it passes to `next` goes
+ * to the app's error handler; when it answers the request itself, the route stops there.
+ *
+ * @example
+ * ```ts
+ * upload: route.post(
+ *   "/:taskId/attachments",
+ *   { use: [authenticate, fromExpress(multer({ limits: { fileSize: 5_000_000 } }).single("file"))] },
+ *   ({ req, params }) => attachments.save(params.taskId, req.file),
+ * ),
+ * ```
+ */
+export declare function fromExpress(handler: RequestHandler): Middleware<{}>;
+/**
+ * An Express middleware wrapped by {@link fromExpress}. In a route's `use` it runs in order with the others;
+ * in the app's `use` the app registers `handler` itself as a plain Express layer, at no extra cost.
+ */
+export declare class ExpressMiddleware implements Middleware<{}> {
+    readonly handler: RequestHandler;
+    constructor(handler: RequestHandler);
+    run({ req, res }: RequestContext): Promise<{}>;
+}
+type UnionToIntersection<U> = (U extends unknown ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
+/** Merges the outputs of a middleware list into one type: `[auth, tenant]` gives `{ user } & { tenant }`. */
+export type MiddlewareContext<T extends readonly Middleware[]> = [T[number]] extends [never] ? {} : UnionToIntersection<T[number] extends infer M ? (M extends Middleware<infer O> ? O : never) : never>;
+/**
+ * Runs `list` in order against the request's context and writes each output onto `target`. Stays synchronous
+ * while the middlewares are, and returns a promise only from the first async one on.
+ */
+export declare function applyMiddlewares(base: RequestContext, target: object, list: readonly Middleware[], from?: number): void | Promise<void>;
+/**
+ * Runs one middleware for the request, reusing its memoized result: a value when it stays synchronous, a
+ * promise otherwise.
+ */
+export declare function resolveMiddleware(middleware: Middleware, ctx: RequestContext): object | Promise<object>;
+/** The security schemes a list of middlewares enforces, merged; `undefined` when none does. */
+export declare function securityOf(middlewares: readonly Middleware[]): SecuritySchemes | undefined;
+export {};
+//# sourceMappingURL=middleware.d.ts.map

package/dist/src/http/middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../../src/http/middleware.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAC7B,OAAO,EAA+B,KAAK,cAAc,EAAE,MAAM,cAAc,CAAC;AAGhF,6GAA6G;AAC7G,MAAM,MAAM,cAAc,GACtB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAC7E;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GACzF;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAClF;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E,0FAA0F;AAC1F,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,UAAU,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM;IACrD,sGAAsG;IACtG,QAAQ,CAAC,QAAQ,CAAC,EAAE,eAAe,GAAG,SAAS,CAAC;IAChD,GAAG,CAAC,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;CACxC;AAED,4CAA4C;AAC5C,MAAM,WAAW,iBAAiB,CAAC,CAAC,EAAE,CAAC;IACrC,+FAA+F;IAC/F,MAAM,CAAC,EAAE,CAAC,CAAC;IACX,6EAA6E;IAC7E,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,kEAAkE;IAClE,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAED;;;GAGG;AACH,KAAK,WAAW,GAAG,KAAK,GAAG,KAAK,GAAG,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;AAEzF,yFAAyF;AACzF,KAAK,cAAc,CAAC,GAAG,IAAI;KAAG,CAAC,IAAI,MAAM,GAAG,GAAG,CAAC,SAAS,WAAW,GAAG,IAAI,CAAC,sBAAsB,GAAG,GAAG,CAAC,CAAC,CAAC;CAAE,CAAC;AAE9G,uFAAuF;AACvF,KAAK,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,MAAM,GAAG,GAAG,GAAG,cAAc,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;AAEzE,KAAK,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC;AAEjD,+GAA+G;AAC/G,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,CAAC,IAAI,cAAc,GAChD,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,GAAG;IAAE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,GACpD,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,GAAG;IAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;CAAE,GAAG,EAAE,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,SAAS,MAAM,GAAG,IAAI,EACxD,EAAE,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GAChE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3B,wBAAgB,gBAAgB,CAC9B,GAAG,SAAS,MAAM,GAAG,IAAI,EACzB,CAAC,SAAS,CAAC,CAAC,OAAO,GAAG,SAAS,GAAG,SAAS,EAC3C,CAAC,SAAS,CAAC,CAAC,OAAO,GAAG,SAAS,GAAG,SAAS,EAE3C,OAAO,EAAE,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,EAChC,EAAE,EAAE,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,GACvE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAiB3B;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,cAAc,GAAG,UAAU,CAAC,EAAE,CAAC,CAEnE;AAED;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,UAAU,CAAC,EAAE,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IAEjC,YAAY,OAAO,EAAE,cAAc,EAElC;IAED,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,EAAE,CAAC,CAW7C;CACF;AA2ED,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GACnG,CAAC,GACD,KAAK,CAAC;AAEV,6GAA6G;AAC7G,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACxF,EAAE,GACF,mBAAmB,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC;AAEzG;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,cAAc,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,SAAS,UAAU,EAAE,EAC3B,IAAI,SAAI,GACP,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CActB;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,cAAc,GAAG,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAEvG;AAED,+FAA+F;AAC/F,wBAAgB,UAAU,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,GAAG,eAAe,GAAG,SAAS,CAG1F"}