http

type Context interface {
	fiber.Ctx
	// CTX returns the underlying [fiber.Ctx].
	CTX() fiber.Ctx
	// Proxy returns the proxy API.
	Proxy() *Proxy
	// Failure writes a failure response.
	Failure(rst any) error
	// Success writes a success response.
	Success(data ...any) error
	// StdRequest returns the equivalent [http.Request] (net/http).
	StdRequest() *http.Request
}

type CorsOptions struct {
	Enable              bool     `json:"enable"`              // Whether CORS is enabled
	AllowOrigins        []string `json:"allowOrigins"`        // Allowed request origins. Defaults to [], which allows every origin
	AllowMethods        []string `json:"allowMethods"`        // Allowed request methods. Defaults to ["GET", "POST", "HEAD", "PUT", "DELETE", "PATCH"]
	AllowHeaders        []string `json:"allowHeaders"`        // Allowed request headers. Defaults to [], which allows every header
	AllowCredentials    bool     `json:"allowCredentials"`    // When every origin is allowed, credentials are not permitted by the CORS specification. Defaults to false
	ExposeHeaders       []string `json:"exposeHeaders"`       // Headers exposed to the client. Defaults to [], which exposes every header
	MaxAge              int      `json:"maxAge"`              // Time for which the browser caches the preflight request result. Defaults to 0
	AllowPrivateNetwork bool     `json:"allowPrivateNetwork"` // Whether requests from private networks are allowed. When true, the Access-Control-Allow-Private-Network response header is set to true. Defaults to false
}

type Handler = func(ctx Context) error

type Option func(o *options)

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

type ProxyOptions struct {
	ProxyHeader string            `json:"proxyHeader"` // Proxy header; defaults to X-Forwarded-For
	TrustProxy  TrustProxyOptions `json:"trustProxy"`  // Trusted proxy configuration
}

type Resp struct {
	Code    int    `json:"code"`              // Response code
	Message string `json:"message"`           // Response message
	Details string `json:"details,omitempty"` // Response details
	Data    any    `json:"data,omitempty"`    // Response data
}

type Router interface {
	// Get registers a handler for GET requests.
	Get(path string, handlers ...any) Router
	// Post registers a handler for POST requests.
	Post(path string, handlers ...any) Router
	// Head registers a handler for HEAD requests.
	Head(path string, handlers ...any) Router
	// Put registers a handler for PUT requests.
	Put(path string, handlers ...any) Router
	// Delete registers a handler for DELETE requests.
	Delete(path string, handlers ...any) Router
	// Connect registers a handler for CONNECT requests.
	Connect(path string, handlers ...any) Router
	// Options registers a handler for OPTIONS requests.
	Options(path string, handlers ...any) Router
	// Trace registers a handler for TRACE requests.
	Trace(path string, handlers ...any) Router
	// Patch registers a handler for PATCH requests.
	Patch(path string, handlers ...any) Router
	// All registers a handler for every method.
	All(path string, handlers ...any) Router
	// Add registers route handlers for the given methods.
	Add(methods []string, path string, handlers ...any) Router
	// Group returns a route group.
	Group(prefix string, middlewares ...any) Router
}

type Server struct {
	component.Base
	// contains filtered or unexported fields
}

type SwagOptions struct {
	Enable           bool   `json:"enable"`           // Whether Swagger is enabled
	Title            string `json:"title"`            // Document title
	FilePath         string `json:"filePath"`         // Document path
	BasePath         string `json:"basePath"`         // Access path
	SwaggerBundleUrl string `json:"swaggerBundleUrl"` // swagger-ui-bundle.js URL
	SwaggerPresetUrl string `json:"swaggerPresetUrl"` // swagger-ui-standalone-preset.js URL
	SwaggerStylesUrl string `json:"swaggerStylesUrl"` // swagger-ui.css URL
}

type TrustProxyOptions struct {
	Enable    bool     `json:"enable"`    // Whether it is enabled; defaults to false
	Proxies   []string `json:"proxies"`   // Proxies is the list of trusted proxy IP addresses or CIDR ranges
	LinkLocal bool     `json:"linkLocal"` // Whether all link-local IP ranges are trusted (for example 169.254.0.0/16, fe80::/10)
	Loopback  bool     `json:"loopback"`  // Whether all loopback IP ranges are trusted (for example 127.0.0.0/8, ::1/128)
	Private   bool     `json:"private"`   // Whether all private IP ranges are trusted (for example 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7)
}