@skmtc/core 0.0.789 → 0.0.791

package/script/oas/parameter/Parameter.d.ts

@@ -6,21 +6,181 @@ import type { OasExample } from '../example/Example.js';
 import type { OasSchema } from '../schema/Schema.js';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
+/**
+ * Constructor fields for {@link OasParameter}.
+ */
 export type ParameterFields = {
+    /** The name of the parameter */
     name: string;
+    /** The location of the parameter (path, query, header, cookie) */
     location: OasParameterLocation;
+    /** A brief description of the parameter */
     description?: string | undefined;
+    /** Determines whether this parameter is mandatory */
     required?: boolean | undefined;
+    /** Specifies that the parameter is deprecated */
     deprecated?: boolean | undefined;
+    /** Whether to allow empty values for the parameter */
     allowEmptyValue?: boolean | undefined;
+    /** Whether reserved characters are allowed in the parameter value */
     allowReserved?: boolean | undefined;
+    /** The schema defining the parameter's data type */
     schema?: OasSchema | OasRef<'schema'> | undefined;
+    /** Example values for the parameter */
     examples?: Record<string, OasExample | OasRef<'example'>> | undefined;
+    /** Media type definitions for the parameter content */
     content?: Record<string, OasMediaType> | undefined;
+    /** The serialization style for the parameter */
     style: OasParameterStyle;
+    /** Whether to explode parameter values */
     explode: boolean;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Parameter Object in the OpenAPI Specification.
+ *
+ * The `OasParameter` class encapsulates the definition of a single operation parameter,
+ * including its location, data type, validation rules, and serialization behavior.
+ * Parameters can be located in the path, query string, headers, or cookies.
+ *
+ * This class provides comprehensive support for parameter validation, serialization
+ * styles, and complex data types through schema definitions or content specifications.
+ *
+ * ## Key Features
+ *
+ * - **Location Support**: Path, query, header, and cookie parameters
+ * - **Schema Validation**: Comprehensive data type validation through schemas
+ * - **Serialization Styles**: Various parameter serialization formats
+ * - **Content Types**: Support for complex parameter content with media types
+ * - **Examples & Documentation**: Parameter examples and descriptive documentation
+ * - **Advanced Options**: Empty values, reserved characters, and explode behavior
+ *
+ * @example Basic path parameter
+ * ```typescript
+ * import { OasParameter, OasString } from '@skmtc/core';
+ *
+ * const userIdParam = new OasParameter({
+ *   name: 'userId',
+ *   location: 'path',
+ *   description: 'Unique identifier for the user',
+ *   required: true,
+ *   schema: new OasString({
+ *     pattern: '^[0-9a-f]{24}$',
+ *     example: '507f1f77bcf86cd799439011'
+ *   }),
+ *   style: 'simple',
+ *   explode: false
+ * });
+ *
+ * // Used in path: /users/{userId}
+ * ```
+ *
+ * @example Query parameter with validation
+ * ```typescript
+ * const pageSizeParam = new OasParameter({
+ *   name: 'pageSize',
+ *   location: 'query',
+ *   description: 'Number of items to return per page',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 1,
+ *     maximum: 100,
+ *     default: 20
+ *   }),
+ *   style: 'form',
+ *   explode: true,
+ *   examples: {
+ *     small: new OasExample({ value: 10 }),
+ *     medium: new OasExample({ value: 25 }),
+ *     large: new OasExample({ value: 50 })
+ *   }
+ * });
+ *
+ * // Used in query: ?pageSize=20
+ * ```
+ *
+ * @example Header parameter
+ * ```typescript
+ * const authHeaderParam = new OasParameter({
+ *   name: 'Authorization',
+ *   location: 'header',
+ *   description: 'Bearer token for authentication',
+ *   required: true,
+ *   schema: new OasString({
+ *     pattern: '^Bearer [A-Za-z0-9+/=]+$',
+ *     example: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
+ *   }),
+ *   style: 'simple',
+ *   explode: false
+ * });
+ * ```
+ *
+ * @example Complex parameter with content
+ * ```typescript
+ * const filterParam = new OasParameter({
+ *   name: 'filter',
+ *   location: 'query',
+ *   description: 'Complex filter object',
+ *   required: false,
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           category: new OasString(),
+ *           priceRange: new OasObject({
+ *             properties: {
+ *               min: new OasNumber(),
+ *               max: new OasNumber()
+ *             }
+ *           })
+ *         }
+ *       })
+ *     })
+ *   },
+ *   style: 'deepObject',
+ *   explode: true
+ * });
+ *
+ * // Used as: ?filter[category]=electronics&filter[priceRange][min]=100
+ * ```
+ *
+ * @example Array parameter with explode
+ * ```typescript
+ * const tagsParam = new OasParameter({
+ *   name: 'tags',
+ *   location: 'query',
+ *   description: 'Filter by multiple tags',
+ *   required: false,
+ *   schema: new OasArray({
+ *     items: new OasString(),
+ *     minItems: 1,
+ *     maxItems: 10
+ *   }),
+ *   style: 'form',
+ *   explode: true // Results in: ?tags=tech&tags=api&tags=rest
+ * });
+ *
+ * // Without explode: ?tags=tech,api,rest
+ * // With explode: ?tags=tech&tags=api&tags=rest
+ * ```
+ *
+ * @example Cookie parameter
+ * ```typescript
+ * const sessionParam = new OasParameter({
+ *   name: 'sessionId',
+ *   location: 'cookie',
+ *   description: 'Session identifier cookie',
+ *   required: false,
+ *   schema: new OasString({
+ *     minLength: 32,
+ *     maxLength: 128
+ *   }),
+ *   style: 'form',
+ *   explode: false
+ * });
+ * ```
+ */
 export declare class OasParameter {
     oasType: 'parameter';
     name: string;

package/script/oas/parameter/Parameter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Parameter.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/Parameter.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACnF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAK9C,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACnC,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,KAAK,EAAE,iBAAiB,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,YAAY;IACvB,OAAO,EAAE,WAAW,CAAc;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACnC,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,KAAK,EAAE,iBAAiB,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,eAAe;IAkBnC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC;IAIpC,OAAO,IAAI,YAAY;IAIvB,WAAW,IAAI,YAAY;IAI3B,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAc9E,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAuBtE"}
+{"version":3,"file":"Parameter.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/Parameter.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACnF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAK9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,kEAAkE;IAClE,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,iDAAiD;IACjD,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,sDAAsD;IACtD,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,qEAAqE;IACrE,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACnC,oDAAoD;IACpD,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,gDAAgD;IAChD,KAAK,EAAE,iBAAiB,CAAA;IACxB,0CAA0C;IAC1C,OAAO,EAAE,OAAO,CAAA;IAChB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+IG;AACH,qBAAa,YAAY;IACvB,OAAO,EAAE,WAAW,CAAc;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACnC,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,KAAK,EAAE,iBAAiB,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,eAAe;IAkBnC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC;IAIpC,OAAO,IAAI,YAAY;IAIvB,WAAW,IAAI,YAAY;IAI3B,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAc9E,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAuBtE"}

package/script/oas/parameter/Parameter.js

@@ -2,6 +2,150 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasParameter = void 0;
 require("../../_dnt.polyfills.js");
+/**
+ * Represents a Parameter Object in the OpenAPI Specification.
+ *
+ * The `OasParameter` class encapsulates the definition of a single operation parameter,
+ * including its location, data type, validation rules, and serialization behavior.
+ * Parameters can be located in the path, query string, headers, or cookies.
+ *
+ * This class provides comprehensive support for parameter validation, serialization
+ * styles, and complex data types through schema definitions or content specifications.
+ *
+ * ## Key Features
+ *
+ * - **Location Support**: Path, query, header, and cookie parameters
+ * - **Schema Validation**: Comprehensive data type validation through schemas
+ * - **Serialization Styles**: Various parameter serialization formats
+ * - **Content Types**: Support for complex parameter content with media types
+ * - **Examples & Documentation**: Parameter examples and descriptive documentation
+ * - **Advanced Options**: Empty values, reserved characters, and explode behavior
+ *
+ * @example Basic path parameter
+ * ```typescript
+ * import { OasParameter, OasString } from '@skmtc/core';
+ *
+ * const userIdParam = new OasParameter({
+ *   name: 'userId',
+ *   location: 'path',
+ *   description: 'Unique identifier for the user',
+ *   required: true,
+ *   schema: new OasString({
+ *     pattern: '^[0-9a-f]{24}$',
+ *     example: '507f1f77bcf86cd799439011'
+ *   }),
+ *   style: 'simple',
+ *   explode: false
+ * });
+ *
+ * // Used in path: /users/{userId}
+ * ```
+ *
+ * @example Query parameter with validation
+ * ```typescript
+ * const pageSizeParam = new OasParameter({
+ *   name: 'pageSize',
+ *   location: 'query',
+ *   description: 'Number of items to return per page',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 1,
+ *     maximum: 100,
+ *     default: 20
+ *   }),
+ *   style: 'form',
+ *   explode: true,
+ *   examples: {
+ *     small: new OasExample({ value: 10 }),
+ *     medium: new OasExample({ value: 25 }),
+ *     large: new OasExample({ value: 50 })
+ *   }
+ * });
+ *
+ * // Used in query: ?pageSize=20
+ * ```
+ *
+ * @example Header parameter
+ * ```typescript
+ * const authHeaderParam = new OasParameter({
+ *   name: 'Authorization',
+ *   location: 'header',
+ *   description: 'Bearer token for authentication',
+ *   required: true,
+ *   schema: new OasString({
+ *     pattern: '^Bearer [A-Za-z0-9+/=]+$',
+ *     example: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
+ *   }),
+ *   style: 'simple',
+ *   explode: false
+ * });
+ * ```
+ *
+ * @example Complex parameter with content
+ * ```typescript
+ * const filterParam = new OasParameter({
+ *   name: 'filter',
+ *   location: 'query',
+ *   description: 'Complex filter object',
+ *   required: false,
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           category: new OasString(),
+ *           priceRange: new OasObject({
+ *             properties: {
+ *               min: new OasNumber(),
+ *               max: new OasNumber()
+ *             }
+ *           })
+ *         }
+ *       })
+ *     })
+ *   },
+ *   style: 'deepObject',
+ *   explode: true
+ * });
+ *
+ * // Used as: ?filter[category]=electronics&filter[priceRange][min]=100
+ * ```
+ *
+ * @example Array parameter with explode
+ * ```typescript
+ * const tagsParam = new OasParameter({
+ *   name: 'tags',
+ *   location: 'query',
+ *   description: 'Filter by multiple tags',
+ *   required: false,
+ *   schema: new OasArray({
+ *     items: new OasString(),
+ *     minItems: 1,
+ *     maxItems: 10
+ *   }),
+ *   style: 'form',
+ *   explode: true // Results in: ?tags=tech&tags=api&tags=rest
+ * });
+ *
+ * // Without explode: ?tags=tech,api,rest
+ * // With explode: ?tags=tech&tags=api&tags=rest
+ * ```
+ *
+ * @example Cookie parameter
+ * ```typescript
+ * const sessionParam = new OasParameter({
+ *   name: 'sessionId',
+ *   location: 'cookie',
+ *   description: 'Session identifier cookie',
+ *   required: false,
+ *   schema: new OasString({
+ *     minLength: 32,
+ *     maxLength: 128
+ *   }),
+ *   style: 'form',
+ *   explode: false
+ * });
+ * ```
+ */
 class OasParameter {
     constructor(fields) {
         Object.defineProperty(this, "oasType", {

package/script/oas/response/Response.d.ts

@@ -5,12 +5,202 @@ import type { OasRef } from '../ref/Ref.js';
 import type { OasSchema } from '../schema/Schema.js';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
+/**
+ * Constructor fields for {@link OasResponse}.
+ */
 export type ResponseFields = {
+    /** A description of the response */
     description?: string | undefined;
+    /** Response headers that can be sent */
     headers?: Record<string, OasHeader | OasRef<'header'>> | undefined;
+    /** Response content for different media types */
     content?: Record<string, OasMediaType> | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Response Object in the OpenAPI Specification.
+ *
+ * The `OasResponse` class encapsulates the definition of a single HTTP response,
+ * including its description, headers, and content for different media types.
+ * Responses describe the possible outcomes of API operations and can include
+ * both successful and error scenarios.
+ *
+ * This class provides comprehensive support for response definitions with typed
+ * content, custom headers, and multiple media type representations.
+ *
+ * ## Key Features
+ *
+ * - **Content Types**: Support for multiple media types (JSON, XML, HTML, etc.)
+ * - **Header Definitions**: Custom response headers with validation
+ * - **Schema Integration**: Typed response bodies through schema definitions
+ * - **Reference Support**: Can reference reusable response components
+ * - **Documentation**: Rich description support for API documentation
+ * - **JSON Schema**: Converts to standard JSON Schema format for validation
+ *
+ * @example Basic JSON response
+ * ```typescript
+ * import { OasResponse, OasMediaType, OasObject, OasString } from '@skmtc/core';
+ *
+ * const successResponse = new OasResponse({
+ *   description: 'User retrieved successfully',
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           id: new OasString(),
+ *           name: new OasString(),
+ *           email: new OasString({ format: 'email' })
+ *         }
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Response with custom headers
+ * ```typescript
+ * const paginatedResponse = new OasResponse({
+ *   description: 'Paginated list of items',
+ *   headers: {
+ *     'X-Total-Count': new OasHeader({
+ *       description: 'Total number of items',
+ *       schema: new OasInteger({ minimum: 0 })
+ *     }),
+ *     'X-Page-Number': new OasHeader({
+ *       description: 'Current page number',
+ *       schema: new OasInteger({ minimum: 1 })
+ *     }),
+ *     'Link': new OasHeader({
+ *       description: 'Pagination links',
+ *       schema: new OasString()
+ *     })
+ *   },
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasArray({
+ *         items: new OasRef({ $ref: '#/components/schemas/Item' })
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Multiple content types
+ * ```typescript
+ * const multiFormatResponse = new OasResponse({
+ *   description: 'User data in multiple formats',
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasRef({ $ref: '#/components/schemas/User' })
+ *     }),
+ *     'application/xml': new OasMediaType({
+ *       schema: new OasObject({
+ *         // XML-specific schema definition
+ *         properties: {
+ *           user: new OasRef({ $ref: '#/components/schemas/User' })
+ *         }
+ *       })
+ *     }),
+ *     'text/csv': new OasMediaType({
+ *       schema: new OasString({
+ *         description: 'User data in CSV format'
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Error responses
+ * ```typescript
+ * const errorResponse = new OasResponse({
+ *   description: 'Validation error occurred',
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           error: new OasString({ description: 'Error message' }),
+ *           code: new OasString({ description: 'Error code' }),
+ *           details: new OasArray({
+ *             items: new OasObject({
+ *               properties: {
+ *                 field: new OasString(),
+ *                 message: new OasString()
+ *               }
+ *             })
+ *           })
+ *         },
+ *         required: ['error', 'code']
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example File download response
+ * ```typescript
+ * const fileDownloadResponse = new OasResponse({
+ *   description: 'File download',
+ *   headers: {
+ *     'Content-Disposition': new OasHeader({
+ *       description: 'Attachment filename',
+ *       schema: new OasString({ example: 'attachment; filename="report.pdf"' })
+ *     }),
+ *     'Content-Length': new OasHeader({
+ *       description: 'File size in bytes',
+ *       schema: new OasInteger({ minimum: 0 })
+ *     })
+ *   },
+ *   content: {
+ *     'application/pdf': new OasMediaType({
+ *       schema: new OasString({
+ *         format: 'binary',
+ *         description: 'PDF file content'
+ *       })
+ *     }),
+ *     'application/octet-stream': new OasMediaType({
+ *       schema: new OasString({
+ *         format: 'binary',
+ *         description: 'Generic binary content'
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example No content response
+ * ```typescript
+ * const noContentResponse = new OasResponse({
+ *   description: 'Operation completed successfully, no content returned'
+ *   // No content or headers - represents HTTP 204 No Content
+ * });
+ * ```
+ *
+ * @example Using in operation definitions
+ * ```typescript
+ * const getUserOperation = new OasOperation({
+ *   path: '/users/{id}',
+ *   method: 'get',
+ *   responses: {
+ *     '200': successResponse,
+ *     '404': new OasResponse({
+ *       description: 'User not found',
+ *       content: {
+ *         'application/json': new OasMediaType({
+ *           schema: new OasObject({
+ *             properties: {
+ *               error: new OasString({ example: 'User not found' }),
+ *               code: new OasString({ example: 'USER_NOT_FOUND' })
+ *             }
+ *           })
+ *         })
+ *       }
+ *     }),
+ *     '500': new OasRef({ $ref: '#/components/responses/InternalServerError' })
+ *   }
+ * });
+ * ```
+ */
 export declare class OasResponse {
     oasType: 'response';
     description: string | undefined;

package/script/oas/response/Response.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../../src/oas/response/Response.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAA;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,WAAW;IACtB,OAAO,EAAE,UAAU,CAAa;IAChC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAA;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IACjD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,cAAc;IAOlC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,UAAU,CAAC;IAInC,OAAO,IAAI,WAAW;IAItB,WAAW,IAAI,WAAW;IAI1B,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAI1F,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,cAAc;CAqBrE"}
+{"version":3,"file":"Response.d.ts","sourceRoot":"","sources":["../../../src/oas/response/Response.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,wCAAwC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAA;IAClE,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IAClD,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsLG;AACH,qBAAa,WAAW;IACtB,OAAO,EAAE,UAAU,CAAa;IAChC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAAA;IACjE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IACjD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,cAAc;IAOlC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,UAAU,CAAC;IAInC,OAAO,IAAI,WAAW;IAItB,WAAW,IAAI,WAAW;IAI1B,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAI1F,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,cAAc;CAqBrE"}