Use `unknown` as the default any type rather than literal `{}`

[chrisui]

Context

Referencing the following code:

graphql-codegen-typescript-validation-schema/src/zod/index.ts

Line 36 in 8105f2b

new DeclarationBlock({}).asKind('type').withName('definedNonNullAny').withContent('{}').string,

Currently, with a custom scalar Date: Date (see graphql-codegen scalarMap config) we end up with type errors such as "{} is missing properties from Date toLocaleString, ..." etc.

Proposal

Replace {} with unknown would allow consumers of this library to cast as neccessary.

[wiksien]

I will fix that.

[Code-Hex]

@chrisui Thanks for your reporting!
This plugin has been developing under the assumption that it inherited the settings of the typescript plugin. for example

example/zod/schemas.ts:
    plugins:
      - ./dist/main/index.js:
          schema: zod
          scalars:
            Date: Date

It was supposed to create a schema that takes into account the Date object. This is a bug and will be fixed. (maybe by @wiksien ?)

[Code-Hex]

@chrisui Could you be more specific?
What kind of code are you trying to write that will cause the problem you are suggesting?

as you know this issue: colinhacks/zod#884

This also happens in z.unknown(), so I have to think of another way.
Let me take a look at your experience.

Thanks.

[wiksien]

@Code-Hex Just so I undestand correctly, I am supposed to import the Date value from ./dist/main/index.js and use it in DeclarationBlock? If the Date value is empty use unknown right? Is it possible for it to be empty?

[Code-Hex]

@wiksien Thanks.

I believe the Date object is just an example. The actual problem is "{} cannot convert to object" (maybe)

I didn't understand enough what he want actually. Maybe there are 2 candidates.

1. If @chrisui want to use Date object simply, we have to generate z.date() instead of definedNonNullAnySchema (very easy)
2. The problem is "{} cannot convert to object they wanted" then we have to consider to use z.unknown (too difficult)

I don't understand what do you mean "empty"? You said "optional or null" right?

Is it possible for it to be empty?

[wiksien]

@Code-Hex Yeah I meant null, sorry my bad, thought shortcut.

[Code-Hex]

@wiksien I see. If GraphQL schema like below and scalar Date as typed unknown will be generated types as nullable or optional

input Day {
  date: Date
}

then

export type Maybe<T> = T | null;
export type InputMaybe<T> = Maybe<T>;
export type Scalars = {
  ID: string;
  String: string;
  ... // some scalars
  Date: unknown;
};

export type Day = {
  date?: InputMaybe<Scalars['Date']>; // unknown | null | undefined
};

And also if it is required in GraphQL schema then generated like below.

export type Day = {
  date: Scalars['Date']; // unknown
};

---

I answer your questions

No, This project is used only typescript.

I am supposed to import the Date value from ./dist/main/index.js and use it in DeclarationBlock?

Yes, you can use z.unknown(). but if required, I think you can not use z.unknown() (colinhacks/zod#884)

If the Date value is empty use unknown right?

I think there is no method (but if you have a good code to suggest, please let me know.)

Is it possible for it to be empty?

[chrisui]

Hey, sorry for delay in reply.

I am passing scalars like the following into my codegen configuration block:

Date: 'Date',
Height: 'ProjectNamespace.Height',
Weight: 'ProjectNamespace.Weight',

In log output I see the following:

unhandled name: Height
unhandled name: Weight
unhandled name: Date

Upon inspecting the generated code anything that was using the Height or Weight scalars are now defined as definedNonNullAnySchema.

When I use this schema I cannot actually pass the shape of these scalars as I've defined because of type errors "{} is missing properties from Date toLocaleString, ...".

Ie. The following won't work

type example {
  dateOfBirth: Date!
}

const schema = z.object({dateOfBirth: definedNonNullAnySchema})
const data = schema.parse({dateOfBirth: new Date()})
const dateString = data.dateOfBirth.toLocaleString()

So just to confirm, I think that there are two issues: the default {} as "any" doesn't really provide any flexibility for fallbacks as even the generated code will not compile. There ideally needs to be a way to provide a generator for custom scalars.

Ps. Sorry for additional notifications as I accidentally submitted early and closed the issue by mistake.

[chrisui]

Is there an equivalent to graphql-codegen-zod's zodSchemasMap?

Docs: https://github.com/withshepherd/graphql-codegen-zod#configs

Example: https://github.com/withshepherd/graphql-codegen-zod/blob/main/codegen.yml#L13

[Code-Hex]

@chrisui Thanks for more details!

I got it. If it's really a problem, we should consider addressing the second.

2. The problem is "{} cannot convert to object they wanted" then we have to consider to use z.unknown (too difficult)

However, your use-case seems to work fine also using the definedNonNullAny type.

https://codesandbox.io/s/zod-example-forked-090ld?file=/src/index.ts:0-956

If there are any mistakes, please point me out. (or please reopen issue)

[Code-Hex]

@chrisui I hope this change would help you
#18