@skmtc/core 0.0.799 → 0.0.800

package/script/context/GenerateContext.js

@@ -255,6 +255,13 @@ class GenerateContext {
             mappings: __classPrivateFieldGet(this, _GenerateContext_mappings, "f")
         };
     }
+    /**
+     * Executes a function within a traced context for debugging and monitoring.
+     *
+     * @param token - Trace identifier or path segments
+     * @param fn - Function to execute within the trace context
+     * @returns The result of the traced function execution
+     */
     trace(token, fn) {
         return (0, tracer_js_1.tracer)(this.stackTrail, token, fn, this.logger);
     }
@@ -283,7 +290,12 @@ class GenerateContext {
             noExport
         });
     }
-    /** @experimental */
+    /**
+     * Registers JSON content for output to a file.
+     *
+     * @experimental This method is experimental and may change in future versions
+     * @param args - Registration arguments with destination path and JSON content
+     */
     registerJson({ destinationPath, json }) {
         const currentFile = __classPrivateFieldGet(this, _GenerateContext_instances, "m", _GenerateContext_getFile).call(this, destinationPath);
         (0, tiny_invariant_1.default)(currentFile instanceof JsonFile_js_1.JsonFile, `File at "${destinationPath}" is not a "JsonFile" type`);
@@ -363,6 +375,14 @@ class GenerateContext {
         });
         return new Inserted_js_1.Inserted({ settings, definition });
     }
