primitives

type AgeOverThresholdsArgs struct {
	// Input is the birthdate claim name (value must be ISO YYYY-MM-DD).
	Input string `yaml:"input" validate:"required" doc_example:"birthdate"`

	// Thresholds are the ages (in years) to expose. Each N produces
	// age_over_N and over_N_this_year (booleans). Every entry must be
	// positive.
	Thresholds []int `yaml:"thresholds" validate:"required,min=1,dive,gt=0" doc_example:"[13, 15, 18, 21, 65]"`
}

type Applier interface {
	Apply(claims map[string]any, now time.Time) (map[string]any, error)
}

type CountryAlpha2Args struct {
	Input  string `yaml:"input" validate:"required" doc_example:"nationalities"`
	Output string `yaml:"output,omitempty" doc_example:"nationalities"`
}

type CountryAlpha3Args struct {
	Input  string `yaml:"input" validate:"required" doc_example:"nationalities"`
	Output string `yaml:"output,omitempty" doc_example:"nationalities"`
}

type Derivation struct {
	// AgeOverThresholds emits two boolean claims per configured threshold
	// N from an ISO YYYY-MM-DD birthdate: age_over_N (completed years at
	// `now`) and over_N_this_year (reaches N at some point in `now`'s
	// calendar year).
	AgeOverThresholds *AgeOverThresholdsArgs `yaml:"age_over_thresholds,omitempty"`

	// Lowercase applies strings.ToLower elementwise.
	Lowercase *LowercaseArgs `yaml:"lowercase,omitempty"`

	// Uppercase applies strings.ToUpper elementwise.
	Uppercase *UppercaseArgs `yaml:"uppercase,omitempty"`

	// Trim applies strings.TrimSpace elementwise.
	Trim *TrimArgs `yaml:"trim,omitempty"`

	// CountryAlpha2 maps country names or alpha-3 codes to ISO 3166-1
	// alpha-2 codes elementwise. Unknown inputs pass through unchanged.
	CountryAlpha2 *CountryAlpha2Args `yaml:"country_alpha2,omitempty"`

	// CountryAlpha3 maps country names or alpha-2 codes to ISO 3166-1
	// alpha-3 codes elementwise. Unknown inputs pass through unchanged.
	CountryAlpha3 *CountryAlpha3Args `yaml:"country_alpha3,omitempty"`

	// YYYYMMDDToISO converts a SCHAC schacDateOfBirth ("YYYYMMDD") claim to
	// ISO full-date ("YYYY-MM-DD"). Impossible calendar dates are an error.
	YYYYMMDDToISO *YYYYMMDDToISOArgs `yaml:"yyyymmdd_to_iso,omitempty"`

	// SWAMIDHighestAssuranceLevel reduces a multi-valued eduPersonAssurance
	// claim to the strongest recognised SWAMID Assurance Framework URI.
	SWAMIDHighestAssuranceLevel *SWAMIDHighestAssuranceLevelArgs `yaml:"swamid_highest_assurance_level,omitempty"`

	// Random writes a freshly generated random value to a claim the source
	// data did not supply - a document identifier, typically. The only
	// primitive here that reads nothing and is not a pure function of its
	// input; see RandomArgs for where the value is generated and how long
	// it lives.
	Random *RandomArgs `yaml:"random,omitempty"`
}

type LowercaseArgs struct {
	// Input is the source claim name. Supports dot-notation claim paths
	// (e.g. "identity.email") so this primitive can target the same nested
	// claims that AttributeMapper materialises.
	Input string `yaml:"input" validate:"required" doc_example:"email"`

	// Output is the target claim name. Defaults to Input (in-place).
	// Supports dot-notation claim paths.
	Output string `yaml:"output,omitempty" doc_example:"email"`
}

type RandomArgs struct {
	// Output is the target claim name. Supports dot-notation claim paths
	// (e.g. "identity.document_id") so this primitive can target the same
	// nested claims that AttributeMapper materialises.
	//
	// There is no Input: this primitive reads nothing.
	Output string `yaml:"output" validate:"required" doc_example:"document_id"`

	// Format selects the shape of the value: "uuid" (the default), "hex" or
	// "base64url".
	Format string `yaml:"format,omitempty" validate:"omitempty,oneof=uuid hex base64url" doc_example:"uuid"`

	// Bytes is how many random bytes back a "hex" or "base64url" value,
	// between 8 and 64. Ignored for "uuid", whose length the format fixes.
	// Defaults to 16.
	Bytes int `yaml:"bytes,omitempty" validate:"omitempty,min=8,max=64" doc_example:"16"`

	// Overwrite replaces a value the source data already supplied.
	//
	// False by default, and deliberately: this primitive exists to fill a
	// claim authentication could not provide, and silently replacing a real
	// identifier with a random one is a worse failure than leaving the
	// derivation with nothing to do. Set it only where the claim is meant to
	// be random every time regardless of what arrived.
	Overwrite bool `yaml:"overwrite,omitempty"`
}

type SWAMIDHighestAssuranceLevelArgs struct {
	// Input is the source claim (string or list of strings).
	Input string `yaml:"input" validate:"required" doc_example:"assurance_level"`

	// Output is the target claim. Defaults to Input (in-place).
	Output string `yaml:"output,omitempty" doc_example:"assurance_level"`
}

type TrimArgs struct {
	Input  string `yaml:"input" validate:"required" doc_example:"name"`
	Output string `yaml:"output,omitempty" doc_example:"name"`
}

type UppercaseArgs struct {
	Input  string `yaml:"input" validate:"required" doc_example:"country"`
	Output string `yaml:"output,omitempty" doc_example:"country"`
}

type YYYYMMDDToISOArgs struct {
	// Input is the source claim name (must be a non-empty YYYYMMDD string).
	Input string `yaml:"input" validate:"required" doc_example:"birthdate"`

	// Output is the target claim name. Defaults to Input.
	Output string `yaml:"output,omitempty" doc_example:"birthdate"`
}