fumadocs-mdx 13.0.0 → 13.0.2

package/dist/chunk-XZY2AWJI.js

@@ -0,0 +1,81 @@
+// src/utils/collections.ts
+import picomatch from "picomatch";
+import { glob } from "tinyglobby";
+import path from "path";
+var SupportedFormats = {
+  doc: ["mdx", "md"],
+  meta: ["json", "yaml"]
+};
+function getGlobPatterns(collection) {
+  if (collection.files) return collection.files;
+  return [`**/*.{${SupportedFormats[collection.type].join(",")}}`];
+}
+function isFileSupported(filePath, collection) {
+  return SupportedFormats[collection.type].some(
+    (format) => filePath.endsWith(`.${format}`)
+  );
+}
+function createCollectionMatcher(core) {
+  const CacheKey = "collection-matcher";
+  return {
+    scan(config) {
+      const scanned = [];
+      function scan(name, collection) {
+        const patterns = getGlobPatterns(collection);
+        for (const dir of Array.isArray(collection.dir) ? collection.dir : [collection.dir]) {
+          scanned.push({
+            name,
+            collection,
+            matcher: picomatch(patterns, {
+              cwd: dir
+            })
+          });
+        }
+      }
+      for (const [name, collection] of config.collections) {
+        if (collection.type === "docs") {
+          scan(name, collection.meta);
+          scan(name, collection.docs);
+        } else {
+          scan(name, collection);
+        }
+      }
+      return scanned;
+    },
+    getFileCollection(file) {
+      const scanned = core.cache.get(CacheKey) ?? this.scan(core.getConfig());
+      core.cache.set(CacheKey, scanned);
+      for (const item of scanned) {
+        if (isFileSupported(file, item.collection) && item.matcher(file))
+          return { name: item.name, collection: item.collection };
+      }
+    }
+  };
+}
+async function getCollectionFiles(collection) {
+  const files = /* @__PURE__ */ new Map();
+  const dirs = Array.isArray(collection.dir) ? collection.dir : [collection.dir];
+  const patterns = getGlobPatterns(collection);
+  await Promise.all(
+    dirs.map(async (dir) => {
+      const result = await glob(patterns, {
+        cwd: path.resolve(dir)
+      });
+      for (const item of result) {
+        if (!isFileSupported(item, collection)) continue;
+        const fullPath = path.join(dir, item);
+        files.set(fullPath, {
+          path: item,
+          fullPath
+        });
+      }
+    })
+  );
+  return Array.from(files.values());
+}
+
+export {
+  getGlobPatterns,
+  createCollectionMatcher,
+  getCollectionFiles
+};

package/dist/{chunk-XV5Z4BFL.js → chunk-YVCR6FUH.js}

@@ -1,6 +1,6 @@
 import {
   ValidationError
-} from "./chunk-HI62EXSB.js";
+} from "./chunk-EELYB2XC.js";
 
 // src/loaders/adapter.ts
 import { fileURLToPath } from "url";

package/dist/config/index.d.cts

@@ -1,11 +1,11 @@
-export { A as AnyCollection, B as BaseCollection, C as CollectionSchema, D as DefaultMDXOptions, a as DocCollection, b as DocsCollection, G as GlobalConfig, M as MetaCollection, d as defineCollections, e as defineConfig, c as defineDocs, f as frontmatterSchema, g as getDefaultMDXOptions, m as metaSchema } from '../define-BCNh3n4O.cjs';
+export { A as AnyCollection, B as BaseCollection, a as CollectionSchema, D as DefaultMDXOptions, b as DocCollection, c as DocsCollection, G as GlobalConfig, M as MetaCollection, P as PostprocessOptions, d as defineCollections, f as defineConfig, e as defineDocs, h as frontmatterSchema, g as getDefaultMDXOptions, m as metaSchema } from '../core-B6j6Fxse.cjs';
 import { Processor, Transformer } from 'unified';
 import { Root } from 'mdast';
