fumadocs-core 15.2.8 → 16.0.3

package/dist/source/index.d.ts

@@ -1,263 +1,42 @@
-import { ReactElement } from 'react';
-import { I as I18nConfig } from '../config-inq6kP6y.js';
-import { R as Root, I as Item, F as Folder$1, S as Separator } from '../page-tree-BG3wP0gU.js';
+export { C as ContentStorage, F as FileSystem, t as InferMetaType, I as InferPageType, f as LoaderConfig, g as LoaderOptions, k as LoaderOutput, L as LoaderPlugin, j as Meta, p as MetaData, M as MetaFile, i as Page, q as PageData, e as PageFile, a as PageTreeBuilder, b as PageTreeBuilderContext, d as PageTreeOptions, P as PageTreeTransformer, R as ResolvedLoaderConfig, h as Source, S as SourceConfig, U as UrlFn, s as VirtualFile, r as VirtualMeta, V as VirtualPage, _ as _ConfigUnion_, u as buildPlugins, l as createGetUrl, c as createPageTreeBuilder, m as loader, o as map, n as multiple } from '../builder-feW_xVjc.js';
+import '../definitions-BRsJlZ6m.js';
+import 'react';
+import '../i18n/index.js';
 
-interface FileInfo {
-    /**
-     * File path without extension
-     *
-     * @deprecated obtain it with `join(dirname, name)`
-     */
-    flattenedPath: string;
-    /**
-     * Original path of file
-     */
-    path: string;
-    /**
-     * File name without locale and extension
-     */
-    name: string;
-    /**
-     * file extension from the last `.`, like `.md`
-     *
-     * empty string if no file extension
-     */
-    ext: string;
-    dirname: string;
-}
-interface FolderInfo {
-    /**
-     * Original path of folder
-     */
-    path: string;
-    /**
-     * folder name
-     */
-    name: string;
-    dirname: string;
-}
-declare function parseFilePath(path: string): FileInfo;
-declare function parseFolderPath(path: string): FolderInfo;
-
-interface LoadOptions {
-    transformers?: Transformer[];
-    getSlugs: (info: FileInfo) => string[];
-}
-interface I18nLoadOptions extends LoadOptions {
-    i18n: {
-        parser: 'dot' | 'dir';
-        languages: string[];
-        defaultLanguage: 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;
-}
-interface SourceConfig {
-    pageData: PageData;
-    metaData: MetaData;
-}
-interface LoaderOptions {
-    baseUrl: string;
-    icon?: NonNullable<BuildPageTreeOptions['resolveIcon']>;
-    slugs?: LoadOptions['getSlugs'];
-    url?: UrlFn;
-    source: Source<any>;
-    transformers?: Transformer[];
-    /**
-     * Additional options for page tree builder
-     */
-    pageTree?: Partial<Omit<BuildPageTreeOptions, 'storage' | 'getUrl'>>;
-    /**
-     * Configure i18n
-     */
-    i18n?: I18nConfig & {
-        parser?: I18nLoadOptions['i18n']['parser'];
-    };
-}
-interface Source<Config extends SourceConfig> {
-    /**
-     * @internal
-     */
-    _config?: Config;
-    files: VirtualFile[] | (() => VirtualFile[]);
-}
-interface Page<Data = PageData> {
-    file: FileInfo;
-    slugs: string[];
-    url: string;
-    data: Data;
-    locale?: string | undefined;
-}
-interface Meta<Data = MetaData> {
-    file: FileInfo;
-    data: Data;
-}
-interface LanguageEntry<Data = PageData> {
-    language: string;
-    pages: Page<Data>[];
-}
-interface LoaderOutput<Config extends LoaderConfig> {
-    pageTree: Config['i18n'] extends true ? Record<string, Root> : Root;
-    getPageTree: (locale?: string) => Root;
-    getPageByHref: (href: string, options?: {
-        /**
-         * resolve relative file paths in `href` from specified dirname, must be a virtual path.
-         */
-        dir?: string;
-    }) => {
-        page: Page<Config['source']['pageData']>;
-        hash?: string;
-    } | undefined;
-    _i18n?: I18nConfig;
-    /**
-     * Get list of pages from language, empty if language hasn't specified
-     *
-     * @param language - If empty, the default language will be used
-     */
-    getPages: (language?: string) => Page<Config['source']['pageData']>[];
-    getLanguages: () => LanguageEntry<Config['source']['pageData']>[];
-    /**
-     * @param language - If empty, the default language will be used
-     */
-    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;
-    /**
-     * generate static params for Next.js SSG
-     */
-    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;
-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;
-}>;
-
-interface MetaData {
-    icon?: string | undefined;
-    title?: string | undefined;
-    root?: boolean | undefined;
-    pages?: string[] | undefined;
-    defaultOpen?: boolean | undefined;
-    description?: string | undefined;
-}
-interface PageData {
-    icon?: string | undefined;
-    title?: string;
-    description?: string | undefined;
-}
-type InferPageType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput<infer Config> ? Page<Config['source']['pageData']> : never;
-type InferMetaType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput<infer Config> ? Meta<Config['source']['metaData']> : never;
 /**
- * @internal
+ * Convert file path into slugs, also encode non-ASCII characters, so they can work in pathname
  */
-type UrlFn = (slugs: string[], locale?: string) => string;
+declare function getSlugs(file: string): string[];
 
-interface MetaFile {
-    file: FileInfo;
-    format: 'meta';
-    data: MetaData;
-}
-interface PageFile {
-    file: FileInfo;
-    format: 'page';
-    data: {
-        slugs: string[];
-        data: PageData;
-    };
-}
-type File = MetaFile | PageFile;
-interface Folder {
-    file: FolderInfo;
-    children: (File | Folder)[];
-}
+declare function basename(path: string, ext?: string): string;
+declare function extname(path: string): string;
+declare function dirname(path: string): string;
 /**
- * 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
+ * Split path into segments, trailing/leading slashes are removed
  */
-declare class Storage {
-    files: Map<string, File>;
-    folders: Map<string, Folder>;
-    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_File = File;
-type fileSystem_Folder = Folder;
-type fileSystem_MetaFile = MetaFile;
-type fileSystem_PageFile = PageFile;
-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 };
-}
+declare function splitPath(path: string): string[];
+/**
+ * Resolve paths, slashes within the path will be ignored
+ * @param paths - Paths to join
+ * @example
+ * ```
+ * ['a','b'] // 'a/b'
+ * ['/a'] // 'a'
+ * ['a', '/b'] // 'a/b'
+ * ['a', '../b/c'] // 'b/c'
+ * ```
+ */
+declare function joinPath(...paths: string[]): string;
+declare function slash(path: string): string;
 
