Skip to content

fix(backend,shared): fix generated TypeDoc references#9340

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
SarahSoutoul merged 3 commits into from
Aug 5, 2026
Merged

fix(backend,shared): fix generated TypeDoc references #9340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e41221b
Fix broken generated links
SarahSoutoul Aug 5, 2026
1087aaa
Add type BillingSubscriptionItemStatus JSdoc
SarahSoutoul Aug 5, 2026
fbde2c0
Merge branch 'main' into ss/fix-typedoc-links
SarahSoutoul Aug 5, 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
6 changes: 6 additions & 0 deletions .changeset/clean-typedoc-links.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
---

Improve generated API reference links, expose `BillingSubscriptionItemStatus`, and clarify the `createUser()` identification status documentation.
10 changes: 10 additions & 0 deletions .typedoc/custom-plugin.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,11 +87,19 @@ const LINK_REPLACEMENTS = [
['enterprise-account', '/docs/reference/backend/types/backend-enterprise-account'],
['enterprise-account-connection', '/docs/reference/backend/types/backend-enterprise-account-connection'],
['enterprise-connection', '/docs/reference/backend/types/backend-enterprise-connection'],
[
'enterprise-connection-custom-attribute',
'/docs/reference/backend/types/backend-enterprise-connection-custom-attribute',
],
['enterprise-connection-oauth-config', '/docs/reference/backend/types/backend-enterprise-connection-oauth-config'],
[
'enterprise-connection-saml-connection',
'/docs/reference/backend/types/backend-enterprise-connection-saml-connection',
],
[
'enterprise-connection-saml-connection-login-hint',
'/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint',
],
['external-account', '/docs/reference/backend/types/backend-external-account'],
['phone-number', '/docs/reference/backend/types/backend-phone-number'],
['protect-check-resource', '/docs/reference/types/protect-check-resource'],
Expand All@@ -114,9 +122,11 @@ const LINK_REPLACEMENTS = [
['billing-per-unit-total-tier', '/docs/reference/types/billing-per-unit-total-tier'],
['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
['billing-subscription-item-seats', '/docs/reference/types/billing-subscription-item-seats'],
['billing-subscription-item-status', '/docs/reference/backend/types/billing-subscription-item-status'],
['feature-resource', '/docs/reference/types/feature-resource'],
['billing-statement-group', '/docs/reference/types/billing-statement-group'],
['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
['billing-totals', '/docs/reference/types/billing-totals'],
['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
['clerk-api-error', '/docs/reference/types/clerk-api-error'],
Expand Down
10 changes: 5 additions & 5 deletions packages/backend/src/api/endpoints/UserApi.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -233,13 +233,13 @@ export type UserPasswordHashingParams = {
export type CreateUserParams = {
/** The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. */
externalId?: string;
/** The email address(es) to assign to the user. Must be unique across your instance. The first email address will be set as the users primary email address. Created verified by default; see `emailAddressIdentificationStatus` to create them reserved. */
/** The email addresses to assign to the user. Each address must be unique across your instance. The first email address becomes the user's primary email address. Addresses are created as verified by default; use `emailAddressIdentificationStatus` to create reserved addresses. */
emailAddress?: string[];
/** Controls the status each email address is created with. Runs parallel to `emailAddress`: when provided, it must contain exactly one item per email address, applied by position. When omitted or empty, every email address is created `'verified'`. Set an item to `'reserved'` to create the corresponding email address reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
/** Sets the creation status of each email address. Entries correspond by index to `emailAddress`, and the array must contain exactly one entry per email address. If omitted, every email address is created as `'verified'`. Use `'reserved'` to create an unverified address that can still be used for sign-in and cannot be claimed by another user. */
emailAddressIdentificationStatus?: ('verified' | 'reserved')[];
/** The phone number(s) to assign to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number. Created verified by default; see `phoneNumberIdentificationStatus` to create them reserved. */
/** The phone numbers to assign to the user. Each number must be unique across your instance. The first phone number becomes the user's primary phone number. Numbers are created as verified by default; use `phoneNumberIdentificationStatus` to create reserved numbers. */
phoneNumber?: string[];
/** Controls the status each phone number is created with. Runs parallel to `phoneNumber`: when provided, it must contain exactly one item per phone number, applied by position. When omitted or empty, every phone number is created `'verified'`. Set an item to `'reserved'` to create the corresponding phone number reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
/** Sets the creation status of each phone number. Entries correspond by index to `phoneNumber`, and the array must contain exactly one entry per phone number. If omitted, every phone number is created as `'verified'`. Use `'reserved'` to create an unverified number that can still be used for sign-in and cannot be claimed by another user. */
phoneNumberIdentificationStatus?: ('verified' | 'reserved')[];
/** The username to assign to the user. Must be unique across your instance. */
username?: string;
Expand DownExpand Up@@ -457,7 +457,7 @@ export class UserAPI extends AbstractAPI {
*
* Your settings in the [Clerk Dashboard](https://dashboard.clerk.com) determine how you should setup your user model. Anything **Required** will need to be provided when creating a user. Trying to add a field that isn't enabled will result in an error.
*
* By default, any email address and phone number created using this method is automatically verified. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to instead create some or all of them as reserved (unverified but usable for sign-in and locked so no other user can claim them).
* By default, email addresses and phone numbers created using this method are verified automatically. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to create any of them as reserved. Reserved identifiers are unverified, but they can still be used for sign-in and cannot be claimed by another user.
*
* > [!CAUTION]
* >
Expand Down
15 changes: 14 additions & 1 deletion packages/backend/src/api/resources/JSON.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1029,14 +1029,27 @@ export interface BillingPlanJSON extends ClerkResourceJSON {
avatar_url: string | null;
}

type BillingSubscriptionItemStatus =
/**
* The possible lifecycle states of a Backend `BillingSubscriptionItem`.
*
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
*/
export type BillingSubscriptionItemStatus =
/** The Subscription Item is in the abandoned state. */
| 'abandoned'
/** The Subscription Item is active. */
| 'active'
/** The Subscription Item is canceled. */
| 'canceled'
/** The Subscription Item has ended. */
| 'ended'
/** The Subscription Item has expired. */
| 'expired'
/** The Subscription Item is incomplete. */
| 'incomplete'
/** The Subscription Item has a past-due payment. */
| 'past_due'
/** The Subscription Item is upcoming. */
| 'upcoming';

/**
Expand Down
1 change: 1 addition & 0 deletions packages/backend/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export type {
BillingPlanJSON,
BillingSubscriptionJSON,
BillingSubscriptionItemJSON,
BillingSubscriptionItemStatus,
} from './api/resources/JSON';

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/shared/src/types/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1445,7 +1445,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
*/
supportEmail?: string;
/**
* By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/Sessions#operation/touchSession){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
* By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/sessions/POST/v1/client/sessions/%7Bsession_id%7D/touch){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
*/
touchSession?: boolean;
/**
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" + '
fix(backend,shared): fix generated TypeDoc references by SarahSoutoul · Pull Request #9340 · clerk/javascript · GitHub
Skip to content
fix(backend,shared): fix generated TypeDoc references#9340

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

SarahSoutoul
merged 3 commits into

from

Aug 5, 2026
 Merged


fix(backend,shared): fix generated TypeDoc references
#9340
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e41221b

Fix broken generated links


SarahSoutoul Aug 5, 2026
1087aaa

Add type BillingSubscriptionItemStatus JSdoc


SarahSoutoul Aug 5, 2026
fbde2c0

Merge branch 'main' into ss/fix-typedoc-links


SarahSoutoul Aug 5, 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


6 changes: 6 additions & 0 deletions
.changeset/clean-typedoc-links.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
---

Improve generated API reference links, expose `BillingSubscriptionItemStatus`, and clarify the `createUser()` identification status documentation.

10 changes: 10 additions & 0 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,11 +87,19 @@ const LINK_REPLACEMENTS = [
 ['enterprise-account', '/docs/reference/backend/types/backend-enterprise-account'],
 ['enterprise-account-connection', '/docs/reference/backend/types/backend-enterprise-account-connection'],
 ['enterprise-connection', '/docs/reference/backend/types/backend-enterprise-connection'],
 [
 'enterprise-connection-custom-attribute',
 '/docs/reference/backend/types/backend-enterprise-connection-custom-attribute',
 ],
 ['enterprise-connection-oauth-config', '/docs/reference/backend/types/backend-enterprise-connection-oauth-config'],
 [
 'enterprise-connection-saml-connection',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection',
 ],
 [
 'enterprise-connection-saml-connection-login-hint',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint',
 ],
 ['external-account', '/docs/reference/backend/types/backend-external-account'],
 ['phone-number', '/docs/reference/backend/types/backend-phone-number'],
 ['protect-check-resource', '/docs/reference/types/protect-check-resource'],
Expand All@@ -114,9 +122,11 @@ const LINK_REPLACEMENTS = [
 ['billing-per-unit-total-tier', '/docs/reference/types/billing-per-unit-total-tier'],
 ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
 ['billing-subscription-item-seats', '/docs/reference/types/billing-subscription-item-seats'],
 ['billing-subscription-item-status', '/docs/reference/backend/types/billing-subscription-item-status'],
 ['feature-resource', '/docs/reference/types/feature-resource'],
 ['billing-statement-group', '/docs/reference/types/billing-statement-group'],
 ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
 ['billing-totals', '/docs/reference/types/billing-totals'],
 ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
 ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
 ['clerk-api-error', '/docs/reference/types/clerk-api-error'],
Expand Down

10 changes: 5 additions & 5 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -233,13 +233,13 @@ export type UserPasswordHashingParams = {
export type CreateUserParams = {
 /** The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. */
 externalId?: string;
 /** The email address(es) to assign to the user. Must be unique across your instance. The first email address will be set as the users primary email address. Created verified by default; see `emailAddressIdentificationStatus` to create them reserved. */
 /** The email addresses to assign to the user. Each address must be unique across your instance. The first email address becomes the user's primary email address. Addresses are created as verified by default; use `emailAddressIdentificationStatus` to create reserved addresses. */
 emailAddress?: string[];
 /** Controls the status each email address is created with. Runs parallel to `emailAddress`: when provided, it must contain exactly one item per email address, applied by position. When omitted or empty, every email address is created `'verified'`. Set an item to `'reserved'` to create the corresponding email address reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each email address. Entries correspond by index to `emailAddress`, and the array must contain exactly one entry per email address. If omitted, every email address is created as `'verified'`. Use `'reserved'` to create an unverified address that can still be used for sign-in and cannot be claimed by another user. */
 emailAddressIdentificationStatus?: ('verified' | 'reserved')[];
 /** The phone number(s) to assign to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number. Created verified by default; see `phoneNumberIdentificationStatus` to create them reserved. */
 /** The phone numbers to assign to the user. Each number must be unique across your instance. The first phone number becomes the user's primary phone number. Numbers are created as verified by default; use `phoneNumberIdentificationStatus` to create reserved numbers. */
 phoneNumber?: string[];
 /** Controls the status each phone number is created with. Runs parallel to `phoneNumber`: when provided, it must contain exactly one item per phone number, applied by position. When omitted or empty, every phone number is created `'verified'`. Set an item to `'reserved'` to create the corresponding phone number reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each phone number. Entries correspond by index to `phoneNumber`, and the array must contain exactly one entry per phone number. If omitted, every phone number is created as `'verified'`. Use `'reserved'` to create an unverified number that can still be used for sign-in and cannot be claimed by another user. */
 phoneNumberIdentificationStatus?: ('verified' | 'reserved')[];
 /** The username to assign to the user. Must be unique across your instance. */
 username?: string;
Expand DownExpand Up@@ -457,7 +457,7 @@ export class UserAPI extends AbstractAPI {
 *
 * Your settings in the [Clerk Dashboard](https://dashboard.clerk.com) determine how you should setup your user model. Anything **Required** will need to be provided when creating a user. Trying to add a field that isn't enabled will result in an error.
 *
 * By default, any email address and phone number created using this method is automatically verified. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to instead create some or all of them as reserved (unverified but usable for sign-in and locked so no other user can claim them).
 * By default, email addresses and phone numbers created using this method are verified automatically. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to create any of them as reserved. Reserved identifiers are unverified, but they can still be used for sign-in and cannot be claimed by another user.
 *
 * > [!CAUTION]
 * >
Expand Down

15 changes: 14 additions & 1 deletion
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1029,14 +1029,27 @@ export interface BillingPlanJSON extends ClerkResourceJSON {
 avatar_url: string | null;
}

type BillingSubscriptionItemStatus =
/**
 * The possible lifecycle states of a Backend `BillingSubscriptionItem`.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export type BillingSubscriptionItemStatus =
 /** The Subscription Item is in the abandoned state. */
 | 'abandoned'
 /** The Subscription Item is active. */
 | 'active'
 /** The Subscription Item is canceled. */
 | 'canceled'
 /** The Subscription Item has ended. */
 | 'ended'
 /** The Subscription Item has expired. */
 | 'expired'
 /** The Subscription Item is incomplete. */
 | 'incomplete'
 /** The Subscription Item has a past-due payment. */
 | 'past_due'
 /** The Subscription Item is upcoming. */
 | 'upcoming';

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export type {
 BillingPlanJSON,
 BillingSubscriptionJSON,
 BillingSubscriptionItemJSON,
 BillingSubscriptionItemStatus,
} from './api/resources/JSON';

/**
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1445,7 +1445,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 supportEmail?: string;
 /**
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/Sessions#operation/touchSession){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/sessions/POST/v1/client/sessions/%7Bsession_id%7D/touch){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 */
 touchSession?: boolean;
 /**
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('^' + ".*" + '
fix(backend,shared): fix generated TypeDoc references by SarahSoutoul · Pull Request #9340 · clerk/javascript · GitHub
Skip to content
fix(backend,shared): fix generated TypeDoc references#9340

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

SarahSoutoul
merged 3 commits into

from

Aug 5, 2026
 Merged


fix(backend,shared): fix generated TypeDoc references
#9340
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e41221b

Fix broken generated links


SarahSoutoul Aug 5, 2026
1087aaa

Add type BillingSubscriptionItemStatus JSdoc


SarahSoutoul Aug 5, 2026
fbde2c0

Merge branch 'main' into ss/fix-typedoc-links


SarahSoutoul Aug 5, 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


6 changes: 6 additions & 0 deletions
.changeset/clean-typedoc-links.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
---

Improve generated API reference links, expose `BillingSubscriptionItemStatus`, and clarify the `createUser()` identification status documentation.

10 changes: 10 additions & 0 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,11 +87,19 @@ const LINK_REPLACEMENTS = [
 ['enterprise-account', '/docs/reference/backend/types/backend-enterprise-account'],
 ['enterprise-account-connection', '/docs/reference/backend/types/backend-enterprise-account-connection'],
 ['enterprise-connection', '/docs/reference/backend/types/backend-enterprise-connection'],
 [
 'enterprise-connection-custom-attribute',
 '/docs/reference/backend/types/backend-enterprise-connection-custom-attribute',
 ],
 ['enterprise-connection-oauth-config', '/docs/reference/backend/types/backend-enterprise-connection-oauth-config'],
 [
 'enterprise-connection-saml-connection',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection',
 ],
 [
 'enterprise-connection-saml-connection-login-hint',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint',
 ],
 ['external-account', '/docs/reference/backend/types/backend-external-account'],
 ['phone-number', '/docs/reference/backend/types/backend-phone-number'],
 ['protect-check-resource', '/docs/reference/types/protect-check-resource'],
Expand All@@ -114,9 +122,11 @@ const LINK_REPLACEMENTS = [
 ['billing-per-unit-total-tier', '/docs/reference/types/billing-per-unit-total-tier'],
 ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
 ['billing-subscription-item-seats', '/docs/reference/types/billing-subscription-item-seats'],
 ['billing-subscription-item-status', '/docs/reference/backend/types/billing-subscription-item-status'],
 ['feature-resource', '/docs/reference/types/feature-resource'],
 ['billing-statement-group', '/docs/reference/types/billing-statement-group'],
 ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
 ['billing-totals', '/docs/reference/types/billing-totals'],
 ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
 ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
 ['clerk-api-error', '/docs/reference/types/clerk-api-error'],
Expand Down

10 changes: 5 additions & 5 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -233,13 +233,13 @@ export type UserPasswordHashingParams = {
export type CreateUserParams = {
 /** The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. */
 externalId?: string;
 /** The email address(es) to assign to the user. Must be unique across your instance. The first email address will be set as the users primary email address. Created verified by default; see `emailAddressIdentificationStatus` to create them reserved. */
 /** The email addresses to assign to the user. Each address must be unique across your instance. The first email address becomes the user's primary email address. Addresses are created as verified by default; use `emailAddressIdentificationStatus` to create reserved addresses. */
 emailAddress?: string[];
 /** Controls the status each email address is created with. Runs parallel to `emailAddress`: when provided, it must contain exactly one item per email address, applied by position. When omitted or empty, every email address is created `'verified'`. Set an item to `'reserved'` to create the corresponding email address reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each email address. Entries correspond by index to `emailAddress`, and the array must contain exactly one entry per email address. If omitted, every email address is created as `'verified'`. Use `'reserved'` to create an unverified address that can still be used for sign-in and cannot be claimed by another user. */
 emailAddressIdentificationStatus?: ('verified' | 'reserved')[];
 /** The phone number(s) to assign to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number. Created verified by default; see `phoneNumberIdentificationStatus` to create them reserved. */
 /** The phone numbers to assign to the user. Each number must be unique across your instance. The first phone number becomes the user's primary phone number. Numbers are created as verified by default; use `phoneNumberIdentificationStatus` to create reserved numbers. */
 phoneNumber?: string[];
 /** Controls the status each phone number is created with. Runs parallel to `phoneNumber`: when provided, it must contain exactly one item per phone number, applied by position. When omitted or empty, every phone number is created `'verified'`. Set an item to `'reserved'` to create the corresponding phone number reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each phone number. Entries correspond by index to `phoneNumber`, and the array must contain exactly one entry per phone number. If omitted, every phone number is created as `'verified'`. Use `'reserved'` to create an unverified number that can still be used for sign-in and cannot be claimed by another user. */
 phoneNumberIdentificationStatus?: ('verified' | 'reserved')[];
 /** The username to assign to the user. Must be unique across your instance. */
 username?: string;
Expand DownExpand Up@@ -457,7 +457,7 @@ export class UserAPI extends AbstractAPI {
 *
 * Your settings in the [Clerk Dashboard](https://dashboard.clerk.com) determine how you should setup your user model. Anything **Required** will need to be provided when creating a user. Trying to add a field that isn't enabled will result in an error.
 *
 * By default, any email address and phone number created using this method is automatically verified. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to instead create some or all of them as reserved (unverified but usable for sign-in and locked so no other user can claim them).
 * By default, email addresses and phone numbers created using this method are verified automatically. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to create any of them as reserved. Reserved identifiers are unverified, but they can still be used for sign-in and cannot be claimed by another user.
 *
 * > [!CAUTION]
 * >
Expand Down

15 changes: 14 additions & 1 deletion
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1029,14 +1029,27 @@ export interface BillingPlanJSON extends ClerkResourceJSON {
 avatar_url: string | null;
}

type BillingSubscriptionItemStatus =
/**
 * The possible lifecycle states of a Backend `BillingSubscriptionItem`.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export type BillingSubscriptionItemStatus =
 /** The Subscription Item is in the abandoned state. */
 | 'abandoned'
 /** The Subscription Item is active. */
 | 'active'
 /** The Subscription Item is canceled. */
 | 'canceled'
 /** The Subscription Item has ended. */
 | 'ended'
 /** The Subscription Item has expired. */
 | 'expired'
 /** The Subscription Item is incomplete. */
 | 'incomplete'
 /** The Subscription Item has a past-due payment. */
 | 'past_due'
 /** The Subscription Item is upcoming. */
 | 'upcoming';

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export type {
 BillingPlanJSON,
 BillingSubscriptionJSON,
 BillingSubscriptionItemJSON,
 BillingSubscriptionItemStatus,
} from './api/resources/JSON';

/**
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1445,7 +1445,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 supportEmail?: string;
 /**
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/Sessions#operation/touchSession){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/sessions/POST/v1/client/sessions/%7Bsession_id%7D/touch){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 */
 touchSession?: boolean;
 /**
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('^' + ".*" + '
fix(backend,shared): fix generated TypeDoc references by SarahSoutoul · Pull Request #9340 · clerk/javascript · GitHub
Skip to content
fix(backend,shared): fix generated TypeDoc references#9340

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

SarahSoutoul
merged 3 commits into

from

Aug 5, 2026
 Merged


fix(backend,shared): fix generated TypeDoc references
#9340
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e41221b

Fix broken generated links


SarahSoutoul Aug 5, 2026
1087aaa

Add type BillingSubscriptionItemStatus JSdoc


SarahSoutoul Aug 5, 2026
fbde2c0

Merge branch 'main' into ss/fix-typedoc-links


SarahSoutoul Aug 5, 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


6 changes: 6 additions & 0 deletions
.changeset/clean-typedoc-links.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
---

Improve generated API reference links, expose `BillingSubscriptionItemStatus`, and clarify the `createUser()` identification status documentation.

10 changes: 10 additions & 0 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,11 +87,19 @@ const LINK_REPLACEMENTS = [
 ['enterprise-account', '/docs/reference/backend/types/backend-enterprise-account'],
 ['enterprise-account-connection', '/docs/reference/backend/types/backend-enterprise-account-connection'],
 ['enterprise-connection', '/docs/reference/backend/types/backend-enterprise-connection'],
 [
 'enterprise-connection-custom-attribute',
 '/docs/reference/backend/types/backend-enterprise-connection-custom-attribute',
 ],
 ['enterprise-connection-oauth-config', '/docs/reference/backend/types/backend-enterprise-connection-oauth-config'],
 [
 'enterprise-connection-saml-connection',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection',
 ],
 [
 'enterprise-connection-saml-connection-login-hint',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint',
 ],
 ['external-account', '/docs/reference/backend/types/backend-external-account'],
 ['phone-number', '/docs/reference/backend/types/backend-phone-number'],
 ['protect-check-resource', '/docs/reference/types/protect-check-resource'],
Expand All@@ -114,9 +122,11 @@ const LINK_REPLACEMENTS = [
 ['billing-per-unit-total-tier', '/docs/reference/types/billing-per-unit-total-tier'],
 ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
 ['billing-subscription-item-seats', '/docs/reference/types/billing-subscription-item-seats'],
 ['billing-subscription-item-status', '/docs/reference/backend/types/billing-subscription-item-status'],
 ['feature-resource', '/docs/reference/types/feature-resource'],
 ['billing-statement-group', '/docs/reference/types/billing-statement-group'],
 ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
 ['billing-totals', '/docs/reference/types/billing-totals'],
 ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
 ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
 ['clerk-api-error', '/docs/reference/types/clerk-api-error'],
Expand Down

10 changes: 5 additions & 5 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -233,13 +233,13 @@ export type UserPasswordHashingParams = {
export type CreateUserParams = {
 /** The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. */
 externalId?: string;
 /** The email address(es) to assign to the user. Must be unique across your instance. The first email address will be set as the users primary email address. Created verified by default; see `emailAddressIdentificationStatus` to create them reserved. */
 /** The email addresses to assign to the user. Each address must be unique across your instance. The first email address becomes the user's primary email address. Addresses are created as verified by default; use `emailAddressIdentificationStatus` to create reserved addresses. */
 emailAddress?: string[];
 /** Controls the status each email address is created with. Runs parallel to `emailAddress`: when provided, it must contain exactly one item per email address, applied by position. When omitted or empty, every email address is created `'verified'`. Set an item to `'reserved'` to create the corresponding email address reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each email address. Entries correspond by index to `emailAddress`, and the array must contain exactly one entry per email address. If omitted, every email address is created as `'verified'`. Use `'reserved'` to create an unverified address that can still be used for sign-in and cannot be claimed by another user. */
 emailAddressIdentificationStatus?: ('verified' | 'reserved')[];
 /** The phone number(s) to assign to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number. Created verified by default; see `phoneNumberIdentificationStatus` to create them reserved. */
 /** The phone numbers to assign to the user. Each number must be unique across your instance. The first phone number becomes the user's primary phone number. Numbers are created as verified by default; use `phoneNumberIdentificationStatus` to create reserved numbers. */
 phoneNumber?: string[];
 /** Controls the status each phone number is created with. Runs parallel to `phoneNumber`: when provided, it must contain exactly one item per phone number, applied by position. When omitted or empty, every phone number is created `'verified'`. Set an item to `'reserved'` to create the corresponding phone number reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each phone number. Entries correspond by index to `phoneNumber`, and the array must contain exactly one entry per phone number. If omitted, every phone number is created as `'verified'`. Use `'reserved'` to create an unverified number that can still be used for sign-in and cannot be claimed by another user. */
 phoneNumberIdentificationStatus?: ('verified' | 'reserved')[];
 /** The username to assign to the user. Must be unique across your instance. */
 username?: string;
Expand DownExpand Up@@ -457,7 +457,7 @@ export class UserAPI extends AbstractAPI {
 *
 * Your settings in the [Clerk Dashboard](https://dashboard.clerk.com) determine how you should setup your user model. Anything **Required** will need to be provided when creating a user. Trying to add a field that isn't enabled will result in an error.
 *
 * By default, any email address and phone number created using this method is automatically verified. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to instead create some or all of them as reserved (unverified but usable for sign-in and locked so no other user can claim them).
 * By default, email addresses and phone numbers created using this method are verified automatically. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to create any of them as reserved. Reserved identifiers are unverified, but they can still be used for sign-in and cannot be claimed by another user.
 *
 * > [!CAUTION]
 * >
Expand Down

15 changes: 14 additions & 1 deletion
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1029,14 +1029,27 @@ export interface BillingPlanJSON extends ClerkResourceJSON {
 avatar_url: string | null;
}

type BillingSubscriptionItemStatus =
/**
 * The possible lifecycle states of a Backend `BillingSubscriptionItem`.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export type BillingSubscriptionItemStatus =
 /** The Subscription Item is in the abandoned state. */
 | 'abandoned'
 /** The Subscription Item is active. */
 | 'active'
 /** The Subscription Item is canceled. */
 | 'canceled'
 /** The Subscription Item has ended. */
 | 'ended'
 /** The Subscription Item has expired. */
 | 'expired'
 /** The Subscription Item is incomplete. */
 | 'incomplete'
 /** The Subscription Item has a past-due payment. */
 | 'past_due'
 /** The Subscription Item is upcoming. */
 | 'upcoming';

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export type {
 BillingPlanJSON,
 BillingSubscriptionJSON,
 BillingSubscriptionItemJSON,
 BillingSubscriptionItemStatus,
} from './api/resources/JSON';

/**
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1445,7 +1445,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 supportEmail?: string;
 /**
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/Sessions#operation/touchSession){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/sessions/POST/v1/client/sessions/%7Bsession_id%7D/touch){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 */
 touchSession?: boolean;
 /**
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" + '
fix(backend,shared): fix generated TypeDoc references by SarahSoutoul · Pull Request #9340 · clerk/javascript · GitHub
Skip to content
fix(backend,shared): fix generated TypeDoc references#9340

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

SarahSoutoul
merged 3 commits into

from

Aug 5, 2026
 Merged


fix(backend,shared): fix generated TypeDoc references
#9340
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e41221b

Fix broken generated links


SarahSoutoul Aug 5, 2026
1087aaa

Add type BillingSubscriptionItemStatus JSdoc


SarahSoutoul Aug 5, 2026
fbde2c0

Merge branch 'main' into ss/fix-typedoc-links


SarahSoutoul Aug 5, 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


6 changes: 6 additions & 0 deletions
.changeset/clean-typedoc-links.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
---

Improve generated API reference links, expose `BillingSubscriptionItemStatus`, and clarify the `createUser()` identification status documentation.

10 changes: 10 additions & 0 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,11 +87,19 @@ const LINK_REPLACEMENTS = [
 ['enterprise-account', '/docs/reference/backend/types/backend-enterprise-account'],
 ['enterprise-account-connection', '/docs/reference/backend/types/backend-enterprise-account-connection'],
 ['enterprise-connection', '/docs/reference/backend/types/backend-enterprise-connection'],
 [
 'enterprise-connection-custom-attribute',
 '/docs/reference/backend/types/backend-enterprise-connection-custom-attribute',
 ],
 ['enterprise-connection-oauth-config', '/docs/reference/backend/types/backend-enterprise-connection-oauth-config'],
 [
 'enterprise-connection-saml-connection',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection',
 ],
 [
 'enterprise-connection-saml-connection-login-hint',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint',
 ],
 ['external-account', '/docs/reference/backend/types/backend-external-account'],
 ['phone-number', '/docs/reference/backend/types/backend-phone-number'],
 ['protect-check-resource', '/docs/reference/types/protect-check-resource'],
Expand All@@ -114,9 +122,11 @@ const LINK_REPLACEMENTS = [
 ['billing-per-unit-total-tier', '/docs/reference/types/billing-per-unit-total-tier'],
 ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
 ['billing-subscription-item-seats', '/docs/reference/types/billing-subscription-item-seats'],
 ['billing-subscription-item-status', '/docs/reference/backend/types/billing-subscription-item-status'],
 ['feature-resource', '/docs/reference/types/feature-resource'],
 ['billing-statement-group', '/docs/reference/types/billing-statement-group'],
 ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
 ['billing-totals', '/docs/reference/types/billing-totals'],
 ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
 ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
 ['clerk-api-error', '/docs/reference/types/clerk-api-error'],
Expand Down

10 changes: 5 additions & 5 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -233,13 +233,13 @@ export type UserPasswordHashingParams = {
export type CreateUserParams = {
 /** The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. */
 externalId?: string;
 /** The email address(es) to assign to the user. Must be unique across your instance. The first email address will be set as the users primary email address. Created verified by default; see `emailAddressIdentificationStatus` to create them reserved. */
 /** The email addresses to assign to the user. Each address must be unique across your instance. The first email address becomes the user's primary email address. Addresses are created as verified by default; use `emailAddressIdentificationStatus` to create reserved addresses. */
 emailAddress?: string[];
 /** Controls the status each email address is created with. Runs parallel to `emailAddress`: when provided, it must contain exactly one item per email address, applied by position. When omitted or empty, every email address is created `'verified'`. Set an item to `'reserved'` to create the corresponding email address reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each email address. Entries correspond by index to `emailAddress`, and the array must contain exactly one entry per email address. If omitted, every email address is created as `'verified'`. Use `'reserved'` to create an unverified address that can still be used for sign-in and cannot be claimed by another user. */
 emailAddressIdentificationStatus?: ('verified' | 'reserved')[];
 /** The phone number(s) to assign to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number. Created verified by default; see `phoneNumberIdentificationStatus` to create them reserved. */
 /** The phone numbers to assign to the user. Each number must be unique across your instance. The first phone number becomes the user's primary phone number. Numbers are created as verified by default; use `phoneNumberIdentificationStatus` to create reserved numbers. */
 phoneNumber?: string[];
 /** Controls the status each phone number is created with. Runs parallel to `phoneNumber`: when provided, it must contain exactly one item per phone number, applied by position. When omitted or empty, every phone number is created `'verified'`. Set an item to `'reserved'` to create the corresponding phone number reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each phone number. Entries correspond by index to `phoneNumber`, and the array must contain exactly one entry per phone number. If omitted, every phone number is created as `'verified'`. Use `'reserved'` to create an unverified number that can still be used for sign-in and cannot be claimed by another user. */
 phoneNumberIdentificationStatus?: ('verified' | 'reserved')[];
 /** The username to assign to the user. Must be unique across your instance. */
 username?: string;
Expand DownExpand Up@@ -457,7 +457,7 @@ export class UserAPI extends AbstractAPI {
 *
 * Your settings in the [Clerk Dashboard](https://dashboard.clerk.com) determine how you should setup your user model. Anything **Required** will need to be provided when creating a user. Trying to add a field that isn't enabled will result in an error.
 *
 * By default, any email address and phone number created using this method is automatically verified. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to instead create some or all of them as reserved (unverified but usable for sign-in and locked so no other user can claim them).
 * By default, email addresses and phone numbers created using this method are verified automatically. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to create any of them as reserved. Reserved identifiers are unverified, but they can still be used for sign-in and cannot be claimed by another user.
 *
 * > [!CAUTION]
 * >
Expand Down

15 changes: 14 additions & 1 deletion
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1029,14 +1029,27 @@ export interface BillingPlanJSON extends ClerkResourceJSON {
 avatar_url: string | null;
}

type BillingSubscriptionItemStatus =
/**
 * The possible lifecycle states of a Backend `BillingSubscriptionItem`.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export type BillingSubscriptionItemStatus =
 /** The Subscription Item is in the abandoned state. */
 | 'abandoned'
 /** The Subscription Item is active. */
 | 'active'
 /** The Subscription Item is canceled. */
 | 'canceled'
 /** The Subscription Item has ended. */
 | 'ended'
 /** The Subscription Item has expired. */
 | 'expired'
 /** The Subscription Item is incomplete. */
 | 'incomplete'
 /** The Subscription Item has a past-due payment. */
 | 'past_due'
 /** The Subscription Item is upcoming. */
 | 'upcoming';

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export type {
 BillingPlanJSON,
 BillingSubscriptionJSON,
 BillingSubscriptionItemJSON,
 BillingSubscriptionItemStatus,
} from './api/resources/JSON';

/**
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1445,7 +1445,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 supportEmail?: string;
 /**
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/Sessions#operation/touchSession){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/sessions/POST/v1/client/sessions/%7Bsession_id%7D/touch){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 */
 touchSession?: boolean;
 /**
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('^' + ".*" + '
fix(backend,shared): fix generated TypeDoc references by SarahSoutoul · Pull Request #9340 · clerk/javascript · GitHub
Skip to content
fix(backend,shared): fix generated TypeDoc references#9340

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

SarahSoutoul
merged 3 commits into

from

Aug 5, 2026
 Merged


fix(backend,shared): fix generated TypeDoc references
#9340
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e41221b

Fix broken generated links


SarahSoutoul Aug 5, 2026
1087aaa

Add type BillingSubscriptionItemStatus JSdoc


SarahSoutoul Aug 5, 2026
fbde2c0

Merge branch 'main' into ss/fix-typedoc-links


SarahSoutoul Aug 5, 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


6 changes: 6 additions & 0 deletions
.changeset/clean-typedoc-links.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
---

Improve generated API reference links, expose `BillingSubscriptionItemStatus`, and clarify the `createUser()` identification status documentation.

10 changes: 10 additions & 0 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,11 +87,19 @@ const LINK_REPLACEMENTS = [
 ['enterprise-account', '/docs/reference/backend/types/backend-enterprise-account'],
 ['enterprise-account-connection', '/docs/reference/backend/types/backend-enterprise-account-connection'],
 ['enterprise-connection', '/docs/reference/backend/types/backend-enterprise-connection'],
 [
 'enterprise-connection-custom-attribute',
 '/docs/reference/backend/types/backend-enterprise-connection-custom-attribute',
 ],
 ['enterprise-connection-oauth-config', '/docs/reference/backend/types/backend-enterprise-connection-oauth-config'],
 [
 'enterprise-connection-saml-connection',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection',
 ],
 [
 'enterprise-connection-saml-connection-login-hint',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint',
 ],
 ['external-account', '/docs/reference/backend/types/backend-external-account'],
 ['phone-number', '/docs/reference/backend/types/backend-phone-number'],
 ['protect-check-resource', '/docs/reference/types/protect-check-resource'],
Expand All@@ -114,9 +122,11 @@ const LINK_REPLACEMENTS = [
 ['billing-per-unit-total-tier', '/docs/reference/types/billing-per-unit-total-tier'],
 ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
 ['billing-subscription-item-seats', '/docs/reference/types/billing-subscription-item-seats'],
 ['billing-subscription-item-status', '/docs/reference/backend/types/billing-subscription-item-status'],
 ['feature-resource', '/docs/reference/types/feature-resource'],
 ['billing-statement-group', '/docs/reference/types/billing-statement-group'],
 ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
 ['billing-totals', '/docs/reference/types/billing-totals'],
 ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
 ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
 ['clerk-api-error', '/docs/reference/types/clerk-api-error'],
Expand Down

10 changes: 5 additions & 5 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -233,13 +233,13 @@ export type UserPasswordHashingParams = {
export type CreateUserParams = {
 /** The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. */
 externalId?: string;
 /** The email address(es) to assign to the user. Must be unique across your instance. The first email address will be set as the users primary email address. Created verified by default; see `emailAddressIdentificationStatus` to create them reserved. */
 /** The email addresses to assign to the user. Each address must be unique across your instance. The first email address becomes the user's primary email address. Addresses are created as verified by default; use `emailAddressIdentificationStatus` to create reserved addresses. */
 emailAddress?: string[];
 /** Controls the status each email address is created with. Runs parallel to `emailAddress`: when provided, it must contain exactly one item per email address, applied by position. When omitted or empty, every email address is created `'verified'`. Set an item to `'reserved'` to create the corresponding email address reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each email address. Entries correspond by index to `emailAddress`, and the array must contain exactly one entry per email address. If omitted, every email address is created as `'verified'`. Use `'reserved'` to create an unverified address that can still be used for sign-in and cannot be claimed by another user. */
 emailAddressIdentificationStatus?: ('verified' | 'reserved')[];
 /** The phone number(s) to assign to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number. Created verified by default; see `phoneNumberIdentificationStatus` to create them reserved. */
 /** The phone numbers to assign to the user. Each number must be unique across your instance. The first phone number becomes the user's primary phone number. Numbers are created as verified by default; use `phoneNumberIdentificationStatus` to create reserved numbers. */
 phoneNumber?: string[];
 /** Controls the status each phone number is created with. Runs parallel to `phoneNumber`: when provided, it must contain exactly one item per phone number, applied by position. When omitted or empty, every phone number is created `'verified'`. Set an item to `'reserved'` to create the corresponding phone number reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each phone number. Entries correspond by index to `phoneNumber`, and the array must contain exactly one entry per phone number. If omitted, every phone number is created as `'verified'`. Use `'reserved'` to create an unverified number that can still be used for sign-in and cannot be claimed by another user. */
 phoneNumberIdentificationStatus?: ('verified' | 'reserved')[];
 /** The username to assign to the user. Must be unique across your instance. */
 username?: string;
Expand DownExpand Up@@ -457,7 +457,7 @@ export class UserAPI extends AbstractAPI {
 *
 * Your settings in the [Clerk Dashboard](https://dashboard.clerk.com) determine how you should setup your user model. Anything **Required** will need to be provided when creating a user. Trying to add a field that isn't enabled will result in an error.
 *
 * By default, any email address and phone number created using this method is automatically verified. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to instead create some or all of them as reserved (unverified but usable for sign-in and locked so no other user can claim them).
 * By default, email addresses and phone numbers created using this method are verified automatically. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to create any of them as reserved. Reserved identifiers are unverified, but they can still be used for sign-in and cannot be claimed by another user.
 *
 * > [!CAUTION]
 * >
Expand Down

15 changes: 14 additions & 1 deletion
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1029,14 +1029,27 @@ export interface BillingPlanJSON extends ClerkResourceJSON {
 avatar_url: string | null;
}

type BillingSubscriptionItemStatus =
/**
 * The possible lifecycle states of a Backend `BillingSubscriptionItem`.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export type BillingSubscriptionItemStatus =
 /** The Subscription Item is in the abandoned state. */
 | 'abandoned'
 /** The Subscription Item is active. */
 | 'active'
 /** The Subscription Item is canceled. */
 | 'canceled'
 /** The Subscription Item has ended. */
 | 'ended'
 /** The Subscription Item has expired. */
 | 'expired'
 /** The Subscription Item is incomplete. */
 | 'incomplete'
 /** The Subscription Item has a past-due payment. */
 | 'past_due'
 /** The Subscription Item is upcoming. */
 | 'upcoming';

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export type {
 BillingPlanJSON,
 BillingSubscriptionJSON,
 BillingSubscriptionItemJSON,
 BillingSubscriptionItemStatus,
} from './api/resources/JSON';

/**
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1445,7 +1445,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 supportEmail?: string;
 /**
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/Sessions#operation/touchSession){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/sessions/POST/v1/client/sessions/%7Bsession_id%7D/touch){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 */
 touchSession?: boolean;
 /**
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('^' + ".*" + '
fix(backend,shared): fix generated TypeDoc references by SarahSoutoul · Pull Request #9340 · clerk/javascript · GitHub
Skip to content
fix(backend,shared): fix generated TypeDoc references#9340

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

SarahSoutoul
merged 3 commits into

from

Aug 5, 2026
 Merged


fix(backend,shared): fix generated TypeDoc references
#9340
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e41221b

Fix broken generated links


SarahSoutoul Aug 5, 2026
1087aaa

Add type BillingSubscriptionItemStatus JSdoc


SarahSoutoul Aug 5, 2026
fbde2c0

Merge branch 'main' into ss/fix-typedoc-links


SarahSoutoul Aug 5, 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


6 changes: 6 additions & 0 deletions
.changeset/clean-typedoc-links.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
---

Improve generated API reference links, expose `BillingSubscriptionItemStatus`, and clarify the `createUser()` identification status documentation.

10 changes: 10 additions & 0 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,11 +87,19 @@ const LINK_REPLACEMENTS = [
 ['enterprise-account', '/docs/reference/backend/types/backend-enterprise-account'],
 ['enterprise-account-connection', '/docs/reference/backend/types/backend-enterprise-account-connection'],
 ['enterprise-connection', '/docs/reference/backend/types/backend-enterprise-connection'],
 [
 'enterprise-connection-custom-attribute',
 '/docs/reference/backend/types/backend-enterprise-connection-custom-attribute',
 ],
 ['enterprise-connection-oauth-config', '/docs/reference/backend/types/backend-enterprise-connection-oauth-config'],
 [
 'enterprise-connection-saml-connection',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection',
 ],
 [
 'enterprise-connection-saml-connection-login-hint',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint',
 ],
 ['external-account', '/docs/reference/backend/types/backend-external-account'],
 ['phone-number', '/docs/reference/backend/types/backend-phone-number'],
 ['protect-check-resource', '/docs/reference/types/protect-check-resource'],
Expand All@@ -114,9 +122,11 @@ const LINK_REPLACEMENTS = [
 ['billing-per-unit-total-tier', '/docs/reference/types/billing-per-unit-total-tier'],
 ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
 ['billing-subscription-item-seats', '/docs/reference/types/billing-subscription-item-seats'],
 ['billing-subscription-item-status', '/docs/reference/backend/types/billing-subscription-item-status'],
 ['feature-resource', '/docs/reference/types/feature-resource'],
 ['billing-statement-group', '/docs/reference/types/billing-statement-group'],
 ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
 ['billing-totals', '/docs/reference/types/billing-totals'],
 ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
 ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
 ['clerk-api-error', '/docs/reference/types/clerk-api-error'],
Expand Down

10 changes: 5 additions & 5 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -233,13 +233,13 @@ export type UserPasswordHashingParams = {
export type CreateUserParams = {
 /** The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. */
 externalId?: string;
 /** The email address(es) to assign to the user. Must be unique across your instance. The first email address will be set as the users primary email address. Created verified by default; see `emailAddressIdentificationStatus` to create them reserved. */
 /** The email addresses to assign to the user. Each address must be unique across your instance. The first email address becomes the user's primary email address. Addresses are created as verified by default; use `emailAddressIdentificationStatus` to create reserved addresses. */
 emailAddress?: string[];
 /** Controls the status each email address is created with. Runs parallel to `emailAddress`: when provided, it must contain exactly one item per email address, applied by position. When omitted or empty, every email address is created `'verified'`. Set an item to `'reserved'` to create the corresponding email address reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each email address. Entries correspond by index to `emailAddress`, and the array must contain exactly one entry per email address. If omitted, every email address is created as `'verified'`. Use `'reserved'` to create an unverified address that can still be used for sign-in and cannot be claimed by another user. */
 emailAddressIdentificationStatus?: ('verified' | 'reserved')[];
 /** The phone number(s) to assign to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number. Created verified by default; see `phoneNumberIdentificationStatus` to create them reserved. */
 /** The phone numbers to assign to the user. Each number must be unique across your instance. The first phone number becomes the user's primary phone number. Numbers are created as verified by default; use `phoneNumberIdentificationStatus` to create reserved numbers. */
 phoneNumber?: string[];
 /** Controls the status each phone number is created with. Runs parallel to `phoneNumber`: when provided, it must contain exactly one item per phone number, applied by position. When omitted or empty, every phone number is created `'verified'`. Set an item to `'reserved'` to create the corresponding phone number reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each phone number. Entries correspond by index to `phoneNumber`, and the array must contain exactly one entry per phone number. If omitted, every phone number is created as `'verified'`. Use `'reserved'` to create an unverified number that can still be used for sign-in and cannot be claimed by another user. */
 phoneNumberIdentificationStatus?: ('verified' | 'reserved')[];
 /** The username to assign to the user. Must be unique across your instance. */
 username?: string;
Expand DownExpand Up@@ -457,7 +457,7 @@ export class UserAPI extends AbstractAPI {
 *
 * Your settings in the [Clerk Dashboard](https://dashboard.clerk.com) determine how you should setup your user model. Anything **Required** will need to be provided when creating a user. Trying to add a field that isn't enabled will result in an error.
 *
 * By default, any email address and phone number created using this method is automatically verified. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to instead create some or all of them as reserved (unverified but usable for sign-in and locked so no other user can claim them).
 * By default, email addresses and phone numbers created using this method are verified automatically. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to create any of them as reserved. Reserved identifiers are unverified, but they can still be used for sign-in and cannot be claimed by another user.
 *
 * > [!CAUTION]
 * >
Expand Down

15 changes: 14 additions & 1 deletion
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1029,14 +1029,27 @@ export interface BillingPlanJSON extends ClerkResourceJSON {
 avatar_url: string | null;
}

type BillingSubscriptionItemStatus =
/**
 * The possible lifecycle states of a Backend `BillingSubscriptionItem`.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export type BillingSubscriptionItemStatus =
 /** The Subscription Item is in the abandoned state. */
 | 'abandoned'
 /** The Subscription Item is active. */
 | 'active'
 /** The Subscription Item is canceled. */
 | 'canceled'
 /** The Subscription Item has ended. */
 | 'ended'
 /** The Subscription Item has expired. */
 | 'expired'
 /** The Subscription Item is incomplete. */
 | 'incomplete'
 /** The Subscription Item has a past-due payment. */
 | 'past_due'
 /** The Subscription Item is upcoming. */
 | 'upcoming';

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export type {
 BillingPlanJSON,
 BillingSubscriptionJSON,
 BillingSubscriptionItemJSON,
 BillingSubscriptionItemStatus,
} from './api/resources/JSON';

/**
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1445,7 +1445,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 supportEmail?: string;
 /**
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/Sessions#operation/touchSession){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/sessions/POST/v1/client/sessions/%7Bsession_id%7D/touch){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 */
 touchSession?: boolean;
 /**
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); }
})();
})();
fix(backend,shared): fix generated TypeDoc references by SarahSoutoul · Pull Request #9340 · clerk/javascript · GitHub
Skip to content
fix(backend,shared): fix generated TypeDoc references#9340

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

SarahSoutoul
merged 3 commits into

from

Aug 5, 2026
 Merged


fix(backend,shared): fix generated TypeDoc references
#9340
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
e41221b

Fix broken generated links


SarahSoutoul Aug 5, 2026
1087aaa

Add type BillingSubscriptionItemStatus JSdoc


SarahSoutoul Aug 5, 2026
fbde2c0

Merge branch 'main' into ss/fix-typedoc-links


SarahSoutoul Aug 5, 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


6 changes: 6 additions & 0 deletions
.changeset/clean-typedoc-links.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
---
'@clerk/backend': patch
'@clerk/shared': patch
---

Improve generated API reference links, expose `BillingSubscriptionItemStatus`, and clarify the `createUser()` identification status documentation.

10 changes: 10 additions & 0 deletions
.typedoc/custom-plugin.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,11 +87,19 @@ const LINK_REPLACEMENTS = [
 ['enterprise-account', '/docs/reference/backend/types/backend-enterprise-account'],
 ['enterprise-account-connection', '/docs/reference/backend/types/backend-enterprise-account-connection'],
 ['enterprise-connection', '/docs/reference/backend/types/backend-enterprise-connection'],
 [
 'enterprise-connection-custom-attribute',
 '/docs/reference/backend/types/backend-enterprise-connection-custom-attribute',
 ],
 ['enterprise-connection-oauth-config', '/docs/reference/backend/types/backend-enterprise-connection-oauth-config'],
 [
 'enterprise-connection-saml-connection',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection',
 ],
 [
 'enterprise-connection-saml-connection-login-hint',
 '/docs/reference/backend/types/backend-enterprise-connection-saml-connection-login-hint',
 ],
 ['external-account', '/docs/reference/backend/types/backend-external-account'],
 ['phone-number', '/docs/reference/backend/types/backend-phone-number'],
 ['protect-check-resource', '/docs/reference/types/protect-check-resource'],
Expand All@@ -114,9 +122,11 @@ const LINK_REPLACEMENTS = [
 ['billing-per-unit-total-tier', '/docs/reference/types/billing-per-unit-total-tier'],
 ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
 ['billing-subscription-item-seats', '/docs/reference/types/billing-subscription-item-seats'],
 ['billing-subscription-item-status', '/docs/reference/backend/types/billing-subscription-item-status'],
 ['feature-resource', '/docs/reference/types/feature-resource'],
 ['billing-statement-group', '/docs/reference/types/billing-statement-group'],
 ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
 ['billing-totals', '/docs/reference/types/billing-totals'],
 ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
 ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
 ['clerk-api-error', '/docs/reference/types/clerk-api-error'],
Expand Down

10 changes: 5 additions & 5 deletions
packages/backend/src/api/endpoints/UserApi.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -233,13 +233,13 @@ export type UserPasswordHashingParams = {
export type CreateUserParams = {
 /** The ID of the user as used in your external systems or your previous authentication solution. Must be unique across your instance. */
 externalId?: string;
 /** The email address(es) to assign to the user. Must be unique across your instance. The first email address will be set as the users primary email address. Created verified by default; see `emailAddressIdentificationStatus` to create them reserved. */
 /** The email addresses to assign to the user. Each address must be unique across your instance. The first email address becomes the user's primary email address. Addresses are created as verified by default; use `emailAddressIdentificationStatus` to create reserved addresses. */
 emailAddress?: string[];
 /** Controls the status each email address is created with. Runs parallel to `emailAddress`: when provided, it must contain exactly one item per email address, applied by position. When omitted or empty, every email address is created `'verified'`. Set an item to `'reserved'` to create the corresponding email address reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each email address. Entries correspond by index to `emailAddress`, and the array must contain exactly one entry per email address. If omitted, every email address is created as `'verified'`. Use `'reserved'` to create an unverified address that can still be used for sign-in and cannot be claimed by another user. */
 emailAddressIdentificationStatus?: ('verified' | 'reserved')[];
 /** The phone number(s) to assign to the user. Must be unique across your instance. The first phone number will be set as the users primary phone number. Created verified by default; see `phoneNumberIdentificationStatus` to create them reserved. */
 /** The phone numbers to assign to the user. Each number must be unique across your instance. The first phone number becomes the user's primary phone number. Numbers are created as verified by default; use `phoneNumberIdentificationStatus` to create reserved numbers. */
 phoneNumber?: string[];
 /** Controls the status each phone number is created with. Runs parallel to `phoneNumber`: when provided, it must contain exactly one item per phone number, applied by position. When omitted or empty, every phone number is created `'verified'`. Set an item to `'reserved'` to create the corresponding phone number reserved instead (unverified but usable for sign-in and locked so no other user can claim it). */
 /** Sets the creation status of each phone number. Entries correspond by index to `phoneNumber`, and the array must contain exactly one entry per phone number. If omitted, every phone number is created as `'verified'`. Use `'reserved'` to create an unverified number that can still be used for sign-in and cannot be claimed by another user. */
 phoneNumberIdentificationStatus?: ('verified' | 'reserved')[];
 /** The username to assign to the user. Must be unique across your instance. */
 username?: string;
Expand DownExpand Up@@ -457,7 +457,7 @@ export class UserAPI extends AbstractAPI {
 *
 * Your settings in the [Clerk Dashboard](https://dashboard.clerk.com) determine how you should setup your user model. Anything **Required** will need to be provided when creating a user. Trying to add a field that isn't enabled will result in an error.
 *
 * By default, any email address and phone number created using this method is automatically verified. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to instead create some or all of them as reserved (unverified but usable for sign-in and locked so no other user can claim them).
 * By default, email addresses and phone numbers created using this method are verified automatically. Use `emailAddressIdentificationStatus` and `phoneNumberIdentificationStatus` to create any of them as reserved. Reserved identifiers are unverified, but they can still be used for sign-in and cannot be claimed by another user.
 *
 * > [!CAUTION]
 * >
Expand Down

15 changes: 14 additions & 1 deletion
packages/backend/src/api/resources/JSON.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1029,14 +1029,27 @@ export interface BillingPlanJSON extends ClerkResourceJSON {
 avatar_url: string | null;
}

type BillingSubscriptionItemStatus =
/**
 * The possible lifecycle states of a Backend `BillingSubscriptionItem`.
 *
 * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
 */
export type BillingSubscriptionItemStatus =
 /** The Subscription Item is in the abandoned state. */
 | 'abandoned'
 /** The Subscription Item is active. */
 | 'active'
 /** The Subscription Item is canceled. */
 | 'canceled'
 /** The Subscription Item has ended. */
 | 'ended'
 /** The Subscription Item has expired. */
 | 'expired'
 /** The Subscription Item is incomplete. */
 | 'incomplete'
 /** The Subscription Item has a past-due payment. */
 | 'past_due'
 /** The Subscription Item is upcoming. */
 | 'upcoming';

/**
Expand Down

1 change: 1 addition & 0 deletions
packages/backend/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -113,6 +113,7 @@ export type {
 BillingPlanJSON,
 BillingSubscriptionJSON,
 BillingSubscriptionItemJSON,
 BillingSubscriptionItemStatus,
} from './api/resources/JSON';

/**
Expand Down

2 changes: 1 addition & 1 deletion
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1445,7 +1445,7 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 supportEmail?: string;
 /**
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/Sessions#operation/touchSession){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 * By default, the [Clerk Frontend API `touch` endpoint](https://clerk.com/docs/reference/frontend-api/tag/sessions/POST/v1/client/sessions/%7Bsession_id%7D/touch){{ target: '_blank' }} is called during page focus to keep the last active session alive. This option allows you to disable this behavior.
 */
 touchSession?: boolean;
 /**
Expand Down
Loading