core

type API struct {

	// MapMethods contain a array of HTTP methos for API validations.
	MapMethods *MapMethods
	// contains filtered or unexported fields
}

type APIRequestReceiver interface {
	// ProcessBody API request body information
	ProcessBody(*http.Request) (*RequestDataContext, error)
	// ProcessEncryptedBody API request url encode data
	ProcessEncryptedBody(*http.Request) (*RequestEncryptedData, error)
	// GetRouteVar returns the route var for the current request, if any.
	GetRouteVar(string, *http.Request) string
}

type APIResponseFormatter interface {
	// Format the response body information.
	Format(ResponseData) *ResponseFormatted
}

type APIResponseWriter interface {
	// Write the API response in screen.
	Write(*ResponseFormatted, http.ResponseWriter)
}

type APISecurityGuarantor interface {
	// ValidateBasicToken validate a token with a basic authentication method.
	ValidateBasicToken(token string) (client, secret string, valid bool)
	// ValidateBasicToken validate a token with a custmo authentication method.
	ValidateCustomToken(token string, validator CustomTokenValidator) (json.RawMessage, bool)
}

type CustomTokenValidator func(string) (json.RawMessage, bool)

type JSONContent []byte

type MapMethods map[string][]string

type Middleware func(next http.HandlerFunc) http.HandlerFunc

type ParamValidator func(any) (errMsg string, err error)

type RequestDataContext struct {
	context.Context

	// Client device UUID
	UUID string

	// Client device type
	DeviceType string

	// Client device brand
	DeviceBrand string

	// Client device model
	DeviceModel string

	// Client device operating system
	DeviceOS string

	// Client device operating system version
	OSVersion string

	// Client device operating system timezone
	OSTimezone string

	// Client App language config
	AppLanguage string

	// Client App version
	AppVersion string

	// Client App build information
	AppBuildInfo string

	// Client App name
	AppName string

	// Client security token
	SecurityToken string

	// DeviceSerial device serial number
	DeviceSerial string

	// DeviceId device unique id
	DeviceId string

	// Latitude device latitude
	Latitude string

	// Longitude device longitude
	Longitude string

	// Request event ID
	EventID string

	// HTTP request headers
	Headers map[string]string

	// You can to use this map to extend request information
	Info info.Info

	// You can use this property to add the body content for your
	// API request in json format.
	Content JSONContent

	// RawBody content
	RawBody []byte

	// Data contains more data
	Data interface{}
}

type RequestEncryptedData struct {
	context.Context

	// Request Metadata
	Metadata string

	// Data contains more data
	Data string

	// You can to use this map to extend request information
	Info info.Info
}

type ResponseCode string

type ResponseData struct {
	// Title of response
	Title string

	// Message descriptor response
	Message string

	// HTTP status code respose
	HTTPStatusCode int

	// Custom code of respoonse
	ResponseCode ResponseCode

	// Response type: error, success, warning, etc.
	ResponseType ResponseType

	// The user security token
	SecurityToken string

	// Indicate actions for devices.
	Actions string

	// Request unique identifier
	EventID string

	// Headers for HTTP response
	Headers map[string]string

	// You can to use this map to add custom informations to generate
	// your API response.
	Info map[string]string

	// You can use this property to add the body content for your
	// API response.
	Content interface{}
}

type ResponseFormatted struct {
	Headers        map[string]string
	HTTPStatusCode int
	Body           interface{}
}

type ResponseType string