terminal

type BodyEditor func(context.Context, string) (Draft, error)

type Browser interface {
	Open(context.Context, string, string) error
}

type Cell struct {
	Text, Link, Color string
	Bold, Muted       bool
	// Time, when set, replaces Text: relative on a TTY, RFC3339 UTC otherwise.
	Time time.Time
}

type Choice struct {
	Label, Value string
}

type Chooser interface {
	// Choose asks for one of choices, starting at the one whose value is initial, else the first.
	Choose(ctx context.Context, title string, choices []Choice, initial string) (string, error)
}

type Column struct {
	// Header names the column; a TTY shows it uppercased above the rows.
	Header string
	// Flex columns shrink to fit the terminal width, widest first, cutting text with "…", down to
	// Min, the header width or eight cells, whichever is wider. Other columns are never cut.
	Flex bool
	Min  int
	// TTYOnly and PipedOnly restrict the column to one kind of output.
	TTYOnly, PipedOnly bool
	// Prefix precedes non-empty cells on a TTY, such as "#" before issue numbers.
	Prefix string
}

type Confirmation struct {
	// Prompt asks about the action in sentence case: `Delete label "bug" from alice/x?`.
	Prompt string
	// DefaultYes lets Enter accept, for constructive actions the user just asked for, such as
	// submitting a form they filled in. Destructive actions keep the default no.
	DefaultYes bool
	// Typed, when set, must be typed to confirm, for irreversible actions such as deleting a repository.
	Typed string
	// NonTTY names the action in the error returned when no prompt is possible and --yes is
	// missing: `delete label "bug" from alice/x`. Without it, a confirmation that defaults to no
	// names the Prompt up to its question mark.
	NonTTY string
}

type Display struct {
	TTY bool
	// Color enables SGR colors and emphasis on a TTY.
	Color bool
	// Links enables OSC 8 links on the first table column on a TTY.
	Links bool
	// Markdown renders view bodies on a TTY.
	Markdown bool
	// Width is the terminal width that table rows fit in; 0 disables truncation.
	Width int
	// Now is the reference for relative times; zero means the current time.
	Now time.Time
}

type Draft struct {
	Path string
	Body string
}

type Editor interface {
	Edit(context.Context, string, string) (Draft, error)
	EditPath(context.Context, string, string) error
}

type Field struct {
	Label string
	// Value is plain text. Cells, when set, replace it with styled values joined by commas, such
	// as colored labels.
	Value string
	Cells []Cell
	// TTYOnly and PipedOnly restrict the field to one kind of output, like table columns.
	TTYOnly, PipedOnly bool
}

type FormPrompter struct {
	Streams Streams
	// Color reports whether forms are colored, following gt's color settings for ErrOut; nil colors
	// them as the terminal allows.
	Color func() bool
	// contains filtered or unexported fields
}

type IssueEditForm interface {
	EditIssue(context.Context, IssueEditFormChoices) (IssueEditFormValues, error)
}

type IssueEditFormChoices struct {
	// Heading names the edited issue above the form, such as "Editing alice/x#2 (Fix login)".
	Heading     string
	Title, Body string
	// Base, set for a pull request, is its base branch, which the form asks for after the title.
	Base               string
	Assignees          []string
	Milestone          *IssueMilestoneChoice
	Labels             []IssueLabelChoice
	Deadline           *time.Time
	AvailableAssignees []string
	Milestones         []IssueMilestoneChoice
	AvailableLabels    []IssueLabelChoice
	EditBody           BodyEditor
}

type IssueEditFormValues struct {
	Title, Body    string
	Base           string
	Assignees      []string
	Milestone      int64
	ClearMilestone bool
	Labels         []int64
	Deadline       *time.Time
	ClearDeadline  bool
	Draft          Draft
}

type IssueForm interface {
	CreateIssue(context.Context, IssueFormChoices) (IssueFormValues, error)
}

type IssueFormChoices struct {
	Templates []IssueTemplateChoice
	// Template, when set, is used instead of asking: the form starts with its title and body.
	Template   *IssueTemplateChoice
	Assignees  []string
	Milestones []IssueMilestoneChoice
	Labels     []IssueLabelChoice
	EditBody   BodyEditor
	// AskNext asks "What's next?" after the title and body, offering metadata only on request.
	AskNext bool
}

type IssueFormValues struct {
	Title, Body string
	Assignees   []string
	Milestone   int64
	Labels      []int64
	Deadline    *time.Time
	Draft       Draft
	// TemplateLabels are the label names of the chosen template, which the caller adds to Labels.
	TemplateLabels []string
	// TemplateRef is the branch or tag the chosen template sets on the issue.
	TemplateRef string
}

