Skip to content

chore(clerk-js,types): Strict type for CommerceCheckout.status #6474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Aug 5, 2025
Merged

chore(clerk-js,types): Strict type for CommerceCheckout.status #6474

merged 1 commit into from
Aug 5, 2025

Conversation

panteliselef
Copy link
Member

@panteliselef panteliselef commented Aug 5, 2025 •
edited by coderabbitai bot
Loading

Description

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:

Summary by CodeRabbit

  • Refactor
    • Improved the accuracy of checkout status values by restricting them to 'needs_confirmation' or 'completed', enhancing clarity and consistency in the Billing Beta feature.

@panteliselef panteliselef requested a review from a team August 5, 2025 11:28
@panteliselef panteliselef self-assigned this Aug 5, 2025
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Aug 5, 2025

🦋 Changeset detected

Latest commit: 97db17c

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/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/localizations Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/clerk-react Patch
@clerk/remix Patch
@clerk/shared Patch
@clerk/tanstack-react-start Patch
@clerk/testing Patch
@clerk/themes Patch
@clerk/vue 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 Vercel
Copy link

vercel bot commented Aug 5, 2025 •
edited
Loading

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 Aug 5, 2025 11:29am

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Aug 5, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 97db17c

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025

📝 Walkthrough

Walkthrough

This change refines the type definition of the status property related to commerce checkout functionality. Specifically, the status property in the CommerceCheckout, CommerceCheckoutResource, and CommerceCheckoutJSON interfaces/classes is updated from a generic string type to a union type with allowed values 'needs_confirmation' | 'completed'. These updates are made across the @clerk/clerk-js and @clerk/types packages, and are marked as minor version updates.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

  • Complexity label: Simple
  • The changes are straightforward type refinements across a small number of files, focused on increasing type specificity for a single property. No logic or structural changes are present.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e3d073e and 97db17c.

📒 Files selected for processing (4)
  • .changeset/nasty-shirts-behave.md (1 hunks)
  • packages/clerk-js/src/core/resources/CommerceCheckout.ts (1 hunks)
  • packages/types/src/commerce.ts (1 hunks)
  • packages/types/src/json.ts (1 hunks)
🧰 Additional context used
📓 Path-based instructions (8)
**/*.{js,jsx,ts,tsx}

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

**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels

Files:

  • packages/types/src/commerce.ts
  • packages/clerk-js/src/core/resources/CommerceCheckout.ts
  • packages/types/src/json.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}

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

Use Prettier for consistent code formatting

Files:

  • packages/types/src/commerce.ts
  • packages/clerk-js/src/core/resources/CommerceCheckout.ts
  • packages/types/src/json.ts
packages/**/*.{ts,tsx}

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

TypeScript is required for all packages

Files:

  • packages/types/src/commerce.ts
  • packages/clerk-js/src/core/resources/CommerceCheckout.ts
  • packages/types/src/json.ts
packages/**/*.{ts,tsx,d.ts}

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

Packages should export TypeScript types alongside runtime code

Files:

  • packages/types/src/commerce.ts
  • packages/clerk-js/src/core/resources/CommerceCheckout.ts
  • packages/types/src/json.ts
**/*.{ts,tsx}

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

Use proper TypeScript error types

**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoid any type - prefer unknown when type is uncertain, then narrow with type guards
Use interface for object shapes that might be extended
Use type for unions, primitives, and computed types
Prefer readonly properties for immutable data structures
Use private for internal implementation details
Use protected for inheritance hierarchies
Use public explicitly for clarity in public APIs
Prefer readonly for properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Use const assertions for literal types: as const
Use satisfies operator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports: import type { ... } from ...
No any types without justification
Proper error handling with typed errors
Consistent use of readonly for immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)

Files:

  • packages/types/src/commerce.ts
  • packages/clerk-js/src/core/resources/CommerceCheckout.ts
  • packages/types/src/json.ts
**/*.{js,ts,tsx,jsx}

📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)

Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.

Files:

  • packages/types/src/commerce.ts
  • packages/clerk-js/src/core/resources/CommerceCheckout.ts
  • packages/types/src/json.ts
**/*

⚙️ CodeRabbit Configuration File

If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.

Files:

  • packages/types/src/commerce.ts
  • packages/clerk-js/src/core/resources/CommerceCheckout.ts
  • packages/types/src/json.ts
.changeset/**

📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)

Automated releases must use Changesets.

Files:

  • .changeset/nasty-shirts-behave.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (22)
  • GitHub Check: Integration Tests (elements, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 14)
  • GitHub Check: Integration Tests (expo-web, chrome)
  • GitHub Check: Integration Tests (react-router, chrome)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (tanstack-react-router, chrome)
  • GitHub Check: Integration Tests (tanstack-react-start, chrome)
  • GitHub Check: Integration Tests (nuxt, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (vue, chrome)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (ap-flows, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Integration Tests (quickstart, chrome)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Integration Tests (express, chrome)
  • GitHub Check: Publish with pkg-pr-new
  • GitHub Check: Static analysis
  • GitHub Check: Unit Tests (22, **)
  • GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
  • GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (4)
.changeset/nasty-shirts-behave.md (1)

1-7: LGTM! Changeset accurately describes the type refinement.

The changeset correctly identifies this as a minor version change for both affected packages and clearly describes the type refinement from string to 'needs_confirmation' | 'completed' for the Billing Beta feature.

packages/types/src/commerce.ts (1)

1506-1506: Excellent type refinement for better type safety.

The change from string to 'needs_confirmation' | 'completed' provides stronger typing while maintaining backward compatibility, as these are the only valid status values in practice.

packages/types/src/json.ts (1)

873-873: Consistent type refinement across JSON serialization interface.

The union type change maintains perfect consistency with the CommerceCheckoutResource interface, ensuring type safety across serialization boundaries.

packages/clerk-js/src/core/resources/CommerceCheckout.ts (1)

21-21: Implementation correctly matches the refined interface types.

The status property type now properly aligns with the CommerceCheckoutResource interface, providing compile-time type safety while maintaining runtime compatibility.

🪧 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.
  • 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.

Support

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

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.

@panteliselef panteliselef merged commit 7b6dcee into main Aug 5, 2025
62 of 63 checks passed
@panteliselef panteliselef deleted the elef/com-1125-update-checkout-statuses-in-clerk-js branch August 5, 2025 18:09
@clerk-cookie clerk-cookie mentioned this pull request Aug 5, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mauricioabreu mauricioabreu mauricioabreu approved these changes

@mzhong9723 mzhong9723 mzhong9723 approved these changes

@l-armstrong l-armstrong l-armstrong approved these changes

Assignees

@panteliselef panteliselef

Labels
clerk-js types
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@panteliselef @mauricioabreu @mzhong9723 @l-armstrong @clerk-cookie