-export { P as PostprocessOptions } from '../remark-postprocess-K233ZVBK.cjs';
 import '@standard-schema/spec';
 import 'fumadocs-core/mdx-plugins';
 import '@mdx-js/mdx';
 import 'zod';
+import 'chokidar';
 
 declare function remarkInclude(this: Processor): Transformer<Root, Root>;
 

package/dist/config/index.d.ts

@@ -1,11 +1,11 @@
-export { A as AnyCollection, B as BaseCollection, C as CollectionSchema, D as DefaultMDXOptions, a as DocCollection, b as DocsCollection, G as GlobalConfig, M as MetaCollection, d as defineCollections, e as defineConfig, c as defineDocs, f as frontmatterSchema, g as getDefaultMDXOptions, m as metaSchema } from '../define-bck_EB4t.js';
+export { A as AnyCollection, B as BaseCollection, a as CollectionSchema, D as DefaultMDXOptions, b as DocCollection, c as DocsCollection, G as GlobalConfig, M as MetaCollection, P as PostprocessOptions, d as defineCollections, f as defineConfig, e as defineDocs, h as frontmatterSchema, g as getDefaultMDXOptions, m as metaSchema } from '../core-B6j6Fxse.js';
 import { Processor, Transformer } from 'unified';
 import { Root } from 'mdast';
-export { P as PostprocessOptions } from '../remark-postprocess-K233ZVBK.js';
 import '@standard-schema/spec';
 import 'fumadocs-core/mdx-plugins';
 import '@mdx-js/mdx';
 import 'zod';
+import 'chokidar';
 
 declare function remarkInclude(this: Processor): Transformer<Root, Root>;
 

package/dist/{define-BCNh3n4O.d.cts → core-B6j6Fxse.d.cts}

@@ -3,7 +3,28 @@ import * as plugins from 'fumadocs-core/mdx-plugins';
 import { ProcessorOptions } from '@mdx-js/mdx';
 import { Pluggable } from 'unified';
 import { z } from 'zod';
-import { P as PostprocessOptions } from './remark-postprocess-K233ZVBK.cjs';
+import { FSWatcher } from 'chokidar';
+
+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;
+    /**
+     * store MDAST and export via `_mdast`.
+     */
+    includeMDAST?: boolean | {
+        removePosition?: boolean;
+    };
+}
 
 type ResolvePlugins = Pluggable[] | ((v: Pluggable[]) => Pluggable[]);
 type DefaultMDXOptions = Omit<NonNullable<ProcessorOptions>, 'rehypePlugins' | 'remarkPlugins' | '_ctx'> & {
@@ -23,6 +44,9 @@ type DefaultMDXOptions = Omit<NonNullable<ProcessorOptions>, 'rehypePlugins' | '
 };
 declare function getDefaultMDXOptions({ valueToExport, rehypeCodeOptions, remarkImageOptions, remarkHeadingOptions, remarkStructureOptions, remarkCodeTabOptions, remarkNpmOptions, _withoutBundler, ...mdxOptions }: DefaultMDXOptions): ProcessorOptions;
 
