@skmtc/core 0.0.788 → 0.0.789

package/esm/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/esm/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/esm/context/ParseContext.js

@@ -16,6 +16,114 @@ import { toDocumentFieldsV3 } from '../oas/document/toDocumentFieldsV3.js';
 import { OasDocument } from '../oas/document/Document.js';
 import { tracer } from '../helpers/tracer.js';
 import * as v from '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;
+ *   }
+ * }
+ * ```
+ */
 export class ParseContext {
     constructor({ documentObject, logger, stackTrail, silent = true }) {
         Object.defineProperty(this, "documentObject", {

package/esm/dsl/Inserted.d.ts

@@ -1,17 +1,257 @@
 import type { GeneratedDefinition, GeneratedValue, GenerationType } from '../types/GeneratedValue.js';
 import type { ContentSettings } from './ContentSettings.js';
 import type { Identifier } from './Identifier.js';
+/**
+ * Constructor arguments for {@link Inserted}.
+ *
+ * @template V - The type of generated value
+ * @template T - The generation type ('force' or 'lazy')
+ * @template EnrichmentType - Optional enrichment data type
+ */
 type ConstructorArgs<V extends GeneratedValue, T extends GenerationType, EnrichmentType> = {
+    /** Content settings including identifier and export path */
     settings: ContentSettings<EnrichmentType>;
+    /** The generated definition with its value */
     definition: GeneratedDefinition<V, T>;
 };
+/**
+ * Represents a successfully inserted generator artifact in the SKMTC DSL system.
+ *
+ * The `Inserted` class is returned when generators are inserted into the generation
+ * context, providing access to the generated content, metadata, and configuration.
+ * It acts as a bridge between the insertion process and the consuming code that
+ * needs to reference or use the generated artifacts.
+ *
+ * This class provides type-safe access to generated values with proper handling
+ * of both forced and lazy generation modes, ensuring the correct optionality
+ * of the generated content based on the generation strategy used.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Generic parameters preserve exact types from generators
+ * - **Generation Modes**: Handles both 'force' and 'lazy' generation strategies
+ * - **Metadata Access**: Provides access to identifiers, export paths, and settings
+ * - **Value Extraction**: Type-safe value extraction with proper optionality
+ * - **Enrichment Support**: Full support for custom enrichment data types
+ *
+ * @template V - The type of generated value (preserves generator output type)
+ * @template T - The generation type ('force' ensures non-null, 'lazy' allows undefined)
+ * @template EnrichmentType - Optional type for custom enrichment data
+ *
+ * @example Basic usage with forced generation
+ * ```typescript
+ * import { Inserted } from '@skmtc/core';
+ *
+ * class MyGenerator extends ModelBase {
+ *   generate(): Definition {
+ *     // Insert a related model with forced generation
+ *     const userModel = this.insertModel(
+ *       new UserModelGenerator({ ... }),
+ *       'User'
+ *     ); // Returns Inserted<UserModelValue, 'force', EnrichmentType>
+ *
+ *     // Access the generated value (guaranteed to be present)
+ *     const userTypeName = userModel.toValue(); // UserModelValue (not undefined)
+ *     const exportPath = userModel.toExportPath(); // './src/models.ts'
+ *     const identifier = userModel.toName(); // 'User'
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createType(this.refName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: `export interface Order { user: ${userTypeName}; }`
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Working with lazy generation
+ * ```typescript
+ * class ConditionalGenerator extends ModelBase {
+ *   generate(): Definition {
+ *     // Insert with lazy generation (may not generate if already exists)
+ *     const optionalModel = this.insertModel(
+ *       new OptionalModelGenerator({ ... }),
+ *       'OptionalModel',
+ *       { generation: 'lazy' }
+ *     ); // Returns Inserted<OptionalValue, 'lazy', EnrichmentType>
+ *
+ *     // Value might be undefined with lazy generation
+ *     const value = optionalModel.toValue(); // OptionalValue | undefined
+ *
+ *     if (value) {
+ *       // Use the generated value
+ *       return this.createDefinitionWith(value);
+ *     } else {
+ *       // Handle case where generation was skipped
+ *       return this.createFallbackDefinition();
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @example Accessing insertion metadata
+ * ```typescript
+ * class MetadataAwareGenerator extends OperationBase {
+ *   generate(): Definition {
+ *     const requestModel = this.insertModel(
+ *       new RequestModelGenerator({ ... }),
+ *       'CreateUserRequest'
+ *     );
+ *
+ *     // Access various metadata
+ *     const modelName = requestModel.toName(); // 'CreateUserRequest'
+ *     const identifier = requestModel.toIdentifier(); // Full Identifier object
+ *     const exportPath = requestModel.toExportPath(); // './src/api/types.ts'
+ *     const enrichments = requestModel.settings.enrichments; // Custom data
+ *
+ *     console.log(`Generated ${modelName} in ${exportPath}`);
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createVariable(this.operation.operationId!),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: `async function createUser(data: ${modelName}) { ... }`
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example With enrichment data
+ * ```typescript
+ * type ValidationEnrichment = {
+ *   validators: string[];
+ *   required: boolean;
+ * };
+ *
+ * class EnrichedGenerator extends ModelBase<ValidationEnrichment> {
+ *   generate(): Definition {
+ *     const validatedModel = this.insertModel(
+ *       new ValidatedModelGenerator({ ... }),
+ *       'ValidatedUser'
+ *     ); // Returns Inserted<ModelValue, 'force', ValidationEnrichment>
+ *
+ *     // Access enrichment data
+ *     const enrichment = validatedModel.settings.enrichments;
+ *     const validators = enrichment?.validators ?? [];
+ *     const isRequired = enrichment?.required ?? false;
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createType(this.refName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: this.generateWithValidation(validatedModel.toValue(), validators)
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ */
 export declare class Inserted<V extends GeneratedValue, T extends GenerationType, EnrichmentType> {
+    /** Content settings including identifier and export path */
     settings: ContentSettings<EnrichmentType>;
+    /** The generated definition with its value */
     definition: GeneratedDefinition<V, T>;
+    /**
+     * Creates a new Inserted instance.
+     *
+     * @param args - Insertion configuration
+     * @param args.settings - Content settings with identifier and export path
+     * @param args.definition - The generated definition containing the value
+     */
     constructor({ settings, definition }: ConstructorArgs<V, T, EnrichmentType>);
+    /**
+     * Gets the name of the inserted artifact.
+     *
+     * This method returns the string name from the identifier, which is commonly
+     * used when referencing the generated artifact in code or templates.
+     *
+     * @returns The name of the inserted artifact
+     *
+     * @example
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User');
+     * const name = userModel.toName(); // 'User'
+     *
+     * // Use in generated code
+     * const code = `interface Order { user: ${name}; }`;
+     * ```
+     */
     toName(): string;
+    /**
+     * Gets the full identifier of the inserted artifact.
+     *
+     * This method returns the complete Identifier object, which includes both
+     * the name and type information. Useful when you need access to entity type
+     * or type annotations.
+     *
+     * @returns The complete Identifier object
+     *
+     * @example
+     * ```typescript
+     * const model = this.insertModel(generator, 'User');
+     * const identifier = model.toIdentifier();
+     *
+     * console.log(identifier.name);        // 'User'
+     * console.log(identifier.entityType);  // EntityType instance
+     * console.log(identifier.typeName);    // Optional type annotation
+     * ```
+     */
     toIdentifier(): Identifier;
+    /**
+     * Gets the export path where the artifact was generated.
+     *
+     * This method returns the file path where the generated artifact is located,
+     * which is useful for creating import statements or understanding the file
+     * structure of generated code.
+     *
+     * @returns The export path of the generated artifact
+     *
+     * @example
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User');
+     * const exportPath = userModel.toExportPath(); // './src/models/User.ts'
+     *
+     * // Create import statement
+     * const importStmt = `import { User } from '${exportPath}';`;
+     * ```
+     */
     toExportPath(): string;
+    /**
+     * Gets the generated value from the inserted artifact.
+     *
+     * This method returns the actual generated content with proper type safety
+     * based on the generation mode. For 'force' generation, the value is guaranteed
+     * to be present. For 'lazy' generation, the value might be undefined if
+     * generation was skipped.
+     *
+     * @returns The generated value, with optionality based on generation type
+     *
+     * @example Forced generation (guaranteed value)
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User'); // 'force' by default
+     * const value = userModel.toValue(); // UserModelValue (never undefined)
+     *
+     * // Safe to use directly
+     * const code = `type OrderUser = ${value};`;
+     * ```
+     *
+     * @example Lazy generation (optional value)
+     * ```typescript
+     * const optionalModel = this.insertModel(generator, 'Optional', { generation: 'lazy' });
+     * const value = optionalModel.toValue(); // OptionalValue | undefined
+     *
+     * if (value) {
+     *   // Use the generated value
+     *   const code = `type Optional = ${value};`;
+     * } else {
+     *   // Handle missing value (generation was skipped)
+     *   const code = 'type Optional = any; // Fallback';
+     * }
+     * ```
+     */
     toValue(): T extends 'force' ? V : V | undefined;
 }
 export {};

package/esm/dsl/Inserted.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Inserted.d.ts","sourceRoot":"","sources":["../../src/dsl/Inserted.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,cAAc,EACf,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,KAAK,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,IAAI;IACzF,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CACtC,CAAA;AAED,qBAAa,QAAQ,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc;IACtF,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;gBACzB,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAK3E,MAAM,IAAI,MAAM;IAIhB,YAAY,IAAI,UAAU;IAI1B,YAAY,IAAI,MAAM;IAItB,OAAO,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS;CAGjD"}
+{"version":3,"file":"Inserted.d.ts","sourceRoot":"","sources":["../../src/dsl/Inserted.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,cAAc,EACf,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;;;;;GAMG;AACH,KAAK,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,IAAI;IACzF,4DAA4D;IAC5D,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,8CAA8C;IAC9C,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CACtC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsIG;AACH,qBAAa,QAAQ,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc;IACtF,4DAA4D;IAC5D,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IAEzC,8CAA8C;IAC9C,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAErC;;;;;;OAMG;gBACS,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAK3E;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,IAAI,MAAM;IAIhB;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,IAAI,UAAU;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,IAAI,MAAM;IAItB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,OAAO,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS;CAGjD"}