@damatjs/module-generator

Damat-specific model discovery, schema output, CRUD scaffolding, registry rendering, and deterministic workflow barrels.

The package consumes generateFilesMap from @damatjs/schema-codegen, writes generated type and Zod files, and scaffolds the route → workflow → step layer expected by a Damat module. Scaffold files are created once: regeneration skips existing files so user edits survive.

Install

bun add @damatjs/module-generator

Run generation

import { runModuleCodegen } from "@damatjs/module-generator";

const result = await runModuleCodegen({
  schema,
  moduleId: "shop",
  typesDir: "./src/types",
  serviceDir: "./src",
  routesRoot: "./src/api/routes",
  workflowsRoot: "./src/workflows",
});

Use runCodegen when the package should discover models from a module resolver before generating. Both entry points return the output directory, regenerated type files, and newly scaffolded files.

Inputs and side effects

| API | Input | Result | | ---------------------- | ----------------------------------- | ---------------------------------------------------- | | runModuleCodegen | Schema, module id, and output paths | Writes generated types, registry, scaffolds, barrels | | runCodegen | Resolved model location and paths | Discovers models, then performs module generation | | generateCrudScaffold | Tables and module paths | Creates missing CRUD files only | | generateBarrels | Directory tree | Rebuilds sorted recursive index.ts files |

Generated type and registry files are replaceable output. Scaffold files are user-owned after their first creation and are never overwritten.

CRUD step templates bind the service layer's generic PostgreSQL rows to the generated table row type at the service boundary. Fresh scaffolds therefore pass strict TypeScript without weakening the workflow contract to any.

API

• runModuleCodegen generates from an existing ModuleSchema.
• runCodegen discovers models, converts them to a schema, then generates.
• generateCrudScaffold creates CRUD steps, workflows, and split routes once.
• generateBarrels rebuilds sorted, deterministic recursive barrels.
• registryAugmentation renders app-owned service registry declarations.
• registryModuleAugmentation renders immutable package registry declarations.

See the internals guide for ownership and filesystem invariants.

License

MIT