+/**
+ * Zod 4 schema
+ */
 declare const metaSchema: z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
     pages: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -31,6 +55,9 @@ declare const metaSchema: z.ZodObject<{
     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>;
@@ -39,42 +66,6 @@ declare const frontmatterSchema: z.ZodObject<{
     _openapi: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
 }, z.core.$strip>;
 
-interface LoadedConfig {
-    collections: Map<string, DocCollection | MetaCollection | DocsCollection>;
-    global: GlobalConfig;
-    getDefaultMDXOptions(mode?: 'default' | 'remote'): Promise<ProcessorOptions>;
-}
-
-type Awaitable<T> = T | Promise<T>;
-interface EmitEntry {
-    /**
-     * path relative to output directory
-     */
-    path: string;
-    content: string;
-}
-interface PluginContext {
-    environment: 'next' | 'vite';
-    configPath: string;
-    outDir: string;
-}
-interface Plugin {
-    /**
-     * on config loaded
-     */
-    config?: (this: PluginContext, config: LoadedConfig) => Awaitable<void | LoadedConfig>;
-    /**
-     * Generate files (e.g. types, index file, or JSON schemas)
-     */
-    emit?: (this: PluginContext) => EmitEntry[] | Promise<EmitEntry[]>;
-}
-type PluginOption = Awaitable<Plugin | Plugin[] | false>;
-declare function createPluginHandler(context: PluginContext, defaultPlugins?: PluginOption[]): {
-    init(config: LoadedConfig): Promise<LoadedConfig>;
-    emit(): Promise<EmitEntry[]>;
-    emitAndWrite(): Promise<void>;
-};
-
 type CollectionSchema<Schema extends StandardSchemaV1, Context> = Schema | ((ctx: Context) => Schema);
 type AnyCollection = DocsCollection | DocCollection | MetaCollection;
 interface BaseCollection {
@@ -152,4 +143,76 @@ declare function defineDocs<DocSchema extends StandardSchemaV1 = typeof frontmat
 }): DocsCollection<DocSchema, MetaSchema, Async>;
 declare function defineConfig(config?: GlobalConfig): GlobalConfig;
 
-export { type AnyCollection as A, type BaseCollection as B, type CollectionSchema as C, type DefaultMDXOptions as D, type EmitEntry as E, type GlobalConfig as G, type LoadedConfig as L, type MetaCollection as M, type Plugin as P, type DocCollection as a, type DocsCollection as b, defineDocs as c, defineCollections as d, defineConfig as e, frontmatterSchema as f, getDefaultMDXOptions as g, type PluginContext as h, type PluginOption as i, createPluginHandler as j, metaSchema as m };
+interface ConfigLoader {
+    getConfig: () => LoadedConfig | Promise<LoadedConfig>;
+}
+interface LoadedConfig {
+    collections: Map<string, DocCollection | MetaCollection | DocsCollection>;
+    global: GlobalConfig;
+    getDefaultMDXOptions(mode?: 'default' | 'remote'): Promise<ProcessorOptions>;
+}
+
+type Awaitable<T> = T | Promise<T>;
+interface EmitEntry {
+    /**
+     * path relative to output directory
+     */
+    path: string;
+    content: string;
+}
+interface PluginContext extends CoreOptions {
+    core: Core;
+}
+interface Plugin {
+    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>;
+}
+type PluginOption = Awaitable<Plugin | Plugin[] | 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 function createCore(options: CoreOptions, defaultPlugins?: PluginOption[]): {
+    _options: CoreOptions;
+    getPluginContext(): PluginContext;
+    /**
+     * Convenient cache store, reset when config changes
+     */
+    cache: Map<string, unknown>;
+    init({ config: newConfig }: {
+        config: Awaitable<LoadedConfig>;
+    }): Promise</*elided*/ any>;
+    getConfig(): LoadedConfig;
+    creatConfigLoader(): ConfigLoader;
+    initServer(server: ServerContext): Promise<void>;
+    emitAndWrite({ filterPlugin, }?: EmitOptions): Promise<void>;
+};
+type Core = ReturnType<typeof createCore>;
+
+export { type AnyCollection as A, type BaseCollection as B, type CoreOptions as C, type DefaultMDXOptions as D, type ExtractedReference as E, type GlobalConfig as G, type LoadedConfig as L, type MetaCollection as M, type PostprocessOptions as P, type ServerContext as S, type CollectionSchema as a, type DocCollection as b, type DocsCollection as c, defineCollections as d, defineDocs as e, defineConfig as f, getDefaultMDXOptions as g, frontmatterSchema as h, type Plugin as i, type EmitEntry as j, type PluginContext as k, type PluginOption as l, metaSchema as m, type EmitOptions as n, createCore as o, type Core as p };

package/dist/{define-bck_EB4t.d.ts → core-B6j6Fxse.d.ts}

@@ -3,7 +3,28 @@ import * as plugins from 'fumadocs-core/mdx-plugins';
 import { ProcessorOptions } from '@mdx-js/mdx';
 import { Pluggable } from 'unified';
 import { z } from 'zod';
