Optional types in generated Typescript

[hardbyte]

Optional types don't appear to generate correct Typescript types without a serde skip_serializing_if annotation.

#[derive(Debug, Clone, Deserialize, reflectapi::Input)]
#[serde(deny_unknown_fields)]
pub struct ARequest {
    pub reflect_option: reflectapi::Option<String>,

    #[serde(default, skip_serializing_if = "reflectapi::Option::is_undefined")]
    pub annotated_reflect_option: reflectapi::Option<String>,

    pub std_option: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub annotated_std_option: Option<String>,
}

Produces the following typescript:

interface ARequest {
        reflect_option: string | null | undefined;
        annotated_reflect_option?: string | null | undefined;
        std_option: string | null;
        annotated_std_option?: string | null;
}

Assuming the first option is the recommended way to define optional types in reflectapi, the generated Typescript interface still requires a reflect_option to be included when defining an ARequest:

https://www.typescriptlang.org/play/?#code/FDCWDsBcFMCcDMCGBjaACAggJWgRwK7QDOkaA3sGldVbNPADbTKQD6A9gA6SjvgBcaErAgBzNAB804fAwaS0+cABN6EaMoDclGtUThw7SIhjLWdRszZcefAPyDhYhTLkKlq+Oq07dQyGY2vAL+IuDiUq4M2n5U+obGpqwkgdzBDqHOkbLRwAC+IEykIdh4hCRoALzkIHnaQA

[avkonst]

If you want pub reflect_option: reflectapi::Option<String>, to be not expected in the input, them you need to annotate it with #[serde(default)] . Not doing so, means the server expects it and so the client correctly generates it as a required property.

[hardbyte]

Must have missed that in the docs.

What is the point of the reflectapi::Option with its "allowed to not be defined variant" if it doesn't include marking something optional?

[andyyu2004]

We need to rename this type sometime to make it more obvious. This is a 3-state type where option is 2-state.

For reflectapi::Option:
undefined -> Undefined; null -> None

For normal options:
undefined -> None, null -> None.

If you care about distinguishing undefined and null you need to to use this type, and if you don't care you should always use a std::Option.

You'll note in the generated type it's T | null | undefined rather than T | null.
I think I understand what you're saying that it's missing the ?, but it's easy to just add serde(default) so I don't think this is worth changing.

[avkonst]

"if it doesn't include marking something optional?" it marks it is that we can not workaround the limitation of rust serde where you have to add default explicitly if you allow a property to be missed. Andy, potential improvement for this could be for Input to assert if serde(default) is missed for the property of the reflectapi::Option

…

On Mon, Feb 3, 2025 at 8:49 AM Brian Thorne ***@***.***> wrote: Must have missed that in the docs. What is the point of the reflectapi::Option with its "allowed to not be defined variant" if it doesn't include marking something optional? — Reply to this email directly, view it on GitHub <#76 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA6JSVPXVMM5M3OELGZ643L2NZZERAVCNFSM6AAAAABWB5OMLSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMRZGUZTAMRZGE> . You are receiving this because you commented.Message ID: ***@***.***>