@skmtc/core 0.0.788 → 0.0.790

package/esm/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/esm/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/esm/oas/union/Union.js

@@ -1,11 +1,114 @@
 /**
- * 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
+ * ```
  */
 export class OasUnion {
     constructor(fields) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skmtc/core",
-  "version": "0.0.788",
+  "version": "0.0.790",
   "repository": {
     "type": "git",
     "url": "https://github.com/skmtc/skmtc.git"

package/script/context/ParseContext.d.ts

@@ -5,62 +5,240 @@ import type * as log from '../deps/jsr.io/@std/log/0.224.14/mod.js';
 import type { StackTrail } from './StackTrail.js';
 import * as v from 'valibot';
 import type { IssueType } from './types.js';
+/**
+ * Constructor arguments for {@link ParseContext}.
+ */
 type ConstructorArgs = {
+    /** The OpenAPI v3 document to parse */
     documentObject: OpenAPIV3.Document;
+    /** Logger instance for debug information */
     logger: log.Logger;
+    /** Stack trail for distributed tracing */
     stackTrail: StackTrail;
+    /** Whether to suppress console output */
     silent: boolean;
 };
+/**
+ * Return type for the parse operation.
+ */
 export type ParseReturn = {
+    /** The parsed OAS document */
     oasDocument: OasDocument;
+    /** Array of parsing issues encountered */
     issues: ParseIssue[];
 };
+/**
+ * Base type for parse warning messages.
+ */
 type ParseWarningBase = {
+    /** Issue severity level */
     level: 'warning';
+    /** Warning message */
     message: string;
 };
+/**
+ * Base type for parse error messages.
+ */
 type ParseErrorBase = {
+    /** Issue severity level */
     level: 'error';
+    /** The error that occurred */
     error: Error;
 };
+/**
+ * Base union type for parse issues.
+ */
 type ParseIssueBase = ParseErrorBase | ParseWarningBase;
+/**
+ * Arguments for logging issues with a specific key.
+ */
 export type LogIssueArgs = ParseIssueBase & {
+    /** The key where the issue occurred */
     key: string;
+    /** The parent object containing the issue */
     parent: unknown;
+    /** The type of issue for categorization */
     type: IssueType;
 };
+/**
+ * Arguments for logging issues without a specific key.
+ */
 export type LogIssueNoKeyArgs = ParseIssueBase & {
+    /** The parent object containing the issue */
     parent: unknown;
+    /** The type of issue for categorization */
     type: IssueType;
 };
+/**
+ * Arguments for provisional parsing with validation.
+ */
 export type ProvisionalParseArgs<T> = {
+    /** The key being parsed */
     key: string;
+    /** The value to validate */
     value: unknown;
+    /** The parent object context */
     parent: unknown;
+    /** Valibot schema for validation */
     schema: v.GenericSchema<T>;
+    /** Function to generate error messages */
     toMessage: (value: unknown) => string;
+    /** The type of issue for categorization */
     type: IssueType;
 };
+/**
+ * Arguments for logging skipped values during parsing.
+ */
 export type LogSkippedValuesArgs = {
+    /** Record of skipped key-value pairs */
     skipped: Record<string, unknown>;
+    /** The parent object context */
     parent: unknown;
+    /** String description of the parent type */
     parentType: string;
 };
+/**
+ * Represents a parsing error with location context.
+ */
 export type ParseError = {
+    /** Error severity level */
     level: 'error';
+    /** The error that occurred */
     error: Error;
+    /** Location string where the error occurred */
     location: string;
+    /** The parent object context */
     parent: unknown;
+    /** The type of issue for categorization */
     type: IssueType;
 };
+/**
+ * Represents a parsing warning with location context.
+ */
 export type ParseWarning = {
+    /** Warning severity level */
     level: 'warning';
+    /** Warning message */
     message: string;
+    /** Location string where the warning occurred */
     location: string;
+    /** The parent object context */
     parent: unknown;
+    /** The type of issue for categorization */
     type: IssueType;
 };
+/**
+ * Union type for all parsing issues.
+ */
 export type ParseIssue = ParseError | ParseWarning;
+/**
+ * The parsing context for the first phase of the SKMTC transformation pipeline.
+ *
+ * `ParseContext` is responsible for converting OpenAPI v3 JSON documents into
+ * the internal OAS (OpenAPI Schema) object representation used by SKMTC. It
+ * provides comprehensive error handling, validation, and issue tracking during
+ * the parsing process.
+ *
+ * This context handles the complex task of transforming external OpenAPI
+ * specifications into type-safe internal representations while maintaining
+ * detailed information about any parsing issues or inconsistencies found.
+ *
+ * ## Key Features
+ *
+ * - **JSON to OAS Conversion**: Transforms OpenAPI JSON into typed OAS objects
+ * - **Validation & Error Handling**: Comprehensive validation with detailed error reporting
+ * - **Issue Tracking**: Collects warnings and errors with precise location information
+ * - **Reference Management**: Handles complex reference resolution and tracking
+ * - **Logging Integration**: Provides detailed logging and tracing capabilities
+ * - **Silent Mode**: Can suppress console output while maintaining error collection
+ *
+ * @example Basic parsing usage
+ * ```typescript
+ * import { ParseContext } from '@skmtc/core';
+ *
+ * const parseContext = new ParseContext({
+ *   documentObject: openApiJsonDocument,
+ *   logger: myLogger,
+ *   stackTrail: traceStack,
+ *   silent: false
+ * });
+ *
+ * const oasDocument = parseContext.parse();
+ *
+ * // Check for parsing issues
+ * if (parseContext.issues.length > 0) {
+ *   console.log('Parsing issues found:');
+ *   parseContext.issues.forEach(issue => {
+ *     console.log(`${issue.level}: ${issue.location} - ${issue.message || issue.error?.message}`);
+ *   });
+ * }
+ *
+ * // Use the parsed document
+ * console.log('Parsed schemas:', Object.keys(oasDocument.components?.schemas || {}));
+ * ```
+ *
+ * @example Error handling during parsing
+ * ```typescript
+ * const parseContext = new ParseContext({
+ *   documentObject: malformedOpenApiDoc,
+ *   logger: logger,
+ *   stackTrail: stack,
+ *   silent: true
+ * });
+ *
+ * try {
+ *   const parsed = parseContext.parse();
+ *
+ *   // Separate errors from warnings
+ *   const errors = parseContext.issues.filter(issue => issue.level === 'error');
+ *   const warnings = parseContext.issues.filter(issue => issue.level === 'warning');
+ *
+ *   if (errors.length > 0) {
+ *     console.error(`${errors.length} parsing errors found`);
+ *     errors.forEach(error => {
+ *       console.error(`Error at ${error.location}: ${error.error.message}`);
+ *     });
+ *   }
+ *
+ *   if (warnings.length > 0) {
+ *     console.warn(`${warnings.length} parsing warnings found`);
+ *     warnings.forEach(warning => {
+ *       console.warn(`Warning at ${warning.location}: ${warning.message}`);
+ *     });
+ *   }
+ * } catch (error) {
+ *   console.error('Critical parsing failure:', error);
+ * }
+ * ```
+ *
+ * @example Integration with CoreContext
+ * ```typescript
+ * // Typically used within CoreContext.parse()
+ * class CustomCoreContext extends CoreContext {
+ *   parseWithCustomValidation(document: OpenAPIV3.Document) {
+ *     const parseContext = new ParseContext({
+ *       documentObject: document,
+ *       logger: this.logger,
+ *       stackTrail: this.stackTrail,
+ *       silent: this.silent
+ *     });
+ *
+ *     const parsed = parseContext.parse();
+ *
+ *     // Custom post-processing based on issues
+ *     const criticalErrors = parseContext.issues.filter(issue =>
+ *       issue.level === 'error' && issue.type === 'schema-validation'
+ *     );
+ *
+ *     if (criticalErrors.length > 0) {
+ *       throw new Error(`Schema validation failed: ${criticalErrors.length} critical errors`);
+ *     }
+ *
+ *     return parsed;
+ *   }
+ * }
+ * ```
+ */
 export declare class ParseContext {
     #private;
     documentObject: OpenAPIV3.Document;

package/script/context/ParseContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ParseContext.d.ts","sourceRoot":"","sources":["../../src/context/ParseContext.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAG9C,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,KAAK,KAAK,GAAG,MAAM,yCAAyC,CAAA;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAE3C,KAAK,eAAe,GAAG;IACrB,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAA;IAClC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,WAAW,EAAE,WAAW,CAAA;IACxB,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB,CAAA;AAED,KAAK,gBAAgB,GAAG;IACtB,KAAK,EAAE,SAAS,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,cAAc,GAAG;IACpB,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED,KAAK,cAAc,GAAG,cAAc,GAAG,gBAAgB,CAAA;AAEvD,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG;IAC1C,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG;IAC/C,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI;IACpC,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IAC1B,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAA;IACrC,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,KAAK,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,SAAS,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,YAAY,CAAA;AAElD,qBAAa,YAAY;;IACvB,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAA;IAClC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,WAAW,EAAE,WAAW,CAAA;IACxB,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,MAAM,EAAE,OAAO,CAAA;gBAGH,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAa,EAAE,EAAE,eAAe;IAWlF,KAAK,IAAI,WAAW;IAWpB,kBAAkB;IAoBlB,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM;IAMhD,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS;IAQvD,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;IAIlD,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,oBAAoB;IAYtE,gBAAgB,CAAC,CAAC,EAAE,EAClB,GAAG,EACH,KAAK,EACL,MAAM,EACN,MAAM,EACN,SAAS,EACT,IAAI,EACL,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS;IAgB1C,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,YAAY;IAItD,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,iBAAiB;CAqB5D;AAED,eAAO,MAAM,WAAW,GAAI,QAAQ,MAAM,KAAG,SAAS,CAAC,QAMtD,CAAA"}
+{"version":3,"file":"ParseContext.d.ts","sourceRoot":"","sources":["../../src/context/ParseContext.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAG9C,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,KAAK,KAAK,GAAG,MAAM,yCAAyC,CAAA;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAE3C;;GAEG;AACH,KAAK,eAAe,GAAG;IACrB,uCAAuC;IACvC,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAA;IAClC,4CAA4C;IAC5C,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,0CAA0C;IAC1C,UAAU,EAAE,UAAU,CAAA;IACtB,yCAAyC;IACzC,MAAM,EAAE,OAAO,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,8BAA8B;IAC9B,WAAW,EAAE,WAAW,CAAA;IACxB,0CAA0C;IAC1C,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB,CAAA;AAED;;GAEG;AACH,KAAK,gBAAgB,GAAG;IACtB,2BAA2B;IAC3B,KAAK,EAAE,SAAS,CAAA;IAChB,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,KAAK,cAAc,GAAG;IACpB,2BAA2B;IAC3B,KAAK,EAAE,OAAO,CAAA;IACd,8BAA8B;IAC9B,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED;;GAEG;AACH,KAAK,cAAc,GAAG,cAAc,GAAG,gBAAgB,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,cAAc,GAAG;IAC1C,uCAAuC;IACvC,GAAG,EAAE,MAAM,CAAA;IACX,6CAA6C;IAC7C,MAAM,EAAE,OAAO,CAAA;IACf,2CAA2C;IAC3C,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,cAAc,GAAG;IAC/C,6CAA6C;IAC7C,MAAM,EAAE,OAAO,CAAA;IACf,2CAA2C;IAC3C,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI;IACpC,2BAA2B;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,4BAA4B;IAC5B,KAAK,EAAE,OAAO,CAAA;IACd,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAA;IACf,oCAAoC;IACpC,MAAM,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IAC1B,0CAA0C;IAC1C,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAA;IACrC,2CAA2C;IAC3C,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAA;IACf,4CAA4C;IAC5C,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,2BAA2B;IAC3B,KAAK,EAAE,OAAO,CAAA;IACd,8BAA8B;IAC9B,KAAK,EAAE,KAAK,CAAA;IACZ,+CAA+C;IAC/C,QAAQ,EAAE,MAAM,CAAA;IAChB,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAA;IACf,2CAA2C;IAC3C,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,6BAA6B;IAC7B,KAAK,EAAE,SAAS,CAAA;IAChB,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAA;IAChB,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAA;IACf,2CAA2C;IAC3C,IAAI,EAAE,SAAS,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,YAAY,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2GG;AACH,qBAAa,YAAY;;IACvB,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAA;IAClC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,WAAW,EAAE,WAAW,CAAA;IACxB,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,MAAM,EAAE,OAAO,CAAA;gBAGH,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAa,EAAE,EAAE,eAAe;IAWlF,KAAK,IAAI,WAAW;IAWpB,kBAAkB;IAoBlB,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM;IAMhD,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS;IAQvD,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;IAIlD,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,oBAAoB;IAYtE,gBAAgB,CAAC,CAAC,EAAE,EAClB,GAAG,EACH,KAAK,EACL,MAAM,EACN,MAAM,EACN,SAAS,EACT,IAAI,EACL,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS;IAgB1C,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,YAAY;IAItD,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,iBAAiB;CAqB5D;AAED,eAAO,MAAM,WAAW,GAAI,QAAQ,MAAM,KAAG,SAAS,CAAC,QAMtD,CAAA"}

package/script/context/ParseContext.js

@@ -52,6 +52,114 @@ const toDocumentFieldsV3_js_1 = require("../oas/document/toDocumentFieldsV3.js")
 const Document_js_1 = require("../oas/document/Document.js");
 const tracer_js_1 = require("../helpers/tracer.js");
 const v = __importStar(require("valibot"));
+/**
+ * The parsing context for the first phase of the SKMTC transformation pipeline.
+ *
+ * `ParseContext` is responsible for converting OpenAPI v3 JSON documents into
+ * the internal OAS (OpenAPI Schema) object representation used by SKMTC. It
+ * provides comprehensive error handling, validation, and issue tracking during
+ * the parsing process.
+ *
+ * This context handles the complex task of transforming external OpenAPI
+ * specifications into type-safe internal representations while maintaining
+ * detailed information about any parsing issues or inconsistencies found.
+ *
+ * ## Key Features
+ *
+ * - **JSON to OAS Conversion**: Transforms OpenAPI JSON into typed OAS objects
+ * - **Validation & Error Handling**: Comprehensive validation with detailed error reporting
+ * - **Issue Tracking**: Collects warnings and errors with precise location information
+ * - **Reference Management**: Handles complex reference resolution and tracking
+ * - **Logging Integration**: Provides detailed logging and tracing capabilities
+ * - **Silent Mode**: Can suppress console output while maintaining error collection
+ *
+ * @example Basic parsing usage
+ * ```typescript
+ * import { ParseContext } from '@skmtc/core';
+ *
+ * const parseContext = new ParseContext({
+ *   documentObject: openApiJsonDocument,
+ *   logger: myLogger,
+ *   stackTrail: traceStack,
+ *   silent: false
+ * });
+ *
+ * const oasDocument = parseContext.parse();
+ *
+ * // Check for parsing issues
+ * if (parseContext.issues.length > 0) {
+ *   console.log('Parsing issues found:');
+ *   parseContext.issues.forEach(issue => {
+ *     console.log(`${issue.level}: ${issue.location} - ${issue.message || issue.error?.message}`);
+ *   });
+ * }
+ *
+ * // Use the parsed document
+ * console.log('Parsed schemas:', Object.keys(oasDocument.components?.schemas || {}));
+ * ```
+ *
+ * @example Error handling during parsing
+ * ```typescript
+ * const parseContext = new ParseContext({
+ *   documentObject: malformedOpenApiDoc,
+ *   logger: logger,
+ *   stackTrail: stack,
+ *   silent: true
+ * });
+ *
+ * try {
+ *   const parsed = parseContext.parse();
+ *
+ *   // Separate errors from warnings
+ *   const errors = parseContext.issues.filter(issue => issue.level === 'error');
+ *   const warnings = parseContext.issues.filter(issue => issue.level === 'warning');
+ *
+ *   if (errors.length > 0) {
+ *     console.error(`${errors.length} parsing errors found`);
+ *     errors.forEach(error => {
+ *       console.error(`Error at ${error.location}: ${error.error.message}`);
+ *     });
+ *   }
+ *
+ *   if (warnings.length > 0) {
+ *     console.warn(`${warnings.length} parsing warnings found`);
+ *     warnings.forEach(warning => {
+ *       console.warn(`Warning at ${warning.location}: ${warning.message}`);
+ *     });
+ *   }
+ * } catch (error) {
+ *   console.error('Critical parsing failure:', error);
+ * }
+ * ```
+ *
+ * @example Integration with CoreContext
+ * ```typescript
+ * // Typically used within CoreContext.parse()
+ * class CustomCoreContext extends CoreContext {
+ *   parseWithCustomValidation(document: OpenAPIV3.Document) {
+ *     const parseContext = new ParseContext({
+ *       documentObject: document,
+ *       logger: this.logger,
+ *       stackTrail: this.stackTrail,
+ *       silent: this.silent
+ *     });
+ *
+ *     const parsed = parseContext.parse();
+ *
+ *     // Custom post-processing based on issues
+ *     const criticalErrors = parseContext.issues.filter(issue =>
+ *       issue.level === 'error' && issue.type === 'schema-validation'
+ *     );
+ *
+ *     if (criticalErrors.length > 0) {
+ *       throw new Error(`Schema validation failed: ${criticalErrors.length} critical errors`);
+ *     }
+ *
+ *     return parsed;
+ *   }
+ * }
+ * ```
+ */
 class ParseContext {
     constructor({ documentObject, logger, stackTrail, silent = true }) {
         Object.defineProperty(this, "documentObject", {