fumadocs-core 15.5.0 → 15.5.2

package/dist/server/index.js

@@ -1,7 +1,6 @@
 import {
   remarkHeading
 } from "../chunk-Y2774T3B.js";
-import "../chunk-MLKGABMK.js";
 
 // src/server/get-toc.ts
 import { remark } from "remark";

package/dist/sidebar.js

@@ -2,7 +2,6 @@
 import {
   useMediaQuery
 } from "./chunk-EP5LHGDZ.js";
-import "./chunk-MLKGABMK.js";
 
 // src/sidebar.tsx
 import {

package/dist/source/index.d.ts

@@ -1,6 +1,47 @@
 import { ReactElement } from 'react';
-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';
+import { I18nConfig } from '../i18n/index.js';
+import { R as Root, I as Item, F as Folder, S as Separator } from '../page-tree-bSt6K__E.js';
+import 'next/dist/server/web/types';
+
+/**
+ * In memory file system.
+ */
+declare class FileSystem<File> {
+    files: Map<string, File>;
+    folders: Map<string, string[]>;
+    constructor();
+    read(path: string): File | undefined;
+    /**
+     * get the direct children of folder (in virtual file path)
+     */
+    readDir(path: string): string[] | undefined;
+    write(path: string, file: File): void;
+    getFiles(): string[];
+    makeDir(path: string): void;
+}
+
+interface LoadOptions {
+    transformers?: Transformer[];
+}
+type ContentStorage = FileSystem<MetaFile | PageFile>;
+interface MetaFile<Data extends MetaData = MetaData> {
+    path: string;
+    absolutePath: string;
+    format: 'meta';
+    data: Data;
+}
+interface PageFile<Data extends PageData = PageData> {
+    path: string;
+    absolutePath: string;
+    format: 'page';
+    slugs: string[];
+    data: Data;
+}
+type Transformer = (context: {
+    storage: ContentStorage;
+    options: LoadOptions;
+}) => void;
+declare function loadFiles(files: VirtualFile[], buildFile: (file: VirtualFile) => MetaFile | PageFile, options: LoadOptions): ContentStorage;
 
 interface FileInfo {
     /**
@@ -37,32 +78,11 @@ interface FolderInfo {
     dirname: string;
 }
 declare function parseFilePath(path: string): FileInfo;
+/**
+ * @deprecated use `dirname` and `basename` directly.
+ */
 declare function parseFolderPath(path: string): FolderInfo;
 
-interface LoadOptions {
-    transformers?: Transformer[];
-    getSlugs: (info: FileInfo) => string[];
-}
-interface VirtualFile {
-    /**
-     * Relative path
-     *
-     * @example `docs/page.mdx`
-     */
-    path: string;
-    type: 'page' | 'meta';
-    /**
-     * Specified Slugs for page
-     */
-    slugs?: string[];
-    data: unknown;
-}
-type Transformer = (context: {
-    storage: Storage;
-    options: LoadOptions;
-}) => void;
-declare function loadFiles<O extends LoadOptions>(files: VirtualFile[], options: O): Storage;
-
 interface LoaderConfig {
     source: SourceConfig;
     i18n: boolean;
@@ -73,15 +93,15 @@ interface SourceConfig {
 }
 interface LoaderOptions<T extends SourceConfig = SourceConfig, I18n extends I18nConfig | undefined = I18nConfig | undefined> {
     baseUrl: string;
-    icon?: NonNullable<BaseOptions['resolveIcon']>;
-    slugs?: LoadOptions['getSlugs'];
+    icon?: NonNullable<BuildPageTreeOptions['resolveIcon']>;
+    slugs?: (info: FileInfo) => string[];
     url?: UrlFn;
     source: Source<T>;
     transformers?: Transformer[];
     /**
      * Additional options for page tree builder
      */
-    pageTree?: Partial<BaseOptions<T['pageData'], T['metaData']>>;
+    pageTree?: Partial<Omit<BuildPageTreeOptions<T['pageData'], T['metaData']>, 'storage'>>;
     /**
      * Configure i18n
      */
@@ -94,21 +114,49 @@ interface Source<Config extends SourceConfig> {
     _config?: Config;
     files: VirtualFile[] | (() => VirtualFile[]);
 }
-interface Page<Data = PageData> {
+interface SharedFileInfo {
     /**
-     * Virtualized file path
+     * Virtualized file path (parsed)
+     *
+     * @deprecated Use `path` instead.
      */
     file: FileInfo;
+    /**
+     * Virtualized file path (relative to content directory)
+     *
+     * @example `docs/page.mdx`
+     */
+    path: string;
+    /**
+     * Absolute path of the file
+     */
+    absolutePath: string;
+}
+interface VirtualFile {
+    /**
+     * Virtualized path (relative to content directory)
+     *
+     * @example `docs/page.mdx`
+     */
+    path: string;
+    /**
+     * Absolute path of the file
+     */
+    absolutePath?: string;
+    type: 'page' | 'meta';
+    /**
+     * Specified Slugs for page
+     */
+    slugs?: string[];
+    data: unknown;
+}
+interface Page<Data = PageData> extends SharedFileInfo {
     slugs: string[];
     url: string;
     data: Data;
     locale?: string | undefined;
 }
-interface Meta<Data = MetaData> {
-    /**
-     * Virtualized file path
-     */
-    file: FileInfo;
+interface Meta<Data = MetaData> extends SharedFileInfo {
     data: Data;
 }
 interface LanguageEntry<Data = PageData> {
@@ -143,7 +191,7 @@ interface LoaderOutput<Config extends LoaderConfig> {
      */
     getPage: (slugs: string[] | undefined, language?: string) => Page<Config['source']['pageData']> | undefined;
     getNodePage: (node: Item, language?: string) => Page<Config['source']['pageData']> | undefined;
-    getNodeMeta: (node: Folder$1, language?: string) => Meta<Config['source']['metaData']> | undefined;
+    getNodeMeta: (node: Folder, language?: string) => Meta<Config['source']['metaData']> | undefined;
     /**
      * generate static params for Next.js SSG
      *
@@ -153,6 +201,9 @@ interface LoaderOutput<Config extends LoaderConfig> {
     generateParams: <TSlug extends string = 'slug', TLang extends string = 'lang'>(slug?: TSlug, lang?: TLang) => (Record<TSlug, string[]> & Record<TLang, string>)[];
 }
 declare function createGetUrl(baseUrl: string, i18n?: I18nConfig): UrlFn;
+/**
+ * Convert file path into slugs, also encode non-ASCII characters, so they can work in pathname
+ */
 declare function getSlugs(info: FileInfo): string[];
 declare function loader<Config extends SourceConfig, I18n extends I18nConfig | undefined = undefined>(options: LoaderOptions<Config, I18n>): LoaderOutput<{
     source: Config;
@@ -179,59 +230,6 @@ type InferMetaType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput
  */
 type UrlFn = (slugs: string[], locale?: string) => string;
 
-interface MetaFile<Data extends MetaData = MetaData> {
-    file: FileInfo;
-    format: 'meta';
-    data: Data;
-}
-interface PageFile<Data extends PageData = PageData> {
-    file: FileInfo;
-    format: 'page';
-    data: {
-        slugs: string[];
-        data: Data;
-    };
-}
-type File = MetaFile | PageFile;
-interface Folder<Page extends PageData = PageData, Meta extends MetaData = MetaData> {
-    file: FolderInfo;
-    children: (MetaFile<Meta> | PageFile<Page> | Folder<Page, Meta>)[];
-}
-/**
- * A virtual file system that solves inconsistent behaviours
- *
- * Some source providers may not provide the full file structure, this will cause inconsistent outputs for page builder and other transformers
- */
-declare class Storage {
-    files: Map<string, File>;
-    folders: Map<string, Folder<PageData, MetaData>>;
-    private rootFolder;
-    constructor();
-    /**
-     * @param path - flattened path
-     * @param format - file format
-     */
-    read<F extends File['format']>(path: string, format: F): Extract<File, {
-        format: F;
-    }> | undefined;
-    readDir(path: string): Folder | undefined;
-    root(): Folder;
-    write<F extends File['format']>(path: string, format: F, data: Extract<File, {
-        format: F;
-    }>['data']): void;
-    list(): File[];
-    makeDir(path: string): void;
-}
-
-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_Folder as Folder, type fileSystem_MetaFile as MetaFile, type fileSystem_PageFile as PageFile, fileSystem_Storage as Storage };
-}
-
 interface BaseOptions<Page extends PageData = PageData, Meta extends MetaData = MetaData> {
     /**
      * Remove references to the file path of original nodes (`$ref`)
@@ -240,15 +238,17 @@ interface BaseOptions<Page extends PageData = PageData, Meta extends MetaData =
      */
     noRef?: boolean;
     attachFile?: (node: Item, file?: PageFile<Page>) => Item;
-    attachFolder?: (node: Folder$1, folder: Folder<Page, Meta>, meta?: MetaFile<Meta>) => Folder$1;
+    attachFolder?: (node: Folder, folder: {
+        children: (PageFile<Page> | MetaFile<Meta>)[];
+    }, meta?: MetaFile<Meta>) => Folder;
     attachSeparator?: (node: Separator) => Separator;
     resolveIcon?: (icon: string | undefined) => ReactElement | undefined;
 }
-interface BuildPageTreeOptions extends BaseOptions {
-    storage: Storage;
+interface BuildPageTreeOptions<Page extends PageData = PageData, Meta extends MetaData = MetaData> extends BaseOptions<Page, Meta> {
+    storage: ContentStorage;
 }
-interface BuildPageTreeOptionsWithI18n extends BaseOptions {
-    storages: Record<string, Storage>;
+interface BuildPageTreeOptionsWithI18n<Page extends PageData = PageData, Meta extends MetaData = MetaData> extends BaseOptions<Page, Meta> {
+    storages: Record<string, ContentStorage>;
     i18n: I18nConfig;
 }
 interface PageTreeBuilder {
@@ -260,4 +260,4 @@ interface PageTreeBuilder {
 }
 declare function createPageTreeBuilder(getUrl: UrlFn): PageTreeBuilder;
 
-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 };
+export { type BuildPageTreeOptions, type BuildPageTreeOptionsWithI18n, type ContentStorage, type FileInfo, FileSystem, type FolderInfo, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type Meta, type MetaData, type MetaFile, type Page, type PageData, type PageFile, type PageTreeBuilder, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loadFiles, loader, parseFilePath, parseFolderPath };