vatel

May 29, 2025

Changes in this version

+ var ErrForbidden = errors.Template("forbidden").Code("VTL-0003").StatusCode(403).Severity(errors.Medium)

+ var ErrInternalError = errors.Template("internal error").Code("VTL-0005").StatusCode(500).Severity(errors.Critical)

+ var ErrInvalidRequestBody = errors.Template("invalid request body").Code("VTL-0007").StatusCode(400).Severity(errors.Tiny)

+ var ErrUnauthorized = errors.Template("unauthorized").Code("VTL-0004").StatusCode(401).Severity(errors.Medium)

+ var ErrValidationFailed = errors.Template("validation failed").Code("VTL-0006").StatusCode(400).Severity(errors.Tiny)

+ func ToClientJSON(err error) []byte

May 1, 2023

Changes in this version

+ func WithTokenDecoder(td TokenDecoder) func(*WsOption)

+ func WithWebsocketSupport(wv *WebsocketVatel) func(*Option)

+ type AccessTokenUpdateHandler struct

+ func (c *AccessTokenUpdateHandler) Handle(ctx WebsocketContext) error

+ func (c *AccessTokenUpdateHandler) Input() interface{}

+ func (c *AccessTokenUpdateHandler) Result() interface{}

+ type WebsocketRequest struct

+ Data json.RawMessage

+ Path string

+ type WebsocketVatel struct

+ func NewWebsocketVatel(optFunc ...func(*WsOption)) *WebsocketVatel

+ func (wv *WebsocketVatel) Endpoints() []Endpoint

+ func (wv *WebsocketVatel) UpdateAccessToken(cid uint64, token string) error

+ func (ww *WebsocketVatel) OnClose(f func(*websocket.Conn, error))

+ func (ww *WebsocketVatel) OnOpen(f func(*websocket.Conn))

+ func (ww *WebsocketVatel) RegisterEndpoint(v *Vatel, e *Endpoint, l *zerolog.Logger) error

+ func (ww *WebsocketVatel) Upgrade(ctx *fasthttp.RequestCtx)

+ func (ww *WebsocketVatel) UpgradeWithID(ctx *fasthttp.RequestCtx, id uint64)

Oct 31, 2022

Changes in this version

+ func WithAuthAccessOnly() func(*WsOption)

+ func WithLogger(log *zerolog.Logger) func(*WsOption)

+ type WebsocketConnection struct

+ func (c *WebsocketConnection) RawConnection() *websocket.Conn

type WebsocketWrapper

+ func NewWebsocketWrapper(optFunc ...func(*WsOption)) *WebsocketWrapper

+ func (dws *WebsocketWrapper) PingAll()

+ func (dws *WebsocketWrapper) Upgrade(ctx Context)

+ func (wg *WebsocketWrapper) TraverseAll(fn func(*WebsocketConnection) bool)

+ func (ww *WebsocketWrapper) Endpoints() []Endpoint

+ func (ww *WebsocketWrapper) RegisterEndpoint(v *Vatel, e *Endpoint, l *zerolog.Logger) error

+ func (ww *WebsocketWrapper) SetOnCloseCallback(fn func(cid uint64))

+ func (ww *WebsocketWrapper) Traverse(cids []uint64, fn func(*WebsocketConnection))

+ func (ww *WebsocketWrapper) Write(cids []uint64, data []byte)

+ type WsOption struct

Oct 30, 2022

Changes in this version

+ type AuthMessageData struct

+ AccessToken string

type Endpoint

+ WebsocketController func() WebsocketHandler

type Vatel

+ func (va *Vatel) AddWebsocketSupport(dws *WebsocketGateway)

+ type WebsocketContext interface

+ BodyWriter func() io.Writer

+ Created func() time.Time

+ Get func(key string) interface{}

+ ID func() uint64

+ Set func(key string, val interface{}) WebsocketContext

+ SetTokenPayload func(tp TokenPayloader)

+ TokenPayload func() TokenPayloader

+ VisitValues func(func(key []byte, val interface{}))

+ func NewWsContext(c *websocket.Conn) WebsocketContext

+ type WebsocketGateway struct

+ func NewWebsocketGateway(l *zerolog.Logger, va *Vatel, publicAccessAllowed bool) *WebsocketGateway

+ func (dws *WebsocketGateway) OnClose(c *websocket.Conn, err error)

+ func (dws *WebsocketGateway) PingAll()

+ func (dws *WebsocketGateway) Upgrade(ctx Context)

+ func (wg *WebsocketGateway) Auth(c *websocket.Conn, token []byte) error

