zod `deepPartial` does not act as specified in the readme

[sneko]

Hi,

The readme (https://github.com/traversable/schema/tree/main/packages/zod#zxdeeppartial) says by default deepPartial adjusts the type, but it's not. I do have:

type MySchema = {
    a: number;
    b: {
        c: string;
    };
}

I have to use applyToOutputType into deepPartial so the type is:

type MySchema = {
    a?: number | undefined;
    b?: {
        c?: string | undefined;
    } | undefined;
}

So I guess at least the documentation should be fixed. Note that the official zod deepPartial in v3 was adjusting the type by default, so I would have thought applyToOutputType would be the default, and not semantic (that does no adjustment).

Thank you,

[ahrjarrett]

@sneko ah, good catch – I changed the default behavior at some point, and must have forgotten to update the docs. Thank you for opening an issue.

Feel free to open a PR if you'd like to contribute, otherwise I'll get on this after I finish work today.

[ahrjarrett]

Also, if you feel like applyToOutputType should be the default behavior, I'd be open to having a discussion about that. We're still pre-v1, so changing it wouldn't technically be considered a breaking.

[Jeto143]

Was very confused about this as well! Instictively I would be tempted to argue that this should definitely be the default behavior but my experience/knowledge about the package is about 1 hour old so there might be good reasons why it's not.

If this doesn't happen, this applyToOutputType flag should def be documented in the main readme.