fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types#9052

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
alexisintech merged 7 commits into from
Jun 30, 2026
Merged

fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types #9052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9660364
fix(repo): backfill JSDoc on inline object literals lost via Omit/Pick
alexisintech Jun 30, 2026
baa7de8
update typedocs for billing and organizationdomain
alexisintech Jun 30, 2026
2e5b7dd
remove custom plugin updates
alexisintech Jun 30, 2026
1d04b80
fix formatting
alexisintech Jun 30, 2026
4a865b3
small copy update
alexisintech Jun 30, 2026
5e7840d
fix(repo): preserve intentionally-empty inline-object comments
alexisintech Jun 30, 2026
8b9da58
fix(repo): deepen type fingerprint to disambiguate generic and nested…
alexisintech Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/fix-typedoc-inline-object-comment-backfill.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---
115 changes: 115 additions & 0 deletions .typedoc/custom-plugin.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -509,6 +509,119 @@ function collectPropertiesFromType(type, reflectionsByName) {
return [];
}

/**
* Structural fingerprint for a `Type`. Recurses into composite shapes so two types that only differ in their type arguments (`Foo<string>` vs `Foo<number>`) or in their nested property types (`{ x: string }` vs `{ x: number }`) get distinct fingerprints. Two shapes that produce the same fingerprint are treated as structurally identical and so eligible for cross-pollinating JSDoc comments.
*
* Recursion guard: a single shared `Set` of visited reflection ids threads through every nested call to avoid infinite loops on cyclic types (e.g. a type literal that ultimately references itself).
*
* @param {import('typedoc').SomeType | undefined} type
* @param {Set<number>} [seen]
* @returns {string}
*/
function typeFingerprint(type, seen = new Set()) {
if (!type) return '?';
const t =
/** @type {{ type?: string; name?: string; value?: unknown; elementType?: import('typedoc').SomeType; types?: import('typedoc').SomeType[]; typeArguments?: import('typedoc').SomeType[]; declaration?: import('typedoc').DeclarationReflection }} */ (
/** @type {unknown} */ (type)
);
switch (t.type) {
case 'intrinsic':
return `i:${t.name ?? ''}`;
case 'literal':
return `l:${JSON.stringify(t.value)}`;
case 'reference': {
const args = t.typeArguments?.length ? `<${t.typeArguments.map(a => typeFingerprint(a, seen)).join(',')}>` : '';
return `r:${t.name ?? ''}${args}`;
}
case 'array':
return `a:${typeFingerprint(t.elementType, seen)}`;
case 'optional':
return `o:${typeFingerprint(t.elementType, seen)}`;
case 'union':
return `u:[${(t.types ?? [])
.map(a => typeFingerprint(a, seen))
.sort()
.join(',')}]`;
case 'intersection':
return `n:[${(t.types ?? [])
.map(a => typeFingerprint(a, seen))
.sort()
.join(',')}]`;
case 'reflection': {
const decl = t.declaration;
if (decl?.id != null) {
if (seen.has(decl.id)) return `rf:<cycle>`;
seen.add(decl.id);
}
const kids = decl?.children?.filter(c => c.kindOf?.(ReflectionKind.Property)) ?? [];
return `rf:[${kids
.map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type, seen)}`)
.sort()
.join(',')}]`;
}
default:
return t.type ?? '?';
}
}

/**
* When TypeScript resolves a type through `Omit<...>` / `Pick<...>` (e.g. `ClerkProviderProps = Omit<IsomorphicClerkOptions, …> & { … }`), inline anonymous object literal property types get re-synthesized — and TypeDoc loses the JSDoc on most of their members. Only the first/leading property's comment survives, the rest come through with `comment === undefined`. The same shape elsewhere in the project (e.g. directly under `IsomorphicClerkOptions['telemetry']`) carries all comments correctly.
*
* Match `@kind:typeLiteral` reflections by structural fingerprint (set of `(name, type, optional)` tuples on their property children); within each group, pick the reflection with the most commented children as the source-of-truth and copy missing comments onto its siblings.
*
* @param {import('typedoc').Reflection[]} all
*/
function backfillInlineObjectChildComments(all) {
/** @type {Map<string, import('typedoc').DeclarationReflection[]>} */
const groups = new Map();
for (const r of all) {
if (!r.kindOf?.(ReflectionKind.TypeLiteral)) continue;
const decl = /** @type {import('typedoc').DeclarationReflection} */ (r);
const propChildren = decl.children?.filter(c => c.kindOf?.(ReflectionKind.Property));
if (!propChildren?.length) continue;
const key = propChildren
.map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type)}`)
.sort()
.join('|');
if (!groups.has(key)) groups.set(key, []);
/** @type {import('typedoc').DeclarationReflection[]} */ (groups.get(key)).push(decl);
}

for (const group of groups.values()) {
if (group.length < 2) continue;
/** @type {import('typedoc').DeclarationReflection | null} */
let best = null;
let bestScore = -1;
for (const refl of group) {
const score =
refl.children?.filter(c => c.kindOf?.(ReflectionKind.Property) && c.comment?.summary?.length).length ?? 0;
if (score > bestScore) {
best = refl;
bestScore = score;
}
}
if (!best || bestScore === 0) continue;
/** @type {Map<string, import('typedoc').DeclarationReflection>} */
const bestByName = new Map();
for (const c of best.children ?? []) {
if (c.kindOf?.(ReflectionKind.Property)) bestByName.set(c.name, c);
}
for (const refl of group) {
if (refl === best) continue;
for (const child of refl.children ?? []) {
if (!child.kindOf?.(ReflectionKind.Property)) continue;
// Any `.comment` object means TypeDoc found a JSDoc block at the source — including
// intentionally empty comments left over from `@generateWithEmptyComment` after the
// modifier tag is stripped in `EVENT_RESOLVE_END`. Only fill in children that have
// no comment at all.
if (child.comment) continue;
const src = bestByName.get(child.name);
if (src?.comment?.summary?.length) child.comment = src.comment;
}
}
}
}

/**
* @param {import('typedoc-plugin-markdown').MarkdownApplication} app
*/
Expand DownExpand Up@@ -565,6 +678,8 @@ export function load(app) {
}
}
}

backfillInlineObjectChildComments(all);
});

app.renderer.on(MarkdownPageEvent.END, output => {
Expand Down
20 changes: 14 additions & 6 deletions packages/shared/src/types/billing.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,13 +87,15 @@ export interface BillingNamespace {

/**
* Gets the credit balance for the current payer.
* @returns A [`BillingCreditBalanceResource`](https://clerk.com/docs/reference/types/billing-credit-balance-resource) object.
*
* @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.
*/
getCreditBalance: (params: GetCreditBalanceParams) => Promise<BillingCreditBalanceResource>;

/**
* Gets the credit history for the current payer.
* @returns A [`ClerkPaginatedResponse`](https://clerk.com/docs/reference/types/clerk-paginated-response) of [`BillingCreditLedgerResource`](https://clerk.com/docs/reference/types/billing-credit-ledger-resource) objects.
*
* @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.
*/
Expand DownExpand Up@@ -913,19 +915,19 @@ export interface BillingSubscriptionResource extends ClerkResource {
}

/**
* The `BillingCreditBalanceResource` type represents the credit balance for a payer.
* @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 interface BillingCreditBalanceResource {
/**
* The balance of the credit.
*/
/** The balance of the credit. */
balance: BillingMoneyAmount | null;
}

/**
* @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 GetCreditBalanceParams = {
/**
* The ID of the Organization to get the credit balance for.
*/
/** The ID of the Organization to get the credit balance for. */
orgId?: string;
};

Expand All@@ -940,13 +942,19 @@ export type GetCreditHistoryParams = {
};

/**
* The `BillingCreditLedgerResource` type represents a credit ledger entry for the current payer or given Organization.
* @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 interface BillingCreditLedgerResource {
/** The ID of the credit ledger entry. */
id: string;
/** The amount of the credit ledger entry. */
amount: BillingMoneyAmount;
/** The type of the source of the credit ledger entry. */
sourceType: string;
/** The ID of the source of the credit ledger entry. */
sourceId: string;
/** The date when the credit ledger entry was created. */
createdAt: Date;
}

Expand Down
8 changes: 4 additions & 4 deletions packages/shared/src/types/organizationDomain.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,13 @@ export interface OrganizationDomainResource extends ClerkResource {
totalPendingSuggestions: number;
/**
* Begins the verification process of a created Organization domain by sending a verification code to the provided email address.
* @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
* @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
*/
prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;

/**
* Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
* @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
* Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
* @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
*/
attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
/**
Expand All@@ -189,7 +189,7 @@ export interface OrganizationDomainResource extends ClerkResource {
delete: () => Promise<void>;
/**
* Updates the enrollment mode of the Verified Domain.
* @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
* @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
*/
updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise<OrganizationDomainResource>;
}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types#9052

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

