@riktajs/swagger 0.1.0

package/dist/decorators/api-security.decorator.d.ts

@@ -0,0 +1,88 @@
+import 'reflect-metadata';
+import type { ApiSecurityOptions } from '../types.js';
+/**
+ * @ApiSecurity() decorator
+ *
+ * Applies a security requirement to a controller or method.
+ * The security scheme must be defined in the SwaggerConfig.securitySchemes.
+ *
+ * Can be applied to:
+ * - Controller classes (applies to all routes)
+ * - Individual route methods
+ *
+ * @param name - Name of the security scheme
+ * @param scopes - Required scopes (for OAuth2)
+ *
+ * @example
+ * ```typescript
+ * @ApiSecurity('bearerAuth')
+ * @Controller('/users')
+ * class UserController {
+ *   @Get('/')
+ *   listUsers() { } // Protected by bearerAuth
+ *
+ *   @Get('/public')
+ *   @ApiSecurity() // Remove security for this endpoint
+ *   getPublicInfo() { }
+ * }
+ * ```
+ */
+export declare function ApiSecurity(name?: string, scopes?: string[]): ClassDecorator & MethodDecorator;
+/**
+ * @ApiBearerAuth() decorator
+ *
+ * Shorthand for @ApiSecurity('bearerAuth').
+ * Applies Bearer token authentication to a controller or method.
+ *
+ * @param name - Name of the bearer auth scheme (default: 'bearerAuth')
+ *
+ * @example
+ * ```typescript
+ * @ApiBearerAuth()
+ * @Controller('/users')
+ * class UserController {
+ *   @Get('/')
+ *   listUsers() { } // Requires Bearer token
+ * }
+ * ```
+ */
+export declare function ApiBearerAuth(name?: string): ClassDecorator & MethodDecorator;
+/**
+ * @ApiBasicAuth() decorator
+ *
+ * Shorthand for @ApiSecurity('basicAuth').
+ * Applies HTTP Basic authentication to a controller or method.
+ *
+ * @param name - Name of the basic auth scheme (default: 'basicAuth')
+ */
+export declare function ApiBasicAuth(name?: string): ClassDecorator & MethodDecorator;
+/**
+ * @ApiOAuth2() decorator
+ *
+ * Applies OAuth2 authentication with specific scopes.
+ *
+ * @param scopes - Required OAuth2 scopes
+ * @param name - Name of the OAuth2 scheme (default: 'oauth2')
+ *
+ * @example
+ * ```typescript
+ * @ApiOAuth2(['read:users', 'write:users'])
+ * @Controller('/users')
+ * class UserController { }
+ * ```
+ */
+export declare function ApiOAuth2(scopes?: string[], name?: string): ClassDecorator & MethodDecorator;
+/**
+ * @ApiCookieAuth() decorator
+ *
+ * Applies cookie-based authentication.
+ *
+ * @param name - Name of the cookie auth scheme (default: 'cookieAuth')
+ */
+export declare function ApiCookieAuth(name?: string): ClassDecorator & MethodDecorator;
+/**
+ * Get security metadata from a class or method
+ * @internal
+ */
+export declare function getApiSecurity(target: Function, propertyKey?: string | symbol): ApiSecurityOptions | null | undefined;
+//# sourceMappingURL=api-security.decorator.d.ts.map

package/dist/decorators/api-security.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-security.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/api-security.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,WAAW,CACzB,IAAI,CAAC,EAAE,MAAM,EACb,MAAM,GAAE,MAAM,EAAO,GACpB,cAAc,GAAG,eAAe,CAqBlC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAAC,IAAI,GAAE,MAAqB,GAAG,cAAc,GAAG,eAAe,CAE3F;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAAC,IAAI,GAAE,MAAoB,GAAG,cAAc,GAAG,eAAe,CAEzF;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CACvB,MAAM,GAAE,MAAM,EAAO,EACrB,IAAI,GAAE,MAAiB,GACtB,cAAc,GAAG,eAAe,CAElC;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,IAAI,GAAE,MAAqB,GAAG,cAAc,GAAG,eAAe,CAE3F;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,QAAQ,EAChB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAC5B,kBAAkB,GAAG,IAAI,GAAG,SAAS,CAWvC"}

package/dist/decorators/api-security.decorator.js