type IssueLabelChoice struct {
	Name string
	ID   int64
}

type IssueMilestoneChoice struct {
	Title string
	ID    int64
}

type IssueTemplateChoice struct {
	Name, About, Title, Body, Ref string
	Labels                        []string
}

type JSONOutput struct {
	// Fields holds the comma-separated fields to keep; "" and "*" keep every field.
	Fields string
	// Allowed lists the fields the command documents. A listed field that an item omits (an empty
	// omitempty value) is selected as null instead of being reported unknown; nil allows none.
	Allowed []string
	// Query is a jq expression applied after field selection.
	Query string
	// Pretty indents the JSON for a terminal and strips control characters from raw jq strings.
	Pretty bool
	// Safe strips control characters from raw jq strings and encoded text like Pretty, for terminal
	// output that must stay one line per value.
	Safe bool
	// Color highlights pretty JSON keys and values.
	Color bool
	// Links lets a template's hyperlink function emit links.
	Links bool
	// CSV writes the selected objects as CSV instead of JSON; Query must be empty.
	CSV bool
	// NoHeader leaves out the CSV header row, for rows that continue earlier output.
	NoHeader bool
	// Template renders the selected objects through this Go template instead of writing JSON; Query
	// and CSV must be empty.
	Template string
	// Now is the time that the template function timeago measures from; it is the clock by default.
	Now func() time.Time
}

type LabelForm interface {
	// EditLabel asks for the name, color and description of a label, starting from current, under
	// heading, such as `Editing label "bug" in alice/x`. validColor checks a color answer.
	EditLabel(ctx context.Context, heading string, current LabelFormValues, validColor func(string) error) (LabelFormValues, error)
}

type LabelFormValues struct {
	Name, Color, Description string
}

type LoginAnswers struct {
	// Host is the instance URL; Method one of LoginToken, LoginOAuth and LoginSSHKey.
	Host, Method string
	// Token is the pasted access token, and SSHKey the private key path, for their methods.
	Token, SSHKey string
	// Store is the credential store of a token: keyring or file.
	Store string
	// SetupGit configures Git to use gt for the instance.
	SetupGit bool
}

type LoginForm interface {
	Login(context.Context, LoginQuestions, *LoginAnswers) error
}

type LoginQuestions struct {
	Host, Method, Store, SetupGit bool
	// ResolveHost normalizes an entered instance, or explains why it is not one.
	ResolveHost func(string) (string, error)
	// TokenHint tells where to create an access token on an instance.
	TokenHint func(host string) string
}

type MergeForm interface {
	SelectPull(context.Context, []MergePullChoice) (int64, error)
	MergeOptions(context.Context, MergeFormChoices) (MergeFormValues, error)
}

type MergeFormChoices struct {
	// Header introduces the form, such as `Merge #3 "Merge me" (feat/merge-me → main) in alice/x`.
	Header string
	// Methods are the merge styles the repository allows; Method preselects one. Without Methods,
	// the form does not ask for one.
	Methods []string
	Method  string
	// DeleteBranch preselects whether to delete the head branch; Branch, when set, asks it.
	DeleteBranch bool
	Branch       string
}

type MergeFormValues struct {
	Method       string
	DeleteBranch bool
}

type MergePullChoice struct {
	Number      int64
	Title, Head string
}

type MilestoneForm interface {
	// EditMilestone asks for the fields of a milestone, starting from current, under heading, such
	// as "Editing milestone v1.0". Empty values create a milestone.
	EditMilestone(ctx context.Context, heading string, current MilestoneFormValues) (MilestoneFormValues, error)
}

type MilestoneFormValues struct {
	Title, Description string
	Deadline           *time.Time
	// Editor is the configured editor command, input only: with one, ctrl+e opens it in the description, except in accessible mode.
	Editor string
}

type Pager interface {
	Page(context.Context, string, io.Reader, Streams) error
}

type PagerError struct{ Err error }

type Policy struct{ Enabled, NoInput, Machine, Interactive bool }

type Prompter interface {
	// Ask collects one line, re-prompting inline until validate, when set, accepts it.
	Ask(ctx context.Context, title string, validate func(string) error) (string, error)
	// AskText collects multi-line markdown, starting from initial.
	AskText(ctx context.Context, title, initial string) (string, error)
	// SecretInput collects a value without displaying it.
	SecretInput(ctx context.Context, title string) (string, error)
	// ConfirmDefault asks a yes/no question that Enter answers with defaultYes.
	ConfirmDefault(ctx context.Context, title string, defaultYes bool) (bool, error)
}

