hateoas

type BaseRepository interface {
	GetType() reflect.Type
}

type Entity interface {
	GetID() string
	SetID(string) error
}

type EntityDoesNotExistError struct {
	EntityName string
	Criteria   map[string]interface{}
}

type InternalError struct {
	Message string
	Detail  string
}

type ListableRepository interface {
	BaseRepository
	FindBy(map[string]interface{}) (interface{}, error)
	FindOneBy(map[string]interface{}) (Entity, error)
}

type Page struct {
	Content       interface{}
	TotalElements int      `json:"totalElements"`
	IDs           []string `json:"ids,omitempty"`
	BasePath      string   `json:"-"`
	Pageable      Pageable
}

type Pageable struct {
	Page      int    `json:"page" form:"page"`
	Size      int    `json:"size" form:"size"`
	Sort      string `json:"sort" form:"sort"`
	IndexedBy string `json:"indexedBy" form:"indexedBy" default:""`
}

type PageableRepository interface {
	BaseRepository
	FindPageBy(Pageable, map[string]interface{}) (Page, error)
}

type PagedResources struct {
	Content      interface{}    `json:"content" binding:"-"`
	PageMetadata pageMetadata   `json:"pageMetadata" binding:"-"`
	Links        []ResourceLink `json:"_links" binding:"-"`
}

type Resource struct {
	Links []ResourceLink `json:"_links,omitempty" gorm:"-" binding:"-"`
}

type ResourceLink struct {
	Rel  string `json:"rel"`
	Href string `json:"href"`
}

type Resourceable interface {
	ToResource(baseURL string)
	GetSelfURL(baseURL string) string
}

type SavableRepository interface {
	ListableRepository
	Save(Entity) error
	Remove(interface{}) error
}

type SoftDeletableEntity interface {
	Entity
	GetDeletedAt() *time.Time
}

type SoftDeletableRepository interface {
	BaseRepository
	FindOneByUnscoped(criteria map[string]interface{}) (SoftDeletableEntity, error)
}

type TruncatableRepository interface {
	BaseRepository
	Truncate() error
}

type UnsupportedEntityError struct {
	Expected string
	Actual   string
}

type UnsupportedIndexError struct {
	Field     string
	Supported []string
}