feat(backend): add OAuth application token revocation#9040
Conversation
🦋 Changeset detectedLatest commit: 2aff791 The changes in this PR will be included in the next version bump. This PR includes changesets to release 10 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.
|
📝 WalkthroughWalkthroughAdds ChangesOAuth Application revokeToken
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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
No API Changes DetectedAll packages have stable APIs with no detected changes. Report generated by Break Check Last ran on |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
packages/backend/src/api/endpoints/OAuthApplicationsApi.ts (1)
40-49: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAdd JSDoc and an explicit return type to
revokeToken()
clerkClient.oauthApplications.revokeToken()is publicpackages/**surface; add method-level JSDoc for the generated reference docs and annotate it asPromise<void>.🤖 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/backend/src/api/endpoints/OAuthApplicationsApi.ts` around lines 40 - 49, Add method-level JSDoc to revokeToken() so it appears correctly in the generated reference docs, and annotate its signature with an explicit Promise<void> return type. Update the revokeToken() declaration in OAuthApplicationsApi alongside RevokeOAuthApplicationTokenParams so the public clerkClient.oauthApplications surface is fully typed and documented.Sources: Coding guidelines, 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.
Nitpick comments:
In `@packages/backend/src/api/endpoints/OAuthApplicationsApi.ts`:
- Around line 40-49: Add method-level JSDoc to revokeToken() so it appears
correctly in the generated reference docs, and annotate its signature with an
explicit Promise<void> return type. Update the revokeToken() declaration in
OAuthApplicationsApi alongside RevokeOAuthApplicationTokenParams so the public
clerkClient.oauthApplications surface is fully typed and documented.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 151c11d6-dd13-420b-a35f-bd4ab3fa5c53
📒 Files selected for processing (4)
.changeset/oauth-application-revoke-token.mdpackages/backend/src/api/__tests__/OAuthApplicationsApi.test.tspackages/backend/src/api/endpoints/OAuthApplicationsApi.tspackages/backend/src/api/request.ts
Summary
Adds SDK support for the new OAuth application token revocation endpoint and documents the backend SDK method.
Validation run:
Changes in this repo
Adds clerkClient.oauthApplications.revokeToken(), handles 204 responses as void, includes focused node and edge-runtime tests, and adds a changeset for @clerk/backend.
Companion PRs
Summary by CodeRabbit
New Features
Bug Fixes
Documentation