git

type ArchiveParams struct {
	ReadParams
	api.ArchiveParams
}

type BlameParams struct {
	ReadParams
	GitRef string
	Path   string

	// LineFrom allows to restrict the blame output to only lines starting from the provided line number (inclusive).
	// Optional, ignored if value is 0.
	LineFrom int

	// LineTo allows to restrict the blame output to only lines up to the provided line number (inclusive).
	// Optional, ignored if value is 0.
	LineTo int
}

type BlamePart struct {
	Commit   *Commit            `json:"commit"`
	Lines    []string           `json:"lines"`
	Previous *BlamePartPrevious `json:"previous,omitempty"`
}

type BlamePartPrevious struct {
	CommitSHA sha.SHA `json:"commit_sha"`
	FileName  string  `json:"file_name"`
}

type Branch struct {
	Name   string
	SHA    sha.SHA
	Commit *Commit
}

type BranchSortOption int

type Commit struct {
	SHA        sha.SHA           `json:"sha"`
	ParentSHAs []sha.SHA         `json:"parent_shas,omitempty"`
	Title      string            `json:"title"`
	Message    string            `json:"message,omitempty"`
	Author     Signature         `json:"author"`
	Committer  Signature         `json:"committer"`
	FileStats  []CommitFileStats `json:"file_stats,omitempty"`
}

type CommitDivergence struct {
	// Ahead is the count of commits the 'From' ref is ahead of the 'To' ref.
	Ahead int32
	// Behind is the count of commits the 'From' ref is behind the 'To' ref.
	Behind int32
}

type CommitDivergenceRequest struct {
	// From is the ref from which the counting of the diverging commits starts.
	From string
	// To is the ref at which the counting of the diverging commits ends.
	To string
}

type CommitFileAction struct {
	Action  FileAction
	Path    string
	Payload []byte
	SHA     sha.SHA
}

type CommitFileStats struct {
	Status     enum.FileDiffStatus
	Path       string
	OldPath    string // populated only in case of renames
	Insertions int64
	Deletions  int64
}

type CommitFilesParams struct {
	WriteParams
	Title     string // Deprecated
	Message   string
	Branch    string
	NewBranch string
	Actions   []CommitFileAction

	// Committer overwrites the git committer used for committing the files
	// (optional, default: actor)
	Committer *Identity
	// CommitterDate overwrites the git committer date used for committing the files
	// (optional, default: current time on server)
	CommitterDate *time.Time
	// Author overwrites the git author used for committing the files
	// (optional, default: committer)
	Author *Identity
	// AuthorDate overwrites the git author date used for committing the files
	// (optional, default: committer date)
	AuthorDate *time.Time
}

type CommitFilesResponse struct {
	CommitID sha.SHA
}

type CommitNumStatsOutput struct {
	Changes []*api.CommitChangeLines
}

type CommitTag struct {
	Name        string
	SHA         sha.SHA
	IsAnnotated bool
	Title       string
	Message     string
	Tagger      *Signature
	Commit      *Commit
}

type CountCommitsOutput struct {
	CommitStats []types.CommitCount
	Total       int
	AuthorCount map[string]int
}

type CountCommitsParams struct {
	ReadParams
	// GitREF is a git reference (branch / tag / commit SHA)
	GitREF string
	// Since allows to filter for commits since the provided
	Since string
	// Until allows to filter for commits until the provided
	Until string
	// Committer allows to filter for commits based on the committer - Optional, ignored if string is empty.
	Committer string
}

type CountCommitsShortstatOutput struct {
	CommitStats []types.CommitCount
	Total       int
	AuthorCount map[string]types.CommitCountData
}

type CreateBranchOutput struct {
	Branch Branch
}

type CreateBranchParams struct {
	WriteParams
	// BranchName is the name of the branch
	BranchName string
	// Target is a git reference (branch / tag / commit SHA)
	Target string
}

type CreateCommitTagOutput struct {
	CommitTag
}

type CreateCommitTagParams struct {
	WriteParams
	Name string

	// Target is the commit (or points to the commit) the new tag will be pointing to.
	Target string

	// Message is the optional message the tag will be created with - if the message is empty
	// the tag will be lightweight, otherwise it'll be annotated
	Message string

	// Tagger overwrites the git author used in case the tag is annotated
	// (optional, default: actor)
	Tagger *Identity
	// TaggerDate overwrites the git author date used in case the tag is annotated
	// (optional, default: current time on server)
	TaggerDate *time.Time
}

