@riktajs/swagger 0.1.0

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

@@ -0,0 +1,33 @@
+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) ?? [];
+        Reflect.defineMetadata(API_HEADER_METADATA, [...existingHeaders, options], target, propertyKey);
+        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-header.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-header.decorator.js","sourceRoot":"","sources":["../../src/decorators/api-header.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAGtD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,SAAS,CAAC,OAAyB;IACjD,OAAO,CACL,MAAc,EACd,WAA4B,EAC5B,UAA8B,EACV,EAAE;QACtB,MAAM,eAAe,GACnB,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;QAEtE,OAAO,CAAC,cAAc,CACpB,mBAAmB,EACnB,CAAC,GAAG,eAAe,EAAE,OAAO,CAAC,EAC7B,MAAM,EACN,WAAW,CACZ,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAgB,EAChB,WAA4B;IAE5B,OAAO,OAAO,CAAC,WAAW,CAAC,mBAAmB,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;AACvF,CAAC"}

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

@@ -0,0 +1,32 @@
+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.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-operation.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/api-operation.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,eAAe,CAc1E;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,QAAQ,EAChB,WAAW,EAAE,MAAM,GAAG,MAAM,GAC3B,mBAAmB,GAAG,SAAS,CAEjC"}

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

@@ -0,0 +1,39 @@
+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-operation.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-operation.decorator.js","sourceRoot":"","sources":["../../src/decorators/api-operation.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAGzD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,YAAY,CAAC,OAA4B;IACvD,OAAO,CACL,MAAc,EACd,WAA4B,EAC5B,UAA8B,EACV,EAAE;QACtB,OAAO,CAAC,cAAc,CACpB,sBAAsB,EACtB,OAAO,EACP,MAAM,EACN,WAAW,CACZ,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAgB,EAChB,WAA4B;IAE5B,OAAO,OAAO,CAAC,WAAW,CAAC,sBAAsB,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;AACpF,CAAC"}

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

@@ -0,0 +1,28 @@
+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.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-param.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/api-param.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,eAAe,CAiBlE;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,MAAM,EAAE,QAAQ,EAChB,WAAW,EAAE,MAAM,GAAG,MAAM,GAC3B,eAAe,EAAE,CAEnB"}

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

@@ -0,0 +1,36 @@
+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) ?? [];
+        Reflect.defineMetadata(API_PARAM_METADATA, [...existingParams, { ...options, required: options.required ?? true }], target, propertyKey);
+        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-param.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-param.decorator.js","sourceRoot":"","sources":["../../src/decorators/api-param.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAGrD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAwB;IAC/C,OAAO,CACL,MAAc,EACd,WAA4B,EAC5B,UAA8B,EACV,EAAE;QACtB,MAAM,cAAc,GAClB,OAAO,CAAC,WAAW,CAAC,kBAAkB,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;QAErE,OAAO,CAAC,cAAc,CACpB,kBAAkB,EAClB,CAAC,GAAG,cAAc,EAAE,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC,EACvE,MAAM,EACN,WAAW,CACZ,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAC1B,MAAgB,EAChB,WAA4B;IAE5B,OAAO,OAAO,CAAC,WAAW,CAAC,kBAAkB,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;AACtF,CAAC"}

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

@@ -0,0 +1,69 @@
+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

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-property.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/api-property.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtD;;GAEG;AACH,UAAU,sBAAsB;IAC9B,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,OAAO,EAAE,kBAAkB,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,WAAW,CAAC,OAAO,GAAE,kBAAuB,GAAG,iBAAiB,CAW/E;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,UAAU,CAAM,GACjD,iBAAiB,CAEnB;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,IAAI,iBAAiB,CAYnD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,QAAQ,GAAG,sBAAsB,EAAE,CAE3E"}

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

