@nocobase/app-server 0.11.1-alpha.4 → 2.0.0-beta.1

package/dist/router/openapi/components.js

@@ -0,0 +1,128 @@
+import { apiErrorStatusCodes } from '../api-error.js';
+const schemaRef = (name) => ({
+    $ref: `#/components/schemas/${name}`,
+});
+/** The HTTP statuses that have a shared error response component, with the component's name. */
+export const apiErrorResponseNames = Object.freeze({
+    400: 'BadRequest',
+    401: 'Unauthenticated',
+    403: 'PermissionDenied',
+    404: 'NotFound',
+    409: 'Conflict',
+    413: 'PayloadTooLarge',
+    415: 'UnsupportedMediaType',
+    429: 'TooManyRequests',
+    500: 'InternalError',
+    501: 'NotImplemented',
+    503: 'Unavailable',
+    504: 'DeadlineExceeded',
+});
+const errorDescriptions = {
+    400: 'The request is invalid (`INVALID_ARGUMENT`, with `fieldViolations` naming each invalid field) or the resource state forbids it (`FAILED_PRECONDITION`).',
+    401: 'No valid session or API key (`UNAUTHENTICATED`).',
+    403: 'The caller may not do this (`PERMISSION_DENIED`).',
+    404: 'The resource the URL names does not exist (`NOT_FOUND`).',
+    409: 'The resource already exists (`ALREADY_EXISTS`) or a concurrent change won (`ABORTED`).',
+    413: 'The request body exceeds a size limit (`INVALID_ARGUMENT`, reason `BODY_TOO_LARGE`).',
+    415: 'The request content type is not supported (`INVALID_ARGUMENT`).',
+    429: 'A rate limit or quota was exceeded (`RESOURCE_EXHAUSTED`); wait for `Retry-After`.',
+    500: 'An unexpected failure (`INTERNAL`); the body reveals nothing about its cause.',
+    501: 'The operation is not implemented (`UNIMPLEMENTED`).',
+    503: 'A dependency is unavailable (`UNAVAILABLE`); retrying later may succeed.',
+    504: 'The operation did not finish in time (`DEADLINE_EXCEEDED`).',
+};
+/** The schemas and responses every API document carries: the standard error body and list metadata. */
+export function apiDocumentBaseComponents() {
+    const responses = {};
+    for (const [code, name] of Object.entries(apiErrorResponseNames)) {
+        responses[name] = {
+            description: errorDescriptions[Number(code)],
+            content: { 'application/json': { schema: schemaRef('ApiErrorBody') } },
+        };
+    }
+    responses[invalidInputResponseName] = {
+        description: invalidInputDescription,
+        content: { 'application/json': { schema: schemaRef('ApiErrorBody') } },
+    };
+    return {
+        schemas: {
+            ApiFieldViolation: {
+                type: 'object',
+                description: 'One invalid field in a request.',
+                required: ['field', 'description'],
+                properties: {
+                    field: {
+                        type: 'string',
+                        description: 'Path to the field, such as `releaseId` or `items.2.name`.',
+                    },
+                    description: { type: 'string' },
+                    reason: { type: 'string' },
+                },
+            },
+            ApiErrorPayload: {
+                type: 'object',
+                required: ['code', 'status', 'reason', 'domain', 'message'],
+                properties: {
+                    code: { type: 'integer', description: 'The HTTP status.' },
+                    status: {
+                        type: 'string',
+                        enum: Object.keys(apiErrorStatusCodes),
+                        description: 'The canonical error category; it decides the HTTP status.',
+                    },
+                    reason: {
+                        type: 'string',
+                        description: 'What went wrong, in UPPER_SNAKE_CASE, unique within `domain`. Clients branch on this.',
+                    },
+                    domain: {
+                        type: 'string',
+                        description: 'Who defined `reason`: a plugin namespace, or `app` for the framework.',
+                    },
+                    message: {
+                        type: 'string',
+                        description: 'Developer-facing English text. Never shown to users or parsed by clients.',
+                    },
+                    localizedMessage: {
+                        type: 'object',
+                        required: ['locale', 'message'],
+                        properties: {
+                            locale: { type: 'string' },
+                            message: { type: 'string' },
+                        },
+                    },
+                    fieldViolations: {
+                        type: 'array',
+                        items: schemaRef('ApiFieldViolation'),
+                    },
+                    metadata: { type: 'object', additionalProperties: true },
+                    requestId: {
+                        type: 'string',
+                        description: 'The id also sent in the `x-request-id` response header.',
+                    },
+                },
+            },
+            ApiErrorBody: {
+                type: 'object',
+                description: 'The body of every failed `/api` response.',
+                required: ['error'],
+                properties: { error: schemaRef('ApiErrorPayload') },
+            },
+            ApiListMeta: {
+                type: 'object',
+                description: 'List metadata. A list pages by `pageToken` (answering `nextPageToken`, absent on the last page) or by `page` (answering `page`, `pageSize` and `total`); an unpaged configuration list answers `total`. A list may add fields of its own.',
+                properties: {
+                    total: { type: 'integer', minimum: 0 },
+                    page: { type: 'integer', minimum: 1 },
+                    pageSize: { type: 'integer', minimum: 1 },
+                    nextPageToken: { type: 'string' },
+                },
+                additionalProperties: true,
+            },
+        },
+        responses,
+    };
+}
+/** The description of the 400 a route answers when `apiValidator()` rejects its input. */
+export const invalidInputDescription = 'The request does not match the parameters or body this operation accepts (`INVALID_ARGUMENT`, reason `INVALID_INPUT`, with `fieldViolations` naming each invalid field).';
+/** The shared response `apiValidator()` failures are documented with: the 400 every route with a validator can answer. */
+export const invalidInputResponseName = 'InvalidInput';
+//# sourceMappingURL=components.js.map

