RobinTail / express-zod-api / 31729488212

100%

push

github

feat: Endpoint-specific status codes (#3621)

Based on discussion #3571 

Added `statusCode` option both to `BuildProps` of
`EndpointsFactory::build()` and to `Middleware::construcor()`. Those can
override the status codes configured at the ResultHandler level in a
very specific way:
- When ResultHandler defines a single schema, we override the codes
assuming the specifics of the Endpoint and the fact that the
ResultHandler treats all cases consistently;
- When ResultHandler defines multiple schemas for different status
codes, we intersect, assumming the narrowing nature of the gives codes:
- if the intersection comes empty, we throw due to inability to figure
out how exactly the ResultHandler would respond for the unlisted code

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
  * Endpoints and middleware can declare custom HTTP status codes.
* Status codes are combined and deduplicated across endpoint and
middleware configuration.
* API responses and generated documentation include only declared,
matching status codes.
* Rate-limit middleware supports custom status codes and retains `429`
by default.
* Invalid or unmatched status-code configurations are reported clearly.

* **Documentation**
* Added guidance and examples for response overrides, authentication
interruptions, and rate limiting.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

1088 of 1140 branches covered (95.44%)

25 of 25 new or added lines in 5 files covered. (100.0%)

1561 of 1561 relevant lines covered (100.0%)

582.96 hits per line