Export UserProps for use in higher-order components

[jamesarosen]

Checklist

• I have looked into the Readme, Examples, and FAQ and have not found a suitable solution or answer.
• I have looked into the API documentation and have not found a suitable solution or answer.
• I have searched the issues and have not found a suitable solution or answer.
• I have searched the Auth0 Community forums and have not found a suitable solution or answer.
• I agree to the terms within the Auth0 Code of Conduct.

Describe the problem you'd like to have solved

It would be nice to have UserProps exported so application developers can use it in their own code. For example,

export const withAdmin = <T extends UserProps = UserProps>(
  page: ComponentType<T>
) => {
  const PageWithAdminRequired = (props: T) => {
    const { user } = useUser()
    const router = useRouter()

    if (!isAdmin(user)) {
      router.push('/')
      return null
    }

    return <Page {...props} />
  }

  PageWithAdminRequired.displayName = `${Page.displayName}WithAdminRequired`

  return Page
}

Describe the ideal solution

#574 extracted the UserProps type. It would be nice to have that available in client code.

Alternatives and current workarounds

For now, I have this in my code:

/**
 * @auth0/nextjs-auth doesn't export this, so we copy the definition.
 * @see @auth0/nextjs-auth0/client/with-page-auth-required
 */
export type UserProps = { user: UserProfile };

Additional context

No response

[mrplotify]

This makes sense that TS clients know exactly what shape the user object will be.