feat(clerk-js): Handle new session pending status as authenticated state

[LauraBeatris]

Description

Context

Introducing a new FAPI session status: pending. It builds a fundamental layer for the after-auth project and the future concept of tasks, eg: Forcing to select an organization after sign-in.

Previously, only active sessions were considered to be in an authenticated state. Now, we're introducing a new status assigned to the user session after a successful authentication process but when there are pending tasks.

Next steps

These changes do not introduce new behavior on helpers / AIO components, neither breaking changes, as it handles pending as an authenticated state, pairing the same functionality as active

Next PRs will start introducing the concept of pending tasks and enforcing resolution upon after-auth.

Developer-facing changes

Once these clerk-js get served, developers shouldn't have to worry about changing their app logic or breaking changes. However, some interface changes are preparing the DX for the next steps mentioned above:

Unifying an signed-in state check based on the session status with Clerk.isSignedIn or Clerk.client.isSignedIn

For custom flows, Clerk.user shouldn't be used to determine if the user has fully authenticated or not, and also, it shouldn't be necessary for developers to explicitly check against the session as it's prone for breaking changes, therefore we're abstracting this behind a new property.

- if (Clerk.session.status === 'active') {
+ if (Clerk.isSignedIn) {
  // Mount user button component
  document.getElementById('signed-in').innerHTML = `
    <div id="user-button"></div>
  `

  const userbuttonDiv = document.getElementById('user-button')

  clerk.mountUserButton(userbuttonDiv)
} else {

Deprecating activeSessions in favor of signedInSessions

Deprecating explicit checks against "active" sessions in favor of a generic property that expresses the "signed-in" state instead, since in the future, we might add other types of session statuses for different levels of user verification as we're doing now with after-auth.

Checklist

• pnpm test runs as expected.
• pnpm build runs as expected.
• (If applicable) JSDoc comments have been added or updated for any package exports
• (If applicable) Documentation has been updated

Type of change

• 🐛 Bug fix
• 🌟 New feature
• 🔨 Breaking change
• 📖 Refactoring / dependency upgrade / documentation
• other:

[changeset-bot]

🦋 Changeset detected

Latest commit: e69c175

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 23 packages

Name	Type
@clerk/elements	Minor
@clerk/shared	Minor
@clerk/astro	Minor
@clerk/clerk-react	Minor
@clerk/types	Minor
@clerk/clerk-expo	Minor
@clerk/vue	Minor
@clerk/clerk-js	Minor
@clerk/ui	Patch
@clerk/agent-toolkit	Patch
@clerk/backend	Patch
@clerk/chrome-extension	Patch
@clerk/expo-passkeys	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/tanstack-start	Patch
@clerk/testing	Patch
@clerk/localizations	Patch
@clerk/themes	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 18, 2025 7:07pm

[144mdgross]

Hello! Sorry if this is the wrong place to ask but I wasn't able to get my discord account working. I begin getting type errors (error TS2322) when updating to version 4.47.0 of types. Is this expected and is it resolved by an update to the corresponding clerk packages? We are using "@clerk/remix": "4.1.1", in conjunction with @clerk/types": "4.6.0 currently without issue.

error TS2322: Type 'SignedInSessionResource | null | undefined' is not assignable to type 'ActiveSessionResource | null | undefined'.
  Type 'PendingSessionResource' is not assignable to type 'ActiveSessionResource'.
    Types of property 'status' are incompatible.
      Type '"pending"' is not assignable to type '"active"'.```