fumadocs-mdx 11.9.1 → 11.10.1

package/dist/bun/index.d.cts

@@ -0,0 +1,8 @@
+import { BunPlugin } from 'bun';
+
+interface MdxPluginOptions {
+    configPath?: string;
+}
+declare function createMdxPlugin(options?: MdxPluginOptions): BunPlugin;
+
+export { type MdxPluginOptions, createMdxPlugin };

package/dist/bun/index.d.ts

@@ -0,0 +1,8 @@
+import { BunPlugin } from 'bun';
+
+interface MdxPluginOptions {
+    configPath?: string;
+}
+declare function createMdxPlugin(options?: MdxPluginOptions): BunPlugin;
+
+export { type MdxPluginOptions, createMdxPlugin };

package/dist/bun/index.js

@@ -0,0 +1,53 @@
+import {
+  createMdxLoader,
+  resolvedConfig
+} from "../chunk-QJCCVMBJ.js";
+import "../chunk-QQWCBFFE.js";
+import "../chunk-SVTXMVLQ.js";
+import "../chunk-IQAEAI4P.js";
+import {
+  findConfigFile
+} from "../chunk-766EAFX6.js";
+import {
+  buildConfig
+} from "../chunk-QVZ7JH4H.js";
+import "../chunk-VWJKRQZR.js";
+
+// src/bun/index.ts
+import { parse } from "querystring";
+import { pathToFileURL } from "url";
+function createMdxPlugin(options = {}) {
+  const { configPath = findConfigFile() } = options;
+  async function getMdxLoader() {
+    const importPath = pathToFileURL(configPath).href;
+    const out = buildConfig(await import(importPath));
+    return createMdxLoader(resolvedConfig(out));
+  }
+  return {
+    name: "bun-plugin-fumadocs-mdx",
+    setup(build) {
+      const mdxLoader = getMdxLoader();
+      build.onLoad({ filter: /\.mdx(\?.+?)?$/ }, async (args) => {
+        const [filePath, query] = args.path.split("?", 2);
+        const content = await Bun.file(filePath).text();
+        const result = await (await mdxLoader)({
+          source: content,
+          query: parse(query),
+          filePath,
+          development: false,
+          compiler: {
+            addDependency() {
+            }
+          }
+        });
+        return {
+          contents: result.code,
+          loader: "js"
+        };
+      });
+    }
+  };
+}
+export {
+  createMdxPlugin
+};

package/dist/chunk-6Y5JDZHD.js

@@ -0,0 +1,65 @@
+// src/utils/import-formatter.ts
+import path from "path";
+function getImportCode(info) {
+  const specifier = JSON.stringify(info.specifier);
+  if (info.type === "default") return `import ${info.name} from ${specifier}`;
+  if (info.type === "namespace")
+    return `import * as ${info.name} from ${specifier}`;
+  if (info.type === "named") {
+    const names = info.names.map(
+      (name) => Array.isArray(name) ? `${name[0]} as ${name[1]}` : name
+    );
+    return `import { ${names.join(", ")} } from ${specifier}`;
+  }
+  return `import ${specifier}`;
+}
+function toImportPath(file, config) {
+  const ext = path.extname(file);
+  let filename;
+  if (ext === ".ts" && config.jsExtension) {
+    filename = file.substring(0, file.length - ext.length) + ".js";
+  } else if (ext === ".ts") {
+    filename = file.substring(0, file.length - ext.length);
+  } else {
+    filename = file;
+  }
+  let importPath;
+  if ("relativeTo" in config) {
+    importPath = path.relative(config.relativeTo, filename);
+    if (!path.isAbsolute(importPath) && !importPath.startsWith(".")) {
+      importPath = `./${importPath}`;
+    }
+  } else {
+    importPath = path.resolve(filename);
+  }
+  return importPath.replaceAll(path.sep, "/");
+}
+function ident(code, tab = 1) {
+  return code.split("\n").map((v) => "  ".repeat(tab) + v).join("\n");
+}
+
+// src/utils/collections.ts
+function getSupportedFormats(collection) {
+  return {
+    doc: ["mdx", "md"],
+    meta: ["json", "yaml"]
+  }[collection.type];
+}
+function getGlobPatterns(collection) {
+  if (collection.files) return collection.files;
+  return [`**/*.{${getSupportedFormats(collection).join(",")}}`];
+}
+function isFileSupported(filePath, collection) {
+  for (const format of getSupportedFormats(collection)) {
+    if (filePath.endsWith(`.${format}`)) return true;
+  }
+  return false;
+}
+
+export {
+  getImportCode,
+  toImportPath,
+  ident,
+  getGlobPatterns,
+  isFileSupported
+};

