feat(backend): Export UserDeletedJSON type from API resources

[kduprey]

Description

• Adds export of UserDeletedJSON type from API resources

Fixes USER-4077

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
  • Exported new UserDeletedJSON type for developers to properly type user deletion event responses from the backend API.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[changeset-bot]

🦋 Changeset detected

Latest commit: 70165a8

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

This PR includes changesets to release 11 packages

Name	Type
@clerk/backend	Minor
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	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 GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
clerk-js-sandbox	Ready	Preview	Comment	Nov 25, 2025 4:42pm

[coderabbitai]

Walkthrough

Adds UserDeletedJSON as a new exported type from the Clerk backend package, enabling customers to handle webhook events for deleted users similar to existing UserJSON support. Updates version manifest and exports the type from the main index file.

Changes

Cohort / File(s)	Summary
Version Bump & Changeset .changeset/violet-carrots-pull.md	Documents minor version bump for @clerk/backend with addition of UserDeletedJSON export.
Type Exports packages/backend/src/index.ts	Exports new UserDeletedJSON type alias, integrated into the JSON types union alongside existing UserJSON and VerificationJSON.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Single type alias addition to existing export list with no logic changes or dependencies to validate

Poem

🐰 A new type hops into view,
UserDeletedJSON — fresh and true!
For webhooks that need to know,
When users must bid farewell and go. 🌙

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title accurately summarizes the main change: exporting the UserDeletedJSON type from API resources.
Linked Issues check	✅ Passed	The changes fully satisfy USER-4077 by exporting UserDeletedJSON type from API resources as requested for webhook handling.
Out of Scope Changes check	✅ Passed	All changes are directly related to exporting the UserDeletedJSON type; no out-of-scope modifications are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch kenton/user-4077-add-exported-type-userdeletedjson-in-clerkjavascript

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between b248601 and 70165a8.

📒 Files selected for processing (2)

• .changeset/violet-carrots-pull.md (1 hunks)
• packages/backend/src/index.ts (1 hunks)

🧰 Additional context used

📓 Path-based instructions (8)

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

All code must pass ESLint checks with the project's configuration

Files:

• packages/backend/src/index.ts

**/*.{js,jsx,ts,tsx,json,md,yml,yaml}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Use Prettier for consistent code formatting

Files:

• packages/backend/src/index.ts

packages/**/src/**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

TypeScript is required for all packages

Files:

• packages/backend/src/index.ts

**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Follow established naming conventions (PascalCase for components, camelCase for variables)

Prefer importing types from @clerk/shared/types instead of the deprecated @clerk/types alias

Files:

• packages/backend/src/index.ts

packages/**/src/**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

packages/**/src/**/*.{ts,tsx,js,jsx}: Maintain comprehensive JSDoc comments for public APIs
Use tree-shaking friendly exports
Validate all inputs and sanitize outputs
All public APIs must be documented with JSDoc
Use dynamic imports for optional features
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
Implement proper logging with different levels

Files:

• packages/backend/src/index.ts

**/*.ts?(x)

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Use proper TypeScript error types

Files:

• packages/backend/src/index.ts

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)

**/*.{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
Implement type guards for unknown types using the pattern function isType(value: unknown): value is Type
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 in classes
Use protected for inheritance hierarchies
Use public explicitly for clarity in public APIs
Use mixins for shared behavior across unrelated classes in TypeScript
Use generic constraints with bounded type parameters like <T extends { id: string }>
Use utility types like Omit, Partial, and Pick for data transformation instead of manual type construction
Use discriminated unions instead of boolean flags for state management and API responses
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation at the type level
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Document functions with JSDoc comments including @param, @returns, @throws, and @example tags
Create custom error classes that extend Error for specific error types
Use the Result pattern for error handling instead of throwing exceptions
Use optional chaining (?.) and nullish coalescing (??) operators for safe property access
Let TypeScript infer obvious types to reduce verbosity
Use const assertions with as const for literal types
Use satisfies operator for type checking without widening types
Declare readonly arrays and objects for immutable data structures
Use spread operator and array spread for immutable updates instead of mutations
Use lazy loading for large types...

Files:

• packages/backend/src/index.ts

**/index.ts

📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)

Avoid barrel files (index.ts re-exports) as they can cause circular dependencies

Files:

• packages/backend/src/index.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). (6)

• GitHub Check: Static analysis
• GitHub Check: Unit Tests (22, **)
• GitHub Check: Unit Tests (22, shared, clerk-js, RQ)
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: semgrep-cloud-platform/scan
• GitHub Check: semgrep-cloud-platform/scan

🔇 Additional comments (2)

.changeset/violet-carrots-pull.md (1)

1-5: Changeset metadata and description look correct

Minor bump for @clerk/backend and the summary clearly describe exporting UserDeletedJSON; this matches the implementation and is semver‑appropriate for an additive public type.

packages/backend/src/index.ts (1)

56-107: New UserDeletedJSON export is correctly wired

Adding UserDeletedJSON to the JSON type export list (adjacent to UserJSON) cleanly exposes the deleted‑user payload type through @clerk/backend while remaining type‑only and tree‑shaking friendly. This satisfies the goal of making the deleted‑user JSON available to consumers for webhooks.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[pkg-pr-new]

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 70165a8