@spinajs/http-swagger 2.0.471 → 2.0.472

package/lib/mjs/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oCAAoC,CAAC;AACnD,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}

package/lib/mjs/index.js

@@ -0,0 +1,7 @@
+export * from './interfaces.js';
+export * from './swagger-cache.js';
+export * from './swagger-service.js';
+export * from './controllers/SwaggerController.js';
+export * from './openapi-builder.js';
+export * from './cli/GenerateSwaggerCache.js';
+//# sourceMappingURL=index.js.map

package/lib/mjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oCAAoC,CAAC;AACnD,cAAc,sBAAsB,CAAC;AACrC,cAAc,+BAA+B,CAAC"}

package/lib/mjs/interfaces.d.ts

@@ -0,0 +1,211 @@
+/**
+ * Configuration for Swagger/OpenAPI documentation generation.
+ * Read from application configuration at path `http.swagger`
+ */
+export interface ISwaggerConfig {
+    enabled: boolean;
+    title: string;
+    version: string;
+    description?: string;
+    basePath?: string;
+    servers?: ISwaggerServer[];
+    securitySchemes?: Record<string, ISecurityScheme>;
+    security?: Record<string, string[]>[];
+    ui?: ISwaggerUiConfig;
+}
+/**
+ * Configuration for Swagger UI rendering
+ */
+export interface ISwaggerUiConfig {
+    /**
+     * URL to swagger-ui CSS file
+     */
+    cssUrl: string;
+    /**
+     * URL to swagger-ui-bundle.js
+     */
+    bundleUrl: string;
+    /**
+     * URL to swagger-ui-standalone-preset.js
+     */
+    presetUrl: string;
+    /**
+     * URL to the OpenAPI JSON spec endpoint (used by Swagger UI to load the spec)
+     */
+    specUrl: string;
+    /**
+     * Custom page title for the Swagger UI page
+     */
+    pageTitle?: string;
+}
+export interface ISwaggerServer {
+    url: string;
+    description?: string;
+}
+export interface ISecurityScheme {
+    type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+    scheme?: string;
+    bearerFormat?: string;
+    name?: string;
+    in?: 'query' | 'header' | 'cookie';
+    description?: string;
+}
+/**
+ * JSDoc documentation extracted from a controller method
+ */
+export interface IMethodDocumentation {
+    summary?: string;
+    description?: string;
+    params: Record<string, IParamDocumentation>;
+    returns?: IReturnDocumentation;
+    responses?: Record<string, IResponseDocumentation>;
+    examples?: IExampleDocumentation[];
+    tags?: string[];
+    deprecated?: boolean;
+    security?: Array<Record<string, string[]>>;
+}
+export interface IParamDocumentation {
+    name: string;
+    description?: string;
+    type?: string;
+    required?: boolean;
+}
+export interface IReturnDocumentation {
+    description?: string;
+    type?: string;
+    schema?: IOpenApiSchema;
+}
+export interface IResponseDocumentation {
+    description: string;
+    type?: string;
+}
+export interface IExampleDocumentation {
+    name?: string;
+    description?: string;
+    value?: string;
+}
+/** JSDoc-extracted documentation for a policy class */
+export interface IPolicyDocumentation {
+    /** File where the policy is defined (for traceability) */
+    file?: string;
+    /** Class-level JSDoc description, if present */
+    description?: string;
+}
+/**
+ * Cache entry for a single controller's JSDoc documentation
+ */
+export interface ISwaggerCacheEntry {
+    className: string;
+    classDescription?: string;
+    classTags?: string[];
+    methods: Record<string, IMethodDocumentation>;
+    /** Controller-level policies (applied to every route on the controller) */
+    controllerPolicies?: string[];
+    /** Per-route policy class names */
+    routePolicies?: Record<string, string[]>;
+    /** Docs for each referenced policy class, keyed by class name */
+    policies?: Record<string, IPolicyDocumentation>;
+}
+/**
+ * OpenAPI 3.0 document structure
+ */
+export interface IOpenApiDocument {
+    openapi: string;
+    info: IOpenApiInfo;
+    servers?: IOpenApiServer[];
+    paths: Record<string, IOpenApiPathItem>;
+    components?: IOpenApiComponents;
+    security?: Record<string, string[]>[];
+    tags?: IOpenApiTag[];
+}
+export interface IOpenApiInfo {
+    title: string;
+    version: string;
+    description?: string;
+}
+export interface IOpenApiServer {
+    url: string;
+    description?: string;
+}
+export interface IOpenApiTag {
+    name: string;
+    description?: string;
+}
+export interface IOpenApiPathItem {
+    [method: string]: IOpenApiOperation;
+}
+export interface IOpenApiOperation {
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    deprecated?: boolean;
+    parameters?: IOpenApiParameter[];
+    requestBody?: IOpenApiRequestBody;
+    responses: Record<string, IOpenApiResponse>;
+    security?: Record<string, string[]>[];
+    /** RBAC resource name (from rbac-http @Resource) */
+    'x-rbac-resource'?: string;
+    /**
+     * Permissions accepted for this route (accesscontrol actions:
+     * readAny|readOwn|updateAny|updateOwn|createAny|createOwn|deleteAny|deleteOwn).
+     * Access is granted if the caller's role(s) have at least one.
+     */
+    'x-rbac-permissions'?: string[];
+    /** Policy class names applied to this route (controller-level + route-level, in execution order) */
+    'x-policies'?: string[];
+}
+export interface IOpenApiParameter {
+    name: string;
+    in: 'query' | 'path' | 'header' | 'cookie';
+    description?: string;
+    required?: boolean;
+    schema?: IOpenApiSchema;
+    style?: string;
+    explode?: boolean;
+}
+export interface IOpenApiRequestBody {
+    description?: string;
+    required?: boolean;
+    content: Record<string, IOpenApiMediaType>;
+}
+export interface IOpenApiMediaType {
+    schema?: IOpenApiSchema;
+    examples?: Record<string, IOpenApiExample>;
+}
+export interface IOpenApiExample {
+    summary?: string;
+    description?: string;
+    value?: any;
+}
+export interface IOpenApiResponse {
+    description?: string;
+    content?: Record<string, IOpenApiMediaType>;
+    $ref?: string;
+}
+export interface IOpenApiSchema {
+    type?: string;
+    format?: string;
+    items?: IOpenApiSchema;
+    properties?: Record<string, IOpenApiSchema>;
+    required?: string[];
+    $ref?: string;
+    description?: string;
+    enum?: any[];
+    minimum?: number;
+    maximum?: number;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    nullable?: boolean;
+    oneOf?: IOpenApiSchema[];
+    anyOf?: IOpenApiSchema[];
+    allOf?: IOpenApiSchema[];
+    example?: unknown;
+}
+export interface IOpenApiComponents {
+    schemas?: Record<string, IOpenApiSchema>;
+    securitySchemes?: Record<string, ISecurityScheme>;
+    responses?: Record<string, IOpenApiResponse>;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/lib/mjs/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACtC,EAAE,CAAC,EAAE,gBAAgB,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,CAAC;IACrD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC5C,OAAO,CAAC,EAAE,oBAAoB,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;IACnD,QAAQ,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACnC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,uDAAuD;AACvD,MAAM,WAAW,oBAAoB;IACnC,0DAA0D;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAC9C,2EAA2E;IAC3E,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,mCAAmC;IACnC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACzC,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACtC,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,MAAM,EAAE,MAAM,GAAG,iBAAiB,CAAC;CACrC;AAED,MAAM,WAAW,iBAAiB;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACjC,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACtC,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,oGAAoG;IACpG,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAClD,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CAC9C"}

package/lib/mjs/interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=interfaces.js.map

package/lib/mjs/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../src/interfaces.ts"],"names":[],"mappings":""}

package/lib/mjs/openapi-builder.d.ts

@@ -0,0 +1,153 @@
+import { ClassInfo } from '@spinajs/di';
+import { BaseController } from '@spinajs/http';
+import { IOpenApiDocument, ISwaggerCacheEntry, ISwaggerConfig } from './interfaces.js';
+export declare class OpenApiBuilder {
+    private config;
+    private document;
+    private tags;
+    private registeredResponses;
+    private errorSchemaRegistered;
+    private registeredPolicies;
+    private policySectionEntries;
+    private infoDescriptionBase;
+    constructor(config: ISwaggerConfig);
+    /**
+     * Add a controller's routes to the OpenAPI document.
+     */
+    addController(controller: ClassInfo<BaseController>, docCache: ISwaggerCacheEntry): void;
+    /**
+     * Surface policy information on an operation:
+     *   - merge controller-level and route-level policies (controller policies run first)
+     *   - vendor extension `x-policies` for tooling
+     *   - human-readable line appended to `description`; each policy links to the
+     *     reusable "Policies" section appended to `info.description`
+     *
+     * The JSDoc descriptions for each unique policy are registered once on the
+     * document via `registerPolicyReference()`.
+     */
+    private applyPolicies;
+    /**
+     * Lazily register a policy in the document-level "Policies" section.
+     * OpenAPI 3.0 has no first-class "policies" components bucket, so we render
+     * them into `info.description` as a markdown anchor that Swagger UI can
+     * link to from operation descriptions.
+     */
+    private registerPolicyReference;
+    private policyAnchor;
+    private firstSentence;
+    /**
+     * Read rbac-http's controller descriptor via the global metadata symbol.
+     * Returns undefined when the controller isn't RBAC-decorated.
+     */
+    private readRbacDescriptor;
+    /**
+     * Attach RBAC info to an operation:
+     *   - vendor extensions `x-rbac-resource` and `x-rbac-permissions` for
+     *     tooling / code-gen consumers
+     *   - a human-readable line appended to the description for Swagger UI
+     */
+    private applyRbac;
+    /**
+     * Build the final OpenAPI document.
+     */
+    build(): IOpenApiDocument;
+    /**
+     * Build the full URL path for a route.
+     */
+    private buildPath;
+    /**
+     * Map SpineJS RouteType to OpenAPI HTTP method string.
+     */
+    private mapRouteType;
+    /**
+     * Build an OpenAPI operation from a route and its documentation.
+     */
+    private buildOperation;
+    /**
+     * Describe the JSON filter envelope used by orm-http's @Filter decorator.
+     *
+     * @Filter accepts either:
+     *   - a Model constructor — @Filterable on its columns stores the filterable
+     *     column map on the model descriptor (Reflect metadata under
+     *     Symbol.for('MODEL_DESCRIPTOR')) at class-load time. We read it directly
+     *     so the schema is available even before orm-http's runtime mixin attaches.
+     *   - an IColumnFilter[] — we build the same envelope shape inline from the
+     *     column descriptors.
+     *
+     * Both cases produce the same { op, filters: [...] } envelope as the runtime
+     * builder in packages/orm-http/src/{model.ts,route-arg.ts}.
+     */
+    private buildFilterSchema;
+    /**
+     * Read the FilterableColumns map from a model constructor via the orm model
+     * descriptor metadata. Keeps http-swagger free of a hard @spinajs/orm dep —
+     * the symbol is global (`Symbol.for('MODEL_DESCRIPTOR')`).
+     */
+    private extractFilterableColumns;
+    /**
+     * Build the { op, filters: [...] } envelope schema given a list of filterable columns.
+     *
+     * OAS 3.0.3 (the doc version we emit) does NOT support multi-type arrays for
+     * `type` — that's an OAS 3.1 feature. Swagger UI renders such schemas as
+     * "Unknown Type: ...". We emit `oneOf` for the Value union and single-typed
+     * sub-schemas for everything else.
+     */
+    private filterEnvelopeSchema;
+    /**
+     * Resolve the effective OpenAPI location for orm-http's @FromModel param.
+     * Mirrors FromDbModel.extract(): paramType decides where the PK is read from
+     * (defaults to path/req.params).
+     */
+    private fromDbModelLocation;
+    /**
+     * Build an OpenAPI parameter from route parameter info.
+     */
+    private buildParameter;
+    /**
+     * Resolve the best schema for a route parameter.
+     * Priority: JSDoc type → decorator schema (param.Schema) → auto-detected primitive (param.RouteParamSchema) → @Schema metadata on DTO class → runtime type inference
+     */
+    private schemaFromParam;
+    /**
+     * Convert a JSON Schema object to an OpenAPI schema, mapping known keywords.
+     */
+    private convertJsonSchema;
+    /**
+     * Build an OpenAPI request body from body-type parameters.
+     */
+    private buildRequestBody;
+    /**
+     * Build response definitions from JSDoc @returns and @response tags.
+     * Only responses explicitly documented in JSDoc are included.
+     */
+    private buildResponses;
+    /**
+     * Lazily register a reusable response component for a standard HTTP status
+     * code (e.g. 401 → `#/components/responses/Unauthorized`) and the shared
+     * Error schema. Returns the component name to $ref, or undefined if the code
+     * isn't in our standard set.
+     *
+     * JSDoc description overrides the default; first JSDoc description wins per
+     * status code so the component stays stable across operations.
+     */
+    private registerStandardResponse;
+    /**
+     * Register the shared Error schema once. Matches the runtime error envelope
+     * built in packages/http/src/error.ts (spread of the Error instance + message,
+     * with optional stack in dev).
+     */
+    private ensureErrorSchema;
+    /**
+     * Infer an OpenAPI schema from a TypeScript runtime type.
+     */
+    private inferSchema;
+    /**
+     * Infer schema from a JSDoc type string like {string}, {number}, {MyDto}
+     */
+    private inferSchemaFromString;
+    /**
+     * Try to parse a string as JSON, return as-is if not valid JSON.
+     */
+    private tryParseJson;
+}
+//# sourceMappingURL=openapi-builder.d.ts.map

package/lib/mjs/openapi-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-builder.d.ts","sourceRoot":"","sources":["../../src/openapi-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAc,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,cAAc,EAAqD,MAAM,eAAe,CAAC;AAElG,OAAO,EACL,gBAAgB,EAOhB,kBAAkB,EAClB,cAAc,EAEf,MAAM,iBAAiB,CAAC;AA6FzB,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,QAAQ,CAAmB;IACnC,OAAO,CAAC,IAAI,CAAuC;IACnD,OAAO,CAAC,mBAAmB,CAA0B;IACrD,OAAO,CAAC,qBAAqB,CAAS;IACtC,OAAO,CAAC,kBAAkB,CAA0B;IACpD,OAAO,CAAC,oBAAoB,CAAgB;IAC5C,OAAO,CAAC,mBAAmB,CAAc;gBAE7B,MAAM,EAAE,cAAc;IA2BlC;;OAEG;IACI,aAAa,CAClB,UAAU,EAAE,SAAS,CAAC,cAAc,CAAC,EACrC,QAAQ,EAAE,kBAAkB,GAC3B,IAAI;IAgDP;;;;;;;;;OASG;IACH,OAAO,CAAC,aAAa;IAqBrB;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,aAAa;IAMrB;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA8B1B;;;;;OAKG;IACH,OAAO,CAAC,SAAS;IAqBjB;;OAEG;IACI,KAAK,IAAI,gBAAgB;IAKhC;;OAEG;IACH,OAAO,CAAC,SAAS;IAuBjB;;OAEG;IACH,OAAO,CAAC,YAAY;IAoBpB;;OAEG;IACH,OAAO,CAAC,cAAc;IA4FtB;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,iBAAiB;IAuCzB;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;IAkBhC;;;;;;;OAOG;IACH,OAAO,CAAC,oBAAoB;IAsC5B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAqB3B;;OAEG;IACH,OAAO,CAAC,cAAc;IAmBtB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAsCvB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IA8DzB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAgDxB;;;OAGG;IACH,OAAO,CAAC,cAAc;IA2CtB;;;;;;;;OAQG;IACH,OAAO,CAAC,wBAAwB;IAqBhC;;;;OAIG;IACH,OAAO,CAAC,iBAAiB;IAmBzB;;OAEG;IACH,OAAO,CAAC,WAAW;IAwBnB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAqB7B;;OAEG;IACH,OAAO,CAAC,YAAY;CAQrB"}