fumadocs-mdx 11.3.1 → 11.4.0

package/dist/define-BB9hRiTI.d.cts

@@ -0,0 +1,106 @@
+import { z, ZodTypeAny } from 'zod';
+import { ProcessorOptions } from '@mdx-js/mdx';
+import { c as MDXOptions, B as BaseCollectionEntry, M as MarkdownProps, G as GlobalConfig } from './build-mdx-o0kbHSlp.cjs';
+
+declare const metaSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    pages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    description: z.ZodOptional<z.ZodString>;
+    root: z.ZodOptional<z.ZodBoolean>;
+    defaultOpen: z.ZodOptional<z.ZodBoolean>;
+    icon: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    root?: boolean | undefined;
+    title?: string | undefined;
+    icon?: string | undefined;
+    pages?: string[] | undefined;
+    description?: string | undefined;
+    defaultOpen?: boolean | undefined;
+}, {
+    root?: boolean | undefined;
+    title?: string | undefined;
+    icon?: string | undefined;
+    pages?: string[] | undefined;
+    description?: string | undefined;
+    defaultOpen?: boolean | undefined;
+}>;
+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<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    icon?: string | undefined;
+    description?: string | undefined;
+    full?: boolean | undefined;
+    _openapi?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    title: string;
+    icon?: string | undefined;
+    description?: string | undefined;
+    full?: boolean | undefined;
+    _openapi?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+}>;
+
+interface TransformContext {
+    path: string;
+    source: string;
+    /**
+     * Compile MDX to JavaScript
+     */
+    buildMDX: (source: string, options?: ProcessorOptions) => Promise<string>;
+}
+interface BaseCollection<Schema> {
+    /**
+     * Directories to scan
+     */
+    dir: string | string[];
+    /**
+     * what files to include/exclude (glob patterns)
+     *
+     * Include all files if not specified
+     */
+    files?: string[];
+    schema?: Schema | ((ctx: TransformContext) => Schema);
+}
+interface MetaCollection<Schema extends ZodTypeAny = ZodTypeAny> extends BaseCollection<Schema> {
+    type: 'meta';
+}
+interface DocCollection<Schema extends ZodTypeAny = ZodTypeAny, Async extends boolean = boolean> extends BaseCollection<Schema> {
+    type: 'doc';
+    mdxOptions?: MDXOptions;
+    /**
+     * Load files with async
+     */
+    async?: Async;
+}
+declare function defineCollections<T extends 'doc' | 'meta', Schema extends ZodTypeAny = ZodTypeAny, Async extends boolean = false>(options: {
+    type: T;
+} & (T extends 'doc' ? DocCollection<Schema, Async> : MetaCollection<Schema>)): {
+    _doc: 'collections';
+    type: T;
+    _type: {
+        async: Async;
+        runtime: T extends 'doc' ? Async extends true ? z.infer<Schema> & BaseCollectionEntry & {
+            load: () => Promise<MarkdownProps>;
+        } : Omit<MarkdownProps, keyof z.infer<Schema>> & z.infer<Schema> & BaseCollectionEntry : typeof options extends MetaCollection ? z.infer<Schema> & BaseCollectionEntry : never;
+    };
+};
+declare function defineDocs<DocData extends ZodTypeAny = typeof frontmatterSchema, MetaData extends ZodTypeAny = typeof metaSchema, DocAsync extends boolean = false>(options?: {
+    /**
+     * The directory to scan files
+     *
+     *  @defaultValue 'content/docs'
+     */
+    dir?: string | string[];
+    docs?: Partial<DocCollection<DocData, DocAsync>>;
+    meta?: Partial<MetaCollection<MetaData>>;
+}): {
+    docs: ReturnType<typeof defineCollections<'doc', DocData, DocAsync>>;
+    meta: ReturnType<typeof defineCollections<'meta', MetaData, false>>;
+};
+declare function defineConfig(config?: GlobalConfig): GlobalConfig;
+
+export { type BaseCollection as B, type DocCollection as D, type MetaCollection as M, type TransformContext as T, defineDocs as a, defineConfig as b, defineCollections as d, frontmatterSchema as f, metaSchema as m };

