plugin

type Answer struct {
	Question Question
	Value    string
}

type Answers []Answer

type Asset struct {
	Name  string
	Value string
}

type Assets []Asset

type CommandLineMod interface {
	// GetQuestions list down all the cli inputs required to generate spec files
	// name used for question will be directly mapped to DefaultConfig() parameters
	GetQuestions(context.Context, GetQuestionsRequest) (*GetQuestionsResponse, error)
	ValidateQuestion(context.Context, ValidateQuestionRequest) (*ValidateQuestionResponse, error)

	// DefaultConfig will be passed down to execution unit as env vars
	// they will be generated based on results of AskQuestions
	// if DryRun is true in PluginOptions, should not throw error for missing inputs
	DefaultConfig(context.Context, DefaultConfigRequest) (*DefaultConfigResponse, error)

	// DefaultAssets will be passed down to execution unit as files
	// if DryRun is true in PluginOptions, should not throw error for missing inputs
	DefaultAssets(context.Context, DefaultAssetsRequest) (*DefaultAssetsResponse, error)
}

type Config struct {
	Name  string
	Value string
}

type Configs []Config

type DefaultAssetsRequest struct {
	Options

	Answers Answers
}

type DefaultAssetsResponse struct {
	Assets Assets `yaml:"defaultassets,omitempty"`
}

type DefaultConfigRequest struct {
	Options

	Answers Answers
}

type DefaultConfigResponse struct {
	Config Configs `yaml:"defaultconfig,omitempty"`
}

type Entrypoint struct {
	Shell  string
	Script string
}

type Evaluator struct {
	FilePath string `yaml:"filepath"`
	Selector string `yaml:"selector,omitempty"`
}

type GetQuestionsRequest struct {
	Options

	JobName string
}

type GetQuestionsResponse struct {
	Questions Questions `yaml:",omitempty"`
}

type HookType string

type Info struct {
	// Name should as simple as possible with no special characters
	// should start with a character, better if all lowercase
	Name        string
	Description string
	PluginType  Type  `yaml:",omitempty"`
	PluginMods  []Mod `yaml:",omitempty"`

	AssetParsers           map[ParserType][]Evaluator `yaml:"asset_parsers,omitempty"`
	DestinationURNTemplate string                     `yaml:"destination_urn_template,omitempty"`

	PluginVersion string   `yaml:",omitempty"`
	APIVersion    []string `yaml:",omitempty"`

	// Image is the full path to docker container that will be scheduled for execution
	Image string

	// Entrypoint command which will be used to execute the plugin
	Entrypoint Entrypoint

	// DependsOn returns list of hooks this should be executed after
	DependsOn []string `yaml:",omitempty"`

	// PluginType provides the place of execution, could be before the transformation
	// after the transformation, etc
	HookType HookType `yaml:",omitempty"`
}

type Mod string

type Options struct {
	DryRun bool
}

type ParserType string

type Plugin struct {
	// Mods apply multiple modifications to existing registered plugins which
	// can be used in different circumstances
	YamlMod YamlMod
}

type Question struct {
	Name        string   `yaml:",omitempty"`
	Prompt      string   `yaml:",omitempty"`
	Help        string   `yaml:",omitempty"`
	Default     string   `yaml:",omitempty"`
	Multiselect []string `yaml:",omitempty"`

	SubQuestions []SubQuestion `yaml:",omitempty"`

	Regexp          string `yaml:",omitempty"`
	ValidationError string `yaml:",omitempty"`
	MinLength       int    `yaml:",omitempty"`
	MaxLength       int    `yaml:",omitempty"`
	Required        bool   `yaml:",omitempty"`
}

type Questions []Question

type SubQuestion struct {
	// IfValue is used as an if condition to match with user input
	// if user value matches this only then ask sub questions
	IfValue   string
	Questions Questions
}

type Type string

type ValidateQuestionRequest struct {
	Options

	Answer Answer
}

type ValidateQuestionResponse struct {
	Success bool
	Error   string
}

type YamlMod interface {
	PluginInfo() *Info
	CommandLineMod
}