// Package init provides methods to initiate an odo project.
// Most of the methods of the package get a `flags` parameter
// representing the flags passed from the user through the command line.
// Several backends are available to complete the operations, the backend
// being chosen depending on the flags content:
// - if no flags are passed, the `interactive` backend will be used
// - if some flags are passed, the `flags` backend will be used.
package init

import (
	"github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
	"github.com/devfile/library/pkg/devfile/parser"

	"github.com/redhat-developer/odo/pkg/init/backend"
	"github.com/redhat-developer/odo/pkg/testingutil/filesystem"
)

type Client interface {
	// Validate checks for each backend if flags are valid
	Validate(flags map[string]string, fs filesystem.Filesystem, dir string) error

	// SelectDevfile returns information about a devfile selected based on Alizer if the directory content,
	// or based on the flags if the directory is empty, or
	// interactively if flags is empty
	SelectDevfile(flags map[string]string, fs filesystem.Filesystem, dir string) (*backend.DevfileLocation, error)

	// DownloadDevfile downloads a devfile given its location information and a destination directory
	// and returns the path of the downloaded file
	DownloadDevfile(devfileLocation *backend.DevfileLocation, destDir string) (string, error)

	// SelectStarterProject selects a starter project from the devfile and returns information about the starter project,
	// depending on the flags. If not starter project is selected, a nil starter is returned
	SelectStarterProject(devfile parser.DevfileObj, flags map[string]string, fs filesystem.Filesystem, dir string) (*v1alpha2.StarterProject, error)

	// DownloadStarterProject downloads the starter project referenced in devfile and stores it in dest directory
	// WARNING: This will first remove all the content of dest.
	DownloadStarterProject(project *v1alpha2.StarterProject, dest string) error

	// PersonalizeName updates a devfile name, depending on the flags.
	// The method will modify the devfile content and save the devfile on disk
	PersonalizeName(devfile parser.DevfileObj, flags map[string]string) error
}