scaffold

type Dependency struct {
	// Field is the struct field name.
	Field string
	// Type is the field's type as written in Go source.
	Type string
}

type Entity struct {
	// Module is the business module the entity belongs to, possibly nested.
	Module string
	// Table is the physical table name.
	Table string
	// Alias is the table's query alias.
	Alias string
	// Name is the Go type name.
	Name string
	// Snake is the entity's snake_case name, used for file and resource names.
	Snake string
	// Comment is the table comment, rendered as the model's doc comment.
	Comment string
	// AuditEmbed is the framework audit mixin the table's columns matched,
	// empty when none did.
	AuditEmbed string
	// HasIDField reports whether the model ends up with a single string ID
	// field, which is what decides if the create/update payload carries one.
	HasIDField bool
	// KeylessTable reports that the table declares no primary key, so nothing
	// the generator writes can give crud one.
	KeylessTable bool
	// Fields are the business columns, audit columns excluded.
	Fields []Field
	// ResourceName is the api.NewRPCResource name.
	ResourceName string
	// Ops are the CRUD operations the resource embeds.
	Ops []Operation
	// AuditUserModel is the qualified WithAuditUserNames argument, empty when
	// the project declares none.
	AuditUserModel string
	// AuditUserModelImport is the package AuditUserModel is selected from.
	AuditUserModelImport string
	// AuditUserModelAlias is the local name that import takes, empty when the
	// package name does not collide with the entity's own model package.
	AuditUserModelAlias string
	// UnmappedColumns names columns whose declared type this tool did not
	// recognize and therefore typed as string.
	UnmappedColumns []string
}

type EntityOptions struct {
	// Module is the business module the entity is generated into.
	Module string
	// Entity is the snake_case entity name.
	Entity string
	// Alias overrides the derived table alias.
	Alias string
	// Search decides which columns become search criteria; nil means every
	// scalar column does.
	Search map[string]searchOperator
}

type Field struct {
	// Column is the database column name.
	Column string
	// Name is the Go field name.
	Name string
	// JSONName is the field's json tag name.
	JSONName string
	// Type is the Go type spelling, already carrying a pointer for a nullable
	// column.
	Type string
	// Nullable reports whether the column accepts NULL, which decides both the
	// pointer and the validation prefix.
	Nullable bool
	// Label is the column comment, surfaced through the label tag that drives
	// validation messages and export headers.
	Label string
	// MaxLength is the declared character bound, zero when unbounded.
	MaxLength int
	// PrimaryKey reports whether the column is part of the table's primary
	// key and therefore needs a bun pk tag on the generated field.
	PrimaryKey bool
	// Search is the search operator this field takes in a search payload.
	Search searchOperator
	// ImportPath is the package the field's type needs, empty for builtins.
	ImportPath string
}

type Operation struct {
	// Field is the struct field and embedded interface name.
	Field string
	// Embed is the full embedded type, such as
	// crud.FindPage[model.Holiday, payload.HolidaySearch].
	Embed string
	// Init is the complete initializer, constructor plus builder chain.
	Init string
}

type Plan struct {
	// contains filtered or unexported fields
}

type ProjectRequest struct {
	// Name is the application name.
	Name string
	// Module is the go.mod module path, defaulting to Name.
	Module string
	// Dir is the directory to create, defaulting to Name under the working
	// directory.
	Dir string
	// WithExample generates the starter business module.
	WithExample bool
	// SkipTidy leaves dependency resolution to the developer.
	SkipTidy bool
	// SkipGit leaves repository initialization to the developer.
	SkipGit bool
}

type ResourceRequest struct {
	// Table is the physical table to derive the entity from.
	Table string
	// Module is the business module to generate into.
	Module string
	// Entity overrides the entity name derived from the table.
	Entity string
	// Alias overrides the derived table alias.
	Alias string
	// Ops overrides the project's configured operation set.
	Ops []string
	// Search overrides which columns become search criteria; nil applies the
	// default of every scalar column.
	Search map[string]searchOperator
	// ConfigPath overrides where application.toml is read from.
	ConfigPath string
	// Source names the data source to inspect; empty means primary.
	Source string
	// Force overwrites generated files that already exist.
	Force bool
}

type ServiceRequest struct {
	// Name is the service name, with or without the Service suffix.
	Name string
	// Module is the business module to generate into.
	Module string
	// Deps are the constructor-injected dependencies.
	Deps []Dependency
	// Force overwrites the service file if it already exists.
	Force bool
}