@buenojs/bueno 0.8.10 → 0.8.11

package/dist/openapi/document-builder.d.ts

@@ -0,0 +1,82 @@
+/**
+ * OpenAPI Document Builder
+ *
+ * Fluent API for building OpenAPI 3.1 documents with configuration for
+ * servers, security schemes, tags, and other top-level metadata.
+ */
+import type { ApiKeySecurityOptions, OpenAPIDocument, SecuritySchemeOptions } from './types';
+/**
+ * DocumentBuilder - Fluent API for constructing OpenAPI documents
+ *
+ * @example
+ * ```typescript
+ * const document = new DocumentBuilder()
+ *   .setTitle('My API')
+ *   .setVersion('1.0.0')
+ *   .setDescription('API description')
+ *   .addBearerAuth()
+ *   .addTag('users', 'User management endpoints')
+ *   .build();
+ * ```
+ */
+export declare class DocumentBuilder {
+    private document;
+    /**
+     * Set the API title
+     */
+    setTitle(title: string): this;
+    /**
+     * Set the API description
+     */
+    setDescription(description: string): this;
+    /**
+     * Set the API version
+     */
+    setVersion(version: string): this;
+    /**
+     * Set contact information
+     */
+    setContact(name: string, url?: string, email?: string): this;
+    /**
+     * Set license information
+     */
+    setLicense(name: string, url?: string): this;
+    /**
+     * Add a server
+     */
+    addServer(url: string, description?: string): this;
+    /**
+     * Add Bearer token authentication
+     *
+     * @example
+     * ```typescript
+     * builder.addBearerAuth('JWT')
+     * ```
+     */
+    addBearerAuth(name?: string, options?: SecuritySchemeOptions): this;
+    /**
+     * Add Basic authentication
+     */
+    addBasicAuth(name?: string, options?: SecuritySchemeOptions): this;
+    /**
+     * Add API Key authentication
+     */
+    addApiKey(options: ApiKeySecurityOptions, name?: string): this;
+    /**
+     * Add an OAuth2 security scheme
+     */
+    addOAuth2(name: string, authorizationUrl: string, tokenUrl?: string, refreshUrl?: string): this;
+    /**
+     * Add an OpenID Connect security scheme
+     */
+    addOpenIdConnect(name: string, url: string): this;
+    /**
+     * Add a tag for organizing operations
+     */
+    addTag(name: string, description?: string): this;
+    /**
+     * Build and return the final OpenAPI document
+     */
+    build(): OpenAPIDocument;
+}
+//# sourceMappingURL=document-builder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"document-builder.d.ts","sourceRoot":"","sources":["../../src/openapi/document-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACX,qBAAqB,EAErB,eAAe,EAIf,qBAAqB,EACrB,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;;GAaG;AACH,qBAAa,eAAe;IAC3B,OAAO,CAAC,QAAQ,CAYd;IAEF;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAS7B;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IASzC;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IASjC;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAQ5D;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;IAQ5C;;OAEG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI;IAQlD;;;;;;;OAOG;IACH,aAAa,CACZ,IAAI,SAAW,EACf,OAAO,CAAC,EAAE,qBAAqB,GAC7B,IAAI;IAsBP;;OAEG;IACH,YAAY,CAAC,IAAI,SAAU,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAqBnE;;OAEG;IACH,SAAS,CACR,OAAO,EAAE,qBAAqB,EAC9B,IAAI,SAAY,GACd,IAAI;IAsBP;;OAEG;IACH,SAAS,CACR,IAAI,EAAE,MAAM,EACZ,gBAAgB,EAAE,MAAM,EACxB,QAAQ,CAAC,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,MAAM,GACjB,IAAI;IAuBP;;OAEG;IACH,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAgBjD;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI;IAchD;;OAEG;IACH,KAAK,IAAI,eAAe;CAGxB"}

package/dist/openapi/document-builder.js

