Refactor navigation APIs

amannn · Aug 27, 2024 · 762465b · 762465b
1 parent 0d89722
commit 762465b
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 122 deletions.
diff --git a/packages/next-intl/src/navigation/react-client/createLocalizedPathnamesNavigation.tsx b/packages/next-intl/src/navigation/react-client/createLocalizedPathnamesNavigation.tsx
@@ -1,11 +1,11 @@
 import React, {ComponentProps, ReactElement, forwardRef, useMemo} from 'react';
 import useLocale from '../../react-client/useLocale';
+import {
+  receiveRoutingConfig,
+  RoutingConfigLocalizedNavigation
+} from '../../routing/config';
 import {Locales, Pathnames} from '../../routing/types';
 import {ParametersExceptFirst} from '../../shared/types';
-import {
-  LocalizedNavigationRoutingConfigInput,
-  receiveLocalizedNavigationRoutingConfig
-} from '../shared/config';
 import {
   compileLocalizedPathname,
   getRoute,
@@ -21,8 +21,8 @@ import useBaseRouter from './useBaseRouter';
 export default function createLocalizedPathnamesNavigation<
   AppLocales extends Locales,
   AppPathnames extends Pathnames<AppLocales>
->(input: LocalizedNavigationRoutingConfigInput<AppLocales, AppPathnames>) {
-  const config = receiveLocalizedNavigationRoutingConfig(input);
+>(routing: RoutingConfigLocalizedNavigation<AppLocales, AppPathnames>) {
+  const config = receiveRoutingConfig(routing);
 
   function useTypedLocale(): AppLocales[number] {
     const locale = useLocale();

diff --git a/packages/next-intl/src/navigation/react-client/createSharedPathnamesNavigation.tsx b/packages/next-intl/src/navigation/react-client/createSharedPathnamesNavigation.tsx
@@ -1,19 +1,19 @@
 import React, {ComponentProps, ReactElement, forwardRef} from 'react';
+import {
+  receiveLocalePrefixConfig,
+  RoutingConfigSharedNavigation
+} from '../../routing/config';
 import {Locales} from '../../routing/types';
 import {ParametersExceptFirst} from '../../shared/types';
-import {
-  SharedNavigationRoutingConfigInput,
-  receiveSharedNavigationRoutingConfig
-} from '../shared/config';
 import ClientLink from './ClientLink';
 import {clientRedirect, clientPermanentRedirect} from './redirects';
 import useBasePathname from './useBasePathname';
 import useBaseRouter from './useBaseRouter';
 
 export default function createSharedPathnamesNavigation<
   const AppLocales extends Locales
->(input?: SharedNavigationRoutingConfigInput<AppLocales>) {
-  const config = receiveSharedNavigationRoutingConfig(input);
+>(routing?: RoutingConfigSharedNavigation<AppLocales, never>) {
+  const localePrefix = receiveLocalePrefixConfig(routing?.localePrefix);
 
   type LinkProps = Omit<
     ComponentProps<typeof ClientLink<AppLocales>>,
@@ -23,7 +23,7 @@ export default function createSharedPathnamesNavigation<
     return (
       <ClientLink<AppLocales>
         ref={ref}
-        localePrefix={config.localePrefix}
+        localePrefix={localePrefix}
         {...props}
       />
     );
@@ -37,30 +37,24 @@ export default function createSharedPathnamesNavigation<
     pathname: string,
     ...args: ParametersExceptFirst<typeof clientRedirect>
   ) {
-    return clientRedirect(
-      {pathname, localePrefix: config.localePrefix},
-      ...args
-    );
+    return clientRedirect({pathname, localePrefix}, ...args);
   }
 
   function permanentRedirect(
     pathname: string,
     ...args: ParametersExceptFirst<typeof clientPermanentRedirect>
   ) {
-    return clientPermanentRedirect(
-      {pathname, localePrefix: config.localePrefix},
-      ...args
-    );
+    return clientPermanentRedirect({pathname, localePrefix}, ...args);
   }
 
   function usePathname(): string {
-    const result = useBasePathname(config.localePrefix);
+    const result = useBasePathname(localePrefix);
     // @ts-expect-error -- Mirror the behavior from Next.js, where `null` is returned when `usePathname` is used outside of Next, but the types indicate that a string is always returned.
     return result;
   }
 
   function useRouter() {
-    return useBaseRouter<AppLocales>(config.localePrefix);
+    return useBaseRouter<AppLocales>(localePrefix);
   }
 
   return {

diff --git a/packages/next-intl/src/navigation/react-server/createLocalizedPathnamesNavigation.tsx b/packages/next-intl/src/navigation/react-server/createLocalizedPathnamesNavigation.tsx
@@ -1,11 +1,11 @@
 import React, {ComponentProps} from 'react';
+import {
+  receiveRoutingConfig,
+  RoutingConfigLocalizedNavigation
+} from '../../routing/config';
 import {Locales, Pathnames} from '../../routing/types';
 import {getRequestLocale} from '../../server/react-server/RequestLocale';
 import {ParametersExceptFirst} from '../../shared/types';
-import {
-  LocalizedNavigationRoutingConfigInput,
-  receiveLocalizedNavigationRoutingConfig
-} from '../shared/config';
 import {
   HrefOrHrefWithParams,
   HrefOrUrlObjectWithParams,
@@ -18,8 +18,8 @@ import {serverPermanentRedirect, serverRedirect} from './redirects';
 export default function createLocalizedPathnamesNavigation<
   AppLocales extends Locales,
   AppPathnames extends Pathnames<AppLocales>
->(input: LocalizedNavigationRoutingConfigInput<AppLocales, AppPathnames>) {
-  const config = receiveLocalizedNavigationRoutingConfig(input);
+>(routing: RoutingConfigLocalizedNavigation<AppLocales, AppPathnames>) {
+  const config = receiveRoutingConfig(routing);
 
   type LinkProps<Pathname extends keyof AppPathnames> = Omit<
     ComponentProps<typeof ServerLink>,

diff --git a/packages/next-intl/src/navigation/react-server/createSharedPathnamesNavigation.tsx b/packages/next-intl/src/navigation/react-server/createSharedPathnamesNavigation.tsx
@@ -1,17 +1,17 @@
 import React, {ComponentProps} from 'react';
+import {
+  receiveLocalePrefixConfig,
+  RoutingConfigSharedNavigation
+} from '../../routing/config';
 import {Locales} from '../../routing/types';
 import {ParametersExceptFirst} from '../../shared/types';
-import {
-  SharedNavigationRoutingConfigInput,
-  receiveSharedNavigationRoutingConfig
-} from '../shared/config';
 import ServerLink from './ServerLink';
 import {serverPermanentRedirect, serverRedirect} from './redirects';
 
 export default function createSharedPathnamesNavigation<
   AppLocales extends Locales
->(input?: SharedNavigationRoutingConfigInput<AppLocales>) {
-  const config = receiveSharedNavigationRoutingConfig(input);
+>(routing?: RoutingConfigSharedNavigation<AppLocales, never>) {
+  const localePrefix = receiveLocalePrefixConfig(routing?.localePrefix);
 
   function notSupported(hookName: string) {
     return () => {
@@ -27,29 +27,21 @@ export default function createSharedPathnamesNavigation<
       'localePrefix' | 'locales'
     >
   ) {
-    return (
-      <ServerLink<AppLocales> localePrefix={config.localePrefix} {...props} />
-    );
+    return <ServerLink<AppLocales> localePrefix={localePrefix} {...props} />;
   }
 
   function redirect(
     pathname: string,
     ...args: ParametersExceptFirst<typeof serverRedirect>
   ) {
-    return serverRedirect(
-      {pathname, localePrefix: config.localePrefix},
-      ...args
-    );
+    return serverRedirect({pathname, localePrefix}, ...args);
   }
 
   function permanentRedirect(
     pathname: string,
     ...args: ParametersExceptFirst<typeof serverPermanentRedirect>
   ) {
-    return serverPermanentRedirect(
-      {pathname, localePrefix: config.localePrefix},
-      ...args
-    );
+    return serverPermanentRedirect({pathname, localePrefix}, ...args);
   }
 
   return {

diff --git a/packages/next-intl/src/navigation/shared/config.tsx b/packages/next-intl/src/navigation/shared/config.tsx
diff --git a/packages/next-intl/src/routing/config.tsx b/packages/next-intl/src/routing/config.tsx
@@ -6,12 +6,6 @@ import {
   Pathnames
 } from './types';
 
-/**
- * Maintainer note: The config that is accepted by the middleware, the shared
- * and the localized pathnames navigation factory function is slightly
- * different. This type declares the shared base config that is accepted by all
- * of them. Properties that are different are declared in consuming types.
- */
 export type RoutingConfig<
   AppLocales extends Locales,
   AppPathnames extends Pathnames<AppLocales>
@@ -34,13 +28,37 @@ export type RoutingConfig<
    **/
   localePrefix?: LocalePrefix<AppLocales>;
 
-  /** Can be used to change the locale handling per domain. */
+  /**
+   * Can be used to change the locale handling per domain.
+   * @see https://next-intl-docs.vercel.app/docs/routing#domains
+   **/
   domains?: DomainsConfig<AppLocales>;
 
-  /** A map of localized pathnames per locale. */
+  /**
+   * A map of localized pathnames per locale.
+   * @see https://next-intl-docs.vercel.app/docs/routing#pathnames
+   **/
   pathnames?: AppPathnames;
 };
 
+export type RoutingConfigSharedNavigation<
+  AppLocales extends Locales,
+  AppPathnames extends Pathnames<AppLocales>
+> = Omit<RoutingConfig<AppLocales, AppPathnames>, 'defaultLocale' | 'locales'> &
+  Partial<
+    Pick<RoutingConfig<AppLocales, AppPathnames>, 'defaultLocale' | 'locales'>
+  >;
+
+export type RoutingConfigLocalizedNavigation<
+  AppLocales extends Locales,
+  AppPathnames extends Pathnames<AppLocales>
+> = Omit<
+  RoutingConfig<AppLocales, AppPathnames>,
+  'defaultLocale' | 'pathnames'
+> &
+  Partial<Pick<RoutingConfig<AppLocales, AppPathnames>, 'defaultLocale'>> &
+  Required<Pick<RoutingConfig<AppLocales, AppPathnames>, 'pathnames'>>;
+
 export type ResolvedRoutingConfig<
   AppLocales extends Locales,
   AppPathnames extends Pathnames<AppLocales>
@@ -50,10 +68,9 @@ export type ResolvedRoutingConfig<
 
 export function receiveRoutingConfig<
   AppLocales extends Locales,
-  AppPathnames extends Pathnames<AppLocales>
->(
-  input: RoutingConfig<AppLocales, AppPathnames>
-): ResolvedRoutingConfig<AppLocales, AppPathnames> {
+  AppPathnames extends Pathnames<AppLocales>,
+  Config extends Partial<RoutingConfig<AppLocales, AppPathnames>>
+>(input: Config) {
   return {
     ...input,
     localePrefix: receiveLocalePrefixConfig(input.localePrefix)