bolt

type BodyCtx interface {
	// Parse the request body to any by the Content-Type header
	Parse(v any) error
	// ParseJSON parses the request body as JSON
	ParseJSON(v any) error
	// ParseXML parses the request body as XML
	ParseXML(v any) error
	// ParseForm parses the request body as form
	ParseForm(v any) error
	// File returns a file from the request
	File(name string, maxSize ...int) (multipart.File, *multipart.FileHeader, error)
}

type Bolt struct {
	CompleteRouter
	// contains filtered or unexported fields
}

type BoltHook int

type CompleteRouter interface {
	Router
	RouterParamValidator
	// Dump writes the routes to the console.
	Dump()
	// contains filtered or unexported methods
}

type Config struct {
	// ErrorHandler handles the request errors
	ErrorHandler func(c Ctx, err error) error
	// NotFoundHandler handles the not found requests
	NotFoundHandler func(c Ctx) error
	// Mode is the application mode
	// default is development
	Mode Mode

	Views     *ViewConfig
	Session   *SessionConfig
	Websocket *WSConfig
}

type CookieCtx interface {
	// Get returns a cookie by name
	Get(name string) (*http.Cookie, error)
	// Set sets a cookie
	Set(cookie *http.Cookie)
}

type Ctx interface {
	ID() string

	// Method returns the request method
	Method() string
	// URL returns the request URL
	URL() *url.URL
	// Path returns the request path
	Path() string
	// Params returns all route params
	Params() map[string]string
	// Param returns a route param by name
	Param(name string, defaultValue ...string) string
	// ParamInt returns a route param by name as int
	ParamInt(name string, defaultValue ...int) (int, error)

	// ResponseWriter returns the http.ResponseWriter
	ResponseWriter() http.ResponseWriter
	// Request returns the http.Request
	Request() *http.Request
	// Context returns the Request Context
	Context() context.Context
	// App returns the Bolt application
	App() *Bolt
	// IP returns the client IP
	IP() net.IP

	// Headers
	// Header returns a HeaderCtx to add response header and get request header
	Header() HeaderCtx
	// Cookie returns a CookieCtx to get and set cookies
	Cookie() CookieCtx
	// Session returns a SessionCtx to get and set session data (if session is enabled in the configuration)
	Session() SessionCtx
	// ContentType sets the response content type
	ContentType(t string) Ctx

	// Status sets the response status code
	Status(code int) Ctx
	// Send sends the output as a byte slice
	Send([]byte) error
	// SendString sends the output as a string
	SendString(s string) error
	// JSON sends the output as a JSON
	JSON(data any) error
	// XML sends the output as a XML
	XML(data any) error
	// SendFile sends a file as a response
	SendFile(path string) error
	// Pipe sends the output as a stream
	Pipe(pipe func(pw *io.PipeWriter)) error
	// Format sends the output in the format specified in the Accept header
	Format(data any) error
	// Redirect redirects the request to the specified URL
	Redirect(to string) error

	Spark(component spark.Component) error

	// Body returns a BodyCtx to parse the request body
	Body() BodyCtx

	// Get returns a stored value by key
	Get(key string) any
	// Set stores a value by key in the context (useful for middleware)
	// note: the value only exists in the current request
	Set(key string, value any)
	// Locals returns all stored values
	Locals() map[string]any
}

type EasyFastHandlerFunc func(c Ctx) (any, error)

type Error struct {
	// contains filtered or unexported fields
}

type HandlerFunc func(c Ctx) error

type HeaderCtx interface {
	// Add adds a header to the response
	Add(key, value string)
	// Get returns a header from the request
	Get(key string) string
}

type Map map[string]any

type MemoryStore struct {
	// contains filtered or unexported fields
}

type MiddlewareFunc func(c Ctx) (bool, error)

type Mode string

type Route interface {
	Name(name string)
	GetName() string
	Method() string
	Path() string
	NormalizedPaths() []string

	Handler() HandlerFunc
	Middlewares() []MiddlewareFunc
	// contains filtered or unexported methods
}

type RouteParamValidatorFunc func(value string) (string, error)

type RoutePart struct {
	Static     bool     `json:"static"`
	Value      string   `json:"value"`
	Validators []string `json:"validators,omitempty"`
}

