@skmtc/core 0.0.795 → 0.0.797

package/script/context/ResultsHandler.js

@@ -10,25 +10,143 @@ exports.ResultsHandler = void 0;
 const levels_js_1 = require("../deps/jsr.io/@std/log/0.224.14/levels.js");
 const base_handler_js_1 = require("../deps/jsr.io/@std/log/0.224.14/base_handler.js");
 const ts_pattern_1 = require("ts-pattern");
+/**
+ * Custom log handler that captures warning and error results for SKMTC processing.
+ *
+ * The `ResultsHandler` extends Deno's standard library BaseHandler to provide
+ * specialized logging behavior for the SKMTC pipeline. It integrates with the
+ * CoreContext to capture warnings and errors as structured results that can be
+ * analyzed and reported after processing completes.
+ *
+ * This handler ensures that important processing issues are captured and stored
+ * in the context's results system rather than just being logged to the console.
+ *
+ * ## Key Features
+ *
+ * - **Result Capture**: Automatically captures WARN and ERROR logs as results
+ * - **Immediate Flushing**: Critical errors trigger immediate flush
+ * - **Lifecycle Management**: Proper setup and cleanup with event handlers
+ * - **Context Integration**: Seamlessly integrates with CoreContext results system
+ *
+ * @example Setting up the handler
+ * ```typescript
+ * import { getLogger } from '@std/log';
+ * import { ResultsHandler, CoreContext } from '@skmtc/core';
+ *
+ * const context = new CoreContext({
+ *   // ... context options
+ * });
+ *
+ * const handler = new ResultsHandler('WARN', {
+ *   context: context,
+ *   formatter: '[{levelName}] {msg}'
+ * });
+ *
+ * const logger = getLogger();
+ * logger.addHandler(handler);
+ *
+ * // Now warnings and errors will be captured as results
+ * logger.warning('Schema validation issue detected');
+ * logger.error('Failed to process operation');
+ * ```
+ *
+ * @example Integration in pipeline
+ * ```typescript
+ * class ProcessingPipeline {
+ *   async process(document: OasDocument) {
+ *     const context = new CoreContext(options);
+ *
+ *     // Set up results handler
+ *     const handler = new ResultsHandler('WARN', { context });
+ *     const logger = getLogger();
+ *     logger.addHandler(handler);
+ *
+ *     try {
+ *       const result = await this.processDocument(document, context);
+ *
+ *       // Check captured results
+ *       if (context.results.hasWarnings()) {
+ *         console.log('Processing completed with warnings');
+ *       }
+ *
+ *       return result;
+ *     } finally {
+ *       handler.destroy();
+ *     }
+ *   }
+ * }
+ * ```
+ */
 class ResultsHandler extends base_handler_js_1.BaseHandler {
+    /**
+     * Creates a new ResultsHandler instance.
+     *
+     * @param levelName - The minimum log level to handle
+     * @param options - Handler configuration including CoreContext
+     *
+     * @example
+     * ```typescript
+     * const context = new CoreContext(contextOptions);
+     * const handler = new ResultsHandler('WARN', {
+     *   context,
+     *   formatter: '[{levelName}] {msg}'
+     * });
+     * ```
+     */
     constructor(levelName, options) {
         super(levelName, options);
         _ResultsHandler_instances.add(this);
+        /** The CoreContext instance for capturing results */
         Object.defineProperty(this, "context", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Bound callback for cleanup on process unload */
         _ResultsHandler_unloadCallback.set(this, (() => {
             this.destroy();
-        }).bind(this));
+        }).bind(this)
+        /**
+         * Creates a new ResultsHandler instance.
+         *
+         * @param levelName - The minimum log level to handle
+         * @param options - Handler configuration including CoreContext
+         *
+         * @example
+         * ```typescript
+         * const context = new CoreContext(contextOptions);
+         * const handler = new ResultsHandler('WARN', {
+         *   context,
+         *   formatter: '[{levelName}] {msg}'
+         * });
+         * ```
+         */
+        );
         this.context = options.context;
     }