alexisintech
merged 7 commits into

from

Jun 30, 2026
 Merged


fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types
#9052
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
9660364

fix(repo): backfill JSDoc on inline object literals lost via Omit/Pick


alexisintech Jun 30, 2026
baa7de8

update typedocs for billing and organizationdomain


alexisintech Jun 30, 2026
2e5b7dd

remove custom plugin updates


alexisintech Jun 30, 2026
1d04b80

fix formatting


alexisintech Jun 30, 2026
4a865b3

small copy update


alexisintech Jun 30, 2026
5e7840d

fix(repo): preserve intentionally-empty inline-object comments


alexisintech Jun 30, 2026
8b9da58

fix(repo): deepen type fingerprint to disambiguate generic and nested…


alexisintech Jun 30, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/fix-typedoc-inline-object-comment-backfill.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -509,6 +509,119 @@ function collectPropertiesFromType(type, reflectionsByName) {
 return [];
}

/**
 * Structural fingerprint for a `Type`. Recurses into composite shapes so two types that only differ in their type arguments (`Foo<string>` vs `Foo<number>`) or in their nested property types (`{ x: string }` vs `{ x: number }`) get distinct fingerprints. Two shapes that produce the same fingerprint are treated as structurally identical and so eligible for cross-pollinating JSDoc comments.
 *
 * Recursion guard: a single shared `Set` of visited reflection ids threads through every nested call to avoid infinite loops on cyclic types (e.g. a type literal that ultimately references itself).
 *
 * @param {import('typedoc').SomeType | undefined} type
 * @param {Set<number>} [seen]
 * @returns {string}
 */
function typeFingerprint(type, seen = new Set()) {
 if (!type) return '?';
 const t =
 /** @type {{ type?: string; name?: string; value?: unknown; elementType?: import('typedoc').SomeType; types?: import('typedoc').SomeType[]; typeArguments?: import('typedoc').SomeType[]; declaration?: import('typedoc').DeclarationReflection }} */ (
 /** @type {unknown} */ (type)
 );
 switch (t.type) {
 case 'intrinsic':
 return `i:${t.name ?? ''}`;
 case 'literal':
 return `l:${JSON.stringify(t.value)}`;
 case 'reference': {
 const args = t.typeArguments?.length ? `<${t.typeArguments.map(a => typeFingerprint(a, seen)).join(',')}>` : '';
 return `r:${t.name ?? ''}${args}`;
 }
 case 'array':
 return `a:${typeFingerprint(t.elementType, seen)}`;
 case 'optional':
 return `o:${typeFingerprint(t.elementType, seen)}`;
 case 'union':
 return `u:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'intersection':
 return `n:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'reflection': {
 const decl = t.declaration;
 if (decl?.id != null) {
 if (seen.has(decl.id)) return `rf:<cycle>`;
 seen.add(decl.id);
 }
 const kids = decl?.children?.filter(c => c.kindOf?.(ReflectionKind.Property)) ?? [];
 return `rf:[${kids
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type, seen)}`)
 .sort()
 .join(',')}]`;
 }
 default:
 return t.type ?? '?';
 }
}

/**
 * When TypeScript resolves a type through `Omit<...>` / `Pick<...>` (e.g. `ClerkProviderProps = Omit<IsomorphicClerkOptions, …> & { … }`), inline anonymous object literal property types get re-synthesized — and TypeDoc loses the JSDoc on most of their members. Only the first/leading property's comment survives, the rest come through with `comment === undefined`. The same shape elsewhere in the project (e.g. directly under `IsomorphicClerkOptions['telemetry']`) carries all comments correctly.
 *
 * Match `@kind:typeLiteral` reflections by structural fingerprint (set of `(name, type, optional)` tuples on their property children); within each group, pick the reflection with the most commented children as the source-of-truth and copy missing comments onto its siblings.
 *
 * @param {import('typedoc').Reflection[]} all
 */
function backfillInlineObjectChildComments(all) {
 /** @type {Map<string, import('typedoc').DeclarationReflection[]>} */
 const groups = new Map();
 for (const r of all) {
 if (!r.kindOf?.(ReflectionKind.TypeLiteral)) continue;
 const decl = /** @type {import('typedoc').DeclarationReflection} */ (r);
 const propChildren = decl.children?.filter(c => c.kindOf?.(ReflectionKind.Property));
 if (!propChildren?.length) continue;
 const key = propChildren
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type)}`)
 .sort()
 .join('|');
 if (!groups.has(key)) groups.set(key, []);
 /** @type {import('typedoc').DeclarationReflection[]} */ (groups.get(key)).push(decl);
 }

 for (const group of groups.values()) {
 if (group.length < 2) continue;
 /** @type {import('typedoc').DeclarationReflection | null} */
 let best = null;
 let bestScore = -1;
 for (const refl of group) {
 const score =
 refl.children?.filter(c => c.kindOf?.(ReflectionKind.Property) && c.comment?.summary?.length).length ?? 0;
 if (score > bestScore) {
 best = refl;
 bestScore = score;
 }
 }
 if (!best || bestScore === 0) continue;
 /** @type {Map<string, import('typedoc').DeclarationReflection>} */
 const bestByName = new Map();
 for (const c of best.children ?? []) {
 if (c.kindOf?.(ReflectionKind.Property)) bestByName.set(c.name, c);
 }
 for (const refl of group) {
 if (refl === best) continue;
 for (const child of refl.children ?? []) {
 if (!child.kindOf?.(ReflectionKind.Property)) continue;
 // Any `.comment` object means TypeDoc found a JSDoc block at the source — including
 // intentionally empty comments left over from `@generateWithEmptyComment` after the
 // modifier tag is stripped in `EVENT_RESOLVE_END`. Only fill in children that have
 // no comment at all.
 if (child.comment) continue;
 const src = bestByName.get(child.name);
 if (src?.comment?.summary?.length) child.comment = src.comment;
 }
 }
 }
}

/**
 * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
 */
Expand DownExpand Up@@ -565,6 +678,8 @@ export function load(app) {
 }
 }
 }

 backfillInlineObjectChildComments(all);
 });

 app.renderer.on(MarkdownPageEvent.END, output => {
Expand Down

20 changes: 14 additions & 6 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,13 +87,15 @@ export interface BillingNamespace {

 /**
 * Gets the credit balance for the current payer.
 * @returns A [`BillingCreditBalanceResource`](https://clerk.com/docs/reference/types/billing-credit-balance-resource) object.
 *
 * @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.
 */
 getCreditBalance: (params: GetCreditBalanceParams) => Promise<BillingCreditBalanceResource>;

 /**
 * Gets the credit history for the current payer.
 * @returns A [`ClerkPaginatedResponse`](https://clerk.com/docs/reference/types/clerk-paginated-response) of [`BillingCreditLedgerResource`](https://clerk.com/docs/reference/types/billing-credit-ledger-resource) objects.
 *
 * @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.
 */
Expand DownExpand Up@@ -913,19 +915,19 @@ export interface BillingSubscriptionResource extends ClerkResource {
}

/**
 * The `BillingCreditBalanceResource` type represents the credit balance for a payer.
 * @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 interface BillingCreditBalanceResource {
 /**
 * The balance of the credit.
 */
 /** The balance of the credit. */
 balance: BillingMoneyAmount | null;
}

/**
 * @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 GetCreditBalanceParams = {
 /**
 * The ID of the Organization to get the credit balance for.
 */
 /** The ID of the Organization to get the credit balance for. */
 orgId?: string;
};

Expand All@@ -940,13 +942,19 @@ export type GetCreditHistoryParams = {
};

/**
 * The `BillingCreditLedgerResource` type represents a credit ledger entry for the current payer or given Organization.
 * @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 interface BillingCreditLedgerResource {
 /** The ID of the credit ledger entry. */
 id: string;
 /** The amount of the credit ledger entry. */
 amount: BillingMoneyAmount;
 /** The type of the source of the credit ledger entry. */
 sourceType: string;
 /** The ID of the source of the credit ledger entry. */
 sourceId: string;
 /** The date when the credit ledger entry was created. */
 createdAt: Date;
}

Expand Down

