ocicache

type Info struct {
	// Dir is the resolved cache directory. Empty when caching is
	// disabled for this process.
	Dir string `json:"dir"`
	// Disabled reports whether the cache is bypassed for this invocation.
	Disabled bool `json:"disabled"`
	// Exists reports whether Dir exists on disk.
	Exists bool `json:"exists"`
	// TotalBytes is the summed size of all files under Dir.
	TotalBytes int64 `json:"total_bytes"`
	// Layers lists per-subdirectory statistics for the four klaus-oci
	// index layers (catalog, tags, refs, blobs).
	Layers []LayerInfo `json:"layers"`
	// NewestEntry is the modification time of the most recently written
	// cache entry, or zero when the cache is empty.
	NewestEntry time.Time `json:"newest_entry"`
	// FreshTTL is the window within which entries are served with zero
	// network traffic.
	FreshTTL time.Duration `json:"fresh_ttl"`
	// StaleTTL is the outer bound for ref/tag entries.
	StaleTTL time.Duration `json:"stale_ttl"`
	// CatalogStaleTTL is the outer bound for catalog entries.
	CatalogStaleTTL time.Duration `json:"catalog_stale_ttl"`
}

type LayerInfo struct {
	Name    string `json:"name"`
	Entries int    `json:"entries"`
	Bytes   int64  `json:"bytes"`
}

type PruneOptions struct {
	// All removes everything under the cache directory, including fresh
	// entries. When false, only entries that the klaus-oci cache would
	// treat as stale (older than the relevant stale TTL) are removed.
	All bool
	// Now is the reference time used to evaluate entry freshness.
	// Defaults to time.Now().
	Now time.Time
}

type PruneResult struct {
	// Dir is the cache directory that was pruned.
	Dir string `json:"dir"`
	// FilesRemoved is the number of files deleted.
	FilesRemoved int `json:"files_removed"`
	// BytesRemoved is the summed size of deleted files.
	BytesRemoved int64 `json:"bytes_removed"`
	// Removed is the cache-relative path of each deleted file. Populated
	// only for --all prunes so large stale sweeps do not produce unwieldy
	// output.
	Removed []string `json:"removed,omitempty"`
}

type RefreshOptions struct {
	// Registry is an optional registry base ("host" or "host/prefix"). When
	// non-empty, only catalog entries for this base are invalidated.
	Registry string
	// Repo is an optional repository ("host/name"). When non-empty, only
	// tag and ref entries for this repository are invalidated.
	Repo string
}

type RefreshResult struct {
	// Dir is the cache directory that was refreshed.
	Dir string `json:"dir"`
	// FilesRemoved is the count of index files invalidated.
	FilesRemoved int `json:"files_removed"`
	// Scope describes what was refreshed (all, registry, repo, ...).
	Scope string `json:"scope"`
}