@skmtc/core 0.0.786 → 0.0.788

package/esm/context/GenerateContext.d.ts

@@ -114,6 +114,101 @@ type GenerateResult = {
     previews: Record<string, Record<string, Preview>>;
     mappings: Record<string, Record<string, Mapping>>;
 };
+/**
+ * The generation context for the second phase of the SKMTC transformation pipeline.
+ *
+ * `GenerateContext` manages the transformation of parsed OAS (OpenAPI Schema) objects
+ * into code artifacts using pluggable generators. It provides APIs for model and operation
+ * generation, file management, dependency tracking, and artifact registration.
+ *
+ * ## Key Responsibilities
+ *
+ * - **Generator Orchestration**: Executes pluggable model and operation generators
+ * - **Schema Processing**: Provides utilities for working with OAS schemas and references
+ * - **File Management**: Handles file creation, imports, exports, and dependencies
+ * - **Artifact Registration**: Collects generated definitions and files for rendering
+ * - **Type System Integration**: Bridges OAS types with generator-specific type systems
+ * - **Settings Management**: Handles skipping logic and client customizations
+ *
+ * ## Generator Integration
+ *
+ * The context works with two main types of generators:
+ * - **Model Generators**: Transform schema definitions into type definitions
+ * - **Operation Generators**: Transform API operations into client functions
+ *
+ * @example Basic usage in a model generator
+ * ```typescript
+ * import { ModelBase } from '@skmtc/core';
+ *
+ * class TypeScriptInterface extends ModelBase {
+ *   generate(): Definition {
+ *     const schema = this.context.getSchema(this.refName);
+ *
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: Identifier.createType(this.refName),
+ *       description: schema.description,
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: this.generateInterfaceBody(schema)
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Operation generator usage
+ * ```typescript
+ * class ApiClientGenerator extends OperationBase {
+ *   generate(): Definition {
+ *     const operation = this.context.getOperation(this.path, this.method);
+ *
+ *     const functionName = this.context.createOperationName(this.path, this.method);
+ *
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: Identifier.createVariable(functionName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: this.generateClientFunction(operation)
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Schema and type system integration
+ * ```typescript
+ * class MyGenerator extends ModelBase {
+ *   generate(): Definition {
+ *     const schema = this.context.getSchema(this.refName);
+ *
+ *     // Transform schema using type system
+ *     const typeOutput = this.context.transformSchema(schema, {
+ *       stringType: 'string',
+ *       numberType: 'number',
+ *       arrayType: (items) => `Array<${items}>`
+ *     });
+ *
+ *     // Register dependencies
+ *     if (schema.hasReferences()) {
+ *       this.context.addImportsToFile('./models/types.ts', {
+ *         './common': ['BaseModel']
+ *       });
+ *     }
+ *
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: Identifier.createType(this.refName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: typeOutput.content
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ */
 export declare class GenerateContext {
     #private;
     oasDocument: OasDocument;

package/esm/context/GenerateContext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GenerateContext.d.ts","sourceRoot":"","sources":["../../src/context/GenerateContext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAErD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C,OAAO,KAAK,EAAE,cAAc,EAAyC,MAAM,sBAAsB,CAAA;AACjG,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAmB,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,EAAe,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAGzE,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,KAAK,KAAK,GAAG,MAAM,yCAAyC,CAAA;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,UAAU,EACV,gBAAgB,EACjB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAE7C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AACvE,OAAO,KAAK,EACV,eAAe,EACf,WAAW,EACX,OAAO,EAGP,OAAO,EACR,MAAM,qBAAqB,CAAA;AAE5B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,KAAK,eAAe,GAAG;IACrB,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAA;IACpC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAClD,oBAAoB,EAAE,CAAC,cAAc,GAAG,SAAS,OAAO,sBAAsB,CAAC,cAAc,CAAC,CAAA;CAC/F,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,eAAe,EAAE,MAAM,CAAA;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAA;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;IACxC,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAA;CACzC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAA;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;IACxC,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAA;IACxC,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,2BAA2B,CAAC,MAAM,SAAS,UAAU,IAAI;IACnE,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,eAAe,EAAE,eAAe,CAAA;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,cAAc,IAAI;IAC5D,UAAU,EAAE,UAAU,CAAA;IACtB,KAAK,EAAE,CAAC,CAAA;IACR,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,YAAY,CAAA;IACvB,YAAY,EAAE,MAAM,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,IAAI;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,yBAAyB,CAAC,MAAM,SAAS,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,IAAI;IAC7F,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,cAAc,EACxB,MAAM,SAAS,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,IAErD,MAAM,SAAS,MAAM,CAAC,QAAQ,CAAC,GAC3B,UAAU,CAAC,CAAC,CAAC,GACb,UAAU,CAAC,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAElE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,cAAc,IAAI;IACzD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,cAAc,EACxB,cAAc,IACZ,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC,CAAA;AAElC,KAAK,uBAAuB,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,IAAI;IAC5D,SAAS,EAAE,YAAY,CAAA;IACvB,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;CACnD,CAAA;AAED,KAAK,sBAAsB,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,IAAI;IAC3D,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;CAC/C,CAAA;AAED,KAAK,cAAc,GAAG;IACpB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,QAAQ,CAAC,CAAA;IACnC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACjD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAClD,CAAA;AAED,qBAAa,eAAe;;IAI1B,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAA;IACpC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAClD,oBAAoB,EAAE,CAAC,cAAc,GAAG,SAAS,OAAO,sBAAsB,CAAC,cAAc,CAAC,CAAA;IAC9F,UAAU,EAAE,UAAU,CAAA;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;gBACtB,EACV,WAAW,EACX,QAAQ,EACR,MAAM,EACN,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACrB,EAAE,eAAe;IAalB;;OAEG;IACH,WAAW,IAAI,cAAc;IA6J7B,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;IAoBlD;;;;OAIG;IACH,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAAE,EAC1C,UAAU,EACV,KAAK,EACL,eAAe,EACf,QAAQ,EACT,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAiD3C,oBAAoB;IACpB,YAAY,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,EAAE,gBAAgB;IAWxD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,OAAY,EAAE,WAAW,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,YAAY;IAmDhF;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,GAAG,SAAS,EAC5F,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,EAClD,SAAS,EAAE,YAAY,EACvB,EAAE,UAAU,EAAE,eAAe,EAAE,QAAgB,EAAE,GAAE,sBAAsB,CAAC,CAAC,CAAM,GAChF,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAajC,qBAAqB,CACnB,CAAC,SAAS,cAAc,EACxB,MAAM,SAAS,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,EACrD,cAAc,EAEd,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,EAC9C,EAAE,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,EAAE,yBAAyB,CAAC,MAAM,CAAC,EAC5E,EAAE,QAAgB,EAAE,GAAE,4BAAiC,GACtD,2BAA2B,CAAC,CAAC,EAAE,MAAM,CAAC;IAyCzC;;;;;;;;;;;;;OAaG;IAEH,WAAW,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,EAC5E,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,EAC9C,OAAO,EAAE,OAAO,EAChB,EAAE,UAAU,EAAE,eAAe,EAAE,QAAgB,EAAE,GAAE,kBAAkB,CAAC,CAAC,CAAM,GAC5E,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAcjC;;;;;;;;;OASG;IACH,0BAA0B,CAAC,CAAC,EAAE,cAAc,EAAE,EAC5C,SAAS,EACT,UAAU,EACX,EAAE,uBAAuB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,eAAe,CAAC,cAAc,CAAC;IAQ/E;;;;;;;;OAQG;IACH,sBAAsB,CAAC,CAAC,EAAE,cAAc,EAAE,EACxC,OAAO,EACP,UAAU,EACX,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,eAAe,CAAC,cAAc,CAAC;IAuB9E;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAYzF;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS;CAOvE;AAED,KAAK,qBAAqB,GAAG;IAC3B,SAAS,EAAE,YAAY,CAAA;IACvB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAI,4BAG/B,qBAAqB,KAAG,eAKzB,CAAA;AAEF,KAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,aAAa,GAAI,0BAA0B,iBAAiB,KAAG,WAI1E,CAAA"}
+{"version":3,"file":"GenerateContext.d.ts","sourceRoot":"","sources":["../../src/context/GenerateContext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAErD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C,OAAO,KAAK,EAAE,cAAc,EAAyC,MAAM,sBAAsB,CAAA;AACjG,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAChD,OAAO,KAAK,EAAmB,mBAAmB,EAAE,MAAM,2BAA2B,CAAA;AACrF,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,KAAK,EAAe,eAAe,EAAE,MAAM,uBAAuB,CAAA;AAGzE,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,OAAO,KAAK,KAAK,GAAG,MAAM,yCAAyC,CAAA;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EACf,UAAU,EACV,gBAAgB,EACjB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAE7C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AACvE,OAAO,KAAK,EACV,eAAe,EACf,WAAW,EACX,OAAO,EAGP,OAAO,EACR,MAAM,qBAAqB,CAAA;AAE5B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAElD,KAAK,eAAe,GAAG;IACrB,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAA;IACpC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;IACtB,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAClD,oBAAoB,EAAE,CAAC,cAAc,GAAG,SAAS,OAAO,sBAAsB,CAAC,cAAc,CAAC,CAAA;CAC/F,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,eAAe,EAAE,MAAM,CAAA;IACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAA;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;IACxC,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAA;CACzC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAA;IACzC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;IACxC,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,SAAS,CAAC,EAAE,CAAA;IACxC,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,2BAA2B,CAAC,MAAM,SAAS,UAAU,IAAI;IACnE,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,eAAe,EAAE,eAAe,CAAA;IAChC,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,cAAc,IAAI;IAC5D,UAAU,EAAE,UAAU,CAAA;IACtB,KAAK,EAAE,CAAC,CAAA;IACR,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,WAAW,EAAE,MAAM,CAAA;IACnB,SAAS,EAAE,YAAY,CAAA;IACvB,YAAY,EAAE,MAAM,EAAE,CAAA;CACvB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,OAAO,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,cAAc,IAAI;IAC7D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,yBAAyB,CAAC,MAAM,SAAS,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,IAAI;IAC7F,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,cAAc,EACxB,MAAM,SAAS,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,IAErD,MAAM,SAAS,MAAM,CAAC,QAAQ,CAAC,GAC3B,UAAU,CAAC,CAAC,CAAC,GACb,UAAU,CAAC,gBAAgB,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;AAElE,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,cAAc,IAAI;IACzD,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,UAAU,CAAC,EAAE,CAAC,CAAA;IACd,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,CAAC,SAAS,cAAc,EACxB,CAAC,SAAS,cAAc,EACxB,cAAc,IACZ,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC,CAAA;AAElC,KAAK,uBAAuB,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,IAAI;IAC5D,SAAS,EAAE,YAAY,CAAA;IACvB,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;CACnD,CAAA;AAED,KAAK,sBAAsB,CAAC,CAAC,EAAE,cAAc,GAAG,SAAS,IAAI;IAC3D,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;CAC/C,CAAA;AAED,KAAK,cAAc,GAAG;IACpB,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,QAAQ,CAAC,CAAA;IACnC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;IACjD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAClD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8FG;AACH,qBAAa,eAAe;;IAI1B,WAAW,EAAE,WAAW,CAAA;IACxB,QAAQ,EAAE,cAAc,GAAG,SAAS,CAAA;IACpC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAA;IAClB,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IAClD,oBAAoB,EAAE,CAAC,cAAc,GAAG,SAAS,OAAO,sBAAsB,CAAC,cAAc,CAAC,CAAA;IAC9F,UAAU,EAAE,UAAU,CAAA;IACtB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;gBACtB,EACV,WAAW,EACX,QAAQ,EACR,MAAM,EACN,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACrB,EAAE,eAAe;IAalB;;OAEG;IACH,WAAW,IAAI,cAAc;IA6J7B,KAAK,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC;IAoBlD;;;;OAIG;IACH,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAAE,EAC1C,UAAU,EACV,KAAK,EACL,eAAe,EACf,QAAQ,EACT,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAiD3C,oBAAoB;IACpB,YAAY,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,EAAE,gBAAgB;IAWxD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,OAAY,EAAE,WAAW,EAAE,eAAe,EAAE,SAAS,EAAE,EAAE,YAAY;IAmDhF;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,GAAG,SAAS,EAC5F,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,cAAc,CAAC,EAClD,SAAS,EAAE,YAAY,EACvB,EAAE,UAAU,EAAE,eAAe,EAAE,QAAgB,EAAE,GAAE,sBAAsB,CAAC,CAAC,CAAM,GAChF,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAajC,qBAAqB,CACnB,CAAC,SAAS,cAAc,EACxB,MAAM,SAAS,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,OAAO,EACrD,cAAc,EAEd,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,EAC9C,EAAE,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,EAAE,yBAAyB,CAAC,MAAM,CAAC,EAC5E,EAAE,QAAgB,EAAE,GAAE,4BAAiC,GACtD,2BAA2B,CAAC,CAAC,EAAE,MAAM,CAAC;IAyCzC;;;;;;;;;;;;;OAaG;IAEH,WAAW,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,EAC5E,UAAU,EAAE,eAAe,CAAC,CAAC,EAAE,cAAc,CAAC,EAC9C,OAAO,EAAE,OAAO,EAChB,EAAE,UAAU,EAAE,eAAe,EAAE,QAAgB,EAAE,GAAE,kBAAkB,CAAC,CAAC,CAAM,GAC5E,QAAQ,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAcjC;;;;;;;;;OASG;IACH,0BAA0B,CAAC,CAAC,EAAE,cAAc,EAAE,EAC5C,SAAS,EACT,UAAU,EACX,EAAE,uBAAuB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,eAAe,CAAC,cAAc,CAAC;IAQ/E;;;;;;;;OAQG;IACH,sBAAsB,CAAC,CAAC,EAAE,cAAc,EAAE,EACxC,OAAO,EACP,UAAU,EACX,EAAE,sBAAsB,CAAC,CAAC,EAAE,cAAc,CAAC,GAAG,eAAe,CAAC,cAAc,CAAC;IAuB9E;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC;IAYzF;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,QAAQ,GAAG,UAAU,GAAG,SAAS;CAOvE;AAED,KAAK,qBAAqB,GAAG;IAC3B,SAAS,EAAE,YAAY,CAAA;IACvB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAI,4BAG/B,qBAAqB,KAAG,eAKzB,CAAA;AAEF,KAAK,iBAAiB,GAAG;IACvB,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,aAAa,GAAI,0BAA0B,iBAAiB,KAAG,WAI1E,CAAA"}

package/esm/context/GenerateContext.js

@@ -23,6 +23,101 @@ import { File } from '../dsl/File.js';
 import { JsonFile } from '../dsl/JsonFile.js';
 import invariant from 'tiny-invariant';
 import { match } from 'ts-pattern';
+/**
+ * The generation context for the second phase of the SKMTC transformation pipeline.
+ *
+ * `GenerateContext` manages the transformation of parsed OAS (OpenAPI Schema) objects
+ * into code artifacts using pluggable generators. It provides APIs for model and operation
+ * generation, file management, dependency tracking, and artifact registration.
+ *
+ * ## Key Responsibilities
+ *
+ * - **Generator Orchestration**: Executes pluggable model and operation generators
+ * - **Schema Processing**: Provides utilities for working with OAS schemas and references
+ * - **File Management**: Handles file creation, imports, exports, and dependencies
+ * - **Artifact Registration**: Collects generated definitions and files for rendering
+ * - **Type System Integration**: Bridges OAS types with generator-specific type systems
+ * - **Settings Management**: Handles skipping logic and client customizations
+ *
+ * ## Generator Integration
+ *
+ * The context works with two main types of generators:
+ * - **Model Generators**: Transform schema definitions into type definitions
+ * - **Operation Generators**: Transform API operations into client functions
+ *
+ * @example Basic usage in a model generator
+ * ```typescript
+ * import { ModelBase } from '@skmtc/core';
+ *
+ * class TypeScriptInterface extends ModelBase {
+ *   generate(): Definition {
+ *     const schema = this.context.getSchema(this.refName);
+ *
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: Identifier.createType(this.refName),
+ *       description: schema.description,
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: this.generateInterfaceBody(schema)
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Operation generator usage
+ * ```typescript
+ * class ApiClientGenerator extends OperationBase {
+ *   generate(): Definition {
+ *     const operation = this.context.getOperation(this.path, this.method);
+ *
+ *     const functionName = this.context.createOperationName(this.path, this.method);
+ *
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: Identifier.createVariable(functionName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: this.generateClientFunction(operation)
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Schema and type system integration
+ * ```typescript
+ * class MyGenerator extends ModelBase {
+ *   generate(): Definition {
+ *     const schema = this.context.getSchema(this.refName);
+ *
+ *     // Transform schema using type system
+ *     const typeOutput = this.context.transformSchema(schema, {
+ *       stringType: 'string',
+ *       numberType: 'number',
+ *       arrayType: (items) => `Array<${items}>`
+ *     });
+ *
+ *     // Register dependencies
+ *     if (schema.hasReferences()) {
+ *       this.context.addImportsToFile('./models/types.ts', {
+ *         './common': ['BaseModel']
+ *       });
+ *     }
+ *
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: Identifier.createType(this.refName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: typeOutput.content
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ */
 export class GenerateContext {
     constructor({ oasDocument, settings, logger, captureCurrentResult, stackTrail, toGeneratorConfigMap }) {
         _GenerateContext_instances.add(this);

package/esm/dsl/ContentSettings.d.ts

@@ -1,18 +1,182 @@
 import type { Identifier } from './Identifier.js';
+/**
+ * Arguments for creating empty ContentSettings without enrichments.
+ */
 type EmptyArgs = {
+    /** The path where generated content will be exported */
     exportPath: string;
+    /** The identifier for the content being generated */
     identifier: Identifier;
 };
+/**
+ * Arguments for creating ContentSettings with enrichments.
+ *
+ * @template EnrichmentType - The type of enrichment data
+ */
 type CreateArgs<EnrichmentType = undefined> = {
+    /** The identifier for the content being generated */
     identifier: Identifier;
+    /** The path where generated content will be exported */
     exportPath: string;
+    /** Custom enrichment data for extending generation */
     enrichments: EnrichmentType;
 };
+/**
+ * Configuration settings for content generators in the SKMTC DSL system.
+ *
+ * `ContentSettings` encapsulates the configuration needed by generators to
+ * produce content, including where to export the generated files, how to
+ * identify the content, and any custom enrichment data for extending
+ * the generation process.
+ *
+ * This class is used by both {@link ModelBase} and {@link OperationBase}
+ * to configure their generation behavior, providing a consistent interface
+ * for generator settings across the system.
+ *
+ * ## Key Features
+ *
+ * - **Export Path Management**: Specifies where generated content should be written
+ * - **Identifier Integration**: Links content to specific identifiers for naming
+ * - **Enrichment Support**: Allows custom data to extend generation capabilities
+ * - **Type Safety**: Generic enrichment typing for compile-time validation
+ *
+ * @template EnrichmentType - The type of enrichment data (default: undefined)
+ *
+ * @example Basic settings without enrichments
+ * ```typescript
+ * import { ContentSettings, Identifier } from '@skmtc/core';
+ *
+ * const settings = ContentSettings.empty({
+ *   exportPath: './src/generated/models.ts',
+ *   identifier: Identifier.createType('UserModels')
+ * });
+ *
+ * console.log(settings.exportPath); // './src/generated/models.ts'
+ * console.log(settings.enrichments); // undefined
+ * ```
+ *
+ * @example Settings with custom enrichments
+ * ```typescript
+ * type ValidationEnrichment = {
+ *   validateRequired: boolean;
+ *   generateComments: boolean;
+ *   customValidators: string[];
+ * };
+ *
+ * const enrichedSettings = new ContentSettings({
+ *   identifier: Identifier.createType('ValidatedModels'),
+ *   exportPath: './src/models/validated.ts',
+ *   enrichments: {
+ *     validateRequired: true,
+ *     generateComments: true,
+ *     customValidators: ['email', 'phone']
+ *   }
+ * });
+ *
+ * // Access enrichment data in generators
+ * if (enrichedSettings.enrichments?.validateRequired) {
+ *   // Generate validation logic
+ * }
+ * ```
+ *
+ * @example Using with ModelBase
+ * ```typescript
+ * class ValidatedModelGenerator extends ModelBase<ValidationEnrichment> {
+ *   constructor(args) {
+ *     super({
+ *       ...args,
+ *       settings: new ContentSettings({
+ *         identifier: Identifier.createType(args.refName),
+ *         exportPath: './src/validated-models.ts',
+ *         enrichments: {
+ *           validateRequired: true,
+ *           generateComments: false,
+ *           customValidators: []
+ *         }
+ *       })
+ *     });
+ *   }
+ *
+ *   toDefinition(): Definition {
+ *     const validation = this.settings.enrichments?.validateRequired
+ *       ? this.generateValidation()
+ *       : '';
+ *
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: this.settings.identifier,
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: `${this.generateInterface()}${validation}`
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ */
 export declare class ContentSettings<EnrichmentType = undefined> {
+    /** The identifier for the content being generated */
     identifier: Identifier;
+    /** The path where generated content will be exported */
     exportPath: string;
+    /** Custom enrichment data for extending generation */
     enrichments: EnrichmentType;
+    /**
+     * Creates a new ContentSettings instance with enrichments.
+     *
+     * @param args - Settings configuration
+     * @param args.identifier - The identifier for the content being generated
+     * @param args.exportPath - The path where generated content will be exported
+     * @param args.enrichments - Custom enrichment data for extending generation
+     *
+     * @example
+     * ```typescript
+     * const settings = new ContentSettings({
+     *   identifier: Identifier.createType('ApiModels'),
+     *   exportPath: './src/api/models.ts',
+     *   enrichments: {
+     *     includeValidation: true,
+   *     format: 'detailed'
+     *   }
+     * });
+     * ```
+     */
     constructor({ identifier, exportPath, enrichments }: CreateArgs<EnrichmentType>);
+    /**
+     * Factory method to create ContentSettings without enrichments.
+     *
+     * This is a convenience method for creating ContentSettings when no
+     * custom enrichment data is needed. It explicitly sets enrichments
+     * to undefined and returns a properly typed instance.
+     *
+     * @param args - Basic settings arguments
+     * @param args.identifier - The identifier for the content being generated
+     * @param args.exportPath - The path where generated content will be exported
+     * @returns ContentSettings instance with undefined enrichments
+     *
+     * @example
+     * ```typescript
+     * const basicSettings = ContentSettings.empty({
+     *   identifier: Identifier.createType('SimpleModels'),
+     *   exportPath: './src/models.ts'
+     * });
+     *
+     * console.log(basicSettings.enrichments); // undefined
+     *
+     * // Use in generator
+     * class SimpleGenerator extends ModelBase {
+     *   constructor(args) {
+     *     super({
+     *       ...args,
+     *       settings: ContentSettings.empty({
+     *         identifier: Identifier.createType(args.refName),
+     *         exportPath: './src/simple-models.ts'
+     *       })
+     *     });
+     *   }
+     * }
+     * ```
+     */
     static empty({ identifier, exportPath }: EmptyArgs): ContentSettings<undefined>;
 }
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"ContentSettings.d.ts","sourceRoot":"","sources":["../../src/dsl/ContentSettings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,KAAK,SAAS,GAAG;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,KAAK,UAAU,CAAC,cAAc,GAAG,SAAS,IAAI;IAC5C,UAAU,EAAE,UAAU,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED,qBAAa,eAAe,CAAC,cAAc,GAAG,SAAS;IACrD,UAAU,EAAE,UAAU,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,cAAc,CAAA;gBACf,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,UAAU,CAAC,cAAc,CAAC;IAM/E,MAAM,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC;CAOhF"}
+{"version":3,"file":"ContentSettings.d.ts","sourceRoot":"","sources":["../../src/dsl/ContentSettings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;GAEG;AACH,KAAK,SAAS,GAAG;IACf,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAA;IAClB,qDAAqD;IACrD,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;;;GAIG;AACH,KAAK,UAAU,CAAC,cAAc,GAAG,SAAS,IAAI;IAC5C,qDAAqD;IACrD,UAAU,EAAE,UAAU,CAAA;IACtB,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAA;IAClB,sDAAsD;IACtD,WAAW,EAAE,cAAc,CAAA;CAC5B,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AACH,qBAAa,eAAe,CAAC,cAAc,GAAG,SAAS;IACrD,qDAAqD;IACrD,UAAU,EAAE,UAAU,CAAA;IAEtB,wDAAwD;IACxD,UAAU,EAAE,MAAM,CAAA;IAElB,sDAAsD;IACtD,WAAW,EAAE,cAAc,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;OAmBG;gBACS,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE,UAAU,CAAC,cAAc,CAAC;IAM/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC;CAOhF"}

package/esm/dsl/ContentSettings.js

@@ -1,17 +1,133 @@
+/**
+ * Configuration settings for content generators in the SKMTC DSL system.
+ *
+ * `ContentSettings` encapsulates the configuration needed by generators to
+ * produce content, including where to export the generated files, how to
+ * identify the content, and any custom enrichment data for extending
+ * the generation process.
+ *
+ * This class is used by both {@link ModelBase} and {@link OperationBase}
+ * to configure their generation behavior, providing a consistent interface
+ * for generator settings across the system.
+ *
+ * ## Key Features
+ *
+ * - **Export Path Management**: Specifies where generated content should be written
+ * - **Identifier Integration**: Links content to specific identifiers for naming
+ * - **Enrichment Support**: Allows custom data to extend generation capabilities
+ * - **Type Safety**: Generic enrichment typing for compile-time validation
+ *
+ * @template EnrichmentType - The type of enrichment data (default: undefined)
+ *
+ * @example Basic settings without enrichments
+ * ```typescript
+ * import { ContentSettings, Identifier } from '@skmtc/core';
+ *
+ * const settings = ContentSettings.empty({
+ *   exportPath: './src/generated/models.ts',
+ *   identifier: Identifier.createType('UserModels')
+ * });
+ *
+ * console.log(settings.exportPath); // './src/generated/models.ts'
+ * console.log(settings.enrichments); // undefined
+ * ```
+ *
+ * @example Settings with custom enrichments
+ * ```typescript
+ * type ValidationEnrichment = {
+ *   validateRequired: boolean;
+ *   generateComments: boolean;
+ *   customValidators: string[];
+ * };
+ *
+ * const enrichedSettings = new ContentSettings({
+ *   identifier: Identifier.createType('ValidatedModels'),
+ *   exportPath: './src/models/validated.ts',
+ *   enrichments: {
+ *     validateRequired: true,
+ *     generateComments: true,
+ *     customValidators: ['email', 'phone']
+ *   }
+ * });
+ *
+ * // Access enrichment data in generators
+ * if (enrichedSettings.enrichments?.validateRequired) {
+ *   // Generate validation logic
+ * }
+ * ```
+ *
+ * @example Using with ModelBase
+ * ```typescript
+ * class ValidatedModelGenerator extends ModelBase<ValidationEnrichment> {
+ *   constructor(args) {
+ *     super({
+ *       ...args,
+ *       settings: new ContentSettings({
+ *         identifier: Identifier.createType(args.refName),
+ *         exportPath: './src/validated-models.ts',
+ *         enrichments: {
+ *           validateRequired: true,
+ *           generateComments: false,
+ *           customValidators: []
+ *         }
+ *       })
+ *     });
+ *   }
+ *
+ *   toDefinition(): Definition {
+ *     const validation = this.settings.enrichments?.validateRequired
+ *       ? this.generateValidation()
+ *       : '';
+ *
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: this.settings.identifier,
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: `${this.generateInterface()}${validation}`
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ */
 export class ContentSettings {
+    /**
+     * Creates a new ContentSettings instance with enrichments.
+     *
+     * @param args - Settings configuration
+     * @param args.identifier - The identifier for the content being generated
+     * @param args.exportPath - The path where generated content will be exported
+     * @param args.enrichments - Custom enrichment data for extending generation
+     *
+     * @example
+     * ```typescript
+     * const settings = new ContentSettings({
+     *   identifier: Identifier.createType('ApiModels'),
+     *   exportPath: './src/api/models.ts',
+     *   enrichments: {
+     *     includeValidation: true,
+   *     format: 'detailed'
+     *   }
+     * });
+     * ```
+     */
     constructor({ identifier, exportPath, enrichments }) {
+        /** The identifier for the content being generated */
         Object.defineProperty(this, "identifier", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The path where generated content will be exported */
         Object.defineProperty(this, "exportPath", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** Custom enrichment data for extending generation */
         Object.defineProperty(this, "enrichments", {
             enumerable: true,
             configurable: true,
@@ -22,6 +138,41 @@ export class ContentSettings {
         this.exportPath = exportPath;
         this.enrichments = enrichments;
     }
+    /**
+     * Factory method to create ContentSettings without enrichments.
+     *
+     * This is a convenience method for creating ContentSettings when no
+     * custom enrichment data is needed. It explicitly sets enrichments
+     * to undefined and returns a properly typed instance.
+     *
+     * @param args - Basic settings arguments
+     * @param args.identifier - The identifier for the content being generated
+     * @param args.exportPath - The path where generated content will be exported
+     * @returns ContentSettings instance with undefined enrichments
+     *
+     * @example
+     * ```typescript
+     * const basicSettings = ContentSettings.empty({
+     *   identifier: Identifier.createType('SimpleModels'),
+     *   exportPath: './src/models.ts'
+     * });
+     *
+     * console.log(basicSettings.enrichments); // undefined
+     *
+     * // Use in generator
+     * class SimpleGenerator extends ModelBase {
+     *   constructor(args) {
+     *     super({
+     *       ...args,
+     *       settings: ContentSettings.empty({
+     *         identifier: Identifier.createType(args.refName),
+     *         exportPath: './src/simple-models.ts'
+     *       })
+     *     });
+     *   }
+     * }
+     * ```
+     */
     static empty({ identifier, exportPath }) {
         return new ContentSettings({
             identifier,