server/middlewares/validators/pagination.ts


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

import * as express from 'express'
import { query } from 'express-validator'
import { logger } from '../../helpers/logger'
import { areValidationErrors } from './utils'
import { PAGINATION } from '@server/initializers/constants'

const paginationValidator = paginationValidatorBuilder()

function paginationValidatorBuilder (tags: string[] = []) {
  return [
    query('start')
      .optional()
      .isInt({ min: 0 }).withMessage('Should have a number start'),
    query('count')
      .optional()
      .isInt({ min: 0, max: PAGINATION.GLOBAL.COUNT.MAX }).withMessage(`Should have a number count (max: ${PAGINATION.GLOBAL.COUNT.MAX})`),

    (req: express.Request, res: express.Response, next: express.NextFunction) => {
      logger.debug('Checking pagination parameters', { parameters: req.query, tags })

      if (areValidationErrors(req, res)) return

      return next()
    }
  ]
}

// ---------------------------------------------------------------------------

export {
  paginationValidator,
  paginationValidatorBuilder
}