package/dist/router/openapi/components.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"components.js","sourceRoot":"","sources":["../../../src/router/openapi/components.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,MAAM,SAAS,GAAG,CAAC,IAAY,EAA+B,EAAE,CAAC,CAAC;IAChE,IAAI,EAAE,wBAAwB,IAAI,EAAE;CACrC,CAAC,CAAC;AAEH,gGAAgG;AAChG,MAAM,CAAC,MAAM,qBAAqB,GAa9B,MAAM,CAAC,MAAM,CAAC;IAChB,GAAG,EAAE,YAAY;IACjB,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,UAAU;IACf,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,gBAAgB;IACrB,GAAG,EAAE,aAAa;IAClB,GAAG,EAAE,kBAAkB;CACxB,CAAC,CAAC;AAIH,MAAM,iBAAiB,GAAmD;IACxE,GAAG,EAAE,yJAAyJ;IAC9J,GAAG,EAAE,kDAAkD;IACvD,GAAG,EAAE,mDAAmD;IACxD,GAAG,EAAE,0DAA0D;IAC/D,GAAG,EAAE,wFAAwF;IAC7F,GAAG,EAAE,sFAAsF;IAC3F,GAAG,EAAE,iEAAiE;IACtE,GAAG,EAAE,oFAAoF;IACzF,GAAG,EAAE,+EAA+E;IACpF,GAAG,EAAE,qDAAqD;IAC1D,GAAG,EAAE,0EAA0E;IAC/E,GAAG,EAAE,6DAA6D;CACnE,CAAC;AAEF,uGAAuG;AACvG,MAAM,UAAU,yBAAyB;IACvC,MAAM,SAAS,GAA+C,EAAE,CAAC;IACjE,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,EAAE,CAAC;QACjE,SAAS,CAAC,IAAI,CAAC,GAAG;YAChB,WAAW,EAAE,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAyB,CAAC;YACpE,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,EAAE,EAAE;SACvE,CAAC;IACJ,CAAC;IACD,SAAS,CAAC,wBAAwB,CAAC,GAAG;QACpC,WAAW,EAAE,uBAAuB;QACpC,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,cAAc,CAAC,EAAE,EAAE;KACvE,CAAC;IACF,OAAO;QACL,OAAO,EAAE;YACP,iBAAiB,EAAE;gBACjB,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,iCAAiC;gBAC9C,QAAQ,EAAE,CAAC,OAAO,EAAE,aAAa,CAAC;gBAClC,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,2DAA2D;qBAC9D;oBACD,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC/B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC3B;aACF;YACD,eAAe,EAAE;gBACf,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,CAAC;gBAC3D,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,kBAAkB,EAAE;oBAC1D,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC;wBACtC,WAAW,EACT,2DAA2D;qBAC9D;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,uFAAuF;qBAC1F;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,uEAAuE;qBAC1E;oBACD,OAAO,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,2EAA2E;qBAC9E;oBACD,gBAAgB,EAAE;wBAChB,IAAI,EAAE,QAAQ;wBACd,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;wBAC/B,UAAU,EAAE;4BACV,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;4BAC1B,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;yBAC5B;qBACF;oBACD,eAAe,EAAE;wBACf,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE,SAAS,CAAC,mBAAmB,CAAC;qBACtC;oBACD,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,oBAAoB,EAAE,IAAI,EAAE;oBACxD,SAAS,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,WAAW,EACT,yDAAyD;qBAC5D;iBACF;aACF;YACD,YAAY,EAAE;gBACZ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,2CAA2C;gBACxD,QAAQ,EAAE,CAAC,OAAO,CAAC;gBACnB,UAAU,EAAE,EAAE,KAAK,EAAE,SAAS,CAAC,iBAAiB,CAAC,EAAE;aACpD;YACD,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,2OAA2O;gBAC7O,UAAU,EAAE;oBACV,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;oBACtC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;oBACrC,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;oBACzC,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAClC;gBACD,oBAAoB,EAAE,IAAI;aAC3B;SACF;QACD,SAAS;KACV,CAAC;AACJ,CAAC;AAED,0FAA0F;AAC1F,MAAM,CAAC,MAAM,uBAAuB,GAClC,0KAA0K,CAAC;AAE7K,0HAA0H;AAC1H,MAAM,CAAC,MAAM,wBAAwB,GAAG,cAAc,CAAC"}

