Actions: Allow effect chaining on form input validators

[bholmesdev]

Changes

Allow chaining utilities on z.object() when validating forms. This includes .refine(), .transform(), and .passthrough().

• Resolves Zod refine on Server Actions input causes undefined values #11641
• Resolves [Actions] Zod object.passthrough does not allow extra input keys/values #11693
• Unwrap nested effects to get basic Zod object
• Add check for the passthrough property. If present, pass unknown form data values as object keys
• Simplify Zod schema type for forms to z.ZodType. We originally tried to restrict this type, but it would grow quite complex to support infinitely nested z.ZodEffect objects. So, we relaxed the type and relaxed the handler. If we find a ZodObject in your validator, we massage FormData. Otherwise, we run your schema as-is.

Testing

• Add unit test for passthrough
• Add integration tests for refine and transform

Docs

N/A

[changeset-bot]

🦋 Changeset detected

Latest commit: 6505eab

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[gtrabanco]

Sorry but I think that test case for .pipe is missed in the test? I think it should work if transform works.

export const passwordSchema = z
  .string()
  .min(8, 'Password should be at least 8 chars length')
  .max(128, 'Password length exceeded. Max 128 chars.');

const inputChangePasswordSchema = z
  .object({
    current_password: passwordSchema,
    new_password: passwordSchema,
    new_password_repeat: passwordSchema,
  })
  .required()
  .refine(
    ({ new_password, new_password_repeat }) => new_password === new_password_repeat,
    'The new password confirmation does not match'
  )
  .refine(
    ({ current_password, new_password }) => current_password !== new_password,
    'The old password and the new password must not match'
  )
  .transform((input) => ({
    currentPassword: input.current_password,
    newPassword: input.new_password,
  }))
  .pipe(
    z.object({
      currentPassword: passwordSchema,
      newPassword: passwordSchema,
    })
  )

[bholmesdev]

Thanks for catching me @gtrabanco! Turns out pipe() isn't a ZodEffect. TIL. Added a test case and fixed the code.