Skip to content

Conversation

panteliselef
Copy link
Member

@panteliselef panteliselef commented Jul 11, 2025

Description

This makes the type ClerkAPIResponseError available where it is needed for #6195

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

  • New Features
    • Made the Clerk API response error interface publicly available for improved error handling and integration.
  • Tests
    • Temporarily skipped certain sign-in and sign-up navigation tests to streamline test execution.

@panteliselef panteliselef self-assigned this Jul 11, 2025
Copy link

changeset-bot bot commented Jul 11, 2025

🦋 Changeset detected

Latest commit: a51d6bb

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

This PR includes changesets to release 22 packages
Name Type
@clerk/shared Patch
@clerk/types Patch
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/chrome-extension Patch
@clerk/clerk-js Patch
@clerk/elements Patch
@clerk/expo-passkeys Patch
@clerk/clerk-expo Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/clerk-react 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

Copy link

vercel bot commented Jul 11, 2025

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 Jul 11, 2025 3:46pm

@panteliselef panteliselef enabled auto-merge (squash) July 11, 2025 12:55
Copy link
Contributor

coderabbitai bot commented Jul 11, 2025

📝 Walkthrough

Walkthrough

This change adds a new exported interface ClerkAPIResponseError to the @clerk/types package, defining a structured error response from the Clerk API with properties including clerkError, status, message, optional clerkTraceId, optional retryAfter, and an array of ClerkAPIError objects. The ClerkAPIResponseError class in the @clerk/shared package is updated to explicitly implement this interface. Additionally, two integration tests related to session tasks for sign-in and two for sign-up were changed from active to skipped tests without altering their internal logic.


📜 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 0fdd556 and a51d6bb.

📒 Files selected for processing (2)
  • integration/tests/session-tasks-sign-in.test.ts (2 hunks)
  • integration/tests/session-tasks-sign-up.test.ts (2 hunks)
✅ Files skipped from review due to trivial changes (2)
  • integration/tests/session-tasks-sign-in.test.ts
  • integration/tests/session-tasks-sign-up.test.ts
⏰ 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). (5)
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Build Packages
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)

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

Copy link

pkg-pr-new bot commented Jul 11, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: a51d6bb

@panteliselef panteliselef merged commit 6826d0b into main Jul 11, 2025
35 of 36 checks passed
@panteliselef panteliselef deleted the elef/add-error-type branch July 11, 2025 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants