chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links#6531

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

Merged
NWylynko merged 4 commits into from
Aug 13, 2025
Merged

chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links #6531

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8da6e33
Wrap components in back ticks so mdx renderer doesn't attempt to inse…
NWylynko Aug 13, 2025
ec8c5c2
Convert LocalizationResource to an interface to fix link
NWylynko Aug 13, 2025
271cb89
Add link replacement pointing to CommerceSubscriptionItemResource
NWylynko Aug 13, 2025
e41768f
Add patch changeset
NWylynko Aug 13, 2025
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/full-times-wear.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Convert LocalizationResource to interface for typedoc documentation
6 changes: 2 additions & 4 deletions .typedoc/custom-plugin.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
['saml-account', '/docs/references/backend/types/backend-saml-account'],
['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
['verify-token-options', '#verify-token-options'],
['localization-resource', '/docs/customization/localization'],
['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
];

/**
Expand DownExpand Up@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
pattern: /\(setActiveParams\)/g,
replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
},
{
pattern: /`_LocalizationResource`/g,
replace: '[Localization](/docs/customization/localization)',
},
{
pattern: /`LoadedClerk`/g,
replace: '[Clerk](/docs/references/javascript/clerk)',
Expand Down
24 changes: 12 additions & 12 deletions packages/types/src/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -653,31 +653,31 @@
buildUrlWithAuth(to: string): string;

/**
* Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
* Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
*
* @param opts A {@link RedirectOptions} object
*/
buildSignInUrl(opts?: RedirectOptions): string;

/**
* Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
* Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
*
* @param opts A {@link RedirectOptions} object
*/
buildSignUpUrl(opts?: RedirectOptions): string;

/**
* Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
* Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
*/
buildUserProfileUrl(): string;

/**
* Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
* Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
*/
buildCreateOrganizationUrl(): string;

/**
* Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
* Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
*/
buildOrganizationProfileUrl(): string;

Expand DownExpand Up@@ -707,7 +707,7 @@
buildAfterMultiSessionSingleSignOutUrl(): string;

/**
* Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
* Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
*/
buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;

Expand All@@ -720,31 +720,31 @@
redirectWithAuth(to: string): Promise<unknown>;

/**
* Redirects to the configured URL where <SignIn/> is mounted.
* Redirects to the configured URL where `<SignIn/>` is mounted.
*
* @param opts A {@link RedirectOptions} object
*/
redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;

/**
* Redirects to the configured URL where <SignUp/> is mounted.
* Redirects to the configured URL where `<SignUp/>` is mounted.
*
* @param opts A {@link RedirectOptions} object
*/
redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;

/**
* Redirects to the configured URL where <UserProfile/> is mounted.
* Redirects to the configured URL where `<UserProfile/>` is mounted.
*/
redirectToUserProfile: () => Promise<unknown>;

/**
* Redirects to the configured URL where <OrganizationProfile /> is mounted.
* Redirects to the configured URL where `<OrganizationProfile />` is mounted.
*/
redirectToOrganizationProfile: () => Promise<unknown>;

/**
* Redirects to the configured URL where <CreateOrganization /> is mounted.
* Redirects to the configured URL where `<CreateOrganization />` is mounted.
*/
redirectToCreateOrganization: () => Promise<unknown>;

Expand All@@ -764,7 +764,7 @@
redirectToAfterSignOut: () => void;

/**
* Redirects to the configured URL where <Waitlist/> is mounted.
* Redirects to the configured URL where `<Waitlist/>` is mounted.
*/
redirectToWaitlist: () => void;

Expand DownExpand Up@@ -1146,7 +1146,7 @@
*/
windowNavigate: (to: URL | string) => void;
},
) => Promise<unknown> | unknown;

Check warning on line 1149 in packages/types/src/clerk.ts

View workflow job for this annotation

GitHub Actions/ Static analysis

'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down
4 changes: 3 additions & 1 deletion packages/types/src/localization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
* the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
* as a starting point.
*/
export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
export interface LocalizationResource
extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}

@NWylynkoNWylynkoAug 13, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

This fixes the type from DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>

image

To LocalizationResource

Image

