Getting a list of schema fields with validation rules

[yudinmaxim]

I couldn't find a way to programmatically determine which fields are required and which can be ignored based on the schema. For example, if using yup, it is done in the following way:

// If I use yup
// Getting the schema description
const schemaDescription = dataSchema.describe();

// A function to determine the required fields based on the description
const getRequiredFields = (description) => { 
  const requiredFields = {};
  Object.entries(description.fields).forEach(([key, value]) => {
    // Check if the field contains the 'required' key 
    requiredFields[key] = value.tests.some(test => test.name === 'required');
  });
  return requiredFields;
};

How can the same be achieved using valibot?

[fabian-hiller]

What is your use case? Fields are required by default in Valibot, but you can make them optional with optional. With Schema.entries you can access the entries of an object schema.

[yudinmaxim]

I'm using Valibot along with vee-validate for form validation in my Vue application. I want to use the required attribute in the form template to mark fields that are mandatory for submission.

[fabian-hiller]

You could try the following:

const getRequiredFields = (description) => { 
  const requiredFields = {};
  Object.entries(ObjectSchema.entries).forEach(([key, schema]) => {
    requiredFields[key] = 'type' in schema && schema.type !== 'optional';
  });
  return requiredFields;
};

[yudinmaxim]

Thank you for the answer.
Yes - it really makes it possible to define the fields that are required.
Thanks a lot

[ruiaraujo012]

I'm looking for that exact thing but, I'm using unions and variants, ho can I do it? Any idea?

Thanks.

[fabian-hiller]

Can you provide more details and a code example?

[ruiaraujo012]

I opened a new discussion here #484, maybe we can continue there?