Support request-typed route definitions#1
Closed
EmanFateen wants to merge 3 commits into
Closed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
This PR carries the request generic through the function-first route definition APIs so typed route handlers and middleware can be registered without casts.
Specifically, it updates:
RouteDefinition<TRequest>to preserve the request type for route middleware and handlers.createRouteDefinition<TRequest>to accept typed middleware and handlers and return the typed route definition.Route<TRequest>to return the same typed route definition it creates.RouteDefinition<TRequest>when a request generic is supplied.Why
HttpScope<TRequest>andHttpMiddleware<TRequest>already support typed requests, but the routing registration path erased that type information back to the defaultHttpRequest. As a result, application code like this could not be registered without internal casts:This change aligns the function-first routing API with the existing request-generic HTTP types.
Validation
docker exec koalats-framework-container npm run builddocker exec koalats-framework-container npx eslint src/routing/definition/route-definition.ts src/routing/definition/create-route-definition.ts src/routing/route.ts src/routing/helpers/http-verb-helpers.ts tests/function-first-routing.e2e.test.tsdocker exec koalats-framework-container npx tsc -p tsconfig.eslint.jsonNote: the test-inclusive typecheck still reports two pre-existing unrelated E2E type errors in
tests/decorator-routing.e2e.test.tsandtests/security-authentication.e2e.test.ts.Related to koala-ts#183