clients

type BadgeLevel uint

type BadgeResponse struct {
	BadgeLevel string `json:"badge_level"`
}

type BranchProtectionRule struct {
	PullRequestRule         PullRequestRule
	AllowDeletions          *bool
	AllowForcePushes        *bool
	RequireLinearHistory    *bool
	EnforceAdmins           *bool
	RequireLastPushApproval *bool
	CheckRules              StatusChecksRule
}

type BranchRef struct {
	Name                 *string
	Protected            *bool
	BranchProtectionRule BranchProtectionRule
}

type CIIBestPracticesClient interface {
	GetBadgeLevel(ctx context.Context, uri string) (BadgeLevel, error)
}

type CheckRun struct {
	Status     string
	Conclusion string
	URL        string
	App        CheckRunApp
}

type CheckRunApp struct {
	Slug string
}

type Commit struct {
	CommittedDate          time.Time
	Message                string
	SHA                    string
	AssociatedMergeRequest PullRequest
	Committer              User
}

type Issue struct {
	URI               *string
	CreatedAt         *time.Time
	Author            *User
	AuthorAssociation *RepoAssociation
	Comments          []IssueComment
}

type IssueComment struct {
	CreatedAt         *time.Time
	Author            *User
	AuthorAssociation *RepoAssociation
}

type Label struct {
	Name string
}

type Language struct {
	// Name is the name of this language.
	Name LanguageName

	// NumLines is the total number of code lines of this language in the repo.
	NumLines int
}

type LanguageName string

type License struct {
	Key    string // RepositoryLicense.GetLicense().GetKey()
	Name   string // RepositoryLicense.GetLicense().GetName()
	Path   string // RepositoryLicense.GetName()
	SPDXId string // RepositoryLicense.GetLicense().GetSPDXID()
	Type   string // RepositoryLicense.GetType()
	Size   int    // RepositoryLicense.GetSize()
}

type PullRequest struct {
	Number   int
	MergedAt time.Time
	HeadSHA  string
	Author   User
	Labels   []Label
	Reviews  []Review
	MergedBy User
}

type PullRequestRule struct {
	Required                     *bool // are PRs required
	RequiredApprovingReviewCount *int32
	DismissStaleReviews          *bool
	RequireCodeOwnerReviews      *bool
}

type Release struct {
	TagName         string
	URL             string
	TargetCommitish string
	Assets          []ReleaseAsset
}

type ReleaseAsset struct {
	Name string
	URL  string
}

type Repo interface {
	// Path returns the specifier of the repository within its forge
	Path() string
	// URI returns the fully qualified address of the repository
	URI() string
	// Host returns the web domain of the repository
	Host() string
	// String returns a string representation of the repository URI
	String() string
	// IsValid returns whether the repository path on the forge is properly
	// -formatted (GitHub), or that the repository exists (GitLab)
	IsValid() error
	Metadata() []string
	AppendMetadata(metadata ...string)
}

type RepoAssociation uint32

type RepoClient interface {
	InitRepo(repo Repo, commitSHA string, commitDepth int) error
	URI() string
	IsArchived() (bool, error)
	ListFiles(predicate func(string) (bool, error)) ([]string, error)
	// Returns an absolute path to the local repository
	// in the format that matches the local OS
	LocalPath() (string, error)
	// GetFileReader returns an io.ReadCloser corresponding to the desired file.
	// Callers should ensure to Close the Reader when finished.
	GetFileReader(filename string) (io.ReadCloser, error)
	GetBranch(branch string) (*BranchRef, error)
	GetCreatedAt() (time.Time, error)
	GetDefaultBranchName() (string, error)
	GetDefaultBranch() (*BranchRef, error)
	GetOrgRepoClient(context.Context) (RepoClient, error)
	ListCommits() ([]Commit, error)
	ListIssues() ([]Issue, error)
	ListLicenses() ([]License, error)
	ListReleases() ([]Release, error)
	ListContributors() ([]User, error)
	ListSuccessfulWorkflowRuns(filename string) ([]WorkflowRun, error)
	ListCheckRunsForRef(ref string) ([]CheckRun, error)
	ListStatuses(ref string) ([]Status, error)
	ListWebhooks() ([]Webhook, error)
	ListProgrammingLanguages() ([]Language, error)
	Search(request SearchRequest) (SearchResponse, error)
	SearchCommits(request SearchCommitsOptions) ([]Commit, error)
	Close() error
}

type Review struct {
	Author *User
	State  string
}

type SearchCommitsOptions struct {
	Author string
}

type SearchRequest struct {
	Query    string
	Filename string
	Path     string
}

type SearchResponse struct {
	Results []SearchResult
	Hits    int
}

type SearchResult struct {
	Path string
}

type Status struct {
	State     string
	Context   string
	URL       string
	TargetURL string
}

type StatusChecksRule struct {
	UpToDateBeforeMerge  *bool
	RequiresStatusChecks *bool
	Contexts             []string
}

type User struct {
	Login            string
	Companies        []string
	Organizations    []User
	NumContributions int
	ID               int64
	IsBot            bool
	IsCodeOwner      bool
}

type VulnerabilitiesClient interface {
	ListUnfixedVulnerabilities(
		context context.Context,
		commit string,
		localDir string,
	) (VulnerabilitiesResponse, error)
}

type VulnerabilitiesResponse struct {
	Vulnerabilities []Vulnerability
}

type Vulnerability struct {
	ID      string
	Aliases []string
}

type Webhook struct {
	Path           string
	ID             int64
	UsesAuthSecret bool
}

type WorkflowRun struct {
	HeadSHA *string `json:"head_sha"`
	URL     string
}