views

type BaseFormView[T interfaces.Saver] struct {
	// The action of the form
	//
	// This will be used in mainly error messages.
	//
	// Example: "create", "view", "update"
	Action string

	// A fallback url for when an error occurs, and the form is submitted.
	BackURL func(r *request.Request) string
	// The success url for when the form is submitted.
	PostRedirect func(r *request.Request, data T) string
	// Extra function to run for authentication.
	//
	// This will be run before the form is rendered.
	ExtraAuth func(r *request.Request) error
	// The required permissions needed to perform an action on the model.
	NeedsAuth bool
	// Needs admin permissions to perform an action on the model.
	NeedsAdmin bool
	// Whether a superuser can perform the action.
	SuperUserCanPerform bool
	// Function to run before rendering a template.
	BeforeRender func(r *request.Request, data T, fieldMap *orderedmap.Map[string, *FormField])
	// Function to run on submission, when overridden; the default save method will not be called.
	OnSubmit func(r *request.Request, data T) error
	// The form data for when the form is submitted.
	//
	// This will only get filled on the POST method!
	FormData map[string]FormData
	// MaxMemory is the maximum memory used when parsing the files of a request.
	MaxMemory int64 // defaults to 32MB
	// Override the get and post methods.
	GET  func(r *request.Request) error
	POST func(r *request.Request, data T) error
	// Template to pass the template variables to.
	Template string
	// Function to get a template.
	GetTemplate func(string) (*template.Template, string, error)
	// The instance of the model passed in.
	//
	// This will be automatically filled in with the model passed in.
	//
	// Do not edit this before the POST method is called!
	Instance T
	// The function to get the instance of the model passed in.
	//
	// This will set the instance to the result of the function.
	GetInstance func(r *request.Request) (T, error)

	// Function to run after the form is submitted and the view specified has been called.
	//
	// This will only get called on the POST method!
	AfterSubmit func(r *request.Request, data T)

	// The tag to use to fetch attributes from struct fields.
	//
	// Defaults to "fields".
	FormTag string

	// Javascript to include in the template.
	//
	// You must include the <script> tags.
	Scripts map[string]template.HTML
	// contains filtered or unexported fields
}

type BaseView[MODEL any] struct {
	// The template to use
	Template string

	// Function to get a template with
	GetTemplate func(string) (*template.Template, string, error)

	// The URL to redirect to after a failed action.
	BackURL func(r *request.Request, model MODEL) string

	// The URL to redirect to after a successful action.
	SuccessURL func(r *request.Request, model MODEL) string

	// The permissions required to perform an action on the model
	//
	// If there is a permission registered, the user must be authenticated!
	RequiredPerms []string

	// NeedsAuth specifies whether the user needs to be authenticated to view the page.
	NeedsAuth bool

	// Needs admin permissions to perform an action on the model.
	NeedsAdmin bool

	// Whether a superuser can perform the action.
	SuperUserCanPerform bool

	// The action to perform on the model.
	//
	// This is used to display the correct message to the user.
	//
	// For example: "delete", "update" or "view"
	Action string

	GetQuerySet func(r *request.Request) (MODEL, error)

	// Overrides for the get and post functions.
	Get  func(r *request.Request, m MODEL)
	Post func(r *request.Request, m MODEL)

	// Extra func to run on the data.
	//
	// This can be used for validation, returning an error will make the request error.
	//
	// With the error message.
	Extra func(r *request.Request, model MODEL) error

	// Extra auth func to run on the data.
	//
	// This can be used for validation, returning an error will make the request error.
	//
	// With the error message.
	ExtraAuth func(r *request.Request, model MODEL) error
}

type CRUDView[T CrudModel[T]] struct {
	// DeleteView
	Delete *DeleteView[T]

	// UpdateView
	Update *UpdateView[T]

	// CreateView
	Create *CreateView[T]

	// ListView
	List *ListView[T]

	// DetailView
	Detail *DetailView[T]
}

type CreateView[T interfaces.Saver] struct {
	BaseFormView[T]
	Fields []string
}

type CrudModel[T any] interface {
	// Reader
	interfaces.Deleter
	interfaces.Saver
	interfaces.Lister[T]
}

type DeleteView[model interfaces.Deleter] struct {
	BaseView[model]
}

type DetailView[T any] struct {
	BaseView[T]

	DeleteURL func(r *request.Request, model T) string
	EditURL   func(r *request.Request, model T) string
}

type FormData struct {
	Values []string
	Files  []interfaces.File
}

type FormField struct {
	Field interfaces.FormField
	Tags  tags.TagMap

	Label string
	// contains filtered or unexported fields
}

type FormGroup struct {
	Label interfaces.Element
	Input interfaces.Element
}

type ListView[T interfaces.Lister[T]] struct {
	BaseView[[]T]

	// Fallback number of items per page (When an error occurs for example)
	//
	// This is also the default.
	//
	// This is used when the user doesn't specify the number of items per page.
	FallbackPerPage int

	// Maximum number of items per page.
	//
	// This is used when the user specifies a number of items per page that is
	// greater than this value.
	MaxPerPage int

	GetQuerySet func(r *request.Request) ([]T, error)
}

type UpdateView[T interfaces.Saver] struct {
	BaseFormView[T]
	Fields []string

	// GetQuerySet has priority over GetInstance!
	GetQuerySet func(r *request.Request) (T, error)
}