+    /**
+     * Sets up the handler with event listeners.
+     *
+     * Registers cleanup callbacks for process termination to ensure
+     * proper resource cleanup and result flushing.
+     *
+     * @override
+     */
     setup() {
         __classPrivateFieldGet(this, _ResultsHandler_instances, "m", _ResultsHandler_resetBuffer).call(this);
         addEventListener('unload', __classPrivateFieldGet(this, _ResultsHandler_unloadCallback, "f"));
     }
+    /**
+     * Handles incoming log records.
+     *
+     * Processes log records through the base handler and triggers
+     * immediate flushing for critical errors above ERROR level.
+     *
+     * @param logRecord - The log record to handle
+     *
+     * @override
+     */
     handle(logRecord) {
         super.handle(logRecord);
         // Immediately flush if log level is higher than ERROR
@@ -36,6 +154,23 @@ class ResultsHandler extends base_handler_js_1.BaseHandler {
             this.flush();
         }
     }
+    /**
+     * Captures log messages as results in the context.
+     *
+     * Converts log level names to result types and captures them
+     * in the associated CoreContext for later analysis.
+     *
+     * @param levelName - The log level name ('WARN' or 'ERROR')
+     *
+     * @throws {Error} When an unsupported log level is provided
+     *
+     * @example
+     * ```typescript
+     * // This is called automatically by the logging system
+     * handler.log('WARN'); // Captures as 'warning' result
+     * handler.log('ERROR'); // Captures as 'error' result
+     * ```
+     */
     log(levelName) {
         this.context.captureCurrentResult((0, ts_pattern_1.match)(levelName)
             .with('WARN', () => 'warning')
@@ -44,9 +179,39 @@ class ResultsHandler extends base_handler_js_1.BaseHandler {
             throw new Error(`Unexpected log level name: ${levelName}`);
         }));
     }
+    /**
+     * Flushes any buffered content.
+     *
+     * This implementation resets the internal buffer. Override
+     * this method in subclasses to implement custom flushing behavior.
+     *
+     * @override
+     */
     flush() {
         __classPrivateFieldGet(this, _ResultsHandler_instances, "m", _ResultsHandler_resetBuffer).call(this);
     }
+    /**
+     * Destroys the handler and cleans up resources.
+     *
+     * Flushes any remaining content and removes event listeners
+     * to prevent memory leaks.
+     *
+     * @override
+     *
+     * @example
+     * ```typescript
+     * const handler = new ResultsHandler('WARN', { context });
+     *
+     * try {
+     *   // Use handler
+     *   logger.addHandler(handler);
+     *   await processDocument();
+     * } finally {
+     *   // Always clean up
+     *   handler.destroy();
+     * }
+     * ```
+     */
     destroy() {
         this.flush();
         removeEventListener('unload', __classPrivateFieldGet(this, _ResultsHandler_unloadCallback, "f"));

package/script/dsl/constants.d.ts

@@ -1,2 +1,30 @@
+/**
+ * Marker constant representing an empty or unset value in the SKMTC DSL system.
+ *
+ * This constant is used throughout the DSL to represent placeholders, empty
+ * templates, or uninitialized content. It provides a consistent way to identify
+ * empty states that need to be handled during code generation.
+ *
+ * @example Usage in templates
+ * ```typescript
+ * import { EMPTY } from '@skmtc/core';
+ *
+ * const template = someCondition ? 'actual content' : EMPTY;
+ *
+ * if (template === EMPTY) {
+ *   // Handle empty state
+ *   console.log('No content to generate');
+ * }
+ * ```
+ *
+ * @example DSL content generation
+ * ```typescript
+ * const content = new List([
+ *   'import { User } from "./types";',
+ *   someFeature ? 'import { Admin } from "./admin";' : EMPTY,
+ *   'export { User };'
+ * ]).filter(line => line !== EMPTY);
+ * ```
+ */
 export declare const EMPTY = "__EMPTY__";
 //# sourceMappingURL=constants.d.ts.map

package/script/dsl/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/dsl/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK,cAAc,CAAA"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/dsl/constants.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,KAAK,cAAc,CAAA"}