8 changes: 4 additions & 4 deletions
packages/shared/src/types/organizationDomain.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,13 @@ export interface OrganizationDomainResource extends ClerkResource {
 totalPendingSuggestions: number;
 /**
 * Begins the verification process of a created Organization domain by sending a verification code to the provided email address.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;

 /**
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
 /**
Expand All@@ -189,7 +189,7 @@ export interface OrganizationDomainResource extends ClerkResource {
 delete: () => Promise<void>;
 /**
 * Updates the enrollment mode of the Verified Domain.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise<OrganizationDomainResource>;
}
Expand Down
Loading

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

Skip to content
fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types#9052

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

alexisintech
merged 7 commits into

from

Jun 30, 2026
 Merged


fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types
#9052
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
9660364

fix(repo): backfill JSDoc on inline object literals lost via Omit/Pick


alexisintech Jun 30, 2026
baa7de8

update typedocs for billing and organizationdomain


alexisintech Jun 30, 2026
2e5b7dd

remove custom plugin updates


alexisintech Jun 30, 2026
1d04b80

fix formatting


alexisintech Jun 30, 2026
4a865b3

small copy update


alexisintech Jun 30, 2026
5e7840d

fix(repo): preserve intentionally-empty inline-object comments


alexisintech Jun 30, 2026
8b9da58

fix(repo): deepen type fingerprint to disambiguate generic and nested…


alexisintech Jun 30, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/fix-typedoc-inline-object-comment-backfill.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -509,6 +509,119 @@ function collectPropertiesFromType(type, reflectionsByName) {
 return [];
}

/**
 * Structural fingerprint for a `Type`. Recurses into composite shapes so two types that only differ in their type arguments (`Foo<string>` vs `Foo<number>`) or in their nested property types (`{ x: string }` vs `{ x: number }`) get distinct fingerprints. Two shapes that produce the same fingerprint are treated as structurally identical and so eligible for cross-pollinating JSDoc comments.
 *
 * Recursion guard: a single shared `Set` of visited reflection ids threads through every nested call to avoid infinite loops on cyclic types (e.g. a type literal that ultimately references itself).
 *
 * @param {import('typedoc').SomeType | undefined} type
 * @param {Set<number>} [seen]
 * @returns {string}
 */
function typeFingerprint(type, seen = new Set()) {
 if (!type) return '?';
 const t =
 /** @type {{ type?: string; name?: string; value?: unknown; elementType?: import('typedoc').SomeType; types?: import('typedoc').SomeType[]; typeArguments?: import('typedoc').SomeType[]; declaration?: import('typedoc').DeclarationReflection }} */ (
 /** @type {unknown} */ (type)
 );
 switch (t.type) {
 case 'intrinsic':
 return `i:${t.name ?? ''}`;
 case 'literal':
 return `l:${JSON.stringify(t.value)}`;
 case 'reference': {
 const args = t.typeArguments?.length ? `<${t.typeArguments.map(a => typeFingerprint(a, seen)).join(',')}>` : '';
 return `r:${t.name ?? ''}${args}`;
 }
 case 'array':
 return `a:${typeFingerprint(t.elementType, seen)}`;
 case 'optional':
 return `o:${typeFingerprint(t.elementType, seen)}`;
 case 'union':
 return `u:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'intersection':
 return `n:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'reflection': {
 const decl = t.declaration;
 if (decl?.id != null) {
 if (seen.has(decl.id)) return `rf:<cycle>`;
 seen.add(decl.id);
 }
 const kids = decl?.children?.filter(c => c.kindOf?.(ReflectionKind.Property)) ?? [];
 return `rf:[${kids
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type, seen)}`)
 .sort()
 .join(',')}]`;
 }
 default:
 return t.type ?? '?';
 }
}

/**
 * When TypeScript resolves a type through `Omit<...>` / `Pick<...>` (e.g. `ClerkProviderProps = Omit<IsomorphicClerkOptions, …> & { … }`), inline anonymous object literal property types get re-synthesized — and TypeDoc loses the JSDoc on most of their members. Only the first/leading property's comment survives, the rest come through with `comment === undefined`. The same shape elsewhere in the project (e.g. directly under `IsomorphicClerkOptions['telemetry']`) carries all comments correctly.
 *
 * Match `@kind:typeLiteral` reflections by structural fingerprint (set of `(name, type, optional)` tuples on their property children); within each group, pick the reflection with the most commented children as the source-of-truth and copy missing comments onto its siblings.
 *
 * @param {import('typedoc').Reflection[]} all
 */
function backfillInlineObjectChildComments(all) {
 /** @type {Map<string, import('typedoc').DeclarationReflection[]>} */
 const groups = new Map();
 for (const r of all) {
 if (!r.kindOf?.(ReflectionKind.TypeLiteral)) continue;
 const decl = /** @type {import('typedoc').DeclarationReflection} */ (r);
 const propChildren = decl.children?.filter(c => c.kindOf?.(ReflectionKind.Property));
 if (!propChildren?.length) continue;
 const key = propChildren
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type)}`)
 .sort()
 .join('|');
 if (!groups.has(key)) groups.set(key, []);
 /** @type {import('typedoc').DeclarationReflection[]} */ (groups.get(key)).push(decl);
 }

 for (const group of groups.values()) {
 if (group.length < 2) continue;
 /** @type {import('typedoc').DeclarationReflection | null} */
 let best = null;
 let bestScore = -1;
 for (const refl of group) {
 const score =
 refl.children?.filter(c => c.kindOf?.(ReflectionKind.Property) && c.comment?.summary?.length).length ?? 0;
 if (score > bestScore) {
 best = refl;
 bestScore = score;
 }
 }
 if (!best || bestScore === 0) continue;
 /** @type {Map<string, import('typedoc').DeclarationReflection>} */
 const bestByName = new Map();
 for (const c of best.children ?? []) {
 if (c.kindOf?.(ReflectionKind.Property)) bestByName.set(c.name, c);
 }
 for (const refl of group) {
 if (refl === best) continue;
 for (const child of refl.children ?? []) {
 if (!child.kindOf?.(ReflectionKind.Property)) continue;
 // Any `.comment` object means TypeDoc found a JSDoc block at the source — including
 // intentionally empty comments left over from `@generateWithEmptyComment` after the
 // modifier tag is stripped in `EVENT_RESOLVE_END`. Only fill in children that have
 // no comment at all.
 if (child.comment) continue;
 const src = bestByName.get(child.name);
 if (src?.comment?.summary?.length) child.comment = src.comment;
 }
 }
 }
}

/**
 * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
 */
Expand DownExpand Up@@ -565,6 +678,8 @@ export function load(app) {
 }
 }
 }

 backfillInlineObjectChildComments(all);
 });

 app.renderer.on(MarkdownPageEvent.END, output => {
Expand Down

20 changes: 14 additions & 6 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,13 +87,15 @@ export interface BillingNamespace {

 /**
 * Gets the credit balance for the current payer.
 * @returns A [`BillingCreditBalanceResource`](https://clerk.com/docs/reference/types/billing-credit-balance-resource) object.
 *
 * @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.
 */
 getCreditBalance: (params: GetCreditBalanceParams) => Promise<BillingCreditBalanceResource>;

 /**
 * Gets the credit history for the current payer.
 * @returns A [`ClerkPaginatedResponse`](https://clerk.com/docs/reference/types/clerk-paginated-response) of [`BillingCreditLedgerResource`](https://clerk.com/docs/reference/types/billing-credit-ledger-resource) objects.
 *
 * @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.
 */
Expand DownExpand Up@@ -913,19 +915,19 @@ export interface BillingSubscriptionResource extends ClerkResource {
}

/**
 * The `BillingCreditBalanceResource` type represents the credit balance for a payer.
 * @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 interface BillingCreditBalanceResource {
 /**
 * The balance of the credit.
 */
 /** The balance of the credit. */
 balance: BillingMoneyAmount | null;
}

/**
 * @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 GetCreditBalanceParams = {
 /**
 * The ID of the Organization to get the credit balance for.
 */
 /** The ID of the Organization to get the credit balance for. */
 orgId?: string;
};

Expand All@@ -940,13 +942,19 @@ export type GetCreditHistoryParams = {
};

/**
 * The `BillingCreditLedgerResource` type represents a credit ledger entry for the current payer or given Organization.
 * @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 interface BillingCreditLedgerResource {
 /** The ID of the credit ledger entry. */
 id: string;
 /** The amount of the credit ledger entry. */
 amount: BillingMoneyAmount;
 /** The type of the source of the credit ledger entry. */
 sourceType: string;
 /** The ID of the source of the credit ledger entry. */
 sourceId: string;
 /** The date when the credit ledger entry was created. */
 createdAt: Date;
}

Expand Down

