types

type DeletedAt null.Time

type FilterOperator string

type FilterOption struct {

	// Field is the name of the field to filter by.
	Field string

	// Value is the value to filter the field by.
	Value string

	// Operator is the operator to use for filtering (e.g., equals, less than).
	Operator FilterOperator
}

type IController interface {
	// IResourceGetter is embedded to include methods related to retrieving resources.
	IResourceGetter

	// IResourceSetter is embedded to include methods related to modifying resources.
	IResourceSetter

	// Create returns a gin.HandlerFunc that handles the creation of a new resource.
	Create() gin.HandlerFunc

	// Read returns a gin.HandlerFunc that handles reading a specific resource.
	Read() gin.HandlerFunc

	// List returns a gin.HandlerFunc that handles listing multiple resources.
	List() gin.HandlerFunc

	// Update returns a gin.HandlerFunc that handles updating an existing resource.
	Update() gin.HandlerFunc

	// Delete returns a gin.HandlerFunc that handles deleting a resource.
	Delete() gin.HandlerFunc
}

type IModel interface {
	// GetID returns the unique identifier of the model.
	GetID() string

	// SetID sets the unique identifier for the model.
	SetID(id string)
}

type IModelAfterBind interface {
	// AfterBind is called after data has been bound to the model from a request context.
	// This could be used to validate or modify the data before it is processed further,
	// but also to ensure that readonly fields are not processed.
	AfterBind(ctx *gin.Context) (err error)
}

type IModelBeforeBind interface {
	// BeforeBind is called before data is bound to the model from a request context.
	// This could be used to set default values.
	BeforeBind(ctx *gin.Context) (err error)
}

type IModelBeforeRender interface {
	// BeforeRender is called before the model is rendered in a response context.
	// This could be used to modify or mask sensitive data before it is sent to the client.
	BeforeRender(ctx *gin.Context) (err error)
}

type IModelCreateClause interface {
	// CreateClause returns a GORM []clause.Interface containing the query clause for creating records.
	// The clause can be used to customize the CREATE operation in the database.
	CreateClause(ctx *gin.Context) []clause.Interface
}

type IModelDeleteClause interface {
	// DeleteClause returns a GORM []clause.Interface containing the query clause for deleting records.
	// The clause can be used to customize the DELETE operation in the database.
	DeleteClause(ctx *gin.Context) []clause.Interface
}

type IModelFilterable interface {
	// Filterable returns a map of fields that can be used to filter queries on the model.
	// This ensures that only displayed values are filtered, preventing exposure of sensitive data.
	Filterable(ctx *gin.Context) map[string]struct{}
}

type IModelListClause interface {
	// ListClause returns a GORM []clause.Interface containing the query clause for listing multiple records.
	// The clause can be used to customize the LIST operation in the database.
	ListClause(ctx *gin.Context) []clause.Interface
}

type IModelReadClause interface {
	// ReadClause returns a GORM []clause.Interface containing the query clause for reading single records.
	// The clause can be used to customize the READ operation in the database.
	ReadClause(ctx *gin.Context) []clause.Interface
}

type IModelReadable interface {
	// Readable returns a slice of field names that are allowed to be read in the model.
	Readable(ctx *gin.Context) []string
}

type IModelSortable interface {
	// Sortable returns a map of fields that can be used to sort queries on the model.
	// This ensures that only displayed values are sorted, preventing exposure of sensitive data.
	Sortable(ctx *gin.Context) map[string]struct{}
}

type IModelUpdatable interface {
	// Updatable returns a slice of field names that are allowed to be updated in the model.
	Updatable(ctx *gin.Context) []string
}

type IModelUpdateClause interface {
	// UpdateClause returns a GORM []clause.Interface containing the query clause for updating records.
	// The clause can be used to customize the UPDATE operation in the database.
	UpdateClause(ctx *gin.Context) []clause.Interface
}

type IRender interface {
	// Render is embedded from gin package, providing the basic render functionality.
	render.Render

	// MimeType returns the MIME type of the rendered content.
	MimeType() string
}

type IResource interface {
	IResourceInitializer
	IResourceGetter
}

type IResourceDatabase interface {
	IResource
	// Database returns the gorm.DB instance associated with this resource for database operations.
	Database() *gorm.DB
}

type IResourceGetter interface {
	// Name returns the name of the resource.
	Name() string

	// Router returns the gin.IRouter associated with this resource.
	Router() gin.IRouter

	// Resource retrieves an IResourceGetter by name, allowing for nested resources.
	Resource() IResourceGetter

	// ResourceOf retrieves an IResourceGetter by name, allowing for nested resources.
	ResourceOf(name string) IResourceGetter

	// Controller returns the controller component of the resource.
	Controller() IController

	// Service returns the service component of the resource.
	Service() IService

	// View returns the view component of the resource.
	View() IView
}

type IResourceInitializer interface {
	// SetResources assigns the provided Resources object to the resource.
	// Additionally, it is responsible for initializing resource references in controllers, services, and views.
	SetResources(*Resources)

	// SetRouter sets the gin.IRouter for handling HTTP requests related to this resource.
	// The router is established by REST as a pre-configured group, incorporating the resource's designated path.
	SetRouter(router gin.IRouter)

	// Register registers the resource's routes and handlers with the router.
	// Must be called after SetRouter
	Register()
}

type IResourceSetter interface {
	// SetResource assigns the provided IResource to this setter.
	SetResource(IResource)
}

type IService interface {
	// IResourceGetter is embedded to include methods related to retrieving resources.
	IResourceGetter

	// IResourceSetter is embedded to include methods related to modifying resources.
	IResourceSetter

	// Create handles the creation of a new resource.
	Create(ctx *gin.Context, entity any) (err error)

	// Read retrieves an existing resource.
	Read(ctx *gin.Context, entity any) (err error)

	// List retrieves a collection of resources.
	List(ctx *gin.Context, entities any) (err error)

	// Update modifies an existing resource.
	Update(ctx *gin.Context, entity any) (err error)

	// Delete removes a resource.
	Delete(ctx *gin.Context, entity any) (err error)
}

type IView interface {
	// IResourceGetter is embedded to include methods related to retrieving resources.
	IResourceGetter

	// IResourceSetter is embedded to include methods related to modifying resources.
	IResourceSetter

	// Create handles the creation of a new resource and returns a IRender object.
	Create(ctx *gin.Context, entity any) IRender

	// Read retrieves an existing resource and returns a IRender object.
	Read(ctx *gin.Context, entity any) IRender

	// List retrieves a collection of resources and returns a IRender object.
	List(ctx *gin.Context, entities any) IRender

	// Update retrieves an existing resource and returns a IRender object.
	Update(ctx *gin.Context, entity any) IRender

	// Delete retrieves an existing resource and returns a IRender object.
	Delete(ctx *gin.Context, entity any) IRender

	// SupportedMimeTypes returns a pointer to a map containing supported MIME types.
	SupportedMimeTypes() map[string]any
}

type Resources map[string]IResource

type SortOption struct {

	// Field is the name of the field to sort by.
	Field string

	// Descending indicates whether the sorting should be in descending order.
	Descending bool
}