package/script/dsl/constants.js

@@ -1,4 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EMPTY = void 0;
+/**
+ * Marker constant representing an empty or unset value in the SKMTC DSL system.
+ *
+ * This constant is used throughout the DSL to represent placeholders, empty
+ * templates, or uninitialized content. It provides a consistent way to identify
+ * empty states that need to be handled during code generation.
+ *
+ * @example Usage in templates
+ * ```typescript
+ * import { EMPTY } from '@skmtc/core';
+ *
+ * const template = someCondition ? 'actual content' : EMPTY;
+ *
+ * if (template === EMPTY) {
+ *   // Handle empty state
+ *   console.log('No content to generate');
+ * }
+ * ```
+ *
+ * @example DSL content generation
+ * ```typescript
+ * const content = new List([
+ *   'import { User } from "./types";',
+ *   someFeature ? 'import { Admin } from "./admin";' : EMPTY,
+ *   'export { User };'
+ * ]).filter(line => line !== EMPTY);
+ * ```
+ */
 exports.EMPTY = '__EMPTY__';

package/script/oas/_helpers/parseDefault.d.ts

@@ -1,16 +1,164 @@
 import type { OpenAPIV3 } from 'openapi-types';
 import type { ParseContext } from '../../context/ParseContext.js';
 import * as v from 'valibot';
+/**
+ * Arguments for parsing OpenAPI schema default values.
+ *
+ * @template T - The expected type of the default value
+ * @template Nullable - Whether the schema allows null values
+ * @template Value - The OpenAPI schema object type
+ */
 type ParseDefaultArgs<T, Nullable extends boolean | undefined, Value extends OpenAPIV3.SchemaObject> = {
+    /** The OpenAPI schema object without nullable, example, and enum properties */
     value: Omit<Value, 'nullable' | 'example' | 'enum'>;
+    /** Whether the schema allows null values */
     nullable: Nullable;
+    /** Valibot schema for validating the default value */
     valibotSchema: v.GenericSchema<T>;
+    /** Parse context for error handling */
     context: ParseContext;
 };
+/**
+ * Return type for parsed default value data.
+ *
+ * @template T - The expected type of the default value
+ * @template Nullable - Whether the schema allows null values
+ * @template Value - The OpenAPI schema object type
+ */
 type ParseDefaultReturn<T, Nullable extends boolean | undefined, Value extends OpenAPIV3.SchemaObject> = {
+    /** The parsed and validated default value */
     default: Nullable extends true ? T | null | undefined : T | undefined;
+    /** The schema object with all processed properties removed */
     value: Omit<Value, 'nullable' | 'example' | 'enum' | 'default'>;
 };