-interface Options {
-    /**
-     * 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;
-    attachSeparator?: (node: Separator) => Separator;
-    getUrl: UrlFn;
-    resolveIcon?: (icon: string | undefined) => ReactElement | undefined;
-}
-interface BuildPageTreeOptions extends Options {
-    storage: Storage;
-}
-interface BuildPageTreeOptionsWithI18n extends Options {
-    storages: Record<string, Storage>;
-    i18n: I18nConfig;
-}
-interface PageTreeBuilder {
-    build: (options: BuildPageTreeOptions) => Root;
-    /**
-     * Build page tree and fallback to the default language if the localized page doesn't exist
-     */
-    buildI18n: (options: BuildPageTreeOptionsWithI18n) => Record<string, Root>;
+declare const path_basename: typeof basename;
+declare const path_dirname: typeof dirname;
+declare const path_extname: typeof extname;
+declare const path_joinPath: typeof joinPath;
+declare const path_slash: typeof slash;
+declare const path_splitPath: typeof splitPath;
+declare namespace path {
+  export { path_basename as basename, path_dirname as dirname, path_extname as extname, path_joinPath as joinPath, path_slash as slash, path_splitPath as splitPath };
 }
-declare function createPageTreeBuilder(): 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 { path as PathUtils, getSlugs };