type Router interface {
	// Get registers a new GET route for a path with matching handler and optional middlewares.
	Get(path string, handler HandlerFunc, middlewares ...MiddlewareFunc) Route
	// Post registers a new POST route for a path with matching handler and optional middlewares.
	Post(path string, handler HandlerFunc, middlewares ...MiddlewareFunc) Route
	// Put registers a new PUT route for a path with matching handler and optional middlewares.
	Put(path string, handler HandlerFunc, middlewares ...MiddlewareFunc) Route
	// Delete registers a new DELETE route for a path with matching handler and optional middlewares.
	Delete(path string, handler HandlerFunc, middlewares ...MiddlewareFunc) Route
	// Patch registers a new PATCH route for a path with matching handler and optional middlewares.
	Patch(path string, handler HandlerFunc, middlewares ...MiddlewareFunc) Route
	// Options registers a new OPTIONS route for a path with matching handler and optional middlewares.
	Options(path string, handler HandlerFunc, middlewares ...MiddlewareFunc) Route
	// All registers a new route for a path with matching handler and optional middlewares.
	All(path string, handler HandlerFunc, middlewares ...MiddlewareFunc) Route
	// Add registers a new route for a path with matching handler and optional middlewares.
	Add(method, path string, handler HandlerFunc, middlewares ...MiddlewareFunc) Route

	// WS registers a new WebSocket route for a path with matching handler and optional middlewares.
	// Note: WebSocket routes should have a different path then GET routes.
	WS(path string, handler WSHandlerFunc, middlewares ...MiddlewareFunc) Route

	// Group creates a new router group with a common prefix and optional middlewares.
	Group(prefix string, middlewares ...MiddlewareFunc) Router
}

type RouterParamValidator interface {
	// RouterParamValidator is an interface that allows you to register custom route parameter validators.
	// default validators: int, bool, uuid, alpha, alphanumeric.
	RegisterRouteParamValidator(name string, fn RouteParamValidatorFunc)
}

type SessionConfig struct {
	// Enabled is a flag to enable or disable the session
	// session is enabled by default
	Enabled bool
	// TokenFunc is a function to get the session token
	// by default it generates a new token if not exists, and stores it in a cookie named "session"
	TokenFunc func(c Ctx) (string, error)
	// TokenExpire is the session token expiration time
	// by default it is 12 hours
	// tokens are renewed at each modification
	TokenExpire time.Duration
	// Store is the session storage
	// by default it uses the MemStorage, an in-memory storage
	Store SessionStore
}

type SessionCtx interface {
	// Get returns a session value by key
	Get(key string) ([]byte, error)
	// Set sets a session value by key
	Set(key string, value []byte) error
	// Delete deletes a session value by key
	Delete(key string) error
	// Destroy destroys the session
	Destroy() error

	// From returns a session from another session id
	From(id string) SessionCtx
	// ID returns the session id
	ID() string
	// SetID sets the session id
	SetID(s string) SessionCtx
}

type SessionStore interface {
	Get(key string) ([]byte, error)
	Exists(key string) bool
	Set(key string, value []byte) error
	SetEx(key string, value []byte, expiry time.Duration) error
	Del(key string) error
}

type ViewConfig struct {
	Views *template.Template
}

type WSConfig struct {
	Timeout time.Duration

	AcceptOptions *websocket.AcceptOptions
}

type WSConn interface {
	Ctx() Ctx
	Conn() *websocket.Conn
	Close() error

	Send(data []byte) error
	SendJSON(v any) error
	// contains filtered or unexported methods
}

type WSHandlerFunc func(conn WSConn)

type WSMessageHandler func(s WSServer, conn WSConn, msg []byte) error

type WSServer interface {
	// AddConnection adds a new connection to the server.
	AddConn(conn WSConn)
	// RemoveConnection removes a connection from the server.
	RemoveConn(conn WSConn)
	// RemoveConnection removes a connection from the server.
	Broadcast(msg []byte)
	// BroadcastFunc sends a message to all connections that satisfy the condition.
	BroadcastFunc(msg []byte, fn func(conn WSConn) bool)
	// BroadcastTo sends a message to a specific connection.
	BroadcastTo(msg []byte, conns ...WSConn)

	// OnMessage sets the function to be called when a message is received.
	OnMessage(fn WSMessageHandler)

	// Close closes the server.
	Close() error
	// contains filtered or unexported methods
}