feature

type AdoptedCommit struct {
	SHA     string `json:"sha"`
	Author  string `json:"author"`
	Subject string `json:"subject"`
	Folded  bool   `json:"folded,omitempty"`
}

type Archived struct {
	At   time.Time `json:"at"`
	Ref  string    `json:"ref"`
	Head string    `json:"head"`
}

type Gate struct {
	FeatureHead   string       `json:"feature_head"`
	PublicMain    string       `json:"public_main"`
	Overlay       string       `json:"overlay"`
	Candidate     string       `json:"candidate"`
	PublishedTree string       `json:"published_tree"`
	Commits       []GateCommit `json:"commits"`
	Checks        string       `json:"checks"`
	Leak          string       `json:"leak"`
	At            time.Time    `json:"at"`
	// ScannedAs is the mode the gate's leak scan covered; empty in a gate
	// recorded before it was stored, which promote does not reuse.
	ScannedAs string `json:"scanned_as,omitempty"`
	// FailedChecks names the checks that failed; absent before 0.7.
	FailedChecks []string `json:"failed_checks,omitempty"`
	// ShadowPR is the gate's draft PR in the shadow repo; 0 before 0.7.
	ShadowPR int `json:"shadow_pr,omitempty"`
	// StartedAt is when the gate pushed its candidate. CI time budgets
	// count from it, so a wait in another process keeps the same budget.
	// Zero before 0.7.
	StartedAt time.Time `json:"started_at,omitzero"`
	// Parent is the feature the gate stacked on; empty when it built on
	// public main.
	Parent string `json:"parent,omitempty"`
	// ForkedAt is the fork point the gate replayed the feature's own
	// commits from; empty when unstacked.
	ForkedAt string `json:"forked_at,omitempty"`
	// Base is the commit the feature's own commits were replayed onto: R,
	// the rebased tip of the features below, or, for an append to the
	// feature's open PR (Update), that PR's head H; empty otherwise (public
	// main).
	Base string `json:"base,omitempty"`
	// BaseTree is Base's published tree: what the leak scan compared the
	// feature's own commits with. Empty when unstacked.
	BaseTree string `json:"base_tree,omitempty"`
	// Below lists every feature under this one with the head the gate
	// built on, bottom first; nil when unstacked.
	Below []StackHead `json:"below,omitempty"`
	// Update is how the gate built the update of the feature's open PR;
	// nil for a first publish and in a gate recorded before 0.12. An append
	// gate's Base is the PR's head H, and its Commits map the new feature
	// commits to the public commits appended on H.
	Update *GateUpdate `json:"update,omitempty"`
}

type GateCommit struct {
	Source  string `json:"source"`
	Rebased string `json:"rebased"`
}

type GateUpdate struct {
	PR     int    `json:"pr"`
	Head   string `json:"head"`
	Base   string `json:"base"`
	Style  string `json:"style"` // append | replace
	Reason string `json:"replace_reason,omitempty"`
}

type Meta struct {
	SchemaVersion string    `json:"schema_version"`
	Name          string    `json:"name"`
	Branch        string    `json:"branch"`
	CreatedBy     string    `json:"created_by"`
	CreatedAt     time.Time `json:"created_at"`
	Base          string    `json:"base"`
	Abandoned     bool      `json:"abandoned"`
	Gate          *Gate     `json:"gate"`
	Promoted      *Promoted `json:"promoted"`
	// Parent is the feature this one is stacked on; "" (or MainParent)
	// means the pair's base branch, as in every record before 0.11, whatever
	// that branch's real name. ParentName reads it.
	Parent string `json:"parent,omitempty"`
	// ForkedAt is the parent's commit the feature was branched from or last
	// restacked onto: the feature's own commits are ForkedAt..head. Empty
	// for a feature started from main.
	ForkedAt string `json:"forked_at,omitempty"`
	// Archived is set once the feature was handed off to the public repo
	// (6.5); nil otherwise. It is optional, so records stay at 0.12: an
	// older binary ignores it and reads the feature as branch_gone.
	Archived *Archived `json:"archived,omitempty"`
}

type Promoted struct {
	PublicPR int    `json:"public_pr"`
	PlanID   string `json:"plan_id"`
	// FeatureHead is the head the publish was planned from; empty in a
	// record written before 0.6. A feature has moved when its branch head
	// is no longer FeatureHead.
	FeatureHead string `json:"feature_head,omitempty"`
	// Branch is the public branch it was published to; empty in a record
	// written before 0.11 (the feature's name then, unless --branch named one).
	Branch string `json:"branch,omitempty"`
	// Base is its PR's base branch, a real GitHub branch name: the pair's
	// base branch (main on most pairs, but master or trunk on others), or
	// the public branch of the feature below it in a stack. It is compared
	// with the base GitHub reports, never with MainParent. Sync records
	// GitHub's retargeting.
	Base string `json:"base,omitempty"`
	// PublishedHead is the public branch's head as Ghostbranch last knew it:
	// the plan's tip at publish, and GitHub's restack of it once sync saw
	// one with the same patch-ids.
	PublishedHead string `json:"published_head,omitempty"`
	// PatchIDs are the published commits' stable patch-ids, oldest first.
	PatchIDs []string `json:"patch_ids,omitempty"`
	// Stack is the native GitHub stack its PR is in; 0 when none.
	Stack int `json:"stack,omitempty"`
	// NeedsUpdate: the PR below it merged by squash or rebase while the PRs
	// were plain chained PRs (no native stack), so its open public PR still
	// carries that parent's old commits. Republishing it is 6.1a-2.
	NeedsUpdate bool `json:"needs_update,omitempty"`
	// Adopted are commits someone made on the public PR's branch on GitHub
	// that feature pull brought into the feature: they came from the public
	// PR, not from Ghostbranch. Absent when none.
	Adopted []AdoptedCommit `json:"adopted,omitempty"`
}

type StackHead struct {
	Feature string `json:"feature"`
	Head    string `json:"head"`
}

type State string

type StateInput struct {
	Meta         Meta
	BranchExists bool
	Head         string
	PublicMain   string
	Overlay      string
	// PRState is the forge's view of the published PR: "", "open",
	// "merged", "closed" or "unknown".
	PRState string
	// Moved reports that the branch has moved since it was published.
	Moved bool
	// ParentMoved reports that a feature below moved since the feature
	// above it forked from it, or is gone; false when unstacked.
	ParentMoved bool
	// StackStale reports that the gate built on a stack that has changed
	// since (Gate.StackFreshFor is false); false when unstacked.
	StackStale bool
	// Behind counts the branch's commits since it was published that its
	// open PR doesn't have; 0 when it isn't published or the PR isn't open.
	Behind int
}