8 changes: 4 additions & 4 deletions
packages/shared/src/types/organizationDomain.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,13 @@ export interface OrganizationDomainResource extends ClerkResource {
 totalPendingSuggestions: number;
 /**
 * Begins the verification process of a created Organization domain by sending a verification code to the provided email address.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;

 /**
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
 /**
Expand All@@ -189,7 +189,7 @@ export interface OrganizationDomainResource extends ClerkResource {
 delete: () => Promise<void>;
 /**
 * Updates the enrollment mode of the Verified Domain.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise<OrganizationDomainResource>;
}
Expand Down
Loading

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

Skip to content
fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types#9052

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

alexisintech
merged 7 commits into

from

Jun 30, 2026
 Merged


fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types
#9052
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
9660364

fix(repo): backfill JSDoc on inline object literals lost via Omit/Pick


alexisintech Jun 30, 2026
baa7de8

update typedocs for billing and organizationdomain


alexisintech Jun 30, 2026
2e5b7dd

remove custom plugin updates


alexisintech Jun 30, 2026
1d04b80

fix formatting


alexisintech Jun 30, 2026
4a865b3

small copy update


alexisintech Jun 30, 2026
5e7840d

fix(repo): preserve intentionally-empty inline-object comments


alexisintech Jun 30, 2026
8b9da58

fix(repo): deepen type fingerprint to disambiguate generic and nested…


alexisintech Jun 30, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/fix-typedoc-inline-object-comment-backfill.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -509,6 +509,119 @@ function collectPropertiesFromType(type, reflectionsByName) {
 return [];
}

/**
 * Structural fingerprint for a `Type`. Recurses into composite shapes so two types that only differ in their type arguments (`Foo<string>` vs `Foo<number>`) or in their nested property types (`{ x: string }` vs `{ x: number }`) get distinct fingerprints. Two shapes that produce the same fingerprint are treated as structurally identical and so eligible for cross-pollinating JSDoc comments.
 *
 * Recursion guard: a single shared `Set` of visited reflection ids threads through every nested call to avoid infinite loops on cyclic types (e.g. a type literal that ultimately references itself).
 *
 * @param {import('typedoc').SomeType | undefined} type
 * @param {Set<number>} [seen]
 * @returns {string}
 */
function typeFingerprint(type, seen = new Set()) {
 if (!type) return '?';
 const t =
 /** @type {{ type?: string; name?: string; value?: unknown; elementType?: import('typedoc').SomeType; types?: import('typedoc').SomeType[]; typeArguments?: import('typedoc').SomeType[]; declaration?: import('typedoc').DeclarationReflection }} */ (
 /** @type {unknown} */ (type)
 );
 switch (t.type) {
 case 'intrinsic':
 return `i:${t.name ?? ''}`;
 case 'literal':
 return `l:${JSON.stringify(t.value)}`;
 case 'reference': {
 const args = t.typeArguments?.length ? `<${t.typeArguments.map(a => typeFingerprint(a, seen)).join(',')}>` : '';
 return `r:${t.name ?? ''}${args}`;
 }
 case 'array':
 return `a:${typeFingerprint(t.elementType, seen)}`;
 case 'optional':
 return `o:${typeFingerprint(t.elementType, seen)}`;
 case 'union':
 return `u:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'intersection':
 return `n:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'reflection': {
 const decl = t.declaration;
 if (decl?.id != null) {
 if (seen.has(decl.id)) return `rf:<cycle>`;
 seen.add(decl.id);
 }
 const kids = decl?.children?.filter(c => c.kindOf?.(ReflectionKind.Property)) ?? [];
 return `rf:[${kids
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type, seen)}`)
 .sort()
 .join(',')}]`;
 }
 default:
 return t.type ?? '?';
 }
}

/**
 * When TypeScript resolves a type through `Omit<...>` / `Pick<...>` (e.g. `ClerkProviderProps = Omit<IsomorphicClerkOptions, …> & { … }`), inline anonymous object literal property types get re-synthesized — and TypeDoc loses the JSDoc on most of their members. Only the first/leading property's comment survives, the rest come through with `comment === undefined`. The same shape elsewhere in the project (e.g. directly under `IsomorphicClerkOptions['telemetry']`) carries all comments correctly.
 *
 * Match `@kind:typeLiteral` reflections by structural fingerprint (set of `(name, type, optional)` tuples on their property children); within each group, pick the reflection with the most commented children as the source-of-truth and copy missing comments onto its siblings.
 *
 * @param {import('typedoc').Reflection[]} all
 */
function backfillInlineObjectChildComments(all) {
 /** @type {Map<string, import('typedoc').DeclarationReflection[]>} */
 const groups = new Map();
 for (const r of all) {
 if (!r.kindOf?.(ReflectionKind.TypeLiteral)) continue;
 const decl = /** @type {import('typedoc').DeclarationReflection} */ (r);
 const propChildren = decl.children?.filter(c => c.kindOf?.(ReflectionKind.Property));
 if (!propChildren?.length) continue;
 const key = propChildren
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type)}`)
 .sort()
 .join('|');
 if (!groups.has(key)) groups.set(key, []);
 /** @type {import('typedoc').DeclarationReflection[]} */ (groups.get(key)).push(decl);
 }

 for (const group of groups.values()) {
 if (group.length < 2) continue;
 /** @type {import('typedoc').DeclarationReflection | null} */
 let best = null;
 let bestScore = -1;
 for (const refl of group) {
 const score =
 refl.children?.filter(c => c.kindOf?.(ReflectionKind.Property) && c.comment?.summary?.length).length ?? 0;
 if (score > bestScore) {
 best = refl;
 bestScore = score;
 }
 }
 if (!best || bestScore === 0) continue;
 /** @type {Map<string, import('typedoc').DeclarationReflection>} */
 const bestByName = new Map();
 for (const c of best.children ?? []) {
 if (c.kindOf?.(ReflectionKind.Property)) bestByName.set(c.name, c);
 }
 for (const refl of group) {
 if (refl === best) continue;
 for (const child of refl.children ?? []) {
 if (!child.kindOf?.(ReflectionKind.Property)) continue;
 // Any `.comment` object means TypeDoc found a JSDoc block at the source — including
 // intentionally empty comments left over from `@generateWithEmptyComment` after the
 // modifier tag is stripped in `EVENT_RESOLVE_END`. Only fill in children that have
 // no comment at all.
 if (child.comment) continue;
 const src = bestByName.get(child.name);
 if (src?.comment?.summary?.length) child.comment = src.comment;
 }
 }
 }
}

/**
 * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
 */
Expand DownExpand Up@@ -565,6 +678,8 @@ export function load(app) {
 }
 }
 }

 backfillInlineObjectChildComments(all);
 });

 app.renderer.on(MarkdownPageEvent.END, output => {
Expand Down

20 changes: 14 additions & 6 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,13 +87,15 @@ export interface BillingNamespace {

 /**
 * Gets the credit balance for the current payer.
 * @returns A [`BillingCreditBalanceResource`](https://clerk.com/docs/reference/types/billing-credit-balance-resource) object.
 *
 * @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.
 */
 getCreditBalance: (params: GetCreditBalanceParams) => Promise<BillingCreditBalanceResource>;

 /**
 * Gets the credit history for the current payer.
 * @returns A [`ClerkPaginatedResponse`](https://clerk.com/docs/reference/types/clerk-paginated-response) of [`BillingCreditLedgerResource`](https://clerk.com/docs/reference/types/billing-credit-ledger-resource) objects.
 *
 * @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.
 */
Expand DownExpand Up@@ -913,19 +915,19 @@ export interface BillingSubscriptionResource extends ClerkResource {
}

/**
 * The `BillingCreditBalanceResource` type represents the credit balance for a payer.
 * @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 interface BillingCreditBalanceResource {
 /**
 * The balance of the credit.
 */
 /** The balance of the credit. */
 balance: BillingMoneyAmount | null;
}

/**
 * @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 GetCreditBalanceParams = {
 /**
 * The ID of the Organization to get the credit balance for.
 */
 /** The ID of the Organization to get the credit balance for. */
 orgId?: string;
};

Expand All@@ -940,13 +942,19 @@ export type GetCreditHistoryParams = {
};

/**
 * The `BillingCreditLedgerResource` type represents a credit ledger entry for the current payer or given Organization.
 * @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 interface BillingCreditLedgerResource {
 /** The ID of the credit ledger entry. */
 id: string;
 /** The amount of the credit ledger entry. */
 amount: BillingMoneyAmount;
 /** The type of the source of the credit ledger entry. */
 sourceType: string;
 /** The ID of the source of the credit ledger entry. */
 sourceId: string;
 /** The date when the credit ledger entry was created. */
 createdAt: Date;
}

Expand Down

