@skmtc/core 0.0.790 → 0.0.792

package/script/helpers/naming.d.ts

@@ -1,9 +1,73 @@
 import type { OasOperation } from '../oas/operation/Operation.js';
 import type { Method } from '../types/Method.js';
+/**
+ * Determines the endpoint type based on HTTP method.
+ *
+ * @param operation - The OpenAPI operation to analyze
+ * @returns 'query' for GET operations, 'mutation' for all others
+ *
+ * @example
+ * ```typescript
+ * const getOp = new OasOperation({ method: 'get', path: '/users' });
+ * console.log(toEndpointType(getOp)); // 'query'
+ *
+ * const postOp = new OasOperation({ method: 'post', path: '/users' });
+ * console.log(toEndpointType(postOp)); // 'mutation'
+ * ```
+ */
 export declare const toEndpointType: (operation: OasOperation) => "query" | "mutation";
-/** generates endpoint name in the `camelCase{method}Api{path}` format */
+/**
+ * Generates endpoint name in the `camelCase{method}Api{path}` format.
+ *
+ * @param operation - The OpenAPI operation
+ * @returns Camel-cased endpoint name
+ *
+ * @example
+ * ```typescript
+ * const op = new OasOperation({ method: 'post', path: '/users/{id}/profile' });
+ * console.log(toEndpointName(op)); // 'createApiUsersIdProfile'
+ * ```
+ */
 export declare const toEndpointName: (operation: OasOperation) => string;
+/**
+ * Generates response type name for an operation.
+ *
+ * @param operation - The OpenAPI operation
+ * @returns Response type name with 'Response' suffix
+ *
+ * @example
+ * ```typescript
+ * const op = new OasOperation({ method: 'get', path: '/users' });
+ * console.log(toResponseName(op)); // 'getApiUsersResponse'
+ * ```
+ */
 export declare const toResponseName: (operation: OasOperation) => string;
+/**
+ * Generates arguments type name for an operation.
+ *
+ * @param operation - The OpenAPI operation
+ * @returns Arguments type name with 'Args' suffix
+ *
+ * @example
+ * ```typescript
+ * const op = new OasOperation({ method: 'put', path: '/users/{id}' });
+ * console.log(toArgsName(op)); // 'updateApiUsersIdArgs'
+ * ```
+ */
 export declare const toArgsName: (operation: OasOperation) => string;
+/**
+ * Converts HTTP method to a descriptive verb.
+ *
+ * @param method - HTTP method
+ * @returns Descriptive verb for the method
+ *
+ * @example
+ * ```typescript
+ * console.log(toMethodVerb('post')); // 'Create'
+ * console.log(toMethodVerb('put'));  // 'Update'
+ * console.log(toMethodVerb('get'));  // 'get'
+ * console.log(toMethodVerb('delete')); // 'delete'
+ * ```
+ */
 export declare const toMethodVerb: (method: Method) => string;
 //# sourceMappingURL=naming.d.ts.map

