fumadocs-mdx 13.0.8 → 14.0.1

package/dist/plugins/last-modified.cjs

@@ -0,0 +1,110 @@
+"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))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  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/plugins/last-modified.ts
+var last_modified_exports = {};
+__export(last_modified_exports, {
+  default: () => lastModified
+});
+module.exports = __toCommonJS(last_modified_exports);
+var import_node_path2 = __toESM(require("path"), 1);
+var import_tinyexec = require("tinyexec");
+
+// src/utils/codegen.ts
+var import_node_path = __toESM(require("path"), 1);
+var import_tinyglobby = require("tinyglobby");
+function ident(code, tab = 1) {
+  return code.split("\n").map((v) => "  ".repeat(tab) + v).join("\n");
+}
+
+// src/plugins/last-modified.ts
+var cache = /* @__PURE__ */ new Map();
+var ExtendTypes = `{
+  /**
+   * Last modified date of document file, obtained from version control.
+   *
+   */
+  lastModified?: Date;
+}`;
+function lastModified(options = {}) {
+  const { versionControl = "git", filter = () => true } = options;
+  return {
+    name: "last-modified",
+    "index-file": {
+      generateTypeConfig() {
+        const lines = [];
+        lines.push("{");
+        lines.push("  DocData: {");
+        for (const collection of this.core.getConfig().collectionList) {
+          if (filter(collection.name)) {
+            lines.push(ident(`${collection.name}: ${ExtendTypes},`, 2));
+          }
+        }
+        lines.push("  }");
+        lines.push("}");
+        return lines.join("\n");
+      },
+      serverOptions(options2) {
+        options2.doc ??= {};
+        options2.doc.passthroughs ??= [];
+        options2.doc.passthroughs.push("lastModified");
+      }
+    },
+    doc: {
+      async vfile(file) {
+        if (!filter(this.collection.name)) return;
+        if (versionControl === "git") {
+          const timestamp = await getGitTimestamp(this.filePath);
+          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 (0, import_tinyexec.x)(
+      "git",
+      ["log", "-1", '--pretty="%ai"', import_node_path2.default.relative(process.cwd(), file)],
+      {
+        throwOnError: true
+      }
+    );
+    return new Date(out.stdout);
+  })();
+  cache.set(file, timePromise);
+  return timePromise.catch(() => void 0);
+}

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

@@ -0,0 +1,37 @@
+import { j as Plugin } from '../core-DTuP23zu.cjs';
+import '@mdx-js/mdx';
+import '@standard-schema/spec';
+import 'unified';
+import 'fumadocs-core/mdx-plugins';
+import 'zod';
+import 'chokidar';
+import 'vfile';
+import 'fumadocs-core/source';
+import '../runtime/types.cjs';
+import 'fumadocs-core/mdx-plugins/remark-structure';
+import 'fumadocs-core/toc';
+import 'mdast';
+import 'mdx/types';
+
+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';
+    /**
+     * Filter the collections to include by names
+     */
+    filter?: (collection: string) => boolean;
+}
+/**
+ * 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,37 @@
+import { j as Plugin } from '../core-B9ZoS6sA.js';
+import '@mdx-js/mdx';
+import '@standard-schema/spec';
+import 'unified';
+import 'fumadocs-core/mdx-plugins';
+import 'zod';
+import 'chokidar';
+import 'vfile';
+import 'fumadocs-core/source';
+import '../runtime/types.js';
+import 'fumadocs-core/mdx-plugins/remark-structure';
+import 'fumadocs-core/toc';
+import 'mdast';
+import 'mdx/types';
+
+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';
+    /**
+     * Filter the collections to include by names
+     */
+    filter?: (collection: string) => boolean;
+}
+/**
+ * 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,74 @@
+import {
+  ident
+} from "../chunk-WBIHDYMN.js";
+
+// src/plugins/last-modified.ts
+import path from "path";
+import { x } from "tinyexec";
+var cache = /* @__PURE__ */ new Map();
+var ExtendTypes = `{
+  /**
+   * Last modified date of document file, obtained from version control.
+   *
+   */
+  lastModified?: Date;
+}`;
+function lastModified(options = {}) {
+  const { versionControl = "git", filter = () => true } = options;
+  return {
+    name: "last-modified",
+    "index-file": {
+      generateTypeConfig() {
+        const lines = [];
+        lines.push("{");
+        lines.push("  DocData: {");
+        for (const collection of this.core.getConfig().collectionList) {
+          if (filter(collection.name)) {
+            lines.push(ident(`${collection.name}: ${ExtendTypes},`, 2));
+          }
+        }
+        lines.push("  }");
+        lines.push("}");
+        return lines.join("\n");
+      },
+      serverOptions(options2) {
+        options2.doc ??= {};
+        options2.doc.passthroughs ??= [];
+        options2.doc.passthroughs.push("lastModified");
+      }
+    },
+    doc: {
+      async vfile(file) {
+        if (!filter(this.collection.name)) return;
+        if (versionControl === "git") {
+          const timestamp = await getGitTimestamp(this.filePath);
+          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/browser.cjs

@@ -0,0 +1,93 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/runtime/browser.ts
+var browser_exports = {};
+__export(browser_exports, {
+  browser: () => browser,
+  createClientLoader: () => createClientLoader
+});
+module.exports = __toCommonJS(browser_exports);
+var import_react = require("react");
+function browser() {
+  return {
+    doc(_name, glob) {
+      const out = {
+        raw: glob,
+        createClientLoader({ id = _name, ...options }) {
+          return createClientLoader(this.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 = (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 getLoader(path)();
+      store.preloaded.set(path, loaded);
+      return loaded;
+    },
+    getComponent(path) {
+      return getRenderer(path);
+    },
+    useContent(path, props) {
+      const Comp = this.getComponent(path);
+      return (0, import_react.createElement)(Comp, props);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  browser,
+  createClientLoader
+});

package/dist/runtime/browser.d.cts

@@ -0,0 +1,53 @@
+import { ReactNode, FC } from 'react';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { D as DocCollection, a as DocsCollection } from '../core-DTuP23zu.cjs';
+import { CompiledMDXProperties } from '../index.cjs';
+import { InternalTypeConfig } from './types.cjs';
+import '@mdx-js/mdx';
+import 'unified';
+import 'fumadocs-core/mdx-plugins';
+import 'zod';
+import 'chokidar';
+import 'vfile';
+import 'fumadocs-core/source';
+import 'fumadocs-core/toc';
+import 'mdx/types';
+import 'fumadocs-core/mdx-plugins/remark-structure';
+import 'mdast';
+
+type CompiledMDXFile<Name extends string, Frontmatter, TC extends InternalTypeConfig> = CompiledMDXProperties<Frontmatter> & TC['DocData'][Name] & Record<string, unknown>;
+interface ClientLoaderOptions<Doc, 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: Doc, props: Props) => ReactNode;
+}
+interface ClientLoader<Doc, Props> {
+    preload: (path: string) => Promise<Doc>;
+    /**
+     * 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, TC extends InternalTypeConfig> = ReturnType<typeof browser<Config, TC>>;
+interface DocCollectionEntry<Name extends string = string, Frontmatter = unknown, TC extends InternalTypeConfig = InternalTypeConfig> {
+    raw: Record<string, () => Promise<CompiledMDXFile<Name, Frontmatter, TC>>>;
+    createClientLoader: <Props extends object>(options: ClientLoaderOptions<CompiledMDXFile<Name, Frontmatter, TC>, Props>) => ClientLoader<CompiledMDXFile<Name, Frontmatter, TC>, Props>;
+}
+declare function browser<Config, TC extends InternalTypeConfig>(): {
+    doc<Name extends keyof Config & string>(_name: Name, glob: Record<string, () => Promise<unknown>>): Config[Name] extends DocCollection<infer Schema> | DocsCollection<infer Schema> ? DocCollectionEntry<Name, StandardSchemaV1.InferOutput<Schema>, TC> : never;
+};
+declare function createClientLoader<Doc = CompiledMDXProperties, Props extends object = object>(globEntries: Record<string, () => Promise<Doc>>, options: ClientLoaderOptions<Doc, Props>): ClientLoader<Doc, Props>;
+
+export { type BrowserCreate, type ClientLoader, type ClientLoaderOptions, type DocCollectionEntry, browser, createClientLoader };

package/dist/runtime/browser.d.ts

@@ -0,0 +1,53 @@
+import { ReactNode, FC } from 'react';
+import { StandardSchemaV1 } from '@standard-schema/spec';
+import { D as DocCollection, a as DocsCollection } from '../core-B9ZoS6sA.js';
+import { CompiledMDXProperties } from '../index.js';
+import { InternalTypeConfig } from './types.js';
+import '@mdx-js/mdx';
+import 'unified';
+import 'fumadocs-core/mdx-plugins';
+import 'zod';
+import 'chokidar';
+import 'vfile';
+import 'fumadocs-core/source';
+import 'fumadocs-core/toc';
+import 'mdx/types';
+import 'fumadocs-core/mdx-plugins/remark-structure';
+import 'mdast';
+
+type CompiledMDXFile<Name extends string, Frontmatter, TC extends InternalTypeConfig> = CompiledMDXProperties<Frontmatter> & TC['DocData'][Name] & Record<string, unknown>;
+interface ClientLoaderOptions<Doc, 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: Doc, props: Props) => ReactNode;
+}
+interface ClientLoader<Doc, Props> {
+    preload: (path: string) => Promise<Doc>;
+    /**
+     * 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, TC extends InternalTypeConfig> = ReturnType<typeof browser<Config, TC>>;
+interface DocCollectionEntry<Name extends string = string, Frontmatter = unknown, TC extends InternalTypeConfig = InternalTypeConfig> {
+    raw: Record<string, () => Promise<CompiledMDXFile<Name, Frontmatter, TC>>>;
+    createClientLoader: <Props extends object>(options: ClientLoaderOptions<CompiledMDXFile<Name, Frontmatter, TC>, Props>) => ClientLoader<CompiledMDXFile<Name, Frontmatter, TC>, Props>;
+}
+declare function browser<Config, TC extends InternalTypeConfig>(): {
+    doc<Name extends keyof Config & string>(_name: Name, glob: Record<string, () => Promise<unknown>>): Config[Name] extends DocCollection<infer Schema> | DocsCollection<infer Schema> ? DocCollectionEntry<Name, StandardSchemaV1.InferOutput<Schema>, TC> : never;
+};
+declare function createClientLoader<Doc = CompiledMDXProperties, Props extends object = object>(globEntries: Record<string, () => Promise<Doc>>, options: ClientLoaderOptions<Doc, Props>): ClientLoader<Doc, Props>;
+
+export { type BrowserCreate, type ClientLoader, type ClientLoaderOptions, type DocCollectionEntry, browser, createClientLoader };

package/dist/runtime/browser.js

@@ -0,0 +1,67 @@
+// src/runtime/browser.ts
+import { lazy, createElement } from "react";
+function browser() {
+  return {
+    doc(_name, glob) {
+      const out = {
+        raw: glob,
+        createClientLoader({ id = _name, ...options }) {
+          return createClientLoader(this.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 {
+  browser,
+  createClientLoader
+};