Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/quiet-terms-drum.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/ui': patch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this also touches shared and clerk-js

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

thanks! will update after some more local testing later

'@clerk/clerk-js': patch
'@clerk/shared': patch
---

Correctly display OAuth consent redirect domains for known multi-label public suffixes.
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/modules/oauthApplication/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,16 @@ import { BaseResource } from '../../resources/internal';

export class OAuthApplication implements OAuthApplicationNamespace {
async getConsentInfo(params: GetOAuthConsentInfoParams): Promise<OAuthConsentInfo> {
const { oauthClientId, scope } = params;
const { oauthClientId, scope, redirectUri } = params;
const search = {
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirect_uri: redirectUri }),
};
const json = await BaseResource._fetch<OAuthConsentInfoJSON>(
{
method: 'GET',
path: `/me/oauth/consent/${encodeURIComponent(oauthClientId)}`,
search: scope !== undefined ? { scope } : undefined,
search: Object.keys(search).length > 0 ? search : undefined,
},
{ skipUpdateClient: true },
);
Expand All@@ -31,6 +35,7 @@ export class OAuthApplication implements OAuthApplicationNamespace {
oauthApplicationUrl: data.oauth_application_url,
clientId: data.client_id,
state: data.state,
redirectDomain: data.redirect_domain,
scopes:
data.scopes?.map(s => ({
scope: s.scope,
Expand Down
21 changes: 13 additions & 8 deletions packages/shared/src/react/hooks/useOAuthConsent.shared.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
import { useMemo } from 'react';

import type { GetOAuthConsentInfoParams } from '../../types';
import { STABLE_KEYS } from '../stable-keys';
import { createCacheKeys } from './createCacheKeys';

export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthClientId: string; scope?: string }) {
const { userId, oauthClientId, scope } = params;
export function useOAuthConsentCacheKeys(params: {
userId: string | null;
oauthClientId: string;
scope?: string;
redirectUri?: string;
}) {
const { userId, oauthClientId, scope, redirectUri } = params;
return useMemo(() => {
const args: Pick<GetOAuthConsentInfoParams, 'oauthClientId'> & { scope?: string } = { oauthClientId };
if (scope !== undefined) {
args.scope = scope;
}
const args = {
oauthClientId,
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirectUri }),
};
return createCacheKeys({
stablePrefix: STABLE_KEYS.OAUTH_CONSENT_INFO_KEY,
authenticated: true,
Expand All@@ -21,5 +26,5 @@ export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthC
args,
},
});
}, [userId, oauthClientId, scope]);
}, [userId, oauthClientId, scope, redirectUri]);
}
10 changes: 5 additions & 5 deletions packages/shared/src/react/hooks/useOAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const HOOK_NAME = 'useOAuthConsent';
export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentReturn {
useAssertWrappedByClerkProvider(HOOK_NAME);

const { oauthClientId: oauthClientIdParam, scope, keepPreviousData = true, enabled = true } = params;
const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();

Expand All@@ -39,14 +39,15 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
userId: user?.id ?? null,
oauthClientId,
scope,
redirectUri,
});

const hasClientId = oauthClientId.length > 0;
const queryEnabled = Boolean(user) && hasClientId && enabled && clerk.loaded;

const query = useClerkQuery({
queryKey,
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope }),
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope, redirectUri }),
enabled: queryEnabled,
placeholderData: defineKeepPreviousDataFn(keepPreviousData && queryEnabled),
});
Expand All@@ -59,7 +60,6 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
};
}

