@riktajs/swagger 0.1.2 → 0.2.0

package/dist/constants.d.ts

@@ -1,56 +1,11 @@
-/**
- * Key for storing API tags on controller classes
- * Used by @ApiTags() decorator
- */
 export declare const API_TAGS_METADATA: unique symbol;
-/**
- * Key for storing API operation metadata on route methods
- * Used by @ApiOperation() decorator
- */
 export declare const API_OPERATION_METADATA: unique symbol;
-/**
- * Key for storing API response metadata on route methods
- * Used by @ApiResponse() decorator
- */
 export declare const API_RESPONSE_METADATA: unique symbol;
-/**
- * Key for storing API property metadata on class properties
- * Used by @ApiProperty() decorator
- */
 export declare const API_PROPERTY_METADATA: unique symbol;
-/**
- * Key for storing API body metadata on route methods
- * Used by @ApiBody() decorator
- */
 export declare const API_BODY_METADATA: unique symbol;
-/**
- * Key for storing API parameter metadata on route methods
- * Used by @ApiParam() decorator
- */
 export declare const API_PARAM_METADATA: unique symbol;
-/**
- * Key for storing API query metadata on route methods
- * Used by @ApiQuery() decorator
- */
 export declare const API_QUERY_METADATA: unique symbol;
-/**
- * Key for storing API header metadata on route methods
- * Used by @ApiHeader() decorator
- */
 export declare const API_HEADER_METADATA: unique symbol;
-/**
- * Key for storing API security metadata on route methods or controllers
- * Used by @ApiSecurity() and @ApiBearerAuth() decorators
- */
 export declare const API_SECURITY_METADATA: unique symbol;
-/**
- * Key for storing API exclude metadata on route methods
- * Used by @ApiExcludeEndpoint() decorator
- */
 export declare const API_EXCLUDE_METADATA: unique symbol;
-/**
- * Key for storing API deprecated metadata on route methods
- * Used when operation is marked as deprecated
- */
 export declare const API_DEPRECATED_METADATA: unique symbol;
-//# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -1,61 +1,11 @@
-// ============================================================================
-// Swagger Package - Metadata Keys
-// ============================================================================
-// Using Symbol.for() to ensure symbols are shared across packages
-// and different import contexts (bundlers, tests, etc.)
-/**
- * Key for storing API tags on controller classes
- * Used by @ApiTags() decorator
- */
 export const API_TAGS_METADATA = Symbol.for('rikta:swagger:apiTags');
-/**
- * Key for storing API operation metadata on route methods
- * Used by @ApiOperation() decorator
- */
 export const API_OPERATION_METADATA = Symbol.for('rikta:swagger:apiOperation');
-/**
- * Key for storing API response metadata on route methods
- * Used by @ApiResponse() decorator
- */
 export const API_RESPONSE_METADATA = Symbol.for('rikta:swagger:apiResponse');
-/**
- * Key for storing API property metadata on class properties
- * Used by @ApiProperty() decorator
- */
 export const API_PROPERTY_METADATA = Symbol.for('rikta:swagger:apiProperty');
-/**
- * Key for storing API body metadata on route methods
- * Used by @ApiBody() decorator
- */
 export const API_BODY_METADATA = Symbol.for('rikta:swagger:apiBody');
-/**
- * Key for storing API parameter metadata on route methods
- * Used by @ApiParam() decorator
- */
 export const API_PARAM_METADATA = Symbol.for('rikta:swagger:apiParam');
-/**
- * Key for storing API query metadata on route methods
- * Used by @ApiQuery() decorator
- */
 export const API_QUERY_METADATA = Symbol.for('rikta:swagger:apiQuery');
-/**
- * Key for storing API header metadata on route methods
- * Used by @ApiHeader() decorator
- */
 export const API_HEADER_METADATA = Symbol.for('rikta:swagger:apiHeader');
-/**
- * Key for storing API security metadata on route methods or controllers
- * Used by @ApiSecurity() and @ApiBearerAuth() decorators
- */
 export const API_SECURITY_METADATA = Symbol.for('rikta:swagger:apiSecurity');
-/**
- * Key for storing API exclude metadata on route methods
- * Used by @ApiExcludeEndpoint() decorator
- */
 export const API_EXCLUDE_METADATA = Symbol.for('rikta:swagger:apiExclude');
