@skmtc/core 0.0.800 → 0.0.803

package/script/dsl/model/toModelBase.js

@@ -38,6 +38,52 @@ const GeneratorKeys_js_1 = require("../../types/GeneratorKeys.js");
 const ModelBase_js_1 = require("./ModelBase.js");
 const v = __importStar(require("valibot"));
 const lodash_es_1 = require("lodash-es");
+/**
+ * Creates a base model class constructor for generating type-safe model artifacts.
+ *
+ * This factory function creates a specialized ModelBase class that implements
+ * the provided configuration for identifier generation, export paths, and
+ * enrichment handling. The resulting class can be instantiated to generate
+ * model artifacts from OpenAPI schemas.
+ *
+ * @template EnrichmentType - Type of enrichments to apply to generated models
+ * @param config - Configuration defining the model generation behavior
+ * @returns Constructor function for creating model instances
+ *
+ * @example Creating a TypeScript interface generator
+ * ```typescript
+ * import { toModelBase } from '@skmtc/core';
+ *
+ * const TypeScriptModelBase = toModelBase({
+ *   id: 'typescript-interfaces',
+ *   toIdentifier: (refName) => new Identifier(pascalCase(refName)),
+ *   toExportPath: (refName) => `./models/${kebabCase(refName)}.ts`,
+ *   toEnrichmentSchema: () => v.object({
+ *     includeValidation: v.optional(v.boolean()),
+ *     readonly: v.optional(v.boolean())
+ *   })
+ * });
+ *
+ * class TypeScriptModelGenerator extends TypeScriptModelBase {
+ *   generate() {
+ *     const enrichments = this.enrichments;
+ *     const interface = generateInterface(this.schema, {
+ *       readonly: enrichments?.readonly ?? false
+ *     });
+ *     this.register({ file: this.createFile(interface) });
+ *   }
+ * }
+ * ```
+ *
+ * @example Creating a validation schema generator
+ * ```typescript
+ * const ValidationModelBase = toModelBase({
+ *   id: 'zod-schemas',
+ *   toIdentifier: (refName) => new Identifier(`${pascalCase(refName)}Schema`),
+ *   toExportPath: (refName) => `./schemas/${kebabCase(refName)}.schema.ts`
+ * });
+ * ```
+ */
 const toModelBase = (config) => {
     var _a;
     return _a = class extends ModelBase_js_1.ModelBase {

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

@@ -11,6 +11,69 @@ type ToModelEntryArgs<EnrichmentType = undefined, Acc = void> = {
     toMappingModule?: ({ context, refName }: ToModelMappingArgs) => MappingModule;
     toEnrichmentRequest?: <RequestedEnrichment extends EnrichmentType>(refName: RefName) => EnrichmentRequest<RequestedEnrichment> | undefined;
 };
+/**
+ * Creates a model transformation entry for the SKMTC pipeline.
+ *
+ * This function creates a standardized model entry that defines how to transform
+ * OpenAPI schema objects into model artifacts. Model entries are used by the
+ * generation pipeline to process schemas and create output files.
+ *
+ * The resulting entry includes transformation logic, preview generation,
+ * mapping generation, enrichment handling, and schema validation.
+ *
+ * @template EnrichmentType - Type of enrichments that can be applied to models
+ * @template Acc - Accumulator type for the transformation process
+ * @param args - Configuration for the model entry
+ * @param args.id - Unique identifier for this model entry
+ * @param args.transform - Function to transform schemas into artifacts
+ * @param args.toPreviewModule - Optional function to generate preview modules
+ * @param args.toMappingModule - Optional function to generate mapping modules
+ * @param args.toEnrichmentSchema - Optional function to provide enrichment validation
+ * @param args.toEnrichmentRequest - Optional function to request enrichments
+ * @returns Model entry object for use in the generation pipeline
+ *
+ * @example Basic model entry
+ * ```typescript
+ * import { toModelEntry } from '@skmtc/core';
+ *
+ * const typeScriptModelEntry = toModelEntry({
+ *   id: 'typescript-models',
+ *   transform: ({ context, refName, acc }) => {
+ *     const schema = context.getSchemaByRefName(refName);
+ *     const tsInterface = generateTypeScriptInterface(schema);
+ *     return { ...acc, [refName]: tsInterface };
+ *   },
+ *   toPreviewModule: ({ context, refName }) => ({
+ *     group: 'forms',
+ *     title: `${refName} Model`,
+ *     description: 'Generated TypeScript interface'
+ *   })
+ * });
+ * ```
+ *
+ * @example Model entry with enrichments
+ * ```typescript
+ * const validationModelEntry = toModelEntry({
+ *   id: 'validation-schemas',
+ *   transform: ({ context, refName, acc }) => {
+ *     const enrichments = context.getEnrichments(refName);
+ *     const schema = context.getSchemaByRefName(refName);
+ *     const validationSchema = generateValidationSchema(schema, {
+ *       strict: enrichments?.strict ?? false
+ *     });
+ *     return { ...acc, [refName]: validationSchema };
+ *   },
+ *   toEnrichmentSchema: () => v.object({
+ *     strict: v.optional(v.boolean()),
+ *     nullable: v.optional(v.boolean())
+ *   }),
+ *   toEnrichmentRequest: (refName) => ({
+ *     path: `models.${refName}`,
+ *     schema: enrichmentSchema
+ *   })
+ * });
+ * ```
+ */
 export declare const toModelEntry: <EnrichmentType = undefined, Acc = void>({ id, transform, toPreviewModule, toMappingModule, toEnrichmentSchema, toEnrichmentRequest }: ToModelEntryArgs<EnrichmentType, Acc>) => {
     id: string;
     type: "model";

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

@@ -1 +1 @@
-{"version":3,"file":"toModelEntry.d.ts","sourceRoot":"","sources":["../../../src/dsl/model/toModelEntry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAClG,OAAO,KAAK,KAAK,CAAC,MAAM,SAAS,CAAA;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAE1E,KAAK,gBAAgB,CAAC,cAAc,GAAG,SAAS,EAAE,GAAG,GAAG,IAAI,IAAI;IAC9D,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,kBAAkB,CAAC,GAAG,CAAC,KAAK,GAAG,CAAA;IACtE,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;IAC1D,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,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,SAAS,cAAc,EAC/D,OAAO,EAAE,OAAO,KACb,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;CACxD,CAAA;AAED,eAAO,MAAM,YAAY,GAAI,cAAc,GAAG,SAAS,EAAE,GAAG,GAAG,IAAI,EAAE,8FAOlE,gBAAgB,CAAC,cAAc,EAAE,GAAG,CAAC,KAAG;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,kBAAkB,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC;IACvE,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,wBAAwB,KAAK,aAAa,CAAC;IACpF,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,kBAAkB,KAAK,aAAa,CAAC;IAC9E,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAC3D,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,SAAS,cAAc,EAC/D,OAAO,EAAE,OAAO,KACb,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;CAWzD,CAAA"}
+{"version":3,"file":"toModelEntry.d.ts","sourceRoot":"","sources":["../../../src/dsl/model/toModelEntry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACzE,OAAO,KAAK,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAClG,OAAO,KAAK,KAAK,CAAC,MAAM,SAAS,CAAA;AACjC,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAE1E,KAAK,gBAAgB,CAAC,cAAc,GAAG,SAAS,EAAE,GAAG,GAAG,IAAI,IAAI;IAC9D,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,kBAAkB,CAAC,GAAG,CAAC,KAAK,GAAG,CAAA;IACtE,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,CAAA;IAC1D,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,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,SAAS,cAAc,EAC/D,OAAO,EAAE,OAAO,KACb,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAA;CACxD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,eAAO,MAAM,YAAY,GAAI,cAAc,GAAG,SAAS,EAAE,GAAG,GAAG,IAAI,EAAE,8FAOlE,gBAAgB,CAAC,cAAc,EAAE,GAAG,CAAC,KAAG;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,kBAAkB,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC;IACvE,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,wBAAwB,KAAK,aAAa,CAAC;IACpF,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,kBAAkB,KAAK,aAAa,CAAC;IAC9E,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAC3D,mBAAmB,CAAC,EAAE,CAAC,mBAAmB,SAAS,cAAc,EAC/D,OAAO,EAAE,OAAO,KACb,iBAAiB,CAAC,mBAAmB,CAAC,GAAG,SAAS,CAAC;CAWzD,CAAA"}

package/script/dsl/model/toModelEntry.js

@@ -1,6 +1,69 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toModelEntry = void 0;
+/**
+ * Creates a model transformation entry for the SKMTC pipeline.
+ *
+ * This function creates a standardized model entry that defines how to transform
+ * OpenAPI schema objects into model artifacts. Model entries are used by the
+ * generation pipeline to process schemas and create output files.
+ *
+ * The resulting entry includes transformation logic, preview generation,
+ * mapping generation, enrichment handling, and schema validation.
+ *
+ * @template EnrichmentType - Type of enrichments that can be applied to models
+ * @template Acc - Accumulator type for the transformation process
+ * @param args - Configuration for the model entry
+ * @param args.id - Unique identifier for this model entry
+ * @param args.transform - Function to transform schemas into artifacts
+ * @param args.toPreviewModule - Optional function to generate preview modules
+ * @param args.toMappingModule - Optional function to generate mapping modules
+ * @param args.toEnrichmentSchema - Optional function to provide enrichment validation
+ * @param args.toEnrichmentRequest - Optional function to request enrichments
+ * @returns Model entry object for use in the generation pipeline
+ *
+ * @example Basic model entry
+ * ```typescript
+ * import { toModelEntry } from '@skmtc/core';
+ *
+ * const typeScriptModelEntry = toModelEntry({
+ *   id: 'typescript-models',
+ *   transform: ({ context, refName, acc }) => {
+ *     const schema = context.getSchemaByRefName(refName);
+ *     const tsInterface = generateTypeScriptInterface(schema);
+ *     return { ...acc, [refName]: tsInterface };
+ *   },
+ *   toPreviewModule: ({ context, refName }) => ({
+ *     group: 'forms',
+ *     title: `${refName} Model`,
+ *     description: 'Generated TypeScript interface'
+ *   })
+ * });
+ * ```
+ *
+ * @example Model entry with enrichments
+ * ```typescript
+ * const validationModelEntry = toModelEntry({
+ *   id: 'validation-schemas',
+ *   transform: ({ context, refName, acc }) => {
+ *     const enrichments = context.getEnrichments(refName);
+ *     const schema = context.getSchemaByRefName(refName);
+ *     const validationSchema = generateValidationSchema(schema, {
+ *       strict: enrichments?.strict ?? false
+ *     });
+ *     return { ...acc, [refName]: validationSchema };
+ *   },
+ *   toEnrichmentSchema: () => v.object({
+ *     strict: v.optional(v.boolean()),
+ *     nullable: v.optional(v.boolean())
+ *   }),
+ *   toEnrichmentRequest: (refName) => ({
+ *     path: `models.${refName}`,
+ *     schema: enrichmentSchema
+ *   })
+ * });
+ * ```
+ */
 const toModelEntry = ({ id, transform, toPreviewModule, toMappingModule, toEnrichmentSchema, toEnrichmentRequest }) => {
     return {
         id,

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

@@ -9,9 +9,9 @@ import type { Definition } from '../Definition.js';
 import type { Inserted } from '../Inserted.js';
 import type { ModelInsertable } from '../model/types.js';
 import type { RefName } from '../../types/RefName.js';
-import { OasSchema } from '../../oas/schema/Schema.js';
-import { OasRef } from '../../oas/ref/Ref.js';
-import { OasVoid } from '../../oas/void/Void.js';
+import type { OasSchema } from '../../oas/schema/Schema.js';
+import type { OasRef } from '../../oas/ref/Ref.js';
+import type { OasVoid } from '../../oas/void/Void.js';
 /**
  * Constructor arguments for {@link OperationBase}.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"OperationBase.d.ts","sourceRoot":"","sources":["../../../src/dsl/operation/OperationBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EAEf,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,kCAAkC,CAAA;AACzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAElD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAA;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAEhD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,cAAc,GAAG,SAAS,IAAI;IAC1D,yEAAyE;IACzE,OAAO,EAAE,eAAe,CAAA;IACxB,0EAA0E;IAC1E,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,gDAAgD;IAChD,YAAY,EAAE,YAAY,CAAA;IAC1B,4CAA4C;IAC5C,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuGG;AACH,qBAAa,aAAa,CAAC,cAAc,GAAG,SAAS,CAAE,SAAQ,WAAW;IACxE,0EAA0E;IAC1E,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IAEzC,4CAA4C;IAC5C,SAAS,EAAE,YAAY,CAAA;IAEvB,oDAAoD;IAC3C,YAAY,EAAE,YAAY,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;;OAqBG;gBACS,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,iBAAiB,CAAC,cAAc,CAAC;IAQ7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,cAAc,GAAG,SAAS,EAClE,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,EAClD,SAAS,EAAE,YAAY,EACvB,OAAO,GAAE,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,UAAU,CAAM,GAC9D,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC;IAQvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,WAAW,CAAC,CAAC,SAAS,cAAc,EAAE,cAAc,GAAG,SAAS,EAC9D,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,EAC9C,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,UAAU,CAAM,GAC1D,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC;IAQvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,qBAAqB,CACnB,CAAC,SAAS,cAAc,EACxB,MAAM,SAAS,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,EACrD,cAAc,GAAG,SAAS,EAE1B,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,EAC9C,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC,EACpF,OAAO,GAAE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,UAAU,CAAM,GAC1D,2BAA2B,CAAC,CAAC,EAAE,MAAM,CAAC;IAYzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAAE,EAC1C,UAAU,EACV,KAAK,EACL,QAAQ,EACT,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IASpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACM,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;CAMhD"}
+{"version":3,"file":"OperationBase.d.ts","sourceRoot":"","sources":["../../../src/dsl/operation/OperationBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,EACV,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACtB,kBAAkB,EAClB,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,kCAAkC,CAAA;AACzC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACxD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAErD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,CAAC,cAAc,GAAG,SAAS,IAAI;IAC1D,yEAAyE;IACzE,OAAO,EAAE,eAAe,CAAA;IACxB,0EAA0E;IAC1E,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,gDAAgD;IAChD,YAAY,EAAE,YAAY,CAAA;IAC1B,4CAA4C;IAC5C,SAAS,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuGG;AACH,qBAAa,aAAa,CAAC,cAAc,GAAG,SAAS,CAAE,SAAQ,WAAW;IACxE,0EAA0E;IAC1E,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IAEzC,4CAA4C;IAC5C,SAAS,EAAE,YAAY,CAAA;IAEvB,oDAAoD;IAC3C,YAAY,EAAE,YAAY,CAAA;IAEnC;;;;;;;;;;;;;;;;;;;;;OAqBG;gBACS,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE,iBAAiB,CAAC,cAAc,CAAC;IAQ7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,cAAc,GAAG,SAAS,EAClE,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,EAClD,SAAS,EAAE,YAAY,EACvB,OAAO,GAAE,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,EAAE,UAAU,CAAM,GAC9D,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC;IAQvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACH,WAAW,CAAC,CAAC,SAAS,cAAc,EAAE,cAAc,GAAG,SAAS,EAC9D,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,EAC9C,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,UAAU,CAAM,GAC1D,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC;IAQvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACH,qBAAqB,CACnB,CAAC,SAAS,cAAc,EACxB,MAAM,SAAS,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,EACrD,cAAc,GAAG,SAAS,EAE1B,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,EAC9C,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,iBAAiB,CAAC,EACpF,OAAO,GAAE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,UAAU,CAAM,GAC1D,2BAA2B,CAAC,CAAC,EAAE,MAAM,CAAC;IAYzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAAE,EAC1C,UAAU,EACV,KAAK,EACL,QAAQ,EACT,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,iBAAiB,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IASpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACM,QAAQ,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;CAMhD"}

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

@@ -12,17 +12,101 @@ type CreateOperationArgs<V extends GeneratedValue, T extends GenerationType, Enr
     destinationPath?: string;
     noExport?: boolean;
 };
+/**
+ * Driver class for generating operation-based artifacts from OpenAPI operations.
+ *
+ * The `OperationDriver` manages the transformation of OpenAPI operation objects
+ * into code artifacts, handling path generation, identifier resolution, and
+ * definition management. It serves as the core orchestrator for operation-based
+ * code generation in the SKMTC pipeline.
+ *
+ * @template V - Type of generated values produced by this driver
+ * @template T - Type of generation strategy (e.g., 'function', 'class', 'hook')
+ * @template EnrichmentType - Type of enrichments that can be applied
+ *
+ * @example Basic usage in an operation generator
+ * ```typescript
+ * class APIClientGenerator extends OperationBase {
+ *   generate() {
+ *     const driver = new OperationDriver({
+ *       context: this.context,
+ *       insertable: this,
+ *       operation: this.operation,
+ *       generation: 'function'
+ *     });
+ *
+ *     const functionCode = driver.definition.toValueString();
+ *     const file = this.createFile(functionCode);
+ *     this.register({ file });
+ *   }
+ * }
+ * ```
+ */
 export declare class OperationDriver<V extends GeneratedValue, T extends GenerationType, EnrichmentType = undefined> {
+    /** The generation context providing access to OAS objects and utilities */
     context: GenerateContext;
+    /** The insertable object that provides generation configuration */
     insertable: OperationInsertable<V, EnrichmentType>;
+    /** The OpenAPI operation object being processed */
     operation: OasOperation;
+    /** Content settings for customizing generation behavior */
     settings: ContentSettings<EnrichmentType>;
+    /** Optional custom destination path for generated files */
     destinationPath?: string;
+    /** The generated definition containing the transformed operation */
     definition: GeneratedDefinition<V, T>;
+    /** Whether to exclude this operation from exports */
     noExport?: boolean;
+    /**
+     * Creates a new OperationDriver instance.
+     *
+     * @param args - Configuration for the operation driver
+     * @param args.context - Generation context
+     * @param args.insertable - Insertable providing generation configuration
+     * @param args.operation - OpenAPI operation to process
+     * @param args.generation - Optional generation type
+     * @param args.destinationPath - Optional custom destination path
+     * @param args.noExport - Whether to exclude from exports
+     */
     constructor({ context, insertable, operation, generation, destinationPath, noExport }: CreateOperationArgs<V, T, EnrichmentType>);
+    /**
+     * Applies generation configuration to create the operation definition.
+     *
+     * This method handles the core generation logic for operations, including
+     * identifier resolution, export path management, and import registration
+     * for cross-file dependencies.
+     *
+     * @template T - The generation type
+     * @param args - Apply configuration arguments
+     * @param args.generation - Optional generation type (unused currently)
+     * @param args.destinationPath - Optional destination path for imports
+     * @returns Generated definition for the operation
+     */
     private apply;
+    /**
+     * Retrieves or creates a definition for the operation.
+     *
+     * This method first checks for cached definitions to avoid duplicate generation,
+     * then creates a new definition if none exists. It handles the complete operation
+     * transformation process including schema resolution and value generation.
+     *
+     * @param args - Definition retrieval arguments
+     * @param args.identifier - The identifier for the definition
+     * @param args.exportPath - The export path for the definition
+     * @returns Operation definition instance
+     */
     private getDefinition;
+    /**
+     * Type guard to verify a definition matches the expected generated value type.
+     *
+     * This method performs type narrowing to ensure a cached definition is compatible
+     * with the current generation requirements, including export path validation.
+     *
+     * @template V - The expected generated value type
+     * @param definition - The definition to verify (may be undefined)
+     * @param exportPath - Expected export path for validation
+     * @returns True if definition matches expected type and constraints
+     */
     private affirmDefinition;
 }
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"OperationDriver.d.ts","sourceRoot":"","sources":["../../../src/dsl/operation/OperationDriver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAI5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACxF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAEvE,KAAK,mBAAmB,CACtB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,cAAc,EACxB,cAAc,GAAG,SAAS,IACxB;IACF,OAAO,EAAE,eAAe,CAAA;IACxB,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;IAClD,SAAS,EAAE,YAAY,CAAA;IACvB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAYD,qBAAa,eAAe,CAC1B,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,cAAc,EACxB,cAAc,GAAG,SAAS;IAE1B,OAAO,EAAE,eAAe,CAAA;IACxB,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;IAClD,SAAS,EAAE,YAAY,CAAA;IACvB,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAA;gBACN,EACV,OAAO,EACP,UAAU,EACV,SAAS,EACT,UAAU,EACV,eAAe,EACf,QAAQ,EACT,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAc5C,OAAO,CAAC,KAAK;IAuBb,OAAO,CAAC,aAAa;IA+BrB,OAAO,CAAC,gBAAgB;CAqBzB"}
+{"version":3,"file":"OperationDriver.d.ts","sourceRoot":"","sources":["../../../src/dsl/operation/OperationDriver.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAI5D,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AACxF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAA;AAEnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAEvE,KAAK,mBAAmB,CACtB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,cAAc,EACxB,cAAc,GAAG,SAAS,IACxB;IACF,OAAO,EAAE,eAAe,CAAA;IACxB,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;IAClD,SAAS,EAAE,YAAY,CAAA;IACvB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAYD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,eAAe,CAC1B,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,cAAc,EACxB,cAAc,GAAG,SAAS;IAE1B,2EAA2E;IAC3E,OAAO,EAAE,eAAe,CAAA;IACxB,mEAAmE;IACnE,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;IAClD,mDAAmD;IACnD,SAAS,EAAE,YAAY,CAAA;IACvB,2DAA2D;IAC3D,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,2DAA2D;IAC3D,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,oEAAoE;IACpE,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IACrC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;;;;;;;OAUG;gBACS,EACV,OAAO,EACP,UAAU,EACV,SAAS,EACT,UAAU,EACV,eAAe,EACf,QAAQ,EACT,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAc5C;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,KAAK;IAuBb;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,aAAa;IA+BrB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,gBAAgB;CAqBzB"}

package/script/dsl/operation/OperationDriver.js

@@ -4,44 +4,92 @@ exports.OperationDriver = void 0;
 const normalize_js_1 = require("../../deps/jsr.io/@std/path/1.1.2/normalize.js");
 const Definition_js_1 = require("../Definition.js");
 const GeneratorKeys_js_1 = require("../../types/GeneratorKeys.js");
+/**
+ * Driver class for generating operation-based artifacts from OpenAPI operations.
+ *
+ * The `OperationDriver` manages the transformation of OpenAPI operation objects
+ * into code artifacts, handling path generation, identifier resolution, and
+ * definition management. It serves as the core orchestrator for operation-based
+ * code generation in the SKMTC pipeline.
+ *
+ * @template V - Type of generated values produced by this driver
+ * @template T - Type of generation strategy (e.g., 'function', 'class', 'hook')
+ * @template EnrichmentType - Type of enrichments that can be applied
+ *
+ * @example Basic usage in an operation generator
+ * ```typescript
+ * class APIClientGenerator extends OperationBase {
+ *   generate() {
+ *     const driver = new OperationDriver({
+ *       context: this.context,
+ *       insertable: this,
+ *       operation: this.operation,
+ *       generation: 'function'
+ *     });
+ *
+ *     const functionCode = driver.definition.toValueString();
+ *     const file = this.createFile(functionCode);
+ *     this.register({ file });
+ *   }
+ * }
+ * ```
+ */
 class OperationDriver {
+    /**
+     * Creates a new OperationDriver instance.
+     *
+     * @param args - Configuration for the operation driver
+     * @param args.context - Generation context
+     * @param args.insertable - Insertable providing generation configuration
+     * @param args.operation - OpenAPI operation to process
+     * @param args.generation - Optional generation type
+     * @param args.destinationPath - Optional custom destination path
+     * @param args.noExport - Whether to exclude from exports
+     */
     constructor({ context, insertable, operation, generation, destinationPath, noExport }) {
+        /** The generation context providing access to OAS objects and utilities */
         Object.defineProperty(this, "context", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The insertable object that provides generation configuration */
         Object.defineProperty(this, "insertable", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The OpenAPI operation object being processed */
         Object.defineProperty(this, "operation", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Content settings for customizing generation behavior */
         Object.defineProperty(this, "settings", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Optional custom destination path for generated files */
         Object.defineProperty(this, "destinationPath", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The generated definition containing the transformed operation */
         Object.defineProperty(this, "definition", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Whether to exclude this operation from exports */
         Object.defineProperty(this, "noExport", {
             enumerable: true,
             configurable: true,
@@ -59,7 +107,20 @@ class OperationDriver {
         });
         this.definition = this.apply({ generation, destinationPath });
     }
-    apply({ generation, destinationPath } = {}) {
+    /**
+     * Applies generation configuration to create the operation definition.
+     *
+     * This method handles the core generation logic for operations, including
+     * identifier resolution, export path management, and import registration
+     * for cross-file dependencies.
+     *
+     * @template T - The generation type
+     * @param args - Apply configuration arguments
+     * @param args.generation - Optional generation type (unused currently)
+     * @param args.destinationPath - Optional destination path for imports
+     * @returns Generated definition for the operation
+     */
+    apply({ generation: _generation, destinationPath } = {}) {
         const { identifier, exportPath } = this.settings;
         // Everything is selected (for now)
         // if (/*!selected && */ generation !== 'force') {
@@ -74,6 +135,18 @@ class OperationDriver {
         }
         return definition;
     }
+    /**
+     * Retrieves or creates a definition for the operation.
+     *
+     * This method first checks for cached definitions to avoid duplicate generation,
+     * then creates a new definition if none exists. It handles the complete operation
+     * transformation process including schema resolution and value generation.
+     *
+     * @param args - Definition retrieval arguments
+     * @param args.identifier - The identifier for the definition
+     * @param args.exportPath - The export path for the definition
+     * @returns Operation definition instance
+     */
     getDefinition({ identifier, exportPath }) {
         const cachedDefinition = this.context.findDefinition({
             name: identifier.name,
@@ -99,6 +172,17 @@ class OperationDriver {
         });
         return definition;
     }
+    /**
+     * Type guard to verify a definition matches the expected generated value type.
+     *
+     * This method performs type narrowing to ensure a cached definition is compatible
+     * with the current generation requirements, including export path validation.
+     *
+     * @template V - The expected generated value type
+     * @param definition - The definition to verify (may be undefined)
+     * @param exportPath - Expected export path for validation
+     * @returns True if definition matches expected type and constraints
+     */
     affirmDefinition(definition, exportPath) {
         if (!definition) {
             return false;

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

@@ -3,11 +3,69 @@ import { OperationBase } from './OperationBase.js';
 import type { Identifier } from '../Identifier.js';
 import type { OperationInsertableArgs } from './types.js';
 import * as v from 'valibot';
+/**
+ * Configuration for creating a base operation class.
+ *
+ * Defines the structure and behavior for operation generators, including
+ * identifier generation, export path resolution, and enrichment schemas.
+ *
+ * @template EnrichmentType - Type of enrichments to apply to generated operations
+ */
 export type BaseOperationConfig<EnrichmentType = undefined> = {
+    /** Unique identifier for the operation generator */
     id: string;
+    /** Function to generate identifiers from operations */
     toIdentifier: (operation: OasOperation) => Identifier;
+    /** Function to generate export paths from operations */
     toExportPath: (operation: OasOperation) => string;
+    /** Optional function to provide enrichment validation schema */
     toEnrichmentSchema?: () => v.BaseSchema<EnrichmentType, EnrichmentType, v.BaseIssue<unknown>>;
 };
+/**
+ * Creates a base operation class constructor for generating type-safe operation artifacts.
+ *
+ * This factory function creates a specialized OperationBase class that implements
+ * the provided configuration for identifier generation, export paths, and
+ * enrichment handling. The resulting class can be instantiated to generate
+ * operation artifacts from OpenAPI operations.
+ *
+ * @template EnrichmentType - Type of enrichments to apply to generated operations
+ * @param config - Configuration defining the operation generation behavior
+ * @returns Constructor function for creating operation instances
+ *
+ * @example Creating a TypeScript function generator
+ * ```typescript
+ * import { toOperationBase } from '@skmtc/core';
+ *
+ * const TypeScriptOperationBase = toOperationBase({
+ *   id: 'typescript-functions',
+ *   toIdentifier: (operation) => new Identifier(camelCase(operation.operationId)),
+ *   toExportPath: (operation) => `./operations/${kebabCase(operation.operationId)}.ts`,
+ *   toEnrichmentSchema: () => v.object({
+ *     includeValidation: v.optional(v.boolean()),
+ *     asyncMode: v.optional(v.boolean())
+ *   })
+ * });
+ *
+ * class TypeScriptOperationGenerator extends TypeScriptOperationBase {
+ *   generate() {
+ *     const enrichments = this.enrichments;
+ *     const functionCode = generateFunction(this.operation, {
+ *       async: enrichments?.asyncMode ?? true
+ *     });
+ *     this.register({ file: this.createFile(functionCode) });
+ *   }
+ * }
+ * ```
+ *
+ * @example Creating a React hook generator
+ * ```typescript
+ * const ReactHookOperationBase = toOperationBase({
+ *   id: 'react-hooks',
+ *   toIdentifier: (operation) => new Identifier(`use${pascalCase(operation.operationId)}`),
+ *   toExportPath: (operation) => `./hooks/${kebabCase(operation.operationId)}.hook.ts`
+ * });
+ * ```
+ */
 export declare const toOperationBase: <EnrichmentType = undefined>(config: BaseOperationConfig<EnrichmentType>) => new (args: OperationInsertableArgs<EnrichmentType>) => OperationBase<EnrichmentType>;
 //# sourceMappingURL=toOperationBase.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"toOperationBase.d.ts","sourceRoot":"","sources":["../../../src/dsl/operation/toOperationBase.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACzD,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAI5B,MAAM,MAAM,mBAAmB,CAAC,cAAc,GAAG,SAAS,IAAI;IAC5D,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,UAAU,CAAA;IACrD,YAAY,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,MAAM,CAAA;IACjD,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;CAC9F,CAAA;AAOD,eAAO,MAAM,eAAe,GAAI,cAAc,GAAG,SAAS,EACxD,QAAQ,mBAAmB,CAAC,cAAc,CAAC,KAC1C,KAAK,IAAI,EAAE,uBAAuB,CAAC,cAAc,CAAC,KAAK,aAAa,CAAC,cAAc,CA6BrF,CAAA"}
+{"version":3,"file":"toOperationBase.d.ts","sourceRoot":"","sources":["../../../src/dsl/operation/toOperationBase.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACzD,OAAO,KAAK,CAAC,MAAM,SAAS,CAAA;AAI5B;;;;;;;GAOG;AACH,MAAM,MAAM,mBAAmB,CAAC,cAAc,GAAG,SAAS,IAAI;IAC5D,oDAAoD;IACpD,EAAE,EAAE,MAAM,CAAA;IACV,uDAAuD;IACvD,YAAY,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,UAAU,CAAA;IACrD,wDAAwD;IACxD,YAAY,EAAE,CAAC,SAAS,EAAE,YAAY,KAAK,MAAM,CAAA;IACjD,gEAAgE;IAChE,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,UAAU,CAAC,cAAc,EAAE,cAAc,EAAE,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAA;CAC9F,CAAA;AAOD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,eAAO,MAAM,eAAe,GAAI,cAAc,GAAG,SAAS,EACxD,QAAQ,mBAAmB,CAAC,cAAc,CAAC,KAC1C,KAAK,IAAI,EAAE,uBAAuB,CAAC,cAAc,CAAC,KAAK,aAAa,CAAC,cAAc,CA6BrF,CAAA"}

package/script/dsl/operation/toOperationBase.js

@@ -38,6 +38,52 @@ const GeneratorKeys_js_1 = require("../../types/GeneratorKeys.js");
 const OperationBase_js_1 = require("./OperationBase.js");
 const v = __importStar(require("valibot"));
 const lodash_es_1 = require("lodash-es");
+/**
+ * Creates a base operation class constructor for generating type-safe operation artifacts.
+ *
+ * This factory function creates a specialized OperationBase class that implements
+ * the provided configuration for identifier generation, export paths, and
+ * enrichment handling. The resulting class can be instantiated to generate
+ * operation artifacts from OpenAPI operations.
+ *
+ * @template EnrichmentType - Type of enrichments to apply to generated operations
+ * @param config - Configuration defining the operation generation behavior
+ * @returns Constructor function for creating operation instances
+ *
+ * @example Creating a TypeScript function generator
+ * ```typescript
+ * import { toOperationBase } from '@skmtc/core';
+ *
+ * const TypeScriptOperationBase = toOperationBase({
+ *   id: 'typescript-functions',
+ *   toIdentifier: (operation) => new Identifier(camelCase(operation.operationId)),
+ *   toExportPath: (operation) => `./operations/${kebabCase(operation.operationId)}.ts`,
+ *   toEnrichmentSchema: () => v.object({
+ *     includeValidation: v.optional(v.boolean()),
+ *     asyncMode: v.optional(v.boolean())
+ *   })
+ * });
+ *
+ * class TypeScriptOperationGenerator extends TypeScriptOperationBase {
+ *   generate() {
+ *     const enrichments = this.enrichments;
+ *     const functionCode = generateFunction(this.operation, {
+ *       async: enrichments?.asyncMode ?? true
+ *     });
+ *     this.register({ file: this.createFile(functionCode) });
+ *   }
+ * }
+ * ```
+ *
+ * @example Creating a React hook generator
+ * ```typescript
+ * const ReactHookOperationBase = toOperationBase({
+ *   id: 'react-hooks',
+ *   toIdentifier: (operation) => new Identifier(`use${pascalCase(operation.operationId)}`),
+ *   toExportPath: (operation) => `./hooks/${kebabCase(operation.operationId)}.hook.ts`
+ * });
+ * ```
+ */
 const toOperationBase = (config) => {
     var _a;
     return _a = class extends OperationBase_js_1.OperationBase {