compose

type App interface {
	Name() string
	Tree() *AppTree
	NodeCount() int
	Ref() *AppRef
	HasLayersMeta(arch string) bool
	GetBlobRuntimeSize(desc *ocispec.Descriptor, arch string, blockSize int64) int64
	GetComposeRoot() *TreeNode
	GetCompose(ctx context.Context, provider BlobProvider) (*composetypes.Project, error)
	CheckComposeInstallation(ctx context.Context, provider BlobProvider, installationRootDir string) (AppBundleErrs, error)
}

type AppBundleErrs map[string]string

type AppInstallCheckResult struct {
	AppName       string        `json:"app_name"`
	MissingImages []string      `json:"missing_images"`
	BundleErrors  AppBundleErrs `json:"bundle_errors"`
}

type AppInstallState string

type AppLoader interface {
	LoadAppTree(context.Context, BlobProvider, platforms.MatchComparer, string) (App, error)
}

type AppRef struct {
	Spec   reference.Spec
	Repo   string
	Name   string
	Tag    string
	Digest digest.Digest
}

type AppStartProgress func(app App, status AppStartStatus, any interface{})

type AppStartStatus string

type AppStore interface {
	BlobProvider
	AddApps(appURIs []string) error
	ListApps(ctx context.Context) ([]*AppRef, error)
	RemoveApps(ctx context.Context, apps []*AppRef, prune bool) error
	Prune(ctx context.Context) ([]string, error)
}

type AppTree TreeNode

type AppsStatus struct {
	Apps []App
	*FetchStatus
	*InstallStatus
	*RunningStatus
}

type BlobFetchProgress struct {
	BlobInfo       `json:"blob_info"`
	BytesFetched   int64         `json:"bytes_fetched"` // overall bytes read for this blob and written to the local storage;
	FetchStartTime time.Time     `json:"fetch_start_time"`
	BytesRead      int64         `json:"bytes_read"`      // total blob bytes read from network during the last fetch attempt
	ReadTime       time.Duration `json:"read_time"`       // aggregate time spent reading this blob data from the network
	ReadSpeedAvg   int64         `json:"read_speed_avg"`  // average read speed in bytes per second
	ReadSpeedCur   int64         `json:"read_speed_curr"` // current read speed in bytes per second
}

type BlobInfo struct {
	Descriptor   *ocispec.Descriptor `json:"descriptor"`
	State        BlobState           `json:"state"`
	Type         BlobType            `json:"type"`
	StoreSize    int64               `json:"store_size"`
	RuntimeSize  int64               `json:"runtime_size"`
	BytesFetched int64               `json:"bytes_fetched"`
}

type BlobProvider interface {
	content.InfoProvider
	Type() BlobProviderType
	GetReadCloser(ctx context.Context, opts ...SecureReadOptions) (io.ReadCloser, error)
}

type BlobProviderType string

type BlobState int

type BlobType string

type BlobsFetchProgress map[digest.Digest]*BlobFetchProgress

type BlobsInfo map[digest.Digest]*BlobInfo

type CheckAppsStatusOption func(*CheckAppsStatusOptions)

type CheckAppsStatusOptions struct {
	CheckInstallation   bool
	CheckRunning        bool
	QuickCheckFetch     bool
	AppTreeBlobProvider BlobProvider
}

type Config struct {
	StoreRoot           string
	ComposeRoot         string
	DockerCfg           *configfile.ConfigFile
	DockerHost          string
	Platform            specs.Platform
	ConnectTimeout      time.Duration
	ReadTimeout         time.Duration
	AppLoader           AppLoader
	AppStoreFactoryFunc func(c *Config) (AppStore, error)
	BlockSize           int64
	DBFilePath          string
	Proxy               ProxyProvider
}

type ErrBlobDigestMismatch struct {
	Expected   digest.Digest
	Calculated digest.Digest
}

type ErrBlobSizeLimitExceed struct {
	Limit int64
}

type ErrBlobSizeMismatch struct {
	Expected int64
	Read     int64
}

type ErrComposeInstall struct {
	Errs AppBundleErrs
}

type ErrImageInstall struct {
	MissingImages []string
}

type FetchOption func(*FetchOptions)

type FetchOptions struct {
	ProgressHandler      FetchProgressFunc
	ProgressPollInterval int    // interval between polling/checking blob download status in milliseconds
	SourcePath           string // path to the source directory containing blobs to fetch, if specified, the blobs will be fetched from this directory instead of remote registry
}

type FetchProgress struct {
	Blobs        BlobsFetchProgress // per-blob metadata and progress
	FetchedCount int                // number of fully fetched blobs
	CurrentBytes int64              // total bytes downloaded so far
	TotalBytes   int64              // total bytes expected to download
}