package/dist/chunk-CNKI574E.js

@@ -0,0 +1,82 @@
+import {
+  ValidationError
+} from "./chunk-IQAEAI4P.js";
+
+// src/loaders/adapter.ts
+import { fileURLToPath } from "url";
+import fs from "fs/promises";
+import { parse } from "querystring";
+import path from "path";
+function toNode(loader, filterByPath) {
+  return async (url, _context, nextLoad) => {
+    if (!url.startsWith("file:///")) return nextLoad(url);
+    const parsedUrl = new URL(url);
+    const filePath = fileURLToPath(parsedUrl);
+    if (filterByPath(filePath)) {
+      const source = (await fs.readFile(filePath)).toString();
+      const result = await loader({
+        filePath,
+        query: Object.fromEntries(parsedUrl.searchParams.entries()),
+        source,
+        development: false,
+        compiler: {
+          addDependency() {
+          }
+        }
+      });
+      return {
+        source: result.code,
+        format: "module",
+        shortCircuit: true
+      };
+    }
+    return nextLoad(url);
+  };
+}
+function toVite(loader) {
+  return async function(file, query, value) {
+    const result = await loader({
+      filePath: file,
+      query: parse(query),
+      source: value,
+      development: this.environment.mode === "dev",
+      compiler: {
+        addDependency: (file2) => {
+          this.addWatchFile(file2);
+        }
+      }
+    });
+    return {
+      code: result.code,
+      map: result.map
+    };
+  };
+}
+function toWebpack(loader) {
+  return async function(source, callback) {
+    try {
+      const result = await loader({
+        filePath: this.resourcePath,
+        query: parse(this.resourceQuery),
+        source,
+        development: this.mode === "development",
+        compiler: this
+      });
+      callback(void 0, result.code, result.map);
+    } catch (error) {
+      if (error instanceof ValidationError) {
+        return callback(new Error(error.toStringFormatted()));
+      }
+      if (!(error instanceof Error)) throw error;
+      const fpath = path.relative(this.context, this.resourcePath);
+      error.message = `${fpath}:${error.name}: ${error.message}`;
+      callback(error);
+    }
+  };
+}
+
+export {
+  toNode,
+  toVite,
+  toWebpack
+};

package/dist/{chunk-GX3THK2Q.js → chunk-IQAEAI4P.js}

