@skmtc/core 0.0.790 → 0.0.792

package/esm/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/esm/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"}

package/esm/oas/response/Response.js

@@ -1,4 +1,187 @@
 import "../../_dnt.polyfills.js";
+/**
+ * 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 class OasResponse {
     constructor(fields) {
         Object.defineProperty(this, "oasType", {

package/esm/oas/void/Void.d.ts

@@ -1,13 +1,140 @@
 import "../../_dnt.polyfills.js";
 import type { OasRef } from '../ref/Ref.js';
+/**
+ * Constructor fields for {@link OasVoid}.
+ */
 export type VoidFields = {
+    /** A short summary of the void schema */
     title?: string;
+    /** A description of what the void represents */
     description?: string;
 };
 /**
- * Object representing a void type in the OpenAPI Specification.
- * It is used to describe an absence of a value such as when no
- * content is returned by an operation.
+ * Represents a void (empty) schema in the OpenAPI Specification.
+ *
+ * The `OasVoid` class represents the absence of a value or content, commonly used
+ * in scenarios where operations don't return any content (like HTTP 204 No Content
+ * responses), optional properties that might not be present, or fallback cases
+ * in schema processing where no specific type is defined.
+ *
+ * This class serves as a type-safe representation of "nothing" in the OpenAPI
+ * type system, enabling proper handling of void responses and empty schemas
+ * throughout the SKMTC pipeline.
+ *
+ * ## Key Features
+ *
+ * - **Empty Content Representation**: Models operations that return no content
+ * - **Type Safety**: Provides a concrete type for void/empty scenarios
+ * - **Schema Processing**: Handles missing or undefined schema definitions
+ * - **Factory Pattern**: Convenient `empty()` static method for common usage
+ * - **Pipeline Integration**: Works seamlessly with the SKMTC processing pipeline
+ *
+ * @example Basic void schema for empty responses
+ * ```typescript
+ * import { OasVoid } from '@skmtc/core';
+ *
+ * const emptyResponse = new OasVoid({
+ *   title: 'No Content',
+ *   description: 'Operation completed successfully with no response body'
+ * });
+ *
+ * // Used for HTTP 204 No Content responses
+ * ```
+ *
+ * @example Using the empty factory method
+ * ```typescript
+ * const voidSchema = OasVoid.empty();
+ *
+ * // Equivalent to new OasVoid({})
+ * // Commonly used as a fallback or placeholder
+ * ```
+ *
+ * @example In operation responses
+ * ```typescript
+ * const deleteOperation = new OasOperation({
+ *   path: '/users/{id}',
+ *   method: 'delete',
+ *   responses: {
+ *     '204': new OasResponse({
+ *       description: 'User deleted successfully',
+ *       content: {
+ *         // No content for successful deletion
+ *       }
+ *     }),
+ *     '404': new OasResponse({
+ *       description: 'User not found'
+ *     })
+ *   }
+ * });
+ *
+ * // The void response indicates successful deletion with no return value
+ * ```
+ *
+ * @example As a schema fallback
+ * ```typescript
+ * function processSchema(schema: OasSchema | undefined): OasSchema {
+ *   if (!schema) {
+ *     return OasVoid.empty(); // Fallback for missing schemas
+ *   }
+ *   return schema;
+ * }
+ *
+ * // Ensures type safety even when schemas are missing
+ * ```
+ *
+ * @example In optional object properties
+ * ```typescript
+ * const userProfile = new OasObject({
+ *   properties: {
+ *     name: new OasString({ description: 'User name' }),
+ *     avatar: new OasString({
+ *       description: 'Avatar URL',
+ *       nullable: true
+ *     }),
+ *     // Some properties might be processed as void if not defined
+ *     metadata: processOptionalSchema(rawSchema.metadata) // might return OasVoid
+ *   }
+ * });
+ * ```
+ *
+ * @example HTTP operations with void responses
+ * ```typescript
+ * // Common HTTP operations that return void/empty content:
+ *
+ * // DELETE - Resource removal
+ * const deleteResponse = new OasVoid({
+ *   title: 'Deletion Successful',
+ *   description: 'Resource was successfully deleted'
+ * });
+ *
+ * // PUT - Update with no response body
+ * const updateResponse = new OasVoid({
+ *   title: 'Update Successful',
+ *   description: 'Resource was successfully updated'
+ * });
+ *
+ * // POST - Action with no return value
+ * const actionResponse = new OasVoid({
+ *   title: 'Action Completed',
+ *   description: 'Action was successfully performed'
+ * });
+ * ```
+ *
+ * @example In code generation
+ * ```typescript
+ * class TypeScriptGenerator extends ModelBase {
+ *   generateType(schema: OasSchema): string {
+ *     if (schema.type === 'void') {
+ *       return 'void'; // TypeScript void type
+ *     }
+ *     // Handle other types...
+ *     return 'unknown';
+ *   }
+ * }
+ *
+ * // Generates:
+ * // async function deleteUser(id: string): Promise<void>
+ * ```
  */
 export declare class OasVoid {
     /**

package/esm/oas/void/Void.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Void.d.ts","sourceRoot":"","sources":["../../../src/oas/void/Void.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;;GAIG;AACH,qBAAa,OAAO;IAClB;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,MAAM,CAAS;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;gBAEnB,MAAM,GAAE,UAAe;IAKnC,MAAM,CAAC,KAAK,IAAI,OAAO;IAIvB,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,OAAO;IAIlB,WAAW,IAAI,OAAO;CAGvB"}
+{"version":3,"file":"Void.d.ts","sourceRoot":"","sources":["../../../src/oas/void/Void.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gDAAgD;IAChD,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8HG;AACH,qBAAa,OAAO;IAClB;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,MAAM,CAAS;IACtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;gBAEnB,MAAM,GAAE,UAAe;IAKnC,MAAM,CAAC,KAAK,IAAI,OAAO;IAIvB,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,OAAO;IAIlB,WAAW,IAAI,OAAO;CAGvB"}

package/esm/oas/void/Void.js

@@ -1,8 +1,130 @@
 import "../../_dnt.polyfills.js";
 /**
- * Object representing a void type in the OpenAPI Specification.
- * It is used to describe an absence of a value such as when no
- * content is returned by an operation.
+ * Represents a void (empty) schema in the OpenAPI Specification.
+ *
+ * The `OasVoid` class represents the absence of a value or content, commonly used
+ * in scenarios where operations don't return any content (like HTTP 204 No Content
+ * responses), optional properties that might not be present, or fallback cases
+ * in schema processing where no specific type is defined.
+ *
+ * This class serves as a type-safe representation of "nothing" in the OpenAPI
+ * type system, enabling proper handling of void responses and empty schemas
+ * throughout the SKMTC pipeline.
+ *
+ * ## Key Features
+ *
+ * - **Empty Content Representation**: Models operations that return no content
+ * - **Type Safety**: Provides a concrete type for void/empty scenarios
+ * - **Schema Processing**: Handles missing or undefined schema definitions
+ * - **Factory Pattern**: Convenient `empty()` static method for common usage
+ * - **Pipeline Integration**: Works seamlessly with the SKMTC processing pipeline
+ *
+ * @example Basic void schema for empty responses
+ * ```typescript
+ * import { OasVoid } from '@skmtc/core';
+ *
+ * const emptyResponse = new OasVoid({
+ *   title: 'No Content',
+ *   description: 'Operation completed successfully with no response body'
+ * });
+ *
+ * // Used for HTTP 204 No Content responses
+ * ```
+ *
+ * @example Using the empty factory method
+ * ```typescript
+ * const voidSchema = OasVoid.empty();
+ *
+ * // Equivalent to new OasVoid({})
+ * // Commonly used as a fallback or placeholder
+ * ```
+ *
+ * @example In operation responses
+ * ```typescript
+ * const deleteOperation = new OasOperation({
+ *   path: '/users/{id}',
+ *   method: 'delete',
+ *   responses: {
+ *     '204': new OasResponse({
+ *       description: 'User deleted successfully',
+ *       content: {
+ *         // No content for successful deletion
+ *       }
+ *     }),
+ *     '404': new OasResponse({
+ *       description: 'User not found'
+ *     })
+ *   }
+ * });
+ *
+ * // The void response indicates successful deletion with no return value
+ * ```
+ *
+ * @example As a schema fallback
+ * ```typescript
+ * function processSchema(schema: OasSchema | undefined): OasSchema {
+ *   if (!schema) {
+ *     return OasVoid.empty(); // Fallback for missing schemas
+ *   }
+ *   return schema;
+ * }
+ *
+ * // Ensures type safety even when schemas are missing
+ * ```
+ *
+ * @example In optional object properties
+ * ```typescript
+ * const userProfile = new OasObject({
+ *   properties: {
+ *     name: new OasString({ description: 'User name' }),
+ *     avatar: new OasString({
+ *       description: 'Avatar URL',
+ *       nullable: true
+ *     }),
+ *     // Some properties might be processed as void if not defined
+ *     metadata: processOptionalSchema(rawSchema.metadata) // might return OasVoid
+ *   }
+ * });
+ * ```
+ *
+ * @example HTTP operations with void responses
+ * ```typescript
+ * // Common HTTP operations that return void/empty content:
+ *
+ * // DELETE - Resource removal
+ * const deleteResponse = new OasVoid({
+ *   title: 'Deletion Successful',
+ *   description: 'Resource was successfully deleted'
+ * });
+ *
+ * // PUT - Update with no response body
+ * const updateResponse = new OasVoid({
+ *   title: 'Update Successful',
+ *   description: 'Resource was successfully updated'
+ * });
+ *
+ * // POST - Action with no return value
+ * const actionResponse = new OasVoid({
+ *   title: 'Action Completed',
+ *   description: 'Action was successfully performed'
+ * });
+ * ```
+ *
+ * @example In code generation
+ * ```typescript
+ * class TypeScriptGenerator extends ModelBase {
+ *   generateType(schema: OasSchema): string {
+ *     if (schema.type === 'void') {
+ *       return 'void'; // TypeScript void type
+ *     }
+ *     // Handle other types...
+ *     return 'unknown';
+ *   }
+ * }
+ *
+ * // Generates:
+ * // async function deleteUser(id: string): Promise<void>
+ * ```
  */
 export class OasVoid {
     constructor(fields = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skmtc/core",
-  "version": "0.0.790",
+  "version": "0.0.792",
   "repository": {
     "type": "git",
     "url": "https://github.com/skmtc/skmtc.git"