validation

type ChangeDescriber interface {
	DescribeChange() (before, after string)
}

type CoreModeler interface {
	GetRootNode() *yaml.Node
}

type Error struct {
	UnderlyingError error
	Node            *yaml.Node
	Severity        Severity
	Rule            string
	Fix             Fix
	// DocumentLocation is the absolute location (URL or file path) of the document
	// where the error originated. Empty means the main document.
	DocumentLocation string
}

type Fix interface {
	// Description returns a human-readable description of what the fix does.
	Description() string

	// Interactive returns true if the fix requires user input before being applied.
	// Non-interactive fixes can be applied directly with Apply().
	// Interactive fixes must have SetInput() called with user responses before Apply().
	Interactive() bool

	// Prompts returns the input prompts needed for this fix.
	// Returns nil for non-interactive fixes.
	Prompts() []Prompt

	// SetInput provides user responses for interactive fixes.
	// The responses slice must correspond 1:1 with the Prompts() slice.
	// Returns an error if the input is invalid.
	// Calling this on a non-interactive fix is a no-op.
	SetInput(responses []string) error

	// Apply applies the fix to the document.
	// For interactive fixes, SetInput() must be called first.
	// The doc parameter is typically *openapi.OpenAPI.
	// Returns an error if the fix cannot be applied.
	Apply(doc any) error
}

type MapKeyNodeGetter interface {
	GetMapKeyNodeOrRoot(key string, root *yaml.Node) *yaml.Node
}

type MapValueNodeGetter interface {
	GetMapValueNodeOrRoot(key string, root *yaml.Node) *yaml.Node
}

type NodeFix interface {
	Fix

	// ApplyNode applies the fix directly to the YAML node tree.
	// rootNode is the document root node.
	ApplyNode(rootNode *yaml.Node) error
}

type Option func(o *Options)

type Options struct {
	ContextObjects map[reflect.Type]any
}

type Prompt struct {
	// Type is the kind of input needed.
	Type PromptType
	// Message is a human-readable description of what input is needed and why.
	Message string
	// Choices is the list of valid choices when Type is PromptChoice.
	// Ignored for other prompt types.
	Choices []string
	// Default is an optional default value.
	Default string
}

type PromptType int

type Prompter interface {
	// PromptFix presents a fix to the user and collects input for its prompts.
	// finding provides the error being fixed so the prompter can display context.
	// fix is the fix that needs input.
	// Returns the user's responses corresponding to fix.Prompts(), or an error.
	// Return ErrSkipFix (or wrap it) to indicate the user chose to skip this fix.
	PromptFix(finding *Error, fix Fix) ([]string, error)

	// Confirm asks the user a yes/no question.
	Confirm(message string) (bool, error)
}

type RuleInfo struct {
	Summary     string
	Description string
	HowToFix    string
}

type Severity string

type SliceNodeGetter interface {
	GetSliceValueNodeOrRoot(index int, root *yaml.Node) *yaml.Node
}

type TypeMismatchError struct {
	Msg        string
	ParentName string
}

type ValueNodeGetter interface {
	GetValueNodeOrRoot(root *yaml.Node) *yaml.Node
}