[wip] feat(clerk-js): Navigate on task resolution #5333

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

Closed
LauraBeatris wants to merge 14 commits into from
Closed

[wip] feat(clerk-js): Navigate on task resolution #5333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
8dc0aba
Update `setActive` to handle `pending` session status
LauraBeatris Mar 4, 2025
ae5b620
Handle internal component navigation
LauraBeatris Mar 4, 2025
82d70fd
Introduce test coverage
LauraBeatris Mar 5, 2025
0203bc0
Introduce experimental prop for lazy loading routes
LauraBeatris Mar 8, 2025
234f912
Send telemetry event
LauraBeatris Mar 8, 2025
b4f1d7e
Refactor internal routing to set on `BaseRouter`
LauraBeatris Mar 10, 2025
9f0f4d0
Refactor integration tests to use use long running apps
LauraBeatris Mar 11, 2025
674b8a3
Update bundlewatch limit for headless bundle
LauraBeatris Mar 11, 2025
e02429e
Remove unused `TokenUpdate` dispatch
LauraBeatris Mar 11, 2025
1731e49
Refactor internal routing logic
LauraBeatris Mar 11, 2025
afa6ed4
Remove unused `null` from type
LauraBeatris Mar 11, 2025
47d3077
Add comment to clarify temporary `experimental.withSessionTasks`
LauraBeatris Mar 11, 2025
39724c1
Forward after sign-in/sign-up URLs to `SessionTask` component context
LauraBeatris Mar 12, 2025
0c5cb8c
Handle navigation to next task upon `/touch`
LauraBeatris Mar 12, 2025
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
1 change: 0 additions & 1 deletion .changeset/brave-pears-add.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
'@clerk/clerk-react': minor
---

