revisor

Jul 29, 2026

Changes in this version

type ValidationOptionFunc

+ func WithOptionalDocumentUUID() ValidationOptionFunc

Mar 3, 2026

Changes in this version

type Validator

+ func (v *Validator) Prune(ctx context.Context, document *newsdoc.Document) ([]ValidationResult, error)

Feb 13, 2026

Changes in this version

type Validator

+ func (v *Validator) WithVariants(variants ...Variant) *Validator

+ type Variant struct

+ Name string

+ Types []string

Dec 18, 2024

Changes in this version

type EnumConstraint

+ Description string

Sep 17, 2024

Changes in this version

type BlockConstraint

+ Ref string

+ func (bc *BlockConstraint) SetBlockConstraints(kind BlockKind, blocks []*BlockConstraint)

+ func (bc BlockConstraint) Copy() *BlockConstraint

+ func (bc BlockConstraint) IsNoop() bool

type BlockConstraintSet

+ SetBlockConstraints func(kind BlockKind, blocks []*BlockConstraint)

+ type BlockDefinition struct

+ Block BlockConstraint

+ ID string

type BlockSignature

+ func (bs BlockSignature) AsConstraint() ConstraintMap

+ type ColourFormat string

+ const ColourHex

+ const ColourRGB

+ const ColourRGBA

+ const ColourUnknown

type ConstraintMap

+ func (cm ConstraintMap) Copy() ConstraintMap

+ func (cm ConstraintMap) JSONSchemaAlias() any

type DocumentConstraint

+ func (dc *DocumentConstraint) SetBlockConstraints(kind BlockKind, blocks []*BlockConstraint)

type StringConstraint

+ ColourFormats []ColourFormat

type StringFormat

+ const StringFormatColour

Jun 25, 2024

Changes in this version

type ConstraintMap

+ func MakeConstraintMap(constraints map[string]StringConstraint) ConstraintMap

Jun 18, 2024

Changes in this version

type ConstraintMap

+ Constraints map[string]StringConstraint

+ Keys []string

+ func (cm *ConstraintMap) MarshalJSON() ([]byte, error)

+ func (cm *ConstraintMap) UnmarshalJSON(data []byte) error

type ConstraintSet

+ func DecodeConstraintSetsFS(sFS embed.FS, names ...string) ([]ConstraintSet, error)

Jun 11, 2024

Changes in this version

type ConstraintSet

+ Enums []Enum

+ type Enum struct

+ Declare string

+ Description string

+ Match string

+ Name string

+ Values map[string]EnumConstraint

+ type EnumConstraint struct

+ Deprecated *Deprecation

+ Forbidden bool

type StringConstraint

+ EnumRef string

type ValidationContext

+ ValidateEnum func(enum string, value string) (*Deprecation, error)

Mar 7, 2024

Changes in this version

+ type DeprecationDecision struct

+ Enforce bool

+ Message string

Feb 28, 2024

Changes in this version

type BlockConstraint

+ Deprecated *Deprecation

+ type Deprecation struct

+ Doc string

+ Label string

+ type DeprecationContext struct

+ Block *newsdoc.Block

+ Entity *EntityRef

+ Value *string

+ type DeprecationHandlerFunc func(deprecation Deprecation, c DeprecationContext) error

type DocumentConstraint

+ Deprecated *Deprecation

type StringConstraint

+ Deprecated *Deprecation

type ValidationOptionFunc

+ func WithDeprecationHandler(fn DeprecationHandlerFunc) ValidationOptionFunc

type ValidationResult

+ EnforcedDeprecation bool

Sep 19, 2023

Changes in this version

type BlockSignature

+ Role string

+ type DefaultValueCollector struct

+ func NewValueCollector() *DefaultValueCollector

+ func (c *DefaultValueCollector) CollectValue(a ValueAnnotation)

+ func (c *DefaultValueCollector) Values() []ValueAnnotation

+ func (c *DefaultValueCollector) With(ref EntityRef) ValueCollector

+ type Geometry string

+ const GeometryAny

+ const GeometryCircularString

+ const GeometryLineString

+ const GeometryMultiLineString

+ const GeometryMultiPoint

+ const GeometryMultiPolygon

+ const GeometryPoint

+ const GeometryPolygon

type StringConstraint

+ Geometry string

+ Hints map[string][]string

+ Labels []string

type StringFormat

+ const StringFormatWKT

type Validator

+ func (v *Validator) WithConstraints(constraints ...ConstraintSet) (*Validator, error)

May 23, 2023

Changes in this version

+ func ValidateEntity(data []byte) (int, error)

+ type BlockConstraint struct

+ Attributes ConstraintMap

+ BlocksFrom []BlocksFrom

+ Content []*BlockConstraint

+ Count *int

+ Data ConstraintMap

+ Declares *BlockSignature

+ Description string

+ Links []*BlockConstraint

+ Match ConstraintMap

+ MaxCount *int

+ Meta []*BlockConstraint

+ MinCount *int

+ Name string

+ func (bc *BlockConstraint) UnmarshalJSON(data []byte) error

+ func (bc BlockConstraint) BlockConstraints(kind BlockKind) []*BlockConstraint

+ func (bc BlockConstraint) DescribeCountConstraint(kind BlockKind) string

+ func (bc BlockConstraint) Matches(b *newsdoc.Block) (Match, []string)

+ type BlockConstraintSet interface

+ BlockConstraints func(kind BlockKind) []*BlockConstraint

+ type BlockKind string