And because of the link replacement in .typedoc/custom-plugin.mjs:56 it then points to /docs/customization/localization

@NWylynkoNWylynkoAug 13, 2025

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I am not sure if this change from type to interface is ok with just doing an empty changeset, or if this should be a patch

@wobsorianowobsorianoAug 13, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We use it internally in @clerk/clerk-js and @clerk/localizations, but technically it's still public because anyone can import it from @clerk/types for some random reason. So at least a patch changeset would be appropriate 🤔


export type __internal_LocalizationResource = {
locale: string;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links#6531

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

 Merged

NWylynko
merged 4 commits into

from

Aug 13, 2025
 Merged


chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links
#6531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8da6e33

Wrap components in back ticks so mdx renderer doesn't attempt to inse…


NWylynko Aug 13, 2025
ec8c5c2

Convert LocalizationResource to an interface to fix link


NWylynko Aug 13, 2025
271cb89

Add link replacement pointing to CommerceSubscriptionItemResource


NWylynko Aug 13, 2025
e41768f

Add patch changeset


NWylynko Aug 13, 2025

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/full-times-wear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Convert LocalizationResource to interface for typedoc documentation

6 changes: 2 additions & 4 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
 ['saml-account', '/docs/references/backend/types/backend-saml-account'],
 ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
 ['verify-token-options', '#verify-token-options'],
 ['localization-resource', '/docs/customization/localization'],
 ['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
];

/**
Expand DownExpand Up@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
 pattern: /\(setActiveParams\)/g,
 replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
 },
 {
 pattern: /`_LocalizationResource`/g,
 replace: '[Localization](/docs/customization/localization)',
 },
 {
 pattern: /`LoadedClerk`/g,
 replace: '[Clerk](/docs/references/javascript/clerk)',
Expand Down

24 changes: 12 additions & 12 deletions
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,31 +653,31 @@
 buildUrlWithAuth(to: string): string;

 /**
 * Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
 * Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignInUrl(opts?: RedirectOptions): string;

 /**
 * Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
 * Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignUpUrl(opts?: RedirectOptions): string;

 /**
 * Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
 * Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
 */
 buildUserProfileUrl(): string;

 /**
 * Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
 * Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
 */
 buildCreateOrganizationUrl(): string;

 /**
 * Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
 * Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
 */
 buildOrganizationProfileUrl(): string;

Expand DownExpand Up@@ -707,7 +707,7 @@
 buildAfterMultiSessionSingleSignOutUrl(): string;

 /**
 * Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
 * Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
 */
 buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;

Expand All@@ -720,31 +720,31 @@
 redirectWithAuth(to: string): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignIn/> is mounted.
 * Redirects to the configured URL where `<SignIn/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignUp/> is mounted.
 * Redirects to the configured URL where `<SignUp/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <UserProfile/> is mounted.
 * Redirects to the configured URL where `<UserProfile/>` is mounted.
 */
 redirectToUserProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <OrganizationProfile /> is mounted.
 * Redirects to the configured URL where `<OrganizationProfile />` is mounted.
 */
 redirectToOrganizationProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <CreateOrganization /> is mounted.
 * Redirects to the configured URL where `<CreateOrganization />` is mounted.
 */
 redirectToCreateOrganization: () => Promise<unknown>;

Expand All@@ -764,7 +764,7 @@
 redirectToAfterSignOut: () => void;

 /**
 * Redirects to the configured URL where <Waitlist/> is mounted.
 * Redirects to the configured URL where `<Waitlist/>` is mounted.
 */
 redirectToWaitlist: () => void;

Expand DownExpand Up@@ -1146,7 +1146,7 @@
 */
 windowNavigate: (to: URL | string) => void;
 },
) => Promise<unknown> | unknown;

Check warning
on line 1149
in packages/types/src/clerk.ts

View workflow job for this annotation
GitHub Actions/ Static analysis
'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
 * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
 * as a starting point.
 */
export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
export interface LocalizationResource
 extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This fixes the type from DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>
