inertiaframe

type Endpoint[R any] interface {
	// Execute executes the endpoint for the given request.
	//
	// If the returned error can automatically be converted to an Inertia
	// error, it will be converted and passed down to the client.
	Execute(context.Context, *Request[R]) (*Response, error)

	// Meta returns the metadata of the endpoint. It is used to configure
	// the endpoint's behavior when mounted on a given http.ServeMux.
	Meta() *Meta
}

type InertiaError struct {
	Cause error `json:"-"`
}

type Message interface {
	// Component returns the component name to be rendered.
	//
	// Executor panics if Component returns an empty string,
	// unless the message implements RawResponseWriter.
	//
	// If the message is implementing RawResponseWriter, the default
	// behavior is prevented and the writer is used instead to
	// write the response data.
	Component() string
}

type Meta struct {
	// HTTP method of the endpoint.
	Method string

	// HTTP path of the endpoint. It supports the same path pattern as
	// the http.ServeMux.
	Path string
}

type MountOpts struct {
	// Middleware is the middleware used to handle requests.
	// If Middleware is nil, no middleware will be used.
	Middleware httpmiddleware.Middleware

	// Validator is the validator used to validate the request data.
	// If Validator is nil, the DefaultValidator will be used.
	Validator *validator.Validate

	// FormDecoder is the decoder used to parse incoming request data
	// when the request type is application/x-www-form-urlencoded or
	// multipart/form-data.
	// If FormDecoder is nil, the DefaultFormDecoder will be used.
	FormDecoder *form.Decoder

	// ErrorHandler is the error handler used to handle errors.
	// If ErrorHandler is nil, the DefaultErrorHandler will be used.
	ErrorHandler httperror.ErrorHandler
}

type Mux interface {
	// Handle handles the given HTTP request at the specified path.
	//
	// The pattern is a string following the http.ServeMux format:
	// "<http-method> <path>".
	Handle(pattern string, h http.Handler)
}

type RawRequestExtractor interface {
	// Extract extracts data from the raw http.Request.
	Extract(*http.Request) error
}

type RawResponseWriter interface {
	Write(http.ResponseWriter, *http.Request) error
}

type Request[M any] struct {
	// Message is a decoded message sent by a client.
	//
	// Message can implement RawRequestExtractor to intercept request data extraction.
	Message *M
}

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

type ResponseConfig struct {
	// ClearHistory determines whether the history should be cleared by
	// the client.
	ClearHistory bool

	// EncryptHistory determines whether the history should be encrypted by
	// the client.
	EncryptHistory bool

	// Concurrency determines the maximum number of concurrent resolutions of lazy
	// props that can be made during response resolution.
	Concurrency int
}