views

type BaseView struct {
	AllowedMethods  []string
	BaseTemplateKey string
	TemplateName    string
	GetContextFn    func(req *http.Request) (ctx.Context, error)
}

type BindableView interface {
	View

	// Bind binds the view to the request and response writer.
	// It returns a new view, specific for said request.
	Bind(w http.ResponseWriter, req *http.Request) (View, error)
}

type CachedResponse struct {
	ResponseStatusCode int         `json:"status_code"`
	ResponseHeader     http.Header `json:"header"`
	ResponseBody       byteArray   `json:"body"`
}

type Checker interface {
	View

	// Check checks the request before serving it.
	// Useful for checking if the request is valid before serving it.
	// Like checking permissions, etc...
	Check(w http.ResponseWriter, req *http.Request) error

	// Fail is a helper function to fail the request.
	// This can be used to redirect, etc.
	Fail(w http.ResponseWriter, req *http.Request, err error)
}

type ContextGetter interface {
	View
	GetContext(req *http.Request) (ctx.Context, error)
}

type ContextHandlerFunc = func(w http.ResponseWriter, req *http.Request, ctx ctx.Context) error

type ControlledView interface {
	View
	TakeControl(w http.ResponseWriter, req *http.Request, v View)
}

type DetailView[T any] struct {
	BaseView
	ContextName string
	URLArgName  string
	GetObjectFn func(req *http.Request, urlArg string) (T, error)
}

type ErrorFunc func(w http.ResponseWriter, req *http.Request, err error, code int)

type ErrorHandler interface {
	// HandleError handles the error.
	HandleError(w http.ResponseWriter, req *http.Request, err error, code int)
}

type FormView[T forms.Form] struct {
	BaseView
	GetFormFn        func(req *http.Request) T
	GetInitialFn     func(req *http.Request) map[string]interface{}
	ValidFn          func(req *http.Request, form T) error
	InvalidFn        func(req *http.Request, form T) error
	SuccessFn        func(w http.ResponseWriter, req *http.Request, form T)
	CheckPermissions func(w http.ResponseWriter, req *http.Request) error
	FailsPermissions func(w http.ResponseWriter, req *http.Request, err error)
}

type HttpContextHandler interface {
	ServeHTTP(http.ResponseWriter, *http.Request, ctx.Context)
}

type MethodsView interface {
	View
	Methods() []string
}

type Renderer interface {
	View
	ContextGetter

	// Render renders the template with the given context.
	Render(w http.ResponseWriter, req *http.Request, context ctx.Context) error
}

type SetupView interface {
	View
	Setup(w http.ResponseWriter, req *http.Request) (http.ResponseWriter, *http.Request)
}

type TemplateGetter interface {
	// GetTemplate returns the template that will be rendered.
	GetTemplate(req *http.Request) string
}

type TemplateKeyer interface {
	// GetBaseKey returns the base key for the template.
	GetBaseKey() string
}

type TemplateRenderer interface {
	// Render renders the template with the given context.
	Render(w http.ResponseWriter, req *http.Request, templateName string, context ctx.Context) error
}

type TemplateView interface {
	View
	ContextGetter
	TemplateGetter
	TemplateRenderer
}

type View interface {
	// ServeXXX is a method that will never get called.
	// It is a placeholder for the actual method that will be called.
	// The actual method will be determined by the type of the request.
	// For example, if the request is a GET request, then ServeGET will be called.
	// If the request is a POST request, then ServePOST will be called.
	// etc...
	ServeXXX(w http.ResponseWriter, req *http.Request)
}

type ViewMixins interface {
	View
	mixins.Definer[View]
}