Skip to content

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

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.

Sign up for GitHub

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

Merged
panteliselef merged 3 commits into from
Dec 13, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ed38a7
feat(nextjs): Accept `redirectUrl` as option for `auth().protect()`
panteliselef Dec 12, 2023
e7ed295
feat(nextjs): Allow for redirectUrl to be the first parameter
panteliselef Dec 13, 2023
3d9144d
chore(nextjs): Update changeset
panteliselef Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .changeset/thirty-chicken-divide.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/nextjs': patch
---

Accept `redirectUrl` as an option for `auth().protect()`.

For example:

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

// Authentication
auth().protect({ redirectUrl: "/any-page" })
```
51 changes: 37 additions & 14 deletions packages/nextjs/src/app-router/server/auth.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type {
CheckAuthorizationParamsWithCustomPermissions,
CheckAuthorizationWithCustomPermissions,
} from '@clerk/types';
import { notFound } from 'next/navigation';
import { notFound, redirect } from 'next/navigation';

import { authAuthHeaderMissing } from '../../server/errors';
import { buildClerkProps, createGetAuth } from '../../server/getAuth';
Expand All@@ -17,14 +17,23 @@ type AuthSignedIn = AuthObjectWithDeprecatedResources<
* This function is experimental as it throws a Nextjs notFound error if user is not authenticated or authorized.
* In the future we would investigate a way to throw a more appropriate error that clearly describes the not authorized of authenticated status.
*/
protect: (
params?:
| CheckAuthorizationParamsWithCustomPermissions
| ((has: CheckAuthorizationWithCustomPermissions) => boolean),
) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
protect: {
(
params?:
| CheckAuthorizationParamsWithCustomPermissions
| ((has: CheckAuthorizationWithCustomPermissions) => boolean),
options?: { redirectUrl: string },
): AuthObjectWithDeprecatedResources<SignedInAuthObject>;

(params?: { redirectUrl: string }): AuthObjectWithDeprecatedResources<SignedInAuthObject>;
};
}
>;

type ProtectGeneric = {
protect: (params?: unknown, options?: unknown) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
};

type AuthSignedOut = AuthObjectWithDeprecatedResources<
SignedOutAuthObject & {
/**
Expand All@@ -42,39 +51,53 @@ export const auth = () => {
noAuthStatusMessage: authAuthHeaderMissing(),
})(buildRequestLike());

(authObject as AuthSignedIn).protect = params => {
(authObject as unknown as ProtectGeneric).protect = (params: any, options: any) => {
const paramsOrFunction = params?.redirectUrl
? undefined
: (params as
| CheckAuthorizationParamsWithCustomPermissions
| ((has: CheckAuthorizationWithCustomPermissions) => boolean));
const redirectUrl = (params?.redirectUrl || options?.redirectUrl) as string | undefined;

const handleUnauthorized = (): never => {
if (redirectUrl) {
redirect(redirectUrl);
}
notFound();
};

/**
* User is not authenticated
*/
if (!authObject.userId) {
notFound();
return handleUnauthorized();
}

/**
* User is authenticated
*/
if (!params) {
if (!paramsOrFunction) {
return { ...authObject };
}

/**
* if a function is passed and returns false then throw not found
*/
if (typeof params === 'function') {
if (params(authObject.has)) {
if (typeof paramsOrFunction === 'function') {
if (paramsOrFunction(authObject.has)) {
return { ...authObject };
}
notFound();
return handleUnauthorized();
}

/**
* Checking if user is authorized when permission or role is passed
*/
if (authObject.has(params)) {
if (authObject.has(paramsOrFunction)) {
return { ...authObject };
}

notFound();
return handleUnauthorized();
};

return authObject as AuthSignedIn | AuthSignedOut;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(nextjs): Accept `redirectUrl` as option for `auth().protect()` #2329 by panteliselef · Pull Request #2333 · clerk/javascript · GitHub
Skip to content
feat(nextjs): Accept redirectUrl as option for auth().protect() #2329#2333

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 3 commits into

from

Dec 13, 2023
 Merged


feat(nextjs): Accept redirectUrl as option for auth().protect() #2329
#2333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5ed38a7

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


panteliselef Dec 12, 2023
e7ed295

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


panteliselef Dec 13, 2023
3d9144d

chore(nextjs): Update changeset


panteliselef Dec 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
.changeset/thirty-chicken-divide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/nextjs': patch
---

Accept `redirectUrl` as an option for `auth().protect()`.

For example:

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

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

51 changes: 37 additions & 14 deletions
packages/nextjs/src/app-router/server/auth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type {
 CheckAuthorizationParamsWithCustomPermissions,
 CheckAuthorizationWithCustomPermissions,
} from '@clerk/types';
import { notFound } from 'next/navigation';
import { notFound, redirect } from 'next/navigation';

import { authAuthHeaderMissing } from '../../server/errors';
import { buildClerkProps, createGetAuth } from '../../server/getAuth';
Expand All@@ -17,14 +17,23 @@ type AuthSignedIn = AuthObjectWithDeprecatedResources<
 * This function is experimental as it throws a Nextjs notFound error if user is not authenticated or authorized.
 * In the future we would investigate a way to throw a more appropriate error that clearly describes the not authorized of authenticated status.
 */
 protect: (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 ) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 protect: {
 (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 options?: { redirectUrl: string },
 ): AuthObjectWithDeprecatedResources<SignedInAuthObject>;

 (params?: { redirectUrl: string }): AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 };
 }
>;

type ProtectGeneric = {
 protect: (params?: unknown, options?: unknown) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
};

type AuthSignedOut = AuthObjectWithDeprecatedResources<
 SignedOutAuthObject & {
 /**
Expand All@@ -42,39 +51,53 @@ export const auth = () => {
 noAuthStatusMessage: authAuthHeaderMissing(),
 })(buildRequestLike());

 (authObject as AuthSignedIn).protect = params => {
 (authObject as unknown as ProtectGeneric).protect = (params: any, options: any) => {
 const paramsOrFunction = params?.redirectUrl
 ? undefined
 : (params as
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean));
 const redirectUrl = (params?.redirectUrl || options?.redirectUrl) as string | undefined;

 const handleUnauthorized = (): never => {
 if (redirectUrl) {
 redirect(redirectUrl);
 }
 notFound();
 };

 /**
 * User is not authenticated
 */
 if (!authObject.userId) {
notFound();
return handleUnauthorized();
 }

 /**
 * User is authenticated
 */
 if (!params) {
 if (!paramsOrFunction) {
 return { ...authObject };
 }

 /**
 * if a function is passed and returns false then throw not found
 */
 if (typeof params === 'function') {
 if (params(authObject.has)) {
 if (typeof paramsOrFunction === 'function') {
 if (paramsOrFunction(authObject.has)) {
 return { ...authObject };
 }
notFound();
return handleUnauthorized();
 }

 /**
 * Checking if user is authorized when permission or role is passed
 */
 if (authObject.has(params)) {
 if (authObject.has(paramsOrFunction)) {
 return { ...authObject };
 }

notFound();
return handleUnauthorized();
 };

 return authObject as AuthSignedIn | AuthSignedOut;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(nextjs): Accept `redirectUrl` as option for `auth().protect()` #2329 by panteliselef · Pull Request #2333 · clerk/javascript · GitHub
Skip to content
feat(nextjs): Accept redirectUrl as option for auth().protect() #2329#2333

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 3 commits into

from

Dec 13, 2023
 Merged


feat(nextjs): Accept redirectUrl as option for auth().protect() #2329
#2333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5ed38a7

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


panteliselef Dec 12, 2023
e7ed295

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


panteliselef Dec 13, 2023
3d9144d

chore(nextjs): Update changeset


panteliselef Dec 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
.changeset/thirty-chicken-divide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/nextjs': patch
---

Accept `redirectUrl` as an option for `auth().protect()`.

For example:

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

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

51 changes: 37 additions & 14 deletions
packages/nextjs/src/app-router/server/auth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type {
 CheckAuthorizationParamsWithCustomPermissions,
 CheckAuthorizationWithCustomPermissions,
} from '@clerk/types';
import { notFound } from 'next/navigation';
import { notFound, redirect } from 'next/navigation';

import { authAuthHeaderMissing } from '../../server/errors';
import { buildClerkProps, createGetAuth } from '../../server/getAuth';
Expand All@@ -17,14 +17,23 @@ type AuthSignedIn = AuthObjectWithDeprecatedResources<
 * This function is experimental as it throws a Nextjs notFound error if user is not authenticated or authorized.
 * In the future we would investigate a way to throw a more appropriate error that clearly describes the not authorized of authenticated status.
 */
 protect: (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 ) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 protect: {
 (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 options?: { redirectUrl: string },
 ): AuthObjectWithDeprecatedResources<SignedInAuthObject>;

 (params?: { redirectUrl: string }): AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 };
 }
>;

type ProtectGeneric = {
 protect: (params?: unknown, options?: unknown) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
};

type AuthSignedOut = AuthObjectWithDeprecatedResources<
 SignedOutAuthObject & {
 /**
Expand All@@ -42,39 +51,53 @@ export const auth = () => {
 noAuthStatusMessage: authAuthHeaderMissing(),
 })(buildRequestLike());

 (authObject as AuthSignedIn).protect = params => {
 (authObject as unknown as ProtectGeneric).protect = (params: any, options: any) => {
 const paramsOrFunction = params?.redirectUrl
 ? undefined
 : (params as
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean));
 const redirectUrl = (params?.redirectUrl || options?.redirectUrl) as string | undefined;

 const handleUnauthorized = (): never => {
 if (redirectUrl) {
 redirect(redirectUrl);
 }
 notFound();
 };

 /**
 * User is not authenticated
 */
 if (!authObject.userId) {
notFound();
return handleUnauthorized();
 }

 /**
 * User is authenticated
 */
 if (!params) {
 if (!paramsOrFunction) {
 return { ...authObject };
 }

 /**
 * if a function is passed and returns false then throw not found
 */
 if (typeof params === 'function') {
 if (params(authObject.has)) {
 if (typeof paramsOrFunction === 'function') {
 if (paramsOrFunction(authObject.has)) {
 return { ...authObject };
 }
notFound();
return handleUnauthorized();
 }

 /**
 * Checking if user is authorized when permission or role is passed
 */
 if (authObject.has(params)) {
 if (authObject.has(paramsOrFunction)) {
 return { ...authObject };
 }

notFound();
return handleUnauthorized();
 };

 return authObject as AuthSignedIn | AuthSignedOut;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', '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('^' + ".*" + '
feat(nextjs): Accept `redirectUrl` as option for `auth().protect()` #2329 by panteliselef · Pull Request #2333 · clerk/javascript · GitHub
Skip to content
feat(nextjs): Accept redirectUrl as option for auth().protect() #2329#2333

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 3 commits into

from

Dec 13, 2023
 Merged


feat(nextjs): Accept redirectUrl as option for auth().protect() #2329
#2333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5ed38a7

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


panteliselef Dec 12, 2023
e7ed295

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


panteliselef Dec 13, 2023
3d9144d

chore(nextjs): Update changeset


panteliselef Dec 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
.changeset/thirty-chicken-divide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/nextjs': patch
---

Accept `redirectUrl` as an option for `auth().protect()`.

For example:

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

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

51 changes: 37 additions & 14 deletions
packages/nextjs/src/app-router/server/auth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type {
 CheckAuthorizationParamsWithCustomPermissions,
 CheckAuthorizationWithCustomPermissions,
} from '@clerk/types';
import { notFound } from 'next/navigation';
import { notFound, redirect } from 'next/navigation';

import { authAuthHeaderMissing } from '../../server/errors';
import { buildClerkProps, createGetAuth } from '../../server/getAuth';
Expand All@@ -17,14 +17,23 @@ type AuthSignedIn = AuthObjectWithDeprecatedResources<
 * This function is experimental as it throws a Nextjs notFound error if user is not authenticated or authorized.
 * In the future we would investigate a way to throw a more appropriate error that clearly describes the not authorized of authenticated status.
 */
 protect: (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 ) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 protect: {
 (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 options?: { redirectUrl: string },
 ): AuthObjectWithDeprecatedResources<SignedInAuthObject>;

 (params?: { redirectUrl: string }): AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 };
 }
>;

type ProtectGeneric = {
 protect: (params?: unknown, options?: unknown) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
};

type AuthSignedOut = AuthObjectWithDeprecatedResources<
 SignedOutAuthObject & {
 /**
Expand All@@ -42,39 +51,53 @@ export const auth = () => {
 noAuthStatusMessage: authAuthHeaderMissing(),
 })(buildRequestLike());

 (authObject as AuthSignedIn).protect = params => {
 (authObject as unknown as ProtectGeneric).protect = (params: any, options: any) => {
 const paramsOrFunction = params?.redirectUrl
 ? undefined
 : (params as
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean));
 const redirectUrl = (params?.redirectUrl || options?.redirectUrl) as string | undefined;

 const handleUnauthorized = (): never => {
 if (redirectUrl) {
 redirect(redirectUrl);
 }
 notFound();
 };

 /**
 * User is not authenticated
 */
 if (!authObject.userId) {
notFound();
return handleUnauthorized();
 }

 /**
 * User is authenticated
 */
 if (!params) {
 if (!paramsOrFunction) {
 return { ...authObject };
 }

 /**
 * if a function is passed and returns false then throw not found
 */
 if (typeof params === 'function') {
 if (params(authObject.has)) {
 if (typeof paramsOrFunction === 'function') {
 if (paramsOrFunction(authObject.has)) {
 return { ...authObject };
 }
notFound();
return handleUnauthorized();
 }

 /**
 * Checking if user is authorized when permission or role is passed
 */
 if (authObject.has(params)) {
 if (authObject.has(paramsOrFunction)) {
 return { ...authObject };
 }

notFound();
return handleUnauthorized();
 };

 return authObject as AuthSignedIn | AuthSignedOut;
Expand Down

, '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" + '
feat(nextjs): Accept `redirectUrl` as option for `auth().protect()` #2329 by panteliselef · Pull Request #2333 · clerk/javascript · GitHub
Skip to content
feat(nextjs): Accept redirectUrl as option for auth().protect() #2329#2333

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 3 commits into

from

Dec 13, 2023
 Merged


feat(nextjs): Accept redirectUrl as option for auth().protect() #2329
#2333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5ed38a7

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


panteliselef Dec 12, 2023
e7ed295

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


panteliselef Dec 13, 2023
3d9144d

chore(nextjs): Update changeset


panteliselef Dec 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
.changeset/thirty-chicken-divide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/nextjs': patch
---

Accept `redirectUrl` as an option for `auth().protect()`.

For example:

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

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

51 changes: 37 additions & 14 deletions
packages/nextjs/src/app-router/server/auth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type {
 CheckAuthorizationParamsWithCustomPermissions,
 CheckAuthorizationWithCustomPermissions,
} from '@clerk/types';
import { notFound } from 'next/navigation';
import { notFound, redirect } from 'next/navigation';

import { authAuthHeaderMissing } from '../../server/errors';
import { buildClerkProps, createGetAuth } from '../../server/getAuth';
Expand All@@ -17,14 +17,23 @@ type AuthSignedIn = AuthObjectWithDeprecatedResources<
 * This function is experimental as it throws a Nextjs notFound error if user is not authenticated or authorized.
 * In the future we would investigate a way to throw a more appropriate error that clearly describes the not authorized of authenticated status.
 */
 protect: (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 ) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 protect: {
 (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 options?: { redirectUrl: string },
 ): AuthObjectWithDeprecatedResources<SignedInAuthObject>;

 (params?: { redirectUrl: string }): AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 };
 }
>;

type ProtectGeneric = {
 protect: (params?: unknown, options?: unknown) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
};

type AuthSignedOut = AuthObjectWithDeprecatedResources<
 SignedOutAuthObject & {
 /**
Expand All@@ -42,39 +51,53 @@ export const auth = () => {
 noAuthStatusMessage: authAuthHeaderMissing(),
 })(buildRequestLike());

 (authObject as AuthSignedIn).protect = params => {
 (authObject as unknown as ProtectGeneric).protect = (params: any, options: any) => {
 const paramsOrFunction = params?.redirectUrl
 ? undefined
 : (params as
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean));
 const redirectUrl = (params?.redirectUrl || options?.redirectUrl) as string | undefined;

 const handleUnauthorized = (): never => {
 if (redirectUrl) {
 redirect(redirectUrl);
 }
 notFound();
 };

 /**
 * User is not authenticated
 */
 if (!authObject.userId) {
notFound();
return handleUnauthorized();
 }

 /**
 * User is authenticated
 */
 if (!params) {
 if (!paramsOrFunction) {
 return { ...authObject };
 }

 /**
 * if a function is passed and returns false then throw not found
 */
 if (typeof params === 'function') {
 if (params(authObject.has)) {
 if (typeof paramsOrFunction === 'function') {
 if (paramsOrFunction(authObject.has)) {
 return { ...authObject };
 }
notFound();
return handleUnauthorized();
 }

 /**
 * Checking if user is authorized when permission or role is passed
 */
 if (authObject.has(params)) {
 if (authObject.has(paramsOrFunction)) {
 return { ...authObject };
 }

notFound();
return handleUnauthorized();
 };

 return authObject as AuthSignedIn | AuthSignedOut;
Expand Down

, '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('^' + ".*" + '
feat(nextjs): Accept `redirectUrl` as option for `auth().protect()` #2329 by panteliselef · Pull Request #2333 · clerk/javascript · GitHub
Skip to content
feat(nextjs): Accept redirectUrl as option for auth().protect() #2329#2333

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 3 commits into

from

Dec 13, 2023
 Merged


feat(nextjs): Accept redirectUrl as option for auth().protect() #2329
#2333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5ed38a7

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


panteliselef Dec 12, 2023
e7ed295

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


panteliselef Dec 13, 2023
3d9144d

chore(nextjs): Update changeset


panteliselef Dec 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
.changeset/thirty-chicken-divide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/nextjs': patch
---

Accept `redirectUrl` as an option for `auth().protect()`.

For example:

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

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

51 changes: 37 additions & 14 deletions
packages/nextjs/src/app-router/server/auth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type {
 CheckAuthorizationParamsWithCustomPermissions,
 CheckAuthorizationWithCustomPermissions,
} from '@clerk/types';
import { notFound } from 'next/navigation';
import { notFound, redirect } from 'next/navigation';

import { authAuthHeaderMissing } from '../../server/errors';
import { buildClerkProps, createGetAuth } from '../../server/getAuth';
Expand All@@ -17,14 +17,23 @@ type AuthSignedIn = AuthObjectWithDeprecatedResources<
 * This function is experimental as it throws a Nextjs notFound error if user is not authenticated or authorized.
 * In the future we would investigate a way to throw a more appropriate error that clearly describes the not authorized of authenticated status.
 */
 protect: (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 ) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 protect: {
 (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 options?: { redirectUrl: string },
 ): AuthObjectWithDeprecatedResources<SignedInAuthObject>;

 (params?: { redirectUrl: string }): AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 };
 }
>;

type ProtectGeneric = {
 protect: (params?: unknown, options?: unknown) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
};

type AuthSignedOut = AuthObjectWithDeprecatedResources<
 SignedOutAuthObject & {
 /**
Expand All@@ -42,39 +51,53 @@ export const auth = () => {
 noAuthStatusMessage: authAuthHeaderMissing(),
 })(buildRequestLike());

 (authObject as AuthSignedIn).protect = params => {
 (authObject as unknown as ProtectGeneric).protect = (params: any, options: any) => {
 const paramsOrFunction = params?.redirectUrl
 ? undefined
 : (params as
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean));
 const redirectUrl = (params?.redirectUrl || options?.redirectUrl) as string | undefined;

 const handleUnauthorized = (): never => {
 if (redirectUrl) {
 redirect(redirectUrl);
 }
 notFound();
 };

 /**
 * User is not authenticated
 */
 if (!authObject.userId) {
notFound();
return handleUnauthorized();
 }

 /**
 * User is authenticated
 */
 if (!params) {
 if (!paramsOrFunction) {
 return { ...authObject };
 }

 /**
 * if a function is passed and returns false then throw not found
 */
 if (typeof params === 'function') {
 if (params(authObject.has)) {
 if (typeof paramsOrFunction === 'function') {
 if (paramsOrFunction(authObject.has)) {
 return { ...authObject };
 }
notFound();
return handleUnauthorized();
 }

 /**
 * Checking if user is authorized when permission or role is passed
 */
 if (authObject.has(params)) {
 if (authObject.has(paramsOrFunction)) {
 return { ...authObject };
 }

notFound();
return handleUnauthorized();
 };

 return authObject as AuthSignedIn | AuthSignedOut;
Expand Down

, '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()` #2329 by panteliselef · Pull Request #2333 · clerk/javascript · GitHub
Skip to content
feat(nextjs): Accept redirectUrl as option for auth().protect() #2329#2333

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 3 commits into