package/dist/router/openapi/declared.d.ts

@@ -0,0 +1,19 @@
+import type { Context } from 'hono';
+import type { DescribeRouteOptions } from 'hono-openapi';
+/**
+ * What `describeRoute()` declares for the route answering `context`, merged over the handlers registered with it (its
+ * method and path); undefined when it declares nothing. A middleware reads it before the route runs, such as
+ * authentication deciding whether the route accepts a credential. The route is the first one at or after the running
+ * handler that is not a middleware for every method, so a sibling path that also matches (`/agents/{agentId}` beside
+ * `/agents/available`) never lends it its declaration.
+ */
+export declare function declaredRouteOf(context: Context): DescribeRouteOptions | undefined;
+/** Whether the route answering `context` lists `scheme` among its own security requirements. */
+export declare function routeAcceptsScheme(context: Context, scheme: string): boolean;
+/**
+ * The business action the route answering `context` declares in its `x-cli` extension (`cliRoute({ action })`);
+ * undefined when it declares none. A route that accepts an agent's run names the action it performs, and the
+ * application checks the run holds it before the route runs.
+ */
+export declare function declaredRouteActionOf(context: Context): string | undefined;
+//# sourceMappingURL=declared.d.ts.map

package/dist/router/openapi/declared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"declared.d.ts","sourceRoot":"","sources":["../../../src/router/openapi/declared.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAMzD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,OAAO,GACf,oBAAoB,GAAG,SAAS,CAalC;AAED,gGAAgG;AAChG,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAI5E;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAO1E"}

package/dist/router/openapi/declared.js

@@ -0,0 +1,46 @@
+import { matchedRoutes } from 'hono/route';
+import { describeSpecOf } from './document.js';
+/**
+ * What `describeRoute()` declares for the route answering `context`, merged over the handlers registered with it (its
+ * method and path); undefined when it declares nothing. A middleware reads it before the route runs, such as
+ * authentication deciding whether the route accepts a credential. The route is the first one at or after the running
+ * handler that is not a middleware for every method, so a sibling path that also matches (`/agents/{agentId}` beside
+ * `/agents/available`) never lends it its declaration.
+ */
+export function declaredRouteOf(context) {
+    const routes = matchedRoutes(context);
+    let index = context.req.routeIndex;
+    while (index < routes.length && routes[index]?.method === 'ALL')
+        index += 1;
+    const target = routes[index];
+    if (!target)
+        return undefined;
+    let declared;
+    for (const route of routes) {
+        if (route.method !== target.method || route.path !== target.path)
+            continue;
+        const spec = describeSpecOf(route.handler);
+        if (spec)
+            declared = { ...declared, ...spec };
+    }
+    return declared;
+}
+/** Whether the route answering `context` lists `scheme` among its own security requirements. */
+export function routeAcceptsScheme(context, scheme) {
+    const security = declaredRouteOf(context)?.security ?? [];
+    return security.some((requirement) => scheme in requirement);
+}
+/**
+ * The business action the route answering `context` declares in its `x-cli` extension (`cliRoute({ action })`);
+ * undefined when it declares none. A route that accepts an agent's run names the action it performs, and the
+ * application checks the run holds it before the route runs.
+ */
+export function declaredRouteActionOf(context) {
+    const declared = declaredRouteOf(context);
+    const cli = declared?.['x-cli'];
+    if (!cli || typeof cli !== 'object')
+        return undefined;
+    const { action } = cli;
+    return typeof action === 'string' ? action : undefined;
+}
+//# sourceMappingURL=declared.js.map

package/dist/router/openapi/declared.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"declared.js","sourceRoot":"","sources":["../../../src/router/openapi/declared.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC7B,OAAgB;IAEhB,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;IACnC,OAAO,KAAK,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,KAAK;QAAE,KAAK,IAAI,CAAC,CAAC;IAC5E,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,CAAC,MAAM;QAAE,OAAO,SAAS,CAAC;IAC9B,IAAI,QAA0C,CAAC;IAC/C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI;YAAE,SAAS;QAC3E,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,IAAI;YAAE,QAAQ,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,EAAE,CAAC;IAChD,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,kBAAkB,CAAC,OAAgB,EAAE,MAAc;IACjE,MAAM,QAAQ,GACZ,eAAe,CAAC,OAAO,CAAC,EAAE,QAAQ,IAAI,EAAE,CAAC;IAC3C,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,MAAM,IAAI,WAAW,CAAC,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAgB;IACpD,MAAM,QAAQ,GACZ,eAAe,CAAC,OAAO,CAAC,CAAC;IAC3B,MAAM,GAAG,GAAY,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IACtD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAoC,CAAC;IACxD,OAAO,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC"}