type CreateRepositoryOutput struct {
	UID string
}

type CreateRepositoryParams struct {
	// Create operation is different from all (from user side), as UID doesn't exist yet.
	// Only take actor and envars as input and create WriteParams manually
	RepoUID string
	Actor   Identity
	EnvVars map[string]string

	DefaultBranch string
	Files         []File

	// Committer overwrites the git committer used for committing the files
	// (optional, default: actor)
	Committer *Identity
	// CommitterDate overwrites the git committer date used for committing the files
	// (optional, default: current time on server)
	CommitterDate *time.Time
	// Author overwrites the git author used for committing the files
	// (optional, default: committer)
	Author *Identity
	// AuthorDate overwrites the git author date used for committing the files
	// (optional, default: committer date)
	AuthorDate *time.Time

	Mirror bool
}

type DeleteBranchParams struct {
	WriteParams
	// BranchName is the name of the branch
	BranchName string
	SHA        string
}

type DeleteRefParams struct {
	ReadParams
	Name string
}

type DeleteRepositoryParams struct {
	WriteParams
}

type DeleteTagParams struct {
	WriteParams
	Name string
}

type DiffCutOutput struct {
	Header       HunkHeader
	LinesHeader  string
	Lines        []string
	MergeBaseSHA sha.SHA
}

type DiffCutParams struct {
	ReadParams
	SourceCommitSHA string
	TargetCommitSHA string
	Path            string
	LineStart       int
	LineStartNew    bool
	LineEnd         int
	LineEndNew      bool
	LineLimit       int
}

type DiffFileHeader struct {
	OldName    string
	NewName    string
	Extensions map[string]string
}

type DiffFileHunkHeaders struct {
	FileHeader  DiffFileHeader
	HunkHeaders []HunkHeader
}

type DiffFileNamesOutput struct {
	Files []string
}

type DiffFilesParams struct {
	ReadParams
	SourceCommitSHA string
	TargetCommitSHA string
	DiffUnified     int // 默认会在变更周围显示三行上下文
	ExcludeList     []string
}

type DiffParams struct {
	ReadParams
	BaseRef      string
	HeadRef      string
	MergeBase    bool
	IncludePatch bool
}

type DiffShortStatOutput struct {
	Files     int
	Additions int
	Deletions int
}

type DiffStatsOutput struct {
	Commits      int
	FilesChanged int
	Additions    int
	Deletions    int
}

type File struct {
	Path    string
	Content []byte
}

type FileAction string

type FileDiff struct {
	SHA         string              `json:"sha"`
	OldSHA      string              `json:"old_sha,omitempty"`
	Path        string              `json:"path"`
	OldPath     string              `json:"old_path,omitempty"`
	Status      enum.FileDiffStatus `json:"status"`
	Additions   int64               `json:"additions"`
	Deletions   int64               `json:"deletions"`
	Changes     int64               `json:"changes"`
	Patch       []byte              `json:"patch,omitempty"`
	IsBinary    bool                `json:"is_binary"`
	IsSubmodule bool                `json:"is_submodule"`
}

type FileInfo struct {
	SHA  sha.SHA
	Size int64
}

type FindOversizeFilesOutput struct {
	FileInfos []FileInfo
}

type FindOversizeFilesParams struct {
	RepoUID       string
	GitObjectDirs []string
	SizeLimit     int64
}

type GeneratePipelineParams struct {
	ReadParams
}

type GeneratePipelinesOutput struct {
	PipelineYAML []byte
}

type GetBlobOutput struct {
	SHA sha.SHA
	// Size is the actual size of the blob.
	Size int64
	// ContentSize is the total number of bytes returned by the Content Reader.
	ContentSize int64
	// Content contains the (partial) content of the blob.
	Content io.ReadCloser
}

type GetBlobParams struct {
	ReadParams
	SHA       string
	SizeLimit int64
}

type GetBranchOutput struct {
	Branch Branch
}

type GetBranchParams struct {
	ReadParams
	// BranchName is the name of the branch
	BranchName string
}

