@skmtc/core 0.0.799 → 0.0.802

package/esm/oas/mediaType/mediaType-types.d.ts

@@ -25,15 +25,5 @@ export type OasMediaTypeData = {
  * Validates the structure of media type objects including content type
  * identifiers, schema definitions, and example collections.
  */
-export declare const oasMediaTypeData: v.ObjectSchema<{
-    readonly oasType: v.LiteralSchema<"mediaType", undefined>;
-    readonly mediaType: v.StringSchema<undefined>;
-    readonly schema: v.OptionalSchema<v.UnionSchema<[v.GenericSchema<OasSchemaData>, v.GenericSchema<OasSchemaRefData>], undefined>, undefined>;
-    readonly examples: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.ObjectSchema<{
-        readonly oasType: v.LiteralSchema<"example", undefined>;
-        readonly summary: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-        readonly description: v.OptionalSchema<v.GenericSchema<string>, undefined>;
-        readonly value: v.OptionalSchema<v.UnknownSchema, undefined>;
-    }, undefined>, v.GenericSchema<OasExampleRefData>], undefined>, undefined>, undefined>;
-}, undefined>;
+export declare const oasMediaTypeData: v.GenericSchema<OasMediaTypeData>;
 //# sourceMappingURL=mediaType-types.d.ts.map

