web

type ApiContext interface {
	echo.Context

	Payload() *jsonapi.OnePayload
	Attrs(permitted ...string) map[string]interface{}
	AttrKeys() []string
	RequireAttrs(...string) error
	BindAndValidate(interface{}) error
	BindMulti(interface{}) ([]interface{}, error)
	BindIdParam(*int, ...string) error
	JsonApi(interface{}, int) error
	JsonApiOK(interface{}, ...interface{}) error
	JsonApiOKPaged(interface{}, *meta.Pagination, ...interface{}) error
	ApiError(string, ...int) *echo.HTTPError
	JsonAPIError(string, int, string) *jsonapi.ErrorObject
	QueryParamTrue(string) (bool, bool)

	RequiredQueryParams(...string) (map[string]string, error)
	OptionalQueryParams(...string) map[string]string
	QParams(...string) (map[string]string, error)
}

type AuthedConfig struct {
	// Skipper defines a function to skip middleware.
	Skipper emw.Skipper
}

type AuthedContextLookup interface {
	Lookup(echo.Context) (echo.Context, error)
	Context(echo.Context) echo.Context
}

type CommonExtendable interface {
	CommonExtend(interface{}) error
}

type CommonLinkable interface {
	CommonLinks(*meta.Pagination) error
}

type CommonMetable interface {
	CommonMeta() error
}

type Extendable interface {
	Extend(interface{}) error
}

type HandlerFunc func(ApiContext) error

type Linkable interface {
	Links(*meta.Pagination) error
}

type Metable interface {
	Meta() error
}

type MethodHandler struct {
	Method     string
	Handler    echo.HandlerFunc
	MiddleWare []echo.MiddlewareFunc
}

type Route struct {
	Path     string
	Handlers []*MethodHandler
	Name     string
	ERoute   *echo.Route
}

type RouteConfig struct {
	Routes     []*Route
	MiddleWare []echo.MiddlewareFunc
}