issues

type Change struct {
	State   state.Change
	Title   string
	HTMLURL string
}

type Close struct {
	Closer interface{} // Change, Commit, nil.
}

type Comment struct {
	ID        uint64
	User      users.User
	CreatedAt time.Time
	Edited    *Edited // Edited is nil if the comment hasn't been edited.
	Body      string
	Reactions []reactions.Reaction
	Editable  bool // Editable represents whether the current user (if any) can perform edit operations on this comment (or the encompassing issue).
}

type CommentRequest struct {
	ID       uint64
	Body     *string            // If not nil, set the body.
	Reaction *reactions.EmojiID // If not nil, toggle this reaction.
}

type Commit struct {
	SHA             string
	Message         string
	AuthorAvatarURL string
	HTMLURL         string
}

type CopierFrom interface {
	// CopyFrom copies all issues from src for specified repo.
	// ctx should provide permission to access all issues in src.
	CopyFrom(ctx context.Context, src Service, repo RepoSpec) error
}

type Edited struct {
	By users.User
	At time.Time
}

type Event struct {
	ID        uint64
	Actor     users.User
	CreatedAt time.Time
	Type      EventType
	Close     Close      // Close is only specified for Closed events.
	Rename    *Rename    // Rename is only provided for Renamed events.
	Label     *Label     // Label is only provided for Labeled and Unlabeled events.
	Milestone *Milestone // Milestone is only provided for Milestoned and Demilestoned events.
}

type EventType string

type Issue struct {
	ID     uint64
	State  State
	Title  string
	Labels []Label
	Comment
	Replies int // Number of replies to this issue (not counting the mandatory issue description comment).
}

type IssueListOptions struct {
	State StateFilter
}

type IssueRequest struct {
	State *State
	Title *string
}

type Label struct {
	Name  string
	Color RGB
}

type ListOptions struct {
	// Start is the index of first result to retrieve, zero-indexed.
	Start int

	// Length is the number of results to include.
	Length int
}

type Milestone struct {
	Name string
}

type RGB struct {
	R, G, B uint8
}

type Rename struct {
	From string
	To   string
}

type RepoSpec struct {
	URI string // URI is clean '/'-separated URI. E.g., "example.com/user/repo".
}

type Service interface {
	// List issues.
	List(ctx context.Context, repo RepoSpec, opt IssueListOptions) ([]Issue, error)
	// Count issues.
	Count(ctx context.Context, repo RepoSpec, opt IssueListOptions) (uint64, error)

	// Get an issue.
	Get(ctx context.Context, repo RepoSpec, id uint64) (Issue, error)

	// ListComments lists comments for specified issue id.
	ListComments(ctx context.Context, repo RepoSpec, id uint64, opt *ListOptions) ([]Comment, error)
	// ListEvents lists events for specified issue id.
	ListEvents(ctx context.Context, repo RepoSpec, id uint64, opt *ListOptions) ([]Event, error)

	// Create a new issue.
	Create(ctx context.Context, repo RepoSpec, issue Issue) (Issue, error)
	// CreateComment creates a new comment for specified issue id.
	CreateComment(ctx context.Context, repo RepoSpec, id uint64, comment Comment) (Comment, error)

	// Edit the specified issue id.
	Edit(ctx context.Context, repo RepoSpec, id uint64, ir IssueRequest) (Issue, []Event, error)
	// EditComment edits comment of specified issue id.
	EditComment(ctx context.Context, repo RepoSpec, id uint64, cr CommentRequest) (Comment, error)
}

type State string

type StateFilter State

type TimelineLister interface {
	// IsTimelineLister reports whether the underlying service implements TimelineLister
	// fully for the specified repo.
	IsTimelineLister(repo RepoSpec) bool

	// ListTimeline lists timeline items (Comment, Event) for specified issue id
	// in chronological order, if IsTimelineLister(repo) reported positively.
	// The issue description comes first in a timeline.
	ListTimeline(ctx context.Context, repo RepoSpec, id uint64, opt *ListOptions) ([]interface{}, error)
}