@skmtc/core 0.0.790 → 0.0.792

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/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/esm/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/esm/oas/pathItem/PathItem.js

@@ -1,3 +1,88 @@
+/**
+ * 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 class OasPathItem {
     constructor(fields = {}) {
         Object.defineProperty(this, "oasType", {