type GetCommitDivergencesOutput struct {
	Divergences []api.CommitDivergence
}

type GetCommitDivergencesParams struct {
	ReadParams
	MaxCount int32
	Requests []CommitDivergenceRequest
}

type GetCommitOutput struct {
	Commit Commit `json:"commit"`
}

type GetCommitParams struct {
	ReadParams
	Revision string
}

type GetDefaultBranchOutput struct {
	// BranchName is the name of the branch (not the full reference).
	BranchName string
}

type GetDefaultBranchParams struct {
	ReadParams
}

type GetDiffHunkHeadersOutput struct {
	Files []DiffFileHunkHeaders
}

type GetDiffHunkHeadersParams struct {
	ReadParams
	SourceCommitSHA string
	TargetCommitSHA string
}

type GetRefParams struct {
	ReadParams
	Name string
	Type enum.RefType
}

type GetRefResponse struct {
	SHA sha.SHA
}

type GetRepositorySizeOutput struct {
	// Total size of the repository in KiB.
	Size int64
}

type GetRepositorySizeParams struct {
	ReadParams
}

type GetSubmoduleOutput struct {
	Submodule Submodule
}

type GetSubmoduleParams struct {
	ReadParams
	// GitREF is a git reference (branch / tag / commit SHA)
	GitREF string
	Path   string
}

type GetTreeNodeOutput struct {
	Node   TreeNode
	Commit *Commit
}

type GetTreeNodeParams struct {
	ReadParams
	// GitREF is a git reference (branch / tag / commit SHA)
	GitREF              string
	Path                string
	IncludeLatestCommit bool
}

type HashRepositoryOutput struct {
	Hash []byte
}

type HashRepositoryParams struct {
	ReadParams
	HashType        hash.Type
	AggregationType hash.AggregationType
}

type Hunk struct {
	HunkHeader
	Lines []string
}

type HunkHeader struct {
	OldLine int
	OldSpan int
	NewLine int
	NewSpan int
	Text    string
}

type Identity struct {
	Name  string `json:"name"`
	Email string `json:"email"`
}

type InfoRefsParams struct {
	ReadParams
	Service     string
	Options     []string // (key, value) pair
	GitProtocol string
}

