Merge pull request #64 from joaovjo/feature/sprint-10

feat(routing): typed route registry + routes:compile (Sprint 10)

Author: joaovjo

dist/index.d.ts

@@ -65,6 +65,7 @@ export type {
     MigrateRefreshCommandOptions,
     MigrateRollbackCommandOptions,
     ParsedArguments,
+    RoutesCompileCommandOptions,
     StubWriteResult,
 } from "@ninots/console";
 export {
@@ -81,6 +82,7 @@ export {
     MigrateRollbackCommand,
     OutputStyle,
     PathResolver,
+    RoutesCompileCommand,
     StubExistsError,
     applyStubReplacements,
     migrationTimestamp,
@@ -167,8 +169,17 @@ export type {
     RouteHandler,
     RouteMatch,
     RouteParams,
+    RouteRegistry,
+    RouteResolver,
+} from "@ninots/routing";
+export {
+    Route,
+    Router,
+    emitRouteRegistry,
+    loadRoutes,
+    route,
+    setRouteResolver,
 } from "@ninots/routing";
-export { Route, Router } from "@ninots/routing";
 export * from "@ninots/session";
 export * from "@ninots/support";
 export * from "@ninots/validation";

index.ts

@@ -65,6 +65,7 @@ export type {
     MigrateRefreshCommandOptions,
     MigrateRollbackCommandOptions,
     ParsedArguments,
+    RoutesCompileCommandOptions,
     StubWriteResult,
 } from "@ninots/console";
 export {
@@ -81,6 +82,7 @@ export {
     MigrateRollbackCommand,
     OutputStyle,
     PathResolver,
+    RoutesCompileCommand,
     StubExistsError,
     applyStubReplacements,
     migrationTimestamp,
@@ -167,8 +169,17 @@ export type {
     RouteHandler,
     RouteMatch,
     RouteParams,
+    RouteRegistry,
+    RouteResolver,
+} from "@ninots/routing";
+export {
+    Route,
+    Router,
+    emitRouteRegistry,
+    loadRoutes,
+    route,
+    setRouteResolver,
 } from "@ninots/routing";
-export { Route, Router } from "@ninots/routing";
 export * from "@ninots/session";
 export * from "@ninots/support";
 export * from "@ninots/validation";

package.json

@@ -37,6 +37,7 @@
         "verify:all": "bun run verify:no-any && bun run type-check && bun run test && bun run lint",
         "verify:explicit-types": "tsc --noImplicitAny --strict --noEmit",
         "verify:no-any": "bun run scripts/verify.ts no-any",
+        "verify:route-types": "bun run scripts/verify-route-types.ts",
         "verify:tests": "bun test"
     },
     "bin": {

packages/console/dist/index.d.ts

@@ -12,6 +12,7 @@ export { MakeViewCommand, type MakeViewCommandOptions } from "./src/commands/mak
 export { MigrateCommand, type MigrateCommandOptions } from "./src/commands/migrate-command";
 export { MigrateRefreshCommand, type MigrateRefreshCommandOptions, } from "./src/commands/migrate-refresh-command";
 export { MigrateRollbackCommand, type MigrateRollbackCommandOptions, } from "./src/commands/migrate-rollback-command";
+export { RoutesCompileCommand, type RoutesCompileCommandOptions, } from "./src/commands/routes-compile-command";
 export { Command } from "./src/command";
 export { PathResolver, StubExistsError, applyStubReplacements, migrationTimestamp, normalizeControllerName, normalizeMigrationName, normalizeModelName, normalizeModuleName, normalizeViewName, type GeneratorPathsConfig, type StubWriteResult, } from "./src/generator";
 export type { CommandInterface } from "./src/contracts/command-interface";

packages/console/dist/src/commands/make-controller-command.d.ts

@@ -12,6 +12,7 @@ export declare class MakeControllerCommand extends Command {
     private readonly resolver;
     constructor(options?: MakeControllerCommandOptions);
     handle(): Promise<number>;
+    private ensureResourceView;
     private ensureWebBinding;
     private writeWebResourceRoutes;
     private writeApiResourceRoutes;

packages/console/dist/src/commands/routes-compile-command.d.ts

@@ -0,0 +1,18 @@
+import type { Router } from "@ninots/routing";
+import { Command } from "../command";
+export interface RoutesCompileCommandOptions {
+    readonly resolveRouter: () => Router | Promise<Router>;
+}
+/**
+ * Compile a typed route registry (`.d.ts`) from the application's Router.
+ *
+ * Boot path: inject `resolveRouter` (same pattern as MigrateCommand) —
+ * typically `bootstrap()` → `ROUTER_KEY` → `getRoutes()`. Writes via `Bun.write`.
+ */
+export declare class RoutesCompileCommand extends Command {
+    private readonly options;
+    signature: string;
+    description: string;
+    constructor(options: RoutesCompileCommandOptions);
+    handle(): Promise<number>;
+}

packages/console/dist/src/generator/stub-templates.d.ts

@@ -1,14 +1,14 @@
 export declare const STUB_TEMPLATES: {
-    readonly "api-resource-routes": "        router.get(\"/{{ routePrefix }}\", () => {{ variableName }}.index());\n        router.get(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.show(request, params));\n        router.put(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.update(request, params));\n        router.delete(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.destroy(request, params));\n";
+    readonly "api-resource-routes": "        router.get(\"/{{ routePrefix }}\", () => {{ variableName }}.index()).name(\"{{ routePrefix }}.index\");\n        router.get(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.show(request, params)).name(\"{{ routePrefix }}.show\");\n        router.put(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.update(request, params)).name(\"{{ routePrefix }}.update\");\n        router.delete(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.destroy(request, params)).name(\"{{ routePrefix }}.destroy\");\n";
     readonly controller: "import { Controller } from \"@/app/Http/Controllers/Controller\";\n\n/**\n * {{ className }} HTTP controller.\n */\nexport class {{ className }} extends Controller {\n}\n";
     readonly "controller-api": "import type { RouteParams } from \"@ninots/framework\";\nimport { Controller } from \"@/app/Http/Controllers/Controller\";\n\n/**\n * {{ className }} API resource controller (no POST routes).\n */\nexport class {{ className }} extends Controller {\n    public async index(): Promise<Response> {\n        return this.json([]);\n    }\n\n    public async show(_request: Request, params?: RouteParams): Promise<Response> {\n        return this.json({ id: params?.id });\n    }\n\n    public async update(request: Request, params?: RouteParams): Promise<Response> {\n        const data = (await request.json()) as Record<string, unknown>;\n        return this.json({ id: params?.id, ...data });\n    }\n\n    public async destroy(_request: Request, params?: RouteParams): Promise<Response> {\n        return this.noContent();\n    }\n}\n";
     readonly "controller-resource": "import type { RouteParams } from \"@ninots/framework\";\nimport { render } from \"@ninots/view\";\nimport { Controller } from \"@/app/Http/Controllers/Controller\";\nimport { {{ viewExportName }} } from \"{{ viewImportPath }}\";\n\n/**\n * {{ className }} resource controller (web + CSRF group).\n */\nexport class {{ className }} extends Controller {\n    public async index(): Promise<Response> {\n        return render({{ viewExportName }}, {});\n    }\n\n    public async create(): Promise<Response> {\n        return render({{ viewExportName }}, { title: \"Create\" });\n    }\n\n    public async store(_request: Request): Promise<Response> {\n        return this.redirect(\"/{{ routePrefix }}\");\n    }\n\n    public async show(_request: Request, params?: RouteParams): Promise<Response> {\n        return render({{ viewExportName }}, { id: params?.id });\n    }\n\n    public async edit(_request: Request, params?: RouteParams): Promise<Response> {\n        return render({{ viewExportName }}, { id: params?.id, title: \"Edit\" });\n    }\n\n    public async update(_request: Request, params?: RouteParams): Promise<Response> {\n        return this.json({ id: params?.id, updated: true });\n    }\n\n    public async destroy(_request: Request, params?: RouteParams): Promise<Response> {\n        return this.noContent();\n    }\n}\n";
     readonly migration: "import type { Connection, Migration } from \"@ninots/framework\";\n\n/**\n * {{ className }} migration.\n */\nexport default class {{ className }} implements Migration {\n    public async up(connection: Connection): Promise<void> {\n        await connection.run(`\n            CREATE TABLE IF NOT EXISTS {{ tableName }} (\n                id INTEGER PRIMARY KEY AUTOINCREMENT\n            )\n        `);\n    }\n\n    public async down(connection: Connection): Promise<void> {\n        await connection.run(\"DROP TABLE IF EXISTS {{ tableName }}\");\n    }\n}\n";
     readonly model: "import { Model, Table } from \"@ninots/framework\";\n\n/**\n * {{ className }} model.\n */\n@Table(\"{{ tableName }}\")\nexport class {{ className }} extends Model {\n    protected static override fillable: string[] = [];\n}\n";
     readonly view: "import { withLayout } from \"@ninots/view\";\nimport { AppLayout } from \"@/resources/views/layouts/app\";\n\nexport interface {{ exportName }}Props {\n    title?: string;\n    id?: string;\n}\n\nfunction {{ exportName }}Page({ title = \"{{ exportName }}\", id }: {{ exportName }}Props) {\n    return (\n        <section className=\"welcome\">\n            <h1>{title}</h1>\n            {id ? <p>Resource ID: {id}</p> : null}\n        </section>\n    );\n}\n\nexport const {{ exportName }} = withLayout(AppLayout, {{ exportName }}Page, { title: \"{{ exportName }} — Ninots\" });\n";
-    readonly "web-resource-routes": "        router.get(\"/{{ routePrefix }}\", () => {{ variableName }}.index());\n        router.get(\"/{{ routePrefix }}/create\", () => {{ variableName }}.create());\n        router.post(\"/{{ routePrefix }}\", (request) => {{ variableName }}.store(request));\n        router.get(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.show(request, params));\n        router.get(\"/{{ routePrefix }}/:id/edit\", (request, params) => {{ variableName }}.edit(request, params));\n        router.put(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.update(request, params));\n        router.delete(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.destroy(request, params));\n";
+    readonly "web-resource-routes": "        router.get(\"/{{ routePrefix }}\", () => {{ variableName }}.index()).name(\"{{ routePrefix }}.index\");\n        router.get(\"/{{ routePrefix }}/create\", () => {{ variableName }}.create()).name(\"{{ routePrefix }}.create\");\n        router.post(\"/{{ routePrefix }}\", (request) => {{ variableName }}.store(request)).name(\"{{ routePrefix }}.store\");\n        router.get(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.show(request, params)).name(\"{{ routePrefix }}.show\");\n        router.get(\"/{{ routePrefix }}/:id/edit\", (request, params) => {{ variableName }}.edit(request, params)).name(\"{{ routePrefix }}.edit\");\n        router.put(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.update(request, params)).name(\"{{ routePrefix }}.update\");\n        router.delete(\"/{{ routePrefix }}/:id\", (request, params) => {{ variableName }}.destroy(request, params)).name(\"{{ routePrefix }}.destroy\");\n";
     readonly "module-provider": "import type { Application } from \"@ninots/framework\";\nimport { ROUTER_KEY, ServiceProvider } from \"@ninots/framework\";\nimport type { Router } from \"@ninots/framework\";\nimport { {{ routesRegisterName }} } from \"{{ routesImportPath }}\";\n\n/**\n * {{ className }} module service provider.\n *\n * Loads module routes via {{ routesRegisterName }} — do not append to routes/web.ts.\n */\nexport class {{ providerClassName }} extends ServiceProvider {\n    constructor(app: Application) {\n        super(app.container);\n    }\n\n    public override register(): void {\n        // Bind module services here.\n    }\n\n    public override boot(): void {\n        const router = this.app.make<Router>(ROUTER_KEY);\n        {{ routesRegisterName }}(router);\n    }\n}\n";
-    readonly "module-routes": "import type { Router } from \"@ninots/framework\";\n\n/**\n * Register HTTP routes for the {{ className }} module.\n */\nexport function {{ routesRegisterName }}(router: Router): void {\n    router.group({ prefix: \"/{{ routePrefix }}\", middleware: [\"web\"] }, () => {\n        // Module routes go here.\n    });\n}\n";
+    readonly "module-routes": "import type { Router } from \"@ninots/framework\";\n\n/**\n * Register HTTP routes for the {{ className }} module.\n */\nexport function {{ routesRegisterName }}(router: Router): void {\n    router.group({ prefix: \"/{{ routePrefix }}\", middleware: [\"web\"] }, () => {\n        router.get(\"/\", () => new Response(\"{{ className }} module\")).name(\"{{ routePrefix }}.index\");\n    });\n}\n";
 };
 export type StubTemplateName = keyof typeof STUB_TEMPLATES;
 export declare function getStubTemplate(name: StubTemplateName): string;

packages/console/index.ts

@@ -19,6 +19,10 @@ export {
     MigrateRollbackCommand,
     type MigrateRollbackCommandOptions,
 } from "./src/commands/migrate-rollback-command";
+export {
+    RoutesCompileCommand,
+    type RoutesCompileCommandOptions,
+} from "./src/commands/routes-compile-command";
 
 export { Command } from "./src/command";
 export {

packages/console/src/commands/routes-compile-command.ts

@@ -0,0 +1,41 @@
+import { join } from "node:path";
+import type { Router } from "@ninots/routing";
+import { emitRouteRegistry } from "@ninots/routing";
+import { Command } from "../command";
+
+export interface RoutesCompileCommandOptions {
+    readonly resolveRouter: () => Router | Promise<Router>;
+}
+
+/**
+ * Compile a typed route registry (`.d.ts`) from the application's Router.
+ *
+ * Boot path: inject `resolveRouter` (same pattern as MigrateCommand) —
+ * typically `bootstrap()` → `ROUTER_KEY` → `getRoutes()`. Writes via `Bun.write`.
+ */
+export class RoutesCompileCommand extends Command {
+    signature = "routes:compile {--out=types/routes.d.ts}";
+    description = "Compile typed route registry from registered routes";
+
+    constructor(private readonly options: RoutesCompileCommandOptions) {
+        super();
+    }
+
+    async handle(): Promise<number> {
+        try {
+            const router = await this.options.resolveRouter();
+            const outOption = this.option("out");
+            const outRel = typeof outOption === "string" && outOption.length > 0 ? outOption : "types/routes.d.ts";
+            const outPath = join(process.cwd(), outRel);
+
+            const content = emitRouteRegistry(router.getRoutes());
+            await Bun.write(outPath, content);
+            this.success(`Wrote ${outRel}`);
+            return 0;
+        } catch (error: unknown) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(`routes:compile failed: ${message}`);
+            return 1;
+        }
+    }
+}

packages/console/src/generator/stub-templates.ts

@@ -1,8 +1,8 @@
 export const STUB_TEMPLATES = {
-    "api-resource-routes": `        router.get("/{{ routePrefix }}", () => {{ variableName }}.index());
-        router.get("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.show(request, params));
-        router.put("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.update(request, params));
-        router.delete("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.destroy(request, params));
+    "api-resource-routes": `        router.get("/{{ routePrefix }}", () => {{ variableName }}.index()).name("{{ routePrefix }}.index");
+        router.get("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.show(request, params)).name("{{ routePrefix }}.show");
+        router.put("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.update(request, params)).name("{{ routePrefix }}.update");
+        router.delete("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.destroy(request, params)).name("{{ routePrefix }}.destroy");
 `,
     controller: `import { Controller } from "@/app/Http/Controllers/Controller";
 
@@ -123,13 +123,13 @@ function {{ exportName }}Page({ title = "{{ exportName }}", id }: {{ exportName
 
 export const {{ exportName }} = withLayout(AppLayout, {{ exportName }}Page, { title: "{{ exportName }} — Ninots" });
 `,
-    "web-resource-routes": `        router.get("/{{ routePrefix }}", () => {{ variableName }}.index());
-        router.get("/{{ routePrefix }}/create", () => {{ variableName }}.create());
-        router.post("/{{ routePrefix }}", (request) => {{ variableName }}.store(request));
-        router.get("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.show(request, params));
-        router.get("/{{ routePrefix }}/:id/edit", (request, params) => {{ variableName }}.edit(request, params));
-        router.put("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.update(request, params));
-        router.delete("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.destroy(request, params));
+    "web-resource-routes": `        router.get("/{{ routePrefix }}", () => {{ variableName }}.index()).name("{{ routePrefix }}.index");
+        router.get("/{{ routePrefix }}/create", () => {{ variableName }}.create()).name("{{ routePrefix }}.create");
+        router.post("/{{ routePrefix }}", (request) => {{ variableName }}.store(request)).name("{{ routePrefix }}.store");
+        router.get("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.show(request, params)).name("{{ routePrefix }}.show");
+        router.get("/{{ routePrefix }}/:id/edit", (request, params) => {{ variableName }}.edit(request, params)).name("{{ routePrefix }}.edit");
+        router.put("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.update(request, params)).name("{{ routePrefix }}.update");
+        router.delete("/{{ routePrefix }}/:id", (request, params) => {{ variableName }}.destroy(request, params)).name("{{ routePrefix }}.destroy");
 `,
     "module-provider": `import type { Application } from "@ninots/framework";
 import { ROUTER_KEY, ServiceProvider } from "@ninots/framework";
@@ -163,7 +163,7 @@ export class {{ providerClassName }} extends ServiceProvider {
  */
 export function {{ routesRegisterName }}(router: Router): void {
     router.group({ prefix: "/{{ routePrefix }}", middleware: ["web"] }, () => {
-        // Module routes go here.
+        router.get("/", () => new Response("{{ className }} module")).name("{{ routePrefix }}.index");
     });
 }
 `,