@@ -1,26 +1,3 @@
-// src/utils/git-timestamp.ts
-import path from "path";
-import { x } from "tinyexec";
-var cache = /* @__PURE__ */ new Map();
-async function getGitTimestamp(file) {
-  const cached = cache.get(file);
-  if (cached) return cached;
-  try {
-    const out = await x(
-      "git",
-      ["log", "-1", '--pretty="%ai"', path.relative(process.cwd(), file)],
-      {
-        throwOnError: true
-      }
-    );
-    const time = new Date(out.stdout);
-    cache.set(file, time);
-    return time;
-  } catch {
-    return;
-  }
-}
-
 // src/utils/validation.ts
 import picocolors from "picocolors";
 var ValidationError = class extends Error {
@@ -59,8 +36,31 @@ async function validate(schema, data, context, errorMessage) {
   return data;
 }
 
+// src/utils/git-timestamp.ts
+import path from "path";
+import { x } from "tinyexec";
+var cache = /* @__PURE__ */ new Map();
+async function getGitTimestamp(file) {
+  const cached = cache.get(file);
+  if (cached) return cached;
+  try {
+    const out = await x(
+      "git",
+      ["log", "-1", '--pretty="%ai"', path.relative(process.cwd(), file)],
+      {
+        throwOnError: true
+      }
+    );
+    const time = new Date(out.stdout);
+    cache.set(file, time);
+    return time;
+  } catch {
+    return;
+  }
+}
+
 export {
-  getGitTimestamp,
   ValidationError,
-  validate
+  validate,
+  getGitTimestamp
 };

package/dist/chunk-QJCCVMBJ.js

@@ -0,0 +1,151 @@
+import {
+  buildMDX
+} from "./chunk-QQWCBFFE.js";
+import {
+  getGitTimestamp,
+  validate
+} from "./chunk-IQAEAI4P.js";
+import {
+  getConfigHash,
+  loadConfig
+} from "./chunk-766EAFX6.js";
+import {
+  fumaMatter
+} from "./chunk-VWJKRQZR.js";
+
+// src/utils/count-lines.ts
+function countLines(s) {
+  let num = 0;
+  for (const c of s) {
+    if (c === "\n") num++;
+  }
+  return num;
+}
+
+// src/loaders/mdx.ts
+import { z } from "zod";
+import fs from "fs/promises";
+import path from "path";
+import { createHash } from "crypto";
+var querySchema = z.object({
+  only: z.literal(["frontmatter", "all"]).default("all"),
+  collection: z.string().optional(),
+  hash: z.string().describe(
+    "the hash of config, used for revalidation on Turbopack/Webpack."
+  ).optional()
+}).loose();
+var cacheEntry = z.object({
+  code: z.string(),
+  map: z.any().optional(),
+  hash: z.string().optional()
+});
+function createMdxLoader(configLoader) {
+  return async ({
+    source: value,
+    development: isDevelopment,
+    query,
+    compiler,
+    filePath
+  }) => {
+    const matter = fumaMatter(value);
+    const parsed = querySchema.parse(query);
+    const loaded = await configLoader.getConfig(parsed.hash);
+    const cacheDir = isDevelopment ? void 0 : loaded.global.experimentalBuildCache;
+    const cacheKey = `${parsed.hash}_${parsed.collection ?? "global"}_${generateCacheHash(filePath)}`;
+    if (cacheDir) {
+      const cached = await fs.readFile(path.join(cacheDir, cacheKey)).then((content) => cacheEntry.parse(JSON.parse(content.toString()))).catch(() => null);
+      if (cached && cached.hash === generateCacheHash(value)) return cached;
+    }
+    const collection = parsed.collection ? loaded.collections.get(parsed.collection) : void 0;
+    let schema;
+    let mdxOptions;
+    switch (collection?.type) {
+      case "doc":
+        mdxOptions = collection.mdxOptions;
+        schema = collection.schema;
+        break;
+      case "docs":
+        mdxOptions = collection.docs.mdxOptions;
+        schema = collection.docs.schema;
+        break;
+    }
+    if (schema) {
+      matter.data = await validate(
+        schema,
+        matter.data,
+        {
+          source: value,
+          path: filePath
+        },
+        `invalid frontmatter in ${filePath}`
+      );
+    }
+    if (parsed.only === "frontmatter") {
+      return {
+        code: `export const frontmatter = ${JSON.stringify(matter.data)}`,
+        map: null
+      };
+    }
+    const data = {};
+    if (loaded.global.lastModifiedTime === "git") {
+      data.lastModified = (await getGitTimestamp(filePath))?.getTime();
+    }
+    const lineOffset = isDevelopment ? countLines(matter.matter) : 0;
+    const compiled = await buildMDX(
+      `${parsed.hash ?? ""}:${parsed.collection ?? "global"}`,
+      "\n".repeat(lineOffset) + matter.content,
+      {
+        development: isDevelopment,
+        ...mdxOptions ?? await loaded.getDefaultMDXOptions(),
+        data,
+        filePath,
+        frontmatter: matter.data,
+        _compiler: compiler
+      }
+    );
+    const out = {
+      code: String(compiled.value),
+      map: compiled.map
+    };
+    if (cacheDir) {
+      await fs.mkdir(cacheDir, { recursive: true });
+      await fs.writeFile(
+        path.join(cacheDir, cacheKey),
+        JSON.stringify({
+          ...out,
+          hash: generateCacheHash(value)
+        })
+      );
+    }
+    return out;
+  };
+}
+function generateCacheHash(input) {
+  return createHash("md5").update(input).digest("hex");
+}
+
+// src/loaders/config-loader.ts
+function resolvedConfig(loaded) {
+  return {
+    getConfig() {
+      return loaded;
+    }
+  };
+}
+function dynamicConfig(configPath, outDir) {
+  return {
+    async getConfig(hash) {
+      return loadConfig(
+        configPath,
+        outDir,
+        hash ?? await getConfigHash(configPath)
+      );
+    }
+  };
+}
+
+export {
+  createMdxLoader,
+  resolvedConfig,
+  dynamicConfig
+};

package/dist/{chunk-NUDEC6C5.js → chunk-UOOPSLFY.js}

@@ -1,4 +1,4 @@
-// src/runtime/index.ts
+// src/runtime/next/index.ts
 import fs from "fs";
 var cache = /* @__PURE__ */ new Map();
 var _runtime = {

package/dist/{chunk-COQ4VMK2.js → chunk-XXSKWWMB.js}

@@ -1,42 +1,16 @@
-// src/utils/import-formatter.ts
+import {
+  getGlobPatterns,
+  ident,
+  toImportPath
+} from "./chunk-6Y5JDZHD.js";
+import {
+  findConfigFile,
+  loadConfig
+} from "./chunk-766EAFX6.js";
+
+// src/vite/postinstall.ts
+import fs from "fs/promises";
 import path from "path";
-function getImportCode(info) {
-  const specifier = JSON.stringify(info.specifier);
-  if (info.type === "default") return `import ${info.name} from ${specifier}`;
-  if (info.type === "namespace")
-    return `import * as ${info.name} from ${specifier}`;
-  if (info.type === "named") {
-    const names = info.names.map(
-      (name) => Array.isArray(name) ? `${name[0]} as ${name[1]}` : name
-    );
-    return `import { ${names.join(", ")} } from ${specifier}`;
-  }
-  return `import ${specifier}`;
-}
-function toImportPath(file, config) {
-  const ext = path.extname(file);
-  let filename;
-  if (ext === ".ts" && config.jsExtension) {
-    filename = file.substring(0, file.length - ext.length) + ".js";
-  } else if (ext === ".ts") {
-    filename = file.substring(0, file.length - ext.length);
-  } else {
-    filename = file;
-  }
-  let importPath;
-  if ("relativeTo" in config) {
-    importPath = path.relative(config.relativeTo, filename);
-    if (!path.isAbsolute(importPath) && !importPath.startsWith(".")) {
-      importPath = `./${importPath}`;
-    }
-  } else {
-    importPath = path.resolve(filename);
-  }
-  return importPath.replaceAll(path.sep, "/");
-}
-function ident(code, tab = 1) {
-  return code.split("\n").map((v) => "  ".repeat(tab) + v).join("\n");
-}
 
 // src/vite/generate-glob.ts
 function generateGlob(name, patterns, globOptions) {
@@ -69,24 +43,6 @@ function getGlobBase(collection) {
   return enforceRelative(dir);
 }
 
-// src/utils/collections.ts
-function getSupportedFormats(collection) {
-  return {
-    doc: ["mdx", "md"],
-    meta: ["json", "yaml"]
-  }[collection.type];
-}
-function getGlobPatterns(collection) {
-  if (collection.files) return collection.files;
-  return [`**/*.{${getSupportedFormats(collection).join(",")}}`];
-}
-function isFileSupported(filePath, collection) {
-  for (const format of getSupportedFormats(collection)) {
-    if (filePath.endsWith(`.${format}`)) return true;
-  }
-  return false;
-}
-
 // src/vite/generate.ts
 function docs(name, collection) {
   const obj = [
@@ -149,10 +105,21 @@ function entry(configPath, config, outDir, jsExtension) {
   return lines.join("\n");
 }
 
+// src/vite/postinstall.ts
+async function postInstall(configPath = findConfigFile(), outDir, addJsExtension = false) {
+  const config = await loadConfig(configPath, "node_modules", void 0, true);
+  const outFile = "source.generated.ts";
+  if (outDir) {
+    await fs.mkdir(outDir, { recursive: true });
+  }
+  await fs.writeFile(
+    outDir ? path.join(outDir, outFile) : outFile,
+    entry(configPath, config, outDir ?? process.cwd(), addJsExtension)
+  );
+  console.log("[MDX] types generated");
+}
+
 export {
-  getImportCode,
-  toImportPath,
-  getGlobPatterns,
-  isFileSupported,
-  entry
+  entry,
+  postInstall
 };

package/dist/config/index.d.cts

@@ -1,4 +1,4 @@
-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-DnJzAZrj.cjs';
+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-BH4bnHQl.cjs';
 import { Processor, Transformer } from 'unified';
 import { Root } from 'mdast';
 import '@standard-schema/spec';

package/dist/config/index.d.ts

@@ -1,4 +1,4 @@
-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-DnJzAZrj.js';
+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-BH4bnHQl.js';
 import { Processor, Transformer } from 'unified';
 import { Root } from 'mdast';
 import '@standard-schema/spec';

package/dist/config/zod-3.d.cts

@@ -1,5 +1,5 @@
 import { z } from 'zod/v3';
-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, g as getDefaultMDXOptions } from '../define-DnJzAZrj.cjs';
+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, g as getDefaultMDXOptions } from '../define-BH4bnHQl.cjs';
 export { Params, remarkInclude } from './index.cjs';
 import '@standard-schema/spec';
 import 'fumadocs-core/mdx-plugins';

package/dist/config/zod-3.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod/v3';
-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, g as getDefaultMDXOptions } from '../define-DnJzAZrj.js';
+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, g as getDefaultMDXOptions } from '../define-BH4bnHQl.js';
 export { Params, remarkInclude } from './index.js';
 import '@standard-schema/spec';
 import 'fumadocs-core/mdx-plugins';

package/dist/{define-DnJzAZrj.d.cts → define-BH4bnHQl.d.cts}

@@ -92,6 +92,12 @@ interface GlobalConfig {
      * @defaultValue 'none'
      */
     lastModifiedTime?: 'git' | 'none';
+    /**
+     * 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, Async extends boolean = false>(options: DocCollection<Schema, Async>): DocCollection<Schema, Async>;
 declare function defineCollections<Schema extends StandardSchemaV1 = StandardSchemaV1>(options: MetaCollection<Schema>): MetaCollection<Schema>;

package/dist/{define-DnJzAZrj.d.ts → define-BH4bnHQl.d.ts}

@@ -92,6 +92,12 @@ interface GlobalConfig {
      * @defaultValue 'none'
      */
     lastModifiedTime?: 'git' | 'none';
+    /**
+     * 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, Async extends boolean = false>(options: DocCollection<Schema, Async>): DocCollection<Schema, Async>;
 declare function defineCollections<Schema extends StandardSchemaV1 = StandardSchemaV1>(options: MetaCollection<Schema>): MetaCollection<Schema>;