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
	// Profile is the app's shape, which the v0.3.0 tree's conditional
	// templates read (ADR-0090 §6). It is the zero Profile for the v0.1
	// trees, which have no conditionals of their own.
	Profile Profile
}

type EjectedModule struct {
	// Name is the module's directory under internal/modules, and what orb
	// eject takes, such as auth.
	Name string
	// Package is the library package it is copied from, such as
	// gorbital.dev/gorbital/authhttp.
	Package 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 Method 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 Profile struct {
	// Auth is the value of --auth: AuthNone, AuthBasic or AuthFull.
	Auth string
	// Scope is the value of --scope: ScopeNone, ScopeSingle, ScopeCustom,
	// or the name of a scope.
	Scope string
	// ScopeName is what the app calls its tenant when Scope is a name:
	// "organisation", "merchant", …. It is empty for the other scopes.
	ScopeName string
	// Methods are the sign-in methods the app serves; empty means the
	// Auth profile's own set (AuthMethods).
	Methods []Method
}

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
	// Scope is the access rule the generator states: ScopeUser,
	// ScopeTenant, ScopePublic or ScopeCustom (ADR-0091).
	Scope string
	// Vocabulary is what the app calls its tenant, for a ScopeTenant
	// resource (ADR-0088).
	Vocabulary Vocabulary
	// Org reports records that belong to a tenant (--scope tenant, or its
	// old name org) instead of a user.
	Org bool
	// RLS reports a tenant resource whose migration forces row-level
	// security with the tenant 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),
	// ScopeTenant, ScopePublic or ScopeCustom (ADR-0091). ScopeOrg is
	// accepted as the old name of ScopeTenant.
	Scope string
	// Vocabulary is what the app calls its tenant, for a ScopeTenant
	// resource (ADR-0088). The zero value is the organisations one.
	Vocabulary Vocabulary
	// RLS adds the row-level security policy to a tenant resource's
	// migration, for apps that ran orb add rls (ADR-0061).
	RLS bool
}

type ScopeRole struct {
	Name  string
	Ident string
}

type Vocabulary struct {
	// Name is the concept in lowercase singular, such as "organisation" or
	// "merchant".
	Name string
	// Plural is Name in plural, for prose such as "the merchant's orders".
	Plural string
	// Segment is the path segment the scope's routes live under, the
	// "orgs" of /v1/orgs/{orgId}.
	Segment string
	// PathParam is the path parameter carrying the scope ID, such as
	// "orgId".
	PathParam string
	// ParamField is PathParam as a Go field name, such as "OrgID".
	ParamField string
	// Column is the table column holding the scope ID, such as "org_id".
	Column string
	// Field is Column as a Go field name, such as "OrgID".
	Field string
	// Var is Column as a Go parameter name, such as "orgID".
	Var string
	// NotFoundCode refuses a request for a scope the actor is not a member
	// of, such as "org_not_found".
	NotFoundCode string
	// IDPrefix starts a scope ID in examples, such as "org".
	IDPrefix string
	// Roles are the scope's roles, most privileged first.
	Roles []string
	// Declared reports a vocabulary the app wrote in gorbital.yaml. Without
	// one the generator writes the v0.2 organisation code — guard.OrgMember
	// and Permission.OrgRoles — so an app that never named its tenant gets
	// byte for byte what v0.2.1 generated (ADR-0091 §3).
	Declared bool
}