notarius/internal/modules/dnd/validate/npcoccurrences/shape/validator.go

// Package shape validates required D&D NPC occurrence candidate 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/npc-occurrences/shape"
	ReasonCode = "invalid_npc_occurrence_shape"
	policy     = "dnd.npc_occurrences.validator.shape.v2"
)

type Options struct{}
type Validator struct{}

var _ contracts.TypedValidator[dnd.NPCOccurrenceList] = (*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.NPCOccurrenceList]) (contracts.ValidationResult, error) {
	issues, corrections := assess(req.Value)
	if len(issues) != 0 {
		return contracts.ValidationResult{
			Approved:           false,
			ReasonCode:         ReasonCode,
			Message:            diagnostics.Aggregate("invalid NPC occurrence shape", issues),
			CorrectionGuidance: corrections.Guidance("Correct every rejected NPC occurrence and return the complete replacement occurrence list"),
		}, nil
	}
	return contracts.ValidationResult{Approved: true}, nil
}

func Validate(value dnd.NPCOccurrenceList) error {
	issues, _ := assess(value)
	if len(issues) == 0 {
		return nil
	}
	return fmt.Errorf("%s", diagnostics.Aggregate("invalid NPC occurrence shape", issues))
}

func assess(value dnd.NPCOccurrenceList) ([]string, diagnostics.Corrections) {
	var corrections diagnostics.Corrections
	if value.Occurrences == nil {
		corrections.Add("list", "Return an `occurrences` array; use an empty array when the transcript establishes no NPC occurrences.", "")
		return []string{"occurrences must be present"}, corrections
	}
	issues := make([]string, 0)
	for index, occurrence := range value.Occurrences {
		prefix := fmt.Sprintf("occurrences[%d]", index)
		record := fmt.Sprintf("Affected %s occurrence for NPC %s %s.", diagnostics.Quote(string(occurrence.Kind)), diagnostics.Quote(strings.TrimSpace(occurrence.Name)), diagnostics.SourceRange(occurrence.SourceRefs))
		if strings.TrimSpace(occurrence.NPCID) == "" {
			issues = append(issues, prefix+".npc_id must not be empty: "+diagnostics.Quote(occurrence.NPCID))
			corrections.Add("name", "Select a nonblank contextual NPC name from the supplied registry for every occurrence.", record)
		}
		if strings.TrimSpace(occurrence.Name) == "" {
			issues = append(issues, prefix+".name must not be empty: "+diagnostics.Quote(occurrence.Name))
			corrections.Add("name", "Select a nonblank contextual NPC name from the supplied registry for every occurrence.", record)
		}
		if !validKind(occurrence.Kind) {
			issues = append(issues, prefix+".kind is unsupported: "+diagnostics.Quote(string(occurrence.Kind)))
			corrections.Add("kind", "Set `kind` to exactly one of `mentioned`, `noncombat_presence`, `dialogue`, `combat_ally`, `combat_opponent`, or `other`.", record)
		}
		if len(occurrence.SourceRefs) == 0 {
			issues = append(issues, prefix+".source_refs must contain at least one reference")
			corrections.Add("source-refs", "Provide at least one transcript source range that directly supports every NPC occurrence.", record)
		}
	}
	return issues, corrections
}

func validKind(value dnd.NPCOccurrenceKind) bool {
	switch value {
	case dnd.NPCOccurrenceKindMentioned,
		dnd.NPCOccurrenceKindNoncombatPresence,
		dnd.NPCOccurrenceKindDialogue,
		dnd.NPCOccurrenceKindCombatAlly,
		dnd.NPCOccurrenceKindCombatOpponent,
		dnd.NPCOccurrenceKindOther:
		return true
	default:
		return false
	}
}

func Spec() pipeline.ValidatorSpec {
	return pipeline.ValidatorSpec{Key: Key, ExecutionClass: contracts.ExecutionClassDeterministic}
}

func Register(registry *pipeline.ValidatorRegistry) error {
	return pipeline.RegisterTypedValidatorBuilder(registry, dnd.NPCOccurrenceListKind, Spec(), validateOptions, func(request pipeline.BuildRequest) (contracts.TypedValidator[dnd.NPCOccurrenceList], 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 }