+/**
+ * Parses and validates OpenAPI schema default values with type safety.
+ *
+ * This function extracts and validates default values from OpenAPI schema objects,
+ * ensuring they conform to the expected type and handling nullable schemas correctly.
+ * Invalid default values are removed and logged as warnings through the parse context.
+ *
+ * The function provides full type safety, with the return type reflecting whether
+ * null values are allowed based on the nullable parameter. This ensures that
+ * generated code maintains proper type constraints for default values.
+ *
+ * @template T - The expected type of the default value
+ * @template Nullable - Whether the schema allows null as a default
+ * @template Value - The OpenAPI schema object type
+ *
+ * @param args - Parsing configuration
+ * @returns Parsed default data with the validated default value and cleaned schema
+ *
+ * @example Basic string default parsing
+ * ```typescript
+ * import { parseDefault } from '@skmtc/core/oas/_helpers';
+ * import * as v from 'valibot';
+ *
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'string',
+ *     default: 'hello world',
+ *     minLength: 5
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.string(),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // 'hello world'
+ * console.log(result.value);   // { type: 'string', minLength: 5 }
+ * ```
+ *
+ * @example Nullable default value
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'string',
+ *     default: null,
+ *     format: 'email'
+ *   },
+ *   nullable: true,
+ *   valibotSchema: v.string(),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // null (valid for nullable schema)
+ * // Type: string | null | undefined
+ * ```
+ *
+ * @example Number default with constraints
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'number',
+ *     default: 42,
+ *     minimum: 0,
+ *     maximum: 100
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.number(),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // 42
+ * console.log(result.value);   // { type: 'number', minimum: 0, maximum: 100 }
+ * ```
+ *
+ * @example Invalid default handling
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'boolean',
+ *     default: 'not a boolean', // Invalid default
+ *     description: 'A boolean flag'
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.boolean(),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // undefined (invalid default removed)
+ * // Context will log a warning about the invalid default
+ * ```
+ *
+ * @example Array default value
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'array',
+ *     items: { type: 'string' },
+ *     default: ['item1', 'item2']
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.array(v.string()),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // ['item1', 'item2']
+ * ```
+ *
+ * @example Object default value
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'object',
+ *     properties: {
+ *       name: { type: 'string' },
+ *       age: { type: 'number' }
+ *     },
+ *     default: { name: 'John', age: 30 }
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.object({
+ *     name: v.string(),
+ *     age: v.number()
+ *   }),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // { name: 'John', age: 30 }
+ * ```
+ */
 export declare const parseDefault: <T, Nullable extends boolean | undefined, Value extends OpenAPIV3.SchemaObject>({ value, nullable, valibotSchema, context }: ParseDefaultArgs<T, Nullable, Value>) => ParseDefaultReturn<T, Nullable, Value>;
 export {};
 //# sourceMappingURL=parseDefault.d.ts.map

