Introduce useCheckout #6195

panteliselef · 2025-06-25T19:51:27Z

Description

React

Usage without provider

const {
  // Resource properties
  id,
  paymentSource,
  plan,
  externalClientSecret,
  planPeriod,
  planPeriodStart,
  totals,
  isImmediatePlanChange,
  
  // helpers
  isStarting,
  isConfirming,
  status,
  error,
  fetchStatus,
  
  
  // methods
  start,
  confirm,
  clear,
  finalize
} = useCheckout({ planId: "cplan_xxx", planPeriod: "montly" });

Usage with provider

<CheckoutProvider for="user" planId="cplan_xxxx" planPeriod="montly">
   <UpgragdeButton />
</CheckoutProvider>

function UpgragdeButton() {
   const checkout = useCheckout();
}

Vanilla JS

const checkout = Clek.checkout({ 
	for: "user",
	planId:"cplan_xxx",
	planPeriod: "monthly"
})

checkout.start()
checkout.confirm()
checkout.finalize()
checkout.clear()
checkout.subscribe()
checkout.getState()

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

Summary by CodeRabbit

New Features
- Introduced an experimental checkout flow, including new hooks and provider components for managing checkout state and actions.
- Added support for checkout management in both user and organization contexts.
- Exposed new methods and types for interacting with the checkout process, including initialization, confirmation, finalization, and error handling.
Refactor
- Updated checkout-related UI components to use the new experimental checkout hooks and provider, simplifying state and error management.
Documentation
- Improved and expanded JSDoc comments and type annotations across error handling and checkout modules.
Tests
- Added comprehensive tests for the new checkout manager, covering state management, concurrency, error propagation, and cache isolation.

changeset-bot · 2025-06-25T19:51:31Z

🦋 Changeset detected

Latest commit: f501d70

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

This PR includes changesets to release 22 packages

Name	Type
@clerk/clerk-js	Minor
@clerk/nextjs	Minor
@clerk/shared	Minor
@clerk/clerk-react	Minor
@clerk/types	Minor
@clerk/chrome-extension	Patch
@clerk/clerk-expo	Patch
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/elements	Patch
@clerk/expo-passkeys	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/vue	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 · 2025-06-25T19:51:32Z

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

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	⬜️ Skipped (Inspect)			Jun 27, 2025 5:33pm

panteliselef · 2025-06-26T09:13:55Z

!snapshot

clerk-cookie · 2025-06-26T09:16:30Z

Hey @panteliselef - the snapshot version command generated the following package versions:

Package	Version
@clerk/agent-toolkit	0.1.3-snapshot.v20250626091436
@clerk/astro	2.9.3-snapshot.v20250626091436
@clerk/backend	2.2.1-snapshot.v20250626091436
@clerk/chrome-extension	2.5.1-snapshot.v20250626091436
@clerk/clerk-js	5.70.0-snapshot.v20250626091436
@clerk/elements	0.23.35-snapshot.v20250626091436
@clerk/clerk-expo	2.14.0-snapshot.v20250626091436
@clerk/expo-passkeys	0.3.12-snapshot.v20250626091436
@clerk/express	1.7.2-snapshot.v20250626091436
@clerk/fastify	2.4.2-snapshot.v20250626091436
@clerk/localizations	3.17.1-snapshot.v20250626091436
@clerk/nextjs	6.24.0-snapshot.v20250626091436
@clerk/nuxt	1.7.3-snapshot.v20250626091436
@clerk/clerk-react	5.33.0-snapshot.v20250626091436
@clerk/react-router	1.6.2-snapshot.v20250626091436
@clerk/remix	4.8.3-snapshot.v20250626091436
@clerk/shared	3.10.0-snapshot.v20250626091436
@clerk/tanstack-react-start	0.18.1-snapshot.v20250626091436
@clerk/testing	1.8.3-snapshot.v20250626091436
@clerk/themes	2.2.52-snapshot.v20250626091436
@clerk/types	4.62.0-snapshot.v20250626091436
@clerk/vue	1.8.10-snapshot.v20250626091436

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/agent-toolkit

npm i @clerk/agent-toolkit@0.1.3-snapshot.v20250626091436 --save-exact

@clerk/astro

npm i @clerk/astro@2.9.3-snapshot.v20250626091436 --save-exact

@clerk/backend

npm i @clerk/backend@2.2.1-snapshot.v20250626091436 --save-exact

@clerk/chrome-extension

npm i @clerk/chrome-extension@2.5.1-snapshot.v20250626091436 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.70.0-snapshot.v20250626091436 --save-exact

@clerk/elements

npm i @clerk/elements@0.23.35-snapshot.v20250626091436 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.14.0-snapshot.v20250626091436 --save-exact

@clerk/expo-passkeys

npm i @clerk/expo-passkeys@0.3.12-snapshot.v20250626091436 --save-exact

@clerk/express

npm i @clerk/express@1.7.2-snapshot.v20250626091436 --save-exact

@clerk/fastify

npm i @clerk/fastify@2.4.2-snapshot.v20250626091436 --save-exact

@clerk/localizations

npm i @clerk/localizations@3.17.1-snapshot.v20250626091436 --save-exact

@clerk/nextjs

npm i @clerk/nextjs@6.24.0-snapshot.v20250626091436 --save-exact

@clerk/nuxt

npm i @clerk/nuxt@1.7.3-snapshot.v20250626091436 --save-exact

@clerk/clerk-react

npm i @clerk/clerk-react@5.33.0-snapshot.v20250626091436 --save-exact

@clerk/react-router

npm i @clerk/react-router@1.6.2-snapshot.v20250626091436 --save-exact

@clerk/remix

npm i @clerk/remix@4.8.3-snapshot.v20250626091436 --save-exact

@clerk/shared