@@ -0,0 +1,228 @@
+/**
+ * OpenAPI Document Builder
+ *
+ * Fluent API for building OpenAPI 3.1 documents with configuration for
+ * servers, security schemes, tags, and other top-level metadata.
+ */
+/**
+ * DocumentBuilder - Fluent API for constructing OpenAPI documents
+ *
+ * @example
+ * ```typescript
+ * const document = new DocumentBuilder()
+ *   .setTitle('My API')
+ *   .setVersion('1.0.0')
+ *   .setDescription('API description')
+ *   .addBearerAuth()
+ *   .addTag('users', 'User management endpoints')
+ *   .build();
+ * ```
+ */
+export class DocumentBuilder {
+    document = {
+        openapi: '3.1.0',
+        info: {
+            title: 'API',
+            version: '1.0.0',
+        },
+        paths: {},
+        components: {
+            schemas: {},
+            securitySchemes: {},
+        },
+        tags: [],
+    };
+    /**
+     * Set the API title
+     */
+    setTitle(title) {
+        if (!this.document.info) {
+            this.document.info = { title, version: '1.0.0' };
+        }
+        else {
+            this.document.info.title = title;
+        }
+        return this;
+    }
+    /**
+     * Set the API description
+     */
+    setDescription(description) {
+        if (!this.document.info) {
+            this.document.info = { title: 'API', version: '1.0.0', description };
+        }
+        else {
+            this.document.info.description = description;
+        }
+        return this;
+    }
+    /**
+     * Set the API version
+     */
+    setVersion(version) {
+        if (!this.document.info) {
+            this.document.info = { title: 'API', version };
+        }
+        else {
+            this.document.info.version = version;
+        }
+        return this;
+    }
+    /**
+     * Set contact information
+     */
+    setContact(name, url, email) {
+        if (!this.document.info) {
+            this.document.info = { title: 'API', version: '1.0.0' };
+        }
+        this.document.info.contact = { name, url, email };
+        return this;
+    }
+    /**
+     * Set license information
+     */
+    setLicense(name, url) {
+        if (!this.document.info) {
+            this.document.info = { title: 'API', version: '1.0.0' };
+        }
+        this.document.info.license = { name, url };
+        return this;
+    }
+    /**
+     * Add a server
+     */
+    addServer(url, description) {
+        if (!this.document.servers) {
+            this.document.servers = [];
+        }
+        this.document.servers.push({ url, description });
+        return this;
+    }
+    /**
+     * Add Bearer token authentication
+     *
+     * @example
+     * ```typescript
+     * builder.addBearerAuth('JWT')
+     * ```
+     */
+    addBearerAuth(name = 'bearer', options) {
+        if (!this.document.components) {
+            this.document.components = { schemas: {}, securitySchemes: {} };
+        }
+        if (!this.document.components.securitySchemes) {
+            this.document.components.securitySchemes = {};
+        }
+        const scheme = {
+            type: 'http',
+            scheme: 'bearer',
+            bearerFormat: options?.bearerFormat ?? 'JWT',
+        };
+        if (options?.description) {
+            scheme.description = options.description;
+        }
+        this.document.components.securitySchemes[name] = scheme;
+        return this;
+    }
+    /**
+     * Add Basic authentication
+     */
+    addBasicAuth(name = 'basic', options) {
+        if (!this.document.components) {
+            this.document.components = { schemas: {}, securitySchemes: {} };
+        }
+        if (!this.document.components.securitySchemes) {
+            this.document.components.securitySchemes = {};
+        }
+        const scheme = {
+            type: 'http',
+            scheme: 'basic',
+        };
+        if (options?.description) {
+            scheme.description = options.description;
+        }
+        this.document.components.securitySchemes[name] = scheme;
+        return this;
+    }
+    /**
+     * Add API Key authentication
+     */
+    addApiKey(options, name = 'api_key') {
+        if (!this.document.components) {
+            this.document.components = { schemas: {}, securitySchemes: {} };
+        }
+        if (!this.document.components.securitySchemes) {
+            this.document.components.securitySchemes = {};
+        }
+        const scheme = {
+            type: 'apiKey',
+            name: options.name,
+            in: options.in,
+        };
+        if (options.description) {
+            scheme.description = options.description;
+        }
+        this.document.components.securitySchemes[name] = scheme;
+        return this;
+    }
+    /**
+     * Add an OAuth2 security scheme
+     */
+    addOAuth2(name, authorizationUrl, tokenUrl, refreshUrl) {
+        if (!this.document.components) {
+            this.document.components = { schemas: {}, securitySchemes: {} };
+        }
+        if (!this.document.components.securitySchemes) {
+            this.document.components.securitySchemes = {};
+        }
+        this.document.components.securitySchemes[name] = {
+            type: 'oauth2',
+            flows: {
+                authorizationCode: {
+                    authorizationUrl,
+                    tokenUrl: tokenUrl || '',
+                    refreshUrl,
+                    scopes: {},
+                },
+            },
+        };
+        return this;
+    }
+    /**
+     * Add an OpenID Connect security scheme
+     */
+    addOpenIdConnect(name, url) {
+        if (!this.document.components) {
+            this.document.components = { schemas: {}, securitySchemes: {} };
+        }
+        if (!this.document.components.securitySchemes) {
+            this.document.components.securitySchemes = {};
+        }
+        this.document.components.securitySchemes[name] = {
+            type: 'openIdConnect',
+            openIdConnectUrl: url,
+        };
+        return this;
+    }
+    /**
+     * Add a tag for organizing operations
+     */
+    addTag(name, description) {
+        if (!this.document.tags) {
+            this.document.tags = [];
+        }
+        const tag = { name };
+        if (description) {
+            tag.description = description;
+        }
+        this.document.tags.push(tag);
+        return this;
+    }
+    /**
+     * Build and return the final OpenAPI document
+     */
+    build() {
+        return this.document;
+    }
+}
+//# sourceMappingURL=document-builder.js.map

