@valkyrjaio/sindri 26.3.0 → 26.4.0

package/src/Sindri/Generator/Ast/Cli/AstCliDataFileGenerator.ts

@@ -14,6 +14,23 @@ import type { CliDataFileGeneratorContract } from '../../Cli/Contract/CliDataFil
 import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
 
 export class AstCliDataFileGenerator extends AstFileGenerator implements CliDataFileGeneratorContract {
+    /** The framework classes every generated CLI data file imports as values. */
+    protected static readonly FRAMEWORK_IMPORTS: Readonly<Record<string, string>> = {
+        CliRoutingData: '@valkyrjaio/valkyrja/Cli/Routing/Data/CliRoutingData.ts',
+        Route: '@valkyrjaio/valkyrja/Cli/Routing/Data/Route.ts',
+        ArgumentParameter: '@valkyrjaio/valkyrja/Cli/Routing/Data/ArgumentParameter.ts',
+        OptionParameter: '@valkyrjaio/valkyrja/Cli/Routing/Data/OptionParameter.ts',
+        ArgumentMode: '@valkyrjaio/valkyrja/Cli/Routing/Enum/ArgumentMode.ts',
+        ArgumentValueMode: '@valkyrjaio/valkyrja/Cli/Routing/Enum/ArgumentValueMode.ts',
+        OptionMode: '@valkyrjaio/valkyrja/Cli/Routing/Enum/OptionMode.ts',
+        OptionValueMode: '@valkyrjaio/valkyrja/Cli/Routing/Enum/OptionValueMode.ts',
+    };
+
+    /** The framework types every generated CLI data file imports. */
+    protected static readonly FRAMEWORK_TYPE_IMPORTS: Readonly<Record<string, string>> = {
+        RouteContract: '@valkyrjaio/valkyrja/Cli/Routing/Data/Contract/RouteContract.ts',
+    };
+
     public classImportMap: Record<string, string> = {};
 
     private readonly printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
@@ -32,22 +49,18 @@ export class AstCliDataFileGenerator extends AstFileGenerator implements CliData
         namespace: string,
         routes: Record<string, ts.Expression>,
     ): GenerateStatus {
-        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap);
+        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap, [
+            ...Object.keys(AstCliDataFileGenerator.FRAMEWORK_IMPORTS),
+            ...Object.keys(AstCliDataFileGenerator.FRAMEWORK_TYPE_IMPORTS),
+        ]);
 
         const contents = this.generateClassContents(routes);
 
         const data = [
             '// This file was automatically generated by Sindri.',
             '',
-            `import { CliRoutingData } from '@valkyrjaio/valkyrja/Cli/Routing/Data/CliRoutingData.ts';`,
-            `import { Route } from '@valkyrjaio/valkyrja/Cli/Routing/Data/Route.ts';`,
-            `import { ArgumentParameter } from '@valkyrjaio/valkyrja/Cli/Routing/Data/ArgumentParameter.ts';`,
-            `import { OptionParameter } from '@valkyrjaio/valkyrja/Cli/Routing/Data/OptionParameter.ts';`,
-            `import { ArgumentMode } from '@valkyrjaio/valkyrja/Cli/Routing/Enum/ArgumentMode.ts';`,
-            `import { ArgumentValueMode } from '@valkyrjaio/valkyrja/Cli/Routing/Enum/ArgumentValueMode.ts';`,
-            `import { OptionMode } from '@valkyrjaio/valkyrja/Cli/Routing/Enum/OptionMode.ts';`,
-            `import { OptionValueMode } from '@valkyrjaio/valkyrja/Cli/Routing/Enum/OptionValueMode.ts';`,
-            `import type { RouteContract } from '@valkyrjaio/valkyrja/Cli/Routing/Data/Contract/RouteContract.ts';`,
+            ...this.buildFrameworkImportLines(AstCliDataFileGenerator.FRAMEWORK_IMPORTS),
+            ...this.buildFrameworkImportLines(AstCliDataFileGenerator.FRAMEWORK_TYPE_IMPORTS, true),
             userImportsBlock,
             `export class ${className} extends CliRoutingData {`,
             `    constructor() {`,
@@ -78,18 +91,43 @@ export class AstCliDataFileGenerator extends AstFileGenerator implements CliData
                 continue;
             }
 
-            const nameArg = (expr.arguments ?? [])[0];
+            const key = this.routeKey((expr.arguments ?? [])[0]);
 
-            if (nameArg === undefined || !ts.isStringLiteral(nameArg)) {
+            if (key === undefined) {
                 continue;
             }
 
-            routes[nameArg.text] = expr;
+            routes[key] = expr;
         }
 
         return this.generateFile(directory, className, namespace, routes);
     }
 
