"when" (joi) in valibot

[abhishekmardiya]

email: Joi.when("_id", {
is: Joi.exist(),
then: Joi.optional(),
otherwise: Joi.string().email().optional(),
}),

	how to achieve similar in valibot

[fabian-hiller]

I recommend using union, variant or check, depending on your exact use case. Feel free to try it out in our playground.

import * as v from 'valibot';

const Schema1 = v.variant('_id', [
  v.object({
    _id: v.pipe(v.string(), v.uuid()),
    email: v.pipe(v.string(), v.email()),
  }),
  v.object({
    _id: v.undefined(),
    email: v.undefined(),
  }),
]);

const Schema2 = v.union([
  v.object({
    _id: v.pipe(v.string(), v.uuid()),
    email: v.pipe(v.string(), v.email()),
  }),
  v.object({
    _id: v.undefined(),
    email: v.undefined(),
  }),
]);

const Schema3 = v.pipe(
  v.object({
    _id: v.optional(v.pipe(v.string(), v.uuid())),
    email: v.optional(v.pipe(v.string(), v.email())),
  }),
  v.check((input) => !input._id || !!input.email)
);

Related links:

• https://valibot.dev/guides/unions/
• https://valibot.dev/guides/pipelines/

[abhishekmardiya]

Thank you so much! I've been searching for a solution like this for days.

By the way, could you please update this page: Migrate from Joi to make it easier to distinguish the APIs from Joi?

Also, you've built an amazing library—hats off to you!

[abhishekmardiya]

Yes, I would love to!
I'm new to Valibot, so once I understand it, I'll definitely help you out.

[fabian-hiller]

Thank you! Feel free to reach out once you feel ready!

[abhishekmardiya]

import * as v from 'valibot';

const Schema = v.pipe(
  v.object({
    type: v.string(),
    constructionStatus: v.optional(v.string('require string')),
  }),
  v.check((input) => {
    if (input.type === 'residential') {
      return !!input.constructionStatus;
    }
    return true;
  }, 'Construction Status is required'),
);

const result = v.safeParse(Schema, {
  type: 'residential',
  // constructionStatus: 'Ready to move',
});

console.log(result);

RESPONSE:

[log]: {
  typed: true,
  success: false,
  output: {
    type: "residential"
  },
  issues: [
    {
      kind: "validation",
      type: "check",
      input: {
        type: "residential"
      },
      expected: null,
      received: "Object",
      message: "Construction Status is required",
      requirement: Function,
      path: undefined,
      issues: undefined,
      lang: undefined,
      abortEarly: undefined,
      abortPipeEarly: undefined
    }
  ]
}

My goal is to append the errors returned from the check function to the corresponding registration field so that I can identify which specific field the error is associated with. Essentially, I want to display the error as an issue type, like 'constructionStatus'.
e.g.,

[log]: {
  typed: true,
  success: false,
  output: {
    type: "residential"
  },
  issues: [
    {
      kind: "validation",
      //need to append this type as "constructionStatus"
      type: "check",
      input: {
        type: "residential"
      },
      expected: null,
      received: "Object",
      message: "Construction Status is required",
      requirement: Function,
      path: undefined,
      issues: undefined,
      lang: undefined,
      abortEarly: undefined,
      abortPipeEarly: undefined
    }
  ]
}

[fabian-hiller]

We have forward for this use case: https://valibot.dev/api/forward/

[abhishekmardiya]

Thanks.
The forward solution works perfectly for our use case. Appreciate your help!