errorhandler

type EnvironmentResolver interface {
	Getenv(key string) string
}

type ErrorHandler interface {
	// Handle inspects the error and returns a suggestion if applicable.
	// The rule parameter provides access to the matching YAML rule,
	// allowing the handler to merge in links or other static data.
	// Returns nil if this handler cannot produce a suggestion.
	Handle(ctx context.Context, err error, rule ErrorSuggestionRule) *ErrorWithSuggestion
}

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

type ErrorLink struct {
	// URL is the link target (required)
	URL string
	// Title is the display text (optional — if empty, the URL is shown)
	Title string
}

type ErrorSuggestionRule struct {
	// Patterns is a list of strings to match against error messages.
	// By default, strings are matched as case-insensitive substrings.
	// Set Regex to true to treat all patterns and property values
	// as regular expressions.
	Patterns []string `yaml:"patterns,omitempty"`

	// ErrorType is the Go struct type name to match via reflection.
	// The error chain is walked using errors.As semantics.
	// Example: "AzureDeploymentError", "ResponseError"
	ErrorType string `yaml:"errorType,omitempty"`

	// Properties is a map of dot-path property names to expected values.
	// Properties are resolved via reflection on the matched error type.
	// By default, values are matched as case-insensitive substrings.
	// Set Regex to true to treat values as regular expressions.
	Properties map[string]string `yaml:"properties,omitempty"`

	// Regex enables regular expression matching for all patterns
	// and property values in this rule.
	Regex bool `yaml:"regex,omitempty"`

	// Handler is the name of a registered ErrorHandler to invoke.
	// When set, the handler computes the suggestion dynamically
	// instead of using the static message/suggestion/links fields.
	Handler string `yaml:"handler,omitempty"`

	// Message is a user-friendly error message.
	Message string `yaml:"message,omitempty"`

	// Suggestion is the actionable next steps for the user.
	Suggestion string `yaml:"suggestion,omitempty"`

	// Links is a list of reference links (each with a URL and
	// optional title).
	Links []RuleLink `yaml:"links,omitempty"`
}

type ErrorSuggestionsConfig struct {
	// Rules is the ordered list of error suggestion rules.
	// Rules are evaluated in order; the first match wins.
	Rules []ErrorSuggestionRule `yaml:"rules"`
}

type ErrorWithSuggestion struct {
	// Err is the original underlying error
	Err error
	// Message is a user-friendly explanation of what went wrong
	Message string
	// Suggestion is actionable next steps to resolve the issue
	Suggestion string
	// Links is an optional list of reference links
	Links []ErrorLink
}

type HandlerResolver func(name string) (ErrorHandler, error)

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

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

type ResourceTypeLocationResolver interface {
	GetLocations(
		ctx context.Context,
		subscriptionID string,
		resourceType string,
	) ([]string, error)
}

type RuleLink struct {
	// URL is the link target (required)
	URL string `yaml:"url"`
	// Title is the display text (optional)
	Title string `yaml:"title,omitempty"`
}