api

type CORSConfig struct {
	AllowOrigins     []string `yaml:"allow_origins"`
	AllowMethods     []string `yaml:"allow_methods"`
	AllowHeaders     []string `yaml:"allow_headers"`
	AllowCredentials bool     `yaml:"allow_credentials"`
	MaxAge           int      `yaml:"max_age"`
}

type ClientTLS struct {
	CertBundle certutil.CertBundle
	AuthType   tls.ClientAuthType
}

type Encoding string

type Endpoint struct {
	Protocol string
	Host     string
	Port     uint
	Path     string
}

type ErrorBody struct {
	Origin  error      `json:"-"`                // keep the original error to trace the stack
	Source  string     `json:"source,omitempty"` // source
	Status  int        `json:"status,omitempty"` // http status code
	Code    string     `json:"code,omitempty"`   // customized error code
	Kind    string     `json:"kind,omitempty"`   // error category
	Message string     `json:"message,omitempty"`
	Details labels.Set `json:"details,omitempty"`
}

type Middleware interface {
	common.Service
	// Func returns the middleware function for one attachment point. config is
	// the raw YAML written under the middleware's name, and nil when there is
	// none. Called once per attachment at registration time - and again on
	// restart, when routes are rebuilt - so per-route state lives in the
	// returned closure. An error fails registration; returning no function
	// and no error declines the attachment, and the server skips it.
	Func(config []byte) (func(echo.HandlerFunc) echo.HandlerFunc, error)
}

type RequestInfo struct {
	Server     string
	URI        string
	Method     string
	Path       string
	RawPath    string
	TraceID    string
	IP         string
	StartedAt  time.Time
	Permission string
	Poll       bool
}

type ResponseInfo struct {
	Status  int
	Took    time.Duration
	Size    uint64
	TraceID string
	Error   *ErrorBody
}

type Router interface {
	common.Service
	Config() []byte
	Handlers() map[string]any // echo.HandlerFunc or WebSocketHandlerFunc
}

type ServerTLS struct {
	CertBundle  certutil.CertBundle
	AuthEnabled bool
}

type Stats struct {
	RequestInfo
	ResponseInfo
}