Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(nextjs): Accept redirectUrl as option for auth().protect() #2329

Merged
merged 7 commits into from
Dec 13, 2023

Conversation

panteliselef
Copy link
Member

@panteliselef panteliselef commented Dec 12, 2023

Description

This PR allows developers to call auth().protect() and pass to it a redirectUrl which can be used as the fallback instead of the standard 404 error that we currently throw.

import { auth } from '@clerk/nextjs/server';

// Authorization
auth().protect({ role:'org:admin' }, { redirectUrl:'/any-page' })
auth().protect({ permission:'org:settings:manage' }, { redirectUrl:'/any-page' })

// Authentication
auth().protect({ redirectUrl:'/any-page' })

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

@panteliselef panteliselef self-assigned this Dec 12, 2023
Copy link

changeset-bot bot commented Dec 12, 2023

🦋 Changeset detected

Latest commit: 6ccbdff

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

This PR includes changesets to release 1 package
Name Type
@clerk/nextjs 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

@panteliselef
Copy link
Member Author

@brkalow @nikosdouvlis Do you find this too annoying ? Types for params are already too complex.

auth().protect(undefined, { redirectUrl:'/any-page' })

@panteliselef
Copy link
Member Author

Avoid merging before the question above is answered

@brkalow
Copy link
Member

brkalow commented Dec 12, 2023

@panteliselef Is the alternative to adjust the types such that this is possible?

auth().protect({ redirectUrl: '/' })

I think I prefer this. ☝️ It feels like we're trying to dissuade people from using the option if they need to do this for the authn scenario:

auth().protect(undefined, { redirectUrl: '/' })

github-merge-queue bot pushed a commit that referenced this pull request Dec 13, 2023
…2329 (#2333)

* feat(nextjs): Accept `redirectUrl` as option for `auth().protect()`

* feat(nextjs): Allow for redirectUrl to be the first parameter

* chore(nextjs): Update changeset
@panteliselef panteliselef added this pull request to the merge queue Dec 13, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 13, 2023
Copy link
Member

@brkalow brkalow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

@panteliselef panteliselef added this pull request to the merge queue Dec 13, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Dec 13, 2023
@panteliselef panteliselef added this pull request to the merge queue Dec 13, 2023
Merged via the queue into main with commit 05bda49 Dec 13, 2023
8 checks passed
@panteliselef panteliselef deleted the elef/core-1219-redirect-url-in-protect branch December 13, 2023 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants