nest-hex 0.2.0 → 0.2.2

package/dist/src/cli/generators/index.d.ts

@@ -0,0 +1,264 @@
+/**
+* Configuration types for nest-hex CLI
+*/
+interface NestHexConfig {
+	/**
+	* Output directory configuration
+	*/
+	output?: {
+		/**
+		* Directory for generated ports
+		* @default 'src/ports'
+		*/
+		portsDir?: string;
+		/**
+		* Directory for generated adapters
+		* @default 'src/adapters'
+		*/
+		adaptersDir?: string;
+	};
+	/**
+	* Naming conventions
+	*/
+	naming?: {
+		/**
+		* Suffix for port tokens
+		* @default 'PORT'
+		*/
+		portSuffix?: string;
+		/**
+		* Suffix for adapter classes
+		* @default 'Adapter'
+		*/
+		adapterSuffix?: string;
+		/**
+		* File naming case
+		* @default 'kebab'
+		*/
+		fileCase?: "kebab" | "camel" | "pascal";
+	};
+	/**
+	* Code style preferences
+	*/
+	style?: {
+		/**
+		* Indentation style
+		* @default 'tab'
+		*/
+		indent?: "tab" | 2 | 4;
+		/**
+		* Quote style
+		* @default 'single'
+		*/
+		quotes?: "single" | "double";
+		/**
+		* Use semicolons
+		* @default true
+		*/
+		semicolons?: boolean;
+	};
+	/**
+	* Custom template paths
+	*/
+	templates?: {
+		portModule?: string;
+		portToken?: string;
+		portInterface?: string;
+		portService?: string;
+		adapterModule?: string;
+		adapterService?: string;
+		adapterTypes?: string;
+	};
+}
+/**
+* Generator types for CLI
+*/
+interface GeneratorOptions {
+	name: string;
+	outputPath?: string;
+	includeModule?: boolean;
+	includeService?: boolean;
+	registrationType?: "sync" | "async";
+	generateExample?: boolean;
+	dryRun?: boolean;
+}
+interface GeneratorContext extends Record<string, unknown> {
+	original: string;
+	kebab: string;
+	camel: string;
+	pascal: string;
+	snake: string;
+	screamingSnake: string;
+	nameKebab: string;
+	nameCamel: string;
+	namePascal: string;
+	nameSnake: string;
+	nameScreamingSnake: string;
+	portSuffix: string;
+	adapterSuffix: string;
+	fileCase: "kebab" | "camel" | "pascal";
+	indent: "tab" | number;
+	quotes: "single" | "double";
+	semicolons: boolean;
+	includeModule: boolean;
+	includeService: boolean;
+	registrationType: "sync" | "async";
+	generateExample: boolean;
+	coreImportPath: string;
+}
+interface FileToGenerate {
+	path: string;
+	content: string;
+}
+interface GeneratorResult {
+	files: string[];
+	success: boolean;
+	message?: string;
+}
+interface NameVariations {
+	original: string;
+	kebab: string;
+	camel: string;
+	pascal: string;
+	snake: string;
+	screamingSnake: string;
+}
+declare function generateNameVariations(name: string): NameVariations;
+/**
+* Abstract base class for all generators.
+*
+* Provides common functionality like:
+* - Template rendering
+* - File writing
+* - Name transformations
+* - Path resolution
+*/
+declare abstract class BaseGenerator {
+	protected readonly config: NestHexConfig;
+	constructor(config: NestHexConfig);
+	/**
+	* Render a template with the given context.
+	*
+	* @param templatePath - Path to the Handlebars template file
+	* @param context - Template context
+	* @returns Rendered template content
+	*/
+	protected renderTemplate(templatePath: string, context: GeneratorContext): Promise<string>;
+	/**
+	* Write a file to disk.
+	*
+	* @param filePath - Destination file path
+	* @param content - File content
+	* @param dryRun - If true, don't actually write the file
+	* @returns WriteResult indicating success and conflict status
+	*/
+	protected writeFile(filePath: string, content: string, dryRun?: boolean): Promise<import("../utils/file-writer").WriteResult>;
+	/**
+	* Generate all name variations for a given name.
+	*
+	* @param name - Original name
+	* @returns Object with all name case variations
+	*/
+	protected getNameVariations(name: string): ReturnType<typeof generateNameVariations>;
+	/**
+	* Resolve a path relative to the project root.
+	*
+	* @param relativePath - Relative path
+	* @returns Absolute path
+	*/
+	protected resolvePath(relativePath: string): string;
+	/**
+	* Get the template directory for a specific generator type.
+	*
+	* @param type - Generator type (port, adapter, service)
+	* @returns Absolute path to template directory
+	*/
+	protected getTemplateDir(type: "port" | "adapter" | "service" | "examples"): string;
+	/**
+	* Create a template context from generator options.
+	*
+	* @param options - Generator options
+	* @param additionalContext - Additional context to merge
+	* @returns Complete template context
+	*/
+	protected createTemplateContext(options: GeneratorOptions, additionalContext?: Record<string, unknown>): GeneratorContext;
+	/**
+	* Generate files from a list of file specifications.
+	*
+	* @param files - Array of files to generate
+	* @param dryRun - If true, don't actually write files
+	* @returns Array of successfully generated file paths
+	* @throws Error if any files fail to write
+	*/
+	protected generateFiles(files: FileToGenerate[], dryRun?: boolean): Promise<string[]>;
+}
+/**
+* Additional options for adapter generation.
+*/
+interface AdapterGeneratorOptions extends GeneratorOptions {
+	/**
+	* Name of the port this adapter implements.
+	* Used to generate correct imports and token references.
+	*/
+	portName?: string;
+	/**
+	* Path to the port interface file (for imports).
+	* If not provided, assumes standard structure.
+	*/
+	portPath?: string;
+	/**
+	* Port token name (e.g., "OBJECT_STORAGE_PORT").
+	* Used in the @Port decorator.
+	*/
+	portTokenName?: string;
+	/**
+	* Technology or service being adapted (e.g., "AWS S3", "HTTP API").
+	* Used in documentation comments.
+	*/
+	technology?: string;
+}
+/**
+* Generator for creating adapter files.
+*
+* Generates:
+* - Adapter class (extends Adapter base class with @Port decorator)
+* - Service implementation (implements the port interface)
+* - Types file (adapter configuration options)
+* - Index file (barrel exports)
+*/
+declare class AdapterGenerator extends BaseGenerator {
+	/**
+	* Generate all adapter files.
+	*/
+	generate(options: AdapterGeneratorOptions): Promise<GeneratorResult>;
+}
+/**
+* Generator for creating port files.
+*
+* Generates:
+* - Port interface (domain contract)
+* - Port token (dependency injection token)
+* - Port service (optional - domain service using the port)
+* - Port module (optional - feature module wrapper)
+* - Index file (barrel exports)
+*/
+declare class PortGenerator extends BaseGenerator {
+	/**
+	* Generate all port files.
+	*/
+	generate(options: GeneratorOptions): Promise<GeneratorResult>;
+}
+/**
+* Generator for creating standalone services.
+*
+* Generates:
+* - Injectable service that uses @InjectPort to inject an existing port
+* - Can be created with or without port injection scaffolding
+*/
+declare class ServiceGenerator extends BaseGenerator {
+	/**
+	* Generate service file.
+	*/
+	generate(options: GeneratorOptions): Promise<GeneratorResult>;
+}
+export { ServiceGenerator, PortGenerator, BaseGenerator, AdapterGeneratorOptions, AdapterGenerator };