image
To LocalizationResource
Image
And because of the link replacement in .typedoc/custom-plugin.mjs:56 it then points to /docs/customization/localization
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I am not sure if this change from type to interface is ok with just doing an empty changeset, or if this should be a patch
@wobsorianowobsorianoAug 13, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We use it internally in @clerk/clerk-js and @clerk/localizations, but technically it's still public because anyone can import it from @clerk/types for some random reason. So at least a patch changeset would be appropriate 🤔

export type __internal_LocalizationResource = {
 locale: string;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links#6531

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

 Merged

NWylynko
merged 4 commits into

from

Aug 13, 2025
 Merged


chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links
#6531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8da6e33

Wrap components in back ticks so mdx renderer doesn't attempt to inse…


NWylynko Aug 13, 2025
ec8c5c2

Convert LocalizationResource to an interface to fix link


NWylynko Aug 13, 2025
271cb89

Add link replacement pointing to CommerceSubscriptionItemResource


NWylynko Aug 13, 2025
e41768f

Add patch changeset


NWylynko Aug 13, 2025

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/full-times-wear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Convert LocalizationResource to interface for typedoc documentation

6 changes: 2 additions & 4 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
 ['saml-account', '/docs/references/backend/types/backend-saml-account'],
 ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
 ['verify-token-options', '#verify-token-options'],
 ['localization-resource', '/docs/customization/localization'],
 ['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
];

/**
Expand DownExpand Up@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
 pattern: /\(setActiveParams\)/g,
 replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
 },
 {
 pattern: /`_LocalizationResource`/g,
 replace: '[Localization](/docs/customization/localization)',
 },
 {
 pattern: /`LoadedClerk`/g,
 replace: '[Clerk](/docs/references/javascript/clerk)',
Expand Down

24 changes: 12 additions & 12 deletions
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,31 +653,31 @@
 buildUrlWithAuth(to: string): string;

 /**
 * Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
 * Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignInUrl(opts?: RedirectOptions): string;

 /**
 * Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
 * Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignUpUrl(opts?: RedirectOptions): string;

 /**
 * Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
 * Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
 */
 buildUserProfileUrl(): string;

 /**
 * Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
 * Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
 */
 buildCreateOrganizationUrl(): string;

 /**
 * Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
 * Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
 */
 buildOrganizationProfileUrl(): string;

Expand DownExpand Up@@ -707,7 +707,7 @@
 buildAfterMultiSessionSingleSignOutUrl(): string;

 /**
 * Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
 * Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
 */
 buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;

Expand All@@ -720,31 +720,31 @@
 redirectWithAuth(to: string): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignIn/> is mounted.
 * Redirects to the configured URL where `<SignIn/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignUp/> is mounted.
 * Redirects to the configured URL where `<SignUp/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <UserProfile/> is mounted.
 * Redirects to the configured URL where `<UserProfile/>` is mounted.
 */
 redirectToUserProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <OrganizationProfile /> is mounted.
 * Redirects to the configured URL where `<OrganizationProfile />` is mounted.
 */
 redirectToOrganizationProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <CreateOrganization /> is mounted.
 * Redirects to the configured URL where `<CreateOrganization />` is mounted.
 */
 redirectToCreateOrganization: () => Promise<unknown>;

Expand All@@ -764,7 +764,7 @@
 redirectToAfterSignOut: () => void;

 /**
 * Redirects to the configured URL where <Waitlist/> is mounted.
 * Redirects to the configured URL where `<Waitlist/>` is mounted.
 */
 redirectToWaitlist: () => void;

Expand DownExpand Up@@ -1146,7 +1146,7 @@
 */
 windowNavigate: (to: URL | string) => void;
 },
) => Promise<unknown> | unknown;

Check warning
on line 1149
in packages/types/src/clerk.ts

View workflow job for this annotation
GitHub Actions/ Static analysis
'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
 * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
 * as a starting point.
 */
export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
export interface LocalizationResource
 extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This fixes the type from DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>
image
To LocalizationResource
Image
And because of the link replacement in .typedoc/custom-plugin.mjs:56 it then points to /docs/customization/localization
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I am not sure if this change from type to interface is ok with just doing an empty changeset, or if this should be a patch
@wobsorianowobsorianoAug 13, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We use it internally in @clerk/clerk-js and @clerk/localizations, but technically it's still public because anyone can import it from @clerk/types for some random reason. So at least a patch changeset would be appropriate 🤔