@@ -0,0 +1,119 @@
+import 'reflect-metadata';
+import { API_SECURITY_METADATA } from '../constants.js';
+/**
+ * @ApiSecurity() decorator
+ *
+ * Applies a security requirement to a controller or method.
+ * The security scheme must be defined in the SwaggerConfig.securitySchemes.
+ *
+ * Can be applied to:
+ * - Controller classes (applies to all routes)
+ * - Individual route methods
+ *
+ * @param name - Name of the security scheme
+ * @param scopes - Required scopes (for OAuth2)
+ *
+ * @example
+ * ```typescript
+ * @ApiSecurity('bearerAuth')
+ * @Controller('/users')
+ * class UserController {
+ *   @Get('/')
+ *   listUsers() { } // Protected by bearerAuth
+ *
+ *   @Get('/public')
+ *   @ApiSecurity() // Remove security for this endpoint
+ *   getPublicInfo() { }
+ * }
+ * ```
+ */
+export function ApiSecurity(name, scopes = []) {
+    return (target, propertyKey, descriptor) => {
+        const security = name ? { name, scopes } : null;
+        if (propertyKey !== undefined && descriptor !== undefined) {
+            // Method decorator - save on target (prototype)
+            Reflect.defineMetadata(API_SECURITY_METADATA, security, target, propertyKey);
+        }
+        else {
+            // Class decorator
+            Reflect.defineMetadata(API_SECURITY_METADATA, security, target);
+        }
+    };
+}
+/**
+ * @ApiBearerAuth() decorator
+ *
+ * Shorthand for @ApiSecurity('bearerAuth').
+ * Applies Bearer token authentication to a controller or method.
+ *
+ * @param name - Name of the bearer auth scheme (default: 'bearerAuth')
+ *
+ * @example
+ * ```typescript
+ * @ApiBearerAuth()
+ * @Controller('/users')
+ * class UserController {
+ *   @Get('/')
+ *   listUsers() { } // Requires Bearer token
+ * }
+ * ```
+ */
+export function ApiBearerAuth(name = 'bearerAuth') {
+    return ApiSecurity(name);
+}
+/**
+ * @ApiBasicAuth() decorator
+ *
+ * Shorthand for @ApiSecurity('basicAuth').
+ * Applies HTTP Basic authentication to a controller or method.
+ *
+ * @param name - Name of the basic auth scheme (default: 'basicAuth')
+ */
+export function ApiBasicAuth(name = 'basicAuth') {
+    return ApiSecurity(name);
+}
+/**
+ * @ApiOAuth2() decorator
+ *
+ * Applies OAuth2 authentication with specific scopes.
+ *
+ * @param scopes - Required OAuth2 scopes
+ * @param name - Name of the OAuth2 scheme (default: 'oauth2')
+ *
+ * @example
+ * ```typescript
+ * @ApiOAuth2(['read:users', 'write:users'])
+ * @Controller('/users')
+ * class UserController { }
+ * ```
+ */
+export function ApiOAuth2(scopes = [], name = 'oauth2') {
+    return ApiSecurity(name, scopes);
+}
+/**
+ * @ApiCookieAuth() decorator
+ *
+ * Applies cookie-based authentication.
+ *
+ * @param name - Name of the cookie auth scheme (default: 'cookieAuth')
+ */
+export function ApiCookieAuth(name = 'cookieAuth') {
+    return ApiSecurity(name);
+}
+/**
+ * Get security metadata from a class or method
+ * @internal
+ */
+export function getApiSecurity(target, propertyKey) {
+    if (propertyKey !== undefined) {
+        // Check if method has explicit security (including null for "no security")
+        const methodSecurity = Reflect.getMetadata(API_SECURITY_METADATA, target.prototype, propertyKey);
+        if (methodSecurity !== undefined) {
+            return methodSecurity;
+        }
+        // Fall back to class-level security
+        return Reflect.getMetadata(API_SECURITY_METADATA, target);
+    }
+    return Reflect.getMetadata(API_SECURITY_METADATA, target);
+}
+//# sourceMappingURL=api-security.decorator.js.map

