@skmtc/core 0.0.803 → 0.0.805

package/esm/oas/contact/Contact.d.ts

@@ -1,15 +1,57 @@
+/**
+ * Constructor fields for {@link OasContact}.
+ *
+ * Defines the configuration options for creating contact information,
+ * including name, URL, email, and extension fields.
+ */
 export type ContactFields = {
     name?: string;
     url?: string;
     email?: string;
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Contact Object in the OpenAPI Specification.
+ *
+ * The `OasContact` class encapsulates contact information for the API,
+ * providing details about who to contact for support, questions, or issues.
+ * This information is typically displayed in API documentation.
+ *
+ * @example Basic contact information
+ * ```typescript
+ * import { OasContact } from '@skmtc/core';
+ *
+ * const contact = new OasContact({
+ *   name: 'API Support Team',
+ *   email: 'support@example.com'
+ * });
+ * ```
+ *
+ * @example Complete contact details
+ * ```typescript
+ * const fullContact = new OasContact({
+ *   name: 'John Doe',
+ *   url: 'https://example.com/contact',
+ *   email: 'john@example.com'
+ * });
+ * ```
+ */
 export declare class OasContact {
+    /** Type identifier for this OAS contact object */
     oasType: "contact";
+    /** The identifying name of the contact person/organization */
     name: string | undefined;
+    /** URL pointing to the contact information */
     url: string | undefined;
+    /** Email address of the contact person/organization */
     email: string | undefined;
+    /** Custom extension fields (x-* properties) for additional contact metadata */
     extensionFields: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasContact instance.
+     *
+     * @param fields - Contact information fields including name, URL, and email
+     */
     constructor(fields?: ContactFields);
 }
 //# sourceMappingURL=Contact.d.ts.map

package/esm/oas/contact/Contact.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Contact.d.ts","sourceRoot":"","sources":["../../../src/oas/contact/Contact.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,UAAU;IACrB,OAAO,EAAG,SAAS,CAAS;IAE5B,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;IACvB,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAExC,MAAM,GAAE,aAAkB;CAMvC"}
+{"version":3,"file":"Contact.d.ts","sourceRoot":"","sources":["../../../src/oas/contact/Contact.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,UAAU;IACrB,kDAAkD;IAClD,OAAO,EAAG,SAAS,CAAS;IAE5B,8DAA8D;IAC9D,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,8CAA8C;IAC9C,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;IACvB,uDAAuD;IACvD,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB,+EAA+E;IAC/E,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAEpD;;;;OAIG;gBACS,MAAM,GAAE,aAAkB;CAMvC"}

package/esm/oas/contact/Contact.js

@@ -1,29 +1,65 @@
+/**
+ * Represents a Contact Object in the OpenAPI Specification.
+ *
+ * The `OasContact` class encapsulates contact information for the API,
+ * providing details about who to contact for support, questions, or issues.
+ * This information is typically displayed in API documentation.
+ *
+ * @example Basic contact information
+ * ```typescript
+ * import { OasContact } from '@skmtc/core';
+ *
+ * const contact = new OasContact({
+ *   name: 'API Support Team',
+ *   email: 'support@example.com'
+ * });
+ * ```
+ *
+ * @example Complete contact details
+ * ```typescript
+ * const fullContact = new OasContact({
+ *   name: 'John Doe',
+ *   url: 'https://example.com/contact',
+ *   email: 'john@example.com'
+ * });
+ * ```
+ */
 export class OasContact {
+    /**
+     * Creates a new OasContact instance.
+     *
+     * @param fields - Contact information fields including name, URL, and email
+     */
     constructor(fields = {}) {
+        /** Type identifier for this OAS contact object */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'contact'
         });
+        /** The identifying name of the contact person/organization */
         Object.defineProperty(this, "name", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** URL pointing to the contact information */
         Object.defineProperty(this, "url", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Email address of the contact person/organization */
         Object.defineProperty(this, "email", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Custom extension fields (x-* properties) for additional contact metadata */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,

package/esm/oas/info/Info.d.ts

@@ -84,13 +84,49 @@ export type InfoFields = {
  */
 export declare class OasInfo {
     #private;
+    /** Type identifier for this OAS info object */
     oasType: 'info';
+    /**
+     * Creates a new OasInfo instance.
+     *
+     * @param fields - API information fields including title, version, description, and contact details
+     */
     constructor(fields: InfoFields);
+    /**
+     * Gets the API title.
+     *
+     * @returns The title of the API
+     */
     get title(): string;
+    /**
+     * Gets the API description.
+     *
+     * @returns Optional detailed description of the API's purpose and functionality
+     */
     get description(): string | undefined;
+    /**
+     * Gets the terms of service URL.
+     *
+     * @returns Optional URL pointing to the API's terms of service
+     */
     get termsOfService(): string | undefined;
+    /**
+     * Gets the contact information.
+     *
+     * @returns Optional contact information for API support and inquiries
+     */
     get contact(): OasContact | undefined;
+    /**
+     * Gets the license information.
+     *
+     * @returns Optional license information governing API usage
+     */
     get license(): OasLicense | undefined;
+    /**
+     * Gets the API version.
+     *
+     * @returns The version string of the API (e.g., '1.0.0', '2.1.3')
+     */
     get version(): string;
     /** Specification Extension fields */
     get extensionFields(): Record<string, unknown> | undefined;

package/esm/oas/info/Info.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Info.d.ts","sourceRoot":"","sources":["../../../src/oas/info/Info.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,kDAAkD;IAClD,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,kDAAkD;IAClD,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,qBAAa,OAAO;;IAClB,OAAO,EAAE,MAAM,CAAS;gBAGZ,MAAM,EAAE,UAAU;IAI9B,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,IAAI,cAAc,IAAI,MAAM,GAAG,SAAS,CAEvC;IAED,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAEpC;IAED,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAEpC;IAED,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;CACF"}
+{"version":3,"file":"Info.d.ts","sourceRoot":"","sources":["../../../src/oas/info/Info.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAA;IACf,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,gDAAgD;IAChD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,kDAAkD;IAClD,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,kDAAkD;IAClD,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,qBAAa,OAAO;;IAClB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAS;IAIxB;;;;OAIG;gBACS,MAAM,EAAE,UAAU;IAI9B;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED;;;;OAIG;IACH,IAAI,cAAc,IAAI,MAAM,GAAG,SAAS,CAEvC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAEpC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,UAAU,GAAG,SAAS,CAEpC;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;CACF"}

package/esm/oas/info/Info.js

@@ -74,31 +74,68 @@ import "../../_dnt.polyfills.js";
  * ```
  */
 export class OasInfo {
+    /**
+     * Creates a new OasInfo instance.
+     *
+     * @param fields - API information fields including title, version, description, and contact details
+     */
     constructor(fields) {
+        /** Type identifier for this OAS info object */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'info'
         });
+        /** Private storage for all info fields */
         _OasInfo_fields.set(this, void 0);
         __classPrivateFieldSet(this, _OasInfo_fields, fields, "f");
     }
+    /**
+     * Gets the API title.
+     *
+     * @returns The title of the API
+     */
     get title() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").title;
     }
+    /**
+     * Gets the API description.
+     *
+     * @returns Optional detailed description of the API's purpose and functionality
+     */
     get description() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").description;
     }
+    /**
+     * Gets the terms of service URL.
+     *
+     * @returns Optional URL pointing to the API's terms of service
+     */
     get termsOfService() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").termsOfService;
     }
+    /**
+     * Gets the contact information.
+     *
+     * @returns Optional contact information for API support and inquiries
+     */
     get contact() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").contact;
     }
+    /**
+     * Gets the license information.
+     *
+     * @returns Optional license information governing API usage
+     */
     get license() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").license;
     }
+    /**
+     * Gets the API version.
+     *
+     * @returns The version string of the API (e.g., '1.0.0', '2.1.3')
+     */
     get version() {
         return __classPrivateFieldGet(this, _OasInfo_fields, "f").version;
     }

package/esm/oas/mediaType/MediaType.d.ts

@@ -96,13 +96,30 @@ export type MediaTypeFields = {
  * ```
  */
 export declare class OasMediaType {
+    /** Type identifier for this OAS media type */
     oasType: 'mediaType';
+    /** The media type identifier (e.g., 'application/json', 'text/xml') */
     mediaType: string;
+    /** The schema defining the structure and validation rules for the content */
     schema: OasSchema | OasRef<'schema'> | undefined;
+    /** Example values demonstrating the media type content */
     examples: Record<string, OasExample | OasRef<'example'>> | undefined;
+    /** Custom extension fields (x-* properties) defined for this media type */
     extensionFields: Record<string, unknown> | undefined;
+    /** Encoding information for multipart and form data serialization */
     encoding?: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasMediaType instance.
+     *
+     * @param fields - Media type configuration including content schema, examples, and encoding
+     */
     constructor(fields: MediaTypeFields);
+    /**
+     * Converts this OAS media type to an OpenAPI v3 JSON schema representation.
+     *
+     * @param options - Conversion options including reference handling and formatting preferences
+     * @returns OpenAPI v3 media type object with schema and examples
+     */
     toJsonSchema(options: ToJsonSchemaOptions): OpenAPIV3.MediaTypeObject;
 }
 //# sourceMappingURL=MediaType.d.ts.map

package/esm/oas/mediaType/MediaType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MediaType.d.ts","sourceRoot":"","sources":["../../../src/oas/mediaType/MediaType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAA;IACjB,uDAAuD;IACvD,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CAC/C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AACH,qBAAa,YAAY;IACvB,OAAO,EAAE,WAAW,CAAc;IAClC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IAChD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACpE,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBAClC,MAAM,EAAE,eAAe;IAQnC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAMtE"}
+{"version":3,"file":"MediaType.d.ts","sourceRoot":"","sources":["../../../src/oas/mediaType/MediaType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAA;IACjB,uDAAuD;IACvD,MAAM,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IACjD,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACrE,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;CAC/C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AACH,qBAAa,YAAY;IACvB,8CAA8C;IAC9C,OAAO,EAAE,WAAW,CAAc;IAClC,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAA;IACjB,6EAA6E;IAC7E,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IAChD,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACpE,2EAA2E;IAC3E,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD,qEAAqE;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IAC9C;;;;OAIG;gBACS,MAAM,EAAE,eAAe;IAQnC;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,eAAe;CAMtE"}

package/esm/oas/mediaType/MediaType.js

@@ -76,37 +76,48 @@
  * ```
  */
 export class OasMediaType {
+    /**
+     * Creates a new OasMediaType instance.
+     *
+     * @param fields - Media type configuration including content schema, examples, and encoding
+     */
     constructor(fields) {
+        /** Type identifier for this OAS media type */
         Object.defineProperty(this, "oasType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: 'mediaType'
         });
+        /** The media type identifier (e.g., 'application/json', 'text/xml') */
         Object.defineProperty(this, "mediaType", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The schema defining the structure and validation rules for the content */
         Object.defineProperty(this, "schema", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Example values demonstrating the media type content */
         Object.defineProperty(this, "examples", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Custom extension fields (x-* properties) defined for this media type */
         Object.defineProperty(this, "extensionFields", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Encoding information for multipart and form data serialization */
         Object.defineProperty(this, "encoding", {
             enumerable: true,
             configurable: true,
@@ -119,6 +130,12 @@ export class OasMediaType {
         this.encoding = fields.encoding;
         this.extensionFields = fields.extensionFields;
     }
+    /**
+     * Converts this OAS media type to an OpenAPI v3 JSON schema representation.
+     *
+     * @param options - Conversion options including reference handling and formatting preferences
+     * @returns OpenAPI v3 media type object with schema and examples
+     */
     toJsonSchema(options) {
         return {
             schema: this.schema?.toJsonSchema(options),

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

@@ -65,6 +65,12 @@ export type OasParameterRefData = {
  * Valibot schema for validating parameter reference data.
  */
 export declare const oasParameterRefData: v.GenericSchema<OasParameterRefData>;
+/**
+ * Data type for OpenAPI example reference objects.
+ *
+ * Represents $ref references to example objects in OpenAPI documents,
+ * enabling example reuse across multiple schema definitions and operations.
+ */
 export type OasExampleRefData = {
     oasType: 'ref';
     refType: 'example';
@@ -72,7 +78,16 @@ export type OasExampleRefData = {
     summary?: string;
     description?: string;
 };
+/**
+ * Valibot schema for validating example reference data.
+ */
 export declare const oasExampleRefData: v.GenericSchema<OasExampleRefData>;
+/**
+ * Data type for OpenAPI request body reference objects.
+ *
+ * Represents $ref references to request body objects in OpenAPI documents,
+ * allowing request body definitions to be reused across operations.
+ */
 export type OasRequestBodyRefData = {
     oasType: 'ref';
     refType: 'requestBody';
@@ -80,7 +95,16 @@ export type OasRequestBodyRefData = {
     summary?: string;
     description?: string;
 };
+/**
+ * Valibot schema for validating request body reference data.
+ */
 export declare const oasRequestBodyRefData: v.GenericSchema<OasRequestBodyRefData>;
+/**
+ * Data type for OpenAPI header reference objects.
+ *
+ * Represents $ref references to header objects in OpenAPI documents,
+ * enabling header definition reuse across operations and responses.
+ */
 export type OasHeaderRefData = {
     oasType: 'ref';
     refType: 'header';
@@ -88,13 +112,37 @@ export type OasHeaderRefData = {
     summary?: string;
     description?: string;
 };
+/**
+ * Valibot schema for validating header reference data.
+ */
 export declare const oasHeaderRefData: v.GenericSchema<OasHeaderRefData>;
+/**
+ * Data type for OpenAPI security scheme reference objects.
+ *
+ * Represents $ref references to security scheme objects in OpenAPI documents,
+ * allowing security scheme definitions to be reused across operations.
+ */
 export type OasSecuritySchemeRefData = {
     oasType: 'ref';
     refType: 'securityScheme';
     $ref: string;
 };
+/**
+ * Valibot schema for validating security scheme reference data.
+ */
 export declare const oasSecuritySchemeRefData: v.GenericSchema<OasSecuritySchemeRefData>;
+/**
+ * Union type representing all possible OpenAPI reference data types.
+ *
+ * Encompasses all supported reference types in the OpenAPI specification,
+ * providing type-safe handling of references to various component types.
+ */
 export type OasRefData = OasSchemaRefData | OasResponseRefData | OasParameterRefData | OasExampleRefData | OasRequestBodyRefData | OasHeaderRefData | OasSecuritySchemeRefData;
+/**
+ * Valibot schema for validating any OpenAPI reference data.
+ *
+ * Union schema that validates all supported reference types,
+ * ensuring type safety across the entire reference system.
+ */
 export declare const oasRefData: v.GenericSchema<OasRefData>;
 //# sourceMappingURL=ref-types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"ref-types.d.ts","sourceRoot":"","sources":["../../../src/oas/ref/ref-types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,QAAQ,CAAA;IACjB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,UAAU,CAAA;IACnB,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAMjE,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,WAAW,CAAA;IACpB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,aAAa,CAAC,mBAAmB,CAMnE,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,SAAS,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAM/D,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,aAAa,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,aAAa,CAAC,qBAAqB,CAMvE,CAAA;AACF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,wBAAwB,CAI7E,CAAA;AAUF,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,CAAA;AAG5B,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CASjD,CAAA"}
+{"version":3,"file":"ref-types.d.ts","sourceRoot":"","sources":["../../../src/oas/ref/ref-types.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,QAAQ,CAAA;IACjB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,UAAU,CAAA;IACnB,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,CAAC,CAAC,aAAa,CAAC,kBAAkB,CAMjE,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAA;IACd,0CAA0C;IAC1C,OAAO,EAAE,WAAW,CAAA;IACpB,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,CAAC,CAAC,aAAa,CAAC,mBAAmB,CAMnE,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,SAAS,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAM/D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,aAAa,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,CAAC,CAAC,aAAa,CAAC,qBAAqB,CAMvE,CAAA;AACF;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,QAAQ,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,CAAC,CAAC,aAAa,CAAC,gBAAgB,CAM7D,CAAA;AAEF;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,KAAK,CAAA;IACd,OAAO,EAAE,gBAAgB,CAAA;IACzB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,aAAa,CAAC,wBAAwB,CAI7E,CAAA;AAUF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,qBAAqB,GACrB,gBAAgB,GAChB,wBAAwB,CAAA;AAG5B;;;;;GAKG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CASjD,CAAA"}

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

@@ -30,6 +30,9 @@ export const oasParameterRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown)
 });
+/**
+ * Valibot schema for validating example reference data.
+ */
 export const oasExampleRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('example'),
@@ -37,6 +40,9 @@ export const oasExampleRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown)
 });
+/**
+ * Valibot schema for validating request body reference data.
+ */
 export const oasRequestBodyRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('requestBody'),
@@ -44,6 +50,9 @@ export const oasRequestBodyRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown)
 });
+/**
+ * Valibot schema for validating header reference data.
+ */
 export const oasHeaderRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('header'),
@@ -51,12 +60,21 @@ export const oasHeaderRefData = v.object({
     summary: v.optional(v.string()),
     description: v.optional(markdown)
 });
+/**
+ * Valibot schema for validating security scheme reference data.
+ */
 export const oasSecuritySchemeRefData = v.object({
     oasType: v.literal('ref'),
     refType: v.literal('securityScheme'),
     $ref: v.string()
 });
 // OasPathItemRefData
+/**
+ * Valibot schema for validating any OpenAPI reference data.
+ *
+ * Union schema that validates all supported reference types,
+ * ensuring type safety across the entire reference system.
+ */
 export const oasRefData = v.union([
     oasSchemaRefData,
     oasResponseRefData,

package/esm/oas/server/Server.d.ts

@@ -2,22 +2,94 @@ import "../../_dnt.polyfills.js";
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
 import type { OasServerVariable } from '../serverVariable/ServerVariable.js';
+/**
+ * Constructor fields for {@link OasServer}.
+ *
+ * Defines the configuration options available when creating server instances,
+ * including URL, description, variables, and extension fields.
+ */
 export type ServerFields = {
     description?: string | undefined;
     url: string;
     variables?: Record<string, OasServerVariable> | undefined;
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents a Server Object in the OpenAPI Specification.
+ *
+ * The `OasServer` class encapsulates server connectivity information, including
+ * the server URL, optional description, and variable definitions for URL templating.
+ * Servers are used to specify different environments (development, staging, production)
+ * or different API versions that clients can connect to.
+ *
+ * @example Basic server
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://api.example.com/v1',
+ *   description: 'Production API server'
+ * });
+ * ```
+ *
+ * @example Server with variables
+ * ```typescript
+ * const server = new OasServer({
+ *   url: 'https://{environment}.example.com/{version}',
+ *   description: 'Configurable API server',
+ *   variables: {
+ *     environment: new OasServerVariable({
+ *       enum: ['api', 'staging', 'dev'],
+ *       default: 'api',
+ *       description: 'API environment'
+ *     }),
+ *     version: new OasServerVariable({
+ *       default: 'v1',
+ *       description: 'API version'
+ *     })
+ *   }
+ * });
+ * ```
+ */
 export declare class OasServer {
+    /** Type identifier for this OAS server */
     oasType: 'server';
+    /** Human-readable description of the server */
     description: string | undefined;
+    /** Server URL with optional variable templating */
     url: string;
+    /** Variable definitions for URL templating */
     variables: Record<string, OasServerVariable> | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasServer instance.
+     *
+     * @param fields - Server configuration including URL, description, and variables
+     */
     constructor(fields: ServerFields);
+    /**
+     * Determines if this server is a reference object.
+     *
+     * @returns Always false since servers are not reference objects in OpenAPI
+     */
     isRef(): boolean;
+    /**
+     * Resolves this server object.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolve(): OasServer;
+    /**
+     * Resolves this server object one level.
+     *
+     * @returns The server instance itself since it's already a concrete object
+     */
     resolveOnce(): OasServer;
+    /**
+     * Converts this OAS server to an OpenAPI v3 JSON schema representation.
+     *
+     * @param _options - Conversion options (currently unused for server objects)
+     * @returns OpenAPI v3 server object with URL, description, and variables
+     */
     toJsonSchema(_options: ToJsonSchemaOptions): OpenAPIV3.ServerObject;
 }
 //# sourceMappingURL=Server.d.ts.map

package/esm/oas/server/Server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Server.d.ts","sourceRoot":"","sources":["../../../src/oas/server/Server.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AAE5E,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,qBAAa,SAAS;IACpB,OAAO,EAAE,QAAQ,CAAW;IAC5B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACxD,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;gBACxC,MAAM,EAAE,YAAY;IAOhC,KAAK,IAAI,OAAO;IAIhB,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;IAIxB,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,YAAY;CAOpE"}
+{"version":3,"file":"Server.d.ts","sourceRoot":"","sources":["../../../src/oas/server/Server.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAA;AAE5E;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACzD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,SAAS;IACpB,0CAA0C;IAC1C,OAAO,EAAE,QAAQ,CAAW;IAC5B,+CAA+C;IAC/C,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,mDAAmD;IACnD,GAAG,EAAE,MAAM,CAAA;IACX,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,GAAG,SAAS,CAAA;IACxD,+CAA+C;IAC/C,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;;;OAIG;gBACS,MAAM,EAAE,YAAY;IAOhC;;;;OAIG;IACH,KAAK,IAAI,OAAO;IAIhB;;;;OAIG;IACH,OAAO,IAAI,SAAS;IAIpB;;;;OAIG;IACH,WAAW,IAAI,SAAS;IAIxB;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,YAAY;CAOpE"}