middleware

type CORSConfig struct {

	// AllowedOrigins is the list of origins that are allowed to access the resource.
	// Default: `[]string{"*"}`
	//
	// This field is optional.
	AllowedOrigins []string

	// AllowedMethods is the list of methods that are allowed to access the resource.
	// Default: `[]string{"GET", "POST", "PUT", "DELETE", "OPTIONS"}`
	//
	// This field is optional.
	AllowedMethods []string

	// AllowedHeaders is the list of headers that are allowed to access the resource.
	// Default: `[]string{"Content-Type", "Content-Length", "Accept-Encoding", "X-CSRF-Token", "Authorization
	// "accept", "origin", "Cache-Control", "X-Requested-With"}`
	//
	// This field is optional.
	AllowedHeaders []string

	// AllowCredentials is the flag that determines if the resource allows credentials.
	// Default: `false`
	//
	// This field is optional.
	AllowCredentials bool
}

type JWTClaims struct {
	jwt.StandardClaims
	XUserID uuid.UUID `json:"x-user-id"`
}

type JWTConfig struct {

	// Prefix is the type of the JWT.
	// Default: `Bearer`
	//
	// This field is optional.
	Prefix string

	// Algorithm is the algorithm of the key that will be used to validate the JWT.
	// Default: `HS256`
	//
	// This field is optional.
	Algorithm string

	// Issuer is the issuer of the JWT.
	// Default: “
	//
	// This field is optional.
	Issuer string

	// Audience is the audience of the JWT.
	// Default: “
	//
	// This field is optional.
	Audience string

	// Key is the secret key that will be used to validate the JWT.
	//
	// This field is mandatory.
	Key string

	// ExceptionalRoutes is the list of routes that will be excluded from the JWT validation.
	// For example, you can exclude the login route from the JWT validation.
	//
	// Example: []string{
	// 		"/login"
	// 		"/healthz"
	//	}
	//
	// This field is optional.
	ExceptionalRoutes []string

	// Header is the request header that will be used to extract the JWT from.
	// Default: `Authorization`
	//
	// This field is optional.
	Header string
}

type Key string

type LoggingConfig struct {

	// Logger is the `log/slog` instance that will be used to log messages.
	// Default: `slog.DefaultLogger`
	//
	// This field is optional.
	Logger *slog.Logger

	// LogLatency is the flag that determines if the latency of the request should be logged.
	// Latency is calculated as the difference between the time the request is received and the time the response is sent.
	// Default: `false`
	//
	// This field is optional.
	LogLatency bool

	// LogError is the flag that determines if the response status is 5xx then the error message should be logged.
	// Default: `false`
	//
	// This field is optional.
	LogError bool
}

type Middleware func(http.Handler) http.Handler

type RecoverConfig struct {

	// Logger is the `log/slog` instance that will be used to log messages.
	// Default: nil
	//
	// This field is optional.
	Logger *slog.Logger
}

type WebhookConfig struct {

	// Token is the unique token that will be used to authenticate the request.
	//
	// This field is mandatory.
	Token string
}