[ci] Update Typedoc (9abb76f) #2772

github-actions · 2025-11-06T18:30:52Z

Auto-generated PR to update Typedoc documentation from clerk/javascript@9abb76f

vercel · 2025-11-06T18:30:59Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Updated (UTC)
clerk-docs	Ready	Preview	Nov 6, 2025 10:27pm

SarahSoutoul · 2025-11-06T18:31:27Z

plan of action:
closing this.
lets get clerk/javascript#7158 merged first
then trigger new CI action
then merge #2756 into that newly created PR from the cI action

NWylynko · 2025-11-06T18:32:54Z

clerk-typedoc/backend/auth-object.mdx

+| ---------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="debug"></a> `debug`         | <code>() => \{ [key: string]: any; \}</code>                                                             | Used to help debug issues when using Clerk in development.                                                                                                     |
+| <a id="gettoken"></a> `getToken`   | <code>() => Promise\<null\> \| () => Promise\<string\> \| ServerGetToken \| () => Promise\<null\></code> | A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates). |
+| <a id="has"></a> `has`             | <code>CheckAuthorizationFromSessionClaims \| () => false</code>                                          | A function that checks if the user has an organization role or custom permission.                                                                              |


Lost a link here

Having a look rn

These links were broken in the first place, as there aren't links in the first place to link these too. This is also a typedoc that's not being used as we discussed. So I think we're safe to ignore.

NWylynko · 2025-11-06T18:33:54Z

clerk-typedoc/backend/billing-subscription.mdx

+| <a id="pastdueat"></a> `pastDueAt`                       | <code>null \| number</code>                                                                                                     | Unix timestamp (milliseconds) of when the subscription became past due.  |
+| <a id="payerid"></a> `payerId`                           | `string`                                                                                                                        | The ID of the payer for this subscription.                               |
+| <a id="status"></a> `status`                             | <code>"abandoned" \| "active" \| "ended" \| "canceled" \| "incomplete" \| "past_due"</code>                                     | The current status of the subscription.                                  |
+| <a id="subscriptionitems"></a> `subscriptionItems`       | <code>[BillingSubscriptionItem](billing-subscription-item.mdx)[]</code>                                                         | Array of subscription items in this subscription.                        |


This is a broken link / missing a link replacement

I'm not sure of this one bcs of several reasons:

It's not being used as a typedoc.

It's only being used in this typedoc.

There is no existing link to link this to.

clerk-typedoc/clerk-react/api-keys.mdx

clerk-typedoc/clerk-react/clerk-provider-props.mdx

clerk-typedoc/clerk-react/plan-details-button-props.mdx

NWylynko · 2025-11-06T18:47:02Z

clerk-typedoc/clerk-react/plan-details-button.mdx

-| `props`   | [`Without`](../types/without.mdx)\<`WithClerkProp`\<`PropsWithChildren`\<[`PlanDetailsButtonProps`](plan-details-button-props.mdx)\>\>, `"clerk"`\> |
+| Parameter | Type                                                                                                                        |
+| --------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `props`   | `Without`\<`WithClerkProp`\<`PropsWithChildren`\<[`PlanDetailsButtonProps`](plan-details-button-props.mdx)\>\>, `"clerk"`\> |


broken link to plan details button props

This typedoc isn't used

NWylynko · 2025-11-06T18:48:34Z

clerk-typedoc/clerk-react/use-organization-list.mdx

+| `params?` | `T$1` |

 ## Returns

-[`UseOrganizationListReturn`](../shared/use-organization-list-return.mdx)\<`T`\>
+`UseOrganizationListReturn`\<`T$1`\>


No idea whats going on with the $1 getting added

Also not used as a typedoc but yeah weird behaviour.

clerk-typedoc/clerk-react/use-session-list.mdx

NWylynko · 2025-11-06T19:23:26Z

clerk-typedoc/clerk-react/use-sign-in-signal.mdx

 ## Returns

-[`SignInSignalValue`](../types/sign-in-signal-value.mdx)
+`SignInSignalValue`