package/dist/openapi/document-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-builder.js","sourceRoot":"","sources":["../../src/openapi/document-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAYH;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,eAAe;IACnB,QAAQ,GAA6B;QAC5C,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACL,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,OAAO;SAChB;QACD,KAAK,EAAE,EAAE;QACT,UAAU,EAAE;YACX,OAAO,EAAE,EAAE;YACX,eAAe,EAAE,EAAE;SACnB;QACD,IAAI,EAAE,EAAE;KACR,CAAC;IAEF;;OAEG;IACH,QAAQ,CAAC,KAAa;QACrB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QAClD,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAClC,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,cAAc,CAAC,WAAmB;QACjC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;QACtE,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC9C,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,OAAe;QACzB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;QAChD,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,IAAY,EAAE,GAAY,EAAE,KAAc;QACpD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAClD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,IAAY,EAAE,GAAY;QACpC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;QACzD,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,SAAS,CAAC,GAAW,EAAE,WAAoB;QAC1C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YAC5B,IAAI,CAAC,QAAQ,CAAC,OAAO,GAAG,EAAE,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACH,aAAa,CACZ,IAAI,GAAG,QAAQ,EACf,OAA+B;QAE/B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YAC/C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,GAAG,EAAE,CAAC;QAC/C,CAAC;QAED,MAAM,MAAM,GAA0B;YACrC,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,QAAQ;YAChB,YAAY,EAAE,OAAO,EAAE,YAAY,IAAI,KAAK;SAC5C,CAAC;QAEF,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;YAC1B,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,IAAI,GAAG,OAAO,EAAE,OAA+B;QAC3D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YAC/C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,GAAG,EAAE,CAAC;QAC/C,CAAC;QAED,MAAM,MAAM,GAA0B;YACrC,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,OAAO;SACf,CAAC;QAEF,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;YAC1B,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,SAAS,CACR,OAA8B,EAC9B,IAAI,GAAG,SAAS;QAEhB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YAC/C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,GAAG,EAAE,CAAC;QAC/C,CAAC;QAED,MAAM,MAAM,GAA0B;YACrC,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,EAAE,EAAE,OAAO,CAAC,EAAE;SACd,CAAC;QAEF,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACzB,MAAM,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QAC1C,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QACxD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,SAAS,CACR,IAAY,EACZ,gBAAwB,EACxB,QAAiB,EACjB,UAAmB;QAEnB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YAC/C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,GAAG,EAAE,CAAC;QAC/C,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG;YAChD,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE;gBACN,iBAAiB,EAAE;oBAClB,gBAAgB;oBAChB,QAAQ,EAAE,QAAQ,IAAI,EAAE;oBACxB,UAAU;oBACV,MAAM,EAAE,EAAE;iBACV;aACD;SACD,CAAC;QAEF,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,IAAY,EAAE,GAAW;QACzC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC;QACjE,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YAC/C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,GAAG,EAAE,CAAC;QAC/C,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG;YAChD,IAAI,EAAE,eAAe;YACrB,gBAAgB,EAAE,GAAG;SACrB,CAAC;QAEF,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,IAAY,EAAE,WAAoB;QACxC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,EAAE,CAAC;QACzB,CAAC;QAED,MAAM,GAAG,GAAe,EAAE,IAAI,EAAE,CAAC;QACjC,IAAI,WAAW,EAAE,CAAC;YACjB,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,KAAK;QACJ,OAAO,IAAI,CAAC,QAA2B,CAAC;IACzC,CAAC;CACD"}