package/script/helpers/naming.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"naming.d.ts","sourceRoot":"","sources":["../../src/helpers/naming.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAGhD,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,KAAG,OAAO,GAAG,UAElE,CAAA;AAED,yEAAyE;AACzE,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,KAAG,MAMxD,CAAA;AAED,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,KAAG,MAIxD,CAAA;AAED,eAAO,MAAM,UAAU,GAAI,WAAW,YAAY,KAAG,MAIpD,CAAA;AAED,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,KAAG,MAK7C,CAAA"}
+{"version":3,"file":"naming.d.ts","sourceRoot":"","sources":["../../src/helpers/naming.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAGhD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,KAAG,OAAO,GAAG,UAElE,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,KAAG,MAMxD,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,KAAG,MAIxD,CAAA;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,GAAI,WAAW,YAAY,KAAG,MAIpD,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,GAAI,QAAQ,MAAM,KAAG,MAK7C,CAAA"}

package/script/helpers/naming.js

@@ -3,27 +3,91 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.toMethodVerb = exports.toArgsName = exports.toResponseName = exports.toEndpointName = exports.toEndpointType = void 0;
 const lodash_es_1 = require("lodash-es");
 const ts_pattern_1 = require("ts-pattern");
+/**
+ * Determines the endpoint type based on HTTP method.
+ *
+ * @param operation - The OpenAPI operation to analyze
+ * @returns 'query' for GET operations, 'mutation' for all others
+ *
+ * @example
+ * ```typescript
+ * const getOp = new OasOperation({ method: 'get', path: '/users' });
+ * console.log(toEndpointType(getOp)); // 'query'
+ *
+ * const postOp = new OasOperation({ method: 'post', path: '/users' });
+ * console.log(toEndpointType(postOp)); // 'mutation'
+ * ```
+ */
 const toEndpointType = (operation) => {
     return operation.method === 'get' ? 'query' : 'mutation';
 };
 exports.toEndpointType = toEndpointType;
-/** generates endpoint name in the `camelCase{method}Api{path}` format */
+/**
+ * Generates endpoint name in the `camelCase{method}Api{path}` format.
+ *
+ * @param operation - The OpenAPI operation
+ * @returns Camel-cased endpoint name
+ *
+ * @example
+ * ```typescript
+ * const op = new OasOperation({ method: 'post', path: '/users/{id}/profile' });
+ * console.log(toEndpointName(op)); // 'createApiUsersIdProfile'
+ * ```
+ */
 const toEndpointName = (operation) => {
     const { path, method } = operation;
     const verb = (0, exports.toMethodVerb)(method);
     return (0, lodash_es_1.camelCase)(`${verb}Api${path}`);
 };
 exports.toEndpointName = toEndpointName;
+/**
+ * Generates response type name for an operation.
+ *
+ * @param operation - The OpenAPI operation
+ * @returns Response type name with 'Response' suffix
+ *
+ * @example
+ * ```typescript
+ * const op = new OasOperation({ method: 'get', path: '/users' });
+ * console.log(toResponseName(op)); // 'getApiUsersResponse'
+ * ```
+ */
 const toResponseName = (operation) => {
     const operationName = (0, exports.toEndpointName)(operation);
     return `${operationName}Response`;
 };
 exports.toResponseName = toResponseName;
+/**
+ * Generates arguments type name for an operation.
+ *
+ * @param operation - The OpenAPI operation
+ * @returns Arguments type name with 'Args' suffix
+ *
+ * @example
+ * ```typescript
+ * const op = new OasOperation({ method: 'put', path: '/users/{id}' });
+ * console.log(toArgsName(op)); // 'updateApiUsersIdArgs'
+ * ```
+ */
 const toArgsName = (operation) => {
     const operationName = (0, exports.toEndpointName)(operation);
     return `${operationName}Args`;
 };
 exports.toArgsName = toArgsName;
+/**
+ * Converts HTTP method to a descriptive verb.
+ *
+ * @param method - HTTP method
+ * @returns Descriptive verb for the method
+ *
+ * @example
+ * ```typescript
+ * console.log(toMethodVerb('post')); // 'Create'
+ * console.log(toMethodVerb('put'));  // 'Update'
+ * console.log(toMethodVerb('get'));  // 'get'
+ * console.log(toMethodVerb('delete')); // 'delete'
+ * ```
+ */
 const toMethodVerb = (method) => {
     return (0, ts_pattern_1.match)(method)
         .with('post', () => 'Create')

package/script/oas/example/Example.d.ts

@@ -1,13 +1,93 @@
 import type { OasRef } from '../ref/Ref.js';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
+/**
+ * Constructor fields for {@link OasExample}.
+ */
 export type ExampleFields = {
+    /** Short summary of the example */
     summary: string | undefined;
+    /** Longer description of the example */
     description: string | undefined;
+    /** The example value */
     value: unknown;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
-/** Provides example data represented by schema */
+/**
+ * Represents an Example Object in the OpenAPI Specification.
+ *
+ * The `OasExample` class provides sample data for parameters, request bodies,
+ * responses, and other components in an OpenAPI document. Examples are crucial
+ * for API documentation, testing, and helping developers understand expected
+ * data formats and structures.
+ *
+ * This class supports rich example definitions with metadata, making API
+ * documentation more informative and interactive for developers.
+ *
+ * ## Key Features
+ *
+ * - **Sample Data**: Concrete examples of API inputs and outputs
+ * - **Documentation**: Summary and description for context
+ * - **Type Flexibility**: Supports any data type as example values
+ * - **Reference Support**: Can be referenced from multiple locations
+ * - **Markdown Support**: Rich text descriptions with CommonMark
+ *
+ * @example Simple string example
+ * ```typescript
+ * import { OasExample } from '@skmtc/core';
+ *
+ * const nameExample = new OasExample({
+ *   summary: 'Typical user name',
+ *   description: 'A common first and last name combination',
+ *   value: 'John Doe'
+ * });
+ * ```
+ *
+ * @example JSON object example
+ * ```typescript
+ * const userExample = new OasExample({
+ *   summary: 'Complete user profile',
+ *   description: 'Example user with all profile fields populated',
+ *   value: {
+ *     id: 12345,
+ *     name: 'Jane Smith',
+ *     email: 'jane.smith@example.com',
+ *     active: true,
+ *     createdAt: '2023-01-15T10:30:00Z'
+ *   }
+ * });
+ * ```
+ *
+ * @example Array example with multiple items
+ * ```typescript
+ * const productsExample = new OasExample({
+ *   summary: 'Product list sample',
+ *   description: 'Typical response for product catalog endpoint',
+ *   value: [
+ *     { id: 1, name: 'Laptop', price: 999.99, category: 'Electronics' },
+ *     { id: 2, name: 'Book', price: 19.99, category: 'Education' },
+ *     { id: 3, name: 'Coffee Mug', price: 12.50, category: 'Home' }
+ *   ]
+ * });
+ * ```
+ *
+ * @example Error response example
+ * ```typescript
+ * const errorExample = new OasExample({
+ *   summary: 'Validation error',
+ *   description: 'Response when request validation fails',
+ *   value: {
+ *     error: 'Validation failed',
+ *     code: 'INVALID_INPUT',
+ *     details: [
+ *       { field: 'email', message: 'Invalid email format' },
+ *       { field: 'age', message: 'Must be between 18 and 120' }
+ *     ]
+ *   }
+ * });
+ * ```
+ */
 export declare class OasExample {
     #private;
     /** Static identifier property for OasExample */

package/script/oas/example/Example.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Example.d.ts","sourceRoot":"","sources":["../../../src/oas/example/Example.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,KAAK,EAAE,OAAO,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED,kDAAkD;AAClD,qBAAa,UAAU;;IACrB,gDAAgD;IAChD,OAAO,EAAE,SAAS,CAAY;gBAIlB,MAAM,EAAE,aAAa;IAIjC,+BAA+B;IAC/B,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAED,2EAA2E;IAC3E,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,6BAA6B;IAC7B,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;IAED,4CAA4C;IAC5C,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC;IAIlC,qBAAqB;IACrB,OAAO,IAAI,UAAU;IAIrB,WAAW,IAAI,UAAU;IAIzB,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,aAAa;CAOrE"}
+{"version":3,"file":"Example.d.ts","sourceRoot":"","sources":["../../../src/oas/example/Example.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAE9C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,mCAAmC;IACnC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,wCAAwC;IACxC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,wBAAwB;IACxB,KAAK,EAAE,OAAO,CAAA;IACd,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyEG;AACH,qBAAa,UAAU;;IACrB,gDAAgD;IAChD,OAAO,EAAE,SAAS,CAAY;gBAIlB,MAAM,EAAE,aAAa;IAIjC,+BAA+B;IAC/B,IAAI,OAAO,IAAI,MAAM,GAAG,SAAS,CAEhC;IAED,2EAA2E;IAC3E,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED,6BAA6B;IAC7B,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;IAED,4CAA4C;IAC5C,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,SAAS,CAAC;IAIlC,qBAAqB;IACrB,OAAO,IAAI,UAAU;IAIrB,WAAW,IAAI,UAAU;IAIzB,YAAY,CAAC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAC,aAAa;CAOrE"}

package/script/oas/example/Example.js

@@ -13,7 +13,80 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _OasExample_fields;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasExample = void 0;
-/** Provides example data represented by schema */
+/**
+ * Represents an Example Object in the OpenAPI Specification.
+ *
+ * The `OasExample` class provides sample data for parameters, request bodies,
+ * responses, and other components in an OpenAPI document. Examples are crucial
+ * for API documentation, testing, and helping developers understand expected
+ * data formats and structures.
+ *
+ * This class supports rich example definitions with metadata, making API
+ * documentation more informative and interactive for developers.
+ *
+ * ## Key Features
+ *
+ * - **Sample Data**: Concrete examples of API inputs and outputs
+ * - **Documentation**: Summary and description for context
+ * - **Type Flexibility**: Supports any data type as example values
+ * - **Reference Support**: Can be referenced from multiple locations
+ * - **Markdown Support**: Rich text descriptions with CommonMark
+ *
+ * @example Simple string example
+ * ```typescript
+ * import { OasExample } from '@skmtc/core';
+ *
+ * const nameExample = new OasExample({
+ *   summary: 'Typical user name',
+ *   description: 'A common first and last name combination',
+ *   value: 'John Doe'
+ * });
+ * ```
+ *
+ * @example JSON object example
+ * ```typescript
+ * const userExample = new OasExample({
+ *   summary: 'Complete user profile',
+ *   description: 'Example user with all profile fields populated',
+ *   value: {
+ *     id: 12345,
+ *     name: 'Jane Smith',
+ *     email: 'jane.smith@example.com',
+ *     active: true,
+ *     createdAt: '2023-01-15T10:30:00Z'
+ *   }
+ * });
+ * ```
+ *
+ * @example Array example with multiple items
+ * ```typescript
+ * const productsExample = new OasExample({
+ *   summary: 'Product list sample',
+ *   description: 'Typical response for product catalog endpoint',
+ *   value: [
+ *     { id: 1, name: 'Laptop', price: 999.99, category: 'Electronics' },
+ *     { id: 2, name: 'Book', price: 19.99, category: 'Education' },
+ *     { id: 3, name: 'Coffee Mug', price: 12.50, category: 'Home' }
+ *   ]
+ * });
+ * ```
+ *
+ * @example Error response example
+ * ```typescript
+ * const errorExample = new OasExample({
+ *   summary: 'Validation error',
+ *   description: 'Response when request validation fails',
+ *   value: {
+ *     error: 'Validation failed',
+ *     code: 'INVALID_INPUT',
+ *     details: [
+ *       { field: 'email', message: 'Invalid email format' },
+ *       { field: 'age', message: 'Must be between 18 and 120' }
+ *     ]
+ *   }
+ * });
+ * ```
+ */
 class OasExample {
     constructor(fields) {
         /** Static identifier property for OasExample */

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"}