Lost broken link here

This typedoc isn't used, and doesn't have a link to lead to.

clerk-typedoc/shared/clerk-api-error.mdx

SarahSoutoul · 2025-11-06T21:52:37Z

Thanks for all the catches @NWylynko - have responded to them all, and as we discussed, it's looking like either the broken links are on typedocs that aren't used in the docs at all or the links were already broken and there is no real link to lead them to, so imo, we could prob ignore these.

I am going to add the changes of this PR in here, so I can test everything. @alexisintech

SarahSoutoul · 2025-11-06T22:48:34Z

Update: Noticed one issue caused by this catchReplacement pattern.

Basically, it gets applied to the BillingMoneyAmount text within the BillingMoneyAmount Javascript type here. That text shouldn't be linked since we're already on the BillingMoneyAmount page (see the screenshots - local vs live docs). If I remove it, it unlinks all the BillingMoneyAmount in the backend typedocs, which aren't used anyway. All the other places where BillingMoneyAmount is rendered, it is linked properly since it's inside the shared package.

So I say we prob want to remove this catch replacement but wanna get everyone's thoughts @alexisintech @NWylynko.

alexisintech · 2025-11-06T23:16:25Z

Update: Noticed one issue caused by this catchReplacement pattern.
Basically, it gets applied to the `BillingMoneyAmount` text within the `BillingMoneyAmount` Javascript type [here](https://clerk.com/docs/reference/javascript/types/billing-money-amount). That text shouldn't be linked since we're already on the `BillingMoneyAmount` page (see the screenshots - local vs live docs). If I remove it, it unlinks all the `BillingMoneyAmount` in the `backend` typedocs, which aren't used anyway. All the other places where `BillingMoneyAmount` is rendered, it is linked properly since it's inside the `shared` package.

So I say we prob want to remove this catch replacement but wanna get everyone's thoughts @alexisintech @NWylynko.

oh yeah then lets remove it !

SarahSoutoul · 2025-11-07T00:01:01Z

Update: Noticed one issue caused by this catchReplacement pattern.

Basically, it gets applied to the BillingMoneyAmount text within the BillingMoneyAmount Javascript type here. That text shouldn't be linked since we're already on the BillingMoneyAmount page (see the screenshots - local vs live docs). If I remove it, it unlinks all the BillingMoneyAmount in the backend typedocs, which aren't used anyway. All the other places where BillingMoneyAmount is rendered, it is linked properly since it's inside the shared package.

So I say we prob want to remove this catch replacement but wanna get everyone's thoughts @alexisintech @NWylynko.

oh yeah then lets remove it !

Okay, we'll need another JS PR then. And re-do the following process:

Will tackle it tomorrow!

SarahSoutoul · 2025-11-07T17:38:04Z

C

Update: Noticed one issue caused by this catchReplacement pattern.
Basically, it gets applied to the `BillingMoneyAmount` text within the `BillingMoneyAmount` Javascript type [here](https://clerk.com/docs/reference/javascript/types/billing-money-amount). That text shouldn't be linked since we're already on the `BillingMoneyAmount` page (see the screenshots - local vs live docs). If I remove it, it unlinks all the `BillingMoneyAmount` in the `backend` typedocs, which aren't used anyway. All the other places where `BillingMoneyAmount` is rendered, it is linked properly since it's inside the `shared` package.

So I say we prob want to remove this catch replacement but wanna get everyone's thoughts @alexisintech @NWylynko.

@alexisintech @NWylynko Fixed this with this PR: clerk/javascript#7176 and newly generated Typedoc CI PR is here: #2776. So closing this one.

docs: update TypeDoc documentation from clerk/javascript@9abb76f

d55afc3

github-actions bot requested a review from a team as a code owner November 6, 2025 18:30

vercel bot had a problem deploying to Preview November 6, 2025 18:31 Failure

SarahSoutoul mentioned this pull request Nov 6, 2025

[ci] Update Typedoc (49f1fcc) #2770

Closed