uos

type ActionSpec interface {
	// Name returns the short name of the action. The action can be triggered at "/actions/<name>".
	Name() string
	// Do executes the action. The implementation must ensure logging and an appropriate response.
	// The returned action (optional) is executed afterwards.
	Do(http.ResponseWriter, *http.Request) *ResponseAction
}

type AppConfiguration struct {
	// application context information, available as template context
	AppInfo map[string]interface{} `json:"app"`

	// web application port
	Port int `json:"port"`
	// base deployment directory - only files "below" this directory are used.
	// If empty or not defined, the directory of the executable is set.
	BaseDir string `json:"base_dir"`

	Logging    LogConfiguration        `json:"logging"`
	Monitoring MonitoringConfiguration `json:"monitoring"`
	Database   DBConfiguration         `json:"database"`
	Assets     AssetConfiguration      `json:"assets"`
	I18N       I18NConfiguration       `json:"i18n"`

	Auth AuthenticationConfiguration `json:"auth"`

	// page configuration integrated into HTML pages. To define common settings
	// the page "_default" can be specified.
	Pages map[string]PageConfiguration `json:"pages"`

	Tuning   TuningConfiguration  `json:"tuning"`
	Features FeatureConfiguration `json:"-"`
}

type AppRequestHandler func(http.ResponseWriter, *http.Request)

type AppRequestHandlerMapping struct {
	// URL route
	Route string
	// request handler for specified route
	Handler AppRequestHandler
	// options
	Options AppRequestHandlerOptions
}

type AppRequestHandlerOptions struct {
	// do not expect valid CSRF token on POST/PUT/DELETE
	NoCSRFcheck bool
	// do not include the page in sitemap
	NoSitemap bool

	// redirect to login page if not authenticated
	IsAuthRequired bool
	// login page (target for "authentication required" pages)
	IsAuthPage bool
}

type AppUser struct {
	gorm.Model

	Name     string `gorm:"unique"`
	Language string

	PasswordHash string
	Salt         string

	IsAdmin bool
	// contains filtered or unexported fields
}

type AssetConfiguration struct {
	// directory containing "dynamic" assets (= assets that are not included in the executable)
	Dynamic string `json:"dynamic"`
	// directory containing template files for pages, forms, dialogs, fragements.
	Templates string `json:"templates"`
	// directory containing markdown documents
	Markdown string `json:"markdown"`
}

type AuthenticationConfiguration struct {
	HashKey  string `json:"hash"`
	BlockKey string `json:"block"`
	// contains filtered or unexported fields
}

type DBConfiguration struct {
	// SQLite database file
	File string `json:"file"`
}

type DialogFooter struct {
	// left-aligned footer elements
	Left []DialogFooterElement
	// right-aligned footer elements
	Right []DialogFooterElement
}

type DialogFooterElement struct {
	// shown as button
	IsButton bool
	// close dialog
	IsClosing bool
	// button submits a form
	IsSaving bool

	// text (button or text label)
	Text string
	// class (button or text label)
	TextClass string

	// referenced form (in combination with IsSaving)
	Form string
}

type DialogSpec interface {
	// Name returns the short name of the dialog. The form is available at '/dialogs/<name>'.
	Name() string
	// DisplayTitle returns the title string of the dialog.
	DisplayTitle() string
	// Footer returns a dialog footer specification.
	Footer() DialogFooter
}

type FeatureConfiguration struct {
	Dialogs bool `json:"-"`
}

type FormItem struct {
	ID string

	InputType     string
	InputTypeHTML string

	Name         string
	Value        string
	DefaultValue string

	Constraints *FormItemConstraints

	Class       string
	Placeholder string
	Min         string
	Max         string

	Label string

	Help      string
	HelpClass string

	Message      string
	MessageClass string

	IsHorizontal bool
	IsHidden     bool
	HasFocus     bool
}

type FormItemConstraints struct {
	IsMandatory bool
	IsNumber    bool

	MinValue float64
	MaxValue float64

	MinLength int
	MaxLength int

	Regexp string
}

type FormItems []FormItem

type FormSpec interface {
	// Name returns the short name of the form. The form is available at '/forms/<name>'.
	Name() string
}

type FormSpecDelete interface {
	// Delete removes the specified item from the database.
	Delete(id string) (*ResponseAction, error)
}

type FormSpecRead interface {
	// Read returns the list of form items. If an id is specified, the form items for an existing
	// entity is returned.
	Read(id string) (FormItems, error)
}

type FormSpecSave interface {
	// Read returns the list of form items. If an id is specified, the form items for an existing
	// entity is returned.
	Read(id string) (FormItems, error)
	// Save writes the specified items to the database.
	Save(id string, items FormItems) (*ResponseAction, error)
}

