recipes

type Data struct {
	Name           string // app name, for example "my-api"
	Module         string // Go module path
	LibraryVersion string
	// Local, when set, is a path to a gorbital checkout used through
	// replace directives (development before a release is published).
	Local string
}

type EnumValue struct {
	Value string // such as on_hold
	Ident string // such as OnHold
}

type Field struct {
	Name   string // snake_case column and JSON name, such as due_date
	Ident  string // Go identifier, such as DueDate
	Human  string // words, such as due date
	Kind   string
	Unique bool
	// Optional marks a string field written name:string? (orb gen module
	// only): 0 to StringMaxLength characters, and never the title.
	Optional bool
	Values   []EnumValue // enum fields only
}

type File struct {
	Path   string `json:"path"`
	SHA256 string `json:"sha256"`
}

type JobData struct {
	Module      string // app module path, for example example.com/acme-api
	Ident       string // Go identifier, for example CleanupSessions
	Name        string // definition name, for example cleanup_sessions
	Package     string // package name, for example cleanupsessions
	Description string
	Enabled     bool
	Schedule    string // cron, descriptor, "@every 15m", or empty
	Timeout     time.Duration
	MaxAttempts int
	Queue       string
	Priority    int

	// Kind is what the job does (ADR-0071): custom (a Work method to
	// write), http (a request), sql (a statement), email (a message) or
	// dispatch (starts another job). Each kind's fields follow.
	Kind           string
	HTTPMethod     string
	HTTPURL        string
	HTTPBody       string
	SQL            string
	EmailTo        string
	EmailSubject   string
	EmailText      string
	DispatchTarget string
	// contains filtered or unexported fields
}

type JobFile struct {
	Path    string
	Content []byte
}

type JobMarker struct {
	Kind           string `json:"kind"`
	HTTPMethod     string `json:"http_method,omitempty"`
	HTTPURL        string `json:"http_url,omitempty"`
	HTTPBody       string `json:"http_body,omitempty"`
	SQL            string `json:"sql,omitempty"`
	EmailTo        string `json:"email_to,omitempty"`
	EmailSubject   string `json:"email_subject,omitempty"`
	EmailText      string `json:"email_text,omitempty"`
	DispatchTarget string `json:"dispatch_target,omitempty"`
	// Worker is the SHA-256 of the generated worker file: while the file
	// still hashes to it, the portal shows the form; once edited by hand,
	// the job is ejected and edited in code.
	Worker string `json:"worker"`
}

type MailRecipe struct {
	Provider string
	// Label is the provider's display name.
	Label string
	// InfraMail is the content of internal/app/infra_mail.go.
	InfraMail []byte
	// InfraMailTest is the content of internal/app/infra_mail_test.go.
	InfraMailTest []byte
	// MainMail is the content of cmd/api/mail.go in the v0.2 layout; nil in
	// releases before it.
	MainMail []byte
	// EnvBlock is the provider's block of .env.example, markers included.
	EnvBlock []byte
	// EnvKeys are the variables EnvBlock assigns, in order.
	EnvKeys []string
	// Modules are the gorbital modules the app needs with this provider.
	Modules []string
}

type MiddlewareData struct {
	// AppModule is the app's module path.
	AppModule string
	// Kind is MiddlewareModule, MiddlewareGlobal or MiddlewareGuard.
	Kind string
	// ModuleName is the module whose delivery package holds it; empty for
	// global middleware.
	ModuleName string
	Ident      string // RequireClientVersion
	Snake      string // require_client_version: file, guard and code names
	Human      string // require client version
}

type ModuleData struct {
	ResourceData
}

type Preset struct {
	// Name is the value of orb new --preset.
	Name string
	// Tenancy is the value of orb new --tenancy: single, or multi for
	// organisations.
	Tenancy string
	// Recipe names the preset's template tree.
	Recipe string
	// contains filtered or unexported fields
}

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

type ResourceData struct {
	Module      string // app module path, such as example.com/acme-api
	Ident       string // Project
	Var         string // project
	Snake       string // project: audit actions, error codes, file names
	Human       string // project
	Plural      string // Projects
	PluralHuman string // projects
	Package     string // projects
	Table       string // projects
	Route       string // projects, as in /v1/projects
	IDPrefix    string // prj
	Migration   string // 20260915000002
	// Org reports records that belong to an organisation (--scope org)
	// instead of a user.
	Org bool
	// RLS reports an organisation resource whose migration forces
	// row-level security with the organisation policy (ADR-0061).
	RLS    bool
	Fields []Field
}

type ResourceOptions struct {
	// Plural is a Go-style plural name, such as People. The default adds the
	// English plural ending to the last word.
	Plural string
	// IDPrefix starts every ID, such as prj for Project. The default takes
	// the first letter and the next consonants.
	IDPrefix string
	// Migration is the migration's version: a UTC timestamp such as
	// 20260915093000.
	Migration string
	// Scope is who the records belong to: ScopeUser (the default) or
	// ScopeOrg, for multi-tenant apps (ADR-0048).
	Scope string
	// RLS adds the row-level security policy to an organisation resource's
	// migration, for apps that ran orb add rls (ADR-0061).
	RLS bool
}