@craft-ts/dev-tools 0.7.0-beta.13

package/src/scripts/angular-brand-codemod.d.ts

@@ -0,0 +1,139 @@
+import { ClassDeclaration, Node, SourceFile } from 'ts-morph';
+export type AngularKind = 'component' | 'directive' | 'pipe' | 'injectable';
+export type AngularBrandMetadataContext = 'imports' | 'hostDirectives';
+export type AngularBrandConfigEntry = {
+    key: string;
+    symbol: string;
+    typeText?: string;
+    module?: string;
+};
+export type AngularBrandImportAugmentationRule = {
+    match: {
+        module: string;
+        symbols?: readonly string[];
+        metadata?: readonly AngularBrandMetadataContext[];
+    };
+    deps?: readonly AngularBrandConfigEntry[];
+    missingProvider?: readonly AngularBrandConfigEntry[];
+};
+export type AngularBrandConfig = {
+    importAugmentations?: readonly AngularBrandImportAugmentationRule[];
+};
+export type ServiceMigrationScope = 'global' | 'toProvide' | 'manuallyProvidedAtRoot' | 'function' | 'abstract';
+export type ServiceMigrationStrategy = 'craftService' | 'toCraftService' | 'companion' | 'ignore';
+export type ServiceMigrationOverride = {
+    file?: string;
+    module?: string;
+    symbol?: string;
+    name?: string;
+    providedIn?: ServiceMigrationScope;
+    strategy?: ServiceMigrationStrategy;
+};
+export type CraftDevToolsConfig = {
+    brand?: AngularBrandConfig;
+    serviceMigration?: {
+        overrides?: readonly ServiceMigrationOverride[];
+    };
+};
+export type TransformResult = {
+    changed: boolean;
+    skipped: boolean;
+    warnings: string[];
+    angularKind?: AngularKind;
+    className?: string;
+    dependencies: string[];
+    dependencyGroups: DependencyGroups;
+    generatedTypeName?: string;
+    generatedDependencyGroups: GeneratedDependencyGroups;
+};
+export type AngularBrandCodemodOptions = {
+    helperImportPath?: string;
+    transformOnlyStandaloneDeclarables?: boolean;
+    includeProviders?: boolean;
+    includeViewProviders?: boolean;
+    config?: AngularBrandConfig;
+    configFilePath?: string;
+};
+export type AngularClassSearchResult = {
+    classDeclaration?: ClassDeclaration;
+    angularKind?: AngularKind;
+    className?: string;
+    skipped: boolean;
+    warnings: string[];
+};
+export type DependencyExtractionResult = {
+    dependencies: string[];
+    warnings: string[];
+};
+export type DependencyGroups = {
+    injected: string[];
+    importDeps: string[];
+    providers: string[];
+};
+export type GeneratedDependencyEntry = {
+    key: string;
+    typeText: string;
+    typeImport?: {
+        moduleSpecifier: string;
+        name: string;
+    };
+};
+export type GeneratedDependencyGroups = {
+    deps: GeneratedDependencyEntry[];
+    propertiesDeps: GeneratedDependencyEntry[];
+    provided: GeneratedDependencyEntry[];
+    missingProvider: GeneratedDependencyEntry[];
+};
+export type DependencyAnalysisResult = Omit<TransformResult, 'changed'> & {
+    classDeclaration?: ClassDeclaration;
+};
+export type ExistingDependencyGroupsResult = {
+    found: boolean;
+    warnings: string[];
+    dependencyGroups: DependencyGroups;
+    exportAssignmentNode?: Node;
+    depsObjectNode?: Node;
+    propertyNodes: Partial<Record<keyof DependencyGroups, Node>>;
+};
+type InjectedDependencyDescriptor = {
+    dependencyText: string;
+    entry: GeneratedDependencyEntry;
+};
+type InjectCallDependencyExtractionResult = DependencyExtractionResult & {
+    generatedDependencies: InjectedDependencyDescriptor[];
+};
+type RunFileReport = TransformResult & {
+    filePath: string;
+};
+export type RunSummary = {
+    transformedFiles: number;
+    skippedFiles: number;
+    warnings: number;
+    countByAngularKind: Record<AngularKind, number>;
+    files: RunFileReport[];
+};
+export declare function defineAngularBrandConfig<Config extends AngularBrandConfig>(config: Config): Config;
+export declare function defineCraftDevToolsConfig<Config extends CraftDevToolsConfig>(config: Config): Config;
+export declare function discoverAngularBrandConfigFilePath(searchFromDir: string, stopDir?: string): string | undefined;
+export declare function loadAngularBrandConfigFromFile(configFilePath: string): AngularBrandConfig;
+export declare function transformSourceFile(sourceFile: SourceFile, options?: AngularBrandCodemodOptions): TransformResult;
+export declare function analyzeSourceFileDependencies(sourceFile: SourceFile, options?: AngularBrandCodemodOptions): DependencyAnalysisResult;
+export declare function findAngularDecoratedClass(sourceFile: SourceFile): AngularClassSearchResult;
+export declare function getAngularKind(classDeclaration: ClassDeclaration): AngularKind | undefined;
+export declare function isStandaloneDeclarable(classDeclaration: ClassDeclaration): boolean;
+export declare function extractDecoratorMetadataDeps(classDeclaration: ClassDeclaration, angularKind?: AngularKind | undefined, options?: AngularBrandCodemodOptions): DependencyExtractionResult;
+export declare function extractConstructorDeps(classDeclaration: ClassDeclaration): DependencyExtractionResult;
+export declare function extractInjectCallDeps(classDeclaration: ClassDeclaration): InjectCallDependencyExtractionResult;
+export declare function mergeDeps(...dependencyGroups: readonly string[][]): string[];
+export declare function writeGeneratedDepsTypeAlias(sourceFile: SourceFile, angularKind: AngularKind, className: string, generatedDependencyGroups: GeneratedDependencyGroups): void;
+export declare function migrateLegacyBrandExport(sourceFile: SourceFile, classDeclaration: ClassDeclaration, className: string): void;
+export declare function ensureHelperImports(sourceFile: SourceFile, helperImportPath: string): void;
+export declare function readExistingDependencyGroups(sourceFile: SourceFile, className?: string): ExistingDependencyGroupsResult;
+export declare function formatDependencyGroups(dependencyGroups: DependencyGroups): string;
+export declare function runAngularBrandCodemod(options?: AngularBrandCodemodOptions & {
+    rootDir?: string;
+    tsConfigFilePath?: string;
+    dryRun?: boolean;
+    log?: (message: string) => void;
+}): Promise<RunSummary>;
+export {};