worktreebranches

type BranchCleanupResult struct {
	BranchEntry
	Eligible       bool   `json:"eligible"`
	SkipReason     string `json:"skip_reason,omitempty"`
	Applied        bool   `json:"applied"`
	Outcome        string `json:"outcome"` // planned, deleted, skipped, or failed
	Error          string `json:"error,omitempty"`
	RecoveryBundle string `json:"recovery_bundle,omitempty"`
}

type BranchEntry struct {
	Repository            string              `json:"repository"`
	Branch                string              `json:"branch"`
	RefKind               string              `json:"ref_kind,omitempty"` // branch or tag
	Scope                 string              `json:"scope"`              // local or remote
	SHA                   string              `json:"sha"`
	ShortSHA              string              `json:"short_sha"`
	CommitterDate         time.Time           `json:"committer_date,omitempty"`
	Author                string              `json:"author,omitempty"`
	Title                 string              `json:"title,omitempty"`
	Base                  string              `json:"base"`
	TargetSHA             string              `json:"target_sha,omitempty"`
	Disposition           string              `json:"disposition"`
	Evidence              string              `json:"evidence"`
	Reason                string              `json:"reason,omitempty"`
	Task                  string              `json:"task,omitempty"`
	OpenPullRequest       *PullRequest        `json:"open_pull_request,omitempty"`
	OpenBasePullRequest   *PullRequest        `json:"open_base_pull_request,omitempty"`
	PullRequests          []BranchPullRequest `json:"pull_requests,omitempty"`
	PullRequestQueried    bool                `json:"pull_request_queried,omitempty"`
	PullRequestQueryError string              `json:"pull_request_query_error,omitempty"`
	// LandingSHA and ReceiptPullRequest carry a receipted branch's proved
	// landing so apply can re-verify the receipt — not ancestry, which a
	// receipted branch fails by construction — against the freshly fetched
	// target. See #req:receipted-requires-a-proved-landing.
	LandingSHA         string       `json:"landing_sha,omitempty"`
	ReceiptPullRequest *PullRequest `json:"receipt_pull_request,omitempty"`
	// PullRequestQueryFailed distinguishes "no matching pull request" from
	// "WB could not ask GitHub." Cleanup's remote apply fails the whole scope
	// closed on the latter; list surfaces the specific error.
	PullRequestQueryFailed bool `json:"pull_request_query_failed,omitempty"`
	// AbsorbedByRejection explains why an operator-supplied --absorbed-by
	// pointer did not verify for this branch. It is set only when
	// --absorbed-by was passed and its attested-absorption proof (see
	// attestedAbsorbedReceipt, shared with `wb worktree cleanup
	// --absorbed-by`) failed for this candidate specifically; the branch keeps
	// whatever disposition its patch evidence (or --receipts) produces. A
	// wrong or dishonest pointer can therefore only fail closed, never widen
	// eligibility, and the rejection is reported rather than silently
	// swallowed.
	AbsorbedByRejection   string `json:"absorbed_by_rejection,omitempty"`
	SupersessionReceipt   string `json:"supersession_receipt,omitempty"`
	SupersessionReviewer  string `json:"supersession_reviewer,omitempty"`
	SupersessionReceiptID string `json:"supersession_receipt_id,omitempty"`
	SupersessionSHA256    string `json:"supersession_sha256,omitempty"`
	SupersessionRejection string `json:"supersession_rejection,omitempty"`
	SupersededAtOrigin    bool   `json:"superseded_at_origin,omitempty"`
}

type BranchPullRequest struct {
	Number   int        `json:"number"`
	URL      string     `json:"url"`
	Role     string     `json:"role"`  // head or base
	State    string     `json:"state"` // open, merged, or closed
	Head     string     `json:"head"`
	Base     string     `json:"base"`
	HeadSHA  string     `json:"head_sha"`
	MergeSHA string     `json:"merge_sha,omitempty"`
	MergedAt *time.Time `json:"merged_at,omitempty"`
}

type BranchQuarantineRequest struct {
	Repository string `json:"repository"`
	Ref        string `json:"ref"`
	SHA        string `json:"sha"`
	Reason     string `json:"reason"`
}

type BranchQuarantineResult struct {
	BranchQuarantineRequest
	Destination string `json:"destination,omitempty"`
	Outcome     string `json:"outcome"`
	Error       string `json:"error,omitempty"`
}

type BranchRef struct {
	Name          string
	SHA           string
	CommitterDate time.Time
	UnknownDate   bool
	Author        string
	Title         string
}

type BranchUse struct {
	Repository string
	Branch     string
	Task       string
}

type GitHubPullRequest = worktreelanding.GitHubPullRequest

type GitHubRef = worktreelanding.GitHubRef

