@skmtc/core 0.0.787 → 0.0.789

package/esm/dsl/Inserted.d.ts

@@ -1,17 +1,257 @@
 import type { GeneratedDefinition, GeneratedValue, GenerationType } from '../types/GeneratedValue.js';
 import type { ContentSettings } from './ContentSettings.js';
 import type { Identifier } from './Identifier.js';
+/**
+ * Constructor arguments for {@link Inserted}.
+ *
+ * @template V - The type of generated value
+ * @template T - The generation type ('force' or 'lazy')
+ * @template EnrichmentType - Optional enrichment data type
+ */
 type ConstructorArgs<V extends GeneratedValue, T extends GenerationType, EnrichmentType> = {
+    /** Content settings including identifier and export path */
     settings: ContentSettings<EnrichmentType>;
+    /** The generated definition with its value */
     definition: GeneratedDefinition<V, T>;
 };
+/**
+ * Represents a successfully inserted generator artifact in the SKMTC DSL system.
+ *
+ * The `Inserted` class is returned when generators are inserted into the generation
+ * context, providing access to the generated content, metadata, and configuration.
+ * It acts as a bridge between the insertion process and the consuming code that
+ * needs to reference or use the generated artifacts.
+ *
+ * This class provides type-safe access to generated values with proper handling
+ * of both forced and lazy generation modes, ensuring the correct optionality
+ * of the generated content based on the generation strategy used.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Generic parameters preserve exact types from generators
+ * - **Generation Modes**: Handles both 'force' and 'lazy' generation strategies
+ * - **Metadata Access**: Provides access to identifiers, export paths, and settings
+ * - **Value Extraction**: Type-safe value extraction with proper optionality
+ * - **Enrichment Support**: Full support for custom enrichment data types
+ *
+ * @template V - The type of generated value (preserves generator output type)
+ * @template T - The generation type ('force' ensures non-null, 'lazy' allows undefined)
+ * @template EnrichmentType - Optional type for custom enrichment data
+ *
+ * @example Basic usage with forced generation
+ * ```typescript
+ * import { Inserted } from '@skmtc/core';
+ *
+ * class MyGenerator extends ModelBase {
+ *   generate(): Definition {
+ *     // Insert a related model with forced generation
+ *     const userModel = this.insertModel(
+ *       new UserModelGenerator({ ... }),
+ *       'User'
+ *     ); // Returns Inserted<UserModelValue, 'force', EnrichmentType>
+ *
+ *     // Access the generated value (guaranteed to be present)
+ *     const userTypeName = userModel.toValue(); // UserModelValue (not undefined)
+ *     const exportPath = userModel.toExportPath(); // './src/models.ts'
+ *     const identifier = userModel.toName(); // 'User'
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createType(this.refName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: `export interface Order { user: ${userTypeName}; }`
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Working with lazy generation
+ * ```typescript
+ * class ConditionalGenerator extends ModelBase {
+ *   generate(): Definition {
+ *     // Insert with lazy generation (may not generate if already exists)
+ *     const optionalModel = this.insertModel(
+ *       new OptionalModelGenerator({ ... }),
+ *       'OptionalModel',
+ *       { generation: 'lazy' }
+ *     ); // Returns Inserted<OptionalValue, 'lazy', EnrichmentType>
+ *
+ *     // Value might be undefined with lazy generation
+ *     const value = optionalModel.toValue(); // OptionalValue | undefined
+ *
+ *     if (value) {
+ *       // Use the generated value
+ *       return this.createDefinitionWith(value);
+ *     } else {
+ *       // Handle case where generation was skipped
+ *       return this.createFallbackDefinition();
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @example Accessing insertion metadata
+ * ```typescript
+ * class MetadataAwareGenerator extends OperationBase {
+ *   generate(): Definition {
+ *     const requestModel = this.insertModel(
+ *       new RequestModelGenerator({ ... }),
+ *       'CreateUserRequest'
+ *     );
+ *
+ *     // Access various metadata
+ *     const modelName = requestModel.toName(); // 'CreateUserRequest'
+ *     const identifier = requestModel.toIdentifier(); // Full Identifier object
+ *     const exportPath = requestModel.toExportPath(); // './src/api/types.ts'
+ *     const enrichments = requestModel.settings.enrichments; // Custom data
+ *
+ *     console.log(`Generated ${modelName} in ${exportPath}`);
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createVariable(this.operation.operationId!),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: `async function createUser(data: ${modelName}) { ... }`
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example With enrichment data
+ * ```typescript
+ * type ValidationEnrichment = {
+ *   validators: string[];
+ *   required: boolean;
+ * };
+ *
+ * class EnrichedGenerator extends ModelBase<ValidationEnrichment> {
+ *   generate(): Definition {
+ *     const validatedModel = this.insertModel(
+ *       new ValidatedModelGenerator({ ... }),
+ *       'ValidatedUser'
+ *     ); // Returns Inserted<ModelValue, 'force', ValidationEnrichment>
+ *
+ *     // Access enrichment data
+ *     const enrichment = validatedModel.settings.enrichments;
+ *     const validators = enrichment?.validators ?? [];
+ *     const isRequired = enrichment?.required ?? false;
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createType(this.refName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: this.generateWithValidation(validatedModel.toValue(), validators)
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ */
 export declare class Inserted<V extends GeneratedValue, T extends GenerationType, EnrichmentType> {
+    /** Content settings including identifier and export path */
     settings: ContentSettings<EnrichmentType>;
+    /** The generated definition with its value */
     definition: GeneratedDefinition<V, T>;
+    /**
+     * Creates a new Inserted instance.
+     *
+     * @param args - Insertion configuration
+     * @param args.settings - Content settings with identifier and export path
+     * @param args.definition - The generated definition containing the value
+     */
     constructor({ settings, definition }: ConstructorArgs<V, T, EnrichmentType>);
+    /**
+     * Gets the name of the inserted artifact.
+     *
+     * This method returns the string name from the identifier, which is commonly
+     * used when referencing the generated artifact in code or templates.
+     *
+     * @returns The name of the inserted artifact
+     *
+     * @example
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User');
+     * const name = userModel.toName(); // 'User'
+     *
+     * // Use in generated code
+     * const code = `interface Order { user: ${name}; }`;
+     * ```
+     */
     toName(): string;
+    /**
+     * Gets the full identifier of the inserted artifact.
+     *
+     * This method returns the complete Identifier object, which includes both
+     * the name and type information. Useful when you need access to entity type
+     * or type annotations.
+     *
+     * @returns The complete Identifier object
+     *
+     * @example
+     * ```typescript
+     * const model = this.insertModel(generator, 'User');
+     * const identifier = model.toIdentifier();
+     *
+     * console.log(identifier.name);        // 'User'
+     * console.log(identifier.entityType);  // EntityType instance
+     * console.log(identifier.typeName);    // Optional type annotation
+     * ```
+     */
     toIdentifier(): Identifier;
+    /**
+     * Gets the export path where the artifact was generated.
+     *
+     * This method returns the file path where the generated artifact is located,
+     * which is useful for creating import statements or understanding the file
+     * structure of generated code.
+     *
+     * @returns The export path of the generated artifact
+     *
+     * @example
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User');
+     * const exportPath = userModel.toExportPath(); // './src/models/User.ts'
+     *
+     * // Create import statement
+     * const importStmt = `import { User } from '${exportPath}';`;
+     * ```
+     */
     toExportPath(): string;
+    /**
+     * Gets the generated value from the inserted artifact.
+     *
+     * This method returns the actual generated content with proper type safety
+     * based on the generation mode. For 'force' generation, the value is guaranteed
+     * to be present. For 'lazy' generation, the value might be undefined if
+     * generation was skipped.
+     *
+     * @returns The generated value, with optionality based on generation type
+     *
+     * @example Forced generation (guaranteed value)
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User'); // 'force' by default
+     * const value = userModel.toValue(); // UserModelValue (never undefined)
+     *
+     * // Safe to use directly
+     * const code = `type OrderUser = ${value};`;
+     * ```
+     *
+     * @example Lazy generation (optional value)
+     * ```typescript
+     * const optionalModel = this.insertModel(generator, 'Optional', { generation: 'lazy' });
+     * const value = optionalModel.toValue(); // OptionalValue | undefined
+     *
+     * if (value) {
+     *   // Use the generated value
+     *   const code = `type Optional = ${value};`;
+     * } else {
+     *   // Handle missing value (generation was skipped)
+     *   const code = 'type Optional = any; // Fallback';
+     * }
+     * ```
+     */
     toValue(): T extends 'force' ? V : V | undefined;
 }
 export {};

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

