@skmtc/core 0.0.790 → 0.0.791

package/script/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/script/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/script/oas/void/Void.js

@@ -3,9 +3,131 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasVoid = void 0;
 require("../../_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>
+ * ```
  */
 class OasVoid {
     constructor(fields = {}) {