package/dist/router/openapi/describe.d.ts

@@ -0,0 +1,82 @@
+import type { StandardSchemaV1 } from '@standard-schema/spec';
+import type { Env, MiddlewareHandler, ValidationTargets } from 'hono';
+import { type ResolverReturnType, type ResponsesWithResolver } from 'hono-openapi';
+import type { InferInput } from 'hono/validator';
+import type { OpenAPIV3_1 } from 'openapi-types';
+import { type ApiErrorResponseCode } from './components.js';
+import { type ApiSchemaDirection } from './schema.js';
+/**
+ * Route metadata for the API document. Plugins take these from `@nocobase/app-server/router` and never import
+ * `hono-openapi` themselves: the metadata is attached to middleware under a symbol that module owns, so a second copy
+ * of it would attach metadata the document generator cannot see.
+ */
+export { describeRoute, type DescribeRouteOptions, type ResolverReturnType, } from 'hono-openapi';
+export type { OpenAPIV3_1 } from 'openapi-types';
+/** One entry of `describeRoute({ responses })`: a response object whose schemas may be `resolver()` results. */
+export type ApiResponseObject = ResponsesWithResolver[string];
+/** A schema a response helper accepts: a Standard Schema such as a zod schema, or an OpenAPI schema or reference. */
+export type ApiSchema = StandardSchemaV1 | OpenAPIV3_1.SchemaObject | OpenAPIV3_1.ReferenceObject;
+type HasUndefined<T> = undefined extends T ? true : false;
+/** The input `apiValidator(target, schema)` adds to a route, so `context.req.valid(target)` is typed by the schema. */
+export interface ApiValidatorInput<Schema extends StandardSchemaV1, Target extends keyof ValidationTargets> {
+    in: HasUndefined<StandardSchemaV1.InferInput<Schema>> extends true ? {
+        [K in Target]?: [StandardSchemaV1.InferInput<Schema>] extends [
+            ValidationTargets[K]
+        ] ? StandardSchemaV1.InferInput<Schema> : InferInput<StandardSchemaV1.InferInput<Schema>, K>;
+    } : {
+        [K in Target]: [StandardSchemaV1.InferInput<Schema>] extends [
+            ValidationTargets[K]
+        ] ? StandardSchemaV1.InferInput<Schema> : InferInput<StandardSchemaV1.InferInput<Schema>, K>;
+    };
+    out: {
+        [K in Target]: StandardSchemaV1.InferOutput<Schema>;
+    };
+}
+export interface ApiValidatorOptions {
+    /** The request media type to document for a `json` or `form` body, when it is not the default. */
+    readonly media?: string;
+}
+/**
+ * A Standard Schema prepared for `describeRoute({ responses })` or `requestBody`, converted under the document's
+ * conventions: definitions become components under stable names, a property keeps its own description next to the
+ * `$ref` of a shared schema, and a response object is open unless the schema is strict. The response helpers use it
+ * already; reach for it only for content they do not cover, such as a streaming media type.
+ */
+export declare function resolver(schema: StandardSchemaV1, direction?: ApiSchemaDirection): ResolverReturnType;
+/**
+ * Validate one part of the request — `param`, `query`, `json`, `header`, `form` or `cookie` — against a Standard Schema
+ * such as a zod schema, and declare that schema in the API document. An invalid request is answered `400
+ * INVALID_ARGUMENT` with reason `INVALID_INPUT`, domain `app`, and a field violation per issue before the handler
+ * runs, exactly as `parseApiInput()` answers; the handler reads the parsed value from `context.req.valid(target)`.
+ * Because of that, the document lists the 400 for invalid input on every route with a validator, without the route
+ * declaring it.
+ *
+ * ```ts
+ * router.post('/orders/:orderId/cancel', describeRoute({ ... }), apiValidator('param', OrderParams), apiValidator('json', CancelOrderInput), handler);
+ * ```
+ */
+export declare function apiValidator<Schema extends StandardSchemaV1, Target extends keyof ValidationTargets, E extends Env = Env, P extends string = string>(target: Target, schema: Schema, options?: ApiValidatorOptions): MiddlewareHandler<E, P, ApiValidatorInput<Schema, Target>>;
+/** A `200`-style JSON response whose body is `{ data }`, `data` being described by `schema`. */
+export declare function dataResponse(schema: ApiSchema, description?: string): ApiResponseObject;
+/**
+ * A JSON list response, `{ data: [...], meta }`. `itemSchema` describes one element; `metaSchema` defaults to the
+ * shared `ApiListMeta` (`total`, `page`, `pageSize`, `nextPageToken`).
+ */
+export declare function listResponse(itemSchema: ApiSchema, metaSchema?: ApiSchema, description?: string): ApiResponseObject;
+/** A response without a body, such as a `204`. */
+export declare function emptyResponse(description?: string): ApiResponseObject;
+/**
+ * The shared error response for one HTTP status, in the standard error body. Without `description` it refers to the
+ * shared component; with one it describes when this route answers that status.
+ */
+export declare function apiErrorResponse(code: ApiErrorResponseCode, description?: string): ApiResponseObject;
+/**
+ * The error responses of an authenticated route that checks a permission: no session or API key, refused permission
+ * and an unexpected failure. Spread them into `responses` and add the route's own, such as `apiErrorResponse(404)`. A
+ * route without a permission check lists `apiErrorResponse(401)` and `apiErrorResponse(500)` instead, and a public one
+ * only `apiErrorResponse(500)`. There is no 400 here: a route with an `apiValidator()` gets the 400 for invalid input
+ * in the document automatically, and lists `apiErrorResponse(400, description)` itself only for another reason, such
+ * as a failed precondition.
+ */
+export declare const apiErrorResponses: Readonly<Record<'401' | '403' | '500', ApiResponseObject>>;
+//# sourceMappingURL=describe.d.ts.map