8 changes: 4 additions & 4 deletions
packages/shared/src/types/organizationDomain.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,13 @@ export interface OrganizationDomainResource extends ClerkResource {
 totalPendingSuggestions: number;
 /**
 * Begins the verification process of a created Organization domain by sending a verification code to the provided email address.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;

 /**
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
 /**
Expand All@@ -189,7 +189,7 @@ export interface OrganizationDomainResource extends ClerkResource {
 delete: () => Promise<void>;
 /**
 * Updates the enrollment mode of the Verified Domain.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise<OrganizationDomainResource>;
}
Expand Down
Loading

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

Skip to content
fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types#9052

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

alexisintech
merged 7 commits into

from

Jun 30, 2026
 Merged


fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types
#9052
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
9660364

fix(repo): backfill JSDoc on inline object literals lost via Omit/Pick


alexisintech Jun 30, 2026
baa7de8

update typedocs for billing and organizationdomain


alexisintech Jun 30, 2026
2e5b7dd

remove custom plugin updates


alexisintech Jun 30, 2026
1d04b80

fix formatting


alexisintech Jun 30, 2026
4a865b3

small copy update


alexisintech Jun 30, 2026
5e7840d

fix(repo): preserve intentionally-empty inline-object comments


alexisintech Jun 30, 2026
8b9da58

fix(repo): deepen type fingerprint to disambiguate generic and nested…


alexisintech Jun 30, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/fix-typedoc-inline-object-comment-backfill.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -509,6 +509,119 @@ function collectPropertiesFromType(type, reflectionsByName) {
 return [];
}

/**
 * Structural fingerprint for a `Type`. Recurses into composite shapes so two types that only differ in their type arguments (`Foo<string>` vs `Foo<number>`) or in their nested property types (`{ x: string }` vs `{ x: number }`) get distinct fingerprints. Two shapes that produce the same fingerprint are treated as structurally identical and so eligible for cross-pollinating JSDoc comments.
 *
 * Recursion guard: a single shared `Set` of visited reflection ids threads through every nested call to avoid infinite loops on cyclic types (e.g. a type literal that ultimately references itself).
 *
 * @param {import('typedoc').SomeType | undefined} type
 * @param {Set<number>} [seen]
 * @returns {string}
 */
function typeFingerprint(type, seen = new Set()) {
 if (!type) return '?';
 const t =
 /** @type {{ type?: string; name?: string; value?: unknown; elementType?: import('typedoc').SomeType; types?: import('typedoc').SomeType[]; typeArguments?: import('typedoc').SomeType[]; declaration?: import('typedoc').DeclarationReflection }} */ (
 /** @type {unknown} */ (type)
 );
 switch (t.type) {
 case 'intrinsic':
 return `i:${t.name ?? ''}`;
 case 'literal':
 return `l:${JSON.stringify(t.value)}`;
 case 'reference': {
 const args = t.typeArguments?.length ? `<${t.typeArguments.map(a => typeFingerprint(a, seen)).join(',')}>` : '';
 return `r:${t.name ?? ''}${args}`;
 }
 case 'array':
 return `a:${typeFingerprint(t.elementType, seen)}`;
 case 'optional':
 return `o:${typeFingerprint(t.elementType, seen)}`;
 case 'union':
 return `u:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'intersection':
 return `n:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'reflection': {
 const decl = t.declaration;
 if (decl?.id != null) {
 if (seen.has(decl.id)) return `rf:<cycle>`;
 seen.add(decl.id);
 }
 const kids = decl?.children?.filter(c => c.kindOf?.(ReflectionKind.Property)) ?? [];
 return `rf:[${kids
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type, seen)}`)
 .sort()
 .join(',')}]`;
 }
 default:
 return t.type ?? '?';
 }
}

/**
 * When TypeScript resolves a type through `Omit<...>` / `Pick<...>` (e.g. `ClerkProviderProps = Omit<IsomorphicClerkOptions, …> & { … }`), inline anonymous object literal property types get re-synthesized — and TypeDoc loses the JSDoc on most of their members. Only the first/leading property's comment survives, the rest come through with `comment === undefined`. The same shape elsewhere in the project (e.g. directly under `IsomorphicClerkOptions['telemetry']`) carries all comments correctly.
 *
 * Match `@kind:typeLiteral` reflections by structural fingerprint (set of `(name, type, optional)` tuples on their property children); within each group, pick the reflection with the most commented children as the source-of-truth and copy missing comments onto its siblings.
 *
 * @param {import('typedoc').Reflection[]} all
 */
function backfillInlineObjectChildComments(all) {
 /** @type {Map<string, import('typedoc').DeclarationReflection[]>} */
 const groups = new Map();
 for (const r of all) {
 if (!r.kindOf?.(ReflectionKind.TypeLiteral)) continue;
 const decl = /** @type {import('typedoc').DeclarationReflection} */ (r);
 const propChildren = decl.children?.filter(c => c.kindOf?.(ReflectionKind.Property));
 if (!propChildren?.length) continue;
 const key = propChildren
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type)}`)
 .sort()
 .join('|');
 if (!groups.has(key)) groups.set(key, []);
 /** @type {import('typedoc').DeclarationReflection[]} */ (groups.get(key)).push(decl);
 }

 for (const group of groups.values()) {
 if (group.length < 2) continue;
 /** @type {import('typedoc').DeclarationReflection | null} */
 let best = null;
 let bestScore = -1;
 for (const refl of group) {
 const score =
 refl.children?.filter(c => c.kindOf?.(ReflectionKind.Property) && c.comment?.summary?.length).length ?? 0;
 if (score > bestScore) {
 best = refl;
 bestScore = score;
 }
 }
 if (!best || bestScore === 0) continue;
 /** @type {Map<string, import('typedoc').DeclarationReflection>} */
 const bestByName = new Map();
 for (const c of best.children ?? []) {
 if (c.kindOf?.(ReflectionKind.Property)) bestByName.set(c.name, c);
 }
 for (const refl of group) {
 if (refl === best) continue;
 for (const child of refl.children ?? []) {
 if (!child.kindOf?.(ReflectionKind.Property)) continue;
 // Any `.comment` object means TypeDoc found a JSDoc block at the source — including
 // intentionally empty comments left over from `@generateWithEmptyComment` after the
 // modifier tag is stripped in `EVENT_RESOLVE_END`. Only fill in children that have
 // no comment at all.
 if (child.comment) continue;
 const src = bestByName.get(child.name);
 if (src?.comment?.summary?.length) child.comment = src.comment;
 }
 }
 }
}

/**
 * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
 */
Expand DownExpand Up@@ -565,6 +678,8 @@ export function load(app) {
 }
 }
 }

 backfillInlineObjectChildComments(all);
 });

 app.renderer.on(MarkdownPageEvent.END, output => {
Expand Down

20 changes: 14 additions & 6 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,13 +87,15 @@ export interface BillingNamespace {

 /**
 * Gets the credit balance for the current payer.
 * @returns A [`BillingCreditBalanceResource`](https://clerk.com/docs/reference/types/billing-credit-balance-resource) object.
 *
 * @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.
 */
 getCreditBalance: (params: GetCreditBalanceParams) => Promise<BillingCreditBalanceResource>;

 /**
 * Gets the credit history for the current payer.
 * @returns A [`ClerkPaginatedResponse`](https://clerk.com/docs/reference/types/clerk-paginated-response) of [`BillingCreditLedgerResource`](https://clerk.com/docs/reference/types/billing-credit-ledger-resource) objects.
 *
 * @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.
 */
Expand DownExpand Up@@ -913,19 +915,19 @@ export interface BillingSubscriptionResource extends ClerkResource {
}

/**
 * The `BillingCreditBalanceResource` type represents the credit balance for a payer.
 * @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 interface BillingCreditBalanceResource {
 /**
 * The balance of the credit.
 */
 /** The balance of the credit. */
 balance: BillingMoneyAmount | null;
}

/**
 * @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 GetCreditBalanceParams = {
 /**
 * The ID of the Organization to get the credit balance for.
 */
 /** The ID of the Organization to get the credit balance for. */
 orgId?: string;
};

Expand All@@ -940,13 +942,19 @@ export type GetCreditHistoryParams = {
};

/**
 * The `BillingCreditLedgerResource` type represents a credit ledger entry for the current payer or given Organization.
 * @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 interface BillingCreditLedgerResource {
 /** The ID of the credit ledger entry. */
 id: string;
 /** The amount of the credit ledger entry. */
 amount: BillingMoneyAmount;
 /** The type of the source of the credit ledger entry. */
 sourceType: string;
 /** The ID of the source of the credit ledger entry. */
 sourceId: string;
 /** The date when the credit ledger entry was created. */
 createdAt: Date;
}

Expand Down

