') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); feat(nextjs): Accept `redirectUrl` as option for `auth().protect()` by panteliselef · Pull Request #2329 · clerk/javascript · GitHub
Skip to content

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

Merged
panteliselef merged 7 commits into
mainfrom
elef/core-1219-redirect-url-in-protect
Dec 13, 2023
Merged

feat(nextjs): Accept redirectUrl as option for auth().protect()#2329
panteliselef merged 7 commits into
mainfrom
elef/core-1219-redirect-url-in-protect

Conversation

@panteliselef

@panteliselefpanteliselef commented Dec 12, 2023•
edited by brkalow
Loading

Copy link
Copy Markdown
Contributor

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';// Authorizationauth().protect({role:'org:admin'},{redirectUrl:'/any-page'})auth().protect({permission:'org:settings:manage'},{redirectUrl:'/any-page'})// Authenticationauth().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

@panteliselefpanteliselef self-assigned this Dec 12, 2023
@changeset-bot

changeset-botBot commented Dec 12, 2023•
edited
Loading

Copy link
Copy Markdown

🦋 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
NameType
@clerk/nextjsPatch

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

panteliselef commented Dec 12, 2023

Copy link
Copy Markdown
ContributorAuthor

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

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

@panteliselef

panteliselef commented Dec 12, 2023

Copy link
Copy Markdown
ContributorAuthor

Avoid merging before the question above is answered

@brkalow

brkalow commented Dec 12, 2023•
edited
Loading

Copy link
Copy Markdown
Member

@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: '/'})

LekoArts
LekoArts reviewed Dec 13, 2023
View reviewed changes
Comment thread.changeset/thirty-chicken-divide.md Outdated
@panteliselefpanteliselef mentioned this pull request Dec 13, 2023
Merged
24 tasks
github-merge-queueBot pushed a commit that referenced this pull request Dec 13, 2023
@panteliselef
feat(nextjs): AcceptredirectUrlas option forauth().protect()#…
96b9bb5
…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-queueBot removed this pull request from the merge queue due to failed status checks Dec 13, 2023
brkalow
brkalow approved these changes Dec 13, 2023
View reviewed changes

@brkalowbrkalow left a comment

Copy link
Copy Markdown
Member

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-queueBot 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 05bda49Dec 13, 2023
@panteliselef
panteliselef deleted the elef/core-1219-redirect-url-in-protect branch December 13, 2023 21:03
@clerk-cookieclerk-cookie mentioned this pull request Dec 13, 2023
Merged
@LekoArtsLekoArts mentioned this pull request Mar 13, 2024
Merged
@LekoArtsLekoArts mentioned this pull request Aug 2, 2024
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@brkalowbrkalowbrkalow approved these changes
@nikosdouvlisnikosdouvlisAwaiting requested review from nikosdouvlis
+3 more reviewers
@LekoArtsLekoArtsLekoArts left review comments
@dimkldimkldimkl approved these changes
@chanioxarischanioxarischanioxaris approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@panteliselefpanteliselef

Labels

nextjs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@panteliselef@brkalow@dimkl@LekoArts@chanioxaris@clerk-cookie