webfmwk

type Address struct {
	// TLS implement IAddress, tlsConfig  implement the TLSConfig interface.
	TLS  *tls.Config `json:"tls,omitempty" mapstructure:"tls,omitempty"`
	Addr string      `json:"addr"`
	Name string      `json:"name"`
}

type Addresses []Address

type Context interface {
	SendResponse
	InputHandling
	ContextLogger

	// GetFastContext return a pointer to the internal fasthttp.RequestCtx.
	GetFastContext() *fasthttp.RequestCtx

	// GetContext return the request context.Context.
	GetContext() context.Context

	// GetVar return the url var parameters. An empty string for missing case.
	GetVar(key string) (val string)

	// GetQueries return the queries into a fasthttp.Args object.
	GetQuery() *fasthttp.Args
}

type ContextLogger interface {
	// SetStructuredLogger set context' structured logger.
	SetStructuredLogger(logger *slog.Logger) Context

	// GetStructuredLogger return context' structured logger.
	GetStructuredLogger() *slog.Logger
}

type DocHandler struct {
	// H hold the doc Handler to expose.
	H HandlerFunc

	// Name is used in debug message.
	Name string

	// Path hold the URI one which the handler is reachable.
	// If a prefix is setup, the path will prefixed.
	Path string
}

type Error struct {

	// Message hold the error message.
	//
	// Example: the impossible appened
	Message string `json:"message" example:"no such resource" validate:"required"`

	// Status hold the error code status.
	//
	// Example: 500
	Status int `json:"status" validate:"required"`
	// contains filtered or unexported fields
}

type ErrorHandled interface {
	// Error implelement the Error interface.
	Error() string

	// GetOPCode return the http status code response associated to the error.
	GetOPCode() int

	// SetStatusCode set the error associated http status code.
	SetStatusCode(op int) ErrorHandled

	// GetContent return the error http response content.
	GetContent() interface{}
}

type ErrorValidation map[string]string

type FastLogger struct{ *slog.Logger }

type Handler func(HandlerFunc) HandlerFunc

type HandlerFunc func(c Context) error

type Header [2]string

type IAddress interface {
	fmt.Stringer

	// GetAddr return the listing address.
	GetAddr() string

	// GetTLS return a pointer to an TLSConfig if present, nil otherwise.
	GetTLS() tls.IConfig

	// GetName return the name of the address, for debug purpose.
	GetName() string

	// IsOk validate that the Address structure have at least the address field populated.
	IsOk() bool

	// IsUnixPath return true if the address is a valid unix socket path.
	IsUnixPath() bool

	// SameAs return true if both config are identique.
	SameAs(in IAddress) bool
}

type InputHandling interface {
	// FetchContent extract the json content from the body into the content interface.
	FetchContent(content interface{}) ErrorHandled

	// Validate is used to validate a content of the content params.
	// See https://go-playground/validator.v10 for more.
	Validate(content interface{}) ErrorHandled

	// FetchAndValidateContent fetch the content then validate it.
	FetchAndValidateContent(content interface{}) ErrorHandled

	// DecodeQP load the query param in the content object.
	// Seee https://github.com/gorilla/query for more.
	DecodeQP(content interface{}) ErrorHandled

	// DecodeAndValidateQP load the query param in the content object and then validate it.
	DecodeAndValidateQP(content interface{}) ErrorHandled
}

type JSONHTTPResponse interface {
	// JSONOk return the interface with an http.StatusOK (200).
	JSONOk(content interface{}) error

	// JSONCreated return the interface with an http.StatusCreated (201).
	JSONCreated(content interface{}) error

	// JSONAccepted return the interface with an http.StatusAccepted (202).
	JSONAccepted(content interface{}) error

	// JSONNoContent return an empty payload an http.StatusNoContent (204).
	JSONNoContent() error

	// JSONBadRequest return the interface with an http.StatusBadRequest (400).
	JSONBadRequest(content interface{}) error

	// JSONUnauthorized return the interface with an http.StatusUnauthorized (401).
	JSONUnauthorized(content interface{}) error

	// JSONForbiden return the interface with an http.StatusForbidden (403).
	JSONForbidden(content interface{}) error

	// JSONNoContent return the interface with an http.StatusNotFound (404).
	JSONNotFound(content interface{}) error

	// JSONMethodNotAllowed return the interface with an http.NotAllowed (405).
	JSONMethodNotAllowed(content interface{}) error

	// JSONConflict return the interface with an http.StatusConflict (409).
	JSONConflict(content interface{}) error

	// JSONUnauthorized return the interface with an http.StatusUnprocessableEntity (422).
	JSONUnprocessable(content interface{}) error

	// JSONInternalError return the interface with an http.StatusInternalServerError (500).
	JSONInternalError(content interface{}) error

	// JSONNotImplemented return the interface with an http.StatusNotImplemented (501).
	JSONNotImplemented(content interface{}) error
}

type JSONResponse interface {
	JSONHTTPResponse

	// JSONBlob answer the JSON content with the status code op.
	JSONBlob(op int, content []byte) error

	// JSON answer the JSON content with the status code op.
	JSON(op int, content interface{}) error
}

type Option func(s *Server)

type Options []Option

type Response struct {
	// Message hold the error message.
	//
	// Example: action successfully completed
	Message string `json:"content,omitempty"`

	// Status hold the error code status.
	//
	// Example: 200
	Status int `json:"status" example:"204" validate:"required"`
}

type Route struct {
	// Handler hold the exposed Handler method.
	Handler HandlerFunc `json:"-"`

	// Verbe hold the verbe at which the handler is reachable.
	Verbe string `json:"verbe"`

	// Path hold the uri at which the handler is reachable.
	// If a prefix is setup, the path will be prefixed.
	Path string `json:"path"`

	// Name is used in message.
	Name string `json:"name"`

	Middlewares *[]Handler
}

type Routes []Route

type RoutesPerPrefix map[string]Routes

type SendResponse interface {
	JSONResponse

	// SendResponse create & send a response according to the parameters.
	SendResponse(op int, content []byte, headers ...Header) error

	// SetHeader set the header of the http response.
	SetHeaders(headers ...Header)

	// SetHeader set the k header to value v.
	SetHeader(k, v string)

	// SetContentType set the Content-Type to v.
	SetContentType(v string)

	// SetContentType set the Content-Type to v.
	SetStatusCode(code int)

	// IsPretty toggle the compact output mode.
	IsPretty() bool
}

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

type ValidationError struct {
	Error  ErrorValidation `json:"message"`
	Status int             `json:"status"`
}

type Worker func()

type WorkerLauncher interface{ Start(Worker) }