service

type BySecurityRating []IService

type Dep struct {
	Stdin  *os.File
	Stdout *os.File
	Stderr *os.File
}

type File struct {
	// Context
	Context string

	// CatalogKey
	CatalogKey string

	// RemoteKey is the remote service key.
	RemoteKey string

	// LocalPath is the path to the local file.
	LocalPath string

	// Type describes the file type
	Type string

	// Options allow servcies to persist user preferences locally.
	Options map[string]string

	// Keys tracks which fields are stashed.
	Keys []string

	// Data contains the file contents.
	Data []byte

	// Synced is the last time the file was synced with the service.
	Synced time.Time
}

type IO struct {
	Stdin  *os.File
	Stdout *os.File
	Stderr *os.File
}

type IService interface {
	// Key uniquely identifies the service and can be entered
	// as a flag value by CLI users.
	// i.e. $ stash sync .env -s s3
	Key() string

	// ObjectKey uniquely identifies each object stashed.
	// This is called to display each files remote key
	// in the user output.
	ObjectKey(path string) string

	// Compatible determines if the list of file types are
	// supported by the service. File types are the file
	// extensions without the leading dot.
	// i.e. env,json,yml
	Compatible(types []string) bool

	// SecurityRating is a number between one and three where
	// one inicates the most secure.
	SecurityRating() int

	// PreHook is called before Sync, Download, or Purge to
	// initilize the service.
	PreHook(io IO) error

	// Sync uploads file contents to the remote service.
	Sync(file File) (File, error)

	// Download gets file contents from the remote service.
	Download(file File, format string) (File, error)

	// Purge deletes file contents from the remote service.
	Purge(file File) error
}

type Opt struct {
	Key          string
	DefaultValue string
	Description  string
	Items        []string
}

type ParameterStoreService struct {
	// contains filtered or unexported fields
}

type S3Service struct {
	// contains filtered or unexported fields
}

type SecretsManagerService struct {
	// contains filtered or unexported fields
}