fix: loosen the BaseSchema type #13734
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: d8a979a 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 |
github-actions
bot
added
the
pkg: astro
|
I'm not sure it's a good idea to allow any zod type. Pretty sure that will lead to confusion. An alternative maybe is to allow any type but check the schema shape when loading the config |
|
@florian-lefebvre until yesterday the type was |
|
True I forgot 😆 |
|
But I agree that it would to have a runtime check. Also non-trivial, as there's a lot of unwrapping to do and edge cases to handle, so maybe later. |
florian-lefebvre
approved these changes
Apr 30, 2025
Merged
openscript
pushed a commit
to openscript/astro
that referenced
this pull request
Sep 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Previously
BaseSchemaused recursive type definitions to try to define "any Zod object, or wrapper type that contains objects". This contained self-referencing types that collapsed toany, meaning there was no typechecking for schema defintions. #13706 fixed that by refactoring out the self-references. However this caused Starlight typechecks to fail (and presumably other sites). At its core, this is because Zod types are inherently recursive, so it's impossible to accurately type them without using recursive types, unless you manually define an arbitrary number of depth of reference. There will always be another layer of abstraction that some user (or more likely integration or library) wants to create.This PR throws it all away, and simply types
BaseSchemaasZodType. This is wider than we actually want: it accepts primitives other than objects. However, so doesany, so this is an improvement over that.Fixes #13713
Testing
The Starlight typecheck that was failing in ecosystem-ci is now passing.
Docs