fumadocs-mdx 12.0.3 → 13.0.0

package/dist/index.cjs

@@ -1,14 +1,8 @@
 "use strict";
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
 var __copyProps = (to, from, except, desc) => {
   if (from && typeof from === "object" || typeof from === "function") {
     for (let key of __getOwnPropNames(from))
@@ -17,111 +11,8 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
 var index_exports = {};
-__export(index_exports, {
-  _runtime: () => _runtime,
-  createMDXSource: () => createMDXSource,
-  resolveFiles: () => resolveFiles
-});
 module.exports = __toCommonJS(index_exports);
-
-// src/runtime/next/index.ts
-var fs = __toESM(require("fs/promises"), 1);
-
-// src/runtime/shared.ts
-function missingProcessedMarkdown() {
-  throw new Error(
-    "getText('processed') requires `includeProcessedMarkdown` to be enabled in your collection config."
-  );
-}
-
-// src/runtime/next/index.ts
-var _runtime = {
-  doc(files) {
-    return files.map((file) => {
-      const data = file.data;
-      const filePath = file.info.fullPath;
-      return {
-        info: file.info,
-        _exports: data,
-        body: data.default,
-        lastModified: data.lastModified,
-        toc: data.toc,
-        structuredData: data.structuredData,
-        extractedReferences: data.extractedReferences,
-        ...data.frontmatter,
-        async getText(type) {
-          if (type === "raw") {
-            return (await fs.readFile(filePath)).toString();
-          }
-          if (typeof data._markdown !== "string") missingProcessedMarkdown();
-          return data._markdown;
-        }
-      };
-    });
-  },
-  meta(files) {
-    return files.map((file) => {
-      return {
-        info: file.info,
-        ...file.data
-      };
-    });
-  },
-  docs(docs, metas) {
-    const parsedDocs = this.doc(docs);
-    const parsedMetas = this.meta(metas);
-    return {
-      docs: parsedDocs,
-      meta: parsedMetas,
-      toFumadocsSource() {
-        return createMDXSource(parsedDocs, parsedMetas);
-      }
-    };
-  }
-};
-function createMDXSource(docs, meta = []) {
-  return {
-    files: resolveFiles({
-      docs,
-      meta
-    })
-  };
-}
-function resolveFiles({ docs, meta }) {
-  const outputs = [];
-  for (const entry of docs) {
-    outputs.push({
-      type: "page",
-      absolutePath: entry.info.fullPath,
-      path: entry.info.path,
-      data: entry
-    });
-  }
-  for (const entry of meta) {
-    outputs.push({
-      type: "meta",
-      absolutePath: entry.info.fullPath,
-      path: entry.info.path,
-      data: entry
-    });
-  }
-  return outputs;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  _runtime,
-  createMDXSource,
-  resolveFiles
-});

package/dist/index.d.cts

@@ -1,13 +1,74 @@
-export { A as AsyncDocCollectionEntry, D as DocCollectionEntry, a as DocData, b as DocMethods, F as FileInfo, M as MetaCollectionEntry, m as missingProcessedMarkdown } from './shared-fFqiuWJC.cjs';
-export { AnyCollectionEntry, _runtime, createMDXSource, resolveFiles } from './runtime/next/index.cjs';
-export { E as ExtractedReference } from './define-DJbJduHy.cjs';
-export { c as AsyncDocOut, A as AsyncRuntimeFile, D as DocOut, M as MetaOut, a as Runtime, R as RuntimeAsync, b as RuntimeFile } from './types-BRx1QsIJ.cjs';
-import 'fumadocs-core/mdx-plugins';
-import 'fumadocs-core/server';
-import 'react';
-import 'mdx/types';
-import 'fumadocs-core/source';
-import '@standard-schema/spec';
+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 { Root } from 'mdast';
+import { C as CompiledMDXProperties } from './build-mdx-BHG-_uxo.cjs';
 import '@mdx-js/mdx';
-import 'unified';
-import 'zod';
+import 'react';
+
+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: MDXContent;
+    /**
+     * table of contents generated from content.
+     */
+    toc: TOCItemType[];
+    /**
+     * 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>;
+    getMDAST: () => Promise<Root>;
+}
+type MetaCollectionEntry<Data> = Data & {
+    /**
+     * file info
+     */
+    info: FileInfo;
+};
+type DocCollectionEntry<Frontmatter> = DocData & DocMethods & Frontmatter;
+type AsyncDocCollectionEntry<Frontmatter> = DocMethods & {
+    load: () => Promise<DocData>;
+} & Frontmatter;
+declare function createDocMethods(info: FileInfo, load: () => Promise<CompiledMDXProperties<any>>): DocMethods;
+
+export { type AsyncDocCollectionEntry, type DocCollectionEntry, type DocData, type DocMethods, ExtractedReference, type FileInfo, type MetaCollectionEntry, createDocMethods };

package/dist/index.d.ts

@@ -1,13 +1,74 @@
-export { A as AsyncDocCollectionEntry, D as DocCollectionEntry, a as DocData, b as DocMethods, F as FileInfo, M as MetaCollectionEntry, m as missingProcessedMarkdown } from './shared-CfiiRctw.js';
-export { AnyCollectionEntry, _runtime, createMDXSource, resolveFiles } from './runtime/next/index.js';
-export { E as ExtractedReference } from './define-DJbJduHy.js';
-export { c as AsyncDocOut, A as AsyncRuntimeFile, D as DocOut, M as MetaOut, a as Runtime, R as RuntimeAsync, b as RuntimeFile } from './types-TeHjsmja.js';
-import 'fumadocs-core/mdx-plugins';
-import 'fumadocs-core/server';
-import 'react';
-import 'mdx/types';
-import 'fumadocs-core/source';
-import '@standard-schema/spec';
+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 { Root } from 'mdast';
+import { C as CompiledMDXProperties } from './build-mdx-CzrQDBRZ.js';
 import '@mdx-js/mdx';
-import 'unified';
-import 'zod';
+import 'react';
+
+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: MDXContent;
+    /**
+     * table of contents generated from content.
+     */
+    toc: TOCItemType[];
+    /**
+     * 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>;
+    getMDAST: () => Promise<Root>;
+}
+type MetaCollectionEntry<Data> = Data & {
+    /**
+     * file info
+     */
+    info: FileInfo;
+};
+type DocCollectionEntry<Frontmatter> = DocData & DocMethods & Frontmatter;
+type AsyncDocCollectionEntry<Frontmatter> = DocMethods & {
+    load: () => Promise<DocData>;
+} & Frontmatter;
+declare function createDocMethods(info: FileInfo, load: () => Promise<CompiledMDXProperties<any>>): DocMethods;
+
+export { type AsyncDocCollectionEntry, type DocCollectionEntry, type DocData, type DocMethods, ExtractedReference, type FileInfo, type MetaCollectionEntry, createDocMethods };

package/dist/index.js

@@ -1,11 +0,0 @@
-import {
-  _runtime,
-  createMDXSource,
-  resolveFiles
-} from "./chunk-OMAMTKDE.js";
-import "./chunk-ZLCSVXCD.js";
-export {
-  _runtime,
-  createMDXSource,
-  resolveFiles
-};

package/dist/{load-UUXLUBHL.js → load-MNG3CLET.js}

@@ -1,9 +1,7 @@
 import {
-  getConfigHash,
   loadConfig
-} from "./chunk-LGYVNESJ.js";
+} from "./chunk-JVZFH6ND.js";
 import "./chunk-U4MQ44TS.js";
 export {
-  getConfigHash,
   loadConfig
 };