Adonis Lucid Filter

Works with AdonisJS v6

This addon adds the functionality to filter Lucid Models

Inspired by EloquentFilter

Versions

Note: Check before install :point_down:

| adonis-lucid-filter | @adonisjs/lucid | |-------------------------------------|---------------------| | ^5.*.* | ^20.*.* | | ^4.*.* | <=18.*.* | | ^3.*.* (@filterable() decorator) | ^15.*.* | | ^2.*.* | 14.*.* |

• Docs for Adonis v5
• Docs for Adonis v4
• Docs for @filterable() decorator

Introduction

Example, we want to return a list of users filtered by multiple parameters. When we navigate to:

/users?name=Tony&lastName=&companyId=2&industry=5

request.all() or request.qs() will return:

{
  "name": "Tony",
  "lastName": "",
  "companyId": 2,
  "industry": 5
}

To filter by all those parameters we would need to do something like:

import type { HttpContext } from '@adonisjs/core/http'
import User from '#models/user'

export default class UsersController {
  async index({ request }: HttpContext): Promise<User[]> {
    const { companyId, lastName, name, industry } = request.qs()
  
    const query = User.query().where('company_id', +companyId)

    if (lastName) {
      query.where('last_name', 'LIKE', `%${lastName}%`)
    }
    if (name) {
      query.where(function () {
        this.where('first_name', 'LIKE', `%${name}%`)
          .orWhere('last_name', 'LIKE', `%${name}%`)
      })
    }
    return query.exec()
  }

}

To filter that same input with Lucid Filters:

import type { HttpContext } from '@adonisjs/core/http'
import User from '#models/user'

export default class UsersController {
  async index({ request }: HttpContext): Promise<User[]> {
    return User.filter(request.qs()).exec()
  }
}

Installation

Make sure to install it using npm, yarn or pnpm.

# npm
npm i adonis-lucid-filter

# yarn
yarn add adonis-lucid-filter

# pnpm
pnpm add adonis-lucid-filter

After install call configure:

node ace configure adonis-lucid-filter

Usage

Make sure to register the provider and commands inside adonisrc.ts file.

providers: [
  // ...
  () => import('adonis-lucid-filter/provider'),
],
commands: [
  // ...
  () => import('adonis-lucid-filter/commands')
]

Generating The Filter

Only available if you have added adonis-lucid-filter/commands in commands array in your `adonisrc.ts'

You can create a model filter with the following ace command:

node ace make:filter user

Where user is the Lucid Model you are creating the filter for. This will create app/models/filters/user_filter.js

Defining The Filter Logic

Define the filter logic based on the camel cased input key passed to the filter() method.

• Empty strings are ignored
• setup() will be called regardless of input
• _id is dropped from the end of the input to define the method so filtering user_id would use the user() method
• Input without a corresponding filter method are ignored
• The value of the key is injected into the method
• All values are accessible through the this.$input a property
• All QueryBuilder methods are accessible in this.$query object in the model filter class.

To define methods for the following input:

{
  "companyId": 5,
  "name": "Tony",
  "mobilePhone": "888555"
}

You would use the following methods:

import { BaseModelFilter } from 'adonis-lucid-filter'
import type { ModelQueryBuilderContract } from '@adonisjs/lucid/types/model'
import User from '#models/user'

export default class UserFilter extends BaseModelFilter {
  declare $query: ModelQueryBuilderContract<typeof User>
  
  static blacklist: string[] = ['secretMethod']

  // This will filter 'companyId', 'company_id' OR 'company'
  company(id: number) {
    this.$query.where('company_id', id)
  }

  name(name: string) {
    this.$query.where((builder) => {
      builder
        .where('first_name', 'LIKE', `%${name}%`)
        .orWhere('last_name', 'LIKE', `%${name}%`)
    })
  }

  mobilePhone(phone: string) {
    this.$query.where('mobile_phone', 'LIKE', `${phone}%`)
  }

  secretMethod(secretParameter: any) {
    this.$query.where('some_column', true)
  }
}

Blacklist

Any methods defined in the blacklist array will not be called by the filter. Those methods are normally used for internal filter logic.

The whitelistMethod() methods can be used to dynamically blacklist methods.

Example:

setup($query) {
  this.whitelistMethod('secretMethod')
  this.$query.where('is_admin', true)
}

setup() not may be async

Note: All methods inside setup() will be called every time filter() is called on the model

In the example above secretMethod() will not be called, even if there is a secret_method key in the input object. In order to call this method it would need to be whitelisted dynamically:

Static properties

export default class UserFilter extends BaseModelFilter {
  // Blacklisted methods
  static blacklist: string[] = []
  
  // Dropped `_id` from the end of the input
  // Doing this would allow you to have a `company()` filter method as well as a `companyId()` filter method.
  static dropId: boolean = true
  
  // Doing this would allow you to have a mobile_phone() filter method instead of mobilePhone().
  // By default, mobilePhone() filter method can be called thanks to one of the following input key:
  // mobile_phone, mobilePhone, mobile_phone_id, mobilePhoneId
  static camelCase: boolean = true
}

Applying The Filter To A Model

import UserFilter from '#models/filters/user_filter'
import { compose } from '@adonisjs/core/helpers'
import { Filterable } from 'adonis-lucid-filter'

export default class User extends compose(BaseModel, Filterable) {
  static $filter = () => UserFilter

  // ...columns and props
}

This gives you access to the filter() method that accepts an object of input:

import type { HttpContext } from '@adonisjs/core/http'
import User from '#models/user'

export default class UsersController {
  async index({ request }: HttpContext): Promise<User[]> {
    return User.filter(request.qs()).exec()
  }

  // or with paginate method

  async index({ request }: HttpContext): Promise<ModelPaginatorContract<User>> {
    const { page = 1, ...input } = request.qs()
    return User.filter(input).paginate(page, 15)
  }
}

Dynamic Filters

You can define the filter dynamically by passing the filter to use as the second parameter of the filter() method. Defining a filter dynamically will take precedent over any other filters defined for the model.

import type { HttpContext } from '@adonisjs/core/http'
import AdminFilter from '#models/filters/admin_filter'
import UserFilter from '#models/filters/user_filter'

export default class UsersController {
  async index({ request, auth }: HttpContext): Promise<User[]> {
    const filter = auth.user.isAdmin() ? AdminFilter : UserFilter
    return User.filter(request.qs(), filter).exec()
  } 
}

Filtering relations

For filtering relations of model may be use .query().filter() or scope filtration, example:

import type { HttpContext } from '@adonisjs/core/http'
import User from '#models/user'

export default class UserPostsController {
  /**
   * Get a list posts of user
   * GET /users/:user_id/posts
   */
  async index({ params, request }: HttpContext): Promise<Post[]> {
    const user: User = await User.findOrFail(params.user_id)
    
    return user.related('posts').query()
      .apply(scopes => scopes.filtration(request.qs()))
      .exec()

    // or

    return user.related('posts').query().filter(request.qs()).exec()
  }
}

Documentation by Query Scopes

Note: The relation model must be Filterable and $filter must be defined in it