export type __internal_LocalizationResource = {
 locale: string;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links#6531

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

 Merged

NWylynko
merged 4 commits into

from

Aug 13, 2025
 Merged


chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links
#6531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8da6e33

Wrap components in back ticks so mdx renderer doesn't attempt to inse…


NWylynko Aug 13, 2025
ec8c5c2

Convert LocalizationResource to an interface to fix link


NWylynko Aug 13, 2025
271cb89

Add link replacement pointing to CommerceSubscriptionItemResource


NWylynko Aug 13, 2025
e41768f

Add patch changeset


NWylynko Aug 13, 2025

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/full-times-wear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Convert LocalizationResource to interface for typedoc documentation

6 changes: 2 additions & 4 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
 ['saml-account', '/docs/references/backend/types/backend-saml-account'],
 ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
 ['verify-token-options', '#verify-token-options'],
 ['localization-resource', '/docs/customization/localization'],
 ['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
];

/**
Expand DownExpand Up@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
 pattern: /\(setActiveParams\)/g,
 replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
 },
 {
 pattern: /`_LocalizationResource`/g,
 replace: '[Localization](/docs/customization/localization)',
 },
 {
 pattern: /`LoadedClerk`/g,
 replace: '[Clerk](/docs/references/javascript/clerk)',
Expand Down

24 changes: 12 additions & 12 deletions
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,31 +653,31 @@
 buildUrlWithAuth(to: string): string;

 /**
 * Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
 * Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignInUrl(opts?: RedirectOptions): string;

 /**
 * Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
 * Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignUpUrl(opts?: RedirectOptions): string;

 /**
 * Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
 * Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
 */
 buildUserProfileUrl(): string;

 /**
 * Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
 * Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
 */
 buildCreateOrganizationUrl(): string;

 /**
 * Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
 * Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
 */
 buildOrganizationProfileUrl(): string;

Expand DownExpand Up@@ -707,7 +707,7 @@
 buildAfterMultiSessionSingleSignOutUrl(): string;

 /**
 * Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
 * Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
 */
 buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;

Expand All@@ -720,31 +720,31 @@
 redirectWithAuth(to: string): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignIn/> is mounted.
 * Redirects to the configured URL where `<SignIn/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignUp/> is mounted.
 * Redirects to the configured URL where `<SignUp/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <UserProfile/> is mounted.
 * Redirects to the configured URL where `<UserProfile/>` is mounted.
 */
 redirectToUserProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <OrganizationProfile /> is mounted.
 * Redirects to the configured URL where `<OrganizationProfile />` is mounted.
 */
 redirectToOrganizationProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <CreateOrganization /> is mounted.
 * Redirects to the configured URL where `<CreateOrganization />` is mounted.
 */
 redirectToCreateOrganization: () => Promise<unknown>;

Expand All@@ -764,7 +764,7 @@
 redirectToAfterSignOut: () => void;

 /**
 * Redirects to the configured URL where <Waitlist/> is mounted.
 * Redirects to the configured URL where `<Waitlist/>` is mounted.
 */
 redirectToWaitlist: () => void;

Expand DownExpand Up@@ -1146,7 +1146,7 @@
 */
 windowNavigate: (to: URL | string) => void;
 },
) => Promise<unknown> | unknown;

Check warning
on line 1149
in packages/types/src/clerk.ts

View workflow job for this annotation
GitHub Actions/ Static analysis
'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
 * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
 * as a starting point.
 */
export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
export interface LocalizationResource
 extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This fixes the type from DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>
image
To LocalizationResource
Image
And because of the link replacement in .typedoc/custom-plugin.mjs:56 it then points to /docs/customization/localization
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I am not sure if this change from type to interface is ok with just doing an empty changeset, or if this should be a patch
@wobsorianowobsorianoAug 13, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We use it internally in @clerk/clerk-js and @clerk/localizations, but technically it's still public because anyone can import it from @clerk/types for some random reason. So at least a patch changeset would be appropriate 🤔