package/dist/decorators/api-security.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-security.decorator.js","sourceRoot":"","sources":["../../src/decorators/api-security.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,WAAW,CACzB,IAAa,EACb,SAAmB,EAAE;IAErB,OAAO,CACL,MAAyB,EACzB,WAA6B,EAC7B,UAA+B,EACzB,EAAE;QACR,MAAM,QAAQ,GAA8B,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAE3E,IAAI,WAAW,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC1D,gDAAgD;YAChD,OAAO,CAAC,cAAc,CACpB,qBAAqB,EACrB,QAAQ,EACR,MAAM,EACN,WAAW,CACZ,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,kBAAkB;YAClB,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAClE,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,aAAa,CAAC,OAAe,YAAY;IACvD,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,OAAe,WAAW;IACrD,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS,CACvB,SAAmB,EAAE,EACrB,OAAe,QAAQ;IAEvB,OAAO,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAAC,OAAe,YAAY;IACvD,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAgB,EAChB,WAA6B;IAE7B,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,2EAA2E;QAC3E,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QACjG,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,oCAAoC;QACpC,OAAO,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;AAC5D,CAAC"}

package/dist/decorators/api-tags.decorator.d.ts

@@ -0,0 +1,31 @@
+import 'reflect-metadata';
+/**
+ * @ApiTags() decorator
+ *
+ * Groups endpoints under one or more tags in the Swagger UI.
+ * Tags are used to organize operations in the documentation.
+ *
+ * Can be applied to:
+ * - Controller classes (applies to all routes in the controller)
+ * - Individual route methods (overrides or adds to controller tags)
+ *
+ * @param tags - One or more tag names
+ *
+ * @example
+ * ```typescript
+ * @ApiTags('Users', 'Authentication')
+ * @Controller('/users')
+ * class UserController {
+ *   @Get('/')
+ *   @ApiTags('Admin') // Adds 'Admin' tag to this specific route
+ *   listUsers() { }
+ * }
+ * ```
+ */
+export declare function ApiTags(...tags: string[]): ClassDecorator & MethodDecorator;
+/**
+ * Get tags metadata from a class or method
+ * @internal
+ */
+export declare function getApiTags(target: Function, propertyKey?: string | symbol): string[];
+//# sourceMappingURL=api-tags.decorator.d.ts.map

package/dist/decorators/api-tags.decorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-tags.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/api-tags.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAG1B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,OAAO,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,cAAc,GAAG,eAAe,CA2B3E;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,QAAQ,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CASpF"}

package/dist/decorators/api-tags.decorator.js

@@ -0,0 +1,52 @@
+import 'reflect-metadata';
+import { API_TAGS_METADATA } from '../constants.js';
+/**
+ * @ApiTags() decorator
+ *
+ * Groups endpoints under one or more tags in the Swagger UI.
+ * Tags are used to organize operations in the documentation.
+ *
+ * Can be applied to:
+ * - Controller classes (applies to all routes in the controller)
+ * - Individual route methods (overrides or adds to controller tags)
+ *
+ * @param tags - One or more tag names
+ *
+ * @example
+ * ```typescript
+ * @ApiTags('Users', 'Authentication')
+ * @Controller('/users')
+ * class UserController {
+ *   @Get('/')
+ *   @ApiTags('Admin') // Adds 'Admin' tag to this specific route
+ *   listUsers() { }
+ * }
+ * ```
+ */
+export function ApiTags(...tags) {
+    return (target, propertyKey, descriptor) => {
+        if (propertyKey !== undefined && descriptor !== undefined) {
+            // Method decorator - save on target (prototype)
+            const existingTags = Reflect.getMetadata(API_TAGS_METADATA, target, propertyKey) ?? [];
+            Reflect.defineMetadata(API_TAGS_METADATA, [...existingTags, ...tags], target, propertyKey);
+        }
+        else {
+            // Class decorator
+            const existingTags = Reflect.getMetadata(API_TAGS_METADATA, target) ?? [];
+            Reflect.defineMetadata(API_TAGS_METADATA, [...existingTags, ...tags], target);
+        }
+    };
+}
+/**
+ * Get tags metadata from a class or method
+ * @internal
+ */
+export function getApiTags(target, propertyKey) {
+    if (propertyKey !== undefined) {
+        const methodTags = Reflect.getMetadata(API_TAGS_METADATA, target.prototype, propertyKey) ?? [];
+        const classTags = Reflect.getMetadata(API_TAGS_METADATA, target) ?? [];
+        return [...new Set([...classTags, ...methodTags])];
+    }
+    return Reflect.getMetadata(API_TAGS_METADATA, target) ?? [];
+}
+//# sourceMappingURL=api-tags.decorator.js.map