package/dist/openapi/index.d.ts

@@ -0,0 +1,48 @@
+/**
+ * OpenAPI Module
+ *
+ * Auto-generate OpenAPI 3.1 specifications from Bueno controllers and decorators.
+ * Provides decorators for documenting API endpoints and a SwaggerModule for setup.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   DocumentBuilder,
+ *   SwaggerModule,
+ *   ApiOperation,
+ *   ApiResponse,
+ *   ApiTags,
+ * } from '@buenojs/bueno/openapi';
+ *
+ * // 1. Document your controller
+ * @Controller('/users')
+ * @ApiTags('users')
+ * class UsersController {
+ *   @Get()
+ *   @ApiOperation({ summary: 'List all users' })
+ *   @ApiResponse({ status: 200, description: 'Success', type: [User] })
+ *   async getAll() { ... }
+ * }
+ *
+ * // 2. Create OpenAPI document
+ * const config = new DocumentBuilder()
+ *   .setTitle('My API')
+ *   .setVersion('1.0.0')
+ *   .addBearerAuth()
+ *   .build();
+ *
+ * const document = SwaggerModule.createDocument(app, config, [UsersController]);
+ *
+ * // 3. Setup Swagger UI
+ * SwaggerModule.setup('/api-docs', app, document);
+ * ```
+ */
+export type { OpenAPIDocument, OpenAPIInfo, OpenAPIContact, OpenAPILicense, OpenAPIServer, OpenAPIPaths, OpenAPIPath, OpenAPIOperation, OpenAPIExternalDocs, OpenAPIParameter, OpenAPIRequestBody, OpenAPIMediaType, OpenAPIExample, OpenAPIResponse, OpenAPIHeader, OpenAPIResponses, OpenAPISchema, OpenAPIDiscriminator, OpenAPIXML, OpenAPIComponents, OpenAPISecurityScheme, OpenAPIOAuthFlows, OpenAPIOAuthFlow, OpenAPISecurity, OpenAPITag, SwaggerOptions, ApiOperationOptions, ApiResponseOptions, ApiParamOptions, ApiQueryOptions, ApiHeaderOptions, ApiBodyOptions, ApiPropertyOptions, SecuritySchemeOptions, ApiKeySecurityOptions, Constructor, } from './types';
+export { DocumentBuilder } from './document-builder';
+export { SchemaGenerator } from './schema-generator';
+export { RouteScanner } from './route-scanner';
+export { SwaggerModule } from './swagger-module';
+export { ApiTags, ApiBearerAuth, ApiBasicAuth, ApiApiKey, ApiExcludeController, } from './decorators';
+export { ApiOperation, ApiResponse, ApiParam, ApiQuery, ApiHeader, ApiBody, ApiExcludeEndpoint, } from './decorators';
+export { ApiProperty, ApiPropertyOptional } from './decorators';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/openapi/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAIH,YAAY,EACX,eAAe,EACf,WAAW,EACX,cAAc,EACd,cAAc,EACd,aAAa,EACb,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,oBAAoB,EACpB,UAAU,EACV,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,UAAU,EACV,cAAc,EACd,mBAAmB,EACnB,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,qBAAqB,EACrB,qBAAqB,EACrB,WAAW,GACX,MAAM,SAAS,CAAC;AAIjB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAKjD,OAAO,EACN,OAAO,EACP,aAAa,EACb,YAAY,EACZ,SAAS,EACT,oBAAoB,GACpB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACN,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,OAAO,EACP,kBAAkB,GAClB,MAAM,cAAc,CAAC;AAGtB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC"}

package/dist/openapi/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/openapi/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AA2CH,4CAA4C;AAE5C,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,gDAAgD;AAEhD,yBAAyB;AACzB,OAAO,EACN,OAAO,EACP,aAAa,EACb,YAAY,EACZ,SAAS,EACT,oBAAoB,GACpB,MAAM,cAAc,CAAC;AAEtB,0BAA0B;AAC1B,OAAO,EACN,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,OAAO,EACP,kBAAkB,GAClB,MAAM,cAAc,CAAC;AAEtB,uCAAuC;AACvC,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC"}

package/dist/openapi/metadata.d.ts