function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string }) {
const { oauthClientId, scope } = params;
return clerk.oauthApplication.getConsentInfo(scope !== undefined ? { oauthClientId, scope } : { oauthClientId });
function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string; redirectUri?: string }) {
return clerk.oauthApplication.getConsentInfo(params);
}
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOAuthConsent.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { GetOAuthConsentInfoParams, OAuthConsentInfo } from '../../types';
/**
* @interface
*/
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope'> & {
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope' | 'redirectUri'> & {
/**
* If `true`, the previous data will be kept in the cache until new data is fetched.
*
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/oauthApplication.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ export interface OAuthConsentInfoJSON extends ClerkResourceJSON {
oauth_application_url: string;
client_id: string;
state: string;
redirect_domain: string | null;
scopes: OAuthConsentScopeJSON[];
}

Expand DownExpand Up@@ -68,6 +69,12 @@ export type OAuthConsentInfo = {
* The `state` parameter from the original authorize request.
*/
state: string;
/**
* The PSL-resolved registrable domain of the redirect URI for display on the consent screen.
* Null when no redirect URI was provided, when it is not registered for the application,
* or when it points to an IP address or localhost.
*/
redirectDomain: string | null;
/**
* A list of scopes the application is requesting, with descriptions and consent requirements.
*/
Expand All@@ -79,6 +86,8 @@ export type GetOAuthConsentInfoParams = {
oauthClientId: string;
/** A space-delimited scope string from the authorize request. */
scope?: string;
/** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
redirectUri?: string;
};

/**
Expand Down
6 changes: 4 additions & 2 deletions packages/ui/src/components/OAuthConsent/OAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,11 @@ function _OAuthConsent() {

// Public path: fetch via hook. Disabled on the accounts portal path
// (which already has all data via context) to avoid a wasted FAPI request.
const redirectUri = ctx.redirectUrl ?? getRedirectUriFromSearch();
const { data, isLoading, error } = useOAuthConsent({
oauthClientId,
scope,
redirectUri: redirectUri || undefined,
// TODO: Remove this once account portal is refactored to use this component
enabled: !hasContextCallbacks,
});
Expand All@@ -69,7 +71,7 @@ function _OAuthConsent() {
const oauthApplicationName = ctx.oauthApplicationName ?? data?.oauthApplicationName ?? '';
const oauthApplicationLogoUrl = ctx.oauthApplicationLogoUrl ?? data?.oauthApplicationLogoUrl;
const oauthApplicationUrl = ctx.oauthApplicationUrl ?? data?.oauthApplicationUrl;
const redirectUrl = ctx.redirectUrl ?? getRedirectUriFromSearch();
const redirectUrl = ctx.redirectUrl ?? redirectUri;

const hasOrgReadScope = scopes.some(s => s.scope === USER_ORG_READ_SCOPE);
const orgSelectionEnabled = !!(hasOrgReadScope && organizationSettings.enabled);
Expand All@@ -85,7 +87,7 @@ function _OAuthConsent() {
const effectiveOrg = selectedOrg ?? defaultOrg;

const { t } = useLocalizations();
const domainAction = getRedirectDisplay(redirectUrl);
const domainAction = data?.redirectDomain ?? getRedirectDisplay(redirectUrl);
const viewFullUrlText = t(localizationKeys('oauthConsent.viewFullUrl'));

// Error states only apply to the public flow.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ const fakeConsentInfo = {
oauthApplicationUrl: 'https://example.com',
clientId: 'client_test',
state: 'abc',
redirectDomain: 'example.com',
scopes: [
{ scope: 'openid', description: 'View your identity', requiresConsent: true },
{ scope: 'email', description: 'Access your email address', requiresConsent: true },
Expand DownExpand Up@@ -94,6 +95,7 @@ describe('OAuthConsent', () => {

expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'client_test',
redirectUri: 'https://app.example/callback',
});
});

Expand DownExpand Up@@ -204,6 +206,7 @@ describe('OAuthConsent', () => {
expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'override_id',
scope: 'openid email',
redirectUri: 'https://app.example/callback',
});
});
});
Expand Down
Loading
, '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" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/quiet-terms-drum.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/ui': patch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this also touches shared and clerk-js

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

thanks! will update after some more local testing later

'@clerk/clerk-js': patch
'@clerk/shared': patch
---

Correctly display OAuth consent redirect domains for known multi-label public suffixes.
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/modules/oauthApplication/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,16 @@ import { BaseResource } from '../../resources/internal';

export class OAuthApplication implements OAuthApplicationNamespace {
async getConsentInfo(params: GetOAuthConsentInfoParams): Promise<OAuthConsentInfo> {
const { oauthClientId, scope } = params;
const { oauthClientId, scope, redirectUri } = params;
const search = {
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirect_uri: redirectUri }),
};
const json = await BaseResource._fetch<OAuthConsentInfoJSON>(
{
method: 'GET',
path: `/me/oauth/consent/${encodeURIComponent(oauthClientId)}`,
search: scope !== undefined ? { scope } : undefined,
search: Object.keys(search).length > 0 ? search : undefined,
},
{ skipUpdateClient: true },
);
Expand All@@ -31,6 +35,7 @@ export class OAuthApplication implements OAuthApplicationNamespace {
oauthApplicationUrl: data.oauth_application_url,
clientId: data.client_id,
state: data.state,
redirectDomain: data.redirect_domain,
scopes:
data.scopes?.map(s => ({
scope: s.scope,
Expand Down
21 changes: 13 additions & 8 deletions packages/shared/src/react/hooks/useOAuthConsent.shared.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
import { useMemo } from 'react';

import type { GetOAuthConsentInfoParams } from '../../types';
import { STABLE_KEYS } from '../stable-keys';
import { createCacheKeys } from './createCacheKeys';

export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthClientId: string; scope?: string }) {
const { userId, oauthClientId, scope } = params;
export function useOAuthConsentCacheKeys(params: {
userId: string | null;
oauthClientId: string;
scope?: string;
redirectUri?: string;
}) {
const { userId, oauthClientId, scope, redirectUri } = params;
return useMemo(() => {
const args: Pick<GetOAuthConsentInfoParams, 'oauthClientId'> & { scope?: string } = { oauthClientId };
if (scope !== undefined) {
args.scope = scope;
}
const args = {
oauthClientId,
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirectUri }),
};
return createCacheKeys({
stablePrefix: STABLE_KEYS.OAUTH_CONSENT_INFO_KEY,
authenticated: true,
Expand All@@ -21,5 +26,5 @@ export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthC
args,
},
});
}, [userId, oauthClientId, scope]);
}, [userId, oauthClientId, scope, redirectUri]);
}
10 changes: 5 additions & 5 deletions packages/shared/src/react/hooks/useOAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const HOOK_NAME = 'useOAuthConsent';
export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentReturn {
useAssertWrappedByClerkProvider(HOOK_NAME);

const { oauthClientId: oauthClientIdParam, scope, keepPreviousData = true, enabled = true } = params;
const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();

Expand All@@ -39,14 +39,15 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
userId: user?.id ?? null,
oauthClientId,
scope,
redirectUri,
});

const hasClientId = oauthClientId.length > 0;
const queryEnabled = Boolean(user) && hasClientId && enabled && clerk.loaded;

const query = useClerkQuery({
queryKey,
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope }),
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope, redirectUri }),
enabled: queryEnabled,
placeholderData: defineKeepPreviousDataFn(keepPreviousData && queryEnabled),
});
Expand All@@ -59,7 +60,6 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
};
}

function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string }) {
const { oauthClientId, scope } = params;
return clerk.oauthApplication.getConsentInfo(scope !== undefined ? { oauthClientId, scope } : { oauthClientId });
function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string; redirectUri?: string }) {
return clerk.oauthApplication.getConsentInfo(params);
}
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOAuthConsent.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { GetOAuthConsentInfoParams, OAuthConsentInfo } from '../../types';
/**
* @interface
*/
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope'> & {
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope' | 'redirectUri'> & {
/**
* If `true`, the previous data will be kept in the cache until new data is fetched.
*
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/oauthApplication.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ export interface OAuthConsentInfoJSON extends ClerkResourceJSON {
oauth_application_url: string;
client_id: string;
state: string;
redirect_domain: string | null;
scopes: OAuthConsentScopeJSON[];
}

Expand DownExpand Up@@ -68,6 +69,12 @@ export type OAuthConsentInfo = {
* The `state` parameter from the original authorize request.
*/
state: string;
/**
* The PSL-resolved registrable domain of the redirect URI for display on the consent screen.
* Null when no redirect URI was provided, when it is not registered for the application,
* or when it points to an IP address or localhost.
*/
redirectDomain: string | null;
/**
* A list of scopes the application is requesting, with descriptions and consent requirements.
*/
Expand All@@ -79,6 +86,8 @@ export type GetOAuthConsentInfoParams = {
oauthClientId: string;
/** A space-delimited scope string from the authorize request. */
scope?: string;
/** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
redirectUri?: string;
};

/**
Expand Down
6 changes: 4 additions & 2 deletions packages/ui/src/components/OAuthConsent/OAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,11 @@ function _OAuthConsent() {

// Public path: fetch via hook. Disabled on the accounts portal path
// (which already has all data via context) to avoid a wasted FAPI request.
const redirectUri = ctx.redirectUrl ?? getRedirectUriFromSearch();
const { data, isLoading, error } = useOAuthConsent({
oauthClientId,
scope,
redirectUri: redirectUri || undefined,
// TODO: Remove this once account portal is refactored to use this component
enabled: !hasContextCallbacks,
});
Expand All@@ -69,7 +71,7 @@ function _OAuthConsent() {
const oauthApplicationName = ctx.oauthApplicationName ?? data?.oauthApplicationName ?? '';
const oauthApplicationLogoUrl = ctx.oauthApplicationLogoUrl ?? data?.oauthApplicationLogoUrl;
const oauthApplicationUrl = ctx.oauthApplicationUrl ?? data?.oauthApplicationUrl;
const redirectUrl = ctx.redirectUrl ?? getRedirectUriFromSearch();
const redirectUrl = ctx.redirectUrl ?? redirectUri;

const hasOrgReadScope = scopes.some(s => s.scope === USER_ORG_READ_SCOPE);
const orgSelectionEnabled = !!(hasOrgReadScope && organizationSettings.enabled);
Expand All@@ -85,7 +87,7 @@ function _OAuthConsent() {
const effectiveOrg = selectedOrg ?? defaultOrg;

const { t } = useLocalizations();
const domainAction = getRedirectDisplay(redirectUrl);
const domainAction = data?.redirectDomain ?? getRedirectDisplay(redirectUrl);
const viewFullUrlText = t(localizationKeys('oauthConsent.viewFullUrl'));

// Error states only apply to the public flow.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ const fakeConsentInfo = {
oauthApplicationUrl: 'https://example.com',
clientId: 'client_test',
state: 'abc',
redirectDomain: 'example.com',
scopes: [
{ scope: 'openid', description: 'View your identity', requiresConsent: true },
{ scope: 'email', description: 'Access your email address', requiresConsent: true },
Expand DownExpand Up@@ -94,6 +95,7 @@ describe('OAuthConsent', () => {

expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'client_test',
redirectUri: 'https://app.example/callback',
});
});

Expand DownExpand Up@@ -204,6 +206,7 @@ describe('OAuthConsent', () => {
expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'override_id',
scope: 'openid email',
redirectUri: 'https://app.example/callback',
});
});
});
Expand Down
Loading
, '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('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/quiet-terms-drum.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/ui': patch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this also touches shared and clerk-js

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

thanks! will update after some more local testing later

'@clerk/clerk-js': patch
'@clerk/shared': patch
---

Correctly display OAuth consent redirect domains for known multi-label public suffixes.
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/modules/oauthApplication/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,16 @@ import { BaseResource } from '../../resources/internal';

export class OAuthApplication implements OAuthApplicationNamespace {
async getConsentInfo(params: GetOAuthConsentInfoParams): Promise<OAuthConsentInfo> {
const { oauthClientId, scope } = params;
const { oauthClientId, scope, redirectUri } = params;
const search = {
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirect_uri: redirectUri }),
};
const json = await BaseResource._fetch<OAuthConsentInfoJSON>(
{
method: 'GET',
path: `/me/oauth/consent/${encodeURIComponent(oauthClientId)}`,
search: scope !== undefined ? { scope } : undefined,
search: Object.keys(search).length > 0 ? search : undefined,
},
{ skipUpdateClient: true },
);
Expand All@@ -31,6 +35,7 @@ export class OAuthApplication implements OAuthApplicationNamespace {
oauthApplicationUrl: data.oauth_application_url,
clientId: data.client_id,
state: data.state,
redirectDomain: data.redirect_domain,
scopes:
data.scopes?.map(s => ({
scope: s.scope,
Expand Down
21 changes: 13 additions & 8 deletions packages/shared/src/react/hooks/useOAuthConsent.shared.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
import { useMemo } from 'react';

import type { GetOAuthConsentInfoParams } from '../../types';
import { STABLE_KEYS } from '../stable-keys';
import { createCacheKeys } from './createCacheKeys';

export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthClientId: string; scope?: string }) {
const { userId, oauthClientId, scope } = params;
export function useOAuthConsentCacheKeys(params: {
userId: string | null;
oauthClientId: string;
scope?: string;
redirectUri?: string;
}) {
const { userId, oauthClientId, scope, redirectUri } = params;
return useMemo(() => {
const args: Pick<GetOAuthConsentInfoParams, 'oauthClientId'> & { scope?: string } = { oauthClientId };
if (scope !== undefined) {
args.scope = scope;
}
const args = {
oauthClientId,
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirectUri }),
};
return createCacheKeys({
stablePrefix: STABLE_KEYS.OAUTH_CONSENT_INFO_KEY,
authenticated: true,
Expand All@@ -21,5 +26,5 @@ export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthC
args,
},
});
}, [userId, oauthClientId, scope]);
}, [userId, oauthClientId, scope, redirectUri]);
}
10 changes: 5 additions & 5 deletions packages/shared/src/react/hooks/useOAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const HOOK_NAME = 'useOAuthConsent';
export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentReturn {
useAssertWrappedByClerkProvider(HOOK_NAME);

const { oauthClientId: oauthClientIdParam, scope, keepPreviousData = true, enabled = true } = params;
const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();

Expand All@@ -39,14 +39,15 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
userId: user?.id ?? null,
oauthClientId,
scope,
redirectUri,
});

const hasClientId = oauthClientId.length > 0;
const queryEnabled = Boolean(user) && hasClientId && enabled && clerk.loaded;

const query = useClerkQuery({
queryKey,
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope }),
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope, redirectUri }),
enabled: queryEnabled,
placeholderData: defineKeepPreviousDataFn(keepPreviousData && queryEnabled),
});
Expand All@@ -59,7 +60,6 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
};
}

function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string }) {
const { oauthClientId, scope } = params;
return clerk.oauthApplication.getConsentInfo(scope !== undefined ? { oauthClientId, scope } : { oauthClientId });
function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string; redirectUri?: string }) {
return clerk.oauthApplication.getConsentInfo(params);
}
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOAuthConsent.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { GetOAuthConsentInfoParams, OAuthConsentInfo } from '../../types';
/**
* @interface
*/
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope'> & {
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope' | 'redirectUri'> & {
/**
* If `true`, the previous data will be kept in the cache until new data is fetched.
*
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/oauthApplication.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ export interface OAuthConsentInfoJSON extends ClerkResourceJSON {
oauth_application_url: string;
client_id: string;
state: string;
redirect_domain: string | null;
scopes: OAuthConsentScopeJSON[];
}

Expand DownExpand Up@@ -68,6 +69,12 @@ export type OAuthConsentInfo = {
* The `state` parameter from the original authorize request.
*/
state: string;
/**
* The PSL-resolved registrable domain of the redirect URI for display on the consent screen.
* Null when no redirect URI was provided, when it is not registered for the application,
* or when it points to an IP address or localhost.
*/
redirectDomain: string | null;
/**
* A list of scopes the application is requesting, with descriptions and consent requirements.
*/
Expand All@@ -79,6 +86,8 @@ export type GetOAuthConsentInfoParams = {
oauthClientId: string;
/** A space-delimited scope string from the authorize request. */
scope?: string;
/** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
redirectUri?: string;
};

/**
Expand Down
6 changes: 4 additions & 2 deletions packages/ui/src/components/OAuthConsent/OAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,11 @@ function _OAuthConsent() {

// Public path: fetch via hook. Disabled on the accounts portal path
// (which already has all data via context) to avoid a wasted FAPI request.
const redirectUri = ctx.redirectUrl ?? getRedirectUriFromSearch();
const { data, isLoading, error } = useOAuthConsent({
oauthClientId,
scope,
redirectUri: redirectUri || undefined,
// TODO: Remove this once account portal is refactored to use this component
enabled: !hasContextCallbacks,
});
Expand All@@ -69,7 +71,7 @@ function _OAuthConsent() {
const oauthApplicationName = ctx.oauthApplicationName ?? data?.oauthApplicationName ?? '';
const oauthApplicationLogoUrl = ctx.oauthApplicationLogoUrl ?? data?.oauthApplicationLogoUrl;
const oauthApplicationUrl = ctx.oauthApplicationUrl ?? data?.oauthApplicationUrl;
const redirectUrl = ctx.redirectUrl ?? getRedirectUriFromSearch();
const redirectUrl = ctx.redirectUrl ?? redirectUri;

const hasOrgReadScope = scopes.some(s => s.scope === USER_ORG_READ_SCOPE);
const orgSelectionEnabled = !!(hasOrgReadScope && organizationSettings.enabled);
Expand All@@ -85,7 +87,7 @@ function _OAuthConsent() {
const effectiveOrg = selectedOrg ?? defaultOrg;

const { t } = useLocalizations();
const domainAction = getRedirectDisplay(redirectUrl);
const domainAction = data?.redirectDomain ?? getRedirectDisplay(redirectUrl);
const viewFullUrlText = t(localizationKeys('oauthConsent.viewFullUrl'));

// Error states only apply to the public flow.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ const fakeConsentInfo = {
oauthApplicationUrl: 'https://example.com',
clientId: 'client_test',
state: 'abc',
redirectDomain: 'example.com',
scopes: [
{ scope: 'openid', description: 'View your identity', requiresConsent: true },
{ scope: 'email', description: 'Access your email address', requiresConsent: true },
Expand DownExpand Up@@ -94,6 +95,7 @@ describe('OAuthConsent', () => {

expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'client_test',
redirectUri: 'https://app.example/callback',
});
});

Expand DownExpand Up@@ -204,6 +206,7 @@ describe('OAuthConsent', () => {
expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'override_id',
scope: 'openid email',
redirectUri: 'https://app.example/callback',
});
});
});
Expand Down
Loading
, '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('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/quiet-terms-drum.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/ui': patch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this also touches shared and clerk-js

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

thanks! will update after some more local testing later

'@clerk/clerk-js': patch
'@clerk/shared': patch
---

Correctly display OAuth consent redirect domains for known multi-label public suffixes.
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/modules/oauthApplication/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,16 @@ import { BaseResource } from '../../resources/internal';

export class OAuthApplication implements OAuthApplicationNamespace {
async getConsentInfo(params: GetOAuthConsentInfoParams): Promise<OAuthConsentInfo> {
const { oauthClientId, scope } = params;
const { oauthClientId, scope, redirectUri } = params;
const search = {
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirect_uri: redirectUri }),
};
const json = await BaseResource._fetch<OAuthConsentInfoJSON>(
{
method: 'GET',
path: `/me/oauth/consent/${encodeURIComponent(oauthClientId)}`,
search: scope !== undefined ? { scope } : undefined,
search: Object.keys(search).length > 0 ? search : undefined,
},
{ skipUpdateClient: true },
);
Expand All@@ -31,6 +35,7 @@ export class OAuthApplication implements OAuthApplicationNamespace {
oauthApplicationUrl: data.oauth_application_url,
clientId: data.client_id,
state: data.state,
redirectDomain: data.redirect_domain,
scopes:
data.scopes?.map(s => ({
scope: s.scope,
Expand Down
21 changes: 13 additions & 8 deletions packages/shared/src/react/hooks/useOAuthConsent.shared.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
import { useMemo } from 'react';

import type { GetOAuthConsentInfoParams } from '../../types';
import { STABLE_KEYS } from '../stable-keys';
import { createCacheKeys } from './createCacheKeys';

export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthClientId: string; scope?: string }) {
const { userId, oauthClientId, scope } = params;
export function useOAuthConsentCacheKeys(params: {
userId: string | null;
oauthClientId: string;
scope?: string;
redirectUri?: string;
}) {
const { userId, oauthClientId, scope, redirectUri } = params;
return useMemo(() => {
const args: Pick<GetOAuthConsentInfoParams, 'oauthClientId'> & { scope?: string } = { oauthClientId };
if (scope !== undefined) {
args.scope = scope;
}
const args = {
oauthClientId,
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirectUri }),
};
return createCacheKeys({
stablePrefix: STABLE_KEYS.OAUTH_CONSENT_INFO_KEY,
authenticated: true,
Expand All@@ -21,5 +26,5 @@ export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthC
args,
},
});
}, [userId, oauthClientId, scope]);
}, [userId, oauthClientId, scope, redirectUri]);
}
10 changes: 5 additions & 5 deletions packages/shared/src/react/hooks/useOAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const HOOK_NAME = 'useOAuthConsent';
export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentReturn {
useAssertWrappedByClerkProvider(HOOK_NAME);

const { oauthClientId: oauthClientIdParam, scope, keepPreviousData = true, enabled = true } = params;
const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();

Expand All@@ -39,14 +39,15 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
userId: user?.id ?? null,
oauthClientId,
scope,
redirectUri,
});

const hasClientId = oauthClientId.length > 0;
const queryEnabled = Boolean(user) && hasClientId && enabled && clerk.loaded;

const query = useClerkQuery({
queryKey,
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope }),
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope, redirectUri }),
enabled: queryEnabled,
placeholderData: defineKeepPreviousDataFn(keepPreviousData && queryEnabled),
});
Expand All@@ -59,7 +60,6 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
};
}

function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string }) {
const { oauthClientId, scope } = params;
return clerk.oauthApplication.getConsentInfo(scope !== undefined ? { oauthClientId, scope } : { oauthClientId });
function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string; redirectUri?: string }) {
return clerk.oauthApplication.getConsentInfo(params);
}
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOAuthConsent.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { GetOAuthConsentInfoParams, OAuthConsentInfo } from '../../types';
/**
* @interface
*/
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope'> & {
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope' | 'redirectUri'> & {
/**
* If `true`, the previous data will be kept in the cache until new data is fetched.
*
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/oauthApplication.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ export interface OAuthConsentInfoJSON extends ClerkResourceJSON {
oauth_application_url: string;
client_id: string;
state: string;
redirect_domain: string | null;
scopes: OAuthConsentScopeJSON[];
}

Expand DownExpand Up@@ -68,6 +69,12 @@ export type OAuthConsentInfo = {
* The `state` parameter from the original authorize request.
*/
state: string;
/**
* The PSL-resolved registrable domain of the redirect URI for display on the consent screen.
* Null when no redirect URI was provided, when it is not registered for the application,
* or when it points to an IP address or localhost.
*/
redirectDomain: string | null;
/**
* A list of scopes the application is requesting, with descriptions and consent requirements.
*/
Expand All@@ -79,6 +86,8 @@ export type GetOAuthConsentInfoParams = {
oauthClientId: string;
/** A space-delimited scope string from the authorize request. */
scope?: string;
/** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
redirectUri?: string;
};

/**
Expand Down
6 changes: 4 additions & 2 deletions packages/ui/src/components/OAuthConsent/OAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,11 @@ function _OAuthConsent() {

// Public path: fetch via hook. Disabled on the accounts portal path
// (which already has all data via context) to avoid a wasted FAPI request.
const redirectUri = ctx.redirectUrl ?? getRedirectUriFromSearch();
const { data, isLoading, error } = useOAuthConsent({
oauthClientId,
scope,
redirectUri: redirectUri || undefined,
// TODO: Remove this once account portal is refactored to use this component
enabled: !hasContextCallbacks,
});
Expand All@@ -69,7 +71,7 @@ function _OAuthConsent() {
const oauthApplicationName = ctx.oauthApplicationName ?? data?.oauthApplicationName ?? '';
const oauthApplicationLogoUrl = ctx.oauthApplicationLogoUrl ?? data?.oauthApplicationLogoUrl;
const oauthApplicationUrl = ctx.oauthApplicationUrl ?? data?.oauthApplicationUrl;
const redirectUrl = ctx.redirectUrl ?? getRedirectUriFromSearch();
const redirectUrl = ctx.redirectUrl ?? redirectUri;

const hasOrgReadScope = scopes.some(s => s.scope === USER_ORG_READ_SCOPE);
const orgSelectionEnabled = !!(hasOrgReadScope && organizationSettings.enabled);
Expand All@@ -85,7 +87,7 @@ function _OAuthConsent() {
const effectiveOrg = selectedOrg ?? defaultOrg;

const { t } = useLocalizations();
const domainAction = getRedirectDisplay(redirectUrl);
const domainAction = data?.redirectDomain ?? getRedirectDisplay(redirectUrl);
const viewFullUrlText = t(localizationKeys('oauthConsent.viewFullUrl'));

// Error states only apply to the public flow.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ const fakeConsentInfo = {
oauthApplicationUrl: 'https://example.com',
clientId: 'client_test',
state: 'abc',
redirectDomain: 'example.com',
scopes: [
{ scope: 'openid', description: 'View your identity', requiresConsent: true },
{ scope: 'email', description: 'Access your email address', requiresConsent: true },
Expand DownExpand Up@@ -94,6 +95,7 @@ describe('OAuthConsent', () => {

expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'client_test',
redirectUri: 'https://app.example/callback',
});
});

Expand DownExpand Up@@ -204,6 +206,7 @@ describe('OAuthConsent', () => {
expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'override_id',
scope: 'openid email',
redirectUri: 'https://app.example/callback',
});
});
});
Expand Down
Loading
, '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" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/quiet-terms-drum.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/ui': patch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this also touches shared and clerk-js

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

thanks! will update after some more local testing later

'@clerk/clerk-js': patch
'@clerk/shared': patch
---

Correctly display OAuth consent redirect domains for known multi-label public suffixes.
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/modules/oauthApplication/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,16 @@ import { BaseResource } from '../../resources/internal';

export class OAuthApplication implements OAuthApplicationNamespace {
async getConsentInfo(params: GetOAuthConsentInfoParams): Promise<OAuthConsentInfo> {
const { oauthClientId, scope } = params;
const { oauthClientId, scope, redirectUri } = params;
const search = {
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirect_uri: redirectUri }),
};
const json = await BaseResource._fetch<OAuthConsentInfoJSON>(
{
method: 'GET',
path: `/me/oauth/consent/${encodeURIComponent(oauthClientId)}`,
search: scope !== undefined ? { scope } : undefined,
search: Object.keys(search).length > 0 ? search : undefined,
},
{ skipUpdateClient: true },
);
Expand All@@ -31,6 +35,7 @@ export class OAuthApplication implements OAuthApplicationNamespace {
oauthApplicationUrl: data.oauth_application_url,
clientId: data.client_id,
state: data.state,
redirectDomain: data.redirect_domain,
scopes:
data.scopes?.map(s => ({
scope: s.scope,
Expand Down
21 changes: 13 additions & 8 deletions packages/shared/src/react/hooks/useOAuthConsent.shared.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
import { useMemo } from 'react';

import type { GetOAuthConsentInfoParams } from '../../types';
import { STABLE_KEYS } from '../stable-keys';
import { createCacheKeys } from './createCacheKeys';

export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthClientId: string; scope?: string }) {
const { userId, oauthClientId, scope } = params;
export function useOAuthConsentCacheKeys(params: {
userId: string | null;
oauthClientId: string;
scope?: string;
redirectUri?: string;
}) {
const { userId, oauthClientId, scope, redirectUri } = params;
return useMemo(() => {
const args: Pick<GetOAuthConsentInfoParams, 'oauthClientId'> & { scope?: string } = { oauthClientId };
if (scope !== undefined) {
args.scope = scope;
}
const args = {
oauthClientId,
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirectUri }),
};
return createCacheKeys({
stablePrefix: STABLE_KEYS.OAUTH_CONSENT_INFO_KEY,
authenticated: true,
Expand All@@ -21,5 +26,5 @@ export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthC
args,
},
});
}, [userId, oauthClientId, scope]);
}, [userId, oauthClientId, scope, redirectUri]);
}
10 changes: 5 additions & 5 deletions packages/shared/src/react/hooks/useOAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const HOOK_NAME = 'useOAuthConsent';
export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentReturn {
useAssertWrappedByClerkProvider(HOOK_NAME);

const { oauthClientId: oauthClientIdParam, scope, keepPreviousData = true, enabled = true } = params;
const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();

Expand All@@ -39,14 +39,15 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
userId: user?.id ?? null,
oauthClientId,
scope,
redirectUri,
});

const hasClientId = oauthClientId.length > 0;
const queryEnabled = Boolean(user) && hasClientId && enabled && clerk.loaded;

const query = useClerkQuery({
queryKey,
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope }),
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope, redirectUri }),
enabled: queryEnabled,
placeholderData: defineKeepPreviousDataFn(keepPreviousData && queryEnabled),
});
Expand All@@ -59,7 +60,6 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
};
}

function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string }) {
const { oauthClientId, scope } = params;
return clerk.oauthApplication.getConsentInfo(scope !== undefined ? { oauthClientId, scope } : { oauthClientId });
function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string; redirectUri?: string }) {
return clerk.oauthApplication.getConsentInfo(params);
}
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOAuthConsent.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { GetOAuthConsentInfoParams, OAuthConsentInfo } from '../../types';
/**
* @interface
*/
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope'> & {
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope' | 'redirectUri'> & {
/**
* If `true`, the previous data will be kept in the cache until new data is fetched.
*
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/oauthApplication.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ export interface OAuthConsentInfoJSON extends ClerkResourceJSON {
oauth_application_url: string;
client_id: string;
state: string;
redirect_domain: string | null;
scopes: OAuthConsentScopeJSON[];
}

Expand DownExpand Up@@ -68,6 +69,12 @@ export type OAuthConsentInfo = {
* The `state` parameter from the original authorize request.
*/
state: string;
/**
* The PSL-resolved registrable domain of the redirect URI for display on the consent screen.
* Null when no redirect URI was provided, when it is not registered for the application,
* or when it points to an IP address or localhost.
*/
redirectDomain: string | null;
/**
* A list of scopes the application is requesting, with descriptions and consent requirements.
*/
Expand All@@ -79,6 +86,8 @@ export type GetOAuthConsentInfoParams = {
oauthClientId: string;
/** A space-delimited scope string from the authorize request. */
scope?: string;
/** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
redirectUri?: string;
};

/**
Expand Down
6 changes: 4 additions & 2 deletions packages/ui/src/components/OAuthConsent/OAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,11 @@ function _OAuthConsent() {

// Public path: fetch via hook. Disabled on the accounts portal path
// (which already has all data via context) to avoid a wasted FAPI request.
const redirectUri = ctx.redirectUrl ?? getRedirectUriFromSearch();
const { data, isLoading, error } = useOAuthConsent({
oauthClientId,
scope,
redirectUri: redirectUri || undefined,
// TODO: Remove this once account portal is refactored to use this component
enabled: !hasContextCallbacks,
});
Expand All@@ -69,7 +71,7 @@ function _OAuthConsent() {
const oauthApplicationName = ctx.oauthApplicationName ?? data?.oauthApplicationName ?? '';
const oauthApplicationLogoUrl = ctx.oauthApplicationLogoUrl ?? data?.oauthApplicationLogoUrl;
const oauthApplicationUrl = ctx.oauthApplicationUrl ?? data?.oauthApplicationUrl;
const redirectUrl = ctx.redirectUrl ?? getRedirectUriFromSearch();
const redirectUrl = ctx.redirectUrl ?? redirectUri;

const hasOrgReadScope = scopes.some(s => s.scope === USER_ORG_READ_SCOPE);
const orgSelectionEnabled = !!(hasOrgReadScope && organizationSettings.enabled);
Expand All@@ -85,7 +87,7 @@ function _OAuthConsent() {
const effectiveOrg = selectedOrg ?? defaultOrg;

const { t } = useLocalizations();
const domainAction = getRedirectDisplay(redirectUrl);
const domainAction = data?.redirectDomain ?? getRedirectDisplay(redirectUrl);
const viewFullUrlText = t(localizationKeys('oauthConsent.viewFullUrl'));

// Error states only apply to the public flow.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ const fakeConsentInfo = {
oauthApplicationUrl: 'https://example.com',
clientId: 'client_test',
state: 'abc',
redirectDomain: 'example.com',
scopes: [
{ scope: 'openid', description: 'View your identity', requiresConsent: true },
{ scope: 'email', description: 'Access your email address', requiresConsent: true },
Expand DownExpand Up@@ -94,6 +95,7 @@ describe('OAuthConsent', () => {

expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'client_test',
redirectUri: 'https://app.example/callback',
});
});

Expand DownExpand Up@@ -204,6 +206,7 @@ describe('OAuthConsent', () => {
expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'override_id',
scope: 'openid email',
redirectUri: 'https://app.example/callback',
});
});
});
Expand Down
Loading
, '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('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/quiet-terms-drum.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/ui': patch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this also touches shared and clerk-js

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

thanks! will update after some more local testing later

'@clerk/clerk-js': patch
'@clerk/shared': patch
---

Correctly display OAuth consent redirect domains for known multi-label public suffixes.
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/modules/oauthApplication/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,16 @@ import { BaseResource } from '../../resources/internal';

export class OAuthApplication implements OAuthApplicationNamespace {
async getConsentInfo(params: GetOAuthConsentInfoParams): Promise<OAuthConsentInfo> {
const { oauthClientId, scope } = params;
const { oauthClientId, scope, redirectUri } = params;
const search = {
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirect_uri: redirectUri }),
};
const json = await BaseResource._fetch<OAuthConsentInfoJSON>(
{
method: 'GET',
path: `/me/oauth/consent/${encodeURIComponent(oauthClientId)}`,
search: scope !== undefined ? { scope } : undefined,
search: Object.keys(search).length > 0 ? search : undefined,
},
{ skipUpdateClient: true },
);
Expand All@@ -31,6 +35,7 @@ export class OAuthApplication implements OAuthApplicationNamespace {
oauthApplicationUrl: data.oauth_application_url,
clientId: data.client_id,
state: data.state,
redirectDomain: data.redirect_domain,
scopes:
data.scopes?.map(s => ({
scope: s.scope,
Expand Down
21 changes: 13 additions & 8 deletions packages/shared/src/react/hooks/useOAuthConsent.shared.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
import { useMemo } from 'react';

import type { GetOAuthConsentInfoParams } from '../../types';
import { STABLE_KEYS } from '../stable-keys';
import { createCacheKeys } from './createCacheKeys';

export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthClientId: string; scope?: string }) {
const { userId, oauthClientId, scope } = params;
export function useOAuthConsentCacheKeys(params: {
userId: string | null;
oauthClientId: string;
scope?: string;
redirectUri?: string;
}) {
const { userId, oauthClientId, scope, redirectUri } = params;
return useMemo(() => {
const args: Pick<GetOAuthConsentInfoParams, 'oauthClientId'> & { scope?: string } = { oauthClientId };
if (scope !== undefined) {
args.scope = scope;
}
const args = {
oauthClientId,
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirectUri }),
};
return createCacheKeys({
stablePrefix: STABLE_KEYS.OAUTH_CONSENT_INFO_KEY,
authenticated: true,
Expand All@@ -21,5 +26,5 @@ export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthC
args,
},
});
}, [userId, oauthClientId, scope]);
}, [userId, oauthClientId, scope, redirectUri]);
}
10 changes: 5 additions & 5 deletions packages/shared/src/react/hooks/useOAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const HOOK_NAME = 'useOAuthConsent';
export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentReturn {
useAssertWrappedByClerkProvider(HOOK_NAME);

const { oauthClientId: oauthClientIdParam, scope, keepPreviousData = true, enabled = true } = params;
const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();

Expand All@@ -39,14 +39,15 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
userId: user?.id ?? null,
oauthClientId,
scope,
redirectUri,
});

const hasClientId = oauthClientId.length > 0;
const queryEnabled = Boolean(user) && hasClientId && enabled && clerk.loaded;

const query = useClerkQuery({
queryKey,
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope }),
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope, redirectUri }),
enabled: queryEnabled,
placeholderData: defineKeepPreviousDataFn(keepPreviousData && queryEnabled),
});
Expand All@@ -59,7 +60,6 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
};
}

function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string }) {
const { oauthClientId, scope } = params;
return clerk.oauthApplication.getConsentInfo(scope !== undefined ? { oauthClientId, scope } : { oauthClientId });
function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string; redirectUri?: string }) {
return clerk.oauthApplication.getConsentInfo(params);
}
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOAuthConsent.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { GetOAuthConsentInfoParams, OAuthConsentInfo } from '../../types';
/**
* @interface
*/
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope'> & {
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope' | 'redirectUri'> & {
/**
* If `true`, the previous data will be kept in the cache until new data is fetched.
*
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/oauthApplication.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ export interface OAuthConsentInfoJSON extends ClerkResourceJSON {
oauth_application_url: string;
client_id: string;
state: string;
redirect_domain: string | null;
scopes: OAuthConsentScopeJSON[];
}

Expand DownExpand Up@@ -68,6 +69,12 @@ export type OAuthConsentInfo = {
* The `state` parameter from the original authorize request.
*/
state: string;
/**
* The PSL-resolved registrable domain of the redirect URI for display on the consent screen.
* Null when no redirect URI was provided, when it is not registered for the application,
* or when it points to an IP address or localhost.
*/
redirectDomain: string | null;
/**
* A list of scopes the application is requesting, with descriptions and consent requirements.
*/
Expand All@@ -79,6 +86,8 @@ export type GetOAuthConsentInfoParams = {
oauthClientId: string;
/** A space-delimited scope string from the authorize request. */
scope?: string;
/** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
redirectUri?: string;
};

/**
Expand Down
6 changes: 4 additions & 2 deletions packages/ui/src/components/OAuthConsent/OAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,11 @@ function _OAuthConsent() {

// Public path: fetch via hook. Disabled on the accounts portal path
// (which already has all data via context) to avoid a wasted FAPI request.
const redirectUri = ctx.redirectUrl ?? getRedirectUriFromSearch();
const { data, isLoading, error } = useOAuthConsent({
oauthClientId,
scope,
redirectUri: redirectUri || undefined,
// TODO: Remove this once account portal is refactored to use this component
enabled: !hasContextCallbacks,
});
Expand All@@ -69,7 +71,7 @@ function _OAuthConsent() {
const oauthApplicationName = ctx.oauthApplicationName ?? data?.oauthApplicationName ?? '';
const oauthApplicationLogoUrl = ctx.oauthApplicationLogoUrl ?? data?.oauthApplicationLogoUrl;
const oauthApplicationUrl = ctx.oauthApplicationUrl ?? data?.oauthApplicationUrl;
const redirectUrl = ctx.redirectUrl ?? getRedirectUriFromSearch();
const redirectUrl = ctx.redirectUrl ?? redirectUri;

const hasOrgReadScope = scopes.some(s => s.scope === USER_ORG_READ_SCOPE);
const orgSelectionEnabled = !!(hasOrgReadScope && organizationSettings.enabled);
Expand All@@ -85,7 +87,7 @@ function _OAuthConsent() {
const effectiveOrg = selectedOrg ?? defaultOrg;

const { t } = useLocalizations();
const domainAction = getRedirectDisplay(redirectUrl);
const domainAction = data?.redirectDomain ?? getRedirectDisplay(redirectUrl);
const viewFullUrlText = t(localizationKeys('oauthConsent.viewFullUrl'));

// Error states only apply to the public flow.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ const fakeConsentInfo = {
oauthApplicationUrl: 'https://example.com',
clientId: 'client_test',
state: 'abc',
redirectDomain: 'example.com',
scopes: [
{ scope: 'openid', description: 'View your identity', requiresConsent: true },
{ scope: 'email', description: 'Access your email address', requiresConsent: true },
Expand DownExpand Up@@ -94,6 +95,7 @@ describe('OAuthConsent', () => {

expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'client_test',
redirectUri: 'https://app.example/callback',
});
});

Expand DownExpand Up@@ -204,6 +206,7 @@ describe('OAuthConsent', () => {
expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'override_id',
scope: 'openid email',
redirectUri: 'https://app.example/callback',
});
});
});
Expand Down
Loading
, '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); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/quiet-terms-drum.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/ui': patch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this also touches shared and clerk-js

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

thanks! will update after some more local testing later

'@clerk/clerk-js': patch
'@clerk/shared': patch
---

Correctly display OAuth consent redirect domains for known multi-label public suffixes.
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/modules/oauthApplication/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,16 @@ import { BaseResource } from '../../resources/internal';

export class OAuthApplication implements OAuthApplicationNamespace {
async getConsentInfo(params: GetOAuthConsentInfoParams): Promise<OAuthConsentInfo> {
const { oauthClientId, scope } = params;
const { oauthClientId, scope, redirectUri } = params;
const search = {
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirect_uri: redirectUri }),
};
const json = await BaseResource._fetch<OAuthConsentInfoJSON>(
{
method: 'GET',
path: `/me/oauth/consent/${encodeURIComponent(oauthClientId)}`,
search: scope !== undefined ? { scope } : undefined,
search: Object.keys(search).length > 0 ? search : undefined,
},
{ skipUpdateClient: true },
);
Expand All@@ -31,6 +35,7 @@ export class OAuthApplication implements OAuthApplicationNamespace {
oauthApplicationUrl: data.oauth_application_url,
clientId: data.client_id,
state: data.state,
redirectDomain: data.redirect_domain,
scopes:
data.scopes?.map(s => ({
scope: s.scope,
Expand Down
21 changes: 13 additions & 8 deletions packages/shared/src/react/hooks/useOAuthConsent.shared.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
import { useMemo } from 'react';

import type { GetOAuthConsentInfoParams } from '../../types';
import { STABLE_KEYS } from '../stable-keys';
import { createCacheKeys } from './createCacheKeys';

export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthClientId: string; scope?: string }) {
const { userId, oauthClientId, scope } = params;
export function useOAuthConsentCacheKeys(params: {
userId: string | null;
oauthClientId: string;
scope?: string;
redirectUri?: string;
}) {
const { userId, oauthClientId, scope, redirectUri } = params;
return useMemo(() => {
const args: Pick<GetOAuthConsentInfoParams, 'oauthClientId'> & { scope?: string } = { oauthClientId };
if (scope !== undefined) {
args.scope = scope;
}
const args = {
oauthClientId,
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirectUri }),
};
return createCacheKeys({
stablePrefix: STABLE_KEYS.OAUTH_CONSENT_INFO_KEY,
authenticated: true,
Expand All@@ -21,5 +26,5 @@ export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthC
args,
},
});
}, [userId, oauthClientId, scope]);
}, [userId, oauthClientId, scope, redirectUri]);
}
10 changes: 5 additions & 5 deletions packages/shared/src/react/hooks/useOAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const HOOK_NAME = 'useOAuthConsent';
export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentReturn {
useAssertWrappedByClerkProvider(HOOK_NAME);

const { oauthClientId: oauthClientIdParam, scope, keepPreviousData = true, enabled = true } = params;
const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();

Expand All@@ -39,14 +39,15 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
userId: user?.id ?? null,
oauthClientId,
scope,
redirectUri,
});

const hasClientId = oauthClientId.length > 0;
const queryEnabled = Boolean(user) && hasClientId && enabled && clerk.loaded;

const query = useClerkQuery({
queryKey,
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope }),
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope, redirectUri }),
enabled: queryEnabled,
placeholderData: defineKeepPreviousDataFn(keepPreviousData && queryEnabled),
});
Expand All@@ -59,7 +60,6 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
};
}

function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string }) {
const { oauthClientId, scope } = params;
return clerk.oauthApplication.getConsentInfo(scope !== undefined ? { oauthClientId, scope } : { oauthClientId });
function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string; redirectUri?: string }) {
return clerk.oauthApplication.getConsentInfo(params);
}
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOAuthConsent.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { GetOAuthConsentInfoParams, OAuthConsentInfo } from '../../types';
/**
* @interface
*/
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope'> & {
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope' | 'redirectUri'> & {
/**
* If `true`, the previous data will be kept in the cache until new data is fetched.
*
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/oauthApplication.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ export interface OAuthConsentInfoJSON extends ClerkResourceJSON {
oauth_application_url: string;
client_id: string;
state: string;
redirect_domain: string | null;
scopes: OAuthConsentScopeJSON[];
}

Expand DownExpand Up@@ -68,6 +69,12 @@ export type OAuthConsentInfo = {
* The `state` parameter from the original authorize request.
*/
state: string;
/**
* The PSL-resolved registrable domain of the redirect URI for display on the consent screen.
* Null when no redirect URI was provided, when it is not registered for the application,
* or when it points to an IP address or localhost.
*/
redirectDomain: string | null;
/**
* A list of scopes the application is requesting, with descriptions and consent requirements.
*/
Expand All@@ -79,6 +86,8 @@ export type GetOAuthConsentInfoParams = {
oauthClientId: string;
/** A space-delimited scope string from the authorize request. */
scope?: string;
/** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
redirectUri?: string;
};

/**
Expand Down
6 changes: 4 additions & 2 deletions packages/ui/src/components/OAuthConsent/OAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,11 @@ function _OAuthConsent() {

// Public path: fetch via hook. Disabled on the accounts portal path
// (which already has all data via context) to avoid a wasted FAPI request.
const redirectUri = ctx.redirectUrl ?? getRedirectUriFromSearch();
const { data, isLoading, error } = useOAuthConsent({
oauthClientId,
scope,
redirectUri: redirectUri || undefined,
// TODO: Remove this once account portal is refactored to use this component
enabled: !hasContextCallbacks,
});
Expand All@@ -69,7 +71,7 @@ function _OAuthConsent() {
const oauthApplicationName = ctx.oauthApplicationName ?? data?.oauthApplicationName ?? '';
const oauthApplicationLogoUrl = ctx.oauthApplicationLogoUrl ?? data?.oauthApplicationLogoUrl;
const oauthApplicationUrl = ctx.oauthApplicationUrl ?? data?.oauthApplicationUrl;
const redirectUrl = ctx.redirectUrl ?? getRedirectUriFromSearch();
const redirectUrl = ctx.redirectUrl ?? redirectUri;

const hasOrgReadScope = scopes.some(s => s.scope === USER_ORG_READ_SCOPE);
const orgSelectionEnabled = !!(hasOrgReadScope && organizationSettings.enabled);
Expand All@@ -85,7 +87,7 @@ function _OAuthConsent() {
const effectiveOrg = selectedOrg ?? defaultOrg;

const { t } = useLocalizations();
const domainAction = getRedirectDisplay(redirectUrl);
const domainAction = data?.redirectDomain ?? getRedirectDisplay(redirectUrl);
const viewFullUrlText = t(localizationKeys('oauthConsent.viewFullUrl'));

// Error states only apply to the public flow.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ const fakeConsentInfo = {
oauthApplicationUrl: 'https://example.com',
clientId: 'client_test',
state: 'abc',
redirectDomain: 'example.com',
scopes: [
{ scope: 'openid', description: 'View your identity', requiresConsent: true },
{ scope: 'email', description: 'Access your email address', requiresConsent: true },
Expand DownExpand Up@@ -94,6 +95,7 @@ describe('OAuthConsent', () => {

expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'client_test',
redirectUri: 'https://app.example/callback',
});
});

Expand DownExpand Up@@ -204,6 +206,7 @@ describe('OAuthConsent', () => {
expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'override_id',
scope: 'openid email',
redirectUri: 'https://app.example/callback',
});
});
});
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions .changeset/quiet-terms-drum.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
'@clerk/ui': patch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks like this also touches shared and clerk-js

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

thanks! will update after some more local testing later

'@clerk/clerk-js': patch
'@clerk/shared': patch
---

Correctly display OAuth consent redirect domains for known multi-label public suffixes.
9 changes: 7 additions & 2 deletions packages/clerk-js/src/core/modules/oauthApplication/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,16 @@ import { BaseResource } from '../../resources/internal';

export class OAuthApplication implements OAuthApplicationNamespace {
async getConsentInfo(params: GetOAuthConsentInfoParams): Promise<OAuthConsentInfo> {
const { oauthClientId, scope } = params;
const { oauthClientId, scope, redirectUri } = params;
const search = {
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirect_uri: redirectUri }),
};
const json = await BaseResource._fetch<OAuthConsentInfoJSON>(
{
method: 'GET',
path: `/me/oauth/consent/${encodeURIComponent(oauthClientId)}`,
search: scope !== undefined ? { scope } : undefined,
search: Object.keys(search).length > 0 ? search : undefined,
},
{ skipUpdateClient: true },
);
Expand All@@ -31,6 +35,7 @@ export class OAuthApplication implements OAuthApplicationNamespace {
oauthApplicationUrl: data.oauth_application_url,
clientId: data.client_id,
state: data.state,
redirectDomain: data.redirect_domain,
scopes:
data.scopes?.map(s => ({
scope: s.scope,
Expand Down
21 changes: 13 additions & 8 deletions packages/shared/src/react/hooks/useOAuthConsent.shared.ts
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
import { useMemo } from 'react';

import type { GetOAuthConsentInfoParams } from '../../types';
import { STABLE_KEYS } from '../stable-keys';
import { createCacheKeys } from './createCacheKeys';

export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthClientId: string; scope?: string }) {
const { userId, oauthClientId, scope } = params;
export function useOAuthConsentCacheKeys(params: {
userId: string | null;
oauthClientId: string;
scope?: string;
redirectUri?: string;
}) {
const { userId, oauthClientId, scope, redirectUri } = params;
return useMemo(() => {
const args: Pick<GetOAuthConsentInfoParams, 'oauthClientId'> & { scope?: string } = { oauthClientId };
if (scope !== undefined) {
args.scope = scope;
}
const args = {
oauthClientId,
...(scope !== undefined && { scope }),
...(redirectUri !== undefined && { redirectUri }),
};
return createCacheKeys({
stablePrefix: STABLE_KEYS.OAUTH_CONSENT_INFO_KEY,
authenticated: true,
Expand All@@ -21,5 +26,5 @@ export function useOAuthConsentCacheKeys(params: { userId: string | null; oauthC
args,
},
});
}, [userId, oauthClientId, scope]);
}, [userId, oauthClientId, scope, redirectUri]);
}
10 changes: 5 additions & 5 deletions packages/shared/src/react/hooks/useOAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -27,7 +27,7 @@ const HOOK_NAME = 'useOAuthConsent';
export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentReturn {
useAssertWrappedByClerkProvider(HOOK_NAME);

const { oauthClientId: oauthClientIdParam, scope, keepPreviousData = true, enabled = true } = params;
const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
const clerk = useClerkInstanceContext();
const user = useUserBase();

Expand All@@ -39,14 +39,15 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
userId: user?.id ?? null,
oauthClientId,
scope,
redirectUri,
});

const hasClientId = oauthClientId.length > 0;
const queryEnabled = Boolean(user) && hasClientId && enabled && clerk.loaded;

const query = useClerkQuery({
queryKey,
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope }),
queryFn: () => fetchConsentInfo(clerk, { oauthClientId, scope, redirectUri }),
enabled: queryEnabled,
placeholderData: defineKeepPreviousDataFn(keepPreviousData && queryEnabled),
});
Expand All@@ -59,7 +60,6 @@ export function useOAuthConsent(params: UseOAuthConsentParams): UseOAuthConsentR
};
}

function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string }) {
const { oauthClientId, scope } = params;
return clerk.oauthApplication.getConsentInfo(scope !== undefined ? { oauthClientId, scope } : { oauthClientId });
function fetchConsentInfo(clerk: LoadedClerk, params: { oauthClientId: string; scope?: string; redirectUri?: string }) {
return clerk.oauthApplication.getConsentInfo(params);
}
2 changes: 1 addition & 1 deletion packages/shared/src/react/hooks/useOAuthConsent.types.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { GetOAuthConsentInfoParams, OAuthConsentInfo } from '../../types';
/**
* @interface
*/
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope'> & {
export type UseOAuthConsentParams = Pick<GetOAuthConsentInfoParams, 'oauthClientId' | 'scope' | 'redirectUri'> & {
/**
* If `true`, the previous data will be kept in the cache until new data is fetched.
*
Expand Down
9 changes: 9 additions & 0 deletions packages/shared/src/types/oauthApplication.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ export interface OAuthConsentInfoJSON extends ClerkResourceJSON {
oauth_application_url: string;
client_id: string;
state: string;
redirect_domain: string | null;
scopes: OAuthConsentScopeJSON[];
}

Expand DownExpand Up@@ -68,6 +69,12 @@ export type OAuthConsentInfo = {
* The `state` parameter from the original authorize request.
*/
state: string;
/**
* The PSL-resolved registrable domain of the redirect URI for display on the consent screen.
* Null when no redirect URI was provided, when it is not registered for the application,
* or when it points to an IP address or localhost.
*/
redirectDomain: string | null;
/**
* A list of scopes the application is requesting, with descriptions and consent requirements.
*/
Expand All@@ -79,6 +86,8 @@ export type GetOAuthConsentInfoParams = {
oauthClientId: string;
/** A space-delimited scope string from the authorize request. */
scope?: string;
/** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
redirectUri?: string;
};

/**
Expand Down
6 changes: 4 additions & 2 deletions packages/ui/src/components/OAuthConsent/OAuthConsent.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,9 +50,11 @@ function _OAuthConsent() {

// Public path: fetch via hook. Disabled on the accounts portal path
// (which already has all data via context) to avoid a wasted FAPI request.
const redirectUri = ctx.redirectUrl ?? getRedirectUriFromSearch();
const { data, isLoading, error } = useOAuthConsent({
oauthClientId,
scope,
redirectUri: redirectUri || undefined,
// TODO: Remove this once account portal is refactored to use this component
enabled: !hasContextCallbacks,
});
Expand All@@ -69,7 +71,7 @@ function _OAuthConsent() {
const oauthApplicationName = ctx.oauthApplicationName ?? data?.oauthApplicationName ?? '';
const oauthApplicationLogoUrl = ctx.oauthApplicationLogoUrl ?? data?.oauthApplicationLogoUrl;
const oauthApplicationUrl = ctx.oauthApplicationUrl ?? data?.oauthApplicationUrl;
const redirectUrl = ctx.redirectUrl ?? getRedirectUriFromSearch();
const redirectUrl = ctx.redirectUrl ?? redirectUri;

const hasOrgReadScope = scopes.some(s => s.scope === USER_ORG_READ_SCOPE);
const orgSelectionEnabled = !!(hasOrgReadScope && organizationSettings.enabled);
Expand All@@ -85,7 +87,7 @@ function _OAuthConsent() {
const effectiveOrg = selectedOrg ?? defaultOrg;

const { t } = useLocalizations();
const domainAction = getRedirectDisplay(redirectUrl);
const domainAction = data?.redirectDomain ?? getRedirectDisplay(redirectUrl);
const viewFullUrlText = t(localizationKeys('oauthConsent.viewFullUrl'));

// Error states only apply to the public flow.
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ const fakeConsentInfo = {
oauthApplicationUrl: 'https://example.com',
clientId: 'client_test',
state: 'abc',
redirectDomain: 'example.com',
scopes: [
{ scope: 'openid', description: 'View your identity', requiresConsent: true },
{ scope: 'email', description: 'Access your email address', requiresConsent: true },
Expand DownExpand Up@@ -94,6 +95,7 @@ describe('OAuthConsent', () => {

expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'client_test',
redirectUri: 'https://app.example/callback',
});
});

Expand DownExpand Up@@ -204,6 +206,7 @@ describe('OAuthConsent', () => {
expect(getConsentInfo).toHaveBeenCalledWith({
oauthClientId: 'override_id',
scope: 'openid email',
redirectUri: 'https://app.example/callback',
});
});
});
Expand Down
Loading