model

type Client interface {
	// DownloadContents downloads the contents of a file from a repository. (implementation of github.RepositoriesService.DownloadContents)
	DownloadContents(ctx context.Context, owner, repo, filepath string, opts *github.RepositoryContentGetOptions) (io.ReadCloser, *github.Response, error)

	// CreateComment creates a comment on the specified issue. Specifying an issue number of 0 will create a comment on the repository.
	// (implementation of github.IssuesService.CreateComment)
	CreateComment(ctx context.Context, owner string, repo string, number int, comment *github.IssueComment) (*github.IssueComment, *github.Response, error)

	// AddLabelsToIssue adds labels to the specified issue. Specifying an issue number of 0 will add labels to the repository.
	// (implementation of github.IssuesService.AddLabelsToIssue)
	AddLabelsToIssue(ctx context.Context, owner string, repo string, number int, labels []string) ([]*github.Label, *github.Response, error)

	// GetIssue retrieves the specified issue. Specifying an issue number of 0 will return the repository's default issue.
	// (implementation of github.IssuesService.Get)
	GetIssue(ctx context.Context, owner string, repo string, number int) (*github.Issue, *github.Response, error)

	// GetPullRequest retrieves the specified pull request. Specifying a pull request number of 0 will return the repository's default pull request.
	// (implementation of github.PullRequestsService.Get)
	GetPullRequest(ctx context.Context, owner string, repo string, number int) (*github.PullRequest, *github.Response, error)
}

type Comments struct {
	Issues       *string `yaml:"issues,omitempty"`
	PullRequests *string `yaml:"prs,omitempty"`
}

type Config interface {
	// FromBytes is used to parse bytes into the Config instance
	FromBytes(b []byte) error

	// LabelsFor allows config implementations to determine the labels to be applied to the input strings
	LabelsFor(text ...string) map[string]Label
}

type Enable struct {
	Issues       *bool `yaml:"issues,omitempty"`
	PullRequests *bool `yaml:"prs,omitempty"`
}

type FieldOverrides interface {
	// IncludedFields returns the fields that are used for labeling, if not defined, it returns an empty slice
	IncludedFields() []string
}

type FullConfig struct {
	Enable   *Enable          `yaml:"enable,omitempty"`
	Comments *Comments        `yaml:"comments,omitempty"`
	Labels   map[string]Label `yaml:"labels,flow"`
	Fields   []string         `yaml:"fields,omitempty,flow"`
}

type Label struct {
	Include  []string `yaml:"include,omitempty,flow"`
	Exclude  []string `yaml:"exclude,omitempty,flow"`
	Branches []string `yaml:"branches,omitempty,flow"`
}

type RichClient struct {
	*github.Client
}

type SimpleConfig struct {
	// Comment will be applied to any issue or pull request matching the target labels
	Comment string `yaml:"comment,omitempty"`

	// Labels are keyed by the label to be applied, and valued by the array of regular expression patterns to match before applying
	Labels map[string][]string `yaml:"labels,omitempty,flow"`

	// Branches are keyed by the label name, and valued by the array of branch names to match before applying
	Branches map[string][]string `yaml:"branches,omitempty,flow"`
}