protocol

type Branch struct {
	Protected bool `json:"protected"`
	Default   bool `json:"default"`
}

type CR struct {
	Number int    `json:"number"`
	Title  string `json:"title"`
	Body   string `json:"body"`
	State  string `json:"state"`
	Draft  bool   `json:"draft,omitempty"`
	// Head is the source branch, Base the target branch.
	Head string `json:"head"`
	Base string `json:"base"`
	URL  string `json:"url"`
	// HeadSHA is the commit the head branch is (or, once merged, was) at.
	HeadSHA string `json:"head_sha,omitempty"`
	// AutoMerge reports that the CR merges by itself once checks pass.
	AutoMerge bool `json:"auto_merge,omitempty"`
	// DeleteHead reports that the head branch should be deleted after merging.
	DeleteHead bool `json:"delete_head,omitempty"`
	// Checking reports that the host is still working out mergeability.
	Checking bool `json:"checking,omitempty"`
	// MergeError is the host's reason a merge did not happen, if any.
	MergeError string `json:"merge_error,omitempty"`
	// FromFork reports that Head lives in another repository.
	FromFork bool `json:"from_fork,omitempty"`
}

type Error struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type Info struct {
	Name     string `json:"name"`
	Protocol int    `json:"protocol"`
	Terms    Terms  `json:"terms"`
	// BlockStyle is one of the Block* constants; empty means BlockHTMLComment.
	BlockStyle string `json:"block_style,omitempty"`
	// MaxBody is the longest description the host accepts; 0 means no limit.
	MaxBody int `json:"max_body,omitempty"`
	// MergeMethods lists the methods Merge supports.
	MergeMethods []string `json:"merge_methods,omitempty"`
	// NativeStacks reports that SyncStack and Unstack manage a stack object
	// on the host, beyond the block git-stack keeps in each description.
	NativeStacks bool `json:"native_stacks,omitempty"`
}

type NewCR struct {
	Head  string `json:"head"`
	Base  string `json:"base"`
	Title string `json:"title"`
	Body  string `json:"body"`
	Draft bool   `json:"draft,omitempty"`
}

type Plugin struct {
	Info Info
	// Detect reports whether repo is hosted where this provider works, for
	// hosts git-stack does not know. It may be nil.
	Detect func(repo Repo) bool
	// Open returns a Provider for repo.
	Open func(repo Repo) (Provider, error)
}

type Provider interface {
	// GetCR fetches a CR by number.
	GetCR(number int) (*CR, error)
	// FindCRForBranch returns the open CR whose head is branch, else the most
	// recently merged one, else nil. CRs from forks are ignored.
	FindCRForBranch(branch string) (*CR, error)
	// SearchCRs returns open CRs whose description contains text.
	SearchCRs(text string) ([]*CR, error)
	// ListCRsTargeting returns open CRs, not from forks, whose base is branch.
	ListCRsTargeting(branch string) ([]*CR, error)
	// CreateCR opens a CR.
	CreateCR(n NewCR) (*CR, error)
	// UpdateCR changes the attributes set in u.
	UpdateCR(number int, u Update) (*CR, error)
	// MarkReady takes a CR out of draft.
	MarkReady(number int) (*CR, error)
	// CancelAutoMerge turns auto-merge off.
	CancelAutoMerge(number int) error
	// Merge asks the host to merge the CR with method once head is at sha.
	// The host may merge at once, or set the CR to merge when checks pass
	// (AutoMerge set in the result). The head branch is never deleted.
	Merge(number int, method, sha string) (*CR, error)
	// GetBranch fetches a branch.
	GetBranch(name string) (*Branch, error)
	// GetRepo fetches repository settings.
	GetRepo() (*RepoSettings, error)
	// SyncStack makes the host's native stack hold exactly numbers, bottom
	// first. Providers without native stacks return nil.
	SyncStack(numbers []int) error
	// Unstack removes the CRs from the host's native stack, if any.
	Unstack(numbers []int) error
}

type Repo struct {
	// RemoteURL is the git remote URL as configured.
	RemoteURL string `json:"remote_url"`
	// Host is the API host, e.g. github.com, with ssh config aliases resolved.
	Host string `json:"host"`
	// Path is the repository path on the host, e.g. owner/repo or group/sub/repo.
	Path string `json:"path"`
}

type RepoSettings struct {
	// DefaultMergeMethod is merge, squash or rebase: what the repository
	// prefers when the user has not chosen.
	DefaultMergeMethod string `json:"default_merge_method"`
}

type Request struct {
	Protocol int     `json:"protocol"`
	Repo     Repo    `json:"repo"`
	Number   int     `json:"number,omitempty"`
	Numbers  []int   `json:"numbers,omitempty"`
	Branch   string  `json:"branch,omitempty"`
	Text     string  `json:"text,omitempty"`
	Method   string  `json:"method,omitempty"`
	SHA      string  `json:"sha,omitempty"`
	New      *NewCR  `json:"new,omitempty"`
	Update   *Update `json:"update,omitempty"`
}

type Response struct {
	Error  *Error        `json:"error,omitempty"`
	Info   *Info         `json:"info,omitempty"`
	Match  bool          `json:"match,omitempty"`
	CR     *CR           `json:"cr,omitempty"`
	CRs    []*CR         `json:"crs,omitempty"`
	Branch *Branch       `json:"branch,omitempty"`
	Repo   *RepoSettings `json:"repo,omitempty"`
}

type Terms struct {
	Short string `json:"short"` // PR, MR
	Long  string `json:"long"`  // pull request, merge request
	// Ref formats a CR number in text, with %d for the number: "#%d", "!%d".
	Ref string `json:"ref"`
}

type Update struct {
	Base  *string `json:"base,omitempty"`
	Title *string `json:"title,omitempty"`
	Body  *string `json:"body,omitempty"`
}