Export AstroConfigType properly as type and not as a Zod schema value

[shishkin]

This makes the intended usage of Zod generated types actually possible

Changes

• Export AstroConfigSchema as value instead of type
• Export AstroConfigType properly as type and not as a Zod schema value

Testing

Previously, type autocomplete was broken on AstroConfig (e.g. inside an integration hook). With this change the zod schema value is retained and can be used to generate the proper type, so autocomplete works (e.g. in packages/astro/src/@types/astro.ts for AstroConfig type).

Docs

No docs impacted. This fixes previously intended behavior that wasn't working.

[changeset-bot]

🦋 Changeset detected

Latest commit: 227254b

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[shishkin]

Now I'm clueless about the failing tests in https://github.com/withastro/astro/actions/runs/5588693525/jobs/10215913345?pr=7702#step:9:3338.

[ematipico]

@shishkin can you explain how you tested the feature? Maybe a screenshot to show this works now?

[shishkin]

@ematipico thanks for prompting me. I actually think my fix doesn't solve the problem I had.

The issue is that AstroConfig typing is not working in 3rd party integrations:

I see only integrations defined in @types/astro.ts.

I thought this was due to the zod schema instance being exported as a type while it must be a value for the z.output<typeof ...> magic to work.

However, now even with my change I'm not able to get the autocompletion in an external integration project, though types now work internally within the astro monorepo for me.

It seems the zod type generation combined with interface inheritance doesn't survive in the exported type definitions. I finally had to resort to zod way of inheritance to generate the final AstroConfig type.

With latest changes I'm able to see autocompletions in an external integration project:

[delucis]

I’m not sure this is currently not working. For example, in an integration I maintain, I already get autocomplete:

[shishkin]

@delucis: I’m not sure this is currently not working. For example, in an integration I maintain, I already get autocomplete

I've tested your delucis/astro-embed repo and indeed autocomplete worked out of the box. But when I upgraded typescript to 5.1.6 and switched tsconfig module resolution to nodenext I only saw integrations in the autocomplete.

[delucis]

Good to know! I tested in https://github.com/withastro/starlight but still helpful to know this may be something introduced with specific config/dependency versions.

[shishkin]

Is there an intention to merge this? Even if it's not an immediate concern for developers not using module resolution bundle or node16 there is still an error in how AstroConfigSchema is imported. If it's used as a value it can't be imported as a type.

[bluwy]

@shishkin Could the issue be that our dts exported is not node16 compatible? There's work regarding it there at #7787. I don't think we'd want to export Zod schema as value, that's leaning towards internal API. And we probably don't want runtime in the astro.ts file too.

[shishkin]

Yes, that makes sense. The issue is due to changes in module resolution bundler/node16. I can try to update the PR to ensure that the config package only exports a proper type instead of a zod schema value.

[shishkin]

@bluwy I've updated the PR to export the type and not the schema value. Hope this makes sense now and can be merged.