export type __internal_LocalizationResource = {
 locale: string;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links#6531

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

 Merged

NWylynko
merged 4 commits into

from

Aug 13, 2025
 Merged


chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links
#6531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8da6e33

Wrap components in back ticks so mdx renderer doesn't attempt to inse…


NWylynko Aug 13, 2025
ec8c5c2

Convert LocalizationResource to an interface to fix link


NWylynko Aug 13, 2025
271cb89

Add link replacement pointing to CommerceSubscriptionItemResource


NWylynko Aug 13, 2025
e41768f

Add patch changeset


NWylynko Aug 13, 2025

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/full-times-wear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Convert LocalizationResource to interface for typedoc documentation

6 changes: 2 additions & 4 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
 ['saml-account', '/docs/references/backend/types/backend-saml-account'],
 ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
 ['verify-token-options', '#verify-token-options'],
 ['localization-resource', '/docs/customization/localization'],
 ['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
];

/**
Expand DownExpand Up@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
 pattern: /\(setActiveParams\)/g,
 replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
 },
 {
 pattern: /`_LocalizationResource`/g,
 replace: '[Localization](/docs/customization/localization)',
 },
 {
 pattern: /`LoadedClerk`/g,
 replace: '[Clerk](/docs/references/javascript/clerk)',
Expand Down

24 changes: 12 additions & 12 deletions
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,31 +653,31 @@
 buildUrlWithAuth(to: string): string;

 /**
 * Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
 * Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignInUrl(opts?: RedirectOptions): string;

 /**
 * Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
 * Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignUpUrl(opts?: RedirectOptions): string;

 /**
 * Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
 * Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
 */
 buildUserProfileUrl(): string;

 /**
 * Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
 * Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
 */
 buildCreateOrganizationUrl(): string;

 /**
 * Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
 * Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
 */
 buildOrganizationProfileUrl(): string;

Expand DownExpand Up@@ -707,7 +707,7 @@
 buildAfterMultiSessionSingleSignOutUrl(): string;

 /**
 * Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
 * Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
 */
 buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;

Expand All@@ -720,31 +720,31 @@
 redirectWithAuth(to: string): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignIn/> is mounted.
 * Redirects to the configured URL where `<SignIn/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignUp/> is mounted.
 * Redirects to the configured URL where `<SignUp/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <UserProfile/> is mounted.
 * Redirects to the configured URL where `<UserProfile/>` is mounted.
 */
 redirectToUserProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <OrganizationProfile /> is mounted.
 * Redirects to the configured URL where `<OrganizationProfile />` is mounted.
 */
 redirectToOrganizationProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <CreateOrganization /> is mounted.
 * Redirects to the configured URL where `<CreateOrganization />` is mounted.
 */
 redirectToCreateOrganization: () => Promise<unknown>;

Expand All@@ -764,7 +764,7 @@
 redirectToAfterSignOut: () => void;

 /**
 * Redirects to the configured URL where <Waitlist/> is mounted.
 * Redirects to the configured URL where `<Waitlist/>` is mounted.
 */
 redirectToWaitlist: () => void;

Expand DownExpand Up@@ -1146,7 +1146,7 @@
 */
 windowNavigate: (to: URL | string) => void;
 },
) => Promise<unknown> | unknown;

Check warning
on line 1149
in packages/types/src/clerk.ts

View workflow job for this annotation
GitHub Actions/ Static analysis
'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
 * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
 * as a starting point.
 */
export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
export interface LocalizationResource
 extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This fixes the type from DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>
image
To LocalizationResource
Image
And because of the link replacement in .typedoc/custom-plugin.mjs:56 it then points to /docs/customization/localization
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I am not sure if this change from type to interface is ok with just doing an empty changeset, or if this should be a patch
@wobsorianowobsorianoAug 13, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We use it internally in @clerk/clerk-js and @clerk/localizations, but technically it's still public because anyone can import it from @clerk/types for some random reason. So at least a patch changeset would be appropriate 🤔