package/dist/decorators/api-tags.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-tags.decorator.js","sourceRoot":"","sources":["../../src/decorators/api-tags.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,OAAO,CAAC,GAAG,IAAc;IACvC,OAAO,CACL,MAAyB,EACzB,WAA6B,EAC7B,UAA+B,EACzB,EAAE;QACR,IAAI,WAAW,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC1D,gDAAgD;YAChD,MAAM,YAAY,GAChB,OAAO,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;YACpE,OAAO,CAAC,cAAc,CACpB,iBAAiB,EACjB,CAAC,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC,EAC1B,MAAM,EACN,WAAW,CACZ,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,kBAAkB;YAClB,MAAM,YAAY,GAChB,OAAO,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;YACvD,OAAO,CAAC,cAAc,CACpB,iBAAiB,EACjB,CAAC,GAAG,YAAY,EAAE,GAAG,IAAI,CAAC,EAC1B,MAAM,CACP,CAAC;QACJ,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,MAAgB,EAAE,WAA6B;IACxE,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,UAAU,GACd,OAAO,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;QAC9E,MAAM,SAAS,GACb,OAAO,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;QACvD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,SAAS,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IACrD,CAAC;IACD,OAAO,OAAO,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;AAC9D,CAAC"}

package/dist/decorators/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Swagger decorators barrel export
+ *
+ * @packageDocumentation
+ */
+export { ApiTags, getApiTags } from './api-tags.decorator.js';
+export { ApiOperation, getApiOperation } from './api-operation.decorator.js';
+export { ApiResponse, ApiOkResponse, ApiCreatedResponse, ApiAcceptedResponse, ApiNoContentResponse, ApiBadRequestResponse, ApiUnauthorizedResponse, ApiForbiddenResponse, ApiNotFoundResponse, ApiConflictResponse, ApiUnprocessableEntityResponse, ApiInternalServerErrorResponse, getApiResponses, } from './api-response.decorator.js';
+export { ApiBody, getApiBody } from './api-body.decorator.js';
+export { ApiParam, getApiParams } from './api-param.decorator.js';
+export { ApiQuery, getApiQueries } from './api-query.decorator.js';
+export { ApiHeader, getApiHeaders } from './api-header.decorator.js';
+export { ApiSecurity, ApiBearerAuth, ApiBasicAuth, ApiOAuth2, ApiCookieAuth, getApiSecurity, } from './api-security.decorator.js';
+export { ApiProperty, ApiPropertyOptional, ApiHideProperty, getApiProperties, } from './api-property.decorator.js';
+export { ApiExcludeEndpoint, ApiExcludeController, isApiExcluded, ApiDeprecated, getApiDeprecated, } from './api-exclude.decorator.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAG9D,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAG7E,OAAO,EACL,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,8BAA8B,EAC9B,8BAA8B,EAC9B,eAAe,GAChB,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAG9D,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAGrE,OAAO,EACL,WAAW,EACX,aAAa,EACb,YAAY,EACZ,SAAS,EACT,aAAa,EACb,cAAc,GACf,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,eAAe,EACf,gBAAgB,GACjB,MAAM,6BAA6B,CAAC;AAGrC,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,aAAa,EACb,gBAAgB,GACjB,MAAM,4BAA4B,CAAC"}

package/dist/decorators/index.js

@@ -0,0 +1,24 @@
+/**
+ * Swagger decorators barrel export
+ *
+ * @packageDocumentation
+ */
+// Tag decorator
+export { ApiTags, getApiTags } from './api-tags.decorator.js';
+// Operation decorator
+export { ApiOperation, getApiOperation } from './api-operation.decorator.js';
+// Response decorators
+export { ApiResponse, ApiOkResponse, ApiCreatedResponse, ApiAcceptedResponse, ApiNoContentResponse, ApiBadRequestResponse, ApiUnauthorizedResponse, ApiForbiddenResponse, ApiNotFoundResponse, ApiConflictResponse, ApiUnprocessableEntityResponse, ApiInternalServerErrorResponse, getApiResponses, } from './api-response.decorator.js';
+// Body decorator
+export { ApiBody, getApiBody } from './api-body.decorator.js';
+// Parameter decorators
+export { ApiParam, getApiParams } from './api-param.decorator.js';
+export { ApiQuery, getApiQueries } from './api-query.decorator.js';
+export { ApiHeader, getApiHeaders } from './api-header.decorator.js';
+// Security decorators
+export { ApiSecurity, ApiBearerAuth, ApiBasicAuth, ApiOAuth2, ApiCookieAuth, getApiSecurity, } from './api-security.decorator.js';
+// Property decorators
+export { ApiProperty, ApiPropertyOptional, ApiHideProperty, getApiProperties, } from './api-property.decorator.js';
+// Exclude/Deprecate decorators
+export { ApiExcludeEndpoint, ApiExcludeController, isApiExcluded, ApiDeprecated, getApiDeprecated, } from './api-exclude.decorator.js';
+//# sourceMappingURL=index.js.map

