feat(ui): add experimental flag to gate the OIDC self-serve flow#9102
feat(ui): add experimental flag to gate the OIDC self-serve flow#9102iagodahlem wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: f3bd95c The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types 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 |
📝 WalkthroughWalkthroughThis PR introduces a new ChangesOIDC self-serve flag
Estimated code review effort: 1 (Trivial) | ~5 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
Comment |
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/electron
@clerk/electron-passkeys
@clerk/eslint-plugin
@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
@clerk/sharedCurrent version: 4.24.0 Subpath
|
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.changeset/empty-ducks-tease.md (1)
1-3: 📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick winAdd a real changeset entry for this PR.
This file is still the empty placeholder form, which only fits docs/tooling-only or otherwise release-free changes. Since this PR adds code in the
experimentalClerk options /ConfigureSSOpath, please include the affected package bump(s) and summary so the release/changelog is generated.🤖 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/empty-ducks-tease.md around lines 1 - 3, The changeset file is still the empty placeholder, but this PR introduces a code change in the experimental Clerk options / ConfigureSSO path, so it needs a real release entry. Update the changeset content to include a short summary of the change and the appropriate package bump(s), using the existing changeset file as the place to document the impacted package(s) so the changelog can be generated.Sources: Coding guidelines, Learnings
🧹 Nitpick comments (1)
packages/shared/src/types/clerk.ts (1)
1484-1487: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueNew experimental flag is well-documented; consider Docs-team review +
@defaulttag.The JSDoc clearly explains the purpose and removal plan, which is good. Two small notes:
- Sibling flag
persistClientdocuments its default via@default true; consider adding@default falsehere for consistency, since the PR objective states the flag is off by default.- Since this JSDoc is on an exported
ClerkOptionstype that Clerk Docs generates reference content from, the Docs team may want to review this addition (even though it lives under the SemVer-exemptexperimentalnamespace).📝 Optional doc tweak
/** * Temporary flag that gates the self-serve OIDC flow in `<ConfigureSSO />`. Remove once the self-serve OIDC flow reaches GA. + * `@default` false */ oidcSelfServe: boolean;🤖 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/types/clerk.ts` around lines 1484 - 1487, The new ClerkOptions experimental flag oidcSelfServe is documented well, but it should be updated for consistency with sibling flags by adding the `@default` false JSDoc tag to reflect that it is off by default. Since this is an exported type that feeds generated reference docs, have the Clerk Docs team review the addition as part of the change, especially within the experimental namespace.Source: Path instructions
🤖 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.
Outside diff comments:
In @.changeset/empty-ducks-tease.md:
- Around line 1-3: The changeset file is still the empty placeholder, but this
PR introduces a code change in the experimental Clerk options / ConfigureSSO
path, so it needs a real release entry. Update the changeset content to include
a short summary of the change and the appropriate package bump(s), using the
existing changeset file as the place to document the impacted package(s) so the
changelog can be generated.
---
Nitpick comments:
In `@packages/shared/src/types/clerk.ts`:
- Around line 1484-1487: The new ClerkOptions experimental flag oidcSelfServe is
documented well, but it should be updated for consistency with sibling flags by
adding the `@default` false JSDoc tag to reflect that it is off by default. Since
this is an exported type that feeds generated reference docs, have the Clerk
Docs team review the addition as part of the change, especially within the
experimental namespace.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 9e7f67db-2260-4329-b791-610053a1f03c
📒 Files selected for processing (3)
.changeset/empty-ducks-tease.mdpackages/shared/src/types/clerk.tspackages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
| @@ -0,0 +1,2 @@ | |||
| --- | |||
There was a problem hiding this comment.
I believe we still need to include the version changes here to bump the packages and build it
Let's write that it's an internal change
Summary
Adds an experimental
oidcSelfServeflag to the ClerkProviderexperimentaloptions, laying the groundwork to gate a forthcoming OIDC self-serve configuration flow in<ConfigureSSO />.<ClerkProvider experimental={{ oidcSelfServe: true }} />(default off).isOIDCFlowEnabledviauseConfigureSSO().experimentalnamespace, so there is no public API impact.ORGS-1741
Summary by CodeRabbit