chore(types): Fix LocalizationResource & CommerceSubscriptionItemResource Typedoc links (#6531)

Author: NWylynko

.changeset/full-times-wear.md

@@ -0,0 +1,5 @@
+---
+'@clerk/types': patch
+---
+
+Convert LocalizationResource to interface for typedoc documentation

.typedoc/custom-plugin.mjs

@@ -53,6 +53,8 @@ const LINK_REPLACEMENTS = [
   ['saml-account', '/docs/references/backend/types/backend-saml-account'],
   ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
   ['verify-token-options', '#verify-token-options'],
+  ['localization-resource', '/docs/customization/localization'],
+  ['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
 ];
 
 /**
@@ -85,10 +87,6 @@ function getCatchAllReplacements() {
       pattern: /\(setActiveParams\)/g,
       replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
     },
-    {
-      pattern: /`_LocalizationResource`/g,
-      replace: '[Localization](/docs/customization/localization)',
-    },
     {
       pattern: /`LoadedClerk`/g,
       replace: '[Clerk](/docs/references/javascript/clerk)',

packages/types/src/clerk.ts

@@ -653,31 +653,31 @@ export interface Clerk {
   buildUrlWithAuth(to: string): string;
 
   /**
-   * Returns the configured url where <SignIn/> is mounted or a custom sign-in page is rendered.
+   * Returns the configured url where `<SignIn/>` is mounted or a custom sign-in page is rendered.
    *
    * @param opts A {@link RedirectOptions} object
    */
   buildSignInUrl(opts?: RedirectOptions): string;
 
   /**
-   * Returns the configured url where <SignUp/> is mounted or a custom sign-up page is rendered.
+   * Returns the configured url where `<SignUp/>` is mounted or a custom sign-up page is rendered.
    *
    * @param opts A {@link RedirectOptions} object
    */
   buildSignUpUrl(opts?: RedirectOptions): string;
 
   /**
-   * Returns the url where <UserProfile /> is mounted or a custom user-profile page is rendered.
+   * Returns the url where `<UserProfile />` is mounted or a custom user-profile page is rendered.
    */
   buildUserProfileUrl(): string;
 
   /**
-   * Returns the configured url where <CreateOrganization /> is mounted or a custom create-organization page is rendered.
+   * Returns the configured url where `<CreateOrganization />` is mounted or a custom create-organization page is rendered.
    */
   buildCreateOrganizationUrl(): string;
 
   /**
-   * Returns the configured url where <OrganizationProfile /> is mounted or a custom organization-profile page is rendered.
+   * Returns the configured url where `<OrganizationProfile />` is mounted or a custom organization-profile page is rendered.
    */
   buildOrganizationProfileUrl(): string;
 
@@ -707,7 +707,7 @@ export interface Clerk {
   buildAfterMultiSessionSingleSignOutUrl(): string;
 
   /**
-   * Returns the configured url where <Waitlist/> is mounted or a custom waitlist page is rendered.
+   * Returns the configured url where `<Waitlist/>` is mounted or a custom waitlist page is rendered.
    */
   buildWaitlistUrl(opts?: { initialValues?: Record<string, string> }): string;
 
@@ -720,31 +720,31 @@ export interface Clerk {
   redirectWithAuth(to: string): Promise<unknown>;
 
   /**
-   * Redirects to the configured URL where <SignIn/> is mounted.
+   * Redirects to the configured URL where `<SignIn/>` is mounted.
    *
    * @param opts A {@link RedirectOptions} object
    */
   redirectToSignIn(opts?: SignInRedirectOptions): Promise<unknown>;
 
   /**
-   * Redirects to the configured URL where <SignUp/> is mounted.
+   * Redirects to the configured URL where `<SignUp/>` is mounted.
    *
    * @param opts A {@link RedirectOptions} object
    */
   redirectToSignUp(opts?: SignUpRedirectOptions): Promise<unknown>;
 
   /**
-   * Redirects to the configured URL where <UserProfile/> is mounted.
+   * Redirects to the configured URL where `<UserProfile/>` is mounted.
    */
   redirectToUserProfile: () => Promise<unknown>;
 
   /**
-   * Redirects to the configured URL where <OrganizationProfile /> is mounted.
+   * Redirects to the configured URL where `<OrganizationProfile />` is mounted.
    */
   redirectToOrganizationProfile: () => Promise<unknown>;
 
   /**
-   * Redirects to the configured URL where <CreateOrganization /> is mounted.
+   * Redirects to the configured URL where `<CreateOrganization />` is mounted.
    */
   redirectToCreateOrganization: () => Promise<unknown>;
 
@@ -764,7 +764,7 @@ export interface Clerk {
   redirectToAfterSignOut: () => void;
 
   /**
-   * Redirects to the configured URL where <Waitlist/> is mounted.
+   * Redirects to the configured URL where `<Waitlist/>` is mounted.
    */
   redirectToWaitlist: () => void;
 

packages/types/src/localization.ts

@@ -60,7 +60,9 @@ type DeepLocalizationWithoutObjects<T> = {
  * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
  * as a starting point.
  */
-export type LocalizationResource = DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>>;
+// eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Needs to be an interface for typedoc to link correctly
+export interface LocalizationResource
+  extends DeepPartial<DeepLocalizationWithoutObjects<__internal_LocalizationResource>> {}
 
 export type __internal_LocalizationResource = {
   locale: string;