feat(backend): Add TypeDoc comments to OAuth Application endpoints #6378
Conversation
🦋 Changeset detectedLatest commit: 3ad2bf7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 11 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.
|
SarahSoutoul
changed the title
SarahSoutoul
changed the title
WalkthroughAdds five new OAuth application fields to the backend SDK: JSON contract gains Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
packages/backend/src/api/resources/OAuthApplication.ts (1)
90-90: Add explicit return type to public static factoryProject guidelines require explicit return types for public APIs.
-static fromJSON(data: OAuthApplicationJSON) { +static fromJSON(data: OAuthApplicationJSON): OAuthApplication {
🧹 Nitpick comments (6)
packages/backend/src/api/resources/JSON.ts (1)
323-327: Add TSDoc for the newly added OAuthApplicationJSON fieldsThese types are exported and part of the public API surface. Adding brief comments will improve generated docs and keep parity with the class docs added in OAuthApplication.ts.
Apply something along these lines:
client_id: string; - client_uri: string | null; - client_image_url: string | null; - dynamically_registered: boolean; - consent_screen_enabled: boolean; - pkce_required: boolean; + /** The public-facing URL of the OAuth application, often shown on consent screens. */ + client_uri: string | null; + /** URL to the application's icon/logo. */ + client_image_url: string | null; + /** Whether this application was created via dynamic client registration (RFC 7591). */ + dynamically_registered: boolean; + /** Whether a consent screen is shown in the auth flow. Cannot be disabled for dynamically registered apps. */ + consent_screen_enabled: boolean; + /** Whether PKCE is required for this application. */ + pkce_required: boolean;packages/backend/src/api/resources/OAuthApplication.ts (5)
3-5: Good addition of the class-level docsNice, concise overview. Consider linking to the BAPI reference for discoverability.
Example tweak:
/** - * The Backend `OAuthApplication` object holds information about an OAuth application. + * The Backend `OAuthApplication` object holds information about an OAuth application. + * See: https://clerk.com/docs/reference/backend-api/tag/oauth-applications */
16-18: Remove “new” from property descriptionsThese properties describe an OAuth application resource in any state, not just right after creation. The “new” qualifier is misleading.
- * The name of the new OAuth application. + * The name of the OAuth application. @@ - * Scopes for the new OAuth application. + * Scopes configured for the OAuth application. @@ - * An array of redirect URIs of the new OAuth application. + * The list of redirect URIs configured for the OAuth application.Also applies to: 48-51, 52-55
44-47: Clarify relationship between public clients and PKCEThe current text suggests PKCE can be used if the client is public, which is true but underspecified given the new pkceRequired flag. Tighten the language to avoid confusion.
- * Indicates whether the client is public. If true, the Proof Key of Code Exchange (PKCE) flow can be used. + * Indicates whether the client is public (cannot safely keep a client secret). + * Public clients must use PKCE; confidential clients may also use PKCE.
96-101: Defensive defaults for newly added fields (back-compat with older backends)If any existing installations don’t yet return these properties, the runtime values would be undefined. Default them to safe values.
- data.client_uri, - data.client_image_url, - data.dynamically_registered, - data.consent_screen_enabled, - data.pkce_required, + data.client_uri ?? null, + data.client_image_url ?? null, + data.dynamically_registered ?? false, + data.consent_screen_enabled ?? false, + data.pkce_required ?? false,If the BAPI guarantees they’re always present, keeping the current mapping is fine. Otherwise, these defaults prevent undefined from leaking into the public API at runtime.
90-113: Add unit tests for JSON mapping of new fieldsNo tests in this PR. Add a test that feeds an OAuthApplicationJSON with the new fields and asserts the resulting instance properties, plus a test where the new fields are omitted (if you adopt defensive defaults).
I can scaffold a Jest test like:
- constructs a minimal OAuthApplicationJSON,
- calls OAuthApplication.fromJSON,
- asserts clientUri/clientImageUrl/dynamicallyRegistered/consentScreenEnabled/pkceRequired mapping.
Would you like me to draft it?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
packages/backend/src/api/resources/JSON.ts(1 hunks)packages/backend/src/api/resources/OAuthApplication.ts(2 hunks)
🧰 Additional context used
📓 Path-based instructions (7)
**/*.{js,jsx,ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
**/*.{js,jsx,ts,tsx}: All code must pass ESLint checks with the project's configuration
Follow established naming conventions (PascalCase for components, camelCase for variables)
Maintain comprehensive JSDoc comments for public APIs
Use dynamic imports for optional features
All public APIs must be documented with JSDoc
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Profile and optimize critical paths
Validate all inputs and sanitize outputs
Implement proper logging with different levels
Files:
packages/backend/src/api/resources/JSON.tspackages/backend/src/api/resources/OAuthApplication.ts
**/*.{js,jsx,ts,tsx,json,css,scss,md,yaml,yml}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use Prettier for consistent code formatting
Files:
packages/backend/src/api/resources/JSON.tspackages/backend/src/api/resources/OAuthApplication.ts
packages/**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
TypeScript is required for all packages
Files:
packages/backend/src/api/resources/JSON.tspackages/backend/src/api/resources/OAuthApplication.ts
packages/**/*.{ts,tsx,d.ts}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Packages should export TypeScript types alongside runtime code
Files:
packages/backend/src/api/resources/JSON.tspackages/backend/src/api/resources/OAuthApplication.ts
**/*.{ts,tsx}
📄 CodeRabbit Inference Engine (.cursor/rules/development.mdc)
Use proper TypeScript error types
**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoidanytype - preferunknownwhen type is uncertain, then narrow with type guards
Useinterfacefor object shapes that might be extended
Usetypefor unions, primitives, and computed types
Preferreadonlyproperties for immutable data structures
Useprivatefor internal implementation details
Useprotectedfor inheritance hierarchies
Usepublicexplicitly for clarity in public APIs
Preferreadonlyfor properties that shouldn't change after construction
Prefer composition and interfaces over deep inheritance chains
Use mixins for shared behavior across unrelated classes
Implement dependency injection for loose coupling
Let TypeScript infer when types are obvious
Useconst assertionsfor literal types:as const
Usesatisfiesoperator for type checking without widening
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Use type-only imports:import type { ... } from ...
Noanytypes without justification
Proper error handling with typed errors
Consistent use ofreadonlyfor immutable data
Proper generic constraints
No unused type parameters
Proper use of utility types instead of manual type construction
Type-only imports where possible
Proper tree-shaking friendly exports
No circular dependencies
Efficient type computations (avoid deep recursion)
Files:
packages/backend/src/api/resources/JSON.tspackages/backend/src/api/resources/OAuthApplication.ts
**/*.{js,ts,tsx,jsx}
📄 CodeRabbit Inference Engine (.cursor/rules/monorepo.mdc)
Support multiple Clerk environment variables (CLERK_, NEXT_PUBLIC_CLERK_, etc.) for configuration.
Files:
packages/backend/src/api/resources/JSON.tspackages/backend/src/api/resources/OAuthApplication.ts
**/*
⚙️ CodeRabbit Configuration File
If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.
Files:
packages/backend/src/api/resources/JSON.tspackages/backend/src/api/resources/OAuthApplication.ts
🧬 Code Graph Analysis (1)
packages/backend/src/api/resources/OAuthApplication.ts (1)
packages/backend/src/index.ts (1)
OAuthApplication(132-132)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: semgrep-cloud-platform/scan
🔇 Additional comments (3)
packages/backend/src/api/resources/JSON.ts (1)
323-329: Confirm backend guarantees for new booleans to avoid runtime undefinedThe interface marks the new flags as required booleans. If any older environments omit them, runtime values can be undefined despite the TS type. Ensure the Backend API always returns these fields; otherwise consider defaulting in the consumer (see fromJSON suggestion) or marking them optional here.
Would you like a follow-up PR to align either JSON defaults or consumer defaults based on the BAPI guarantee?
packages/backend/src/api/resources/OAuthApplication.ts (2)
7-88: No external instantiations – constructor only used internally
Verified thatnew OAuthApplication(…)is only called inside the class’s ownfromJSONmethod and nowhere else in the codebase. Since there are no external call sites, this change to the positional parameters cannot break consumer code.
7-88: No change needed: keep barereadonlyper existing convention.We inspected the repository and found that backend resource classes consistently use constructor parameter properties without an explicit
publicmodifier. The brief instances ofpublic readonlyare confined to theclerk-jspackage, not the backend API resources. To stay aligned with local style, leave the constructor parameters as-is.
@clerk/agent-toolkit
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/dev-cli
@clerk/elements
@clerk/clerk-expo
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/clerk-react
@clerk/react-router
@clerk/remix
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/themes
@clerk/types
@clerk/upgrade
@clerk/vue
commit: |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
.changeset/small-moments-find.md(1 hunks)packages/backend/src/api/resources/JSON.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/backend/src/api/resources/JSON.ts
🧰 Additional context used
📓 Path-based instructions (1)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/small-moments-find.md
🪛 LanguageTool
.changeset/small-moments-find.md
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ---
(QB_NEW_DE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: Formatting | Dedupe | Changeset
- GitHub Check: Build Packages
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: semgrep-cloud-platform/scan
- GitHub Check: semgrep-cloud-platform/scan
| --- | ||
| --- |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Empty changeset frontmatter — specify package(s) and bump type, or CI/release will fail
This file contains only two --- lines with no package bump metadata or description. Changesets require a YAML frontmatter block mapping package names to semver bump types, followed by a description. Given the PR adds new OAuthApplication fields (public surface) and TypeDoc, this likely warrants a minor bump for the backend SDK. Please fill this out (or remove the file if no release is intended).
Suggested content (verify package names and bump types before committing):
----
----
+---
+ '@clerk/backend': minor
+---
+
+feat(backend): Add TypeDoc to OAuthApplication and surface new fields
+
+- JSON: client_uri, client_image_url, dynamically_registered, consent_screen_enabled, pkce_required
+- Class: clientUri, clientImageUrl, dynamicallyRegistered, consentScreenEnabled, pkceRequiredIf additional published packages are affected, list them in the same frontmatter block with their respective bump types.
Run this script to verify the correct package name(s) and decide bump levels based on changed files:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# List changed files against main (adjust base if needed)
BASE_REF=${BASE_REF:-origin/main}
git fetch -q origin || true
CHANGED_FILES=$(git diff --name-only "${BASE_REF}"...HEAD)
echo "Changed files:"
printf "%s\n" "${CHANGED_FILES}"
echo
echo "Resolving impacted package roots and names:"
echo "${CHANGED_FILES}" | while read -r f; do
# Walk up to find nearest package.json
dir="$(dirname "$f")"
while [[ "$dir" != "." && "$dir" != "/" ]]; do
if [[ -f "$dir/package.json" ]]; then
echo "$dir/package.json"
break
fi
dir="$(dirname "$dir")"
done
done | sort -u | while read -r pkgjson; do
name=$(jq -r '.name' "$pkgjson" 2>/dev/null || echo null)
private=$(jq -r '.private // false' "$pkgjson" 2>/dev/null || echo false)
echo "• $(dirname "$pkgjson") — name: $name — private: $private"
done
echo
echo "Tip:"
echo "- Use 'minor' if you surfaced new public fields/types; 'patch' if purely docs/internal."Length of output: 3324
Specify the changeset frontmatter for @clerk/backend
Your .changeset/small-moments-find.md is currently empty, which will cause CI/release to fail. Since your PR adds new public fields/types to the backend SDK, you should apply a minor bump to @clerk/backend. Please update the file to include:
---
-
+
+---
+ '@clerk/backend': minor
+---
+
+feat(backend): add TypeDoc & expose new OAuthApplication fields
+
+- JSON: client_uri, client_image_url, dynamically_registered, consent_screen_enabled, pkce_required
+- Class: clientUri, clientImageUrl, dynamicallyRegistered, consentScreenEnabled, pkceRequired• File needing update:
- .changeset/small-moments-find.md
Tag the correct package and bump type to ensure the release goes out smoothly.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[grammar] ~1-~1: Hier könnte ein Fehler sein.
Context: --- ---
(QB_NEW_DE)
🤖 Prompt for AI Agents
In .changeset/small-moments-find.md around lines 1 to 2, the file is empty and
missing the required changeset frontmatter; add a valid changeset YAML block
that lists the package @clerk/backend and sets the bump type to "minor" (and
include a short summary message), ensuring the file begins and ends with --- and
contains the package name and "minor" bump so CI/release will succeed.
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
.changeset/blue-comics-kneel.md (1)
1-6: Empty Changeset Body DetectedThe file
.changeset/old-dolls-smell.mdcontains only the frontmatter delimiters and no descriptive content. This will break the release pipeline.• Problematic file:
.changeset/old-dolls-smell.md--- ---• Required fix:
- Add meaningful change description below the second
---, for example:--- '@clerk/some-package': patch --- Describe the change introduced by this release here.- Or, if this changeset is not needed, delete the file.
Please update or remove
.changeset/old-dolls-smell.mdbefore merging.
🧹 Nitpick comments (1)
.changeset/blue-comics-kneel.md (1)
5-5: Strengthen the release note to enumerate added fields and doc updates.Being explicit here helps downstream readers and release notes consumers. Suggest expanding the description.
Apply this diff to make the intent crystal clear:
-Add missing properties to OAuthApplicationJSON +Expose new OAuthApplication fields and docs. + +Adds the following properties to OAuthApplicationJSON and surfaces them on OAuthApplication: +- client_uri +- client_image_url +- dynamically_registered +- consent_screen_enabled +- pkce_required + +Also adds TypeDoc to OAuthApplication and updates fromJSON mappings.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (1)
.typedoc/__tests__/__snapshots__/file-structure.test.ts.snapis excluded by!**/*.snap
📒 Files selected for processing (1)
.changeset/blue-comics-kneel.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
.changeset/**
📄 CodeRabbit inference engine (.cursor/rules/monorepo.mdc)
Automated releases must use Changesets.
Files:
.changeset/blue-comics-kneel.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: pr-title-lint
- GitHub Check: Integration Tests (nextjs, chrome, 14)
- GitHub Check: Integration Tests (billing, chrome)
- GitHub Check: Integration Tests (nextjs, chrome, 15)
- GitHub Check: Integration Tests (generic, chrome)
🔇 Additional comments (2)
.changeset/blue-comics-kneel.md (2)
1-3: Changeset frontmatter looks valid; minor bump is reasonable.This adheres to our release process under
.changeset/**and a minor version makes sense for adding new, non-breaking fields and documentation to the backend SDK.
2-2: Confirm semver classification for added TS fieldsI ran a repository-wide search for common break-risk patterns but found no matches; however, absence of evidence isn’t evidence of absence. Please manually verify that our TypeScript compatibility policy permits adding required properties to a public interface before classifying this as a minor bump.
• No object-literal assignments of
OAuthApplicationJSONwere found (e.g.const x: OAuthApplicationJSON = { … }).
• No external calls tonew OAuthApplication(…)outside ofpackages/backendwere detected.
• No explicit semver/TS-compatibility guidance was located inREADME.mdordocs/.Next steps:
- Review our TS compatibility policy on additive interface fields—if required properties are considered breaking, either make the new fields optional or bump to a major release.
- If the policy does treat these changes as non-breaking, the minor bump is acceptable; otherwise update the changeset to a major version.
Description
What does this solve?
Linear: https://linear.app/clerk/issue/DOCS-10504/document-oauth-applications-js-backend-sdk-endpoints
Currently, the clerk docs don't have any information around the OAuth applications JS Backend SDK endpoints. This PR adds documentation for the backend OAuthApplication object type. This PR works in conjunction with this one here: clerk/clerk-docs#2447.
Used the following links for information:
What changed?
Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change
Summary by CodeRabbit
New Features
Chores