@@ -0,0 +1,76 @@
+import 'reflect-metadata';
+import { API_PROPERTY_METADATA } from '../constants.js';
+/**
+ * @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 function ApiProperty(options = {}) {
+    return (target, propertyKey) => {
+        const existingProperties = Reflect.getMetadata(API_PROPERTY_METADATA, target.constructor) ?? [];
+        Reflect.defineMetadata(API_PROPERTY_METADATA, [...existingProperties, { propertyKey, options }], target.constructor);
+    };
+}
+/**
+ * @ApiPropertyOptional() decorator
+ *
+ * Shorthand for @ApiProperty({ required: false }).
+ * Marks a property as optional in the schema.
+ */
+export function ApiPropertyOptional(options = {}) {
+    return ApiProperty({ ...options, required: false });
+}
+/**
+ * @ApiHideProperty() decorator
+ *
+ * Excludes a property from the generated schema.
+ * Useful for internal properties that shouldn't be documented.
+ */
+export function ApiHideProperty() {
+    return (target, propertyKey) => {
+        const existingProperties = Reflect.getMetadata(API_PROPERTY_METADATA, target.constructor) ?? [];
+        // Add property with special flag to hide it
+        Reflect.defineMetadata(API_PROPERTY_METADATA, [...existingProperties, { propertyKey, options: { _hidden: true } }], target.constructor);
+    };
+}
+/**
+ * Get all property metadata from a class
+ * @internal
+ */
+export function getApiProperties(target) {
+    return Reflect.getMetadata(API_PROPERTY_METADATA, target) ?? [];
+}
+//# sourceMappingURL=api-property.decorator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-property.decorator.js","sourceRoot":"","sources":["../../src/decorators/api-property.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAWxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,WAAW,CAAC,UAA8B,EAAE;IAC1D,OAAO,CAAC,MAAc,EAAE,WAA4B,EAAQ,EAAE;QAC5D,MAAM,kBAAkB,GACtB,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAEvE,OAAO,CAAC,cAAc,CACpB,qBAAqB,EACrB,CAAC,GAAG,kBAAkB,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,EACjD,MAAM,CAAC,WAAW,CACnB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAAgD,EAAE;IAElD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,CAAC,MAAc,EAAE,WAA4B,EAAQ,EAAE;QAC5D,MAAM,kBAAkB,GACtB,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAEvE,4CAA4C;QAC5C,OAAO,CAAC,cAAc,CACpB,qBAAqB,EACrB,CAAC,GAAG,kBAAkB,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAwB,EAAE,CAAC,EAC1F,MAAM,CAAC,WAAW,CACnB,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAgB;IAC/C,OAAO,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC;AAClE,CAAC"}

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

@@ -0,0 +1,30 @@
+import 'reflect-metadata';
+import type { ApiQueryOptions } from '../types.js';
+/**
+ * @ApiQuery() decorator
+ *
+ * Documents a query parameter for an API operation.
+ * Multiple @ApiQuery decorators can be applied for routes with multiple query parameters.
+ *
+ * @param options - Query parameter options including name, description, and type
+ *
+ * @example
+ * ```typescript
+ * @Get('/')
+ * @ApiQuery({ name: 'page', description: 'Page number', type: 'integer', required: false })
+ * @ApiQuery({ name: 'limit', description: 'Items per page', type: 'integer', required: false })
+ * @ApiQuery({ name: 'sort', description: 'Sort order', enum: ['asc', 'desc'] })
+ * listUsers(
+ *   @Query('page') page?: number,
+ *   @Query('limit') limit?: number,
+ *   @Query('sort') sort?: string
+ * ) { }
+ * ```
+ */
+export declare function ApiQuery(options: ApiQueryOptions): MethodDecorator;
+/**
+ * Get all query parameter metadata from a method
+ * @internal
+ */
+export declare function getApiQueries(target: Function, propertyKey: string | symbol): ApiQueryOptions[];
+//# sourceMappingURL=api-query.decorator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-query.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/api-query.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,eAAe,CAiBlE;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,QAAQ,EAChB,WAAW,EAAE,MAAM,GAAG,MAAM,GAC3B,eAAe,EAAE,CAEnB"}

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

@@ -0,0 +1,38 @@
+import 'reflect-metadata';
+import { API_QUERY_METADATA } from '../constants.js';
+/**
+ * @ApiQuery() decorator
+ *
+ * Documents a query parameter for an API operation.
+ * Multiple @ApiQuery decorators can be applied for routes with multiple query parameters.
+ *
+ * @param options - Query parameter options including name, description, and type
+ *
+ * @example
+ * ```typescript
+ * @Get('/')
+ * @ApiQuery({ name: 'page', description: 'Page number', type: 'integer', required: false })
+ * @ApiQuery({ name: 'limit', description: 'Items per page', type: 'integer', required: false })
+ * @ApiQuery({ name: 'sort', description: 'Sort order', enum: ['asc', 'desc'] })
+ * listUsers(
+ *   @Query('page') page?: number,
+ *   @Query('limit') limit?: number,
+ *   @Query('sort') sort?: string
+ * ) { }
+ * ```
+ */
+export function ApiQuery(options) {
+    return (target, propertyKey, descriptor) => {
+        const existingQueries = Reflect.getMetadata(API_QUERY_METADATA, target, propertyKey) ?? [];
+        Reflect.defineMetadata(API_QUERY_METADATA, [...existingQueries, { ...options, required: options.required ?? false }], target, propertyKey);
+        return descriptor;
+    };
+}
+/**
+ * Get all query parameter metadata from a method
+ * @internal
+ */
+export function getApiQueries(target, propertyKey) {
+    return Reflect.getMetadata(API_QUERY_METADATA, target.prototype, propertyKey) ?? [];
+}
+//# sourceMappingURL=api-query.decorator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-query.decorator.js","sourceRoot":"","sources":["../../src/decorators/api-query.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAGrD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAwB;IAC/C,OAAO,CACL,MAAc,EACd,WAA4B,EAC5B,UAA8B,EACV,EAAE;QACtB,MAAM,eAAe,GACnB,OAAO,CAAC,WAAW,CAAC,kBAAkB,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;QAErE,OAAO,CAAC,cAAc,CACpB,kBAAkB,EAClB,CAAC,GAAG,eAAe,EAAE,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK,EAAE,CAAC,EACzE,MAAM,EACN,WAAW,CACZ,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAgB,EAChB,WAA4B;IAE5B,OAAO,OAAO,CAAC,WAAW,CAAC,kBAAkB,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;AACtF,CAAC"}

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

