@skmtc/core 0.0.788 → 0.0.789

package/script/oas/components/Components.js

@@ -15,6 +15,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasComponents = exports.componentsKeys = void 0;
 require("../../_dnt.polyfills.js");
 require("../../_dnt.polyfills.js");
+/**
+ * Available component types in an OpenAPI document.
+ */
 exports.componentsKeys = [
     'schemas',
     'responses',
@@ -24,11 +27,182 @@ exports.componentsKeys = [
     'headers',
     'securitySchemes'
 ];
-/** 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}`);
+ *       });
+ *     }
+ *   }
+ * }
+ * ```
  */
 class OasComponents {
+    /**
+     * 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 = {}) {
         /** Static identifier property for OasComponents */
         Object.defineProperty(this, "oasType", {
@@ -41,6 +215,35 @@ class OasComponents {
         _OasComponents_fields.set(this, void 0);
         __classPrivateFieldSet(this, _OasComponents_fields, fields, "f");
     }
+    /**
+     * 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() {
         return Object.keys(__classPrivateFieldGet(this, _OasComponents_fields, "f").schemas ?? {});
     }
@@ -48,6 +251,42 @@ class OasComponents {
     get schemas() {
         return __classPrivateFieldGet(this, _OasComponents_fields, "f").schemas;
     }
+    /**
+     * 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) {
         const { [refName]: removed, ...rest } = __classPrivateFieldGet(this, _OasComponents_fields, "f").schemas;
         __classPrivateFieldGet(this, _OasComponents_fields, "f").schemas = rest;

package/script/oas/union/Union.d.ts

@@ -3,24 +3,138 @@ import type { OasSchema } from '../schema/Schema.js';
 import type { OasRef } from '../ref/Ref.js';
 import type { ToJsonSchemaOptions } from '../schema/Schema.js';
 import type { OpenAPIV3 } from 'openapi-types';
+/**
+ * Constructor fields for {@link OasUnion}.
+ */
 export type UnionFields = {
+    /** A short summary of the union type */
     title?: string;
+    /** A description of the union type */
     description?: string;
+    /** Whether the union value can be null */
     nullable?: boolean;
+    /** Discriminator object for creating tagged unions */
     discriminator?: OasDiscriminator;
+    /** Example value for the union */
     example?: unknown;
+    /** Default value for the union */
     default?: unknown;
+    /** Array of schemas that make up the union members */
     members: (OasSchema | OasRef<'schema'>)[];
+    /** Custom extension fields (x-* properties) */
     extensionFields?: Record<string, unknown>;
 };
 /**
- * Object representing a 'oneOf' or 'anyOf' in the OpenAPI Specification.
+ * Represents a union type schema in the OpenAPI Specification.
+ *
+ * `OasUnion` handles both OpenAPI `oneOf` and `anyOf` constructs by mapping them
+ * to TypeScript union types. While OpenAPI distinguishes between these concepts,
+ * in TypeScript they both represent union types (A | B | C), making the distinction
+ * less meaningful for code generation.
+ *
+ * This class supports both simple unions and discriminated (tagged) unions through
+ * the discriminator property, which enables more precise type narrowing in generated code.
+ *
+ * ## Key Features
+ *
+ * - **Union Types**: Represents multiple possible schema types as a single union
+ * - **Tagged Unions**: Supports discriminator properties for type narrowing
+ * - **Reference Resolution**: Handles references to other schemas within union members
+ * - **Nullable Support**: Can represent nullable union types (A | B | null)
+ * - **JSON Schema**: Converts to standard JSON Schema format for validation
+ *
+ * @example Basic union type
+ * ```typescript
+ * import { OasUnion, OasString, OasInteger } from '@skmtc/core';
+ *
+ * const stringOrNumber = new OasUnion({
+ *   title: 'StringOrNumber',
+ *   description: 'A value that can be either a string or number',
+ *   members: [
+ *     new OasString({ title: 'String Value' }),
+ *     new OasInteger({ title: 'Integer Value' })
+ *   ]
+ * });
+ *
+ * // This represents: string | number
+ * ```
+ *
+ * @example Discriminated union (tagged union)
+ * ```typescript
+ * const shape = new OasUnion({
+ *   title: 'Shape',
+ *   description: 'Different types of geometric shapes',
+ *   discriminator: new OasDiscriminator({
+ *     propertyName: 'type',
+ *     mapping: {
+ *       'circle': '#/components/schemas/Circle',
+ *       'square': '#/components/schemas/Square'
+ *     }
+ *   }),
+ *   members: [
+ *     new OasRef({ $ref: '#/components/schemas/Circle' }),
+ *     new OasRef({ $ref: '#/components/schemas/Square' })
+ *   ]
+ * });
+ *
+ * // This creates a tagged union that can be narrowed by the 'type' property
+ * ```
+ *
+ * @example Nullable union
+ * ```typescript
+ * const nullableStatus = new OasUnion({
+ *   title: 'NullableStatus',
+ *   nullable: true,
+ *   members: [
+ *     new OasString({ enum: ['active', 'inactive'] }),
+ *     new OasString({ enum: ['pending', 'suspended'] })
+ *   ],
+ *   default: null
+ * });
+ *
+ * // This represents: ('active' | 'inactive' | 'pending' | 'suspended') | null
+ * ```
+ *
+ * @example Complex nested union
+ * ```typescript
+ * const apiResponse = new OasUnion({
+ *   title: 'ApiResponse',
+ *   description: 'Response from API endpoint',
+ *   members: [
+ *     new OasObject({
+ *       title: 'SuccessResponse',
+ *       properties: {
+ *         success: new OasBoolean({ default: true }),
+ *         data: new OasObject({ additionalProperties: true })
+ *       }
+ *     }),
+ *     new OasObject({
+ *       title: 'ErrorResponse',
+ *       properties: {
+ *         error: new OasString(),
+ *         code: new OasInteger()
+ *       }
+ *     })
+ *   ]
+ * });
+ *
+ * // This represents: { success: boolean; data: Record<string, any> } | { error: string; code: number }
+ * ```
  *
- * In the context of TypeScript 'anyOf' is not helpful since it implies
- * a union that consists of all possible combinations of member types.
+ * @example Using with references
+ * ```typescript
+ * const userOrAdmin = new OasUnion({
+ *   title: 'UserOrAdmin',
+ *   description: 'Either a regular user or an admin user',
+ *   members: [
+ *     new OasRef({ $ref: '#/components/schemas/User' }),
+ *     new OasRef({ $ref: '#/components/schemas/Admin' })
+ *   ]
+ * });
  *
- * Generating such combination types would not be useful and we map both
- * 'oneOf' and 'anyOf' to a TypeScript union type.
+ * // References will be resolved during processing
+ * // This represents: User | Admin
+ * ```
  */
 export declare class OasUnion {
     /**

package/script/oas/union/Union.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Union.d.ts","sourceRoot":"","sources":["../../../src/oas/union/Union.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,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,WAAW,GAAG;IACxB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,aAAa,CAAC,EAAE,gBAAgB,CAAA;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,OAAO,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAA;IACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;GAQG;AACH,qBAAa,QAAQ;IACnB;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,OAAO,CAAS;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B;;OAEG;IACH,aAAa,EAAE,gBAAgB,GAAG,SAAS,CAAA;IAC3C;;OAEG;IACH,OAAO,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAA;IAEzC,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;gBAEL,MAAM,EAAE,WAAW;IAW/B,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,QAAQ;IAInB,WAAW,IAAI,QAAQ;IAIvB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAU3E"}
+{"version":3,"file":"Union.d.ts","sourceRoot":"","sources":["../../../src/oas/union/Union.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACzE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,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,WAAW,GAAG;IACxB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,sDAAsD;IACtD,aAAa,CAAC,EAAE,gBAAgB,CAAA;IAChC,kCAAkC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,kCAAkC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,sDAAsD;IACtD,OAAO,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAA;IACzC,+CAA+C;IAC/C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+GG;AACH,qBAAa,QAAQ;IACnB;;;OAGG;IACH,OAAO,EAAG,QAAQ,CAAS;IAC3B;;OAEG;IACH,IAAI,EAAG,OAAO,CAAS;IACvB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,SAAS,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B;;OAEG;IACH,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAA;IAC7B;;OAEG;IACH,aAAa,EAAE,gBAAgB,GAAG,SAAS,CAAA;IAC3C;;OAEG;IACH,OAAO,EAAE,CAAC,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAA;IAEzC,qCAAqC;IACrC,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;gBAEL,MAAM,EAAE,WAAW;IAW/B,KAAK,IAAI,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC;IAIjC,OAAO,IAAI,QAAQ;IAInB,WAAW,IAAI,QAAQ;IAIvB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,SAAS,CAAC,oBAAoB;CAU3E"}

package/script/oas/union/Union.js

@@ -2,13 +2,116 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OasUnion = void 0;
 /**
- * Object representing a 'oneOf' or 'anyOf' in the OpenAPI Specification.
+ * Represents a union type schema in the OpenAPI Specification.
  *
- * In the context of TypeScript 'anyOf' is not helpful since it implies
- * a union that consists of all possible combinations of member types.
+ * `OasUnion` handles both OpenAPI `oneOf` and `anyOf` constructs by mapping them
+ * to TypeScript union types. While OpenAPI distinguishes between these concepts,
+ * in TypeScript they both represent union types (A | B | C), making the distinction
+ * less meaningful for code generation.
  *
- * Generating such combination types would not be useful and we map both
- * 'oneOf' and 'anyOf' to a TypeScript union type.
+ * This class supports both simple unions and discriminated (tagged) unions through
+ * the discriminator property, which enables more precise type narrowing in generated code.
+ *
+ * ## Key Features
+ *
+ * - **Union Types**: Represents multiple possible schema types as a single union
+ * - **Tagged Unions**: Supports discriminator properties for type narrowing
+ * - **Reference Resolution**: Handles references to other schemas within union members
+ * - **Nullable Support**: Can represent nullable union types (A | B | null)
+ * - **JSON Schema**: Converts to standard JSON Schema format for validation
+ *
+ * @example Basic union type
+ * ```typescript
+ * import { OasUnion, OasString, OasInteger } from '@skmtc/core';
+ *
+ * const stringOrNumber = new OasUnion({
+ *   title: 'StringOrNumber',
+ *   description: 'A value that can be either a string or number',
+ *   members: [
+ *     new OasString({ title: 'String Value' }),
+ *     new OasInteger({ title: 'Integer Value' })
+ *   ]
+ * });
+ *
+ * // This represents: string | number
+ * ```
+ *
+ * @example Discriminated union (tagged union)
+ * ```typescript
+ * const shape = new OasUnion({
+ *   title: 'Shape',
+ *   description: 'Different types of geometric shapes',
+ *   discriminator: new OasDiscriminator({
+ *     propertyName: 'type',
+ *     mapping: {
+ *       'circle': '#/components/schemas/Circle',
+ *       'square': '#/components/schemas/Square'
+ *     }
+ *   }),
+ *   members: [
+ *     new OasRef({ $ref: '#/components/schemas/Circle' }),
+ *     new OasRef({ $ref: '#/components/schemas/Square' })
+ *   ]
+ * });
+ *
+ * // This creates a tagged union that can be narrowed by the 'type' property
+ * ```
+ *
+ * @example Nullable union
+ * ```typescript
+ * const nullableStatus = new OasUnion({
+ *   title: 'NullableStatus',
+ *   nullable: true,
+ *   members: [
+ *     new OasString({ enum: ['active', 'inactive'] }),
+ *     new OasString({ enum: ['pending', 'suspended'] })
+ *   ],
+ *   default: null
+ * });
+ *
+ * // This represents: ('active' | 'inactive' | 'pending' | 'suspended') | null
+ * ```
+ *
+ * @example Complex nested union
+ * ```typescript
+ * const apiResponse = new OasUnion({
+ *   title: 'ApiResponse',
+ *   description: 'Response from API endpoint',
+ *   members: [
+ *     new OasObject({
+ *       title: 'SuccessResponse',
+ *       properties: {
+ *         success: new OasBoolean({ default: true }),
+ *         data: new OasObject({ additionalProperties: true })
+ *       }
+ *     }),
+ *     new OasObject({
+ *       title: 'ErrorResponse',
+ *       properties: {
+ *         error: new OasString(),
+ *         code: new OasInteger()
+ *       }
+ *     })
+ *   ]
+ * });
+ *
+ * // This represents: { success: boolean; data: Record<string, any> } | { error: string; code: number }
+ * ```
+ *
+ * @example Using with references
+ * ```typescript
+ * const userOrAdmin = new OasUnion({
+ *   title: 'UserOrAdmin',
+ *   description: 'Either a regular user or an admin user',
+ *   members: [
+ *     new OasRef({ $ref: '#/components/schemas/User' }),
+ *     new OasRef({ $ref: '#/components/schemas/Admin' })
+ *   ]
+ * });
+ *
+ * // References will be resolved during processing
+ * // This represents: User | Admin
+ * ```
  */
 class OasUnion {
     constructor(fields) {