@fougere/adapter-rest 0.23.0-alpha.0 → 0.25.0-alpha.0

package/dist/RestProtocol.d.ts

@@ -1,9 +1,12 @@
 import { Format, type Accepted } from '@fougere/schema';
 import { type ProtocolConfig } from '@fougere/core';
-/** Where one operation answers, when what its contract derives is not what it should be. */
 declare const ROUTE: Format<{
     method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
     path?: string | undefined;
+    responses?: {
+        headers?: string[] | undefined;
+        status?: number | undefined;
+    }[] | undefined;
     status?: number | undefined;
 }>;
 /**
@@ -11,9 +14,16 @@ declare const ROUTE: Format<{
  * A frond of this project says its own in its `frond.config.ts`.
  */
 declare const REST: Format<{
+    openapi?: {
+        ui?: "scalar" | "swagger" | boolean | undefined;
+    } | undefined;
     overrides?: Record<string, {
         method?: "DELETE" | "GET" | "PATCH" | "POST" | "PUT" | undefined;
         path?: string | undefined;
+        responses?: {
+            headers?: string[] | undefined;
+            status?: number | undefined;
+        }[] | undefined;
         status?: number | undefined;
     }> | undefined;
     prefix?: string | undefined;

package/dist/RestProtocol.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RestProtocol.d.ts","sourceRoot":"","sources":["../src/RestProtocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAA4D,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAE9G,4FAA4F;AAC5F,QAAA,MAAM,KAAK;;;;EAIA,CAAC;AAEZ;;;GAGG;AACH,QAAA,MAAM,IAAI;;;;;;;EAGC,CAAC;AAEZ,iGAAiG;AACjG,QAAA,MAAM,KAAK;;EAEA,CAAC;AAEZ,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC;AAE/C,OAAO,QAAQ,eAAe,CAAC;IAC7B,UAAU,gBAAgB;QACxB,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;KAC7B;IACD,UAAU,yBAAyB;QACjC,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB;IACD,UAAU,qBAAqB;QAC7B,IAAI,CAAC,EAAE,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC;KAC/B;CACF;AAED,uEAAuE;AACvE,eAAO,MAAM,MAAM,SAAS,CAAC;AAE7B,wBAAgB,QAAQ,CAAC,SAAS,EAAE,cAAc,GAAG,SAAS,GAAG,MAAM,CAEtE"}
+{"version":3,"file":"RestProtocol.d.ts","sourceRoot":"","sources":["../src/RestProtocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAA4D,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAS9G,QAAA,MAAM,KAAK;;;;;;;;EAKA,CAAC;AAOZ;;;GAGG;AACH,QAAA,MAAM,IAAI;;;;;;;;;;;;;;EAKC,CAAC;AAEZ,iGAAiG;AACjG,QAAA,MAAM,KAAK;;EAEA,CAAC;AAEZ,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC;AAE/C,OAAO,QAAQ,eAAe,CAAC;IAC7B,UAAU,gBAAgB;QACxB,IAAI,EAAE,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;KAC7B;IACD,UAAU,yBAAyB;QACjC,IAAI,CAAC,EAAE,SAAS,CAAC;KAClB;IACD,UAAU,qBAAqB;QAC7B,IAAI,CAAC,EAAE,QAAQ,CAAC,OAAO,KAAK,CAAC,CAAC;KAC/B;CACF;AAED,uEAAuE;AACvE,eAAO,MAAM,MAAM,SAAS,CAAC;AAE7B,wBAAgB,QAAQ,CAAC,SAAS,EAAE,cAAc,GAAG,SAAS,GAAG,MAAM,CAEtE"}

package/dist/RestProtocol.js

@@ -2,10 +2,20 @@ import { Format } from '@fougere/schema';
 import { HTTP_METHODS } from '@fougere/http';
 import { Protocols, RouteAddress, isScanned } from '@fougere/core';
 /** Where one operation answers, when what its contract derives is not what it should be. */
+/** An answer the op may give besides its own — a redirect, say — and the headers it sets. */
+const RESPONSE = Format.of()
+    .key('status', Format.count)
+    .key('headers', Format.listOf(Format.text))
+    .closed();
 const ROUTE = Format.of('protocol/rest/route')
     .key('method', Format.tokens(HTTP_METHODS))
     .key('path', Format.text)
     .key('status', Format.count)
+    .key('responses', Format.listOf(RESPONSE))
+    .closed();
+/** The page reading the document, at `{prefix}/docs` — `true` is Swagger UI. None without it. */
+const OPENAPI = Format.of('protocol/rest/openapi')
+    .key('ui', Format.either(Format.tokens(['swagger', 'scalar']), Format.flag))
     .closed();
 /**
  * Where the app mounts REST, and the routes of a frond it cannot edit — `betterAuth()`, a package's.
@@ -13,6 +23,8 @@ const ROUTE = Format.of('protocol/rest/route')
  */
 const REST = Format.of('protocol/rest')
     .key('prefix', Format.text)
+    /** Publish what REST serves at `{prefix}/openapi.json`. Nothing without it. */
+    .key('openapi', OPENAPI)
     .key('overrides', Format.recordOf(ROUTE))
     .closed();
 /** What a frond says of itself: the segment it answers under, `/journal` rather than `/blog`. */

package/dist/RestProtocol.js.map

@@ -1 +1 @@
-{"version":3,"file":"RestProtocol.js","sourceRoot":"","sources":["../src/RestProtocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAA6C,MAAM,eAAe,CAAC;AAE9G,4FAA4F;AAC5F,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,qBAAqB,CAAC;KAC3C,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;KAC1C,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;KACxB,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC;KAC3B,MAAM,EAAE,CAAC;AAEZ;;;GAGG;AACH,MAAM,IAAI,GAAG,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC;KACpC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC;KAC1B,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;KACxC,MAAM,EAAE,CAAC;AAEZ,iGAAiG;AACjG,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,qBAAqB,CAAC;KAC3C,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;KACxB,MAAM,EAAE,CAAC;AAgBZ,uEAAuE;AACvE,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC;AAE7B,MAAM,UAAU,QAAQ,CAAC,SAAqC;IAC5D,OAAO,SAAS,EAAE,IAAI,EAAE,MAAM,IAAI,MAAM,CAAC;AAC3C,CAAC;AAED,yGAAyG;AACzG,SAAS,SAAS,CAAC,SAAgD,EAAE,MAAkC;IACrG,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9D,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,eAAe,GAAG,sDAAsD,CAAC,CAAC;QAE9F,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1G,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,eAAe,GAAG,oCAAoC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;QAC7F,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAEjC,OAAO;YACL,eAAe,GAAG,gBAAgB,KAAK,CAAC,IAAI,gEAAgE;kBACxG,KAAK,KAAK,CAAC,MAAM,CAAC,IAAI,qCAAqC,GAAG,cAAc,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM;SAC5G,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;IACzB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,CAAC,OAA8B,EAAE,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3F,CAAC,CAAC"}
+{"version":3,"file":"RestProtocol.js","sourceRoot":"","sources":["../src/RestProtocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,EAA6C,MAAM,eAAe,CAAC;AAE9G,4FAA4F;AAC5F,6FAA6F;AAC7F,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE,EAAE;KACzB,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC;KAC3B,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;KAC1C,MAAM,EAAE,CAAC;AAEZ,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,qBAAqB,CAAC;KAC3C,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;KAC1C,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;KACxB,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,KAAK,CAAC;KAC3B,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;KACzC,MAAM,EAAE,CAAC;AAEZ,iGAAiG;AACjG,MAAM,OAAO,GAAG,MAAM,CAAC,EAAE,CAAC,uBAAuB,CAAC;KAC/C,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,QAAQ,CAAU,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;KACpF,MAAM,EAAE,CAAC;AAEZ;;;GAGG;AACH,MAAM,IAAI,GAAG,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC;KACpC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC;IAC3B,+EAA+E;KAC9E,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC;KACvB,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;KACxC,MAAM,EAAE,CAAC;AAEZ,iGAAiG;AACjG,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,qBAAqB,CAAC;KAC3C,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC;KACxB,MAAM,EAAE,CAAC;AAgBZ,uEAAuE;AACvE,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC;AAE7B,MAAM,UAAU,QAAQ,CAAC,SAAqC;IAC5D,OAAO,SAAS,EAAE,IAAI,EAAE,MAAM,IAAI,MAAM,CAAC;AAC3C,CAAC;AAED,yGAAyG;AACzG,SAAS,SAAS,CAAC,SAAgD,EAAE,MAAkC;IACrG,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QAC9D,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,eAAe,GAAG,sDAAsD,CAAC,CAAC;QAE9F,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1G,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,eAAe,GAAG,oCAAoC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAC;QAC7F,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QAEjC,OAAO;YACL,eAAe,GAAG,gBAAgB,KAAK,CAAC,IAAI,gEAAgE;kBACxG,KAAK,KAAK,CAAC,MAAM,CAAC,IAAI,qCAAqC,GAAG,cAAc,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM;SAC5G,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;IACzB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,CAAC,OAA8B,EAAE,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC;CAC3F,CAAC,CAAC"}

package/dist/door.d.ts

@@ -0,0 +1,48 @@
+import { DoorMiddleware, type Door } from '@fougere/core';
+import { type ResponseResult } from '@fougere/http';
+import type { RouteDefinition } from './routes/RouteDefinition.js';
+/** What a host hands the REST door for one matched route — the body still to read, so the door reads it. */
+export interface RestRequest {
+    /** The op the route names — what a middleware bound to a handler stands around. */
+    operation: string;
+    headers: Headers;
+    params: Record<string, string>;
+    query: Record<string, unknown>;
+    body: () => Promise<unknown>;
+    state: Record<string, unknown>;
+}
+/**
+ * An answer a REST middleware may give in the op's place, declared in its return type — the status
+ * and the headers are what the contract reads, in the vocabulary of OpenAPI's `responses`.
+ */
+export interface RestResponse<Status extends number, Headers extends Record<string, string> = Record<never, string>, Body = null> extends ResponseResult {
+    status: Status;
+    headers: Headers;
+    data: Body;
+}
+type HandlerClass = abstract new (...args: never[]) => unknown;
+/** A REST middleware standing around its whole frond: `class Powered extends RestMiddleware()`. */
+export declare function RestMiddleware(): abstract new () => DoorMiddleware<RestRequest, ResponseResult>;
+/**
+ * A REST middleware standing around one handler's operations, one method per op it names:
+ * `class PostRest extends RestMiddleware(PostHandler) { bySlug(request, next) { … } }`. An op it
+ * names nothing for goes straight through.
+ */
+export declare function RestMiddleware(handler: HandlerClass): new () => {
+    around(request: RestRequest, next: () => Promise<ResponseResult>): Promise<ResponseResult>;
+};
+/** What a route's op is called with. */
+export interface RestInvocation {
+    params: Record<string, string>;
+    query: Record<string, unknown>;
+    input: unknown;
+    state: Record<string, unknown>;
+}
+/**
+ * REST's edges for one route: the body read within the cycle, the op called, and the answer written
+ * as HTTP — the one place REST decides a status, read off the contract and never off the op's name.
+ * Every host runs it, whoever matched the route: a router by its own paths, a web host by `matchRoute`.
+ */
+export declare function restDoor(route: RouteDefinition): Door<RestRequest, RestInvocation, ResponseResult>;
+export {};
+//# sourceMappingURL=door.d.ts.map

package/dist/door.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"door.d.ts","sourceRoot":"","sources":["../src/door.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAwC,KAAK,IAAI,EAAE,MAAM,eAAe,CAAC;AAChG,OAAO,EAA+B,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAGnE,4GAA4G;AAC5G,MAAM,WAAW,WAAW;IAC1B,mFAAmF;IACnF,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY,CAAC,MAAM,SAAS,MAAM,EAAE,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,IAAI,GAAG,IAAI,CAC9H,SAAQ,cAAc;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;CACZ;AAED,KAAK,YAAY,GAAG,QAAQ,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,OAAO,CAAC;AAE/D,mGAAmG;AACnG,wBAAgB,cAAc,IAAI,QAAQ,WAAW,cAAc,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;AACjG;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,YAAY,GAAG,UAAU;IAAE,MAAM,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;CAAE,CAAC;AAwBhK,wCAAwC;AACxC,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC,WAAW,EAAE,cAAc,EAAE,cAAc,CAAC,CAmBlG"}

package/dist/door.js

@@ -0,0 +1,97 @@
+import { DoorMiddleware, ErrorCode, FougereError, toHttpError } from '@fougere/core';
+import { HttpError } from '@fougere/http';
+export function RestMiddleware(handler) {
+    if (!handler) {
+        class AtRest extends DoorMiddleware {
+            static door = 'rest';
+        }
+        return AtRest;
+    }
+    class AtHandler extends DoorMiddleware {
+        static door = 'rest';
+        static handler = handler;
+        around(request, next) {
+            const own = this[request.operation];
+            return typeof own === 'function' ? own.call(this, request, next) : next();
+        }
+    }
+    return AtHandler;
+}
+/**
+ * REST's edges for one route: the body read within the cycle, the op called, and the answer written
+ * as HTTP — the one place REST decides a status, read off the contract and never off the op's name.
+ * Every host runs it, whoever matched the route: a router by its own paths, a web host by `matchRoute`.
+ */
+export function restDoor(route) {
+    return {
+        name: 'rest',
+        address: route.address,
+        carries: 'http',
+        carrier: ({ headers }) => ({ request: headers, response: new Headers() }),
+        // A read carries no body, so what its input view names arrives in the query string.
+        decode: async ({ params, query, body, state }) => ({
+            params,
+            query,
+            input: route.method === 'GET' && route.inputFields ? inputOf(route.inputFields, query) : await read(body),
+            state,
+        }),
+        run: (invocation) => route.handler(invocation),
+        encode: (outcome, _request, carrier) => leaving('refused' in outcome ? refused(outcome.refused) : responseOf(route, outcome.answered), carrier),
+    };
+}
+/** The fields of an input view the query string carries, read as the shape of each says — a query holds only text. */
+function inputOf(fields, query) {
+    return Object.fromEntries(Object.entries(fields).flatMap(([key, field]) => {
+        if (query[key] === undefined)
+            return [];
+        const text = String(query[key]);
+        const type = field.shape.type;
+        if (type === 'number' || type === 'integer')
+            return [[key, text.trim() === '' ? text : Number(text)]];
+        if (type === 'boolean')
+            return [[key, text === 'true' ? true : text === 'false' ? false : text]];
+        return [[key, text]];
+    }));
+}
+/** `@fougere/http` refuses a body in its own words, since it takes no dependency on core. */
+async function read(body) {
+    try {
+        return await body();
+    }
+    catch (failure) {
+        if (!(failure instanceof HttpError))
+            throw failure;
+        throw new FougereError({ code: failure.code, message: failure.message, cause: failure });
+    }
+}
+function responseOf(route, result) {
+    if (route.method === 'DELETE' && typeof result === 'boolean') {
+        return result ? { status: route.successStatus ?? 204, data: null } : refused(notFound(route));
+    }
+    if (result == null && (route.cardinality === 'maybe' || route.cardinality === 'one'))
+        return refused(notFound(route));
+    if (result === undefined)
+        return { status: route.successStatus ?? 204, data: null };
+    const status = route.successStatus ?? (route.creates ? 201 : 200);
+    if (route.cardinality === 'page' && Array.isArray(result)) {
+        // The page-level facts ride beside the rows: on the array itself, JSON drops them.
+        const page = result;
+        return { status, data: { items: [...result], total: page.total, hasMore: page.hasMore, endCursor: page.endCursor } };
+    }
+    return { status, data: result };
+}
+/** What the keepers of `state:` wrote on the carrier goes out with the answer — every `Set-Cookie` line kept apart. */
+function leaving(answer, carrier) {
+    const cookies = carrier?.response.getSetCookie() ?? [];
+    if (cookies.length === 0)
+        return answer;
+    return { ...answer, headers: { ...answer.headers, 'set-cookie': cookies } };
+}
+function notFound(route) {
+    return new FougereError({ code: ErrorCode.NOT_FOUND, message: `No row answers ${route.method} ${route.path}.` });
+}
+function refused(failure) {
+    const { status, body } = toHttpError(failure);
+    return { status, data: body };
+}
+//# sourceMappingURL=door.js.map

package/dist/door.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"door.js","sourceRoot":"","sources":["../src/door.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAa,MAAM,eAAe,CAAC;AAChG,OAAO,EAAE,SAAS,EAAyC,MAAM,eAAe,CAAC;AAoCjF,MAAM,UAAU,cAAc,CAAC,OAAsB;IACnD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAe,MAAO,SAAQ,cAA2C;YACvE,MAAM,CAAmB,IAAI,GAAG,MAAM,CAAC;SACxC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAe,SAAU,SAAQ,cAA2C;QAC1E,MAAM,CAAmB,IAAI,GAAG,MAAM,CAAC;QACvC,MAAM,CAAmB,OAAO,GAAG,OAAO,CAAC;QAE3C,MAAM,CAAC,OAAoB,EAAE,IAAmC;YAC9D,MAAM,GAAG,GAAI,IAA2C,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAE5E,OAAO,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC5E,CAAC;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAUD;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAsB;IAC7C,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,OAAO,EAAE,MAAM;QACf,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,EAAe,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,OAAO,EAAE,EAAE,CAAC;QACtF,oFAAoF;QACpF,MAAM,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YACjD,MAAM;YACN,KAAK;YACL,KAAK,EAAE,KAAK,CAAC,MAAM,KAAK,KAAK,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC;YACzG,KAAK;SACN,CAAC;QACF,GAAG,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC;QAC9C,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,OAAO,CAC7C,SAAS,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,EACrF,OAAkC,CACnC;KACF,CAAC;AACJ,CAAC;AAED,sHAAsH;AACtH,SAAS,OAAO,CAAC,MAAc,EAAE,KAA8B;IAC7D,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAuB,EAAE;QAC7F,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS;YAAE,OAAO,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAChC,MAAM,IAAI,GAAI,KAAK,CAAC,KAA4B,CAAC,IAAI,CAAC;QACtD,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACtG,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,CAAC,CAAC,GAAG,EAAE,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjG,OAAO,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC,CAAC;AACN,CAAC;AAED,6FAA6F;AAC7F,KAAK,UAAU,IAAI,CAAC,IAA4B;IAC9C,IAAI,CAAC;QACH,OAAO,MAAM,IAAI,EAAE,CAAC;IACtB,CAAC;IAAC,OAAO,OAAO,EAAE,CAAC;QACjB,IAAI,CAAC,CAAC,OAAO,YAAY,SAAS,CAAC;YAAE,MAAM,OAAO,CAAC;QACnD,MAAM,IAAI,YAAY,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAiB,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IACxG,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,KAAsB,EAAE,MAAe;IACzD,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,SAAS,EAAE,CAAC;QAC7D,OAAO,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,aAAa,IAAI,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IAChG,CAAC;IACD,IAAI,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,KAAK,OAAO,IAAI,KAAK,CAAC,WAAW,KAAK,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;IACtH,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,aAAa,IAAI,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAEpF,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAClE,IAAI,KAAK,CAAC,WAAW,KAAK,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1D,mFAAmF;QACnF,MAAM,IAAI,GAAG,MAA8E,CAAC;QAE5F,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;IACvH,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAClC,CAAC;AAED,uHAAuH;AACvH,SAAS,OAAO,CAAC,MAAsB,EAAE,OAAgC;IACvE,MAAM,OAAO,GAAG,OAAO,EAAE,QAAQ,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC;IACvD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,MAAM,CAAC;IAExC,OAAO,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,CAAC;AAC9E,CAAC;AAED,SAAS,QAAQ,CAAC,KAAsB;IACtC,OAAO,IAAI,YAAY,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,SAAS,EAAE,OAAO,EAAE,kBAAkB,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;AACnH,CAAC;AAED,SAAS,OAAO,CAAC,OAAqB;IACpC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAE9C,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAChC,CAAC"}

package/dist/index.d.ts

@@ -1,6 +1,9 @@
 import './RestProtocol.js';
 export { generateRoutes, type RouteDefinition } from './routes/RouteDefinition.js';
-export type { HttpMethod } from '@fougere/http';
+export type { HttpMethod, ResponseResult } from '@fougere/http';
 export { PREFIX, prefixOf, type RestRoute } from './RestProtocol.js';
-export { registerRoutes } from './register.js';
+export { registerDescribed, registerRoutes, type RegisterOptions } from './register.js';
+export { openApiOf, type OpenApiDocument } from './openapi/document.js';
+export { describedAt, describedPaths, type DocsPage } from './openapi/described.js';
+export { RestMiddleware, restDoor, type RestInvocation, type RestRequest, type RestResponse } from './door.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnF,YAAY,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnF,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,SAAS,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AACxF,OAAO,EAAE,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,KAAK,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,KAAK,cAAc,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,WAAW,CAAC"}

package/dist/index.js

@@ -1,9 +1,11 @@
 import './RestProtocol.js';
 export { generateRoutes } from './routes/RouteDefinition.js';
 export { PREFIX, prefixOf } from './RestProtocol.js';
-export { registerRoutes } from './register.js';
-// No schema endpoint here. Discovery is `rpc.discover` on the envelope — one
-// surface, which answers with what the host SERVES. A second GET published
-// every scanned entity instead, façade or not: the auth tables of a host that
-// mounted it were readable by anyone.
+export { registerDescribed, registerRoutes } from './register.js';
+export { openApiOf } from './openapi/document.js';
+export { describedAt, describedPaths } from './openapi/described.js';
+export { RestMiddleware, restDoor } from './door.js';
+// The document is read off what the process SERVES, and published only on request. A schema GET
+// once published every scanned entity, façade or not: the auth tables of a host that mounted it
+// were readable by anyone.
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAwB,MAAM,6BAA6B,CAAC;AAEnF,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAkB,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C,6EAA6E;AAC7E,2EAA2E;AAC3E,8EAA8E;AAC9E,sCAAsC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAwB,MAAM,6BAA6B,CAAC;AAEnF,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAkB,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAwB,MAAM,eAAe,CAAC;AACxF,OAAO,EAAE,SAAS,EAAwB,MAAM,uBAAuB,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAiB,MAAM,wBAAwB,CAAC;AACpF,OAAO,EAAE,cAAc,EAAE,QAAQ,EAA4D,MAAM,WAAW,CAAC;AAE/G,gGAAgG;AAChG,gGAAgG;AAChG,2BAA2B"}

package/dist/openapi/described.d.ts

@@ -0,0 +1,19 @@
+import type { ResponseResult } from '@fougere/http';
+import type { AppLike } from '../routes/RouteDefinition.js';
+/** The page that reads the document, by the word `openapi: { ui }` names it — `true` is Swagger UI. */
+declare const PAGES: {
+    swagger: (url: string) => string;
+    scalar: (url: string) => string;
+};
+export type DocsPage = keyof typeof PAGES;
+/**
+ * What REST publishes of itself — `{prefix}/openapi.json` when `protocols: { rest: { openapi: {} } }`
+ * says so, and `{prefix}/docs` reading it when `ui` says which page — or `undefined` for any other
+ * request. Nothing is published without the line: the document names every op and what each refuses
+ * at once, and a page loads code from elsewhere, which is a decision of its own.
+ */
+export declare function describedAt(app: AppLike, method: string, path: string): ResponseResult | undefined;
+/** The paths `describedAt` answers, for a router that mounts each one. */
+export declare function describedPaths(app: AppLike): string[];
+export {};
+//# sourceMappingURL=described.d.ts.map

package/dist/openapi/described.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"described.d.ts","sourceRoot":"","sources":["../../src/openapi/described.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAEpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAyB5D,uGAAuG;AACvG,QAAA,MAAM,KAAK;IACT,OAAO,QAAQ,MAAM;IAOrB,MAAM,QAAQ,MAAM;CAMrB,CAAC;AAEF,MAAM,MAAM,QAAQ,GAAG,MAAM,OAAO,KAAK,CAAC;AAE1C;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAYlG;AAED,0EAA0E;AAC1E,wBAAgB,cAAc,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,EAAE,CAMrD"}

package/dist/openapi/described.js

@@ -0,0 +1,69 @@
+import { prefixOf } from '../RestProtocol.js';
+import { openApiOf } from './document.js';
+const SWAGGER = {
+    script: {
+        url: 'https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.33.1/swagger-ui-bundle.js',
+        integrity: 'sha384-ZPehFMQommnnuaZ4rpxgkgTT2DKFVp4hZC/7pLit+9Lek9T1YGSo23eHFbvNkXkw',
+    },
+    style: {
+        url: 'https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.33.1/swagger-ui.css',
+        integrity: 'sha384-Ov4/wv3j2bmct8cDc5X4ngJZohVPzEmc6uDPH8WeljUxO5vtoykvMEfbu9Vh6RaW',
+    },
+};
+const SCALAR = {
+    url: 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.72.3/dist/browser/standalone.js',
+    integrity: 'sha384-HWi/QCSPi64AQ0xBXFGDk+7gmvZ4hJ/7sZMIXqWVz6Ikb6+Cxej/hWKaomOStyFb',
+};
+/** The page that reads the document, by the word `openapi: { ui }` names it — `true` is Swagger UI. */
+const PAGES = {
+    swagger: (url) => page(`<link rel="stylesheet" href="${SWAGGER.style.url}" integrity="${SWAGGER.style.integrity}" crossorigin="anonymous">`, `<div id="swagger-ui"></div>
+  <script src="${SWAGGER.script.url}" integrity="${SWAGGER.script.integrity}" crossorigin="anonymous"></script>
+  <script>SwaggerUIBundle({ url: ${JSON.stringify(url)}, dom_id: '#swagger-ui' })</script>`),
+    // Scalar sends usage to its makers unless told not to.
+    scalar: (url) => page('', `<div id="app"></div>
+  <script src="${SCALAR.url}" integrity="${SCALAR.integrity}" crossorigin="anonymous"></script>
+  <script>Scalar.createApiReference('#app', { url: ${JSON.stringify(url)}, telemetry: false })</script>`),
+};
+/**
+ * What REST publishes of itself — `{prefix}/openapi.json` when `protocols: { rest: { openapi: {} } }`
+ * says so, and `{prefix}/docs` reading it when `ui` says which page — or `undefined` for any other
+ * request. Nothing is published without the line: the document names every op and what each refuses
+ * at once, and a page loads code from elsewhere, which is a decision of its own.
+ */
+export function describedAt(app, method, path) {
+    const openapi = app.protocols?.rest?.openapi;
+    if (method !== 'GET' || !openapi)
+        return undefined;
+    const prefix = prefixOf(app.protocols);
+    if (path === `${prefix}/openapi.json`)
+        return { status: 200, data: openApiOf(app) };
+    const ui = openapi.ui === true ? 'swagger' : openapi.ui || undefined;
+    if (ui && path === `${prefix}/docs`) {
+        return { status: 200, data: PAGES[ui](`${prefix}/openapi.json`), raw: true, headers: { 'content-type': 'text/html; charset=utf-8' } };
+    }
+    return undefined;
+}
+/** The paths `describedAt` answers, for a router that mounts each one. */
+export function describedPaths(app) {
+    const openapi = app.protocols?.rest?.openapi;
+    if (!openapi)
+        return [];
+    const prefix = prefixOf(app.protocols);
+    return [`${prefix}/openapi.json`, ...(openapi.ui ? [`${prefix}/docs`] : [])];
+}
+function page(head, body) {
+    return `<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>API reference</title>
+  ${head}
+</head>
+<body>
+  ${body}
+</body>
+</html>
+`;
+}
+//# sourceMappingURL=described.js.map

package/dist/openapi/described.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"described.js","sourceRoot":"","sources":["../../src/openapi/described.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAQ1C,MAAM,OAAO,GAAG;IACd,MAAM,EAAE;QACN,GAAG,EAAE,0EAA0E;QAC/E,SAAS,EAAE,yEAAyE;KACrF;IACD,KAAK,EAAE;QACL,GAAG,EAAE,oEAAoE;QACzE,SAAS,EAAE,yEAAyE;KACrF;CAC+B,CAAC;AAEnC,MAAM,MAAM,GAAW;IACrB,GAAG,EAAE,sFAAsF;IAC3F,SAAS,EAAE,yEAAyE;CACrF,CAAC;AAEF,uGAAuG;AACvG,MAAM,KAAK,GAAG;IACZ,OAAO,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAC5B,gCAAgC,OAAO,CAAC,KAAK,CAAC,GAAG,gBAAgB,OAAO,CAAC,KAAK,CAAC,SAAS,4BAA4B,EACpH;iBACa,OAAO,CAAC,MAAM,CAAC,GAAG,gBAAgB,OAAO,CAAC,MAAM,CAAC,SAAS;mCACxC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,qCAAqC,CACxF;IACD,uDAAuD;IACvD,MAAM,EAAE,CAAC,GAAW,EAAE,EAAE,CAAC,IAAI,CAC3B,EAAE,EACF;iBACa,MAAM,CAAC,GAAG,gBAAgB,MAAM,CAAC,SAAS;qDACN,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,gCAAgC,CACrG;CACF,CAAC;AAIF;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAY,EAAE,MAAc,EAAE,IAAY;IACpE,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC;IAC7C,IAAI,MAAM,KAAK,KAAK,IAAI,CAAC,OAAO;QAAE,OAAO,SAAS,CAAC;IACnD,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAEvC,IAAI,IAAI,KAAK,GAAG,MAAM,eAAe;QAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;IACpF,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,SAAS,CAAC;IACrE,IAAI,EAAE,IAAI,IAAI,KAAK,GAAG,MAAM,OAAO,EAAE,CAAC;QACpC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,eAAe,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,0BAA0B,EAAE,EAAE,CAAC;IACxI,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,cAAc,CAAC,GAAY;IACzC,MAAM,OAAO,GAAG,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO,CAAC;IAC7C,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAEvC,OAAO,CAAC,GAAG,MAAM,eAAe,EAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/E,CAAC;AAED,SAAS,IAAI,CAAC,IAAY,EAAE,IAAY;IACtC,OAAO;;;;;;IAML,IAAI;;;IAGJ,IAAI;;;CAGP,CAAC;AACF,CAAC"}

package/dist/openapi/document.d.ts

@@ -0,0 +1,25 @@
+import { type AppLike } from '../routes/RouteDefinition.js';
+type Schema = Record<string, unknown>;
+/** OpenAPI 3.1 — the part of it this writes. */
+export interface OpenApiDocument {
+    openapi: '3.1.0';
+    info: {
+        title: string;
+        version: string;
+    };
+    tags: {
+        name: string;
+    }[];
+    paths: Record<string, Record<string, Schema>>;
+    components: {
+        schemas: Record<string, Schema>;
+    };
+}
+/**
+ * What this process serves on REST, as OpenAPI 3.1 — read off the routes `generateRoutes` already
+ * answers, never declared beside them. A schema is the card's descriptor, which IS JSON Schema; a
+ * refusal is the op's own `errors` and the half the framework implies, at the status the door says.
+ */
+export declare function openApiOf(app: AppLike): OpenApiDocument;
+export {};
+//# sourceMappingURL=document.d.ts.map

package/dist/openapi/document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../../src/openapi/document.ts"],"names":[],"mappings":"AAEA,OAAO,EAAkB,KAAK,OAAO,EAAwB,MAAM,8BAA8B,CAAC;AAGlG,KAAK,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEtC,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACzC,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC9C,UAAU,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,CAAC;CACjD;AAaD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,eAAe,CA+CvD"}

package/dist/openapi/document.js

@@ -0,0 +1,171 @@
+import { Card } from '@fougere/schema';
+import { ErrorCode, FougereError, refusalsOf, toHttpError } from '@fougere/core';
+import { generateRoutes } from '../routes/RouteDefinition.js';
+/** What every refusal answers, whatever the door: `toHttpError`'s body. */
+const REFUSAL = {
+    type: 'object',
+    properties: {
+        code: { type: 'string', enum: Object.values(ErrorCode) },
+        message: { type: 'string' },
+        details: {},
+    },
+    required: ['code', 'message'],
+};
+/**
+ * What this process serves on REST, as OpenAPI 3.1 — read off the routes `generateRoutes` already
+ * answers, never declared beside them. A schema is the card's descriptor, which IS JSON Schema; a
+ * refusal is the op's own `errors` and the half the framework implies, at the status the door says.
+ */
+export function openApiOf(app) {
+    const schemas = { Refusal: REFUSAL };
+    const named = new Map();
+    // An entity keeps its own name; a view cut from it is named by where it is used — `PostUpdateInput` —
+    // unless it states what a schema already written states. What a view borrowed from is not a shape.
+    const refOf = (view, usedAs) => {
+        let name = named.get(view);
+        if (!name) {
+            const { 'x-fougere-derived': derived, ...descriptor } = Card.fromSchema(view).descriptor;
+            // A patch view requires nothing: every field it carries is a change, and none must be sent.
+            const patch = view.getOpts().patch === true;
+            if (patch)
+                delete descriptor.required;
+            descriptor.properties = writtenBy(descriptor.properties, patch);
+            const shape = JSON.stringify(descriptor);
+            name = Object.keys(schemas).find((one) => JSON.stringify(schemas[one]) === shape);
+            if (!name) {
+                const title = descriptor.title ?? 'Row';
+                const wanted = derived ? title + usedAs : title;
+                name = wanted;
+                for (let n = 2; schemas[name]; n++)
+                    name = `${wanted}${n}`;
+                // A reader shows a schema by its title, so a view says its own name and not its entity's.
+                schemas[name] = { ...descriptor, title: name };
+            }
+            named.set(view, name);
+        }
+        return { $ref: `#/components/schemas/${name}` };
+    };
+    const paths = {};
+    const tags = new Set();
+    for (const route of generateRoutes(app)) {
+        const meta = app.operationsFor(route.address)?.get(route.operationName);
+        if (!meta)
+            continue;
+        const frond = app.fronds.find((one) => one.handlers.some((handler) => handler.address === route.address)).name;
+        tags.add(frond);
+        const path = route.path.replace(/:(\w+)/g, '{$1}');
+        paths[path] = { ...paths[path], [route.method.toLowerCase()]: operationOf(route, meta, frond, refOf) };
+    }
+    return {
+        openapi: '3.1.0',
+        info: { title: [...tags].join(', ') || 'API', version: 'unversioned' },
+        tags: [...tags].map((name) => ({ name })),
+        paths,
+        components: { schemas },
+    };
+}
+function operationOf(route, meta, frond, refOf) {
+    const inPath = new Set([...route.path.matchAll(/:(\w+)/g)].map((match) => match[1]));
+    const params = (meta.binding ?? []).flatMap(({ source, optional }) => (source.kind === 'param' ? [{ ...source, optional }] : []));
+    const reads = route.method === 'GET' || route.method === 'DELETE';
+    const parameters = params
+        .filter((param) => inPath.has(param.name) || reads)
+        .map((param) => ({
+        name: param.name,
+        in: inPath.has(param.name) ? 'path' : 'query',
+        required: inPath.has(param.name) || !param.optional,
+        schema: { type: param.coerce ?? 'string' },
+    }));
+    // A read carries no body: the fields of its input view are its query string.
+    const queried = route.method === 'GET' && meta.input ? queryOf(meta.input) : [];
+    const operation = route.operationName[0].toUpperCase() + route.operationName.slice(1);
+    return {
+        operationId: `${route.address}.${route.operationName}`,
+        tags: [frond],
+        ...(meta.description && { description: meta.description }),
+        ...(parameters.length + queried.length > 0 && { parameters: [...parameters, ...queried] }),
+        ...(route.method === 'GET' ? {} : requestBodyOf(meta, reads ? [] : params.filter((param) => !inPath.has(param.name)), (view) => refOf(view, `${operation}Input`))),
+        responses: responsesOf(route, meta, inPath.size > 0, (view) => refOf(view, `${operation}Output`)),
+    };
+}
+function queryOf(view) {
+    const { properties, required = [] } = Card.fromSchema(view).descriptor;
+    return Object.entries(properties).map(([name, schema]) => ({ name, in: 'query', required: required.includes(name), schema }));
+}
+/** The input view whole, or the fields a change carries — the path designates, the body carries what changes. */
+function requestBodyOf(meta, carried, refOf) {
+    if (meta.input)
+        return { requestBody: { required: true, content: { 'application/json': { schema: refOf(meta.input) } } } };
+    if (carried.length === 0)
+        return {};
+    const schema = {
+        type: 'object',
+        properties: Object.fromEntries(carried.map((param) => [param.name, { type: param.coerce ?? 'string' }])),
+        required: carried.filter((param) => !param.optional).map((param) => param.name),
+    };
+    return { requestBody: { required: true, content: { 'application/json': { schema } } } };
+}
+function responsesOf(route, meta, designates, refOf) {
+    const responses = {};
+    const answers = meta.output && meta.cardinality !== 'none' && route.method !== 'DELETE';
+    if (answers) {
+        const row = refOf(meta.output);
+        const schema = meta.cardinality === 'page' ? pageOf(row) : meta.cardinality === 'many' ? { type: 'array', items: row } : row;
+        responses[String(route.successStatus ?? (route.creates ? 201 : 200))] = { description: 'Answered.', content: { 'application/json': { schema } } };
+    }
+    else {
+        responses[String(route.successStatus ?? 204)] = { description: 'Done, nothing to answer.' };
+    }
+    for (const answer of route.responses ?? []) {
+        responses[String(answer.status)] = {
+            description: 'Answered in the op\'s place by a door middleware.',
+            ...(answer.headers && { headers: Object.fromEntries(answer.headers.map((name) => [name, { schema: { type: 'string' } }])) }),
+        };
+    }
+    const missing = designates && (route.method === 'DELETE' || meta.cardinality === 'one' || meta.cardinality === 'maybe');
+    const codes = new Set([...refusalsOf({ kind: meta.kind, input: meta.input, errors: meta.errors }), ...(missing ? [ErrorCode.NOT_FOUND] : [])]);
+    const refusedAt = new Map();
+    for (const code of codes) {
+        const { status } = toHttpError(new FougereError({ code, message: code }));
+        refusedAt.set(status, [...(refusedAt.get(status) ?? []), code]);
+    }
+    // Each status names its own codes, so a reader's example is one this status can answer.
+    for (const [status, refused] of refusedAt) {
+        responses[String(status)] = {
+            description: `Refused: ${refused.join(', ')}.`,
+            content: {
+                'application/json': {
+                    schema: { allOf: [{ $ref: '#/components/schemas/Refusal' }, { properties: { code: { enum: refused } } }] },
+                    example: { code: refused[0], message: 'What was refused, in words.' },
+                },
+            },
+        };
+    }
+    return responses;
+}
+/**
+ * What the lifecycle axis says of who writes a field, in OpenAPI's words: a value the server fills
+ * at creation is `readOnly`, so no request sends it; a field no update may change is not in a patch.
+ */
+function writtenBy(properties, patch) {
+    return Object.fromEntries(Object.entries(properties).flatMap(([key, property]) => {
+        const lifecycle = property['x-fougere']?.lifecycle;
+        if (patch && lifecycle?.update === 'forbidden')
+            return [];
+        const filled = lifecycle?.create === 'now' || (typeof lifecycle?.create === 'object' && lifecycle.create !== null && 'generate' in lifecycle.create);
+        return [[key, filled ? { ...property, readOnly: true } : property]];
+    }));
+}
+function pageOf(row) {
+    return {
+        type: 'object',
+        properties: {
+            items: { type: 'array', items: row },
+            total: { type: 'integer' },
+            hasMore: { type: 'boolean' },
+            endCursor: { type: 'string' },
+        },
+        required: ['items'],
+    };
+}
+//# sourceMappingURL=document.js.map

package/dist/openapi/document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../src/openapi/document.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAmB,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAAE,cAAc,EAAsC,MAAM,8BAA8B,CAAC;AAclG,2EAA2E;AAC3E,MAAM,OAAO,GAAW;IACtB,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE;QACxD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,OAAO,EAAE,EAAE;KACZ;IACD,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,GAAY;IACpC,MAAM,OAAO,GAA2B,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAC7D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAsB,CAAC;IAC5C,sGAAsG;IACtG,mGAAmG;IACnG,MAAM,KAAK,GAAG,CAAC,IAAgB,EAAE,MAAc,EAAU,EAAE;QACzD,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC;YACzF,4FAA4F;YAC5F,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC;YAC5C,IAAI,KAAK;gBAAE,OAAO,UAAU,CAAC,QAAQ,CAAC;YACtC,UAAU,CAAC,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC,UAAoC,EAAE,KAAK,CAAiC,CAAC;YAC1H,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YACzC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC;YAClF,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,IAAI,KAAK,CAAC;gBACxC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;gBAChD,IAAI,GAAG,MAAM,CAAC;gBACd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;oBAAE,IAAI,GAAG,GAAG,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3D,0FAA0F;gBAC1F,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,EAAE,KAAK,EAAE,IAAI,EAAuB,CAAC;YACtE,CAAC;YACD,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACxB,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,wBAAwB,IAAI,EAAE,EAAE,CAAC;IAClD,CAAC,CAAC;IAEF,MAAM,KAAK,GAA6B,EAAE,CAAC;IAC3C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,cAAc,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,GAAG,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACxE,IAAI,CAAC,IAAI;YAAE,SAAS;QACpB,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC,CAAE,CAAC,IAAI,CAAC;QAChH,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAChB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QACnD,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;IACzG,CAAC;IAED,OAAO;QACL,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE;QACtE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACzC,KAAK;QACL,UAAU,EAAE,EAAE,OAAO,EAAE;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAsB,EAAE,IAAmB,EAAE,KAAa,EAAE,KAAmD;IAClI,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC;IACtF,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClI,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,KAAK,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAClE,MAAM,UAAU,GAAG,MAAM;SACtB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC;SAClD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACf,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;QAC7C,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ;QACnD,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,IAAI,QAAQ,EAAE;KAC3C,CAAC,CAAC,CAAC;IACN,6EAA6E;IAC7E,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAEhF,MAAM,SAAS,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAEvF,OAAO;QACL,WAAW,EAAE,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,aAAa,EAAE;QACtD,IAAI,EAAE,CAAC,KAAK,CAAC;QACb,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1D,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,GAAG,UAAU,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;QAC1F,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,SAAS,OAAO,CAAC,CAAC,CAAC;QAClK,SAAS,EAAE,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,SAAS,QAAQ,CAAC,CAAC;KAClG,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,IAAgB;IAC/B,MAAM,EAAE,UAAU,EAAE,QAAQ,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC;IAEvE,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;AAChI,CAAC;AAED,iHAAiH;AACjH,SAAS,aAAa,CACpB,IAAmB,EACnB,OAA+D,EAC/D,KAAmC;IAEnC,IAAI,IAAI,CAAC,KAAK;QAAE,OAAO,EAAE,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAC3H,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAEpC,MAAM,MAAM,GAAW;QACrB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC,CAAC,CAAC;QACxG,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC;KAChF,CAAC;IAEF,OAAO,EAAE,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC;AAC1F,CAAC;AAED,SAAS,WAAW,CAAC,KAAsB,EAAE,IAAmB,EAAE,UAAmB,EAAE,KAAmC;IACxH,MAAM,SAAS,GAA2B,EAAE,CAAC;IAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IACxF,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,MAAO,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAC7H,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACpJ,CAAC;SAAM,CAAC;QACN,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,WAAW,EAAE,0BAA0B,EAAE,CAAC;IAC9F,CAAC;IAED,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;QAC3C,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG;YACjC,WAAW,EAAE,mDAAmD;YAChE,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC7H,CAAC;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,CAAC,CAAC;IACxH,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC/I,MAAM,SAAS,GAAG,IAAI,GAAG,EAAuB,CAAC;IACjD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,IAAI,YAAY,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC1E,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,wFAAwF;IACxF,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,SAAS,EAAE,CAAC;QAC1C,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG;YAC1B,WAAW,EAAE,YAAY,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;YAC9C,OAAO,EAAE;gBACP,kBAAkB,EAAE;oBAClB,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,8BAA8B,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE;oBAC1G,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,6BAA6B,EAAE;iBACtE;aACF;SACF,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,SAAS,SAAS,CAAC,UAAkC,EAAE,KAAc;IACnE,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,EAAE;QAC/E,MAAM,SAAS,GAAI,QAAQ,CAAC,WAAW,CAAwE,EAAE,SAAS,CAAC;QAC3H,IAAI,KAAK,IAAI,SAAS,EAAE,MAAM,KAAK,WAAW;YAAE,OAAO,EAAE,CAAC;QAC1D,MAAM,MAAM,GAAG,SAAS,EAAE,MAAM,KAAK,KAAK,IAAI,CAAC,OAAO,SAAS,EAAE,MAAM,KAAK,QAAQ,IAAI,SAAS,CAAC,MAAM,KAAK,IAAI,IAAI,UAAU,IAAI,SAAS,CAAC,MAAM,CAAC,CAAC;QAErJ,OAAO,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC,CAAC;AACN,CAAC;AAED,SAAS,MAAM,CAAC,GAAW;IACzB,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE;YACpC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;YAC5B,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC9B;QACD,QAAQ,EAAE,CAAC,OAAO,CAAC;KACpB,CAAC;AACJ,CAAC"}

package/dist/register.d.ts

@@ -1,8 +1,15 @@
 /**
  * Framework-agnostic route registration — translates RouteDefinition[] into HttpRouter calls.
  */
+import { type Answering } from '@fougere/core';
 import type { HttpRouter } from '@fougere/http';
-import type { RouteDefinition } from './routes/RouteDefinition.js';
+import type { AppLike, RouteDefinition } from './routes/RouteDefinition.js';
+export interface RegisterOptions {
+    /** The app's cycle, which watches each request — `app.answer`. Without it the door runs unwatched. */
+    answer?: Answering;
+}
 /** Register all route definitions on an HttpRouter. */
-export declare function registerRoutes(router: HttpRouter, routes: RouteDefinition[]): void;
+export declare function registerRoutes(router: HttpRouter, routes: RouteDefinition[], { answer }?: RegisterOptions): void;
+/** What REST publishes of itself, on a router — nothing unless `protocols: { rest: { openapi: {} } }`. */
+export declare function registerDescribed(router: HttpRouter, app: AppLike): void;
 //# sourceMappingURL=register.d.ts.map