from

Dec 13, 2023
 Merged


feat(nextjs): Accept redirectUrl as option for auth().protect() #2329
#2333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
5ed38a7

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


panteliselef Dec 12, 2023
e7ed295

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


panteliselef Dec 13, 2023
3d9144d

chore(nextjs): Update changeset


panteliselef Dec 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


16 changes: 16 additions & 0 deletions
.changeset/thirty-chicken-divide.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
---
'@clerk/nextjs': patch
---

Accept `redirectUrl` as an option for `auth().protect()`.

For example:

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

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

51 changes: 37 additions & 14 deletions
packages/nextjs/src/app-router/server/auth.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ import type {
 CheckAuthorizationParamsWithCustomPermissions,
 CheckAuthorizationWithCustomPermissions,
} from '@clerk/types';
import { notFound } from 'next/navigation';
import { notFound, redirect } from 'next/navigation';

import { authAuthHeaderMissing } from '../../server/errors';
import { buildClerkProps, createGetAuth } from '../../server/getAuth';
Expand All@@ -17,14 +17,23 @@ type AuthSignedIn = AuthObjectWithDeprecatedResources<
 * This function is experimental as it throws a Nextjs notFound error if user is not authenticated or authorized.
 * In the future we would investigate a way to throw a more appropriate error that clearly describes the not authorized of authenticated status.
 */
 protect: (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 ) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 protect: {
 (
 params?:
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
 options?: { redirectUrl: string },
 ): AuthObjectWithDeprecatedResources<SignedInAuthObject>;

 (params?: { redirectUrl: string }): AuthObjectWithDeprecatedResources<SignedInAuthObject>;
 };
 }
