@skmtc/core 0.0.805 → 0.0.807

package/script/types/Method.js

@@ -34,6 +34,73 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isMethod = exports.methods = exports.method = exports.methodValuesNoTrace = exports.methodValues = void 0;
+/**
+ * @fileoverview HTTP Method System for SKMTC Core
+ *
+ * This module provides comprehensive HTTP method definitions and utilities for
+ * handling OpenAPI operations. It includes type-safe method definitions,
+ * validation utilities, and constants for all HTTP methods supported by
+ * the OpenAPI v3 specification.
+ *
+ * The module ensures type safety when working with HTTP methods throughout
+ * the SKMTC pipeline and provides utilities for method validation and processing.
+ *
+ * ## Key Features
+ *
+ * - **Complete Method Support**: All HTTP methods from OpenAPI v3 specification
+ * - **Type Safety**: Branded types and type guards for method handling
+ * - **Validation**: Runtime validation with Valibot integration
+ * - **Case Handling**: Proper case normalization for method strings
+ * - **Specification Compliance**: Full adherence to OpenAPI v3 method definitions
+ *
+ * @example Working with HTTP methods
+ * ```typescript
+ * import { Method, isMethod, methodValues } from '@skmtc/core/Method';
+ *
+ * // Type-safe method handling
+ * const method: Method = 'GET';
+ *
+ * // Validate unknown method strings
+ * const userInput = 'post';
+ * if (isMethod(userInput)) {
+ *   console.log(`Valid method: ${userInput}`); // TypeScript knows it's a Method
+ * }
+ *
+ * // List all supported methods
+ * console.log('Supported methods:', methodValues);
+ * ```
+ *
+ * @example Method validation in generators
+ * ```typescript
+ * import { isMethod, Method } from '@skmtc/core/Method';
+ *
+ * function processOperation(path: string, method: string, operation: any) {
+ *   if (!isMethod(method)) {
+ *     throw new Error(`Unsupported HTTP method: ${method}`);
+ *   }
+ *
+ *   // TypeScript now knows method is of type Method
+ *   return generateOperationCode(path, method, operation);
+ * }
+ * ```
+ *
+ * @example Case-insensitive method handling
+ * ```typescript
+ * import { normalizeMethod, isMethod } from '@skmtc/core/Method';
+ *
+ * function handleMethodString(methodStr: string) {
+ *   const normalized = methodStr.toLowerCase();
+ *
+ *   if (isMethod(normalized)) {
+ *     return processValidMethod(normalized);
+ *   } else {
+ *     throw new Error(`Invalid method: ${methodStr}`);
+ *   }
+ * }
+ * ```
+ *
+ * @module Method
+ */
 require("../_dnt.polyfills.js");
 const v = __importStar(require("valibot"));
 /**
@@ -41,6 +108,7 @@ const v = __importStar(require("valibot"));
  *
  * This constant array includes all HTTP methods that can be used
  * in OpenAPI path operations, as defined by the OpenAPI specification.
+ * All methods are in lowercase to match OpenAPI conventions.
  */
 exports.methodValues = [
     'get',

package/script/types/Preview.d.ts

@@ -1,3 +1,78 @@
+/**
+ * @fileoverview Preview and Mapping System for SKMTC Core
+ *
+ * This module provides comprehensive types and utilities for creating preview
+ * interfaces and mapping configurations for generated code. The preview system
+ * enables interactive demonstrations of generated APIs, forms, tables, and
+ * other UI components within development tools and documentation.
+ *
+ * The mapping system provides metadata about how OpenAPI operations and models
+ * translate to generated code, enabling rich tooling experiences and
+ * reverse-engineering capabilities.
+ *
+ * ## Key Features
+ *
+ * - **Interactive Previews**: Rich preview interfaces for generated components
+ * - **Source Mapping**: Traceability from generated code back to OpenAPI sources
+ * - **UI Grouping**: Organized grouping of related UI components (forms, tables, inputs)
+ * - **Generator Integration**: Deep integration with the generator pipeline
+ * - **Type Safety**: Comprehensive validation and type safety throughout
+ *
+ * @example Creating operation previews
+ * ```typescript
+ * import type { PreviewModule, OperationSource } from '@skmtc/core/Preview';
+ *
+ * const operationSource: OperationSource = {
+ *   type: 'operation',
+ *   generatorId: 'react-forms',
+ *   operationPath: '/users',
+ *   operationMethod: 'POST'
+ * };
+ *
+ * const preview: PreviewModule = {
+ *   title: 'Create User Form',
+ *   description: 'Interactive form for creating new users',
+ *   group: 'forms',
+ *   source: operationSource,
+ *   moduleName: 'CreateUserForm',
+ *   exportName: 'default'
+ * };
+ * ```
+ *
+ * @example Creating model previews
+ * ```typescript
+ * import type { PreviewModule, ModelSource } from '@skmtc/core/Preview';
+ *
+ * const modelSource: ModelSource = {
+ *   type: 'model',
+ *   generatorId: 'typescript-types',
+ *   refName: 'User'
+ * };
+ *
+ * const preview: PreviewModule = {
+ *   title: 'User Type Definition',
+ *   description: 'TypeScript interface for User model',
+ *   group: 'tables',
+ *   source: modelSource,
+ *   moduleName: 'UserTypes',
+ *   exportName: 'User'
+ * };
+ * ```
+ *
+ * @example Working with mappings
+ * ```typescript
+ * import type { MappingModule } from '@skmtc/core/Preview';
+ *
+ * const mapping: MappingModule = {
+ *   source: operationSource,
+ *   moduleName: 'UserApi',
+ *   exportName: 'createUser',
+ *   generatedPath: './src/generated/UserApi.ts'
+ * };
+ * ```
+ *
+ * @module Preview
+ */
 import "../_dnt.polyfills.js";
 import { type Method } from './Method.js';
 import * as v from 'valibot';

package/script/types/Preview.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Preview.d.ts","sourceRoot":"","sources":["../../src/types/Preview.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,EAAU,KAAK,MAAM,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,WAAW,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAExD,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,YAAY,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,YAAY,CAAA;IACnB,QAAQ,EAAE,OAAO,GAAG,WAAW,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,MAAM,EAAE,eAAe,GAAG,WAAW,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,MAAM,EAAE,eAAe,GAAG,WAAW,CAAA;CACtC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,YAAY,CAC1C;IACE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;IACtD,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;IAC/C,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;IACjD,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC,WAAW,CACrC;QACE,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC;QACjC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC;QAClC,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC;QACjC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC;QACnC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,SAAS,CAAC;QACpC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC;QAClC,CAAC,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,CAAC;QACrC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC;KACpC,EACD,SAAS,CACV,CAAA;CACF,EACD,SAAS,CAMT,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,YAAY,CACtC;IACE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAClD,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;IAC/C,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;CAC5C,EACD,SAAS,CAKT,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,aAAa,CAAC,YAAY,CAA6C,CAAA;AAEpG;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,aAAa,CAIvD,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,aAAa,CAMvD,CAAA;AAKF;;;;GAIG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAG3C,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAG3C,CAAA"}
+{"version":3,"file":"Preview.d.ts","sourceRoot":"","sources":["../../src/types/Preview.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0EG;AACH,OAAO,sBAAsB,CAAC;AAG9B,OAAO,EAAU,KAAK,MAAM,EAAE,MAAM,aAAa,CAAA;AACjD,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAE5B,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,WAAW,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;AAExD,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,YAAY,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,YAAY,CAAA;IACnB,QAAQ,EAAE,OAAO,GAAG,WAAW,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,MAAM,EAAE,eAAe,GAAG,WAAW,CAAA;CACtC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG;IACpB,MAAM,EAAE,aAAa,CAAA;IACrB,MAAM,EAAE,eAAe,GAAG,WAAW,CAAA;CACtC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,EAAE,CAAC,CAAC,YAAY,CAC1C;IACE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;IACtD,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;IAC/C,QAAQ,CAAC,aAAa,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;IACjD,QAAQ,CAAC,eAAe,EAAE,CAAC,CAAC,WAAW,CACrC;QACE,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC;QACjC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC;QAClC,CAAC,CAAC,aAAa,CAAC,KAAK,EAAE,SAAS,CAAC;QACjC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC;QACnC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,SAAS,CAAC;QACpC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,SAAS,CAAC;QAClC,CAAC,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,CAAC;QACrC,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC;KACpC,EACD,SAAS,CACV,CAAA;CACF,EACD,SAAS,CAMT,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,CAAC,CAAC,YAAY,CACtC;IACE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAClD,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;IAC/C,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;CAC5C,EACD,SAAS,CAKT,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,CAAC,CAAC,aAAa,CAAC,YAAY,CAA6C,CAAA;AAEpG;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,aAAa,CAIvD,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,aAAa,CAMvD,CAAA;AAKF;;;;GAIG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAG3C,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,OAAO,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAG3C,CAAA"}

package/script/types/Preview.js

@@ -34,6 +34,81 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapping = exports.preview = exports.mappingModule = exports.previewModule = exports.previewGroup = exports.modelSource = exports.operationSource = void 0;
+/**
+ * @fileoverview Preview and Mapping System for SKMTC Core
+ *
+ * This module provides comprehensive types and utilities for creating preview
+ * interfaces and mapping configurations for generated code. The preview system
+ * enables interactive demonstrations of generated APIs, forms, tables, and
+ * other UI components within development tools and documentation.
+ *
+ * The mapping system provides metadata about how OpenAPI operations and models
+ * translate to generated code, enabling rich tooling experiences and
+ * reverse-engineering capabilities.
+ *
+ * ## Key Features
+ *
+ * - **Interactive Previews**: Rich preview interfaces for generated components
+ * - **Source Mapping**: Traceability from generated code back to OpenAPI sources
+ * - **UI Grouping**: Organized grouping of related UI components (forms, tables, inputs)
+ * - **Generator Integration**: Deep integration with the generator pipeline
+ * - **Type Safety**: Comprehensive validation and type safety throughout
+ *
+ * @example Creating operation previews
+ * ```typescript
+ * import type { PreviewModule, OperationSource } from '@skmtc/core/Preview';
+ *
+ * const operationSource: OperationSource = {
+ *   type: 'operation',
+ *   generatorId: 'react-forms',
+ *   operationPath: '/users',
+ *   operationMethod: 'POST'
+ * };
+ *
+ * const preview: PreviewModule = {
+ *   title: 'Create User Form',
+ *   description: 'Interactive form for creating new users',
+ *   group: 'forms',
+ *   source: operationSource,
+ *   moduleName: 'CreateUserForm',
+ *   exportName: 'default'
+ * };
+ * ```
+ *
+ * @example Creating model previews
+ * ```typescript
+ * import type { PreviewModule, ModelSource } from '@skmtc/core/Preview';
+ *
+ * const modelSource: ModelSource = {
+ *   type: 'model',
+ *   generatorId: 'typescript-types',
+ *   refName: 'User'
+ * };
+ *
+ * const preview: PreviewModule = {
+ *   title: 'User Type Definition',
+ *   description: 'TypeScript interface for User model',
+ *   group: 'tables',
+ *   source: modelSource,
+ *   moduleName: 'UserTypes',
+ *   exportName: 'User'
+ * };
+ * ```
+ *
+ * @example Working with mappings
+ * ```typescript
+ * import type { MappingModule } from '@skmtc/core/Preview';
+ *
+ * const mapping: MappingModule = {
+ *   source: operationSource,
+ *   moduleName: 'UserApi',
+ *   exportName: 'createUser',
+ *   generatedPath: './src/generated/UserApi.ts'
+ * };
+ * ```
+ *
+ * @module Preview
+ */
 require("../_dnt.polyfills.js");
 const Method_js_1 = require("./Method.js");
 const v = __importStar(require("valibot"));

package/script/types/RefName.d.ts

@@ -1,3 +1,73 @@
+/**
+ * @fileoverview Reference Name System for SKMTC Core
+ *
+ * This module provides a type-safe reference name system for identifying
+ * OpenAPI schema components throughout the SKMTC pipeline. Reference names
+ * are branded types that ensure schema identifiers are handled safely and
+ * prevent accidental mixing with regular strings.
+ *
+ * The reference name system is crucial for maintaining type safety when
+ * working with OpenAPI component references, schema lookups, and cross-references
+ * between different parts of the generated code.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Branded types prevent string confusion and improve code reliability
+ * - **Schema Integration**: Direct mapping to OpenAPI components.schemas keys
+ * - **Reference Tracking**: Safe handling of schema references throughout generation
+ * - **IDE Support**: Enhanced IntelliSense and error detection in development
+ * - **Validation**: Compile-time validation of schema reference usage
+ *
+ * @example Basic reference name usage
+ * ```typescript
+ * import type { RefName } from '@skmtc/core/RefName';
+ *
+ * // Create a reference name (typically done by the parser)
+ * const userRef: RefName = 'User' as RefName;
+ * const productRef: RefName = 'Product' as RefName;
+ *
+ * // TypeScript prevents mixing with regular strings
+ * const regularString = 'User';
+ * // const invalid: RefName = regularString; // Type error!
+ * ```
+ *
+ * @example Using reference names in generators
+ * ```typescript
+ * import type { RefName } from '@skmtc/core/RefName';
+ *
+ * function generateModelImport(refName: RefName): string {
+ *   return `import type { ${refName} } from './models/${refName}';`;
+ * }
+ *
+ * function generateModelReference(refName: RefName): string {
+ *   return `#/components/schemas/${refName}`;
+ * }
+ *
+ * // Usage with type safety
+ * const userRef: RefName = 'User' as RefName;
+ * const importStatement = generateModelImport(userRef);
+ * const schemaRef = generateModelReference(userRef);
+ * ```
+ *
+ * @example Reference name validation
+ * ```typescript
+ * import type { RefName } from '@skmtc/core/RefName';
+ *
+ * function isValidRefName(value: string): value is RefName {
+ *   // Validate that the string is a valid schema reference name
+ *   return /^[A-Za-z][A-Za-z0-9_]*$/.test(value) && value.length > 0;
+ * }
+ *
+ * function safeCreateRefName(value: string): RefName | null {
+ *   if (isValidRefName(value)) {
+ *     return value as RefName;
+ *   }
+ *   return null;
+ * }
+ * ```
+ *
+ * @module RefName
+ */
 import "../_dnt.polyfills.js";
 import type { Brand } from './Brand.js';
 /**

package/script/types/RefName.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RefName.d.ts","sourceRoot":"","sources":["../../src/types/RefName.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA"}
+{"version":3,"file":"RefName.d.ts","sourceRoot":"","sources":["../../src/types/RefName.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AACH,OAAO,sBAAsB,CAAC;AAG9B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4DG;AACH,MAAM,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA"}

package/script/types/RefName.js

@@ -1,3 +1,73 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @fileoverview Reference Name System for SKMTC Core
+ *
+ * This module provides a type-safe reference name system for identifying
+ * OpenAPI schema components throughout the SKMTC pipeline. Reference names
+ * are branded types that ensure schema identifiers are handled safely and
+ * prevent accidental mixing with regular strings.
+ *
+ * The reference name system is crucial for maintaining type safety when
+ * working with OpenAPI component references, schema lookups, and cross-references
+ * between different parts of the generated code.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Branded types prevent string confusion and improve code reliability
+ * - **Schema Integration**: Direct mapping to OpenAPI components.schemas keys
+ * - **Reference Tracking**: Safe handling of schema references throughout generation
+ * - **IDE Support**: Enhanced IntelliSense and error detection in development
+ * - **Validation**: Compile-time validation of schema reference usage
+ *
+ * @example Basic reference name usage
+ * ```typescript
+ * import type { RefName } from '@skmtc/core/RefName';
+ *
+ * // Create a reference name (typically done by the parser)
+ * const userRef: RefName = 'User' as RefName;
+ * const productRef: RefName = 'Product' as RefName;
+ *
+ * // TypeScript prevents mixing with regular strings
+ * const regularString = 'User';
+ * // const invalid: RefName = regularString; // Type error!
+ * ```
+ *
+ * @example Using reference names in generators
+ * ```typescript
+ * import type { RefName } from '@skmtc/core/RefName';
+ *
+ * function generateModelImport(refName: RefName): string {
+ *   return `import type { ${refName} } from './models/${refName}';`;
+ * }
+ *
+ * function generateModelReference(refName: RefName): string {
+ *   return `#/components/schemas/${refName}`;
+ * }
+ *
+ * // Usage with type safety
+ * const userRef: RefName = 'User' as RefName;
+ * const importStatement = generateModelImport(userRef);
+ * const schemaRef = generateModelReference(userRef);
+ * ```
+ *
+ * @example Reference name validation
+ * ```typescript
+ * import type { RefName } from '@skmtc/core/RefName';
+ *
+ * function isValidRefName(value: string): value is RefName {
+ *   // Validate that the string is a valid schema reference name
+ *   return /^[A-Za-z][A-Za-z0-9_]*$/.test(value) && value.length > 0;
+ * }
+ *
+ * function safeCreateRefName(value: string): RefName | null {
+ *   if (isValidRefName(value)) {
+ *     return value as RefName;
+ *   }
+ *   return null;
+ * }
+ * ```
+ *
+ * @module RefName
+ */
 require("../_dnt.polyfills.js");

package/script/types/Settings.d.ts

@@ -1,3 +1,53 @@
+/**
+ * @fileoverview SKMTC Core Settings and Configuration
+ *
+ * This module provides comprehensive configuration types and schemas for the SKMTC
+ * code generation pipeline. It defines settings for generators, modules, packages,
+ * and runtime behavior that control how OpenAPI documents are processed and what
+ * artifacts are generated.
+ *
+ * ## Key Features
+ *
+ * - **Generator Configuration**: Settings for individual code generators
+ * - **Module Management**: Package and module resolution configuration
+ * - **Runtime Settings**: Control generation behavior and output preferences
+ * - **Enrichment Integration**: Support for UI enrichment metadata
+ * - **Type Safety**: Comprehensive Valibot validation for all configuration
+ *
+ * @example Basic generator settings
+ * ```typescript
+ * import type { Settings } from '@skmtc/core/Settings';
+ *
+ * const settings: Settings = {
+ *   generators: {
+ *     'my-generator': {
+ *       enabled: true,
+ *       config: {
+ *         outputPath: './generated',
+ *         typescript: true
+ *       }
+ *     }
+ *   },
+ *   enrichments: {},
+ *   filters: {
+ *     includePaths: ['/api/v1/*'],
+ *     excludeMethods: ['OPTIONS']
+ *   }
+ * };
+ * ```
+ *
+ * @example Module package configuration
+ * ```typescript
+ * import type { ModulePackage } from '@skmtc/core/Settings';
+ *
+ * const moduleConfig: ModulePackage = {
+ *   rootPath: './src/generated',
+ *   moduleName: '@my-org/api-client'
+ * };
+ * ```
+ *
+ * @module Settings
+ */
 import "../_dnt.polyfills.js";
 import { type GeneratorEnrichments } from './Enrichments.js';
 import * as v from 'valibot';

package/script/types/Settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Settings.d.ts","sourceRoot":"","sources":["../../src/types/Settings.ts"],"names":[],"mappings":"AAAA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,EAAwB,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAClF,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAU,KAAK,MAAM,EAAE,MAAM,aAAa,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,aAAa,CAGvD,CAAA;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAA;IAChB,uDAAuD;IACvD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,CAAC,aAAa,CAAC,SAAS,CAAyC,CAAA;AAE1F;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC,cAAc,CAAmC,CAAA;AAE9F;;;;GAIG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CAA6C,CAAA;AAIhG;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC,cAAc,CAKzD,CAAA;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;AAEhD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;AAEjD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAEtD;;;;;GAKG;AACH,MAAM,MAAM,IAAI,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAA;IAC1B,kDAAkD;IAClD,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,sDAAsD;IACtD,IAAI,CAAC,EAAE,IAAI,EAAE,CAAA;CACd,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,0DAA0D;IAC1D,QAAQ,EAAE,cAAc,CAAA;CACzB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAG/D,CAAA"}
+{"version":3,"file":"Settings.d.ts","sourceRoot":"","sources":["../../src/types/Settings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,OAAO,sBAAsB,CAAC;AAG9B,OAAO,EAAwB,KAAK,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAClF,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAC5B,OAAO,EAAU,KAAK,MAAM,EAAE,MAAM,aAAa,CAAA;AAEjD;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,CAAC,CAAC,aAAa,CAAC,aAAa,CAGvD,CAAA;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iDAAiD;IACjD,QAAQ,EAAE,MAAM,CAAA;IAChB,uDAAuD;IACvD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,EAAE,CAAC,CAAC,aAAa,CAAC,SAAS,CAAyC,CAAA;AAE1F;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC,cAAc,CAAmC,CAAA;AAE9F;;;;GAIG;AACH,eAAO,MAAM,UAAU,EAAE,CAAC,CAAC,aAAa,CAAC,UAAU,CAA6C,CAAA;AAIhG;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,CAAC,CAAC,aAAa,CAAC,cAAc,CAKzD,CAAA;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;AAEhD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;AAEjD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAEtD;;;;;GAKG;AACH,MAAM,MAAM,IAAI,GAAG,cAAc,GAAG,UAAU,GAAG,MAAM,CAAA;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAA;IAC1B,kDAAkD;IAClD,WAAW,CAAC,EAAE,oBAAoB,CAAA;IAClC,sDAAsD;IACtD,IAAI,CAAC,EAAE,IAAI,EAAE,CAAA;CACd,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,0DAA0D;IAC1D,QAAQ,EAAE,cAAc,CAAA;CACzB,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,aAAa,CAAC,iBAAiB,CAG/D,CAAA"}

package/script/types/Settings.js

@@ -34,6 +34,56 @@ var __importStar = (this && this.__importStar) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.skmtcClientConfig = exports.clientSettings = exports.skipModels = exports.skipOperations = exports.skipPaths = exports.modulePackage = void 0;
+/**
+ * @fileoverview SKMTC Core Settings and Configuration
+ *
+ * This module provides comprehensive configuration types and schemas for the SKMTC
+ * code generation pipeline. It defines settings for generators, modules, packages,
+ * and runtime behavior that control how OpenAPI documents are processed and what
+ * artifacts are generated.
+ *
+ * ## Key Features
+ *
+ * - **Generator Configuration**: Settings for individual code generators
+ * - **Module Management**: Package and module resolution configuration
+ * - **Runtime Settings**: Control generation behavior and output preferences
+ * - **Enrichment Integration**: Support for UI enrichment metadata
+ * - **Type Safety**: Comprehensive Valibot validation for all configuration
+ *
+ * @example Basic generator settings
+ * ```typescript
+ * import type { Settings } from '@skmtc/core/Settings';
+ *
+ * const settings: Settings = {
+ *   generators: {
+ *     'my-generator': {
+ *       enabled: true,
+ *       config: {
+ *         outputPath: './generated',
+ *         typescript: true
+ *       }
+ *     }
+ *   },
+ *   enrichments: {},
+ *   filters: {
+ *     includePaths: ['/api/v1/*'],
+ *     excludeMethods: ['OPTIONS']
+ *   }
+ * };
+ * ```
+ *
+ * @example Module package configuration
+ * ```typescript
+ * import type { ModulePackage } from '@skmtc/core/Settings';
+ *
+ * const moduleConfig: ModulePackage = {
+ *   rootPath: './src/generated',
+ *   moduleName: '@my-org/api-client'
+ * };
+ * ```
+ *
+ * @module Settings
+ */
 require("../_dnt.polyfills.js");
 const Enrichments_js_1 = require("./Enrichments.js");
 const v = __importStar(require("valibot"));