package/dist/decorators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,gBAAgB;AAChB,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE9D,sBAAsB;AACtB,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE7E,sBAAsB;AACtB,OAAO,EACL,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,8BAA8B,EAC9B,8BAA8B,EAC9B,eAAe,GAChB,MAAM,6BAA6B,CAAC;AAErC,iBAAiB;AACjB,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE9D,uBAAuB;AACvB,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAErE,sBAAsB;AACtB,OAAO,EACL,WAAW,EACX,aAAa,EACb,YAAY,EACZ,SAAS,EACT,aAAa,EACb,cAAc,GACf,MAAM,6BAA6B,CAAC;AAErC,sBAAsB;AACtB,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,eAAe,EACf,gBAAgB,GACjB,MAAM,6BAA6B,CAAC;AAErC,+BAA+B;AAC/B,OAAO,EACL,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,aAAa,EACb,gBAAgB,GACjB,MAAM,4BAA4B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @riktajs/swagger
+ *
+ * Automatic OpenAPI/Swagger documentation generation for Rikta Framework.
+ *
+ * This package provides decorators and utilities to automatically generate
+ * OpenAPI 3.0/3.1 documentation from your Rikta controllers and routes.
+ *
+ * Features:
+ * - Automatic route extraction from @Controller, @Get, @Post, etc.
+ * - Decorators for enriching API documentation (@ApiTags, @ApiOperation, @ApiResponse, etc.)
+ * - Zod schema integration for automatic request/response type documentation
+ * - Interactive Swagger UI served via Fastify
+ * - Full OpenAPI 3.0/3.1 specification support
+ *
+ * @example
+ * ```typescript
+ * import { Rikta, Controller, Get } from '@riktajs/core';
+ * import { swaggerPlugin, ApiTags, ApiOperation, ApiResponse } from '@riktajs/swagger';
+ * import { z } from 'zod';
+ *
+ * const UserSchema = z.object({
+ *   id: z.string().uuid(),
+ *   name: z.string(),
+ *   email: z.string().email(),
+ * });
+ *
+ * @ApiTags('Users')
+ * @Controller('/users')
+ * class UserController {
+ *   @Get('/')
+ *   @ApiOperation({ summary: 'List all users' })
+ *   @ApiResponse({ status: 200, description: 'Array of users', schema: z.array(UserSchema) })
+ *   async listUsers() {
+ *     return [];
+ *   }
+ * }
+ *
+ * const app = await Rikta.create({ port: 3000 });
+ *
+ * // Register swagger plugin
+ * app.server.register(swaggerPlugin, {
+ *   title: 'My API',
+ *   version: '1.0.0',
+ *   description: 'My awesome API documentation',
+ * });
+ *
+ * await app.listen();
+ * // Swagger UI available at http://localhost:3000/docs
+ * // OpenAPI JSON available at http://localhost:3000/docs/json
+ * ```
+ *
+ * @packageDocumentation
+ */
+export * from './constants.js';
+export { CONTROLLER_METADATA, ROUTES_METADATA, PARAM_METADATA, HTTP_CODE_METADATA, GUARDS_METADATA, ZOD_SCHEMA_METADATA, } from '@riktajs/core';
+export type * from './types.js';
+export * from './decorators/index.js';
+export { OpenApiGenerator } from './openapi/generator.js';
+export { zodToOpenApi, toOpenApiSchema, isZodSchema } from './openapi/zod-to-openapi.js';
+export { swaggerPlugin, registerSwagger, createSwaggerConfig } from './plugin/swagger.plugin.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AAGH,cAAc,gBAAgB,CAAC;AAI/B,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,mBAAmB,GACpB,MAAM,eAAe,CAAC;AAGvB,mBAAmB,YAAY,CAAC;AAGhC,cAAc,uBAAuB,CAAC;AAGtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAG1D,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAGzF,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/index.js

