Validation at the collection level

fturmel12 months ago

4

• 

  denolfe

  12 months ago

  beforeValidate is the proper place to do this type of logic.

  
  

  
  

  Any field data you need should be inside

  data

  or

  originalDoc

  that is passed.

  https://payloadcms.com/docs/hooks/collections#beforevalidate
  

  
  

  You should be able to throw one of the errors available in

  payload/errors

  if validation fails.

• 

  fturmel12 months ago

  Thanks for confirming! Are the

  payload/errors

  documented anywhere?

  
  
  

  Sharing back my

  beforeValidate

  hook implementation in case anyone needs to solve a similar problem:

  
  
  

  async ({ data, originalDoc }) => {
    const payload = await getPayloadClient();
  
    const entries = (
      await payload.find({
        collection: 'myCollection',
        pagination: false,
        where: { id: { not_equals: originalDoc?.id } },
      })
    ).docs;
  
    entries.forEach(entry => {
      if (entry.field1 === data?.field1 && entry.field2 === data?.field2) {
        throw new ValidationError([
          { field: 'field1', message: 'This combination of field 1 and field 2 already exists.' },
          { field: 'field2', message: 'This combination of field 1 and field 2 already exists.' },
        ]);
      }
    });
  }

• 

  denolfe

  12 months ago

  I don't believe their usage is documented explicitly. Your best bet is to search the monorepo for

  from 'payload/errors'

  to see some examples.

• 

  fturmel12 months ago

  I figured it out for my use case, but might be something to consider adding to the docs. Here's the path to errors in the source code for anyone else that might find it useful:

  https://github.com/payloadcms/payload/tree/main/packages/payload/src/errors