package/dist/define-D3l733EX.d.ts

@@ -0,0 +1,106 @@
+import { z, ZodTypeAny } from 'zod';
+import { ProcessorOptions } from '@mdx-js/mdx';
+import { c as MDXOptions, B as BaseCollectionEntry, M as MarkdownProps, G as GlobalConfig } from './build-mdx-o0kbHSlp.js';
+
+declare const metaSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    pages: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    description: z.ZodOptional<z.ZodString>;
+    root: z.ZodOptional<z.ZodBoolean>;
+    defaultOpen: z.ZodOptional<z.ZodBoolean>;
+    icon: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    root?: boolean | undefined;
+    title?: string | undefined;
+    icon?: string | undefined;
+    pages?: string[] | undefined;
+    description?: string | undefined;
+    defaultOpen?: boolean | undefined;
+}, {
+    root?: boolean | undefined;
+    title?: string | undefined;
+    icon?: string | undefined;
+    pages?: string[] | undefined;
+    description?: string | undefined;
+    defaultOpen?: boolean | undefined;
+}>;
+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<{}, "passthrough", z.ZodTypeAny, z.objectOutputType<{}, z.ZodTypeAny, "passthrough">, z.objectInputType<{}, z.ZodTypeAny, "passthrough">>>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    icon?: string | undefined;
+    description?: string | undefined;
+    full?: boolean | undefined;
+    _openapi?: z.objectOutputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+}, {
+    title: string;
+    icon?: string | undefined;
+    description?: string | undefined;
+    full?: boolean | undefined;
+    _openapi?: z.objectInputType<{}, z.ZodTypeAny, "passthrough"> | undefined;
+}>;
+
+interface TransformContext {
+    path: string;
+    source: string;
+    /**
+     * Compile MDX to JavaScript
+     */
+    buildMDX: (source: string, options?: ProcessorOptions) => Promise<string>;
+}
+interface BaseCollection<Schema> {
+    /**
+     * Directories to scan
+     */
+    dir: string | string[];
+    /**
+     * what files to include/exclude (glob patterns)
+     *
+     * Include all files if not specified
+     */
+    files?: string[];
+    schema?: Schema | ((ctx: TransformContext) => Schema);
+}
+interface MetaCollection<Schema extends ZodTypeAny = ZodTypeAny> extends BaseCollection<Schema> {
+    type: 'meta';
+}
+interface DocCollection<Schema extends ZodTypeAny = ZodTypeAny, Async extends boolean = boolean> extends BaseCollection<Schema> {
+    type: 'doc';
+    mdxOptions?: MDXOptions;
+    /**
+     * Load files with async
+     */
+    async?: Async;
+}
+declare function defineCollections<T extends 'doc' | 'meta', Schema extends ZodTypeAny = ZodTypeAny, Async extends boolean = false>(options: {
+    type: T;
+} & (T extends 'doc' ? DocCollection<Schema, Async> : MetaCollection<Schema>)): {
+    _doc: 'collections';
+    type: T;
+    _type: {
+        async: Async;
+        runtime: T extends 'doc' ? Async extends true ? z.infer<Schema> & BaseCollectionEntry & {
+            load: () => Promise<MarkdownProps>;
+        } : Omit<MarkdownProps, keyof z.infer<Schema>> & z.infer<Schema> & BaseCollectionEntry : typeof options extends MetaCollection ? z.infer<Schema> & BaseCollectionEntry : never;
+    };
+};
+declare function defineDocs<DocData extends ZodTypeAny = typeof frontmatterSchema, MetaData extends ZodTypeAny = typeof metaSchema, DocAsync extends boolean = false>(options?: {
+    /**
+     * The directory to scan files
+     *
+     *  @defaultValue 'content/docs'
+     */
+    dir?: string | string[];
+    docs?: Partial<DocCollection<DocData, DocAsync>>;
+    meta?: Partial<MetaCollection<MetaData>>;
+}): {
+    docs: ReturnType<typeof defineCollections<'doc', DocData, DocAsync>>;
+    meta: ReturnType<typeof defineCollections<'meta', MetaData, false>>;
+};
+declare function defineConfig(config?: GlobalConfig): GlobalConfig;
+
+export { type BaseCollection as B, type DocCollection as D, type MetaCollection as M, type TransformContext as T, defineDocs as a, defineConfig as b, defineCollections as d, frontmatterSchema as f, metaSchema as m };