npm i @clerk/shared@3.10.0-snapshot.v20250626091436 --save-exact

@clerk/tanstack-react-start

npm i @clerk/tanstack-react-start@0.18.1-snapshot.v20250626091436 --save-exact

@clerk/testing

npm i @clerk/testing@1.8.3-snapshot.v20250626091436 --save-exact

@clerk/themes

npm i @clerk/themes@2.2.52-snapshot.v20250626091436 --save-exact

@clerk/types

npm i @clerk/types@4.62.0-snapshot.v20250626091436 --save-exact

@clerk/vue

npm i @clerk/vue@1.8.10-snapshot.v20250626091436 --save-exact

panteliselef · 2025-06-26T09:35:38Z

!snapshot

# Conflicts: # integration/tests/pricing-table.test.ts # packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx # packages/shared/src/react/hooks/index.ts # packages/testing/src/playwright/unstable/page-objects/checkout.ts

panteliselef · 2025-06-27T16:17:36Z

.changeset/stale-pillows-sneeze.md

+'@clerk/types': minor
+---
+
+wip


I will update this :)

coderabbitai · 2025-06-27T17:22:06Z

📝 Walkthrough

Walkthrough

This change introduces an experimental checkout API and related infrastructure across Clerk's JavaScript, React, and Next.js packages. It adds new types, interfaces, and methods to support a commerce checkout lifecycle, including state management, error handling, and context propagation. The core logic includes a checkout manager for handling state, concurrency, and subscriptions, as well as a React hook (useCheckout) and provider for integrating checkout flows into UI components. Several UI components are refactored to use the new experimental hook and provider, replacing previous context and state management. TypeScript interfaces and documentation are updated to reflect the new API surface, and new exports are added to make the experimental features available in relevant packages.

Suggested reviewers

wobsoriano

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-06-27T17:25:41Z

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6195

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@6195

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@6195

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@6195

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@6195

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6195

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6195

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@6195

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@6195

@clerk/express

npm i https://pkg.pr.new/@clerk/express@6195

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@6195

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@6195

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@6195

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@6195

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@6195

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@6195

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6195

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@6195

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@6195

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@6195

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6195

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6195

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@6195

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@6195

commit: f501d70

coderabbitai

Actionable comments posted: 6

🧹 Nitpick comments (3)

.changeset/stale-pillows-sneeze.md (1)
9-9: Update the changeset description.

The placeholder "wip" description should be replaced with a meaningful description of the experimental checkout feature being introduced across these packages.

Consider updating to something like:
-wip
+Introduce experimental checkout API with useCheckout hook and CheckoutProvider
packages/shared/src/react/hooks/useCheckout.ts (1)
72-78: Consider returning error states instead of throwing.

Throwing errors in React hooks can cause issues with error boundaries and component lifecycle. Consider returning error states instead.
-  if (!user) {
-    throw new Error('Clerk: User is not authenticated');
-  }
-
-  if (forOrganization === 'organization' && !organization) {
-    throw new Error('Clerk: Use `setActive` to set the organization');
-  }
+  if (!user) {
+    return {
+      ...nullProperties,
+      error: new Error('Clerk: User is not authenticated'),
+      // ... other properties
+    };
+  }
packages/clerk-js/src/core/modules/checkout/manager.ts (1)
122-166: Robust operation execution with concurrency control.

The implementation handles concurrent operations well with deduplication. Consider adding a type guard for the error casting to ensure type safety:
         } catch (error) {
           // Cast error to expected type and update state
-          const clerkError = error as ClerkAPIResponseError;
+          const clerkError = error as ClerkAPIResponseError | Error;
           updateCacheState({ [isRunningField]: false, error: clerkError });
           throw error;
         }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d898eb7 and 33e17b3.

📒 Files selected for processing (23)

.changeset/stale-pillows-sneeze.md (1 hunks)
packages/clerk-js/src/core/clerk.ts (4 hunks)
packages/clerk-js/src/core/modules/checkout/__tests__/manager.spec.ts (1 hunks)
packages/clerk-js/src/core/modules/checkout/instance.ts (1 hunks)
packages/clerk-js/src/core/modules/checkout/manager.ts (1 hunks)
packages/clerk-js/src/ui/components/Checkout/CheckoutComplete.tsx (2 hunks)
packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx (5 hunks)
packages/clerk-js/src/ui/components/Checkout/CheckoutPage.tsx (1 hunks)
packages/clerk-js/src/ui/components/Checkout/index.tsx (1 hunks)
packages/clerk-js/src/ui/components/Checkout/parts.tsx (5 hunks)
packages/clerk-js/src/ui/contexts/CoreClerkContextWrapper.tsx (2 hunks)
packages/nextjs/src/client-boundary/hooks.ts (1 hunks)
packages/nextjs/src/index.ts (1 hunks)
packages/react/src/contexts/ClerkContextProvider.tsx (2 hunks)
packages/react/src/hooks/index.ts (1 hunks)
packages/react/src/isomorphicClerk.ts (1 hunks)
packages/shared/src/error.ts (10 hunks)
packages/shared/src/react/contexts.tsx (4 hunks)
packages/shared/src/react/hooks/index.ts (1 hunks)
packages/shared/src/react/hooks/useCheckout.ts (1 hunks)
packages/shared/src/react/index.ts (1 hunks)
packages/types/src/api.ts (1 hunks)
packages/types/src/clerk.ts (4 hunks)

🧰 Additional context used

📓 Path-based instructions (8)

`**/*.{js,ts,tsx,jsx}`: All code must pass ESLint checks with the project's configuration. Use Prettier for consistent code formatting.

**/*.{js,ts,tsx,jsx}: All code must pass ESLint checks with the project's configuration.
Use Prettier for consistent code formatting.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/development.mdc)