fumadocs-core 15.2.12 → 15.2.14

package/dist/{config-inq6kP6y.d.ts → config-Cm58P4fz.d.ts}

@@ -21,6 +21,12 @@ interface I18nConfig {
      * @defaultValue 'never'
      */
     hideLocale?: 'always' | 'default-locale' | 'never';
+    /**
+     * Used by `loader()`, specify the way to parse i18n file structure.
+     *
+     * @defaultValue 'dot'
+     */
+    parser?: 'dot' | 'dir';
 }
 
 export type { I18nConfig as I };

package/dist/i18n/index.d.ts

@@ -1,4 +1,4 @@
-import { I as I18nConfig } from '../config-inq6kP6y.js';
+import { I as I18nConfig } from '../config-Cm58P4fz.js';
 import { NextMiddleware } from 'next/dist/server/web/types';
 
 interface MiddlewareOptions extends I18nConfig {

package/dist/search/server.d.ts

@@ -1,7 +1,7 @@
 import { TypedDocument, Orama, Language, RawData, create, SearchParams } from '@orama/orama';
 import { S as StructuredData } from '../remark-structure-FIjTA11P.js';
 import { S as SortedResult } from '../types-Ch8gnVgO.js';
-import { I as I18nConfig } from '../config-inq6kP6y.js';
+import { I as I18nConfig } from '../config-Cm58P4fz.js';
 import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
 import 'mdast';
 import 'unified';

package/dist/server/index.d.ts

@@ -8,7 +8,7 @@ import { LoaderOutput, LoaderConfig, InferPageType } from '../source/index.js';
 import 'react';
 import 'unified';
 import 'vfile';
-import '../config-inq6kP6y.js';
+import '../config-Cm58P4fz.js';
 
 /**
  * Flatten tree to an array of page nodes

package/dist/source/index.d.ts

@@ -1,5 +1,5 @@
 import { ReactElement } from 'react';
-import { I as I18nConfig } from '../config-inq6kP6y.js';
+import { I as I18nConfig } from '../config-Cm58P4fz.js';
 import { R as Root, I as Item, F as Folder$1, S as Separator } from '../page-tree-bSt6K__E.js';
 
 interface FileInfo {
@@ -10,11 +10,11 @@ interface FileInfo {
      */
     flattenedPath: string;
     /**
-     * Original path of file
+     * path of file (unparsed)
      */
     path: string;
     /**
-     * File name without locale and extension
+     * File name without extension
      */
     name: string;
     /**
@@ -43,13 +43,6 @@ interface LoadOptions {
     transformers?: Transformer[];
     getSlugs: (info: FileInfo) => string[];
 }
-interface I18nLoadOptions extends LoadOptions {
-    i18n: {
-        parser: 'dot' | 'dir';
-        languages: string[];
-        defaultLanguage: string;
-    };
-}
 interface VirtualFile {
     /**
      * Relative path
@@ -78,23 +71,21 @@ interface SourceConfig {
     pageData: PageData;
     metaData: MetaData;
 }
-interface LoaderOptions {
+interface LoaderOptions<T extends SourceConfig = SourceConfig, I18n extends I18nConfig | undefined = I18nConfig | undefined> {
     baseUrl: string;
-    icon?: NonNullable<BuildPageTreeOptions['resolveIcon']>;
+    icon?: NonNullable<BaseOptions['resolveIcon']>;
     slugs?: LoadOptions['getSlugs'];
     url?: UrlFn;
-    source: Source<any>;
+    source: Source<T>;
     transformers?: Transformer[];
     /**
      * Additional options for page tree builder
      */
-    pageTree?: Partial<Omit<BuildPageTreeOptions, 'storage' | 'getUrl'>>;
+    pageTree?: Partial<BaseOptions<T['pageData'], T['metaData']>>;
     /**
      * Configure i18n
      */
-    i18n?: I18nConfig & {
-        parser?: I18nLoadOptions['i18n']['parser'];
-    };
+    i18n?: I18n;
 }
 interface Source<Config extends SourceConfig> {
     /**
@@ -104,6 +95,9 @@ interface Source<Config extends SourceConfig> {
     files: VirtualFile[] | (() => VirtualFile[]);
 }
 interface Page<Data = PageData> {
+    /**
+     * Virtualized file path
+     */
     file: FileInfo;
     slugs: string[];
     url: string;
@@ -111,6 +105,9 @@ interface Page<Data = PageData> {
     locale?: string | undefined;
 }
 interface Meta<Data = MetaData> {
+    /**
+     * Virtualized file path
+     */
     file: FileInfo;
     data: Data;
 }
@@ -156,10 +153,9 @@ interface LoaderOutput<Config extends LoaderConfig> {
 }
 declare function createGetUrl(baseUrl: string, i18n?: I18nConfig): UrlFn;
 declare function getSlugs(info: FileInfo): string[];
-type InferSourceConfig<T> = T extends Source<infer Config> ? Config : never;
-declare function loader<Options extends LoaderOptions>(options: Options): LoaderOutput<{
-    source: InferSourceConfig<Options['source']>;
-    i18n: Options['i18n'] extends I18nConfig ? true : false;
+declare function loader<Config extends SourceConfig, I18n extends I18nConfig | undefined = undefined>(options: LoaderOptions<Config, I18n>): LoaderOutput<{
+    source: Config;
+    i18n: I18n extends I18nConfig ? true : false;
 }>;
 
 interface MetaData {
@@ -182,23 +178,23 @@ type InferMetaType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput
  */
 type UrlFn = (slugs: string[], locale?: string) => string;
 
-interface MetaFile {
+interface MetaFile<Data extends MetaData = MetaData> {
     file: FileInfo;
     format: 'meta';
-    data: MetaData;
+    data: Data;
 }
-interface PageFile {
+interface PageFile<Data extends PageData = PageData> {
     file: FileInfo;
     format: 'page';
     data: {
         slugs: string[];
-        data: PageData;
+        data: Data;
     };
 }
 type File = MetaFile | PageFile;
-interface Folder {
+interface Folder<Page extends PageData = PageData, Meta extends MetaData = MetaData> {
     file: FolderInfo;
-    children: (File | Folder)[];
+    children: (MetaFile<Meta> | PageFile<Page> | Folder<Page, Meta>)[];
 }
 /**
  * A virtual file system that solves inconsistent behaviours
@@ -207,7 +203,7 @@ interface Folder {
  */
 declare class Storage {
     files: Map<string, File>;
-    folders: Map<string, Folder>;
+    folders: Map<string, Folder<PageData, MetaData>>;
     private rootFolder;
     constructor();
     /**
@@ -226,33 +222,31 @@ declare class Storage {
     makeDir(path: string): void;
 }
 
-type fileSystem_File = File;
-type fileSystem_Folder = Folder;
-type fileSystem_MetaFile = MetaFile;
-type fileSystem_PageFile = PageFile;
+type fileSystem_Folder<Page extends PageData = PageData, Meta extends MetaData = MetaData> = Folder<Page, Meta>;
+type fileSystem_MetaFile<Data extends MetaData = MetaData> = MetaFile<Data>;
+type fileSystem_PageFile<Data extends PageData = PageData> = PageFile<Data>;
 type fileSystem_Storage = Storage;
 declare const fileSystem_Storage: typeof Storage;
 declare namespace fileSystem {
-  export { type fileSystem_File as File, type fileSystem_Folder as Folder, type fileSystem_MetaFile as MetaFile, type fileSystem_PageFile as PageFile, fileSystem_Storage as Storage };
+  export { type fileSystem_Folder as Folder, type fileSystem_MetaFile as MetaFile, type fileSystem_PageFile as PageFile, fileSystem_Storage as Storage };
 }
 
-interface Options {
+interface BaseOptions<Page extends PageData = PageData, Meta extends MetaData = MetaData> {
     /**
      * Remove references to the file path of original nodes (`$ref`)
      *
      * @defaultValue false
      */
     noRef?: boolean;
-    attachFile?: (node: Item, file?: PageFile) => Item;
-    attachFolder?: (node: Folder$1, folder: Folder, meta?: MetaFile) => Folder$1;
+    attachFile?: (node: Item, file?: PageFile<Page>) => Item;
+    attachFolder?: (node: Folder$1, folder: Folder<Page, Meta>, meta?: MetaFile<Meta>) => Folder$1;
     attachSeparator?: (node: Separator) => Separator;
-    getUrl: UrlFn;
     resolveIcon?: (icon: string | undefined) => ReactElement | undefined;
 }
-interface BuildPageTreeOptions extends Options {
+interface BuildPageTreeOptions extends BaseOptions {
     storage: Storage;
 }
-interface BuildPageTreeOptionsWithI18n extends Options {
+interface BuildPageTreeOptionsWithI18n extends BaseOptions {
     storages: Record<string, Storage>;
     i18n: I18nConfig;
 }
@@ -263,6 +257,6 @@ interface PageTreeBuilder {
      */
     buildI18n: (options: BuildPageTreeOptionsWithI18n) => Record<string, Root>;
 }
-declare function createPageTreeBuilder(): PageTreeBuilder;
+declare function createPageTreeBuilder(getUrl: UrlFn): PageTreeBuilder;
 
-export { type BuildPageTreeOptions, type BuildPageTreeOptionsWithI18n, type FileInfo, fileSystem as FileSystem, type FolderInfo, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type Meta, type MetaData, type Page, type PageData, type PageTreeBuilder, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loadFiles, loader, parseFilePath, parseFolderPath };
+export { type BaseOptions, type BuildPageTreeOptions, type BuildPageTreeOptionsWithI18n, type FileInfo, fileSystem as FileSystem, type FolderInfo, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type Meta, type MetaData, type Page, type PageData, type PageTreeBuilder, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loadFiles, loader, parseFilePath, parseFolderPath };

package/dist/source/index.js

@@ -140,7 +140,7 @@ function buildFileNode(file, ctx) {
     name: file.data.data.title ?? pathToName(file.file.name),
     description: file.data.data.description,
     icon: ctx.options.resolveIcon?.(file.data.data.icon),
-    url: ctx.options.getUrl(file.data.slugs, ctx.locale),
+    url: ctx.getUrl(file.data.slugs, ctx.locale),
     $ref: !ctx.options.noRef ? {
       file: file.file.path
     } : void 0
@@ -156,19 +156,21 @@ function build(ctx) {
     children: folder.children
   };
 }
-function createPageTreeBuilder() {
+function createPageTreeBuilder(getUrl) {
   return {
     build(options) {
       return build({
         options,
         builder: this,
-        storage: options.storage
+        storage: options.storage,
+        getUrl
       });
     },
     buildI18n({ i18n, ...options }) {
       const entries = i18n.languages.map((lang) => {
         const tree = build({
           options,
+          getUrl,
           builder: this,
           locale: lang,
           storage: options.storages[i18n.defaultLanguage],
@@ -429,7 +431,7 @@ function createOutput(options) {
     })
   };
   const walker = indexPages(storages, getUrl, options.i18n);
-  const builder = createPageTreeBuilder();
+  const builder = createPageTreeBuilder(getUrl);
   let pageTree;
   return {
     _i18n: options.i18n,
@@ -438,7 +440,6 @@ function createOutput(options) {
         pageTree ??= builder.buildI18n({
           storages,
           resolveIcon: options.icon,
-          getUrl,
           i18n: options.i18n,
           ...options.pageTree
         });
@@ -446,7 +447,6 @@ function createOutput(options) {
         pageTree ??= builder.build({
           storage: storages[""],
           resolveIcon: options.icon,
-          getUrl,
           ...options.pageTree
         });
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "15.2.12",
+  "version": "15.2.14",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -97,19 +97,19 @@
     "@algolia/client-search": "4.24.0",
     "@mdx-js/mdx": "^3.1.0",
     "@oramacloud/client": "^2.1.4",
-    "@tanstack/react-router": "^1.117.1",
+    "@tanstack/react-router": "^1.119.0",
     "@types/estree-jsx": "^1.0.5",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
     "@types/negotiator": "^0.6.3",
-    "@types/node": "22.15.2",
+    "@types/node": "22.15.3",
     "@types/react": "^19.1.2",
-    "@types/react-dom": "^19.1.2",
+    "@types/react-dom": "^19.1.3",
     "algoliasearch": "4.24.0",
     "mdast-util-mdx-jsx": "^3.2.0",
     "mdast-util-mdxjs-esm": "^2.0.1",
     "next": "^15.3.1",
-    "react-router": "^7.5.2",
+    "react-router": "^7.5.3",
     "remark-mdx": "^3.1.0",
     "remark-rehype": "^11.1.2",
     "typescript": "^5.8.3",