server

type AuthenticatedRequest struct {
	Type        AuthenticatedType      `json:"type"`
	User        AuthenticatedUser      `json:"user"`
	Permissions []AuthorizedPermission `json:"permissions"`
}

type AuthenticatedType string

type AuthenticatedUser struct {
	ID    any    `json:"id"`
	Name  string `json:"name"`
	Email string `json:"email"`
}

type AuthenticationType string

type AuthorizedPermission string

type Config struct {
	AppServerEnv             string
	AppServerHost            string
	AppServerHome            string
	AppServerPort            string
	AppImageTagFeatureBranch string
	AppImageTagSHA           string
}

type DocumentationConfig struct {
	Document    bool
	Summary     string // used for API doc endpoint title
	Description string // used for API doc endpoint description
}

type HTTPCORSConfig struct {
	AllowedOrigins   []string
	AllowedHeaders   []string
	ExposedHeaders   []string
	AllowCredentials bool
}

type Handle func(w http.ResponseWriter, r *http.Request, pp httprouter.Params, qp *queryparam.QueryParams, l logger.Logger, m modeller.Modeller) error

type HandlerConfig struct {
	Name string
	// Method - The HTTP method
	Method string
	// Path - The HTTP request URI including :parameter placeholders
	Path string
	// HandlerFunc - Function to handle requests for this method and path
	HandlerFunc Handle
	// MiddlewareConfig -
	MiddlewareConfig MiddlewareConfig
	// DocumentationConfig -
	DocumentationConfig DocumentationConfig
}

type HttpMethod string

type MiddlewareConfig struct {
	AuthenTypes            []AuthenticationType
	AuthzPermissions       []AuthorizedPermission
	ValidateRequestSchema  *jsonschema.SchemaWithReferences
	ValidateResponseSchema *jsonschema.SchemaWithReferences
	ValidateParamsConfig   *ValidateParamsConfig
}

type MiddlewareFunc func(hc HandlerConfig, h Handle) (Handle, error)

type Response struct {
	Error      *ResponseError      `json:"error,omitempty"`
	Pagination *ResponsePagination `json:"pagination,omitempty"`
}

type ResponseError struct {
	Code   string `json:"code"`
	Detail string `json:"detail"`
}

type ResponsePagination struct {
	Number int `json:"page_number"`
	Size   int `json:"page_size"`
	Count  int `json:"page_count"`
}

type Runner struct {
	Config             configurer.Configurer
	Log                logger.Logger
	Store              storer.Storer
	RepositoryPreparer preparer.Repository
	QueryPreparer      preparer.Query

	// HTTPCORSConfig
	HTTPCORSConfig HTTPCORSConfig

	// Handler and message configuration
	HandlerConfig map[string]HandlerConfig

	// Run functions
	RunHTTPFunc   func(args map[string]interface{}) (*http.Server, error)
	RunDaemonFunc func(args map[string]interface{}) error

	// RouterFunc
	RouterFunc func(router *httprouter.Router) (*httprouter.Router, error)

	// HandlerFunc is the default handler function. It is used for liveness and healthz. Therefore, it should execute quickly.
	HandlerFunc Handle

	// HandlerMiddlewareFuncs returns a list of middleware functions to apply to routes
	HandlerMiddlewareFuncs func() []MiddlewareFunc

	// Service feature callbacks
	AuthenticateRequestFunc func(l logger.Logger, m modeller.Modeller, apiKey string) (AuthenticatedRequest, error)

	// Domain layer
	ModellerFunc func(l logger.Logger) (modeller.Modeller, error)

	// Data layer
	RepositoryPreparerFunc func(l logger.Logger) (preparer.Repository, error)
	QueryPreparerFunc      func(l logger.Logger) (preparer.Query, error)
	// contains filtered or unexported fields
}

type Server struct {
	Config configurer.Configurer
	Log    logger.Logger
	Store  storer.Storer
	Runner runnable.Runnable
}

type ValidateParamsConfig struct {
	ExcludePathParamsFromQueryParams bool
	RemoveParamPrefixes              []string
	PathParamSchema                  *jsonschema.SchemaWithReferences
	QueryParamSchema                 *jsonschema.SchemaWithReferences
}

type WriteResponseOption = func(http.ResponseWriter) error