common

type BranchNameBuilderSettings struct {
	BranchNameTemplate string
	BaseBranch         string
	DependencyName     string
	GroupName          string
	NewRelease         *ReleaseInfo
}

type CapturedGroup struct {
	StartIndex int
	EndIndex   int
	Key        string
	Value      string
}

type DatasourceSettings struct {
	// The logger to use for the datasource.
	Logger *slog.Logger
	// Host rules that might apply when using this datasource.
	HostRules []*HostRule
	// An optional cache to use.
	Cache cache.Cache[[]*ReleaseInfo]
}

type DatasourceType string

type Dependency struct {
	// The name of the dependency.
	Name string
	// The current version of the dependency (unprocessed).
	Version string
	// An optional digest either in addition to the version or instead a version.
	Digest string
	// The type of the dependency. Used to allow different handlings per type in the manager. Optional.
	Type string
	// The datasource of the dependency.
	Datasource DatasourceType
	// A map that contains additional data about the dependency (for example a digest).
	AdditionalData map[string]string
	// The filepath from where this dependency was found.
	FilePath string

	// A list of update types that are allowed. Can be "major", "minor", or "patch".
	UpdateTypes []UpdateType
	// This flag defines if unstable releases are allowed. Unstable usually means a version that also has parts with text.
	AllowUnstable *bool
	// A list of registry urls to use. Allows overwriting the default. Depends on the datasource.
	RegistryUrls []string
	// Defines the regexp to use to parse the version into separate parts. See https://github.com/Roemer/gover for more details.
	Versioning string
	// An optional regexp that is used to separate the version part from the rest of the raw version string.
	ExtractVersion string
	// A flag to indicate if versions from a remote that do not match the versioning should be ignored or give an exception.
	IgnoreNonMatching *bool
	// A flag that allows disabling individual dependencies.
	Skip *bool
	// An optional text to describe, why a dependency was disabled.
	SkipReason string
	// Flag to indicate if the version check should be skipped (eg. for versions like latest or jdk8 where there is still a digest)
	SkipVersionCheck *bool

	// Allows defining regexes that replace further information from dependencies (like hash) after updating.
	PostUpgradeReplacements []string
	// An optional name of a group to group dependency updates together.
	GroupName string
	// A list of labels to add to the created PR for this dependency.
	Labels []string
	// A list of reviewers to add to the created PR for this dependency.
	Reviewers []string
	// A template for the title when committing and creating an MR/PR.
	TitleTemplate string
	// A template for the branch name when creating an MR/PR.
	BranchNameTemplate string

	// Contains information about the manager from which this dependency was found from. Is "nil" if the dependency is not from a manager.
	ManagerInfo *ManagerInfo
}

type DependencyWithUpdate struct {
	Dependency *Dependency
	NewRelease *ReleaseInfo
}

type DevcontainerManagerFeatureDependency struct {
	Property       string
	Datasource     DatasourceType
	DependencyName string
}

type DevcontainerManagerSettings struct {
	FeatureDependencies map[string][]*DevcontainerManagerFeatureDependency
}

type GonovateCache struct {
	ReleaseCache      *cache.FileCache[[]*ReleaseInfo]
	GitLabUserIdCache *cache.MemoryCache[int64]
}

type HostRule struct {
	// The host that needs to match in order to use this rule.
	MatchHost string `json:"matchHost" yaml:"matchHost"`
	// The username to authenticate with the host.
	Username string `json:"username" yaml:"username"`
	// The password to authenticate with the host.
	Password string `json:"password" yaml:"password"`
	// A token to authenticate with the host.
	Token string `json:"token" yaml:"token"`
}

type IDatasource interface {
	// Gets all possible releases for the dependency.
	GetReleases(dependency *Dependency) ([]*ReleaseInfo, error)
	// Gets the digest for the dependency.
	GetDigest(dependency *Dependency, releaseVersion string) (string, error)
	// Gets additional data for the dependency and the new release.
	GetAdditionalData(dependency *Dependency, newRelease *ReleaseInfo, dataType string) (string, error)
	// Handles the dependency update searching.
	SearchDependencyUpdates(dependency *Dependency) ([]*ReleaseInfo, error)
}

type IEngine interface {
	// Gets the logger for the engine.
	Logger() *slog.Logger
	// Gets the desired manager.
	GetManager(managerSettings *ManagerSettings) (IManager, error)
	// Resolves match-strings with presets.
	ResolveMatchString(matchString string) (string, error)
	// Resolves versioning-strings with presets.
	ResolveVersioning(versioning string) (string, error)
}

type IManager interface {
	// Gets the id of the manager.
	Id() string
	// Gets the type of the manager.
	Type() ManagerType
	// Gets the settings with which the manager was created.
	Settings() *ManagerSettings
	// Extracts all dependencies from the manager.
	ExtractDependencies(filePath string) ([]*Dependency, error)
	// Applies a dependency update with the manager.
	ApplyDependencyUpdate(dependency *Dependency, newRelease *ReleaseInfo) error
}

type ManagerInfo struct {
	// The id of the manager from which this dependency was found.
	ManagerId string
	// An object that can contain data which is set/read from the manager to process the dependency.
	ManagerData interface{}
}

type ManagerSettings struct {
	// The logger to use for the manager.
	Logger *slog.Logger
	// A flag which is set when the manager is disabled.
	Disabled *bool
	// A list of patterns with the files that the manager should process.
	FilePatterns []string
	// Settings for the RegexManager.
	RegexManagerSettings *RegexManagerSettings
	// Settings for the DevcontainerManager.
	DevcontainerManagerSettings *DevcontainerManagerSettings
}

type ManagerType string

type PlatformSettings struct {
	// The logger to use for the platform.
	Logger *slog.Logger
	// The type of the platform.
	Platform PlatformType
	// The token which is used to interact with the platform. Is expanded from environment variables.
	Token string
	// The endpoint to use when interacting with the platform.
	Endpoint string
	// The author to use when interacting with git.
	GitAuthor string
	// The name of the base branch.
	BaseBranch string
	// Cache for gitlab user id lookups.
	GitLabUserIdCache *cache.MemoryCache[int64]
}

type PlatformType string

type Project struct {
	Path string
}

type RegexManagerSettings struct {
	MatchStringPresets map[string]*presets.MatchStringPreset
	MatchStrings       []string
}

type ReleaseInfo struct {
	// The time when the release was created
	ReleaseDate time.Time `json:"releaseDate,omitzero"`
	// The original versionstring of the release
	VersionString string `json:"versionString"`
	// The parsed version of the release
	Version *gover.Version `json:"-"`
	// The digest of the release
	Digest string `json:"digest,omitempty"`
	// The type of the update this release would be. Can be "major", "minor", or "patch"
	UpdateType UpdateType `json:"-"`
	// Can contain additional data for the release like hashes or urls
	AdditionalData map[string]string `json:"additionalData,omitempty"`
}

type TitleBuilderSettings struct {
	TitleTemplate  string
	DependencyName string
	GroupName      string
	NewRelease     *ReleaseInfo
}

type UpdateGroup struct {
	Title        string
	BranchName   string
	Dependencies []*DependencyWithUpdate
	Labels       []string
	Reviewers    []string
}

type UpdateType string