@@ -1 +1 @@
-{"version":3,"file":"Inserted.d.ts","sourceRoot":"","sources":["../../src/dsl/Inserted.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,cAAc,EACf,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,KAAK,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,IAAI;IACzF,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CACtC,CAAA;AAED,qBAAa,QAAQ,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc;IACtF,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;gBACzB,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAK3E,MAAM,IAAI,MAAM;IAIhB,YAAY,IAAI,UAAU;IAI1B,YAAY,IAAI,MAAM;IAItB,OAAO,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS;CAGjD"}
+{"version":3,"file":"Inserted.d.ts","sourceRoot":"","sources":["../../src/dsl/Inserted.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,cAAc,EACf,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;;;;;GAMG;AACH,KAAK,eAAe,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc,IAAI;IACzF,4DAA4D;IAC5D,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IACzC,8CAA8C;IAC9C,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;CACtC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsIG;AACH,qBAAa,QAAQ,CAAC,CAAC,SAAS,cAAc,EAAE,CAAC,SAAS,cAAc,EAAE,cAAc;IACtF,4DAA4D;IAC5D,QAAQ,EAAE,eAAe,CAAC,cAAc,CAAC,CAAA;IAEzC,8CAA8C;IAC9C,UAAU,EAAE,mBAAmB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAErC;;;;;;OAMG;gBACS,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,cAAc,CAAC;IAK3E;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,IAAI,MAAM;IAIhB;;;;;;;;;;;;;;;;;;OAkBG;IACH,YAAY,IAAI,UAAU;IAI1B;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,IAAI,MAAM;IAItB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,OAAO,IAAI,CAAC,SAAS,OAAO,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS;CAGjD"}

package/esm/dsl/Inserted.js

@@ -1,11 +1,155 @@
+/**
+ * Represents a successfully inserted generator artifact in the SKMTC DSL system.
+ *
+ * The `Inserted` class is returned when generators are inserted into the generation
+ * context, providing access to the generated content, metadata, and configuration.
+ * It acts as a bridge between the insertion process and the consuming code that
+ * needs to reference or use the generated artifacts.
+ *
+ * This class provides type-safe access to generated values with proper handling
+ * of both forced and lazy generation modes, ensuring the correct optionality
+ * of the generated content based on the generation strategy used.
+ *
+ * ## Key Features
+ *
+ * - **Type Safety**: Generic parameters preserve exact types from generators
+ * - **Generation Modes**: Handles both 'force' and 'lazy' generation strategies
+ * - **Metadata Access**: Provides access to identifiers, export paths, and settings
+ * - **Value Extraction**: Type-safe value extraction with proper optionality
+ * - **Enrichment Support**: Full support for custom enrichment data types
+ *
+ * @template V - The type of generated value (preserves generator output type)
+ * @template T - The generation type ('force' ensures non-null, 'lazy' allows undefined)
+ * @template EnrichmentType - Optional type for custom enrichment data
+ *
+ * @example Basic usage with forced generation
+ * ```typescript
+ * import { Inserted } from '@skmtc/core';
+ *
+ * class MyGenerator extends ModelBase {
+ *   generate(): Definition {
+ *     // Insert a related model with forced generation
+ *     const userModel = this.insertModel(
+ *       new UserModelGenerator({ ... }),
+ *       'User'
+ *     ); // Returns Inserted<UserModelValue, 'force', EnrichmentType>
+ *
+ *     // Access the generated value (guaranteed to be present)
+ *     const userTypeName = userModel.toValue(); // UserModelValue (not undefined)
+ *     const exportPath = userModel.toExportPath(); // './src/models.ts'
+ *     const identifier = userModel.toName(); // 'User'
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createType(this.refName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: `export interface Order { user: ${userTypeName}; }`
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Working with lazy generation
+ * ```typescript
+ * class ConditionalGenerator extends ModelBase {
+ *   generate(): Definition {
+ *     // Insert with lazy generation (may not generate if already exists)
+ *     const optionalModel = this.insertModel(
+ *       new OptionalModelGenerator({ ... }),
+ *       'OptionalModel',
+ *       { generation: 'lazy' }
+ *     ); // Returns Inserted<OptionalValue, 'lazy', EnrichmentType>
+ *
+ *     // Value might be undefined with lazy generation
+ *     const value = optionalModel.toValue(); // OptionalValue | undefined
+ *
+ *     if (value) {
+ *       // Use the generated value
+ *       return this.createDefinitionWith(value);
+ *     } else {
+ *       // Handle case where generation was skipped
+ *       return this.createFallbackDefinition();
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @example Accessing insertion metadata
+ * ```typescript
+ * class MetadataAwareGenerator extends OperationBase {
+ *   generate(): Definition {
+ *     const requestModel = this.insertModel(
+ *       new RequestModelGenerator({ ... }),
+ *       'CreateUserRequest'
+ *     );
+ *
+ *     // Access various metadata
+ *     const modelName = requestModel.toName(); // 'CreateUserRequest'
+ *     const identifier = requestModel.toIdentifier(); // Full Identifier object
+ *     const exportPath = requestModel.toExportPath(); // './src/api/types.ts'
+ *     const enrichments = requestModel.settings.enrichments; // Custom data
+ *
+ *     console.log(`Generated ${modelName} in ${exportPath}`);
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createVariable(this.operation.operationId!),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: `async function createUser(data: ${modelName}) { ... }`
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example With enrichment data
+ * ```typescript
+ * type ValidationEnrichment = {
+ *   validators: string[];
+ *   required: boolean;
+ * };
+ *
+ * class EnrichedGenerator extends ModelBase<ValidationEnrichment> {
+ *   generate(): Definition {
+ *     const validatedModel = this.insertModel(
+ *       new ValidatedModelGenerator({ ... }),
+ *       'ValidatedUser'
+ *     ); // Returns Inserted<ModelValue, 'force', ValidationEnrichment>
+ *
+ *     // Access enrichment data
+ *     const enrichment = validatedModel.settings.enrichments;
+ *     const validators = enrichment?.validators ?? [];
+ *     const isRequired = enrichment?.required ?? false;
+ *
+ *     return new Definition({
+ *       identifier: Identifier.createType(this.refName),
+ *       value: {
+ *         generatorKey: this.generatorKey,
+ *         content: this.generateWithValidation(validatedModel.toValue(), validators)
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ */
 export class Inserted {
+    /**
+     * Creates a new Inserted instance.
+     *
+     * @param args - Insertion configuration
+     * @param args.settings - Content settings with identifier and export path
+     * @param args.definition - The generated definition containing the value
+     */
     constructor({ settings, definition }) {
+        /** Content settings including identifier and export path */
         Object.defineProperty(this, "settings", {
             enumerable: true,
             configurable: true,
             writable: true,
             value: void 0
         });
+        /** The generated definition with its value */
         Object.defineProperty(this, "definition", {
             enumerable: true,
             configurable: true,
@@ -15,15 +159,102 @@ export class Inserted {
         this.settings = settings;
         this.definition = definition;
     }
+    /**
+     * Gets the name of the inserted artifact.
+     *
+     * This method returns the string name from the identifier, which is commonly
+     * used when referencing the generated artifact in code or templates.
+     *
+     * @returns The name of the inserted artifact
+     *
+     * @example
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User');
+     * const name = userModel.toName(); // 'User'
+     *
+     * // Use in generated code
+     * const code = `interface Order { user: ${name}; }`;
+     * ```
+     */
     toName() {
         return this.settings.identifier.name;
     }
+    /**
+     * Gets the full identifier of the inserted artifact.
+     *
+     * This method returns the complete Identifier object, which includes both
+     * the name and type information. Useful when you need access to entity type
+     * or type annotations.
+     *
+     * @returns The complete Identifier object
+     *
+     * @example
+     * ```typescript
+     * const model = this.insertModel(generator, 'User');
+     * const identifier = model.toIdentifier();
+     *
+     * console.log(identifier.name);        // 'User'
+     * console.log(identifier.entityType);  // EntityType instance
+     * console.log(identifier.typeName);    // Optional type annotation
+     * ```
+     */
     toIdentifier() {
         return this.settings.identifier;
     }
+    /**
+     * Gets the export path where the artifact was generated.
+     *
+     * This method returns the file path where the generated artifact is located,
+     * which is useful for creating import statements or understanding the file
+     * structure of generated code.
+     *
+     * @returns The export path of the generated artifact
+     *
+     * @example
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User');
+     * const exportPath = userModel.toExportPath(); // './src/models/User.ts'
+     *
+     * // Create import statement
+     * const importStmt = `import { User } from '${exportPath}';`;
+     * ```
+     */
     toExportPath() {
         return this.settings.exportPath;
     }
+    /**
+     * Gets the generated value from the inserted artifact.
+     *
+     * This method returns the actual generated content with proper type safety
+     * based on the generation mode. For 'force' generation, the value is guaranteed
+     * to be present. For 'lazy' generation, the value might be undefined if
+     * generation was skipped.
+     *
+     * @returns The generated value, with optionality based on generation type
+     *
+     * @example Forced generation (guaranteed value)
+     * ```typescript
+     * const userModel = this.insertModel(generator, 'User'); // 'force' by default
+     * const value = userModel.toValue(); // UserModelValue (never undefined)
+     *
+     * // Safe to use directly
+     * const code = `type OrderUser = ${value};`;
+     * ```
+     *
+     * @example Lazy generation (optional value)
+     * ```typescript
+     * const optionalModel = this.insertModel(generator, 'Optional', { generation: 'lazy' });
+     * const value = optionalModel.toValue(); // OptionalValue | undefined
+     *
+     * if (value) {
+     *   // Use the generated value
+     *   const code = `type Optional = ${value};`;
+     * } else {
+     *   // Handle missing value (generation was skipped)
+     *   const code = 'type Optional = any; // Fallback';
+     * }
+     * ```
+     */
     toValue() {
         return this.definition?.value;
     }

package/esm/dsl/JsonFile.d.ts

@@ -1,12 +1,174 @@
+/**
+ * Constructor arguments for {@link JsonFile}.
+ */
 type JsonFileArgs = {
+    /** The file path for the generated JSON file */
     path: string;
+    /** The JSON content to write to the file */
     content: Record<string, unknown>;
 };
+/**
+ * Represents a JSON file in the SKMTC DSL system.
+ *
+ * The `JsonFile` class is used to generate JSON files as part of the code generation
+ * process. It provides a simple interface for creating configuration files, manifests,
+ * package.json files, and other JSON-based artifacts with proper formatting.
+ *
+ * ## Key Features
+ *
+ * - **JSON Formatting**: Automatically formats JSON with 2-space indentation
+ * - **Type Safety**: Accepts any valid JSON-serializable content structure
+ * - **Path Management**: Associates content with specific file paths
+ * - **String Conversion**: Easy integration with file writing systems
+ *
+ * @example Basic JSON file creation
+ * ```typescript
+ * import { JsonFile } from '@skmtc/core';
+ *
+ * const packageJson = new JsonFile({
+ *   path: './package.json',
+ *   content: {
+ *     name: 'my-api-client',
+ *     version: '1.0.0',
+ *     type: 'module',
+ *     main: './index.js',
+ *     dependencies: {
+ *       'axios': '^1.0.0'
+ *     }
+ *   }
+ * });
+ *
+ * const jsonContent = packageJson.toString();
+ * console.log(jsonContent);
+ * // {
+ * //   "name": "my-api-client",
+ * //   "version": "1.0.0",
+ * //   "type": "module",
+ * //   "main": "./index.js",
+ * //   "dependencies": {
+ * //     "axios": "^1.0.0"
+ * //   }
+ * // }
+ * ```
+ *
+ * @example Configuration file generation
+ * ```typescript
+ * const configFile = new JsonFile({
+ *   path: './src/config/api.json',
+ *   content: {
+ *     baseUrl: 'https://api.example.com',
+ *     timeout: 5000,
+ *     retryAttempts: 3,
+ *     endpoints: {
+ *       users: '/users',
+ *       products: '/products',
+ *       orders: '/orders'
+ *     }
+ *   }
+ * });
+ *
+ * // Write to file system
+ * await Deno.writeTextFile(configFile.path, configFile.toString());
+ * ```
+ *
+ * @example OpenAPI specification output
+ * ```typescript
+ * const openApiFile = new JsonFile({
+ *   path: './dist/openapi.json',
+ *   content: {
+ *     openapi: '3.0.0',
+ *     info: {
+ *       title: 'My API',
+ *       version: '1.0.0'
+ *     },
+ *     paths: {
+ *       '/users': {
+ *         get: {
+ *           summary: 'List users',
+ *           responses: {
+ *             '200': {
+ *               description: 'Success'
+ *             }
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }
+ * });
+ * ```
+ *
+ * @example Using with generator registration
+ * ```typescript
+ * class MyGenerator extends ContentBase {
+ *   generate() {
+ *     const manifestFile = new JsonFile({
+ *       path: './generated/manifest.json',
+ *       content: {
+ *         generatedAt: new Date().toISOString(),
+ *         version: '1.0.0',
+ *         files: [
+ *           './models/User.ts',
+ *           './models/Product.ts'
+ *         ]
+ *       }
+ *     });
+ *
+ *     // Register with the generation context
+ *     this.register({ jsonFile: manifestFile });
+ *   }
+ * }
+ * ```
+ */
 export declare class JsonFile {
+    /** The file type, always 'json' for JSON files */
     fileType: 'json';
+    /** The file path for this generated JSON file */
     path: string;
+    /** The JSON content to write to the file */
     content: Record<string, unknown>;
+    /**
+     * Creates a new JsonFile instance.
+     *
+     * @param args - JSON file configuration
+     * @param args.path - The output path for this JSON file
+     * @param args.content - The JSON content to write
+     *
+     * @example
+     * ```typescript
+     * const configFile = new JsonFile({
+     *   path: './config/settings.json',
+     *   content: {
+     *     theme: 'dark',
+     *     language: 'en',
+     *     features: ['auth', 'notifications']
+     *   }
+     * });
+     * ```
+     */
     constructor({ path, content }: JsonFileArgs);
+    /**
+     * Converts the JSON content to a formatted string.
+     *
+     * This method serializes the content object to JSON with 2-space indentation
+     * for readable output. The resulting string is suitable for writing directly
+     * to a file or including in the generation pipeline.
+     *
+     * @returns The formatted JSON content as a string
+     *
+     * @example
+     * ```typescript
+     * const file = new JsonFile({
+     *   path: './data.json',
+     *   content: { name: 'test', value: 42 }
+     * });
+     *
+     * console.log(file.toString());
+     * // {
+     * //   "name": "test",
+     * //   "value": 42
+     * // }
+     * ```
+     */
     toString(): string;
 }
 export {};