chore(backend,react,shared,vue): Update docs links (#8047)

Author: alexisintech

.changeset/better-ways-doubt.md

@@ -0,0 +1,2 @@
+---
+---

.typedoc/custom-plugin.mjs

@@ -43,25 +43,25 @@ const FILES_WITHOUT_HEADINGS = [
  * Ideally this is a temporary solution until every one of these files are published in production and can be linked to.
  */
 const LINK_REPLACEMENTS = [
-  ['set-active-params', '/docs/reference/javascript/types/set-active-params'],
-  ['clerk-paginated-response', '/docs/reference/javascript/types/clerk-paginated-response'],
+  ['set-active-params', '/docs/reference/types/set-active-params'],
+  ['clerk-paginated-response', '/docs/reference/types/clerk-paginated-response'],
   ['paginated-resources', '#paginated-resources'],
   ['use-checkout-options', '#use-checkout-options'],
   ['needs-reverification-parameters', '#needs-reverification-parameters'],
   ['create-organization-params', '#create-organization-params'],
-  ['session-resource', '/docs/reference/javascript/session'],
-  ['signed-in-session-resource', '/docs/reference/javascript/session'],
-  ['sign-in-resource', '/docs/reference/javascript/sign-in'],
-  ['sign-up-resource', '/docs/reference/javascript/sign-up'],
-  ['user-resource', '/docs/reference/javascript/user'],
-  ['session-status-claim', '/docs/reference/javascript/types/session-status'],
-  ['user-organization-invitation-resource', '/docs/reference/javascript/types/user-organization-invitation'],
-  ['organization-membership-resource', '/docs/reference/javascript/types/organization-membership'],
-  ['organization-suggestion-resource', '/docs/reference/javascript/types/organization-suggestion'],
-  ['organization-resource', '/docs/reference/javascript/organization'],
-  ['organization-domain-resource', '/docs/reference/javascript/types/organization-domain-resource'],
-  ['organization-invitation-resource', '/docs/reference/javascript/types/organization-invitation'],
-  ['organization-membership-request-resource', '/docs/reference/javascript/types/organization-membership-request'],
+  ['session-resource', '/docs/reference/objects/session'],
+  ['signed-in-session-resource', '/docs/reference/objects/session'],
+  ['sign-in-resource', '/docs/reference/objects/sign-in'],
+  ['sign-up-resource', '/docs/reference/objects/sign-up'],
+  ['user-resource', '/docs/reference/objects/user'],
+  ['session-status-claim', '/docs/reference/types/session-status'],
+  ['user-organization-invitation-resource', '/docs/reference/types/user-organization-invitation'],
+  ['organization-membership-resource', '/docs/reference/types/organization-membership'],
+  ['organization-suggestion-resource', '/docs/reference/types/organization-suggestion'],
+  ['organization-resource', '/docs/reference/objects/organization'],
+  ['organization-domain-resource', '/docs/reference/types/organization-domain-resource'],
+  ['organization-invitation-resource', '/docs/reference/types/organization-invitation'],
+  ['organization-membership-request-resource', '/docs/reference/types/organization-membership-request'],
   ['session', '/docs/reference/backend/types/backend-session'],
   ['session-activity', '/docs/reference/backend/types/backend-session-activity'],
   ['organization', '/docs/reference/backend/types/backend-organization'],
@@ -77,22 +77,22 @@ const LINK_REPLACEMENTS = [
   ['invitation', '/docs/reference/backend/types/backend-invitation'],
   ['verify-token-options', '#verify-token-options'],
   ['localization-resource', '/docs/guides/customizing-clerk/localization'],
-  ['confirm-checkout-params', '/docs/reference/javascript/types/billing-checkout-resource#parameters'],
-  ['billing-payment-method-resource', '/docs/reference/javascript/types/billing-payment-method-resource'],
-  ['billing-payer-resource', '/docs/reference/javascript/types/billing-payer-resource'],
-  ['billing-plan-resource', '/docs/reference/javascript/types/billing-plan-resource'],
-  ['billing-checkout-totals', '/docs/reference/javascript/types/billing-checkout-totals'],
-  ['billing-checkout-resource', '/docs/reference/javascript/types/billing-checkout-resource'],
-  ['billing-money-amount', '/docs/reference/javascript/types/billing-money-amount'],
-  ['billing-subscription-item-resource', '/docs/reference/javascript/types/billing-subscription-item-resource'],
-  ['feature-resource', '/docs/reference/javascript/types/feature-resource'],
-  ['billing-statement-group', '/docs/reference/javascript/types/billing-statement-group'],
-  ['billing-statement-resource', '/docs/reference/javascript/types/billing-statement-resource'],
-  ['billing-subscription-resource', '/docs/reference/javascript/types/billing-subscription-resource'],
-  ['clerk-api-response-error', '/docs/reference/javascript/types/clerk-api-response-error'],
-  ['billing-statement-totals', '/docs/reference/javascript/types/billing-statement-totals'],
-  ['billing-payment-resource', '/docs/reference/javascript/types/billing-payment-resource'],
-  ['deleted-object-resource', '/docs/reference/javascript/types/deleted-object-resource'],
+  ['confirm-checkout-params', '/docs/reference/types/billing-checkout-resource#parameters'],
+  ['billing-payment-method-resource', '/docs/reference/types/billing-payment-method-resource'],
+  ['billing-payer-resource', '/docs/reference/types/billing-payer-resource'],
+  ['billing-plan-resource', '/docs/reference/types/billing-plan-resource'],
+  ['billing-checkout-totals', '/docs/reference/types/billing-checkout-totals'],
+  ['billing-checkout-resource', '/docs/reference/types/billing-checkout-resource'],
+  ['billing-money-amount', '/docs/reference/types/billing-money-amount'],
+  ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'],
+  ['feature-resource', '/docs/reference/types/feature-resource'],
+  ['billing-statement-group', '/docs/reference/types/billing-statement-group'],
+  ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'],
+  ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'],
+  ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'],
+  ['billing-statement-totals', '/docs/reference/types/billing-statement-totals'],
+  ['billing-payment-resource', '/docs/reference/types/billing-payment-resource'],
+  ['deleted-object-resource', '/docs/reference/types/deleted-object-resource'],
   ['checkout-flow-resource', '/docs/reference/hooks/use-checkout#checkout-flow-resource'],
   ['organization-creation-defaults-resource', '#organization-creation-defaults-resource'],
 ];
@@ -133,7 +133,7 @@ function getCatchAllReplacements() {
     },
     {
       pattern: /`LoadedClerk`/g,
-      replace: '[Clerk](/docs/reference/javascript/clerk)',
+      replace: '[Clerk](/docs/reference/objects/clerk)',
     },
     {
       pattern: /(?<![\[\w`])`?LocalizationResource`?(?![\]\w`])/g,
@@ -143,64 +143,63 @@ function getCatchAllReplacements() {
       // SessionResource appears in plain text, with an array next to it, with backticks, etc.
       // e.g. `SessionResource[]`
       pattern: /(?<![`[\]])\bSessionResource(\[\])?\b(?![\]\)`])/g,
-      replace: '[`SessionResource`](/docs/reference/javascript/session)$1',
+      replace: '[`SessionResource`](/docs/reference/objects/session)$1',
     },
     {
       pattern: /(?<![\[\w`])`?SessionStatusClaim`?(?![\]\w`])/g,
-      replace: '[`SessionStatusClaim`](/docs/reference/javascript/types/session-status)',
+      replace: '[`SessionStatusClaim`](/docs/reference/types/session-status)',
     },
     {
       pattern: /(?<![`[\]])\bSetActiveParams\b(?![\]\(])/g,
-      replace: '[SetActiveParams](/docs/reference/javascript/types/set-active-params)',
+      replace: '[SetActiveParams](/docs/reference/types/set-active-params)',
     },
     {
       pattern: /(?<![\[\w`])`?SignInResource`?(?![\]\w`])/g,
-      replace: '[`SignInResource`](/docs/reference/javascript/sign-in)',
+      replace: '[`SignInResource`](/docs/reference/objects/sign-in)',
     },
     {
       pattern: /(?<![\[\w`])`?SignedInSessionResource`?(?![\]\w`])/g,
-      replace: '[`SignedInSessionResource`](/docs/reference/javascript/session)',
+      replace: '[`SignedInSessionResource`](/docs/reference/objects/session)',
     },
     {
       pattern: /(?<![\[\w`])`?SignUpResource`?(?![\]\w`])/g,
-      replace: '[`SignUpResource`](/docs/reference/javascript/sign-up)',
+      replace: '[`SignUpResource`](/docs/reference/objects/sign-up)',
     },
     {
       pattern: /(?<![\[\w`])`?OrganizationResource`?(?![\]\w`])/g,
-      replace: '[`OrganizationResource`](/docs/reference/javascript/organization)',
+      replace: '[`OrganizationResource`](/docs/reference/objects/organization)',
     },
     {
       pattern: /`OrganizationPrivateMetadata`/g,
-      replace:
-        '[`OrganizationPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-private-metadata)',
+      replace: '[`OrganizationPrivateMetadata`](/docs/reference/types/metadata#organization-private-metadata)',
     },
     {
       pattern: /OrganizationPublicMetadata/g,
-      replace: '[OrganizationPublicMetadata](/docs/reference/javascript/types/metadata#organization-public-metadata)',
+      replace: '[OrganizationPublicMetadata](/docs/reference/types/metadata#organization-public-metadata)',
     },
     {
       pattern: /`OrganizationInvitationPrivateMetadata`/g,
       replace:
-        '[`OrganizationInvitationPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-invitation-private-metadata)',
+        '[`OrganizationInvitationPrivateMetadata`](/docs/reference/types/metadata#organization-invitation-private-metadata)',
     },
     {
       pattern: /`OrganizationInvitationPublicMetadata`/g,
       replace:
-        '[`OrganizationInvitationPublicMetadata`](/docs/reference/javascript/types/metadata#organization-invitation-public-metadata)',
+        '[`OrganizationInvitationPublicMetadata`](/docs/reference/types/metadata#organization-invitation-public-metadata)',
     },
     {
       pattern: /`OrganizationMembershipPrivateMetadata`/g,
       replace:
-        '[`OrganizationMembershipPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-membership-private-metadata)',
+        '[`OrganizationMembershipPrivateMetadata`](/docs/reference/types/metadata#organization-membership-private-metadata)',
     },
     {
       pattern: /`OrganizationMembershipPublicMetadata`/g,
       replace:
-        '[`OrganizationMembershipPublicMetadata`](/docs/reference/javascript/types/metadata#organization-membership-public-metadata)',
+        '[`OrganizationMembershipPublicMetadata`](/docs/reference/types/metadata#organization-membership-public-metadata)',
     },
     {
       pattern: /(?<![\[\w`])`?UserResource`?(?![\]\w`])/g,
-      replace: '[`UserResource`](/docs/reference/javascript/user)',
+      replace: '[`UserResource`](/docs/reference/objects/user)',
     },
     {
       /**

packages/backend/src/api/resources/APIKey.ts

@@ -66,7 +66,7 @@ export class APIKey {
      */
     readonly updatedAt: number,
     /**
-     * The API key secret. **This property is only present in the response from [`create()`](/docs/reference/javascript/api-keys#create) and cannot be retrieved later.**
+     * The API key secret. **This property is only present in the response from [`create()`](/docs/reference/objects/api-keys#create) and cannot be retrieved later.**
      */
     readonly secret?: string,
   ) {}

packages/backend/src/api/resources/Client.ts

@@ -4,7 +4,7 @@ import type { ClientJSON } from './JSON';
 import { Session } from './Session';
 
 /**
- * The Backend `Client` object is similar to the [`Client`](https://clerk.com/docs/reference/javascript/client) object as it holds information about the authenticated sessions in the current device. However, the Backend `Client` object is different from the `Client` object in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Clients#operation/GetClient) and is not directly accessible from the Frontend API.
+ * The Backend `Client` object is similar to the [`Client`](https://clerk.com/docs/reference/objects/client) object as it holds information about the authenticated sessions in the current device. However, the Backend `Client` object is different from the `Client` object in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Clients#operation/GetClient) and is not directly accessible from the Frontend API.
  */
 export class Client {
   constructor(
@@ -21,11 +21,11 @@ export class Client {
      */
     readonly sessions: Session[],
     /**
-     * The ID of the [`SignIn`](https://clerk.com/docs/reference/javascript/sign-in){{ target: '_blank' }}.
+     * The ID of the [`SignIn`](https://clerk.com/docs/reference/objects/sign-in).
      */
     readonly signInId: string | null,
     /**
-     * The ID of the [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up){{ target: '_blank' }}.
+     * The ID of the [`SignUp`](https://clerk.com/docs/reference/objects/sign-up).
      */
     readonly signUpId: string | null,
     /**

packages/backend/src/api/resources/CommercePlan.ts

@@ -4,7 +4,7 @@ import { Feature } from './Feature';
 import type { BillingPlanJSON } from './JSON';
 
 /**
- * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) object as it holds information about a Plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
+ * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/types/billing-plan-resource) object as it holds information about a Plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
  *
  * @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.
  */

packages/backend/src/api/resources/CommerceSubscription.ts

@@ -4,7 +4,7 @@ import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
 import type { BillingSubscriptionJSON } from './JSON';
 
 /**
- * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/reference/javascript/types/billing-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
+ * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/reference/types/billing-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
  *
  * @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.
  */

packages/backend/src/api/resources/CommerceSubscriptionItem.ts

@@ -4,7 +4,7 @@ import { BillingPlan } from './CommercePlan';
 import type { BillingSubscriptionItemJSON } from './JSON';
 
 /**
- * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/reference/javascript/types/billing-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
+ * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/reference/types/billing-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
  *
  * @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.
  */

packages/backend/src/api/resources/Invitation.ts

@@ -21,7 +21,7 @@ export class Invitation {
      */
     readonly emailAddress: string,
     /**
-     * [Metadata](https://clerk.com/docs/reference/javascript/types/metadata#user-public-metadata){{ target: '_blank' }} that can be read from the Frontend API and [Backend API](https://clerk.com/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
+     * [Metadata](https://clerk.com/docs/reference/types/metadata#user-public-metadata){{ target: '_blank' }} that can be read from the Frontend API and [Backend API](https://clerk.com/docs/reference/backend-api){{ target: '_blank' }} and can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
      */
     readonly publicMetadata: Record<string, unknown> | null,
     /**

packages/backend/src/api/resources/Organization.ts

@@ -1,7 +1,7 @@
 import type { OrganizationJSON } from './JSON';
 
 /**
- * The Backend `Organization` object is similar to the [`Organization`](https://clerk.com/docs/reference/javascript/organization) object as it holds information about an Organization, as well as methods for managing it. However, the Backend `Organization` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/ListOrganizations){{ target: '_blank' }} and is not directly accessible from the Frontend API.
+ * The Backend `Organization` object is similar to the [`Organization`](https://clerk.com/docs/reference/objects/organization) object as it holds information about an Organization, as well as methods for managing it. However, the Backend `Organization` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/ListOrganizations){{ target: '_blank' }} and is not directly accessible from the Frontend API.
  */
 export class Organization {
   private _raw: OrganizationJSON | null = null;

packages/backend/src/api/resources/OrganizationInvitation.ts

@@ -2,7 +2,7 @@ import type { OrganizationInvitationStatus, OrganizationMembershipRole } from '.
 import type { OrganizationInvitationJSON, PublicOrganizationDataJSON } from './JSON';
 
 /**
- * The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](https://clerk.com/docs/reference/javascript/types/organization-invitation) object as it's the model around an Organization invitation. However, the Backend `OrganizationInvitation` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API.
+ * The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](https://clerk.com/docs/reference/types/organization-invitation) object as it's the model around an Organization invitation. However, the Backend `OrganizationInvitation` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API.
  */
 export class OrganizationInvitation {
   private _raw: OrganizationInvitationJSON | null = null;