protocol

type Action func(req Request)

type Api interface {
	Run(ip string, port uint, mode string) error
	AppendDuplexModule(mod DuplexModule)
	AppendModule(mod Module)
	AppendPreHandlers(string, Action)
	GetRoute(url, method string) *RequestDefinition
	AppendAuthorizer(baseURL string, authorizer Authorizer)
	AppendAuthenticator(baseURL string, authorizer Authenticator)
	SetCors(cors []string)
	SetLogHandler(LogHandler)
	SetLogPolicy(model.LogPolicy)
	TestHandle(*httptest.ResponseRecorder, *http.Request) error
	// OpenAPI
	SetExternalDocs(openapi.ExternalDocs)
	SetInfo(openapi.Info)
	SetContact(openapi.Contact)
	SetServers([]openapi.Server)
	EnableOpenApi(route string) error
	SetErrors([]string)
}

type Authenticator interface {
	GetModel(token string) (misc.JwtClaim, error)
	CheckToken(token string) (bool, error)
}

type Authorizer func(identity string, permission string) (bool, error)

type DuplexConnection interface {
	Publish(topic string, message any) error
	GetCaller() (misc.Caller, bool)
	MustGetCaller() misc.Caller
}

type DuplexHandler func(msg DuplexMessage)

type DuplexHandlerDefinition struct {
	Topic          string
	Dto            any
	Handler        DuplexHandler
	AnyPermissions []string
	FreeRoute      bool // Free route require neither authentication nor authorization
}

type DuplexMessage interface {
	GetDto() any
	MustGetCaller() misc.Caller
	GetTopic() string
}

type DuplexModule interface {
	GetDuplexHandlers() []*DuplexHandlerDefinition
	GetBaseURL() string
	OnDuplexConnected(DuplexConnection)
	OnDuplexDisconnected(DuplexConnection)
}

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

type FileMultipart interface {
	fileProtocol.File
	Multipart
}

type HTTPMethod string

type LogHandler interface {
	Handle(model.HttpLog)
}

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

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

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

type MultipartFileDefinition interface {
	MultipartDefinition
	Verify(FileHeader) error
}

type MultipartValueDefinition interface {
	MultipartDefinition
	Verify() error
}

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{})
	SetFile(key string, f FileHeader)
	SetFiles(key string, f []FileHeader)
	Get(key string) (interface{}, bool)
	MustGet(key string) interface{}
	GetDTO() (interface{}, bool)
	MustGetDTO() interface{}
	GetFile(partName string) (FileHeader, bool)
	MustGetFile(partName string) FileHeader
	GetFiles(partName string) ([]FileHeader, bool)
	MustGetFiles(partName string) []FileHeader
	Negotiate(stausCode int, err error, dto interface{})
	RangeFile(status int, err error, file fileProtocol.SeekerFile)
	WriteFile(status int, err error, file fileProtocol.File)
	ReturnMultipartMixed(status int, err error, out ...Multipart)
	GetPagination() (misc.Pagination, bool)
	GetCursorPagination() (misc.CursorPagination, bool)
	GetCaller() (misc.Caller, bool)
	MustGetCaller() misc.Caller
	GetSort() []misc.Sort
	GetQuery() []misc.Query
	GetDefaultQuery() (string, bool)
	IsAndQuery() bool
}

type RequestDefinition struct {
	Route          string
	Parameters     []RequestParameter
	Dto            Verifier
	DtoArray       Verifier
	FileParts      []MultipartFileDefinition
	ValueParts     []MultipartValueDefinition
	Handler        Action
	MaxLimit       int
	Method         HTTPMethod
	AnyPermissions []string
	FreeRoute      bool // Free route require neither authentication nor authorization

	// Specific for Swagger
	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 RequestParameter struct {
	Definition misc.QueryDefinition
	Query      bool
	Optional   bool
}

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

type Verifier interface {
	Verify() error
}