How to validate for ObjectID

Question

Using Joi schema validation, is it possible to validate against MongoDB ObjectID's?

Something like this could be great:

_id: Joi.ObjectId().required().error(errorParser),

Answer 1

I find that if I do

Joi.object({
  id: Joi.string().hex().length(24)
})

it works without installing any external library or using RegEx

The hex makes sure the string contains only hexadecimal characters and the length makes sure that it is a string of exactly 24 characters

Answer 2

const Joi = require('@hapi/joi')
Joi.objectId = require('joi-objectid')(Joi)
 
const schema = Joi.object({
  id: Joi.objectId(),
  name: Joi.string().max(100),
  date: Joi.date()
})

checkout https://www.npmjs.com/package/joi-objectid

Answer 3

If you want a TypeScript version of the above library integrated with Express without installing anything:

import Joi from '@hapi/joi';
import { createValidator } from 'express-joi-validation';

export const JoiObjectId = (message = 'valid id') => Joi.string().regex(/^[0-9a-fA-F]{24}$/, message)

const validator = createValidator({
    passError: true,
});

const params = Joi.object({
    id: JoiObjectId().required(),
});

router.get<{ id: string }>(
    '/:id',
    validator.params(params),
    (req, res, next) => { 
       const { id } = req.params; // id has string type
       .... 
    }
);