export type __internal_LocalizationResource = {
 locale: string;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links#6531

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

 Merged

NWylynko
merged 4 commits into

from

Aug 13, 2025
 Merged


chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links
#6531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8da6e33

Wrap components in back ticks so mdx renderer doesn't attempt to inse…


NWylynko Aug 13, 2025
ec8c5c2

Convert LocalizationResource to an interface to fix link


NWylynko Aug 13, 2025
271cb89

Add link replacement pointing to CommerceSubscriptionItemResource


NWylynko Aug 13, 2025
e41768f

Add patch changeset


NWylynko Aug 13, 2025

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/full-times-wear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Convert LocalizationResource to interface for typedoc documentation

6 changes: 2 additions & 4 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
 ['saml-account', '/docs/references/backend/types/backend-saml-account'],
 ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
 ['verify-token-options', '#verify-token-options'],
 ['localization-resource', '/docs/customization/localization'],
 ['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
];

/**
Expand DownExpand Up@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
 pattern: /\(setActiveParams\)/g,
 replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
 },
 {
 pattern: /`_LocalizationResource`/g,
 replace: '[Localization](/docs/customization/localization)',
 },
 {
 pattern: /`LoadedClerk`/g,
 replace: '[Clerk](/docs/references/javascript/clerk)',
Expand Down

24 changes: 12 additions & 12 deletions
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,31 +653,31 @@
 buildUrlWithAuth(to: string): string;

 /**
 * Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
 * Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignInUrl(opts?: RedirectOptions): string;

 /**
 * Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
 * Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignUpUrl(opts?: RedirectOptions): string;

 /**
 * Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
 * Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
 */
 buildUserProfileUrl(): string;

 /**
 * Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
 * Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
 */
 buildCreateOrganizationUrl(): string;

 /**
 * Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
 * Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
 */
 buildOrganizationProfileUrl(): string;

Expand DownExpand Up@@ -707,7 +707,7 @@
 buildAfterMultiSessionSingleSignOutUrl(): string;

 /**
 * Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
 * Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
 */
 buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;

Expand All@@ -720,31 +720,31 @@
 redirectWithAuth(to: string): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignIn/> is mounted.
 * Redirects to the configured URL where `<SignIn/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignUp/> is mounted.
 * Redirects to the configured URL where `<SignUp/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <UserProfile/> is mounted.
 * Redirects to the configured URL where `<UserProfile/>` is mounted.
 */
 redirectToUserProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <OrganizationProfile /> is mounted.
 * Redirects to the configured URL where `<OrganizationProfile />` is mounted.
 */
 redirectToOrganizationProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <CreateOrganization /> is mounted.
 * Redirects to the configured URL where `<CreateOrganization />` is mounted.
 */
 redirectToCreateOrganization: () => Promise<unknown>;

Expand All@@ -764,7 +764,7 @@
 redirectToAfterSignOut: () => void;

 /**
 * Redirects to the configured URL where <Waitlist/> is mounted.
 * Redirects to the configured URL where `<Waitlist/>` is mounted.
 */
 redirectToWaitlist: () => void;

Expand DownExpand Up@@ -1146,7 +1146,7 @@
 */
 windowNavigate: (to: URL | string) => void;
 },
) => Promise<unknown> | unknown;

Check warning
on line 1149
in packages/types/src/clerk.ts

View workflow job for this annotation
GitHub Actions/ Static analysis
'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
 * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
 * as a starting point.
 */
export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
export interface LocalizationResource
 extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This fixes the type from DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>
image
To LocalizationResource
Image
And because of the link replacement in .typedoc/custom-plugin.mjs:56 it then points to /docs/customization/localization
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I am not sure if this change from type to interface is ok with just doing an empty changeset, or if this should be a patch
@wobsorianowobsorianoAug 13, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We use it internally in @clerk/clerk-js and @clerk/localizations, but technically it's still public because anyone can import it from @clerk/types for some random reason. So at least a patch changeset would be appropriate 🤔

