types

type CheckResult struct {
	// OldPath is the path to the old configuration
	OldPath string `json:"old_path"`

	// NewPath is the path to the new configuration
	NewPath string `json:"new_path"`

	// Findings is the list of all findings
	Findings []*Finding `json:"findings"`

	// Summary contains counts by severity
	Summary Summary `json:"summary"`

	// Result is PASS or FAIL based on the policy
	Result string `json:"result"`

	// FailOn is the severity threshold used for the result
	FailOn Severity `json:"fail_on"`
}

type FileRange struct {
	Filename  string `json:"filename"`
	Line      int    `json:"line"`
	Column    int    `json:"column,omitempty"`
	EndLine   int    `json:"end_line,omitempty"`
	EndColumn int    `json:"end_column,omitempty"`
}

type Finding struct {
	// RuleID is the unique identifier for the rule (e.g., "BC001")
	RuleID string `json:"rule_id"`

	// RuleName is the human-readable rule name (e.g., "required-input-added")
	RuleName string `json:"rule_name"`

	// Severity is the severity level of this finding
	Severity Severity `json:"severity"`

	// Message is a short description of the finding
	Message string `json:"message"`

	// Detail provides additional context about the finding
	Detail string `json:"detail,omitempty"`

	// OldLocation is the source location in the old config (nil if not applicable)
	OldLocation *FileRange `json:"old_location,omitempty"`

	// NewLocation is the source location in the new config (nil if not applicable)
	NewLocation *FileRange `json:"new_location,omitempty"`

	// Ignored indicates if this finding was suppressed by an annotation
	Ignored bool `json:"ignored"`

	// IgnoreReason is the reason provided in the ignore annotation
	IgnoreReason string `json:"ignore_reason,omitempty"`

	// Metadata contains rule-specific metadata for advanced processing
	// Used by rename detection rules to store old/new names for suppression logic
	Metadata map[string]string `json:"metadata,omitempty"`

	// Remediation provides guidance on how to fix this issue
	// Only populated when --include-remediation flag is set
	Remediation string `json:"remediation,omitempty"`
}

type ModuleCallSignature struct {
	// Name is the module call name
	Name string `json:"name"`

	// Source is the module source
	Source string `json:"source"`

	// Version is the module version constraint
	Version string `json:"version,omitempty"`

	// Address is the full module address (e.g., "module.vpc")
	Address string `json:"address"`

	// DeclRange is the source location of the declaration
	DeclRange FileRange `json:"pos"`
}

type ModuleSnapshot struct {
	// Path is the directory path of the module
	Path string `json:"path"`

	// Variables maps variable names to their signatures
	Variables map[string]*VariableSignature `json:"variables"`

	// Outputs maps output names to their signatures
	Outputs map[string]*OutputSignature `json:"outputs"`

	// Resources maps resource addresses (type.name) to their signatures
	Resources map[string]*ResourceSignature `json:"resources"`

	// Modules maps module call names to their signatures
	Modules map[string]*ModuleCallSignature `json:"modules"`

	// MovedBlocks contains all moved block declarations
	MovedBlocks []*MovedBlock `json:"moved_blocks"`

	// RequiredVersion is the terraform.required_version constraint
	RequiredVersion string `json:"required_version,omitempty"`

	// RequiredProviders maps provider names to their requirements
	RequiredProviders map[string]*ProviderRequirement `json:"required_providers,omitempty"`
}

type MovedBlock struct {
	// From is the source address
	From string `json:"from"`

	// To is the destination address
	To string `json:"to"`

	// DeclRange is the source location of the declaration
	DeclRange FileRange `json:"pos"`
}

type OutputSignature struct {
	// Name is the output name
	Name string `json:"name"`

	// Description is the output description
	Description string `json:"description,omitempty"`

	// Sensitive indicates if the output is marked sensitive
	Sensitive bool `json:"sensitive,omitempty"`

	// DeclRange is the source location of the declaration
	DeclRange FileRange `json:"pos"`
}

type ProviderRequirement struct {
	// Source is the provider source (e.g., "hashicorp/aws")
	Source string `json:"source,omitempty"`

	// Version is the version constraint
	Version string `json:"version,omitempty"`
}

type ResourceSignature struct {
	// Type is the resource type (e.g., "aws_s3_bucket")
	Type string `json:"type"`

	// Name is the resource name (e.g., "main")
	Name string `json:"name"`

	// Address is the full resource address (e.g., "aws_s3_bucket.main")
	Address string `json:"address"`

	// DeclRange is the source location of the declaration
	DeclRange FileRange `json:"pos"`
}

type Severity int

type Summary struct {
	Error   int `json:"error"`
	Warning int `json:"warning"`
	Notice  int `json:"notice"`
	Ignored int `json:"ignored"`
	Total   int `json:"total"`
}

type ValidationBlock struct {
	// Condition is the raw condition expression as a string
	Condition string `json:"condition"`

	// ErrorMessage is the error message shown when validation fails
	ErrorMessage string `json:"error_message,omitempty"`
}

type VariableSignature struct {
	// Name is the variable name
	Name string `json:"name"`

	// Type is the normalized type expression (e.g., "string", "list(string)")
	Type string `json:"type,omitempty"`

	// Default is the JSON-serialized default value, nil if no default
	Default interface{} `json:"default,omitempty"`

	// Description is the variable description
	Description string `json:"description,omitempty"`

	// Sensitive indicates if the variable is marked sensitive
	Sensitive bool `json:"sensitive,omitempty"`

	// Nullable indicates if the variable accepts null values.
	// nil means unspecified (defaults to true in Terraform 1.1+)
	// Pointer is used to distinguish unset from explicit false.
	Nullable *bool `json:"nullable,omitempty"`

	// Required is true if the variable has no default value
	Required bool `json:"required"`

	// ValidationCount is the number of validation blocks on this variable
	ValidationCount int `json:"validation_count,omitempty"`

	// Validations contains the validation blocks for this variable
	Validations []ValidationBlock `json:"validations,omitempty"`

	// DeclRange is the source location of the declaration
	DeclRange FileRange `json:"pos"`
}