Add import handling for external classes

[tvillaren]

Why

This PR adds support for imports.

The following input:

// source.ts
import { Person } from "@3rdparty/person";

export interface Hero {
  name: string;
  realPerson: Person;
}

will output

//output.ts

const personSchema = z.any();

export const heroSchema = z.object({
  name: z.string(),
  realPerson: personSchema,
});

[codecov-commenter]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (4f4e68e) 96.90% compared to head (fa6bfcc) 97.05%.

Files	Patch %	Lines
src/core/generateZodSchema.ts	75.00%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #135      +/-   ##
==========================================
+ Coverage   96.90%   97.05%   +0.15%     
==========================================
  Files          14       15       +1     
  Lines         742      782      +40     
  Branches      309      316       +7     
==========================================
+ Hits          719      759      +40     
  Misses         23       23              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tvillaren]

Blocked by #140

[tvillaren]

Hey @fabien0102,

Thank you for your recent update & merge.
Following those, here is proposal for a feature addition to handle non-relative imports. I already use it today (the only missing bit to ship it was the validation issue #140).

I acknowledge that this feature is a bit opinionated as it takes any non-relative import as not being a zod schema.
Happy to exchange about it here.

As a follow-up, I see an opening to handle relative imports as zod schemas (generated or not) and may open up the door to multi-file generation support eventually.

[dan-blank]

Thanks for the PR!

I acknowledge that this feature is a bit opinionated as it takes any non-relative import as not being a zod schema. Happy to exchange about it here.

I think this is a sensible default. One option came to my mind:

Use a comment to tell ts-to-zod that the import is assumed to be a zod schema.

// source.ts

import { Person } from "@3rdparty/person";

// ts-to-zod ImportIsZodSchema Person

export interface Hero {
  name: string;
  realPerson: Person;
}

Its semantics would be:

• Once we parsed // ts-to-zod ImportsIsZodSchema Person, we assume at every use site of Person that Person is a zod schema
• Does not work for * in imports. When encountering *, log an error ("Only works for explicit imports") and use the default (= assume that the import is not a zod schema)
• Does not work for as in imports. Also log and default.

It works for non-relative modules only, based on the principle that we might want to handle relative modules using the ts-to-zod conversion.

I don't understand the reasoning, could you explain/clarify in your OP? :)

[tvillaren]

The rationale behind using only non-relative imports for this feature was mostly based on the rationale that 3rd party imports had very little chance to be Zod Schema.

Relative imports, on the other hand, have maybe a higher chance to be a class / type / interface that is also transformed somewhere in the codebase into a zodSchema.
👉 For those, there are different handling strategies (like using JSTags-style comments) to tell the transpiler we have a zodSchema for this somewhere
👉 And I had as a future step to maybe fiddle with multiple file ts-to-zod (that would be based on relative imports obviously)

👉 In the meantime, it's quite easy to handle any imports as 3rd party ones and have specific JSTags comments in the future to handle zod schema (generated or referenced manually)

[tvillaren]

Hello @dan-blank, @fabien0102 👋

I updated this PR to allow any type of imports (non-relative and relative modules alltogether).
For now, it assumes that imports are to be used as z.instanceof(), I'm going to work on another PR to add JSTags for import statement to allow specifying when we reference a zod schema.

WDYT?

[anthony-dandrea]

Looks good here as well! Ran into the same small issue mentioned in your other PR.

[tvillaren]

Hello @fabien0102 , @schiller-manuel

After much discussions and thoughts, I reworked this Pull Request to support imports and generate a z.any() for all type references coming from an import.

It was previously using z.instanceof(ImportName) but it was an overlook from my side of the official documentation where instanceof is meant to be used only for imported Class (not types or interfaces).

Additionally, I had to update the fixOptionalAny bit that was added a couple of months ago to support type references as well.

But now this supports simply the imports, and I will rebase #148 to support imports of Zod Schemas as well.

[schiller-manuel]

looks good, would love to get this and #148 merged asap.
can you clean this up (see my comments) please?

[tvillaren]

Hey @schiller-manuel,

Thank you for you review, I just cleaned the two commented lines.
I'm working on #148 and will push an update ASAP.

Thanks.