-/**
- * Key for storing API deprecated metadata on route methods
- * Used when operation is marked as deprecated
- */
 export const API_DEPRECATED_METADATA = Symbol.for('rikta:swagger:apiDeprecated');
-//# sourceMappingURL=constants.js.map

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

@@ -1,33 +1,4 @@
 import 'reflect-metadata';
 import type { ApiBodyOptions } from '../types.js';
-/**
- * @ApiBody() decorator
- *
- * Documents the request body for an API operation.
- * Supports both Zod schemas and OpenAPI schema objects.
- *
- * @param options - Body options including schema, description, and examples
- *
- * @example
- * ```typescript
- * const CreateUserSchema = z.object({
- *   name: z.string().min(2),
- *   email: z.string().email(),
- * });
- *
- * @Post('/')
- * @ApiBody({
- *   description: 'User creation data',
- *   schema: CreateUserSchema,
- *   required: true,
- * })
- * createUser(@Body() data: z.infer<typeof CreateUserSchema>) { }
- * ```
- */
 export declare function ApiBody(options: ApiBodyOptions): MethodDecorator;
-/**
- * Get body metadata from a method
- * @internal
- */
 export declare function getApiBody(target: Function, propertyKey: string | symbol): ApiBodyOptions | undefined;
-//# sourceMappingURL=api-body.decorator.d.ts.map

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

@@ -1,40 +1,11 @@
 import 'reflect-metadata';
 import { API_BODY_METADATA } from '../constants.js';
-/**
- * @ApiBody() decorator
- *
- * Documents the request body for an API operation.
- * Supports both Zod schemas and OpenAPI schema objects.
- *
- * @param options - Body options including schema, description, and examples
- *
- * @example
- * ```typescript
- * const CreateUserSchema = z.object({
- *   name: z.string().min(2),
- *   email: z.string().email(),
- * });
- *
- * @Post('/')
- * @ApiBody({
- *   description: 'User creation data',
- *   schema: CreateUserSchema,
- *   required: true,
- * })
- * createUser(@Body() data: z.infer<typeof CreateUserSchema>) { }
- * ```
- */
 export function ApiBody(options) {
     return (target, propertyKey, descriptor) => {
         Reflect.defineMetadata(API_BODY_METADATA, { ...options, required: options.required ?? true }, target, propertyKey);
         return descriptor;
     };
 }
-/**
- * Get body metadata from a method
- * @internal
- */
 export function getApiBody(target, propertyKey) {
     return Reflect.getMetadata(API_BODY_METADATA, target.prototype, propertyKey);
 }
-//# sourceMappingURL=api-body.decorator.js.map

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

@@ -1,71 +1,9 @@
 import 'reflect-metadata';
-/**
- * @ApiExcludeEndpoint() decorator
- *
- * Excludes an endpoint from the Swagger documentation.
- * The route will still work but won't appear in the docs.
- *
- * @example
- * ```typescript
- * @Controller('/users')
- * class UserController {
- *   @Get('/')
- *   listUsers() { } // Documented
- *
- *   @Get('/internal')
- *   @ApiExcludeEndpoint()
- *   internalEndpoint() { } // Not documented
- * }
- * ```
- */
 export declare function ApiExcludeEndpoint(): MethodDecorator;
-/**
- * @ApiExcludeController() decorator
- *
- * Excludes an entire controller from the Swagger documentation.
- * All routes in the controller will still work but won't appear in the docs.
- *
- * @example
- * ```typescript
- * @ApiExcludeController()
- * @Controller('/internal')
- * class InternalController {
- *   @Get('/health')
- *   health() { } // Not documented
- * }
- * ```
- */
 export declare function ApiExcludeController(): ClassDecorator;
-/**
- * Check if an endpoint is excluded from documentation
- * @internal
- */
 export declare function isApiExcluded(target: Function, propertyKey?: string | symbol): boolean;
