@skmtc/core 0.0.789 → 0.0.791

package/esm/oas/boolean/Boolean.js

@@ -1,6 +1,135 @@
 import "../../_dnt.polyfills.js";
 /**
- * Object representing a boolean in the OpenAPI Specification.
+ * Represents a boolean schema in the OpenAPI Specification.
+ *
+ * The `OasBoolean` class handles boolean data types in OpenAPI schemas, supporting
+ * both simple true/false values and more complex boolean schemas with constraints,
+ * enumerations, and nullable types. This class provides type-safe boolean handling
+ * with optional null value support through generic typing.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Generic nullable type support with proper TypeScript inference
+ * - **Enum Support**: Constrain boolean values to specific true/false combinations
+ * - **Null Handling**: Optional null value support for nullable boolean types
+ * - **Validation**: Default values and example validation
+ * - **JSON Schema**: Converts to standard JSON Schema format for validation
+ * - **Documentation**: Rich metadata support for API documentation
+ *
+ * @template Nullable - Whether the boolean value itself can be null
+ *
+ * @example Basic boolean schema
+ * ```typescript
+ * import { OasBoolean } from '@skmtc/core';
+ *
+ * const isActiveSchema = new OasBoolean({
+ *   title: 'Active Status',
+ *   description: 'Whether the user account is active',
+ *   default: true,
+ *   example: true
+ * });
+ *
+ * // This represents: boolean with default true
+ * ```
+ *
+ * @example Nullable boolean schema
+ * ```typescript
+ * const nullableFlag = new OasBoolean<true>({
+ *   title: 'Optional Flag',
+ *   description: 'An optional boolean flag that can be null',
+ *   nullable: true,
+ *   default: null,
+ *   example: true
+ * });
+ *
+ * // This represents: boolean | null
+ * ```
+ *
+ * @example Boolean with enum constraints
+ * ```typescript
+ * const strictBoolean = new OasBoolean({
+ *   title: 'Confirmation',
+ *   description: 'Must explicitly be true to confirm action',
+ *   enums: [true], // Only true is allowed
+ *   example: true
+ * });
+ *
+ * // This only accepts true, effectively making it required
+ * ```
+ *
+ * @example Boolean with null in enum
+ * ```typescript
+ * const triStateBoolean = new OasBoolean<true>({
+ *   title: 'Approval Status',
+ *   description: 'Approval can be true (approved), false (denied), or null (pending)',
+ *   nullable: true,
+ *   enums: [true, false, null],
+ *   default: null,
+ *   example: null
+ * });
+ *
+ * // This represents: true | false | null (tri-state logic)
+ * ```
+ *
+ * @example Feature flag schema
+ * ```typescript
+ * const featureFlag = new OasBoolean({
+ *   title: 'Feature Enabled',
+ *   description: 'Whether the new feature is enabled for this user',
+ *   default: false,
+ *   example: false
+ * });
+ *
+ * // Used in configuration objects
+ * const userConfig = new OasObject({
+ *   properties: {
+ *     darkMode: featureFlag,
+ *     notifications: featureFlag,
+ *     betaFeatures: featureFlag
+ *   }
+ * });
+ * ```
+ *
+ * @example Consent and agreement booleans
+ * ```typescript
+ * const consentSchema = new OasBoolean({
+ *   title: 'Terms Accepted',
+ *   description: 'User has accepted the terms and conditions',
+ *   enums: [true], // Must be true to be valid
+ *   example: true
+ * });
+ *
+ * const privacyConsent = new OasBoolean({
+ *   title: 'Privacy Policy Accepted',
+ *   description: 'User has accepted the privacy policy',
+ *   default: false,
+ *   example: true
+ * });
+ *
+ * // Used in registration forms where consent is required
+ * ```
+ *
+ * @example Optional settings with nullable booleans
+ * ```typescript
+ * const userPreferences = new OasObject({
+ *   properties: {
+ *     emailNotifications: new OasBoolean<true>({
+ *       title: 'Email Notifications',
+ *       description: 'Enable email notifications (null means use default)',
+ *       nullable: true,
+ *       default: null
+ *     }),
+ *     smsNotifications: new OasBoolean<true>({
+ *       title: 'SMS Notifications',
+ *       description: 'Enable SMS notifications (null means not set)',
+ *       nullable: true,
+ *       default: null
+ *     })
+ *   }
+ * });
+ *
+ * // Allows: { emailNotifications: true, smsNotifications: null }
+ * ```
  */
 export class OasBoolean {
     constructor(fields = {}) {

package/esm/oas/number/Number.d.ts

@@ -2,23 +2,201 @@ import "../../_dnt.polyfills.js";
 import type { OasRef } from '../ref/Ref.js';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
+/**
+ * Constructor fields for {@link OasNumber}.
+ *
+ * @template Nullable - Whether the number can be null (affects type unions)
+ */
 export type NumberFields<Nullable extends boolean | undefined> = {
+    /** A short summary of the number schema */
     title?: string;
+    /** A description of the number schema */
     description?: string;
+    /** Whether the number value can be null */
     nullable?: Nullable;
+    /** Default value for the number (null allowed if Nullable is true) */
     default?: Nullable extends true ? number | null | undefined : number | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
+    /** Example value for the number (null allowed if Nullable is true) */
     example?: Nullable extends true ? number | null | undefined : number | undefined;
+    /** Array of valid enum values for the number (null allowed if Nullable is true) */
     enums?: Nullable extends true ? (number | null)[] | undefined : number[] | undefined;
+    /** The format of the number (float or double precision) */
     format?: 'float' | 'double';
+    /** Value must be a multiple of this number */
     multipleOf?: number;
+    /** Maximum value allowed (inclusive by default) */
     maximum?: number;
+    /** Whether the maximum value is exclusive */
     exclusiveMaximum?: boolean;
+    /** Minimum value allowed (inclusive by default) */
     minimum?: number;
+    /** Whether the minimum value is exclusive */
     exclusiveMinimum?: boolean;
 };
 /**
- * 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
+ * });
+ * ```
  */
 export declare class OasNumber<Nullable extends boolean | undefined = boolean | undefined> {
     /**

package/esm/oas/number/Number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Number.d.ts","sourceRoot":"","sources":["../../../src/oas/number/Number.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAChF,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAChF,KAAK,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACpF,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED;;GAEG;AACH,qBAAa,SAAS,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAC/E;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,QAAQ,CAAS;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/E;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC9B,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/E;;OAEG;IACH,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACnF;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAA;gBACzB,MAAM,GAAE,YAAY,CAAC,QAAQ,CAAM;IAgB/C,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,SAAS,CAAC,QAAQ,CAAC;IAI9B,WAAW,IAAI,SAAS,CAAC,QAAQ,CAAC;IAKlC,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAgB5E"}
+{"version":3,"file":"Number.d.ts","sourceRoot":"","sources":["../../../src/oas/number/Number.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAE9D;;;;GAIG;AACH,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAC/D,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,sEAAsE;IACtE,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAChF,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,sEAAsE;IACtE,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAChF,mFAAmF;IACnF,KAAK,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACpF,2DAA2D;IAC3D,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC3B,8CAA8C;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkKG;AACH,qBAAa,SAAS,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAC/E;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,QAAQ,CAAS;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/E;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC9B,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;IAC/E;;OAEG;IACH,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;IACnF;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;IACtC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAA;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,OAAO,GAAG,SAAS,CAAA;gBACzB,MAAM,GAAE,YAAY,CAAC,QAAQ,CAAM;IAgB/C,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,SAAS,CAAC,QAAQ,CAAC;IAI9B,WAAW,IAAI,SAAS,CAAC,QAAQ,CAAC;IAKlC,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAgB5E"}

package/esm/oas/number/Number.js

@@ -1,6 +1,166 @@
 import "../../_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
+ * });
+ * ```
  */
 export class OasNumber {
     constructor(fields = {}) {

package/esm/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;