colinhacks / zod

TypeScript-first schema validation with static type inference
https://zod.dev
MIT License
33.44k stars 1.15k forks source link

Prisma XOR with Zod > 3.21.1 not working #2184

Closed chrishoermann closed 6 months ago

chrishoermann commented 1 year ago

We encounterd a bug when using generated prisma types with versions greater than 3.21.1.

You can reproduce the issue in the following repo: https://github.com/chrishoermann/zod-prisma-types-bug

As you can read in the following discussion we first thought it was an issue with prisma, but after digging around and finding that the suspected type has been this way for a long time now @njdowdy found that this is a zod issue that happend somwhere in 3.21.2

Discussed in https://github.com/colinhacks/zod/discussions/2171

Originally posted by **chrishoermann** March 9, 2023 I've built a generator for prisma ([zod-prisma-types](https://github.com/chrishoermann/zod-prisma-types)) that throws a type error since prisma updated their `XOR` type in 4.11: ```ts type Without = { [P in Exclude]?: never }; /** * XOR is needed to have a real mutually exclusive union type * https://stackoverflow.com/questions/42123407/does-typescript-support-mutually-exclusive-types */ type XOR = T extends object ? U extends object ? (Without & U) | (Without & T) : U : T ``` before this type update the following zod schema worked without problems: ```ts export const UserCreateInputSchema: z.ZodType = z.object({ id: z.string().cuid().optional(), email: z.string().email({ message: "Invalid email address" }), name: z.string().min(1).max(100).optional().nullable(), role: z.union([ z.lazy(() => UserCreateroleInputSchema),z.lazy(() => RoleSchema).array() ]).optional(), enum: z.lazy(() => AnotherEnumSchema).optional(), scalarList: z.union([ z.lazy(() => UserCreatescalarListInputSchema),z.string().array() ]).optional(), posts: z.lazy(() => PostCreateNestedManyWithoutAuthorInputSchema).optional(), profile: z.lazy(() => ProfileCreateNestedOneWithoutUserInputSchema).optional(), location: z.lazy(() => LocationCreateNestedOneWithoutUserInputSchema).optional(), }).strict(); export const UserUncheckedCreateInputSchema: z.ZodType = z.object({ id: z.string().cuid().optional(), email: z.string().email({ message: "Invalid email address" }), name: z.string().min(1).max(100).optional().nullable(), role: z.union([ z.lazy(() => UserCreateroleInputSchema),z.lazy(() => RoleSchema).array() ]).optional(), enum: z.lazy(() => AnotherEnumSchema).optional(), scalarList: z.union([ z.lazy(() => UserCreatescalarListInputSchema),z.string().array() ]).optional(), lat: z.number(), lng: z.number(), posts: z.lazy(() => PostUncheckedCreateNestedManyWithoutAuthorInputSchema).optional(), profile: z.lazy(() => ProfileUncheckedCreateNestedOneWithoutUserInputSchema).optional(), }).strict(); export const UserCreateArgsSchema: z.ZodType = z.object({ select: UserSelectSchema.optional(), include: UserIncludeSchema.optional(), data: z.union([ UserCreateInputSchema,UserUncheckedCreateInputSchema ]), }).strict() ``` so a simple union was sufficient to satisfy typescript. in Prisma 4.11 typescript now throws the following error because, as I see it, the `Without<...>` type can not be satisfied with a union anymore: ``` Type 'ZodObject<{ select: ZodOptional>; include: ZodOptional>; data: ZodUnion<...>; }, "strict", ZodTypeAny, { ...; }, { ...; }>' is not assignable to type 'ZodType'. The types of '_type.data' are incompatible between these types. Type '(UserCreateInput | UserUncheckedCreateInput) & (UserCreateInput | UserUncheckedCreateInput | undefined)' is not assignable to type '(Without & UserUncheckedCreateInput) | (Without<...> & UserCreateInput)'. Type 'UserCreateInput & UserUncheckedCreateInput' is not assignable to type '(Without & UserUncheckedCreateInput) | (Without<...> & UserCreateInput)'. Type 'UserCreateInput & UserUncheckedCreateInput' is not assignable to type 'Without & UserCreateInput'. Type 'UserCreateInput & UserUncheckedCreateInput' is not assignable to type 'Without'. Types of property 'lat' are incompatible. Type 'number' is not assignable to type 'undefined'. ``` I'm currently a bit stuck on how to solve this issue because I don't really know how to implement the `Without<...>` type especially because the `z.ZodType<...>` does not provide the object helper methods that would have been my first guess on how to approach this. Any help is appreciated.
ymc9 commented 1 year ago

Thanks for creating the issue @chrishoermann ! I'm working zenstack and hit by the same thing 😄.

cimchd commented 1 year ago

We have the same problem. Since almost 3 month now we are stuck to using zod in version 3.21.1. We put a resolutions entry at the top of our monorepo:

// package.json
{
  // ...
  "resolutions": {
    "zod": "<=3.21.1",
  }
}
ymc9 commented 1 year ago

This issue has been here for a while 😄. Just wondering if it's on the radar for a fix soon.

Intevel commented 1 year ago

It seems like this bug does not occur in v4.16.1 of Prisma 👍🏼

oceandrama commented 1 year ago

@Intevel No, I can confirm same error with prisma@4.16.1 and zod@3.21.4

Intevel commented 1 year ago

@Intevel No, I can confirm same error with prisma@14.16.1 and zod@3.21.4

Did you updated your @prisma/client aswell?

oceandrama commented 1 year ago

Did you updated your @prisma/client aswell?

Yes, sure

artem-alek commented 1 year ago

Waiting for an update as well. Stuck here too

chrishoermann commented 1 year ago

any news on this one? Is it confirmed as a bug yet?

ymc9 commented 1 year ago

If it's confirmed to be a bug, I'd like to try making a fix.

ymc9 commented 1 year ago

Hi @colinhacks , we need some attention here 😄. Many people build Prisma-related tools using zod and all likely blocked to some extent.

fer112233 commented 1 year ago

This issue needs to get more attention!

aronmal commented 1 year ago

I do agree. I sadly have switched to dirzzle for new projetcs by now.

laneme commented 10 months ago

Zod sure has a lot of open issues for a validation library. No wonder its the most used these days.

This is probably gonna take some time to get picked up without a random dev stepping in.

karthi-21 commented 10 months ago

Not only prisma, we recently encountered the same error with nextjs react-hook-forms zodResolver.

ksdaylight commented 9 months ago

Hope this problem can be solved .

Darkbound commented 7 months ago

Here to add some weight to the issue

dominic-schmid commented 7 months ago

I've got that same problem. Is there any workaround in the meantime (that isn't downgrading)?

CasperSK89 commented 7 months ago

We need this fixed :-)

rickylabs commented 6 months ago

Any news on this topic ? This is a blocking issue that prevent us to generate types from Prisma schema with latest Zod release

KenAdams-AK commented 6 months ago

setting up the following rule in tsconfig.json might be a solution.

{
    "compilerOptions": {
        "strictNullChecks": true   
    }
}
sergej2705 commented 6 months ago

When will the fix be released?

colinhacks commented 5 months ago

This fix has landed in zod@beta