repository

type Credential interface {
	Valid() bool
	ToAuthMethod() transport.AuthMethod
	ToString() string
}

type CredentialResolver interface {
	ResolveCredential(ctx context.Context, namespace, name string) (Credential, error)
}

type DefaultPackageUpdater struct{}

type ListPackageFilter struct {
	Key PackageKey
}

type ListPackageRevisionFilter struct {
	Key PackageRevisionKey

	// Lifecycle matches the spec.lifecycle of the package
	Lifecycles []porchapi.PackageRevisionLifecycle

	// KptfileLabels matches labels specified in the Kptfile
	KptfileLabels map[string]string

	Label labels.Selector
}

type Object interface {
	metav1.Object
	runtime.Object
}

type Package interface {
	KubeObjectNamespace() string
	KubeObjectName() string
	Key() PackageKey

	// GetPackage returns the object representing this package
	GetPackage(ctx context.Context) *porchapi.PorchPackage

	// GetLatestRevision returns the name of the package revision that is the "latest" package
	// revision belonging to this package
	GetLatestRevision(ctx context.Context) int
}

type PackageFetcher struct {
	RepoOpener        RepositoryOpener
	ReferenceResolver ReferenceResolver
}

type PackageKey struct {
	RepoKey       RepositoryKey
	Path, Package string
}

type PackageResources struct {
	Contents map[string]string
}

type PackageRevision interface {
	KubeObjectNamespace() string
	KubeObjectName() string
	Key() PackageRevisionKey

	// UID returns a unique identifier for the PackageRevision.
	UID() types.UID

	// Lifecycle returns the current lifecycle state of the package.
	Lifecycle(ctx context.Context) porchapi.PackageRevisionLifecycle

	// UpdateLifecycle updates the desired lifecycle of the package. This can only
	// be used for Published package revisions to go from Published to DeletionProposed
	// or vice versa. Draft revisions should use PackageDraft.UpdateLifecycle.
	UpdateLifecycle(ctx context.Context, lifecycle porchapi.PackageRevisionLifecycle) error

	// GetPackageRevision returns the PackageRevision ("DRY") API representation of this package-revision
	GetPackageRevision(ctx context.Context) (*porchapi.PackageRevision, error)

	// GetResources returns the PackageRevisionResources ("WET") API representation of this package-revision
	// TODO: return PackageResources or filesystem abstraction?
	GetResources(ctx context.Context) (*porchapi.PackageRevisionResources, error)

	// GetUpstreamLock returns the kpt lock information.
	GetUpstreamLock(ctx context.Context) (kptfilev1.Upstream, kptfilev1.Locator, error)

	// GetKptfile returns the Kptfile for the package
	GetKptfile(ctx context.Context) (kptfilev1.KptFile, error)

	// GetLock returns the current revision's lock information.
	// This will be the upstream info for downstream revisions.
	GetLock(ctx context.Context) (kptfilev1.Upstream, kptfilev1.Locator, error)

	// ResourceVersion returns the Kube resource version of the package
	ResourceVersion() string

	// Create the main package revision
	// TODO: This is a git thing and probably shouldn't be on the generic PackageRevision interface
	ToMainPackageRevision(ctx context.Context) PackageRevision

	// Get the Kubernetes metadata for the package revision
	GetMeta() metav1.ObjectMeta

	// Set the Kubernetes metadata for the package revision
	SetMeta(ctx context.Context, meta metav1.ObjectMeta) error
}

type PackageRevisionDraft interface {
	Key() PackageRevisionKey
	GetMeta() metav1.ObjectMeta
	UpdateResources(context.Context, *porchapi.PackageRevisionResources, *porchapi.Task) error
	// Updates desired lifecycle of the package. The lifecycle is applied on Close.
	UpdateLifecycle(context.Context, porchapi.PackageRevisionLifecycle) error
}

type PackageRevisionKey struct {
	PkgKey        PackageKey
	Revision      int
	WorkspaceName string
}

type ReferenceResolver interface {
	ResolveReference(ctx context.Context, namespace, name string, result Object) error
}

type Repository interface {
	KubeObjectNamespace() string
	KubeObjectName() string
	Key() RepositoryKey

	// ListPackageRevisions lists the existing package revisions in the repository
	ListPackageRevisions(ctx context.Context, filter ListPackageRevisionFilter) ([]PackageRevision, error)

	// CreatePackageRevision creates a new package revision
	CreatePackageRevisionDraft(ctx context.Context, obj *porchapi.PackageRevision) (PackageRevisionDraft, error)

	// ClosePackageRevisionDraft closes out a Package Revision Draft
	ClosePackageRevisionDraft(ctx context.Context, prd PackageRevisionDraft, version int) (PackageRevision, error)

	// DeletePackageRevision deletes a package revision
	DeletePackageRevision(ctx context.Context, old PackageRevision) error

	// UpdatePackageRevision updates a package
	UpdatePackageRevision(ctx context.Context, old PackageRevision) (PackageRevisionDraft, error)

	// ListPackages lists all packages in the repository
	ListPackages(ctx context.Context, filter ListPackageFilter) ([]Package, error)

	// Version returns a string that is guaranteed to be different if any change has been made to the repo contents
	Version(ctx context.Context) (string, error)

	// Close cleans up any resources associated with the repository
	Close(ctx context.Context) error

	// Refresh the repository
	Refresh(ctx context.Context) error
}

type RepositoryKey struct {
	Namespace, Name, Path, PlaceholderWSname string
}

type RepositoryOpener interface {
	OpenRepository(ctx context.Context, repositorySpec *configapi.Repository) (Repository, error)
}

type UserInfo struct {
	Name  string
	Email string
}

type UserInfoProvider interface {
	// GetUserInfo returns the information about the user on whose behalf the request is being
	// processed, if any. If user cannot be determnined, returns nil.
	GetUserInfo(ctx context.Context) *UserInfo
}