-/**
- * @ApiDeprecated() decorator
- *
- * Marks an endpoint as deprecated in the documentation.
- * The endpoint will be styled differently in Swagger UI.
- *
- * @param message - Optional deprecation message
- *
- * @example
- * ```typescript
- * @Controller('/users')
- * class UserController {
- *   @Get('/v1')
- *   @ApiDeprecated('Use /v2 instead')
- *   legacyEndpoint() { }
- * }
- * ```
- */
 export declare function ApiDeprecated(message?: string): MethodDecorator;
-/**
- * Check if an endpoint is deprecated
- * @internal
- */
 export declare function getApiDeprecated(target: Function, propertyKey: string | symbol): {
     deprecated: boolean;
     message?: string;
 } | undefined;
-//# sourceMappingURL=api-exclude.decorator.d.ts.map

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

@@ -1,95 +1,31 @@
 import 'reflect-metadata';
 import { API_EXCLUDE_METADATA, API_DEPRECATED_METADATA } from '../constants.js';
-/**
- * @ApiExcludeEndpoint() decorator
- *
- * Excludes an endpoint from the Swagger documentation.
- * The route will still work but won't appear in the docs.
- *
- * @example
- * ```typescript
- * @Controller('/users')
- * class UserController {
- *   @Get('/')
- *   listUsers() { } // Documented
- *
- *   @Get('/internal')
- *   @ApiExcludeEndpoint()
- *   internalEndpoint() { } // Not documented
- * }
- * ```
- */
 export function ApiExcludeEndpoint() {
     return (target, propertyKey, descriptor) => {
         Reflect.defineMetadata(API_EXCLUDE_METADATA, true, target, propertyKey);
         return descriptor;
     };
 }
-/**
- * @ApiExcludeController() decorator
- *
- * Excludes an entire controller from the Swagger documentation.
- * All routes in the controller will still work but won't appear in the docs.
- *
- * @example
- * ```typescript
- * @ApiExcludeController()
- * @Controller('/internal')
- * class InternalController {
- *   @Get('/health')
- *   health() { } // Not documented
- * }
- * ```
- */
 export function ApiExcludeController() {
     return (target) => {
         Reflect.defineMetadata(API_EXCLUDE_METADATA, true, target);
     };
 }
-/**
- * Check if an endpoint is excluded from documentation
- * @internal
- */
 export function isApiExcluded(target, propertyKey) {
-    // Check class-level exclusion
     if (Reflect.getMetadata(API_EXCLUDE_METADATA, target) === true) {
         return true;
     }
-    // Check method-level exclusion
     if (propertyKey !== undefined) {
         return Reflect.getMetadata(API_EXCLUDE_METADATA, target.prototype, propertyKey) === true;
     }
     return false;
 }
-/**
- * @ApiDeprecated() decorator
- *
- * Marks an endpoint as deprecated in the documentation.
- * The endpoint will be styled differently in Swagger UI.
- *
- * @param message - Optional deprecation message
- *
- * @example
- * ```typescript
- * @Controller('/users')
- * class UserController {
- *   @Get('/v1')
- *   @ApiDeprecated('Use /v2 instead')
- *   legacyEndpoint() { }
- * }
- * ```
- */
 export function ApiDeprecated(message) {
     return (target, propertyKey, descriptor) => {
         Reflect.defineMetadata(API_DEPRECATED_METADATA, { deprecated: true, message }, target, propertyKey);
         return descriptor;
     };
 }
-/**
- * Check if an endpoint is deprecated
- * @internal
- */
 export function getApiDeprecated(target, propertyKey) {
     return Reflect.getMetadata(API_DEPRECATED_METADATA, target.prototype, propertyKey);
 }
-//# sourceMappingURL=api-exclude.decorator.js.map

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

@@ -1,25 +1,4 @@
 import 'reflect-metadata';
 import type { ApiHeaderOptions } from '../types.js';
-/**
- * @ApiHeader() decorator
- *
- * Documents a header parameter for an API operation.
- * Multiple @ApiHeader decorators can be applied for routes with multiple headers.
- *
- * @param options - Header options including name, description, and required flag
- *
- * @example
- * ```typescript
- * @Get('/')
- * @ApiHeader({ name: 'X-Request-ID', description: 'Unique request identifier', required: true })
- * @ApiHeader({ name: 'X-Correlation-ID', description: 'Correlation ID for tracing' })
- * listUsers() { }
- * ```
- */
 export declare function ApiHeader(options: ApiHeaderOptions): MethodDecorator;
