@skmtc/core 0.0.788 → 0.0.790

package/esm/oas/boolean/Boolean.d.ts

@@ -2,17 +2,158 @@ import "../../_dnt.polyfills.js";
 import type { OpenAPIV3 } from 'openapi-types';
 import type { OasRef } from '../ref/Ref.js';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
+/**
+ * Constructor fields for {@link OasBoolean}.
+ *
+ * @template Nullable - Whether the boolean can be null (affects type unions)
+ */
 export type BooleanFields<Nullable extends boolean | undefined> = {
+    /** A short summary of the boolean schema */
     title?: string;
+    /** A description of the boolean schema */
     description?: string;
+    /** Whether the boolean value can be null */
     nullable?: Nullable;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
+    /** Example value for the boolean (null allowed if Nullable is true) */
     example?: Nullable extends true ? boolean | null | undefined : boolean | undefined;
+    /** Array of valid enum values for the boolean (null allowed if Nullable is true) */
     enums?: Nullable extends true ? (boolean | null)[] | undefined : boolean[] | undefined;
+    /** Default value for the boolean (null allowed if Nullable is true) */
     default?: Nullable extends true ? boolean | null | undefined : boolean | undefined;
 };
 /**
- * Object representing a boolean in the OpenAPI Specification.
+ * Represents a boolean schema in the OpenAPI Specification.
+ *
+ * The `OasBoolean` class handles boolean data types in OpenAPI schemas, supporting
+ * both simple true/false values and more complex boolean schemas with constraints,
+ * enumerations, and nullable types. This class provides type-safe boolean handling
+ * with optional null value support through generic typing.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Generic nullable type support with proper TypeScript inference
+ * - **Enum Support**: Constrain boolean values to specific true/false combinations
+ * - **Null Handling**: Optional null value support for nullable boolean types
+ * - **Validation**: Default values and example validation
+ * - **JSON Schema**: Converts to standard JSON Schema format for validation
+ * - **Documentation**: Rich metadata support for API documentation
+ *
+ * @template Nullable - Whether the boolean value itself can be null
+ *
+ * @example Basic boolean schema
+ * ```typescript
+ * import { OasBoolean } from '@skmtc/core';
+ *
+ * const isActiveSchema = new OasBoolean({
+ *   title: 'Active Status',
+ *   description: 'Whether the user account is active',
+ *   default: true,
+ *   example: true
+ * });
+ *
+ * // This represents: boolean with default true
+ * ```
+ *
+ * @example Nullable boolean schema
+ * ```typescript
+ * const nullableFlag = new OasBoolean<true>({
+ *   title: 'Optional Flag',
+ *   description: 'An optional boolean flag that can be null',
+ *   nullable: true,
+ *   default: null,
+ *   example: true
+ * });
+ *
+ * // This represents: boolean | null
+ * ```
+ *
+ * @example Boolean with enum constraints
+ * ```typescript
+ * const strictBoolean = new OasBoolean({
+ *   title: 'Confirmation',
+ *   description: 'Must explicitly be true to confirm action',
+ *   enums: [true], // Only true is allowed
+ *   example: true
+ * });
+ *
+ * // This only accepts true, effectively making it required
+ * ```
+ *
+ * @example Boolean with null in enum
+ * ```typescript
+ * const triStateBoolean = new OasBoolean<true>({
+ *   title: 'Approval Status',
+ *   description: 'Approval can be true (approved), false (denied), or null (pending)',
+ *   nullable: true,
+ *   enums: [true, false, null],
+ *   default: null,
+ *   example: null
+ * });
+ *
+ * // This represents: true | false | null (tri-state logic)
+ * ```
+ *
+ * @example Feature flag schema
+ * ```typescript
+ * const featureFlag = new OasBoolean({
+ *   title: 'Feature Enabled',
+ *   description: 'Whether the new feature is enabled for this user',
+ *   default: false,
+ *   example: false
+ * });
+ *
+ * // Used in configuration objects
+ * const userConfig = new OasObject({
+ *   properties: {
+ *     darkMode: featureFlag,
+ *     notifications: featureFlag,
+ *     betaFeatures: featureFlag
+ *   }
+ * });
+ * ```
+ *
+ * @example Consent and agreement booleans
+ * ```typescript
+ * const consentSchema = new OasBoolean({
+ *   title: 'Terms Accepted',
+ *   description: 'User has accepted the terms and conditions',
+ *   enums: [true], // Must be true to be valid
+ *   example: true
+ * });
+ *
+ * const privacyConsent = new OasBoolean({
+ *   title: 'Privacy Policy Accepted',
+ *   description: 'User has accepted the privacy policy',
+ *   default: false,
+ *   example: true
+ * });
+ *
+ * // Used in registration forms where consent is required
+ * ```
+ *
+ * @example Optional settings with nullable booleans
+ * ```typescript
+ * const userPreferences = new OasObject({
+ *   properties: {
+ *     emailNotifications: new OasBoolean<true>({
+ *       title: 'Email Notifications',
+ *       description: 'Enable email notifications (null means use default)',
+ *       nullable: true,
+ *       default: null
+ *     }),
+ *     smsNotifications: new OasBoolean<true>({
+ *       title: 'SMS Notifications',
+ *       description: 'Enable SMS notifications (null means not set)',
+ *       nullable: true,
+ *       default: null
+ *     })
+ *   }
+ * });
+ *
+ * // Allows: { emailNotifications: true, smsNotifications: null }
+ * ```
  */
 export declare class OasBoolean<Nullable extends boolean | undefined = boolean | undefined> {
     /**

package/esm/oas/boolean/Boolean.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Boolean.d.ts","sourceRoot":"","sources":["../../../src/oas/boolean/Boolean.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAC9D,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAA;IAClF,KAAK,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACtF,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAA;CACnF,CAAA;AAED;;GAEG;AACH,qBAAa,UAAU,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAChF;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,SAAS,CAAS;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAE9B,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAA;IAEjF;;OAEG;IACH,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACrF;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAA;gBAErE,MAAM,GAAE,aAAa,CAAC,QAAQ,CAAM;IAUhD,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC;IAI/B,WAAW,IAAI,UAAU,CAAC,QAAQ,CAAC;IAKnC,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAW5E"}
+{"version":3,"file":"Boolean.d.ts","sourceRoot":"","sources":["../../../src/oas/boolean/Boolean.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AAE9D;;;;GAIG;AACH,MAAM,MAAM,aAAa,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,IAAI;IAChE,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,0CAA0C;IAC1C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACzC,uEAAuE;IACvE,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAA;IAClF,oFAAoF;IACpF,KAAK,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACtF,uEAAuE;IACvE,OAAO,CAAC,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAA;CACnF,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmIG;AACH,qBAAa,UAAU,CAAC,QAAQ,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS;IAChF;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,SAAS,CAAS;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAA;IAE9B,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAA;IAEjF;;OAEG;IACH,KAAK,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,GAAG,SAAS,CAAA;IACrF;;OAEG;IACH,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,CAAA;gBAErE,MAAM,GAAE,aAAa,CAAC,QAAQ,CAAM;IAUhD,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,UAAU,CAAC,QAAQ,CAAC;IAI/B,WAAW,IAAI,UAAU,CAAC,QAAQ,CAAC;IAKnC,YAAY,CAAC,OAAO,CAAC,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAW5E"}

package/esm/oas/boolean/Boolean.js

@@ -1,6 +1,135 @@
 import "../../_dnt.polyfills.js";
 /**
- * Object representing a boolean in the OpenAPI Specification.
+ * Represents a boolean schema in the OpenAPI Specification.
+ *
+ * The `OasBoolean` class handles boolean data types in OpenAPI schemas, supporting
+ * both simple true/false values and more complex boolean schemas with constraints,
+ * enumerations, and nullable types. This class provides type-safe boolean handling
+ * with optional null value support through generic typing.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Generic nullable type support with proper TypeScript inference
+ * - **Enum Support**: Constrain boolean values to specific true/false combinations
+ * - **Null Handling**: Optional null value support for nullable boolean types
+ * - **Validation**: Default values and example validation
+ * - **JSON Schema**: Converts to standard JSON Schema format for validation
+ * - **Documentation**: Rich metadata support for API documentation
+ *
+ * @template Nullable - Whether the boolean value itself can be null
+ *
+ * @example Basic boolean schema
+ * ```typescript
+ * import { OasBoolean } from '@skmtc/core';
+ *
+ * const isActiveSchema = new OasBoolean({
+ *   title: 'Active Status',
+ *   description: 'Whether the user account is active',
+ *   default: true,
+ *   example: true
+ * });
+ *
+ * // This represents: boolean with default true
+ * ```
+ *
+ * @example Nullable boolean schema
+ * ```typescript
+ * const nullableFlag = new OasBoolean<true>({
+ *   title: 'Optional Flag',
+ *   description: 'An optional boolean flag that can be null',
+ *   nullable: true,
+ *   default: null,
+ *   example: true
+ * });
+ *
+ * // This represents: boolean | null
+ * ```
+ *
+ * @example Boolean with enum constraints
+ * ```typescript
+ * const strictBoolean = new OasBoolean({
+ *   title: 'Confirmation',
+ *   description: 'Must explicitly be true to confirm action',
+ *   enums: [true], // Only true is allowed
+ *   example: true
+ * });
+ *
+ * // This only accepts true, effectively making it required
+ * ```
+ *
+ * @example Boolean with null in enum
+ * ```typescript
+ * const triStateBoolean = new OasBoolean<true>({
+ *   title: 'Approval Status',
+ *   description: 'Approval can be true (approved), false (denied), or null (pending)',
+ *   nullable: true,
+ *   enums: [true, false, null],
+ *   default: null,
+ *   example: null
+ * });
+ *
+ * // This represents: true | false | null (tri-state logic)
+ * ```
+ *
+ * @example Feature flag schema
+ * ```typescript
+ * const featureFlag = new OasBoolean({
+ *   title: 'Feature Enabled',
+ *   description: 'Whether the new feature is enabled for this user',
+ *   default: false,
+ *   example: false
+ * });
+ *
+ * // Used in configuration objects
+ * const userConfig = new OasObject({
+ *   properties: {
+ *     darkMode: featureFlag,
+ *     notifications: featureFlag,
+ *     betaFeatures: featureFlag
+ *   }
+ * });
+ * ```
+ *
+ * @example Consent and agreement booleans
+ * ```typescript
+ * const consentSchema = new OasBoolean({
+ *   title: 'Terms Accepted',
+ *   description: 'User has accepted the terms and conditions',
+ *   enums: [true], // Must be true to be valid
+ *   example: true
+ * });
+ *
+ * const privacyConsent = new OasBoolean({
+ *   title: 'Privacy Policy Accepted',
+ *   description: 'User has accepted the privacy policy',
+ *   default: false,
+ *   example: true
+ * });
+ *
+ * // Used in registration forms where consent is required
+ * ```
+ *
+ * @example Optional settings with nullable booleans
+ * ```typescript
+ * const userPreferences = new OasObject({
+ *   properties: {
+ *     emailNotifications: new OasBoolean<true>({
+ *       title: 'Email Notifications',
+ *       description: 'Enable email notifications (null means use default)',
+ *       nullable: true,
+ *       default: null
+ *     }),
+ *     smsNotifications: new OasBoolean<true>({
+ *       title: 'SMS Notifications',
+ *       description: 'Enable SMS notifications (null means not set)',
+ *       nullable: true,
+ *       default: null
+ *     })
+ *   }
+ * });
+ *
+ * // Allows: { emailNotifications: true, smsNotifications: null }
+ * ```
  */
 export class OasBoolean {
     constructor(fields = {}) {

package/esm/oas/components/Components.d.ts

@@ -9,29 +9,279 @@ import type { OasRef } from '../ref/Ref.js';
 import type { OasSchema } from '../schema/Schema.js';
 import type { RefName } from '../../types/RefName.js';
 import type { OasSecurityScheme } from '../securitySchemes/SecurityScheme.js';
+/**
+ * Available component types in an OpenAPI document.
+ */
 export declare const componentsKeys: string[];
+/**
+ * Constructor fields for {@link OasComponents}.
+ */
 export type ComponentsFields = {
+    /** Reusable schema components */
     schemas?: Record<RefName, OasSchema | OasRef<'schema'>>;
+    /** Reusable response components */
     responses?: Record<RefName, OasResponse | OasRef<'response'>>;
+    /** Reusable parameter components */
     parameters?: Record<RefName, OasParameter | OasRef<'parameter'>>;
+    /** Reusable example components */
     examples?: Record<RefName, OasExample | OasRef<'example'>>;
+    /** Reusable request body components */
     requestBodies?: Record<RefName, OasRequestBody | OasRef<'requestBody'>>;
+    /** Reusable header components */
     headers?: Record<RefName, OasHeader | OasRef<'header'>>;
+    /** Reusable security scheme components */
     securitySchemes?: Record<string, OasSecurityScheme | OasRef<'securityScheme'>>;
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
-/** Container object for re-usable schema items within the API
+/**
+ * Represents the OpenAPI Components Object in the SKMTC OAS processing system.
+ *
+ * The `OasComponents` class manages the reusable components section of an OpenAPI
+ * document, providing centralized access to shared schemas, responses, parameters,
+ * and other reusable elements that can be referenced throughout the API specification.
+ *
+ * This class serves as the central registry for all reusable components, enabling
+ * efficient reference resolution and reducing duplication in OpenAPI documents.
+ *
+ * ## Key Features
+ *
+ * - **Schema Management**: Central repository for reusable data schemas
+ * - **Response Reuse**: Common response definitions for consistent API responses
+ * - **Parameter Standardization**: Shared parameter definitions across operations
+ * - **Reference Resolution**: Support for internal references ($ref) to components
+ * - **Type Safety**: Strongly typed access to different component categories
+ * - **Extension Support**: Custom OpenAPI extension field handling
+ *
+ * @example Basic component access
+ * ```typescript
+ * import { OasComponents } from '@skmtc/core';
+ *
+ * // Typically created during document parsing
+ * const components = new OasComponents({
+ *   schemas: {
+ *     User: new OasObject({
+ *       properties: {
+ *         id: new OasString(),
+ *         name: new OasString()
+ *       }
+ *     }),
+ *     Product: new OasObject({
+ *       properties: {
+ *         id: new OasString(),
+ *         price: new OasNumber()
+ *       }
+ *     })
+ *   },
+ *   responses: {
+ *     NotFound: new OasResponse({
+ *       description: '404 - Resource not found'
+ *     })
+ *   }
+ * });
+ *
+ * // Access schemas
+ * const userSchema = components.schemas?.['User'];
+ * const productSchema = components.schemas?.['Product'];
+ *
+ * // Access responses
+ * const notFoundResponse = components.responses?.['NotFound'];
+ * ```
+ *
+ * @example Schema management
+ * ```typescript
+ * // Get all schema reference names
+ * const schemaNames = components.toSchemasRefNames();
+ * console.log(schemaNames); // ['User', 'Product', 'Order']
+ *
+ * // Remove a schema (useful for processing)
+ * const removedSchema = components.removeSchema('ObsoleteSchema');
+ * console.log('Removed:', removedSchema);
+ *
+ * // Check remaining schemas
+ * const remainingSchemas = components.toSchemasRefNames();
+ * console.log('Remaining:', remainingSchemas);
+ * ```
+ *
+ * @example Parameter reuse
+ * ```typescript
+ * const components = new OasComponents({
+ *   parameters: {
+ *     PageSize: new OasParameter({
+ *       name: 'pageSize',
+ *       in: 'query',
+ *       schema: new OasInteger({ minimum: 1, maximum: 100, default: 20 })
+ *     }),
+ *     PageNumber: new OasParameter({
+ *       name: 'page',
+ *       in: 'query',
+ *       schema: new OasInteger({ minimum: 1, default: 1 })
+ *     })
+ *   }
+ * });
+ *
+ * // These parameters can be referenced in operations:
+ * // $ref: '#/components/parameters/PageSize'
+ * // $ref: '#/components/parameters/PageNumber'
+ * ```
+ *
+ * @example Response standardization
+ * ```typescript
+ * const components = new OasComponents({
+ *   responses: {
+ *     Success: new OasResponse({
+ *       description: 'Successful operation',
+ *       content: {
+ *         'application/json': {
+ *           schema: new OasObject({
+ *             properties: {
+ *               success: new OasBoolean({ default: true }),
+ *               data: new OasObject({ additionalProperties: true })
+ *             }
+ *           })
+ *         }
+ *       }
+ *     }),
+ *     ValidationError: new OasResponse({
+ *       description: 'Validation failed',
+ *       content: {
+ *         'application/json': {
+ *           schema: new OasObject({
+ *             properties: {
+ *               error: new OasString(),
+ *               details: new OasArray({
+ *                 items: new OasString()
+ *               })
+ *             }
+ *           })
+ *         }
+ *       }
+ *     })
+ *   }
+ * });
+ *
+ * // Standardized responses across all operations
+ * ```
+ *
+ * @example Processing components in generators
+ * ```typescript
+ * class ComponentProcessor {
+ *   processDocument(document: OasDocument) {
+ *     const components = document.components;
+ *     if (!components) return;
+ *
+ *     // Process all schemas
+ *     if (components.schemas) {
+ *       Object.entries(components.schemas).forEach(([name, schema]) => {
+ *         if (schema.isRef()) {
+ *           console.log(`Schema ${name} is a reference to ${schema.$ref}`);
+ *         } else {
+ *           console.log(`Schema ${name} is a direct definition`);
+ *         }
+ *       });
+ *     }
  *
- * Fields not yet implemented: **securitySchemes**, **links**, **callbacks**
+ *     // Process parameters
+ *     if (components.parameters) {
+ *       Object.keys(components.parameters).forEach(paramName => {
+ *         console.log(`Reusable parameter: ${paramName}`);
+ *       });
+ *     }
+ *   }
+ * }
+ * ```
  */
 export declare class OasComponents {
     #private;
     /** Static identifier property for OasComponents */
     oasType: "components";
+    /**
+     * Creates a new OasComponents instance.
+     *
+     * @param fields - Component definitions (defaults to empty object)
+     *
+     * @example
+     * ```typescript
+     * const components = new OasComponents({
+     *   schemas: {
+     *     User: userSchema,
+     *     Product: productSchema
+     *   },
+     *   responses: {
+     *     NotFound: notFoundResponse
+     *   }
+     * });
+     * ```
+     */
     constructor(fields?: ComponentsFields);
+    /**
+     * Gets all schema reference names.
+     *
+     * This method extracts the keys from the schemas object and returns them
+     * as an array of RefName types. Useful for iterating over all available
+     * schemas or checking schema availability.
+     *
+     * @returns Array of reference names for all schemas
+     *
+     * @example
+     * ```typescript
+     * const components = new OasComponents({
+     *   schemas: {
+     *     User: userSchema,
+     *     Product: productSchema,
+     *     Order: orderSchema
+     *   }
+     * });
+     *
+     * const schemaNames = components.toSchemasRefNames();
+     * console.log(schemaNames); // ['User', 'Product', 'Order']
+     *
+     * // Use for processing
+     * schemaNames.forEach(name => {
+     *   const schema = components.schemas?.[name];
+     *   console.log(`Processing schema: ${name}`);
+     * });
+     * ```
+     */
     toSchemasRefNames(): RefName[];
     /** Record holding re-usable {@link OasSchema} objects or Refs  */
     get schemas(): Record<RefName, OasSchema | OasRef<'schema'>> | undefined;
+    /**
+     * Removes a schema from the components and returns it.
+     *
+     * This method permanently removes a schema from the components object
+     * and returns the removed schema. This is useful during processing when
+     * you need to extract and handle specific schemas separately.
+     *
+     * @param refName - The reference name of the schema to remove
+     * @returns The removed schema object or reference
+     *
+     * @throws {Error} When the schema doesn't exist or schemas object is undefined
+     *
+     * @example
+     * ```typescript
+     * const components = new OasComponents({
+     *   schemas: {
+     *     User: userSchema,
+     *     Product: productSchema,
+     *     Internal: internalSchema
+     *   }
+     * });
+     *
+     * // Remove internal schema that shouldn't be exposed
+     * const internalSchema = components.removeSchema('Internal');
+     * console.log('Removed internal schema');
+     *
+     * // Check remaining schemas
+     * const remainingSchemas = components.toSchemasRefNames();
+     * console.log(remainingSchemas); // ['User', 'Product']
+     *
+     * // Process removed schema separately
+     * if (!internalSchema.isRef()) {
+     *   console.log('Processing internal schema privately');
+     * }
+     * ```
+     */
     removeSchema(refName: RefName): OasSchema | OasRef<'schema'>;
     /** Record holding re-usable {@link OasResponse} objects or Refs  */
     get responses(): Record<RefName, OasResponse | OasRef<'response'>> | undefined;

package/esm/oas/components/Components.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Components.d.ts","sourceRoot":"","sources":["../../../src/oas/components/Components.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,yBAAyB,CAAC;AACjC,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,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAE7E,eAAO,MAAM,cAAc,UAQ1B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;IACvD,SAAS,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC7D,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAA;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;IAC1D,aAAa,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,CAAA;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;IACvD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAA;IAC9E,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;GAGG;AACH,qBAAa,aAAa;;IACxB,mDAAmD;IACnD,OAAO,EAAG,YAAY,CAAS;gBAInB,MAAM,GAAE,gBAAqB;IAIzC,iBAAiB,IAAI,OAAO,EAAE;IAI9B,kEAAkE;IAClE,IAAI,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAEvE;IAED,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAQ5D,oEAAoE;IACpE,IAAI,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,SAAS,CAE7E;IAED,qEAAqE;IACrE,IAAI,UAAU,IAAI,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,SAAS,CAEhF;IAED,mEAAmE;IACnE,IAAI,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAE1E;IAED,uEAAuE;IACvE,IAAI,aAAa,IAAI,MAAM,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,SAAS,CAEvF;IAED,kEAAkE;IAClE,IAAI,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAEvE;IAED,0EAA0E;IAC1E,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC,GAAG,SAAS,CAE9F;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;CACF"}
+{"version":3,"file":"Components.d.ts","sourceRoot":"","sources":["../../../src/oas/components/Components.ts"],"names":[],"mappings":"AAAA,OAAO,yBAAyB,CAAC;AACjC,OAAO,yBAAyB,CAAC;AACjC,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,MAAM,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAA;AAE7E;;GAEG;AACH,eAAO,MAAM,cAAc,UAQ1B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;IACvD,mCAAmC;IACnC,SAAS,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;IAC7D,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,CAAA;IAChE,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;IAC1D,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,CAAA;IACvE,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;IACvD,0CAA0C;IAC1C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAA;IAC9E,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4JG;AACH,qBAAa,aAAa;;IACxB,mDAAmD;IACnD,OAAO,EAAG,YAAY,CAAS;IAI/B;;;;;;;;;;;;;;;;;OAiBG;gBACS,MAAM,GAAE,gBAAqB;IAIzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,iBAAiB,IAAI,OAAO,EAAE;IAI9B,kEAAkE;IAClE,IAAI,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAEvE;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAQ5D,oEAAoE;IACpE,IAAI,SAAS,IAAI,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,SAAS,CAE7E;IAED,qEAAqE;IACrE,IAAI,UAAU,IAAI,MAAM,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,SAAS,CAEhF;IAED,mEAAmE;IACnE,IAAI,QAAQ,IAAI,MAAM,CAAC,OAAO,EAAE,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAG,SAAS,CAE1E;IAED,uEAAuE;IACvE,IAAI,aAAa,IAAI,MAAM,CAAC,OAAO,EAAE,cAAc,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,SAAS,CAEvF;IAED,kEAAkE;IAClE,IAAI,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,CAEvE;IAED,0EAA0E;IAC1E,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC,GAAG,SAAS,CAE9F;IAED,qCAAqC;IACrC,IAAI,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEzD;CACF"}