package/script/oas/_helpers/parseDefault.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseDefault.d.ts","sourceRoot":"","sources":["../../../src/oas/_helpers/parseDefault.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,KAAK,gBAAgB,CACnB,CAAC,EACD,QAAQ,SAAS,OAAO,GAAG,SAAS,EACpC,KAAK,SAAS,SAAS,CAAC,YAAY,IAClC;IACF,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,MAAM,CAAC,CAAA;IACnD,QAAQ,EAAE,QAAQ,CAAA;IAClB,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IACjC,OAAO,EAAE,YAAY,CAAA;CACtB,CAAA;AAED,KAAK,kBAAkB,CACrB,CAAC,EACD,QAAQ,SAAS,OAAO,GAAG,SAAS,EACpC,KAAK,SAAS,SAAS,CAAC,YAAY,IAClC;IACF,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,CAAA;IACrE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC,CAAA;CAChE,CAAA;AAED,eAAO,MAAM,YAAY,GACvB,CAAC,EACD,QAAQ,SAAS,OAAO,GAAG,SAAS,EACpC,KAAK,SAAS,SAAS,CAAC,YAAY,EACpC,6CAKC,gBAAgB,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAG,kBAAkB,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAgB9E,CAAA"}
+{"version":3,"file":"parseDefault.d.ts","sourceRoot":"","sources":["../../../src/oas/_helpers/parseDefault.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B;;;;;;GAMG;AACH,KAAK,gBAAgB,CACnB,CAAC,EACD,QAAQ,SAAS,OAAO,GAAG,SAAS,EACpC,KAAK,SAAS,SAAS,CAAC,YAAY,IAClC;IACF,+EAA+E;IAC/E,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,MAAM,CAAC,CAAA;IACnD,4CAA4C;IAC5C,QAAQ,EAAE,QAAQ,CAAA;IAClB,sDAAsD;IACtD,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;IACjC,uCAAuC;IACvC,OAAO,EAAE,YAAY,CAAA;CACtB,CAAA;AAED;;;;;;GAMG;AACH,KAAK,kBAAkB,CACrB,CAAC,EACD,QAAQ,SAAS,OAAO,GAAG,SAAS,EACpC,KAAK,SAAS,SAAS,CAAC,YAAY,IAClC;IACF,6CAA6C;IAC7C,OAAO,EAAE,QAAQ,SAAS,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,CAAC,GAAG,SAAS,CAAA;IACrE,8DAA8D;IAC9D,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC,CAAA;CAChE,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+HG;AACH,eAAO,MAAM,YAAY,GACvB,CAAC,EACD,QAAQ,SAAS,OAAO,GAAG,SAAS,EACpC,KAAK,SAAS,SAAS,CAAC,YAAY,EACpC,6CAKC,gBAAgB,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAG,kBAAkB,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAgB9E,CAAA"}

package/script/oas/_helpers/parseDefault.js

@@ -35,6 +35,134 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseDefault = void 0;
 const v = __importStar(require("valibot"));
+/**
+ * Parses and validates OpenAPI schema default values with type safety.
+ *
+ * This function extracts and validates default values from OpenAPI schema objects,
+ * ensuring they conform to the expected type and handling nullable schemas correctly.
+ * Invalid default values are removed and logged as warnings through the parse context.
+ *
+ * The function provides full type safety, with the return type reflecting whether
+ * null values are allowed based on the nullable parameter. This ensures that
+ * generated code maintains proper type constraints for default values.
+ *
+ * @template T - The expected type of the default value
+ * @template Nullable - Whether the schema allows null as a default
+ * @template Value - The OpenAPI schema object type
+ *
+ * @param args - Parsing configuration
+ * @returns Parsed default data with the validated default value and cleaned schema
+ *
+ * @example Basic string default parsing
+ * ```typescript
+ * import { parseDefault } from '@skmtc/core/oas/_helpers';
+ * import * as v from 'valibot';
+ *
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'string',
+ *     default: 'hello world',
+ *     minLength: 5
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.string(),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // 'hello world'
+ * console.log(result.value);   // { type: 'string', minLength: 5 }
+ * ```
+ *
+ * @example Nullable default value
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'string',
+ *     default: null,
+ *     format: 'email'
+ *   },
+ *   nullable: true,
+ *   valibotSchema: v.string(),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // null (valid for nullable schema)
+ * // Type: string | null | undefined
+ * ```
+ *
+ * @example Number default with constraints
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'number',
+ *     default: 42,
+ *     minimum: 0,
+ *     maximum: 100
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.number(),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // 42
+ * console.log(result.value);   // { type: 'number', minimum: 0, maximum: 100 }
+ * ```
+ *
+ * @example Invalid default handling
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'boolean',
+ *     default: 'not a boolean', // Invalid default
+ *     description: 'A boolean flag'
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.boolean(),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // undefined (invalid default removed)
+ * // Context will log a warning about the invalid default
+ * ```
+ *
+ * @example Array default value
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'array',
+ *     items: { type: 'string' },
+ *     default: ['item1', 'item2']
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.array(v.string()),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // ['item1', 'item2']
+ * ```
+ *
+ * @example Object default value
+ * ```typescript
+ * const result = parseDefault({
+ *   value: {
+ *     type: 'object',
+ *     properties: {
+ *       name: { type: 'string' },
+ *       age: { type: 'number' }
+ *     },
+ *     default: { name: 'John', age: 30 }
+ *   },
+ *   nullable: false,
+ *   valibotSchema: v.object({
+ *     name: v.string(),
+ *     age: v.number()
+ *   }),
+ *   context: parseContext
+ * });
+ *
+ * console.log(result.default); // { name: 'John', age: 30 }
+ * ```
+ */
 const parseDefault = ({ value, nullable, valibotSchema, context }) => {
     const { default: defaultValue, ...rest } = value;
     const parsedDefault = context.provisionalParse({