@@ -0,0 +1,70 @@
+import 'reflect-metadata';
+import type { ApiResponseOptions } from '../types.js';
+/**
+ * @ApiResponse() decorator
+ *
+ * Documents a possible response for an API operation.
+ * Multiple @ApiResponse decorators can be applied to document different response scenarios.
+ *
+ * @param options - Response options including status code, description, and schema
+ *
+ * @example
+ * ```typescript
+ * @Get('/:id')
+ * @ApiResponse({ status: 200, description: 'User found', schema: UserSchema })
+ * @ApiResponse({ status: 404, description: 'User not found' })
+ * @ApiResponse({ status: 500, description: 'Internal server error' })
+ * getUser(@Param('id') id: string) { }
+ * ```
+ */
+export declare function ApiResponse(options: ApiResponseOptions): MethodDecorator;
+/**
+ * @ApiOkResponse() - Shorthand for 200 OK response
+ */
+export declare function ApiOkResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiCreatedResponse() - Shorthand for 201 Created response
+ */
+export declare function ApiCreatedResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiAcceptedResponse() - Shorthand for 202 Accepted response
+ */
+export declare function ApiAcceptedResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiNoContentResponse() - Shorthand for 204 No Content response
+ */
+export declare function ApiNoContentResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiBadRequestResponse() - Shorthand for 400 Bad Request response
+ */
+export declare function ApiBadRequestResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiUnauthorizedResponse() - Shorthand for 401 Unauthorized response
+ */
+export declare function ApiUnauthorizedResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiForbiddenResponse() - Shorthand for 403 Forbidden response
+ */
+export declare function ApiForbiddenResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiNotFoundResponse() - Shorthand for 404 Not Found response
+ */
+export declare function ApiNotFoundResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiConflictResponse() - Shorthand for 409 Conflict response
+ */
+export declare function ApiConflictResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiUnprocessableEntityResponse() - Shorthand for 422 Unprocessable Entity response
+ */
+export declare function ApiUnprocessableEntityResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * @ApiInternalServerErrorResponse() - Shorthand for 500 Internal Server Error response
+ */
+export declare function ApiInternalServerErrorResponse(options?: Omit<ApiResponseOptions, 'status'>): MethodDecorator;
+/**
+ * Get all response metadata from a method
+ * @internal
+ */
+export declare function getApiResponses(target: Function, propertyKey: string | symbol): ApiResponseOptions[];
+//# sourceMappingURL=api-response.decorator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-response.decorator.d.ts","sourceRoot":"","sources":["../../src/decorators/api-response.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEtD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,eAAe,CAiBxE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAC5C,OAAO,GAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAM,GAC/C,eAAe,CAEjB;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,QAAQ,EAChB,WAAW,EAAE,MAAM,GAAG,MAAM,GAC3B,kBAAkB,EAAE,CAEtB"}

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