@@ -0,0 +1,68 @@
+/**
+ * @riktajs/swagger
+ *
+ * Automatic OpenAPI/Swagger documentation generation for Rikta Framework.
+ *
+ * This package provides decorators and utilities to automatically generate
+ * OpenAPI 3.0/3.1 documentation from your Rikta controllers and routes.
+ *
+ * Features:
+ * - Automatic route extraction from @Controller, @Get, @Post, etc.
+ * - Decorators for enriching API documentation (@ApiTags, @ApiOperation, @ApiResponse, etc.)
+ * - Zod schema integration for automatic request/response type documentation
+ * - Interactive Swagger UI served via Fastify
+ * - Full OpenAPI 3.0/3.1 specification support
+ *
+ * @example
+ * ```typescript
+ * import { Rikta, Controller, Get } from '@riktajs/core';
+ * import { swaggerPlugin, ApiTags, ApiOperation, ApiResponse } from '@riktajs/swagger';
+ * import { z } from 'zod';
+ *
+ * const UserSchema = z.object({
+ *   id: z.string().uuid(),
+ *   name: z.string(),
+ *   email: z.string().email(),
+ * });
+ *
+ * @ApiTags('Users')
+ * @Controller('/users')
+ * class UserController {
+ *   @Get('/')
+ *   @ApiOperation({ summary: 'List all users' })
+ *   @ApiResponse({ status: 200, description: 'Array of users', schema: z.array(UserSchema) })
+ *   async listUsers() {
+ *     return [];
+ *   }
+ * }
+ *
+ * const app = await Rikta.create({ port: 3000 });
+ *
+ * // Register swagger plugin
+ * app.server.register(swaggerPlugin, {
+ *   title: 'My API',
+ *   version: '1.0.0',
+ *   description: 'My awesome API documentation',
+ * });
+ *
+ * await app.listen();
+ * // Swagger UI available at http://localhost:3000/docs
+ * // OpenAPI JSON available at http://localhost:3000/docs/json
+ * ```
+ *
+ * @packageDocumentation
+ */
+// Export swagger-specific constants
+export * from './constants.js';
+// Re-export core constants needed for metadata reading
+// These are imported from @riktajs/core to avoid duplication
+export { CONTROLLER_METADATA, ROUTES_METADATA, PARAM_METADATA, HTTP_CODE_METADATA, GUARDS_METADATA, ZOD_SCHEMA_METADATA, } from '@riktajs/core';
+// Export decorators
+export * from './decorators/index.js';
+// Export OpenAPI generator
+export { OpenApiGenerator } from './openapi/generator.js';
+// Export Zod-to-OpenAPI utilities
+export { zodToOpenApi, toOpenApiSchema, isZodSchema } from './openapi/zod-to-openapi.js';
+// Export Fastify plugin
+export { swaggerPlugin, registerSwagger, createSwaggerConfig } from './plugin/swagger.plugin.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;AAEH,oCAAoC;AACpC,cAAc,gBAAgB,CAAC;AAE/B,uDAAuD;AACvD,6DAA6D;AAC7D,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,kBAAkB,EAClB,eAAe,EACf,mBAAmB,GACpB,MAAM,eAAe,CAAC;AAKvB,oBAAoB;AACpB,cAAc,uBAAuB,CAAC;AAEtC,2BAA2B;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,kCAAkC;AAClC,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAEzF,wBAAwB;AACxB,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/openapi/generator.d.ts

