Page authenticate role

[siddhsuresh]

Closes: #2399

What are the changes and their implications?

• add option role to the authenicate property to authorize users depending on their role

Values that can be passed to role property is string or an array of strings

Used the following convention [mentioned in the issue]

// user must be logged in
Page.authenticate = true 
// user must be logged in and redirects otherwise
Page.authenticate = { redirectTo: "/login" }
// user must be logged in and with role "ADMIN" or "USER"
Page.authenticate = { role: ["ADMIN", "USER"] }
// user must be logged in with role "ADMIN" and redirects otherwise
Page.authenticate = { role: "ADMIN", redirectTo: "/login" }

Feature Checklist

• Changeset added (run pnpm changeset in the root directory)
• fixed test in packages\blitz-auth\src\client\auth-client.test.ts to show role as public
• Documentation added/updated (submit PR to blitzjs.com repo main branch)

[changeset-bot]

🦋 Changeset detected

Latest commit: 7da9bb0

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages

Name	Type
@blitzjs/auth	Patch
@blitzjs/next	Patch
@blitzjs/rpc	Patch
@blitzjs/codemod	Patch
@blitzjs/config	Patch
@blitzjs/generator	Patch
blitz	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[itsdillon]

@siddhsuresh Were you able to update the docs with this? Great job as always!

[siddhsuresh]

@siddhsuresh Were you able to update the docs with this? Great job as always!

@dillonraphael I linked the updated docs PR

[itsdillon]

Sorry @siddhsuresh, can we just get the conflicts resolved? Going to get this merged and released.

[siddhsuresh]

Sorry @siddhsuresh, can we just get the conflicts resolved? Going to get this merged and released.

@dillonraphael I resolved the merge conflict