Alt: Improving final intersection
Fixes #2760 Alternative implementation to #2761
I like this one more for being more explicit.
Walkthrough
The changes update core type definitions to allow input schemas to be undefined in the EndpointsFactory and related utilities. A new ConditionalIntersection type replaces direct intersection types to handle optional schemas. Type constraints, return types, and method signatures are adjusted accordingly. Tests are enhanced to verify stricter type equality and input property handling.
Changes
| File(s) | Change Summary |
|---|---|
| express-zod-api/src/endpoints-factory.ts | Allowed undefined for generic input schema parameters; replaced z.ZodIntersection with ConditionalIntersection in types and methods. |
| express-zod-api/src/io-schema.ts | Added ConditionalIntersection type alias; updated getFinalEndpointInputSchema to use it and accept undefined generics. |
| express-zod-api/tests/endpoints-factory.spec.ts | Added tests for excessive property handling; changed type assertions from toExtend to toEqualTypeOf; updated generic parameter assertions. |
Sequence Diagram(s)
sequenceDiagram
participant Developer
participant EndpointsFactory
participant Handler
Developer->>EndpointsFactory: build({ input: schema | undefined, ... })
EndpointsFactory->>Handler: handler({ input: ConditionalIntersection<MIN, IN> })
Handler-->>EndpointsFactory: Returns output
Assessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
Ensure accessing undefined input properties results in a TypeScript error, not never type (#2760) |
✅ |
Poem
In the warren of types, a fix hops in—
Undefined inputs now handled with a grin!
No more “never” when you typo a key,
TypeScript will bark, as clear as can be.
With intersections smart and schemas anew,
Bugs in the garden are fewer—woohoo!
🐇✨
📜 Recent review details
Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro
📥 Commits
Reviewing files that changed from the base of the PR and between 058c258b898c138778cac9a0e4b7cf088777922e and 98d4995df0a869683085d868a2fd8ef145191b0b.
📒 Files selected for processing (1)
CHANGELOG.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- CHANGELOG.md
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and explain its main purpose.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.