8 changes: 4 additions & 4 deletions
packages/shared/src/types/organizationDomain.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,13 @@ export interface OrganizationDomainResource extends ClerkResource {
 totalPendingSuggestions: number;
 /**
 * Begins the verification process of a created Organization domain by sending a verification code to the provided email address.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;

 /**
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
 /**
Expand All@@ -189,7 +189,7 @@ export interface OrganizationDomainResource extends ClerkResource {
 delete: () => Promise<void>;
 /**
 * Updates the enrollment mode of the Verified Domain.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise<OrganizationDomainResource>;
}
Expand Down
Loading

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

Skip to content
fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types#9052

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

alexisintech
merged 7 commits into

from

Jun 30, 2026
 Merged


fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types
#9052
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
9660364

fix(repo): backfill JSDoc on inline object literals lost via Omit/Pick


alexisintech Jun 30, 2026
baa7de8

update typedocs for billing and organizationdomain


alexisintech Jun 30, 2026
2e5b7dd

remove custom plugin updates


alexisintech Jun 30, 2026
1d04b80

fix formatting


alexisintech Jun 30, 2026
4a865b3

small copy update


alexisintech Jun 30, 2026
5e7840d

fix(repo): preserve intentionally-empty inline-object comments


alexisintech Jun 30, 2026
8b9da58

fix(repo): deepen type fingerprint to disambiguate generic and nested…


alexisintech Jun 30, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/fix-typedoc-inline-object-comment-backfill.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -509,6 +509,119 @@ function collectPropertiesFromType(type, reflectionsByName) {
 return [];
}

/**
 * Structural fingerprint for a `Type`. Recurses into composite shapes so two types that only differ in their type arguments (`Foo<string>` vs `Foo<number>`) or in their nested property types (`{ x: string }` vs `{ x: number }`) get distinct fingerprints. Two shapes that produce the same fingerprint are treated as structurally identical and so eligible for cross-pollinating JSDoc comments.
 *
 * Recursion guard: a single shared `Set` of visited reflection ids threads through every nested call to avoid infinite loops on cyclic types (e.g. a type literal that ultimately references itself).
 *
 * @param {import('typedoc').SomeType | undefined} type
 * @param {Set<number>} [seen]
 * @returns {string}
 */
function typeFingerprint(type, seen = new Set()) {
 if (!type) return '?';
 const t =
 /** @type {{ type?: string; name?: string; value?: unknown; elementType?: import('typedoc').SomeType; types?: import('typedoc').SomeType[]; typeArguments?: import('typedoc').SomeType[]; declaration?: import('typedoc').DeclarationReflection }} */ (
 /** @type {unknown} */ (type)
 );
 switch (t.type) {
 case 'intrinsic':
 return `i:${t.name ?? ''}`;
 case 'literal':
 return `l:${JSON.stringify(t.value)}`;
 case 'reference': {
 const args = t.typeArguments?.length ? `<${t.typeArguments.map(a => typeFingerprint(a, seen)).join(',')}>` : '';
 return `r:${t.name ?? ''}${args}`;
 }
 case 'array':
 return `a:${typeFingerprint(t.elementType, seen)}`;
 case 'optional':
 return `o:${typeFingerprint(t.elementType, seen)}`;
 case 'union':
 return `u:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'intersection':
 return `n:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'reflection': {
 const decl = t.declaration;
 if (decl?.id != null) {
 if (seen.has(decl.id)) return `rf:<cycle>`;
 seen.add(decl.id);
 }
 const kids = decl?.children?.filter(c => c.kindOf?.(ReflectionKind.Property)) ?? [];
 return `rf:[${kids
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type, seen)}`)
 .sort()
 .join(',')}]`;
 }
 default:
 return t.type ?? '?';
 }
}

/**
 * When TypeScript resolves a type through `Omit<...>` / `Pick<...>` (e.g. `ClerkProviderProps = Omit<IsomorphicClerkOptions, …> & { … }`), inline anonymous object literal property types get re-synthesized — and TypeDoc loses the JSDoc on most of their members. Only the first/leading property's comment survives, the rest come through with `comment === undefined`. The same shape elsewhere in the project (e.g. directly under `IsomorphicClerkOptions['telemetry']`) carries all comments correctly.
 *
 * Match `@kind:typeLiteral` reflections by structural fingerprint (set of `(name, type, optional)` tuples on their property children); within each group, pick the reflection with the most commented children as the source-of-truth and copy missing comments onto its siblings.
 *
 * @param {import('typedoc').Reflection[]} all
 */
function backfillInlineObjectChildComments(all) {
 /** @type {Map<string, import('typedoc').DeclarationReflection[]>} */
 const groups = new Map();
 for (const r of all) {
 if (!r.kindOf?.(ReflectionKind.TypeLiteral)) continue;
 const decl = /** @type {import('typedoc').DeclarationReflection} */ (r);
 const propChildren = decl.children?.filter(c => c.kindOf?.(ReflectionKind.Property));
 if (!propChildren?.length) continue;
 const key = propChildren
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type)}`)
 .sort()
 .join('|');
 if (!groups.has(key)) groups.set(key, []);
 /** @type {import('typedoc').DeclarationReflection[]} */ (groups.get(key)).push(decl);
 }

 for (const group of groups.values()) {
 if (group.length < 2) continue;
 /** @type {import('typedoc').DeclarationReflection | null} */
 let best = null;
 let bestScore = -1;
 for (const refl of group) {
 const score =
 refl.children?.filter(c => c.kindOf?.(ReflectionKind.Property) && c.comment?.summary?.length).length ?? 0;
 if (score > bestScore) {
 best = refl;
 bestScore = score;
 }
 }
 if (!best || bestScore === 0) continue;
 /** @type {Map<string, import('typedoc').DeclarationReflection>} */
 const bestByName = new Map();
 for (const c of best.children ?? []) {
 if (c.kindOf?.(ReflectionKind.Property)) bestByName.set(c.name, c);
 }
 for (const refl of group) {
 if (refl === best) continue;
 for (const child of refl.children ?? []) {
 if (!child.kindOf?.(ReflectionKind.Property)) continue;
 // Any `.comment` object means TypeDoc found a JSDoc block at the source — including
 // intentionally empty comments left over from `@generateWithEmptyComment` after the
 // modifier tag is stripped in `EVENT_RESOLVE_END`. Only fill in children that have
 // no comment at all.
 if (child.comment) continue;
 const src = bestByName.get(child.name);
 if (src?.comment?.summary?.length) child.comment = src.comment;
 }
 }
 }
}

/**
 * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
 */
Expand DownExpand Up@@ -565,6 +678,8 @@ export function load(app) {
 }
 }
 }

 backfillInlineObjectChildComments(all);
 });

 app.renderer.on(MarkdownPageEvent.END, output => {
Expand Down

20 changes: 14 additions & 6 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,13 +87,15 @@ export interface BillingNamespace {

 /**
 * Gets the credit balance for the current payer.
 * @returns A [`BillingCreditBalanceResource`](https://clerk.com/docs/reference/types/billing-credit-balance-resource) object.
 *
 * @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.
 */
 getCreditBalance: (params: GetCreditBalanceParams) => Promise<BillingCreditBalanceResource>;

 /**
 * Gets the credit history for the current payer.
 * @returns A [`ClerkPaginatedResponse`](https://clerk.com/docs/reference/types/clerk-paginated-response) of [`BillingCreditLedgerResource`](https://clerk.com/docs/reference/types/billing-credit-ledger-resource) objects.
 *
 * @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.
 */
Expand DownExpand Up@@ -913,19 +915,19 @@ export interface BillingSubscriptionResource extends ClerkResource {
}

/**
 * The `BillingCreditBalanceResource` type represents the credit balance for a payer.
 * @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 interface BillingCreditBalanceResource {
 /**
 * The balance of the credit.
 */
 /** The balance of the credit. */
 balance: BillingMoneyAmount | null;
}

/**
 * @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 GetCreditBalanceParams = {
 /**
 * The ID of the Organization to get the credit balance for.
 */
 /** The ID of the Organization to get the credit balance for. */
 orgId?: string;
};

Expand All@@ -940,13 +942,19 @@ export type GetCreditHistoryParams = {
};

/**
 * The `BillingCreditLedgerResource` type represents a credit ledger entry for the current payer or given Organization.
 * @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 interface BillingCreditLedgerResource {
 /** The ID of the credit ledger entry. */
 id: string;
 /** The amount of the credit ledger entry. */
 amount: BillingMoneyAmount;
 /** The type of the source of the credit ledger entry. */
 sourceType: string;
 /** The ID of the source of the credit ledger entry. */
 sourceId: string;
 /** The date when the credit ledger entry was created. */
 createdAt: Date;
}

Expand Down

