Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/good-jeans-call.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/elements": minor
"@clerk/nextjs": minor
"@clerk/shared": minor
---

Remove `@clerk/elements` reliance on `next` and `@clerk/clerk-react` directly. The host router is now provided by `@clerk/nextjs`.
8 changes: 3 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/elements/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,9 +94,7 @@
"typescript": "*"
},
"peerDependencies": {
"@clerk/clerk-react": "^5.0.0",
"@clerk/shared": "^2.0.0",
"next": "^13.5.4 || ^14.0.3 || ^15.0.0-rc",
Comment on lines -97 to -99

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

🔪

"react": "^18.0.0 || ^19.0.0-beta",
"react-dom": "^18.0.0 || ^19.0.0-beta"
},
Expand Down
15 changes: 11 additions & 4 deletions packages/elements/src/internals/constants/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { safeAccess } from '~/utils/safe-access';

export const SSO_CALLBACK_PATH_ROUTE = '/sso-callback';
export const CHOOSE_SESSION_PATH_ROUTE = '/choose';
export const MAGIC_LINK_VERIFY_PATH_ROUTE = '/verify';

export const SIGN_IN_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL ?? '/sign-in';
export const SIGN_UP_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL ?? '/sign-up';
// TODO: remove reliance on next-specific variables here
export const SIGN_IN_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL,
'/sign-in',
);
export const SIGN_UP_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL,
'/sign-up',
);
Comment on lines +7 to +15

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This realistically should be coming from the clerk provider / core clerk object instead of deriving it from environment variables. To maintain compat, I've just made this pull the env vars in a non-erroring way.


// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ export const clerkLoader = fromCallback<EventObject, Clerk | LoadedClerk>(({ sen
if (clerk.loaded) {
reportLoaded();
} else if ('addOnLoaded' in clerk) {
// @ts-expect-error - Expects `addOnLoaded` from @clerk/clerk-react's IsomorphicClerk.
// @ts-expect-error - Expects `addOnLoaded` from @clerk/shared/react's IsomorphicClerk.
clerk.addOnLoaded(reportLoaded);
} else {
sendBack({ type: 'ERROR', message: 'Clerk client could not be loaded' });
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
import { isTruthy } from '@clerk/shared/underscore';
import { createBrowserInspector } from '@statelyai/inspect';

import { safeAccess } from '~/utils/safe-access';

export const getInspector = () => {
if (
__DEV__ &&
typeof window !== 'undefined' &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
const { inspect } = createBrowserInspector({
autoStart: true,
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { isTruthy } from '@clerk/shared/underscore';

import { safeAccess } from '~/utils/safe-access';

import { createConsoleInspector } from './console';

export function getInspector() {
if (
__DEV__ &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG ?? process.env.CLERK_ELEMENTS_DEBUG)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
return createConsoleInspector({
enabled: true,
debugServer: isTruthy(process.env.CLERK_ELEMENTS_DEBUG_SERVER),
debugServer: isTruthy(safeAccess(() => process.env.CLERK_ELEMENTS_DEBUG_SERVER, false)),
});
}
return undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/form/input.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { logger } from '@clerk/shared/logger';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type {
Control as RadixControl,
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/loading.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import { useSelector } from '@xstate/react';
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/hooks/use-password.hook.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { noop } from '@clerk/shared';
import { useClerk } from '@clerk/shared/react';
import type { PasswordSettingsData, PasswordValidation } from '@clerk/types';
import * as React from 'react';

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import type React from 'react';
import { useCallback } from 'react';
Expand Down
1 change: 0 additions & 1 deletion packages/elements/src/react/router/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
export { useNextRouter } from './next';
export { Route, Router, useClerkRouter } from '@clerk/shared/router';
export { useVirtualRouter } from './virtual';
32 changes: 0 additions & 32 deletions packages/elements/src/react/router/next.ts

This file was deleted.

20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-in/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import React, { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
import { SignInRouterMachine } from '~/internals/machines/sign-in';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignInRouterCtx } from '~/react/sign-in/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignInRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -53,7 +53,14 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
if (actor.getSnapshot().can(evt)) {
actor.send(evt);
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}

// Ensure that the latest instantiated formRef is attached to the router
if (formRef && actor.getSnapshot().can({ type: 'RESET.STEP' })) {
Expand DownExpand Up@@ -123,8 +130,7 @@ export function SignInRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-up/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
import { SignUpRouterMachine } from '~/internals/machines/sign-up';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignUpRouterCtx } from '~/react/sign-up/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -61,7 +61,14 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
formRef,
});
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router, clerk.loaded]);

Expand DownExpand Up@@ -122,8 +129,7 @@ export function SignUpRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-up/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
7 changes: 7 additions & 0 deletions packages/elements/src/utils/safe-access.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export function safeAccess(fn: any, fallback: any) {
try {
return fn();
} catch (e) {
return fallback;
}
}
43 changes: 40 additions & 3 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
'use client';
import { ClerkProvider as ReactClerkProvider } from '@clerk/clerk-react';
import { useRouter } from 'next/navigation';
import type { ClerkHostRouter } from '@clerk/shared/router';
import { ClerkHostRouterContext } from '@clerk/shared/router';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import React, { useEffect, useTransition } from 'react';

import { useSafeLayoutEffect } from '../../client-boundary/hooks/useSafeLayoutEffect';
Expand All@@ -17,12 +19,48 @@ declare global {
__clerk_nav_await: Array<(value: void) => void>;
__clerk_nav: (to: string) => Promise<void>;
__clerk_internal_invalidateCachePromise: () => void | undefined;
next?: {
version: string;
};
}
}

// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
export const NEXT_WINDOW_HISTORY_SUPPORT_VERSION = '14.1.0';

/**
* Clerk router integration with Next.js's router.
*/
export const useNextRouter = (): ClerkHostRouter => {
const router = useRouter();
const pathname = usePathname();
// eslint-disable-next-line react-hooks/rules-of-hooks -- The order doesn't differ between renders as we're checking the execution environment.
const searchParams = typeof window === 'undefined' ? new URLSearchParams() : useSearchParams();

// The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
// preserve internal state between steps.
const canUseWindowHistoryAPIs =
typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;

return {
mode: 'path',
name: 'NextRouter',
push: (path: string) => router.push(path),
replace: (path: string) =>
canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
shallowPush(path: string) {
canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
},
pathname: () => pathname,
searchParams: () => searchParams,
};
};
Comment on lines +28 to +58

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I've shifted the useNextRouter() hook from elements into the Next SDK.


export const ClientClerkProvider = (props: NextClerkProviderProps) => {
const { __unstable_invokeMiddlewareOnAuthStateChange = true, children } = props;
const router = useRouter();
const clerkRouter = useNextRouter();
const push = useAwaitablePush();
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();
Expand DownExpand Up@@ -57,7 +95,6 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
return new Promise(res => {
window.__clerk_internal_invalidateCachePromise = res;
startTransition(() => {
//@ts-expect-error next exists on window
if (window.next?.version && typeof window.next.version === 'string' && window.next.version.startsWith('13')) {
router.refresh();
} else {
Expand All@@ -84,7 +121,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
<ClerkNextOptionsProvider options={mergedProps}>
<ReactClerkProvider {...mergedProps}>
<ClerkJSScript router='app' />
{children}
<ClerkHostRouterContext.Provider value={clerkRouter}>{children}</ClerkHostRouterContext.Provider>
</ReactClerkProvider>
</ClerkNextOptionsProvider>
);
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/good-jeans-call.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/elements": minor
"@clerk/nextjs": minor
"@clerk/shared": minor
---

Remove `@clerk/elements` reliance on `next` and `@clerk/clerk-react` directly. The host router is now provided by `@clerk/nextjs`.
8 changes: 3 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/elements/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,9 +94,7 @@
"typescript": "*"
},
"peerDependencies": {
"@clerk/clerk-react": "^5.0.0",
"@clerk/shared": "^2.0.0",
"next": "^13.5.4 || ^14.0.3 || ^15.0.0-rc",
Comment on lines -97 to -99

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

🔪

"react": "^18.0.0 || ^19.0.0-beta",
"react-dom": "^18.0.0 || ^19.0.0-beta"
},
Expand Down
15 changes: 11 additions & 4 deletions packages/elements/src/internals/constants/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { safeAccess } from '~/utils/safe-access';

export const SSO_CALLBACK_PATH_ROUTE = '/sso-callback';
export const CHOOSE_SESSION_PATH_ROUTE = '/choose';
export const MAGIC_LINK_VERIFY_PATH_ROUTE = '/verify';

export const SIGN_IN_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL ?? '/sign-in';
export const SIGN_UP_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL ?? '/sign-up';
// TODO: remove reliance on next-specific variables here
export const SIGN_IN_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL,
'/sign-in',
);
export const SIGN_UP_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL,
'/sign-up',
);
Comment on lines +7 to +15

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This realistically should be coming from the clerk provider / core clerk object instead of deriving it from environment variables. To maintain compat, I've just made this pull the env vars in a non-erroring way.


// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ export const clerkLoader = fromCallback<EventObject, Clerk | LoadedClerk>(({ sen
if (clerk.loaded) {
reportLoaded();
} else if ('addOnLoaded' in clerk) {
// @ts-expect-error - Expects `addOnLoaded` from @clerk/clerk-react's IsomorphicClerk.
// @ts-expect-error - Expects `addOnLoaded` from @clerk/shared/react's IsomorphicClerk.
clerk.addOnLoaded(reportLoaded);
} else {
sendBack({ type: 'ERROR', message: 'Clerk client could not be loaded' });
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
import { isTruthy } from '@clerk/shared/underscore';
import { createBrowserInspector } from '@statelyai/inspect';

import { safeAccess } from '~/utils/safe-access';

export const getInspector = () => {
if (
__DEV__ &&
typeof window !== 'undefined' &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
const { inspect } = createBrowserInspector({
autoStart: true,
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { isTruthy } from '@clerk/shared/underscore';

import { safeAccess } from '~/utils/safe-access';

import { createConsoleInspector } from './console';

export function getInspector() {
if (
__DEV__ &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG ?? process.env.CLERK_ELEMENTS_DEBUG)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
return createConsoleInspector({
enabled: true,
debugServer: isTruthy(process.env.CLERK_ELEMENTS_DEBUG_SERVER),
debugServer: isTruthy(safeAccess(() => process.env.CLERK_ELEMENTS_DEBUG_SERVER, false)),
});
}
return undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/form/input.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { logger } from '@clerk/shared/logger';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type {
Control as RadixControl,
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/loading.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import { useSelector } from '@xstate/react';
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/hooks/use-password.hook.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { noop } from '@clerk/shared';
import { useClerk } from '@clerk/shared/react';
import type { PasswordSettingsData, PasswordValidation } from '@clerk/types';
import * as React from 'react';

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import type React from 'react';
import { useCallback } from 'react';
Expand Down
1 change: 0 additions & 1 deletion packages/elements/src/react/router/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
export { useNextRouter } from './next';
export { Route, Router, useClerkRouter } from '@clerk/shared/router';
export { useVirtualRouter } from './virtual';
32 changes: 0 additions & 32 deletions packages/elements/src/react/router/next.ts

This file was deleted.

20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-in/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import React, { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
import { SignInRouterMachine } from '~/internals/machines/sign-in';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignInRouterCtx } from '~/react/sign-in/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignInRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -53,7 +53,14 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
if (actor.getSnapshot().can(evt)) {
actor.send(evt);
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}

// Ensure that the latest instantiated formRef is attached to the router
if (formRef && actor.getSnapshot().can({ type: 'RESET.STEP' })) {
Expand DownExpand Up@@ -123,8 +130,7 @@ export function SignInRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-up/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
import { SignUpRouterMachine } from '~/internals/machines/sign-up';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignUpRouterCtx } from '~/react/sign-up/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -61,7 +61,14 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
formRef,
});
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router, clerk.loaded]);

Expand DownExpand Up@@ -122,8 +129,7 @@ export function SignUpRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-up/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
7 changes: 7 additions & 0 deletions packages/elements/src/utils/safe-access.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export function safeAccess(fn: any, fallback: any) {
try {
return fn();
} catch (e) {
return fallback;
}
}
43 changes: 40 additions & 3 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
'use client';
import { ClerkProvider as ReactClerkProvider } from '@clerk/clerk-react';
import { useRouter } from 'next/navigation';
import type { ClerkHostRouter } from '@clerk/shared/router';
import { ClerkHostRouterContext } from '@clerk/shared/router';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import React, { useEffect, useTransition } from 'react';

import { useSafeLayoutEffect } from '../../client-boundary/hooks/useSafeLayoutEffect';
Expand All@@ -17,12 +19,48 @@ declare global {
__clerk_nav_await: Array<(value: void) => void>;
__clerk_nav: (to: string) => Promise<void>;
__clerk_internal_invalidateCachePromise: () => void | undefined;
next?: {
version: string;
};
}
}

// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
export const NEXT_WINDOW_HISTORY_SUPPORT_VERSION = '14.1.0';

/**
* Clerk router integration with Next.js's router.
*/
export const useNextRouter = (): ClerkHostRouter => {
const router = useRouter();
const pathname = usePathname();
// eslint-disable-next-line react-hooks/rules-of-hooks -- The order doesn't differ between renders as we're checking the execution environment.
const searchParams = typeof window === 'undefined' ? new URLSearchParams() : useSearchParams();

// The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
// preserve internal state between steps.
const canUseWindowHistoryAPIs =
typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;

return {
mode: 'path',
name: 'NextRouter',
push: (path: string) => router.push(path),
replace: (path: string) =>
canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
shallowPush(path: string) {
canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
},
pathname: () => pathname,
searchParams: () => searchParams,
};
};
Comment on lines +28 to +58

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I've shifted the useNextRouter() hook from elements into the Next SDK.


export const ClientClerkProvider = (props: NextClerkProviderProps) => {
const { __unstable_invokeMiddlewareOnAuthStateChange = true, children } = props;
const router = useRouter();
const clerkRouter = useNextRouter();
const push = useAwaitablePush();
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();
Expand DownExpand Up@@ -57,7 +95,6 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
return new Promise(res => {
window.__clerk_internal_invalidateCachePromise = res;
startTransition(() => {
//@ts-expect-error next exists on window
if (window.next?.version && typeof window.next.version === 'string' && window.next.version.startsWith('13')) {
router.refresh();
} else {
Expand All@@ -84,7 +121,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
<ClerkNextOptionsProvider options={mergedProps}>
<ReactClerkProvider {...mergedProps}>
<ClerkJSScript router='app' />
{children}
<ClerkHostRouterContext.Provider value={clerkRouter}>{children}</ClerkHostRouterContext.Provider>
</ReactClerkProvider>
</ClerkNextOptionsProvider>
);
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/good-jeans-call.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/elements": minor
"@clerk/nextjs": minor
"@clerk/shared": minor
---

Remove `@clerk/elements` reliance on `next` and `@clerk/clerk-react` directly. The host router is now provided by `@clerk/nextjs`.
8 changes: 3 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/elements/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,9 +94,7 @@
"typescript": "*"
},
"peerDependencies": {
"@clerk/clerk-react": "^5.0.0",
"@clerk/shared": "^2.0.0",
"next": "^13.5.4 || ^14.0.3 || ^15.0.0-rc",
Comment on lines -97 to -99

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

🔪

"react": "^18.0.0 || ^19.0.0-beta",
"react-dom": "^18.0.0 || ^19.0.0-beta"
},
Expand Down
15 changes: 11 additions & 4 deletions packages/elements/src/internals/constants/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { safeAccess } from '~/utils/safe-access';

export const SSO_CALLBACK_PATH_ROUTE = '/sso-callback';
export const CHOOSE_SESSION_PATH_ROUTE = '/choose';
export const MAGIC_LINK_VERIFY_PATH_ROUTE = '/verify';

export const SIGN_IN_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL ?? '/sign-in';
export const SIGN_UP_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL ?? '/sign-up';
// TODO: remove reliance on next-specific variables here
export const SIGN_IN_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL,
'/sign-in',
);
export const SIGN_UP_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL,
'/sign-up',
);
Comment on lines +7 to +15

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This realistically should be coming from the clerk provider / core clerk object instead of deriving it from environment variables. To maintain compat, I've just made this pull the env vars in a non-erroring way.


// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ export const clerkLoader = fromCallback<EventObject, Clerk | LoadedClerk>(({ sen
if (clerk.loaded) {
reportLoaded();
} else if ('addOnLoaded' in clerk) {
// @ts-expect-error - Expects `addOnLoaded` from @clerk/clerk-react's IsomorphicClerk.
// @ts-expect-error - Expects `addOnLoaded` from @clerk/shared/react's IsomorphicClerk.
clerk.addOnLoaded(reportLoaded);
} else {
sendBack({ type: 'ERROR', message: 'Clerk client could not be loaded' });
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
import { isTruthy } from '@clerk/shared/underscore';
import { createBrowserInspector } from '@statelyai/inspect';

import { safeAccess } from '~/utils/safe-access';

export const getInspector = () => {
if (
__DEV__ &&
typeof window !== 'undefined' &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
const { inspect } = createBrowserInspector({
autoStart: true,
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { isTruthy } from '@clerk/shared/underscore';

import { safeAccess } from '~/utils/safe-access';

import { createConsoleInspector } from './console';

export function getInspector() {
if (
__DEV__ &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG ?? process.env.CLERK_ELEMENTS_DEBUG)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
return createConsoleInspector({
enabled: true,
debugServer: isTruthy(process.env.CLERK_ELEMENTS_DEBUG_SERVER),
debugServer: isTruthy(safeAccess(() => process.env.CLERK_ELEMENTS_DEBUG_SERVER, false)),
});
}
return undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/form/input.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { logger } from '@clerk/shared/logger';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type {
Control as RadixControl,
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/loading.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import { useSelector } from '@xstate/react';
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/hooks/use-password.hook.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { noop } from '@clerk/shared';
import { useClerk } from '@clerk/shared/react';
import type { PasswordSettingsData, PasswordValidation } from '@clerk/types';
import * as React from 'react';

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import type React from 'react';
import { useCallback } from 'react';
Expand Down
1 change: 0 additions & 1 deletion packages/elements/src/react/router/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
export { useNextRouter } from './next';
export { Route, Router, useClerkRouter } from '@clerk/shared/router';
export { useVirtualRouter } from './virtual';
32 changes: 0 additions & 32 deletions packages/elements/src/react/router/next.ts

This file was deleted.

20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-in/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import React, { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
import { SignInRouterMachine } from '~/internals/machines/sign-in';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignInRouterCtx } from '~/react/sign-in/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignInRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -53,7 +53,14 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
if (actor.getSnapshot().can(evt)) {
actor.send(evt);
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}

// Ensure that the latest instantiated formRef is attached to the router
if (formRef && actor.getSnapshot().can({ type: 'RESET.STEP' })) {
Expand DownExpand Up@@ -123,8 +130,7 @@ export function SignInRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-up/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
import { SignUpRouterMachine } from '~/internals/machines/sign-up';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignUpRouterCtx } from '~/react/sign-up/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -61,7 +61,14 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
formRef,
});
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router, clerk.loaded]);

Expand DownExpand Up@@ -122,8 +129,7 @@ export function SignUpRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-up/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
7 changes: 7 additions & 0 deletions packages/elements/src/utils/safe-access.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export function safeAccess(fn: any, fallback: any) {
try {
return fn();
} catch (e) {
return fallback;
}
}
43 changes: 40 additions & 3 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
'use client';
import { ClerkProvider as ReactClerkProvider } from '@clerk/clerk-react';
import { useRouter } from 'next/navigation';
import type { ClerkHostRouter } from '@clerk/shared/router';
import { ClerkHostRouterContext } from '@clerk/shared/router';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import React, { useEffect, useTransition } from 'react';

import { useSafeLayoutEffect } from '../../client-boundary/hooks/useSafeLayoutEffect';
Expand All@@ -17,12 +19,48 @@ declare global {
__clerk_nav_await: Array<(value: void) => void>;
__clerk_nav: (to: string) => Promise<void>;
__clerk_internal_invalidateCachePromise: () => void | undefined;
next?: {
version: string;
};
}
}

// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
export const NEXT_WINDOW_HISTORY_SUPPORT_VERSION = '14.1.0';

/**
* Clerk router integration with Next.js's router.
*/
export const useNextRouter = (): ClerkHostRouter => {
const router = useRouter();
const pathname = usePathname();
// eslint-disable-next-line react-hooks/rules-of-hooks -- The order doesn't differ between renders as we're checking the execution environment.
const searchParams = typeof window === 'undefined' ? new URLSearchParams() : useSearchParams();

// The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
// preserve internal state between steps.
const canUseWindowHistoryAPIs =
typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;

return {
mode: 'path',
name: 'NextRouter',
push: (path: string) => router.push(path),
replace: (path: string) =>
canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
shallowPush(path: string) {
canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
},
pathname: () => pathname,
searchParams: () => searchParams,
};
};
Comment on lines +28 to +58

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I've shifted the useNextRouter() hook from elements into the Next SDK.


export const ClientClerkProvider = (props: NextClerkProviderProps) => {
const { __unstable_invokeMiddlewareOnAuthStateChange = true, children } = props;
const router = useRouter();
const clerkRouter = useNextRouter();
const push = useAwaitablePush();
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();
Expand DownExpand Up@@ -57,7 +95,6 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
return new Promise(res => {
window.__clerk_internal_invalidateCachePromise = res;
startTransition(() => {
//@ts-expect-error next exists on window
if (window.next?.version && typeof window.next.version === 'string' && window.next.version.startsWith('13')) {
router.refresh();
} else {
Expand All@@ -84,7 +121,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
<ClerkNextOptionsProvider options={mergedProps}>
<ReactClerkProvider {...mergedProps}>
<ClerkJSScript router='app' />
{children}
<ClerkHostRouterContext.Provider value={clerkRouter}>{children}</ClerkHostRouterContext.Provider>
</ReactClerkProvider>
</ClerkNextOptionsProvider>
);
Expand Down
Loading
, '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 \u003e 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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/good-jeans-call.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/elements": minor
"@clerk/nextjs": minor
"@clerk/shared": minor
---

Remove `@clerk/elements` reliance on `next` and `@clerk/clerk-react` directly. The host router is now provided by `@clerk/nextjs`.
8 changes: 3 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/elements/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,9 +94,7 @@
"typescript": "*"
},
"peerDependencies": {
"@clerk/clerk-react": "^5.0.0",
"@clerk/shared": "^2.0.0",
"next": "^13.5.4 || ^14.0.3 || ^15.0.0-rc",
Comment on lines -97 to -99

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

🔪

"react": "^18.0.0 || ^19.0.0-beta",
"react-dom": "^18.0.0 || ^19.0.0-beta"
},
Expand Down
15 changes: 11 additions & 4 deletions packages/elements/src/internals/constants/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { safeAccess } from '~/utils/safe-access';

export const SSO_CALLBACK_PATH_ROUTE = '/sso-callback';
export const CHOOSE_SESSION_PATH_ROUTE = '/choose';
export const MAGIC_LINK_VERIFY_PATH_ROUTE = '/verify';

export const SIGN_IN_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL ?? '/sign-in';
export const SIGN_UP_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL ?? '/sign-up';
// TODO: remove reliance on next-specific variables here
export const SIGN_IN_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL,
'/sign-in',
);
export const SIGN_UP_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL,
'/sign-up',
);
Comment on lines +7 to +15

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This realistically should be coming from the clerk provider / core clerk object instead of deriving it from environment variables. To maintain compat, I've just made this pull the env vars in a non-erroring way.


// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ export const clerkLoader = fromCallback<EventObject, Clerk | LoadedClerk>(({ sen
if (clerk.loaded) {
reportLoaded();
} else if ('addOnLoaded' in clerk) {
// @ts-expect-error - Expects `addOnLoaded` from @clerk/clerk-react's IsomorphicClerk.
// @ts-expect-error - Expects `addOnLoaded` from @clerk/shared/react's IsomorphicClerk.
clerk.addOnLoaded(reportLoaded);
} else {
sendBack({ type: 'ERROR', message: 'Clerk client could not be loaded' });
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
import { isTruthy } from '@clerk/shared/underscore';
import { createBrowserInspector } from '@statelyai/inspect';

import { safeAccess } from '~/utils/safe-access';

export const getInspector = () => {
if (
__DEV__ &&
typeof window !== 'undefined' &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
const { inspect } = createBrowserInspector({
autoStart: true,
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { isTruthy } from '@clerk/shared/underscore';

import { safeAccess } from '~/utils/safe-access';

import { createConsoleInspector } from './console';

export function getInspector() {
if (
__DEV__ &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG ?? process.env.CLERK_ELEMENTS_DEBUG)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
return createConsoleInspector({
enabled: true,
debugServer: isTruthy(process.env.CLERK_ELEMENTS_DEBUG_SERVER),
debugServer: isTruthy(safeAccess(() => process.env.CLERK_ELEMENTS_DEBUG_SERVER, false)),
});
}
return undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/form/input.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { logger } from '@clerk/shared/logger';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type {
Control as RadixControl,
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/loading.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import { useSelector } from '@xstate/react';
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/hooks/use-password.hook.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { noop } from '@clerk/shared';
import { useClerk } from '@clerk/shared/react';
import type { PasswordSettingsData, PasswordValidation } from '@clerk/types';
import * as React from 'react';

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import type React from 'react';
import { useCallback } from 'react';
Expand Down
1 change: 0 additions & 1 deletion packages/elements/src/react/router/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
export { useNextRouter } from './next';
export { Route, Router, useClerkRouter } from '@clerk/shared/router';
export { useVirtualRouter } from './virtual';
32 changes: 0 additions & 32 deletions packages/elements/src/react/router/next.ts

This file was deleted.

20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-in/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import React, { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
import { SignInRouterMachine } from '~/internals/machines/sign-in';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignInRouterCtx } from '~/react/sign-in/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignInRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -53,7 +53,14 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
if (actor.getSnapshot().can(evt)) {
actor.send(evt);
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}

// Ensure that the latest instantiated formRef is attached to the router
if (formRef && actor.getSnapshot().can({ type: 'RESET.STEP' })) {
Expand DownExpand Up@@ -123,8 +130,7 @@ export function SignInRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-up/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
import { SignUpRouterMachine } from '~/internals/machines/sign-up';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignUpRouterCtx } from '~/react/sign-up/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -61,7 +61,14 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
formRef,
});
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router, clerk.loaded]);

Expand DownExpand Up@@ -122,8 +129,7 @@ export function SignUpRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-up/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
7 changes: 7 additions & 0 deletions packages/elements/src/utils/safe-access.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export function safeAccess(fn: any, fallback: any) {
try {
return fn();
} catch (e) {
return fallback;
}
}
43 changes: 40 additions & 3 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
'use client';
import { ClerkProvider as ReactClerkProvider } from '@clerk/clerk-react';
import { useRouter } from 'next/navigation';
import type { ClerkHostRouter } from '@clerk/shared/router';
import { ClerkHostRouterContext } from '@clerk/shared/router';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import React, { useEffect, useTransition } from 'react';

import { useSafeLayoutEffect } from '../../client-boundary/hooks/useSafeLayoutEffect';
Expand All@@ -17,12 +19,48 @@ declare global {
__clerk_nav_await: Array<(value: void) => void>;
__clerk_nav: (to: string) => Promise<void>;
__clerk_internal_invalidateCachePromise: () => void | undefined;
next?: {
version: string;
};
}
}

// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
export const NEXT_WINDOW_HISTORY_SUPPORT_VERSION = '14.1.0';

/**
* Clerk router integration with Next.js's router.
*/
export const useNextRouter = (): ClerkHostRouter => {
const router = useRouter();
const pathname = usePathname();
// eslint-disable-next-line react-hooks/rules-of-hooks -- The order doesn't differ between renders as we're checking the execution environment.
const searchParams = typeof window === 'undefined' ? new URLSearchParams() : useSearchParams();

// The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
// preserve internal state between steps.
const canUseWindowHistoryAPIs =
typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;

return {
mode: 'path',
name: 'NextRouter',
push: (path: string) => router.push(path),
replace: (path: string) =>
canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
shallowPush(path: string) {
canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
},
pathname: () => pathname,
searchParams: () => searchParams,
};
};
Comment on lines +28 to +58

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I've shifted the useNextRouter() hook from elements into the Next SDK.


export const ClientClerkProvider = (props: NextClerkProviderProps) => {
const { __unstable_invokeMiddlewareOnAuthStateChange = true, children } = props;
const router = useRouter();
const clerkRouter = useNextRouter();
const push = useAwaitablePush();
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();
Expand DownExpand Up@@ -57,7 +95,6 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
return new Promise(res => {
window.__clerk_internal_invalidateCachePromise = res;
startTransition(() => {
//@ts-expect-error next exists on window
if (window.next?.version && typeof window.next.version === 'string' && window.next.version.startsWith('13')) {
router.refresh();
} else {
Expand All@@ -84,7 +121,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
<ClerkNextOptionsProvider options={mergedProps}>
<ReactClerkProvider {...mergedProps}>
<ClerkJSScript router='app' />
{children}
<ClerkHostRouterContext.Provider value={clerkRouter}>{children}</ClerkHostRouterContext.Provider>
</ReactClerkProvider>
</ClerkNextOptionsProvider>
);
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/good-jeans-call.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/elements": minor
"@clerk/nextjs": minor
"@clerk/shared": minor
---

Remove `@clerk/elements` reliance on `next` and `@clerk/clerk-react` directly. The host router is now provided by `@clerk/nextjs`.
8 changes: 3 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/elements/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,9 +94,7 @@
"typescript": "*"
},
"peerDependencies": {
"@clerk/clerk-react": "^5.0.0",
"@clerk/shared": "^2.0.0",
"next": "^13.5.4 || ^14.0.3 || ^15.0.0-rc",
Comment on lines -97 to -99

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

🔪

"react": "^18.0.0 || ^19.0.0-beta",
"react-dom": "^18.0.0 || ^19.0.0-beta"
},
Expand Down
15 changes: 11 additions & 4 deletions packages/elements/src/internals/constants/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { safeAccess } from '~/utils/safe-access';

export const SSO_CALLBACK_PATH_ROUTE = '/sso-callback';
export const CHOOSE_SESSION_PATH_ROUTE = '/choose';
export const MAGIC_LINK_VERIFY_PATH_ROUTE = '/verify';

export const SIGN_IN_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL ?? '/sign-in';
export const SIGN_UP_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL ?? '/sign-up';
// TODO: remove reliance on next-specific variables here
export const SIGN_IN_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL,
'/sign-in',
);
export const SIGN_UP_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL,
'/sign-up',
);
Comment on lines +7 to +15

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This realistically should be coming from the clerk provider / core clerk object instead of deriving it from environment variables. To maintain compat, I've just made this pull the env vars in a non-erroring way.


// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ export const clerkLoader = fromCallback<EventObject, Clerk | LoadedClerk>(({ sen
if (clerk.loaded) {
reportLoaded();
} else if ('addOnLoaded' in clerk) {
// @ts-expect-error - Expects `addOnLoaded` from @clerk/clerk-react's IsomorphicClerk.
// @ts-expect-error - Expects `addOnLoaded` from @clerk/shared/react's IsomorphicClerk.
clerk.addOnLoaded(reportLoaded);
} else {
sendBack({ type: 'ERROR', message: 'Clerk client could not be loaded' });
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
import { isTruthy } from '@clerk/shared/underscore';
import { createBrowserInspector } from '@statelyai/inspect';

import { safeAccess } from '~/utils/safe-access';

export const getInspector = () => {
if (
__DEV__ &&
typeof window !== 'undefined' &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
const { inspect } = createBrowserInspector({
autoStart: true,
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { isTruthy } from '@clerk/shared/underscore';

import { safeAccess } from '~/utils/safe-access';

import { createConsoleInspector } from './console';

export function getInspector() {
if (
__DEV__ &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG ?? process.env.CLERK_ELEMENTS_DEBUG)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
return createConsoleInspector({
enabled: true,
debugServer: isTruthy(process.env.CLERK_ELEMENTS_DEBUG_SERVER),
debugServer: isTruthy(safeAccess(() => process.env.CLERK_ELEMENTS_DEBUG_SERVER, false)),
});
}
return undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/form/input.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { logger } from '@clerk/shared/logger';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type {
Control as RadixControl,
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/loading.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import { useSelector } from '@xstate/react';
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/hooks/use-password.hook.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { noop } from '@clerk/shared';
import { useClerk } from '@clerk/shared/react';
import type { PasswordSettingsData, PasswordValidation } from '@clerk/types';
import * as React from 'react';

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import type React from 'react';
import { useCallback } from 'react';
Expand Down
1 change: 0 additions & 1 deletion packages/elements/src/react/router/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
export { useNextRouter } from './next';
export { Route, Router, useClerkRouter } from '@clerk/shared/router';
export { useVirtualRouter } from './virtual';
32 changes: 0 additions & 32 deletions packages/elements/src/react/router/next.ts

This file was deleted.

20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-in/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import React, { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
import { SignInRouterMachine } from '~/internals/machines/sign-in';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignInRouterCtx } from '~/react/sign-in/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignInRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -53,7 +53,14 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
if (actor.getSnapshot().can(evt)) {
actor.send(evt);
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}

// Ensure that the latest instantiated formRef is attached to the router
if (formRef && actor.getSnapshot().can({ type: 'RESET.STEP' })) {
Expand DownExpand Up@@ -123,8 +130,7 @@ export function SignInRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-up/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
import { SignUpRouterMachine } from '~/internals/machines/sign-up';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignUpRouterCtx } from '~/react/sign-up/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -61,7 +61,14 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
formRef,
});
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router, clerk.loaded]);

Expand DownExpand Up@@ -122,8 +129,7 @@ export function SignUpRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-up/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
7 changes: 7 additions & 0 deletions packages/elements/src/utils/safe-access.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export function safeAccess(fn: any, fallback: any) {
try {
return fn();
} catch (e) {
return fallback;
}
}
43 changes: 40 additions & 3 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
'use client';
import { ClerkProvider as ReactClerkProvider } from '@clerk/clerk-react';
import { useRouter } from 'next/navigation';
import type { ClerkHostRouter } from '@clerk/shared/router';
import { ClerkHostRouterContext } from '@clerk/shared/router';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import React, { useEffect, useTransition } from 'react';

import { useSafeLayoutEffect } from '../../client-boundary/hooks/useSafeLayoutEffect';
Expand All@@ -17,12 +19,48 @@ declare global {
__clerk_nav_await: Array<(value: void) => void>;
__clerk_nav: (to: string) => Promise<void>;
__clerk_internal_invalidateCachePromise: () => void | undefined;
next?: {
version: string;
};
}
}

// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
export const NEXT_WINDOW_HISTORY_SUPPORT_VERSION = '14.1.0';

/**
* Clerk router integration with Next.js's router.
*/
export const useNextRouter = (): ClerkHostRouter => {
const router = useRouter();
const pathname = usePathname();
// eslint-disable-next-line react-hooks/rules-of-hooks -- The order doesn't differ between renders as we're checking the execution environment.
const searchParams = typeof window === 'undefined' ? new URLSearchParams() : useSearchParams();

// The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
// preserve internal state between steps.
const canUseWindowHistoryAPIs =
typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;

return {
mode: 'path',
name: 'NextRouter',
push: (path: string) => router.push(path),
replace: (path: string) =>
canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
shallowPush(path: string) {
canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
},
pathname: () => pathname,
searchParams: () => searchParams,
};
};
Comment on lines +28 to +58

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I've shifted the useNextRouter() hook from elements into the Next SDK.


export const ClientClerkProvider = (props: NextClerkProviderProps) => {
const { __unstable_invokeMiddlewareOnAuthStateChange = true, children } = props;
const router = useRouter();
const clerkRouter = useNextRouter();
const push = useAwaitablePush();
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();
Expand DownExpand Up@@ -57,7 +95,6 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
return new Promise(res => {
window.__clerk_internal_invalidateCachePromise = res;
startTransition(() => {
//@ts-expect-error next exists on window
if (window.next?.version && typeof window.next.version === 'string' && window.next.version.startsWith('13')) {
router.refresh();
} else {
Expand All@@ -84,7 +121,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
<ClerkNextOptionsProvider options={mergedProps}>
<ReactClerkProvider {...mergedProps}>
<ClerkJSScript router='app' />
{children}
<ClerkHostRouterContext.Provider value={clerkRouter}>{children}</ClerkHostRouterContext.Provider>
</ReactClerkProvider>
</ClerkNextOptionsProvider>
);
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/good-jeans-call.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/elements": minor
"@clerk/nextjs": minor
"@clerk/shared": minor
---

Remove `@clerk/elements` reliance on `next` and `@clerk/clerk-react` directly. The host router is now provided by `@clerk/nextjs`.
8 changes: 3 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/elements/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,9 +94,7 @@
"typescript": "*"
},
"peerDependencies": {
"@clerk/clerk-react": "^5.0.0",
"@clerk/shared": "^2.0.0",
"next": "^13.5.4 || ^14.0.3 || ^15.0.0-rc",
Comment on lines -97 to -99

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

🔪

"react": "^18.0.0 || ^19.0.0-beta",
"react-dom": "^18.0.0 || ^19.0.0-beta"
},
Expand Down
15 changes: 11 additions & 4 deletions packages/elements/src/internals/constants/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { safeAccess } from '~/utils/safe-access';

export const SSO_CALLBACK_PATH_ROUTE = '/sso-callback';
export const CHOOSE_SESSION_PATH_ROUTE = '/choose';
export const MAGIC_LINK_VERIFY_PATH_ROUTE = '/verify';

export const SIGN_IN_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL ?? '/sign-in';
export const SIGN_UP_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL ?? '/sign-up';
// TODO: remove reliance on next-specific variables here
export const SIGN_IN_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL,
'/sign-in',
);
export const SIGN_UP_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL,
'/sign-up',
);
Comment on lines +7 to +15

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This realistically should be coming from the clerk provider / core clerk object instead of deriving it from environment variables. To maintain compat, I've just made this pull the env vars in a non-erroring way.


// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ export const clerkLoader = fromCallback<EventObject, Clerk | LoadedClerk>(({ sen
if (clerk.loaded) {
reportLoaded();
} else if ('addOnLoaded' in clerk) {
// @ts-expect-error - Expects `addOnLoaded` from @clerk/clerk-react's IsomorphicClerk.
// @ts-expect-error - Expects `addOnLoaded` from @clerk/shared/react's IsomorphicClerk.
clerk.addOnLoaded(reportLoaded);
} else {
sendBack({ type: 'ERROR', message: 'Clerk client could not be loaded' });
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
import { isTruthy } from '@clerk/shared/underscore';
import { createBrowserInspector } from '@statelyai/inspect';

import { safeAccess } from '~/utils/safe-access';

export const getInspector = () => {
if (
__DEV__ &&
typeof window !== 'undefined' &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
const { inspect } = createBrowserInspector({
autoStart: true,
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { isTruthy } from '@clerk/shared/underscore';

import { safeAccess } from '~/utils/safe-access';

import { createConsoleInspector } from './console';

export function getInspector() {
if (
__DEV__ &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG ?? process.env.CLERK_ELEMENTS_DEBUG)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
return createConsoleInspector({
enabled: true,
debugServer: isTruthy(process.env.CLERK_ELEMENTS_DEBUG_SERVER),
debugServer: isTruthy(safeAccess(() => process.env.CLERK_ELEMENTS_DEBUG_SERVER, false)),
});
}
return undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/form/input.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { logger } from '@clerk/shared/logger';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type {
Control as RadixControl,
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/loading.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import { useSelector } from '@xstate/react';
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/hooks/use-password.hook.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { noop } from '@clerk/shared';
import { useClerk } from '@clerk/shared/react';
import type { PasswordSettingsData, PasswordValidation } from '@clerk/types';
import * as React from 'react';

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import type React from 'react';
import { useCallback } from 'react';
Expand Down
1 change: 0 additions & 1 deletion packages/elements/src/react/router/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
export { useNextRouter } from './next';
export { Route, Router, useClerkRouter } from '@clerk/shared/router';
export { useVirtualRouter } from './virtual';
32 changes: 0 additions & 32 deletions packages/elements/src/react/router/next.ts

This file was deleted.

20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-in/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import React, { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
import { SignInRouterMachine } from '~/internals/machines/sign-in';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignInRouterCtx } from '~/react/sign-in/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignInRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -53,7 +53,14 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
if (actor.getSnapshot().can(evt)) {
actor.send(evt);
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}

// Ensure that the latest instantiated formRef is attached to the router
if (formRef && actor.getSnapshot().can({ type: 'RESET.STEP' })) {
Expand DownExpand Up@@ -123,8 +130,7 @@ export function SignInRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-up/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
import { SignUpRouterMachine } from '~/internals/machines/sign-up';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignUpRouterCtx } from '~/react/sign-up/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -61,7 +61,14 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
formRef,
});
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router, clerk.loaded]);

Expand DownExpand Up@@ -122,8 +129,7 @@ export function SignUpRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-up/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
7 changes: 7 additions & 0 deletions packages/elements/src/utils/safe-access.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export function safeAccess(fn: any, fallback: any) {
try {
return fn();
} catch (e) {
return fallback;
}
}
43 changes: 40 additions & 3 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
'use client';
import { ClerkProvider as ReactClerkProvider } from '@clerk/clerk-react';
import { useRouter } from 'next/navigation';
import type { ClerkHostRouter } from '@clerk/shared/router';
import { ClerkHostRouterContext } from '@clerk/shared/router';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import React, { useEffect, useTransition } from 'react';

import { useSafeLayoutEffect } from '../../client-boundary/hooks/useSafeLayoutEffect';
Expand All@@ -17,12 +19,48 @@ declare global {
__clerk_nav_await: Array<(value: void) => void>;
__clerk_nav: (to: string) => Promise<void>;
__clerk_internal_invalidateCachePromise: () => void | undefined;
next?: {
version: string;
};
}
}

// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
export const NEXT_WINDOW_HISTORY_SUPPORT_VERSION = '14.1.0';

/**
* Clerk router integration with Next.js's router.
*/
export const useNextRouter = (): ClerkHostRouter => {
const router = useRouter();
const pathname = usePathname();
// eslint-disable-next-line react-hooks/rules-of-hooks -- The order doesn't differ between renders as we're checking the execution environment.
const searchParams = typeof window === 'undefined' ? new URLSearchParams() : useSearchParams();

// The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
// preserve internal state between steps.
const canUseWindowHistoryAPIs =
typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;

return {
mode: 'path',
name: 'NextRouter',
push: (path: string) => router.push(path),
replace: (path: string) =>
canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
shallowPush(path: string) {
canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
},
pathname: () => pathname,
searchParams: () => searchParams,
};
};
Comment on lines +28 to +58

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I've shifted the useNextRouter() hook from elements into the Next SDK.


export const ClientClerkProvider = (props: NextClerkProviderProps) => {
const { __unstable_invokeMiddlewareOnAuthStateChange = true, children } = props;
const router = useRouter();
const clerkRouter = useNextRouter();
const push = useAwaitablePush();
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();
Expand DownExpand Up@@ -57,7 +95,6 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
return new Promise(res => {
window.__clerk_internal_invalidateCachePromise = res;
startTransition(() => {
//@ts-expect-error next exists on window
if (window.next?.version && typeof window.next.version === 'string' && window.next.version.startsWith('13')) {
router.refresh();
} else {
Expand All@@ -84,7 +121,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
<ClerkNextOptionsProvider options={mergedProps}>
<ReactClerkProvider {...mergedProps}>
<ClerkJSScript router='app' />
{children}
<ClerkHostRouterContext.Provider value={clerkRouter}>{children}</ClerkHostRouterContext.Provider>
</ReactClerkProvider>
</ClerkNextOptionsProvider>
);
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/good-jeans-call.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/elements": minor
"@clerk/nextjs": minor
"@clerk/shared": minor
---

Remove `@clerk/elements` reliance on `next` and `@clerk/clerk-react` directly. The host router is now provided by `@clerk/nextjs`.
8 changes: 3 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/elements/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,9 +94,7 @@
"typescript": "*"
},
"peerDependencies": {
"@clerk/clerk-react": "^5.0.0",
"@clerk/shared": "^2.0.0",
"next": "^13.5.4 || ^14.0.3 || ^15.0.0-rc",
Comment on lines -97 to -99

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

🔪

"react": "^18.0.0 || ^19.0.0-beta",
"react-dom": "^18.0.0 || ^19.0.0-beta"
},
Expand Down
15 changes: 11 additions & 4 deletions packages/elements/src/internals/constants/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { safeAccess } from '~/utils/safe-access';

export const SSO_CALLBACK_PATH_ROUTE = '/sso-callback';
export const CHOOSE_SESSION_PATH_ROUTE = '/choose';
export const MAGIC_LINK_VERIFY_PATH_ROUTE = '/verify';

export const SIGN_IN_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL ?? '/sign-in';
export const SIGN_UP_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL ?? '/sign-up';
// TODO: remove reliance on next-specific variables here
export const SIGN_IN_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL,
'/sign-in',
);
export const SIGN_UP_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL,
'/sign-up',
);
Comment on lines +7 to +15

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This realistically should be coming from the clerk provider / core clerk object instead of deriving it from environment variables. To maintain compat, I've just made this pull the env vars in a non-erroring way.


// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ export const clerkLoader = fromCallback<EventObject, Clerk | LoadedClerk>(({ sen
if (clerk.loaded) {
reportLoaded();
} else if ('addOnLoaded' in clerk) {
// @ts-expect-error - Expects `addOnLoaded` from @clerk/clerk-react's IsomorphicClerk.
// @ts-expect-error - Expects `addOnLoaded` from @clerk/shared/react's IsomorphicClerk.
clerk.addOnLoaded(reportLoaded);
} else {
sendBack({ type: 'ERROR', message: 'Clerk client could not be loaded' });
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
import { isTruthy } from '@clerk/shared/underscore';
import { createBrowserInspector } from '@statelyai/inspect';

import { safeAccess } from '~/utils/safe-access';

export const getInspector = () => {
if (
__DEV__ &&
typeof window !== 'undefined' &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
const { inspect } = createBrowserInspector({
autoStart: true,
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { isTruthy } from '@clerk/shared/underscore';

import { safeAccess } from '~/utils/safe-access';

import { createConsoleInspector } from './console';

export function getInspector() {
if (
__DEV__ &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG ?? process.env.CLERK_ELEMENTS_DEBUG)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
return createConsoleInspector({
enabled: true,
debugServer: isTruthy(process.env.CLERK_ELEMENTS_DEBUG_SERVER),
debugServer: isTruthy(safeAccess(() => process.env.CLERK_ELEMENTS_DEBUG_SERVER, false)),
});
}
return undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/form/input.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { logger } from '@clerk/shared/logger';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type {
Control as RadixControl,
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/loading.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import { useSelector } from '@xstate/react';
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/hooks/use-password.hook.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { noop } from '@clerk/shared';
import { useClerk } from '@clerk/shared/react';
import type { PasswordSettingsData, PasswordValidation } from '@clerk/types';
import * as React from 'react';

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import type React from 'react';
import { useCallback } from 'react';
Expand Down
1 change: 0 additions & 1 deletion packages/elements/src/react/router/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
export { useNextRouter } from './next';
export { Route, Router, useClerkRouter } from '@clerk/shared/router';
export { useVirtualRouter } from './virtual';
32 changes: 0 additions & 32 deletions packages/elements/src/react/router/next.ts

This file was deleted.

20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-in/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import React, { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
import { SignInRouterMachine } from '~/internals/machines/sign-in';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignInRouterCtx } from '~/react/sign-in/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignInRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -53,7 +53,14 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
if (actor.getSnapshot().can(evt)) {
actor.send(evt);
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}

// Ensure that the latest instantiated formRef is attached to the router
if (formRef && actor.getSnapshot().can({ type: 'RESET.STEP' })) {
Expand DownExpand Up@@ -123,8 +130,7 @@ export function SignInRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-up/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
import { SignUpRouterMachine } from '~/internals/machines/sign-up';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignUpRouterCtx } from '~/react/sign-up/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -61,7 +61,14 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
formRef,
});
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router, clerk.loaded]);

Expand DownExpand Up@@ -122,8 +129,7 @@ export function SignUpRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-up/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
7 changes: 7 additions & 0 deletions packages/elements/src/utils/safe-access.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export function safeAccess(fn: any, fallback: any) {
try {
return fn();
} catch (e) {
return fallback;
}
}
43 changes: 40 additions & 3 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
'use client';
import { ClerkProvider as ReactClerkProvider } from '@clerk/clerk-react';
import { useRouter } from 'next/navigation';
import type { ClerkHostRouter } from '@clerk/shared/router';
import { ClerkHostRouterContext } from '@clerk/shared/router';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import React, { useEffect, useTransition } from 'react';

import { useSafeLayoutEffect } from '../../client-boundary/hooks/useSafeLayoutEffect';
Expand All@@ -17,12 +19,48 @@ declare global {
__clerk_nav_await: Array<(value: void) => void>;
__clerk_nav: (to: string) => Promise<void>;
__clerk_internal_invalidateCachePromise: () => void | undefined;
next?: {
version: string;
};
}
}

// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
export const NEXT_WINDOW_HISTORY_SUPPORT_VERSION = '14.1.0';

/**
* Clerk router integration with Next.js's router.
*/
export const useNextRouter = (): ClerkHostRouter => {
const router = useRouter();
const pathname = usePathname();
// eslint-disable-next-line react-hooks/rules-of-hooks -- The order doesn't differ between renders as we're checking the execution environment.
const searchParams = typeof window === 'undefined' ? new URLSearchParams() : useSearchParams();

// The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
// preserve internal state between steps.
const canUseWindowHistoryAPIs =
typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;

return {
mode: 'path',
name: 'NextRouter',
push: (path: string) => router.push(path),
replace: (path: string) =>
canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
shallowPush(path: string) {
canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
},
pathname: () => pathname,
searchParams: () => searchParams,
};
};
Comment on lines +28 to +58

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I've shifted the useNextRouter() hook from elements into the Next SDK.


export const ClientClerkProvider = (props: NextClerkProviderProps) => {
const { __unstable_invokeMiddlewareOnAuthStateChange = true, children } = props;
const router = useRouter();
const clerkRouter = useNextRouter();
const push = useAwaitablePush();
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();
Expand DownExpand Up@@ -57,7 +95,6 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
return new Promise(res => {
window.__clerk_internal_invalidateCachePromise = res;
startTransition(() => {
//@ts-expect-error next exists on window
if (window.next?.version && typeof window.next.version === 'string' && window.next.version.startsWith('13')) {
router.refresh();
} else {
Expand All@@ -84,7 +121,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
<ClerkNextOptionsProvider options={mergedProps}>
<ReactClerkProvider {...mergedProps}>
<ClerkJSScript router='app' />
{children}
<ClerkHostRouterContext.Provider value={clerkRouter}>{children}</ClerkHostRouterContext.Provider>
</ReactClerkProvider>
</ClerkNextOptionsProvider>
);
Expand Down
Loading
, '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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/good-jeans-call.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
---
"@clerk/elements": minor
"@clerk/nextjs": minor
"@clerk/shared": minor
---

Remove `@clerk/elements` reliance on `next` and `@clerk/clerk-react` directly. The host router is now provided by `@clerk/nextjs`.
8 changes: 3 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions packages/elements/package.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -94,9 +94,7 @@
"typescript": "*"
},
"peerDependencies": {
"@clerk/clerk-react": "^5.0.0",
"@clerk/shared": "^2.0.0",
"next": "^13.5.4 || ^14.0.3 || ^15.0.0-rc",
Comment on lines -97 to -99

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

🔪

"react": "^18.0.0 || ^19.0.0-beta",
"react-dom": "^18.0.0 || ^19.0.0-beta"
},
Expand Down
15 changes: 11 additions & 4 deletions packages/elements/src/internals/constants/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { safeAccess } from '~/utils/safe-access';

export const SSO_CALLBACK_PATH_ROUTE = '/sso-callback';
export const CHOOSE_SESSION_PATH_ROUTE = '/choose';
export const MAGIC_LINK_VERIFY_PATH_ROUTE = '/verify';

export const SIGN_IN_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL ?? '/sign-in';
export const SIGN_UP_DEFAULT_BASE_PATH =
process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL ?? '/sign-up';
// TODO: remove reliance on next-specific variables here
export const SIGN_IN_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_IN_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_IN_URL,
'/sign-in',
);
export const SIGN_UP_DEFAULT_BASE_PATH = safeAccess(
() => process.env.CLERK_SIGN_UP_URL ?? process.env.NEXT_PUBLIC_CLERK_SIGN_UP_URL,
'/sign-up',
);
Comment on lines +7 to +15

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This realistically should be coming from the clerk provider / core clerk object instead of deriving it from environment variables. To maintain compat, I've just made this pull the env vars in a non-erroring way.


// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@ export const clerkLoader = fromCallback<EventObject, Clerk | LoadedClerk>(({ sen
if (clerk.loaded) {
reportLoaded();
} else if ('addOnLoaded' in clerk) {
// @ts-expect-error - Expects `addOnLoaded` from @clerk/clerk-react's IsomorphicClerk.
// @ts-expect-error - Expects `addOnLoaded` from @clerk/shared/react's IsomorphicClerk.
clerk.addOnLoaded(reportLoaded);
} else {
sendBack({ type: 'ERROR', message: 'Clerk client could not be loaded' });
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
import { isTruthy } from '@clerk/shared/underscore';
import { createBrowserInspector } from '@statelyai/inspect';

import { safeAccess } from '~/utils/safe-access';

export const getInspector = () => {
if (
__DEV__ &&
typeof window !== 'undefined' &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
const { inspect } = createBrowserInspector({
autoStart: true,
Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,20 @@
import { isTruthy } from '@clerk/shared/underscore';

import { safeAccess } from '~/utils/safe-access';

import { createConsoleInspector } from './console';

export function getInspector() {
if (
__DEV__ &&
process.env.NODE_ENV === 'development' &&
isTruthy(process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG ?? process.env.CLERK_ELEMENTS_DEBUG)
isTruthy(
safeAccess(() => process.env.NEXT_PUBLIC_CLERK_ELEMENTS_DEBUG_UI ?? process.env.CLERK_ELEMENTS_DEBUG_UI, false),
)
) {
return createConsoleInspector({
enabled: true,
debugServer: isTruthy(process.env.CLERK_ELEMENTS_DEBUG_SERVER),
debugServer: isTruthy(safeAccess(() => process.env.CLERK_ELEMENTS_DEBUG_SERVER, false)),
});
}
return undefined;
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/form/input.tsx
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { logger } from '@clerk/shared/logger';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type {
Control as RadixControl,
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/common/loading.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import { useSelector } from '@xstate/react';
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/hooks/use-password.hook.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { noop } from '@clerk/shared';
import { useClerk } from '@clerk/shared/react';
import type { PasswordSettingsData, PasswordValidation } from '@clerk/types';
import * as React from 'react';

Expand Down
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import type { OAuthProvider, SamlStrategy, Web3Provider } from '@clerk/types';
import type React from 'react';
import { useCallback } from 'react';
Expand Down
1 change: 0 additions & 1 deletion packages/elements/src/react/router/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
export { useNextRouter } from './next';
export { Route, Router, useClerkRouter } from '@clerk/shared/router';
export { useVirtualRouter } from './virtual';
32 changes: 0 additions & 32 deletions packages/elements/src/react/router/next.ts

This file was deleted.

20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-in/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import React, { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignInRouterInitEvent } from '~/internals/machines/sign-in';
import { SignInRouterMachine } from '~/internals/machines/sign-in';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignInRouterCtx } from '~/react/sign-in/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignInRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -53,7 +53,14 @@ function SignInFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
if (actor.getSnapshot().can(evt)) {
actor.send(evt);
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}

// Ensure that the latest instantiated formRef is attached to the router
if (formRef && actor.getSnapshot().can({ type: 'RESET.STEP' })) {
Expand DownExpand Up@@ -123,8 +130,7 @@ export function SignInRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-in/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
20 changes: 13 additions & 7 deletions packages/elements/src/react/sign-up/root.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { useClerkHostRouter } from '@clerk/shared/router';
import { eventComponentMounted } from '@clerk/shared/telemetry';
import { useSelector } from '@xstate/react';
import { useEffect } from 'react';
Expand All@@ -9,7 +10,7 @@ import { FormStoreProvider, useFormStore } from '~/internals/machines/form/form.
import type { SignUpRouterInitEvent } from '~/internals/machines/sign-up';
import { SignUpRouterMachine } from '~/internals/machines/sign-up';
import { inspect } from '~/internals/utils/inspector';
import { Router, useClerkRouter, useNextRouter, useVirtualRouter } from '~/react/router';
import { Router, useClerkRouter, useVirtualRouter } from '~/react/router';
import { SignUpRouterCtx } from '~/react/sign-up/context';

import { Form } from '../common/form';
Expand DownExpand Up@@ -39,8 +40,7 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
return;
}

// @ts-expect-error -- This is actually an IsomorphicClerk instance
clerk.addOnLoaded(() => {
const cb = () => {
const evt: SignUpRouterInitEvent = {
type: 'INIT',
clerk,
Expand All@@ -61,7 +61,14 @@ function SignUpFlowProvider({ children, exampleMode, fallback, isRootPath }: Sig
formRef,
});
}
});
};

if ('addOnLoaded' in clerk) {
// @ts-expect-error - addOnLoaded doesn't exist on the clerk type, but it does on IsomorphicClerk, which can be hit when Elements is used standalone
clerk.addOnLoaded(cb);
} else {
cb();
}
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [clerk, exampleMode, formRef?.id, !!router, clerk.loaded]);

Expand DownExpand Up@@ -122,8 +129,7 @@ export function SignUpRoot({
}),
);

// TODO: eventually we'll rely on the framework SDK to specify its host router, but for now we'll default to Next.js
const router = (routing === ROUTING.virtual ? useVirtualRouter : useNextRouter)();
const router = (routing === ROUTING.virtual ? useVirtualRouter : useClerkHostRouter)();
const isRootPath = path === router.pathname();

return (
Expand Down
2 changes: 1 addition & 1 deletion packages/elements/src/react/sign-up/step.tsx
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { useClerk } from '@clerk/clerk-react';
import { useClerk } from '@clerk/shared/react';
import { eventComponentMounted } from '@clerk/shared/telemetry';

import { ClerkElementsRuntimeError } from '~/internals/errors';
Expand Down
7 changes: 7 additions & 0 deletions packages/elements/src/utils/safe-access.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
export function safeAccess(fn: any, fallback: any) {
try {
return fn();
} catch (e) {
return fallback;
}
}
43 changes: 40 additions & 3 deletions packages/nextjs/src/app-router/client/ClerkProvider.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
'use client';
import { ClerkProvider as ReactClerkProvider } from '@clerk/clerk-react';
import { useRouter } from 'next/navigation';
import type { ClerkHostRouter } from '@clerk/shared/router';
import { ClerkHostRouterContext } from '@clerk/shared/router';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import React, { useEffect, useTransition } from 'react';

import { useSafeLayoutEffect } from '../../client-boundary/hooks/useSafeLayoutEffect';
Expand All@@ -17,12 +19,48 @@ declare global {
__clerk_nav_await: Array<(value: void) => void>;
__clerk_nav: (to: string) => Promise<void>;
__clerk_internal_invalidateCachePromise: () => void | undefined;
next?: {
version: string;
};
}
}

// The version that Next added support for the window.history.pushState and replaceState APIs.
// ref: https://nextjs.org/blog/next-14-1#windowhistorypushstate-and-windowhistoryreplacestate
export const NEXT_WINDOW_HISTORY_SUPPORT_VERSION = '14.1.0';

/**
* Clerk router integration with Next.js's router.
*/
export const useNextRouter = (): ClerkHostRouter => {
const router = useRouter();
const pathname = usePathname();
// eslint-disable-next-line react-hooks/rules-of-hooks -- The order doesn't differ between renders as we're checking the execution environment.
const searchParams = typeof window === 'undefined' ? new URLSearchParams() : useSearchParams();

// The window.history APIs seem to prevent Next.js from triggering a full page re-render, allowing us to
// preserve internal state between steps.
const canUseWindowHistoryAPIs =
typeof window !== 'undefined' && window.next && window.next.version >= NEXT_WINDOW_HISTORY_SUPPORT_VERSION;

return {
mode: 'path',
name: 'NextRouter',
push: (path: string) => router.push(path),
replace: (path: string) =>
canUseWindowHistoryAPIs ? window.history.replaceState(null, '', path) : router.replace(path),
shallowPush(path: string) {
canUseWindowHistoryAPIs ? window.history.pushState(null, '', path) : router.push(path, {});
},
pathname: () => pathname,
searchParams: () => searchParams,
};
};
Comment on lines +28 to +58

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I've shifted the useNextRouter() hook from elements into the Next SDK.


export const ClientClerkProvider = (props: NextClerkProviderProps) => {
const { __unstable_invokeMiddlewareOnAuthStateChange = true, children } = props;
const router = useRouter();
const clerkRouter = useNextRouter();
const push = useAwaitablePush();
const replace = useAwaitableReplace();
const [isPending, startTransition] = useTransition();
Expand DownExpand Up@@ -57,7 +95,6 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
return new Promise(res => {
window.__clerk_internal_invalidateCachePromise = res;
startTransition(() => {
//@ts-expect-error next exists on window
if (window.next?.version && typeof window.next.version === 'string' && window.next.version.startsWith('13')) {
router.refresh();
} else {
Expand All@@ -84,7 +121,7 @@ export const ClientClerkProvider = (props: NextClerkProviderProps) => {
<ClerkNextOptionsProvider options={mergedProps}>
<ReactClerkProvider {...mergedProps}>
<ClerkJSScript router='app' />
{children}
<ClerkHostRouterContext.Provider value={clerkRouter}>{children}</ClerkHostRouterContext.Provider>
</ReactClerkProvider>
</ClerkNextOptionsProvider>
);
Expand Down
Loading