fix(default-value): add flag to utilize generated enum types for default values

[sutt0n]

The latest of this wonderful plugin has unfortunately broken default values for us and this adds the options, useEnumTypeAsDefaultValue to utilize the actual code-generated enum instead of the stringified version and I've exposed the namingConvention configuration map -- specifically to target enumValues. I'm unsure if others are having this issue as it's very new, and this could very well be an edge-case; furthermore, that's why I've added it behind a flag.

Related PR: #529

The Problem

For example, if one were to have the following enum:

export enum GuyFieriQuotes {
  DinersDriveInsAndDives = "DINERS_DRIVEINS_AND_DIVES",
  Funkalicious = "FUNKALICIOUS",
  WelcomeToFlavortown = "WELCOME_TO_FLAVORTOWN"
}

export const GuyFieriQuotesSchema = z.nativeEnum(GuyFieriQuotes);

We then have the generated schema:

export function FlavortownInputSchema(): z.ZodObject<Properties<FlavortownInput>> {
  return {
    quote: GuyFieriQuotesSchema.default("WELCOME_TO_FLAVORTOWN"),
  };
}

This would throw the following type errors:

Argument of type '"WELCOME_TO_FLAVORTOWN"' is not assignable to parameter of type 'GuyFieriQuotesSchema'.

Output of Solution

Adding this fix/feature generates this output:

export function FlavortownInputSchema(): z.ZodObject<Properties<FlavortownInput>> {
  return {
    quote: GuyFieriQuotesSchema.default(GuyFieriQuotes.WelcomeToFlavortown),
  };
}

Edit: Addresses #640

[sutt0n]

Force push resolved a merge conflict with upstream pnpm-lock.yml.

[sutt0n]

@Code-Hex Any chance we can get this reviewed at your earliest convenience, please and thank you?

[Code-Hex]

@sutt0n I'm sorry for delay!

I check this PR

[sutt0n]

@Code-Hex No worries! I see you've updated your pnpm version -- should I do the same, as well? I'm presuming to 9.x?

[sutt0n]

@Code-Hex The most updated push is the correct one that both builds and passes lint successfully. I had a problem after rebasing from upstream, and fixed the lint errors after resolving said problem. 🙂

[Code-Hex]

@sutt0n Thanks! I will check this morning 🙏

[Code-Hex]

@sutt0n If you can fix the areas I commented on and also add valibot support, I'll merge it in!

[Code-Hex]

I don't know how to use it with just this, so I think it's better to describe the URL using @link
https://the-guild.dev/graphql/codegen/docs/config-reference/naming-convention

JSDoc: https://jsdoc.app/tags-inline-link

Btw, I think it would be confusing if the user uses transformUnderscore or typeNames as this feature is not applicable. is it possible to support transformUnderscore and typeNames? or write a comment?

[sutt0n]

@Code-Hex I don't believe that Valibot supports default values for enum/"picklist" types at the moment, it seems like a new library. I don't see anything on the documentation https://valibot.dev/guides/enums/ around enums/"picklists" supporting default values, nor the API for enums: https://valibot.dev/api/enum/

I'll disregard Valibot for now, as it's not possible.

[sutt0n]

@Code-Hex I've also added a comment for transformUnderscore and typeNames.

[sutt0n]

@Code-Hex I've rebased against main and this is ready for review now.

[Code-Hex]

@sutt0n Thanks! I agree ignore Valibot for now.
I'm sorry, but could you please add what you added to your comment in the README? I'll merge it once, so if you could make a PR for me, that would be great!

[Code-Hex]

I will merge this PR (#723) instead of this PR to resolve conflict.

Please just respond to this correspondence
#636 (comment)