Navigate to tasks on after sign-in/sign-up
8 changes: 4 additions & 4 deletions packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "572kB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "78kB" },
{ "path": "./dist/clerk.js", "maxSize": "560kB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
{ "path": "./dist/clerk.headless.js", "maxSize": "50KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "92KB" },
{ "path": "./dist/vendors*.js", "maxSize": "26.5KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "89.2KB" },
{ "path": "./dist/vendors*.js", "maxSize": "25.1KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
{ "path": "./dist/createorganization*.js", "maxSize": "5KB" },
{ "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down
10 changes: 8 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
OrganizationProfileProps,
OrganizationResource,
OrganizationSwitcherProps,
PendingSessionResource,
PublicKeyCredentialCreationOptionsWithoutExtensions,
PublicKeyCredentialRequestOptionsWithoutExtensions,
PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand DownExpand Up@@ -1009,6 +1010,11 @@ export class Clerk implements ClerkInterface {
newSession = this.#getSessionFromClient(newSession?.id);
}

if (newSession?.status === 'pending') {
await this.#handlePendingSession(newSession);
return;
}

// getToken syncs __session and __client_uat to cookies using events.TokenUpdate dispatched event.
const token = await newSession?.getToken();
if (!token) {
Expand DownExpand Up@@ -1058,7 +1064,7 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
};

#handlePendingSession = async (session: SignedInSessionResource) => {
#handlePendingSession = async (session: PendingSessionResource) => {
if (!this.environment) {
return;
}
Expand All@@ -1067,7 +1073,7 @@ export class Clerk implements ClerkInterface {
// to `pending`
if (inActiveBrowserTab() || !this.#options.standardBrowser) {
await this.#touchCurrentSession(session);
session = this.#getSessionFromClient(session.id) ?? session;
session = (this.#getSessionFromClient(session.id) ?? session) as PendingSessionResource;
}

// Syncs __session and __client_uat, in case the `pending` session
Expand Down
8 changes: 2 additions & 6 deletions packages/clerk-js/src/ui/common/withRedirect.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Com
Component,
sessionExistsAndSingleSessionModeEnabled,
({ clerk }) => signInCtx.sessionTaskUrl || signInCtx.afterSignInUrl || clerk.buildAfterSignInUrl(),
signInCtx.sessionTaskUrl
? warnings.cannotRenderSignInComponentWhenTaskExists
: warnings.cannotRenderSignInComponentWhenSessionExists,
warnings.cannotRenderSignInComponentWhenSessionExists,
)(props);
};

Expand All@@ -83,9 +81,7 @@ export const withRedirectToAfterSignUp = <P extends AvailableComponentProps>(Com
Component,
sessionExistsAndSingleSessionModeEnabled,
({ clerk }) => signUpCtx.sessionTaskUrl || signUpCtx.afterSignUpUrl || clerk.buildAfterSignUpUrl(),
signUpCtx.sessionTaskUrl
? warnings.cannotRenderSignUpComponentWhenTaskExists
: warnings.cannotRenderSignUpComponentWhenSessionExists,
warnings.cannotRenderSignUpComponentWhenSessionExists,
)(props);
};

Expand Down
25 changes: 20 additions & 5 deletions packages/clerk-js/src/ui/components/SessionTask/SessionTask.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,25 @@ import type { SessionTask } from '@clerk/types';
import { OrganizationListContext } from '../../contexts';
import { OrganizationList } from '../OrganizationList';

const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
org: () => (
interface SessionTaskProps {
task: SessionTask['key'];
redirectUrlComplete: string;
}

const ContentRegistry: Record<
SessionTask['key'],
React.ComponentType<Pick<SessionTaskProps, 'redirectUrlComplete'>>
> = {
org: ({ redirectUrlComplete }) => (
// TODO - Hide personal workspace within organization list context based on environment
<OrganizationListContext.Provider value={{ componentName: 'OrganizationList', hidePersonal: true }}>
<OrganizationListContext.Provider
value={{
componentName: 'OrganizationList',
hidePersonal: true,
afterSelectOrganizationUrl: redirectUrlComplete,
afterCreateOrganizationUrl: redirectUrlComplete,
}}
>
<OrganizationList />
</OrganizationListContext.Provider>
),
Expand All@@ -17,12 +32,12 @@ const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
/**
* @internal
*/
export function SessionTask({ task}: { task: SessionTask['key'] }): React.ReactNode {
export function SessionTask({ task, redirectUrlComplete }: SessionTaskProps): React.ReactNode {
const clerk = useClerk();

clerk.telemetry?.record(eventComponentMounted('SessionTask', { task }));

const Content = ContentRegistry[task];

return <Content />;
return <Content redirectUrlComplete={redirectUrlComplete} />;
}
15 changes: 12 additions & 3 deletions packages/clerk-js/src/ui/components/SignIn/SignIn.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useClerk } from '@clerk/shared/react';
import type { SignInModalProps, SignInProps } from '@clerk/types';
import React from 'react';
import { preloadComponent, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { normalizeRoutingOptions } from '../../../utils/normalizeRoutingOptions';
Expand All@@ -10,6 +11,8 @@ import {
SignInContext,
SignUpContext,
useSignInContext,
useSignInContext,
useSignInContext,
useSignUpContext,
withCoreSessionSwitchGuard,
} from '../../contexts';
Expand DownExpand Up@@ -132,7 +135,10 @@ function SignInRoutes(): JSX.Element {
</Route>
{signInContext.withSessionTasks && (
<Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
<SessionTask task='org' />
<SessionTask
task='org'
redirectUrlComplete={signUpContext.afterSignUpUrl}
/>
</Route>
)}
<Route index>
Expand All@@ -146,7 +152,10 @@ function SignInRoutes(): JSX.Element {
)}
{signInContext.withSessionTasks && (
<Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
<SessionTask task='org' />
<SessionTask
task='org'
redirectUrlComplete={signUpContext.afterSignInUrl}
/>
</Route>
)}
<Route index>
Expand DownExpand Up@@ -192,7 +201,7 @@ function SignInRoot() {

React.useEffect(() => {
return __internal_setComponentNavigationContext?.({ basePath, navigate });
}, [basePath, navigate]);
}, []);

return (
<SignUpContext.Provider value={normalizedSignUpContext}>
Expand Down
14 changes: 10 additions & 4 deletions packages/clerk-js/src/ui/components/SignUp/SignUp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
import { useClerk } from '@clerk/shared/react';
import type { SignUpModalProps, SignUpProps } from '@clerk/types';
import React from 'react';
import { useFetch } from 'ui/hooks';
import { preloadSessionTask, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignUpEmailLinkFlowComplete } from '../../common/EmailLinkCompleteFlowCard';
import { SignUpContext, useSignUpContext, withCoreSessionSwitchGuard } from '../../contexts';
import { Flow } from '../../customizables';
import { useFetch } from '../../hooks';
import { preloadSessionTask, SessionTask } from '../../lazyModules/components';
import { Route, Switch, useRouter, VIRTUAL_ROUTER_BASE_PATH } from '../../router';
import { SignUpContinue } from './SignUpContinue';
import { SignUpSSOCallback } from './SignUpSSOCallback';
import { SignUpStart } from './SignUpStart';
import { SignUpVerifyEmail } from './SignUpVerifyEmail';
import { SignUpVerifyPhone } from './SignUpVerifyPhone';

const usePreloadSessionTask = (enabled = false) =>
useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

const usePreloadSessionTask = (enabled = false) =>
useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

Expand All@@ -36,7 +39,7 @@ function SignUpRoutes(): JSX.Element {

React.useEffect(() => {
return __internal_setComponentNavigationContext?.({ basePath, navigate });
}, [basePath, navigate]);
}, []);

return (
<Flow.Root flow='signUp'>
Expand DownExpand Up@@ -91,7 +94,10 @@ function SignUpRoutes(): JSX.Element {
</Route>
{signUpContext.withSessionTasks && (
<Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
<SessionTask task='org' />
<SessionTask
task='org'
redirectUrlComplete={signUpContext.afterSignUpUrl}
/>
</Route>
)}
<Route index>
Expand Down
6 changes: 0 additions & 6 deletions packages/clerk-js/src/ui/lazyModules/components.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@ const componentImportPaths = {
UserVerification: () => import(/* webpackChunkName: "userverification" */ './../components/UserVerification'),
Waitlist: () => import(/* webpackChunkName: "waitlist" */ './../components/Waitlist'),
KeylessPrompt: () => import(/* webpackChunkName: "keylessPrompt" */ '../components/KeylessPrompt'),
PricingTable: () => import(/* webpackChunkName: "pricingTable" */ '../components/PricingTable'),
Checkout: () => import(/* webpackChunkName: "checkout" */ '../components/Checkout'),
SessionTask: () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask'),
} as const;

Expand DownExpand Up@@ -91,10 +89,6 @@ export const KeylessPrompt = lazy(() =>
componentImportPaths.KeylessPrompt().then(module => ({ default: module.KeylessPrompt })),
);

export const PricingTable = lazy(() =>
componentImportPaths.PricingTable().then(module => ({ default: module.__experimental_PricingTable })),
);

export const preloadSessionTask = () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask');
export const SessionTask = lazy(() =>
componentImportPaths.SessionTask().then(module => ({ default: module.SessionTask })),
Expand Down
1 change: 0 additions & 1 deletion packages/react/src/isomorphicClerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,6 @@ type IsomorphicLoadedClerk = Without<
| '__internal_addNavigationListener'
| '__internal_getCachedResources'
| '__internal_reloadInitialResources'
| '__experimental_commerce'
| '__internal_setComponentNavigationContext'
> & {
client: ClientResource | undefined;
Expand Down
1 change: 0 additions & 1 deletion packages/types/src/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -817,7 +817,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
* Clerk will rethrow network errors that occur while the user is offline.
*/
rethrowOfflineNetworkErrors: boolean;
commerce: boolean;
// `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
withSessionTasks: boolean;
},
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} 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
[wip] feat(clerk-js): Navigate on task resolution #5333

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

 Closed

LauraBeatris
wants to merge
14
commits into

from

 Closed


[wip] feat(clerk-js): Navigate on task resolution #5333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
8dc0aba

Update `setActive` to handle `pending` session status


LauraBeatris Mar 4, 2025
ae5b620

Handle internal component navigation


LauraBeatris Mar 4, 2025
82d70fd

Introduce test coverage


LauraBeatris Mar 5, 2025
0203bc0

Introduce experimental prop for lazy loading routes


LauraBeatris Mar 8, 2025
234f912

Send telemetry event


LauraBeatris Mar 8, 2025
b4f1d7e

Refactor internal routing to set on `BaseRouter`


LauraBeatris Mar 10, 2025
9f0f4d0

Refactor integration tests to use use long running apps


LauraBeatris Mar 11, 2025
674b8a3

Update bundlewatch limit for headless bundle


LauraBeatris Mar 11, 2025
e02429e

Remove unused `TokenUpdate` dispatch


LauraBeatris Mar 11, 2025
1731e49

Refactor internal routing logic


LauraBeatris Mar 11, 2025
afa6ed4

Remove unused `null` from type


LauraBeatris Mar 11, 2025
47d3077

Add comment to clarify temporary `experimental.withSessionTasks`


LauraBeatris Mar 11, 2025
39724c1

Forward after sign-in/sign-up URLs to `SessionTask` component context


LauraBeatris Mar 12, 2025
0c5cb8c

Handle navigation to next task upon `/touch`


LauraBeatris Mar 12, 2025

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


1 change: 0 additions & 1 deletion
.changeset/brave-pears-add.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
'@clerk/clerk-react': minor
---

Navigate to tasks on after sign-in/sign-up

8 changes: 4 additions & 4 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "572kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "78kB" },
 { "path": "./dist/clerk.js", "maxSize": "560kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "50KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "92KB" },
 { "path": "./dist/vendors*.js", "maxSize": "26.5KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "89.2KB" },
 { "path": "./dist/vendors*.js", "maxSize": "25.1KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

10 changes: 8 additions & 2 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 PendingSessionResource,
 PublicKeyCredentialCreationOptionsWithoutExtensions,
 PublicKeyCredentialRequestOptionsWithoutExtensions,
 PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand DownExpand Up@@ -1009,6 +1010,11 @@ export class Clerk implements ClerkInterface {
 newSession = this.#getSessionFromClient(newSession?.id);
 }

 if (newSession?.status === 'pending') {
 await this.#handlePendingSession(newSession);
 return;
 }

 // getToken syncs __session and __client_uat to cookies using events.TokenUpdate dispatched event.
 const token = await newSession?.getToken();
 if (!token) {
Expand DownExpand Up@@ -1058,7 +1064,7 @@ export class Clerk implements ClerkInterface {
 await onAfterSetActive();
 };

 #handlePendingSession = async (session: SignedInSessionResource) => {
 #handlePendingSession = async (session: PendingSessionResource) => {
 if (!this.environment) {
 return;
 }
Expand All@@ -1067,7 +1073,7 @@ export class Clerk implements ClerkInterface {
 // to `pending`
 if (inActiveBrowserTab() || !this.#options.standardBrowser) {
 await this.#touchCurrentSession(session);
 session = this.#getSessionFromClient(session.id) ?? session;
 session = (this.#getSessionFromClient(session.id) ?? session) as PendingSessionResource;
 }

 // Syncs __session and __client_uat, in case the `pending` session
Expand Down

8 changes: 2 additions & 6 deletions
packages/clerk-js/src/ui/common/withRedirect.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signInCtx.sessionTaskUrl || signInCtx.afterSignInUrl || clerk.buildAfterSignInUrl(),
 signInCtx.sessionTaskUrl
 ? warnings.cannotRenderSignInComponentWhenTaskExists
 : warnings.cannotRenderSignInComponentWhenSessionExists,
 warnings.cannotRenderSignInComponentWhenSessionExists,
 )(props);
 };

Expand All@@ -83,9 +81,7 @@ export const withRedirectToAfterSignUp = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signUpCtx.sessionTaskUrl || signUpCtx.afterSignUpUrl || clerk.buildAfterSignUpUrl(),
 signUpCtx.sessionTaskUrl
 ? warnings.cannotRenderSignUpComponentWhenTaskExists
 : warnings.cannotRenderSignUpComponentWhenSessionExists,
 warnings.cannotRenderSignUpComponentWhenSessionExists,
 )(props);
 };

Expand Down

25 changes: 20 additions & 5 deletions
packages/clerk-js/src/ui/components/SessionTask/SessionTask.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,25 @@ import type { SessionTask } from '@clerk/types';
import { OrganizationListContext } from '../../contexts';
import { OrganizationList } from '../OrganizationList';

const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
 org: () => (
interface SessionTaskProps {
 task: SessionTask['key'];
 redirectUrlComplete: string;
}

const ContentRegistry: Record<
 SessionTask['key'],
 React.ComponentType<Pick<SessionTaskProps, 'redirectUrlComplete'>>
> = {
 org: ({ redirectUrlComplete }) => (
 // TODO - Hide personal workspace within organization list context based on environment
 <OrganizationListContext.Provider value={{ componentName: 'OrganizationList', hidePersonal: true }}>
 <OrganizationListContext.Provider
 value={{
 componentName: 'OrganizationList',
 hidePersonal: true,
 afterSelectOrganizationUrl: redirectUrlComplete,
 afterCreateOrganizationUrl: redirectUrlComplete,
 }}
 >
 <OrganizationList />
 </OrganizationListContext.Provider>
 ),
Expand All@@ -17,12 +32,12 @@ const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
/**
 * @internal
 */
export function SessionTask({ task}: { task: SessionTask['key'] }): React.ReactNode {
export function SessionTask({ task, redirectUrlComplete }: SessionTaskProps): React.ReactNode {
 const clerk = useClerk();

 clerk.telemetry?.record(eventComponentMounted('SessionTask', { task }));

 const Content = ContentRegistry[task];

 return <Content />;
 return <Content redirectUrlComplete={redirectUrlComplete} />;
}

15 changes: 12 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useClerk } from '@clerk/shared/react';
import type { SignInModalProps, SignInProps } from '@clerk/types';
import React from 'react';
import { preloadComponent, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { normalizeRoutingOptions } from '../../../utils/normalizeRoutingOptions';
Expand All@@ -10,6 +11,8 @@ import {
 SignInContext,
 SignUpContext,
 useSignInContext,
 useSignInContext,
 useSignInContext,
 useSignUpContext,
 withCoreSessionSwitchGuard,
} from '../../contexts';
Expand DownExpand Up@@ -132,7 +135,10 @@ function SignInRoutes(): JSX.Element {
 </Route>
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand All@@ -146,7 +152,10 @@ function SignInRoutes(): JSX.Element {
 )}
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignInUrl}
 />
 </Route>
 )}
 <Route index>
Expand DownExpand Up@@ -192,7 +201,7 @@ function SignInRoot() {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <SignUpContext.Provider value={normalizedSignUpContext}>
Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
import { useClerk } from '@clerk/shared/react';
import type { SignUpModalProps, SignUpProps } from '@clerk/types';
import React from 'react';
import { useFetch } from 'ui/hooks';
import { preloadSessionTask, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignUpEmailLinkFlowComplete } from '../../common/EmailLinkCompleteFlowCard';
import { SignUpContext, useSignUpContext, withCoreSessionSwitchGuard } from '../../contexts';
import { Flow } from '../../customizables';
import { useFetch } from '../../hooks';
import { preloadSessionTask, SessionTask } from '../../lazyModules/components';
import { Route, Switch, useRouter, VIRTUAL_ROUTER_BASE_PATH } from '../../router';
import { SignUpContinue } from './SignUpContinue';
import { SignUpSSOCallback } from './SignUpSSOCallback';
import { SignUpStart } from './SignUpStart';
import { SignUpVerifyEmail } from './SignUpVerifyEmail';
import { SignUpVerifyPhone } from './SignUpVerifyPhone';

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

Expand All@@ -36,7 +39,7 @@ function SignUpRoutes(): JSX.Element {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <Flow.Root flow='signUp'>
Expand DownExpand Up@@ -91,7 +94,10 @@ function SignUpRoutes(): JSX.Element {
 </Route>
 {signUpContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand Down

6 changes: 0 additions & 6 deletions
packages/clerk-js/src/ui/lazyModules/components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@ const componentImportPaths = {
 UserVerification: () => import(/* webpackChunkName: "userverification" */ './../components/UserVerification'),
 Waitlist: () => import(/* webpackChunkName: "waitlist" */ './../components/Waitlist'),
 KeylessPrompt: () => import(/* webpackChunkName: "keylessPrompt" */ '../components/KeylessPrompt'),
 PricingTable: () => import(/* webpackChunkName: "pricingTable" */ '../components/PricingTable'),
 Checkout: () => import(/* webpackChunkName: "checkout" */ '../components/Checkout'),
 SessionTask: () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask'),
} as const;

Expand DownExpand Up@@ -91,10 +89,6 @@ export const KeylessPrompt = lazy(() =>
 componentImportPaths.KeylessPrompt().then(module => ({ default: module.KeylessPrompt })),
);

export const PricingTable = lazy(() =>
 componentImportPaths.PricingTable().then(module => ({ default: module.__experimental_PricingTable })),
);

export const preloadSessionTask = () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask');
export const SessionTask = lazy(() =>
 componentImportPaths.SessionTask().then(module => ({ default: module.SessionTask })),
Expand Down

1 change: 0 additions & 1 deletion
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,6 @@ type IsomorphicLoadedClerk = Without<
 | '__internal_addNavigationListener'
 | '__internal_getCachedResources'
 | '__internal_reloadInitialResources'
 | '__experimental_commerce'
 | '__internal_setComponentNavigationContext'
> & {
 client: ClientResource | undefined;
Expand Down

1 change: 0 additions & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -817,7 +817,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 * Clerk will rethrow network errors that occur while the user is offline.
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[wip] feat(clerk-js): Navigate on task resolution #5333

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

 Closed

LauraBeatris
wants to merge
14
commits into

from

 Closed


[wip] feat(clerk-js): Navigate on task resolution #5333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
8dc0aba

Update `setActive` to handle `pending` session status


LauraBeatris Mar 4, 2025
ae5b620

Handle internal component navigation


LauraBeatris Mar 4, 2025
82d70fd

Introduce test coverage


LauraBeatris Mar 5, 2025
0203bc0

Introduce experimental prop for lazy loading routes


LauraBeatris Mar 8, 2025
234f912

Send telemetry event


LauraBeatris Mar 8, 2025
b4f1d7e

Refactor internal routing to set on `BaseRouter`


LauraBeatris Mar 10, 2025
9f0f4d0

Refactor integration tests to use use long running apps


LauraBeatris Mar 11, 2025
674b8a3

Update bundlewatch limit for headless bundle


LauraBeatris Mar 11, 2025
e02429e

Remove unused `TokenUpdate` dispatch


LauraBeatris Mar 11, 2025
1731e49

Refactor internal routing logic


LauraBeatris Mar 11, 2025
afa6ed4

Remove unused `null` from type


LauraBeatris Mar 11, 2025
47d3077

Add comment to clarify temporary `experimental.withSessionTasks`


LauraBeatris Mar 11, 2025
39724c1

Forward after sign-in/sign-up URLs to `SessionTask` component context


LauraBeatris Mar 12, 2025
0c5cb8c

Handle navigation to next task upon `/touch`


LauraBeatris Mar 12, 2025

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


1 change: 0 additions & 1 deletion
.changeset/brave-pears-add.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
'@clerk/clerk-react': minor
---

Navigate to tasks on after sign-in/sign-up

8 changes: 4 additions & 4 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "572kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "78kB" },
 { "path": "./dist/clerk.js", "maxSize": "560kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "50KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "92KB" },
 { "path": "./dist/vendors*.js", "maxSize": "26.5KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "89.2KB" },
 { "path": "./dist/vendors*.js", "maxSize": "25.1KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

10 changes: 8 additions & 2 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 PendingSessionResource,
 PublicKeyCredentialCreationOptionsWithoutExtensions,
 PublicKeyCredentialRequestOptionsWithoutExtensions,
 PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand DownExpand Up@@ -1009,6 +1010,11 @@ export class Clerk implements ClerkInterface {
 newSession = this.#getSessionFromClient(newSession?.id);
 }

 if (newSession?.status === 'pending') {
 await this.#handlePendingSession(newSession);
 return;
 }

 // getToken syncs __session and __client_uat to cookies using events.TokenUpdate dispatched event.
 const token = await newSession?.getToken();
 if (!token) {
Expand DownExpand Up@@ -1058,7 +1064,7 @@ export class Clerk implements ClerkInterface {
 await onAfterSetActive();
 };

 #handlePendingSession = async (session: SignedInSessionResource) => {
 #handlePendingSession = async (session: PendingSessionResource) => {
 if (!this.environment) {
 return;
 }
Expand All@@ -1067,7 +1073,7 @@ export class Clerk implements ClerkInterface {
 // to `pending`
 if (inActiveBrowserTab() || !this.#options.standardBrowser) {
 await this.#touchCurrentSession(session);
 session = this.#getSessionFromClient(session.id) ?? session;
 session = (this.#getSessionFromClient(session.id) ?? session) as PendingSessionResource;
 }

 // Syncs __session and __client_uat, in case the `pending` session
Expand Down

8 changes: 2 additions & 6 deletions
packages/clerk-js/src/ui/common/withRedirect.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signInCtx.sessionTaskUrl || signInCtx.afterSignInUrl || clerk.buildAfterSignInUrl(),
 signInCtx.sessionTaskUrl
 ? warnings.cannotRenderSignInComponentWhenTaskExists
 : warnings.cannotRenderSignInComponentWhenSessionExists,
 warnings.cannotRenderSignInComponentWhenSessionExists,
 )(props);
 };

Expand All@@ -83,9 +81,7 @@ export const withRedirectToAfterSignUp = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signUpCtx.sessionTaskUrl || signUpCtx.afterSignUpUrl || clerk.buildAfterSignUpUrl(),
 signUpCtx.sessionTaskUrl
 ? warnings.cannotRenderSignUpComponentWhenTaskExists
 : warnings.cannotRenderSignUpComponentWhenSessionExists,
 warnings.cannotRenderSignUpComponentWhenSessionExists,
 )(props);
 };

Expand Down

25 changes: 20 additions & 5 deletions
packages/clerk-js/src/ui/components/SessionTask/SessionTask.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,25 @@ import type { SessionTask } from '@clerk/types';
import { OrganizationListContext } from '../../contexts';
import { OrganizationList } from '../OrganizationList';

const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
 org: () => (
interface SessionTaskProps {
 task: SessionTask['key'];
 redirectUrlComplete: string;
}

const ContentRegistry: Record<
 SessionTask['key'],
 React.ComponentType<Pick<SessionTaskProps, 'redirectUrlComplete'>>
> = {
 org: ({ redirectUrlComplete }) => (
 // TODO - Hide personal workspace within organization list context based on environment
 <OrganizationListContext.Provider value={{ componentName: 'OrganizationList', hidePersonal: true }}>
 <OrganizationListContext.Provider
 value={{
 componentName: 'OrganizationList',
 hidePersonal: true,
 afterSelectOrganizationUrl: redirectUrlComplete,
 afterCreateOrganizationUrl: redirectUrlComplete,
 }}
 >
 <OrganizationList />
 </OrganizationListContext.Provider>
 ),
Expand All@@ -17,12 +32,12 @@ const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
/**
 * @internal
 */
export function SessionTask({ task}: { task: SessionTask['key'] }): React.ReactNode {
export function SessionTask({ task, redirectUrlComplete }: SessionTaskProps): React.ReactNode {
 const clerk = useClerk();

 clerk.telemetry?.record(eventComponentMounted('SessionTask', { task }));

 const Content = ContentRegistry[task];

 return <Content />;
 return <Content redirectUrlComplete={redirectUrlComplete} />;
}

15 changes: 12 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useClerk } from '@clerk/shared/react';
import type { SignInModalProps, SignInProps } from '@clerk/types';
import React from 'react';
import { preloadComponent, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { normalizeRoutingOptions } from '../../../utils/normalizeRoutingOptions';
Expand All@@ -10,6 +11,8 @@ import {
 SignInContext,
 SignUpContext,
 useSignInContext,
 useSignInContext,
 useSignInContext,
 useSignUpContext,
 withCoreSessionSwitchGuard,
} from '../../contexts';
Expand DownExpand Up@@ -132,7 +135,10 @@ function SignInRoutes(): JSX.Element {
 </Route>
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand All@@ -146,7 +152,10 @@ function SignInRoutes(): JSX.Element {
 )}
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignInUrl}
 />
 </Route>
 )}
 <Route index>
Expand DownExpand Up@@ -192,7 +201,7 @@ function SignInRoot() {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <SignUpContext.Provider value={normalizedSignUpContext}>
Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
import { useClerk } from '@clerk/shared/react';
import type { SignUpModalProps, SignUpProps } from '@clerk/types';
import React from 'react';
import { useFetch } from 'ui/hooks';
import { preloadSessionTask, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignUpEmailLinkFlowComplete } from '../../common/EmailLinkCompleteFlowCard';
import { SignUpContext, useSignUpContext, withCoreSessionSwitchGuard } from '../../contexts';
import { Flow } from '../../customizables';
import { useFetch } from '../../hooks';
import { preloadSessionTask, SessionTask } from '../../lazyModules/components';
import { Route, Switch, useRouter, VIRTUAL_ROUTER_BASE_PATH } from '../../router';
import { SignUpContinue } from './SignUpContinue';
import { SignUpSSOCallback } from './SignUpSSOCallback';
import { SignUpStart } from './SignUpStart';
import { SignUpVerifyEmail } from './SignUpVerifyEmail';
import { SignUpVerifyPhone } from './SignUpVerifyPhone';

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

Expand All@@ -36,7 +39,7 @@ function SignUpRoutes(): JSX.Element {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <Flow.Root flow='signUp'>
Expand DownExpand Up@@ -91,7 +94,10 @@ function SignUpRoutes(): JSX.Element {
 </Route>
 {signUpContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand Down

6 changes: 0 additions & 6 deletions
packages/clerk-js/src/ui/lazyModules/components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@ const componentImportPaths = {
 UserVerification: () => import(/* webpackChunkName: "userverification" */ './../components/UserVerification'),
 Waitlist: () => import(/* webpackChunkName: "waitlist" */ './../components/Waitlist'),
 KeylessPrompt: () => import(/* webpackChunkName: "keylessPrompt" */ '../components/KeylessPrompt'),
 PricingTable: () => import(/* webpackChunkName: "pricingTable" */ '../components/PricingTable'),
 Checkout: () => import(/* webpackChunkName: "checkout" */ '../components/Checkout'),
 SessionTask: () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask'),
} as const;

Expand DownExpand Up@@ -91,10 +89,6 @@ export const KeylessPrompt = lazy(() =>
 componentImportPaths.KeylessPrompt().then(module => ({ default: module.KeylessPrompt })),
);

export const PricingTable = lazy(() =>
 componentImportPaths.PricingTable().then(module => ({ default: module.__experimental_PricingTable })),
);

export const preloadSessionTask = () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask');
export const SessionTask = lazy(() =>
 componentImportPaths.SessionTask().then(module => ({ default: module.SessionTask })),
Expand Down

1 change: 0 additions & 1 deletion
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,6 @@ type IsomorphicLoadedClerk = Without<
 | '__internal_addNavigationListener'
 | '__internal_getCachedResources'
 | '__internal_reloadInitialResources'
 | '__experimental_commerce'
 | '__internal_setComponentNavigationContext'
> & {
 client: ClientResource | undefined;
Expand Down

1 change: 0 additions & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -817,7 +817,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 * Clerk will rethrow network errors that occur while the user is offline.
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[wip] feat(clerk-js): Navigate on task resolution #5333

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

 Closed

LauraBeatris
wants to merge
14
commits into

from

 Closed


[wip] feat(clerk-js): Navigate on task resolution #5333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
8dc0aba

Update `setActive` to handle `pending` session status


LauraBeatris Mar 4, 2025
ae5b620

Handle internal component navigation


LauraBeatris Mar 4, 2025
82d70fd

Introduce test coverage


LauraBeatris Mar 5, 2025
0203bc0

Introduce experimental prop for lazy loading routes


LauraBeatris Mar 8, 2025
234f912

Send telemetry event


LauraBeatris Mar 8, 2025
b4f1d7e

Refactor internal routing to set on `BaseRouter`


LauraBeatris Mar 10, 2025
9f0f4d0

Refactor integration tests to use use long running apps


LauraBeatris Mar 11, 2025
674b8a3

Update bundlewatch limit for headless bundle


LauraBeatris Mar 11, 2025
e02429e

Remove unused `TokenUpdate` dispatch


LauraBeatris Mar 11, 2025
1731e49

Refactor internal routing logic


LauraBeatris Mar 11, 2025
afa6ed4

Remove unused `null` from type


LauraBeatris Mar 11, 2025
47d3077

Add comment to clarify temporary `experimental.withSessionTasks`


LauraBeatris Mar 11, 2025
39724c1

Forward after sign-in/sign-up URLs to `SessionTask` component context


LauraBeatris Mar 12, 2025
0c5cb8c

Handle navigation to next task upon `/touch`


LauraBeatris Mar 12, 2025

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


1 change: 0 additions & 1 deletion
.changeset/brave-pears-add.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
'@clerk/clerk-react': minor
---

Navigate to tasks on after sign-in/sign-up

8 changes: 4 additions & 4 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "572kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "78kB" },
 { "path": "./dist/clerk.js", "maxSize": "560kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "50KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "92KB" },
 { "path": "./dist/vendors*.js", "maxSize": "26.5KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "89.2KB" },
 { "path": "./dist/vendors*.js", "maxSize": "25.1KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

10 changes: 8 additions & 2 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 PendingSessionResource,
 PublicKeyCredentialCreationOptionsWithoutExtensions,
 PublicKeyCredentialRequestOptionsWithoutExtensions,
 PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand DownExpand Up@@ -1009,6 +1010,11 @@ export class Clerk implements ClerkInterface {
 newSession = this.#getSessionFromClient(newSession?.id);
 }

 if (newSession?.status === 'pending') {
 await this.#handlePendingSession(newSession);
 return;
 }

 // getToken syncs __session and __client_uat to cookies using events.TokenUpdate dispatched event.
 const token = await newSession?.getToken();
 if (!token) {
Expand DownExpand Up@@ -1058,7 +1064,7 @@ export class Clerk implements ClerkInterface {
 await onAfterSetActive();
 };

 #handlePendingSession = async (session: SignedInSessionResource) => {
 #handlePendingSession = async (session: PendingSessionResource) => {
 if (!this.environment) {
 return;
 }
Expand All@@ -1067,7 +1073,7 @@ export class Clerk implements ClerkInterface {
 // to `pending`
 if (inActiveBrowserTab() || !this.#options.standardBrowser) {
 await this.#touchCurrentSession(session);
 session = this.#getSessionFromClient(session.id) ?? session;
 session = (this.#getSessionFromClient(session.id) ?? session) as PendingSessionResource;
 }

 // Syncs __session and __client_uat, in case the `pending` session
Expand Down

8 changes: 2 additions & 6 deletions
packages/clerk-js/src/ui/common/withRedirect.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signInCtx.sessionTaskUrl || signInCtx.afterSignInUrl || clerk.buildAfterSignInUrl(),
 signInCtx.sessionTaskUrl
 ? warnings.cannotRenderSignInComponentWhenTaskExists
 : warnings.cannotRenderSignInComponentWhenSessionExists,
 warnings.cannotRenderSignInComponentWhenSessionExists,
 )(props);
 };

Expand All@@ -83,9 +81,7 @@ export const withRedirectToAfterSignUp = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signUpCtx.sessionTaskUrl || signUpCtx.afterSignUpUrl || clerk.buildAfterSignUpUrl(),
 signUpCtx.sessionTaskUrl
 ? warnings.cannotRenderSignUpComponentWhenTaskExists
 : warnings.cannotRenderSignUpComponentWhenSessionExists,
 warnings.cannotRenderSignUpComponentWhenSessionExists,
 )(props);
 };

Expand Down

25 changes: 20 additions & 5 deletions
packages/clerk-js/src/ui/components/SessionTask/SessionTask.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,25 @@ import type { SessionTask } from '@clerk/types';
import { OrganizationListContext } from '../../contexts';
import { OrganizationList } from '../OrganizationList';

const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
 org: () => (
interface SessionTaskProps {
 task: SessionTask['key'];
 redirectUrlComplete: string;
}

const ContentRegistry: Record<
 SessionTask['key'],
 React.ComponentType<Pick<SessionTaskProps, 'redirectUrlComplete'>>
> = {
 org: ({ redirectUrlComplete }) => (
 // TODO - Hide personal workspace within organization list context based on environment
 <OrganizationListContext.Provider value={{ componentName: 'OrganizationList', hidePersonal: true }}>
 <OrganizationListContext.Provider
 value={{
 componentName: 'OrganizationList',
 hidePersonal: true,
 afterSelectOrganizationUrl: redirectUrlComplete,
 afterCreateOrganizationUrl: redirectUrlComplete,
 }}
 >
 <OrganizationList />
 </OrganizationListContext.Provider>
 ),
Expand All@@ -17,12 +32,12 @@ const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
/**
 * @internal
 */
export function SessionTask({ task}: { task: SessionTask['key'] }): React.ReactNode {
export function SessionTask({ task, redirectUrlComplete }: SessionTaskProps): React.ReactNode {
 const clerk = useClerk();

 clerk.telemetry?.record(eventComponentMounted('SessionTask', { task }));

 const Content = ContentRegistry[task];

 return <Content />;
 return <Content redirectUrlComplete={redirectUrlComplete} />;
}

15 changes: 12 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useClerk } from '@clerk/shared/react';
import type { SignInModalProps, SignInProps } from '@clerk/types';
import React from 'react';
import { preloadComponent, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { normalizeRoutingOptions } from '../../../utils/normalizeRoutingOptions';
Expand All@@ -10,6 +11,8 @@ import {
 SignInContext,
 SignUpContext,
 useSignInContext,
 useSignInContext,
 useSignInContext,
 useSignUpContext,
 withCoreSessionSwitchGuard,
} from '../../contexts';
Expand DownExpand Up@@ -132,7 +135,10 @@ function SignInRoutes(): JSX.Element {
 </Route>
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand All@@ -146,7 +152,10 @@ function SignInRoutes(): JSX.Element {
 )}
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignInUrl}
 />
 </Route>
 )}
 <Route index>
Expand DownExpand Up@@ -192,7 +201,7 @@ function SignInRoot() {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <SignUpContext.Provider value={normalizedSignUpContext}>
Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
import { useClerk } from '@clerk/shared/react';
import type { SignUpModalProps, SignUpProps } from '@clerk/types';
import React from 'react';
import { useFetch } from 'ui/hooks';
import { preloadSessionTask, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignUpEmailLinkFlowComplete } from '../../common/EmailLinkCompleteFlowCard';
import { SignUpContext, useSignUpContext, withCoreSessionSwitchGuard } from '../../contexts';
import { Flow } from '../../customizables';
import { useFetch } from '../../hooks';
import { preloadSessionTask, SessionTask } from '../../lazyModules/components';
import { Route, Switch, useRouter, VIRTUAL_ROUTER_BASE_PATH } from '../../router';
import { SignUpContinue } from './SignUpContinue';
import { SignUpSSOCallback } from './SignUpSSOCallback';
import { SignUpStart } from './SignUpStart';
import { SignUpVerifyEmail } from './SignUpVerifyEmail';
import { SignUpVerifyPhone } from './SignUpVerifyPhone';

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

Expand All@@ -36,7 +39,7 @@ function SignUpRoutes(): JSX.Element {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <Flow.Root flow='signUp'>
Expand DownExpand Up@@ -91,7 +94,10 @@ function SignUpRoutes(): JSX.Element {
 </Route>
 {signUpContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand Down

6 changes: 0 additions & 6 deletions
packages/clerk-js/src/ui/lazyModules/components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@ const componentImportPaths = {
 UserVerification: () => import(/* webpackChunkName: "userverification" */ './../components/UserVerification'),
 Waitlist: () => import(/* webpackChunkName: "waitlist" */ './../components/Waitlist'),
 KeylessPrompt: () => import(/* webpackChunkName: "keylessPrompt" */ '../components/KeylessPrompt'),
 PricingTable: () => import(/* webpackChunkName: "pricingTable" */ '../components/PricingTable'),
 Checkout: () => import(/* webpackChunkName: "checkout" */ '../components/Checkout'),
 SessionTask: () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask'),
} as const;

Expand DownExpand Up@@ -91,10 +89,6 @@ export const KeylessPrompt = lazy(() =>
 componentImportPaths.KeylessPrompt().then(module => ({ default: module.KeylessPrompt })),
);

export const PricingTable = lazy(() =>
 componentImportPaths.PricingTable().then(module => ({ default: module.__experimental_PricingTable })),
);

export const preloadSessionTask = () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask');
export const SessionTask = lazy(() =>
 componentImportPaths.SessionTask().then(module => ({ default: module.SessionTask })),
Expand Down

1 change: 0 additions & 1 deletion
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,6 @@ type IsomorphicLoadedClerk = Without<
 | '__internal_addNavigationListener'
 | '__internal_getCachedResources'
 | '__internal_reloadInitialResources'
 | '__experimental_commerce'
 | '__internal_setComponentNavigationContext'
> & {
 client: ClientResource | undefined;
Expand Down

1 change: 0 additions & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -817,7 +817,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 * Clerk will rethrow network errors that occur while the user is offline.
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} 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
[wip] feat(clerk-js): Navigate on task resolution #5333

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

 Closed

LauraBeatris
wants to merge
14
commits into

from

 Closed


[wip] feat(clerk-js): Navigate on task resolution #5333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
8dc0aba

Update `setActive` to handle `pending` session status


LauraBeatris Mar 4, 2025
ae5b620

Handle internal component navigation


LauraBeatris Mar 4, 2025
82d70fd

Introduce test coverage


LauraBeatris Mar 5, 2025
0203bc0

Introduce experimental prop for lazy loading routes


LauraBeatris Mar 8, 2025
234f912

Send telemetry event


LauraBeatris Mar 8, 2025
b4f1d7e

Refactor internal routing to set on `BaseRouter`


LauraBeatris Mar 10, 2025
9f0f4d0

Refactor integration tests to use use long running apps


LauraBeatris Mar 11, 2025
674b8a3

Update bundlewatch limit for headless bundle


LauraBeatris Mar 11, 2025
e02429e

Remove unused `TokenUpdate` dispatch


LauraBeatris Mar 11, 2025
1731e49

Refactor internal routing logic


LauraBeatris Mar 11, 2025
afa6ed4

Remove unused `null` from type


LauraBeatris Mar 11, 2025
47d3077

Add comment to clarify temporary `experimental.withSessionTasks`


LauraBeatris Mar 11, 2025
39724c1

Forward after sign-in/sign-up URLs to `SessionTask` component context


LauraBeatris Mar 12, 2025
0c5cb8c

Handle navigation to next task upon `/touch`


LauraBeatris Mar 12, 2025

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


1 change: 0 additions & 1 deletion
.changeset/brave-pears-add.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
'@clerk/clerk-react': minor
---

Navigate to tasks on after sign-in/sign-up

8 changes: 4 additions & 4 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "572kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "78kB" },
 { "path": "./dist/clerk.js", "maxSize": "560kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "50KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "92KB" },
 { "path": "./dist/vendors*.js", "maxSize": "26.5KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "89.2KB" },
 { "path": "./dist/vendors*.js", "maxSize": "25.1KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

10 changes: 8 additions & 2 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 PendingSessionResource,
 PublicKeyCredentialCreationOptionsWithoutExtensions,
 PublicKeyCredentialRequestOptionsWithoutExtensions,
 PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand DownExpand Up@@ -1009,6 +1010,11 @@ export class Clerk implements ClerkInterface {
 newSession = this.#getSessionFromClient(newSession?.id);
 }

 if (newSession?.status === 'pending') {
 await this.#handlePendingSession(newSession);
 return;
 }

 // getToken syncs __session and __client_uat to cookies using events.TokenUpdate dispatched event.
 const token = await newSession?.getToken();
 if (!token) {
Expand DownExpand Up@@ -1058,7 +1064,7 @@ export class Clerk implements ClerkInterface {
 await onAfterSetActive();
 };

 #handlePendingSession = async (session: SignedInSessionResource) => {
 #handlePendingSession = async (session: PendingSessionResource) => {
 if (!this.environment) {
 return;
 }
Expand All@@ -1067,7 +1073,7 @@ export class Clerk implements ClerkInterface {
 // to `pending`
 if (inActiveBrowserTab() || !this.#options.standardBrowser) {
 await this.#touchCurrentSession(session);
 session = this.#getSessionFromClient(session.id) ?? session;
 session = (this.#getSessionFromClient(session.id) ?? session) as PendingSessionResource;
 }

 // Syncs __session and __client_uat, in case the `pending` session
Expand Down

8 changes: 2 additions & 6 deletions
packages/clerk-js/src/ui/common/withRedirect.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signInCtx.sessionTaskUrl || signInCtx.afterSignInUrl || clerk.buildAfterSignInUrl(),
 signInCtx.sessionTaskUrl
 ? warnings.cannotRenderSignInComponentWhenTaskExists
 : warnings.cannotRenderSignInComponentWhenSessionExists,
 warnings.cannotRenderSignInComponentWhenSessionExists,
 )(props);
 };

Expand All@@ -83,9 +81,7 @@ export const withRedirectToAfterSignUp = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signUpCtx.sessionTaskUrl || signUpCtx.afterSignUpUrl || clerk.buildAfterSignUpUrl(),
 signUpCtx.sessionTaskUrl
 ? warnings.cannotRenderSignUpComponentWhenTaskExists
 : warnings.cannotRenderSignUpComponentWhenSessionExists,
 warnings.cannotRenderSignUpComponentWhenSessionExists,
 )(props);
 };

Expand Down

25 changes: 20 additions & 5 deletions
packages/clerk-js/src/ui/components/SessionTask/SessionTask.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,25 @@ import type { SessionTask } from '@clerk/types';
import { OrganizationListContext } from '../../contexts';
import { OrganizationList } from '../OrganizationList';

const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
 org: () => (
interface SessionTaskProps {
 task: SessionTask['key'];
 redirectUrlComplete: string;
}

const ContentRegistry: Record<
 SessionTask['key'],
 React.ComponentType<Pick<SessionTaskProps, 'redirectUrlComplete'>>
> = {
 org: ({ redirectUrlComplete }) => (
 // TODO - Hide personal workspace within organization list context based on environment
 <OrganizationListContext.Provider value={{ componentName: 'OrganizationList', hidePersonal: true }}>
 <OrganizationListContext.Provider
 value={{
 componentName: 'OrganizationList',
 hidePersonal: true,
 afterSelectOrganizationUrl: redirectUrlComplete,
 afterCreateOrganizationUrl: redirectUrlComplete,
 }}
 >
 <OrganizationList />
 </OrganizationListContext.Provider>
 ),
Expand All@@ -17,12 +32,12 @@ const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
/**
 * @internal
 */
export function SessionTask({ task}: { task: SessionTask['key'] }): React.ReactNode {
export function SessionTask({ task, redirectUrlComplete }: SessionTaskProps): React.ReactNode {
 const clerk = useClerk();

 clerk.telemetry?.record(eventComponentMounted('SessionTask', { task }));

 const Content = ContentRegistry[task];

 return <Content />;
 return <Content redirectUrlComplete={redirectUrlComplete} />;
}

15 changes: 12 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useClerk } from '@clerk/shared/react';
import type { SignInModalProps, SignInProps } from '@clerk/types';
import React from 'react';
import { preloadComponent, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { normalizeRoutingOptions } from '../../../utils/normalizeRoutingOptions';
Expand All@@ -10,6 +11,8 @@ import {
 SignInContext,
 SignUpContext,
 useSignInContext,
 useSignInContext,
 useSignInContext,
 useSignUpContext,
 withCoreSessionSwitchGuard,
} from '../../contexts';
Expand DownExpand Up@@ -132,7 +135,10 @@ function SignInRoutes(): JSX.Element {
 </Route>
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand All@@ -146,7 +152,10 @@ function SignInRoutes(): JSX.Element {
 )}
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignInUrl}
 />
 </Route>
 )}
 <Route index>
Expand DownExpand Up@@ -192,7 +201,7 @@ function SignInRoot() {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <SignUpContext.Provider value={normalizedSignUpContext}>
Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
import { useClerk } from '@clerk/shared/react';
import type { SignUpModalProps, SignUpProps } from '@clerk/types';
import React from 'react';
import { useFetch } from 'ui/hooks';
import { preloadSessionTask, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignUpEmailLinkFlowComplete } from '../../common/EmailLinkCompleteFlowCard';
import { SignUpContext, useSignUpContext, withCoreSessionSwitchGuard } from '../../contexts';
import { Flow } from '../../customizables';
import { useFetch } from '../../hooks';
import { preloadSessionTask, SessionTask } from '../../lazyModules/components';
import { Route, Switch, useRouter, VIRTUAL_ROUTER_BASE_PATH } from '../../router';
import { SignUpContinue } from './SignUpContinue';
import { SignUpSSOCallback } from './SignUpSSOCallback';
import { SignUpStart } from './SignUpStart';
import { SignUpVerifyEmail } from './SignUpVerifyEmail';
import { SignUpVerifyPhone } from './SignUpVerifyPhone';

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

Expand All@@ -36,7 +39,7 @@ function SignUpRoutes(): JSX.Element {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <Flow.Root flow='signUp'>
Expand DownExpand Up@@ -91,7 +94,10 @@ function SignUpRoutes(): JSX.Element {
 </Route>
 {signUpContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand Down

6 changes: 0 additions & 6 deletions
packages/clerk-js/src/ui/lazyModules/components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@ const componentImportPaths = {
 UserVerification: () => import(/* webpackChunkName: "userverification" */ './../components/UserVerification'),
 Waitlist: () => import(/* webpackChunkName: "waitlist" */ './../components/Waitlist'),
 KeylessPrompt: () => import(/* webpackChunkName: "keylessPrompt" */ '../components/KeylessPrompt'),
 PricingTable: () => import(/* webpackChunkName: "pricingTable" */ '../components/PricingTable'),
 Checkout: () => import(/* webpackChunkName: "checkout" */ '../components/Checkout'),
 SessionTask: () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask'),
} as const;

Expand DownExpand Up@@ -91,10 +89,6 @@ export const KeylessPrompt = lazy(() =>
 componentImportPaths.KeylessPrompt().then(module => ({ default: module.KeylessPrompt })),
);

export const PricingTable = lazy(() =>
 componentImportPaths.PricingTable().then(module => ({ default: module.__experimental_PricingTable })),
);

export const preloadSessionTask = () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask');
export const SessionTask = lazy(() =>
 componentImportPaths.SessionTask().then(module => ({ default: module.SessionTask })),
Expand Down

1 change: 0 additions & 1 deletion
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,6 @@ type IsomorphicLoadedClerk = Without<
 | '__internal_addNavigationListener'
 | '__internal_getCachedResources'
 | '__internal_reloadInitialResources'
 | '__experimental_commerce'
 | '__internal_setComponentNavigationContext'
> & {
 client: ClientResource | undefined;
Expand Down

1 change: 0 additions & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -817,7 +817,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 * Clerk will rethrow network errors that occur while the user is offline.
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[wip] feat(clerk-js): Navigate on task resolution #5333

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

 Closed

LauraBeatris
wants to merge
14
commits into

from

 Closed


[wip] feat(clerk-js): Navigate on task resolution #5333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
8dc0aba

Update `setActive` to handle `pending` session status


LauraBeatris Mar 4, 2025
ae5b620

Handle internal component navigation


LauraBeatris Mar 4, 2025
82d70fd

Introduce test coverage


LauraBeatris Mar 5, 2025
0203bc0

Introduce experimental prop for lazy loading routes


LauraBeatris Mar 8, 2025
234f912

Send telemetry event


LauraBeatris Mar 8, 2025
b4f1d7e

Refactor internal routing to set on `BaseRouter`


LauraBeatris Mar 10, 2025
9f0f4d0

Refactor integration tests to use use long running apps


LauraBeatris Mar 11, 2025
674b8a3

Update bundlewatch limit for headless bundle


LauraBeatris Mar 11, 2025
e02429e

Remove unused `TokenUpdate` dispatch


LauraBeatris Mar 11, 2025
1731e49

Refactor internal routing logic


LauraBeatris Mar 11, 2025
afa6ed4

Remove unused `null` from type


LauraBeatris Mar 11, 2025
47d3077

Add comment to clarify temporary `experimental.withSessionTasks`


LauraBeatris Mar 11, 2025
39724c1

Forward after sign-in/sign-up URLs to `SessionTask` component context


LauraBeatris Mar 12, 2025
0c5cb8c

Handle navigation to next task upon `/touch`


LauraBeatris Mar 12, 2025

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


1 change: 0 additions & 1 deletion
.changeset/brave-pears-add.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
'@clerk/clerk-react': minor
---

Navigate to tasks on after sign-in/sign-up

8 changes: 4 additions & 4 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "572kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "78kB" },
 { "path": "./dist/clerk.js", "maxSize": "560kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "50KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "92KB" },
 { "path": "./dist/vendors*.js", "maxSize": "26.5KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "89.2KB" },
 { "path": "./dist/vendors*.js", "maxSize": "25.1KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

10 changes: 8 additions & 2 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 PendingSessionResource,
 PublicKeyCredentialCreationOptionsWithoutExtensions,
 PublicKeyCredentialRequestOptionsWithoutExtensions,
 PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand DownExpand Up@@ -1009,6 +1010,11 @@ export class Clerk implements ClerkInterface {
 newSession = this.#getSessionFromClient(newSession?.id);
 }

 if (newSession?.status === 'pending') {
 await this.#handlePendingSession(newSession);
 return;
 }

 // getToken syncs __session and __client_uat to cookies using events.TokenUpdate dispatched event.
 const token = await newSession?.getToken();
 if (!token) {
Expand DownExpand Up@@ -1058,7 +1064,7 @@ export class Clerk implements ClerkInterface {
 await onAfterSetActive();
 };

 #handlePendingSession = async (session: SignedInSessionResource) => {
 #handlePendingSession = async (session: PendingSessionResource) => {
 if (!this.environment) {
 return;
 }
Expand All@@ -1067,7 +1073,7 @@ export class Clerk implements ClerkInterface {
 // to `pending`
 if (inActiveBrowserTab() || !this.#options.standardBrowser) {
 await this.#touchCurrentSession(session);
 session = this.#getSessionFromClient(session.id) ?? session;
 session = (this.#getSessionFromClient(session.id) ?? session) as PendingSessionResource;
 }

 // Syncs __session and __client_uat, in case the `pending` session
Expand Down

8 changes: 2 additions & 6 deletions
packages/clerk-js/src/ui/common/withRedirect.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signInCtx.sessionTaskUrl || signInCtx.afterSignInUrl || clerk.buildAfterSignInUrl(),
 signInCtx.sessionTaskUrl
 ? warnings.cannotRenderSignInComponentWhenTaskExists
 : warnings.cannotRenderSignInComponentWhenSessionExists,
 warnings.cannotRenderSignInComponentWhenSessionExists,
 )(props);
 };

Expand All@@ -83,9 +81,7 @@ export const withRedirectToAfterSignUp = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signUpCtx.sessionTaskUrl || signUpCtx.afterSignUpUrl || clerk.buildAfterSignUpUrl(),
 signUpCtx.sessionTaskUrl
 ? warnings.cannotRenderSignUpComponentWhenTaskExists
 : warnings.cannotRenderSignUpComponentWhenSessionExists,
 warnings.cannotRenderSignUpComponentWhenSessionExists,
 )(props);
 };

Expand Down

25 changes: 20 additions & 5 deletions
packages/clerk-js/src/ui/components/SessionTask/SessionTask.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,25 @@ import type { SessionTask } from '@clerk/types';
import { OrganizationListContext } from '../../contexts';
import { OrganizationList } from '../OrganizationList';

const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
 org: () => (
interface SessionTaskProps {
 task: SessionTask['key'];
 redirectUrlComplete: string;
}

const ContentRegistry: Record<
 SessionTask['key'],
 React.ComponentType<Pick<SessionTaskProps, 'redirectUrlComplete'>>
> = {
 org: ({ redirectUrlComplete }) => (
 // TODO - Hide personal workspace within organization list context based on environment
 <OrganizationListContext.Provider value={{ componentName: 'OrganizationList', hidePersonal: true }}>
 <OrganizationListContext.Provider
 value={{
 componentName: 'OrganizationList',
 hidePersonal: true,
 afterSelectOrganizationUrl: redirectUrlComplete,
 afterCreateOrganizationUrl: redirectUrlComplete,
 }}
 >
 <OrganizationList />
 </OrganizationListContext.Provider>
 ),
Expand All@@ -17,12 +32,12 @@ const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
/**
 * @internal
 */
export function SessionTask({ task}: { task: SessionTask['key'] }): React.ReactNode {
export function SessionTask({ task, redirectUrlComplete }: SessionTaskProps): React.ReactNode {
 const clerk = useClerk();

 clerk.telemetry?.record(eventComponentMounted('SessionTask', { task }));

 const Content = ContentRegistry[task];

 return <Content />;
 return <Content redirectUrlComplete={redirectUrlComplete} />;
}

15 changes: 12 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useClerk } from '@clerk/shared/react';
import type { SignInModalProps, SignInProps } from '@clerk/types';
import React from 'react';
import { preloadComponent, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { normalizeRoutingOptions } from '../../../utils/normalizeRoutingOptions';
Expand All@@ -10,6 +11,8 @@ import {
 SignInContext,
 SignUpContext,
 useSignInContext,
 useSignInContext,
 useSignInContext,
 useSignUpContext,
 withCoreSessionSwitchGuard,
} from '../../contexts';
Expand DownExpand Up@@ -132,7 +135,10 @@ function SignInRoutes(): JSX.Element {
 </Route>
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand All@@ -146,7 +152,10 @@ function SignInRoutes(): JSX.Element {
 )}
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignInUrl}
 />
 </Route>
 )}
 <Route index>
Expand DownExpand Up@@ -192,7 +201,7 @@ function SignInRoot() {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <SignUpContext.Provider value={normalizedSignUpContext}>
Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
import { useClerk } from '@clerk/shared/react';
import type { SignUpModalProps, SignUpProps } from '@clerk/types';
import React from 'react';
import { useFetch } from 'ui/hooks';
import { preloadSessionTask, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignUpEmailLinkFlowComplete } from '../../common/EmailLinkCompleteFlowCard';
import { SignUpContext, useSignUpContext, withCoreSessionSwitchGuard } from '../../contexts';
import { Flow } from '../../customizables';
import { useFetch } from '../../hooks';
import { preloadSessionTask, SessionTask } from '../../lazyModules/components';
import { Route, Switch, useRouter, VIRTUAL_ROUTER_BASE_PATH } from '../../router';
import { SignUpContinue } from './SignUpContinue';
import { SignUpSSOCallback } from './SignUpSSOCallback';
import { SignUpStart } from './SignUpStart';
import { SignUpVerifyEmail } from './SignUpVerifyEmail';
import { SignUpVerifyPhone } from './SignUpVerifyPhone';

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

Expand All@@ -36,7 +39,7 @@ function SignUpRoutes(): JSX.Element {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <Flow.Root flow='signUp'>
Expand DownExpand Up@@ -91,7 +94,10 @@ function SignUpRoutes(): JSX.Element {
 </Route>
 {signUpContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand Down

6 changes: 0 additions & 6 deletions
packages/clerk-js/src/ui/lazyModules/components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@ const componentImportPaths = {
 UserVerification: () => import(/* webpackChunkName: "userverification" */ './../components/UserVerification'),
 Waitlist: () => import(/* webpackChunkName: "waitlist" */ './../components/Waitlist'),
 KeylessPrompt: () => import(/* webpackChunkName: "keylessPrompt" */ '../components/KeylessPrompt'),
 PricingTable: () => import(/* webpackChunkName: "pricingTable" */ '../components/PricingTable'),
 Checkout: () => import(/* webpackChunkName: "checkout" */ '../components/Checkout'),
 SessionTask: () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask'),
} as const;

Expand DownExpand Up@@ -91,10 +89,6 @@ export const KeylessPrompt = lazy(() =>
 componentImportPaths.KeylessPrompt().then(module => ({ default: module.KeylessPrompt })),
);

export const PricingTable = lazy(() =>
 componentImportPaths.PricingTable().then(module => ({ default: module.__experimental_PricingTable })),
);

export const preloadSessionTask = () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask');
export const SessionTask = lazy(() =>
 componentImportPaths.SessionTask().then(module => ({ default: module.SessionTask })),
Expand Down

1 change: 0 additions & 1 deletion
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,6 @@ type IsomorphicLoadedClerk = Without<
 | '__internal_addNavigationListener'
 | '__internal_getCachedResources'
 | '__internal_reloadInitialResources'
 | '__experimental_commerce'
 | '__internal_setComponentNavigationContext'
> & {
 client: ClientResource | undefined;
Expand Down

1 change: 0 additions & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -817,7 +817,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 * Clerk will rethrow network errors that occur while the user is offline.
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[wip] feat(clerk-js): Navigate on task resolution #5333

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

 Closed

LauraBeatris
wants to merge
14
commits into

from

 Closed


[wip] feat(clerk-js): Navigate on task resolution #5333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
8dc0aba

Update `setActive` to handle `pending` session status


LauraBeatris Mar 4, 2025
ae5b620

Handle internal component navigation


LauraBeatris Mar 4, 2025
82d70fd

Introduce test coverage


LauraBeatris Mar 5, 2025
0203bc0

Introduce experimental prop for lazy loading routes


LauraBeatris Mar 8, 2025
234f912

Send telemetry event


LauraBeatris Mar 8, 2025
b4f1d7e

Refactor internal routing to set on `BaseRouter`


LauraBeatris Mar 10, 2025
9f0f4d0

Refactor integration tests to use use long running apps


LauraBeatris Mar 11, 2025
674b8a3

Update bundlewatch limit for headless bundle


LauraBeatris Mar 11, 2025
e02429e

Remove unused `TokenUpdate` dispatch


LauraBeatris Mar 11, 2025
1731e49

Refactor internal routing logic


LauraBeatris Mar 11, 2025
afa6ed4

Remove unused `null` from type


LauraBeatris Mar 11, 2025
47d3077

Add comment to clarify temporary `experimental.withSessionTasks`


LauraBeatris Mar 11, 2025
39724c1

Forward after sign-in/sign-up URLs to `SessionTask` component context


LauraBeatris Mar 12, 2025
0c5cb8c

Handle navigation to next task upon `/touch`


LauraBeatris Mar 12, 2025

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


1 change: 0 additions & 1 deletion
.changeset/brave-pears-add.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
'@clerk/clerk-react': minor
---

Navigate to tasks on after sign-in/sign-up

8 changes: 4 additions & 4 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "572kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "78kB" },
 { "path": "./dist/clerk.js", "maxSize": "560kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "50KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "92KB" },
 { "path": "./dist/vendors*.js", "maxSize": "26.5KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "89.2KB" },
 { "path": "./dist/vendors*.js", "maxSize": "25.1KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

10 changes: 8 additions & 2 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 PendingSessionResource,
 PublicKeyCredentialCreationOptionsWithoutExtensions,
 PublicKeyCredentialRequestOptionsWithoutExtensions,
 PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand DownExpand Up@@ -1009,6 +1010,11 @@ export class Clerk implements ClerkInterface {
 newSession = this.#getSessionFromClient(newSession?.id);
 }

 if (newSession?.status === 'pending') {
 await this.#handlePendingSession(newSession);
 return;
 }

 // getToken syncs __session and __client_uat to cookies using events.TokenUpdate dispatched event.
 const token = await newSession?.getToken();
 if (!token) {
Expand DownExpand Up@@ -1058,7 +1064,7 @@ export class Clerk implements ClerkInterface {
 await onAfterSetActive();
 };

 #handlePendingSession = async (session: SignedInSessionResource) => {
 #handlePendingSession = async (session: PendingSessionResource) => {
 if (!this.environment) {
 return;
 }
Expand All@@ -1067,7 +1073,7 @@ export class Clerk implements ClerkInterface {
 // to `pending`
 if (inActiveBrowserTab() || !this.#options.standardBrowser) {
 await this.#touchCurrentSession(session);
 session = this.#getSessionFromClient(session.id) ?? session;
 session = (this.#getSessionFromClient(session.id) ?? session) as PendingSessionResource;
 }

 // Syncs __session and __client_uat, in case the `pending` session
Expand Down

8 changes: 2 additions & 6 deletions
packages/clerk-js/src/ui/common/withRedirect.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signInCtx.sessionTaskUrl || signInCtx.afterSignInUrl || clerk.buildAfterSignInUrl(),
 signInCtx.sessionTaskUrl
 ? warnings.cannotRenderSignInComponentWhenTaskExists
 : warnings.cannotRenderSignInComponentWhenSessionExists,
 warnings.cannotRenderSignInComponentWhenSessionExists,
 )(props);
 };

Expand All@@ -83,9 +81,7 @@ export const withRedirectToAfterSignUp = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signUpCtx.sessionTaskUrl || signUpCtx.afterSignUpUrl || clerk.buildAfterSignUpUrl(),
 signUpCtx.sessionTaskUrl
 ? warnings.cannotRenderSignUpComponentWhenTaskExists
 : warnings.cannotRenderSignUpComponentWhenSessionExists,
 warnings.cannotRenderSignUpComponentWhenSessionExists,
 )(props);
 };

Expand Down

25 changes: 20 additions & 5 deletions
packages/clerk-js/src/ui/components/SessionTask/SessionTask.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,25 @@ import type { SessionTask } from '@clerk/types';
import { OrganizationListContext } from '../../contexts';
import { OrganizationList } from '../OrganizationList';

const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
 org: () => (
interface SessionTaskProps {
 task: SessionTask['key'];
 redirectUrlComplete: string;
}

const ContentRegistry: Record<
 SessionTask['key'],
 React.ComponentType<Pick<SessionTaskProps, 'redirectUrlComplete'>>
> = {
 org: ({ redirectUrlComplete }) => (
 // TODO - Hide personal workspace within organization list context based on environment
 <OrganizationListContext.Provider value={{ componentName: 'OrganizationList', hidePersonal: true }}>
 <OrganizationListContext.Provider
 value={{
 componentName: 'OrganizationList',
 hidePersonal: true,
 afterSelectOrganizationUrl: redirectUrlComplete,
 afterCreateOrganizationUrl: redirectUrlComplete,
 }}
 >
 <OrganizationList />
 </OrganizationListContext.Provider>
 ),
Expand All@@ -17,12 +32,12 @@ const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
/**
 * @internal
 */
export function SessionTask({ task}: { task: SessionTask['key'] }): React.ReactNode {
export function SessionTask({ task, redirectUrlComplete }: SessionTaskProps): React.ReactNode {
 const clerk = useClerk();

 clerk.telemetry?.record(eventComponentMounted('SessionTask', { task }));

 const Content = ContentRegistry[task];

 return <Content />;
 return <Content redirectUrlComplete={redirectUrlComplete} />;
}

15 changes: 12 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useClerk } from '@clerk/shared/react';
import type { SignInModalProps, SignInProps } from '@clerk/types';
import React from 'react';
import { preloadComponent, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { normalizeRoutingOptions } from '../../../utils/normalizeRoutingOptions';
Expand All@@ -10,6 +11,8 @@ import {
 SignInContext,
 SignUpContext,
 useSignInContext,
 useSignInContext,
 useSignInContext,
 useSignUpContext,
 withCoreSessionSwitchGuard,
} from '../../contexts';
Expand DownExpand Up@@ -132,7 +135,10 @@ function SignInRoutes(): JSX.Element {
 </Route>
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand All@@ -146,7 +152,10 @@ function SignInRoutes(): JSX.Element {
 )}
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignInUrl}
 />
 </Route>
 )}
 <Route index>
Expand DownExpand Up@@ -192,7 +201,7 @@ function SignInRoot() {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <SignUpContext.Provider value={normalizedSignUpContext}>
Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
import { useClerk } from '@clerk/shared/react';
import type { SignUpModalProps, SignUpProps } from '@clerk/types';
import React from 'react';
import { useFetch } from 'ui/hooks';
import { preloadSessionTask, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignUpEmailLinkFlowComplete } from '../../common/EmailLinkCompleteFlowCard';
import { SignUpContext, useSignUpContext, withCoreSessionSwitchGuard } from '../../contexts';
import { Flow } from '../../customizables';
import { useFetch } from '../../hooks';
import { preloadSessionTask, SessionTask } from '../../lazyModules/components';
import { Route, Switch, useRouter, VIRTUAL_ROUTER_BASE_PATH } from '../../router';
import { SignUpContinue } from './SignUpContinue';
import { SignUpSSOCallback } from './SignUpSSOCallback';
import { SignUpStart } from './SignUpStart';
import { SignUpVerifyEmail } from './SignUpVerifyEmail';
import { SignUpVerifyPhone } from './SignUpVerifyPhone';

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

Expand All@@ -36,7 +39,7 @@ function SignUpRoutes(): JSX.Element {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <Flow.Root flow='signUp'>
Expand DownExpand Up@@ -91,7 +94,10 @@ function SignUpRoutes(): JSX.Element {
 </Route>
 {signUpContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand Down

6 changes: 0 additions & 6 deletions
packages/clerk-js/src/ui/lazyModules/components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@ const componentImportPaths = {
 UserVerification: () => import(/* webpackChunkName: "userverification" */ './../components/UserVerification'),
 Waitlist: () => import(/* webpackChunkName: "waitlist" */ './../components/Waitlist'),
 KeylessPrompt: () => import(/* webpackChunkName: "keylessPrompt" */ '../components/KeylessPrompt'),
 PricingTable: () => import(/* webpackChunkName: "pricingTable" */ '../components/PricingTable'),
 Checkout: () => import(/* webpackChunkName: "checkout" */ '../components/Checkout'),
 SessionTask: () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask'),
} as const;

Expand DownExpand Up@@ -91,10 +89,6 @@ export const KeylessPrompt = lazy(() =>
 componentImportPaths.KeylessPrompt().then(module => ({ default: module.KeylessPrompt })),
);

export const PricingTable = lazy(() =>
 componentImportPaths.PricingTable().then(module => ({ default: module.__experimental_PricingTable })),
);

export const preloadSessionTask = () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask');
export const SessionTask = lazy(() =>
 componentImportPaths.SessionTask().then(module => ({ default: module.SessionTask })),
Expand Down

1 change: 0 additions & 1 deletion
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,6 @@ type IsomorphicLoadedClerk = Without<
 | '__internal_addNavigationListener'
 | '__internal_getCachedResources'
 | '__internal_reloadInitialResources'
 | '__experimental_commerce'
 | '__internal_setComponentNavigationContext'
> & {
 client: ClientResource | undefined;
Expand Down

1 change: 0 additions & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -817,7 +817,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 * Clerk will rethrow network errors that occur while the user is offline.
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[wip] feat(clerk-js): Navigate on task resolution #5333

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

 Closed

LauraBeatris
wants to merge
14
commits into

from

 Closed


[wip] feat(clerk-js): Navigate on task resolution #5333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


14 commits


Select commit
Hold shift + click to select a range
8dc0aba

Update `setActive` to handle `pending` session status


LauraBeatris Mar 4, 2025
ae5b620

Handle internal component navigation


LauraBeatris Mar 4, 2025
82d70fd

Introduce test coverage


LauraBeatris Mar 5, 2025
0203bc0

Introduce experimental prop for lazy loading routes


LauraBeatris Mar 8, 2025
234f912

Send telemetry event


LauraBeatris Mar 8, 2025
b4f1d7e

Refactor internal routing to set on `BaseRouter`


LauraBeatris Mar 10, 2025
9f0f4d0

Refactor integration tests to use use long running apps


LauraBeatris Mar 11, 2025
674b8a3

Update bundlewatch limit for headless bundle


LauraBeatris Mar 11, 2025
e02429e

Remove unused `TokenUpdate` dispatch


LauraBeatris Mar 11, 2025
1731e49

Refactor internal routing logic


LauraBeatris Mar 11, 2025
afa6ed4

Remove unused `null` from type


LauraBeatris Mar 11, 2025
47d3077

Add comment to clarify temporary `experimental.withSessionTasks`


LauraBeatris Mar 11, 2025
39724c1

Forward after sign-in/sign-up URLs to `SessionTask` component context


LauraBeatris Mar 12, 2025
0c5cb8c

Handle navigation to next task upon `/touch`


LauraBeatris Mar 12, 2025

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


1 change: 0 additions & 1 deletion
.changeset/brave-pears-add.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
'@clerk/clerk-react': minor
---

Navigate to tasks on after sign-in/sign-up

8 changes: 4 additions & 4 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "572kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "78kB" },
 { "path": "./dist/clerk.js", "maxSize": "560kB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "75kB" },
 { "path": "./dist/clerk.headless.js", "maxSize": "50KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "92KB" },
 { "path": "./dist/vendors*.js", "maxSize": "26.5KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "89.2KB" },
 { "path": "./dist/vendors*.js", "maxSize": "25.1KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "35.5KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
 { "path": "./dist/impersonationfab*.js", "maxSize": "5KB" },
Expand Down

10 changes: 8 additions & 2 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
 OrganizationProfileProps,
 OrganizationResource,
 OrganizationSwitcherProps,
 PendingSessionResource,
 PublicKeyCredentialCreationOptionsWithoutExtensions,
 PublicKeyCredentialRequestOptionsWithoutExtensions,
 PublicKeyCredentialWithAuthenticatorAssertionResponse,
Expand DownExpand Up@@ -1009,6 +1010,11 @@ export class Clerk implements ClerkInterface {
 newSession = this.#getSessionFromClient(newSession?.id);
 }

 if (newSession?.status === 'pending') {
 await this.#handlePendingSession(newSession);
 return;
 }

 // getToken syncs __session and __client_uat to cookies using events.TokenUpdate dispatched event.
 const token = await newSession?.getToken();
 if (!token) {
Expand DownExpand Up@@ -1058,7 +1064,7 @@ export class Clerk implements ClerkInterface {
 await onAfterSetActive();
 };

 #handlePendingSession = async (session: SignedInSessionResource) => {
 #handlePendingSession = async (session: PendingSessionResource) => {
 if (!this.environment) {
 return;
 }
Expand All@@ -1067,7 +1073,7 @@ export class Clerk implements ClerkInterface {
 // to `pending`
 if (inActiveBrowserTab() || !this.#options.standardBrowser) {
 await this.#touchCurrentSession(session);
 session = this.#getSessionFromClient(session.id) ?? session;
 session = (this.#getSessionFromClient(session.id) ?? session) as PendingSessionResource;
 }

 // Syncs __session and __client_uat, in case the `pending` session
Expand Down

8 changes: 2 additions & 6 deletions
packages/clerk-js/src/ui/common/withRedirect.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,9 +62,7 @@ export const withRedirectToAfterSignIn = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signInCtx.sessionTaskUrl || signInCtx.afterSignInUrl || clerk.buildAfterSignInUrl(),
 signInCtx.sessionTaskUrl
 ? warnings.cannotRenderSignInComponentWhenTaskExists
 : warnings.cannotRenderSignInComponentWhenSessionExists,
 warnings.cannotRenderSignInComponentWhenSessionExists,
 )(props);
 };

Expand All@@ -83,9 +81,7 @@ export const withRedirectToAfterSignUp = <P extends AvailableComponentProps>(Com
 Component,
 sessionExistsAndSingleSessionModeEnabled,
 ({ clerk }) => signUpCtx.sessionTaskUrl || signUpCtx.afterSignUpUrl || clerk.buildAfterSignUpUrl(),
 signUpCtx.sessionTaskUrl
 ? warnings.cannotRenderSignUpComponentWhenTaskExists
 : warnings.cannotRenderSignUpComponentWhenSessionExists,
 warnings.cannotRenderSignUpComponentWhenSessionExists,
 )(props);
 };

Expand Down

25 changes: 20 additions & 5 deletions
packages/clerk-js/src/ui/components/SessionTask/SessionTask.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,10 +5,25 @@ import type { SessionTask } from '@clerk/types';
import { OrganizationListContext } from '../../contexts';
import { OrganizationList } from '../OrganizationList';

const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
 org: () => (
interface SessionTaskProps {
 task: SessionTask['key'];
 redirectUrlComplete: string;
}

const ContentRegistry: Record<
 SessionTask['key'],
 React.ComponentType<Pick<SessionTaskProps, 'redirectUrlComplete'>>
> = {
 org: ({ redirectUrlComplete }) => (
 // TODO - Hide personal workspace within organization list context based on environment
 <OrganizationListContext.Provider value={{ componentName: 'OrganizationList', hidePersonal: true }}>
 <OrganizationListContext.Provider
 value={{
 componentName: 'OrganizationList',
 hidePersonal: true,
 afterSelectOrganizationUrl: redirectUrlComplete,
 afterCreateOrganizationUrl: redirectUrlComplete,
 }}
 >
 <OrganizationList />
 </OrganizationListContext.Provider>
 ),
Expand All@@ -17,12 +32,12 @@ const ContentRegistry: Record<SessionTask['key'], React.ComponentType> = {
/**
 * @internal
 */
export function SessionTask({ task}: { task: SessionTask['key'] }): React.ReactNode {
export function SessionTask({ task, redirectUrlComplete }: SessionTaskProps): React.ReactNode {
 const clerk = useClerk();

 clerk.telemetry?.record(eventComponentMounted('SessionTask', { task }));

 const Content = ContentRegistry[task];

 return <Content />;
 return <Content redirectUrlComplete={redirectUrlComplete} />;
}

15 changes: 12 additions & 3 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import { useClerk } from '@clerk/shared/react';
import type { SignInModalProps, SignInProps } from '@clerk/types';
import React from 'react';
import { preloadComponent, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { normalizeRoutingOptions } from '../../../utils/normalizeRoutingOptions';
Expand All@@ -10,6 +11,8 @@ import {
 SignInContext,
 SignUpContext,
 useSignInContext,
 useSignInContext,
 useSignInContext,
 useSignUpContext,
 withCoreSessionSwitchGuard,
} from '../../contexts';
Expand DownExpand Up@@ -132,7 +135,10 @@ function SignInRoutes(): JSX.Element {
 </Route>
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand All@@ -146,7 +152,10 @@ function SignInRoutes(): JSX.Element {
 )}
 {signInContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignInUrl}
 />
 </Route>
 )}
 <Route index>
Expand DownExpand Up@@ -192,7 +201,7 @@ function SignInRoot() {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <SignUpContext.Provider value={normalizedSignUpContext}>
Expand Down

14 changes: 10 additions & 4 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
import { useClerk } from '@clerk/shared/react';
import type { SignUpModalProps, SignUpProps } from '@clerk/types';
import React from 'react';
import { useFetch } from 'ui/hooks';
import { preloadSessionTask, SessionTask } from 'ui/lazyModules/components';

import { SESSION_TASK_ROUTE_BY_KEY } from '../../../core/sessionTasks';
import { SignUpEmailLinkFlowComplete } from '../../common/EmailLinkCompleteFlowCard';
import { SignUpContext, useSignUpContext, withCoreSessionSwitchGuard } from '../../contexts';
import { Flow } from '../../customizables';
import { useFetch } from '../../hooks';
import { preloadSessionTask, SessionTask } from '../../lazyModules/components';
import { Route, Switch, useRouter, VIRTUAL_ROUTER_BASE_PATH } from '../../router';
import { SignUpContinue } from './SignUpContinue';
import { SignUpSSOCallback } from './SignUpSSOCallback';
import { SignUpStart } from './SignUpStart';
import { SignUpVerifyEmail } from './SignUpVerifyEmail';
import { SignUpVerifyPhone } from './SignUpVerifyPhone';

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

const usePreloadSessionTask = (enabled = false) =>
 useFetch(enabled ? preloadSessionTask : undefined, 'preloadComponent', { staleTime: Infinity });

Expand All@@ -36,7 +39,7 @@ function SignUpRoutes(): JSX.Element {

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
 }, [basePath, navigate]);
 }, []);

 return (
 <Flow.Root flow='signUp'>
Expand DownExpand Up@@ -91,7 +94,10 @@ function SignUpRoutes(): JSX.Element {
 </Route>
 {signUpContext.withSessionTasks && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 <SessionTask
 task='org'
 redirectUrlComplete={signUpContext.afterSignUpUrl}
 />
 </Route>
 )}
 <Route index>
Expand Down

6 changes: 0 additions & 6 deletions
packages/clerk-js/src/ui/lazyModules/components.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,8 +17,6 @@ const componentImportPaths = {
 UserVerification: () => import(/* webpackChunkName: "userverification" */ './../components/UserVerification'),
 Waitlist: () => import(/* webpackChunkName: "waitlist" */ './../components/Waitlist'),
 KeylessPrompt: () => import(/* webpackChunkName: "keylessPrompt" */ '../components/KeylessPrompt'),
 PricingTable: () => import(/* webpackChunkName: "pricingTable" */ '../components/PricingTable'),
 Checkout: () => import(/* webpackChunkName: "checkout" */ '../components/Checkout'),
 SessionTask: () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask'),
} as const;

Expand DownExpand Up@@ -91,10 +89,6 @@ export const KeylessPrompt = lazy(() =>
 componentImportPaths.KeylessPrompt().then(module => ({ default: module.KeylessPrompt })),
);

export const PricingTable = lazy(() =>
 componentImportPaths.PricingTable().then(module => ({ default: module.__experimental_PricingTable })),
);

export const preloadSessionTask = () => import(/* webpackChunkName: "sessionTask" */ '../components/SessionTask');
export const SessionTask = lazy(() =>
 componentImportPaths.SessionTask().then(module => ({ default: module.SessionTask })),
Expand Down

1 change: 0 additions & 1 deletion
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,7 +92,6 @@ type IsomorphicLoadedClerk = Without<
 | '__internal_addNavigationListener'
 | '__internal_getCachedResources'
 | '__internal_reloadInitialResources'
 | '__experimental_commerce'
 | '__internal_setComponentNavigationContext'
> & {
 client: ClientResource | undefined;
Expand Down

1 change: 0 additions & 1 deletion
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -817,7 +817,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 * Clerk will rethrow network errors that occur while the user is offline.
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
Expand Down