-/**
- * Get all header parameter metadata from a method
- * @internal
- */
 export declare function getApiHeaders(target: Function, propertyKey: string | symbol): ApiHeaderOptions[];
-//# sourceMappingURL=api-header.decorator.d.ts.map

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

@@ -1,21 +1,5 @@
 import 'reflect-metadata';
 import { API_HEADER_METADATA } from '../constants.js';
-/**
- * @ApiHeader() decorator
- *
- * Documents a header parameter for an API operation.
- * Multiple @ApiHeader decorators can be applied for routes with multiple headers.
- *
- * @param options - Header options including name, description, and required flag
- *
- * @example
- * ```typescript
- * @Get('/')
- * @ApiHeader({ name: 'X-Request-ID', description: 'Unique request identifier', required: true })
- * @ApiHeader({ name: 'X-Correlation-ID', description: 'Correlation ID for tracing' })
- * listUsers() { }
- * ```
- */
 export function ApiHeader(options) {
     return (target, propertyKey, descriptor) => {
         const existingHeaders = Reflect.getMetadata(API_HEADER_METADATA, target, propertyKey) ?? [];
@@ -23,11 +7,6 @@ export function ApiHeader(options) {
         return descriptor;
     };
 }
-/**
- * Get all header parameter metadata from a method
- * @internal
- */
 export function getApiHeaders(target, propertyKey) {
     return Reflect.getMetadata(API_HEADER_METADATA, target.prototype, propertyKey) ?? [];
 }
-//# sourceMappingURL=api-header.decorator.js.map

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

@@ -1,32 +1,4 @@
 import 'reflect-metadata';
 import type { ApiOperationOptions } from '../types.js';
-/**
- * @ApiOperation() decorator
- *
- * Describes a single API operation (endpoint) with summary, description,
- * and other OpenAPI operation metadata.
- *
- * @param options - Operation options
- *
- * @example
- * ```typescript
- * @Controller('/users')
- * class UserController {
- *   @Get('/:id')
- *   @ApiOperation({
- *     summary: 'Get user by ID',
- *     description: 'Retrieves a single user by their unique identifier',
- *     operationId: 'getUserById',
- *     deprecated: false,
- *   })
- *   getUser(@Param('id') id: string) { }
- * }
- * ```
- */
 export declare function ApiOperation(options: ApiOperationOptions): MethodDecorator;
-/**
- * Get operation metadata from a method
- * @internal
- */
 export declare function getApiOperation(target: Function, propertyKey: string | symbol): ApiOperationOptions | undefined;
-//# sourceMappingURL=api-operation.decorator.d.ts.map

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

@@ -1,39 +1,11 @@
 import 'reflect-metadata';
 import { API_OPERATION_METADATA } from '../constants.js';
-/**
- * @ApiOperation() decorator
- *
- * Describes a single API operation (endpoint) with summary, description,
- * and other OpenAPI operation metadata.
- *
- * @param options - Operation options
- *
- * @example
- * ```typescript
- * @Controller('/users')
- * class UserController {
- *   @Get('/:id')
- *   @ApiOperation({
- *     summary: 'Get user by ID',
- *     description: 'Retrieves a single user by their unique identifier',
- *     operationId: 'getUserById',
- *     deprecated: false,
- *   })
- *   getUser(@Param('id') id: string) { }
- * }
- * ```
- */
 export function ApiOperation(options) {
     return (target, propertyKey, descriptor) => {
         Reflect.defineMetadata(API_OPERATION_METADATA, options, target, propertyKey);
         return descriptor;
     };
 }
-/**
- * Get operation metadata from a method
- * @internal
- */
 export function getApiOperation(target, propertyKey) {
     return Reflect.getMetadata(API_OPERATION_METADATA, target.prototype, propertyKey);
 }
-//# sourceMappingURL=api-operation.decorator.js.map

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

@@ -1,28 +1,4 @@
 import 'reflect-metadata';
 import type { ApiParamOptions } from '../types.js';
-/**
- * @ApiParam() decorator
- *
- * Documents a path parameter for an API operation.
- * Multiple @ApiParam decorators can be applied for routes with multiple parameters.
- *
- * @param options - Parameter options including name, description, and type
- *
- * @example
- * ```typescript
- * @Get('/:userId/posts/:postId')
- * @ApiParam({ name: 'userId', description: 'User ID', type: 'string', format: 'uuid' })
- * @ApiParam({ name: 'postId', description: 'Post ID', type: 'integer' })
- * getUserPost(
- *   @Param('userId') userId: string,
- *   @Param('postId') postId: number
- * ) { }
- * ```
- */
 export declare function ApiParam(options: ApiParamOptions): MethodDecorator;
-/**
- * Get all path parameter metadata from a method
- * @internal
- */
 export declare function getApiParams(target: Function, propertyKey: string | symbol): ApiParamOptions[];
-//# sourceMappingURL=api-param.decorator.d.ts.map

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

@@ -1,24 +1,5 @@
 import 'reflect-metadata';
 import { API_PARAM_METADATA } from '../constants.js';
-/**
- * @ApiParam() decorator
- *
- * Documents a path parameter for an API operation.
- * Multiple @ApiParam decorators can be applied for routes with multiple parameters.
- *
- * @param options - Parameter options including name, description, and type
- *
- * @example
- * ```typescript
- * @Get('/:userId/posts/:postId')
- * @ApiParam({ name: 'userId', description: 'User ID', type: 'string', format: 'uuid' })
- * @ApiParam({ name: 'postId', description: 'Post ID', type: 'integer' })
- * getUserPost(
- *   @Param('userId') userId: string,
- *   @Param('postId') postId: number
- * ) { }
- * ```
- */
 export function ApiParam(options) {
     return (target, propertyKey, descriptor) => {
         const existingParams = Reflect.getMetadata(API_PARAM_METADATA, target, propertyKey) ?? [];
@@ -26,11 +7,6 @@ export function ApiParam(options) {
         return descriptor;
     };
 }
-/**
- * Get all path parameter metadata from a method
- * @internal
- */
 export function getApiParams(target, propertyKey) {
     return Reflect.getMetadata(API_PARAM_METADATA, target.prototype, propertyKey) ?? [];
 }
-//# sourceMappingURL=api-param.decorator.js.map

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

@@ -1,69 +1,11 @@
 import 'reflect-metadata';
 import type { ApiPropertyOptions } from '../types.js';
-/**
- * Stored property metadata structure
- */
 interface StoredPropertyMetadata {
     propertyKey: string | symbol;
     options: ApiPropertyOptions;
 }
-/**
- * @ApiProperty() decorator
- *
- * Documents a property of a DTO class for schema generation.
- * Used when you want to manually define schema properties instead of using Zod.
- *
- * @param options - Property options including type, description, and validation rules
- *
- * @example
- * ```typescript
- * class CreateUserDto {
- *   @ApiProperty({
- *     description: 'User email address',
- *     type: 'string',
- *     format: 'email',
- *     example: 'user@example.com',
- *     required: true,
- *   })
- *   email!: string;
- *
- *   @ApiProperty({
- *     description: 'User age',
- *     type: 'integer',
- *     minimum: 0,
- *     maximum: 150,
- *     required: false,
- *   })
- *   age?: number;
- *
- *   @ApiProperty({
- *     description: 'User role',
- *     enum: ['admin', 'user', 'guest'],
- *     default: 'user',
- *   })
- *   role!: string;
- * }
- * ```
- */
 export declare function ApiProperty(options?: ApiPropertyOptions): PropertyDecorator;
-/**
- * @ApiPropertyOptional() decorator
- *
- * Shorthand for @ApiProperty({ required: false }).
- * Marks a property as optional in the schema.
- */
 export declare function ApiPropertyOptional(options?: Omit<ApiPropertyOptions, 'required'>): PropertyDecorator;
-/**
- * @ApiHideProperty() decorator
- *
- * Excludes a property from the generated schema.
- * Useful for internal properties that shouldn't be documented.
- */
 export declare function ApiHideProperty(): PropertyDecorator;
-/**
- * Get all property metadata from a class
- * @internal
- */
 export declare function getApiProperties(target: Function): StoredPropertyMetadata[];
 export {};
-//# sourceMappingURL=api-property.decorator.d.ts.map