Closed
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
92 changes: 92 additions & 0 deletions .changeset/split-setactive-into-select-methods.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
---
'@clerk/clerk-js': major
'@clerk/shared': major
'@clerk/react': major
'@clerk/nextjs': major
'@clerk/vue': major
'@clerk/expo': major
'@clerk/ui': major
'@clerk/testing': major
---

Replace `setActive` with purpose-specific methods: `selectSession` and `selectOrganization`

## Breaking Changes

### `setActive` Removed from Public API

The `setActive` method has been removed from the Clerk object and all hooks. Use the new purpose-specific methods instead:

- `clerk.selectSession(session, options?)` - For session selection
- `clerk.selectOrganization(organization, options?)` - For organization selection

### Hook Return Types

The following hooks no longer return `setActive`:

- `useSignIn()` - now returns `selectSession` instead of `setActive`
- `useSignUp()` - now returns `selectSession` instead of `setActive`
- `useSessionList()` - now returns `selectSession` instead of `setActive`
- `useOrganizationList()` - now returns `selectOrganization` instead of `setActive`

### Migration

**Before:**
```tsx
const { setActive } = useSignIn();
await setActive({ session: createdSessionId });

const { setActive } = useOrganizationList();
await setActive({ organization: org });
```

**After:**
```tsx
const { selectSession } = useSignIn();
await selectSession(createdSessionId);

const { selectOrganization } = useOrganizationList();
await selectOrganization(org);
```

### New Methods on Clerk Object

Two new methods are available on the Clerk object:

- `clerk.selectSession(session, options?)` - For session selection (sign-in, sign-up, multi-session switching)
- `clerk.selectOrganization(organization, options?)` - For organization selection (org switching, personal workspace)

### Options

Both methods accept an options object:

```tsx
// selectSession options
await selectSession(session, {
redirectUrl?: string;
navigate?: ({ session }) => void | Promise<void>;
});

// selectOrganization options
await selectOrganization(organization, {
redirectUrl?: string;
navigate?: ({ session, organization }) => void | Promise<void>;
});
```

### Expo Hooks

The `StartGoogleAuthenticationFlowReturnType` and `StartAppleAuthenticationFlowReturnType` types now return `selectSession` instead of `setActive`.

### Internal Window Hooks (Next.js)

The internal window hooks have been renamed:
- `__internal_onBeforeSetActive` → `__internal_onBeforeSelectSession`
- `__internal_onAfterSetActive` → `__internal_onAfterSelectSession`

### Types Removed

The following types have been removed from the public API:
- `SetActive`
- `SetActiveParams`
- `SetActiveNavigate` (use `SelectSessionNavigate` instead)
97 changes: 84 additions & 13 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,8 @@ import type {
RedirectOptions,
Resources,
SDKMetadata,
SelectOrganizationOptions,
SelectSessionOptions,
SessionResource,
SetActiveParams,
SignedInSessionResource,
Expand DownExpand Up@@ -297,7 +299,7 @@ export class Clerk implements ClerkInterface {
public __internal_isWebAuthnAutofillSupported: (() => Promise<boolean>) | undefined;
public __internal_isWebAuthnPlatformAuthenticatorSupported: (() => Promise<boolean>) | undefined;

public __internal_setActiveInProgress = false;
public __internal_selectSessionInProgress = false;

get publishableKey(): string {
return this.#publishableKey;
Expand DownExpand Up@@ -583,13 +585,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

const opts = callbackOrOptions && typeof callbackOrOptions === 'object' ? callbackOrOptions : options || {};
Expand DownExpand Up@@ -1446,7 +1448,7 @@ export class Clerk implements ClerkInterface {
public setActive = async (params: SetActiveParams): Promise<void> => {
const { organization, redirectUrl, navigate: setActiveNavigate } = params;
let { session } = params;
this.__internal_setActiveInProgress = true;
this.__internal_selectSessionInProgress = true;
debugLogger.debug(
'setActive() start',
{
Expand DownExpand Up@@ -1476,13 +1478,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

let newSession = session === undefined ? this.session : session;
Expand DownExpand Up@@ -1605,10 +1607,79 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
}
} finally {
this.__internal_setActiveInProgress = false;
this.__internal_selectSessionInProgress = false;
}
};

/**
* Select a session to make active.
*
* Use this method after sign-in or sign-up to activate the created session,
* or to switch between sessions in a multi-session application.
*
* Pass `null` to sign out and clear the active session.
*/
public selectSession = async (
session: SignedInSessionResource | string | null,
options?: SelectSessionOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session: s }: { session: SessionResource }) => {
const result = await navigate({ session: s });
if (typeof result === 'string') {
await this.navigate(result);
}
}
: undefined;

return this.setActive({
session,
navigate: setActiveNavigate,
redirectUrl,
});
};

/**
* Select an organization to make active within the current session.
*
* Use this method to switch between organizations or to select a personal workspace.
*
* Pass `null` to switch to the personal workspace (no active organization).
*/
public selectOrganization = async (
organization: OrganizationResource | string | null,
options?: SelectOrganizationOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session }: { session: SessionResource }) => {
// Resolve the organization for the callback
const org =
organization === null
? null
: typeof organization === 'string'
? (this.organization ?? null)
: organization;

const result = await navigate({ session, organization: org });
if (typeof result === 'string') {
await this.navigate(result);
}
}
Comment on lines +1658 to +1673

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the selected organization when invoking navigate.

When organization is a string, the callback receives this.organization (the current org), not the newly selected one. This can route to the wrong org or personal workspace. Resolve the organization from the session being activated (e.g., via session.lastActiveOrganizationId or memberships) before calling navigate.

🛠️ Proposed fix
- const org =- organization === null- ? null- : typeof organization === 'string'- ? (this.organization ?? null)- : organization;+ const org =+ organization === null+ ? null+ : typeof organization === 'string'+ ? session.user.organizationMemberships.find(+ mem => mem.organization.id === session.lastActiveOrganizationId,+ )?.organization ?? null+ : organization;
🤖 Prompt for AI Agents
In `@packages/clerk-js/src/core/clerk.ts` around lines 1658 - 1673, The
setActiveNavigate wrapper currently uses this.organization when the external
`organization` config is a string, which can be stale; instead resolve the
selected org from the activating session before calling `navigate`. In the async
function `setActiveNavigate` (wrapping `navigate` and using `SessionResource`),
if `organization === null` pass null; if `typeof organization === 'string'`
derive the org from the provided `session` (prefer
`session.lastActiveOrganizationId` or fall back to finding a membership with
matching organization id in `session.memberships`) and pass that resolved
id/object to `navigate`; otherwise pass the `organization` object directly.
Update the resolution logic in `setActiveNavigate` to use
`session.lastActiveOrganizationId`/`session.memberships` instead of
`this.organization` before invoking `navigate` and handling string return values
with `this.navigate`.

: undefined;

return this.setActive({
organization,
navigate: setActiveNavigate,
redirectUrl,
});
};