@@ -0,0 +1,36 @@
+/**
+ * OpenAPI Metadata Storage
+ *
+ * Isolated metadata storage using WeakMap, following the same pattern as src/modules/metadata.ts
+ * This avoids circular dependencies and keeps metadata separate from the core module system.
+ */
+import type { Constructor } from './types';
+/**
+ * Set metadata on a class constructor
+ */
+export declare function setApiMetadata(target: Constructor, key: string, value: unknown): void;
+/**
+ * Get metadata from a class constructor
+ */
+export declare function getApiMetadata<T>(target: Constructor, key: string): T | undefined;
+/**
+ * Set metadata on a method prototype
+ */
+export declare function setApiMethodMetadata(target: object, key: string, value: unknown): void;
+/**
+ * Get metadata from a method prototype
+ */
+export declare function getApiMethodMetadata<T>(target: object, key: string): T | undefined;
+/**
+ * Set metadata on a property of a class prototype
+ */
+export declare function setApiPropertyMetadata(target: object, propertyKey: string | symbol, value: unknown): void;
+/**
+ * Get metadata from a property of a class prototype
+ */
+export declare function getApiPropertyMetadata<T>(target: object, propertyKey: string | symbol): T | undefined;
+/**
+ * Get all property metadata keys from a class prototype
+ */
+export declare function getApiPropertyKeys(target: object): (string | symbol)[];
+//# sourceMappingURL=metadata.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.d.ts","sourceRoot":"","sources":["../../src/openapi/metadata.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAS3C;;GAEG;AACH,wBAAgB,cAAc,CAC7B,MAAM,EAAE,WAAW,EACnB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,GACZ,IAAI,CAKN;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAC/B,MAAM,EAAE,WAAW,EACnB,GAAG,EAAE,MAAM,GACT,CAAC,GAAG,SAAS,CAEf;AASD;;GAEG;AACH,wBAAgB,oBAAoB,CACnC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,GACZ,IAAI,CAKN;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACrC,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,GACT,CAAC,GAAG,SAAS,CAEf;AASD;;GAEG;AACH,wBAAgB,sBAAsB,CACrC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,GAAG,MAAM,EAC5B,KAAK,EAAE,OAAO,GACZ,IAAI,CAMN;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,EACvC,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,GAAG,MAAM,GAC1B,CAAC,GAAG,SAAS,CAGf;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAItE"}

package/dist/openapi/metadata.js

@@ -0,0 +1,78 @@
+/**
+ * OpenAPI Metadata Storage
+ *
+ * Isolated metadata storage using WeakMap, following the same pattern as src/modules/metadata.ts
+ * This avoids circular dependencies and keeps metadata separate from the core module system.
+ */
+// ============= Class-Level Metadata =============
+/**
+ * Stores metadata on class constructors (e.g., @ApiTags, @ApiBearerAuth, @ApiExcludeController)
+ */
+const classMetadataStore = new WeakMap();
+/**
+ * Set metadata on a class constructor
+ */
+export function setApiMetadata(target, key, value) {
+    if (!classMetadataStore.has(target)) {
+        classMetadataStore.set(target, new Map());
+    }
+    classMetadataStore.get(target)?.set(key, value);
+}
+/**
+ * Get metadata from a class constructor
+ */
+export function getApiMetadata(target, key) {
+    return classMetadataStore.get(target)?.get(key);
+}
+// ============= Method/Prototype-Level Metadata =============
+/**
+ * Stores metadata on method prototypes (e.g., @ApiOperation, @ApiResponse, @ApiParam)
+ */
+const methodMetadataStore = new WeakMap();
+/**
+ * Set metadata on a method prototype
+ */
+export function setApiMethodMetadata(target, key, value) {
+    if (!methodMetadataStore.has(target)) {
+        methodMetadataStore.set(target, new Map());
+    }
+    methodMetadataStore.get(target)?.set(key, value);
+}
+/**
+ * Get metadata from a method prototype
+ */
+export function getApiMethodMetadata(target, key) {
+    return methodMetadataStore.get(target)?.get(key);
+}
+// ============= Property-Level Metadata =============
+/**
+ * Stores metadata on class properties (e.g., @ApiProperty decorators on DTO properties)
+ */
+const propertyMetadataStore = new WeakMap();
+/**
+ * Set metadata on a property of a class prototype
+ */
+export function setApiPropertyMetadata(target, propertyKey, value) {
+    if (!propertyMetadataStore.has(target)) {
+        propertyMetadataStore.set(target, new Map());
+    }
+    const key = typeof propertyKey === 'symbol' ? propertyKey.toString() : propertyKey;
+    propertyMetadataStore.get(target)?.set(key, value);
+}
+/**
+ * Get metadata from a property of a class prototype
+ */
+export function getApiPropertyMetadata(target, propertyKey) {
+    const key = typeof propertyKey === 'symbol' ? propertyKey.toString() : propertyKey;
+    return propertyMetadataStore.get(target)?.get(key);
+}
+/**
+ * Get all property metadata keys from a class prototype
+ */
+export function getApiPropertyKeys(target) {
+    const metaMap = propertyMetadataStore.get(target);
+    if (!metaMap)
+        return [];
+    return Array.from(metaMap.keys());
+}
+//# sourceMappingURL=metadata.js.map

