policy

type CheckCategoryMap map[string][]category.RiskCategory

type CompiledPolicy struct {
	Rules            []SeverityRule
	ExpectedFailures map[string]ExpectedFailureV2
	ExpectedWarnings map[string]ExpectedFailureV2
	Workflow         *WorkflowConfig
}

type DepthRange struct {
	Min int
	Max int // -1 = infinity
}

type EvaluationContext struct {
	SourcePath     string
	Ecosystem      string
	Depth          int
	Dev            bool
	CheckCode      string
	Categories     []category.RiskCategory
	EvaluationTime time.Time
}

type EvaluationResult struct {
	Status       string            `json:"status"`
	Source       string            `json:"source"`
	WorkflowMode WorkflowMode      `json:"workflow_mode,omitempty"`
	Error        string            `json:"error,omitempty"`
	Policies     *PolicyBreakdown  `json:"policies"`
	Findings     []Finding         `json:"findings"`
	Summary      EvaluationSummary `json:"summary"`
}

type EvaluationSummary struct {
	TotalPackages     int `json:"total_packages"`
	UnblockedPackages int `json:"unblocked_packages"`
	// Deprecated: Use UnblockedPackages instead.
	ChecksPassed int `json:"checks_passed"`
	Blocking     int `json:"blocking"`
	Warning      int `json:"warning"`
	Acknowledged int `json:"acknowledged"`
	Expired      int `json:"expired"`
	Ignored      int `json:"ignored"`
}

type ExpectedFailureV2 struct {
	Checks     []string   `json:"checks,omitempty" jsonschema:"description=Check codes to acknowledge for this entity"`
	Reason     string     `json:"reason" jsonschema:"description=Why this violation is acceptable"`
	Expires    *time.Time `json:"expires,omitempty" jsonschema:"description=Expiration date for acknowledgment"`
	ApprovedBy string     `json:"approved_by,omitempty" jsonschema:"description=Who approved this exception"`
}

type Finding struct {
	Kind           FindingKind          `json:"kind"`
	Package        string               `json:"package"`
	Check          string               `json:"check"`
	Categories     []string             `json:"categories,omitempty"`
	Rationale      string               `json:"rationale"`
	Evidence       []string             `json:"evidence,omitempty"`
	DependencyPath []string             `json:"dependency_path"`
	RootLocation   *models.LocationInfo `json:"root_loc,omitempty"`
	Dev            bool                 `json:"dev,omitempty"`
	Note           string               `json:"note,omitempty"`
	MatchedRule    string               `json:"matched_rule,omitempty"`
}

type FindingKind string

type LoadResult struct {
	Policy    *CompiledPolicy
	Overrides map[string][]PolicyOverride
}

type PathTarget struct {
	IsCategory bool
	Name       string
}

type Policy struct {
	Version          int                          `json:"version" jsonschema:"enum=2,description=Policy file version (must be 2)"`
	Workflow         *WorkflowConfig              `json:"workflow,omitempty" jsonschema:"description=Workflow behavior configuration"`
	Severity         map[string]SeverityValue     `` /* 388-byte string literal not displayed */
	ExpectedFailures map[string]ExpectedFailureV2 `` /* 344-byte string literal not displayed */
	ExpectedWarnings map[string]ExpectedFailureV2 `` /* 400-byte string literal not displayed */
	Overrides        map[string][]PolicyOverride  `` /* 187-byte string literal not displayed */
}

type PolicyBreakdown struct {
	Strategy PolicyStrategy `json:"strategy"`
	Repo     *PolicySummary `json:"repo"`
	Default  *PolicySummary `json:"default"`
	Applied  *PolicySummary `json:"applied"`
}

type PolicyOverride struct {
	Path   string `json:"path" jsonschema:"description=Dot-separated path to override (e.g. output.source_url)"`
	Value  any    `json:"value" jsonschema:"description=Value to set at the path"`
	Reason string `json:"reason" jsonschema:"description=E&O required: explanation for the override"`
	// Precedence controls when the override applies. "force" (the default when
	// empty) always sets the value — a deliberate correction. "fallback" sets the
	// value only when the field resolved no value from metadata, so it gap-fills
	// without clobbering a package's own declaration.
	Precedence string `` /* 163-byte string literal not displayed */
}

type PolicyStrategy string

type PolicySummary struct {
	Version   int    `json:"version"`
	RuleCount int    `json:"rule_count"`
	RawYAML   string `json:"raw_yaml,omitempty"`
}

type Severity string

type SeverityPath struct {
	SourcePath *string
	Ecosystem  *string
	DepthRange *DepthRange
	Env        *bool
	Target     PathTarget
}

type SeverityResult struct {
	Severity    Severity
	Note        string
	MatchedRule string
}

type SeverityRule struct {
	Path          SeverityPath
	Value         SeverityValue
	Specificity   int
	WildcardCount int
	IsOverlay     bool
	IsOverride    bool
}

type SeverityValue struct {
	Severity      Severity   `json:"severity" jsonschema:"enum=blocking,enum=warning,enum=ignore"`
	Reason        string     `json:"reason,omitempty"`
	BlockingAfter *time.Time `json:"blocking_after,omitempty" jsonschema:"description=Date after which severity escalates to blocking"`
}

type WorkflowConfig struct {
	Mode WorkflowMode `` /* 402-byte string literal not displayed */
}

type WorkflowMode string