@skmtc/core 0.0.791 → 0.0.793

package/script/oas/mediaType/MediaType.d.ts

@@ -3,13 +3,98 @@ import type { OasSchema } from '../schema/Schema.js';
 import type { OasExample } from '../example/Example.js';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
+/**
+ * Constructor fields for {@link OasMediaType}.
+ */
 export type MediaTypeFields = {
+    /** The media type string (e.g., 'application/json', 'text/xml') */
     mediaType: string;
+    /** The schema defining the structure of the content */
     schema?: OasSchema | OasRef<'schema'> | undefined;
+    /** Example values for the media type */
     examples?: Record<string, OasExample | OasRef<'example'>> | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
+    /** Encoding information for multipart or form data */
     encoding?: Record<string, unknown> | undefined;
 };
+/**
+ * Represents a Media Type Object in the OpenAPI Specification.
+ *
+ * The `OasMediaType` class encapsulates the definition of content for different
+ * media types in request bodies and responses. It defines the structure, format,
+ * and validation rules for content using schemas and provides examples for
+ * documentation and testing purposes.
+ *
+ * This class supports various content types including JSON, XML, form data,
+ * file uploads, and binary content, making it essential for describing API
+ * request and response payloads.
+ *
+ * ## Key Features
+ *
+ * - **Schema Validation**: Define content structure through OpenAPI schemas
+ * - **Multiple Examples**: Rich example support for documentation and testing
+ * - **Encoding Support**: Handle multipart and form data encoding
+ * - **Content Type Support**: JSON, XML, binary, form data, and more
+ * - **Reference Integration**: Work seamlessly with schema references
+ *
+ * @example JSON content type
+ * ```typescript
+ * import { OasMediaType, OasObject, OasString } from '@skmtc/core';
+ *
+ * const jsonContent = new OasMediaType({
+ *   mediaType: 'application/json',
+ *   schema: new OasObject({
+ *     properties: {
+ *       name: new OasString(),
+ *       email: new OasString({ format: 'email' })
+ *     }
+ *   }),
+ *   examples: {
+ *     user: new OasExample({
+ *       summary: 'Sample user',
+ *       value: { name: 'John Doe', email: 'john@example.com' }
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example File upload with multipart form data
+ * ```typescript
+ * const fileUpload = new OasMediaType({
+ *   mediaType: 'multipart/form-data',
+ *   schema: new OasObject({
+ *     properties: {
+ *       file: new OasString({ format: 'binary' }),
+ *       description: new OasString()
+ *     }
+ *   }),
+ *   encoding: {
+ *     file: {
+ *       contentType: 'image/png, image/jpeg',
+ *       style: 'form'
+ *     }
+ *   }
+ * });
+ * ```
+ *
+ * @example XML content with namespace
+ * ```typescript
+ * const xmlContent = new OasMediaType({
+ *   mediaType: 'application/xml',
+ *   schema: new OasObject({
+ *     properties: {
+ *       product: new OasRef({ $ref: '#/components/schemas/Product' })
+ *     }
+ *   }),
+ *   examples: {
+ *     sample: new OasExample({
+ *       value: '<product><name>Widget</name><price>19.99</price></product>'
+ *     })
+ *   }
+ * });
+ * ```
+ */
 export declare class OasMediaType {
     oasType: 'mediaType';
     mediaType: string;

package/script/oas/mediaType/MediaType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MediaType.d.ts","sourceRoot":"","sources":["../../../src/oas/mediaType/MediaType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,MAAM,eAAe,GAAG;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,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,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CAC/C,CAAA;AAED,qBAAa,YAAY;IACvB,OAAO,EAAE,WAAW,CAAc;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IAChD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACpE,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAClC,MAAM,EAAE,eAAe;IAQnC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAMtE"}
+{"version":3,"file":"MediaType.d.ts","sourceRoot":"","sources":["../../../src/oas/mediaType/MediaType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAA;IACjB,uDAAuD;IACvD,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CAC/C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AACH,qBAAa,YAAY;IACvB,OAAO,EAAE,WAAW,CAAc;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IAChD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACpE,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAClC,MAAM,EAAE,eAAe;IAQnC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAMtE"}

package/script/oas/mediaType/MediaType.js

@@ -1,6 +1,83 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasMediaType = void 0;
+/**
+ * Represents a Media Type Object in the OpenAPI Specification.
+ *
+ * The `OasMediaType` class encapsulates the definition of content for different
+ * media types in request bodies and responses. It defines the structure, format,
+ * and validation rules for content using schemas and provides examples for
+ * documentation and testing purposes.
+ *
+ * This class supports various content types including JSON, XML, form data,
+ * file uploads, and binary content, making it essential for describing API
+ * request and response payloads.
+ *
+ * ## Key Features
+ *
+ * - **Schema Validation**: Define content structure through OpenAPI schemas
+ * - **Multiple Examples**: Rich example support for documentation and testing
+ * - **Encoding Support**: Handle multipart and form data encoding
+ * - **Content Type Support**: JSON, XML, binary, form data, and more
+ * - **Reference Integration**: Work seamlessly with schema references
+ *
+ * @example JSON content type
+ * ```typescript
+ * import { OasMediaType, OasObject, OasString } from '@skmtc/core';
+ *
+ * const jsonContent = new OasMediaType({
+ *   mediaType: 'application/json',
+ *   schema: new OasObject({
+ *     properties: {
+ *       name: new OasString(),
+ *       email: new OasString({ format: 'email' })
+ *     }
+ *   }),
+ *   examples: {
+ *     user: new OasExample({
+ *       summary: 'Sample user',
+ *       value: { name: 'John Doe', email: 'john@example.com' }
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example File upload with multipart form data
+ * ```typescript
+ * const fileUpload = new OasMediaType({
+ *   mediaType: 'multipart/form-data',
+ *   schema: new OasObject({
+ *     properties: {
+ *       file: new OasString({ format: 'binary' }),
+ *       description: new OasString()
+ *     }
+ *   }),
+ *   encoding: {
+ *     file: {
+ *       contentType: 'image/png, image/jpeg',
+ *       style: 'form'
+ *     }
+ *   }
+ * });
+ * ```
+ *
+ * @example XML content with namespace
+ * ```typescript
+ * const xmlContent = new OasMediaType({
+ *   mediaType: 'application/xml',
+ *   schema: new OasObject({
+ *     properties: {
+ *       product: new OasRef({ $ref: '#/components/schemas/Product' })
+ *     }
+ *   }),
+ *   examples: {
+ *     sample: new OasExample({
+ *       value: '<product><name>Widget</name><price>19.99</price></product>'
+ *     })
+ *   }
+ * });
+ * ```
+ */
 class OasMediaType {
     constructor(fields) {
         Object.defineProperty(this, "oasType", {

package/script/oas/pathItem/PathItem.d.ts

@@ -1,11 +1,103 @@
 import type { OasParameter } from '../parameter/Parameter.js';
 import type { OasRef } from '../ref/Ref.js';
+/**
+ * Constructor fields for {@link OasPathItem}.
+ */
 export type PathItemFields = {
+    /** Optional summary for the path item */
     summary?: string | undefined;
+    /** Optional description for the path item */
     description?: string | undefined;
+    /** Parameters that are applicable for all operations on this path */
     parameters?: (OasParameter | OasRef<'parameter'>)[] | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Path Item Object in the OpenAPI Specification.
+ *
+ * The `OasPathItem` class describes operations available on a single API path.
+ * It serves as a container for HTTP operations (GET, POST, PUT, DELETE, etc.)
+ * and can define parameters that apply to all operations on the path.
+ *
+ * This class provides path-level configuration and shared parameters that
+ * reduce duplication across operations on the same endpoint.
+ *
+ * ## Key Features
+ *
+ * - **Operation Container**: Groups HTTP methods for a single path
+ * - **Shared Parameters**: Path-level parameters for all operations
+ * - **Documentation**: Summary and description for the path
+ * - **Extension Support**: Custom fields for additional metadata
+ * - **Parameter Inheritance**: Parameters shared across all operations
+ *
+ * @example Basic path item with shared parameters
+ * ```typescript
+ * import { OasPathItem, OasParameter, OasString } from '@skmtc/core';
+ *
+ * const userPathItem = new OasPathItem({
+ *   summary: 'User operations',
+ *   description: 'Operations for managing individual users',
+ *   parameters: [
+ *     new OasParameter({
+ *       name: 'userId',
+ *       in: 'path',
+ *       required: true,
+ *       schema: new OasString({ format: 'uuid' }),
+ *       description: 'Unique identifier for the user'
+ *     })
+ *   ]
+ * });
+ * ```
+ *
+ * @example Path with common headers
+ * ```typescript
+ * const apiPathItem = new OasPathItem({
+ *   summary: 'API endpoint',
+ *   description: 'Authenticated endpoint requiring API key',
+ *   parameters: [
+ *     new OasParameter({
+ *       name: 'Authorization',
+ *       in: 'header',
+ *       required: true,
+ *       schema: new OasString({ pattern: '^Bearer .+$' }),
+ *       description: 'Bearer token for authentication'
+ *     }),
+ *     new OasParameter({
+ *       name: 'Accept-Version',
+ *       in: 'header',
+ *       required: false,
+ *       schema: new OasString({ enum: ['v1', 'v2'] }),
+ *       description: 'API version preference'
+ *     })
+ *   ]
+ * });
+ * ```
+ *
+ * @example RESTful resource path
+ * ```typescript
+ * const resourcePathItem = new OasPathItem({
+ *   summary: 'Product resource',
+ *   description: 'CRUD operations for product management',
+ *   parameters: [
+ *     new OasParameter({
+ *       name: 'productId',
+ *       in: 'path',
+ *       required: true,
+ *       schema: new OasInteger({ minimum: 1 }),
+ *       description: 'Product identifier'
+ *     }),
+ *     new OasParameter({
+ *       name: 'include',
+ *       in: 'query',
+ *       required: false,
+ *       schema: new OasString({ enum: ['details', 'reviews', 'images'] }),
+ *       description: 'Additional data to include in response'
+ *     })
+ *   ]
+ * });
+ * ```
+ */
 export declare class OasPathItem {
     oasType: 'pathItem';
     summary: string | undefined;

package/script/oas/pathItem/PathItem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PathItem.d.ts","sourceRoot":"","sources":["../../../src/oas/pathItem/PathItem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,UAAU,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC/D,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,WAAW;IACtB,OAAO,EAAE,UAAU,CAAa;IAChC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAExC,MAAM,GAAE,cAAmB;CAMxC"}
+{"version":3,"file":"PathItem.d.ts","sourceRoot":"","sources":["../../../src/oas/pathItem/PathItem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,qEAAqE;IACrE,UAAU,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC/D,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoFG;AACH,qBAAa,WAAW;IACtB,OAAO,EAAE,UAAU,CAAa;IAChC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAExC,MAAM,GAAE,cAAmB;CAMxC"}

package/script/oas/pathItem/PathItem.js

@@ -1,6 +1,91 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasPathItem = void 0;
+/**
+ * Represents a Path Item Object in the OpenAPI Specification.
+ *
+ * The `OasPathItem` class describes operations available on a single API path.
+ * It serves as a container for HTTP operations (GET, POST, PUT, DELETE, etc.)
+ * and can define parameters that apply to all operations on the path.
+ *
+ * This class provides path-level configuration and shared parameters that
+ * reduce duplication across operations on the same endpoint.
+ *
+ * ## Key Features
+ *
+ * - **Operation Container**: Groups HTTP methods for a single path
+ * - **Shared Parameters**: Path-level parameters for all operations
+ * - **Documentation**: Summary and description for the path
+ * - **Extension Support**: Custom fields for additional metadata
+ * - **Parameter Inheritance**: Parameters shared across all operations
+ *
+ * @example Basic path item with shared parameters
+ * ```typescript
+ * import { OasPathItem, OasParameter, OasString } from '@skmtc/core';
+ *
+ * const userPathItem = new OasPathItem({
+ *   summary: 'User operations',
+ *   description: 'Operations for managing individual users',
+ *   parameters: [
+ *     new OasParameter({
+ *       name: 'userId',
+ *       in: 'path',
+ *       required: true,
+ *       schema: new OasString({ format: 'uuid' }),
+ *       description: 'Unique identifier for the user'
+ *     })
+ *   ]
+ * });
+ * ```
+ *
+ * @example Path with common headers
+ * ```typescript
+ * const apiPathItem = new OasPathItem({
+ *   summary: 'API endpoint',
+ *   description: 'Authenticated endpoint requiring API key',
+ *   parameters: [
+ *     new OasParameter({
+ *       name: 'Authorization',
+ *       in: 'header',
+ *       required: true,
+ *       schema: new OasString({ pattern: '^Bearer .+$' }),
+ *       description: 'Bearer token for authentication'
+ *     }),
+ *     new OasParameter({
+ *       name: 'Accept-Version',
+ *       in: 'header',
+ *       required: false,
+ *       schema: new OasString({ enum: ['v1', 'v2'] }),
+ *       description: 'API version preference'
+ *     })
+ *   ]
+ * });
+ * ```
+ *
+ * @example RESTful resource path
+ * ```typescript
+ * const resourcePathItem = new OasPathItem({
+ *   summary: 'Product resource',
+ *   description: 'CRUD operations for product management',
+ *   parameters: [
+ *     new OasParameter({
+ *       name: 'productId',
+ *       in: 'path',
+ *       required: true,
+ *       schema: new OasInteger({ minimum: 1 }),
+ *       description: 'Product identifier'
+ *     }),
+ *     new OasParameter({
+ *       name: 'include',
+ *       in: 'query',
+ *       required: false,
+ *       schema: new OasString({ enum: ['details', 'reviews', 'images'] }),
+ *       description: 'Additional data to include in response'
+ *     })
+ *   ]
+ * });
+ * ```
+ */
 class OasPathItem {
     constructor(fields = {}) {
         Object.defineProperty(this, "oasType", {

package/script/oas/requestBody/RequestBody.d.ts

@@ -4,12 +4,276 @@ 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 OasRequestBody}.
+ */
 export type RequestBodyFields = {
+    /** A description of the request body */
     description?: string | undefined;
+    /** Request content for different media types */
     content: Record<string, OasMediaType>;
+    /** Whether the request body is required */
     required?: boolean | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Request Body Object in the OpenAPI Specification.
+ *
+ * The `OasRequestBody` class encapsulates the definition of a request body that
+ * can be sent with HTTP operations. It supports multiple content types, schema
+ * validation, and can be marked as required or optional. Request bodies are
+ * commonly used with POST, PUT, PATCH, and sometimes DELETE operations.
+ *
+ * This class provides comprehensive support for request body definitions with
+ * typed content, multiple media type representations, and proper validation.
+ *
+ * ## Key Features
+ *
+ * - **Multiple Content Types**: Support for JSON, XML, form data, binary, and more
+ * - **Schema Validation**: Typed request bodies through schema definitions
+ * - **Required/Optional**: Control whether the request body is mandatory
+ * - **Reference Support**: Can reference reusable request body components
+ * - **Documentation**: Rich description support for API documentation
+ * - **Media Type Flexibility**: Different schemas for different content types
+ *
+ * @example Basic JSON request body
+ * ```typescript
+ * import { OasRequestBody, OasMediaType, OasObject, OasString } from '@skmtc/core';
+ *
+ * const createUserRequest = new OasRequestBody({
+ *   description: 'User data for creating a new user account',
+ *   required: true,
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           name: new OasString({
+ *             description: 'Full name',
+ *             minLength: 1,
+ *             maxLength: 100
+ *           }),
+ *           email: new OasString({
+ *             format: 'email',
+ *             description: 'Email address'
+ *           }),
+ *           password: new OasString({
+ *             minLength: 8,
+ *             description: 'Account password'
+ *           })
+ *         },
+ *         required: ['name', 'email', 'password']
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Multiple content types
+ * ```typescript
+ * const multiFormatRequest = new OasRequestBody({
+ *   description: 'Product data in multiple formats',
+ *   required: true,
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasRef({ $ref: '#/components/schemas/Product' })
+ *     }),
+ *     'application/xml': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           product: new OasRef({ $ref: '#/components/schemas/Product' })
+ *         }
+ *       })
+ *     }),
+ *     'application/x-www-form-urlencoded': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           name: new OasString(),
+ *           price: new OasNumber({ format: 'double' }),
+ *           category_id: new OasInteger()
+ *         }
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example File upload request body
+ * ```typescript
+ * const fileUploadRequest = new OasRequestBody({
+ *   description: 'File upload with metadata',
+ *   required: true,
+ *   content: {
+ *     'multipart/form-data': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           file: new OasString({
+ *             format: 'binary',
+ *             description: 'The file to upload'
+ *           }),
+ *           filename: new OasString({
+ *             description: 'Original filename'
+ *           }),
+ *           description: new OasString({
+ *             description: 'File description',
+ *             required: false
+ *           }),
+ *           tags: new OasArray({
+ *             items: new OasString(),
+ *             description: 'File tags'
+ *           })
+ *         },
+ *         required: ['file', 'filename']
+ *       })
+ *     }),
+ *     'application/octet-stream': new OasMediaType({
+ *       schema: new OasString({
+ *         format: 'binary',
+ *         description: 'Raw binary file content'
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Optional request body for updates
+ * ```typescript
+ * const updateUserRequest = new OasRequestBody({
+ *   description: 'Partial user data for updates (all fields optional)',
+ *   required: false, // Request body itself is optional
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           name: new OasString({ description: 'Updated name' }),
+ *           email: new OasString({
+ *             format: 'email',
+ *             description: 'Updated email'
+ *           }),
+ *           bio: new OasString({ description: 'User biography' }),
+ *           preferences: new OasObject({
+ *             properties: {
+ *               notifications: new OasBoolean(),
+ *               theme: new OasString({ enum: ['light', 'dark'] })
+ *             }
+ *           })
+ *         }
+ *         // No required fields - all updates are optional
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Complex nested data structures
+ * ```typescript
+ * const orderRequest = new OasRequestBody({
+ *   description: 'Complete order with items and shipping',
+ *   required: true,
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           customer: new OasObject({
+ *             properties: {
+ *               id: new OasString(),
+ *               email: new OasString({ format: 'email' })
+ *             },
+ *             required: ['id']
+ *           }),
+ *           items: new OasArray({
+ *             items: new OasObject({
+ *               properties: {
+ *                 productId: new OasString(),
+ *                 quantity: new OasInteger({ minimum: 1 }),
+ *                 customizations: new OasArray({
+ *                   items: new OasString()
+ *                 })
+ *               },
+ *               required: ['productId', 'quantity']
+ *             }),
+ *             minItems: 1
+ *           }),
+ *           shipping: new OasObject({
+ *             properties: {
+ *               address: new OasRef({ $ref: '#/components/schemas/Address' }),
+ *               method: new OasString({ enum: ['standard', 'express', 'overnight'] }),
+ *               instructions: new OasString()
+ *             },
+ *             required: ['address', 'method']
+ *           }),
+ *           couponCode: new OasString({ description: 'Optional discount code' })
+ *         },
+ *         required: ['customer', 'items', 'shipping']
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Form data with validation
+ * ```typescript
+ * const registrationForm = new OasRequestBody({
+ *   description: 'User registration form data',
+ *   required: true,
+ *   content: {
+ *     'application/x-www-form-urlencoded': new OasMediaType({
+ *       schema: new OasObject({
+ *         properties: {
+ *           username: new OasString({
+ *             pattern: '^[a-zA-Z0-9_]{3,20}$',
+ *             description: 'Alphanumeric username, 3-20 characters'
+ *           }),
+ *           email: new OasString({
+ *             format: 'email',
+ *             description: 'Valid email address'
+ *           }),
+ *           password: new OasString({
+ *             minLength: 8,
+ *             description: 'Password, minimum 8 characters'
+ *           }),
+ *           confirmPassword: new OasString({
+ *             description: 'Password confirmation'
+ *           }),
+ *           agreeToTerms: new OasBoolean({
+ *             enum: [true],
+ *             description: 'Must accept terms of service'
+ *           })
+ *         },
+ *         required: ['username', 'email', 'password', 'confirmPassword', 'agreeToTerms']
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Using in operation definitions
+ * ```typescript
+ * const createProductOperation = new OasOperation({
+ *   path: '/products',
+ *   method: 'post',
+ *   requestBody: createUserRequest,
+ *   responses: {
+ *     '201': new OasResponse({
+ *       description: 'Product created successfully',
+ *       content: {
+ *         'application/json': new OasMediaType({
+ *           schema: new OasRef({ $ref: '#/components/schemas/Product' })
+ *         })
+ *       }
+ *     }),
+ *     '400': new OasResponse({
+ *       description: 'Invalid request data',
+ *       content: {
+ *         'application/json': new OasMediaType({
+ *           schema: new OasRef({ $ref: '#/components/schemas/ValidationError' })
+ *         })
+ *       }
+ *     })
+ *   }
+ * });
+ * ```
+ */
 export declare class OasRequestBody {
     oasType: 'requestBody';
     description: string | undefined;

package/script/oas/requestBody/RequestBody.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RequestBody.d.ts","sourceRoot":"","sources":["../../../src/oas/requestBody/RequestBody.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,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,iBAAiB,GAAG;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACrC,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,cAAc;IACzB,OAAO,EAAE,aAAa,CAAgB;IACtC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACrC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,iBAAiB;IAOrC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,aAAa,CAAC;IAItC,OAAO,IAAI,cAAc;IAIzB,WAAW,IAAI,cAAc;IAI7B,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAI1F,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,iBAAiB;CAYxE"}
+{"version":3,"file":"RequestBody.d.ts","sourceRoot":"","sources":["../../../src/oas/requestBody/RequestBody.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,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,iBAAiB,GAAG;IAC9B,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,gDAAgD;IAChD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACrC,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAC9B,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgQG;AACH,qBAAa,cAAc;IACzB,OAAO,EAAE,aAAa,CAAgB;IACtC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IACrC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,iBAAiB;IAOrC,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,aAAa,CAAC;IAItC,OAAO,IAAI,cAAc;IAIzB,WAAW,IAAI,cAAc;IAI7B,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS;IAI1F,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,iBAAiB;CAYxE"}