@@ -0,0 +1,100 @@
+import 'reflect-metadata';
+import { API_RESPONSE_METADATA } from '../constants.js';
+/**
+ * @ApiResponse() decorator
+ *
+ * Documents a possible response for an API operation.
+ * Multiple @ApiResponse decorators can be applied to document different response scenarios.
+ *
+ * @param options - Response options including status code, description, and schema
+ *
+ * @example
+ * ```typescript
+ * @Get('/:id')
+ * @ApiResponse({ status: 200, description: 'User found', schema: UserSchema })
+ * @ApiResponse({ status: 404, description: 'User not found' })
+ * @ApiResponse({ status: 500, description: 'Internal server error' })
+ * getUser(@Param('id') id: string) { }
+ * ```
+ */
+export function ApiResponse(options) {
+    return (target, propertyKey, descriptor) => {
+        const existingResponses = Reflect.getMetadata(API_RESPONSE_METADATA, target, propertyKey) ?? [];
+        Reflect.defineMetadata(API_RESPONSE_METADATA, [...existingResponses, options], target, propertyKey);
+        return descriptor;
+    };
+}
+/**
+ * @ApiOkResponse() - Shorthand for 200 OK response
+ */
+export function ApiOkResponse(options = {}) {
+    return ApiResponse({ ...options, status: 200 });
+}
+/**
+ * @ApiCreatedResponse() - Shorthand for 201 Created response
+ */
+export function ApiCreatedResponse(options = {}) {
+    return ApiResponse({ ...options, status: 201 });
+}
+/**
+ * @ApiAcceptedResponse() - Shorthand for 202 Accepted response
+ */
+export function ApiAcceptedResponse(options = {}) {
+    return ApiResponse({ ...options, status: 202 });
+}
+/**
+ * @ApiNoContentResponse() - Shorthand for 204 No Content response
+ */
+export function ApiNoContentResponse(options = {}) {
+    return ApiResponse({ ...options, status: 204 });
+}
+/**
+ * @ApiBadRequestResponse() - Shorthand for 400 Bad Request response
+ */
+export function ApiBadRequestResponse(options = {}) {
+    return ApiResponse({ ...options, status: 400, description: options.description ?? 'Bad Request' });
+}
+/**
+ * @ApiUnauthorizedResponse() - Shorthand for 401 Unauthorized response
+ */
+export function ApiUnauthorizedResponse(options = {}) {
+    return ApiResponse({ ...options, status: 401, description: options.description ?? 'Unauthorized' });
+}
+/**
+ * @ApiForbiddenResponse() - Shorthand for 403 Forbidden response
+ */
+export function ApiForbiddenResponse(options = {}) {
+    return ApiResponse({ ...options, status: 403, description: options.description ?? 'Forbidden' });
+}
+/**
+ * @ApiNotFoundResponse() - Shorthand for 404 Not Found response
+ */
+export function ApiNotFoundResponse(options = {}) {
+    return ApiResponse({ ...options, status: 404, description: options.description ?? 'Not Found' });
+}
+/**
+ * @ApiConflictResponse() - Shorthand for 409 Conflict response
+ */
+export function ApiConflictResponse(options = {}) {
+    return ApiResponse({ ...options, status: 409, description: options.description ?? 'Conflict' });
+}
+/**
+ * @ApiUnprocessableEntityResponse() - Shorthand for 422 Unprocessable Entity response
+ */
+export function ApiUnprocessableEntityResponse(options = {}) {
+    return ApiResponse({ ...options, status: 422, description: options.description ?? 'Unprocessable Entity' });
+}
+/**
+ * @ApiInternalServerErrorResponse() - Shorthand for 500 Internal Server Error response
+ */
+export function ApiInternalServerErrorResponse(options = {}) {
+    return ApiResponse({ ...options, status: 500, description: options.description ?? 'Internal Server Error' });
+}
+/**
+ * Get all response metadata from a method
+ * @internal
+ */
+export function getApiResponses(target, propertyKey) {
+    return Reflect.getMetadata(API_RESPONSE_METADATA, target.prototype, propertyKey) ?? [];
+}
+//# sourceMappingURL=api-response.decorator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api-response.decorator.js","sourceRoot":"","sources":["../../src/decorators/api-response.decorator.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAGxD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,WAAW,CAAC,OAA2B;IACrD,OAAO,CACL,MAAc,EACd,WAA4B,EAC5B,UAA8B,EACV,EAAE;QACtB,MAAM,iBAAiB,GACrB,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;QAExE,OAAO,CAAC,cAAc,CACpB,qBAAqB,EACrB,CAAC,GAAG,iBAAiB,EAAE,OAAO,CAAC,EAC/B,MAAM,EACN,WAAW,CACZ,CAAC;QACF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAC3B,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,aAAa,EAAE,CAAC,CAAC;AACrG,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACrC,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,cAAc,EAAE,CAAC,CAAC;AACtG,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,WAAW,EAAE,CAAC,CAAC;AACnG,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,WAAW,EAAE,CAAC,CAAC;AACnG,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,UAAU,EAAE,CAAC,CAAC;AAClG,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC5C,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,sBAAsB,EAAE,CAAC,CAAC;AAC9G,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAC5C,UAA8C,EAAE;IAEhD,OAAO,WAAW,CAAC,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,uBAAuB,EAAE,CAAC,CAAC;AAC/G,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAC7B,MAAgB,EAChB,WAA4B;IAE5B,OAAO,OAAO,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;AACzF,CAAC"}