export type __internal_LocalizationResource = {
 locale: string;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links#6531

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

 Merged

NWylynko
merged 4 commits into

from

Aug 13, 2025
 Merged


chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links
#6531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8da6e33

Wrap components in back ticks so mdx renderer doesn't attempt to inse…


NWylynko Aug 13, 2025
ec8c5c2

Convert LocalizationResource to an interface to fix link


NWylynko Aug 13, 2025
271cb89

Add link replacement pointing to CommerceSubscriptionItemResource


NWylynko Aug 13, 2025
e41768f

Add patch changeset


NWylynko Aug 13, 2025

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/full-times-wear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Convert LocalizationResource to interface for typedoc documentation

6 changes: 2 additions & 4 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
 ['saml-account', '/docs/references/backend/types/backend-saml-account'],
 ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
 ['verify-token-options', '#verify-token-options'],
 ['localization-resource', '/docs/customization/localization'],
 ['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
];

/**
Expand DownExpand Up@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
 pattern: /\(setActiveParams\)/g,
 replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
 },
 {
 pattern: /`_LocalizationResource`/g,
 replace: '[Localization](/docs/customization/localization)',
 },
 {
 pattern: /`LoadedClerk`/g,
 replace: '[Clerk](/docs/references/javascript/clerk)',
Expand Down

24 changes: 12 additions & 12 deletions
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,31 +653,31 @@
 buildUrlWithAuth(to: string): string;

 /**
 * Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
 * Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignInUrl(opts?: RedirectOptions): string;

 /**
 * Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
 * Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignUpUrl(opts?: RedirectOptions): string;

 /**
 * Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
 * Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
 */
 buildUserProfileUrl(): string;

 /**
 * Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
 * Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
 */
 buildCreateOrganizationUrl(): string;

 /**
 * Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
 * Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
 */
 buildOrganizationProfileUrl(): string;

Expand DownExpand Up@@ -707,7 +707,7 @@
 buildAfterMultiSessionSingleSignOutUrl(): string;

 /**
 * Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
 * Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
 */
 buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;

Expand All@@ -720,31 +720,31 @@
 redirectWithAuth(to: string): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignIn/> is mounted.
 * Redirects to the configured URL where `<SignIn/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignUp/> is mounted.
 * Redirects to the configured URL where `<SignUp/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <UserProfile/> is mounted.
 * Redirects to the configured URL where `<UserProfile/>` is mounted.
 */
 redirectToUserProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <OrganizationProfile /> is mounted.
 * Redirects to the configured URL where `<OrganizationProfile />` is mounted.
 */
 redirectToOrganizationProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <CreateOrganization /> is mounted.
 * Redirects to the configured URL where `<CreateOrganization />` is mounted.
 */
 redirectToCreateOrganization: () => Promise<unknown>;

Expand All@@ -764,7 +764,7 @@
 redirectToAfterSignOut: () => void;

 /**
 * Redirects to the configured URL where <Waitlist/> is mounted.
 * Redirects to the configured URL where `<Waitlist/>` is mounted.
 */
 redirectToWaitlist: () => void;

Expand DownExpand Up@@ -1146,7 +1146,7 @@
 */
 windowNavigate: (to: URL | string) => void;
 },
) => Promise<unknown> | unknown;

Check warning
on line 1149
in packages/types/src/clerk.ts

View workflow job for this annotation
GitHub Actions/ Static analysis
'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
 * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
 * as a starting point.
 */
export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
export interface LocalizationResource
 extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This fixes the type from DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>
image
To LocalizationResource
Image
And because of the link replacement in .typedoc/custom-plugin.mjs:56 it then points to /docs/customization/localization
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I am not sure if this change from type to interface is ok with just doing an empty changeset, or if this should be a patch
@wobsorianowobsorianoAug 13, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We use it internally in @clerk/clerk-js and @clerk/localizations, but technically it's still public because anyone can import it from @clerk/types for some random reason. So at least a patch changeset would be appropriate 🤔

