@skmtc/core 0.0.791 → 0.0.793

package/script/oas/header/Header.d.ts

@@ -4,16 +4,232 @@ import type { OasExample } from '../example/Example.js';
 import type { OasSchema } from '../schema/Schema.js';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
+/**
+ * Constructor fields for {@link OasHeader}.
+ */
 export type HeaderFields = {
+    /** A brief description of the header */
     description: string | undefined;
+    /** Whether the header is required */
     required: boolean | undefined;
+    /** Whether the header is deprecated */
     deprecated: boolean | undefined;
+    /** Schema defining the header's data type */
     schema: OasSchema | OasRef<'schema'> | undefined;
+    /** Example values for the header */
     examples: Record<string, OasExample | OasRef<'example'>> | undefined;
+    /** Content definitions for complex header values */
     content: Record<string, OasMediaType> | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
-/** Describes a single header in the API */
+/**
+ * Represents a Header Object in the OpenAPI Specification.
+ *
+ * The `OasHeader` class encapsulates the definition of a single HTTP header that
+ * can be sent with responses or expected in requests. Headers provide additional
+ * metadata about the HTTP message and can include authentication tokens, content
+ * information, pagination data, rate limiting details, and more.
+ *
+ * This class provides comprehensive support for header definitions with typed
+ * values, validation schemas, examples, and documentation.
+ *
+ * ## Key Features
+ *
+ * - **Schema Validation**: Typed header values through schema definitions
+ * - **Examples**: Multiple example values for documentation and testing
+ * - **Content Types**: Support for complex header values with media types
+ * - **Deprecation Support**: Mark headers as deprecated with proper warnings
+ * - **Required/Optional**: Control whether headers are mandatory
+ * - **Documentation**: Rich description support for API documentation
+ *
+ * @example Basic authentication header
+ * ```typescript
+ * import { OasHeader, OasString } from '@skmtc/core';
+ *
+ * const authHeader = new OasHeader({
+ *   description: 'Bearer token for API authentication',
+ *   required: true,
+ *   schema: new OasString({
+ *     pattern: '^Bearer [A-Za-z0-9+/=]+$',
+ *     description: 'JWT bearer token'
+ *   }),
+ *   examples: {
+ *     valid: new OasExample({
+ *       summary: 'Valid bearer token',
+ *       value: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Pagination headers
+ * ```typescript
+ * const totalCountHeader = new OasHeader({
+ *   description: 'Total number of items available',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 0,
+ *     description: 'Non-negative integer count'
+ *   }),
+ *   examples: {
+ *     empty: new OasExample({ value: 0, description: 'No items' }),
+ *     normal: new OasExample({ value: 150, description: 'Normal case' }),
+ *     large: new OasExample({ value: 10000, description: 'Large dataset' })
+ *   }
+ * });
+ *
+ * const linkHeader = new OasHeader({
+ *   description: 'Pagination links (RFC 5988)',
+ *   required: false,
+ *   schema: new OasString({
+ *     description: 'Comma-separated list of link relations'
+ *   }),
+ *   examples: {
+ *     withNext: new OasExample({
+ *       value: '</api/users?page=2>; rel="next", </api/users?page=10>; rel="last"'
+ *     }),
+ *     lastPage: new OasExample({
+ *       value: '</api/users?page=9>; rel="prev", </api/users?page=1>; rel="first"'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Content type and encoding headers
+ * ```typescript
+ * const contentTypeHeader = new OasHeader({
+ *   description: 'MIME type of the response content',
+ *   required: true,
+ *   schema: new OasString({
+ *     enum: [
+ *       'application/json',
+ *       'application/xml',
+ *       'text/csv',
+ *       'application/pdf',
+ *       'application/octet-stream'
+ *     ]
+ *   }),
+ *   examples: {
+ *     json: new OasExample({ value: 'application/json' }),
+ *     xml: new OasExample({ value: 'application/xml' }),
+ *     csv: new OasExample({ value: 'text/csv' })
+ *   }
+ * });
+ *
+ * const contentLengthHeader = new OasHeader({
+ *   description: 'Size of the response body in bytes',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 0,
+ *     description: 'Content size in bytes'
+ *   })
+ * });
+ * ```
+ *
+ * @example Rate limiting headers
+ * ```typescript
+ * const rateLimitHeader = new OasHeader({
+ *   description: 'Number of requests remaining in the current window',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 0,
+ *     description: 'Remaining request count'
+ *   }),
+ *   examples: {
+ *     available: new OasExample({ value: 95, description: '95 requests remaining' }),
+ *     depleted: new OasExample({ value: 0, description: 'Rate limit reached' })
+ *   }
+ * });
+ *
+ * const rateLimitResetHeader = new OasHeader({
+ *   description: 'Unix timestamp when the rate limit window resets',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 0,
+ *     description: 'Unix timestamp in seconds'
+ *   }),
+ *   examples: {
+ *     reset: new OasExample({
+ *       value: 1634567890,
+ *       description: 'Reset at 2021-10-18 12:31:30 UTC'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Custom application headers
+ * ```typescript
+ * const requestIdHeader = new OasHeader({
+ *   description: 'Unique identifier for request tracing',
+ *   required: false,
+ *   schema: new OasString({
+ *     format: 'uuid',
+ *     description: 'UUID v4 request identifier'
+ *   }),
+ *   examples: {
+ *     uuid: new OasExample({
+ *       value: '123e4567-e89b-12d3-a456-426614174000',
+ *       description: 'Request tracking ID'
+ *     })
+ *   }
+ * });
+ *
+ * const serverTimingHeader = new OasHeader({
+ *   description: 'Server-side performance metrics',
+ *   required: false,
+ *   schema: new OasString({
+ *     description: 'Server-Timing header format (RFC 8760)'
+ *   }),
+ *   examples: {
+ *     timing: new OasExample({
+ *       value: 'db;dur=53, app;dur=47.2',
+ *       description: 'Database took 53ms, app logic 47.2ms'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Deprecated header
+ * ```typescript
+ * const deprecatedHeader = new OasHeader({
+ *   description: 'Legacy API version header (deprecated)',
+ *   required: false,
+ *   deprecated: true,
+ *   schema: new OasString({
+ *     enum: ['v1', 'v2'],
+ *     description: 'Use Accept or Content-Type header instead'
+ *   }),
+ *   examples: {
+ *     legacy: new OasExample({
+ *       value: 'v1',
+ *       description: 'Legacy version (use Accept header instead)'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Using in response definitions
+ * ```typescript
+ * const successResponse = new OasResponse({
+ *   description: 'Paginated user list',
+ *   headers: {
+ *     'X-Total-Count': totalCountHeader,
+ *     'Link': linkHeader,
+ *     'X-Rate-Limit-Remaining': rateLimitHeader,
+ *     'X-Rate-Limit-Reset': rateLimitResetHeader,
+ *     'X-Request-ID': requestIdHeader
+ *   },
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasArray({
+ *         items: new OasRef({ $ref: '#/components/schemas/User' })
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ */
 export declare class OasHeader {
     #private;
     oasType: 'header';

package/script/oas/header/Header.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Header.d.ts","sourceRoot":"","sources":["../../../src/oas/header/Header.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,MAAM,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,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,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IACjD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,2CAA2C;AAC3C,qBAAa,SAAS;;IACpB,OAAO,EAAE,QAAQ,CAAW;gBAGhB,MAAM,EAAE,YAAY;IAIhC,kCAAkC;IAClC,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,iEAAiE;IACjE,IAAI,QAAQ,IAAI,OAAO,GAAG,SAAS,CAElC;IAED,6FAA6F;IAC7F,IAAI,UAAU,IAAI,OAAO,GAAG,SAAS,CAEpC;IAED,4BAA4B;IAC5B,IAAI,MAAM,IAAI,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAErD;IAED,6BAA6B;IAC7B,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAEzE;IAED,4BAA4B;IAC5B,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAEtD;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;IAED,4CAA4C;IAC5C,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,qBAAqB;IACrB,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;IAIxB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAc9E,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,YAAY;CASnE"}
+{"version":3,"file":"Header.d.ts","sourceRoot":"","sources":["../../../src/oas/header/Header.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AACvD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,wCAAwC;IACxC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,qCAAqC;IACrC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B,uCAAuC;IACvC,UAAU,EAAE,OAAO,GAAG,SAAS,CAAA;IAC/B,6CAA6C;IAC7C,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAA;IAChD,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAAA;IACpE,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAAA;IACjD,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8MG;AACH,qBAAa,SAAS;;IACpB,OAAO,EAAE,QAAQ,CAAW;gBAGhB,MAAM,EAAE,YAAY;IAIhC,kCAAkC;IAClC,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,iEAAiE;IACjE,IAAI,QAAQ,IAAI,OAAO,GAAG,SAAS,CAElC;IAED,6FAA6F;IAC7F,IAAI,UAAU,IAAI,OAAO,GAAG,SAAS,CAEpC;IAED,4BAA4B;IAC5B,IAAI,MAAM,IAAI,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,SAAS,CAErD;IAED,6BAA6B;IAC7B,IAAI,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAEzE;IAED,4BAA4B;IAC5B,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,SAAS,CAEtD;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;IAED,4CAA4C;IAC5C,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,qBAAqB;IACrB,OAAO,IAAI,SAAS;IAIpB,WAAW,IAAI,SAAS;IAIxB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,GAAE,MAA2B,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAc9E,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,YAAY;CASnE"}

package/script/oas/header/Header.js

@@ -13,7 +13,213 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _OasHeader_fields;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasHeader = void 0;
-/** Describes a single header in the API */
+/**
+ * Represents a Header Object in the OpenAPI Specification.
+ *
+ * The `OasHeader` class encapsulates the definition of a single HTTP header that
+ * can be sent with responses or expected in requests. Headers provide additional
+ * metadata about the HTTP message and can include authentication tokens, content
+ * information, pagination data, rate limiting details, and more.
+ *
+ * This class provides comprehensive support for header definitions with typed
+ * values, validation schemas, examples, and documentation.
+ *
+ * ## Key Features
+ *
+ * - **Schema Validation**: Typed header values through schema definitions
+ * - **Examples**: Multiple example values for documentation and testing
+ * - **Content Types**: Support for complex header values with media types
+ * - **Deprecation Support**: Mark headers as deprecated with proper warnings
+ * - **Required/Optional**: Control whether headers are mandatory
+ * - **Documentation**: Rich description support for API documentation
+ *
+ * @example Basic authentication header
+ * ```typescript
+ * import { OasHeader, OasString } from '@skmtc/core';
+ *
+ * const authHeader = new OasHeader({
+ *   description: 'Bearer token for API authentication',
+ *   required: true,
+ *   schema: new OasString({
+ *     pattern: '^Bearer [A-Za-z0-9+/=]+$',
+ *     description: 'JWT bearer token'
+ *   }),
+ *   examples: {
+ *     valid: new OasExample({
+ *       summary: 'Valid bearer token',
+ *       value: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Pagination headers
+ * ```typescript
+ * const totalCountHeader = new OasHeader({
+ *   description: 'Total number of items available',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 0,
+ *     description: 'Non-negative integer count'
+ *   }),
+ *   examples: {
+ *     empty: new OasExample({ value: 0, description: 'No items' }),
+ *     normal: new OasExample({ value: 150, description: 'Normal case' }),
+ *     large: new OasExample({ value: 10000, description: 'Large dataset' })
+ *   }
+ * });
+ *
+ * const linkHeader = new OasHeader({
+ *   description: 'Pagination links (RFC 5988)',
+ *   required: false,
+ *   schema: new OasString({
+ *     description: 'Comma-separated list of link relations'
+ *   }),
+ *   examples: {
+ *     withNext: new OasExample({
+ *       value: '</api/users?page=2>; rel="next", </api/users?page=10>; rel="last"'
+ *     }),
+ *     lastPage: new OasExample({
+ *       value: '</api/users?page=9>; rel="prev", </api/users?page=1>; rel="first"'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Content type and encoding headers
+ * ```typescript
+ * const contentTypeHeader = new OasHeader({
+ *   description: 'MIME type of the response content',
+ *   required: true,
+ *   schema: new OasString({
+ *     enum: [
+ *       'application/json',
+ *       'application/xml',
+ *       'text/csv',
+ *       'application/pdf',
+ *       'application/octet-stream'
+ *     ]
+ *   }),
+ *   examples: {
+ *     json: new OasExample({ value: 'application/json' }),
+ *     xml: new OasExample({ value: 'application/xml' }),
+ *     csv: new OasExample({ value: 'text/csv' })
+ *   }
+ * });
+ *
+ * const contentLengthHeader = new OasHeader({
+ *   description: 'Size of the response body in bytes',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 0,
+ *     description: 'Content size in bytes'
+ *   })
+ * });
+ * ```
+ *
+ * @example Rate limiting headers
+ * ```typescript
+ * const rateLimitHeader = new OasHeader({
+ *   description: 'Number of requests remaining in the current window',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 0,
+ *     description: 'Remaining request count'
+ *   }),
+ *   examples: {
+ *     available: new OasExample({ value: 95, description: '95 requests remaining' }),
+ *     depleted: new OasExample({ value: 0, description: 'Rate limit reached' })
+ *   }
+ * });
+ *
+ * const rateLimitResetHeader = new OasHeader({
+ *   description: 'Unix timestamp when the rate limit window resets',
+ *   required: false,
+ *   schema: new OasInteger({
+ *     minimum: 0,
+ *     description: 'Unix timestamp in seconds'
+ *   }),
+ *   examples: {
+ *     reset: new OasExample({
+ *       value: 1634567890,
+ *       description: 'Reset at 2021-10-18 12:31:30 UTC'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Custom application headers
+ * ```typescript
+ * const requestIdHeader = new OasHeader({
+ *   description: 'Unique identifier for request tracing',
+ *   required: false,
+ *   schema: new OasString({
+ *     format: 'uuid',
+ *     description: 'UUID v4 request identifier'
+ *   }),
+ *   examples: {
+ *     uuid: new OasExample({
+ *       value: '123e4567-e89b-12d3-a456-426614174000',
+ *       description: 'Request tracking ID'
+ *     })
+ *   }
+ * });
+ *
+ * const serverTimingHeader = new OasHeader({
+ *   description: 'Server-side performance metrics',
+ *   required: false,
+ *   schema: new OasString({
+ *     description: 'Server-Timing header format (RFC 8760)'
+ *   }),
+ *   examples: {
+ *     timing: new OasExample({
+ *       value: 'db;dur=53, app;dur=47.2',
+ *       description: 'Database took 53ms, app logic 47.2ms'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Deprecated header
+ * ```typescript
+ * const deprecatedHeader = new OasHeader({
+ *   description: 'Legacy API version header (deprecated)',
+ *   required: false,
+ *   deprecated: true,
+ *   schema: new OasString({
+ *     enum: ['v1', 'v2'],
+ *     description: 'Use Accept or Content-Type header instead'
+ *   }),
+ *   examples: {
+ *     legacy: new OasExample({
+ *       value: 'v1',
+ *       description: 'Legacy version (use Accept header instead)'
+ *     })
+ *   }
+ * });
+ * ```
+ *
+ * @example Using in response definitions
+ * ```typescript
+ * const successResponse = new OasResponse({
+ *   description: 'Paginated user list',
+ *   headers: {
+ *     'X-Total-Count': totalCountHeader,
+ *     'Link': linkHeader,
+ *     'X-Rate-Limit-Remaining': rateLimitHeader,
+ *     'X-Rate-Limit-Reset': rateLimitResetHeader,
+ *     'X-Request-ID': requestIdHeader
+ *   },
+ *   content: {
+ *     'application/json': new OasMediaType({
+ *       schema: new OasArray({
+ *         items: new OasRef({ $ref: '#/components/schemas/User' })
+ *       })
+ *     })
+ *   }
+ * });
+ * ```
+ */
 class OasHeader {
     constructor(fields) {
         Object.defineProperty(this, "oasType", {

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

@@ -1,15 +1,87 @@
 import "../../_dnt.polyfills.js";
 import type { OasContact } from '../contact/Contact.js';
 import type { OasLicense } from '../license/License.js';
+/**
+ * Constructor fields for {@link OasInfo}.
+ */
 export type InfoFields = {
+    /** The title of the API */
     title: string;
+    /** The version of the OpenAPI document */
     version: string;
+    /** A description of the API */
     description?: string | undefined;
+    /** A URL to the Terms of Service for the API */
     termsOfService?: string | undefined;
+    /** The contact information for the exposed API */
     contact?: OasContact | undefined;
+    /** The license information for the exposed API */
     license?: OasLicense | undefined;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
+/**
+ * Represents an Info Object in the OpenAPI Specification.
+ *
+ * The `OasInfo` class encapsulates metadata about the API including its title,
+ * version, description, and contact information. This information is displayed
+ * in API documentation and helps developers understand what the API does and
+ * how to use it effectively.
+ *
+ * This class provides essential API metadata that appears at the top level
+ * of OpenAPI documents and drives documentation generation and tooling.
+ *
+ * ## Key Features
+ *
+ * - **API Identification**: Title and version information for API tracking
+ * - **Documentation**: Rich description support for API overview
+ * - **Contact Information**: Developer contact details and support resources
+ * - **Legal Information**: License and terms of service references
+ * - **Extension Support**: Custom fields for additional metadata
+ *
+ * @example Basic API information
+ * ```typescript
+ * import { OasInfo } from '@skmtc/core';
+ *
+ * const apiInfo = new OasInfo({
+ *   title: 'Pet Store API',
+ *   version: '1.0.0',
+ *   description: 'A sample API that uses a petstore as an example'
+ * });
+ * ```
+ *
+ * @example Complete API metadata
+ * ```typescript
+ * const fullApiInfo = new OasInfo({
+ *   title: 'E-Commerce Platform API',
+ *   version: '2.1.0',
+ *   description: 'Comprehensive e-commerce API for managing products, orders, and customers',
+ *   termsOfService: 'https://api.example.com/terms',
+ *   contact: new OasContact({
+ *     name: 'API Support Team',
+ *     url: 'https://api.example.com/support',
+ *     email: 'api-support@example.com'
+ *   }),
+ *   license: new OasLicense({
+ *     name: 'MIT',
+ *     url: 'https://opensource.org/licenses/MIT'
+ *   })
+ * });
+ * ```
+ *
+ * @example Versioned API with semantic versioning
+ * ```typescript
+ * const versionedInfo = new OasInfo({
+ *   title: 'User Management Service',
+ *   version: '3.2.1',
+ *   description: 'RESTful API for user authentication and profile management',
+ *   contact: new OasContact({
+ *     name: 'Development Team',
+ *     email: 'dev@company.com'
+ *   })
+ * });
+ * ```
+ */
 export declare class OasInfo {
     #private;
     oasType: 'info';

package/script/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,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAChC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,OAAO,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IAChC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,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,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"}

package/script/oas/info/Info.js

@@ -14,6 +14,68 @@ var _OasInfo_fields;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasInfo = void 0;
 require("../../_dnt.polyfills.js");
+/**
+ * Represents an Info Object in the OpenAPI Specification.
+ *
+ * The `OasInfo` class encapsulates metadata about the API including its title,
+ * version, description, and contact information. This information is displayed
+ * in API documentation and helps developers understand what the API does and
+ * how to use it effectively.
+ *
+ * This class provides essential API metadata that appears at the top level
+ * of OpenAPI documents and drives documentation generation and tooling.
+ *
+ * ## Key Features
+ *
+ * - **API Identification**: Title and version information for API tracking
+ * - **Documentation**: Rich description support for API overview
+ * - **Contact Information**: Developer contact details and support resources
+ * - **Legal Information**: License and terms of service references
+ * - **Extension Support**: Custom fields for additional metadata
+ *
+ * @example Basic API information
+ * ```typescript
+ * import { OasInfo } from '@skmtc/core';
+ *
+ * const apiInfo = new OasInfo({
+ *   title: 'Pet Store API',
+ *   version: '1.0.0',
+ *   description: 'A sample API that uses a petstore as an example'
+ * });
+ * ```
+ *
+ * @example Complete API metadata
+ * ```typescript
+ * const fullApiInfo = new OasInfo({
+ *   title: 'E-Commerce Platform API',
+ *   version: '2.1.0',
+ *   description: 'Comprehensive e-commerce API for managing products, orders, and customers',
+ *   termsOfService: 'https://api.example.com/terms',
+ *   contact: new OasContact({
+ *     name: 'API Support Team',
+ *     url: 'https://api.example.com/support',
+ *     email: 'api-support@example.com'
+ *   }),
+ *   license: new OasLicense({
+ *     name: 'MIT',
+ *     url: 'https://opensource.org/licenses/MIT'
+ *   })
+ * });
+ * ```
+ *
+ * @example Versioned API with semantic versioning
+ * ```typescript
+ * const versionedInfo = new OasInfo({
+ *   title: 'User Management Service',
+ *   version: '3.2.1',
+ *   description: 'RESTful API for user authentication and profile management',
+ *   contact: new OasContact({
+ *     name: 'Development Team',
+ *     email: 'dev@company.com'
+ *   })
+ * });
+ * ```
+ */
 class OasInfo {
     constructor(fields) {
         Object.defineProperty(this, "oasType", {