fix!: Reorganize SDK types to tighten helpers around custom props #18
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.
Closes #17
This reworks how some types are represented within
arcjet
and@arcjet/next
to avoid passing rule types deep into the type tree. Instead, we'll now extract theExtraProps
at the SDK type so it no longer looks likeArcjet<Primitive<{}> | Product<{ email: string }>>
but insteadArcjet<{ email: string }>
. This allows us to tighten the props onwithArcjet
andcreateMiddleware
because they use theWithoutCustomProps
utility.This is a breaking change to
@arcjet/next
because I madecreateMiddleware
take the instantiated SDK instead of configuration, which made it easier to adjust these types.I also took the opportunity to remove some type utility exports because I wanted to rename the EmptyObject for a nicer type error message.
With these changes, this now provides a type error when you try to use
protectSignup
with the middleware: