Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: ['20.x', '22.x', '24.x']
node-version: ['22.x', '24.x', '26.x']
steps:
- name: Check out repository
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ code in this repository.
release).

CI runs `npm run lint` then `npm test -- --ci --coverage --runInBand` against
Node 20.x, 22.x, and 24.x. The package targets `node >= 20` and is CommonJS
Node 22.x, 24.x, and 26.x. The package targets `node >= 22` and is CommonJS
(`require` / `module.exports`).

## Architecture
Expand Down
2 changes: 1 addition & 1 deletion eslint.config.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const js = require('@eslint/js')
const prettier = require('eslint-config-prettier')
const jest = require('eslint-plugin-jest')
const node = require('eslint-plugin-n').default
const node = require('eslint-plugin-n')
const globals = require('globals')

module.exports = [
Expand Down
1,396 changes: 691 additions & 705 deletions package-lock.json

Large diffs are not rendered by default.

23 changes: 11 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@truepic/queryql",
"version": "0.22.0",
"version": "0.23.0",
"description": "Easily add filtering, sorting, and pagination to your REST API through your old friend: the query string!",
"keywords": [
"filter",
Expand Down Expand Up @@ -40,24 +40,23 @@
"test": "jest"
},
"dependencies": {
"is": "^3.3.2",
"joi": "^18.2.1"
"joi": "^18.2.4"
},
"devDependencies": {
"@eslint/js": "^10.0.1",
"eslint": "^10.3.0",
"eslint": "^10.8.1",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-jest": "^29.15.2",
"eslint-plugin-n": "^18.0.1",
"globals": "^17.6.0",
"jest": "^30.4.1",
"eslint-plugin-jest": "^29.16.1",
"eslint-plugin-n": "^18.3.0",
"globals": "^17.11.0",
"jest": "^30.4.2",
"jest-junit": "^17.0.0",
"knex": "^3.2.10",
"prettier": "3.8.3",
"release-it": "^20.0.1"
"knex": "^3.3.0",
"prettier": "3.9.6",
"release-it": "^21.0.2"
},
"engines": {
"node": ">=20"
"node": ">=22"
},
"publishConfig": {
"access": "public"
Expand Down
4 changes: 1 addition & 3 deletions src/adapters/base.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
const is = require('is')

const AdapterValidator = require('../validators/adapter')
const NotImplementedError = require('../errors/not_implemented')

Expand Down Expand Up @@ -41,7 +39,7 @@ class BaseAdapter {

const operatorMethod = `filter:${operator}`

if (is.fn(this[operatorMethod])) {
if (typeof this[operatorMethod] === 'function') {
return this[operatorMethod](builder, filter)
}

Expand Down
4 changes: 1 addition & 3 deletions src/orchestrators/base.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
const is = require('is')

const cache = require('../services/cache_function')
const NotImplementedError = require('../errors/not_implemented')
const ValidationError = require('../errors/validation')
Expand Down Expand Up @@ -58,7 +56,7 @@ class BaseOrchestrator {
const args = [this.querier.builder, values]

this.querier.builder =
querierMethod && is.fn(this.querier[querierMethod])
querierMethod && typeof this.querier[querierMethod] === 'function'
? this.querier[querierMethod](...args)
: this.querier.adapter[this.queryKey](...args)

Expand Down
7 changes: 4 additions & 3 deletions src/parsers/filter.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
const is = require('is')

const BaseParser = require('./base')
const flattenMap = require('../services/flatten_map')

Expand Down Expand Up @@ -95,7 +93,10 @@ class FilterParser extends BaseParser {
const filters = []

for (const [name, value] of entries) {
if (is.object(value)) {
// `Object.prototype.toString` is used instead of `typeof` so that arrays,
// `null`, and exotic objects (like `Date`) are treated as filter values
// rather than operator objects.
if (Object.prototype.toString.call(value) === '[object Object]') {
filters.push(...this.parseObject(name, value))
} else {
filters.push(this.parseNonObject(name, value))
Expand Down
7 changes: 4 additions & 3 deletions src/parsers/page.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
const is = require('is')

const BaseParser = require('./base')
const flattenMap = require('../services/flatten_map')

Expand Down Expand Up @@ -60,7 +58,10 @@ class PageParser extends BaseParser {

if (!this.query) {
page = this.defaults
} else if (is.number(this.query) || is.string(this.query)) {
} else if (
typeof this.query === 'number' ||
typeof this.query === 'string'
) {
page = this.parseNumber()
} else {
page = this.parseObject()
Expand Down
6 changes: 2 additions & 4 deletions src/parsers/sort.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
const is = require('is')

const BaseParser = require('./base')
const flattenMap = require('../services/flatten_map')

Expand Down Expand Up @@ -89,9 +87,9 @@ class SortParser extends BaseParser {

const sorts = []

if (is.string(this.query)) {
if (typeof this.query === 'string') {
sorts.push(this.parseString(this.query))
} else if (is.array(this.query)) {
} else if (Array.isArray(this.query)) {
sorts.push(...this.parseArray(this.query))
} else {
sorts.push(...this.parseObject(this.query))
Expand Down
8 changes: 2 additions & 6 deletions src/schema.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
const is = require('is')

class Schema {
constructor() {
this.filters = new Map()
Expand Down Expand Up @@ -33,7 +31,7 @@ class Schema {
}

page(isEnabledOrOptions = true) {
if (is.bool(isEnabledOrOptions)) {
if (typeof isEnabledOrOptions === 'boolean') {
this.pageOptions = { isEnabled: isEnabledOrOptions }
} else {
this.pageOptions = {
Expand All @@ -49,9 +47,7 @@ class Schema {
}

mapFilterNamesToOperators() {
const filters = Array.from(this.filters.values())

return filters.reduce((accumulator, filter) => {
return this.filters.values().reduce((accumulator, filter) => {
if (!accumulator[filter.name]) {
accumulator[filter.name] = []
}
Expand Down
4 changes: 1 addition & 3 deletions src/services/flatten_map.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
module.exports = ({ map, key = null, value = null }) => {
const entries = Array.from(map.entries())

return entries.reduce((accumulator, [entryKey, entryValue]) => {
return map.entries().reduce((accumulator, [entryKey, entryValue]) => {
const newKey = key ? key(entryKey, entryValue) : entryKey
const newValue = value ? value(entryValue, entryKey) : entryValue

Expand Down