httpzen

type Action func(req Request)

type Api interface {
	Run(ip string, port uint, mode string) error
	AppendModule(mod Module)
	AppendMiddleware(string, Action) // TODO: add middleware base on order. study it!
	GetRoute(url, method string) *RequestDefinition
	SetCors(cors []string)

	// For testing
	TestHandle(*httptest.ResponseRecorder, *http.Request) error

	// OpenAPI
	SetExternalDocs(ExternalDocs)
	SetInfo(Info)
	SetContact(Contact)
	SetServers([]Server)
	EnableOpenApi(route string) error
	SetErrors([]string)
}

type Contact struct {
	Name  string
	Email string
	URL   string
}

type DescriptionGetter interface {
	GetDescription() string
}

type ExternalDocs struct {
	Description string
	URL         string
}

type File interface {
	io.Reader
	io.Closer
	GetFilename() string
	GetMimeType() string
	GetLastModifiedDate() time.Time
}

type FileHeader interface {
	GetHeader() textproto.MIMEHeader
	GetSize() int64
	GetFilename() string
	OpenFile() (File, error)
}

type FileMultiaprt interface {
	File
	Multipart
}

type HTTPMethod string

type Info struct {
	Version     string
	Description string
	Title       string
}

type Module interface {
	GetRequestHandlers() []*RequestDefinition
	GetBaseURL() string
	GetTag() Tag
}

type Multipart interface {
	io.ReadCloser
	GetPartName() string
	GetMimeType() string
}

type MultipartDefinition interface {
	IsOptional() bool
	GetPartName() string
	IsSingle() bool
	GetObject() interface{}
}

type MultipartFileDefinition interface {
	MultipartDefinition
	Verify(FileHeader) error
}

type MultipartValueDefinition interface {
	MultipartDefinition
	Verify() error
}

type NameGetter interface {
	GetName() string
}

type Request interface {
	// GetJson and other stuff
	SetServerError(msg string)
	SetForbidden()
	SetUnauthorized(msg string, code string)
	SetBadRequest(msg string, code string)
	SetNotFound(msg string, code string)
	ReturnStatus(int, error)
	Set(key string, value interface{})
	Get(key string) (interface{}, bool)
	MustGet(key string) interface{}
	GetDto() (interface{}, bool)
	MustGetDto() interface{}
	Negotiate(stausCode int, err error, Dto interface{})
	RangeFile(status int, err error, file SeekerFile)
	WriteFile(status int, err error, file File)
	ReturnMultpartMixed(status int, err error, out ...Multipart)
}

type RequestDefinition struct {
	Route   string
	Dto     Verifier
	Handler Action
	Method  HTTPMethod

	// For open api
	Summary             string
	Description         string
	OperationID         string // Tools use this UNIQUE id to idenitfy the action example: GetUserByID,GetUsers, ....
	Deprecated          bool   // Set true if this definition is deprecated
	ResponseDefinitions []ResponseDefinition
}

type ResponseDefinition struct {
	Description string // For example: success operation
	Status      int
	Dto         any // Might be basic dto,
}

type SeekerFile interface {
	io.Seeker
	File
}

type Server struct {
	URL         string
	Description string
}

type Tag struct {
	Name         string
	Description  string
	ExternalDocs *ExternalDocs
}

type Verifier interface {
	Verify() error
}