github

type Author struct {
	Login string `json:"login,omitempty"`
	Name  string `json:"name,omitempty"`
	Email string `json:"email,omitempty"`
}

type Check struct {
	Name  string     `json:"name"`
	State CheckState `json:"state"`
	// Suite identifies the check suite (one workflow run) a check run
	// belongs to; a newer suite of the same app, workflow and event with
	// the same check name supersedes it, as when concurrency cancels a run
	// in favour of a later one. Zero for status contexts.
	Suite int64 `json:"-"`
	// App and Workflow identify what produced a check run: the GitHub App
	// behind its suite and, for GitHub Actions, the workflow. Two workflows
	// can each have a job called "test"; neither says anything about the
	// other's.
	App      int64 `json:"-"`
	Workflow int64 `json:"-"`
	// Event is what triggered a GitHub Actions workflow run, such as
	// "push" or "pull_request". A workflow listening to both runs twice on
	// the same commit, and a run for one event never supersedes the other.
	Event string `json:"-"`
	// Status is true for a commit status context rather than a check run.
	// GitHub reports only the latest status per context, and a status
	// never stands in for a check run of the same name or the reverse.
	Status bool `json:"-"`
}

type CheckState string

type Client interface {
	Viewer(ctx context.Context) (string, error)
	FetchRepo(ctx context.Context, owner, name string) (*Repo, error)
	Merge(ctx context.Context, owner, name string, number int, method, headOID string) error
	Comment(ctx context.Context, owner, name string, number int, body string) error
	PullRequestDetails(ctx context.Context, owner, name string, number int) (*PullRequestDetails, error)
	PullRequestState(ctx context.Context, owner, name string, number int) (PRState, error)
	// FileText reads the file at path on the repository's default branch.
	// It returns nil, and no error, when the repository or the file does
	// not exist or cannot be seen.
	FileText(ctx context.Context, owner, name, path string) ([]byte, error)
}

type Comment struct {
	Author    string    `json:"author"`
	Body      string    `json:"body"`
	CreatedAt time.Time `json:"created_at"`
}

type Commit struct {
	OID           string    `json:"oid"`
	Message       string    `json:"-"`
	CommittedDate time.Time `json:"committed_date"`
	// Authors is the commit author followed by every Co-authored-by
	// trailer. The first is always the author GitHub recorded, empty when
	// it recorded none; only it can carry a Login, since a trailer links no
	// account.
	Authors []Author `json:"authors"`
	// SignedByGitHub is true when the commit carries a valid signature made
	// with GitHub's own key, as Dependabot's commits do.
	SignedByGitHub bool `json:"signed_by_github"`
	// CommittedByGitHub is true when GitHub itself is the committer, as on
	// every commit Dependabot makes. An API call that names its own
	// committer gets no such commit, even when GitHub signs it.
	CommittedByGitHub bool `json:"committed_by_github"`
}

type PRState string

type PullRequest struct {
	Number         int       `json:"number"`
	Title          string    `json:"title"`
	URL            string    `json:"url"`
	Author         string    `json:"author"`
	IsDraft        bool      `json:"is_draft"`
	CreatedAt      time.Time `json:"created_at"`
	HeadOID        string    `json:"head_oid"`
	BaseRef        string    `json:"base_ref"`
	Mergeable      string    `json:"mergeable"`       // MERGEABLE, CONFLICTING, UNKNOWN
	MergeState     string    `json:"merge_state"`     // CLEAN, BEHIND, BLOCKED, DIRTY, ...
	ReviewDecision string    `json:"review_decision"` // APPROVED, REVIEW_REQUIRED, ...
	CommitCount    int       `json:"commit_count"`
	Commits        []Commit  `json:"commits"`
	Checks         []Check   `json:"checks"`
	// ChecksOID is the commit Checks were read from; checks for any commit
	// but HeadOID say nothing about what would be merged.
	ChecksOID string `json:"checks_oid"`
	// CheckCount is the total number of checks, which can exceed the number
	// fetched into Checks.
	CheckCount int `json:"check_count"`
	// BaseMovedAt is when the latest commit on the base branch was made, as
	// a merge into it does; zero when GitHub cannot say.
	BaseMovedAt time.Time `json:"base_moved_at"`
	// Comments are the latest comments, oldest first; CommentCount is how
	// many the PR has, which can exceed the number fetched.
	Comments     []Comment `json:"-"`
	CommentCount int       `json:"-"`
}

type PullRequestDetails struct {
	// Body is the PR description, where Dependabot puts release notes,
	// changelog entries and commits.
	Body string
	// Diff is the PR's unified diff, cut at MaxDiffBytes.
	Diff      string
	Truncated bool
	// DiffError says why Diff is empty, such as GitHub refusing a diff too
	// large to render.
	DiffError string
}

type RateLimitError struct {
	Err   error
	Reset time.Time
}

type Repo struct {
	FullName      string        `json:"full_name"`
	Archived      bool          `json:"archived"`
	Permission    string        `json:"permission"` // ADMIN, MAINTAIN, WRITE, TRIAGE, READ
	SquashAllowed bool          `json:"squash_allowed"`
	MergeAllowed  bool          `json:"merge_allowed"`
	RebaseAllowed bool          `json:"rebase_allowed"`
	PullRequests  []PullRequest `json:"pull_requests"`
	// OpenPRCount is how many open Dependabot PRs GitHub reports, which can
	// exceed the number fetched into PullRequests.
	OpenPRCount int `json:"open_pr_count"`
	// SearchCount is how many results the search returned, before closed
	// PRs still in its index were dropped. Only when it falls short of
	// OpenPRCount were some PRs left unread: GitHub counts those closed PRs
	// too.
	SearchCount int `json:"search_count"`
	// FetchedAt is when this state was read, the "now" that the age of
	// commits and comments is measured against.
	FetchedAt time.Time `json:"-"`
}

type WorkflowScopeError struct{ Err error }