public addListener = (listener: ListenerCallback): UnsubscribeCallback => {
listener = memoizeListenerCallback(listener);
this.#listeners.push(listener);
Expand DownExpand Up@@ -2596,8 +2667,8 @@ export class Clerk implements ClerkInterface {
const hasTransitionedToPendingStatus = this.session.status === 'active' && session?.status === 'pending';
if (hasTransitionedToPendingStatus) {
const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

// Execute hooks to update server authentication context and trigger
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,7 +204,7 @@ export class CheckoutFlow implements CheckoutFlowResourceNonStrict {
throw new Error('Clerk: `confirm()` must be called before `finalize()`');
}

await BillingCheckout.clerk.setActive({ session: BillingCheckout.clerk.session?.id, navigate });
await BillingCheckout.clerk.selectSession(BillingCheckout.clerk.session?.id ?? null, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1243,7 +1243,7 @@ class SignInFuture implements SignInFutureResource {
}

this.#hasBeenFinalized = true;
await SignIn.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignIn.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,7 +972,7 @@ class SignUpFuture implements SignUpFutureResource {
}

this.#hasBeenFinalized = true;
await SignUp.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignUp.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,8 @@ const __BUILD_VARIANT_CHANNEL__: boolean;
const __BUILD_VARIANT_CHIPS__: boolean;

interface Window {
__internal_onBeforeSetActive: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSetActive: () => Promise<void> | void;
__internal_onBeforeSelectSession: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSelectSession: () => Promise<void> | void;
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
__internal_ClerkUiCtor?: import('@clerk/shared/types').ClerkUiConstructor;
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/test/mock-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,8 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepVitestMocked<LoadedCle
});

mockProp(clerkAny, 'navigate');
mockProp(clerkAny, 'setActive');
mockProp(clerkAny, 'selectSession');
mockProp(clerkAny, 'selectOrganization');
mockProp(clerkAny, 'redirectWithAuth');
mockProp(clerkAny, '__internal_navigateWithError');
return clerkAny as DeepVitestMocked<LoadedClerk>;
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type { OAuthStrategy, SetActive, SignInResource, SignUpResource } from '@clerk/shared/types';
import type { OAuthStrategy, SelectSessionHook, SignInResource, SignUpResource } from '@clerk/shared/types';
import * as AuthSession from 'expo-auth-session';
import * as WebBrowser from 'expo-web-browser';

Expand All@@ -18,7 +18,7 @@ export type StartOAuthFlowParams = {

export type StartOAuthFlowReturnType = {
createdSessionId: string;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
authSessionResult?: WebBrowser.WebBrowserAuthSessionResult;
Expand All@@ -33,7 +33,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
Expand All@@ -42,7 +42,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
createdSessionId: '',
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -79,7 +79,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId: '',
setActive,
selectSession,
signIn,
signUp,
};
Expand DownExpand Up@@ -108,7 +108,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId,
setActive,
selectSession,
signIn,
signUp,
};
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useSSO.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SelectSessionHook,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
Expand All@@ -28,13 +28,13 @@ export type StartSSOFlowParams = {
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
Expand All@@ -44,7 +44,7 @@ export function useSSO() {
authSessionResult: null,
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -81,7 +81,7 @@ export function useSSO() {
if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand All@@ -102,7 +102,7 @@ export function useSSO() {

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
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
92 changes: 92 additions & 0 deletions .changeset/split-setactive-into-select-methods.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
---
'@clerk/clerk-js': major
'@clerk/shared': major
'@clerk/react': major
'@clerk/nextjs': major
'@clerk/vue': major
'@clerk/expo': major
'@clerk/ui': major
'@clerk/testing': major
---

Replace `setActive` with purpose-specific methods: `selectSession` and `selectOrganization`

## Breaking Changes

### `setActive` Removed from Public API

The `setActive` method has been removed from the Clerk object and all hooks. Use the new purpose-specific methods instead:

- `clerk.selectSession(session, options?)` - For session selection
- `clerk.selectOrganization(organization, options?)` - For organization selection

### Hook Return Types

The following hooks no longer return `setActive`:

- `useSignIn()` - now returns `selectSession` instead of `setActive`
- `useSignUp()` - now returns `selectSession` instead of `setActive`
- `useSessionList()` - now returns `selectSession` instead of `setActive`
- `useOrganizationList()` - now returns `selectOrganization` instead of `setActive`

### Migration

**Before:**
```tsx
const { setActive } = useSignIn();
await setActive({ session: createdSessionId });

const { setActive } = useOrganizationList();
await setActive({ organization: org });
```

**After:**
```tsx
const { selectSession } = useSignIn();
await selectSession(createdSessionId);

const { selectOrganization } = useOrganizationList();
await selectOrganization(org);
```

### New Methods on Clerk Object

Two new methods are available on the Clerk object:

- `clerk.selectSession(session, options?)` - For session selection (sign-in, sign-up, multi-session switching)
- `clerk.selectOrganization(organization, options?)` - For organization selection (org switching, personal workspace)

### Options

Both methods accept an options object:

```tsx
// selectSession options
await selectSession(session, {
redirectUrl?: string;
navigate?: ({ session }) => void | Promise<void>;
});

// selectOrganization options
await selectOrganization(organization, {
redirectUrl?: string;
navigate?: ({ session, organization }) => void | Promise<void>;
});
```

### Expo Hooks

The `StartGoogleAuthenticationFlowReturnType` and `StartAppleAuthenticationFlowReturnType` types now return `selectSession` instead of `setActive`.

### Internal Window Hooks (Next.js)

The internal window hooks have been renamed:
- `__internal_onBeforeSetActive` → `__internal_onBeforeSelectSession`
- `__internal_onAfterSetActive` → `__internal_onAfterSelectSession`

### Types Removed

The following types have been removed from the public API:
- `SetActive`
- `SetActiveParams`
- `SetActiveNavigate` (use `SelectSessionNavigate` instead)
97 changes: 84 additions & 13 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,8 @@ import type {
RedirectOptions,
Resources,
SDKMetadata,
SelectOrganizationOptions,
SelectSessionOptions,
SessionResource,
SetActiveParams,
SignedInSessionResource,
Expand DownExpand Up@@ -297,7 +299,7 @@ export class Clerk implements ClerkInterface {
public __internal_isWebAuthnAutofillSupported: (() => Promise<boolean>) | undefined;
public __internal_isWebAuthnPlatformAuthenticatorSupported: (() => Promise<boolean>) | undefined;

public __internal_setActiveInProgress = false;
public __internal_selectSessionInProgress = false;

get publishableKey(): string {
return this.#publishableKey;
Expand DownExpand Up@@ -583,13 +585,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

const opts = callbackOrOptions && typeof callbackOrOptions === 'object' ? callbackOrOptions : options || {};
Expand DownExpand Up@@ -1446,7 +1448,7 @@ export class Clerk implements ClerkInterface {
public setActive = async (params: SetActiveParams): Promise<void> => {
const { organization, redirectUrl, navigate: setActiveNavigate } = params;
let { session } = params;
this.__internal_setActiveInProgress = true;
this.__internal_selectSessionInProgress = true;
debugLogger.debug(
'setActive() start',
{
Expand DownExpand Up@@ -1476,13 +1478,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

let newSession = session === undefined ? this.session : session;
Expand DownExpand Up@@ -1605,10 +1607,79 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
}
} finally {
this.__internal_setActiveInProgress = false;
this.__internal_selectSessionInProgress = false;
}
};

/**
* Select a session to make active.
*
* Use this method after sign-in or sign-up to activate the created session,
* or to switch between sessions in a multi-session application.
*
* Pass `null` to sign out and clear the active session.
*/
public selectSession = async (
session: SignedInSessionResource | string | null,
options?: SelectSessionOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session: s }: { session: SessionResource }) => {
const result = await navigate({ session: s });
if (typeof result === 'string') {
await this.navigate(result);
}
}
: undefined;

return this.setActive({
session,
navigate: setActiveNavigate,
redirectUrl,
});
};

/**
* Select an organization to make active within the current session.
*
* Use this method to switch between organizations or to select a personal workspace.
*
* Pass `null` to switch to the personal workspace (no active organization).
*/
public selectOrganization = async (
organization: OrganizationResource | string | null,
options?: SelectOrganizationOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session }: { session: SessionResource }) => {
// Resolve the organization for the callback
const org =
organization === null
? null
: typeof organization === 'string'
? (this.organization ?? null)
: organization;

const result = await navigate({ session, organization: org });
if (typeof result === 'string') {
await this.navigate(result);
}
}
Comment on lines +1658 to +1673

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the selected organization when invoking navigate.

When organization is a string, the callback receives this.organization (the current org), not the newly selected one. This can route to the wrong org or personal workspace. Resolve the organization from the session being activated (e.g., via session.lastActiveOrganizationId or memberships) before calling navigate.

🛠️ Proposed fix
- const org =- organization === null- ? null- : typeof organization === 'string'- ? (this.organization ?? null)- : organization;+ const org =+ organization === null+ ? null+ : typeof organization === 'string'+ ? session.user.organizationMemberships.find(+ mem => mem.organization.id === session.lastActiveOrganizationId,+ )?.organization ?? null+ : organization;
🤖 Prompt for AI Agents
In `@packages/clerk-js/src/core/clerk.ts` around lines 1658 - 1673, The
setActiveNavigate wrapper currently uses this.organization when the external
`organization` config is a string, which can be stale; instead resolve the
selected org from the activating session before calling `navigate`. In the async
function `setActiveNavigate` (wrapping `navigate` and using `SessionResource`),
if `organization === null` pass null; if `typeof organization === 'string'`
derive the org from the provided `session` (prefer
`session.lastActiveOrganizationId` or fall back to finding a membership with
matching organization id in `session.memberships`) and pass that resolved
id/object to `navigate`; otherwise pass the `organization` object directly.
Update the resolution logic in `setActiveNavigate` to use
`session.lastActiveOrganizationId`/`session.memberships` instead of
`this.organization` before invoking `navigate` and handling string return values
with `this.navigate`.

: undefined;

return this.setActive({
organization,
navigate: setActiveNavigate,
redirectUrl,
});
};

public addListener = (listener: ListenerCallback): UnsubscribeCallback => {
listener = memoizeListenerCallback(listener);
this.#listeners.push(listener);
Expand DownExpand Up@@ -2596,8 +2667,8 @@ export class Clerk implements ClerkInterface {
const hasTransitionedToPendingStatus = this.session.status === 'active' && session?.status === 'pending';
if (hasTransitionedToPendingStatus) {
const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

// Execute hooks to update server authentication context and trigger
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,7 +204,7 @@ export class CheckoutFlow implements CheckoutFlowResourceNonStrict {
throw new Error('Clerk: `confirm()` must be called before `finalize()`');
}

await BillingCheckout.clerk.setActive({ session: BillingCheckout.clerk.session?.id, navigate });
await BillingCheckout.clerk.selectSession(BillingCheckout.clerk.session?.id ?? null, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1243,7 +1243,7 @@ class SignInFuture implements SignInFutureResource {
}

this.#hasBeenFinalized = true;
await SignIn.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignIn.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,7 +972,7 @@ class SignUpFuture implements SignUpFutureResource {
}

this.#hasBeenFinalized = true;
await SignUp.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignUp.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,8 @@ const __BUILD_VARIANT_CHANNEL__: boolean;
const __BUILD_VARIANT_CHIPS__: boolean;

interface Window {
__internal_onBeforeSetActive: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSetActive: () => Promise<void> | void;
__internal_onBeforeSelectSession: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSelectSession: () => Promise<void> | void;
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
__internal_ClerkUiCtor?: import('@clerk/shared/types').ClerkUiConstructor;
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/test/mock-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,8 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepVitestMocked<LoadedCle
});

mockProp(clerkAny, 'navigate');
mockProp(clerkAny, 'setActive');
mockProp(clerkAny, 'selectSession');
mockProp(clerkAny, 'selectOrganization');
mockProp(clerkAny, 'redirectWithAuth');
mockProp(clerkAny, '__internal_navigateWithError');
return clerkAny as DeepVitestMocked<LoadedClerk>;
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type { OAuthStrategy, SetActive, SignInResource, SignUpResource } from '@clerk/shared/types';
import type { OAuthStrategy, SelectSessionHook, SignInResource, SignUpResource } from '@clerk/shared/types';
import * as AuthSession from 'expo-auth-session';
import * as WebBrowser from 'expo-web-browser';

Expand All@@ -18,7 +18,7 @@ export type StartOAuthFlowParams = {

export type StartOAuthFlowReturnType = {
createdSessionId: string;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
authSessionResult?: WebBrowser.WebBrowserAuthSessionResult;
Expand All@@ -33,7 +33,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
Expand All@@ -42,7 +42,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
createdSessionId: '',
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -79,7 +79,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId: '',
setActive,
selectSession,
signIn,
signUp,
};
Expand DownExpand Up@@ -108,7 +108,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId,
setActive,
selectSession,
signIn,
signUp,
};
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useSSO.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SelectSessionHook,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
Expand All@@ -28,13 +28,13 @@ export type StartSSOFlowParams = {
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
Expand All@@ -44,7 +44,7 @@ export function useSSO() {
authSessionResult: null,
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -81,7 +81,7 @@ export function useSSO() {
if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand All@@ -102,7 +102,7 @@ export function useSSO() {

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand Down
Loading
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
Closed
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
92 changes: 92 additions & 0 deletions .changeset/split-setactive-into-select-methods.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
---
'@clerk/clerk-js': major
'@clerk/shared': major
'@clerk/react': major
'@clerk/nextjs': major
'@clerk/vue': major
'@clerk/expo': major
'@clerk/ui': major
'@clerk/testing': major
---

Replace `setActive` with purpose-specific methods: `selectSession` and `selectOrganization`

## Breaking Changes

### `setActive` Removed from Public API

The `setActive` method has been removed from the Clerk object and all hooks. Use the new purpose-specific methods instead:

- `clerk.selectSession(session, options?)` - For session selection
- `clerk.selectOrganization(organization, options?)` - For organization selection

### Hook Return Types

The following hooks no longer return `setActive`:

- `useSignIn()` - now returns `selectSession` instead of `setActive`
- `useSignUp()` - now returns `selectSession` instead of `setActive`
- `useSessionList()` - now returns `selectSession` instead of `setActive`
- `useOrganizationList()` - now returns `selectOrganization` instead of `setActive`

### Migration

**Before:**
```tsx
const { setActive } = useSignIn();
await setActive({ session: createdSessionId });

const { setActive } = useOrganizationList();
await setActive({ organization: org });
```

**After:**
```tsx
const { selectSession } = useSignIn();
await selectSession(createdSessionId);

const { selectOrganization } = useOrganizationList();
await selectOrganization(org);
```

### New Methods on Clerk Object

Two new methods are available on the Clerk object:

- `clerk.selectSession(session, options?)` - For session selection (sign-in, sign-up, multi-session switching)
- `clerk.selectOrganization(organization, options?)` - For organization selection (org switching, personal workspace)

### Options

Both methods accept an options object:

```tsx
// selectSession options
await selectSession(session, {
redirectUrl?: string;
navigate?: ({ session }) => void | Promise<void>;
});

// selectOrganization options
await selectOrganization(organization, {
redirectUrl?: string;
navigate?: ({ session, organization }) => void | Promise<void>;
});
```

### Expo Hooks

The `StartGoogleAuthenticationFlowReturnType` and `StartAppleAuthenticationFlowReturnType` types now return `selectSession` instead of `setActive`.

### Internal Window Hooks (Next.js)

The internal window hooks have been renamed:
- `__internal_onBeforeSetActive` → `__internal_onBeforeSelectSession`
- `__internal_onAfterSetActive` → `__internal_onAfterSelectSession`

### Types Removed

The following types have been removed from the public API:
- `SetActive`
- `SetActiveParams`
- `SetActiveNavigate` (use `SelectSessionNavigate` instead)
97 changes: 84 additions & 13 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,8 @@ import type {
RedirectOptions,
Resources,
SDKMetadata,
SelectOrganizationOptions,
SelectSessionOptions,
SessionResource,
SetActiveParams,
SignedInSessionResource,
Expand DownExpand Up@@ -297,7 +299,7 @@ export class Clerk implements ClerkInterface {
public __internal_isWebAuthnAutofillSupported: (() => Promise<boolean>) | undefined;
public __internal_isWebAuthnPlatformAuthenticatorSupported: (() => Promise<boolean>) | undefined;

public __internal_setActiveInProgress = false;
public __internal_selectSessionInProgress = false;

get publishableKey(): string {
return this.#publishableKey;
Expand DownExpand Up@@ -583,13 +585,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

const opts = callbackOrOptions && typeof callbackOrOptions === 'object' ? callbackOrOptions : options || {};
Expand DownExpand Up@@ -1446,7 +1448,7 @@ export class Clerk implements ClerkInterface {
public setActive = async (params: SetActiveParams): Promise<void> => {
const { organization, redirectUrl, navigate: setActiveNavigate } = params;
let { session } = params;
this.__internal_setActiveInProgress = true;
this.__internal_selectSessionInProgress = true;
debugLogger.debug(
'setActive() start',
{
Expand DownExpand Up@@ -1476,13 +1478,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

let newSession = session === undefined ? this.session : session;
Expand DownExpand Up@@ -1605,10 +1607,79 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
}
} finally {
this.__internal_setActiveInProgress = false;
this.__internal_selectSessionInProgress = false;
}
};

/**
* Select a session to make active.
*
* Use this method after sign-in or sign-up to activate the created session,
* or to switch between sessions in a multi-session application.
*
* Pass `null` to sign out and clear the active session.
*/
public selectSession = async (
session: SignedInSessionResource | string | null,
options?: SelectSessionOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session: s }: { session: SessionResource }) => {
const result = await navigate({ session: s });
if (typeof result === 'string') {
await this.navigate(result);
}
}
: undefined;

return this.setActive({
session,
navigate: setActiveNavigate,
redirectUrl,
});
};

/**
* Select an organization to make active within the current session.
*
* Use this method to switch between organizations or to select a personal workspace.
*
* Pass `null` to switch to the personal workspace (no active organization).
*/
public selectOrganization = async (
organization: OrganizationResource | string | null,
options?: SelectOrganizationOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session }: { session: SessionResource }) => {
// Resolve the organization for the callback
const org =
organization === null
? null
: typeof organization === 'string'
? (this.organization ?? null)
: organization;

const result = await navigate({ session, organization: org });
if (typeof result === 'string') {
await this.navigate(result);
}
}
Comment on lines +1658 to +1673

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the selected organization when invoking navigate.

When organization is a string, the callback receives this.organization (the current org), not the newly selected one. This can route to the wrong org or personal workspace. Resolve the organization from the session being activated (e.g., via session.lastActiveOrganizationId or memberships) before calling navigate.

🛠️ Proposed fix
- const org =- organization === null- ? null- : typeof organization === 'string'- ? (this.organization ?? null)- : organization;+ const org =+ organization === null+ ? null+ : typeof organization === 'string'+ ? session.user.organizationMemberships.find(+ mem => mem.organization.id === session.lastActiveOrganizationId,+ )?.organization ?? null+ : organization;
🤖 Prompt for AI Agents
In `@packages/clerk-js/src/core/clerk.ts` around lines 1658 - 1673, The
setActiveNavigate wrapper currently uses this.organization when the external
`organization` config is a string, which can be stale; instead resolve the
selected org from the activating session before calling `navigate`. In the async
function `setActiveNavigate` (wrapping `navigate` and using `SessionResource`),
if `organization === null` pass null; if `typeof organization === 'string'`
derive the org from the provided `session` (prefer
`session.lastActiveOrganizationId` or fall back to finding a membership with
matching organization id in `session.memberships`) and pass that resolved
id/object to `navigate`; otherwise pass the `organization` object directly.
Update the resolution logic in `setActiveNavigate` to use
`session.lastActiveOrganizationId`/`session.memberships` instead of
`this.organization` before invoking `navigate` and handling string return values
with `this.navigate`.

: undefined;

return this.setActive({
organization,
navigate: setActiveNavigate,
redirectUrl,
});
};

public addListener = (listener: ListenerCallback): UnsubscribeCallback => {
listener = memoizeListenerCallback(listener);
this.#listeners.push(listener);
Expand DownExpand Up@@ -2596,8 +2667,8 @@ export class Clerk implements ClerkInterface {
const hasTransitionedToPendingStatus = this.session.status === 'active' && session?.status === 'pending';
if (hasTransitionedToPendingStatus) {
const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

// Execute hooks to update server authentication context and trigger
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,7 +204,7 @@ export class CheckoutFlow implements CheckoutFlowResourceNonStrict {
throw new Error('Clerk: `confirm()` must be called before `finalize()`');
}

await BillingCheckout.clerk.setActive({ session: BillingCheckout.clerk.session?.id, navigate });
await BillingCheckout.clerk.selectSession(BillingCheckout.clerk.session?.id ?? null, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1243,7 +1243,7 @@ class SignInFuture implements SignInFutureResource {
}

this.#hasBeenFinalized = true;
await SignIn.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignIn.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,7 +972,7 @@ class SignUpFuture implements SignUpFutureResource {
}

this.#hasBeenFinalized = true;
await SignUp.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignUp.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,8 @@ const __BUILD_VARIANT_CHANNEL__: boolean;
const __BUILD_VARIANT_CHIPS__: boolean;

interface Window {
__internal_onBeforeSetActive: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSetActive: () => Promise<void> | void;
__internal_onBeforeSelectSession: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSelectSession: () => Promise<void> | void;
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
__internal_ClerkUiCtor?: import('@clerk/shared/types').ClerkUiConstructor;
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/test/mock-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,8 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepVitestMocked<LoadedCle
});

mockProp(clerkAny, 'navigate');
mockProp(clerkAny, 'setActive');
mockProp(clerkAny, 'selectSession');
mockProp(clerkAny, 'selectOrganization');
mockProp(clerkAny, 'redirectWithAuth');
mockProp(clerkAny, '__internal_navigateWithError');
return clerkAny as DeepVitestMocked<LoadedClerk>;
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type { OAuthStrategy, SetActive, SignInResource, SignUpResource } from '@clerk/shared/types';
import type { OAuthStrategy, SelectSessionHook, SignInResource, SignUpResource } from '@clerk/shared/types';
import * as AuthSession from 'expo-auth-session';
import * as WebBrowser from 'expo-web-browser';

Expand All@@ -18,7 +18,7 @@ export type StartOAuthFlowParams = {

export type StartOAuthFlowReturnType = {
createdSessionId: string;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
authSessionResult?: WebBrowser.WebBrowserAuthSessionResult;
Expand All@@ -33,7 +33,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
Expand All@@ -42,7 +42,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
createdSessionId: '',
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -79,7 +79,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId: '',
setActive,
selectSession,
signIn,
signUp,
};
Expand DownExpand Up@@ -108,7 +108,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId,
setActive,
selectSession,
signIn,
signUp,
};
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useSSO.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SelectSessionHook,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
Expand All@@ -28,13 +28,13 @@ export type StartSSOFlowParams = {
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
Expand All@@ -44,7 +44,7 @@ export function useSSO() {
authSessionResult: null,
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -81,7 +81,7 @@ export function useSSO() {
if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand All@@ -102,7 +102,7 @@ export function useSSO() {

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand Down
Loading
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 > 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
Closed
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
92 changes: 92 additions & 0 deletions .changeset/split-setactive-into-select-methods.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
---
'@clerk/clerk-js': major
'@clerk/shared': major
'@clerk/react': major
'@clerk/nextjs': major
'@clerk/vue': major
'@clerk/expo': major
'@clerk/ui': major
'@clerk/testing': major
---

Replace `setActive` with purpose-specific methods: `selectSession` and `selectOrganization`

## Breaking Changes

### `setActive` Removed from Public API

The `setActive` method has been removed from the Clerk object and all hooks. Use the new purpose-specific methods instead:

- `clerk.selectSession(session, options?)` - For session selection
- `clerk.selectOrganization(organization, options?)` - For organization selection

### Hook Return Types

The following hooks no longer return `setActive`:

- `useSignIn()` - now returns `selectSession` instead of `setActive`
- `useSignUp()` - now returns `selectSession` instead of `setActive`
- `useSessionList()` - now returns `selectSession` instead of `setActive`
- `useOrganizationList()` - now returns `selectOrganization` instead of `setActive`

### Migration

**Before:**
```tsx
const { setActive } = useSignIn();
await setActive({ session: createdSessionId });

const { setActive } = useOrganizationList();
await setActive({ organization: org });
```

**After:**
```tsx
const { selectSession } = useSignIn();
await selectSession(createdSessionId);

const { selectOrganization } = useOrganizationList();
await selectOrganization(org);
```

### New Methods on Clerk Object

Two new methods are available on the Clerk object:

- `clerk.selectSession(session, options?)` - For session selection (sign-in, sign-up, multi-session switching)
- `clerk.selectOrganization(organization, options?)` - For organization selection (org switching, personal workspace)

### Options

Both methods accept an options object:

```tsx
// selectSession options
await selectSession(session, {
redirectUrl?: string;
navigate?: ({ session }) => void | Promise<void>;
});

// selectOrganization options
await selectOrganization(organization, {
redirectUrl?: string;
navigate?: ({ session, organization }) => void | Promise<void>;
});
```

### Expo Hooks

The `StartGoogleAuthenticationFlowReturnType` and `StartAppleAuthenticationFlowReturnType` types now return `selectSession` instead of `setActive`.

### Internal Window Hooks (Next.js)

The internal window hooks have been renamed:
- `__internal_onBeforeSetActive` → `__internal_onBeforeSelectSession`
- `__internal_onAfterSetActive` → `__internal_onAfterSelectSession`

### Types Removed

The following types have been removed from the public API:
- `SetActive`
- `SetActiveParams`
- `SetActiveNavigate` (use `SelectSessionNavigate` instead)
97 changes: 84 additions & 13 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,8 @@ import type {
RedirectOptions,
Resources,
SDKMetadata,
SelectOrganizationOptions,
SelectSessionOptions,
SessionResource,
SetActiveParams,
SignedInSessionResource,
Expand DownExpand Up@@ -297,7 +299,7 @@ export class Clerk implements ClerkInterface {
public __internal_isWebAuthnAutofillSupported: (() => Promise<boolean>) | undefined;
public __internal_isWebAuthnPlatformAuthenticatorSupported: (() => Promise<boolean>) | undefined;

public __internal_setActiveInProgress = false;
public __internal_selectSessionInProgress = false;

get publishableKey(): string {
return this.#publishableKey;
Expand DownExpand Up@@ -583,13 +585,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

const opts = callbackOrOptions && typeof callbackOrOptions === 'object' ? callbackOrOptions : options || {};
Expand DownExpand Up@@ -1446,7 +1448,7 @@ export class Clerk implements ClerkInterface {
public setActive = async (params: SetActiveParams): Promise<void> => {
const { organization, redirectUrl, navigate: setActiveNavigate } = params;
let { session } = params;
this.__internal_setActiveInProgress = true;
this.__internal_selectSessionInProgress = true;
debugLogger.debug(
'setActive() start',
{
Expand DownExpand Up@@ -1476,13 +1478,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

let newSession = session === undefined ? this.session : session;
Expand DownExpand Up@@ -1605,10 +1607,79 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
}
} finally {
this.__internal_setActiveInProgress = false;
this.__internal_selectSessionInProgress = false;
}
};

/**
* Select a session to make active.
*
* Use this method after sign-in or sign-up to activate the created session,
* or to switch between sessions in a multi-session application.
*
* Pass `null` to sign out and clear the active session.
*/
public selectSession = async (
session: SignedInSessionResource | string | null,
options?: SelectSessionOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session: s }: { session: SessionResource }) => {
const result = await navigate({ session: s });
if (typeof result === 'string') {
await this.navigate(result);
}
}
: undefined;

return this.setActive({
session,
navigate: setActiveNavigate,
redirectUrl,
});
};

/**
* Select an organization to make active within the current session.
*
* Use this method to switch between organizations or to select a personal workspace.
*
* Pass `null` to switch to the personal workspace (no active organization).
*/
public selectOrganization = async (
organization: OrganizationResource | string | null,
options?: SelectOrganizationOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session }: { session: SessionResource }) => {
// Resolve the organization for the callback
const org =
organization === null
? null
: typeof organization === 'string'
? (this.organization ?? null)
: organization;

const result = await navigate({ session, organization: org });
if (typeof result === 'string') {
await this.navigate(result);
}
}
Comment on lines +1658 to +1673

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the selected organization when invoking navigate.

When organization is a string, the callback receives this.organization (the current org), not the newly selected one. This can route to the wrong org or personal workspace. Resolve the organization from the session being activated (e.g., via session.lastActiveOrganizationId or memberships) before calling navigate.

🛠️ Proposed fix
- const org =- organization === null- ? null- : typeof organization === 'string'- ? (this.organization ?? null)- : organization;+ const org =+ organization === null+ ? null+ : typeof organization === 'string'+ ? session.user.organizationMemberships.find(+ mem => mem.organization.id === session.lastActiveOrganizationId,+ )?.organization ?? null+ : organization;
🤖 Prompt for AI Agents
In `@packages/clerk-js/src/core/clerk.ts` around lines 1658 - 1673, The
setActiveNavigate wrapper currently uses this.organization when the external
`organization` config is a string, which can be stale; instead resolve the
selected org from the activating session before calling `navigate`. In the async
function `setActiveNavigate` (wrapping `navigate` and using `SessionResource`),
if `organization === null` pass null; if `typeof organization === 'string'`
derive the org from the provided `session` (prefer
`session.lastActiveOrganizationId` or fall back to finding a membership with
matching organization id in `session.memberships`) and pass that resolved
id/object to `navigate`; otherwise pass the `organization` object directly.
Update the resolution logic in `setActiveNavigate` to use
`session.lastActiveOrganizationId`/`session.memberships` instead of
`this.organization` before invoking `navigate` and handling string return values
with `this.navigate`.

: undefined;

return this.setActive({
organization,
navigate: setActiveNavigate,
redirectUrl,
});
};

public addListener = (listener: ListenerCallback): UnsubscribeCallback => {
listener = memoizeListenerCallback(listener);
this.#listeners.push(listener);
Expand DownExpand Up@@ -2596,8 +2667,8 @@ export class Clerk implements ClerkInterface {
const hasTransitionedToPendingStatus = this.session.status === 'active' && session?.status === 'pending';
if (hasTransitionedToPendingStatus) {
const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

// Execute hooks to update server authentication context and trigger
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,7 +204,7 @@ export class CheckoutFlow implements CheckoutFlowResourceNonStrict {
throw new Error('Clerk: `confirm()` must be called before `finalize()`');
}

await BillingCheckout.clerk.setActive({ session: BillingCheckout.clerk.session?.id, navigate });
await BillingCheckout.clerk.selectSession(BillingCheckout.clerk.session?.id ?? null, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1243,7 +1243,7 @@ class SignInFuture implements SignInFutureResource {
}

this.#hasBeenFinalized = true;
await SignIn.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignIn.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,7 +972,7 @@ class SignUpFuture implements SignUpFutureResource {
}

this.#hasBeenFinalized = true;
await SignUp.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignUp.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,8 @@ const __BUILD_VARIANT_CHANNEL__: boolean;
const __BUILD_VARIANT_CHIPS__: boolean;

interface Window {
__internal_onBeforeSetActive: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSetActive: () => Promise<void> | void;
__internal_onBeforeSelectSession: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSelectSession: () => Promise<void> | void;
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
__internal_ClerkUiCtor?: import('@clerk/shared/types').ClerkUiConstructor;
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/test/mock-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,8 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepVitestMocked<LoadedCle
});

mockProp(clerkAny, 'navigate');
mockProp(clerkAny, 'setActive');
mockProp(clerkAny, 'selectSession');
mockProp(clerkAny, 'selectOrganization');
mockProp(clerkAny, 'redirectWithAuth');
mockProp(clerkAny, '__internal_navigateWithError');
return clerkAny as DeepVitestMocked<LoadedClerk>;
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type { OAuthStrategy, SetActive, SignInResource, SignUpResource } from '@clerk/shared/types';
import type { OAuthStrategy, SelectSessionHook, SignInResource, SignUpResource } from '@clerk/shared/types';
import * as AuthSession from 'expo-auth-session';
import * as WebBrowser from 'expo-web-browser';

Expand All@@ -18,7 +18,7 @@ export type StartOAuthFlowParams = {

export type StartOAuthFlowReturnType = {
createdSessionId: string;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
authSessionResult?: WebBrowser.WebBrowserAuthSessionResult;
Expand All@@ -33,7 +33,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
Expand All@@ -42,7 +42,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
createdSessionId: '',
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -79,7 +79,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId: '',
setActive,
selectSession,
signIn,
signUp,
};
Expand DownExpand Up@@ -108,7 +108,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId,
setActive,
selectSession,
signIn,
signUp,
};
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useSSO.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SelectSessionHook,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
Expand All@@ -28,13 +28,13 @@ export type StartSSOFlowParams = {
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
Expand All@@ -44,7 +44,7 @@ export function useSSO() {
authSessionResult: null,
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -81,7 +81,7 @@ export function useSSO() {
if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand All@@ -102,7 +102,7 @@ export function useSSO() {

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand Down
Loading
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
Closed
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
92 changes: 92 additions & 0 deletions .changeset/split-setactive-into-select-methods.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
---
'@clerk/clerk-js': major
'@clerk/shared': major
'@clerk/react': major
'@clerk/nextjs': major
'@clerk/vue': major
'@clerk/expo': major
'@clerk/ui': major
'@clerk/testing': major
---

Replace `setActive` with purpose-specific methods: `selectSession` and `selectOrganization`

## Breaking Changes

### `setActive` Removed from Public API

The `setActive` method has been removed from the Clerk object and all hooks. Use the new purpose-specific methods instead:

- `clerk.selectSession(session, options?)` - For session selection
- `clerk.selectOrganization(organization, options?)` - For organization selection

### Hook Return Types

The following hooks no longer return `setActive`:

- `useSignIn()` - now returns `selectSession` instead of `setActive`
- `useSignUp()` - now returns `selectSession` instead of `setActive`
- `useSessionList()` - now returns `selectSession` instead of `setActive`
- `useOrganizationList()` - now returns `selectOrganization` instead of `setActive`

### Migration

**Before:**
```tsx
const { setActive } = useSignIn();
await setActive({ session: createdSessionId });

const { setActive } = useOrganizationList();
await setActive({ organization: org });
```

**After:**
```tsx
const { selectSession } = useSignIn();
await selectSession(createdSessionId);

const { selectOrganization } = useOrganizationList();
await selectOrganization(org);
```

### New Methods on Clerk Object

Two new methods are available on the Clerk object:

- `clerk.selectSession(session, options?)` - For session selection (sign-in, sign-up, multi-session switching)
- `clerk.selectOrganization(organization, options?)` - For organization selection (org switching, personal workspace)

### Options

Both methods accept an options object:

```tsx
// selectSession options
await selectSession(session, {
redirectUrl?: string;
navigate?: ({ session }) => void | Promise<void>;
});

// selectOrganization options
await selectOrganization(organization, {
redirectUrl?: string;
navigate?: ({ session, organization }) => void | Promise<void>;
});
```

### Expo Hooks

The `StartGoogleAuthenticationFlowReturnType` and `StartAppleAuthenticationFlowReturnType` types now return `selectSession` instead of `setActive`.

### Internal Window Hooks (Next.js)

The internal window hooks have been renamed:
- `__internal_onBeforeSetActive` → `__internal_onBeforeSelectSession`
- `__internal_onAfterSetActive` → `__internal_onAfterSelectSession`

### Types Removed

The following types have been removed from the public API:
- `SetActive`
- `SetActiveParams`
- `SetActiveNavigate` (use `SelectSessionNavigate` instead)
97 changes: 84 additions & 13 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,8 @@ import type {
RedirectOptions,
Resources,
SDKMetadata,
SelectOrganizationOptions,
SelectSessionOptions,
SessionResource,
SetActiveParams,
SignedInSessionResource,
Expand DownExpand Up@@ -297,7 +299,7 @@ export class Clerk implements ClerkInterface {
public __internal_isWebAuthnAutofillSupported: (() => Promise<boolean>) | undefined;
public __internal_isWebAuthnPlatformAuthenticatorSupported: (() => Promise<boolean>) | undefined;

public __internal_setActiveInProgress = false;
public __internal_selectSessionInProgress = false;

get publishableKey(): string {
return this.#publishableKey;
Expand DownExpand Up@@ -583,13 +585,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

const opts = callbackOrOptions && typeof callbackOrOptions === 'object' ? callbackOrOptions : options || {};
Expand DownExpand Up@@ -1446,7 +1448,7 @@ export class Clerk implements ClerkInterface {
public setActive = async (params: SetActiveParams): Promise<void> => {
const { organization, redirectUrl, navigate: setActiveNavigate } = params;
let { session } = params;
this.__internal_setActiveInProgress = true;
this.__internal_selectSessionInProgress = true;
debugLogger.debug(
'setActive() start',
{
Expand DownExpand Up@@ -1476,13 +1478,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

let newSession = session === undefined ? this.session : session;
Expand DownExpand Up@@ -1605,10 +1607,79 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
}
} finally {
this.__internal_setActiveInProgress = false;
this.__internal_selectSessionInProgress = false;
}
};

/**
* Select a session to make active.
*
* Use this method after sign-in or sign-up to activate the created session,
* or to switch between sessions in a multi-session application.
*
* Pass `null` to sign out and clear the active session.
*/
public selectSession = async (
session: SignedInSessionResource | string | null,
options?: SelectSessionOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session: s }: { session: SessionResource }) => {
const result = await navigate({ session: s });
if (typeof result === 'string') {
await this.navigate(result);
}
}
: undefined;

return this.setActive({
session,
navigate: setActiveNavigate,
redirectUrl,
});
};

/**
* Select an organization to make active within the current session.
*
* Use this method to switch between organizations or to select a personal workspace.
*
* Pass `null` to switch to the personal workspace (no active organization).
*/
public selectOrganization = async (
organization: OrganizationResource | string | null,
options?: SelectOrganizationOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session }: { session: SessionResource }) => {
// Resolve the organization for the callback
const org =
organization === null
? null
: typeof organization === 'string'
? (this.organization ?? null)
: organization;

const result = await navigate({ session, organization: org });
if (typeof result === 'string') {
await this.navigate(result);
}
}
Comment on lines +1658 to +1673

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the selected organization when invoking navigate.

When organization is a string, the callback receives this.organization (the current org), not the newly selected one. This can route to the wrong org or personal workspace. Resolve the organization from the session being activated (e.g., via session.lastActiveOrganizationId or memberships) before calling navigate.

🛠️ Proposed fix
- const org =- organization === null- ? null- : typeof organization === 'string'- ? (this.organization ?? null)- : organization;+ const org =+ organization === null+ ? null+ : typeof organization === 'string'+ ? session.user.organizationMemberships.find(+ mem => mem.organization.id === session.lastActiveOrganizationId,+ )?.organization ?? null+ : organization;
🤖 Prompt for AI Agents
In `@packages/clerk-js/src/core/clerk.ts` around lines 1658 - 1673, The
setActiveNavigate wrapper currently uses this.organization when the external
`organization` config is a string, which can be stale; instead resolve the
selected org from the activating session before calling `navigate`. In the async
function `setActiveNavigate` (wrapping `navigate` and using `SessionResource`),
if `organization === null` pass null; if `typeof organization === 'string'`
derive the org from the provided `session` (prefer
`session.lastActiveOrganizationId` or fall back to finding a membership with
matching organization id in `session.memberships`) and pass that resolved
id/object to `navigate`; otherwise pass the `organization` object directly.
Update the resolution logic in `setActiveNavigate` to use
`session.lastActiveOrganizationId`/`session.memberships` instead of
`this.organization` before invoking `navigate` and handling string return values
with `this.navigate`.

: undefined;

return this.setActive({
organization,
navigate: setActiveNavigate,
redirectUrl,
});
};

public addListener = (listener: ListenerCallback): UnsubscribeCallback => {
listener = memoizeListenerCallback(listener);
this.#listeners.push(listener);
Expand DownExpand Up@@ -2596,8 +2667,8 @@ export class Clerk implements ClerkInterface {
const hasTransitionedToPendingStatus = this.session.status === 'active' && session?.status === 'pending';
if (hasTransitionedToPendingStatus) {
const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

// Execute hooks to update server authentication context and trigger
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,7 +204,7 @@ export class CheckoutFlow implements CheckoutFlowResourceNonStrict {
throw new Error('Clerk: `confirm()` must be called before `finalize()`');
}

await BillingCheckout.clerk.setActive({ session: BillingCheckout.clerk.session?.id, navigate });
await BillingCheckout.clerk.selectSession(BillingCheckout.clerk.session?.id ?? null, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1243,7 +1243,7 @@ class SignInFuture implements SignInFutureResource {
}

this.#hasBeenFinalized = true;
await SignIn.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignIn.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,7 +972,7 @@ class SignUpFuture implements SignUpFutureResource {
}

this.#hasBeenFinalized = true;
await SignUp.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignUp.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,8 @@ const __BUILD_VARIANT_CHANNEL__: boolean;
const __BUILD_VARIANT_CHIPS__: boolean;

interface Window {
__internal_onBeforeSetActive: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSetActive: () => Promise<void> | void;
__internal_onBeforeSelectSession: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSelectSession: () => Promise<void> | void;
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
__internal_ClerkUiCtor?: import('@clerk/shared/types').ClerkUiConstructor;
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/test/mock-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,8 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepVitestMocked<LoadedCle
});

mockProp(clerkAny, 'navigate');
mockProp(clerkAny, 'setActive');
mockProp(clerkAny, 'selectSession');
mockProp(clerkAny, 'selectOrganization');
mockProp(clerkAny, 'redirectWithAuth');
mockProp(clerkAny, '__internal_navigateWithError');
return clerkAny as DeepVitestMocked<LoadedClerk>;
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type { OAuthStrategy, SetActive, SignInResource, SignUpResource } from '@clerk/shared/types';
import type { OAuthStrategy, SelectSessionHook, SignInResource, SignUpResource } from '@clerk/shared/types';
import * as AuthSession from 'expo-auth-session';
import * as WebBrowser from 'expo-web-browser';

Expand All@@ -18,7 +18,7 @@ export type StartOAuthFlowParams = {

export type StartOAuthFlowReturnType = {
createdSessionId: string;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
authSessionResult?: WebBrowser.WebBrowserAuthSessionResult;
Expand All@@ -33,7 +33,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
Expand All@@ -42,7 +42,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
createdSessionId: '',
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -79,7 +79,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId: '',
setActive,
selectSession,
signIn,
signUp,
};
Expand DownExpand Up@@ -108,7 +108,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId,
setActive,
selectSession,
signIn,
signUp,
};
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useSSO.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SelectSessionHook,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
Expand All@@ -28,13 +28,13 @@ export type StartSSOFlowParams = {
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
Expand All@@ -44,7 +44,7 @@ export function useSSO() {
authSessionResult: null,
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -81,7 +81,7 @@ export function useSSO() {
if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand All@@ -102,7 +102,7 @@ export function useSSO() {

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand Down
Loading
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
Closed
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
92 changes: 92 additions & 0 deletions .changeset/split-setactive-into-select-methods.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
---
'@clerk/clerk-js': major
'@clerk/shared': major
'@clerk/react': major
'@clerk/nextjs': major
'@clerk/vue': major
'@clerk/expo': major
'@clerk/ui': major
'@clerk/testing': major
---

Replace `setActive` with purpose-specific methods: `selectSession` and `selectOrganization`

## Breaking Changes

### `setActive` Removed from Public API

The `setActive` method has been removed from the Clerk object and all hooks. Use the new purpose-specific methods instead:

- `clerk.selectSession(session, options?)` - For session selection
- `clerk.selectOrganization(organization, options?)` - For organization selection

### Hook Return Types

The following hooks no longer return `setActive`:

- `useSignIn()` - now returns `selectSession` instead of `setActive`
- `useSignUp()` - now returns `selectSession` instead of `setActive`
- `useSessionList()` - now returns `selectSession` instead of `setActive`
- `useOrganizationList()` - now returns `selectOrganization` instead of `setActive`

### Migration

**Before:**
```tsx
const { setActive } = useSignIn();
await setActive({ session: createdSessionId });

const { setActive } = useOrganizationList();
await setActive({ organization: org });
```

**After:**
```tsx
const { selectSession } = useSignIn();
await selectSession(createdSessionId);

const { selectOrganization } = useOrganizationList();
await selectOrganization(org);
```

### New Methods on Clerk Object

Two new methods are available on the Clerk object:

- `clerk.selectSession(session, options?)` - For session selection (sign-in, sign-up, multi-session switching)
- `clerk.selectOrganization(organization, options?)` - For organization selection (org switching, personal workspace)

### Options

Both methods accept an options object:

```tsx
// selectSession options
await selectSession(session, {
redirectUrl?: string;
navigate?: ({ session }) => void | Promise<void>;
});

// selectOrganization options
await selectOrganization(organization, {
redirectUrl?: string;
navigate?: ({ session, organization }) => void | Promise<void>;
});
```

### Expo Hooks

The `StartGoogleAuthenticationFlowReturnType` and `StartAppleAuthenticationFlowReturnType` types now return `selectSession` instead of `setActive`.

### Internal Window Hooks (Next.js)

The internal window hooks have been renamed:
- `__internal_onBeforeSetActive` → `__internal_onBeforeSelectSession`
- `__internal_onAfterSetActive` → `__internal_onAfterSelectSession`

### Types Removed

The following types have been removed from the public API:
- `SetActive`
- `SetActiveParams`
- `SetActiveNavigate` (use `SelectSessionNavigate` instead)
97 changes: 84 additions & 13 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,8 @@ import type {
RedirectOptions,
Resources,
SDKMetadata,
SelectOrganizationOptions,
SelectSessionOptions,
SessionResource,
SetActiveParams,
SignedInSessionResource,
Expand DownExpand Up@@ -297,7 +299,7 @@ export class Clerk implements ClerkInterface {
public __internal_isWebAuthnAutofillSupported: (() => Promise<boolean>) | undefined;
public __internal_isWebAuthnPlatformAuthenticatorSupported: (() => Promise<boolean>) | undefined;

public __internal_setActiveInProgress = false;
public __internal_selectSessionInProgress = false;

get publishableKey(): string {
return this.#publishableKey;
Expand DownExpand Up@@ -583,13 +585,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

const opts = callbackOrOptions && typeof callbackOrOptions === 'object' ? callbackOrOptions : options || {};
Expand DownExpand Up@@ -1446,7 +1448,7 @@ export class Clerk implements ClerkInterface {
public setActive = async (params: SetActiveParams): Promise<void> => {
const { organization, redirectUrl, navigate: setActiveNavigate } = params;
let { session } = params;
this.__internal_setActiveInProgress = true;
this.__internal_selectSessionInProgress = true;
debugLogger.debug(
'setActive() start',
{
Expand DownExpand Up@@ -1476,13 +1478,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

let newSession = session === undefined ? this.session : session;
Expand DownExpand Up@@ -1605,10 +1607,79 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
}
} finally {
this.__internal_setActiveInProgress = false;
this.__internal_selectSessionInProgress = false;
}
};

/**
* Select a session to make active.
*
* Use this method after sign-in or sign-up to activate the created session,
* or to switch between sessions in a multi-session application.
*
* Pass `null` to sign out and clear the active session.
*/
public selectSession = async (
session: SignedInSessionResource | string | null,
options?: SelectSessionOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session: s }: { session: SessionResource }) => {
const result = await navigate({ session: s });
if (typeof result === 'string') {
await this.navigate(result);
}
}
: undefined;

return this.setActive({
session,
navigate: setActiveNavigate,
redirectUrl,
});
};

/**
* Select an organization to make active within the current session.
*
* Use this method to switch between organizations or to select a personal workspace.
*
* Pass `null` to switch to the personal workspace (no active organization).
*/
public selectOrganization = async (
organization: OrganizationResource | string | null,
options?: SelectOrganizationOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session }: { session: SessionResource }) => {
// Resolve the organization for the callback
const org =
organization === null
? null
: typeof organization === 'string'
? (this.organization ?? null)
: organization;

const result = await navigate({ session, organization: org });
if (typeof result === 'string') {
await this.navigate(result);
}
}
Comment on lines +1658 to +1673

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the selected organization when invoking navigate.

When organization is a string, the callback receives this.organization (the current org), not the newly selected one. This can route to the wrong org or personal workspace. Resolve the organization from the session being activated (e.g., via session.lastActiveOrganizationId or memberships) before calling navigate.

🛠️ Proposed fix
- const org =- organization === null- ? null- : typeof organization === 'string'- ? (this.organization ?? null)- : organization;+ const org =+ organization === null+ ? null+ : typeof organization === 'string'+ ? session.user.organizationMemberships.find(+ mem => mem.organization.id === session.lastActiveOrganizationId,+ )?.organization ?? null+ : organization;
🤖 Prompt for AI Agents
In `@packages/clerk-js/src/core/clerk.ts` around lines 1658 - 1673, The
setActiveNavigate wrapper currently uses this.organization when the external
`organization` config is a string, which can be stale; instead resolve the
selected org from the activating session before calling `navigate`. In the async
function `setActiveNavigate` (wrapping `navigate` and using `SessionResource`),
if `organization === null` pass null; if `typeof organization === 'string'`
derive the org from the provided `session` (prefer
`session.lastActiveOrganizationId` or fall back to finding a membership with
matching organization id in `session.memberships`) and pass that resolved
id/object to `navigate`; otherwise pass the `organization` object directly.
Update the resolution logic in `setActiveNavigate` to use
`session.lastActiveOrganizationId`/`session.memberships` instead of
`this.organization` before invoking `navigate` and handling string return values
with `this.navigate`.

: undefined;

return this.setActive({
organization,
navigate: setActiveNavigate,
redirectUrl,
});
};

public addListener = (listener: ListenerCallback): UnsubscribeCallback => {
listener = memoizeListenerCallback(listener);
this.#listeners.push(listener);
Expand DownExpand Up@@ -2596,8 +2667,8 @@ export class Clerk implements ClerkInterface {
const hasTransitionedToPendingStatus = this.session.status === 'active' && session?.status === 'pending';
if (hasTransitionedToPendingStatus) {
const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

// Execute hooks to update server authentication context and trigger
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,7 +204,7 @@ export class CheckoutFlow implements CheckoutFlowResourceNonStrict {
throw new Error('Clerk: `confirm()` must be called before `finalize()`');
}

await BillingCheckout.clerk.setActive({ session: BillingCheckout.clerk.session?.id, navigate });
await BillingCheckout.clerk.selectSession(BillingCheckout.clerk.session?.id ?? null, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1243,7 +1243,7 @@ class SignInFuture implements SignInFutureResource {
}

this.#hasBeenFinalized = true;
await SignIn.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignIn.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,7 +972,7 @@ class SignUpFuture implements SignUpFutureResource {
}

this.#hasBeenFinalized = true;
await SignUp.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignUp.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,8 @@ const __BUILD_VARIANT_CHANNEL__: boolean;
const __BUILD_VARIANT_CHIPS__: boolean;

interface Window {
__internal_onBeforeSetActive: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSetActive: () => Promise<void> | void;
__internal_onBeforeSelectSession: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSelectSession: () => Promise<void> | void;
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
__internal_ClerkUiCtor?: import('@clerk/shared/types').ClerkUiConstructor;
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/test/mock-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,8 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepVitestMocked<LoadedCle
});

mockProp(clerkAny, 'navigate');
mockProp(clerkAny, 'setActive');
mockProp(clerkAny, 'selectSession');
mockProp(clerkAny, 'selectOrganization');
mockProp(clerkAny, 'redirectWithAuth');
mockProp(clerkAny, '__internal_navigateWithError');
return clerkAny as DeepVitestMocked<LoadedClerk>;
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type { OAuthStrategy, SetActive, SignInResource, SignUpResource } from '@clerk/shared/types';
import type { OAuthStrategy, SelectSessionHook, SignInResource, SignUpResource } from '@clerk/shared/types';
import * as AuthSession from 'expo-auth-session';
import * as WebBrowser from 'expo-web-browser';

Expand All@@ -18,7 +18,7 @@ export type StartOAuthFlowParams = {

export type StartOAuthFlowReturnType = {
createdSessionId: string;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
authSessionResult?: WebBrowser.WebBrowserAuthSessionResult;
Expand All@@ -33,7 +33,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
Expand All@@ -42,7 +42,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
createdSessionId: '',
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -79,7 +79,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId: '',
setActive,
selectSession,
signIn,
signUp,
};
Expand DownExpand Up@@ -108,7 +108,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId,
setActive,
selectSession,
signIn,
signUp,
};
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useSSO.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SelectSessionHook,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
Expand All@@ -28,13 +28,13 @@ export type StartSSOFlowParams = {
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
Expand All@@ -44,7 +44,7 @@ export function useSSO() {
authSessionResult: null,
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -81,7 +81,7 @@ export function useSSO() {
if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand All@@ -102,7 +102,7 @@ export function useSSO() {

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand Down
Loading
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
Closed
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
92 changes: 92 additions & 0 deletions .changeset/split-setactive-into-select-methods.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
---
'@clerk/clerk-js': major
'@clerk/shared': major
'@clerk/react': major
'@clerk/nextjs': major
'@clerk/vue': major
'@clerk/expo': major
'@clerk/ui': major
'@clerk/testing': major
---

Replace `setActive` with purpose-specific methods: `selectSession` and `selectOrganization`

## Breaking Changes

### `setActive` Removed from Public API

The `setActive` method has been removed from the Clerk object and all hooks. Use the new purpose-specific methods instead:

- `clerk.selectSession(session, options?)` - For session selection
- `clerk.selectOrganization(organization, options?)` - For organization selection

### Hook Return Types

The following hooks no longer return `setActive`:

- `useSignIn()` - now returns `selectSession` instead of `setActive`
- `useSignUp()` - now returns `selectSession` instead of `setActive`
- `useSessionList()` - now returns `selectSession` instead of `setActive`
- `useOrganizationList()` - now returns `selectOrganization` instead of `setActive`

### Migration

**Before:**
```tsx
const { setActive } = useSignIn();
await setActive({ session: createdSessionId });

const { setActive } = useOrganizationList();
await setActive({ organization: org });
```

**After:**
```tsx
const { selectSession } = useSignIn();
await selectSession(createdSessionId);

const { selectOrganization } = useOrganizationList();
await selectOrganization(org);
```

### New Methods on Clerk Object

Two new methods are available on the Clerk object:

- `clerk.selectSession(session, options?)` - For session selection (sign-in, sign-up, multi-session switching)
- `clerk.selectOrganization(organization, options?)` - For organization selection (org switching, personal workspace)

### Options

Both methods accept an options object:

```tsx
// selectSession options
await selectSession(session, {
redirectUrl?: string;
navigate?: ({ session }) => void | Promise<void>;
});

// selectOrganization options
await selectOrganization(organization, {
redirectUrl?: string;
navigate?: ({ session, organization }) => void | Promise<void>;
});
```

### Expo Hooks

The `StartGoogleAuthenticationFlowReturnType` and `StartAppleAuthenticationFlowReturnType` types now return `selectSession` instead of `setActive`.

### Internal Window Hooks (Next.js)

The internal window hooks have been renamed:
- `__internal_onBeforeSetActive` → `__internal_onBeforeSelectSession`
- `__internal_onAfterSetActive` → `__internal_onAfterSelectSession`

### Types Removed

The following types have been removed from the public API:
- `SetActive`
- `SetActiveParams`
- `SetActiveNavigate` (use `SelectSessionNavigate` instead)
97 changes: 84 additions & 13 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,8 @@ import type {
RedirectOptions,
Resources,
SDKMetadata,
SelectOrganizationOptions,
SelectSessionOptions,
SessionResource,
SetActiveParams,
SignedInSessionResource,
Expand DownExpand Up@@ -297,7 +299,7 @@ export class Clerk implements ClerkInterface {
public __internal_isWebAuthnAutofillSupported: (() => Promise<boolean>) | undefined;
public __internal_isWebAuthnPlatformAuthenticatorSupported: (() => Promise<boolean>) | undefined;

public __internal_setActiveInProgress = false;
public __internal_selectSessionInProgress = false;

get publishableKey(): string {
return this.#publishableKey;
Expand DownExpand Up@@ -583,13 +585,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

const opts = callbackOrOptions && typeof callbackOrOptions === 'object' ? callbackOrOptions : options || {};
Expand DownExpand Up@@ -1446,7 +1448,7 @@ export class Clerk implements ClerkInterface {
public setActive = async (params: SetActiveParams): Promise<void> => {
const { organization, redirectUrl, navigate: setActiveNavigate } = params;
let { session } = params;
this.__internal_setActiveInProgress = true;
this.__internal_selectSessionInProgress = true;
debugLogger.debug(
'setActive() start',
{
Expand DownExpand Up@@ -1476,13 +1478,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

let newSession = session === undefined ? this.session : session;
Expand DownExpand Up@@ -1605,10 +1607,79 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
}
} finally {
this.__internal_setActiveInProgress = false;
this.__internal_selectSessionInProgress = false;
}
};

/**
* Select a session to make active.
*
* Use this method after sign-in or sign-up to activate the created session,
* or to switch between sessions in a multi-session application.
*
* Pass `null` to sign out and clear the active session.
*/
public selectSession = async (
session: SignedInSessionResource | string | null,
options?: SelectSessionOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session: s }: { session: SessionResource }) => {
const result = await navigate({ session: s });
if (typeof result === 'string') {
await this.navigate(result);
}
}
: undefined;

return this.setActive({
session,
navigate: setActiveNavigate,
redirectUrl,
});
};

/**
* Select an organization to make active within the current session.
*
* Use this method to switch between organizations or to select a personal workspace.
*
* Pass `null` to switch to the personal workspace (no active organization).
*/
public selectOrganization = async (
organization: OrganizationResource | string | null,
options?: SelectOrganizationOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session }: { session: SessionResource }) => {
// Resolve the organization for the callback
const org =
organization === null
? null
: typeof organization === 'string'
? (this.organization ?? null)
: organization;

const result = await navigate({ session, organization: org });
if (typeof result === 'string') {
await this.navigate(result);
}
}
Comment on lines +1658 to +1673

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the selected organization when invoking navigate.

When organization is a string, the callback receives this.organization (the current org), not the newly selected one. This can route to the wrong org or personal workspace. Resolve the organization from the session being activated (e.g., via session.lastActiveOrganizationId or memberships) before calling navigate.

🛠️ Proposed fix
- const org =- organization === null- ? null- : typeof organization === 'string'- ? (this.organization ?? null)- : organization;+ const org =+ organization === null+ ? null+ : typeof organization === 'string'+ ? session.user.organizationMemberships.find(+ mem => mem.organization.id === session.lastActiveOrganizationId,+ )?.organization ?? null+ : organization;
🤖 Prompt for AI Agents
In `@packages/clerk-js/src/core/clerk.ts` around lines 1658 - 1673, The
setActiveNavigate wrapper currently uses this.organization when the external
`organization` config is a string, which can be stale; instead resolve the
selected org from the activating session before calling `navigate`. In the async
function `setActiveNavigate` (wrapping `navigate` and using `SessionResource`),
if `organization === null` pass null; if `typeof organization === 'string'`
derive the org from the provided `session` (prefer
`session.lastActiveOrganizationId` or fall back to finding a membership with
matching organization id in `session.memberships`) and pass that resolved
id/object to `navigate`; otherwise pass the `organization` object directly.
Update the resolution logic in `setActiveNavigate` to use
`session.lastActiveOrganizationId`/`session.memberships` instead of
`this.organization` before invoking `navigate` and handling string return values
with `this.navigate`.

: undefined;

return this.setActive({
organization,
navigate: setActiveNavigate,
redirectUrl,
});
};

public addListener = (listener: ListenerCallback): UnsubscribeCallback => {
listener = memoizeListenerCallback(listener);
this.#listeners.push(listener);
Expand DownExpand Up@@ -2596,8 +2667,8 @@ export class Clerk implements ClerkInterface {
const hasTransitionedToPendingStatus = this.session.status === 'active' && session?.status === 'pending';
if (hasTransitionedToPendingStatus) {
const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

// Execute hooks to update server authentication context and trigger
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,7 +204,7 @@ export class CheckoutFlow implements CheckoutFlowResourceNonStrict {
throw new Error('Clerk: `confirm()` must be called before `finalize()`');
}

await BillingCheckout.clerk.setActive({ session: BillingCheckout.clerk.session?.id, navigate });
await BillingCheckout.clerk.selectSession(BillingCheckout.clerk.session?.id ?? null, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1243,7 +1243,7 @@ class SignInFuture implements SignInFutureResource {
}

this.#hasBeenFinalized = true;
await SignIn.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignIn.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,7 +972,7 @@ class SignUpFuture implements SignUpFutureResource {
}

this.#hasBeenFinalized = true;
await SignUp.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignUp.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,8 @@ const __BUILD_VARIANT_CHANNEL__: boolean;
const __BUILD_VARIANT_CHIPS__: boolean;

interface Window {
__internal_onBeforeSetActive: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSetActive: () => Promise<void> | void;
__internal_onBeforeSelectSession: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSelectSession: () => Promise<void> | void;
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
__internal_ClerkUiCtor?: import('@clerk/shared/types').ClerkUiConstructor;
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/test/mock-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,8 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepVitestMocked<LoadedCle
});

mockProp(clerkAny, 'navigate');
mockProp(clerkAny, 'setActive');
mockProp(clerkAny, 'selectSession');
mockProp(clerkAny, 'selectOrganization');
mockProp(clerkAny, 'redirectWithAuth');
mockProp(clerkAny, '__internal_navigateWithError');
return clerkAny as DeepVitestMocked<LoadedClerk>;
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type { OAuthStrategy, SetActive, SignInResource, SignUpResource } from '@clerk/shared/types';
import type { OAuthStrategy, SelectSessionHook, SignInResource, SignUpResource } from '@clerk/shared/types';
import * as AuthSession from 'expo-auth-session';
import * as WebBrowser from 'expo-web-browser';

Expand All@@ -18,7 +18,7 @@ export type StartOAuthFlowParams = {

export type StartOAuthFlowReturnType = {
createdSessionId: string;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
authSessionResult?: WebBrowser.WebBrowserAuthSessionResult;
Expand All@@ -33,7 +33,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
Expand All@@ -42,7 +42,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
createdSessionId: '',
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -79,7 +79,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId: '',
setActive,
selectSession,
signIn,
signUp,
};
Expand DownExpand Up@@ -108,7 +108,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId,
setActive,
selectSession,
signIn,
signUp,
};
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useSSO.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SelectSessionHook,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
Expand All@@ -28,13 +28,13 @@ export type StartSSOFlowParams = {
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
Expand All@@ -44,7 +44,7 @@ export function useSSO() {
authSessionResult: null,
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -81,7 +81,7 @@ export function useSSO() {
if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand All@@ -102,7 +102,7 @@ export function useSSO() {

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand Down
Loading
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
Closed
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
92 changes: 92 additions & 0 deletions .changeset/split-setactive-into-select-methods.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
---
'@clerk/clerk-js': major
'@clerk/shared': major
'@clerk/react': major
'@clerk/nextjs': major
'@clerk/vue': major
'@clerk/expo': major
'@clerk/ui': major
'@clerk/testing': major
---

Replace `setActive` with purpose-specific methods: `selectSession` and `selectOrganization`

## Breaking Changes

### `setActive` Removed from Public API

The `setActive` method has been removed from the Clerk object and all hooks. Use the new purpose-specific methods instead:

- `clerk.selectSession(session, options?)` - For session selection
- `clerk.selectOrganization(organization, options?)` - For organization selection

### Hook Return Types

The following hooks no longer return `setActive`:

- `useSignIn()` - now returns `selectSession` instead of `setActive`
- `useSignUp()` - now returns `selectSession` instead of `setActive`
- `useSessionList()` - now returns `selectSession` instead of `setActive`
- `useOrganizationList()` - now returns `selectOrganization` instead of `setActive`

### Migration

**Before:**
```tsx
const { setActive } = useSignIn();
await setActive({ session: createdSessionId });

const { setActive } = useOrganizationList();
await setActive({ organization: org });
```

**After:**
```tsx
const { selectSession } = useSignIn();
await selectSession(createdSessionId);

const { selectOrganization } = useOrganizationList();
await selectOrganization(org);
```

### New Methods on Clerk Object

Two new methods are available on the Clerk object:

- `clerk.selectSession(session, options?)` - For session selection (sign-in, sign-up, multi-session switching)
- `clerk.selectOrganization(organization, options?)` - For organization selection (org switching, personal workspace)

### Options

Both methods accept an options object:

```tsx
// selectSession options
await selectSession(session, {
redirectUrl?: string;
navigate?: ({ session }) => void | Promise<void>;
});

// selectOrganization options
await selectOrganization(organization, {
redirectUrl?: string;
navigate?: ({ session, organization }) => void | Promise<void>;
});
```

### Expo Hooks

The `StartGoogleAuthenticationFlowReturnType` and `StartAppleAuthenticationFlowReturnType` types now return `selectSession` instead of `setActive`.

### Internal Window Hooks (Next.js)

The internal window hooks have been renamed:
- `__internal_onBeforeSetActive` → `__internal_onBeforeSelectSession`
- `__internal_onAfterSetActive` → `__internal_onAfterSelectSession`

### Types Removed

The following types have been removed from the public API:
- `SetActive`
- `SetActiveParams`
- `SetActiveNavigate` (use `SelectSessionNavigate` instead)
97 changes: 84 additions & 13 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,8 @@ import type {
RedirectOptions,
Resources,
SDKMetadata,
SelectOrganizationOptions,
SelectSessionOptions,
SessionResource,
SetActiveParams,
SignedInSessionResource,
Expand DownExpand Up@@ -297,7 +299,7 @@ export class Clerk implements ClerkInterface {
public __internal_isWebAuthnAutofillSupported: (() => Promise<boolean>) | undefined;
public __internal_isWebAuthnPlatformAuthenticatorSupported: (() => Promise<boolean>) | undefined;

public __internal_setActiveInProgress = false;
public __internal_selectSessionInProgress = false;

get publishableKey(): string {
return this.#publishableKey;
Expand DownExpand Up@@ -583,13 +585,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

const opts = callbackOrOptions && typeof callbackOrOptions === 'object' ? callbackOrOptions : options || {};
Expand DownExpand Up@@ -1446,7 +1448,7 @@ export class Clerk implements ClerkInterface {
public setActive = async (params: SetActiveParams): Promise<void> => {
const { organization, redirectUrl, navigate: setActiveNavigate } = params;
let { session } = params;
this.__internal_setActiveInProgress = true;
this.__internal_selectSessionInProgress = true;
debugLogger.debug(
'setActive() start',
{
Expand DownExpand Up@@ -1476,13 +1478,13 @@ export class Clerk implements ClerkInterface {
}

const onBeforeSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onBeforeSetActive === 'function'
? window.__internal_onBeforeSetActive
typeof window !== 'undefined' && typeof window.__internal_onBeforeSelectSession === 'function'
? window.__internal_onBeforeSelectSession
: noop;

const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

let newSession = session === undefined ? this.session : session;
Expand DownExpand Up@@ -1605,10 +1607,79 @@ export class Clerk implements ClerkInterface {
await onAfterSetActive();
}
} finally {
this.__internal_setActiveInProgress = false;
this.__internal_selectSessionInProgress = false;
}
};

/**
* Select a session to make active.
*
* Use this method after sign-in or sign-up to activate the created session,
* or to switch between sessions in a multi-session application.
*
* Pass `null` to sign out and clear the active session.
*/
public selectSession = async (
session: SignedInSessionResource | string | null,
options?: SelectSessionOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session: s }: { session: SessionResource }) => {
const result = await navigate({ session: s });
if (typeof result === 'string') {
await this.navigate(result);
}
}
: undefined;

return this.setActive({
session,
navigate: setActiveNavigate,
redirectUrl,
});
};

/**
* Select an organization to make active within the current session.
*
* Use this method to switch between organizations or to select a personal workspace.
*
* Pass `null` to switch to the personal workspace (no active organization).
*/
public selectOrganization = async (
organization: OrganizationResource | string | null,
options?: SelectOrganizationOptions,
): Promise<void> => {
const { navigate, redirectUrl } = options ?? {};

// Convert navigate callback to setActive format if provided
const setActiveNavigate = navigate
? async ({ session }: { session: SessionResource }) => {
// Resolve the organization for the callback
const org =
organization === null
? null
: typeof organization === 'string'
? (this.organization ?? null)
: organization;

const result = await navigate({ session, organization: org });
if (typeof result === 'string') {
await this.navigate(result);
}
}
Comment on lines +1658 to +1673

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Use the selected organization when invoking navigate.

When organization is a string, the callback receives this.organization (the current org), not the newly selected one. This can route to the wrong org or personal workspace. Resolve the organization from the session being activated (e.g., via session.lastActiveOrganizationId or memberships) before calling navigate.

🛠️ Proposed fix
- const org =- organization === null- ? null- : typeof organization === 'string'- ? (this.organization ?? null)- : organization;+ const org =+ organization === null+ ? null+ : typeof organization === 'string'+ ? session.user.organizationMemberships.find(+ mem => mem.organization.id === session.lastActiveOrganizationId,+ )?.organization ?? null+ : organization;
🤖 Prompt for AI Agents
In `@packages/clerk-js/src/core/clerk.ts` around lines 1658 - 1673, The
setActiveNavigate wrapper currently uses this.organization when the external
`organization` config is a string, which can be stale; instead resolve the
selected org from the activating session before calling `navigate`. In the async
function `setActiveNavigate` (wrapping `navigate` and using `SessionResource`),
if `organization === null` pass null; if `typeof organization === 'string'`
derive the org from the provided `session` (prefer
`session.lastActiveOrganizationId` or fall back to finding a membership with
matching organization id in `session.memberships`) and pass that resolved
id/object to `navigate`; otherwise pass the `organization` object directly.
Update the resolution logic in `setActiveNavigate` to use
`session.lastActiveOrganizationId`/`session.memberships` instead of
`this.organization` before invoking `navigate` and handling string return values
with `this.navigate`.

: undefined;

return this.setActive({
organization,
navigate: setActiveNavigate,
redirectUrl,
});
};

public addListener = (listener: ListenerCallback): UnsubscribeCallback => {
listener = memoizeListenerCallback(listener);
this.#listeners.push(listener);
Expand DownExpand Up@@ -2596,8 +2667,8 @@ export class Clerk implements ClerkInterface {
const hasTransitionedToPendingStatus = this.session.status === 'active' && session?.status === 'pending';
if (hasTransitionedToPendingStatus) {
const onAfterSetActive: SetActiveHook =
typeof window !== 'undefined' && typeof window.__internal_onAfterSetActive === 'function'
? window.__internal_onAfterSetActive
typeof window !== 'undefined' && typeof window.__internal_onAfterSelectSession === 'function'
? window.__internal_onAfterSelectSession
: noop;

// Execute hooks to update server authentication context and trigger
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/BillingCheckout.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -204,7 +204,7 @@ export class CheckoutFlow implements CheckoutFlowResourceNonStrict {
throw new Error('Clerk: `confirm()` must be called before `finalize()`');
}

await BillingCheckout.clerk.setActive({ session: BillingCheckout.clerk.session?.id, navigate });
await BillingCheckout.clerk.selectSession(BillingCheckout.clerk.session?.id ?? null, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1243,7 +1243,7 @@ class SignInFuture implements SignInFutureResource {
}

this.#hasBeenFinalized = true;
await SignIn.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignIn.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}

Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -972,7 +972,7 @@ class SignUpFuture implements SignUpFutureResource {
}

this.#hasBeenFinalized = true;
await SignUp.clerk.setActive({ session: this.#resource.createdSessionId, navigate });
await SignUp.clerk.selectSession(this.#resource.createdSessionId, { navigate });
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/global.d.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,8 +15,8 @@ const __BUILD_VARIANT_CHANNEL__: boolean;
const __BUILD_VARIANT_CHIPS__: boolean;

interface Window {
__internal_onBeforeSetActive: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSetActive: () => Promise<void> | void;
__internal_onBeforeSelectSession: (intent?: 'sign-out') => Promise<void> | void;
__internal_onAfterSelectSession: () => Promise<void> | void;
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
__internal_ClerkUiCtor?: import('@clerk/shared/types').ClerkUiConstructor;
/**
Expand Down
3 changes: 2 additions & 1 deletion packages/clerk-js/src/test/mock-helpers.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -99,7 +99,8 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepVitestMocked<LoadedCle
});

mockProp(clerkAny, 'navigate');
mockProp(clerkAny, 'setActive');
mockProp(clerkAny, 'selectSession');
mockProp(clerkAny, 'selectOrganization');
mockProp(clerkAny, 'redirectWithAuth');
mockProp(clerkAny, '__internal_navigateWithError');
return clerkAny as DeepVitestMocked<LoadedClerk>;
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useOAuth.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type { OAuthStrategy, SetActive, SignInResource, SignUpResource } from '@clerk/shared/types';
import type { OAuthStrategy, SelectSessionHook, SignInResource, SignUpResource } from '@clerk/shared/types';
import * as AuthSession from 'expo-auth-session';
import * as WebBrowser from 'expo-web-browser';

Expand All@@ -18,7 +18,7 @@ export type StartOAuthFlowParams = {

export type StartOAuthFlowReturnType = {
createdSessionId: string;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
authSessionResult?: WebBrowser.WebBrowserAuthSessionResult;
Expand All@@ -33,7 +33,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return errorThrower.throw('Missing oauth strategy');
}

const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startOAuthFlow(startOAuthFlowParams?: StartOAuthFlowParams): Promise<StartOAuthFlowReturnType> {
Expand All@@ -42,7 +42,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
createdSessionId: '',
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -79,7 +79,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId: '',
setActive,
selectSession,
signIn,
signUp,
};
Expand DownExpand Up@@ -108,7 +108,7 @@ export function useOAuth(useOAuthParams: UseOAuthFlowParams) {
return {
authSessionResult,
createdSessionId,
setActive,
selectSession,
signIn,
signUp,
};
Expand Down
12 changes: 6 additions & 6 deletions packages/expo/src/hooks/useSSO.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@ import { useSignIn, useSignUp } from '@clerk/react/legacy';
import type {
EnterpriseSSOStrategy,
OAuthStrategy,
SetActive,
SelectSessionHook,
SignInResource,
SignUpResource,
} from '@clerk/shared/types';
Expand All@@ -28,13 +28,13 @@ export type StartSSOFlowParams = {
export type StartSSOFlowReturnType = {
createdSessionId: string | null;
authSessionResult: WebBrowser.WebBrowserAuthSessionResult | null;
setActive?: SetActive;
selectSession?: SelectSessionHook;
signIn?: SignInResource;
signUp?: SignUpResource;
};

export function useSSO() {
const { signIn, setActive, isLoaded: isSignInLoaded } = useSignIn();
const { signIn, selectSession, isLoaded: isSignInLoaded } = useSignIn();
const { signUp, isLoaded: isSignUpLoaded } = useSignUp();

async function startSSOFlow(startSSOFlowParams: StartSSOFlowParams): Promise<StartSSOFlowReturnType> {
Expand All@@ -44,7 +44,7 @@ export function useSSO() {
authSessionResult: null,
signIn,
signUp,
setActive,
selectSession,
};
}

Expand DownExpand Up@@ -81,7 +81,7 @@ export function useSSO() {
if (authSessionResult.type !== 'success' || !authSessionResult.url) {
return {
createdSessionId: null,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand All@@ -102,7 +102,7 @@ export function useSSO() {

return {
createdSessionId: signUp.createdSessionId ?? signIn.createdSessionId,
setActive,
selectSession,
signIn,
signUp,
authSessionResult,
Expand Down
Loading
Loading