+ func (wg *WebsocketGateway) Traverse(fn func(*WsCon) bool)

+ func (wsg *WebsocketGateway) Endpoints() []Endpoint

+ func (wsg *WebsocketGateway) OnOpen(c *websocket.Conn)

+ func (wsg *WebsocketGateway) RegisterEndpoint(v *Vatel, e *Endpoint, l *zerolog.Logger) error

+ type WebsocketHandler interface

+ Handle func(WebsocketContext) error

+ type WebsocketMessage struct

+ Data json.RawMessage

+ Path string

+ type WebsocketWrapper interface

+ MustRegisterEndpoint func(v *Vatel, e *Endpoint, l *zerolog.Logger) error

+ OnClose func(*websocket.Conn, error)

+ OnOpen func(*websocket.Conn)

+ type WsCon struct

+ func (c *WsCon) RawWC() *websocket.Conn

+ type WsContext struct

+ func (ctx *WsContext) BodyWriter() io.Writer

+ func (ctx *WsContext) Created() time.Time

+ func (ctx *WsContext) Get(key string) interface{}

+ func (ctx *WsContext) ID() uint64

+ func (ctx *WsContext) Set(key string, val interface{}) WebsocketContext

+ func (ctx *WsContext) SetTokenPayload(tp TokenPayloader)

+ func (ctx *WsContext) TokenPayload() TokenPayloader

+ func (ctx *WsContext) VisitValues(f func(key []byte, v interface{}))

Feb 22, 2022

Changes in this version

+ func WithMetricReporter(mr MetricReporter) func(*Option)

type Endpoint

+ SuccessStatusCode int

+ type MetricReporter interface

+ ReportMetric func(method, path string, statusCode int, dur float64, size int)

Jan 14, 2022

Changes in this version

+ func WithAlarmer(ala Alarmer) func(*Option)

+ func WithJsonMasker(jm JsonMasker) func(*Option)

+ type Alarmer interface

+ Alarm func(m map[string]interface{})

+ type JsonMasker interface

+ Fields func(structure interface{}, tag string) jsonmask.Fields

+ Mask func(src []byte, fields jsonmask.Fields) ([]byte, error)

Nov 13, 2021

Changes in this version

+ func WithRequestID() func(*Option)

+ type MiddlewarePos int

+ const AfterAuthorization

+ const BeforeAuthorization

+ const OnErrorResponse

+ const OnSuccessResponse

Nov 10, 2021

Changes in this version

+ func WithVerboseError() func(*Option)

Nov 10, 2021

Changes in this version

+ const LogConfidential

Nov 9, 2021

Changes in this version

+ const LogConfident

+ const LogFull

+ const LogFullOnExit

+ const LogUnknown

+ func WithDefaultLogOption(lo LogOption) func(*Option)

+ func WithStaticLoggingLevel() func(*Option)

+ func WithUrlPrefix(s string) func(*Option)

type Context

+ Get func(key string) interface{}

+ Set func(key string, val interface{}) *VatelContext

+ VisitUserValues func(func(key []byte, val interface{}))

type Endpoint

+ Compress bool

+ LogOptions LogOption

+ type LogOption uint32

+ const LogEnter

+ const LogExit

+ const LogReqBody

+ const LogReqInput

+ const LogRespBody

+ const LogRespOutput

+ const LogSilent

+ type Option struct

type VatelContext

+ func (ctx *VatelContext) Get(key string) interface{}

+ func (ctx *VatelContext) Set(key string, val interface{}) *VatelContext

+ func (ctx *VatelContext) VisitUserValues(f func(key []byte, v interface{}))

Nov 3, 2021

Changes in this version

type Vatel

+ func (v *Vatel) SetRevokeTokenChecker(rtc RevokeTokenChecker)

Oct 31, 2021

Changes in this version

type TokenPayloader

+ Debug func() bool

Oct 11, 2021

Changes in this version

type Endpoint

+ SuppressLog bool

Oct 5, 2021

Changes in this version

+ var ErrAccessTokenRevoked = errors.New("access token revoked").Code("VTL-0002").StatusCode(401).Critical()

+ var ErrAuthorizationHeaderMissed = errors.New("header Authorization missed").Code("VTL-0001").StatusCode(401).Critical()

type Endpoint

+ ManualStatusCode bool

+ func NewEndpoint(method, path string, perms []string, c func() Handler) *Endpoint

+ type RevokeTokenChecker interface

+ IsTokenRevoked func(accessToken string) (bool, error)

type Vatel

+ func (v *Vatel) AddMiddleware(f ...func(Context) error)

