rest

type AfterDeleteLifecycleHook func(response *response.Response, request *http.Request) error

type AfterIndexLifecycleHook func(response *response.Response, request *http.Request, model *[]surf.Model) error

type BaseController struct {
	GetModel        surf.BuildModel
	LifecycleHooks  LifecycleHooks
	MethodWhiteList []string
}

type BaseLifecycleHook func(response *response.Response, request *http.Request, model surf.Model) error

type BeforeIndexLifecycleHook func(response *response.Response, request *http.Request, model *surf.BulkFetchConfig) error

type LifecycleHooks struct {
	// After validation and model prep, but before creation
	BeforeCreate BaseLifecycleHook

	// After create, but before HTTP response
	AfterCreate BaseLifecycleHook

	// After the BulkFetchConfig is set, but before the fetch
	BeforeIndex BeforeIndexLifecycleHook

	// After the fetch, but before the response
	AfterIndex AfterIndexLifecycleHook

	// After the model is prepared to be loaded, but before it is actually loaded
	BeforeShow BaseLifecycleHook

	// After the model is loaded, but before the HTTP response
	AfterShow BaseLifecycleHook

	// After the model has been loaded + the values have been validated + set to the model,
	// but before the model is updated
	BeforeUpdate BaseLifecycleHook

	// After update, but before HTTP response
	AfterUpdate BaseLifecycleHook

	// After the models identifier has been set, but before the deletion
	BeforeDelete BaseLifecycleHook

	// After the model has been deleted, but before the HTTP response
	AfterDelete AfterDeleteLifecycleHook
}

type ManyToManyController struct {
	GetBaseModel                surf.BuildModel
	GetNestedModel              surf.BuildModel
	GetRelationModel            surf.BuildModel
	BaseModelForeignReference   string
	NestedModelForeignReference string
	LifecycleHooks              LifecycleHooks
	MethodWhiteList             []string
}

type OneToManyController struct {
	GetBaseModel           surf.BuildModel
	GetNestedModel         surf.BuildModel
	NestedForeignReference string
	BelongsTo              func(baseModel, nestedModel surf.Model) bool
	LifecycleHooks         LifecycleHooks
	MethodWhiteList        []string
}

type OneToOneController struct {
	NestedModelNameSingular string
	ForeignReference        string
	GetBaseModel            surf.BuildModel
	GetNestedModel          surf.BuildModel
	LifecycleHooks          LifecycleHooks
	MethodWhiteList         []string
}