How to make all properties in Zod schema optional based on specific product availability flag?

Question

I have a Zod schema for validating product attributes for an e-commerce application. In my schema, I currently have an attribute called isLimitedEdition which indicates whether the product is in limited supply. However, when isLimitedEdition is set to true , I want all other properties in the schema to become optional.

This is the existing architecture:

const productProperties = z.object({
  name: z.string().nonempty(),
  description: z.string().nonempty(),
  price: z.number().positive(),
  category: z.string().nonempty(),
  brand: z.string().nonempty(),
  isFeatured: z.boolean().default(false),
  isLimitedEdition: z.boolean().default(false),
});

In this architecture, I want to implement a behavior where if isLimitedEdition is set to true, all properties (name, description, price, category, brand, isFeatured) become optional.

How can I modify this schema to achieve the desired behavior? I would be grateful for any guidance or code examples to help me implement this logic correctly. Thank you in advance!

I tried the refine method without success

Answer 1

You can use discriminatedUnion to achieve this:

const productProperties = z.object({
  name: z.string().nonempty(),
  description: z.string().nonempty(),
  price: z.number().positive(),
  category: z.string().nonempty(),
  brand: z.string().nonempty(),
  isFeatured: z.boolean().default(false),
})

const product = z.discriminatedUnion('isLimitedEdition', [
  productProperties.extend({ isLimitedEdition: z.literal(false) }),
  productProperties.partial().extend({ isLimitedEdition: z.literal(true) }),
])