internals

type Ctx interface {
	// Get a value from the context
	Get(key string) any
	// Deprecated: Use Ctx.AddIssue() instead
	// Please don't depend on this interface it may change
	NewError(p *PathBuilder, e ZogIssue)
	// Adds an issue to the schema execution.
	AddIssue(e ZogIssue)
	// Please don't depend on this interface it may change
	HasErrored() bool
}

type DataProvider interface {
	Get(key string) any
	GetNestedProvider(key string) DataProvider
	GetUnderlying() any // returns the underlying value the dp is wrapping
}

type DpFactory = func() (DataProvider, ZogIssue)

type EmptyDataProvider struct {
	Underlying any
}

type ErrsList struct {
	List ZogIssueList
}

type ErrsMap struct {
	M ZogIssueMap
}

type ExecCtx struct {
	Fmter  IssueFmtFunc
	Errors ZogIssues
	// contains filtered or unexported fields
}

type IsZeroValueFunc = func(val any, ctx Ctx) bool

type IssueFmtFunc = func(e ZogError, p Ctx)

type LengthCapable[K any] interface {
	~[]any | ~[]K | string | map[any]any | ~chan any
}

type MapDataProvider[T any] struct {
	M map[string]T
}

type PathBuilder []string

type PostTransform = func(dataPtr any, ctx Ctx) error

type PreTransform = func(data any, ctx Ctx) (out any, err error)

type SchemaCtx struct {
	*ExecCtx
	Val       any
	DestPtr   any
	Path      *PathBuilder
	DType     zconst.ZogType
	CanCatch  bool
	HasCaught bool
}

type Test struct {
	IssueCode    zconst.ZogIssueCode
	IssuePath    string
	Params       map[string]any
	IssueFmtFunc IssueFmtFunc
	ValidateFunc TestFunc
}

type TestCtx struct {
	*SchemaCtx
	Test *Test
}

type TestFunc = func(val any, ctx Ctx) bool

type ZogErr struct {
	C       zconst.ZogIssueCode // error code
	EPath   string              // path of the value that caused the error
	ParamsM map[string]any      // params for the error (e.g. min, max, len, etc)
	Typ     string              // destination type
	Val     any                 // value that caused the error
	Msg     string              // human readable message
	Err     error               // the underlying error
}

type ZogError = ZogIssue

type ZogIssue interface {
	// returns the error code for the error. This is a unique identifier for the Issue. Generally also the ID for the Test that caused the error.
	Code() zconst.ZogIssueCode

	// Sets the error code for the Issue. This is a unique identifier for the Issue. Generally also the ID for the Test that caused the error.
	SetCode(zconst.ZogIssueCode) ZogIssue

	// returns the path of the Issue. This is the path of the value that caused the Issue.
	Path() string

	// Sets the path of the Issue. This is the path of the value that caused the Issue.
	SetPath(string) ZogIssue

	// returns the data value that caused the Issue.
	// if using Schema.Parse(data, dest) then this will be the value of data.
	Value() any

	// Deprecated: Use SetValue() instead
	// Sets the data value that caused the Issue.
	// if using Schema.Parse(data, dest) then this will be the value of data.
	SValue(any) ZogIssue

	// Sets the data value that caused the Issue.
	// if using Schema.Parse(data, dest) then this will be the value of data.
	SetValue(any) ZogIssue

	// Returns destination type. i.e The zconst.ZogType of the value that was validated.
	// if Using Schema.Parse(data, dest) then this will be the type of dest.
	Dtype() string

	// Deprecated: Use SetDType() instead
	// Sets destination type. i.e The zconst.ZogType of the value that was validated.
	// if Using Schema.Parse(data, dest) then this will be the type of dest.
	SDType(zconst.ZogType) ZogIssue

	// Sets destination type. i.e The zconst.ZogType of the value that was validated.
	// if Using Schema.Parse(data, dest) then this will be the type of dest.
	SetDType(zconst.ZogType) ZogIssue

	// returns the params map for the error. Taken from the Test that caused the error. This may be nil if Test has no params.
	Params() map[string]any

	// Deprecated: Use SetParams() instead
	// Sets the params map for the error. Taken from the Test that caused the error. This may be nil if Test has no params.
	SParams(map[string]any) ZogIssue
	// Sets the params map for the error. Taken from the Test that caused the error. This may be nil if Test has no params.
	SetParams(map[string]any) ZogIssue
	// returns the human readable, user-friendly message for the error. This is safe to expose to the user.
	Message() string
	// sets the human readable, user-friendly message for the error. This is safe to expose to the user.
	SetMessage(string)
	// returns the string representation of the ZogIssue (same as String())
	Error() string
	// Sets the wrapped error.
	SetError(error) ZogIssue
	// returns the wrapped error or nil if none
	Unwrap() error
	// returns the string representation of the ZogIssue (same as Error())
	String() string
}

type ZogIssueList = []ZogError

type ZogIssueMap = map[string][]ZogError

type ZogIssues interface {
	Add(path string, err ZogError)
	IsEmpty() bool
	Free()
}

type ZogPrimitive interface {
	~string | ~bool | time.Time | constraints.Ordered
}