/** * @angular-modernizer/plugin-angular - Component Inputs Interface Extraction Rule * * Transform rule that extracts @Input() properties into a separate interface * for better type safety and component API definition. * * Philosophy: "Thin Rule, Thick Orchestrator" * - The rule is a minimal wrapper * - All business logic lives in the orchestrator * - The rule handles the plugin protocol (TransformRule interface) */ import type { TransformRule, TransformContext, TransformResult, } from '@angular-modernizer/plugin-system'; import type { PublicApi } from '@angular-modernizer/api'; import { ComponentInputsInterfaceExtractionOrchestrator } from '../orchestrators/component-inputs-interface-extraction-orchestrator.js'; /** * Transform rule for extracting @Input() properties into interfaces. * * @remarks * This rule implements the {@link TransformRule} interface and serves as the * bridge between the Angular Modernizer's plugin system and the component * inputs interface extraction orchestrator. It follows the "Thin Rule, Thick Orchestrator" pattern * where the rule handles protocol compliance while delegating all business logic * to the {@link ComponentInputsInterfaceExtractionOrchestrator}. * * ## What It Does * * The rule orchestrates the extraction of: * - **@Input() properties**: Moves all @Input() decorated properties to a separate interface * - **Type safety**: Creates strongly-typed interfaces for component APIs * - **Component implementation**: Makes components implement the extracted interface * - **Preservation**: Keeps @Input() decorators and default values on component properties * * ## Example Usage * * This rule is typically not used directly, but rather accessed through the * {@link AngularPlugin}: * * ```typescript * const plugin = new AngularPlugin(); * const rules = plugin.getTransformRules(); * const rule = rules.find(r => r.id === 'angular:component-inputs-interface-extraction'); * const result = await rule.transform(context); * ``` * * ## Transformation Behavior * * **Input Properties Extraction**: * ```typescript * // Before * export class UserCardComponent { * @Input() user: { name: string; age: number }; * @Input() theme: string = 'light'; * } * * // After * interface UserCardComponentInputs { * user: { name: string; age: number }; * theme: string; * } * * export class UserCardComponent implements UserCardComponentInputs { * @Input() user: { name: string; age: number }; * @Input() theme: string = 'light'; * } * ``` * * @see {@link ComponentInputsInterfaceExtractionOrchestrator} for transformation logic * @see {@link TransformRule} for the interface contract * @see {@link AngularPlugin} for plugin integration * * @public */ export class ComponentInputsInterfaceExtractionRule implements TransformRule { /** * Unique rule identifier. * Format: "plugin-name:rule-name" */ public readonly id = 'angular:component-inputs-interface-extraction'; /** * Human-readable rule name. */ public readonly name = 'Component Inputs Interface Extraction'; /** * Rule description. */ public readonly description = 'Extracts @Input() properties into a separate interface for better type safety and component API definition'; /** * Rule category for grouping. */ public readonly category = 'modernization'; /** * Tags for filtering and search. */ public readonly tags = [ 'angular', 'component', 'inputs', 'interface', 'type-safety', 'modernization', ]; /** * The orchestrator that performs the actual transformation. */ private readonly orchestrator = new ComponentInputsInterfaceExtractionOrchestrator(); /** * Transform a source file by extracting @Input() properties into interfaces. * * @remarks * This method implements the {@link TransformRule.transform} contract. * It delegates to the {@link ComponentInputsInterfaceExtractionOrchestrator} for the actual * transformation work, then packages the result into a {@link TransformResult}. * * The method: * 1. Captures the file's initial state * 2. Invokes the orchestrator to perform the extraction * 3. Detects whether the file was modified * 4. Returns a standardized {@link TransformResult} * * ## Return Value * * The transform result includes: * - `modified`: Whether the file was changed * - `message`: A human-readable summary * - `filePath`: The path to the transformed file * - `ruleId`: This rule's identifier * * @param context - Transform context with file, project, and API access * * @returns Promise resolving to the transformation result * * @example * ```typescript * const rule = new ComponentInputsInterfaceExtractionRule(); * const result = await rule.transform(context); * * if (result.modified) { * console.info(`Extracted inputs interface: ${result.filePath}`); * } * ``` * * @public */ async transform( context: TransformContext, ): Promise { const { sourceFile, filePath } = context; // Check if this transformation type is requested const pluginConfig = context.config[ '@angular-modernizer/plugin-angular' ] as Record | undefined; if ( pluginConfig?.['transformationType'] !== 'component-inputs-interface-extraction' ) { return { ruleId: this.id, modified: false, message: 'Transformation type not applicable', filePath, }; } // Capture initial state to detect modifications const initialText = sourceFile.getFullText(); // Run the orchestrator this.orchestrator.run(context); // Detect if the file was modified const modified = sourceFile.getFullText() !== initialText; // Return the result return { ruleId: this.id, modified, message: modified ? `Successfully extracted @Input() properties into interface` : `No @Input properties found to extract`, filePath, }; } }