+ func (v *Vatel) NotFoundHandler(f func(Context) error)

+ func (v *Vatel) SetRevokeTokenCheker(rtc RevokeTokenChecker)

Sep 9, 2021

Changes in this version

+ type Dater interface

+ Parse func(string) (interface{}, error)

+ Set func(interface{})

Jul 30, 2021

Changes in this version

type Context

+ RequestCtx func() *fasthttp.RequestCtx

type VatelContext

+ func (ctx *VatelContext) RequestCtx() *fasthttp.RequestCtx

Jan 17, 2021

Changes in this version

+ type Authorizer interface

+ IsAllowed func(requestPerms []byte, endpointPerms ...uint) (bool, error)

+ type Context interface

+ BodyWriter func() io.Writer

+ FormFile func(key string) (*multipart.FileHeader, error)

+ FormValue func(key string) []byte

+ Header func(name string) []byte

+ Log func(key string, val interface{}) *VatelContext

+ LogValues func() map[string]interface{}

+ SaveMultipartFile func(fh *multipart.FileHeader, path string) error

+ SetContentType func([]byte) *VatelContext

+ SetHeader func(name, val []byte) *VatelContext

+ SetStatusCode func(code int) *VatelContext

+ SetTokenPayload func(tp TokenPayloader)

+ TokenPayload func() TokenPayloader

+ func NewContext(ctx *fasthttp.RequestCtx) Context

+ type Endpoint struct

+ Controller func() Handler

+ LanguageLabel string

+ Method string

+ NoInputLog bool

+ NoResultLog bool

+ Path string

+ Perms []string

+ ResponseContentType string

+ func NewEnpoint(method, path string, perms []string, c func() Handler) *Endpoint

+ type Endpointer interface

+ Endpoints func() []Endpoint

+ type Error struct

+ func (ce *Error) JSON() interface{}

+ func (ce *Error) MarshalZerologObject(e *zerolog.Event)

+ type Handler interface

+ Handle func(Context) error

+ type Inputer interface

+ Input func() interface{}

+ type Logger interface

+ Log func()

+ type Paramer interface

+ Param func() interface{}

+ type PermissionManager interface

+ PermissionBitPos func(perm string) (uint, bool)

+ type RequestDebugger interface

+ IsDebugRequired func(TokenPayloader) (in, out bool)

+ type Resulter interface

+ Result func() interface{}

+ type TokenDecoder interface

+ Decode func(encodedToken []byte) (Tokener, error)

+ type TokenPayloader interface

+ Extra func() interface{}

+ Login func() string

+ Perms func() []byte

+ Role func() int

+ User func() int

+ type Tokener interface

+ ApplicationPayload func() TokenPayloader

+ SystemPayload func() map[string]interface{}

+ type Vatel struct

+ func NewVatel(urlprefix string) *Vatel

+ func (v *Vatel) Add(cs Endpointer)

+ func (v *Vatel) BuildHandlers(mux *router.Router, l *zerolog.Logger) error

+ func (v *Vatel) DisableAuthorizer()

+ func (v *Vatel) Endpoints() []Endpoint

+ func (v *Vatel) MustBuildHandlers(mux *router.Router, l *zerolog.Logger)

+ func (v *Vatel) Set(key, value string)

+ func (v *Vatel) SetAuthorizer(a Authorizer)

+ func (v *Vatel) SetPermissionManager(pm PermissionManager)

+ func (v *Vatel) SetRequestDebugger(rd RequestDebugger)

+ func (v *Vatel) SetTokenDecoder(tp TokenDecoder)

+ type VatelContext struct

+ func (ctx *VatelContext) BodyWriter() io.Writer

+ func (ctx *VatelContext) FormFile(key string) (*multipart.FileHeader, error)

+ func (ctx *VatelContext) FormValue(key string) []byte

+ func (ctx *VatelContext) Header(name string) []byte

+ func (ctx *VatelContext) Log(key string, val interface{}) *VatelContext

+ func (ctx *VatelContext) LogValues() map[string]interface{}

+ func (ctx *VatelContext) SaveMultipartFile(fh *multipart.FileHeader, path string) error

+ func (ctx *VatelContext) SetContentType(contentType []byte) *VatelContext

+ func (ctx *VatelContext) SetHeader(name, val []byte) *VatelContext

+ func (ctx *VatelContext) SetStatusCode(code int) *VatelContext

+ func (ctx *VatelContext) SetTokenPayload(tp TokenPayloader)

+ func (ctx *VatelContext) TokenPayload() TokenPayloader