package/dist/router/openapi/describe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.d.ts","sourceRoot":"","sources":["../../../src/router/openapi/describe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AACtE,OAAO,EAGL,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC3B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAGjD,OAAO,EAEL,KAAK,oBAAoB,EAC1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAEL,KAAK,kBAAkB,EAExB,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,OAAO,EACL,aAAa,EACb,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,GACxB,MAAM,cAAc,CAAC;AACtB,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,gHAAgH;AAChH,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;AAE9D,qHAAqH;AACrH,MAAM,MAAM,SAAS,GACnB,gBAAgB,GAAG,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC,eAAe,CAAC;AAI5E,KAAK,YAAY,CAAC,CAAC,IAAI,SAAS,SAAS,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAE1D,uHAAuH;AACvH,MAAM,WAAW,iBAAiB,CAChC,MAAM,SAAS,gBAAgB,EAC/B,MAAM,SAAS,MAAM,iBAAiB;IAEtC,EAAE,EAAE,YAAY,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS,IAAI,GAC9D;SACG,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS;YAC5D,iBAAiB,CAAC,CAAC,CAAC;SACrB,GACG,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,GACnC,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;KACvD,GACD;SACG,CAAC,IAAI,MAAM,GAAG,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS;YAC3D,iBAAiB,CAAC,CAAC,CAAC;SACrB,GACG,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,GACnC,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;KACvD,CAAC;IACN,GAAG,EAAE;SAAG,CAAC,IAAI,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC;KAAE,CAAC;CAC9D;AAED,MAAM,WAAW,mBAAmB;IAClC,kGAAkG;IAClG,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,gBAAgB,EACxB,SAAS,GAAE,kBAA6B,GACvC,kBAAkB,CAcpB;AAgDD;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAC1B,MAAM,SAAS,gBAAgB,EAC/B,MAAM,SAAS,MAAM,iBAAiB,EACtC,CAAC,SAAS,GAAG,GAAG,GAAG,EACnB,CAAC,SAAS,MAAM,GAAG,MAAM,EAEzB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,mBAAmB,GAC5B,iBAAiB,CAAC,CAAC,EAAE,CAAC,EAAE,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAwB5D;AA0DD,gGAAgG;AAChG,wBAAgB,YAAY,CAC1B,MAAM,EAAE,SAAS,EACjB,WAAW,GAAE,MAAmB,GAC/B,iBAAiB,CAanB;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,UAAU,EAAE,SAAS,EACrB,UAAU,CAAC,EAAE,SAAS,EACtB,WAAW,GAAE,MAAmB,GAC/B,iBAAiB,CAsBnB;AAED,kDAAkD;AAClD,wBAAgB,aAAa,CAC3B,WAAW,GAAE,MAAsB,GAClC,iBAAiB,CAEnB;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,oBAAoB,EAC1B,WAAW,CAAC,EAAE,MAAM,GACnB,iBAAiB,CAYnB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CACtC,MAAM,CAAC,KAAK,GAAG,KAAK,GAAG,KAAK,EAAE,iBAAiB,CAAC,CAKhD,CAAC"}

package/dist/router/openapi/describe.js

