template

type DisplayOptionType string

type Filter func(value string) (string, error)

type FormField struct {
	Type                   FormFieldType  `json:"type" yaml:"type"`
	Label                  string         `json:"label" yaml:"label"`
	Placeholder            string         `json:"placeholder" yaml:"placeholder"`
	FormControlName        string         `yaml:"formControlName" json:"formControlName"`
	Hint                   string         `json:"hint" yaml:"hint"`
	Icon                   string         `json:"icon" yaml:"icon"`
	IsCheckedByDefault     bool           `json:"isCheckedByDefault" yaml:"isCheckedByDefault"`
	OptionsUrl             string         `json:"optionsUrl" yaml:"optionsUrl"`
	SelectOptions          []SelectOption `json:"selectOptions" yaml:"selectOptions"`
	Validation             string         `json:"validation" yaml:"validation"`
	ValidationErrorMessage string         `json:"validationErrorMessage" yaml:"validationErrorMessage"`
	MaxCharacters          string         `json:"maxCharacters" yaml:"maxCharacters"`
	ImageButtons           []ImageButton  `yaml:"imageButtons" json:"imageButtons"`
}

type FormFieldType string

type FormGroup struct {
	DisplayName string      `yaml:"displayName" json:"displayName"`
	FormFields  []FormField `yaml:"formFields" json:"formFields"`
	ImageGroup  bool        `yaml:"imageGroup" json:"imageGroup"`
}

type GenesisGitRepository struct {
	Domain string `yaml:"domain" json:"domain"`
	Name   string `yaml:"name" json:"name"`
}

type GenesisProject struct {
	Projects []GenesisTemplate `yaml:"projects"`
	// contains filtered or unexported fields
}

type GenesisTemplate struct {
	Name          string               `yaml:"name" json:"name"`
	Root          string               `yaml:"root" json:"root"`
	Language      Language             `yaml:"language" json:"language"`
	Runtime       Runtime              `yaml:"runtime" json:"runtime"`
	GitRepository GenesisGitRepository `yaml:"git,omitempty" json:"git,omitempty"`
	Options       []Option             `yaml:"options,omitempty" json:"options,omitempty"`
	FormGroups    []FormGroup          `yaml:"formGroups" json:"formGroups"`
	// contains filtered or unexported fields
}

type GenesisTemplateApi struct {
	DirectoryPath string
}

type GenesisVariable struct {
	RawKey        string
	RawValue      string
	ParsedKey     string
	ParsedValue   string
	ParsedFilters []string
	Filters       []Filter
}

type ImageButton struct {
	Type        DisplayOptionType `yaml:"type" json:"type"`
	Name        string            `yaml:"name" json:"name"`
	DisplayName string            `yaml:"displayName" json:"displayName"`
	Description string            `yaml:"description" json:"description"`
	IconUrl     string            `yaml:"iconUrl" json:"iconUrl"`
	ImageUrl    string            `yaml:"imageUrl" json:"imageUrl"`
}

type Language struct {
	Name    string `yaml:"name" json:"name"`
	Version string `yaml:"version" json:"version"`
}

type Option struct {
	Name      string    `yaml:"name" json:"name"`
	Default   string    `yaml:"default,omitempty" json:"default,omitempty"`
	Required  bool      `yaml:"required,omitempty" json:"required,omitempty"`
	GroupName string    `yaml:"groupName" json:"groupName"`
	FormField FormField `yaml:"formField,omitempty" json:"formField,omitempty"`
}

type Project interface {
	// GetTemplateFileName returns the name of the file to read as a template for the project.
	// This is effectively a contract that guarantees a constant value for a particular implementation of ProjectTemplate.
	GetTemplateFileName() string

	// GetClonedDirectoryPath
	GetClonedDirectoryPath() (string, error)

	// Set the directory path where this project instance has been cloned
	SetClonedDirectoryPath(directoryPath string) error
}

type ProjectTemplate interface {
	// Get the options that are required to be provided for this ProjectTemplate instance
	GetRequiredOptions() []Option

	// Set all required options in a key-value map
	SetValidatedOptions(args map[string]string) error

	// Get the validated options map
	GetValidatedOptions() (map[string]string, error)

	// Get the root directory name
	GetRoot() (string, error)

	// Get the name of the template
	GetName() string

	// Add formFields to groups
	OrganizeGroups() error
}

type ProjectTemplateApi interface {
	// GetProjectNames returns the available template names in a Genesis template project.
	// The gitRepositoryUrl tells the function where to look for a .yml file.
	// It returns a slice of strings with each Project name, and any errors encountered
	GetProjectNames() ([]string, error)

	// GetProjectFromRepo retrieves a single template project from the Git repo at the given URL,
	// and any errors encountered.
	GetProjectFromRepo(projectName string) (ProjectTemplate, error)

	// GetProjectsFromRepo retrieves a list of genesis template projects from the Git repo at the
	// given URL, and any errors encountered.
	GetProjectsFromRepo() (GenesisProject, error)

	// GenerateFromTemplate creates a new project from the provided template, using the
	// variableReplacementMap to customize the Project, as needed.
	GenerateFromTemplate(project ProjectTemplate, variableReplacementMap map[string]string) error

	// ValidateGenesisProject goes out to gitRepositoryUrl and looks for a .yml file.
	// If it exists, then the method returns true. If not, false.
	// Also returns any errors encountered.
	ValidateGenesisProject() (bool, error)

	// Cleanup deletes temporary files and folders
	Cleanup() error
}

type Runtime struct {
	Names     []string  `yaml:"names"`
	GroupName string    `yaml:"groupName" json:"groupName"`
	FormField FormField `yaml:"formField,omitempty" json:"formField,omitempty"`
}

type SelectOption struct {
	Value        string `yaml:"value" json:"value"`
	DisplayValue string `yaml:"displayValue" json:"displayValue"`
	IconUrl      string `yaml:"iconUrl" json:"iconUrl"`
}