ociclient

type AllowPlainHttp bool

type Client interface {
	Resolver

	// Fetch fetches the blob for the given ocispec Descriptor.
	Fetch(ctx context.Context, ref string, desc ocispecv1.Descriptor, writer io.Writer) error

	// PushBlob uploads the blob for the given ocispec Descriptor to the given ref
	PushBlob(ctx context.Context, ref string, desc ocispecv1.Descriptor, opts ...PushOption) error

	// GetRawManifest returns the raw manifest for a reference.
	// The returned manifest can either be single arch or multi arch (image index/manifest list)
	GetRawManifest(ctx context.Context, ref string) (ocispecv1.Descriptor, []byte, error)

	// PushRawManifest uploads the given raw manifest to the given reference.
	// If the manifest is multi arch (image index/manifest list), only the multi arch manifest is pushed.
	// The referenced single arch manifests must be pushed individiually before.
	PushRawManifest(ctx context.Context, ref string, desc ocispecv1.Descriptor, rawManifest []byte, opts ...PushOption) error

	// GetManifest returns the ocispec Manifest for a reference
	// Deprecated: Please prefer GetRawManifest instead
	GetManifest(ctx context.Context, ref string) (*ocispecv1.Manifest, error)

	// PushManifest uploads the given Manifest to the given reference.
	// Deprecated: Please prefer PushRawManifest instead
	PushManifest(ctx context.Context, ref string, manifest *ocispecv1.Manifest, opts ...PushOption) error

	// GetOCIArtifact returns an OCIArtifact for a reference.
	// Deprecated: Please prefer GetRawManifest instead
	GetOCIArtifact(ctx context.Context, ref string) (*oci.Artifact, error)

	// PushOCIArtifact uploads the given OCIArtifact to the given ref.
	// Deprecated: Please prefer PushRawManifest instead
	PushOCIArtifact(ctx context.Context, ref string, artifact *oci.Artifact, opts ...PushOption) error
}

type ExtendedClient interface {
	Client
	// ListTags returns a list of all tags of the given ref.
	ListTags(ctx context.Context, ref string) ([]string, error)
	// ListRepositories lists all repositories for the given registry host.
	ListRepositories(ctx context.Context, registryHost string) ([]string, error)
}

type FSLayer struct {
	BlobSum digest.Digest `json:"blobSum"`
}

type GenericStore func(ctx context.Context, desc ocispecv1.Descriptor, writer io.Writer) error

type History struct {
	V1Compatibility string `json:"v1Compatibility"`
}

type Option interface {
	ApplyOption(options *Options)
}

type Options struct {
	// Paths configures local paths to search for docker configuration files
	Paths []string

	// AllowPlainHttp allows the fallback to http if https is not supported by the registry.
	AllowPlainHttp bool

	// Keyring sets the used keyring.
	// A default keyring will be created if not given.
	Keyring credentials.OCIKeyring

	// CacheConfig contains the cache configuration.
	// Tis configuration will automatically create a new cache based on that configuration.
	// This cache can be overwritten with the Cache property.
	CacheConfig *cache.Options

	// Cache is the oci cache to be used by the client
	Cache cache.Cache

	// CustomMediaTypes defines the custom known media types
	CustomMediaTypes sets.String //nolint:all

	HTTPClient *http.Client
}

type PushOption interface {
	ApplyPushOption(options *PushOptions)
}

type PushOptions struct {
	// Store is the oci cache to be used by the client
	Store Store
}

type Resolver interface {
	// Resolve attempts to resolve the reference into a name and descriptor.
	//
	// The argument `ref` should be a scheme-less URI representing the remote.
	// Structurally, it has a host and path. The "host" can be used to directly
	// reference a specific host or be matched against a specific handler.
	//
	// The returned name should be used to identify the referenced entity.
	// Depending on the remote namespace, this may be immutable or mutable.
	// While the name may differ from ref, it should itself be a valid ref.
	//
	// If the resolution fails, an error will be returned.
	Resolve(ctx context.Context, ref string) (name string, desc ocispecv1.Descriptor, err error)
}

type Store interface {
	Get(desc ocispecv1.Descriptor) (io.ReadCloser, error)
}

type V1History struct {
	Author          string    `json:"author,omitempty"`
	Created         time.Time `json:"created"`
	Comment         string    `json:"comment,omitempty"`
	ThrowAway       *bool     `json:"throwaway,omitempty"`
	Size            *int      `json:"Size,omitempty"`
	ContainerConfig struct {
		Cmd []string `json:"Cmd,omitempty"`
	} `json:"container_config,omitempty"`
}

type V1Manifest struct {
	FSLayers []FSLayer `json:"fsLayers"`
	History  []History `json:"history"`
}

type WithCacheOption struct {
	cache.Cache
}

type WithHTTPClient http.Client

type WithKeyringOption struct {
	credentials.OCIKeyring
}

type WithKnownMediaType string

type WithStoreOption struct {
	Store
}