>;

type ProtectGeneric = {
 protect: (params?: unknown, options?: unknown) => AuthObjectWithDeprecatedResources<SignedInAuthObject>;
};

type AuthSignedOut = AuthObjectWithDeprecatedResources<
 SignedOutAuthObject & {
 /**
Expand All@@ -42,39 +51,53 @@ export const auth = () => {
 noAuthStatusMessage: authAuthHeaderMissing(),
 })(buildRequestLike());

 (authObject as AuthSignedIn).protect = params => {
 (authObject as unknown as ProtectGeneric).protect = (params: any, options: any) => {
 const paramsOrFunction = params?.redirectUrl
 ? undefined
 : (params as
 | CheckAuthorizationParamsWithCustomPermissions
 | ((has: CheckAuthorizationWithCustomPermissions) => boolean));
 const redirectUrl = (params?.redirectUrl || options?.redirectUrl) as string | undefined;

 const handleUnauthorized = (): never => {
 if (redirectUrl) {
 redirect(redirectUrl);
 }
 notFound();
 };

 /**
 * User is not authenticated
 */
 if (!authObject.userId) {
notFound();
return handleUnauthorized();
 }

 /**
 * User is authenticated
 */
 if (!params) {
 if (!paramsOrFunction) {
 return { ...authObject };
 }

 /**
 * if a function is passed and returns false then throw not found
 */
 if (typeof params === 'function') {
 if (params(authObject.has)) {
 if (typeof paramsOrFunction === 'function') {
 if (paramsOrFunction(authObject.has)) {
 return { ...authObject };
 }
notFound();
return handleUnauthorized();
 }

 /**
 * Checking if user is authorized when permission or role is passed
 */
 if (authObject.has(params)) {
 if (authObject.has(paramsOrFunction)) {
 return { ...authObject };
 }

notFound();
return handleUnauthorized();
 };

 return authObject as AuthSignedIn | AuthSignedOut;
Expand Down