@truepic/queryql/src/orchestrators/filterer.js

Easily add filtering, sorting, and pagination to your REST API through your old friend: the query string!

const BaseOrchestrator = require('./base')
const FilterParser = require('../parsers/filter')

class Filterer extends BaseOrchestrator {
  get queryKey() {
    return 'filter'
  }

  get schema() {
    return this.querier.schema.filters
  }

  get isEnabled() {
    return this.schema.size >= 1
  }

  buildParser() {
    return new FilterParser(
      this.queryKey,
      this.query || this.querier.defaultFilter,
      this.querier.schema,
      {
        operator: this.querier.adapter.constructor.DEFAULT_FILTER_OPERATOR,
        ...this.querier.filterDefaults,
      },
    )
  }

  validate() {
    if (!this.isEnabled) {
      return true
    }

    this.parser.validate()
    this.querier.adapter.validator.validateFilters(this.parse())
    this.querier.validator.validateFilters(this.parse())

    return true
  }

  run() {
    this.validate()

    const filters = this.parse()

    if (!filters) {
      return this.querier
    }

    let key
    let filter

    for (const filterSchema of this.schema.values()) {
      key = this.parser.buildKey(filterSchema)
      filter = filters.get(key)

      if (filter) {
        this.apply(filter, key)
      }
    }

    return this.querier
  }
}

module.exports = Filterer