+ const BlockKindContent

+ const BlockKindLink

+ const BlockKindMeta

+ func (bk BlockKind) Description(n int) string

+ type BlockSignature struct

+ Rel string

+ Type string

+ type BlockSource interface

+ GetBlocks func(kind BlockKind) []newsdoc.Block

+ type BlocksFrom struct

+ DocType string

+ Global bool

+ Kind BlockKind

+ type BorrowedBlocks struct

+ Kind BlockKind

+ Source BlockConstraintSet

+ func (bb BorrowedBlocks) BlockConstraints(kind BlockKind) []*BlockConstraint

+ type ConstraintMap map[string]StringConstraint

+ func (cm ConstraintMap) Requirements() string

+ type ConstraintSet struct

+ Attributes ConstraintMap

+ Content []*BlockConstraint

+ Documents []DocumentConstraint

+ HTMLPolicies []HTMLPolicy

+ Links []*BlockConstraint

+ Meta []*BlockConstraint

+ Name string

+ Schema string

+ Version int

+ func (cs ConstraintSet) BlockConstraints(kind BlockKind) []*BlockConstraint

+ func (cs ConstraintSet) Validate() error

+ type DocumentBlocks struct

+ func NewDocumentBlocks(document *newsdoc.Document) DocumentBlocks

+ func (db DocumentBlocks) GetBlocks(kind BlockKind) []newsdoc.Block

+ type DocumentConstraint struct

+ Attributes ConstraintMap

+ Content []*BlockConstraint

+ Declares string

+ Description string

+ Links []*BlockConstraint

+ Match ConstraintMap

+ Meta []*BlockConstraint

+ Name string

+ func (dc *DocumentConstraint) UnmarshalJSON(data []byte) error

+ func (dc DocumentConstraint) BlockConstraints(kind BlockKind) []*BlockConstraint

+ func (dc DocumentConstraint) Matches(d *newsdoc.Document, vCtx *ValidationContext) Match

+ type EntityRef struct

+ BlockKind BlockKind

+ Index int

+ Name string

+ RefType RefType

+ Rel string

+ Type string

+ func (er EntityRef) String() string

+ type Glob struct

+ func CompileGlob(pattern string) (*Glob, error)

+ func (g *Glob) MarshalJSON() ([]byte, error)

+ func (g *Glob) Match(s string) bool

+ func (g *Glob) UnmarshalJSON(data []byte) error

+ type GlobList []*Glob

+ func (gl GlobList) MatchOrEmpty(v string) bool

+ func (gl GlobList) String() string

+ type HTMLElement struct

+ Attributes ConstraintMap

+ type HTMLPolicy struct

+ Description string

+ Elements map[string]HTMLElement

+ Extends string

+ Name string

+ Uses string

+ func (hp *HTMLPolicy) Check(v string) error

+ type HTMLPolicySet struct

+ func NewHTMLPolicySet() *HTMLPolicySet

+ func (s *HTMLPolicySet) Add(source string, policies ...HTMLPolicy) error

+ func (s *HTMLPolicySet) Resolve() (map[string]*HTMLPolicy, error)

+ type Match int

+ const MatchDeclaration

+ const Matches

+ const NoMatch

+ type NestedBlocks struct

+ func NewNestedBlocks(block *newsdoc.Block) NestedBlocks

+ func (nb NestedBlocks) GetBlocks(kind BlockKind) []newsdoc.Block

+ type RefType string

+ const RefTypeAttribute

+ const RefTypeBlock

+ const RefTypeData

+ func (rt RefType) String() string

+ type Regexp struct

+ func (r *Regexp) MarshalJSON() ([]byte, error)

+ func (r *Regexp) Match(v string) bool

+ func (r *Regexp) String() string

+ func (r *Regexp) UnmarshalJSON(data []byte) error

+ type StringConstraint struct

+ AllowEmpty bool

+ Const *string

+ Description string

+ Enum []string

+ Format StringFormat

+ Glob GlobList

+ HTMLPolicy string

+ Name string

+ Optional bool

+ Pattern *Regexp

+ Time string

+ func (sc *StringConstraint) Requirement() string

+ func (sc *StringConstraint) Validate(value string, exists bool, vCtx *ValidationContext) error

+ type StringFormat string

+ const StringFormatBoolean

+ const StringFormatFloat

+ const StringFormatHTML

+ const StringFormatInt

+ const StringFormatNone

+ const StringFormatRFC3339

+ const StringFormatUUID

+ func (f StringFormat) Describe() string

+ type ValidationContext struct

+ ValidateHTML func(policyName, value string) error

+ type ValidationOptionFunc func(vc *ValidationContext)

+ func WithValueCollector(collector ValueCollector) ValidationOptionFunc

+ type ValidationResult struct

+ Entity []EntityRef

+ Error string

+ func (vr ValidationResult) String() string

+ type Validator struct

+ func NewValidator(constraints ...ConstraintSet) (*Validator, error)

+ func (v *Validator) ValidateDocument(document *newsdoc.Document, opts ...ValidationOptionFunc) []ValidationResult

+ type ValueAnnotation struct

+ Constraint StringConstraint

+ Ref []EntityRef

+ Value string

+ type ValueCollector interface

+ CollectValue func(a ValueAnnotation)

+ With func(ref EntityRef) ValueCollector

+ type ValueDiscarder struct

+ func (ValueDiscarder) CollectValue(_ ValueAnnotation)

+ func (ValueDiscarder) With(_ EntityRef) ValueCollector