Uh oh!
There was an error while loading. Please reload this page.
chore(clerk-js,shared,ui): Add EnterpriseConnection resource - #8175
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 117026d The changes in this PR will be included in the next version bump. This PR includes changesets to release 21 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 |
b51c4dc to
c2e56c6CompareEnterpriseConnection resourceEnterpriseConnection resourceEnterpriseConnection resourceEnterpriseConnection resource📝 WalkthroughWalkthroughAdds a new EnterpriseConnection resource class and corresponding JSON/resource type definitions, re-exports them, and updates type imports across packages. Changes 🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
| export type UseUserEnterpriseConnectionsReturn = { | ||
| data: EnterpriseAccountConnectionResource[] | undefined; | ||
| data: EnterpriseConnectionResource[] | undefined; |
There was a problem hiding this comment.
wouldn't this count as a breaking change? Not saying we need to since this is just a TypeScript type change, but the change in type here seems significant enough to justify calling it out in the changelog. I assume the API has been returning something of the shape EnterpriseConnectionResource so at runtime I doubt this would break anything functional, but I can imagine this causing a TypeScript error if someone was previously using the EnterpriceAccountConnectionResource type.
There was a problem hiding this comment.
We haven't released user.getEnterpriseConnections yet in production, so I expect no breaking changes on existing apps
There was a problem hiding this comment.
I'll clarify that type change behavior on the changelog as well
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.changeset/humble-trams-laugh.md:
- Line 9: Update the type description for User.getEnterpriseConnections() so it
reflects an array return type: replace the singular
EnterpriseAccountConnectionResource with EnterpriseAccountConnectionResource[]
(or the correct EnterpriseConnectionResource[] if that's the canonical type in
your codebase) in the changelog/description so the documented return type
matches the actual plural method signature; ensure the mention of
User.getEnterpriseConnections() and the resource type name are updated
consistently.
🪄 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: ASSERTIVE
Plan: Pro
Run ID: 1cb81ab7-6641-4d82-9df6-af6052eeb9a9
📒 Files selected for processing (1)
.changeset/humble-trams-laugh.md
Uh oh!
There was an error while loading. Please reload this page.
@clerk/agent-toolkit@clerk/astro@clerk/backend@clerk/chrome-extension@clerk/clerk-js@clerk/dev-cli@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/vuecommit: |
5e62ce7 to
482b75bCompare482b75b to
40bb08dCompareThere was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@packages/clerk-js/src/core/resources/User.ts`:
- Around line 314-316: Update the mock response in the test at User.test.ts so
it matches the new EnterpriseConnectionJSON schema: replace any single "domain"
string with "domains" as an array (e.g. domains: []), remove obsolete fields
like "protocol" and "provider", and add the new nested objects "saml_connection"
and/or "oauth_config" (or minimal empty objects) as expected by
EnterpriseConnection.fromJSON/EnterpriseConnectionJSON; ensure the test mock
objects mirror the real API shape so the code paths in
EnterpriseConnection.fromJSON and the mapping in User (where it casts to
EnterpriseConnectionJSON[] and constructs new EnterpriseConnection(connection))
exercise the correct schema.
🪄 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: ASSERTIVE
Plan: Pro
Run ID: 91da4969-d424-4a91-bb92-3a539ae76038
📒 Files selected for processing (10)
.changeset/humble-trams-laugh.mdpackages/clerk-js/bundlewatch.config.jsonpackages/clerk-js/src/core/resources/EnterpriseConnection.tspackages/clerk-js/src/core/resources/User.tspackages/clerk-js/src/core/resources/internal.tspackages/shared/src/react/hooks/useUserEnterpriseConnections.tsxpackages/shared/src/types/enterpriseConnection.tspackages/shared/src/types/index.tspackages/shared/src/types/user.tspackages/ui/src/components/UserProfile/EnterpriseAccountsSection.tsx
| )?.response as unknown as EnterpriseConnectionJSON[]; | ||
| return (json || []).map(connection => new EnterpriseAccountConnection(connection)); | ||
| return (json || []).map(connection => new EnterpriseConnection(connection)); |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash# Check test file for enterprise connection mock data
rg -n -A 30 'enterprise.*connection.*JSON' packages/clerk-js/src/core/resources/__tests__/User.test.tsRepository: clerk/javascript
Length of output: 42
🏁 Script executed:
# First, let's look at the test file to find enterprise connection related tests
rg -n -B 2 -A 20 'getEnterpriseConnections' packages/clerk-js/src/core/resources/__tests__/User.test.tsRepository: clerk/javascript
Length of output: 806
🏁 Script executed:
# Find the EnterpriseConnectionJSON type definition
rg -n -B 2 -A 10 'interface EnterpriseConnectionJSON\|type EnterpriseConnectionJSON' packages/clerk-js/src/Repository: clerk/javascript
Length of output: 42
🏁 Script executed:
# Also check what EnterpriseConnection class looks like
rg -n -B 2 -A 15 'class EnterpriseConnection\|export class EnterpriseConnection' packages/clerk-js/src/Repository: clerk/javascript
Length of output: 42
🏁 Script executed:
# Look at the test setup before line 112 to see the mock data
sed -n '80,115p' packages/clerk-js/src/core/resources/__tests__/User.test.tsRepository: clerk/javascript
Length of output: 1095
🏁 Script executed:
# Search for enterprise connection related types more broadly
rg -n 'EnterpriseConnectionJSON\|enterprise_connection' packages/clerk-js/src/ -t tsRepository: clerk/javascript
Length of output: 42
🏁 Script executed:
# Search for EnterpriseConnection references in the codebase
rg -n 'class EnterpriseConnection' packages/clerk-js/src/ -t tsRepository: clerk/javascript
Length of output: 220
🏁 Script executed:
# Find EnterpriseConnectionJSON type definition
fd -t f EnterpriseConnection.ts packages/clerk-js/src/ --exec head -150 {} \;Repository: clerk/javascript
Length of output: 4987
🏁 Script executed:
# Search for EnterpriseConnectionJSON in type files
rg -n 'EnterpriseConnectionJSON' packages/clerk-js/src/ -t ts -B 2 -A 10Repository: clerk/javascript
Length of output: 9696
Update test mock data to match the new EnterpriseConnectionJSON schema.
The test at packages/clerk-js/src/core/resources/__tests__/User.test.ts uses stale mock data with the old API structure. The mock includes fields like domain (string), protocol, and provider that don't exist in the new EnterpriseConnectionJSON type, which expects domains (array), saml_connection, and oauth_config objects instead.
The test currently passes by coincidence because the EnterpriseConnection.fromJSON() implementation provides defaults for optional fields (domains ?? []), but the mock should be updated to reflect the actual API response structure to properly validate the new code.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@packages/clerk-js/src/core/resources/User.ts` around lines 314 - 316, Update
the mock response in the test at User.test.ts so it matches the new
EnterpriseConnectionJSON schema: replace any single "domain" string with
"domains" as an array (e.g. domains: []), remove obsolete fields like "protocol"
and "provider", and add the new nested objects "saml_connection" and/or
"oauth_config" (or minimal empty objects) as expected by
EnterpriseConnection.fromJSON/EnterpriseConnectionJSON; ensure the test mock
objects mirror the real API shape so the code paths in
EnterpriseConnection.fromJSON and the mapping in User (where it casts to
EnterpriseConnectionJSON[] and constructs new EnterpriseConnection(connection))
exercise the correct schema.
There was a problem hiding this comment.
Missed this one, will raise a follow up PR to fix it alongside adding provider and logo_public_url properties to EnterpriseConnection
There was a problem hiding this comment.
@LauraBeatris, sounds good! Would you like me to open a GitHub issue to track these follow-up items:
- Update the
User.test.tsmock data to match the newEnterpriseConnectionJSONschema (replacedomainwithdomains: [], remove obsoleteprotocol/providerfields, addsaml_connection/oauth_confignested objects). - Add
providerandlogo_public_urlproperties to theEnterpriseConnectionresource and its associated types.
🧠 Learnings used
Learnt from: wobsoriano
Repo: clerk/javascript PR: 7883
File: packages/backend/src/api/__tests__/M2MTokenApi.test.ts:414-419
Timestamp: 2026-02-24T18:03:27.067Z
Learning: In TypeScript files within the clerk/javascript repository, enforce explicit return type annotations for exported functions and public APIs, but allow internal test helper functions without explicit return types. This helps maintain API clarity and type safety for consumers while not burdening test helpers that are not part of the public surface.
Uh oh!
There was an error while loading. Please reload this page.
Description
EnterpriseConnectionresource from FAPI/me/enterprise_connectionsquery return type to useEnterpriseConnectionUserProfilelogic for connection to enterprise connection, to rely on theEnterpriseConnectionproperties instead of the previously wrong typeChecklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Refactor
Chores