type Interface interface {
	CreateRepository(ctx context.Context, params *CreateRepositoryParams) (*CreateRepositoryOutput, error)
	DeleteRepository(ctx context.Context, params *DeleteRepositoryParams) error
	GetTreeNode(ctx context.Context, params *GetTreeNodeParams) (*GetTreeNodeOutput, error)
	ListTreeNodes(ctx context.Context, params *ListTreeNodeParams) (*ListTreeNodeOutput, error)
	ListPaths(ctx context.Context, params *ListPathsParams) (*ListPathsOutput, error)
	GetSubmodule(ctx context.Context, params *GetSubmoduleParams) (*GetSubmoduleOutput, error)
	GetBlob(ctx context.Context, params *GetBlobParams) (*GetBlobOutput, error)
	CreateBranch(ctx context.Context, params *CreateBranchParams) (*CreateBranchOutput, error)
	CreateCommitTag(ctx context.Context, params *CreateCommitTagParams) (*CreateCommitTagOutput, error)
	DeleteTag(ctx context.Context, params *DeleteTagParams) error
	GetBranch(ctx context.Context, params *GetBranchParams) (*GetBranchOutput, error)
	DeleteBranch(ctx context.Context, params *DeleteBranchParams) error
	ListBranches(ctx context.Context, params *ListBranchesParams) (*ListBranchesOutput, error)
	UpdateDefaultBranch(ctx context.Context, params *UpdateDefaultBranchParams) error
	GetRef(ctx context.Context, params GetRefParams) (GetRefResponse, error)
	DeleteRef(ctx context.Context, params DeleteRefParams) error
	PathsDetails(ctx context.Context, params PathsDetailsParams) (PathsDetailsOutput, error)
	Summary(ctx context.Context, params SummaryParams) (SummaryOutput, error)

	// GetRepositorySize calculates the size of a repo in KiB.
	GetRepositorySize(ctx context.Context, params *GetRepositorySizeParams) (*GetRepositorySizeOutput, error)
	// UpdateRef creates, updates or deletes a git ref. If the OldValue is defined it must match the reference value
	// prior to the call. To remove a ref use the zero ref as the NewValue. To require the creation of a new one and
	// not update of an exiting one, set the zero ref as the OldValue.
	UpdateRef(ctx context.Context, params UpdateRefParams) error

	SyncRepository(ctx context.Context, params *SyncRepositoryParams) (*SyncRepositoryOutput, error)
	MirrorSyncRepository(ctx context.Context, params *MirrorSyncParams) (bool, error)

	MatchFiles(ctx context.Context, params *MatchFilesParams) (*MatchFilesOutput, error)

	/*
	 * Commits service
	 */
	GetCommit(ctx context.Context, params *GetCommitParams) (*GetCommitOutput, error)
	ListCommits(ctx context.Context, params *ListCommitsParams) (*ListCommitsOutput, error)
	ListCommitSHAs(ctx context.Context, params *ListCommitsParams) ([]string, error)
	ListCommitTags(ctx context.Context, params *ListCommitTagsParams) (*ListCommitTagsOutput, error)
	CountCommits(ctx context.Context, params *CountCommitsParams) (*CountCommitsOutput, error)
	CountCommitsWithShortstat(ctx context.Context, params *CountCommitsParams) (*CountCommitsShortstatOutput, error)
	GetCommitDivergences(ctx context.Context, params *GetCommitDivergencesParams) (*GetCommitDivergencesOutput, error)
	CommitFiles(ctx context.Context, params *CommitFilesParams) (CommitFilesResponse, error)
	MergeBase(ctx context.Context, params MergeBaseParams) (MergeBaseOutput, error)
	IsAncestor(ctx context.Context, params IsAncestorParams) (IsAncestorOutput, error)
	FindOversizeFiles(
		ctx context.Context,
		params *FindOversizeFilesParams,
	) (*FindOversizeFilesOutput, error)

	/*
	 * Git Cli Service
	 */
	GetInfoRefs(ctx context.Context, w io.Writer, params *InfoRefsParams) error
	ServicePack(ctx context.Context, params *ServicePackParams) error

	/*
	 * Diff services
	 */
	RawDiff(ctx context.Context, w io.Writer, in *DiffParams, files ...api.FileDiffRequest) error
	Diff(ctx context.Context, in *DiffParams, files ...api.FileDiffRequest) (<-chan *FileDiff, <-chan error)
	DiffFileNames(ctx context.Context, in *DiffParams) (DiffFileNamesOutput, error)
	ReceiveDiffFileNames(ctx context.Context, params *DiffParams) (DiffFileNamesOutput, error)
	ReceiveDiffSNumStatus(ctx context.Context, params *DiffParams) (CommitNumStatsOutput, error)
	CommitDiff(ctx context.Context, params *GetCommitParams, w io.Writer) error
	DiffShortStat(ctx context.Context, params *DiffParams) (DiffShortStatOutput, error)
	DiffStats(ctx context.Context, params *DiffParams) (DiffStatsOutput, error)
	ReceiveCommitNumStat(ctx context.Context, ref string, params *ReadParams) (CommitNumStatsOutput, error)

	GetDiffHunkHeaders(ctx context.Context, params GetDiffHunkHeadersParams) (GetDiffHunkHeadersOutput, error)
	DiffCut(ctx context.Context, params *DiffCutParams) (DiffCutOutput, error)

	DiffFiles(ctx context.Context, params *DiffFilesParams) (string, error)

	/*
	 * Merge services
	 */
	Merge(ctx context.Context, in *MergeParams) (MergeOutput, error)

	/*
	 * Blame services
	 */
	Blame(ctx context.Context, params *BlameParams) (<-chan *BlamePart, <-chan error)
	PushRemote(ctx context.Context, params *PushRemoteParams) error

	GeneratePipeline(ctx context.Context, params *GeneratePipelineParams) (GeneratePipelinesOutput, error)

	/*
	 * Secret Scanning service
	 */
	ScanSecrets(ctx context.Context, param *ScanSecretsParams) (*ScanSecretsOutput, error)
	Archive(ctx context.Context, params ArchiveParams, w io.Writer) error
}