@@ -0,0 +1,207 @@
+import { uniqueSymbol, validator, } from 'hono-openapi';
+import { invalidApiInputError } from '../api-error.js';
+import { apiErrorResponseNames, } from './components.js';
+import { convertApiSchema, } from './schema.js';
+/**
+ * Route metadata for the API document. Plugins take these from `@nocobase/app-server/router` and never import
+ * `hono-openapi` themselves: the metadata is attached to middleware under a symbol that module owns, so a second copy
+ * of it would attach metadata the document generator cannot see.
+ */
+export { describeRoute, } from 'hono-openapi';
+/**
+ * A Standard Schema prepared for `describeRoute({ responses })` or `requestBody`, converted under the document's
+ * conventions: definitions become components under stable names, a property keeps its own description next to the
+ * `$ref` of a shared schema, and a response object is open unless the schema is strict. The response helpers use it
+ * already; reach for it only for content they do not cover, such as a streaming media type.
+ */
+export function resolver(schema, direction = 'output') {
+    return {
+        vendor: schema['~standard'].vendor,
+        validate: schema['~standard'].validate,
+        toJSONSchema: async () => (await convertApiSchema(schema, direction)).schema,
+        toOpenAPISchema: async () => {
+            const converted = await convertApiSchema(schema, direction);
+            return {
+                schema: converted.schema,
+                components: converted.components,
+            };
+        },
+    };
+}
+// OpenAPI ignores a header parameter with one of these names: the request body's media type and the accepted ones
+// are described by the operation, and credentials by its security requirements.
+const ignoredHeaderParameters = new Set([
+    'accept',
+    'authorization',
+    'content-type',
+]);
+function withoutIgnoredHeaders(converted) {
+    let schema = converted.schema;
+    const schemas = { ...converted.components?.schemas };
+    const ref = schema.$ref?.startsWith('#/components/schemas/')
+        ? schema.$ref.slice('#/components/schemas/'.length)
+        : undefined;
+    if (ref !== undefined && schemas[ref]) {
+        schema = { ...schemas[ref] };
+        delete schemas[ref];
+    }
+    const properties = Object.entries(schema.properties ?? {}).filter(([name]) => !ignoredHeaderParameters.has(name.toLowerCase()));
+    if (ref === undefined &&
+        properties.length === Object.keys(schema.properties ?? {}).length) {
+        return converted;
+    }
+    const required = schema.required?.filter((name) => !ignoredHeaderParameters.has(name.toLowerCase()));
+    return {
+        schema: {
+            ...schema,
+            properties: Object.fromEntries(properties),
+            ...(required ? { required } : {}),
+        },
+        components: Object.keys(schemas).length > 0
+            ? { ...converted.components, schemas }
+            : undefined,
+    };
+}
+/**
+ * Validate one part of the request — `param`, `query`, `json`, `header`, `form` or `cookie` — against a Standard Schema
+ * such as a zod schema, and declare that schema in the API document. An invalid request is answered `400
+ * INVALID_ARGUMENT` with reason `INVALID_INPUT`, domain `app`, and a field violation per issue before the handler
+ * runs, exactly as `parseApiInput()` answers; the handler reads the parsed value from `context.req.valid(target)`.
+ * Because of that, the document lists the 400 for invalid input on every route with a validator, without the route
+ * declaring it.
+ *
+ * ```ts
+ * router.post('/orders/:orderId/cancel', describeRoute({ ... }), apiValidator('param', OrderParams), apiValidator('json', CancelOrderInput), handler);
+ * ```
+ */
+export function apiValidator(target, schema, options) {
+    const middleware = validator(target, schema, (result) => {
+        if (!result.success)
+            throw invalidApiInputError(result.error);
+    }, options);
+    // Document the schema the way the response helpers do, rather than with hono-openapi's own conversion.
+    const metadata = middleware[uniqueSymbol];
+    const input = resolver(schema, 'input');
+    metadata.toJSONSchema = input.toJSONSchema;
+    metadata.toOpenAPISchema = async () => {
+        const converted = await convertApiSchema(schema, 'input');
+        return target === 'header' ? withoutIgnoredHeaders(converted) : converted;
+    };
+    return middleware;
+}
+function isStandardSchema(schema) {
+    return typeof schema === 'object' && schema !== null && '~standard' in schema;
+}
+async function resolveParts(parts) {
+    const schemas = {};
+    let components;
+    for (const [key, part] of Object.entries(parts)) {
+        if (!isStandardSchema(part)) {
+            schemas[key] = part;
+            continue;
+        }
+        // Responses describe what the server sends, so a schema with a transform documents its output.
+        const result = await convertApiSchema(part, 'output');
+        schemas[key] = result.schema;
+        const collected = { ...result.components?.schemas };
+        if (Object.keys(collected).length > 0) {
+            components = {
+                ...components,
+                schemas: { ...components?.schemas, ...collected },
+            };
+        }
+    }
+    return { schemas, components };
+}
+/**
+ * A `resolver()`-shaped value whose OpenAPI schema is built from several schemas, each a Standard Schema or a plain
+ * OpenAPI schema, resolved when the document is generated.
+ */
+function composeSchema(parts, build) {
+    return {
+        vendor: 'nocobase',
+        validate: (value) => ({ value }),
+        toJSONSchema: async () => build((await resolveParts(parts)).schemas),
+        toOpenAPISchema: async () => {
+            const resolved = await resolveParts(parts);
+            return {
+                schema: build(resolved.schemas),
+                components: resolved.components,
+            };
+        },
+    };
+}
+/** A `200`-style JSON response whose body is `{ data }`, `data` being described by `schema`. */
+export function dataResponse(schema, description = 'Success.') {
+    return {
+        description,
+        content: {
+            'application/json': {
+                schema: composeSchema({ data: schema }, ({ data }) => ({
+                    type: 'object',
+                    required: ['data'],
+                    properties: { data: data },
+                })),
+            },
+        },
+    };
+}
+/**
+ * A JSON list response, `{ data: [...], meta }`. `itemSchema` describes one element; `metaSchema` defaults to the
+ * shared `ApiListMeta` (`total`, `page`, `pageSize`, `nextPageToken`).
+ */
+export function listResponse(itemSchema, metaSchema, description = 'Success.') {
+    return {
+        description,
+        content: {
+            'application/json': {
+                schema: composeSchema({
+                    item: itemSchema,
+                    meta: metaSchema ?? { $ref: '#/components/schemas/ApiListMeta' },
+                }, ({ item, meta }) => ({
+                    type: 'object',
+                    required: ['data', 'meta'],
+                    properties: {
+                        data: { type: 'array', items: item },
+                        meta: meta,
+                    },
+                })),
+            },
+        },
+    };
+}
+/** A response without a body, such as a `204`. */
+export function emptyResponse(description = 'No content.') {
+    return { description };
+}
+/**
+ * The shared error response for one HTTP status, in the standard error body. Without `description` it refers to the
+ * shared component; with one it describes when this route answers that status.
+ */
+export function apiErrorResponse(code, description) {
+    if (description === undefined) {
+        return { $ref: `#/components/responses/${apiErrorResponseNames[code]}` };
+    }
+    return {
+        description,
+        content: {
+            'application/json': {
+                schema: { $ref: '#/components/schemas/ApiErrorBody' },
+            },
+        },
+    };
+}
+/**
+ * The error responses of an authenticated route that checks a permission: no session or API key, refused permission
+ * and an unexpected failure. Spread them into `responses` and add the route's own, such as `apiErrorResponse(404)`. A
+ * route without a permission check lists `apiErrorResponse(401)` and `apiErrorResponse(500)` instead, and a public one
+ * only `apiErrorResponse(500)`. There is no 400 here: a route with an `apiValidator()` gets the 400 for invalid input
+ * in the document automatically, and lists `apiErrorResponse(400, description)` itself only for another reason, such
+ * as a failed precondition.
+ */
+export const apiErrorResponses = Object.freeze({
+    '401': apiErrorResponse(401),
+    '403': apiErrorResponse(403),
+    '500': apiErrorResponse(500),
+});
+//# sourceMappingURL=describe.js.map

