framework

package

v0.7.0 Latest Latest Go to latest Published: Aug 28, 2026 License: Apache-2.0 Imports: 11 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Clyra-AI/proof

Links

Open Source Insights

Documentation ¶

Overview ¶

Package framework loads versioned framework definitions and computes deterministic evidence-path matches.

Framework coverage APIs are compatibility surfaces. They describe whether supplied records satisfy declared evidence paths; they do not decide regulatory applicability, compliance status, or gap severity.

Index ¶

type Control
type ControlCoveragedeprecated
type Coveragedeprecated
- func EvaluateCoverage(f *Framework, records []record.Record) (*Coverage, error)deprecated
type EvidenceSet
type EvidenceSetCoveragedeprecated
type Framework
- func Load(idOrFile string) (*Framework, error)
- func LoadFile(path string) (*Framework, error)
type Info
- func List() ([]Info, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Control ¶

type Control struct {
	ID                  string        `yaml:"id" json:"id"`
	Title               string        `yaml:"title" json:"title"`
	RequiredRecordTypes []string      `yaml:"required_record_types,omitempty" json:"required_record_types,omitempty"`
	MinimumFrequency    string        `yaml:"minimum_frequency,omitempty" json:"minimum_frequency,omitempty"`
	RequiredFields      []string      `yaml:"required_fields,omitempty" json:"required_fields,omitempty"`
	EvidenceSets        []EvidenceSet `yaml:"evidence_sets,omitempty" json:"evidence_sets,omitempty"`
	Children            []Control     `yaml:"children,omitempty" json:"children,omitempty"`
}

type ControlCoverage deprecated added in v0.5.0

type ControlCoverage struct {
	ID                    string                `json:"id"`
	Title                 string                `json:"title"`
	Covered               bool                  `json:"covered"`
	MatchedEvidenceSetIDs []string              `json:"matched_evidence_set_ids,omitempty"`
	EvidenceSets          []EvidenceSetCoverage `json:"evidence_sets,omitempty"`
	Children              []ControlCoverage     `json:"children,omitempty"`
}

ControlCoverage describes deterministic evidence-path matches for one framework control.

Deprecated: retained for compatibility; this type carries no compliance interpretation.

type Coverage deprecated added in v0.5.0

type Coverage struct {
	FrameworkID      string            `json:"framework_id"`
	FrameworkVersion string            `json:"framework_version"`
	TotalControls    int               `json:"total_controls"`
	CoveredControls  int               `json:"covered_controls"`
	Controls         []ControlCoverage `json:"controls"`
}

Coverage is the deterministic evidence-path coverage result for a framework.

Deprecated: framework coverage is retained as a compatibility API. It must not be interpreted as compliance status, regulatory applicability, or gap scoring; those semantics belong to the consuming product.

func EvaluateCoverage deprecated added in v0.5.0

func EvaluateCoverage(f *Framework, records []record.Record) (*Coverage, error)

EvaluateCoverage reports deterministic evidence-path coverage.

Deprecated: use this only as a compatibility helper. It does not evaluate regulatory applicability, compliance status, or gap scoring.

type EvidenceSet ¶ added in v0.5.0

type EvidenceSet struct {
	ID                  string   `yaml:"id" json:"id"`
	Title               string   `yaml:"title,omitempty" json:"title,omitempty"`
	SourceProducts      []string `yaml:"source_products,omitempty" json:"source_products,omitempty"`
	RequiredRecordTypes []string `yaml:"required_record_types,omitempty" json:"required_record_types,omitempty"`
	MinimumFrequency    string   `yaml:"minimum_frequency,omitempty" json:"minimum_frequency,omitempty"`
	RequiredFields      []string `yaml:"required_fields,omitempty" json:"required_fields,omitempty"`
}

type EvidenceSetCoverage deprecated added in v0.5.0

type EvidenceSetCoverage struct {
	ID                  string   `json:"id"`
	Title               string   `json:"title,omitempty"`
	Covered             bool     `json:"covered"`
	SourceProducts      []string `json:"source_products,omitempty"`
	RequiredRecordTypes []string `json:"required_record_types"`
	MinimumFrequency    string   `json:"minimum_frequency"`
	RequiredFields      []string `json:"required_fields"`
	MatchingRecordIDs   []string `json:"matching_record_ids,omitempty"`
	MissingRecordTypes  []string `json:"missing_record_types,omitempty"`
}

EvidenceSetCoverage describes deterministic record matches for one evidence set.

Deprecated: retained for compatibility; this type carries no compliance interpretation.

type Framework ¶

type Framework struct {
	Framework struct {
		ID      string `yaml:"id" json:"id"`
		Version string `yaml:"version" json:"version"`
		Title   string `yaml:"title" json:"title"`
	} `yaml:"framework" json:"framework"`
	Controls []Control `yaml:"controls" json:"controls"`
}

func Load ¶

func Load(idOrFile string) (*Framework, error)

func LoadFile ¶ added in v0.4.1

func LoadFile(path string) (*Framework, error)

type Info ¶

type Info struct {
	ID           string `json:"id"`
	Version      string `json:"version"`
	Title        string `json:"title"`
	ControlCount int    `json:"control_count"`
	File         string `json:"file"`
}

func List ¶

func List() ([]Info, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL