schematics

package module

Go to main page

Versions in this module

v1

v1.0.3

Jul 25, 2026

Changes in this version

+ const ProblemContentType

+ func RuleName(c Code) (string, bool)

+ func WriteProblem(w http.ResponseWriter, r *http.Request, err error, opts ...ProblemOption) error

type API

+ func (a *API) WriteProblem(w http.ResponseWriter, r *http.Request, err error, opts ...ProblemOption) error

+ type Attribute struct

+ Key string

+ Value any

+ type Catalog struct

+ DefaultLocale string

+ func LoadCatalogBytes(b []byte) (*Catalog, error)

+ func LoadCatalogFile(path string) (*Catalog, error)

+ func LoadCatalogTOMLBytes(b []byte) (*Catalog, error)

+ func LoadCatalogTOMLFile(path string) (*Catalog, error)

+ func NewCatalog() *Catalog

+ func (c *Catalog) Merge(locale string, templates map[string]string)

+ func (c *Catalog) Render(locale, rule string, args map[string]any) (msg string, ok bool)

+ type Code string

+ const CodeBodyTooLarge

+ const CodeDependsOn

+ const CodeDuplicateTarget

+ const CodeEmptyTarget

+ const CodeMalformedWhen

+ const CodeRequired

+ const CodeRouteNotFound

+ const CodeSampleMismatch

+ const CodeSchemaInvalid

+ const CodeUnknownCondition

+ const CodeUnknownOperator

+ const CodeUnknownRule

+ func RuleCode(rule string) Code

+ func (c Code) Namespace() string

+ func (c Code) String() string

+ type Event struct

+ Code Code

+ Duration time.Duration

+ Errors int

+ Failed bool

+ Kind EventKind

+ Op Operation

+ RowID string

+ Rows int

+ Rule string

+ Target string

+ type EventKind string

+ const EventRule

+ const EventValidation

+ type Metrics struct

+ RuleEvaluations func(rule, target string)

+ RuleFailures func(rule, code, target string)

+ Validations func(op, outcome string, duration time.Duration)

+ func (m Metrics) Observer() Observer

+ type Observer interface

+ Observe func(Event)

+ type ObserverFunc func(Event)

+ func (f ObserverFunc) Observe(e Event)

+ type Operation string

+ const OpValidate

+ const OpValidateArray

+ const OpValidateRequest

+ const OpValidateStream

type Option

+ func WithCatalog(cat *Catalog) Option

+ func WithObserver(o Observer) Option

+ func WithTracer(t Tracer) Option

+ type Problem struct

+ Detail string

+ Errors []ProblemError

+ Instance string

+ Status int

+ Title string

+ Type string

+ func NewProblem(err error, opts ...ProblemOption) *Problem

+ func (p *Problem) Write(w http.ResponseWriter) error

+ type ProblemError struct

+ Code string

+ Detail string

+ Pointer string

+ RowID string

+ Rule string

+ Target string

+ type ProblemOption func(*problemConfig)

+ func WithProblemDetail(detail string) ProblemOption

+ func WithProblemInstance(uri string) ProblemOption

+ func WithProblemLocale(locale string) ProblemOption

+ func WithProblemStatus(status int) ProblemOption

+ func WithProblemTitle(title string) ProblemOption

+ func WithProblemType(uri string) ProblemOption

+ type RowResult struct

+ Errors *ValidationErrors

+ Index int

+ RowID string

+ func (r RowResult) Valid() bool

type SchemaError

+ Details []SchemaProblem

+ func (e *SchemaError) Codes() []Code

+ type SchemaProblem struct

+ Code Code

+ Message string

+ Target string

type Schematics

+ func (s *Schematics) ValidateStream(r io.Reader, opts ...StreamOption) error

+ func (s *Schematics) ValidateStreamCtx(ctx context.Context, r io.Reader, opts ...StreamOption) error

+ func (s *Schematics) ValidateStreamEach(ctx context.Context, r io.Reader, fn func(RowResult) error, ...) error

+ type SlogObserver struct

+ func NewSlogObserver(logger *slog.Logger, level slog.Level) *SlogObserver

+ func (o *SlogObserver) Observe(e Event)

+ type Span interface

+ End func()

+ SetAttributes func(attrs ...Attribute)

+ type StreamOption func(*streamConfig)

+ func WithConcurrency(n int) StreamOption

+ type StreamPanic struct

+ Stack []byte

+ Suppressed error

+ Value any

+ func (p *StreamPanic) Error() string

+ func (p *StreamPanic) Unwrap() error

+ type Tracer interface

+ Start func(ctx context.Context, name string) (context.Context, Span)

type ValidationError

+ Code Code

+ func (e *ValidationError) Pointer() string

type ValidationErrors

+ func (es *ValidationErrors) Pointers() []string

+ type WhenNode struct

+ All []WhenNode

+ Any []WhenNode

+ Args Args

+ Condition string

+ Negate bool

+ Not *WhenNode

v1.0.2

Jul 24, 2026

Changes in this version

+ type FieldBuilder struct

+ func (fb *FieldBuilder) AddToDB() *FieldBuilder

+ func (fb *FieldBuilder) After(date string) *FieldBuilder

+ func (fb *FieldBuilder) AfterNow() *FieldBuilder

+ func (fb *FieldBuilder) Alpha() *FieldBuilder

+ func (fb *FieldBuilder) Alphanumeric() *FieldBuilder

+ func (fb *FieldBuilder) Before(date string) *FieldBuilder

+ func (fb *FieldBuilder) BeforeNow() *FieldBuilder

+ func (fb *FieldBuilder) Between(min, max float64) *FieldBuilder

+ func (fb *FieldBuilder) Capitalize() *FieldBuilder

+ func (fb *FieldBuilder) Contains(sub string) *FieldBuilder

+ func (fb *FieldBuilder) Default(v any) *FieldBuilder

+ func (fb *FieldBuilder) DependsOn(targets ...string) *FieldBuilder

+ func (fb *FieldBuilder) Description(d string) *FieldBuilder

+ func (fb *FieldBuilder) DisplayName(n string) *FieldBuilder

+ func (fb *FieldBuilder) Done() *SchemaBuilder

+ func (fb *FieldBuilder) Email() *FieldBuilder

+ func (fb *FieldBuilder) EndsWith(suffix string) *FieldBuilder

+ func (fb *FieldBuilder) Equals(v string) *FieldBuilder

+ func (fb *FieldBuilder) ExactLength(n int) *FieldBuilder

+ func (fb *FieldBuilder) Field(target string) *FieldBuilder

+ func (fb *FieldBuilder) HasDigit() *FieldBuilder

+ func (fb *FieldBuilder) HasLower() *FieldBuilder

+ func (fb *FieldBuilder) HasUpper() *FieldBuilder

+ func (fb *FieldBuilder) InOptions(opts ...string) *FieldBuilder

+ func (fb *FieldBuilder) IsArray() *FieldBuilder

+ func (fb *FieldBuilder) IsBase64() *FieldBuilder

+ func (fb *FieldBuilder) IsBoolean() *FieldBuilder

+ func (fb *FieldBuilder) IsCIDR() *FieldBuilder

+ func (fb *FieldBuilder) IsDate() *FieldBuilder

+ func (fb *FieldBuilder) IsFloat() *FieldBuilder

+ func (fb *FieldBuilder) IsHTTPS() *FieldBuilder

+ func (fb *FieldBuilder) IsHex() *FieldBuilder

+ func (fb *FieldBuilder) IsIP() *FieldBuilder

+ func (fb *FieldBuilder) IsInteger() *FieldBuilder

+ func (fb *FieldBuilder) IsJSON() *FieldBuilder

+ func (fb *FieldBuilder) IsNumber() *FieldBuilder

+ func (fb *FieldBuilder) IsObject() *FieldBuilder

+ func (fb *FieldBuilder) IsString() *FieldBuilder

+ func (fb *FieldBuilder) IsURL() *FieldBuilder

+ func (fb *FieldBuilder) IsUUID() *FieldBuilder

+ func (fb *FieldBuilder) ItemsInOptions(opts ...string) *FieldBuilder

+ func (fb *FieldBuilder) LengthBetween(min, max int) *FieldBuilder

+ func (fb *FieldBuilder) Like(p string) *FieldBuilder

+ func (fb *FieldBuilder) Lower() *FieldBuilder

+ func (fb *FieldBuilder) Max(v float64) *FieldBuilder

+ func (fb *FieldBuilder) MaxItems(n int) *FieldBuilder

+ func (fb *FieldBuilder) MaxLength(n int) *FieldBuilder

