fumadocs-core 12.2.4 → 12.3.0

package/dist/middleware.d.ts

@@ -1,15 +1,31 @@
 import { NextMiddleware } from 'next/dist/server/web/types';
 
 interface MiddlewareOptions {
+    /**
+     * Supported locale codes
+     */
     languages: string[];
+    /**
+     * Default locale if not specified
+     */
     defaultLanguage: string;
+    /**
+     * A function that adds the locale prefix to path name
+     */
     format?: (locale: string, path: string) => string;
+    /**
+     * Don't show the locale prefix on URL.
+     *
+     * - `always`: Always hide the prefix
+     * - `default-locale`: Only hide the default locale
+     * - `never`: Never hide the prefix
+     *
+     * This API uses `NextResponse.rewrite`.
+     *
+     * @defaultValue 'never'
+     */
+    hideLocale?: 'always' | 'default-locale' | 'never';
 }
-/**
- * @param languages - Supported locale codes
- * @param defaultLanguage - Default local if not specified
- * @param format - A function that returns the redirected url with locale code
- */
-declare function createI18nMiddleware({ languages, defaultLanguage, format, }: MiddlewareOptions): NextMiddleware;
+declare function createI18nMiddleware({ languages, defaultLanguage, format, hideLocale, }: MiddlewareOptions): NextMiddleware;
 
 export { createI18nMiddleware };

package/dist/middleware.js

@@ -18,20 +18,31 @@ var defaultFormat = (locale, path) => {
 function createI18nMiddleware({
   languages,
   defaultLanguage,
-  format = defaultFormat
+  format = defaultFormat,
+  hideLocale = "never"
 }) {
+  function shouldHideLocale(locale) {
+    return hideLocale === "always" || hideLocale === "default-locale" && locale === defaultLanguage;
+  }
   return (request) => {
     const { pathname } = request.nextUrl;
-    const pathnameIsMissingLocale = languages.every(
-      (locale) => !pathname.startsWith(`/${locale}/`) && pathname !== `/${locale}`
+    const pathLocale = languages.find(
+      (locale) => pathname.startsWith(`/${locale}/`) || pathname === `/${locale}`
     );
-    if (pathnameIsMissingLocale) {
+    if (!pathLocale) {
       const locale = getLocale(request, languages, defaultLanguage);
       let path = pathname;
       while (path.startsWith("/")) {
         path = path.slice(1);
       }
-      return NextResponse.redirect(new URL(format(locale, path), request.url));
+      const url = new URL(format(locale, path), request.url);
+      return shouldHideLocale(locale) ? NextResponse.rewrite(url) : NextResponse.redirect(url);
+    }
+    if (hideLocale === "default-locale" && pathLocale === defaultLanguage) {
+      const path = pathLocale.slice(`/${pathLocale}`.length);
+      return NextResponse.redirect(
+        new URL(path.startsWith("/") ? path : `/${path}`, request.url)
+      );
     }
     return NextResponse.next();
   };

package/dist/source/index.d.ts

@@ -88,7 +88,7 @@ interface SourceConfig {
     pageData: PageData;
     metaData: MetaData;
 }
-interface LoaderOptions {
+interface LoaderOptions extends Pick<BuildPageTreeOptionsWithI18n, 'languages' | 'defaultLanguage'> {
     /**
      * @defaultValue `''`
      */
@@ -97,7 +97,6 @@ interface LoaderOptions {
      * @defaultValue `'/'`
      */
     baseUrl?: string;
-    languages?: string[];
     icon?: NonNullable<BuildPageTreeOptions['resolveIcon']>;
     slugs?: LoadOptions['getSlugs'];
     url?: UrlFn;
@@ -197,7 +196,14 @@ interface BuildPageTreeOptions {
     resolveIcon?: (icon: string | undefined) => ReactElement | undefined;
 }
 interface BuildPageTreeOptionsWithI18n extends BuildPageTreeOptions {
+    /**
+     * Build a page tree for each language
+     */
     languages?: string[];
+    /**
+     * Hide the locale prefix from URLs if it is same as the specified default locale.
+     */
+    defaultLanguage?: string;
 }
 interface PageTreeBuilder {
     build: (options: BuildPageTreeOptions) => Root;

package/dist/source/index.js

@@ -205,10 +205,10 @@ function createPageTreeBuilder() {
       });
     },
     buildI18n(_a) {
-      var _b = _a, { languages = [] } = _b, options = __objRest(_b, ["languages"]);
+      var _b = _a, { languages = [], defaultLanguage } = _b, options = __objRest(_b, ["languages", "defaultLanguage"]);
       const entries = languages.map((lang) => {
         const tree = build({
-          lang,
+          lang: lang === defaultLanguage ? void 0 : lang,
           options,
           builder: this,
           storage: options.storage
@@ -372,6 +372,7 @@ function createOutput({
   baseUrl = "/",
   slugs: slugsFn = getSlugs,
   url: getUrl = createGetUrl(baseUrl),
+  defaultLanguage,
   pageTree: pageTreeOptions = {}
 }) {
   const storage = loadFiles(
@@ -392,7 +393,8 @@ function createOutput({
     languages,
     storage,
     resolveIcon,
-    getUrl
+    getUrl,
+    defaultLanguage
   }, pageTreeOptions));
   return {
     pageTree,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "12.2.4",
+  "version": "12.3.0",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",