type IsAncestorOutput struct {
	Ancestor bool
}

type IsAncestorParams struct {
	ReadParams
	AncestorCommitSHA   sha.SHA
	DescendantCommitSHA sha.SHA
}

type ListBranchesOutput struct {
	Branches []Branch
}

type ListBranchesParams struct {
	ReadParams
	IncludeCommit bool
	Query         string
	Sort          BranchSortOption
	Order         SortOrder
	Page          int32
	PageSize      int32
}

type ListCommitTagsOutput struct {
	Tags []CommitTag
}

type ListCommitTagsParams struct {
	ReadParams
	IncludeCommit bool
	Query         string
	Sort          TagSortOption
	Order         SortOrder
	Page          int32
	PageSize      int32
}

type ListCommitsOutput struct {
	Commits       []Commit
	RenameDetails []*RenameDetails
	TotalCommits  int
}

type ListCommitsParams struct {
	ReadParams
	// GitREF is a git reference (branch / tag / commit SHA)
	GitREF string
	// After is a git reference (branch / tag / commit SHA)
	// If provided, commits only up to that reference will be returned (exlusive)
	After string
	Page  int32
	Limit int32
	Path  string

	// Since allows to filter for commits since the provided UNIX timestamp - Optional, ignored if value is 0.
	Since int64

	// Until allows to filter for commits until the provided UNIX timestamp - Optional, ignored if value is 0.
	Until int64

	// Committer allows to filter for commits based on the committer - Optional, ignored if string is empty.
	Committer string

	// Author allows to filter for commits based on the author - Optional, ignored if string is empty.
	Author string

	// IncludeStats allows to include information about inserted, deletions and status for changed files.
	IncludeStats bool

	// Regex allows to use regular expression in the Committer and Author fields
	Regex bool
}

type ListPathsOutput struct {
	Files       []string
	Directories []string
}

type ListPathsParams struct {
	ReadParams
	// GitREF is a git reference (branch / tag / commit SHA)
	GitREF             string
	IncludeDirectories bool
}

type ListTreeNodeOutput struct {
	Nodes []TreeNode
}

type ListTreeNodeParams struct {
	ReadParams
	// GitREF is a git reference (branch / tag / commit SHA)
	GitREF             string
	Path               string
	FlattenDirectories bool
}

type MatchFilesOutput struct {
	Files []api.FileContent
}

type MatchFilesParams struct {
	ReadParams
	Ref     string
	DirPath string
	Pattern string
	MaxSize int
}

type MergeBaseOutput struct {
	MergeBaseSHA sha.SHA
}

type MergeBaseParams struct {
	ReadParams
	Ref1 string
	Ref2 string
}

type MergeOutput struct {
	// BaseSHA is the sha of the latest commit on the base branch that was used for merging.
	BaseSHA sha.SHA
	// HeadSHA is the sha of the latest commit on the head branch that was used for merging.
	HeadSHA sha.SHA
	// MergeBaseSHA is the sha of the merge base of the HeadSHA and BaseSHA
	MergeBaseSHA sha.SHA
	// MergeSHA is the sha of the commit after merging HeadSHA with BaseSHA.
	MergeSHA sha.SHA

	CommitCount      int
	ChangedFileCount int
	Additions        int
	Deletions        int
	ConflictFiles    []string
}

type MergeParams struct {
	WriteParams

	BaseSHA    sha.SHA
	BaseBranch string

	// HeadRepoUID specifies the UID of the repo that contains the head branch (required for forking).
	// WARNING: This field is currently not supported yet!
	HeadRepoUID string
	HeadBranch  string

	Title   string // Deprecated
	Message string

	// Committer overwrites the git committer used for committing the files
	// (optional, default: actor)
	Committer *Identity
	// CommitterDate overwrites the git committer date used for committing the files
	// (optional, default: current time on server)
	CommitterDate *time.Time
	// Author overwrites the git author used for committing the files
	// (optional, default: committer)
	Author *Identity
	// AuthorDate overwrites the git author date used for committing the files
	// (optional, default: committer date)
	AuthorDate *time.Time

	RefType enum.RefType
	RefName string

	// HeadExpectedSHA is commit sha on the head branch, if HeadExpectedSHA is older
	// than the HeadBranch latest sha then merge will fail.
	HeadExpectedSHA sha.SHA

	Force            bool
	DeleteHeadBranch bool

	Method enum.MergeMethod
}