-import { P as PostprocessOptions } from './remark-postprocess-K233ZVBK.js';
+import { FSWatcher } from 'chokidar';
+
+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;
+    /**
+     * store MDAST and export via `_mdast`.
+     */
+    includeMDAST?: boolean | {
+        removePosition?: boolean;
+    };
+}
 
 type ResolvePlugins = Pluggable[] | ((v: Pluggable[]) => Pluggable[]);
 type DefaultMDXOptions = Omit<NonNullable<ProcessorOptions>, 'rehypePlugins' | 'remarkPlugins' | '_ctx'> & {
@@ -23,6 +44,9 @@ type DefaultMDXOptions = Omit<NonNullable<ProcessorOptions>, 'rehypePlugins' | '
 };
 declare function getDefaultMDXOptions({ valueToExport, rehypeCodeOptions, remarkImageOptions, remarkHeadingOptions, remarkStructureOptions, remarkCodeTabOptions, remarkNpmOptions, _withoutBundler, ...mdxOptions }: DefaultMDXOptions): ProcessorOptions;
 
+/**
+ * Zod 4 schema
+ */
 declare const metaSchema: z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
     pages: z.ZodOptional<z.ZodArray<z.ZodString>>;
@@ -31,6 +55,9 @@ declare const metaSchema: z.ZodObject<{
     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>;
@@ -39,42 +66,6 @@ declare const frontmatterSchema: z.ZodObject<{
     _openapi: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
 }, z.core.$strip>;
 
-interface LoadedConfig {
-    collections: Map<string, DocCollection | MetaCollection | DocsCollection>;
-    global: GlobalConfig;
-    getDefaultMDXOptions(mode?: 'default' | 'remote'): Promise<ProcessorOptions>;
-}
-
-type Awaitable<T> = T | Promise<T>;
-interface EmitEntry {
-    /**
-     * path relative to output directory
-     */
-    path: string;
-    content: string;
-}
-interface PluginContext {
-    environment: 'next' | 'vite';
-    configPath: string;
-    outDir: string;
-}
-interface Plugin {
-    /**
-     * on config loaded
-     */
-    config?: (this: PluginContext, config: LoadedConfig) => Awaitable<void | LoadedConfig>;
-    /**
-     * Generate files (e.g. types, index file, or JSON schemas)
-     */
-    emit?: (this: PluginContext) => EmitEntry[] | Promise<EmitEntry[]>;
-}
-type PluginOption = Awaitable<Plugin | Plugin[] | false>;
-declare function createPluginHandler(context: PluginContext, defaultPlugins?: PluginOption[]): {
-    init(config: LoadedConfig): Promise<LoadedConfig>;
-    emit(): Promise<EmitEntry[]>;
-    emitAndWrite(): Promise<void>;
-};
-
 type CollectionSchema<Schema extends StandardSchemaV1, Context> = Schema | ((ctx: Context) => Schema);
 type AnyCollection = DocsCollection | DocCollection | MetaCollection;
 interface BaseCollection {
@@ -152,4 +143,76 @@ declare function defineDocs<DocSchema extends StandardSchemaV1 = typeof frontmat
 }): DocsCollection<DocSchema, MetaSchema, Async>;
 declare function defineConfig(config?: GlobalConfig): GlobalConfig;
 