+    /**
+     * Derive the map key for a route from its name argument.
+     *
+     * A literal name keys the map by its own text. A constant reference
+     * (`CliCommandName.LIST` — how the framework's own commands name
+     * themselves) is kept as a `Class::CASE` marker, so the generated file
+     * emits the constant reference as a computed key rather than baking in the
+     * value it happens to hold today.
+     */
+    protected routeKey(nameArg: ts.Expression | undefined): string | undefined {
+        if (nameArg === undefined) {
+            return undefined;
+        }
+
+        if (ts.isStringLiteral(nameArg)) {
+            return nameArg.text;
+        }
+
+        if (ts.isPropertyAccessExpression(nameArg) && ts.isIdentifier(nameArg.expression)) {
+            return `${nameArg.expression.text}::${nameArg.name.text}`;
+        }
+
+        return undefined;
+    }
+
     public generateClassContents(routes: Record<string, ts.Expression>): string {
         const entries = Object.entries(routes);
 

package/src/Sindri/Generator/Ast/Container/AstContainerDataFileGenerator.ts

@@ -14,6 +14,16 @@ import type { ContainerDataFileGeneratorContract } from '../../Container/Contrac
 import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
 
 export class AstContainerDataFileGenerator extends AstFileGenerator implements ContainerDataFileGeneratorContract {
+    /** The framework class every generated container data file imports as a value. */
+    protected static readonly FRAMEWORK_IMPORTS: Readonly<Record<string, string>> = {
+        ContainerData: '@valkyrjaio/valkyrja/Container/Data/ContainerData.ts',
+    };
+
+    /** The framework type every generated container data file imports. */
+    protected static readonly FRAMEWORK_TYPE_IMPORTS: Readonly<Record<string, string>> = {
+        ContainerContract: '@valkyrjaio/valkyrja/Container/Manager/Contract/ContainerContract.ts',
+    };
+
     public classImportMap: Record<string, string> = {};
 
     private readonly printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
@@ -32,15 +42,18 @@ export class AstContainerDataFileGenerator extends AstFileGenerator implements C
         namespace: string,
         publishers: Readonly<Record<string, readonly [string, string]>>,
     ): GenerateStatus {
-        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap);
+        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap, [
+            ...Object.keys(AstContainerDataFileGenerator.FRAMEWORK_IMPORTS),
+            ...Object.keys(AstContainerDataFileGenerator.FRAMEWORK_TYPE_IMPORTS),
+        ]);
 
         const contents = this.generateClassContents(publishers);
 
         const data = [
             '// This file was automatically generated by Sindri.',
             '',
-            `import { ContainerData } from '@valkyrjaio/valkyrja/Container/Data/ContainerData.ts';`,
-            `import type { ContainerContract } from '@valkyrjaio/valkyrja/Container/Manager/Contract/ContainerContract.ts';`,
+            ...this.buildFrameworkImportLines(AstContainerDataFileGenerator.FRAMEWORK_IMPORTS),
+            ...this.buildFrameworkImportLines(AstContainerDataFileGenerator.FRAMEWORK_TYPE_IMPORTS, true),
             userImportsBlock,
             `export class ${className} extends ContainerData {`,
             `    constructor() {`,

package/src/Sindri/Generator/Ast/Event/AstEventDataFileGenerator.ts

@@ -14,6 +14,21 @@ import type { EventDataFileGeneratorContract } from '../../Event/Contract/EventD
 import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
 
 export class AstEventDataFileGenerator extends AstFileGenerator implements EventDataFileGeneratorContract {
+    /** The framework class every generated event data file imports as a value. */
+    protected static readonly FRAMEWORK_IMPORTS: Readonly<Record<string, string>> = {
+        EventData: '@valkyrjaio/valkyrja/Event/Data/EventData.ts',
+    };
+
+    /** The framework classes a generated event data file imports only when it holds listeners. */
+    protected static readonly LISTENER_IMPORTS: Readonly<Record<string, string>> = {
+        Listener: '@valkyrjaio/valkyrja/Event/Data/Listener.ts',
+    };
+
+    /** The framework types a generated event data file imports only when it holds listeners. */
+    protected static readonly LISTENER_TYPE_IMPORTS: Readonly<Record<string, string>> = {
+        ListenerContract: '@valkyrjaio/valkyrja/Event/Data/Contract/ListenerContract.ts',
+    };
+
     public classImportMap: Record<string, string> = {};
 
     private readonly printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
@@ -32,7 +47,11 @@ export class AstEventDataFileGenerator extends AstFileGenerator implements Event
         namespace: string,
         listeners: Record<string, ts.Expression>,
     ): GenerateStatus {
-        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap);
+        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap, [
+            ...Object.keys(AstEventDataFileGenerator.FRAMEWORK_IMPORTS),
+            ...Object.keys(AstEventDataFileGenerator.LISTENER_IMPORTS),
+            ...Object.keys(AstEventDataFileGenerator.LISTENER_TYPE_IMPORTS),
+        ]);
 
         const contents = this.generateClassContents(listeners);
 