package/dist/index.cjs

@@ -21,36 +21,11 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   createMDXSource: () => createMDXSource,
-  toRuntime: () => toRuntime,
-  toRuntimeAsync: () => toRuntimeAsync
+  resolveFiles: () => resolveFiles,
+  toRuntime: () => toRuntime
 });
 module.exports = __toCommonJS(index_exports);
 
-// src/runtime/resolve-files.ts
-function resolveFiles({
-  docs,
-  meta,
-  rootDir = ""
-}) {
-  const outputs = [];
-  for (const entry of docs) {
-    if (!entry._file.path.startsWith(rootDir)) continue;
-    outputs.push({
-      type: "page",
-      path: entry._file.path,
-      data: entry
-    });
-  }
-  for (const entry of meta) {
-    outputs.push({
-      type: "meta",
-      path: entry._file.path,
-      data: entry
-    });
-  }
-  return outputs;
-}
-
 // src/runtime/index.ts
 function toRuntime(type, file, info) {
   if (type === "doc") {
@@ -68,19 +43,6 @@ function toRuntime(type, file, info) {
     _file: info
   };
 }
-function toRuntimeAsync(frontmatter, load, info) {
-  return {
-    async load() {
-      const { default: body, ...res } = await load();
-      return {
-        body,
-        ...res
-      };
-    },
-    ...frontmatter,
-    _file: info
-  };
-}
 function createMDXSource(docs, meta = []) {
   return {
     files: (rootDir) => resolveFiles({
@@ -90,9 +52,32 @@ function createMDXSource(docs, meta = []) {
     })
   };
 }
+function resolveFiles({
+  docs,
+  meta,
+  rootDir = ""
+}) {
+  const outputs = [];
+  for (const entry of docs) {
+    if (!entry._file.path.startsWith(rootDir)) continue;
+    outputs.push({
+      type: "page",
+      path: entry._file.path,
+      data: entry
+    });
+  }
+  for (const entry of meta) {
+    outputs.push({
+      type: "meta",
+      path: entry._file.path,
+      data: entry
+    });
+  }
+  return outputs;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createMDXSource,
-  toRuntime,
-  toRuntimeAsync
+  resolveFiles,
+  toRuntime
 });

package/dist/index.d.cts

@@ -1,17 +1,23 @@
-import { PageData, MetaData, Source } from 'fumadocs-core/source';
-import { F as FileInfo, B as BaseCollectionEntry } from './build-mdx-C2hor32E.cjs';
+import { PageData, MetaData, Source, VirtualFile } from 'fumadocs-core/source';
+import { F as FileInfo, B as BaseCollectionEntry } from './build-mdx-o0kbHSlp.cjs';
 import 'zod';
 import 'mdx/types';
 import 'fumadocs-core/mdx-plugins';
 import 'fumadocs-core/server';
 import '@mdx-js/mdx';
 import 'unified';
+import 'react';
 
 declare function toRuntime(type: 'doc' | 'meta', file: Record<string, unknown>, info: FileInfo): unknown;
-declare function toRuntimeAsync(frontmatter: Record<string, unknown>, load: () => Promise<Record<string, unknown>>, info: FileInfo): unknown;
 declare function createMDXSource<Doc extends PageData & BaseCollectionEntry, Meta extends MetaData & BaseCollectionEntry>(docs: Doc[], meta?: Meta[]): Source<{
     pageData: Doc;
     metaData: Meta;
 }>;
+interface ResolveOptions {
+    docs: BaseCollectionEntry[];
+    meta: BaseCollectionEntry[];
+    rootDir?: string;
+}
+declare function resolveFiles({ docs, meta, rootDir, }: ResolveOptions): VirtualFile[];
 
-export { createMDXSource, toRuntime, toRuntimeAsync };
+export { createMDXSource, resolveFiles, toRuntime };

package/dist/index.d.ts

@@ -1,17 +1,23 @@
-import { PageData, MetaData, Source } from 'fumadocs-core/source';
-import { F as FileInfo, B as BaseCollectionEntry } from './build-mdx-C2hor32E.js';
+import { PageData, MetaData, Source, VirtualFile } from 'fumadocs-core/source';
+import { F as FileInfo, B as BaseCollectionEntry } from './build-mdx-o0kbHSlp.js';
 import 'zod';
 import 'mdx/types';
 import 'fumadocs-core/mdx-plugins';
 import 'fumadocs-core/server';
 import '@mdx-js/mdx';
 import 'unified';
+import 'react';
 
 declare function toRuntime(type: 'doc' | 'meta', file: Record<string, unknown>, info: FileInfo): unknown;
-declare function toRuntimeAsync(frontmatter: Record<string, unknown>, load: () => Promise<Record<string, unknown>>, info: FileInfo): unknown;
 declare function createMDXSource<Doc extends PageData & BaseCollectionEntry, Meta extends MetaData & BaseCollectionEntry>(docs: Doc[], meta?: Meta[]): Source<{
     pageData: Doc;
     metaData: Meta;
 }>;
+interface ResolveOptions {
+    docs: BaseCollectionEntry[];
+    meta: BaseCollectionEntry[];
+    rootDir?: string;
+}
+declare function resolveFiles({ docs, meta, rootDir, }: ResolveOptions): VirtualFile[];
 
-export { createMDXSource, toRuntime, toRuntimeAsync };
+export { createMDXSource, resolveFiles, toRuntime };

package/dist/index.js

@@ -1,28 +1,3 @@
-// src/runtime/resolve-files.ts
-function resolveFiles({
-  docs,
-  meta,
-  rootDir = ""
-}) {
-  const outputs = [];
-  for (const entry of docs) {
-    if (!entry._file.path.startsWith(rootDir)) continue;
-    outputs.push({
-      type: "page",
-      path: entry._file.path,
-      data: entry
-    });
-  }
-  for (const entry of meta) {
-    outputs.push({
-      type: "meta",
-      path: entry._file.path,
-      data: entry
-    });
-  }
-  return outputs;
-}
-
 // src/runtime/index.ts
 function toRuntime(type, file, info) {
   if (type === "doc") {
@@ -40,19 +15,6 @@ function toRuntime(type, file, info) {
     _file: info
   };
 }
-function toRuntimeAsync(frontmatter, load, info) {
-  return {
-    async load() {
-      const { default: body, ...res } = await load();
-      return {
-        body,
-        ...res
-      };
-    },
-    ...frontmatter,
-    _file: info
-  };
-}
 function createMDXSource(docs, meta = []) {
   return {
     files: (rootDir) => resolveFiles({
@@ -62,8 +24,31 @@ function createMDXSource(docs, meta = []) {
     })
   };
 }
+function resolveFiles({
+  docs,
+  meta,
+  rootDir = ""
+}) {
+  const outputs = [];
+  for (const entry of docs) {
+    if (!entry._file.path.startsWith(rootDir)) continue;
+    outputs.push({
+      type: "page",
+      path: entry._file.path,
+      data: entry
+    });
+  }
+  for (const entry of meta) {
+    outputs.push({
+      type: "meta",
+      path: entry._file.path,
+      data: entry
+    });
+  }
+  return outputs;
+}
 export {
   createMDXSource,
-  toRuntime,
-  toRuntimeAsync
+  resolveFiles,
+  toRuntime
 };

package/dist/loader-mdx.cjs

@@ -100,6 +100,7 @@ function getDefaultMDXOptions({
   remarkImageOptions,
   remarkHeadingOptions,
   remarkStructureOptions,
+  remarkCodeTabOptions,
   ...mdxOptions
 }) {
   const mdxExports = [
@@ -110,18 +111,20 @@ function getDefaultMDXOptions({
   ];
   const remarkPlugins = pluginOption(
     (v) => [
-      import_mdx_plugins.remarkGfm,
+      plugins.remarkGfm,
       [
-        import_mdx_plugins.remarkHeading,
+        plugins.remarkHeading,
         {
           generateToc: false,
           ...remarkHeadingOptions
         }
       ],
-      remarkImageOptions !== false && [import_mdx_plugins.remarkImage, remarkImageOptions],
+      remarkImageOptions !== false && [plugins.remarkImage, remarkImageOptions],
+      // Fumadocs 14 compatibility
+      "remarkCodeTab" in plugins && remarkCodeTabOptions !== false && plugins.remarkCodeTab,
       ...v,
       remarkStructureOptions !== false && [
-        import_mdx_plugins.remarkStructure,
+        plugins.remarkStructure,
         remarkStructureOptions
       ],
       [remarkMdxExport, { values: mdxExports }]
@@ -130,9 +133,9 @@ function getDefaultMDXOptions({
   );
   const rehypePlugins = pluginOption(
     (v) => [
-      rehypeCodeOptions !== false && [import_mdx_plugins.rehypeCode, rehypeCodeOptions],
+      rehypeCodeOptions !== false && [plugins.rehypeCode, rehypeCodeOptions],
       ...v,
-      [import_mdx_plugins.rehypeToc]
+      [plugins.rehypeToc]
     ],
     mdxOptions.rehypePlugins
   );
@@ -142,11 +145,11 @@ function getDefaultMDXOptions({
     rehypePlugins
   };
 }
-var import_mdx_plugins;
+var plugins;
 var init_mdx_options = __esm({
   "src/utils/mdx-options.ts"() {
     "use strict";
-    import_mdx_plugins = require("fumadocs-core/mdx-plugins");
+    plugins = __toESM(require("fumadocs-core/mdx-plugins"), 1);
     init_remark_exports();
   }
 });
@@ -161,41 +164,15 @@ var path4 = __toESM(require("path"), 1);
 var import_node_querystring = require("querystring");
 var import_gray_matter2 = __toESM(require("gray-matter"), 1);
 
-// src/config/cached.ts
+// src/utils/config-cache.ts
 var import_node_crypto = require("crypto");
 var fs = __toESM(require("fs"), 1);
 
-// src/config/load.ts
+// src/utils/load-config.ts
 var path = __toESM(require("path"), 1);
 var import_node_url = require("url");
-async function loadConfig(configPath) {
-  const { build } = await import("esbuild");
-  const url = (0, import_node_url.pathToFileURL)(path.resolve(".source/source.config.mjs"));
-  const transformed = await build({
-    entryPoints: [{ in: configPath, out: "source.config" }],
-    bundle: true,
-    outdir: ".source",
-    target: "node18",
-    write: true,
-    platform: "node",
-    format: "esm",
-    packages: "external",
-    outExtension: {
-      ".js": ".mjs"
-    },
-    allowOverwrite: true
-  });
-  if (transformed.errors.length > 0) {
-    throw new Error("failed to compile configuration file");
-  }
-  const loaded = await import(`${url.href}?hash=${Date.now().toString()}`);
-  const [err, config] = buildConfig(
-    // every call to `loadConfig` will cause the previous cache to be ignored
-    loaded
-  );
-  if (err !== null) throw new Error(err);
-  return config;
-}
+
+// src/config/build.ts
 function buildConfig(config) {
   const collections = /* @__PURE__ */ new Map();
   let globalConfig;
@@ -243,7 +220,37 @@ function buildConfig(config) {
   ];
 }
 
-// src/config/cached.ts
+// src/utils/load-config.ts
+async function loadConfig(configPath) {
+  const { build } = await import("esbuild");
+  const url = (0, import_node_url.pathToFileURL)(path.resolve(".source/source.config.mjs"));
+  const transformed = await build({
+    entryPoints: [{ in: configPath, out: "source.config" }],
+    bundle: true,
+    outdir: ".source",
+    target: "node18",
+    write: true,
+    platform: "node",
+    format: "esm",
+    packages: "external",
+    outExtension: {
+      ".js": ".mjs"
+    },
+    allowOverwrite: true
+  });
+  if (transformed.errors.length > 0) {
+    throw new Error("failed to compile configuration file");
+  }
+  const loaded = await import(`${url.href}?hash=${Date.now().toString()}`);
+  const [err, config] = buildConfig(
+    // every call to `loadConfig` will cause the previous cache to be ignored
+    loaded
+  );
+  if (err !== null) throw new Error(err);
+  return config;
+}
+
+// src/utils/config-cache.ts
 var cache = /* @__PURE__ */ new Map();
 async function loadConfigCached(configPath, hash) {
   const cached = cache.get(configPath);
@@ -356,11 +363,11 @@ function buildMDX(group, configHash, source, options = {}) {
 
 // src/utils/format-error.ts
 function formatError(message, error) {
-  const lines = [];
+  const lines2 = [];
   function walk(key, { _errors, ...rest }, padStart = 0) {
     if (key !== void 0 || _errors.length > 0) {
       const text = key ? `${key}: ${_errors.join("\n    ")}` : _errors.join("\n");
-      lines.push(
+      lines2.push(
         text.split("\n").map((line) => `${" ".repeat(padStart)}${line}`).join("\n")
       );
     }
@@ -369,7 +376,7 @@ function formatError(message, error) {
     }
   }
   walk(void 0, error.format());
-  return [message, ...lines].join("\n");
+  return [message, ...lines2].join("\n");
 }
 
 // src/utils/git-timestamp.ts
@@ -426,7 +433,6 @@ async function loader(source, callback) {
     collection = void 0;
   }
   const mdxOptions = collection?.mdxOptions ?? await config.getDefaultMDXOptions();
-  let frontmatter = matter2.data;
   if (collection?.schema) {
     let schema = collection.schema;
     if (typeof schema === "function") {
@@ -444,7 +450,7 @@ async function loader(source, callback) {
         path: filePath
       });
     }
-    const result = await schema.safeParseAsync(frontmatter);
+    const result = await schema.safeParseAsync(matter2.data);
     if (result.error) {
       callback(
         new Error(
@@ -453,21 +459,24 @@ async function loader(source, callback) {
       );
       return;
     }
-    frontmatter = result.data;
+    matter2.data = result.data;
   }
   let timestamp;
   if (config.global?.lastModifiedTime === "git")
     timestamp = (await getGitTimestamp(filePath))?.getTime();
   try {
+    const lineOffset = "\n".repeat(
+      this.mode === "development" ? lines(source) - lines(matter2.content) : 0
+    );
     const file = await buildMDX(
       collectionId ?? "global",
       configHash,
-      matter2.content,
+      lineOffset + matter2.content,
       {
         development: this.mode === "development",
         ...mdxOptions,
         filePath,
-        frontmatter,
+        frontmatter: matter2.data,
         data: {
           lastModified: timestamp
         },
@@ -482,3 +491,10 @@ async function loader(source, callback) {
     callback(error);
   }
 }
+function lines(s) {
+  let num = 0;
+  for (const c of s) {
+    if (c === "\n") num++;
+  }
+  return num;
+}