export type __internal_LocalizationResource = {
 locale: string;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links#6531

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

 Merged

NWylynko
merged 4 commits into

from

Aug 13, 2025
 Merged


chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links
#6531
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
8da6e33

Wrap components in back ticks so mdx renderer doesn't attempt to inse…


NWylynko Aug 13, 2025
ec8c5c2

Convert LocalizationResource to an interface to fix link


NWylynko Aug 13, 2025
271cb89

Add link replacement pointing to CommerceSubscriptionItemResource


NWylynko Aug 13, 2025
e41768f

Add patch changeset


NWylynko Aug 13, 2025

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/full-times-wear.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': patch
---

Convert LocalizationResource to interface for typedoc documentation

6 changes: 2 additions & 4 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
 ['saml-account', '/docs/references/backend/types/backend-saml-account'],
 ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
 ['verify-token-options', '#verify-token-options'],
 ['localization-resource', '/docs/customization/localization'],
 ['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
];

/**
Expand DownExpand Up@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
 pattern: /\(setActiveParams\)/g,
 replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
 },
 {
 pattern: /`_LocalizationResource`/g,
 replace: '[Localization](/docs/customization/localization)',
 },
 {
 pattern: /`LoadedClerk`/g,
 replace: '[Clerk](/docs/references/javascript/clerk)',
Expand Down

24 changes: 12 additions & 12 deletions
packages/types/src/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -653,31 +653,31 @@
 buildUrlWithAuth(to: string): string;

 /**
 * Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
 * Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignInUrl(opts?: RedirectOptions): string;

 /**
 * Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
 * Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
 *
 * @param opts A {@link RedirectOptions} object
 */
 buildSignUpUrl(opts?: RedirectOptions): string;

 /**
 * Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
 * Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
 */
 buildUserProfileUrl(): string;

 /**
 * Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
 * Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
 */
 buildCreateOrganizationUrl(): string;

 /**
 * Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
 * Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
 */
 buildOrganizationProfileUrl(): string;

Expand DownExpand Up@@ -707,7 +707,7 @@
 buildAfterMultiSessionSingleSignOutUrl(): string;

 /**
 * Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
 * Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
 */
 buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;

Expand All@@ -720,31 +720,31 @@
 redirectWithAuth(to: string): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignIn/> is mounted.
 * Redirects to the configured URL where `<SignIn/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <SignUp/> is mounted.
 * Redirects to the configured URL where `<SignUp/>` is mounted.
 *
 * @param opts A {@link RedirectOptions} object
 */
 redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;

 /**
 * Redirects to the configured URL where <UserProfile/> is mounted.
 * Redirects to the configured URL where `<UserProfile/>` is mounted.
 */
 redirectToUserProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <OrganizationProfile /> is mounted.
 * Redirects to the configured URL where `<OrganizationProfile />` is mounted.
 */
 redirectToOrganizationProfile: () => Promise<unknown>;

 /**
 * Redirects to the configured URL where <CreateOrganization /> is mounted.
 * Redirects to the configured URL where `<CreateOrganization />` is mounted.
 */
 redirectToCreateOrganization: () => Promise<unknown>;

Expand All@@ -764,7 +764,7 @@
 redirectToAfterSignOut: () => void;

 /**
 * Redirects to the configured URL where <Waitlist/> is mounted.
 * Redirects to the configured URL where `<Waitlist/>` is mounted.
 */
 redirectToWaitlist: () => void;

Expand DownExpand Up@@ -1146,7 +1146,7 @@
 */
 windowNavigate: (to: URL | string) => void;
 },
) => Promise<unknown> | unknown;

Check warning
on line 1149
in packages/types/src/clerk.ts

View workflow job for this annotation
GitHub Actions/ Static analysis
'unknown' overrides all other types in this union type

export type WithoutRouting<T> = Omit<T, 'path' | 'routing'>;

Expand Down

4 changes: 3 additions & 1 deletion
packages/types/src/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
 * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
 * as a starting point.
 */
export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
export interface LocalizationResource
 extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

This fixes the type from DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>
image
To LocalizationResource
Image
And because of the link replacement in .typedoc/custom-plugin.mjs:56 it then points to /docs/customization/localization
@NWylynkoNWylynkoAug 13, 2025

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

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

I am not sure if this change from type to interface is ok with just doing an empty changeset, or if this should be a patch
@wobsorianowobsorianoAug 13, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

We use it internally in @clerk/clerk-js and @clerk/localizations, but technically it's still public because anyone can import it from @clerk/types for some random reason. So at least a patch changeset would be appropriate 🤔

export type __internal_LocalizationResource = {
 locale: string;
Expand Down
Loading