-export { type AnyCollection as A, type BaseCollection as B, type CollectionSchema as C, type DefaultMDXOptions as D, type EmitEntry as E, type GlobalConfig as G, type LoadedConfig as L, type MetaCollection as M, type Plugin as P, type DocCollection as a, type DocsCollection as b, defineDocs as c, defineCollections as d, defineConfig as e, frontmatterSchema as f, getDefaultMDXOptions as g, type PluginContext as h, type PluginOption as i, createPluginHandler as j, metaSchema as m };
+interface ConfigLoader {
+    getConfig: () => LoadedConfig | Promise<LoadedConfig>;
+}
+interface LoadedConfig {
+    collections: Map<string, DocCollection | MetaCollection | DocsCollection>;
+    global: GlobalConfig;
+    getDefaultMDXOptions(mode?: 'default' | 'remote'): Promise<ProcessorOptions>;
+}
+
+type Awaitable<T> = T | Promise<T>;
+interface EmitEntry {
+    /**
+     * path relative to output directory
+     */
+    path: string;
+    content: string;
+}
+interface PluginContext extends CoreOptions {
+    core: Core;
+}
+interface Plugin {
+    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>;
+}
+type PluginOption = Awaitable<Plugin | Plugin[] | 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 function createCore(options: CoreOptions, defaultPlugins?: PluginOption[]): {
+    _options: CoreOptions;
+    getPluginContext(): PluginContext;
+    /**
+     * Convenient cache store, reset when config changes
+     */
+    cache: Map<string, unknown>;
+    init({ config: newConfig }: {
+        config: Awaitable<LoadedConfig>;
+    }): Promise</*elided*/ any>;
+    getConfig(): LoadedConfig;
+    creatConfigLoader(): ConfigLoader;
+    initServer(server: ServerContext): Promise<void>;
+    emitAndWrite({ filterPlugin, }?: EmitOptions): Promise<void>;
+};
+type Core = ReturnType<typeof createCore>;
+
+export { type AnyCollection as A, type BaseCollection as B, type CoreOptions as C, type DefaultMDXOptions as D, type ExtractedReference as E, type GlobalConfig as G, type LoadedConfig as L, type MetaCollection as M, type PostprocessOptions as P, type ServerContext as S, type CollectionSchema as a, type DocCollection as b, type DocsCollection as c, defineCollections as d, defineDocs as e, defineConfig as f, getDefaultMDXOptions as g, frontmatterSchema as h, type Plugin as i, type EmitEntry as j, type PluginContext as k, type PluginOption as l, metaSchema as m, type EmitOptions as n, createCore as o, type Core as p };

package/dist/index.d.cts

@@ -1,10 +1,15 @@
 import { StructuredData } from 'fumadocs-core/mdx-plugins';
 import { TOCItemType } from 'fumadocs-core/toc';
 import { MDXContent } from 'mdx/types';
-import { E as ExtractedReference } from './remark-postprocess-K233ZVBK.cjs';
+import { E as ExtractedReference } from './core-B6j6Fxse.cjs';
+export { p as Core, C as CoreOptions, j as EmitEntry, n as EmitOptions, i as Plugin, k as PluginContext, l as PluginOption, S as ServerContext, o as createCore } from './core-B6j6Fxse.cjs';
 import { Root } from 'mdast';
-import { C as CompiledMDXProperties } from './build-mdx-BHG-_uxo.cjs';
+import { C as CompiledMDXProperties } from './build-mdx-D-r3_eQL.cjs';
+import '@standard-schema/spec';
 import '@mdx-js/mdx';
+import 'unified';
+import 'zod';
+import 'chokidar';
 import 'react';
 
 interface FileInfo {

package/dist/index.d.ts

@@ -1,10 +1,15 @@
 import { StructuredData } from 'fumadocs-core/mdx-plugins';
 import { TOCItemType } from 'fumadocs-core/toc';
 import { MDXContent } from 'mdx/types';
-import { E as ExtractedReference } from './remark-postprocess-K233ZVBK.js';
+import { E as ExtractedReference } from './core-B6j6Fxse.js';
+export { p as Core, C as CoreOptions, j as EmitEntry, n as EmitOptions, i as Plugin, k as PluginContext, l as PluginOption, S as ServerContext, o as createCore } from './core-B6j6Fxse.js';
 import { Root } from 'mdast';
-import { C as CompiledMDXProperties } from './build-mdx-CzrQDBRZ.js';
+import { C as CompiledMDXProperties } from './build-mdx-CCNr86q6.js';
+import '@standard-schema/spec';
 import '@mdx-js/mdx';
+import 'unified';
+import 'zod';
+import 'chokidar';
 import 'react';
 
 interface FileInfo {