8 changes: 4 additions & 4 deletions
packages/shared/src/types/organizationDomain.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,13 @@ export interface OrganizationDomainResource extends ClerkResource {
 totalPendingSuggestions: number;
 /**
 * Begins the verification process of a created Organization domain by sending a verification code to the provided email address.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;

 /**
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
 /**
Expand All@@ -189,7 +189,7 @@ export interface OrganizationDomainResource extends ClerkResource {
 delete: () => Promise<void>;
 /**
 * Updates the enrollment mode of the Verified Domain.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise<OrganizationDomainResource>;
}
Expand Down
Loading

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

Skip to content
fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types#9052

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

alexisintech
merged 7 commits into

from

Jun 30, 2026
 Merged


fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types
#9052
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
9660364

fix(repo): backfill JSDoc on inline object literals lost via Omit/Pick


alexisintech Jun 30, 2026
baa7de8

update typedocs for billing and organizationdomain


alexisintech Jun 30, 2026
2e5b7dd

remove custom plugin updates


alexisintech Jun 30, 2026
1d04b80

fix formatting


alexisintech Jun 30, 2026
4a865b3

small copy update


alexisintech Jun 30, 2026
5e7840d

fix(repo): preserve intentionally-empty inline-object comments


alexisintech Jun 30, 2026
8b9da58

fix(repo): deepen type fingerprint to disambiguate generic and nested…


alexisintech Jun 30, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/fix-typedoc-inline-object-comment-backfill.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -509,6 +509,119 @@ function collectPropertiesFromType(type, reflectionsByName) {
 return [];
}

/**
 * Structural fingerprint for a `Type`. Recurses into composite shapes so two types that only differ in their type arguments (`Foo<string>` vs `Foo<number>`) or in their nested property types (`{ x: string }` vs `{ x: number }`) get distinct fingerprints. Two shapes that produce the same fingerprint are treated as structurally identical and so eligible for cross-pollinating JSDoc comments.
 *
 * Recursion guard: a single shared `Set` of visited reflection ids threads through every nested call to avoid infinite loops on cyclic types (e.g. a type literal that ultimately references itself).
 *
 * @param {import('typedoc').SomeType | undefined} type
 * @param {Set<number>} [seen]
 * @returns {string}
 */
function typeFingerprint(type, seen = new Set()) {
 if (!type) return '?';
 const t =
 /** @type {{ type?: string; name?: string; value?: unknown; elementType?: import('typedoc').SomeType; types?: import('typedoc').SomeType[]; typeArguments?: import('typedoc').SomeType[]; declaration?: import('typedoc').DeclarationReflection }} */ (
 /** @type {unknown} */ (type)
 );
 switch (t.type) {
 case 'intrinsic':
 return `i:${t.name ?? ''}`;
 case 'literal':
 return `l:${JSON.stringify(t.value)}`;
 case 'reference': {
 const args = t.typeArguments?.length ? `<${t.typeArguments.map(a => typeFingerprint(a, seen)).join(',')}>` : '';
 return `r:${t.name ?? ''}${args}`;
 }
 case 'array':
 return `a:${typeFingerprint(t.elementType, seen)}`;
 case 'optional':
 return `o:${typeFingerprint(t.elementType, seen)}`;
 case 'union':
 return `u:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'intersection':
 return `n:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'reflection': {
 const decl = t.declaration;
 if (decl?.id != null) {
 if (seen.has(decl.id)) return `rf:<cycle>`;
 seen.add(decl.id);
 }
 const kids = decl?.children?.filter(c => c.kindOf?.(ReflectionKind.Property)) ?? [];
 return `rf:[${kids
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type, seen)}`)
 .sort()
 .join(',')}]`;
 }
 default:
 return t.type ?? '?';
 }
}

/**
 * When TypeScript resolves a type through `Omit<...>` / `Pick<...>` (e.g. `ClerkProviderProps = Omit<IsomorphicClerkOptions, …> & { … }`), inline anonymous object literal property types get re-synthesized — and TypeDoc loses the JSDoc on most of their members. Only the first/leading property's comment survives, the rest come through with `comment === undefined`. The same shape elsewhere in the project (e.g. directly under `IsomorphicClerkOptions['telemetry']`) carries all comments correctly.
 *
 * Match `@kind:typeLiteral` reflections by structural fingerprint (set of `(name, type, optional)` tuples on their property children); within each group, pick the reflection with the most commented children as the source-of-truth and copy missing comments onto its siblings.
 *
 * @param {import('typedoc').Reflection[]} all
 */
function backfillInlineObjectChildComments(all) {
 /** @type {Map<string, import('typedoc').DeclarationReflection[]>} */
 const groups = new Map();
 for (const r of all) {
 if (!r.kindOf?.(ReflectionKind.TypeLiteral)) continue;
 const decl = /** @type {import('typedoc').DeclarationReflection} */ (r);
 const propChildren = decl.children?.filter(c => c.kindOf?.(ReflectionKind.Property));
 if (!propChildren?.length) continue;
 const key = propChildren
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type)}`)
 .sort()
 .join('|');
 if (!groups.has(key)) groups.set(key, []);
 /** @type {import('typedoc').DeclarationReflection[]} */ (groups.get(key)).push(decl);
 }

 for (const group of groups.values()) {
 if (group.length < 2) continue;
 /** @type {import('typedoc').DeclarationReflection | null} */
 let best = null;
 let bestScore = -1;
 for (const refl of group) {
 const score =
 refl.children?.filter(c => c.kindOf?.(ReflectionKind.Property) && c.comment?.summary?.length).length ?? 0;
 if (score > bestScore) {
 best = refl;
 bestScore = score;
 }
 }
 if (!best || bestScore === 0) continue;
 /** @type {Map<string, import('typedoc').DeclarationReflection>} */
 const bestByName = new Map();
 for (const c of best.children ?? []) {
 if (c.kindOf?.(ReflectionKind.Property)) bestByName.set(c.name, c);
 }
 for (const refl of group) {
 if (refl === best) continue;
 for (const child of refl.children ?? []) {
 if (!child.kindOf?.(ReflectionKind.Property)) continue;
 // Any `.comment` object means TypeDoc found a JSDoc block at the source — including
 // intentionally empty comments left over from `@generateWithEmptyComment` after the
 // modifier tag is stripped in `EVENT_RESOLVE_END`. Only fill in children that have
 // no comment at all.
 if (child.comment) continue;
 const src = bestByName.get(child.name);
 if (src?.comment?.summary?.length) child.comment = src.comment;
 }
 }
 }
}

/**
 * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
 */
Expand DownExpand Up@@ -565,6 +678,8 @@ export function load(app) {
 }
 }
 }

 backfillInlineObjectChildComments(all);
 });

 app.renderer.on(MarkdownPageEvent.END, output => {
Expand Down

20 changes: 14 additions & 6 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,13 +87,15 @@ export interface BillingNamespace {

 /**
 * Gets the credit balance for the current payer.
 * @returns A [`BillingCreditBalanceResource`](https://clerk.com/docs/reference/types/billing-credit-balance-resource) object.
 *
 * @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.
 */
 getCreditBalance: (params: GetCreditBalanceParams) => Promise<BillingCreditBalanceResource>;

 /**
 * Gets the credit history for the current payer.
 * @returns A [`ClerkPaginatedResponse`](https://clerk.com/docs/reference/types/clerk-paginated-response) of [`BillingCreditLedgerResource`](https://clerk.com/docs/reference/types/billing-credit-ledger-resource) objects.
 *
 * @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.
 */
Expand DownExpand Up@@ -913,19 +915,19 @@ export interface BillingSubscriptionResource extends ClerkResource {
}

/**
 * The `BillingCreditBalanceResource` type represents the credit balance for a payer.
 * @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 interface BillingCreditBalanceResource {
 /**
 * The balance of the credit.
 */
 /** The balance of the credit. */
 balance: BillingMoneyAmount | null;
}

/**
 * @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 GetCreditBalanceParams = {
 /**
 * The ID of the Organization to get the credit balance for.
 */
 /** The ID of the Organization to get the credit balance for. */
 orgId?: string;
};

Expand All@@ -940,13 +942,19 @@ export type GetCreditHistoryParams = {
};

/**
 * The `BillingCreditLedgerResource` type represents a credit ledger entry for the current payer or given Organization.
 * @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 interface BillingCreditLedgerResource {
 /** The ID of the credit ledger entry. */
 id: string;
 /** The amount of the credit ledger entry. */
 amount: BillingMoneyAmount;
 /** The type of the source of the credit ledger entry. */
 sourceType: string;
 /** The ID of the source of the credit ledger entry. */
 sourceId: string;
 /** The date when the credit ledger entry was created. */
 createdAt: Date;
}

Expand Down

