webfram

type APIKeySecuritySchemeOptions struct {
	// Name of the header, query, or cookie parameter to be used.
	Name string
	// Description provides a description of the API Key security scheme.
	Description string
	// In specifies the location of the API key.
	In string
	// Extensions are custom extensions for the API Key security scheme.
	Extensions map[string]interface{}
	//nolint:gocritic // this is a field comment, not a deprecation notice
	// Deprecated indicates whether the API Key security scheme is deprecated.
	Deprecated bool
}

type AppMiddleware = Middleware[Handler]

type Assets struct {
	// FS is the file system containing the static assets.
	FS fs.FS
	// Templates configures template settings for the framework.
	Templates *Templates
	// I18nMessages configures internationalization message settings.
	I18nMessages *I18nMessages
}

type AuthorizationCodeOAuthFlowOptions struct {
	// AuthorizationURL is the URL to obtain authorization.
	AuthorizationURL string
	// TokenURL is the URL to obtain tokens.
	TokenURL string
	// Scopes is a map of scope names to descriptions.
	Scopes map[string]string
	// RefreshURL is the URL to obtain authorization.
	RefreshURL string
	// Extensions are custom extensions for the Authorization Code OAuth2 flow.
	Extensions map[string]interface{}
}

type ClientCredentialsOAuthFlowOptions struct {
	// TokenURL is the URL to obtain tokens.
	TokenURL string
	// Scopes is a map of scope names to descriptions.
	Scopes map[string]string
	// RefreshURL is the URL to obtain authorization.
	RefreshURL string
	// Extensions are custom extensions for the Client Credentials OAuth2 flow.
	Extensions map[string]interface{}
}

type Components struct {
	// SecuritySchemes is a map of security scheme names to definitions.
	SecuritySchemes map[string]SecurityScheme
}

type Config struct {
	// Telemetry configures telemetry settings for the framework.
	Telemetry *Telemetry
	// Security configures security settings for the framework.
	Security *security.Config
	// I18nMessages configures internationalization message settings.
	I18nMessages *I18nMessages
	// Assets configures static assets and their locations.
	Assets *Assets
	// OpenAPI configures OpenAPI documentation settings.
	OpenAPI *OpenAPI
	// JSONPCallbackParamName is the name of the query parameter for JSONP callbacks.
	JSONPCallbackParamName string
}

type Contact struct {
	// Name is the name of the contact.
	Name string
	// URL is the URL of the contact.
	URL string
	// Email is the email address of the contact.
	Email string
}

type DeviceAuthorizationOAuthFlowOptions struct {
	// DeviceAuthorizationURL is the URL to obtain device codes.
	DeviceAuthorizationURL string
	// TokenURL is the URL to obtain tokens.
	TokenURL string
	// Scopes is a map of scope names to descriptions.
	Scopes map[string]string
	// RefreshURL is the URL to obtain authorization.
	RefreshURL string
	// Extensions are custom extensions for the Device Authorization OAuth2 flow.
	Extensions map[string]interface{}
}

type Example struct {
	DataValue       any
	DefaultValue    any
	SerializedValue any
	Server          *Server
	Summary         string
	Description     string
	ExternalValue   string
}

type ExternalDocs struct {
	// Description provides a description of the external documentation.
	Description string
	// URL is the URL of the external documentation.
	URL string
}

type HTTPBasicSecuritySchemeOptions struct {
	// Description provides a description of the HTTP Basic security scheme.
	Description string
	// Extensions are custom extensions for the HTTP Basic security scheme.
	Extensions map[string]interface{}
	//nolint:gocritic // this is a field comment, not a deprecation notice
	// Deprecated indicates whether the HTTP Basic security scheme is deprecated.
	Deprecated bool
}

type HTTPBearerSecuritySchemeOptions struct {
	// Description provides a description of the HTTP Bearer security scheme.
	Description string
	// BearerFormat is an optional hint to the client to identify how the bearer token is formatted.
	// e.g., "JWT"
	BearerFormat string
	// Extensions are custom extensions for the HTTP Bearer security scheme.
	Extensions map[string]interface{}
	//nolint:gocritic // this is a field comment, not a deprecation notice
	// Deprecated indicates whether the HTTP Bearer security scheme is deprecated.
	Deprecated bool
}

type HTTPDigestSecuritySchemeOptions struct {
	// Description provides a description of the HTTP Digest security scheme.
	Description string
	// Extensions are custom extensions for the HTTP Digest security scheme.
	Extensions map[string]interface{}
	//nolint:gocritic // this is a field comment, not a deprecation notice
	// Deprecated indicates whether the HTTP Digest security scheme is deprecated.
	Deprecated bool
}

type Handler interface {
	ServeHTTP(ResponseWriter, *Request)
}

