installer

type ChecksumValidator struct {
	// UniqueFilename is the name of the global file containing all the checksums
	// Usually "checksums.txt", "SHA256SUMS", etc.
	UniqueFilename string
}

type Config struct {
	// Source where to load the releases from (example: GitHubSource).
	Source Source
	// Validator represents types which enable additional validation of downloaded release.
	Validator Validator
	// Filters are regexp used to filter on specific assets for releases with multiple assets.
	// An asset is selected if it matches any of those, in addition to the regular tag, os, arch, extensions.
	// Please make sure that your filter(s) uniquely match an asset.
	Filters []string
	// OS is set to the value of runtime.GOOS by default, but you can force another value here.
	OS string
	// Arch is set to the value of runtime.GOARCH by default, but you can force another value here.
	Arch string
	// Arm 32bits version. Valid values are 0 (unknown), 5, 6 or 7. Default is detected value (if available).
	Arm uint8
	// Arch name for macOS universal binary. Default to none.
	// If set, the updater will only pick the universal binary if the Arch is not found.
	UniversalArch string
	// Draft permits an upgrade to a "draft" version (default to false).
	Draft bool
	// Prerelease permits an upgrade to a "pre-release" version (default to false).
	Prerelease bool
	// To prevent automatic removal of the old binary, and allow you to test an update prior to manual removal.
	OldSavePath string
}

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

type GitHubConfig struct {
	// APIToken represents GitHub API token. If it's not empty, it will be used for authentication of GitHub API
	APIToken string
	// EnterpriseBaseURL is a base URL of GitHub API. If you want to use this library with GitHub Enterprise,
	// please set "https://{your-organization-address}/api/v3/" to this field.
	EnterpriseBaseURL string
	// EnterpriseUploadURL is a URL to upload stuffs to GitHub Enterprise instance. This is often the same as an API base URL.
	// So if this field is not set and EnterpriseBaseURL is set, EnterpriseBaseURL is also set to this field.
	EnterpriseUploadURL string
}

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

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

type Logger interface {
	// Print calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.
	Print(v ...any)
	// Printf calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.
	Printf(format string, v ...any)
}

type Options struct {
	// TargetPath defines the path to the file to update.
	// The empty string means 'the executable file of the running program'.
	TargetPath string

	// Create TargetPath replacement with this file mode. If zero, defaults to 0755.
	TargetMode os.FileMode

	// Checksum of the new binary to verify against. If nil, no checksum or signature verification is done.
	Checksum []byte

	// Public key to use for signature verification. If nil, no signature verification is done.
	PublicKey crypto.PublicKey

	// Signature to verify the updated file. If nil, no signature verification is done.
	Signature []byte

	// Pluggable signature verification algorithm. If nil, ECDSA is used.
	Verifier Verifier

	// Use this hash function to generate the checksum. If not set, SHA256 is used.
	Hash crypto.Hash

	// Store the old executable file at this path after a successful update.
	// The empty string means the old executable file will be removed after the update.
	OldSavePath string
}

type Release struct {
	// AssetURL is a URL to the uploaded file for the release
	AssetURL string
	// AssetSize represents the size of asset in bytes
	AssetByteSize int
	// AssetID is the ID of the asset on the source platform
	AssetID int64
	// ReleaseID is the ID of the release on the source platform
	ReleaseID int64
	// AssetName is the filename of the asset
	AssetName string
	// ValidationAssetID is the ID of additional validation asset on the source platform
	ValidationAssetID int64
	// ValidationAssetURL is the URL of additional validation asset on the source platform
	ValidationAssetURL string
	// ValidationChain is the list of validation assets being used (first record is ValidationAssetID).
	ValidationChain []struct {
		// ValidationAssetID is the ID of additional validation asset on the source platform
		ValidationAssetID int64
		// ValidationAssetURL is the filename of additional validation asset on the source platform
		ValidationAssetName string
		// ValidationAssetURL is the URL of additional validation asset on the source platform
		ValidationAssetURL string
	}
	// URL is a URL to release page for browsing
	URL string
	// ReleaseNotes is a release notes of the release
	ReleaseNotes string
	// Name represents a name of the release
	Name string
	// PublishedAt is the time when the release was published
	PublishedAt time.Time
	// OS this release is for
	OS string
	// Arch this release is for
	Arch string
	// Arm 32bits version (if any). Valid values are 0 (unknown), 5, 6 or 7
	Arm uint8
	// Prerelease is set to true for alpha, beta or release candidates
	Prerelease bool
	// contains filtered or unexported fields
}

type Repository interface {
	GetSlug() (string, string, error)
}

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

type SHAValidator struct{}

type Source interface {
	ListReleases(ctx context.Context, repository Repository) ([]SourceRelease, error)
	DownloadReleaseAsset(ctx context.Context, rel *Release, assetID int64) (io.ReadCloser, error)
}

type SourceAsset interface {
	GetID() int64
	GetName() string
	GetSize() int
	GetBrowserDownloadURL() string
}

type SourceRelease interface {
	GetID() int64
	GetTagName() string
	GetDraft() bool
	GetPrerelease() bool
	GetPublishedAt() time.Time
	GetReleaseNotes() string
	GetName() string
	GetURL() string

	GetAssets() []SourceAsset
}

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

type Validator interface {
	// Validate validates release bytes against an additional asset bytes.
	// See SHAValidator for more information.
	Validate(filename string, release, asset []byte) error
	// GetValidationAssetName returns the additional asset name containing the validation checksum.
	// The asset containing the checksum can be based on the release asset name
	// Please note if the validation file cannot be found, the DetectLatest and DetectVersion methods
	// will fail with a wrapped ErrValidationAssetNotFound error
	GetValidationAssetName(releaseFilename string) string
}

type Verifier interface {
	VerifySignature(checksum, signature []byte, h crypto.Hash, publicKey crypto.PublicKey) error
}