8 changes: 4 additions & 4 deletions
packages/shared/src/types/organizationDomain.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,13 @@ export interface OrganizationDomainResource extends ClerkResource {
 totalPendingSuggestions: number;
 /**
 * Begins the verification process of a created Organization domain by sending a verification code to the provided email address.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;

 /**
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
 /**
Expand All@@ -189,7 +189,7 @@ export interface OrganizationDomainResource extends ClerkResource {
 delete: () => Promise<void>;
 /**
 * Updates the enrollment mode of the Verified Domain.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise<OrganizationDomainResource>;
}
Expand Down
Loading

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

Skip to content
fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types#9052

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

alexisintech
merged 7 commits into

from

Jun 30, 2026
 Merged


fix(repo,shared): backfill inline-object JSDoc on Omit/Pick-resolved types
#9052
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
9660364

fix(repo): backfill JSDoc on inline object literals lost via Omit/Pick


alexisintech Jun 30, 2026
baa7de8

update typedocs for billing and organizationdomain


alexisintech Jun 30, 2026
2e5b7dd

remove custom plugin updates


alexisintech Jun 30, 2026
1d04b80

fix formatting


alexisintech Jun 30, 2026
4a865b3

small copy update


alexisintech Jun 30, 2026
5e7840d

fix(repo): preserve intentionally-empty inline-object comments


alexisintech Jun 30, 2026
8b9da58

fix(repo): deepen type fingerprint to disambiguate generic and nested…


alexisintech Jun 30, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.changeset/fix-typedoc-inline-object-comment-backfill.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
---
---

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -509,6 +509,119 @@ function collectPropertiesFromType(type, reflectionsByName) {
 return [];
}

/**
 * Structural fingerprint for a `Type`. Recurses into composite shapes so two types that only differ in their type arguments (`Foo<string>` vs `Foo<number>`) or in their nested property types (`{ x: string }` vs `{ x: number }`) get distinct fingerprints. Two shapes that produce the same fingerprint are treated as structurally identical and so eligible for cross-pollinating JSDoc comments.
 *
 * Recursion guard: a single shared `Set` of visited reflection ids threads through every nested call to avoid infinite loops on cyclic types (e.g. a type literal that ultimately references itself).
 *
 * @param {import('typedoc').SomeType | undefined} type
 * @param {Set<number>} [seen]
 * @returns {string}
 */
function typeFingerprint(type, seen = new Set()) {
 if (!type) return '?';
 const t =
 /** @type {{ type?: string; name?: string; value?: unknown; elementType?: import('typedoc').SomeType; types?: import('typedoc').SomeType[]; typeArguments?: import('typedoc').SomeType[]; declaration?: import('typedoc').DeclarationReflection }} */ (
 /** @type {unknown} */ (type)
 );
 switch (t.type) {
 case 'intrinsic':
 return `i:${t.name ?? ''}`;
 case 'literal':
 return `l:${JSON.stringify(t.value)}`;
 case 'reference': {
 const args = t.typeArguments?.length ? `<${t.typeArguments.map(a => typeFingerprint(a, seen)).join(',')}>` : '';
 return `r:${t.name ?? ''}${args}`;
 }
 case 'array':
 return `a:${typeFingerprint(t.elementType, seen)}`;
 case 'optional':
 return `o:${typeFingerprint(t.elementType, seen)}`;
 case 'union':
 return `u:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'intersection':
 return `n:[${(t.types ?? [])
 .map(a => typeFingerprint(a, seen))
 .sort()
 .join(',')}]`;
 case 'reflection': {
 const decl = t.declaration;
 if (decl?.id != null) {
 if (seen.has(decl.id)) return `rf:<cycle>`;
 seen.add(decl.id);
 }
 const kids = decl?.children?.filter(c => c.kindOf?.(ReflectionKind.Property)) ?? [];
 return `rf:[${kids
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type, seen)}`)
 .sort()
 .join(',')}]`;
 }
 default:
 return t.type ?? '?';
 }
}

/**
 * When TypeScript resolves a type through `Omit<...>` / `Pick<...>` (e.g. `ClerkProviderProps = Omit<IsomorphicClerkOptions, …> & { … }`), inline anonymous object literal property types get re-synthesized — and TypeDoc loses the JSDoc on most of their members. Only the first/leading property's comment survives, the rest come through with `comment === undefined`. The same shape elsewhere in the project (e.g. directly under `IsomorphicClerkOptions['telemetry']`) carries all comments correctly.
 *
 * Match `@kind:typeLiteral` reflections by structural fingerprint (set of `(name, type, optional)` tuples on their property children); within each group, pick the reflection with the most commented children as the source-of-truth and copy missing comments onto its siblings.
 *
 * @param {import('typedoc').Reflection[]} all
 */
function backfillInlineObjectChildComments(all) {
 /** @type {Map<string, import('typedoc').DeclarationReflection[]>} */
 const groups = new Map();
 for (const r of all) {
 if (!r.kindOf?.(ReflectionKind.TypeLiteral)) continue;
 const decl = /** @type {import('typedoc').DeclarationReflection} */ (r);
 const propChildren = decl.children?.filter(c => c.kindOf?.(ReflectionKind.Property));
 if (!propChildren?.length) continue;
 const key = propChildren
 .map(c => `${c.name}${c.flags?.isOptional ? '?' : ''}:${typeFingerprint(c.type)}`)
 .sort()
 .join('|');
 if (!groups.has(key)) groups.set(key, []);
 /** @type {import('typedoc').DeclarationReflection[]} */ (groups.get(key)).push(decl);
 }

 for (const group of groups.values()) {
 if (group.length < 2) continue;
 /** @type {import('typedoc').DeclarationReflection | null} */
 let best = null;
 let bestScore = -1;
 for (const refl of group) {
 const score =
 refl.children?.filter(c => c.kindOf?.(ReflectionKind.Property) && c.comment?.summary?.length).length ?? 0;
 if (score > bestScore) {
 best = refl;
 bestScore = score;
 }
 }
 if (!best || bestScore === 0) continue;
 /** @type {Map<string, import('typedoc').DeclarationReflection>} */
 const bestByName = new Map();
 for (const c of best.children ?? []) {
 if (c.kindOf?.(ReflectionKind.Property)) bestByName.set(c.name, c);
 }
 for (const refl of group) {
 if (refl === best) continue;
 for (const child of refl.children ?? []) {
 if (!child.kindOf?.(ReflectionKind.Property)) continue;
 // Any `.comment` object means TypeDoc found a JSDoc block at the source — including
 // intentionally empty comments left over from `@generateWithEmptyComment` after the
 // modifier tag is stripped in `EVENT_RESOLVE_END`. Only fill in children that have
 // no comment at all.
 if (child.comment) continue;
 const src = bestByName.get(child.name);
 if (src?.comment?.summary?.length) child.comment = src.comment;
 }
 }
 }
}

/**
 * @param {import('typedoc-plugin-markdown').MarkdownApplication} app
 */
Expand DownExpand Up@@ -565,6 +678,8 @@ export function load(app) {
 }
 }
 }

 backfillInlineObjectChildComments(all);
 });

 app.renderer.on(MarkdownPageEvent.END, output => {
Expand Down

20 changes: 14 additions & 6 deletions
packages/shared/src/types/billing.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -87,13 +87,15 @@ export interface BillingNamespace {

 /**
 * Gets the credit balance for the current payer.
 * @returns A [`BillingCreditBalanceResource`](https://clerk.com/docs/reference/types/billing-credit-balance-resource) object.
 *
 * @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.
 */
 getCreditBalance: (params: GetCreditBalanceParams) => Promise<BillingCreditBalanceResource>;

 /**
 * Gets the credit history for the current payer.
 * @returns A [`ClerkPaginatedResponse`](https://clerk.com/docs/reference/types/clerk-paginated-response) of [`BillingCreditLedgerResource`](https://clerk.com/docs/reference/types/billing-credit-ledger-resource) objects.
 *
 * @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.
 */
Expand DownExpand Up@@ -913,19 +915,19 @@ export interface BillingSubscriptionResource extends ClerkResource {
}

/**
 * The `BillingCreditBalanceResource` type represents the credit balance for a payer.
 * @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 interface BillingCreditBalanceResource {
 /**
 * The balance of the credit.
 */
 /** The balance of the credit. */
 balance: BillingMoneyAmount | null;
}

/**
 * @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 GetCreditBalanceParams = {
 /**
 * The ID of the Organization to get the credit balance for.
 */
 /** The ID of the Organization to get the credit balance for. */
 orgId?: string;
};

Expand All@@ -940,13 +942,19 @@ export type GetCreditHistoryParams = {
};

/**
 * The `BillingCreditLedgerResource` type represents a credit ledger entry for the current payer or given Organization.
 * @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 interface BillingCreditLedgerResource {
 /** The ID of the credit ledger entry. */
 id: string;
 /** The amount of the credit ledger entry. */
 amount: BillingMoneyAmount;
 /** The type of the source of the credit ledger entry. */
 sourceType: string;
 /** The ID of the source of the credit ledger entry. */
 sourceId: string;
 /** The date when the credit ledger entry was created. */
 createdAt: Date;
}

Expand Down

8 changes: 4 additions & 4 deletions
packages/shared/src/types/organizationDomain.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -173,13 +173,13 @@ export interface OrganizationDomainResource extends ClerkResource {
 totalPendingSuggestions: number;
 /**
 * Begins the verification process of a created Organization domain by sending a verification code to the provided email address.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;

 /**
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepare-affiliation-verification), by validating the provided verification code.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
 /**
Expand All@@ -189,7 +189,7 @@ export interface OrganizationDomainResource extends ClerkResource {
 delete: () => Promise<void>;
 /**
 * Updates the enrollment mode of the Verified Domain.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/nextjs/reference/types/organization-domain-resource) object.
 * @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
 */
 updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise<OrganizationDomainResource>;
}
Expand Down
Loading