+ func (fb *FieldBuilder) Message(msg string) *FieldBuilder

+ func (fb *FieldBuilder) Meta(m map[string]any) *FieldBuilder

+ func (fb *FieldBuilder) Min(v float64) *FieldBuilder

+ func (fb *FieldBuilder) MinItems(n int) *FieldBuilder

+ func (fb *FieldBuilder) MinLength(n int) *FieldBuilder

+ func (fb *FieldBuilder) MultipleOf(of float64) *FieldBuilder

+ func (fb *FieldBuilder) Name(n string) *FieldBuilder

+ func (fb *FieldBuilder) Negative() *FieldBuilder

+ func (fb *FieldBuilder) New(opts ...Option) (*Schematics, error)

+ func (fb *FieldBuilder) NonNegative() *FieldBuilder

+ func (fb *FieldBuilder) NotEmpty() *FieldBuilder

+ func (fb *FieldBuilder) NotInOptions(opts ...string) *FieldBuilder

+ func (fb *FieldBuilder) Op(name string, args Args) *FieldBuilder

+ func (fb *FieldBuilder) Pattern(p string) *FieldBuilder

+ func (fb *FieldBuilder) Positive() *FieldBuilder

+ func (fb *FieldBuilder) Regex() *FieldBuilder

+ func (fb *FieldBuilder) Replace(old, new string) *FieldBuilder

+ func (fb *FieldBuilder) Required() *FieldBuilder

+ func (fb *FieldBuilder) Rule(name string, args Args) *FieldBuilder

+ func (fb *FieldBuilder) Schema() Schema

+ func (fb *FieldBuilder) Slugify() *FieldBuilder

+ func (fb *FieldBuilder) StartsWith(prefix string) *FieldBuilder

+ func (fb *FieldBuilder) Tags(tags ...string) *FieldBuilder

+ func (fb *FieldBuilder) ToString() *FieldBuilder

+ func (fb *FieldBuilder) Trim() *FieldBuilder

+ func (fb *FieldBuilder) Truncate(length int, suffix string) *FieldBuilder

+ func (fb *FieldBuilder) Type(t string) *FieldBuilder

+ func (fb *FieldBuilder) Unique() *FieldBuilder

+ func (fb *FieldBuilder) Upper() *FieldBuilder

+ func (fb *FieldBuilder) When(condition string, args Args) *FieldBuilder

+ func (fb *FieldBuilder) WhenAbsent(field string) *FieldBuilder

+ func (fb *FieldBuilder) WhenEquals(field string, value any) *FieldBuilder

+ func (fb *FieldBuilder) WhenNot(condition string, args Args) *FieldBuilder

+ func (fb *FieldBuilder) WhenPresent(field string) *FieldBuilder

type Option

+ func WithCollectAll() Option

+ func WithMaxBodyBytes(n int64) Option

+ func WithTypeChecks() Option

+ type SchemaBuilder struct

+ func NewSchema() *SchemaBuilder

+ func (b *SchemaBuilder) ArrayIDKey(k string) *SchemaBuilder

+ func (b *SchemaBuilder) DB(m map[string]any) *SchemaBuilder

+ func (b *SchemaBuilder) Field(target string) *FieldBuilder

+ func (b *SchemaBuilder) Locale(l string) *SchemaBuilder

+ func (b *SchemaBuilder) New(opts ...Option) (*Schematics, error)

+ func (b *SchemaBuilder) Schema() Schema

+ func (b *SchemaBuilder) Separator(sep string) *SchemaBuilder

type Schematics

+ func ImportSchema(b []byte, opts ...Option) (*Schematics, error)

+ func (s *Schematics) ValidateBytes(b []byte, isArray bool) error

+ func (s *Schematics) ValidateBytesCtx(ctx context.Context, b []byte, isArray bool) error

v1.0.1

Jul 23, 2026

Changes in this version

type Schematics

+ func (s *Schematics) ValidateSchema(sample any, ignoreTargets ...string) error

v1.0.0

Jul 22, 2026

v0

v0.0.1

Jul 19, 2026

Changes in this version

+ const Version

+ func Deflate(flat map[string]any, separator string) map[string]any

+ func Flatten(data map[string]any, separator string) map[string]any

+ type API struct

+ func NewAPI(opts ...Option) *API

+ func (a *API) Base() *Schematics

+ func (a *API) LoadBytes(b []byte) error

+ func (a *API) LoadFile(path string) error

