fumadocs-mdx 13.0.7 → 14.0.0

package/dist/plugins/last-modified.d.cts

@@ -0,0 +1,27 @@
+import { j as Plugin } from '../index-D7JdSMpp.cjs';
+import '@mdx-js/mdx';
+import '@standard-schema/spec';
+import 'unified';
+import 'fumadocs-core/mdx-plugins';
+import 'zod';
+import 'chokidar';
+import 'vfile';
+
+interface LastModifiedPluginOptions {
+    /**
+     * Version control to obtain the last modified time.
+     *
+     * - `git`: Requires `git` to be installed.
+     *
+     *    If you are using Vercel, please set `VERCEL_DEEP_CLONE` environment variable to `true`.
+     *
+     * @defaultValue 'git'
+     */
+    versionControl?: 'git';
+}
+/**
+ * Injects `lastModified` property to page exports.
+ */
+declare function lastModified(options?: LastModifiedPluginOptions): Plugin;
+
+export { type LastModifiedPluginOptions, lastModified as default };

package/dist/plugins/last-modified.d.ts

@@ -0,0 +1,27 @@
+import { j as Plugin } from '../index-D7JdSMpp.js';
+import '@mdx-js/mdx';
+import '@standard-schema/spec';
+import 'unified';
+import 'fumadocs-core/mdx-plugins';
+import 'zod';
+import 'chokidar';
+import 'vfile';
+
+interface LastModifiedPluginOptions {
+    /**
+     * Version control to obtain the last modified time.
+     *
+     * - `git`: Requires `git` to be installed.
+     *
+     *    If you are using Vercel, please set `VERCEL_DEEP_CLONE` environment variable to `true`.
+     *
+     * @defaultValue 'git'
+     */
+    versionControl?: 'git';
+}
+/**
+ * Injects `lastModified` property to page exports.
+ */
+declare function lastModified(options?: LastModifiedPluginOptions): Plugin;
+
+export { type LastModifiedPluginOptions, lastModified as default };

package/dist/plugins/last-modified.js

@@ -0,0 +1,44 @@
+// src/plugins/last-modified.ts
+import path from "path";
+import { x } from "tinyexec";
+var cache = /* @__PURE__ */ new Map();
+function lastModified(options = {}) {
+  const { versionControl = "git" } = options;
+  return {
+    name: "last-modified",
+    doc: {
+      async vfile(file) {
+        if (versionControl === "git") {
+          const timestamp = await getGitTimestamp(this.filePath).then(
+            (v) => v?.getTime()
+          );
+          if (timestamp === void 0) return;
+          file.data["mdx-export"] ??= [];
+          file.data["mdx-export"].push({
+            name: "lastModified",
+            value: timestamp
+          });
+        }
+      }
+    }
+  };
+}
+async function getGitTimestamp(file) {
+  const cached = cache.get(file);
+  if (cached) return cached;
+  const timePromise = (async () => {
+    const out = await x(
+      "git",
+      ["log", "-1", '--pretty="%ai"', path.relative(process.cwd(), file)],
+      {
+        throwOnError: true
+      }
+    );
+    return new Date(out.stdout);
+  })();
+  cache.set(file, timePromise);
+  return timePromise.catch(() => void 0);
+}
+export {
+  lastModified as default
+};

package/dist/runtime/{vite/browser.cjs → browser.cjs}

@@ -17,77 +17,69 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// src/runtime/vite/browser.ts
+// src/runtime/browser.ts
 var browser_exports = {};
 __export(browser_exports, {
   createClientLoader: () => createClientLoader,
-  fromConfig: () => fromConfigBase,
-  fromConfigBase: () => fromConfigBase,
-  toClientRenderer: () => toClientRenderer
+  fromConfig: () => fromConfig
 });
 module.exports = __toCommonJS(browser_exports);
-
-// src/runtime/vite/base.ts
 var import_react = require("react");
