sheaf

type Archiver interface {
	// Archive archives a source to a writer.
	Archive(src string, w io.Writer) error
	// Unarchive unarchives a reader to a destination.
	Unarchive(r io.Reader, dest string) error
	// UnarchivePath unarchives a source to a destination.
	UnarchivePath(src string, dest string) error
}

type ArtifactsService interface {
	Index() ([]byte, error)
	Image() ImageService
}

type Bundle interface {
	Codec() Codec
	Path() string
	Config() BundleConfig
	Artifacts() ArtifactsService
	Manifests() (ManifestService, error)
	Images() (images.Set, error)
	Copy(dest string) (Bundle, error)
}

type BundleConfig interface {
	GetSchemaVersion() string
	SetSchemaVersion(string)
	GetName() string
	SetName(string)
	GetVersion() string
	SetVersion(string)
	GetUserDefinedImages() []UserDefinedImage
	SetUserDefinedImages([]UserDefinedImage)
}

type BundleConfigCodec interface {
	// Encode encodes a bundle config to a writer.
	Encode(w io.Writer, bc BundleConfig) error
	// Decode decodes a bundle config from a reader.
	Decode(r io.Reader) (BundleConfig, error)
}

type BundleConfigFactory func() BundleConfig

type BundleConfigWriter interface {
	Write(Bundle, BundleConfig) error
}

type BundleCreatorFunc func(bc BundleConfig) error

type BundleFactory func(uri string) (Bundle, error)

type BundleFactoryFunc func(rootPath string) (Bundle, error)

type BundleImage struct {
	Name      string `json:"name"`
	Digest    string `json:"digest"`
	MediaType string `json:"mediaType"`
}

type BundleImager interface {
	// CreateImage creates an image from a bundle.
	CreateImage(b Bundle) (v1.Image, error)
}

type BundleManifest struct {
	ID   string
	Data []byte
}

type BundlePacker interface {
	// Pack packs a bundle to a destination.
	Pack(b Bundle, dest string, force bool) error
}

type Codec interface {
	Decoder
	Encoder
}

type Decoder interface {
	Decode([]byte, interface{}) error
}

type Encoder interface {
	Encode(interface{}) ([]byte, error)
}

type ImageReader interface {
	// Read fetches an image given a reference.
	Read(refStr string) (v1.Image, error)
}

type ImageRelocator interface {
	Relocate(rootPath, prefix string, images []image.Name, iw ImageWriter) error
}

type ImageReplacer interface {
	// Replace replaces images in a bundle manifest with prefixed options.
	Replace(manifest BundleManifest, config BundleConfig, prefix string) ([]byte, error)
}

type ImageService interface {
	List() ([]BundleImage, error)
}

type ImageWriter interface {
	// Write writes an image to a reference location.
	Write(ref string, image v1.Image) error
	// WriteIndex writes an image index to a reference location.
	WriteIndex(ref string, imageIndex v1.ImageIndex) error
}

type ManifestGenerator interface {
	Show(w io.Writer) error
}

type ManifestService interface {
	List() ([]BundleManifest, error)
	Add(overwrite bool, manifestURIs ...string) error
}

type Option func(o *options)

type UserDefinedImage struct {
	APIVersion string `json:"apiVersion"`
	Kind       string `json:"kind"`
	JSONPath   string `json:"jsonPath"`
}

type UserDefinedImageKey struct {
	APIVersion string
	Kind       string
}

type UserDefinedImageType string