package/dist/openapi/metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.js","sourceRoot":"","sources":["../../src/openapi/metadata.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,mDAAmD;AAEnD;;GAEG;AACH,MAAM,kBAAkB,GAAG,IAAI,OAAO,EAAqC,CAAC;AAE5E;;GAEG;AACH,MAAM,UAAU,cAAc,CAC7B,MAAmB,EACnB,GAAW,EACX,KAAc;IAEd,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACrC,kBAAkB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAC3C,CAAC;IACD,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAC7B,MAAmB,EACnB,GAAW;IAEX,OAAO,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAkB,CAAC;AAClE,CAAC;AAED,8DAA8D;AAE9D;;GAEG;AACH,MAAM,mBAAmB,GAAG,IAAI,OAAO,EAAgC,CAAC;AAExE;;GAEG;AACH,MAAM,UAAU,oBAAoB,CACnC,MAAc,EACd,GAAW,EACX,KAAc;IAEd,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,mBAAmB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CACnC,MAAc,EACd,GAAW;IAEX,OAAO,mBAAmB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAkB,CAAC;AACnE,CAAC;AAED,sDAAsD;AAEtD;;GAEG;AACH,MAAM,qBAAqB,GAAG,IAAI,OAAO,EAAgC,CAAC;AAE1E;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACrC,MAAc,EACd,WAA4B,EAC5B,KAAc;IAEd,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;QACxC,qBAAqB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAC9C,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;IACnF,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AACpD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACrC,MAAc,EACd,WAA4B;IAE5B,MAAM,GAAG,GAAG,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;IACnF,OAAO,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,GAAG,CAAkB,CAAC;AACrE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAc;IAChD,MAAM,OAAO,GAAG,qBAAqB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClD,IAAI,CAAC,OAAO;QAAE,OAAO,EAAE,CAAC;IACxB,OAAO,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAwB,CAAC;AAC1D,CAAC"}

package/dist/openapi/route-scanner.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Route Scanner
+ *
+ * Scans controllers and extracts OpenAPI operation metadata from decorators.
+ * Combines HTTP method decorators, parameter documentation, and responses
+ * into OpenAPI operation objects.
+ */
+import type { Constructor, OpenAPIPaths } from './types';
+import { SchemaGenerator } from './schema-generator';
+/**
+ * RouteScanner - Scans controllers and extracts OpenAPI operations
+ */
+export declare class RouteScanner {
+    private schemaGenerator;
+    constructor(schemaGenerator: SchemaGenerator);
+    /**
+     * Scan all controllers and generate OpenAPI paths
+     */
+    scanControllers(controllers: Constructor[]): OpenAPIPaths;
+    /**
+     * Generate an OpenAPI operation for a single route
+     */
+    private generateOperation;
+    /**
+     * Convert a route pattern from :param format to {param} format (OpenAPI style)
+     * Handles optional params (:param?) and regex params (:param<regex>)
+     */
+    private convertPathToOpenAPI;
+    /**
+     * Get the schema generator instance
+     */
+    getSchemaGenerator(): SchemaGenerator;
+}
+//# sourceMappingURL=route-scanner.d.ts.map

package/dist/openapi/route-scanner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-scanner.d.ts","sourceRoot":"","sources":["../../src/openapi/route-scanner.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EACX,WAAW,EAGX,YAAY,EAGZ,MAAM,SAAS,CAAC;AAIjB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAQrD;;GAEG;AACH,qBAAa,YAAY;IACZ,OAAO,CAAC,eAAe;gBAAf,eAAe,EAAE,eAAe;IAEpD;;OAEG;IACH,eAAe,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,YAAY;IAyDzD;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAkLzB;;;OAGG;IACH,OAAO,CAAC,oBAAoB;IAI5B;;OAEG;IACH,kBAAkB,IAAI,eAAe;CAGrC"}