+    /**
+     * Inserts a normalized model definition into the generation context.
+     *
+     * @param insertable - Model insertable configuration with prototype and transform functions
+     * @param schema - OAS schema, reference, or void type to generate model from
+     * @param options - Insertion options including generation type and destination
+     * @returns Inserted model instance with settings and definition
+     */
     insertNormalisedModel(insertable, { schema, fallbackName, destinationPath }, { noExport = false } = {}) {
         if (schema.isRef()) {
             const { definition } = this.insertModel(insertable, schema.toRefName(), {

package/script/context/ParseContext.d.ts

@@ -30,7 +30,7 @@ export type ParseReturn = {
 /**
  * Base type for parse warning messages.
  */
-type ParseWarningBase = {
+export type ParseWarningBase = {
     /** Issue severity level */
     level: 'warning';
     /** Warning message */
@@ -39,7 +39,7 @@ type ParseWarningBase = {
 /**
  * Base type for parse error messages.
  */
-type ParseErrorBase = {
+export type ParseErrorBase = {
     /** Issue severity level */
     level: 'error';
     /** The error that occurred */
@@ -48,7 +48,7 @@ type ParseErrorBase = {
 /**
  * Base union type for parse issues.
  */
-type ParseIssueBase = ParseErrorBase | ParseWarningBase;
+export type ParseIssueBase = ParseErrorBase | ParseWarningBase;
 /**
  * Arguments for logging issues with a specific key.
  */
@@ -253,17 +253,78 @@ export declare class ParseContext {
     issues: ParseIssue[];
     /** Whether to suppress console output during parsing */
     silent: boolean;
+    /**
+     * Creates a new ParseContext instance for the parsing phase.
+     *
+     * @param args - Constructor arguments including document object, logger, and options
+     */
     constructor({ documentObject, logger, stackTrail, silent }: ConstructorArgs);
+    /**
+     * Parses the OpenAPI v3 document and returns the internal OAS document representation.
+     *
+     * @returns Parsed OAS document with all components and operations
+     */
     parse(): OasDocument;
+    /**
+     * Removes items from the parsed document that encountered errors during parsing.
+     */
     removeErroredItems(): void;
+    /**
+     * Registers a reference ($ref) with its associated stack trail for error tracking.
+     *
+     * @param stackTrail - Current processing context stack trail
+     * @param $ref - OpenAPI reference string to register
+     */
     registerRef(stackTrail: StackTrail, $ref: string): void;
+    /**
+     * Registers an error that occurred while processing a reference.
+     *
+     * @param error - Error that occurred during reference processing
+     * @param $ref - Reference string that caused the error (if available)
+     */
     registerRefError(error: Error, $ref: string | undefined): void;
+    /**
+     * Executes a function within a traced context for debugging and monitoring.
+     *
+     * @param token - Trace identifier or path segments
+     * @param fn - Function to execute within the trace context
+     * @returns The result of the traced function execution
+     */
     trace<T>(token: string | string[], fn: () => T): T;
+    /**
+     * Logs warnings for fields that were skipped during parsing.
+     *
+     * @param args - Arguments containing skipped fields and parent context
+     */
     logSkippedFields({ skipped, parent, parentType }: LogSkippedValuesArgs): void;
+    /**
+     * Attempts to parse a value with optional error handling and logging.
+     *
+     * @param args - Parsing arguments including schema and error handling
+     * @returns Parsed value or undefined if parsing fails
+     */
     provisionalParse<T>({ key, value, parent, schema, toMessage, type }: ProvisionalParseArgs<T>): T | undefined;
+    /**
+     * Logs a parsing issue with associated key context.
+     *
+     * @param args - Issue arguments including key, parent object, and issue details
+     */
     logIssue({ key, parent, type, ...issue }: LogIssueArgs): void;
+    /**
+     * Logs a parsing issue without specific key context.
+     *
+     * @param args - Issue arguments including parent object and issue details
+     */
     logIssueNoKey({ parent, type, ...issue }: LogIssueNoKeyArgs): void;
 }
+/**
+ * Parses an OpenAPI v3 schema from string format (JSON or YAML).
+ *
+ * Automatically detects the format based on content and parses accordingly.
+ *
+ * @param schema - Schema string in JSON or YAML format
+ * @returns Parsed OpenAPI v3 document object
+ */
 export declare const parseSchema: (schema: string) => OpenAPIV3.Document;
 export {};
 //# sourceMappingURL=ParseContext.d.ts.map

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;;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,oDAAoD;IACpD,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAA;IAClC,6DAA6D;IAC7D,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,qCAAqC;IACrC,WAAW,EAAE,WAAW,CAAA;IACxB,uDAAuD;IACvD,UAAU,EAAE,UAAU,CAAA;IACtB,iEAAiE;IACjE,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,wDAAwD;IACxD,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,MAAM,MAAM,gBAAgB,GAAG;IAC7B,2BAA2B;IAC3B,KAAK,EAAE,SAAS,CAAA;IAChB,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,2BAA2B;IAC3B,KAAK,EAAE,OAAO,CAAA;IACd,8BAA8B;IAC9B,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG,gBAAgB,CAAA;AAE9D;;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,oDAAoD;IACpD,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAA;IAClC,6DAA6D;IAC7D,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,qCAAqC;IACrC,WAAW,EAAE,WAAW,CAAA;IACxB,uDAAuD;IACvD,UAAU,EAAE,UAAU,CAAA;IACtB,iEAAiE;IACjE,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,wDAAwD;IACxD,MAAM,EAAE,OAAO,CAAA;IAGf;;;;OAIG;gBACS,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,EAAE,MAAa,EAAE,EAAE,eAAe;IAWlF;;;;OAIG;IACH,KAAK,IAAI,WAAW;IAWpB;;OAEG;IACH,kBAAkB;IAoBlB;;;;;OAKG;IACH,WAAW,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM;IAMhD;;;;;OAKG;IACH,gBAAgB,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS;IAQvD;;;;;;OAMG;IACH,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;IAIlD;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,oBAAoB;IAYtE;;;;;OAKG;IACH,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;;;;OAIG;IACH,QAAQ,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,YAAY;IAItD;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,iBAAiB;CAqB5D;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,MAAM,KAAG,SAAS,CAAC,QAMtD,CAAA"}

package/script/context/ParseContext.js

@@ -161,6 +161,11 @@ const v = __importStar(require("valibot"));
  * ```
  */
 class ParseContext {
+    /**
+     * Creates a new ParseContext instance for the parsing phase.
+     *
+     * @param args - Constructor arguments including document object, logger, and options
+     */
     constructor({ documentObject, logger, stackTrail, silent = true }) {
         /** The original OpenAPI v3 document being parsed */
         Object.defineProperty(this, "documentObject", {
@@ -215,6 +220,11 @@ class ParseContext {
         __classPrivateFieldSet(this, _ParseContext_refStackTrails, {}, "f");
         __classPrivateFieldSet(this, _ParseContext_refErrors, {}, "f");
     }
+    /**
+     * Parses the OpenAPI v3 document and returns the internal OAS document representation.
+     *
+     * @returns Parsed OAS document with all components and operations
+     */
     parse() {
         this.oasDocument.fields = (0, toDocumentFieldsV3_js_1.toDocumentFieldsV3)({
             documentObject: this.documentObject,
@@ -223,6 +233,9 @@ class ParseContext {
         this.removeErroredItems();
         return this.oasDocument;
     }
+    /**
+     * Removes items from the parsed document that encountered errors during parsing.
+     */
     removeErroredItems() {
         Object.entries(__classPrivateFieldGet(this, _ParseContext_refErrors, "f")).forEach(([$ref, errors]) => {
             errors.forEach(error => {
@@ -241,19 +254,43 @@ class ParseContext {
             });
         });
     }
+    /**
+     * Registers a reference ($ref) with its associated stack trail for error tracking.
+     *
+     * @param stackTrail - Current processing context stack trail
+     * @param $ref - OpenAPI reference string to register
+     */
     registerRef(stackTrail, $ref) {
         const refStackTrails = __classPrivateFieldGet(this, _ParseContext_refStackTrails, "f")[$ref];
         refStackTrails ? refStackTrails.push(stackTrail) : (__classPrivateFieldGet(this, _ParseContext_refStackTrails, "f")[$ref] = [stackTrail]);
     }
+    /**
+     * Registers an error that occurred while processing a reference.
+     *
+     * @param error - Error that occurred during reference processing
+     * @param $ref - Reference string that caused the error (if available)
+     */
     registerRefError(error, $ref) {
         if ($ref) {
             const refErrors = __classPrivateFieldGet(this, _ParseContext_refErrors, "f")[$ref];
             refErrors ? refErrors.push(error) : (__classPrivateFieldGet(this, _ParseContext_refErrors, "f")[$ref] = [error]);
         }
     }
+    /**
+     * Executes a function within a traced context for debugging and monitoring.
+     *
+     * @param token - Trace identifier or path segments
+     * @param fn - Function to execute within the trace context
+     * @returns The result of the traced function execution
+     */
     trace(token, fn) {
         return (0, tracer_js_1.tracer)(this.stackTrail, token, fn, this.logger);
     }
+    /**
+     * Logs warnings for fields that were skipped during parsing.
+     *
+     * @param args - Arguments containing skipped fields and parent context
+     */
     logSkippedFields({ skipped, parent, parentType }) {
         Object.keys(skipped).forEach(key => {
             this.logIssue({
@@ -265,6 +302,12 @@ class ParseContext {
             });
         });
     }
+    /**
+     * Attempts to parse a value with optional error handling and logging.
+     *
+     * @param args - Parsing arguments including schema and error handling
+     * @returns Parsed value or undefined if parsing fails
+     */
     provisionalParse({ key, value, parent, schema, toMessage, type }) {
         const parsed = v.safeParse(v.optional(schema), value);
         if (parsed.success) {
@@ -278,9 +321,19 @@ class ParseContext {
             type
         });
     }
+    /**
+     * Logs a parsing issue with associated key context.
+     *
+     * @param args - Issue arguments including key, parent object, and issue details
+     */
     logIssue({ key, parent, type, ...issue }) {
         this.trace(key, () => this.logIssueNoKey({ parent, type, ...issue }));
     }
+    /**
+     * Logs a parsing issue without specific key context.
+     *
+     * @param args - Issue arguments including parent object and issue details
+     */
     logIssueNoKey({ parent, type, ...issue }) {
         if (issue.level === 'error') {
             this.registerRefError(issue.error, this.stackTrail.toStackRef());
@@ -303,6 +356,14 @@ class ParseContext {
 }
 exports.ParseContext = ParseContext;
 _ParseContext_refStackTrails = new WeakMap(), _ParseContext_refErrors = new WeakMap();
+/**
+ * Parses an OpenAPI v3 schema from string format (JSON or YAML).
+ *
+ * Automatically detects the format based on content and parses accordingly.
+ *
+ * @param schema - Schema string in JSON or YAML format
+ * @returns Parsed OpenAPI v3 document object
+ */
 const parseSchema = (schema) => {
     if (schema.trimStart().startsWith('{')) {
         return JSON.parse(schema);

package/script/context/ResultsHandler.d.ts

@@ -1,14 +1,21 @@
 import { type LevelName } from '../deps/jsr.io/@std/log/0.224.14/levels.js';
 import type { LogRecord } from '../deps/jsr.io/@std/log/0.224.14/logger.js';
 import { BaseHandler } from '../deps/jsr.io/@std/log/0.224.14/base_handler.js';
-import type { BaseHandlerOptions } from '../deps/jsr.io/@std/log/0.224.14/base_handler.js';
 import type { CoreContext } from './CoreContext.js';
+/**
+ * Base log handler interface for extending Deno standard library handlers.
+ */
+export interface LogHandlerBase {
+    handle(logRecord: LogRecord): void;
+}
 /**
  * Configuration options for the {@link ResultsHandler}.
  */
-export interface ResultsHandlerOptions extends BaseHandlerOptions {
+export interface ResultsHandlerOptions {
     /** The CoreContext instance to capture results to */
     context: CoreContext;
+    /** Formatter function for log messages */
+    formatter?: (logRecord: LogRecord) => string;
 }
 /**
  * Custom log handler that captures warning and error results for SKMTC processing.
@@ -77,7 +84,7 @@ export interface ResultsHandlerOptions extends BaseHandlerOptions {
  * }
  * ```
  */
-export declare class ResultsHandler extends BaseHandler {
+export declare class ResultsHandler extends BaseHandler implements LogHandlerBase {
     #private;
     /** The CoreContext instance for capturing results */
     context: CoreContext;

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

@@ -1 +1 @@
-{"version":3,"file":"ResultsHandler.d.ts","sourceRoot":"","sources":["../../src/context/ResultsHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAa,MAAM,4CAA4C,CAAA;AACtF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4CAA4C,CAAA;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAA;AAC9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,kDAAkD,CAAA;AAC1F,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAGnD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D,qDAAqD;IACrD,OAAO,EAAE,WAAW,CAAA;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,qBAAa,cAAe,SAAQ,WAAW;;IAC7C,qDAAqD;IACrD,OAAO,EAAE,WAAW,CAAA;IAOpB;;;;;;;;;;;;;;OAcG;gBACS,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,qBAAqB;IAMhE;;;;;;;OAOG;IACM,KAAK;IAMd;;;;;;;;;OASG;IACM,MAAM,CAAC,SAAS,EAAE,SAAS;IASpC;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM;IAWrB;;;;;;;OAOG;IACH,KAAK;IAWL;;;;;;;;;;;;;;;;;;;;;OAqBG;IACM,OAAO;CAKjB"}
+{"version":3,"file":"ResultsHandler.d.ts","sourceRoot":"","sources":["../../src/context/ResultsHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAAa,MAAM,4CAA4C,CAAA;AACtF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4CAA4C,CAAA;AAC3E,OAAO,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAA;AAC9E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAGnD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,qDAAqD;IACrD,OAAO,EAAE,WAAW,CAAA;IACpB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,MAAM,CAAA;CAC7C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,qBAAa,cAAe,SAAQ,WAAY,YAAW,cAAc;;IACvE,qDAAqD;IACrD,OAAO,EAAE,WAAW,CAAA;IAOpB;;;;;;;;;;;;;;OAcG;gBACS,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,qBAAqB;IAMhE;;;;;;;OAOG;IACM,KAAK;IAMd;;;;;;;;;OASG;IACM,MAAM,CAAC,SAAS,EAAE,SAAS;IASpC;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM;IAWrB;;;;;;;OAOG;IACH,KAAK;IAWL;;;;;;;;;;;;;;;;;;;;;OAqBG;IACM,OAAO;CAKjB"}

package/script/dsl/model/types.d.ts

@@ -6,33 +6,73 @@ import type { EnrichmentRequest } from '../../types/EnrichmentRequest.js';
 import type * as v from 'valibot';
 import type { MappingModule, PreviewModule } from '../../types/Preview.js';
 import type { SchemaToValueFn } from '../../types/TypeSystem.js';
-type ModelInsertableConstructorArgs<EnrichmentType = undefined> = {
+/**
+ * Constructor arguments for model insertable instances.
+ *
+ * @template EnrichmentType - Optional enrichment data type for additional metadata
+ */
+export type ModelInsertableConstructorArgs<EnrichmentType = undefined> = {
     context: GenerateContext;
     refName: RefName;
     settings: ContentSettings<EnrichmentType>;
     destinationPath: string;
     rootRef?: RefName;
 };
+/**
+ * Interface for objects that provide model transformation capabilities.
+ *
+ * Used by generator configurations to transform model definitions
+ * during the code generation process.
+ */
 export type WithTransformModel = {
     transformModel: (refName: RefName) => void;
 };
-type ToEnrichmentsArgs = {
+/**
+ * Arguments for generating enrichment data for models.
+ */
+export type ModelToEnrichmentsArgs = {
     refName: RefName;
     context: GenerateContext;
 };
+/**
+ * Arguments passed to model transformation functions.
+ *
+ * @template Acc - Accumulator type for collecting transformation results
+ */
 export type TransformModelArgs<Acc> = {
     context: GenerateContext;
     refName: RefName;
     acc: Acc | undefined;
 };
+/**
+ * Arguments for generating model preview modules.
+ *
+ * Preview modules provide quick insights into generated models
+ * without full code generation.
+ */
 export type ToModelPreviewModuleArgs = {
     context: GenerateContext;
     refName: RefName;
 };
+/**
+ * Arguments for generating model mapping information.
+ *
+ * Mappings track relationships between OAS schemas and generated models,
+ * enabling cross-references and dependency analysis.
+ */
 export type ToModelMappingArgs = {
     context: GenerateContext;
     refName: RefName;
 };
+/**
+ * Configuration object for insertable model generators.
+ *
+ * Defines the contract for model generator classes that can be inserted
+ * into the generation context to produce type-safe model definitions.
+ *
+ * @template V - Generated value type produced by the model generator
+ * @template EnrichmentType - Optional enrichment data type for additional metadata
+ */
 export type ModelInsertable<V, EnrichmentType = undefined> = {
     prototype: V;
 } & {
@@ -41,10 +81,18 @@ export type ModelInsertable<V, EnrichmentType = undefined> = {
     type: 'model';
     toIdentifier: (refName: RefName) => Identifier;
     toExportPath: (refName: RefName) => string;
-    toEnrichments: ({ refName, context }: ToEnrichmentsArgs) => EnrichmentType;
+    toEnrichments: ({ refName, context }: ModelToEnrichmentsArgs) => EnrichmentType;
     schemaToValueFn: SchemaToValueFn;
     createIdentifier: (name: string) => Identifier;
 } & Function;
+/**
+ * Configuration object for model generators.
+ *
+ * Defines the behavior and capabilities of model generators including
+ * transformation logic, preview generation, and enrichment handling.
+ *
+ * @template EnrichmentType - Optional enrichment data type for additional metadata
+ */
 export type ModelConfig<EnrichmentType = undefined> = {
     id: string;
     type: 'model';
@@ -54,5 +102,4 @@ export type ModelConfig<EnrichmentType = undefined> = {
     toEnrichmentSchema?: () => v.BaseSchema<EnrichmentType, EnrichmentType, v.BaseIssue<unknown>>;
     toEnrichmentRequest?: <RequestedEnrichment extends EnrichmentType>(refName: RefName) => EnrichmentRequest<RequestedEnrichment> | undefined;
 };
-export {};
 //# sourceMappingURL=types.d.ts.map

package/script/dsl/model/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/dsl/model/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,KAAK,CAAC,MAAM,SAAS,CAAA;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC1E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,KAAK,8BAA8B,CAAC,cAAc,GAAG,SAAS,IAAI;IAChE,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,cAAc,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CAC3C,CAAA;AAED,KAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,kBAAkB,CAAC,GAAG,IAAI;IACpC,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,GAAG,GAAG,SAAS,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,IAAI;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,GAAG;IAC9E,KAAK,EACH,OAAO,EACP,OAAO,EACP,QAAQ,EACR,eAAe,EACf,OAAO,EACR,EAAE,8BAA8B,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;IACrD,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,OAAO,CAAA;IACb,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,UAAU,CAAA;IAC9C,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,CAAA;IAC1C,aAAa,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,iBAAiB,KAAK,cAAc,CAAA;IAC1E,eAAe,EAAE,eAAe,CAAA;IAChC,gBAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,UAAU,CAAA;CAE/C,GAAG,QAAQ,CAAA;AAEZ,MAAM,MAAM,WAAW,CAAC,cAAc,GAAG,SAAS,IAAI;IACpD,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,kBAAkB,CAAC,GAAG,CAAC,KAAK,GAAG,CAAA;IAClF,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,wBAAwB,KAAK,aAAa,CAAA;IACnF,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,kBAAkB,KAAK,aAAa,CAAA;IAC7E,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7F,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,SAAS,cAAc,EAC/D,OAAO,EAAE,OAAO,KACb,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;CACxD,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/dsl/model/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,KAAK,CAAC,MAAM,SAAS,CAAA;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC1E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,CAAC,cAAc,GAAG,SAAS,IAAI;IACvE,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,eAAe,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,cAAc,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CAC3C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,eAAe,CAAA;CACzB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,GAAG,IAAI;IACpC,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,GAAG,GAAG,SAAS,CAAA;CACrB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,EAAE,eAAe,CAAA;IACxB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,IAAI;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,GAAG;IAC9E,KAAK,EACH,OAAO,EACP,OAAO,EACP,QAAQ,EACR,eAAe,EACf,OAAO,EACR,EAAE,8BAA8B,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;IACrD,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,OAAO,CAAA;IACb,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,UAAU,CAAA;IAC9C,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,CAAA;IAC1C,aAAa,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,sBAAsB,KAAK,cAAc,CAAA;IAC/E,eAAe,EAAE,eAAe,CAAA;IAChC,gBAAgB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,UAAU,CAAA;CAE/C,GAAG,QAAQ,CAAA;AAEZ;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,cAAc,GAAG,SAAS,IAAI;IACpD,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,OAAO,CAAA;IACb,SAAS,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,kBAAkB,CAAC,GAAG,CAAC,KAAK,GAAG,CAAA;IAClF,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,wBAAwB,KAAK,aAAa,CAAA;IACnF,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,kBAAkB,KAAK,aAAa,CAAA;IAC7E,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7F,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,SAAS,cAAc,EAC/D,OAAO,EAAE,OAAO,KACb,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;CACxD,CAAA"}

package/script/dsl/operation/types.d.ts

@@ -5,40 +5,88 @@ import type { Identifier } from '../Identifier.js';
 import type { EnrichmentRequest } from '../../types/EnrichmentRequest.js';
 import type * as v from 'valibot';
 import type { MappingModule, PreviewModule } from '../../types/Preview.js';
+/**
+ * Arguments passed to operation insertable constructors.
+ *
+ * @template EnrichmentType - Optional enrichment data type for additional metadata
+ */
 export type OperationInsertableArgs<EnrichmentType = undefined> = {
     context: GenerateContext;
     settings: ContentSettings<EnrichmentType>;
     operation: OasOperation;
 };
+/**
+ * Arguments passed to operation transformation functions.
+ *
+ * @template Acc - Accumulator type for collecting transformation results
+ */
 export type TransformOperationArgs<Acc> = {
     context: GenerateContext;
     operation: OasOperation;
     acc: Acc | undefined;
 };
+/**
+ * Interface for objects that provide operation transformation capabilities.
+ *
+ * Used by generator configurations to transform operation definitions
+ * during the code generation process.
+ */
 export type WithTransformOperation = {
     transformOperation: (operation: OasOperation) => void;
 };
+/**
+ * Arguments for checking if an operation is supported with enrichment configuration.
+ *
+ * @template EnrichmentType - Optional enrichment data type for additional metadata
+ */
 export type IsSupportedOperationConfigArgs<EnrichmentType = undefined> = {
     context: GenerateContext;
     operation: OasOperation;
     enrichments: EnrichmentType;
 };
+/**
+ * Arguments for checking if an operation is supported for code generation.
+ */
 export type IsSupportedOperationArgs = {
     context: GenerateContext;
     operation: OasOperation;
 };
-type ToEnrichmentsArgs = {
+/**
+ * Arguments for generating enrichment data for operations.
+ */
+export type OperationToEnrichmentsArgs = {
     operation: OasOperation;
     context: GenerateContext;
 };
+/**
+ * Arguments for generating operation preview modules.
+ *
+ * Preview modules provide quick insights into generated operations
+ * without full code generation.
+ */
 export type ToOperationPreviewModuleArgs = {
     context: GenerateContext;
     operation: OasOperation;
 };
+/**
+ * Arguments for generating operation mapping information.
+ *
+ * Mappings track relationships between OAS operations and generated code,
+ * enabling cross-references and dependency analysis.
+ */
 export type ToOperationMappingArgs = {
     context: GenerateContext;
     operation: OasOperation;
 };
+/**
+ * Configuration object for insertable operation generators.
+ *
+ * Defines the contract for operation generator classes that can be inserted
+ * into the generation context to produce type-safe operation definitions.
+ *
+ * @template V - Generated value type produced by the operation generator
+ * @template EnrichmentType - Optional enrichment data type for additional metadata
+ */
 export type OperationInsertable<V, EnrichmentType = undefined> = {
     prototype: V;
 } & {
@@ -47,12 +95,23 @@ export type OperationInsertable<V, EnrichmentType = undefined> = {
     type: 'operation';
     toIdentifier: (operation: OasOperation) => Identifier;
     toExportPath: (operation: OasOperation) => string;
-    toEnrichments: ({ operation, context }: ToEnrichmentsArgs) => EnrichmentType;
+    toEnrichments: ({ operation, context }: OperationToEnrichmentsArgs) => EnrichmentType;
 } & Function;
+/**
+ * Arguments for checking if an operation is supported for generation.
+ */
 export type IsSupportedArgs = {
     context: GenerateContext;
     operation: OasOperation;
 };
+/**
+ * Configuration object for operation generators.
+ *
+ * Defines the behavior and capabilities of operation generators including
+ * support detection, transformation logic, and enrichment handling.
+ *
+ * @template EnrichmentType - Optional enrichment data type for additional metadata
+ */
 export type OperationConfig<EnrichmentType = undefined> = {
     id: string;
     type: 'operation';
@@ -63,5 +122,4 @@ export type OperationConfig<EnrichmentType = undefined> = {
     toMappingModule?: ({ context, operation }: ToOperationMappingArgs) => MappingModule;
     toEnrichmentRequest?: <RequestedEnrichment extends EnrichmentType>(operation: OasOperation) => EnrichmentRequest<RequestedEnrichment> | undefined;
 };
-export {};
 //# sourceMappingURL=types.d.ts.map

package/script/dsl/operation/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/dsl/operation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,KAAK,CAAC,MAAM,SAAS,CAAA;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC1E,MAAM,MAAM,uBAAuB,CAAC,cAAc,GAAG,SAAS,IAAI;IAChE,OAAO,EAAE,eAAe,CAAA;IACxB,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,sBAAsB,CAAC,GAAG,IAAI;IACxC,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;IACvB,GAAG,EAAE,GAAG,GAAG,SAAS,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,kBAAkB,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,IAAI,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,8BAA8B,CAAC,cAAc,GAAG,SAAS,IAAI;IACvE,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;IACvB,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED,KAAK,iBAAiB,GAAG;IACvB,SAAS,EAAE,YAAY,CAAA;IACvB,OAAO,EAAE,eAAe,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,IAAI;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,GAAG;IAClF,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,uBAAuB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;IAClF,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,WAAW,CAAA;IACjB,YAAY,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,UAAU,CAAA;IACrD,YAAY,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,MAAM,CAAA;IACjD,aAAa,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,iBAAiB,KAAK,cAAc,CAAA;CAE7E,GAAG,QAAQ,CAAA;AAEZ,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,cAAc,GAAG,SAAS,IAAI;IACxD,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,WAAW,CAAA;IACjB,SAAS,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,sBAAsB,CAAC,GAAG,CAAC,KAAK,GAAG,CAAA;IACxF,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;IAC1D,WAAW,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,eAAe,KAAK,OAAO,CAAA;IACjE,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,4BAA4B,KAAK,aAAa,CAAA;IACzF,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,sBAAsB,KAAK,aAAa,CAAA;IACnF,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,SAAS,cAAc,EAC/D,SAAS,EAAE,YAAY,KACpB,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;CACxD,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/dsl/operation/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AACvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,KAAK,CAAC,MAAM,SAAS,CAAA;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAC1E;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,CAAC,cAAc,GAAG,SAAS,IAAI;IAChE,OAAO,EAAE,eAAe,CAAA;IACxB,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,CAAC,GAAG,IAAI;IACxC,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;IACvB,GAAG,EAAE,GAAG,GAAG,SAAS,CAAA;CACrB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,kBAAkB,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,IAAI,CAAA;CACtD,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,CAAC,cAAc,GAAG,SAAS,IAAI;IACvE,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;IACvB,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,SAAS,EAAE,YAAY,CAAA;IACvB,OAAO,EAAE,eAAe,CAAA;CACzB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,IAAI;IAAE,SAAS,EAAE,CAAC,CAAA;CAAE,GAAG;IAClF,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,uBAAuB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;IAClF,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,WAAW,CAAA;IACjB,YAAY,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,UAAU,CAAA;IACrD,YAAY,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,MAAM,CAAA;IACjD,aAAa,EAAE,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,0BAA0B,KAAK,cAAc,CAAA;CAEtF,GAAG,QAAQ,CAAA;AAEZ;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,eAAe,CAAA;IACxB,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,CAAC,cAAc,GAAG,SAAS,IAAI;IACxD,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,WAAW,CAAA;IACjB,SAAS,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,sBAAsB,CAAC,GAAG,CAAC,KAAK,GAAG,CAAA;IACxF,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;IAC1D,WAAW,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,eAAe,KAAK,OAAO,CAAA;IACjE,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,4BAA4B,KAAK,aAAa,CAAA;IACzF,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE,sBAAsB,KAAK,aAAa,CAAA;IACnF,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,SAAS,cAAc,EAC/D,SAAS,EAAE,YAAY,KACpB,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;CACxD,CAAA"}

package/script/oas/operation/Operation.d.ts

@@ -46,7 +46,10 @@ export type OperationFields = {
     /** OpenAPI specification extensions */
     extensionFields?: Record<string, unknown>;
 };
-type ToRequestBodyMapArgs = {
+/**
+ * Arguments passed to request body mapping functions.
+ */
+export type ToRequestBodyMapArgs = {
     schema: OasSchema | OasRef<'schema'>;
     requestBody: OasRequestBody;
 };
@@ -186,9 +189,35 @@ export declare class OasOperation {
     deprecated: boolean | undefined;
     /** OpenAPI specification extensions */
     extensionFields: Record<string, unknown> | undefined;
+    /**
+     * Creates a new OasOperation instance from operation field data.
+     *
+     * @param fields - Operation field data from OpenAPI specification
+     */
     constructor(fields: OperationFields);
+    /**
+     * Returns the successful response definition for this operation.
+     *
+     * Looks for the lowest numbered 2xx response code and returns its response definition.
+     *
+     * @returns Success response object or undefined if none found
+     */
     toSuccessResponse(): OasResponse | OasRef<'response'> | undefined;
+    /**
+     * Returns the HTTP status code for the primary success response.
+     *
+     * Finds the lowest numbered 2xx status code in the responses.
+     *
+     * @returns Success status code as string or undefined if none found
+     */
     toSuccessResponseCode(): string | undefined;
+    /**
+     * Maps the request body schema to a custom value using the provided mapping function.
+     *
+     * @param map - Function to transform the request body schema and metadata
+     * @param mediaType - Media type to extract schema from (default: 'application/json')
+     * @returns Mapped value or undefined if no request body schema found
+     */
     toRequestBody<V>(map: ({ schema, requestBody }: ToRequestBodyMapArgs) => V, mediaType?: string): V | undefined;
     /**
      * Resolve all parameters and optionally filter by location
@@ -197,9 +226,25 @@ export declare class OasOperation {
      * @returns
      */
     toParams(filter?: OasParameterLocation[]): OasParameter[];
+    /**
+     * Creates an OAS object representation of operation parameters.
+     *
+     * @param filter - Optional array of parameter locations to include
+     * @returns OAS object with parameter properties
+     */
     toParametersObject(filter?: OasParameterLocation[]): OasObject;
+    /**
+     * Converts the operation to OpenAPI v3 JSON schema format.
+     *
+     * @param options - Conversion options for nested components
+     * @returns OpenAPI v3 operation object
+     */
     toJsonSchema(options: ToJsonSchemaOptions): OpenAPIV3.OperationObject;
+    /**
+     * Serializes the operation to a plain JavaScript object.
+     *
+     * @returns Plain object representation of the operation
+     */
     toJSON(): object;
 }
-export {};
 //# sourceMappingURL=Operation.d.ts.map