// Package shape validates the required extracted item fields. package shape import ( "context" "fmt" "strings" "gitea.maximumdirect.net/eric/notarius/internal/framework/contracts" "gitea.maximumdirect.net/eric/notarius/internal/framework/pipeline" "gitea.maximumdirect.net/eric/notarius/internal/modules/dnd" "gitea.maximumdirect.net/eric/notarius/internal/modules/dnd/shared/diagnostics" ) const ( Key = "extract/dnd/item-registry/shape" ReasonCode = "invalid_item_shape" policy = "dnd.item_registry.validator.shape.v2" ) type Options struct{} type Validator struct{} var _ contracts.TypedValidator[dnd.ItemRegistry] = (*Validator)(nil) var _ pipeline.CheckpointFingerprintProvider = (*Validator)(nil) func New(Options) *Validator { return &Validator{} } func (v *Validator) Name() string { return Key } func (v *Validator) ExecutionClass() contracts.ExecutionClass { return contracts.ExecutionClassDeterministic } func (v *Validator) CheckpointFingerprints() []pipeline.CheckpointFingerprint { return []pipeline.CheckpointFingerprint{{Name: "policy", Value: policy}} } func (v *Validator) Validate(_ context.Context, req contracts.TypedValidationRequest[dnd.ItemRegistry]) (contracts.ValidationResult, error) { normalization := req.Stage == string(pipeline.StageNormalize) issues, corrections := assess(req.Value, normalization) if len(issues) > 0 { prefix := "Correct every rejected item and return the complete replacement registry" if normalization { prefix = "Correct the duplicate-group proposals and return the complete replacement proposal response" } return rejection(diagnostics.Aggregate("invalid item shape", issues), corrections.Guidance(prefix)), nil } return contracts.ValidationResult{Approved: true}, nil } func Validate(value dnd.ItemRegistry) error { issues, _ := assess(value, false) if len(issues) == 0 { return nil } return fmt.Errorf("%s", diagnostics.Aggregate("invalid item shape", issues)) } func assess(value dnd.ItemRegistry, normalization bool) ([]string, diagnostics.Corrections) { var corrections diagnostics.Corrections nameRule := "Provide one nonblank, transcript-supported item name for every registry entry." refRule := "Provide at least one transcript source range that directly supports every named item." listRule := "Return an `items` array; use an empty array when the transcript establishes no named items." if normalization { nameRule = "Revise the duplicate-group proposals so every selected canonical item has a nonblank, transcript-supported name." refRule = "Revise the duplicate-group proposals so every selected canonical item preserves direct transcript evidence." listRule = "Revise the duplicate-group proposals so normalization retains the complete item candidate registry." } if value.Items == nil { corrections.Add("list", listRule, "") return []string{"items must be present"}, corrections } issues := make([]string, 0) for index, item := range value.Items { prefix := fmt.Sprintf("items[%d]", index) record := "Affected item " + diagnostics.Quote(strings.TrimSpace(item.Name)) + " " + diagnostics.SourceRange(item.SourceRefs) + "." if strings.TrimSpace(item.ID) == "" { issues = append(issues, prefix+".id must not be empty") corrections.Add("name", nameRule, record) } if strings.TrimSpace(item.Name) == "" { issues = append(issues, prefix+".name must not be empty") corrections.Add("name", nameRule, record) } if len(item.SourceRefs) == 0 { issues = append(issues, prefix+".source_refs must not be empty") corrections.Add("source-refs", refRule, record) } } return issues, corrections } func Spec() pipeline.ValidatorSpec { return pipeline.ValidatorSpec{Key: Key, ExecutionClass: contracts.ExecutionClassDeterministic} } func Register(registry *pipeline.ValidatorRegistry) error { return pipeline.RegisterTypedValidatorBuilder(registry, dnd.ItemRegistryKind, Spec(), validateOptions, func(request pipeline.BuildRequest) (contracts.TypedValidator[dnd.ItemRegistry], error) { options, err := DecodeOptions(request.Options) if err != nil { return nil, err } return New(options), nil }) } func DecodeOptions(options map[string]any) (Options, error) { if err := pipeline.RejectUnknownOptions(options); err != nil { return Options{}, err } return Options{}, nil } func validateOptions(options map[string]any) error { _, err := DecodeOptions(options); return err } func rejection(message, guidance string) contracts.ValidationResult { return contracts.ValidationResult{Approved: false, ReasonCode: ReasonCode, Message: message, CorrectionGuidance: guidance} }