zudojs-cli 2.1.1 → 2.1.3

package/README.md

@@ -178,7 +178,7 @@ current directory.
 | Option            | Applies to                    | Description                                                        |
 | ----------------- | ----------------------------- | ------------------------------------------------------------------ |
 | `--module <name>` | every schematic but `module`  | Generates inside `<root>/modules/<name>` instead of the schematic's default directory |
-| `--service <name>`| microservice projects, CQRS   | Selects the app a schematic belongs to; also names the CQRS service for `command`/`query` |
+| `--service <name>`| microservice projects          | Selects the microservice app a schematic (including `command`/`query`) is written into |
 | `--dry-run`       | all                           | Lists the files without writing anything                           |
 | `--force`         | all                           | Overwrites files that already exist                                |
 

package/dist/src/bin/zudojs.js

@@ -178,7 +178,7 @@ app.register(createCommand({
         {
             name: "service",
             short: "s",
-            description: "The service name (for CQRS commands/queries)",
+            description: "Microservice projects: the app to generate into (gateway or a service name). Elsewhere: a folder grouping CQRS commands/queries",
             type: "string",
         },
         {

package/dist/src/commands/generate.command.js

@@ -6,11 +6,10 @@
  * backend lives, then places the schematic accordingly.
  */
 import { join } from "node:path";
-import { generateService } from "../generators/service/service.generator.js";
 import { generateModule } from "../generators/module/module.generator.js";
 import { generateCommand } from "../generators/command/command.generator.js";
 import { generateQuery } from "../generators/query/query.generator.js";
-import { generateMiddleware } from "../generators/middleware/middleware.generator.js";
+import { generateMiddleware, } from "../generators/middleware/middleware.generator.js";
 import { generateEvent } from "../generators/event/event.generator.js";
 import { generateJob } from "../generators/job/job.generator.js";
 import { generateModel } from "../generators/model/model.generator.js";
@@ -53,10 +52,6 @@ function getArchitectureRoot(architecture, schematic, serviceName) {
             }
             return "src";
         case "microservice":
-            if (schematic === "service") {
-                // A new service is a new app in the workspace.
-                return "apps/services";
-            }
             // `--service <name>` selects which app the schematic belongs to.
             // Without it the gateway app — the one app always generated — is used.
             // Modules go to that app's src/modules, next to the scaffolded ones,
@@ -72,13 +67,6 @@ function getArchitectureRoot(architecture, schematic, serviceName) {
             if (schematic === "module") {
                 return "src/modules";
             }
-            if (schematic === "service") {
-                // The monolith template scaffolds `src/services/app.service.ts` and a
-                // `src/services/index.ts` barrel. Generating into `src/<name>/`
-                // instead left two conventions in one project, and the generated
-                // service was never exported from the barrel the template owns.
-                return "src/services";
-            }
             return "src";
     }
 }
@@ -221,6 +209,15 @@ export async function runGenerateCommand(context) {
                 .map((step) => `  ${step}`)
                 .join("\n")}`);
         },
+        onMiddlewareRegistered: (registration) => {
+            if (registration.registered) {
+                context.logger.info(`Registered in the middleware pipeline of ${registration.serverFile}.`);
+                return;
+            }
+            context.logger.warn(`Could not register the middleware automatically (the zudojs:server-imports or zudojs:server-middleware markers are missing). Add:\n${registration.manualSteps
+                .map((step) => `  ${step}`)
+                .join("\n")}`);
+        },
     }, cwd);
     if (dryRun) {
         context.logger.info(`Dry run: ${fileCount(result.length)} would be generated (nothing written):`);
@@ -254,8 +251,6 @@ async function runSchematic(schematic, name, options, cwd) {
         // writing to `<basePath>/commands/<name>`.
         const cqrsService = options.architecture === "microservice" ? undefined : options.service;
         switch (schematic) {
-            case "service":
-                return await generateService({ name, basePath, dryRun }, cwd);
             case "module":
                 return await generateModule({ name, feature: true, basePath, dryRun, onRegistered: options.onModuleRegistered }, cwd);
             case "command":
@@ -263,7 +258,7 @@ async function runSchematic(schematic, name, options, cwd) {
             case "query":
                 return await generateQuery({ name, ...(cqrsService ? { service: cqrsService } : {}), basePath, dryRun }, cwd);
             case "middleware":
-                return await generateMiddleware({ name, basePath, dryRun }, cwd);
+                return await generateMiddleware({ name, basePath, dryRun, onRegistered: options.onMiddlewareRegistered }, cwd);
             case "event":
                 return await generateEvent({ name, basePath, dryRun }, cwd);
             case "job":

package/dist/src/constants/index.js

@@ -133,7 +133,11 @@ export const SCHEMA_CHOICES = Object.freeze([
         label: "Resource",
         hint: "DTO, repository, service, controller, CRUD routes and a test, registered",
     },
-    { value: "service", label: "Service (CQRS)" },
+    {
+        value: "service",
+        label: "Service",
+        hint: "src/services/<name>.service.ts, plus its DTO and repository when missing",
+    },
     { value: "module", label: "Module" },
     { value: "command", label: "Command" },
     { value: "query", label: "Query" },

package/dist/src/constants/zudojsVersions.generated.js

@@ -6,43 +6,43 @@
  * Do not edit by hand; run `node scripts/generateZudojsVersions.mjs`.
  */
 export const ZUDOJS_PACKAGE_VERSIONS = Object.freeze({
-    "@zudojs/adapters": "1.2.1",
-    "@zudojs/api": "1.2.1",
-    "@zudojs/auth": "1.3.1",
-    "@zudojs/auth-oauth": "1.2.3",
-    "@zudojs/cache": "1.2.1",
-    "@zudojs/config": "1.3.1",
-    "@zudojs/constants": "1.1.2",
-    "@zudojs/container": "1.2.1",
-    "@zudojs/core": "1.2.2",
-    "@zudojs/cqrs": "1.2.1",
-    "@zudojs/crypto": "1.3.1",
-    "@zudojs/database": "1.3.1",
-    "@zudojs/docs": "1.0.4",
-    "@zudojs/errors": "1.3.0",
-    "@zudojs/events": "1.3.1",
-    "@zudojs/feature-flags": "1.4.0",
-    "@zudojs/http": "1.4.2",
-    "@zudojs/lifecycle": "1.2.1",
-    "@zudojs/logger": "1.4.1",
-    "@zudojs/messaging": "1.2.1",
-    "@zudojs/middleware": "1.1.0",
-    "@zudojs/observability": "1.2.1",
-    "@zudojs/openapi": "1.5.0",
-    "@zudojs/permissions": "1.4.1",
-    "@zudojs/plugins": "1.3.1",
-    "@zudojs/queue": "1.4.1",
-    "@zudojs/rpc": "1.4.1",
-    "@zudojs/runtime": "1.3.1",
-    "@zudojs/scheduler": "1.2.0",
-    "@zudojs/schema": "1.2.1",
-    "@zudojs/security": "1.3.1",
-    "@zudojs/serialization": "1.2.1",
-    "@zudojs/storage": "1.2.1",
-    "@zudojs/tenancy": "1.3.1",
-    "@zudojs/testing": "1.2.2",
-    "@zudojs/transactions": "1.2.0",
+    "@zudojs/adapters": "1.2.3",
+    "@zudojs/api": "1.2.3",
+    "@zudojs/auth": "1.3.3",
+    "@zudojs/auth-oauth": "1.2.5",
+    "@zudojs/cache": "1.2.3",
+    "@zudojs/config": "1.3.3",
+    "@zudojs/constants": "1.1.4",
+    "@zudojs/container": "1.2.3",
+    "@zudojs/core": "1.2.4",
+    "@zudojs/cqrs": "1.2.3",
+    "@zudojs/crypto": "1.3.3",
+    "@zudojs/database": "1.4.0",
+    "@zudojs/docs": "1.0.6",
+    "@zudojs/errors": "1.3.2",
+    "@zudojs/events": "1.3.3",
+    "@zudojs/feature-flags": "1.4.2",
+    "@zudojs/http": "1.4.4",
+    "@zudojs/lifecycle": "1.2.3",
+    "@zudojs/logger": "1.4.3",
+    "@zudojs/messaging": "1.2.3",
+    "@zudojs/middleware": "1.1.2",
+    "@zudojs/observability": "1.2.3",
+    "@zudojs/openapi": "1.5.2",
+    "@zudojs/permissions": "1.4.3",
+    "@zudojs/plugins": "1.3.3",
+    "@zudojs/queue": "1.5.1",
+    "@zudojs/rpc": "1.4.3",
+    "@zudojs/runtime": "1.3.3",
+    "@zudojs/scheduler": "1.2.2",
+    "@zudojs/schema": "1.2.3",
+    "@zudojs/security": "1.3.3",
+    "@zudojs/serialization": "1.2.3",
+    "@zudojs/storage": "1.2.3",
+    "@zudojs/tenancy": "1.3.3",
+    "@zudojs/testing": "1.2.4",
+    "@zudojs/transactions": "1.2.2",
     "@zudojs/types": "1.2.0",
-    "@zudojs/validation": "1.1.0",
+    "@zudojs/validation": "1.1.2",
 });
 //# sourceMappingURL=zudojsVersions.generated.js.map

package/dist/src/generators/command/command.generator.d.ts

@@ -1,13 +1,19 @@
 /**
  * zudojs-cli — Command Generator
  *
- * Generates a CQRS command with handler.
+ * Generates a CQRS command, its handler and a barrel under
+ * `<basePath>[/<service>]/commands/<name>/`.
  */
+/** Options for {@link generateCommand}. */
 export interface GenerateCommandOptions {
     readonly name: string;
     readonly service?: string;
     readonly basePath?: string;
     readonly dryRun?: boolean;
 }
+/**
+ * Writes `<name>.command.ts`, `<name>.handler.ts` and `index.ts`, and
+ * returns their paths (only the paths on a dry run).
+ */
 export declare function generateCommand(options: GenerateCommandOptions, cwd: string): Promise<string[]>;
 //# sourceMappingURL=command.generator.d.ts.map

package/dist/src/generators/command/command.generator.js

@@ -1,55 +1,29 @@
 /**
  * zudojs-cli — Command Generator
  *
- * Generates a CQRS command with handler.
+ * Generates a CQRS command, its handler and a barrel under
+ * `<basePath>[/<service>]/commands/<name>/`.
  */
 import { writeFileTree } from "../../utils/utils.fileSystem.js";
 import { CLIGenerationError } from "../../errors/index.js";
-import { normalizeName } from "../../utils/utils.name.js";
+import { assertGeneratableName } from "../../utils/utils.name.js";
+import { cqrsSchematicNames, renderCommandBarrel, renderCommandFile, renderCommandHandlerFile, } from "./command.template.js";
+/**
+ * Writes `<name>.command.ts`, `<name>.handler.ts` and `index.ts`, and
+ * returns their paths (only the paths on a dry run).
+ */
 export async function generateCommand(options, cwd) {
-    const name = normalizeName(options.name);
-    const nameCamel = name
-        .replace(/-([a-z])/g, (_m, c) => c.toUpperCase())
-        .replace(/^./, (c) => c.toUpperCase());
-    const service = options.service;
+    const names = cqrsSchematicNames(assertGeneratableName(options.name, "command name"));
     const basePath = options.basePath ?? "services";
-    // When no service grouping is given the schematic is written directly under
-    // basePath. Callers that resolved the owning app into basePath (the
-    // microservice layout) pass no service, so the path is not nested twice.
-    const servicePath = service ? `${basePath}/${service}` : basePath;
+    // Without a service group the schematic goes directly under basePath:
+    // callers that resolved the owning app into basePath (the microservice
+    // layout) pass no service, so the path is not nested twice.
+    const servicePath = options.service ? `${basePath}/${options.service}` : basePath;
+    const dir = `${servicePath}/commands/${names.slug}`;
     const files = {
-        [`${servicePath}/commands/${name}/${name}.command.ts`]: `import type { BaseCommand } from "@zudojs/cqrs";
-
-export interface ${nameCamel}CommandPayload {
-  readonly [key: string]: unknown;
-}
-
-export class ${nameCamel}Command implements BaseCommand<${nameCamel}CommandPayload> {
-  readonly commandName = "${name}";
-
-  constructor(public readonly payload: ${nameCamel}CommandPayload) {}
-}
-`,
-        [`${servicePath}/commands/${name}/${name}.handler.ts`]: `import type { CommandHandler, CommandResult } from "@zudojs/cqrs";
-import { createLogger } from "@zudojs/logger";
-import { ${nameCamel}Command } from "./${name}.command.js";
-
-export class ${nameCamel}CommandHandler implements CommandHandler<${nameCamel}Command> {
-  private readonly logger = createLogger({ name: "${name}-handler" });
-
-  async handle(command: ${nameCamel}Command): Promise<CommandResult> {
-    this.logger.info("Processing ${name} command", { payload: command.payload });
-
-    return {
-      success: true,
-      data: { id: crypto.randomUUID(), ...command.payload },
-    };
-  }
-}
-`,
-        [`${servicePath}/commands/${name}/index.ts`]: `export { ${nameCamel}Command } from "./${name}.command.js";
-export { ${nameCamel}CommandHandler } from "./${name}.handler.js";
-`,
+        [`${dir}/${names.slug}.command.ts`]: renderCommandFile(names),
+        [`${dir}/${names.slug}.handler.ts`]: renderCommandHandlerFile(names),
+        [`${dir}/index.ts`]: renderCommandBarrel(names),
     };
     if (options.dryRun) {
         return Object.keys(files);
@@ -59,7 +33,7 @@ export { ${nameCamel}CommandHandler } from "./${name}.handler.js";
         return Object.keys(files);
     }
     catch (error) {
-        throw new CLIGenerationError(`Failed to generate command: ${name} in ${servicePath}`, error);
+        throw new CLIGenerationError(`Failed to generate command: ${names.slug} in ${servicePath}`, error);
     }
 }
 //# sourceMappingURL=command.generator.js.map

package/dist/src/generators/command/command.template.d.ts

@@ -0,0 +1,24 @@
+/**
+ * zudojs-cli — Command schematic templates, written against the
+ * @zudojs/cqrs API: a `CommandOf` type built with `createCommand`, and a
+ * `CommandHandler` subclass (`commandType` + `execute`) registered on a
+ * `CommandBus`.
+ */
+/** Identifiers derived from a command name (`create-user`). */
+export interface CqrsSchematicNames {
+    /** kebab-case: folder and file names (`create-user`). */
+    readonly slug: string;
+    /** PascalCase: class and type prefix, and the bus discriminator (`CreateUser`). */
+    readonly pascal: string;
+    /** UPPER_SNAKE: prefix of the discriminator constant (`CREATE_USER`). */
+    readonly constant: string;
+}
+/** Derives {@link CqrsSchematicNames} from an already validated slug. */
+export declare function cqrsSchematicNames(slug: string): CqrsSchematicNames;
+/** `<slug>.command.ts`: the discriminator, payload, command type and factory. */
+export declare function renderCommandFile(n: CqrsSchematicNames): string;
+/** `<slug>.handler.ts`: the handler class and its bus registration. */
+export declare function renderCommandHandlerFile(n: CqrsSchematicNames): string;
+/** `index.ts`: the command folder's barrel. */
+export declare function renderCommandBarrel(n: CqrsSchematicNames): string;
+//# sourceMappingURL=command.template.d.ts.map

package/dist/src/generators/command/command.template.js

@@ -0,0 +1,78 @@
+/**
+ * zudojs-cli — Command schematic templates, written against the
+ * @zudojs/cqrs API: a `CommandOf` type built with `createCommand`, and a
+ * `CommandHandler` subclass (`commandType` + `execute`) registered on a
+ * `CommandBus`.
+ */
+import { toPascalCase } from "../../utils/utils.name.js";
+/** Derives {@link CqrsSchematicNames} from an already validated slug. */
+export function cqrsSchematicNames(slug) {
+    return { slug, pascal: toPascalCase(slug), constant: slug.toUpperCase().replace(/-/g, "_") };
+}
+/** `<slug>.command.ts`: the discriminator, payload, command type and factory. */
+export function renderCommandFile(n) {
+    const id = `${n.constant}_COMMAND`;
+    return `import { createCommand, type CommandOf } from "@zudojs/cqrs";
+
+/** Discriminator the command bus routes ${n.pascal} commands on. */
+export const ${id} = "${n.pascal}";
+
+/** Data a ${n.pascal} command carries. Replace it with the fields the use case needs. */
+export type ${n.pascal}CommandPayload = {
+  readonly data: Readonly<Record<string, unknown>>;
+};
+
+/** The ${n.pascal} command: \`{ type: "${n.pascal}", data }\`. */
+export type ${n.pascal}Command = CommandOf<typeof ${id}, ${n.pascal}CommandPayload>;
+
+/** Creates an immutable ${n.pascal} command. */
+export function create${n.pascal}Command(payload: ${n.pascal}CommandPayload): ${n.pascal}Command {
+  return createCommand(${id}, payload);
+}
+`;
+}
+/** `<slug>.handler.ts`: the handler class and its bus registration. */
+export function renderCommandHandlerFile(n) {
+    const id = `${n.constant}_COMMAND`;
+    return `import { randomUUID } from "node:crypto";
+
+import { CommandHandler, type CommandBus } from "@zudojs/cqrs";
+
+import { ${id}, type ${n.pascal}Command } from "./${n.slug}.command.js";
+
+/** What executing a ${n.pascal} command returns. */
+export interface ${n.pascal}CommandResult {
+  readonly id: string;
+  readonly data: Readonly<Record<string, unknown>>;
+}
+
+/** Handles ${n.pascal} commands: put the write-side logic in \`execute\`. */
+export class ${n.pascal}CommandHandler extends CommandHandler<${n.pascal}Command, ${n.pascal}CommandResult> {
+  public override readonly commandType = ${id};
+
+  public override async execute(command: ${n.pascal}Command): Promise<${n.pascal}CommandResult> {
+    return { id: randomUUID(), data: command.data };
+  }
+}
+
+/**
+ * Registers {@link ${n.pascal}CommandHandler} on a command bus.
+ *
+ * @example
+ * const bus = register${n.pascal}Command(createCommandBus());
+ * const result = await bus.execute<${n.pascal}Command, ${n.pascal}CommandResult>(
+ *   create${n.pascal}Command({ data: {} }),
+ * );
+ */
+export function register${n.pascal}Command(bus: CommandBus): CommandBus {
+  return bus.register(${id}, new ${n.pascal}CommandHandler());
+}
+`;
+}
+/** `index.ts`: the command folder's barrel. */
+export function renderCommandBarrel(n) {
+    return `export * from "./${n.slug}.command.js";
+export * from "./${n.slug}.handler.js";
+`;
+}
+//# sourceMappingURL=command.template.js.map

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

@@ -0,0 +1,6 @@
+/**
+ * zudojs-cli — Command schematic: a `CommandOf` command type, its factory
+ * and a `CommandHandler` subclass for @zudojs/cqrs.
+ */
+export * from "./command.generator.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/generators/command/index.js

@@ -0,0 +1,6 @@
+/**
+ * zudojs-cli — Command schematic: a `CommandOf` command type, its factory
+ * and a `CommandHandler` subclass for @zudojs/cqrs.
+ */
+export * from "./command.generator.js";
+//# sourceMappingURL=index.js.map

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

@@ -8,7 +8,6 @@ export { FullstackComposer } from "./fullstack/index.js";
 export { IntegrationGenerator } from "./integration/index.js";
 export { InfrastructureGenerator } from "./infrastructure/index.js";
 export { generateModule } from "./module/module.generator.js";
-export { generateService } from "./service/service.generator.js";
 export { generateCommand } from "./command/command.generator.js";
 export { generateQuery } from "./query/query.generator.js";
 export { generateResource, resolveResourceLayout, planResource, RESOURCE_SCHEMATICS, } from "./resource/index.js";

package/dist/src/generators/index.js

@@ -8,7 +8,6 @@ export { FullstackComposer } from "./fullstack/index.js";
 export { IntegrationGenerator } from "./integration/index.js";
 export { InfrastructureGenerator } from "./infrastructure/index.js";
 export { generateModule } from "./module/module.generator.js";
-export { generateService } from "./service/service.generator.js";
 export { generateCommand } from "./command/command.generator.js";
 export { generateQuery } from "./query/query.generator.js";
 export { generateResource, resolveResourceLayout, planResource, RESOURCE_SCHEMATICS, } from "./resource/index.js";

package/dist/src/generators/infrastructure/infrastructure.generator.js

@@ -7,7 +7,7 @@ import { writeFileTree } from "../../utils/utils.fileSystem.js";
 import { CLIValidationError } from "../../errors/index.js";
 import { resolveDatabaseAdapter } from "../../adapters/databases/databaseAdapter.resolver.js";
 import { resolveMicroserviceServices } from "../../templates/microservice/microservice.template.js";
-import { renderAppPackageDockerfile, renderWorkspaceAppDockerfile, } from "../../templates/shared/dockerfile.template.js";
+import { renderAppPackageDockerfile, renderWorkspaceAppDockerfile, } from "../../templates/shared/dockerfile/index.js";
 const SERVICE_NAME_PATTERN = /^[a-zA-Z0-9_-]+$/;
 /**
  * Database passwords are interpolated by compose from `.env`

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

@@ -1,5 +1,6 @@
 /**
  * zudojs-cli — Middleware Generator
  */
-export { generateMiddleware, type GenerateMiddlewareOptions, } from "./middleware.generator.js";
+export { generateMiddleware, middlewareAppSrc, middlewareServerLines, type GenerateMiddlewareOptions, type MiddlewareRegistration, } from "./middleware.generator.js";
+export { renderMiddlewareFile, type MiddlewareFileOptions } from "./middleware.template.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/generators/middleware/index.js

@@ -1,5 +1,6 @@
 /**
  * zudojs-cli — Middleware Generator
  */
-export { generateMiddleware, } from "./middleware.generator.js";
+export { generateMiddleware, middlewareAppSrc, middlewareServerLines, } from "./middleware.generator.js";
+export { renderMiddlewareFile } from "./middleware.template.js";
 //# sourceMappingURL=index.js.map

package/dist/src/generators/middleware/middleware.generator.d.ts

@@ -1,12 +1,39 @@
 /**
  * zudojs-cli — Middleware Generator
  *
- * Generates middleware files.
+ * Writes `<basePath>/middlewares/<name>.middleware.ts` (an `HttpMiddleware`
+ * from @zudojs/http), exports it from the folder barrel and registers it in
+ * the app's `src/server.ts` between the `zudojs:server-imports` and
+ * `zudojs:server-middleware` markers. A server.ts missing either marker pair
+ * is left unchanged (no import without its registration) and the lines to
+ * add by hand are reported instead.
  */
 export interface GenerateMiddlewareOptions {
     readonly name: string;
     readonly basePath: string;
     readonly dryRun?: boolean;
+    /** Receives the registration outcome (e.g. lines to add by hand). */
+    readonly onRegistered?: (registration: MiddlewareRegistration) => void;
 }
+/** Outcome of registering a generated middleware in `server.ts`. */
+export interface MiddlewareRegistration {
+    /** Whether server.ts now runs the middleware. */
+    readonly registered: boolean;
+    /** The server file it was (or should be) registered in. */
+    readonly serverFile: string;
+    /** Lines to add by hand when `registered` is false. */
+    readonly manualSteps: readonly string[];
+}
+/**
+ * The app source directory owning `basePath`: `src` for `src` and
+ * `src/modules/billing`, `apps/services/x/src` for a service.
+ */
+export declare function middlewareAppSrc(basePath: string): string;
+/** The import and pipeline lines that register `factoryName` in server.ts. */
+export declare function middlewareServerLines(basePath: string, factoryName: string): {
+    readonly serverFile: string;
+    readonly importLine: string;
+    readonly entryLine: string;
+};
 export declare function generateMiddleware(options: GenerateMiddlewareOptions, cwd: string): Promise<string[]>;
 //# sourceMappingURL=middleware.generator.d.ts.map

package/dist/src/generators/middleware/middleware.generator.js

@@ -1,29 +1,74 @@
 /**
  * zudojs-cli — Middleware Generator
  *
- * Generates middleware files.
+ * Writes `<basePath>/middlewares/<name>.middleware.ts` (an `HttpMiddleware`
+ * from @zudojs/http), exports it from the folder barrel and registers it in
+ * the app's `src/server.ts` between the `zudojs:server-imports` and
+ * `zudojs:server-middleware` markers. A server.ts missing either marker pair
+ * is left unchanged (no import without its registration) and the lines to
+ * add by hand are reported instead.
  */
-import { writeFileTree } from "../../utils/utils.fileSystem.js";
+import { posix } from "node:path";
+import { CLIValidationError } from "../../errors/index.js";
+import { mergeBarrelExport, writeFileTree } from "../../utils/utils.fileSystem.js";
 import { normalizeName, toCamelCase } from "../../utils/utils.name.js";
+import { MARKERS, applyMarkerEdits, conflictingImport, planMarkerEdits, } from "../../wiring/index.js";
+import { renderMiddlewareFile } from "./middleware.template.js";
+/**
+ * The app source directory owning `basePath`: `src` for `src` and
+ * `src/modules/billing`, `apps/services/x/src` for a service.
+ */
+export function middlewareAppSrc(basePath) {
+    return basePath.replace(/\/modules\/[^/]+$/, "");
+}
+/** The import and pipeline lines that register `factoryName` in server.ts. */
+export function middlewareServerLines(basePath, factoryName) {
+    const appSrc = middlewareAppSrc(basePath);
+    const barrel = posix.relative(appSrc, `${basePath}/middlewares/index.js`);
+    return {
+        serverFile: `${appSrc}/server.ts`,
+        importLine: `import { ${factoryName} } from "./${barrel}";`,
+        entryLine: `${factoryName}(),`,
+    };
+}
 export async function generateMiddleware(options, cwd) {
     const name = normalizeName(options.name);
-    const nameCamel = toCamelCase(options.name);
+    const factoryName = `${toCamelCase(options.name)}Middleware`;
+    const lines = middlewareServerLines(options.basePath, factoryName);
+    const barrel = `${options.basePath}/middlewares/index.ts`;
+    const clash = conflictingImport(cwd, lines.serverFile, lines.importLine);
+    if (clash !== undefined) {
+        throw new CLIValidationError(`${lines.serverFile} already imports ${factoryName} (${clash.trim()}), so middleware "${name}" cannot be registered. Choose another name.`);
+    }
     const files = {
-        [`${options.basePath}/middlewares/${name}.middleware.ts`]: `/**
- * ${name} middleware.
- */
-
-export function ${nameCamel}Middleware() {
-  return async (ctx: unknown, next: () => Promise<void>) => {
-    await next();
-  };
-}
-`,
+        [`${options.basePath}/middlewares/${name}.middleware.ts`]: renderMiddlewareFile({
+            name,
+            factoryName,
+            serverFile: lines.serverFile,
+        }),
+        [barrel]: mergeBarrelExport(cwd, barrel, `export { ${factoryName} } from "./${name}.middleware.js";`),
     };
+    const edits = [
+        { file: lines.serverFile, marker: MARKERS.serverImports, line: lines.importLine },
+        { file: lines.serverFile, marker: MARKERS.serverMiddleware, line: lines.entryLine },
+    ];
+    const planned = planMarkerEdits(cwd, edits).outcome;
+    const registered = planned.manualSteps.length === 0;
     if (options.dryRun) {
-        return Object.keys(files);
+        return [...Object.keys(files), ...(registered ? planned.edited : [])];
     }
     await writeFileTree(cwd, files);
-    return Object.keys(files);
+    const edited = registered ? (await applyMarkerEdits(cwd, edits)).edited : [];
+    options.onRegistered?.({
+        registered,
+        serverFile: lines.serverFile,
+        manualSteps: registered
+            ? []
+            : [
+                `In ${lines.serverFile}: ${lines.importLine}`,
+                `In ${lines.serverFile}: add ${lines.entryLine} to the middlewares list of the HttpMiddlewarePipeline, before dispatch`,
+            ],
+    });
+    return [...Object.keys(files), ...edited];
 }
 //# sourceMappingURL=middleware.generator.js.map

package/dist/src/generators/middleware/middleware.template.d.ts

@@ -0,0 +1,21 @@
+/**
+ * zudojs-cli — Generated `<name>.middleware.ts`.
+ *
+ * `generate middleware` used to write
+ * `(ctx: unknown, next: () => Promise<void>) => Promise<void>`: registering
+ * it in the server pipeline failed tsc with TS2322, and because it returned
+ * nothing the response produced by `next()` was dropped. The file is now a
+ * real `HttpMiddleware` from @zudojs/http that returns `next()`'s response.
+ */
+/** Options for {@link renderMiddlewareFile}. */
+export interface MiddlewareFileOptions {
+    /** Normalized (kebab-case) name, e.g. `request-timer`. */
+    readonly name: string;
+    /** Factory function name, e.g. `requestTimerMiddleware`. */
+    readonly factoryName: string;
+    /** Where the factory is registered, e.g. `src/server.ts`. */
+    readonly serverFile: string;
+}
+/** Renders the middleware source file. */
+export declare function renderMiddlewareFile(options: MiddlewareFileOptions): string;
+//# sourceMappingURL=middleware.template.d.ts.map