package/dist/router/openapi/describe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"describe.js","sourceRoot":"","sources":["../../../src/router/openapi/describe.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,SAAS,GAGV,MAAM,cAAc,CAAC;AAItB,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EACL,qBAAqB,GAEtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,gBAAgB,GAGjB,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,OAAO,EACL,aAAa,GAGd,MAAM,cAAc,CAAC;AA0CtB;;;;;GAKG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAwB,EACxB,YAAgC,QAAQ;IAExC,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM;QAClC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ;QACtC,YAAY,EAAE,KAAK,IAAI,EAAE,CACvB,CAAC,MAAM,gBAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,MAAe;QAC7D,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAC5D,OAAO;gBACL,MAAM,EAAE,SAAS,CAAC,MAAkC;gBACpD,UAAU,EAAE,SAAS,CAAC,UAAU;aACjC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,kHAAkH;AAClH,gFAAgF;AAChF,MAAM,uBAAuB,GAAG,IAAI,GAAG,CAAC;IACtC,QAAQ;IACR,eAAe;IACf,cAAc;CACf,CAAC,CAAC;AAEH,SAAS,qBAAqB,CAC5B,SAA6B;IAE7B,IAAI,MAAM,GAAG,SAAS,CAAC,MACe,CAAC;IACvC,MAAM,OAAO,GAAG,EAAE,GAAG,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;IACrD,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,uBAAuB,CAAC;QAC1D,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,MAAM,CAAC;QACnD,CAAC,CAAC,SAAS,CAAC;IACd,IAAI,GAAG,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QACtC,MAAM,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;IACtB,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,CAC/D,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,uBAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAC7D,CAAC;IACF,IACE,GAAG,KAAK,SAAS;QACjB,UAAU,CAAC,MAAM,KAAK,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,EACjE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE,MAAM,CACtC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,uBAAuB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAC3D,CAAC;IACF,OAAO;QACL,MAAM,EAAE;YACN,GAAG,MAAM;YACT,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC;YAC1C,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClC;QACD,UAAU,EACR,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC;YAC7B,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE;YACtC,CAAC,CAAC,SAAS;KAChB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,YAAY,CAM1B,MAAc,EACd,MAAc,EACd,OAA6B;IAE7B,MAAM,UAAU,GAAG,SAAS,CAC1B,MAAM,EACN,MAAM,EACN,CAAC,MAAM,EAAE,EAAE;QACT,IAAI,CAAC,MAAM,CAAC,OAAO;YAAE,MAAM,oBAAoB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAChE,CAAC,EACD,OAAO,CACR,CAAC;IACF,uGAAuG;IACvG,MAAM,QAAQ,GACZ,UACD,CAAC,YAAY,CAAC,CAAC;IAChB,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,QAAQ,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;IAC3C,QAAQ,CAAC,eAAe,GAAG,KAAK,IAAI,EAAE;QACpC,MAAM,SAAS,GAAG,MAAM,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5E,CAAC,CAAC;IACF,OAAO,UAIN,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAiB;IACzC,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,WAAW,IAAI,MAAM,CAAC;AAChF,CAAC;AAOD,KAAK,UAAU,YAAY,CACzB,KAA0C;IAE1C,MAAM,OAAO,GAAgC,EAAE,CAAC;IAChD,IAAI,UAAoD,CAAC;IACzD,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAChD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;YACpB,SAAS;QACX,CAAC;QACD,+FAA+F;QAC/F,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtD,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,MAAM,SAAS,GAAG,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC;QACpD,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtC,UAAU,GAAG;gBACX,GAAG,UAAU;gBACb,OAAO,EAAE,EAAE,GAAG,UAAU,EAAE,OAAO,EAAE,GAAG,SAAS,EAAE;aAClD,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CACpB,KAA0C,EAC1C,KAAsE;IAEtE,OAAO;QACL,MAAM,EAAE,UAAU;QAClB,QAAQ,EAAE,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;QACzC,YAAY,EAAE,KAAK,IAAI,EAAE,CACvB,KAAK,CAAC,CAAC,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAU;QACrD,eAAe,EAAE,KAAK,IAAI,EAAE;YAC1B,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,CAAC;YAC3C,OAAO;gBACL,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,OAAO,CAA6B;gBAC3D,UAAU,EAAE,QAAQ,CAAC,UAAU;aAChC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,YAAY,CAC1B,MAAiB,EACjB,cAAsB,UAAU;IAEhC,OAAO;QACL,WAAW;QACX,OAAO,EAAE;YACP,kBAAkB,EAAE;gBAClB,MAAM,EAAE,aAAa,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;oBACrD,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,CAAC,MAAM,CAAC;oBAClB,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;iBAC3B,CAAC,CAAC;aACJ;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAC1B,UAAqB,EACrB,UAAsB,EACtB,cAAsB,UAAU;IAEhC,OAAO;QACL,WAAW;QACX,OAAO,EAAE;YACP,kBAAkB,EAAE;gBAClB,MAAM,EAAE,aAAa,CACnB;oBACE,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,UAAU,IAAI,EAAE,IAAI,EAAE,kCAAkC,EAAE;iBACjE,EACD,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;oBACnB,IAAI,EAAE,QAAQ;oBACd,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;oBAC1B,UAAU,EAAE;wBACV,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE;wBACpC,IAAI,EAAE,IAAI;qBACX;iBACF,CAAC,CACH;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,aAAa,CAC3B,cAAsB,aAAa;IAEnC,OAAO,EAAE,WAAW,EAAE,CAAC;AACzB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAA0B,EAC1B,WAAoB;IAEpB,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,EAAE,IAAI,EAAE,0BAA0B,qBAAqB,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;IAC3E,CAAC;IACD,OAAO;QACL,WAAW;QACX,OAAO,EAAE;YACP,kBAAkB,EAAE;gBAClB,MAAM,EAAE,EAAE,IAAI,EAAE,mCAAmC,EAAE;aACtD;SACF;KACF,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAE1B,MAAM,CAAC,MAAM,CAAC;IAChB,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC;IAC5B,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC;IAC5B,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC;CAC7B,CAAC,CAAC"}

package/dist/router/openapi/docs-routes.d.ts

@@ -0,0 +1,10 @@
+import { Hono } from 'hono';
+import type { ApiDocsService } from './service.js';
+/** The Swagger UI files the page loads, with their content types. The build copies exactly these into `dist/swagger-ui`. */
+export declare const swaggerUiAssets: Readonly<Record<string, string>>;
+/**
+ * `GET /swagger` (the OpenAPI document), `GET /swagger/docs` (Swagger UI) and the page's files, mounted under `/api`.
+ * Every one is hidden from the document it serves and guarded by the service's access checks.
+ */
+export declare function createApiDocsRouter(service: ApiDocsService): Hono;
+//# sourceMappingURL=docs-routes.d.ts.map

package/dist/router/openapi/docs-routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-routes.d.ts","sourceRoot":"","sources":["../../../src/router/openapi/docs-routes.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,IAAI,EAA0B,MAAM,MAAM,CAAC;AAUpD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEnD,4HAA4H;AAC5H,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAK3D,CAAC;AAkGH;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,CA8DjE"}