fumadocs-mdx 11.10.1 → 12.0.1

package/dist/runtime/vite/server.js

@@ -3,50 +3,88 @@ import {
   fromConfigBase,
   toClientRenderer
 } from "../../chunk-46UPKP5R.js";
+import {
+  missingProcessedMarkdown
+} from "../../chunk-ZLCSVXCD.js";
 
 // src/runtime/vite/server.ts
 import * as path from "path";
+import fs from "fs/promises";
 function fromConfig() {
   const base = fromConfigBase();
-  function mapPageData(entry) {
-    const { toc, structuredData, lastModified, frontmatter } = entry;
+  function fileInfo(file, base2) {
+    return {
+      path: file,
+      fullPath: path.join(base2, file)
+    };
+  }
+  function mapDocData(entry) {
     return {
-      ...frontmatter,
-      default: entry.default,
       body: entry.default,
-      toc,
-      structuredData,
-      lastModified,
+      toc: entry.toc,
+      extractedReferences: entry.extractedReferences,
+      structuredData: entry.structuredData,
+      lastModified: entry.lastModified,
       _exports: entry
     };
   }
-  function mapPageDataLazy(head, content) {
+  function mapPageData(info, entry) {
+    return {
+      ...mapDocData(entry),
+      info,
+      async getText(type) {
+        if (type === "raw") {
+          return (await fs.readFile(info.fullPath)).toString();
+        }
+        if (typeof entry._markdown !== "string") missingProcessedMarkdown();
+        return entry._markdown;
+      },
+      ...entry.frontmatter
+    };
+  }
+  function mapPageDataLazy(info, head, content) {
     return {
       ...head,
+      info,
       async load() {
-        const { default: body, ...rest } = await content();
-        return { body, ...rest };
+        return mapDocData(await content());
+      },
+      async getText(type) {
+        if (type === "raw") {
+          return (await fs.readFile(info.fullPath)).toString();
+        }
+        const entry = await content();
+        if (typeof entry._markdown !== "string") missingProcessedMarkdown();
+        return entry._markdown;
       }
     };
   }
+  function mapMetaData(info, content) {
+    return {
+      info,
+      ...content
+    };
+  }
   return {
     ...base,
     async sourceAsync(doc, meta) {
       const virtualFiles = [
         ...Object.entries(doc).map(async ([file, content]) => {
+          const info = fileInfo(file, content.base);
           return {
             type: "page",
             path: file,
-            absolutePath: path.join(content.base, file),
-            data: mapPageData(await content())
+            absolutePath: info.fullPath,
+            data: mapPageData(info, await content())
           };
         }),
         ...Object.entries(meta).map(async ([file, content]) => {
+          const info = fileInfo(file, content.base);
           return {
             type: "meta",
-            path: file,
-            absolutePath: path.join(content.base, file),
-            data: await content()
+            path: info.path,
+            absolutePath: info.fullPath,
+            data: mapMetaData(info, await content())
           };
         })
       ];
@@ -55,19 +93,21 @@ function fromConfig() {
     async sourceLazy(doc, meta) {
       const virtualFiles = [
         ...Object.entries(doc.head).map(async ([file, frontmatter]) => {
+          const info = fileInfo(file, doc.base);
           return {
             type: "page",
-            path: file,
-            absolutePath: path.join(doc.base, file),
-            data: mapPageDataLazy(await frontmatter(), doc.body[file])
+            path: info.path,
+            absolutePath: info.fullPath,
+            data: mapPageDataLazy(info, await frontmatter(), doc.body[file])
           };
         }),
         ...Object.entries(meta).map(async ([file, content]) => {
+          const info = fileInfo(file, content.base);
           return {
             type: "meta",
-            path: file,
-            absolutePath: path.join(content.base, file),
-            data: await content()
+            path: info.path,
+            absolutePath: info.fullPath,
+            data: mapMetaData(info, await content())
           };
         })
       ];

package/dist/shared-0QIuV0XZ.d.ts

@@ -0,0 +1,70 @@
+import { StructuredData } from 'fumadocs-core/mdx-plugins';
+import { TableOfContents } from 'fumadocs-core/server';
+import { FC } from 'react';
+import { MDXProps } from 'mdx/types';
+import { E as ExtractedReference } from './define--6HQ1ehX.js';
+
+interface FileInfo {
+    /**
+     * virtualized path for Source API
+     */
+    path: string;
+    /**
+     * the file path in file system
+     */
+    fullPath: string;
+}
+interface DocData {
+    /**
+     * Compiled MDX content (as component)
+     */
+    body: FC<MDXProps>;
+    /**
+     * table of contents generated from content.
+     */
+    toc: TableOfContents;
+    /**
+     * structured data for document search indexing.
+     */
+    structuredData: StructuredData;
+    /**
+     * Raw exports from the compiled MDX file.
+     */
+    _exports: Record<string, unknown>;
+    /**
+     * Last modified date of document file, obtained from version control.
+     *
+     * Only available when `lastModifiedTime` is enabled on global config.
+     */
+    lastModified?: Date;
+    /**
+     * extracted references (e.g. hrefs, paths), useful for analyzing relationships between pages.
+     */
+    extractedReferences?: ExtractedReference[];
+}
+interface DocMethods {
+    /**
+     * file info
+     */
+    info: FileInfo;
+    /**
+     * get document as text.
+     *
+     * - `type: raw` - read the original content from file system.
+     * - `type: processed` - get the processed Markdown content, only available when `includeProcessedMarkdown` is enabled on collection config.
+     */
+    getText: (type: 'raw' | 'processed') => Promise<string>;
+}
+type MetaCollectionEntry<Data> = Data & {
+    /**
+     * file info
+     */
+    info: FileInfo;
+};
+type DocCollectionEntry<Frontmatter> = Override<DocData & DocMethods, Frontmatter>;
+type AsyncDocCollectionEntry<Frontmatter> = Override<DocMethods & {
+    load: () => Promise<DocData>;
+}, Frontmatter>;
+type Override<A, B> = Omit<A, keyof B> & B;
+
+export type { AsyncDocCollectionEntry as A, DocCollectionEntry as D, FileInfo as F, MetaCollectionEntry as M };

package/dist/shared-CqgMnt9h.d.cts

@@ -0,0 +1,70 @@
+import { StructuredData } from 'fumadocs-core/mdx-plugins';
+import { TableOfContents } from 'fumadocs-core/server';
+import { FC } from 'react';
+import { MDXProps } from 'mdx/types';
+import { E as ExtractedReference } from './define--6HQ1ehX.cjs';
+
+interface FileInfo {
+    /**
+     * virtualized path for Source API
+     */
+    path: string;
+    /**
+     * the file path in file system
+     */
+    fullPath: string;
+}
+interface DocData {
+    /**
+     * Compiled MDX content (as component)
+     */
+    body: FC<MDXProps>;
+    /**
+     * table of contents generated from content.
+     */
+    toc: TableOfContents;
+    /**
+     * structured data for document search indexing.
+     */
+    structuredData: StructuredData;
+    /**
+     * Raw exports from the compiled MDX file.
+     */
+    _exports: Record<string, unknown>;
+    /**
+     * Last modified date of document file, obtained from version control.
+     *
+     * Only available when `lastModifiedTime` is enabled on global config.
+     */
+    lastModified?: Date;
+    /**
+     * extracted references (e.g. hrefs, paths), useful for analyzing relationships between pages.
+     */
+    extractedReferences?: ExtractedReference[];
+}
+interface DocMethods {
+    /**
+     * file info
+     */
+    info: FileInfo;
+    /**
+     * get document as text.
+     *
+     * - `type: raw` - read the original content from file system.
+     * - `type: processed` - get the processed Markdown content, only available when `includeProcessedMarkdown` is enabled on collection config.
+     */
+    getText: (type: 'raw' | 'processed') => Promise<string>;
+}
+type MetaCollectionEntry<Data> = Data & {
+    /**
+     * file info
+     */
+    info: FileInfo;
+};
+type DocCollectionEntry<Frontmatter> = Override<DocData & DocMethods, Frontmatter>;
+type AsyncDocCollectionEntry<Frontmatter> = Override<DocMethods & {
+    load: () => Promise<DocData>;
+}, Frontmatter>;
+type Override<A, B> = Omit<A, keyof B> & B;
+
+export type { AsyncDocCollectionEntry as A, DocCollectionEntry as D, FileInfo as F, MetaCollectionEntry as M };

package/dist/{types-DN9KrG7R.d.ts → types-CFlQxTN8.d.ts}

@@ -1,8 +1,8 @@
 import { StandardSchemaV1 } from '@standard-schema/spec';
 import { Source, PageData, MetaData } from 'fumadocs-core/source';
-import { a as DocCollection, M as MetaCollection, b as DocsCollection, G as GlobalConfig } from './define-BH4bnHQl.js';
+import { a as DocCollection, M as MetaCollection, b as DocsCollection, G as GlobalConfig } from './define--6HQ1ehX.js';
 import { ProcessorOptions } from '@mdx-js/mdx';
-import { C as CompiledMDXProperties } from './build-mdx-DnC1jKvn.js';
+import { F as FileInfo, A as AsyncDocCollectionEntry, M as MetaCollectionEntry, D as DocCollectionEntry } from './shared-0QIuV0XZ.js';
 
 interface LoadedConfig {
     collections: Map<string, DocCollection | MetaCollection | DocsCollection>;
@@ -10,44 +10,20 @@ interface LoadedConfig {
     getDefaultMDXOptions(mode?: 'default' | 'remote'): Promise<ProcessorOptions>;
 }
 
-interface BaseCollectionEntry {
-    /**
-     * Raw file path of collection entry, including absolute path (not normalized).
-     */
-    _file: FileInfo;
-}
-interface FileInfo {
-    path: string;
-    absolutePath: string;
-}
-interface MarkdownProps extends Omit<CompiledMDXProperties, 'frontmatter' | 'default'> {
-    body: CompiledMDXProperties['default'];
-}
 interface RuntimeFile {
     info: FileInfo;
     data: Record<string, unknown>;
 }
 interface AsyncRuntimeFile {
-    info: FileInfo;
-    data: Record<string, unknown>;
-    content: {
-        matter: string;
-        body: string;
+    info: FileInfo & {
+        hash?: string;
+        absolutePath?: string;
     };
+    data: Record<string, unknown>;
     lastModified?: Date;
 }
-type DocOut<Schema extends StandardSchemaV1> = Override<MarkdownProps & {
-    /**
-     * Other exports in the compiled Markdown/MDX file
-     */
-    _exports: Record<string, unknown>;
-    /**
-     * Read the original content of file from file system.
-     */
-    get content(): string;
-}, StandardSchemaV1.InferOutput<Schema> & BaseCollectionEntry>;
-type Override<A, B> = Omit<A, keyof B> & B;
-type MetaOut<Schema extends StandardSchemaV1> = StandardSchemaV1.InferOutput<Schema> & BaseCollectionEntry;
+type DocOut<Schema extends StandardSchemaV1 = StandardSchemaV1> = DocCollectionEntry<StandardSchemaV1.InferOutput<Schema>>;
+type MetaOut<Schema extends StandardSchemaV1 = StandardSchemaV1> = MetaCollectionEntry<StandardSchemaV1.InferOutput<Schema>>;
 interface Runtime {
     doc: <C>(files: RuntimeFile[]) => C extends DocCollection<infer Schema, false> ? DocOut<Schema>[] : never;
     meta: <C>(files: RuntimeFile[]) => C extends MetaCollection<infer Schema> ? MetaOut<Schema>[] : never;
@@ -60,10 +36,7 @@ interface Runtime {
         }>;
     } : never;
 }
-type AsyncDocOut<Schema extends StandardSchemaV1> = StandardSchemaV1.InferOutput<Schema> & BaseCollectionEntry & {
-    content: string;
-    load: () => Promise<MarkdownProps & Record<string, unknown>>;
-};
+type AsyncDocOut<Schema extends StandardSchemaV1 = StandardSchemaV1> = AsyncDocCollectionEntry<StandardSchemaV1.InferOutput<Schema>>;
 interface RuntimeAsync {
     doc: <C>(files: AsyncRuntimeFile[], collection: string, config: LoadedConfig) => C extends DocCollection<infer Schema, true> ? AsyncDocOut<Schema>[] : never;
     docs: <C>(docs: AsyncRuntimeFile[], metas: RuntimeFile[], collection: string, config: LoadedConfig) => C extends DocsCollection<infer DocSchema, infer MetaSchema, true> ? {
@@ -76,4 +49,4 @@ interface RuntimeAsync {
     } : never;
 }
 
-export type { BaseCollectionEntry as B, LoadedConfig as L, Runtime as R, RuntimeAsync as a };
+export type { AsyncRuntimeFile as A, DocOut as D, LoadedConfig as L, MetaOut as M, Runtime as R, RuntimeFile as a, AsyncDocOut as b, RuntimeAsync as c };

package/dist/{types-DT83Ijs6.d.cts → types-DkGjw-Uo.d.cts}

@@ -1,8 +1,8 @@
 import { StandardSchemaV1 } from '@standard-schema/spec';
 import { Source, PageData, MetaData } from 'fumadocs-core/source';
-import { a as DocCollection, M as MetaCollection, b as DocsCollection, G as GlobalConfig } from './define-BH4bnHQl.cjs';
+import { a as DocCollection, M as MetaCollection, b as DocsCollection, G as GlobalConfig } from './define--6HQ1ehX.cjs';
 import { ProcessorOptions } from '@mdx-js/mdx';
-import { C as CompiledMDXProperties } from './build-mdx-DnC1jKvn.cjs';
+import { F as FileInfo, A as AsyncDocCollectionEntry, M as MetaCollectionEntry, D as DocCollectionEntry } from './shared-CqgMnt9h.cjs';
 
 interface LoadedConfig {
     collections: Map<string, DocCollection | MetaCollection | DocsCollection>;
@@ -10,44 +10,20 @@ interface LoadedConfig {
     getDefaultMDXOptions(mode?: 'default' | 'remote'): Promise<ProcessorOptions>;
 }
 
-interface BaseCollectionEntry {
-    /**
-     * Raw file path of collection entry, including absolute path (not normalized).
-     */
-    _file: FileInfo;
-}
-interface FileInfo {
-    path: string;
-    absolutePath: string;
-}
-interface MarkdownProps extends Omit<CompiledMDXProperties, 'frontmatter' | 'default'> {
-    body: CompiledMDXProperties['default'];
-}
 interface RuntimeFile {
     info: FileInfo;
     data: Record<string, unknown>;
 }
 interface AsyncRuntimeFile {
-    info: FileInfo;
-    data: Record<string, unknown>;
-    content: {
-        matter: string;
-        body: string;
+    info: FileInfo & {
+        hash?: string;
+        absolutePath?: string;
     };
+    data: Record<string, unknown>;
     lastModified?: Date;
 }
-type DocOut<Schema extends StandardSchemaV1> = Override<MarkdownProps & {
-    /**
-     * Other exports in the compiled Markdown/MDX file
-     */
-    _exports: Record<string, unknown>;
-    /**
-     * Read the original content of file from file system.
-     */
-    get content(): string;
-}, StandardSchemaV1.InferOutput<Schema> & BaseCollectionEntry>;
-type Override<A, B> = Omit<A, keyof B> & B;
-type MetaOut<Schema extends StandardSchemaV1> = StandardSchemaV1.InferOutput<Schema> & BaseCollectionEntry;
+type DocOut<Schema extends StandardSchemaV1 = StandardSchemaV1> = DocCollectionEntry<StandardSchemaV1.InferOutput<Schema>>;
+type MetaOut<Schema extends StandardSchemaV1 = StandardSchemaV1> = MetaCollectionEntry<StandardSchemaV1.InferOutput<Schema>>;
 interface Runtime {
     doc: <C>(files: RuntimeFile[]) => C extends DocCollection<infer Schema, false> ? DocOut<Schema>[] : never;
     meta: <C>(files: RuntimeFile[]) => C extends MetaCollection<infer Schema> ? MetaOut<Schema>[] : never;
@@ -60,10 +36,7 @@ interface Runtime {
         }>;
     } : never;
 }
-type AsyncDocOut<Schema extends StandardSchemaV1> = StandardSchemaV1.InferOutput<Schema> & BaseCollectionEntry & {
-    content: string;
-    load: () => Promise<MarkdownProps & Record<string, unknown>>;
-};
+type AsyncDocOut<Schema extends StandardSchemaV1 = StandardSchemaV1> = AsyncDocCollectionEntry<StandardSchemaV1.InferOutput<Schema>>;
 interface RuntimeAsync {
     doc: <C>(files: AsyncRuntimeFile[], collection: string, config: LoadedConfig) => C extends DocCollection<infer Schema, true> ? AsyncDocOut<Schema>[] : never;
     docs: <C>(docs: AsyncRuntimeFile[], metas: RuntimeFile[], collection: string, config: LoadedConfig) => C extends DocsCollection<infer DocSchema, infer MetaSchema, true> ? {
@@ -76,4 +49,4 @@ interface RuntimeAsync {
     } : never;
 }
 
-export type { BaseCollectionEntry as B, LoadedConfig as L, Runtime as R, RuntimeAsync as a };
+export type { AsyncRuntimeFile as A, DocOut as D, LoadedConfig as L, MetaOut as M, Runtime as R, RuntimeFile as a, AsyncDocOut as b, RuntimeAsync as c };