Skip to content

fix(clerk-js): Support both clerkUICtor and clerkUiCtor for backwards compatibility #7712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jacekradko wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(clerk-js): Support both clerkUICtor and clerkUiCtor for backwards compatibility #7712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0ad49b
fix(clerk-js): Support both clerkUICtor and clerkUiCtor for backwards…
jacekradko Jan 30, 2026
f4ea9e3
chore: add changeset
jacekradko Jan 30, 2026
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/major-parks-study.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clerk/clerk-js": patch
---

Support both `clerkUICtor` and `clerkUiCtor` option names for backwards compatibility
5 changes: 5 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3248,9 +3248,14 @@ export class Clerk implements ClerkInterface {
};

#initOptions = (options?: ClerkOptions): ClerkOptions => {
// Support both clerkUICtor (correct) and clerkUiCtor (legacy) for backwards compatibility
const clerkUICtor =
options?.clerkUICtor ?? (options as Record<string, unknown> | undefined)?.clerkUiCtor ?? undefined;

return {
...defaultOptions,
...options,
clerkUICtor: clerkUICtor as ClerkOptions['clerkUICtor'],
allowedRedirectOrigins: createAllowedRedirectOrigins(
Comment on lines 3250 to 3259
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 30, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Add tests for the legacy alias behavior before merge.

This PR changes initialization to accept both clerkUICtor and clerkUiCtor, but no tests were added to lock in that behavior. Please add coverage for both option names.
As per coding guidelines, “If there are no tests added or modified as part of the PR, please suggest that tests be added to cover the changes.”

🤖 Prompt for AI Agents 
In `@packages/clerk-js/src/core/clerk.ts` around lines 3250 - 3259, Add unit tests
to cover the backward-compatible alias behavior introduced in the `#initOptions`
function: write tests that instantiate Clerk (or call
Clerk.prototype.#initOptions via a public initialization helper) passing options
with clerkUICtor and separately with the legacy clerkUiCtor and assert that the
resulting configuration uses the same constructor value in clerkUICtor; include
tests for both merging with defaultOptions and for when only the legacy key is
provided to ensure createAllowedRedirectOrigins and other returned properties
are preserved. Ensure tests reference the public initialization path that
exercises `#initOptions` (e.g., new Clerk(...) or init method) and assert equality
of the effective clerkUICtor and other merged fields.

options?.allowedRedirectOrigins,
this.frontendApi,
Expand Down
Loading