fumadocs-mdx 14.0.1 → 14.0.2

package/dist/core-DTuP23zu.d.cts

@@ -1,341 +0,0 @@
-import { ProcessorOptions } from '@mdx-js/mdx';
-import { StandardSchemaV1 } from '@standard-schema/spec';
-import { Pluggable } from 'unified';
-import * as Plugins from 'fumadocs-core/mdx-plugins';
-import { z } from 'zod';
-import { FSWatcher } from 'chokidar';
-import { VFile } from 'vfile';
-import { PageData, MetaData, Source } from 'fumadocs-core/source';
-import { InternalTypeConfig, DocData, DocMethods, MetaMethods } from './runtime/types.cjs';
-
-type ResolvePlugins = Pluggable[] | ((v: Pluggable[]) => Pluggable[]);
-type DefaultMDXOptions = Omit<NonNullable<ProcessorOptions>, 'rehypePlugins' | 'remarkPlugins' | '_ctx'> & {
-    rehypePlugins?: ResolvePlugins;
-    remarkPlugins?: ResolvePlugins;
-    /**
-     * Properties to export from `vfile.data`
-     */
-    valueToExport?: string[];
-    remarkStructureOptions?: Plugins.StructureOptions | false;
-    remarkHeadingOptions?: Plugins.RemarkHeadingOptions;
-    remarkImageOptions?: Plugins.RemarkImageOptions | false;
-    remarkCodeTabOptions?: Plugins.RemarkCodeTabOptions | false;
-    remarkNpmOptions?: Plugins.RemarkNpmOptions | false;
-    rehypeCodeOptions?: Plugins.RehypeCodeOptions | false;
-};
-type MDXPresetOptions = ({
-    preset?: 'fumadocs';
-} & DefaultMDXOptions) | ({
-    preset: 'minimal';
-} & ProcessorOptions);
-/**
- * apply MDX processor presets
- */
-declare function applyMdxPreset(options?: MDXPresetOptions): (environment: BuildEnvironment) => Promise<ProcessorOptions>;
-
-/**
- * Zod 4 schema
- */
-declare const metaSchema: z.ZodObject<{
-    title: z.ZodOptional<z.ZodString>;
-    pages: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    description: z.ZodOptional<z.ZodString>;
-    root: z.ZodOptional<z.ZodBoolean>;
-    defaultOpen: z.ZodOptional<z.ZodBoolean>;
-    icon: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-/**
- * Zod 4 schema
- */
-declare const frontmatterSchema: z.ZodObject<{
-    title: z.ZodString;
-    description: z.ZodOptional<z.ZodString>;
-    icon: z.ZodOptional<z.ZodString>;
-    full: z.ZodOptional<z.ZodBoolean>;
-    _openapi: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
-}, z.core.$strip>;
-
-interface ExtractedReference {
-    href: string;
-}
-interface PostprocessOptions {
-    _format: 'md' | 'mdx';
-    /**
-     * Properties to export from `vfile.data`
-     */
-    valueToExport?: string[];
-    /**
-     * stringify MDAST and export via `_markdown`.
-     */
-    includeProcessedMarkdown?: boolean;
-    /**
-     * extract link references, export via `extractedReferences`.
-     */
-    extractLinkReferences?: boolean;
-    /**
-     * store MDAST and export via `_mdast`.
-     */
-    includeMDAST?: boolean | {
-        removePosition?: boolean;
-    };
-}
-
-type CollectionSchema<Schema extends StandardSchemaV1, Context> = Schema | ((ctx: Context) => Schema);
-type AnyCollection = DocsCollection | DocCollection | MetaCollection;
-interface BaseCollection {
-    /**
-     * Directory to scan
-     */
-    dir: string;
-    /**
-     * what files to include/exclude (glob patterns)
-     *
-     * Include all files if not specified
-     */
-    files?: string[];
-}
-interface MetaCollection<Schema extends StandardSchemaV1 = StandardSchemaV1> extends BaseCollection {
-    type: 'meta';
-    schema?: CollectionSchema<Schema, {
-        path: string;
-        source: string;
-    }>;
-}
-interface DocCollection<Schema extends StandardSchemaV1 = StandardSchemaV1> extends BaseCollection {
-    type: 'doc';
-    postprocess?: Partial<PostprocessOptions>;
-    mdxOptions?: ProcessorOptions | ((environment: BuildEnvironment) => Promise<ProcessorOptions>);
-    /**
-     * Load files with async
-     */
-    async?: boolean;
-    /**
-     * Compile files on-demand
-     */
-    dynamic?: boolean;
-    schema?: CollectionSchema<Schema, {
-        path: string;
-        source: string;
-    }>;
-}
-interface DocsCollection<DocSchema extends StandardSchemaV1 = StandardSchemaV1, MetaSchema extends StandardSchemaV1 = StandardSchemaV1> {
-    type: 'docs';
-    dir: string;
-    docs: DocCollection<DocSchema>;
-    meta: MetaCollection<MetaSchema>;
-}
-interface GlobalConfig {
-    plugins?: PluginOption[];
-    /**
-     * Configure global MDX options
-     *
-     * @remarks `MDXPresetOptions`
-     */
-    mdxOptions?: MDXPresetOptions | (() => Promise<MDXPresetOptions>);
-    /**
-     * specify a directory to access & store cache (disabled during development mode).
-     *
-     * The cache will never be updated, delete the cache folder to clean.
-     */
-    experimentalBuildCache?: string;
-}
-declare function defineCollections<Schema extends StandardSchemaV1 = StandardSchemaV1>(options: DocCollection<Schema>): DocCollection<Schema>;
-declare function defineCollections<Schema extends StandardSchemaV1 = StandardSchemaV1>(options: MetaCollection<Schema>): MetaCollection<Schema>;
-declare function defineDocs<DocSchema extends StandardSchemaV1 = typeof frontmatterSchema, MetaSchema extends StandardSchemaV1 = typeof metaSchema>(options: {
-    /**
-     * The content directory to scan files
-     *
-     *  @defaultValue 'content/docs'
-     */
-    dir?: string;
-    docs?: Omit<DocCollection<DocSchema>, 'dir' | 'type'>;
-    meta?: Omit<MetaCollection<MetaSchema>, 'dir' | 'type'>;
-}): DocsCollection<DocSchema, MetaSchema>;
-declare function defineConfig(config?: GlobalConfig): GlobalConfig;
-
-type BuildEnvironment = 'bundler' | 'runtime';
-interface LoadedConfig {
-    collectionList: CollectionItem[];
-    getCollection(name: string): CollectionItem | undefined;
-    global: GlobalConfig;
-    getMDXOptions(collection?: DocCollectionItem, environment?: BuildEnvironment): ProcessorOptions | Promise<ProcessorOptions>;
-}
-type CollectionItem = MetaCollectionItem | DocCollectionItem | DocsCollectionItem;
-type PrimitiveCollectionItem<T extends DocCollection | MetaCollection> = Omit<T, 'files'> & {
-    name: string;
-    hasFile: (filePath: string) => boolean;
-    isFileSupported: (filePath: string) => boolean;
-    patterns: string[];
-};
-type MetaCollectionItem = PrimitiveCollectionItem<MetaCollection>;
-type DocCollectionItem = PrimitiveCollectionItem<DocCollection>;
-interface DocsCollectionItem extends DocsCollection {
-    name: string;
-    meta: MetaCollectionItem;
-    docs: DocCollectionItem;
-    hasFile: (filePath: string) => boolean;
-}
-
-type MetaCollectionEntry<Data> = Data & MetaMethods;
-type DocCollectionEntry<Name extends string = string, Frontmatter = unknown, TC extends InternalTypeConfig = InternalTypeConfig> = DocData & DocMethods & Frontmatter & TC['DocData'][Name];
-type AsyncDocCollectionEntry<Name extends string = string, Frontmatter = unknown, TC extends InternalTypeConfig = InternalTypeConfig> = {
-    load: () => Promise<DocData & TC['DocData'][Name]>;
-} & DocMethods & Frontmatter;
-interface DocsCollectionEntry<Name extends string = string, Frontmatter extends PageData = PageData, Meta extends MetaData = MetaData, TC extends InternalTypeConfig = InternalTypeConfig> {
-    docs: DocCollectionEntry<Name, Frontmatter, TC>[];
-    meta: MetaCollectionEntry<Meta>[];
-    toFumadocsSource: () => Source<{
-        pageData: DocCollectionEntry<Name, Frontmatter, TC>;
-        metaData: MetaCollectionEntry<Meta>;
-    }>;
-}
-interface AsyncDocsCollectionEntry<Name extends string = string, Frontmatter extends PageData = PageData, Meta extends MetaData = MetaData, TC extends InternalTypeConfig = InternalTypeConfig> {
-    docs: AsyncDocCollectionEntry<Name, Frontmatter, TC>[];
-    meta: MetaCollectionEntry<Meta>[];
-    toFumadocsSource: () => Source<{
-        pageData: AsyncDocCollectionEntry<Name, Frontmatter, TC>;
-        metaData: MetaCollectionEntry<Meta>;
-    }>;
-}
-type AwaitableGlobEntries<T> = Record<string, T | (() => Promise<T>)>;
-type ServerCreate<Config, TC extends InternalTypeConfig = InternalTypeConfig> = ReturnType<typeof server<Config, TC>>;
-interface ServerOptions {
-    doc?: {
-        passthroughs?: string[];
-    };
-}
-declare function server<Config, TC extends InternalTypeConfig>(options?: ServerOptions): {
-    doc<Name extends keyof Config & string>(_name: Name, base: string, glob: AwaitableGlobEntries<unknown>): Promise<Config[Name] extends DocCollection<infer Schema extends StandardSchemaV1<unknown, unknown>> | DocsCollection<infer Schema extends StandardSchemaV1<unknown, unknown>, StandardSchemaV1<unknown, unknown>> ? DocCollectionEntry<Name, StandardSchemaV1.InferOutput<Schema>, TC>[] : never>;
-    docLazy<Name extends keyof Config & string>(_name: Name, base: string, head: AwaitableGlobEntries<unknown>, body: Record<string, () => Promise<unknown>>): Promise<Config[Name] extends DocCollection<infer Schema extends StandardSchemaV1<unknown, unknown>> | DocsCollection<infer Schema extends StandardSchemaV1<unknown, unknown>, StandardSchemaV1<unknown, unknown>> ? AsyncDocCollectionEntry<Name, StandardSchemaV1.InferOutput<Schema>, TC>[] : never>;
-    meta<Name extends keyof Config & string>(_name: Name, base: string, glob: AwaitableGlobEntries<unknown>): Promise<Config[Name] extends MetaCollection<infer Schema extends StandardSchemaV1<unknown, unknown>> | DocsCollection<StandardSchemaV1<unknown, unknown>, infer Schema extends StandardSchemaV1<unknown, unknown>> ? MetaCollectionEntry<StandardSchemaV1.InferOutput<Schema>>[] : never>;
-    docs<Name extends keyof Config & string>(name: Name, base: string, metaGlob: AwaitableGlobEntries<unknown>, docGlob: AwaitableGlobEntries<unknown>): Promise<Config[Name] extends DocsCollection<infer Page extends StandardSchemaV1<unknown, unknown>, infer Meta extends StandardSchemaV1<unknown, unknown>> ? StandardSchemaV1.InferOutput<Page> extends PageData ? StandardSchemaV1.InferOutput<Meta> extends MetaData ? DocsCollectionEntry<Name, StandardSchemaV1.InferOutput<Page>, StandardSchemaV1.InferOutput<Meta>, TC> : never : never : never>;
-    docsLazy<Name extends keyof Config & string>(name: Name, base: string, metaGlob: AwaitableGlobEntries<unknown>, docHeadGlob: AwaitableGlobEntries<unknown>, docBodyGlob: Record<string, () => Promise<unknown>>): Promise<Config[Name] extends DocsCollection<infer Page extends StandardSchemaV1<unknown, unknown>, infer Meta extends StandardSchemaV1<unknown, unknown>> ? StandardSchemaV1.InferOutput<Page> extends PageData ? StandardSchemaV1.InferOutput<Meta> extends MetaData ? AsyncDocsCollectionEntry<Name, StandardSchemaV1.InferOutput<Page>, StandardSchemaV1.InferOutput<Meta>, TC> : never : never : never>;
-};
-declare function toFumadocsSource<Page extends DocMethods & PageData, Meta extends MetaMethods & MetaData>(pages: Page[], metas: Meta[]): Source<{
-    pageData: Page;
-    metaData: Meta;
-}>;
-
-interface IndexFilePluginOptions {
-    target?: 'default' | 'vite';
-    /**
-     * add `.js` extensions to imports, needed for ESM without bundler resolution
-     */
-    addJsExtension?: boolean;
-    /**
-     * Generate entry point for browser
-     * @defaultValue true
-     */
-    browser?: boolean;
-    /**
-     * Generate entry point for dynamic compilation
-     * @defaultValue true
-     */
-    dynamic?: boolean;
-}
-interface IndexFilePlugin {
-    ['index-file']?: {
-        generateTypeConfig?: (this: PluginContext) => string | void;
-        serverOptions?: (this: PluginContext, options: ServerOptions) => void;
-    };
-}
-declare function indexFile(options?: IndexFilePluginOptions): Plugin;
-
-type Awaitable<T> = T | Promise<T>;
-interface EmitEntry {
-    /**
-     * path relative to output directory
-     */
-    path: string;
-    content: string;
-}
-interface PluginContext extends CoreOptions {
-    core: Core;
-}
-type CompilationContext<Collection> = PluginContext & TransformOptions<Collection>;
-interface TransformOptions<Collection> {
-    collection: Collection;
-    filePath: string;
-    source: string;
-}
-interface Plugin extends IndexFilePlugin {
-    name?: string;
-    /**
-     * on config loaded/updated
-     */
-    config?: (this: PluginContext, config: LoadedConfig) => Awaitable<void | LoadedConfig>;
-    /**
-     * Generate files (e.g. types, index file, or JSON schemas)
-     */
-    emit?: (this: PluginContext) => Awaitable<EmitEntry[]>;
-    /**
-     * Configure Fumadocs dev server
-     */
-    configureServer?: (this: PluginContext, server: ServerContext) => Awaitable<void>;
-    meta?: {
-        /**
-         * Transform metadata
-         */
-        transform?: (this: CompilationContext<MetaCollectionItem>, data: unknown) => Awaitable<unknown | void>;
-    };
-    doc?: {
-        /**
-         * Transform frontmatter
-         */
-        frontmatter?: (this: CompilationContext<DocCollectionItem>, data: Record<string, unknown>) => Awaitable<Record<string, unknown> | void>;
-        /**
-         * Transform `vfile` on compilation stage
-         */
-        vfile?: (this: CompilationContext<DocCollectionItem>, file: VFile) => Awaitable<VFile | void>;
-    };
-}
-type PluginOption = Awaitable<Plugin | PluginOption[] | false>;
-interface ServerContext {
-    /**
-     * the file watcher, by default all content files are watched, along with other files.
-     *
-     * make sure to filter when listening to events
-     */
-    watcher?: FSWatcher;
-}
-interface CoreOptions {
-    environment: string;
-    configPath: string;
-    outDir: string;
-}
-interface EmitOptions {
-    /**
-     * filter the plugins to run emit
-     */
-    filterPlugin?: (plugin: Plugin) => boolean;
-}
-declare const _Defaults: {
-    configPath: string;
-    outDir: string;
-};
-declare function createCore(options: CoreOptions, defaultPlugins?: PluginOption[]): {
-    /**
-     * Convenient cache store, reset when config changes
-     */
-    cache: Map<string, unknown>;
-    init({ config: newConfig }: {
-        config: Awaitable<LoadedConfig>;
-    }): Promise<void>;
-    getOptions(): CoreOptions;
-    getConfig(): LoadedConfig;
-    /**
-     * The file path of compiled config file, the file may not exist (e.g. on Vite, or still compiling)
-     */
-    getCompiledConfigPath(): string;
-    getPlugins(): Plugin[];
-    getPluginContext(): PluginContext;
-    initServer(server: ServerContext): Promise<void>;
-    emit({ filterPlugin }?: EmitOptions): Promise<EmitEntry[]>;
-    emitAndWrite(emitOptions?: EmitOptions): Promise<void>;
-    transformMeta(options: TransformOptions<MetaCollectionItem>, data: unknown): Promise<unknown>;
-    transformFrontmatter(options: TransformOptions<DocCollectionItem>, data: Record<string, unknown>): Promise<Record<string, unknown>>;
-    transformVFile(options: TransformOptions<DocCollectionItem>, file: VFile): Promise<VFile>;
-};
-type Core = ReturnType<typeof createCore>;
-
-export { type AnyCollection as A, type BaseCollection as B, type CollectionSchema as C, type DocCollection as D, type ExtractedReference as E, toFumadocsSource as F, type GlobalConfig as G, indexFile as H, type IndexFilePluginOptions as I, type IndexFilePlugin as J, type MetaCollection as M, type PostprocessOptions as P, type ServerOptions as S, type TransformOptions as T, _Defaults as _, type DocsCollection as a, defineDocs as b, defineConfig as c, defineCollections as d, type DefaultMDXOptions as e, type MDXPresetOptions as f, applyMdxPreset as g, frontmatterSchema as h, type CoreOptions as i, type Plugin as j, type AsyncDocCollectionEntry as k, type AsyncDocsCollectionEntry as l, metaSchema as m, type EmitEntry as n, type PluginContext as o, type CompilationContext as p, type PluginOption as q, type ServerContext as r, type EmitOptions as s, createCore as t, type Core as u, type MetaCollectionEntry as v, type DocCollectionEntry as w, type DocsCollectionEntry as x, type ServerCreate as y, server as z };

package/dist/index-BD8Woo4m.d.cts

@@ -1,8 +0,0 @@
-import { i as CoreOptions } from './core-DTuP23zu.cjs';
-
-interface WebpackLoaderOptions extends CoreOptions {
-    compiledConfigPath: string;
-    isDev: boolean;
-}
-
-export type { WebpackLoaderOptions as W };

package/dist/index.cjs

@@ -1,18 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-module.exports = __toCommonJS(index_exports);

package/dist/index.d.cts

@@ -1,61 +0,0 @@
-export { p as CompilationContext, u as Core, i as CoreOptions, n as EmitEntry, s as EmitOptions, E as ExtractedReference, j as Plugin, o as PluginContext, q as PluginOption, r as ServerContext, T as TransformOptions, _ as _Defaults, t as createCore } from './core-DTuP23zu.cjs';
-import { createProcessor } from '@mdx-js/mdx';
-import { StructuredData } from 'fumadocs-core/mdx-plugins';
-import { TOCItemType } from 'fumadocs-core/toc';
-import { FC } from 'react';
-import { MDXProps } from 'mdx/types';
-import '@standard-schema/spec';
-import 'unified';
-import 'zod';
-import 'chokidar';
-import 'vfile';
-import 'fumadocs-core/source';
-import './runtime/types.cjs';
-import 'fumadocs-core/mdx-plugins/remark-structure';
-import 'mdast';
-
-type Processor = ReturnType<typeof createProcessor>;
-interface CompilerOptions {
-    addDependency: (file: string) => void;
-}
-interface CompiledMDXProperties<Frontmatter = Record<string, unknown>> {
-    frontmatter: Frontmatter;
-    structuredData: StructuredData;
-    toc: TOCItemType[];
-    default: FC<MDXProps>;
-    /**
-     * Enable from `postprocess` option.
-     */
-    _markdown?: string;
-    /**
-     * Enable from `postprocess` option.
-     */
-    _mdast?: string;
-}
-interface FumadocsDataMap {
-    /**
-     * [Fumadocs MDX] raw frontmatter, you can modify it
-     */
-    frontmatter?: Record<string, unknown>;
-    /**
-     * [Fumadocs MDX] additional ESM exports to write
-     */
-    'mdx-export'?: {
-        name: string;
-        value: unknown;
-    }[];
-    /**
-     * [Fumadocs MDX] The compiler object from loader
-     */
-    _compiler?: CompilerOptions;
-    /**
-     * [Fumadocs MDX] get internal processor, do not use this on user land.
-     */
-    _getProcessor?: (format: 'md' | 'mdx') => Processor;
-}
-declare module 'vfile' {
-    interface DataMap extends FumadocsDataMap {
-    }
-}
-
-export type { CompiledMDXProperties };

package/dist/load-from-file-5HUQN36V.js

@@ -1,8 +0,0 @@
-import {
-  loadConfig
-} from "./chunk-MTTISKQJ.js";
-import "./chunk-ZY6UZ7NH.js";
-import "./chunk-E5DJTSIM.js";
-export {
-  loadConfig
-};

package/dist/next/index.d.cts

@@ -1,33 +0,0 @@
-import { NextConfig } from 'next';
-import { I as IndexFilePluginOptions } from '../core-DTuP23zu.cjs';
-import '@mdx-js/mdx';
-import '@standard-schema/spec';
-import 'unified';
-import 'fumadocs-core/mdx-plugins';
-import 'zod';
-import 'chokidar';
-import 'vfile';
-import 'fumadocs-core/source';
-import '../runtime/types.cjs';
-import 'fumadocs-core/mdx-plugins/remark-structure';
-import 'fumadocs-core/toc';
-import 'mdast';
-import 'mdx/types';
-
-interface CreateMDXOptions {
-    /**
-     * Path to source configuration file
-     */
-    configPath?: string;
-    /**
-     * Directory for output files
-     *
-     * @defaultValue '.source'
-     */
-    outDir?: string;
-    index?: IndexFilePluginOptions | false;
-}
-declare function createMDX(createOptions?: CreateMDXOptions): (nextConfig?: NextConfig) => NextConfig;
-declare function postInstall(options: CreateMDXOptions): Promise<void>;
-
-export { type CreateMDXOptions, createMDX, postInstall };