GridQueryGenerator 1.0.1

GridQueryGenerator

Features

This project provides a source generator that automatically creates strongly-typed classes based on attributes. It allows for sorting, filtering and pagination of simple types and types of IEnumerable. Additionally, it automates creation of Range<T> filter types. All filters by default will be nullable and only checked and executed when they have a value. Sorting allows for multi-sort via a SortPriority.

Limitations

Currently, filtering and sorting via nested types isn't supported, as the focus of this library is mainly about the interop between frontend grids.

Usage

Simply annotate your class with [GridQuery]. From there you can decide on the default page size (100 by default) and whether all members should be included by default. If you choose to exclude members, you would then annotate them with the [GridQueryMember] attribute and set Include = false. The [GridQueryMember] also allows you to specify the filter type, the sort direction and whether sorting should be allowed in general.

using GridQueryGenerator.Attributes;
using GridQueryGenerator.Enums;

[GridQuery(IncludeAllByDefault = true, PageSize = 25)]
public class Product
{
    [GridQueryMember(Include = false)]
    public int Id { get; set; }
    
    [GridQueryMember(Filter = FilterType.Range)]
    public decimal Price { get; set; }

    public string Name { get; set; }
}

The generated class will have filters for Price and Name, both of which can be sorted by as well. Because Name is of type string, it will be fuzzy-searched instead of only providing exact matches. Price will be of type Range<decimal> and provide Min and Max properties to set a lower and upper bound (inclusive)

To use the generated ProductGridQuery, you have two options.

1. You can use the GridSort, GridFilter, GridPaging or GridQuery extension methods on IQueryable<T> (note: GridQuery combines all of the previous three for convenience)
2. You can call ApplySorting, ApplyFilters, ApplyPaging or ApplyGrid on the ProductGridQuery instance, passing your instance of IQueryable<T>

public List<Product> GetProducts(ProductGridQuery queryParams, IQueryable<Product> productQuery)
{
    // Is equal to var option1 = productQuery.GridFilter(queryParams).GridSorting(queryParams).GridPaging(queryParams);
    var option1 = productQuery.GridQuery(queryParams);
    
    // Is equal to queryParams.ApplyGrid(productQuery);
    var option2 = queryParams.ApplyPaging(queryParams.ApplySorting(queryParams.ApplyFilters(productQuery)));

    // your remaining logic
}

License

EUPL-1.2