@skmtc/core 0.0.790 → 0.0.791

package/script/oas/number/Number.js

@@ -3,7 +3,167 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasNumber = void 0;
 require("../../_dnt.polyfills.js");
 /**
- * Object representing a number in the OpenAPI Specification.
+ * Represents a number schema in the OpenAPI Specification.
+ *
+ * The `OasNumber` class handles floating-point numeric data types in OpenAPI schemas,
+ * supporting comprehensive validation constraints including ranges, precision formats,
+ * and mathematical constraints. This class provides type-safe number handling with
+ * optional null value support and extensive validation capabilities.
+ *
+ * ## Key Features
+ *
+ * - **Range Validation**: Minimum and maximum constraints with exclusive/inclusive options
+ * - **Precision Control**: Float and double format support for different precision needs
+ * - **Mathematical Constraints**: Multiple-of validation for specific numeric patterns
+ * - **Type Safety**: Generic nullable type support with proper TypeScript inference
+ * - **Enum Support**: Constrain numbers to specific allowed values
+ * - **Null Handling**: Optional null value support for nullable number types
+ *
+ * @template Nullable - Whether the number value itself can be null
+ *
+ * @example Basic number schema with range
+ * ```typescript
+ * import { OasNumber } from '@skmtc/core';
+ *
+ * const ageSchema = new OasNumber({
+ *   title: 'Age',
+ *   description: 'Person age in years',
+ *   minimum: 0,
+ *   maximum: 150,
+ *   example: 25,
+ *   default: 18
+ * });
+ *
+ * // This represents: number (0 <= value <= 150)
+ * ```
+ *
+ * @example Price with precision and constraints
+ * ```typescript
+ * const priceSchema = new OasNumber({
+ *   title: 'Product Price',
+ *   description: 'Price in USD with cent precision',
+ *   format: 'double',
+ *   minimum: 0,
+ *   exclusiveMinimum: true, // Must be > 0, not >= 0
+ *   multipleOf: 0.01, // Must be in cents (e.g., 19.99, 10.50)
+ *   example: 29.99
+ * });
+ *
+ * // This represents: number > 0, in multiples of 0.01
+ * ```
+ *
+ * @example Percentage with strict bounds
+ * ```typescript
+ * const percentageSchema = new OasNumber({
+ *   title: 'Completion Percentage',
+ *   description: 'Task completion as a percentage',
+ *   minimum: 0,
+ *   maximum: 100,
+ *   multipleOf: 0.1, // One decimal place precision
+ *   example: 75.5,
+ *   default: 0
+ * });
+ *
+ * // This represents: 0 <= value <= 100, in increments of 0.1
+ * ```
+ *
+ * @example Nullable rating system
+ * ```typescript
+ * const ratingSchema = new OasNumber<true>({
+ *   title: 'User Rating',
+ *   description: 'Product rating from 1-5 stars, null if not rated',
+ *   nullable: true,
+ *   minimum: 1,
+ *   maximum: 5,
+ *   multipleOf: 0.5, // Allow half-star ratings
+ *   enums: [1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5, null],
+ *   example: 4.5,
+ *   default: null
+ * });
+ *
+ * // This represents: (1 | 1.5 | 2 | 2.5 | 3 | 3.5 | 4 | 4.5 | 5) | null
+ * ```
+ *
+ * @example Scientific measurement with high precision
+ * ```typescript
+ * const temperatureSchema = new OasNumber({
+ *   title: 'Temperature',
+ *   description: 'Temperature in Celsius with high precision',
+ *   format: 'double',
+ *   minimum: -273.15, // Absolute zero
+ *   maximum: 1000,
+ *   multipleOf: 0.001, // Millikelvin precision
+ *   example: 23.456
+ * });
+ *
+ * // For scientific applications requiring high precision
+ * ```
+ *
+ * @example Currency with regional constraints
+ * ```typescript
+ * const currencySchema = new OasNumber({
+ *   title: 'Amount',
+ *   description: 'Transaction amount in major currency units',
+ *   format: 'double',
+ *   minimum: 0,
+ *   maximum: 999999.99,
+ *   multipleOf: 0.01,
+ *   example: 1234.56
+ * });
+ *
+ * // Used in financial applications
+ * const transaction = new OasObject({
+ *   properties: {
+ *     amount: currencySchema,
+ *     currency: new OasString({ enum: ['USD', 'EUR', 'GBP'] })
+ *   }
+ * });
+ * ```
+ *
+ * @example Coordinate system
+ * ```typescript
+ * const latitudeSchema = new OasNumber({
+ *   title: 'Latitude',
+ *   description: 'Geographic latitude coordinate',
+ *   format: 'double',
+ *   minimum: -90,
+ *   maximum: 90,
+ *   example: 40.7128
+ * });
+ *
+ * const longitudeSchema = new OasNumber({
+ *   title: 'Longitude',
+ *   description: 'Geographic longitude coordinate',
+ *   format: 'double',
+ *   minimum: -180,
+ *   maximum: 180,
+ *   example: -74.0060
+ * });
+ *
+ * // Used for location data
+ * ```
+ *
+ * @example Probability and statistics
+ * ```typescript
+ * const probabilitySchema = new OasNumber({
+ *   title: 'Probability',
+ *   description: 'Statistical probability value',
+ *   minimum: 0,
+ *   maximum: 1,
+ *   exclusiveMaximum: false, // Can be exactly 1
+ *   example: 0.75,
+ *   default: 0.5
+ * });
+ *
+ * const confidenceSchema = new OasNumber({
+ *   title: 'Confidence Level',
+ *   description: 'Statistical confidence level as percentage',
+ *   minimum: 0,
+ *   maximum: 100,
+ *   enums: [90, 95, 99], // Common confidence levels
+ *   example: 95
+ * });
+ * ```
  */
 class OasNumber {
     constructor(fields = {}) {

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"}

package/script/oas/response/Response.js

@@ -2,6 +2,189 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasResponse = void 0;
 require("../../_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' })
+ *   }
+ * });
+ * ```
+ */
 class OasResponse {
     constructor(fields) {
         Object.defineProperty(this, "oasType", {