Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fresh-lies-film.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': patch
---

Make `OAuthProviderData.docsUrl` optional and remove the Enstall OAuth provider docs URL.
1 change: 0 additions & 1 deletion packages/shared/src/oauth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ export const OAUTH_PROVIDERS: OAuthProviderData[] = [
provider: 'enstall',
strategy: 'oauth_enstall',
name: 'Enstall',
docsUrl: 'https://clerk.com/docs/authentication/social-connections/enstall',

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran a full org-wide sweep of docsUrl / OAUTH_PROVIDERS consumers (in-repo + gh search code --owner clerk), and there is the one spot worth a second look — everything appears safe.

clerk/cli reads OAUTH_PROVIDERS[].docsUrl but defensively (?.docsUrl ?? fallback), and the in-repo UI consumers only read .strategy/.provider/.name, never .docsUrl, so we're good here.

The tricky one is clerk/dashboard. Its getSocialSettings.ts imports OAUTH_PROVIDERS from @clerk/shared/oauth and reads item.docsUrl with a name-based fallback:

item.docsUrl ?? `https://clerk.com/docs/guides/configure/auth-strategies/social-connections/${item.provider}`

Then, it renders that as the provider's docs link on the SSO connection page.

With docsUrl gone, Enstall falls through to …/guides/configure/auth-strategies/social-connections/enstall, which currently 404s — whereas the URL being removed here 308-redirects to the live social-connections overview (via the redirect added in clerk-docs#3391). So on the Enstall-enabled instance, this swaps a working (redirected) link for a hard 404 on the surface that actually renders it.

Since the dashboard is what surfaces this link, should we pair this with a dashboard change that drops the link when docsUrl is absent (or skips the fallback for private providers), or add a clerk-docs redirect for the new …/auth-strategies/social-connections/enstall path so the fallback resolves?

},
{
provider: 'huggingface',
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/types/oauth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export interface OAuthProviderData {
provider: OAuthProvider;
strategy: OAuthStrategy;
name: string;
docsUrl: string;
docsUrl?: string;
}

/** @inline */
Expand Down
1 change: 0 additions & 1 deletion packages/shared/src/types/runtime-values.ts
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,6 @@ export const OAUTH_PROVIDERS: OAuthProviderData[] = [
provider: 'enstall',
strategy: 'oauth_enstall',
name: 'Enstall',
docsUrl: 'https://clerk.com/docs/authentication/social-connections/enstall',
},
{
provider: 'huggingface',
Expand Down
Loading