-function fromConfigBase() {
-  function normalize(entries, base) {
-    const out = {};
-    for (const k in entries) {
-      const mappedK = k.startsWith("./") ? k.slice(2) : k;
-      if (base) Object.assign(entries[k], { base });
-      out[mappedK] = entries[k];
-    }
-    return out;
-  }
+function fromConfig() {
   return {
-    doc(_, base, glob) {
-      return normalize(glob, base);
-    },
-    meta(_, base, glob) {
-      return normalize(glob, base);
-    },
-    docLazy(_, base, head, body) {
-      return {
-        base,
-        head: normalize(head),
-        body: normalize(body)
+    doc(_name, glob) {
+      const raw = glob;
+      const out = {
+        raw,
+        createClientLoader({ id = _name, ...options }) {
+          return createClientLoader(raw, { id, ...options });
+        }
       };
+      return out;
     }
   };
 }
 var loaderStore = /* @__PURE__ */ new Map();
-function createClientLoader(files, options) {
+function createClientLoader(globEntries, options) {
   const { id = "", component } = options;
-  let renderer;
+  const renderers = {};
+  const loaders = /* @__PURE__ */ new Map();
   const store = loaderStore.get(id) ?? {
     preloaded: /* @__PURE__ */ new Map()
   };
   loaderStore.set(id, store);
-  function getRenderer() {
-    if (renderer) return renderer;
-    renderer = {};
-    for (const k in files) {
-      const OnDemand = (0, import_react.lazy)(async () => {
-        const loaded = await files[k]();
-        return { default: (props) => component(loaded, props) };
-      });
-      renderer[k] = (props) => {
-        const cached = store.preloaded.get(k);
-        if (!cached) return (0, import_react.createElement)(OnDemand, props);
-        return component(cached, props);
-      };
-    }
-    return renderer;
+  for (const k in globEntries) {
+    loaders.set(k.startsWith("./") ? k.slice(2) : k, globEntries[k]);
+  }
+  function getLoader(path) {
+    const loader = loaders.get(path);
+    if (!loader)
+      throw new Error(
+        `[createClientLoader] ${path} does not exist in available entries`
+      );
+    return loader;
+  }
+  function getRenderer(path) {
+    if (path in renderers) return renderers[path];
+    const OnDemand = (0, import_react.lazy)(async () => {
+      const loaded = await getLoader(path)();
+      return { default: (props) => component(loaded, props) };
+    });
+    renderers[path] = (props) => {
+      const cached = store.preloaded.get(path);
+      if (!cached) return (0, import_react.createElement)(OnDemand, props);
+      return component(cached, props);
+    };
+    return renderers[path];
   }
   return {
     async preload(path) {
-      const loaded = await files[path]();
+      const loaded = await getLoader(path)();
       store.preloaded.set(path, loaded);
       return loaded;
     },
-    getRenderer,
     getComponent(path) {
-      return getRenderer()[path];
+      return getRenderer(path);
     },
     useContent(path, props) {
       const Comp = this.getComponent(path);
@@ -95,13 +87,8 @@ function createClientLoader(files, options) {
     }
   };
 }
-function toClientRenderer(files, component) {
-  return createClientLoader(files, { component }).getRenderer();
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createClientLoader,
-  fromConfig,
-  fromConfigBase,
-  toClientRenderer
+  fromConfig
 });

package/dist/runtime/browser.d.cts

@@ -0,0 +1,50 @@
+import { ReactNode, FC } from 'react';
+import { CompiledMDXFile } from './server.cjs';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { D as DocCollection, b as DocsCollection } from '../index-D7JdSMpp.cjs';
+import 'fumadocs-core/source';
+import 'fumadocs-core/mdx-plugins';
+import 'fumadocs-core/toc';
+import 'mdx/types';
+import 'mdast';
+import '@mdx-js/mdx';
+import 'unified';
+import 'zod';
+import 'chokidar';
+import 'vfile';
+
+interface ClientLoaderOptions<Frontmatter, Props> {
+    /**
+     * Loader ID (usually your collection name)
+     *
+     * The code splitting strategy of frameworks like Tanstack Start may duplicate `createClientLoader()` into different chunks.
+     *
+     * We use loader ID to share cache between multiple instances of client loader.
+     *
+     * @defaultValue ''
+     */
+    id?: string;
+    component: (loaded: CompiledMDXFile<Frontmatter>, props: Props) => ReactNode;
+}
+interface ClientLoader<Frontmatter, Props> {
+    preload: (path: string) => Promise<CompiledMDXFile<Frontmatter>>;
+    /**
+     * Get a component that renders content with `React.lazy`.
+     */
+    getComponent: (path: string) => FC<Props>;
+    /**
+     * Get react nodes that renders content with `React.lazy`.
+     */
+    useContent: (path: string, props: Props) => ReactNode;
+}
+type BrowserCreate<Config> = ReturnType<typeof fromConfig<Config>>;
+interface DocCollectionEntry<Frontmatter> {
+    raw: Record<string, () => Promise<CompiledMDXFile<Frontmatter>>>;
+    createClientLoader: <Props extends object>(options: ClientLoaderOptions<Frontmatter, Props>) => ClientLoader<Frontmatter, Props>;
+}
+declare function fromConfig<Config>(): {
+    doc<Name extends keyof Config>(_name: Name, glob: Record<string, () => Promise<unknown>>): Config[Name] extends DocCollection<infer Schema> | DocsCollection<infer Schema> ? DocCollectionEntry<StandardSchemaV1.InferOutput<Schema>> : never;
+};
+declare function createClientLoader<Frontmatter, Props extends object = object>(globEntries: Record<string, () => Promise<CompiledMDXFile<Frontmatter>>>, options: ClientLoaderOptions<Frontmatter, Props>): ClientLoader<Frontmatter, Props>;
+
+export { type BrowserCreate, type ClientLoader, type ClientLoaderOptions, type DocCollectionEntry, createClientLoader, fromConfig };

package/dist/runtime/browser.d.ts

@@ -0,0 +1,50 @@
+import { ReactNode, FC } from 'react';
+import { CompiledMDXFile } from './server.js';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { D as DocCollection, b as DocsCollection } from '../index-D7JdSMpp.js';
+import 'fumadocs-core/source';
+import 'fumadocs-core/mdx-plugins';
+import 'fumadocs-core/toc';
+import 'mdx/types';
+import 'mdast';
+import '@mdx-js/mdx';
+import 'unified';
+import 'zod';
+import 'chokidar';
+import 'vfile';
+
+interface ClientLoaderOptions<Frontmatter, Props> {
+    /**
+     * Loader ID (usually your collection name)
+     *
+     * The code splitting strategy of frameworks like Tanstack Start may duplicate `createClientLoader()` into different chunks.
+     *
+     * We use loader ID to share cache between multiple instances of client loader.
+     *
+     * @defaultValue ''
+     */
+    id?: string;
+    component: (loaded: CompiledMDXFile<Frontmatter>, props: Props) => ReactNode;
+}
+interface ClientLoader<Frontmatter, Props> {
+    preload: (path: string) => Promise<CompiledMDXFile<Frontmatter>>;
+    /**
+     * Get a component that renders content with `React.lazy`.
+     */
+    getComponent: (path: string) => FC<Props>;
+    /**
+     * Get react nodes that renders content with `React.lazy`.
+     */
+    useContent: (path: string, props: Props) => ReactNode;
+}
+type BrowserCreate<Config> = ReturnType<typeof fromConfig<Config>>;
+interface DocCollectionEntry<Frontmatter> {
+    raw: Record<string, () => Promise<CompiledMDXFile<Frontmatter>>>;
+    createClientLoader: <Props extends object>(options: ClientLoaderOptions<Frontmatter, Props>) => ClientLoader<Frontmatter, Props>;
+}
+declare function fromConfig<Config>(): {
+    doc<Name extends keyof Config>(_name: Name, glob: Record<string, () => Promise<unknown>>): Config[Name] extends DocCollection<infer Schema> | DocsCollection<infer Schema> ? DocCollectionEntry<StandardSchemaV1.InferOutput<Schema>> : never;
+};
+declare function createClientLoader<Frontmatter, Props extends object = object>(globEntries: Record<string, () => Promise<CompiledMDXFile<Frontmatter>>>, options: ClientLoaderOptions<Frontmatter, Props>): ClientLoader<Frontmatter, Props>;
+
+export { type BrowserCreate, type ClientLoader, type ClientLoaderOptions, type DocCollectionEntry, createClientLoader, fromConfig };

package/dist/runtime/browser.js

@@ -0,0 +1,68 @@
+// src/runtime/browser.ts
+import { lazy, createElement } from "react";
+function fromConfig() {
+  return {
+    doc(_name, glob) {
+      const raw = glob;
+      const out = {
+        raw,
+        createClientLoader({ id = _name, ...options }) {
+          return createClientLoader(raw, { id, ...options });
+        }
+      };
+      return out;
+    }
+  };
+}
+var loaderStore = /* @__PURE__ */ new Map();
+function createClientLoader(globEntries, options) {
+  const { id = "", component } = options;
+  const renderers = {};
+  const loaders = /* @__PURE__ */ new Map();
+  const store = loaderStore.get(id) ?? {
+    preloaded: /* @__PURE__ */ new Map()
+  };
+  loaderStore.set(id, store);
+  for (const k in globEntries) {
+    loaders.set(k.startsWith("./") ? k.slice(2) : k, globEntries[k]);
+  }
+  function getLoader(path) {
+    const loader = loaders.get(path);
+    if (!loader)
+      throw new Error(
+        `[createClientLoader] ${path} does not exist in available entries`
+      );
+    return loader;
+  }
+  function getRenderer(path) {
+    if (path in renderers) return renderers[path];
+    const OnDemand = lazy(async () => {
+      const loaded = await getLoader(path)();
+      return { default: (props) => component(loaded, props) };
+    });
+    renderers[path] = (props) => {
+      const cached = store.preloaded.get(path);
+      if (!cached) return createElement(OnDemand, props);
+      return component(cached, props);
+    };
+    return renderers[path];
+  }
+  return {
+    async preload(path) {
+      const loaded = await getLoader(path)();
+      store.preloaded.set(path, loaded);
+      return loaded;
+    },
+    getComponent(path) {
+      return getRenderer(path);
+    },
+    useContent(path, props) {
+      const Comp = this.getComponent(path);
+      return createElement(Comp, props);
+    }
+  };
+}
+export {
+  createClientLoader,
+  fromConfig
+};