Improve types in server-side withPageAuthRequired

[misoton665]

By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

This PR is about server-side withPageAuthRequired.
Because withPageAuthRequired does not accept Query as a type parameter, it's returned GetServerSideProps with a default Query type of ParsedUrlQuery.

withPageAuthRequired({
  getServerSideProps,
  returnTo: "/foo/bar"
});

The type of this will be GetServerSideProps<P, ParsedUrlQuery> no matter what type of getServerSideProps is passed.

In this PR, withPageAuthRequired has been changed so that Query can also be specified as a type parameter.

Testing

Since this is a modification of the type definition, no tests have been added.

• This change adds test coverage for new/changed/fixed functionality

Checklist

• I have added documentation for new/changed functionality in this PR or in auth0.com/docs
• All active GitHub checks for tests, formatting, and security are passing
• The correct base branch is being used, if not main

[vercel]

@misoton665 is attempting to deploy a commit to the Auth0 Team on Vercel.

A member of the Team first needs to authorize it.

[misoton665]

What is the status of this PR?
I believe it is reviewing, but if there is anything I need to do before that, please let me know.

[adamjmcgrath]

Hi @misoton665 - thanks for raising this, apologies for the delay, I haven't got round to looking at this yet. I will do shortly

[adamjmcgrath]

Hi @misoton665

If I add a single type parameter to the server side version of withPageAuthRequired then I get a TS error, because it wants me to use the client side version of the overload

I think you need to add a default type argument of ParsedUrlQuery to

nextjs-auth0/src/helpers/with-page-auth-required.ts

Line 91 in 196d16d

<P, Q extends ParsedUrlQuery>(opts?: WithPageAuthRequiredOptions<P, Q>): PageRoute<P, Q>;

[misoton665]

@adamjmcgrath
Thank you for confirming this.
I've added a commit to give default parameters.
7315459

[adamjmcgrath]

Thanks @misoton665