nexus

type BaseEndpoint struct {
	RequestUtils  RequestUtils
	ResponseUtils ResponseUtils
	// contains filtered or unexported fields
}

type BaseWebsocket struct {
	Pool ClientPool
}

type ClientPool interface {
	Register(client WebsocketClient)
	Get(filter func(client WebsocketClient) bool) []WebsocketClient
}

type Config struct {
	ListenAddress       string
	Middlewares         []Middleware
	Endpoints           map[string][]Endpoint
	StaticFiles         http.FileSystem
	CrossOriginRequests CorsConfig
	Websockets          []Websocket
}

type CorsConfig struct {
	AllowedOrigins   []string
	AllowedMethods   []string
	AllowedHeaders   []string
	AllowCredentials bool
}

type Endpoint interface {
	Methods() []string
	GetRoute() string
	ExplicitMiddlewares() []string
	Handler(http.ResponseWriter, *http.Request) *HttpError
	Before(http.ResponseWriter, *http.Request) *HttpError
	After(http.ResponseWriter, *http.Request) *HttpError
	OnError(err *HttpError, w http.ResponseWriter, r *http.Request)
}

type HttpError struct {
	Status int
	Error  error
}

type Middleware interface {
	GetKey() string
	Execute(w http.ResponseWriter, r *http.Request) *HttpError
}

type RequestUtils interface {
	GetBearerToken(r *http.Request) string
	GetClientIP(r *http.Request) string
	GetPreferredLanguage(r *http.Request, supportedLanguages []string) string
	GetTraceID(r *http.Request) string
	GetHeaderValue(r *http.Request, name string) string
	GetUrlParam(r *http.Request, name string) string
	GetUrlParamInt(r *http.Request, name string, defaultValue int) int
	GetUrlParamBool(r *http.Request, name string, defaultValue bool) bool
	GetUrlParamFloat32(r *http.Request, name string, defaultValue float32) float32
	GetUrlParamFloat64(r *http.Request, name string, defaultValue float64) float64
	GetFormData(r *http.Request, name string) (string, fail.CustomError)
	GetRawBody(r *http.Request) ([]byte, fail.CustomError)
	GetJsonBody(r *http.Request, target any) fail.CustomError
}

type ResponseUtils interface {
	WritePlainText(status int, data string, w http.ResponseWriter) *HttpError
	WriteBytes(status int, data []byte, w http.ResponseWriter) *HttpError
	WriteJson(status int, data any, w http.ResponseWriter) *HttpError
	WriteEmpty(status int, w http.ResponseWriter) *HttpError
	WriteError(err *HttpError, w http.ResponseWriter)
}

type Runner interface {
	Start(config Config) fail.CustomError
}

type Websocket interface {
	GetRoute() string
	Handshake(w http.ResponseWriter, r *http.Request) *HttpError
	ClientConnect(client WebsocketClient) fail.CustomError
	CheckOrigin(r *http.Request) bool
	ReadBufferSize() int
	WriteBufferSize() int
	EnableCompression() bool
	Handle(data []byte, client WebsocketClient) fail.CustomError
}

type WebsocketClient interface {
	GetId() string
	Send(data []byte) fail.CustomError
	SendJson(data any) fail.CustomError
	Close() fail.CustomError
	Closed() *fail.ErrorList
	OnClose(toDo func() fail.CustomError)
}