type HandlerConfig struct {
	OperationConfig *OperationConfig
	// contains filtered or unexported fields
}

type HandlerFunc func(ResponseWriter, *Request)

type Header struct {
	Example     any
	TypeHint    any
	Examples    map[string]Example
	Explode     *bool
	Content     map[string]TypeInfo
	Description string
	Style       string
	Required    bool
	Deprecated  bool
}

type I18nMessages struct {
	// Dir is the directory where i18n message files are located.
	Dir string
	// SupportedLanguages is a list of supported language tags.
	SupportedLanguages []string
}

type ImplicitOAuthFlowOptions struct {
	// AuthorizationURL is the URL to obtain authorization.
	AuthorizationURL string
	// Scopes is a map of scope names to descriptions.
	Scopes map[string]string
	// RefreshURL is the URL to obtain authorization.
	RefreshURL string
	// Extensions are custom extensions for the Implicit OAuth2 flow.
	Extensions map[string]interface{}
}

type Info struct {
	// Title of the API.
	Title string
	// Summary provides a brief summary of the API.
	Summary string
	// Description provides a detailed description of the API.
	Description string
	// TermsOfService is the URL to the terms of service for the API.
	TermsOfService string
	// Contact information for the API.
	Contact *Contact
	// License information for the API.
	License *License
	// Version of the API.
	Version string
}

type License struct {
	// Name of the license.
	Name string
	// Identifier is the SPDX identifier of the license.
	Identifier string
	// URL is the URL of the license.
	URL string
}

type Link struct {
	OperationRef string
	OperationID  string
	Parameters   map[string]any
	RequestBody  any
	Description  string
}

type Middleware[H any] = func(H) H

type MutualTLSSecuritySchemeOptions struct {
	// Description provides a description of the Mutual TLS security scheme.
	Description string
	// Extensions are custom extensions for the Mutual TLS security scheme.
	Extensions map[string]interface{}
	//nolint:gocritic // this is a field comment, not a deprecation notice
	// Deprecated indicates whether the Mutual TLS security scheme is deprecated.
	Deprecated bool
}

type OAuth2SecuritySchemeOptions struct {
	// Flows is a map of OAuth2 flows.
	Flows []OAuthFlow
	// Description provides a description of the OAuth2 security scheme.
	Description string
	// Extensions are custom extensions for the OAuth2 security scheme.
	Extensions map[string]interface{}
	//nolint:gocritic // this is a field comment, not a deprecation notice
	// Deprecated indicates whether the OAuth2 security scheme is deprecated.
	Deprecated bool
}

type OAuthFlow interface {
	// contains filtered or unexported methods
}

type OpenAPI struct {

	// Config is the OpenAPI configuration.
	Config *OpenAPIConfig
	// URLPath is the HTTP path for the OpenAPI JSON endpoint (e.g., "GET /openapi.json").
	URLPath string
	// Enabled indicates whether OpenAPI documentation is enabled.
	Enabled bool
	// contains filtered or unexported fields
}

type OpenAPIConfig struct {
	Info *Info
	// Servers is a list of OpenAPI server definitions.
	Servers []Server
	// Tags is a list of OpenAPI tags.
	Tags []Tag
	// Security is a list of security requirements for the OpenAPI document.
	Security []map[string][]string
	// ExternalDocs provides external documentation for the OpenAPI document.
	ExternalDocs *ExternalDocs
	// Components holds various schema components.
	Components *Components
}

type OpenIdConnectSecuritySchemeOptions struct {
	//nolint:revive,staticcheck // OpenId naming follows OpenAPI specification convention
	// OpenIdConnectURL is the OpenID Connect URL to discover OAuth2 configuration values.
	OpenIdConnectURL string
	// Description provides a description of the OpenID Connect security scheme.
	Description string
	// Extensions are custom extensions for the OpenID Connect security scheme.
	Extensions map[string]interface{}
	//nolint:gocritic // this is a field comment, not a deprecation notice
	// Deprecated indicates whether the OpenID Connect security scheme is deprecated.
	Deprecated bool
}

type OperationConfig struct {
	Method      string
	Summary     string
	Description string
	OperationID string
	Tags        []string
	Parameters  []Parameter
	Security    []map[string][]string
	RequestBody *RequestBody
	Responses   map[string]Response
	Servers     []Server
}

type Parameter struct {
	Example          any
	Default          any
	Const            any
	TypeHint         any
	Explode          *bool
	Examples         map[string]Example
	Content          map[string]any
	Style            string
	Format           string
	Name             string
	Description      string
	In               string
	Pattern          string
	Enum             []any
	Minimum          float64
	MinItems         int
	MinLength        int
	MaxLength        int
	ExclusiveMaximum float64
	ExclusiveMinimum float64
	Maximum          float64
	MaxItems         int
	MultipleOf       float64
	AllowReserved    bool
	Nullable         bool
	UniqueItems      bool
	Deprecated       bool
	Required         bool
}