type PullForm interface {
	CreatePull(context.Context, PullFormChoices) (PullFormValues, error)
}

type PullFormChoices struct {
	// Repo is the base repository, named in the form's header.
	Repo                                   string
	BaseOwner, Base, HeadOwner, HeadBranch string
	// Title and Body seed the form; Title applies only while HeadBranch is kept.
	Title, Body          string
	AllowMaintainerEdits bool
	Assignees            []string
	Milestones           []IssueMilestoneChoice
	Labels               []IssueLabelChoice
	// CanPush offers metadata, which needs push access; without it, changing branches offers AGit.
	CanPush  bool
	EditBody BodyEditor
	// SeedBody seeds the body in place of Body when the branches asked first change.
	SeedBody func(ctx context.Context, base, headBranch string) (string, error)
}

type PullFormValues struct {
	IssueFormValues
	Agit                 bool
	Base, Head, Topic    string
	AllowMaintainerEdits bool
	// AsDraft submits the pull request as a draft.
	AsDraft bool
}

type ReleaseForm interface {
	// EditRelease asks for the fields of a release, starting from current, under heading, such as
	// "Editing release v1.0 in alice/x". Empty values create a release.
	EditRelease(ctx context.Context, heading string, current ReleaseFormValues) (ReleaseFormValues, error)
}

type ReleaseFormValues struct {
	Tag, Title, Notes, Target string
	Draft, Prerelease         bool
	// Editor is the configured editor command, input only: with one, ctrl+e opens it in the notes, except in accessible mode.
	Editor string
}

type RepoForm interface {
	CreateRepo(context.Context, RepoFormChoices) (RepoFormValues, error)
}

type RepoFormChoices struct {
	// Owners are the accounts the repository can belong to, yourself first.
	Owners               []string
	Licenses, Gitignores []string
	// ValidateName and ValidateDescription check the answers as repository creation does.
	ValidateName, ValidateDescription func(string) error
}

type RepoFormValues struct {
	Owner, Name, Description string
	Private, AutoInit        bool
	License                  string
	Gitignores               []string
	Clone                    bool
}

type ReviewCommentDraft struct {
	Path, Body       string
	OldLine, NewLine int64
}

type ReviewForm interface {
	CreateReview(context.Context, ReviewFormChoices) (ReviewFormValues, error)
}

type ReviewFormChoices struct {
	// Header introduces the form, such as `Reviewing #1 "Add one.txt" (feat/one → main) in alice/x`.
	Header string
	// Author leaves out approving and requesting changes, which Gitea refuses on one's own pull request.
	Author bool
	// Body seeds the review body.
	Body string
	// Editor is the configured editor command that ctrl+e opens on the body, except in accessible mode; empty disables it.
	Editor string
	// ReviewDiff, when non-nil, offers to annotate the diff in the editor after the body.
	ReviewDiff func(context.Context) ([]ReviewCommentDraft, error)
	// Pending tells that the pending review a comment would publish has a body or inline
	// comments, so that the comment needs neither.
	Pending bool
}

type ReviewFormValues struct {
	Event    string
	Body     string
	Comments []ReviewCommentDraft
}

type Streams struct {
	In     io.Reader
	Out    io.Writer
	ErrOut io.Writer
	InTTY  bool
	OutTTY bool
	ErrTTY bool
	// OutPlain and ErrPlain mark a terminal that shows escape sequences as text, such as a Windows
	// console without virtual terminal processing: output on it stays uncolored.
	OutPlain, ErrPlain bool
	// Width is the number of columns human output on Out fits in; 0 means unlimited.
	Width int
	// contains filtered or unexported fields
}

type SystemBrowser struct{ ErrOut io.Writer }

type SystemEditor struct {
	Directory string
	Streams   Streams
}

type SystemPager struct{}

type View struct {
	Title, ID string
	// Badges, such as the state, start the line under the title; Meta completes it, for example
	// "alice opened about 2 hours ago • 2 comments".
	Badges []Cell
	Meta   string
	Fields []Field
	Body   string
	// Plain marks the body as plain text, such as a commit message, which is never rendered as markdown.
	Plain bool
	// Bodyless resources, such as webhooks, have no body: the view ends with the fields and URL.
	Bodyless bool
	// Kind names the resource in the footer, such as "issue".
	Kind, URL string
}