chore(clerk-js,shared): Remove deprecated enterprise methods from User resource#8747
chore(clerk-js,shared): Remove deprecated enterprise methods from User resource#8747LauraBeatris wants to merge 2 commits into
User resource#8747Conversation
🦋 Changeset detectedLatest commit: 0ac6617 The changes in this PR will be included in the next version bump. This PR includes changesets to release 20 packages
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 |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
LauraBeatris
changed the title
User resourceUser resource
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/hono
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/react
@clerk/react-router
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/ui
@clerk/upgrade
@clerk/vue
commit: |
API Changes Report
Summary
🔴 Breaking changes index (4)Every breaking change, up front. Full diffs are in the package sections below.
@clerk/sharedCurrent version: 4.15.0 Subpath
|
📝 WalkthroughWalkthroughThis PR removes three enterprise connection mutation methods ( ChangesRemove User enterprise connection write methods
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx (1)
18-24: ⚡ Quick winAdd a contract test for the narrowed hook surface.
This removes members from an exported return type, but no test changes are included here. A small type-level or hook-shape test would lock in that
createEnterpriseConnection,updateEnterpriseConnection, anddeleteEnterpriseConnectionstay absent whilerevalidateremains available.As per coding guidelines,
**/*: "If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes."🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx` around lines 18 - 24, The exported type UseUserEnterpriseConnectionsReturn was narrowed to remove createEnterpriseConnection, updateEnterpriseConnection, and deleteEnterpriseConnection while keeping revalidate; add a small contract test that asserts the hook shape: import or call the hook (useUserEnterpriseConnections) and assert at the type or runtime level that createEnterpriseConnection, updateEnterpriseConnection, and deleteEnterpriseConnection are not present on the returned object and that revalidate exists and is callable; use a TypeScript type-level assertion (e.g., ensuring ReturnType<typeof useUserEnterpriseConnections> extends UseUserEnterpriseConnectionsReturn) or a runtime shape check in the hook test file to lock this contract so future changes cannot reintroduce the removed members.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.changeset/quick-pugs-tap.md:
- Line 6: The changelog sentence that reads "Remove deprecated
`createEnterpriseConnection`, `updateEnterpriseConnection`, and
`deleteEnterpriseConnection` methods from the `User` resource in favor of
`Organization` scoped ones" needs hyphenation; update the phrase `Organization
scoped` to `Organization-scoped` so it reads "...in favor of
`Organization-scoped` ones" to improve readability and consistency.
---
Nitpick comments:
In `@packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx`:
- Around line 18-24: The exported type UseUserEnterpriseConnectionsReturn was
narrowed to remove createEnterpriseConnection, updateEnterpriseConnection, and
deleteEnterpriseConnection while keeping revalidate; add a small contract test
that asserts the hook shape: import or call the hook
(useUserEnterpriseConnections) and assert at the type or runtime level that
createEnterpriseConnection, updateEnterpriseConnection, and
deleteEnterpriseConnection are not present on the returned object and that
revalidate exists and is callable; use a TypeScript type-level assertion (e.g.,
ensuring ReturnType<typeof useUserEnterpriseConnections> extends
UseUserEnterpriseConnectionsReturn) or a runtime shape check in the hook test
file to lock this contract so future changes cannot reintroduce the removed
members.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 831e64d3-bd13-4936-ac2f-00663f6a6dda
📒 Files selected for processing (5)
.changeset/quick-pugs-tap.mdpackages/clerk-js/src/core/resources/User.tspackages/clerk-js/src/core/resources/__tests__/User.test.tspackages/shared/src/react/hooks/useUserEnterpriseConnections.tsxpackages/shared/src/types/user.ts
💤 Files with no reviewable changes (2)
- packages/clerk-js/src/core/resources/User.ts
- packages/clerk-js/src/core/resources/tests/User.test.ts
| '@clerk/shared': patch | ||
| --- | ||
|
|
||
| Remove deprecated `createEnterpriseConnection`, `updateEnterpriseConnection`, and `deleteEnterpriseConnection` methods from the `User` resource in favor of `Organization` scoped ones |
There was a problem hiding this comment.
Hyphenate “Organization-scoped” in the changelog entry.
This is user-facing release-note copy, so the hyphenation should be fixed for readability and consistency.
✏️ Suggested edit
-Remove deprecated `createEnterpriseConnection`, `updateEnterpriseConnection`, and `deleteEnterpriseConnection` methods from the `User` resource in favor of `Organization` scoped ones
+Remove deprecated `createEnterpriseConnection`, `updateEnterpriseConnection`, and `deleteEnterpriseConnection` methods from the `User` resource in favor of `Organization`-scoped ones📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Remove deprecated `createEnterpriseConnection`, `updateEnterpriseConnection`, and `deleteEnterpriseConnection` methods from the `User` resource in favor of `Organization` scoped ones | |
| Remove deprecated `createEnterpriseConnection`, `updateEnterpriseConnection`, and `deleteEnterpriseConnection` methods from the `User` resource in favor of `Organization`-scoped ones |
🧰 Tools
🪛 LanguageTool
[grammar] ~6-~6: Use a hyphen to join words.
Context: ...serresource in favor ofOrganizationscoped ones ConfigureSSO` was previous...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.changeset/quick-pugs-tap.md at line 6, The changelog sentence that reads
"Remove deprecated `createEnterpriseConnection`, `updateEnterpriseConnection`,
and `deleteEnterpriseConnection` methods from the `User` resource in favor of
`Organization` scoped ones" needs hyphenation; update the phrase `Organization
scoped` to `Organization-scoped` so it reads "...in favor of
`Organization-scoped` ones" to improve readability and consistency.
LauraBeatris
force-pushed
the
laura/remove-ec-methods-user-resource
branch
from
80ee6b2 to
0ac6617
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
.changeset/quick-pugs-tap.md (1)
6-6:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winHyphenate “Organization-scoped” in release-note copy.
This is still valid, but it was already raised on this PR; keeping as duplicate for tracking.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.changeset/quick-pugs-tap.md at line 6, Update the release-note copy to hyphenate “Organization-scoped” wherever it appears (replace the current "Organization scoped" text with "Organization-scoped") in the release notes; locate the phrase in the release note content (the sentence about removing createEnterpriseConnection, updateEnterpriseConnection, and deleteEnterpriseConnection in favor of Organization scoped ones) and apply the hyphenation to produce "Organization-scoped" for consistent style.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In @.changeset/quick-pugs-tap.md:
- Line 6: Update the release-note copy to hyphenate “Organization-scoped”
wherever it appears (replace the current "Organization scoped" text with
"Organization-scoped") in the release notes; locate the phrase in the release
note content (the sentence about removing createEnterpriseConnection,
updateEnterpriseConnection, and deleteEnterpriseConnection in favor of
Organization scoped ones) and apply the hyphenation to produce
"Organization-scoped" for consistent style.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 07380424-dca4-4a87-a795-4f5f56eb556c
📒 Files selected for processing (5)
.changeset/quick-pugs-tap.mdpackages/clerk-js/src/core/resources/User.tspackages/clerk-js/src/core/resources/__tests__/User.test.tspackages/shared/src/react/hooks/useUserEnterpriseConnections.tsxpackages/shared/src/types/user.ts
💤 Files with no reviewable changes (2)
- packages/clerk-js/src/core/resources/tests/User.test.ts
- packages/clerk-js/src/core/resources/User.ts
🚧 Files skipped from review as they are similar to previous changes (2)
- packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx
- packages/shared/src/types/user.ts
1 participant
Description
This PR removes some enterprise connection methods from the
Userresource, leaving one for retrieval which is currently used onOrganizationProfilefor account linking.There aren't existing GA consumers for those
The only previous consumer of those were previous versions of
clerk/uion<ConfigureSSO />internals. Removing those fromclerk-jswon't break existing clients are this component also didn't get released GA.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
createEnterpriseConnection(),updateEnterpriseConnection(), anddeleteEnterpriseConnection(). To manage enterprise connections, use the Organization-scoped equivalents instead. The read-only methodgetEnterpriseConnections()remains available. Update your integrations to leverage Organization-based APIs for connection write operations.