restserver

type CustomAuthenticationMiddleware interface {
	Apply(ctx WebContext) (*security.AuthenticationContext, error)
}

type CustomMiddleware interface {
	Apply(ctx WebContext) *MiddlewareError
}

type Error struct {
	Error string `json:"error"`
}

type MiddlewareError struct {
	Err        error `json:"error"`
	StatusCode int   `json:"statusCode"`
}

type RequestTest struct {
	// Method http method
	Method string
	// Url to call in test
	Url string
	// Path to register endpoint
	Path string
	// Request headers
	Headers map[string]string
	// Body request
	Body string
	// UploadFile file to upload in multipart form file
	UploadFile *os.File
	// FormFileField field name
	FormFileField string
	// FormFileName file name
	FormFileName string
}

type Route struct {
	// URI specifies the path or endpoint for the route in the HTTP router.
	URI string
	// Method defines the HTTP method (e.g., GET, POST) associated with the route.
	Method string
	// Prefix specifies a common prefix for the routes.
	Prefix RoutePrefix
	// Function defines the handler function to be executed when the route is accessed.
	Function func(ctx WebContext)
	// BeforeEnter is a middleware function executed before entering the route handler; returns MiddlewareError for failures.
	BeforeEnter func(ctx WebContext) *MiddlewareError
}

type RoutePrefix string

type Server interface {
	// contains filtered or unexported methods
}

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

type WebContext interface {
	// Context returns the call context
	Context() context.Context
	// AuthenticationContext returns a pointer of authentication context if exists
	AuthenticationContext() *security.AuthenticationContext

	//RequestHeader returns a slice of http request header for a key
	RequestHeader(key string) []string
	// RequestHeaders returns a slice of http request header by key
	RequestHeaders() map[string][]string
	// PathParam returns a url path param for a key
	PathParam(key string) string
	// QueryParam returns a url query param for key
	QueryParam(key string) string
	// QueryArrayParam returns a url query array param for key
	QueryArrayParam(key string) []string
	// DecodeQueryParams converts all url query params into structured object
	DecodeQueryParams(object any) error
	// DecodeBody converts http request body into a structured object
	DecodeBody(object any) error
	// DecodeFormData converts http request form data into a structured object
	DecodeFormData(object any) error
	// StringBody return request raw body
	StringBody() (string, error)
	// Path return request path
	Path() string
	// FormFile returns the first file for the provided form key.
	FormFile(key string) (multipart.File, *multipart.FileHeader, error)
	// FormValue returns the first value for the provided form key.
	FormValue(key string) string

	// AddHeader add header into http response
	AddHeader(key string, value string)
	// AddHeaders add a map of headers into an http response
	AddHeaders(headers map[string]string)
	// Redirect http response with redirect headers
	Redirect(url string, statusCode int)
	// ServeFile serve a file into http response
	ServeFile(path string)
	// JsonResponse converts any object on JSON http response body
	JsonResponse(statusCode int, body any)
	// ErrorResponse converts any error on structured error http JSON response body
	ErrorResponse(statusCode int, err error)
	// EmptyResponse returns empty http json response body
	EmptyResponse(statusCode int)
}