From e3dcf35f33ebb187c8ab16ba772b3db1132cc194 Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Wed, 10 Jun 2026 18:12:22 -0700 Subject: [PATCH 1/4] docs(shared): fix broken Clerk docs links in organization JSDoc The JSDoc-linked URLs for `organization-invitation`, `organization-suggestion`, and the `Organization` reference page all 404'd because they used the old un-hyphenated slugs and `types/organization` instead of `objects/organization`. Hover docs in IDEs now resolve to the correct pages. Co-Authored-By: Claude Opus 4.7 (1M context) --- .changeset/fix-organization-jsdoc-links.md | 5 +++++ packages/shared/src/types/organizationDomain.ts | 6 +++--- packages/shared/src/types/organizationMembership.ts | 2 +- packages/shared/src/types/organizationSettings.ts | 2 +- 4 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 .changeset/fix-organization-jsdoc-links.md diff --git a/.changeset/fix-organization-jsdoc-links.md b/.changeset/fix-organization-jsdoc-links.md new file mode 100644 index 00000000000..a872b43a202 --- /dev/null +++ b/.changeset/fix-organization-jsdoc-links.md @@ -0,0 +1,5 @@ +--- +'@clerk/shared': patch +--- + +Fix broken Clerk documentation links in JSDoc comments on `OrganizationDomainResource`, `OrganizationMembershipResource`, `OrganizationSettingsResource`, and `UpdateEnrollmentModeParams`. Hover documentation in IDEs now points at the correct `organization-invitation`, `organization-suggestion`, and `objects/organization` pages instead of 404ing. diff --git a/packages/shared/src/types/organizationDomain.ts b/packages/shared/src/types/organizationDomain.ts index d9d72746975..f9a08a428d5 100644 --- a/packages/shared/src/types/organizationDomain.ts +++ b/packages/shared/src/types/organizationDomain.ts @@ -54,7 +54,7 @@ export interface OrganizationDomainResource extends ClerkResource { * * */ @@ -76,7 +76,7 @@ export interface OrganizationDomainResource extends ClerkResource { */ affiliationEmailAddress: string | null; /** - * The total number of pending [invitations](https://clerk.com/docs/reference/types/organizationinvitation) associated with this domain. + * The total number of pending [invitations](https://clerk.com/docs/reference/types/organization-invitation) associated with this domain. */ totalPendingInvitations: number; /** @@ -132,7 +132,7 @@ export type AttemptAffiliationVerificationParams = { /** @generateWithEmptyComment */ export type UpdateEnrollmentModeParams = Pick & { /** - * Whether to delete any pending [invitations](https://clerk.com/docs/reference/types/organizationinvitation) or [suggestions](https://clerk.com/docs/reference/types/organizationsuggestion) that were created by the previous enrollment mode. + * Whether to delete any pending [invitations](https://clerk.com/docs/reference/types/organization-invitation) or [suggestions](https://clerk.com/docs/reference/types/organization-suggestion) that were created by the previous enrollment mode. */ deletePending?: boolean; }; diff --git a/packages/shared/src/types/organizationMembership.ts b/packages/shared/src/types/organizationMembership.ts index a4f50101108..ca17721a71a 100644 --- a/packages/shared/src/types/organizationMembership.ts +++ b/packages/shared/src/types/organizationMembership.ts @@ -46,7 +46,7 @@ export interface OrganizationMembershipResource extends ClerkResource { */ id: string; /** - * The [`Organization`](https://clerk.com/docs/reference/types/organization) object the membership belongs to. + * The [`Organization`](https://clerk.com/docs/reference/objects/organization) object the membership belongs to. */ organization: OrganizationResource; /** diff --git a/packages/shared/src/types/organizationSettings.ts b/packages/shared/src/types/organizationSettings.ts index f7ce2739f1c..d35fd3db2a4 100644 --- a/packages/shared/src/types/organizationSettings.ts +++ b/packages/shared/src/types/organizationSettings.ts @@ -65,7 +65,7 @@ export interface OrganizationSettingsResource extends ClerkResource { * * */ From dd9d6c802d90221d363b963277193c1f9675bdfd Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Wed, 10 Jun 2026 18:12:56 -0700 Subject: [PATCH 2/4] chore(repo): empty changeset for JSDoc-only link fix Comments-only change; no package patch needed. Co-Authored-By: Claude Opus 4.7 (1M context) --- .changeset/fix-organization-jsdoc-links.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/.changeset/fix-organization-jsdoc-links.md b/.changeset/fix-organization-jsdoc-links.md index a872b43a202..a845151cc84 100644 --- a/.changeset/fix-organization-jsdoc-links.md +++ b/.changeset/fix-organization-jsdoc-links.md @@ -1,5 +1,2 @@ --- -'@clerk/shared': patch --- - -Fix broken Clerk documentation links in JSDoc comments on `OrganizationDomainResource`, `OrganizationMembershipResource`, `OrganizationSettingsResource`, and `UpdateEnrollmentModeParams`. Hover documentation in IDEs now points at the correct `organization-invitation`, `organization-suggestion`, and `objects/organization` pages instead of 404ing. From 5a9ddd3e0beb68043ac1123c511cea7711a6a1b9 Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Wed, 10 Jun 2026 18:18:03 -0700 Subject: [PATCH 3/4] active organization fix --- packages/shared/src/types/billing.ts | 50 +++++++++++++--------------- 1 file changed, 24 insertions(+), 26 deletions(-) diff --git a/packages/shared/src/types/billing.ts b/packages/shared/src/types/billing.ts index c4591f516e7..c25a5f656c1 100644 --- a/packages/shared/src/types/billing.ts +++ b/packages/shared/src/types/billing.ts @@ -157,9 +157,7 @@ export type GetPlansParams = ClerkPaginationParams<{ */ for?: ForPayerType; /** - * The organization ID to fetch plans for (needs to match the current active organization ID). Providing this - * parameter will populate the `availablePrices` field with the prices that are available to the - * authenticated organization. + * The organization ID to fetch plans for (needs to match the current [Active Organization](!active-organization) ID). Providing this parameter will populate the `availablePrices` field with the prices that are available to the authenticated organization. */ orgId?: string; /** @@ -1223,31 +1221,31 @@ export type CreateCheckoutParams = WithOptionalOrgType<{ */ export type ConfirmCheckoutParams = | { - /** - * The ID of a saved payment method to use for this checkout. - */ - paymentMethodId?: string; - } + /** + * The ID of a saved payment method to use for this checkout. + */ + paymentMethodId?: string; + } | { - /** - * A token representing payment details, usually from a payment form. **Requires** `gateway` to be provided. - */ - paymentToken?: string; - /** - * The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. - */ - gateway?: PaymentGateway; - } + /** + * A token representing payment details, usually from a payment form. **Requires** `gateway` to be provided. + */ + paymentToken?: string; + /** + * The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. + */ + gateway?: PaymentGateway; + } | { - /** - * The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. - */ - gateway?: PaymentGateway; - /** - * If true, uses a test card for the checkout. **Requires** `gateway` to be provided. - */ - useTestCard?: boolean; - }; + /** + * The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. + */ + gateway?: PaymentGateway; + /** + * If true, uses a test card for the checkout. **Requires** `gateway` to be provided. + */ + useTestCard?: boolean; + }; /** * The `BillingCheckoutResource` type represents information about a checkout session. From 13d81f2f6f5f8078420b60579a1ff28c8385cf19 Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Wed, 10 Jun 2026 18:23:36 -0700 Subject: [PATCH 4/4] style(shared): run prettier on billing.ts CI format:check was failing on union type member indentation. Co-Authored-By: Claude Opus 4.7 (1M context) --- packages/shared/src/types/billing.ts | 46 ++++++++++++++-------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/packages/shared/src/types/billing.ts b/packages/shared/src/types/billing.ts index c25a5f656c1..60390e1206e 100644 --- a/packages/shared/src/types/billing.ts +++ b/packages/shared/src/types/billing.ts @@ -1221,31 +1221,31 @@ export type CreateCheckoutParams = WithOptionalOrgType<{ */ export type ConfirmCheckoutParams = | { - /** - * The ID of a saved payment method to use for this checkout. - */ - paymentMethodId?: string; - } + /** + * The ID of a saved payment method to use for this checkout. + */ + paymentMethodId?: string; + } | { - /** - * A token representing payment details, usually from a payment form. **Requires** `gateway` to be provided. - */ - paymentToken?: string; - /** - * The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. - */ - gateway?: PaymentGateway; - } + /** + * A token representing payment details, usually from a payment form. **Requires** `gateway` to be provided. + */ + paymentToken?: string; + /** + * The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. + */ + gateway?: PaymentGateway; + } | { - /** - * The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. - */ - gateway?: PaymentGateway; - /** - * If true, uses a test card for the checkout. **Requires** `gateway` to be provided. - */ - useTestCard?: boolean; - }; + /** + * The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. + */ + gateway?: PaymentGateway; + /** + * If true, uses a test card for the checkout. **Requires** `gateway` to be provided. + */ + useTestCard?: boolean; + }; /** * The `BillingCheckoutResource` type represents information about a checkout session.