@@ -0,0 +1,98 @@
+import 'reflect-metadata';
+import type { SwaggerConfig, OpenApiDocument, OpenApiSecurityScheme, OpenApiInfoObject } from '../types.js';
+type Constructor<T = unknown> = new (...args: any[]) => T;
+/**
+ * Shorthand config options that allow flat title/version/description
+ */
+interface OpenApiGeneratorConfig extends Omit<SwaggerConfig, 'info'> {
+    /** API title (shorthand for info.title) */
+    title?: string;
+    /** API version (shorthand for info.version) */
+    version?: string;
+    /** API description (shorthand for info.description) */
+    description?: string;
+    /** API contact (shorthand for info.contact) */
+    contact?: OpenApiInfoObject['contact'];
+    /** API license (shorthand for info.license) */
+    license?: OpenApiInfoObject['license'];
+    /** API terms of service (shorthand for info.termsOfService) */
+    termsOfService?: string;
+    /** Full info object (takes precedence over shorthand) */
+    info?: OpenApiInfoObject;
+}
+/**
+ * OpenAPI Specification Generator
+ *
+ * Collects metadata from controllers and generates a complete
+ * OpenAPI 3.0.3 specification document.
+ *
+ * @example
+ * ```typescript
+ * const generator = new OpenApiGenerator({
+ *   info: {
+ *     title: 'My API',
+ *     version: '1.0.0',
+ *   },
+ * });
+ *
+ * // Add controllers to scan
+ * generator.addController(UserController);
+ * generator.addController(ProductController);
+ *
+ * // Generate the specification
+ * const spec = generator.generate();
+ * ```
+ */
+export declare class OpenApiGenerator {
+    private config;
+    private controllers;
+    private globalSecuritySchemes;
+    constructor(config?: OpenApiGeneratorConfig);
+    /**
+     * Add a controller to be documented
+     */
+    addController(controller: Constructor): this;
+    /**
+     * Add multiple controllers
+     */
+    addControllers(controllers: Constructor[]): this;
+    /**
+     * Add a global security scheme
+     */
+    addSecurityScheme(name: string, scheme: OpenApiSecurityScheme): this;
+    /**
+     * Generate the OpenAPI specification document
+     */
+    generate(): OpenApiDocument;
+    private getControllerMeta;
+    private getControllerRoutes;
+    private getControllerTags;
+    private isControllerExcluded;
+    private isControllerDeprecated;
+    private isEndpointExcluded;
+    private isEndpointDeprecated;
+    private getOperationMetadata;
+    private getResponseMetadata;
+    private getBodyMetadata;
+    private getSwaggerParamMetadata;
+    private getQueryMetadata;
+    private getHeaderMetadata;
+    private getSecurityMetadata;
+    private getMethodTags;
+    private getHttpStatusCode;
+    private getCoreParams;
+    private normalizePath;
+    private buildOperation;
+    private buildParameters;
+    private extractPathParams;
+    private buildRequestBody;
+    private buildResponses;
+    private getDefaultStatusDescription;
+    private buildSecuritySchemes;
+}
+/**
+ * Create a new OpenAPI generator instance
+ */
+export declare function createOpenApiGenerator(config?: Partial<SwaggerConfig>): OpenApiGenerator;
+export {};
+//# sourceMappingURL=generator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/openapi/generator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AA4B1B,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EAIf,qBAAqB,EACrB,iBAAiB,EAQlB,MAAM,aAAa,CAAC;AAMrB,KAAK,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAY1D;;GAEG;AACH,UAAU,sBAAuB,SAAQ,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC;IAClE,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACvC,+CAA+C;IAC/C,OAAO,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACvC,+DAA+D;IAC/D,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,yDAAyD;IACzD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,WAAW,CAAqB;IACxC,OAAO,CAAC,qBAAqB,CAAiD;gBAElE,MAAM,GAAE,sBAA2B;IAqB/C;;OAEG;IACH,aAAa,CAAC,UAAU,EAAE,WAAW,GAAG,IAAI;IAK5C;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,GAAG,IAAI;IAKhD;;OAEG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,qBAAqB,GAAG,IAAI;IAKpE;;OAEG;IACH,QAAQ,IAAI,eAAe;IAuF3B,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,sBAAsB;IAI9B,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,oBAAoB;IAM5B,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,uBAAuB;IAI/B,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,mBAAmB;IAuB3B,OAAO,CAAC,aAAa;IAKrB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,aAAa;IAiCrB,OAAO,CAAC,cAAc;IA8DtB,OAAO,CAAC,eAAe;IA0GvB,OAAO,CAAC,iBAAiB;IAczB,OAAO,CAAC,gBAAgB;IA0CxB,OAAO,CAAC,cAAc;IA6CtB,OAAO,CAAC,2BAA2B;IAgBnC,OAAO,CAAC,oBAAoB;CAwC7B;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAExF"}