type PathInfo struct {
	Summary     string
	Description string
	// AdditionalOperations map[string]*Operation
	Servers    []Server
	Parameters []Parameter
}

type Request struct {
	*http.Request
}

type RequestBody struct {
	Content     map[string]TypeInfo
	Example     *Example
	Examples    map[string]Example
	Description string
	Required    bool
}

type Response struct {
	Headers     map[string]Header
	Content     map[string]TypeInfo
	Links       map[string]Link
	Summary     string
	Description string
}

type ResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

type SSEDisconnectFunc func()

type SSEErrorFunc func(error)

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

type SSEPayload struct {
	// Data is the event data.
	Data any `json:"data"               validate:"required"`
	// ID is the event ID.
	ID string `json:"id,omitempty"`
	// Event is the event type.
	Event string `json:"event,omitempty"`
	// Comments are optional comments for the event.
	Comments []string `json:"comments,omitempty"`
	// Retry is the reconnection time in case of connection loss.
	Retry time.Duration `json:"retry,omitempty"`
}

type SSEPayloadFunc func() SSEPayload

type SecurityScheme interface {
	// contains filtered or unexported methods
}

type ServeFileOptions struct {
	Inline   bool   // If true, serves the file inline; otherwise as an attachment
	Filename string // Optional filename for Content-Disposition header
}

type ServeMux struct {
	http.ServeMux
	// contains filtered or unexported fields
}

type Server struct {
	Variables   map[string]ServerVariable
	URL         string
	Name        string
	Description string
}

type ServerConfig struct {
	ConnState                    func(net.Conn, http.ConnState)
	TLSConfig                    *tls.Config
	Protocols                    *http.Protocols
	HTTP2                        *http.HTTP2Config
	ConnContext                  func(ctx context.Context, c net.Conn) context.Context
	BaseContext                  func(net.Listener) context.Context
	ErrorLog                     *slog.Logger
	TLSNextProto                 map[string]func(*http.Server, *tls.Conn, http.Handler)
	ReadHeaderTimeout            time.Duration
	MaxHeaderBytes               int
	IdleTimeout                  time.Duration
	WriteTimeout                 time.Duration
	ReadTimeout                  time.Duration
	DisableGeneralOptionsHandler bool
}

type ServerVariable struct {
	Default     string
	Description string
	Enum        []string
}

type StandardMiddleware = Middleware[http.Handler]

type Tag struct {
	// Name is the name of the tag.
	Name string
	// Summary provides a brief summary of the tag.
	Summary string
	// Description provides a detailed description of the tag.
	Description string
	// ExternalDocs provides external documentation for the tag.
	ExternalDocs *ExternalDocs
	// Parent is the name of the parent tag, if any.
	Parent string
	// Kind represents the kind of the tag.
	Kind string
}

type Telemetry struct {
	// UseDefaultRegistry indicates whether to use the default Prometheus registry.
	UseDefaultRegistry bool
	// Collectors are custom Prometheus collectors to register.
	Collectors []prometheus.Collector
	// URLPath is the HTTP path for the metrics endpoint (e.g., "GET /metrics").
	URLPath string
	// Addr is the optional address for a separate telemetry server (e.g., ":9090").
	// If empty or equal to the main server address, telemetry runs on the main server.
	Addr string
	// Enabled indicates whether telemetry is enabled.
	Enabled bool
	// HandlerOpts are options for the Prometheus HTTP handler.
	HandlerOpts promhttp.HandlerOpts
}

type Templates struct {
	// Dir is the directory where template files are located.
	Dir string
	// LayoutBaseName is the base name of the layout template.
	LayoutBaseName string
	// HTMLTemplateExtension is the file extension for HTML templates.
	HTMLTemplateExtension string
	// TextTemplateExtension is the file extension for text templates.
	TextTemplateExtension string
}

type TypeInfo struct {
	// TypeHint provides a hint about the data type.
	TypeHint any
	// XMLRootName specifies the root element name for XML serialization.
	// Only applicable when using XML content type.
	XMLRootName string
	Example     any
	Examples    map[string]Example
}

type ValidationError struct {
	XMLName xml.Name `json:"-"     xml:"validationError" form:"-"`
	Field   string   `json:"field" xml:"field"           form:"field"`
	Error   string   `json:"error" xml:"error"           form:"error"`
}

type ValidationErrors struct {
	XMLName xml.Name          `json:"-"      xml:"validationErrors" form:"-"`
	Errors  []ValidationError `json:"errors" xml:"errors"           form:"errors"`
}