type GitHubRepository = worktreelanding.GitHubRepository

type InventoryPorts struct {
	Discover            func(string) ([]Repository, error)
	ListInUse           func(context.Context, string, string) ([]BranchUse, error)
	Git                 worktreeproof.GitQuery
	CheckedOut          func(context.Context, string) (map[string]bool, string)
	InUse               func(context.Context, string, string) (map[string]string, string)
	OpenHeadPull        func(context.Context, string, string, string, string) (*PullRequest, error)
	OpenBasePull        func(context.Context, string, string, string) (*PullRequest, error)
	FetchTarget         func(context.Context, string, string) (string, error)
	IsAncestor          func(context.Context, string, string, string) (bool, error)
	ContentContained    func(context.Context, string, string, string) (bool, error)
	CommitTree          func(context.Context, string, string) (string, error)
	Supersession        func(context.Context, string, Repository, BranchRef, string, string) (*SupersessionEvidence, string)
	SupersessionDigest  func(string) (string, error)
	AttestedReceipt     func(context.Context, Repository, BranchRef, string, string, string) (*worktreelanding.VerifiedCandidate, string, error)
	PullRequestsForHead func(context.Context, Repository, string) ([]GitHubPullRequest, error)
	AbsorbingPR         func([]GitHubPullRequest, string) *PullRequest
	PullRequestAPI      func(context.Context, string, string) ([]byte, error)
	HostName            func() (string, error)
	TempDir             func() (string, error)
	RemoveDir           func(string) error
}

type InventoryService struct{ Ports InventoryPorts }

type InventorySweep struct {
	ProjectsRoot, Base, Scope, Only, Filter, Repository, Org, Branch, Name string
	OlderThan                                                              time.Duration
	Progress                                                               io.Writer
	Now                                                                    time.Time
	Receipts, WithPRs, Cleanup, IncludeRetired                             bool
	AbsorbedBy, SupersededBy                                               string
}

type PeerEvidence struct {
	Path        string        `json:"-"`
	Host        string        `json:"host"`
	GeneratedAt time.Time     `json:"generated_at"`
	Repository  string        `json:"repository"`
	Branch      string        `json:"branch"`
	Base        string        `json:"base"`
	Diagnostics []string      `json:"diagnostics,omitempty"`
	Entries     []BranchEntry `json:"entries"`
}

type PeerEvidenceValidation struct {
	LocalHost, Repository, Branch, Base string
	RequireHosts                        []string
	Evidence                            []PeerEvidence
	Results                             []BranchCleanupResult
	Now                                 time.Time
}

type PolicyOptions struct {
	Base, Scope, Only, Branch, Name string
	OlderThan                       time.Duration
	Now                             time.Time
}

type PullRequest = worktreeproof.PullRequest

type PullRequestEvidence struct {
	Requests []BranchPullRequest
	OpenHead *PullRequest
	OpenBase *PullRequest
	Err      error
}

type Repository struct {
	Slug string
	Path string
}

type RepositoryInspection func(context.Context, Repository, InventorySweep, map[string]string) ([]BranchEntry, string)

type RetiredInventory struct {
	Host                                 string
	GeneratedAt                          time.Time
	Repository, Org, Branch, Base, Scope string
	Entries                              []BranchEntry
	Diagnostics                          []string
	Totals                               map[string]int
	RetiredRefs                          map[string]int
	RetiredBranches                      int
	RetiredTags                          map[string]int
	RetiredTagNames                      int
	RetiredRemoteUnavailable             bool
	ElapsedMS                            int64
}

type SupersessionApproval = worktreeproof.SupersessionApproval

type SupersessionDependencyDelta = worktreeproof.SupersessionDependencyDelta

type SupersessionEntry struct {
	Task, Repository, Branch, Base, HeadSHA, RemoteTargetSHA string
	CanonicalDir, WorktreeDir                                string
	OpenPullRequest                                          *PullRequest
}

type SupersessionEvidence struct {
	Reviewer  string
	ReceiptID string
}

type SupersessionPorts struct {
	Git                worktreeproof.GitQuery
	ReadGitFileBytes   func(context.Context, string, string, string) ([]byte, error)
	IsAncestor         func(context.Context, string, string, string) (bool, error)
	ReadReceipt        func(string) ([]byte, error)
	ReadCampaignMarker func(string) (bool, error)
}

type SupersessionReceipt = worktreeproof.SupersessionReceipt

type SupersessionReplacement = worktreeproof.SupersessionReplacement

type SupersessionResidual = worktreeproof.SupersessionResidual

type SupersessionService struct{ Ports SupersessionPorts }

type SupersessionWorkflowAdoption = worktreeproof.SupersessionWorkflowAdoption