package/esm/oas/mediaType/mediaType-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mediaType-types.d.ts","sourceRoot":"","sources":["../../../src/oas/mediaType/mediaType-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,6BAA6B,CAAA;AACjF,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAGtB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iDAAiD;IACjD,OAAO,EAAE,WAAW,CAAA;IACpB,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAA;IACjB,mDAAmD;IACnD,MAAM,CAAC,EAAE,aAAa,GAAG,gBAAgB,CAAA;IAEzC,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,iBAAiB,CAAC,CAAA;CAE9D,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;aAO3B,CAAA"}
+{"version":3,"file":"mediaType-types.d.ts","sourceRoot":"","sources":["../../../src/oas/mediaType/mediaType-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,6BAA6B,CAAA;AACjF,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAGtB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;;GAMG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iDAAiD;IACjD,OAAO,EAAE,WAAW,CAAA;IACpB,yEAAyE;IACzE,SAAS,EAAE,MAAM,CAAA;IACjB,mDAAmD;IACnD,MAAM,CAAC,EAAE,aAAa,GAAG,gBAAgB,CAAA;IAEzC,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,iBAAiB,CAAC,CAAA;CAE9D,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAO7D,CAAA"}

package/esm/oas/number/number-types.d.ts

@@ -5,28 +5,14 @@ import * as v from 'valibot';
  * Defines the precision formats for number types: float for single-precision
  * and double for double-precision floating-point numbers.
  */
-export declare const numberFormat: v.UnionSchema<[v.LiteralSchema<"float", undefined>, v.LiteralSchema<"double", undefined>], undefined>;
+export declare const numberFormat: v.GenericSchema<'float' | 'double'>;
 /**
  * Valibot schema for validating OpenAPI number data objects.
  *
  * Validates number schemas including precision formats, range constraints,
  * multiple validation, and enumeration values.
  */
-export declare const oasNumberData: v.ObjectSchema<{
-    readonly type: v.LiteralSchema<"number", undefined>;
-    readonly title: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-    readonly description: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-    readonly default: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-    readonly format: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"float", undefined>, v.LiteralSchema<"double", undefined>], undefined>, undefined>;
-    readonly enum: v.OptionalSchema<v.ArraySchema<v.NumberSchema<undefined>, undefined>, undefined>;
-    readonly nullable: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-    readonly example: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-    readonly multipleOf: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-    readonly maximum: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-    readonly exclusiveMaximum: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-    readonly minimum: v.OptionalSchema<v.NumberSchema<undefined>, undefined>;
-    readonly exclusiveMinimum: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-}, undefined>;
+export declare const oasNumberData: v.GenericSchema<OasNumberData>;
 export type OasNumberData = {
     type: 'number';
     title?: string;

package/esm/oas/number/number-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"number-types.d.ts","sourceRoot":"","sources":["../../../src/oas/number/number-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,YAAY,uGAAqD,CAAA;AAE9E;;;;;GAKG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;aAcxB,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,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"}
+{"version":3,"file":"number-types.d.ts","sourceRoot":"","sources":["../../../src/oas/number/number-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,GAAG,QAAQ,CAAsD,CAAA;AAEnH;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,aAAa,CAcvD,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,QAAQ,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,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"}

package/esm/oas/operation/Operation.d.ts

@@ -46,7 +46,10 @@ export type OperationFields = {
     /** OpenAPI specification extensions */
     extensionFields?: Record<string, unknown>;
 };
-type ToRequestBodyMapArgs = {
+/**
+ * Arguments passed to request body mapping functions.
+ */
+export type ToRequestBodyMapArgs = {
     schema: OasSchema | OasRef<'schema'>;
     requestBody: OasRequestBody;
 };
@@ -186,9 +189,35 @@ export declare class OasOperation {
     deprecated: boolean | undefined;
     /** OpenAPI specification extensions */
     extensionFields: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasOperation instance from operation field data.
+     *
+     * @param fields - Operation field data from OpenAPI specification
+     */
     constructor(fields: OperationFields);
+    /**
+     * Returns the successful response definition for this operation.
+     *
+     * Looks for the lowest numbered 2xx response code and returns its response definition.
+     *
+     * @returns Success response object or undefined if none found
+     */
     toSuccessResponse(): OasResponse | OasRef<'response'> | undefined;
+    /**
+     * Returns the HTTP status code for the primary success response.
+     *
+     * Finds the lowest numbered 2xx status code in the responses.
+     *
+     * @returns Success status code as string or undefined if none found
+     */
     toSuccessResponseCode(): string | undefined;
+    /**
+     * Maps the request body schema to a custom value using the provided mapping function.
+     *
+     * @param map - Function to transform the request body schema and metadata
+     * @param mediaType - Media type to extract schema from (default: 'application/json')
+     * @returns Mapped value or undefined if no request body schema found
+     */
     toRequestBody<V>(map: ({ schema, requestBody }: ToRequestBodyMapArgs) => V, mediaType?: string): V | undefined;
     /**
      * Resolve all parameters and optionally filter by location
@@ -197,9 +226,25 @@ export declare class OasOperation {
      * @returns
      */
     toParams(filter?: OasParameterLocation[]): OasParameter[];
+    /**
+     * Creates an OAS object representation of operation parameters.
+     *
+     * @param filter - Optional array of parameter locations to include
+     * @returns OAS object with parameter properties
+     */
     toParametersObject(filter?: OasParameterLocation[]): OasObject;
+    /**
+     * Converts the operation to OpenAPI v3 JSON schema format.
+     *
+     * @param options - Conversion options for nested components
+     * @returns OpenAPI v3 operation object
+     */
     toJsonSchema(options: ToJsonSchemaOptions): OpenAPIV3.OperationObject;
+    /**
+     * Serializes the operation to a plain JavaScript object.
+     *
+     * @returns Plain object representation of the operation
+     */
     toJSON(): object;
 }
-export {};
 //# sourceMappingURL=Operation.d.ts.map

package/esm/oas/operation/Operation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Operation.d.ts","sourceRoot":"","sources":["../../../src/oas/operation/Operation.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAC3F;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,qDAAqD;IACrD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC3B,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC/D,oDAAoD;IACpD,WAAW,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAChE,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC/C,2CAA2C;IAC3C,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,KAAK,oBAAoB,GAAG;IAC1B,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0GG;AACH,qBAAa,YAAY;IACvB,gDAAgD;IAChD,OAAO,EAAE,WAAW,CAAc;IAElC,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,qDAAqD;IACrD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,0CAA0C;IAC1C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,qCAAqC;IACrC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,sDAAsD;IACtD,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC1B,4CAA4C;IAC5C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,4CAA4C;IAC5C,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,oDAAoD;IACpD,WAAW,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAC/D,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,+CAA+C;IAC/C,QAAQ,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC9C,2CAA2C;IAC3C,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAExC,MAAM,EAAE,eAAe;IAgBnC,iBAAiB,IAAI,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS;IAMjE,qBAAqB,IAAI,MAAM,GAAG,SAAS;IAiB3C,aAAa,CAAC,CAAC,EACb,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,oBAAoB,KAAK,CAAC,EACzD,SAAS,SAAqB,GAC7B,CAAC,GAAG,SAAS;IAOhB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,GAAG,YAAY,EAAE;IAQzD,kBAAkB,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS;IAY9D,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;IAiBrE,MAAM,IAAI,MAAM;CAcjB"}
+{"version":3,"file":"Operation.d.ts","sourceRoot":"","sources":["../../../src/oas/operation/Operation.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AAC3E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAA;AAC3F;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,qDAAqD;IACrD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC5B,sDAAsD;IACtD,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC3B,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,4CAA4C;IAC5C,UAAU,CAAC,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC/D,oDAAoD;IACpD,WAAW,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAChE,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC/C,2CAA2C;IAC3C,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAChC,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;IACpC,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0GG;AACH,qBAAa,YAAY;IACvB,gDAAgD;IAChD,OAAO,EAAE,WAAW,CAAc;IAElC,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,qDAAqD;IACrD,QAAQ,EAAE,WAAW,GAAG,SAAS,CAAA;IACjC,0CAA0C;IAC1C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,qCAAqC;IACrC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,sDAAsD;IACtD,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;IAC1B,4CAA4C;IAC5C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,4CAA4C;IAC5C,UAAU,EAAE,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,EAAE,GAAG,SAAS,CAAA;IAC9D,oDAAoD;IACpD,WAAW,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,GAAG,SAAS,CAAA;IAC/D,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC3D,+CAA+C;IAC/C,QAAQ,EAAE,sBAAsB,EAAE,GAAG,SAAS,CAAA;IAC9C,2CAA2C;IAC3C,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,uCAAuC;IACvC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAEpD;;;;OAIG;gBACS,MAAM,EAAE,eAAe;IAgBnC;;;;;;OAMG;IACH,iBAAiB,IAAI,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,SAAS;IAMjE;;;;;;OAMG;IACH,qBAAqB,IAAI,MAAM,GAAG,SAAS;IAiB3C;;;;;;OAMG;IACH,aAAa,CAAC,CAAC,EACb,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,oBAAoB,KAAK,CAAC,EACzD,SAAS,SAAqB,GAC7B,CAAC,GAAG,SAAS;IAOhB;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,GAAG,YAAY,EAAE;IAQzD;;;;;OAKG;IACH,kBAAkB,CAAC,MAAM,CAAC,EAAE,oBAAoB,EAAE,GAAG,SAAS;IAY9D;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;IAiBrE;;;;OAIG;IACH,MAAM,IAAI,MAAM;CAcjB"}

package/esm/oas/operation/Operation.js

@@ -108,6 +108,11 @@ import { OasObject } from '../object/Object.js';
  * ```
  */
 export class OasOperation {
+    /**
+     * Creates a new OasOperation instance from operation field data.
+     *
+     * @param fields - Operation field data from OpenAPI specification
+     */
     constructor(fields) {
         /** Type identifier for OAS operation objects */
         Object.defineProperty(this, "oasType", {
@@ -221,10 +226,24 @@ export class OasOperation {
         this.deprecated = fields.deprecated;
         this.extensionFields = fields.extensionFields;
     }
+    /**
+     * Returns the successful response definition for this operation.
+     *
+     * Looks for the lowest numbered 2xx response code and returns its response definition.
+     *
+     * @returns Success response object or undefined if none found
+     */
     toSuccessResponse() {
         const successCode = this.toSuccessResponseCode();
         return successCode ? this.responses[successCode] : undefined;
     }
+    /**
+     * Returns the HTTP status code for the primary success response.
+     *
+     * Finds the lowest numbered 2xx status code in the responses.
+     *
+     * @returns Success status code as string or undefined if none found
+     */
     toSuccessResponseCode() {
         const successCode = Object.keys(this.responses)
             .map(httpCode => parseInt(httpCode))
@@ -238,6 +257,13 @@ export class OasOperation {
         }
         return undefined;
     }
+    /**
+     * Maps the request body schema to a custom value using the provided mapping function.
+     *
+     * @param map - Function to transform the request body schema and metadata
+     * @param mediaType - Media type to extract schema from (default: 'application/json')
+     * @returns Mapped value or undefined if no request body schema found
+     */
     toRequestBody(map, mediaType = 'application/json') {
         const requestBody = this.requestBody?.resolve();
         const schema = requestBody?.content[mediaType]?.schema;
@@ -254,6 +280,12 @@ export class OasOperation {
             ?.map(param => param.resolve())
             .filter(param => (filter?.length ? filter.includes(param.location) : true)) ?? []);
     }
+    /**
+     * Creates an OAS object representation of operation parameters.
+     *
+     * @param filter - Optional array of parameter locations to include
+     * @returns OAS object with parameter properties
+     */
     toParametersObject(filter) {
         const parameters = this.toParams(filter);
         return parameters.reduce((acc, parameter) => {
@@ -264,6 +296,12 @@ export class OasOperation {
             });
         }, OasObject.empty());
     }
+    /**
+     * Converts the operation to OpenAPI v3 JSON schema format.
+     *
+     * @param options - Conversion options for nested components
+     * @returns OpenAPI v3 operation object
+     */
     toJsonSchema(options) {
         return {
             tags: this.tags,
@@ -278,6 +316,11 @@ export class OasOperation {
             ...this.extensionFields
         };
     }
+    /**
+     * Serializes the operation to a plain JavaScript object.
+     *
+     * @returns Plain object representation of the operation
+     */
     toJSON() {
         return {
             tags: this.tags,

package/esm/oas/operation/operation-types.d.ts

@@ -0,0 +1,22 @@
+import { type OasParameterData } from '../parameter/parameter-types.js';
+import { type OasPathItemData } from '../pathItem/pathItem-types.js';
+import { type OasParameterRefData, type OasRequestBodyRefData, type OasResponseRefData } from '../ref/ref-types.js';
+import { type OasRequestBodyData } from '../requestBody/requestBody-types.js';
+import { type OasResponseData } from '../response/response-types.js';
+import * as v from 'valibot';
+export type OasOperationData = {
+    oasType: 'operation';
+    pathItem: OasPathItemData;
+    path: string;
+    method: 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace';
+    operationId?: string;
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    parameters?: (OasParameterData | OasParameterRefData)[];
+    requestBody?: OasRequestBodyData | OasRequestBodyRefData;
+    responses: Record<string, OasResponseData | OasResponseRefData>;
+    deprecated?: boolean;
+};
+export declare const oasOperationData: v.GenericSchema<OasOperationData>;
+//# sourceMappingURL=operation-types.d.ts.map

package/esm/oas/operation/operation-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-types.d.ts","sourceRoot":"","sources":["../../../src/oas/operation/operation-types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,iCAAiC,CAAA;AACzF,OAAO,EAAE,KAAK,eAAe,EAAmB,MAAM,+BAA+B,CAAA;AACrF,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EAIxB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,KAAK,kBAAkB,EAAsB,MAAM,qCAAqC,CAAA;AACjG,OAAO,EAAE,KAAK,eAAe,EAAmB,MAAM,+BAA+B,CAAA;AACrF,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,WAAW,CAAA;IACpB,QAAQ,EAAE,eAAe,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;IAClF,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IAGpB,UAAU,CAAC,EAAE,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,EAAE,CAAA;IACvD,WAAW,CAAC,EAAE,kBAAkB,GAAG,qBAAqB,CAAA;IACxD,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,kBAAkB,CAAC,CAAA;IAE/D,UAAU,CAAC,EAAE,OAAO,CAAA;CAGrB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CA2B7D,CAAA"}

package/esm/oas/operation/operation-types.js

@@ -0,0 +1,35 @@
+import { markdown } from '../markdown/markdown-types.js';
+import { oasParameterData } from '../parameter/parameter-types.js';
+import { oasPathItemData } from '../pathItem/pathItem-types.js';
+import { oasParameterRefData, oasRequestBodyRefData, oasResponseRefData } from '../ref/ref-types.js';
+import { oasRequestBodyData } from '../requestBody/requestBody-types.js';
+import { oasResponseData } from '../response/response-types.js';
+import * as v from 'valibot';
+export const oasOperationData = v.object({
+    oasType: v.literal('operation'),
+    pathItem: oasPathItemData,
+    path: v.string(),
+    method: v.enum({
+        get: 'get',
+        put: 'put',
+        post: 'post',
+        delete: 'delete',
+        options: 'options',
+        head: 'head',
+        patch: 'patch',
+        trace: 'trace'
+    }),
+    operationId: v.optional(v.string()),
+    tags: v.optional(v.array(v.string())),
+    summary: v.optional(v.string()),
+    description: v.optional(markdown),
+    // externalDocs: externalDocs.optional(),
+    // operationId: z.string().optional(),
+    parameters: v.optional(v.array(v.union([oasParameterData, oasParameterRefData]))),
+    requestBody: v.optional(v.union([oasRequestBodyData, oasRequestBodyRefData])),
+    responses: v.record(v.string(), v.union([oasResponseData, oasResponseRefData])),
+    // callbacks: z.never(),
+    deprecated: v.optional(v.boolean())
+    // security: z.never(),
+    // servers: z.array(server).optional()
+});

package/esm/oas/parameter/parameter-types.d.ts

@@ -4,22 +4,9 @@ import { type OasExampleRefData, type OasSchemaRefData } from '../ref/ref-types.
 import { type OasSchemaData } from '../schema/schema-types.js';
 import * as v from 'valibot';
 export type OasParameterLocation = 'query' | 'header' | 'path' | 'cookie';
-export declare const oasParameterLocation: v.EnumSchema<{
-    readonly query: "query";
-    readonly header: "header";
-    readonly path: "path";
-    readonly cookie: "cookie";
-}, undefined>;
+export declare const oasParameterLocation: v.GenericSchema<OasParameterLocation>;
 export type OasParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
-export declare const oasParameterStyle: v.EnumSchema<{
-    readonly matrix: "matrix";
-    readonly label: "label";
-    readonly form: "form";
-    readonly simple: "simple";
-    readonly spaceDelimited: "spaceDelimited";
-    readonly pipeDelimited: "pipeDelimited";
-    readonly deepObject: "deepObject";
-}, undefined>;
+export declare const oasParameterStyle: v.GenericSchema<OasParameterStyle>;
 export type OasParameterData = {
     oasType: 'parameter';
     allowEmptyValue?: boolean;
@@ -35,47 +22,5 @@ export type OasParameterData = {
     schema?: OasSchemaData | OasSchemaRefData;
     style: OasParameterStyle;
 };
-export declare const oasParameterData: v.ObjectSchema<{
-    readonly oasType: v.LiteralSchema<"parameter", undefined>;
-    readonly allowEmptyValue: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-    readonly allowReserved: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-    readonly content: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.ObjectSchema<{
-        readonly oasType: v.LiteralSchema<"mediaType", undefined>;
-        readonly mediaType: v.StringSchema<undefined>;
-        readonly schema: v.OptionalSchema<v.UnionSchema<[v.GenericSchema<OasSchemaData>, v.GenericSchema<OasSchemaRefData>], undefined>, undefined>;
-        readonly examples: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.ObjectSchema<{
-            readonly oasType: v.LiteralSchema<"example", undefined>;
-            readonly summary: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-            readonly description: v.OptionalSchema<v.GenericSchema<string>, undefined>;
-            readonly value: v.OptionalSchema<v.UnknownSchema, undefined>;
-        }, undefined>, v.GenericSchema<OasExampleRefData>], undefined>, undefined>, undefined>;
-    }, undefined>, undefined>, undefined>;
-    readonly deprecated: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-    readonly description: v.OptionalSchema<v.GenericSchema<string>, undefined>;
-    readonly examples: v.OptionalSchema<v.RecordSchema<v.StringSchema<undefined>, v.UnionSchema<[v.ObjectSchema<{
-        readonly oasType: v.LiteralSchema<"example", undefined>;
-        readonly summary: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-        readonly description: v.OptionalSchema<v.GenericSchema<string>, undefined>;
-        readonly value: v.OptionalSchema<v.UnknownSchema, undefined>;
-    }, undefined>, v.GenericSchema<OasExampleRefData>], undefined>, undefined>, undefined>;
-    readonly explode: v.BooleanSchema<undefined>;
-    readonly location: v.EnumSchema<{
-        readonly query: "query";
-        readonly header: "header";
-        readonly path: "path";
-        readonly cookie: "cookie";
-    }, undefined>;
-    readonly name: v.StringSchema<undefined>;
-    readonly required: v.OptionalSchema<v.BooleanSchema<undefined>, undefined>;
-    readonly schema: v.OptionalSchema<v.UnionSchema<[v.GenericSchema<OasSchemaData>, v.GenericSchema<OasSchemaRefData>], undefined>, undefined>;
-    readonly style: v.EnumSchema<{
-        readonly matrix: "matrix";
-        readonly label: "label";
-        readonly form: "form";
-        readonly simple: "simple";
-        readonly spaceDelimited: "spaceDelimited";
-        readonly pipeDelimited: "pipeDelimited";
-        readonly deepObject: "deepObject";
-    }, undefined>;
-}, undefined>;
+export declare const oasParameterData: v.GenericSchema<OasParameterData>;
 //# sourceMappingURL=parameter-types.d.ts.map

package/esm/oas/parameter/parameter-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parameter-types.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/parameter-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,6BAA6B,CAAA;AAEjF,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,iCAAiC,CAAA;AACzF,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAGtB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEzE,eAAO,MAAM,oBAAoB;;;;;aAK/B,CAAA;AAEF,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,OAAO,GACP,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,eAAe,GACf,YAAY,CAAA;AAEhB,eAAO,MAAM,iBAAiB;;;;;;;;aAQ5B,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,WAAW,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,iBAAiB,CAAC,CAAA;IAC7D,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,aAAa,GAAG,gBAAgB,CAAA;IACzC,KAAK,EAAE,iBAAiB,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;aAc3B,CAAA"}
+{"version":3,"file":"parameter-types.d.ts","sourceRoot":"","sources":["../../../src/oas/parameter/parameter-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,cAAc,EAAkB,MAAM,6BAA6B,CAAA;AAEjF,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,iCAAiC,CAAA;AACzF,OAAO,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAGtB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;AAEzE,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,aAAa,CAAC,oBAAoB,CAKrE,CAAA;AAEF,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,OAAO,GACP,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,eAAe,GACf,YAAY,CAAA;AAEhB,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAQ/D,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,WAAW,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IAC1C,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,GAAG,iBAAiB,CAAC,CAAA;IAC7D,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,aAAa,GAAG,gBAAgB,CAAA;IACzC,KAAK,EAAE,iBAAiB,CAAA;CACzB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAc7D,CAAA"}

package/esm/oas/pathItem/pathItem-types.d.ts

@@ -0,0 +1,12 @@
+import { type OasParameterData } from '../parameter/parameter-types.js';
+import { type OasParameterRefData } from '../ref/ref-types.js';
+import * as v from 'valibot';
+export type OasPathItemData = {
+    oasType: 'pathItem';
+    $ref?: string;
+    summary?: string;
+    description?: string;
+    parameters?: (OasParameterData | OasParameterRefData)[];
+};
+export declare const oasPathItemData: v.GenericSchema<OasPathItemData>;
+//# sourceMappingURL=pathItem-types.d.ts.map

package/esm/oas/pathItem/pathItem-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pathItem-types.d.ts","sourceRoot":"","sources":["../../../src/oas/pathItem/pathItem-types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,iCAAiC,CAAA;AACzF,OAAO,EAAE,KAAK,mBAAmB,EAAuB,MAAM,qBAAqB,CAAA;AACnF,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,UAAU,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,UAAU,CAAC,EAAE,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,EAAE,CAAA;CACxD,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,aAAa,CAAC,eAAe,CAO3D,CAAA"}

package/esm/oas/pathItem/pathItem-types.js

@@ -0,0 +1,12 @@
+import { markdown } from '../markdown/markdown-types.js';
+import { oasParameterData } from '../parameter/parameter-types.js';
+import { oasParameterRefData } from '../ref/ref-types.js';
+import * as v from 'valibot';
+export const oasPathItemData = v.object({
+    oasType: v.literal('pathItem'),
+    $ref: v.optional(v.string()),
+    summary: v.optional(v.string()),
+    description: v.optional(markdown),
+    // servers: z.array(server).optional(),
+    parameters: v.optional(v.array(v.union([oasParameterData, oasParameterRefData])))
+});

package/esm/oas/ref/Ref.d.ts

@@ -10,6 +10,11 @@ import type { OasDocument } from '../document/Document.js';
 import type { RefName } from '../../types/RefName.js';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { OasSecurityScheme } from '../securitySchemes/SecurityScheme.js';
+/**
+ * Field data for creating OAS reference objects.
+ *
+ * @template T - The type of component being referenced (e.g., 'schema', 'response')
+ */
 export type RefFields<T extends OasRefData['refType']> = {
     refType: T;
     $ref: string;
@@ -102,11 +107,39 @@ export type RefFields<T extends OasRefData['refType']> = {
  */
 export declare class OasRef<T extends OasRefData['refType']> {
     #private;
+    /** OAS type identifier */
     oasType: 'ref';
+    /** Type identifier */
     type: 'ref';
+    /**
+     * Creates a new OAS reference instance.
+     *
+     * @param fields - Reference field data including refType and $ref
+     * @param oasDocument - Document containing the referenced component
+     */
     constructor(fields: RefFields<T>, oasDocument: OasDocument);
+    /**
+     * Type guard to check if this instance is a reference.
+     *
+     * @returns Always true for OasRef instances
+     */
     isRef(): this is OasRef<T>;
+    /**
+     * Recursively resolves this reference to its final target component.
+     *
+     * Follows reference chains until reaching a non-reference component,
+     * with protection against infinite loops.
+     *
+     * @param lookupsPerformed - Internal counter to prevent infinite recursion
+     * @returns The resolved component
+     * @throws Error if maximum lookup depth is exceeded
+     */
     resolve(lookupsPerformed?: number): ResolvedRef<T>;
+    /**
+     * Resolves this reference one level, potentially returning another reference.
+     *
+     * @returns Either the resolved component or another reference in the chain
+     */
     resolveOnce(): OasRef<T> | ResolvedRef<T>;
     toRefName(): RefName;
     get $ref(): string;
@@ -115,10 +148,24 @@ export declare class OasRef<T extends OasRefData['refType']> {
     toJsonSchema({ resolve }: ToJsonSchemaOptions): OpenAPIV3.ReferenceObject | ResolvedRefJsonType<T>;
     toJSON(): object;
 }
-type ResolvedRefJsonType<T extends OasRefData['refType']> = ReturnType<ResolvedRef<T>['toJsonSchema']>;
+/**
+ * Type representing the JSON schema result from resolving a reference.
+ *
+ * @template T - The type of component being referenced
+ */
+export type ResolvedRefJsonType<T extends OasRefData['refType']> = ReturnType<ResolvedRef<T>['toJsonSchema']>;
+/**
+ * Union type of all OAS component types that can be referenced.
+ *
+ * Includes all OpenAPI component types that support $ref resolution.
+ */
 export type OasComponentType = OasSchema | OasResponse | OasParameter | OasExample | OasRequestBody | OasHeader | OasSecurityScheme;
+/**
+ * Type representing a resolved reference to a specific component type.
+ *
+ * @template T - The type of component being referenced (e.g., 'schema', 'response')
+ */
 export type ResolvedRef<T extends OasRefData['refType']> = Extract<OasComponentType, {
     oasType: T;
 }>;
-export {};
 //# sourceMappingURL=Ref.d.ts.map

package/esm/oas/ref/Ref.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Ref.d.ts","sourceRoot":"","sources":["../../../src/oas/ref/Ref.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAGhD,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAI7E,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,CAAC,IAAI;IACvD,OAAO,EAAE,CAAC,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqFG;AACH,qBAAa,MAAM,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,CAAC;;IACjD,OAAO,EAAE,KAAK,CAAQ;IACtB,IAAI,EAAE,KAAK,CAAQ;gBAIP,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,WAAW;IAK1D,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC;IAI1B,OAAO,CAAC,gBAAgB,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAUrD,WAAW,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAsCzC,SAAS,IAAI,OAAO;IAIpB,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,OAAO,IAAI,UAAU,CAAC,SAAS,CAAC,CAEnC;IAED,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,YAAY,CAAC,EACX,OAAO,EACR,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe,GAAG,mBAAmB,CAAC,CAAC,CAAC;IAsB3E,MAAM,IAAI,MAAM;CAajB;AAED,KAAK,mBAAmB,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,CAAC,IAAI,UAAU,CACpE,WAAW,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAC/B,CAAA;AAED,MAAM,MAAM,gBAAgB,GACxB,SAAS,GACT,WAAW,GACX,YAAY,GACZ,UAAU,GACV,cAAc,GACd,SAAS,GACT,iBAAiB,CAAA;AAErB,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,gBAAgB,EAAE;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC,CAAA"}
+{"version":3,"file":"Ref.d.ts","sourceRoot":"","sources":["../../../src/oas/ref/Ref.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAGhD,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAI7E;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,CAAC,IAAI;IACvD,OAAO,EAAE,CAAC,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqFG;AACH,qBAAa,MAAM,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,CAAC;;IACjD,0BAA0B;IAC1B,OAAO,EAAE,KAAK,CAAQ;IACtB,sBAAsB;IACtB,IAAI,EAAE,KAAK,CAAQ;IAInB;;;;;OAKG;gBACS,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,WAAW;IAK1D;;;;OAIG;IACH,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC;IAI1B;;;;;;;;;OASG;IACH,OAAO,CAAC,gBAAgB,GAAE,MAAU,GAAG,WAAW,CAAC,CAAC,CAAC;IAUrD;;;;OAIG;IACH,WAAW,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC;IAsCzC,SAAS,IAAI,OAAO;IAIpB,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,OAAO,IAAI,UAAU,CAAC,SAAS,CAAC,CAEnC;IAED,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,YAAY,CAAC,EACX,OAAO,EACR,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe,GAAG,mBAAmB,CAAC,CAAC,CAAC;IAsB3E,MAAM,IAAI,MAAM;CAajB;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,CAAC,IAAI,UAAU,CAC3E,WAAW,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAC/B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,SAAS,GACT,WAAW,GACX,YAAY,GACZ,UAAU,GACV,cAAc,GACd,SAAS,GACT,iBAAiB,CAAA;AAErB;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,CAAC,IAAI,OAAO,CAAC,gBAAgB,EAAE;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC,CAAA"}

package/esm/oas/ref/Ref.js

@@ -101,13 +101,21 @@ const MAX_LOOKUPS = 10;
  * ```
  */
 export class OasRef {
+    /**
+     * Creates a new OAS reference instance.
+     *
+     * @param fields - Reference field data including refType and $ref
+     * @param oasDocument - Document containing the referenced component
+     */
     constructor(fields, oasDocument) {
+        /** OAS type identifier */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'ref'
         });
+        /** Type identifier */
         Object.defineProperty(this, "type", {
             enumerable: true,
             configurable: true,
@@ -119,9 +127,24 @@ export class OasRef {
         __classPrivateFieldSet(this, _OasRef_fields, fields, "f");
         __classPrivateFieldSet(this, _OasRef_oasDocument, oasDocument, "f");
     }
+    /**
+     * Type guard to check if this instance is a reference.
+     *
+     * @returns Always true for OasRef instances
+     */
     isRef() {
         return true;
     }
+    /**
+     * Recursively resolves this reference to its final target component.
+     *
+     * Follows reference chains until reaching a non-reference component,
+     * with protection against infinite loops.
+     *
+     * @param lookupsPerformed - Internal counter to prevent infinite recursion
+     * @returns The resolved component
+     * @throws Error if maximum lookup depth is exceeded
+     */
     resolve(lookupsPerformed = 0) {
         if (lookupsPerformed >= MAX_LOOKUPS) {
             throw new Error('Max lookups reached');
@@ -129,6 +152,11 @@ export class OasRef {
         const resolved = this.resolveOnce();
         return resolved.isRef() ? resolved.resolve(lookupsPerformed + 1) : resolved;
     }
+    /**
+     * Resolves this reference one level, potentially returning another reference.
+     *
+     * @returns Either the resolved component or another reference in the chain
+     */
     resolveOnce() {
         const c = this.oasDocument.components;
         const refName = toRefName(this.$ref);

package/esm/oas/requestBody/requestBody-types.d.ts

@@ -0,0 +1,10 @@
+import { type OasMediaTypeData } from '../mediaType/mediaType-types.js';
+import * as v from 'valibot';
+export type OasRequestBodyData = {
+    oasType: 'requestBody';
+    description?: string;
+    content: Record<string, OasMediaTypeData>;
+    required?: boolean;
+};
+export declare const oasRequestBodyData: v.GenericSchema<OasRequestBodyData>;
+//# sourceMappingURL=requestBody-types.d.ts.map

package/esm/oas/requestBody/requestBody-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"requestBody-types.d.ts","sourceRoot":"","sources":["../../../src/oas/requestBody/requestBody-types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,iCAAiC,CAAA;AACzF,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,aAAa,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAKjE,CAAA"}

package/esm/oas/requestBody/requestBody-types.js

@@ -0,0 +1,9 @@
+import { markdown } from '../markdown/markdown-types.js';
+import { oasMediaTypeData } from '../mediaType/mediaType-types.js';
+import * as v from 'valibot';
+export const oasRequestBodyData = v.object({
+    oasType: v.literal('requestBody'),
+    description: v.optional(markdown),
+    content: v.record(v.string(), oasMediaTypeData),
+    required: v.optional(v.boolean())
+});

package/esm/oas/response/response-types.d.ts

@@ -0,0 +1,12 @@
+import { type OasHeaderData } from '../header/header-types.js';
+import { type OasMediaTypeData } from '../mediaType/mediaType-types.js';
+import { type OasHeaderRefData } from '../ref/ref-types.js';
+import * as v from 'valibot';
+export type OasResponseData = {
+    oasType: 'response';
+    description: string;
+    headers?: Record<string, OasHeaderData | OasHeaderRefData>;
+    content?: Record<string, OasMediaTypeData>;
+};
+export declare const oasResponseData: v.GenericSchema<OasResponseData>;
+//# sourceMappingURL=response-types.d.ts.map

package/esm/oas/response/response-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-types.d.ts","sourceRoot":"","sources":["../../../src/oas/response/response-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,aAAa,EAAiB,MAAM,2BAA2B,CAAA;AAC7E,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,iCAAiC,CAAA;AACzF,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,qBAAqB,CAAA;AAC7E,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,UAAU,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,gBAAgB,CAAC,CAAA;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;CAE3C,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,aAAa,CAAC,eAAe,CAM3D,CAAA"}

package/esm/oas/response/response-types.js

@@ -0,0 +1,11 @@
+import { oasHeaderData } from '../header/header-types.js';
+import { oasMediaTypeData } from '../mediaType/mediaType-types.js';
+import { oasHeaderRefData } from '../ref/ref-types.js';
+import * as v from 'valibot';
+export const oasResponseData = v.object({
+    oasType: v.literal('response'),
+    description: v.string(),
+    headers: v.optional(v.record(v.string(), v.union([oasHeaderData, oasHeaderRefData]))),
+    content: v.optional(v.record(v.string(), oasMediaTypeData))
+    // links: z.record(z.union([link, ref])).optional()
+});

package/esm/oas/schema/toSchemasV3.js

@@ -80,8 +80,8 @@ export const toSchemaV3 = ({ schema, context }) => {
     })
         .with({ anyOf: P.array() }, matched => {
         return context.trace('anyOf', () => {
-            const lastThree = context.stackTrail.slice(-3).toString();
-            const lastFive = context.stackTrail.slice(-5).toString();
+            const _lastThree = context.stackTrail.slice(-3).toString();
+            const _lastFive = context.stackTrail.slice(-5).toString();
             // deno-lint-ignore ban-ts-comment
             // @ts-expect-error
             if (matched['x-expansionResources']) {