fastify schema validation with trim

Question

I have written a schema as follows

input: {
            type: "string",
            allOf: [
                {
                  transform: [
                    "trim"
                  ]
                },
                {
                  minLength: 1
                }
            ],
            transform: ["trim"],
            trim: true,
            description: "Input",
            minLength: 1,
            maxLength: 3
        }

I want to accomplish 2 things - I want to trim the input and I want to validate that the trimmed input has minLength = 1. I tried all the different configurations I came across for doing this, but none of them have worked so far. I am using fastify version 3.0.0, and I believe it uses ajv validator for doing the transform and validation. The validation part is working, however the trim has not happened.

score 4 · Answer 1 · answered Jun 01 '22 at 11:52

Install ajv-keywords using below cmd

npm i ajv-keywords

Import 'ajvKeywords' in code as follows

import ajvKeywords from 'ajv-keywords'

Pass on ajv instance to ajvKeyword

const ajv = new Ajv({
    useDefaults: true,
  })


 ajvKeywords(ajv, ['transform'])

And use in schema as follows

schema: {
    body: {
      type: 'object',
      properties: {
        input: {
          type: 'string',
          transform: ['trim'],
          allOf: [
            { transform: ['trim'] },
            { minLength: 1 },
            { maxLength: 3 }
          ]
       }
        }
      }
    }
  }

Working as expected.... – Bhavesh Kawad Jun 01 '22 at 11:55 — Bhavesh Kawad, Jun 01 '22 at 11:55

score 1 · Accepted Answer · answered Aug 07 '20 at 16:26

1

transform is not a standard json-schema feature.

So you need to configure ajv to get it working:

Notice that allOf array is executed sequentially, so if you move the min/max keyword at the root document, the spaces will be evaluated!


const Fastify = require('fastify')
const fastify = Fastify({
  logger: true,
  ajv: {
    plugins: [
      [require('ajv-keywords'), ['transform']]
    ]
  }
})

fastify.post('/', {
  handler: async (req) => { return req.body },
  schema: {
    body: {
      type: 'object',
      properties: {
        input: {
          type: 'string',
          allOf: [
            { transform: ['trim'] },
            { minLength: 1 },
            { maxLength: 3 }
          ]
        }
      }
    }
  }
})

fastify.inject({
  method: 'POST',
  url: '/',
  payload: {
    input: '   foo   '
  }
}, (_, res) => {
  console.log(res.payload);
})

answered Aug 07 '20 at 16:26

Manuel Spigolon

11,003
5
50
73

I am facing this issue . https://github.com/ajv-validator/ajv-keywords/issues/164 any pointers to resolve would be great – Rizwan Patel Mar 30 '21 at 20:34
Reply on the issue, it is a matter of incompatible versions – Manuel Spigolon Mar 30 '21 at 21:21
Can this method be used with fluent-json-schema plugin? – user2058413 Jun 30 '23 at 04:16
Yes, you can - but you need to use the `S.raw()` method – Manuel Spigolon Jul 02 '23 at 06:21

fastify schema validation with trim

2 Answers2

Linked