type FragmentSpec interface {
	// Name returns the short name of a fragment. The fragment is available at '/fragments/<name>'
	// and uses the template 'fragment_<name>'.
	Name() string
}

type FragmentSpecRead interface {
	// GetContextObject returns the fragment template context object for the given URL parameters.
	GetContextObject(params Getter) (interface{}, error)
}

type Getter interface {
	Get(string) string
}

type I18NConfiguration struct {
	// directory containing translations (PO files)
	Locale string `json:"locale"`
	// list of supported languages (first entry is primary language)
	Languages []string `json:"languages"`
}

type LogConfiguration struct {
	// log level (panic, fatal, error, warn, info, debug, trace)
	Level string `json:"level"`
	// write logmessages as colored output to stderr - otherwise log as JSON
	UseConsole bool `json:"use_console"`
}

type LogContext map[string]interface{}

type MonitoringConfiguration struct {
	// port for pprof web interface
	PortPPROF int `json:"pprof"`
	// port for application metrics (Prometheus)
	PortMetrics int `json:"metrics"`
}

type PageConfiguration struct {
	Title       string `json:"title"`
	Description string `json:"description"`
	Author      string `json:"author"`
	URL         string `json:"url"`

	StaticBaseURL string `json:"static_base_url"`

	FavIcon string `json:"favicon"`

	Styles []string `json:"styles"`

	ScriptsHead []string `json:"scripts_head"`
	ScriptsBody []string `json:"scripts_body"`
}

type PageConfigurationHandler func(string, *http.Request, *PageConfiguration)

type ResourceSpec interface {
	// Name returns the short name of a resource. The resource is available at '/<name>'.
	Name() string
}

type ResourceSpecList interface {
	// List return a filtered list of resources. Used as context to resource_list_<name> template.
	List(filter string, page, count int) ([]interface{}, error)
}

type ResourceSpecRead interface {
	// Read returns the resource as template context for resource_<name>.
	Read(id string) (interface{}, error)
}

type ResponseAction struct {
	// contains filtered or unexported fields
}

type TableAction struct {
	// (LineAwesome) icon of the action
	Icon string
	// button text
	Text string
	// button class
	ButtonClass string

	// hx-<method>
	Method string
	// action target, e.g. "/dialogs/..."
	TargetURL string
	// CSS selector for elements to include in the resulting request
	Include string

	// confirmation dialog title, empty: no confirmation required
	ConfirmationTitle string
	// confirmation dialog message
	ConfirmationMessage string
}

type TableActions []TableAction

type TableColumn struct {
	// display name
	DisplayName string
	// table supports sorting by this column
	IsSortable bool

	// function to convert raw values to visualization (e.g. for formatting)
	Format TableFormatFunc

	// is current sortfield? (determined automatically)
	IsSortField bool
	// is sorted descending? (determined automatically)
	IsSortDesc bool
	// internal name (determined automatically)
	Name string
}

type TableConfiguration struct {
	// comma separated list of selected columns
	Columns []string

	// sort column
	SortColumn string
	// sort mode (ASC or DESC or empty)
	SortMode string

	// selected page
	Page int
	// number of rows to return
	Rows int
}

type TableData [][]interface{}

type TableDisplay interface {
	// DisplaySettings returns custom table display settings
	DisplaySettings() TableDisplayProperties
}

type TableDisplayProperties struct {
	// show as full element width
	IsFullWidth bool
	// highlight table rows on hover
	IsHoverable bool
	// emphasize every second row
	IsStriped bool
	// show table content as cards on small displays
	IsMobileReady bool
	// rows can be selected
	IsSelectable bool
	// rows can be expanded
	IsExpandable bool
	// last column contains buttons
	HasRowActions bool
}

type TableFormatFunc func(interface{}, interface{}) interface{}

type TableSpec interface {
	// Name returns the short name of the table. The table data is available at '/tables/<name>'.
	Name() string
	// ModelName returns the name of the underlying DB model. Can return "" to indicate a custom table.
	// A returned model must be registered (using RegisterDBModels).
	ModelName() string
	// ResourceName is required if the table IsExpandable (see display properties). The detail rows
	// content will be loaded as the specified resource.
	ResourceName() string

	// LoadData returns the table data according to the specified configuration.
	LoadData(TableConfiguration) (TableData, error)

	// ColumnInfo returns table column information for the selected columns.
	ColumnInfo([]string) []TableColumn
	// ColumnDefault returns list of default columns
	ColumnDefault() []string

	// Actions returns a set of actions related to the table and their contained items.
	Actions() *TableActions
}

type TableSpecDelete interface {
	// Delete removes the specified items from the database.
	Delete(ids []uint) (*ResponseAction, error)
}

type TuningConfiguration struct {
	ActivateHTMXPreloading bool `json:"htmx_preload"`
}