errors

type ActionType string

type ErrorCategory string

type ErrorContext struct {
	// Category helps clients group and handle errors
	Category ErrorCategory `json:"category,omitempty"`
	// Reason code from the parent error for programmatic identification
	ReasonCode ErrorReasonCode `json:"reasonCode,omitempty"`
	// Suggested actions the user can take
	SuggestedActions []SuggestedAction `json:"suggestedActions,omitempty"`
	// Additional metadata for context
	Metadata map[string]any `json:"metadata,omitempty"`
}

type ErrorReasonCode string

type ExpandedSerialiseError struct {
	ReasonCode  ErrorReasonCode
	Err         error
	ChildErrors []error
}

type LoadError struct {
	ReasonCode  ErrorReasonCode
	Err         error
	ChildErrors []error
	Line        *int
	Column      *int
	Context     *ErrorContext `json:"context,omitempty"`
}

type RunError struct {
	ReasonCode  ErrorReasonCode
	Err         error
	ChildErrors []error
	// ChildBlueprintPath is the path to the child blueprint that caused the error.
	// This should be in the following format:
	// "include.<childName>::include.<grandChildName>::..."
	// Rendered as "include.<childName> -> include.<grandChildName> -> ..."
	//
	// This is useful for distinguishing between errors that occur in the parent blueprint
	// and errors that occur in a child blueprint.
	ChildBlueprintPath string
	Context            *ErrorContext `json:"context,omitempty"`
}

type SerialiseError struct {
	ReasonCode  ErrorReasonCode
	Err         error
	ChildErrors []error
	Context     *ErrorContext `json:"context,omitempty"`
}

type SuggestedAction struct {
	Type        string `json:"type"`                  // Programmatically stable identifier
	Title       string `json:"title"`                 // Human-readable title
	Description string `json:"description,omitempty"` // Human-readable description
	Priority    int    `json:"priority,omitempty"`    // 1=highest, 5=lowest
}