type FetchProgressFunc func(*FetchProgress)

type FetchReport struct {
	BlobsStatus BlobsInfo
}

type FetchStatus struct {
	BlobsStatus  map[digest.Digest]FetchReport
	MissingBlobs BlobsInfo
}

type ImageLoadState string

type ImageRef struct {
	reference.Spec
	Digest digest.Digest
}

type ImageRoot struct {
	specs.Versioned
	MediaType string          `json:"mediaType,omitempty"`
	Config    json.RawMessage `json:"config,omitempty"`
	Layers    json.RawMessage `json:"layers,omitempty"`
	Manifests json.RawMessage `json:"manifests,omitempty"`
	FSLayers  json.RawMessage `json:"fsLayers,omitempty"` // schema 1

	Type     BlobType
	Children []TreeNode
}

type ImageTree TreeNode

type InstallCheckResult map[string]*AppInstallCheckResult

type InstallOption func(*InstallOptions)

type InstallOptions struct {
	ProgressReporter progress.Reporter[InstallProgress]
	LoadedImages     map[string]struct{}
}

type InstallProgress struct {
	AppInstallState AppInstallState
	AppID           string
	ImageLoadState  ImageLoadState
	ImageID         string
	ID              string
	Current         int64
	Total           int64
}

type InstallProgressFunc func(*InstallProgress)

type InstallReport struct {
	Images       map[digest.Digest]bool
	BundleErrors AppBundleErrs
}

type InstallStatus struct {
	AppsInstallStatus   map[digest.Digest]*InstallReport
	NotInstalledImages  map[string]interface{}
	NotInstalledCompose map[digest.Digest]interface{}
}

type InstalledImagesInfo struct {
	// Image ID to image summary map (Image ID is the docker's internal ID for the image,
	// not the digest URI of the image).
	InstalledImages map[string]image.Summary
	// Image refs (both digest and tag) to image ID map.
	// The same image can have multiple references.
	InstalledImageRefs map[string]string
}

type LoadImageOption func(*LoadImageOptions)

type LoadImageOptions struct {
	ReadBlobsFromStore bool
	RefWithDigest      bool
	ProgressReporter   progress.Reporter[LoadImageProgress]
	ProgressCallback   ProgressCallbackFn
}

type LoadImageProgress struct {
	State   ImageLoadState
	ImageID string
	ID      string
	Current int64
	Total   int64
}

type NodeProcessor func(node *TreeNode, depth int) error

type ProgressCallbackFn func(*LoadImageProgress)

type ProxyConfig struct {
	ProxyURL   *url.URL
	ProxyCerts *x509.CertPool
}

type ProxyProvider func() *ProxyConfig

type RemoveOpt func(*RemoveOpts)

type RemoveOpts struct {
	Prune       bool
	CheckStatus bool
}

type RunningReport struct {
	Services []*Service
	Health   string
}

type RunningStatus struct {
	AppsRunningStatus map[digest.Digest]RunningReport
	NotRunningApps    map[digest.Digest]interface{}
}

type SecureReadOptions func(opts *SecureReadParams)

type SecureReadParams struct {
	Ref               string
	ExpectedDigest    digest.Digest
	ExpectedSize      int64
	ReadLimit         int64
	Descriptor        ocispec.Descriptor
	DisableSecureRead bool
}

type Service struct {
	Name   string `json:"name"`
	Image  string `json:"image"`
	Hash   string `json:"hash"`
	CtrID  string `json:"ctr-id"`
	State  string `json:"state"`
	Status string `json:"status"`
	Health string `json:"health,omitempty"`
}

type Services []*Service

type StartOption func(*StartOptions)

type StartOptions struct {
	Verbose         bool
	ProgressHandler AppStartProgress
}

type StatFS struct {
	BlockSize int64
	Blocks    uint64
	Bfree     uint64
}

type TreeNode struct {
	Descriptor *ocispec.Descriptor
	Type       BlobType
	Children   []*TreeNode
}

type UninstallOpt func(*UninstallOpts)

type UninstallOpts struct {
	Prune bool
}

type UsageInfo struct {
	Path       string  `json:"path"`
	SizeB      uint64  `json:"size_b"`
	Free       uint64  `json:"free"`
	FreeP      float32 `json:"free_p"`
	Reserved   uint64  `json:"reserved"`
	ReservedP  float32 `json:"reserved_p"`
	Available  uint64  `json:"available"`
	AvailableP float32 `json:"available_p"`
	Required   uint64  `json:"required"`
	RequiredP  float32 `json:"required_p"`
}