@@ -42,15 +61,15 @@ export class AstEventDataFileGenerator extends AstFileGenerator implements Event
         const listenerImports =
             Object.keys(listeners).length > 0
                 ? [
-                      `import { Listener } from '@valkyrjaio/valkyrja/Event/Data/Listener.ts';`,
-                      `import type { ListenerContract } from '@valkyrjaio/valkyrja/Event/Data/Contract/ListenerContract.ts';`,
+                      ...this.buildFrameworkImportLines(AstEventDataFileGenerator.LISTENER_IMPORTS),
+                      ...this.buildFrameworkImportLines(AstEventDataFileGenerator.LISTENER_TYPE_IMPORTS, true),
                   ]
                 : [];
 
         const data = [
             '// This file was automatically generated by Sindri.',
             '',
-            `import { EventData } from '@valkyrjaio/valkyrja/Event/Data/EventData.ts';`,
+            ...this.buildFrameworkImportLines(AstEventDataFileGenerator.FRAMEWORK_IMPORTS),
             ...listenerImports,
             userImportsBlock,
             `export class ${className} extends EventData {`,

package/src/Sindri/Generator/Ast/Http/AstHttpDataFileGenerator.ts

@@ -34,6 +34,21 @@ interface ImperativeRouteMeta {
 }
 
 export class AstHttpDataFileGenerator extends AstFileGenerator implements HttpDataFileGeneratorContract {
+    /** The framework classes every generated HTTP data file imports as values. */
+    protected static readonly FRAMEWORK_IMPORTS: Readonly<Record<string, string>> = {
+        HttpRoutingData: '@valkyrjaio/valkyrja/Http/Routing/Data/HttpRoutingData.ts',
+        DynamicRoute: '@valkyrjaio/valkyrja/Http/Routing/Data/DynamicRoute.ts',
+        Route: '@valkyrjaio/valkyrja/Http/Routing/Data/Route.ts',
+        Parameter: '@valkyrjaio/valkyrja/Http/Routing/Data/Parameter.ts',
+        RequestMethod: '@valkyrjaio/valkyrja/Http/Message/Enum/RequestMethod.ts',
+        Regex: '@valkyrjaio/valkyrja/Http/Routing/Constant/Regex.ts',
+    };
+
+    /** The framework types every generated HTTP data file imports. */
+    protected static readonly FRAMEWORK_TYPE_IMPORTS: Readonly<Record<string, string>> = {
+        RouteContract: '@valkyrjaio/valkyrja/Http/Routing/Data/Contract/RouteContract.ts',
+    };
+
     public classImportMap: Record<string, string> = {};
 
     protected readonly processor: ProcessorContract;
@@ -60,7 +75,10 @@ export class AstHttpDataFileGenerator extends AstFileGenerator implements HttpDa
         routes: Record<string, ts.Expression>,
         routeData: Record<string, HttpRouteData>,
     ): GenerateStatus {
-        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap);
+        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap, [
+            ...Object.keys(AstHttpDataFileGenerator.FRAMEWORK_IMPORTS),
+            ...Object.keys(AstHttpDataFileGenerator.FRAMEWORK_TYPE_IMPORTS),
+        ]);
 
         const routesContent = this.getRoutesAsContent(routes, routeData);
         const paths = this.printNestedObject(this.buildPaths(routeData));
@@ -87,7 +105,10 @@ export class AstHttpDataFileGenerator extends AstFileGenerator implements HttpDa
         _namespace: string,
         routeExprs: readonly ts.Expression[],
     ): GenerateStatus {
-        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap);
+        const userImportsBlock = this.buildUserImportsBlock(this.classImportMap, [
+            ...Object.keys(AstHttpDataFileGenerator.FRAMEWORK_IMPORTS),
+            ...Object.keys(AstHttpDataFileGenerator.FRAMEWORK_TYPE_IMPORTS),
+        ]);
 
         const metas = routeExprs
             .map((expr) => this.extractRouteMeta(expr))
@@ -114,13 +135,8 @@ export class AstHttpDataFileGenerator extends AstFileGenerator implements HttpDa
         return [
             '// This file was automatically generated by Sindri.',
             '',
-            `import { HttpRoutingData } from '@valkyrjaio/valkyrja/Http/Routing/Data/HttpRoutingData.ts';`,
-            `import { DynamicRoute } from '@valkyrjaio/valkyrja/Http/Routing/Data/DynamicRoute.ts';`,
-            `import { Route } from '@valkyrjaio/valkyrja/Http/Routing/Data/Route.ts';`,
-            `import { Parameter } from '@valkyrjaio/valkyrja/Http/Routing/Data/Parameter.ts';`,
-            `import { RequestMethod } from '@valkyrjaio/valkyrja/Http/Message/Enum/RequestMethod.ts';`,
-            `import { Regex } from '@valkyrjaio/valkyrja/Http/Routing/Constant/Regex.ts';`,
-            `import type { RouteContract } from '@valkyrjaio/valkyrja/Http/Routing/Data/Contract/RouteContract.ts';`,
+            ...this.buildFrameworkImportLines(AstHttpDataFileGenerator.FRAMEWORK_IMPORTS),
+            ...this.buildFrameworkImportLines(AstHttpDataFileGenerator.FRAMEWORK_TYPE_IMPORTS, true),
             userImportsBlock,
             `export class ${className} extends HttpRoutingData {`,
             `    constructor() {`,