list

type Filters map[string][]string

type ListMeta struct {
	Total   int                 `json:"total"`
	Count   int                 `json:"count"`
	Limit   int                 `json:"limit"`
	Offset  int                 `json:"offset"`
	Filters map[string][]string `json:"filters,omitempty"`
	Search  string              `json:"search,omitempty"`
	Sort    []SortField         `json:"sort,omitempty"`
}

type ListQuery struct {
	Limit   int
	Offset  int
	Search  string
	Filters Filters
	Sort    []SortField
	Raw     url.Values
	// contains filtered or unexported fields
}

type ListQueryConfig struct {
	DefaultLimit   int
	MaxLimit       int
	AllowedFilters []string
	Required       []string
	SearchParam    string
	SortParam      string
	AllowedSorts   []string
	DefaultSort    []SortField
	// FilterParser overrides the default filter parser when set.
	FilterParser func(values url.Values, cfg ListQueryConfig) Filters
	// SortParser overrides the default sort parser when set.
	SortParser func(values url.Values, cfg ListQueryConfig) []SortField
}

type ListResponse[T any] struct {
	Data []T      `json:"data"`
	Meta ListMeta `json:"meta"`
}

type SortField struct {
	Field string `json:"field"`
	Desc  bool   `json:"desc"`
}