checker

type ArchivedStatus struct {
	Status bool
}

type BinaryArtifactData struct {
	// Files contains a list of files.
	Files []File
}

type BranchProtectionsData struct {
	Branches        []clients.BranchRef
	CodeownersFiles []string
}

type CIIBestPracticesData struct {
	Badge clients.BadgeLevel
}

type CITestData struct {
	CIInfo []RevisionCIInfo
}

type Changeset struct {
	ReviewPlatform string
	RevisionID     string
	Commits        []clients.Commit
	Reviews        []clients.Review
	Author         clients.User
}

type Check struct {
	Fn                    CheckFn
	SupportedRequestTypes []RequestType
}

type CheckDetail struct {
	Msg  LogMessage
	Type DetailType // Any of DetailWarn, DetailInfo, DetailDebug.
}

type CheckFn func(*CheckRequest) CheckResult

type CheckNameToFnMap map[string]Check

type CheckRequest struct {
	Ctx                   context.Context
	RepoClient            clients.RepoClient
	CIIClient             clients.CIIBestPracticesClient
	OssFuzzRepo           clients.RepoClient
	Dlogger               DetailLogger
	Repo                  clients.Repo
	VulnerabilitiesClient clients.VulnerabilitiesClient
	// UPGRADEv6: return raw results instead of scores.
	RawResults    *RawResults
	RequiredTypes []RequestType
}

type CheckResult struct {
	Name    string
	Version int
	Error   error
	Score   int
	Reason  string
	Details []CheckDetail
	// Structured results.
	Rules []string // TODO(X): add support.
}

type CodeReviewData struct {
	DefaultBranchChangesets []Changeset
}

type ContributorsData struct {
	Users []clients.User
}

type DangerousWorkflow struct {
	Job  *WorkflowJob
	Type DangerousWorkflowType
	File File
}

type DangerousWorkflowData struct {
	Workflows    []DangerousWorkflow
	NumWorkflows int
}

type DangerousWorkflowType string

type Dependency struct {
	// TODO: unique dependency name.
	// TODO: Job         *WorkflowJob
	Name     *string
	PinnedAt *string
	Location *File
	Msg      *string // Only for debug messages.
	Pinned   *bool
	Type     DependencyUseType
}

type DependencyUpdateToolData struct {
	// Tools contains a list of tools.
	Tools []Tool
}

type DependencyUseType string

type DetailLogger interface {
	Info(msg *LogMessage)
	Warn(msg *LogMessage)
	Debug(msg *LogMessage)
	// Flush resets the logger state and returns collected logs.
	Flush() []CheckDetail
}

type DetailType int

type File struct {
	Path      string
	Snippet   string           // Snippet of code
	Offset    uint             // Offset in the file of Path (line for source/text files).
	EndOffset uint             // End of offset in the file, e.g. if the command spans multiple lines.
	FileSize  uint             // Total size of file.
	Type      finding.FileType // Type of file.

}

type FuzzingData struct {
	Fuzzers []Tool
}

type License struct {
	Name        string                 // OSI standardized license name
	SpdxID      string                 // SPDX standardized identifier
	Attribution LicenseAttributionType // source of licensing information
	Approved    bool                   // FSF or OSI Approved License
}

type LicenseAttributionType string

type LicenseData struct {
	LicenseFiles []LicenseFile
}

type LicenseFile struct {
	LicenseInformation License
	File               File
}

type LogMessage struct {
	// Structured results.
	Finding *finding.Finding

	// Non-structured results.
	Text        string            // A short string explaining why the detail was recorded/logged.
	Path        string            // Fullpath to the file.
	Type        finding.FileType  // Type of file.
	Offset      uint              // Offset in the file of Path (line for source/text files).
	EndOffset   uint              // End of offset in the file, e.g. if the command spans multiple lines.
	Snippet     string            // Snippet of code
	Remediation *rule.Remediation // Remediation information, if any.
}

type MaintainedData struct {
	CreatedAt            time.Time
	Issues               []clients.Issue
	DefaultBranchCommits []clients.Commit
	ArchivedStatus       ArchivedStatus
}

type MetadataData struct {
	Metadata map[string]string
}

type Package struct {
	// TODO: not supported yet. This needs to be unique across
	// ecosystems: purl, OSV, CPE, etc.
	Name *string
	Job  *WorkflowJob
	File *File
	// Note: Msg is populated only for debug messages.
	Msg  *string
	Runs []Run
}

type PackagingData struct {
	Packages []Package
}

type PermissionLevel string

type PermissionLocation string

type PinningDependenciesData struct {
	Dependencies []Dependency
}

type ProportionalScoreWeighted struct {
	Success int
	Total   int
	Weight  int
}

type RawResults struct {
	BinaryArtifactResults       BinaryArtifactData
	BranchProtectionResults     BranchProtectionsData
	CIIBestPracticesResults     CIIBestPracticesData
	CITestResults               CITestData
	CodeReviewResults           CodeReviewData
	ContributorsResults         ContributorsData
	DangerousWorkflowResults    DangerousWorkflowData
	DependencyUpdateToolResults DependencyUpdateToolData
	FuzzingResults              FuzzingData
	LicenseResults              LicenseData
	MaintainedResults           MaintainedData
	Metadata                    MetadataData
	PackagingResults            PackagingData
	PinningDependenciesResults  PinningDependenciesData
	SecurityPolicyResults       SecurityPolicyData
	SignedReleasesResults       SignedReleasesData
	TokenPermissionsResults     TokenPermissionsData
	VulnerabilitiesResults      VulnerabilitiesData
	WebhookResults              WebhooksData
}

type RequestType int

type ReviewPlatform = string

type RevisionCIInfo struct {
	HeadSHA           string
	CheckRuns         []clients.CheckRun
	Statuses          []clients.Status
	PullRequestNumber int
}

type Run struct {
	URL string
}

type Runner struct {
	CheckName    string
	Repo         string
	CheckRequest CheckRequest
}

type SecurityPolicyData struct {
	PolicyFiles []SecurityPolicyFile
}

type SecurityPolicyFile struct {
	// security policy information found in repo or org
	Information []SecurityPolicyInformation
	// file that contains the security policy information
	File File
}

type SecurityPolicyInformation struct {
	InformationType  SecurityPolicyInformationType
	InformationValue SecurityPolicyValueType
}

type SecurityPolicyInformationType string

type SecurityPolicyValueType struct {
	Match      string // Snippet of match
	LineNumber uint   // Line number in policy file of match
	Offset     uint   // Offset in the line of the match
}

type SignedReleasesData struct {
	Releases []clients.Release
}

type TokenPermission struct {
	Job          *WorkflowJob
	LocationType *PermissionLocation
	Name         *string
	Value        *string
	File         *File
	Msg          *string
	Type         PermissionLevel
}

type TokenPermissionsData struct {
	TokenPermissions []TokenPermission
	NumTokens        int
}

type Tool struct {
	URL   *string
	Desc  *string
	Files []File
	Name  string
	// Runs of the tool.
	Runs []Run
	// Issues created by the tool.
	Issues []clients.Issue
	// Merge requests created by the tool.
	MergeRequests []clients.PullRequest
}

type VulnerabilitiesData struct {
	Vulnerabilities []clients.Vulnerability
}

type WebhooksData struct {
	Webhooks []clients.Webhook
}

type WorkflowJob struct {
	Name *string
	ID   *string
}