+ func (a *API) ValidateRequest(r *http.Request) error

+ type APIEndpoint struct

+ Body []Field

+ Headers []Field

+ Method string

+ Path string

+ Query []Field

+ type APIGlobal struct

+ Headers []Field

+ type APISchema struct

+ Endpoints []APIEndpoint

+ Global APIGlobal

+ Separator string

+ Version string

+ type Args map[string]any

+ func (a Args) Bool(key string) (bool, error)

+ func (a Args) Float(key string) (float64, error)

+ func (a Args) FloatOr(key string, def float64) float64

+ func (a Args) Get(key string) (any, bool)

+ func (a Args) Has(key string) bool

+ func (a Args) Int(key string) (int, error)

+ func (a Args) String(key string) (string, error)

+ func (a Args) StringOr(key, def string) string

+ func (a Args) Strings(key string) ([]string, error)

+ type Condition func(args Args, ctx *Context) bool

+ type ConditionRef struct

+ Args Args

+ Condition string

+ Negate bool

+ type Context struct

+ Ctx context.Context

+ DB map[string]any

+ Field *FieldView

+ Flat map[string]any

+ Locale string

+ RowID string

+ Separator string

+ func (c *Context) FieldPresent(target string) bool

+ func (c *Context) Lookup(target string) (any, bool)

+ type Field struct

+ AddToDB bool

+ DependsOn []string

+ Description string

+ DisplayName string

+ Meta map[string]any

+ Name string

+ Operate []OperatorRef

+ Required bool

+ Tags []string

+ Target string

+ TargetRegex bool

+ Type string

+ Validate []RuleRef

+ When []ConditionRef

+ type FieldView struct

+ Name string

+ Provided bool

+ Required bool

+ Tags []string

+ Target string

+ Type string

+ type Operator func(value any, args Args, ctx *Context) (any, error)

+ type OperatorRef struct

+ Args Args

+ Op string

+ type Option func(*Schematics)

+ func WithArrayIDKey(key string) Option

+ func WithDB(db map[string]any) Option

+ func WithLocale(locale string) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithSeparator(sep string) Option

+ type Rule func(value any, args Args, ctx *Context) error

+ type RuleRef struct

+ Args Args

+ Message string

+ Messages map[string]string

+ Rule string

+ type Schema struct

+ ArrayIDKey string

+ DB map[string]any

+ Fields []Field

+ Locale string

+ Separator string

+ Version string

+ type SchemaError struct

+ Problems []string

+ func (e *SchemaError) Error() string

+ type Schematics struct

+ func New(opts ...Option) *Schematics

+ func (s *Schematics) Check() error

+ func (s *Schematics) ConditionNames() []string

+ func (s *Schematics) LoadBytes(b []byte) error

+ func (s *Schematics) LoadFile(path string) error

+ func (s *Schematics) LoadMap(m any) error

+ func (s *Schematics) Operate(data any) (any, error)

+ func (s *Schematics) OperateCtx(ctx context.Context, data any) (any, error)

+ func (s *Schematics) OperatorNames() []string

+ func (s *Schematics) RegisterCondition(name string, fn Condition) *Schematics

+ func (s *Schematics) RegisterOperator(name string, fn Operator) *Schematics

+ func (s *Schematics) RegisterRule(name string, fn Rule) *Schematics

+ func (s *Schematics) RuleNames() []string

+ func (s *Schematics) Schema() Schema

+ func (s *Schematics) SetSchema(schema Schema) *Schematics

+ func (s *Schematics) Validate(data any) error

+ func (s *Schematics) ValidateCtx(ctx context.Context, data any) error

+ type ValidationError struct

+ RowID string

+ Rule string

+ Target string

+ Value any

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) Format(locale, format string) string

+ func (e *ValidationError) MarshalJSON() ([]byte, error)

+ func (e *ValidationError) Message(locale string) string

+ type ValidationErrors struct

+ Errors []*ValidationError

+ func (es *ValidationErrors) Add(e *ValidationError)

+ func (es *ValidationErrors) Error() string

+ func (es *ValidationErrors) ForTarget(target string) []*ValidationError

+ func (es *ValidationErrors) HasErrors() bool

+ func (es *ValidationErrors) Len() int

+ func (es *ValidationErrors) Messages(locale string) []string

+ func (es *ValidationErrors) Strings(locale, format string) []string

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