type MirrorSyncParams struct {
	ReadParams
	Prune bool
}

type PathDetails struct {
	Path       string  `json:"path"`
	LastCommit *Commit `json:"last_commit,omitempty"`
}

type PathsDetailsOutput struct {
	Details []PathDetails
}

type PathsDetailsParams struct {
	ReadParams
	GitREF string
	Paths  []string
}

type PushRemoteParams struct {
	ReadParams
	RemoteURL string
}

type ReadParams struct {
	RepoUID             string
	AlternateObjectDirs []string
}

type RenameDetails struct {
	OldPath         string
	NewPath         string
	CommitShaBefore sha.SHA
	CommitShaAfter  sha.SHA
}

type Repository interface {
	GetGitUID() string
}

type ScanSecretsFinding struct {
	Description string   `json:"description"`
	StartLine   int64    `json:"start_line"`
	EndLine     int64    `json:"end_line"`
	StartColumn int64    `json:"start_column"`
	EndColumn   int64    `json:"end_column"`
	Match       string   `json:"match"`
	Secret      string   `json:"secret"`
	File        string   `json:"file"`
	SymlinkFile string   `json:"symlink_file"`
	Commit      string   `json:"commit"`
	Entropy     float64  `json:"entropy"`
	Author      string   `json:"author"`
	Email       string   `json:"email"`
	Date        string   `json:"date"`
	Message     string   `json:"message"`
	Tags        []string `json:"tags"`
	RuleID      string   `json:"rule_id"`
	// Fingerprint is the unique identifier of the secret that can be used in .gitleaksignore files.
	Fingerprint string `json:"fingerprint"`
}

type ScanSecretsOutput struct {
	Findings []ScanSecretsFinding
}

type ScanSecretsParams struct {
	ReadParams

	BaseRev string // optional to scan for secrets on diff between baseRev and Rev
	Rev     string

	GitleaksIgnorePath string // optional, keep empty to skip using .gitleaksignore file.
}

type Service struct {
	// contains filtered or unexported fields
}

type ServicePackParams struct {
	*ReadParams
	*WriteParams
	api.ServicePackOptions
}

type Signature struct {
	Identity Identity  `json:"identity"`
	When     time.Time `json:"when"`
}

type SortOrder int

type StreamReader[T any] struct {
	// contains filtered or unexported fields
}

type Submodule struct {
	Name string
	URL  string
}

type SummaryOutput struct {
	CommitCount int
	BranchCount int
	TagCount    int
}

type SummaryParams struct {
	ReadParams
}

type SyncRepositoryOutput struct {
	DefaultBranch string
}

type SyncRepositoryParams struct {
	WriteParams
	Source            string
	CreateIfNotExists bool

	// RefSpecs [OPTIONAL] allows to override the refspecs that are being synced from the remote repository.
	// By default all references present on the remote repository will be fetched (including scm internal ones).
	RefSpecs []string
	// DefaultBranch [OPTIONAL] allows to override the default branch of the repository.
	// If empty, the default branch will be set to match the remote repository's default branch.
	// WARNING: If the remote repo is empty and no value is provided, an api.ErrNoDefaultBranch error is returned.
	DefaultBranch string
}

type TagSortOption int

type TreeNode struct {
	Type TreeNodeType
	Mode TreeNodeMode
	SHA  string // TODO: make sha.SHA
	Name string
	Path string
}

type TreeNodeMode string

type TreeNodeType string

type UpdateDefaultBranchParams struct {
	WriteParams
	// BranchName is the name of the branch (not the full reference).
	BranchName string
}

type UpdateRefParams struct {
	WriteParams
	Type enum.RefType
	Name string
	// NewValue specified the new value the reference should point at.
	// An empty value will lead to the deletion of the branch.
	NewValue sha.SHA
	// OldValue is an optional value that can be used to ensure that the reference
	// is updated iff its current value is matching the provided value.
	OldValue sha.SHA
}

type WriteParams struct {
	RepoUID string
	Actor   Identity
	EnvVars map[string]string
	Mirror  bool
}