@skmtc/core 0.0.788 → 0.0.790

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) {