fumadocs-mdx 8.1.1 → 8.2.0

package/dist/config.d.mts

@@ -5,10 +5,11 @@ import { NextConfig } from 'next';
 import { RemarkImageOptions, RehypeCodeOptions } from 'fumadocs-core/mdx-plugins';
 import { PluggableList } from 'unified';
 import { Configuration } from 'webpack';
-import { Options } from './loader-mdx.mjs';
+import { Options as Options$1 } from './loader-mdx.mjs';
+import { O as Options } from './search-index-plugin-qbqv40V1.mjs';
 import '@mdx-js/mdx';
 
-type MDXOptions = Omit<NonNullable<Options>, 'rehypePlugins' | 'remarkPlugins'> & {
+type MDXOptions = Omit<NonNullable<Options$1>, 'rehypePlugins' | 'remarkPlugins'> & {
     rehypePlugins?: ResolvePlugins;
     remarkPlugins?: ResolvePlugins;
     /**
@@ -22,6 +23,7 @@ type ResolvePlugins = PluggableList | ((v: PluggableList) => PluggableList);
 interface CreateMDXOptions {
     cwd?: string;
     mdxOptions?: MDXOptions;
+    buildSearchIndex?: Partial<Options> | false;
     /**
      * Where the root map.ts should be, relative to cwd
      *
@@ -35,7 +37,7 @@ interface CreateMDXOptions {
      */
     rootContentPath?: string;
 }
-declare const createMDX: ({ mdxOptions, cwd, rootMapPath, rootContentPath, }?: CreateMDXOptions) => (nextConfig?: NextConfig) => {
+declare const createMDX: ({ mdxOptions, cwd, rootMapPath, rootContentPath, buildSearchIndex, }?: CreateMDXOptions) => (nextConfig?: NextConfig) => {
     webpack: (config: Configuration, options: next_dist_server_config_shared.WebpackConfigContext) => any;
     exportPathMap?: ((defaultMap: next_dist_server_config_shared.ExportPathMap, ctx: {
         dev: boolean;

package/dist/config.mjs

@@ -1,11 +1,5 @@
-import {
-  __objRest,
-  __spreadProps,
-  __spreadValues
-} from "./chunk-P26LYDRL.mjs";
-
 // src/config.ts
-import path from "path";
+import path2 from "node:path";
 import {
   rehypeCode,
   remarkGfm,
@@ -15,7 +9,7 @@ import {
 } from "fumadocs-core/mdx-plugins";
 
 // src/webpack-plugins/map-plugin.ts
-import fs from "fs";
+import * as fs from "node:fs";
 var firstLoad = true;
 var content = `
 /** Auto-generated **/
@@ -86,6 +80,67 @@ function remarkMdxExport({ values }) {
   };
 }
 
+// src/webpack-plugins/search-index-plugin.ts
+import * as path from "node:path";
+import { createRequire } from "node:module";
+import { createGetUrl, getSlugs, parseFilePath } from "fumadocs-core/source";
+var require2 = createRequire(import.meta.url);
+var pkg = require2("next/dist/compiled/webpack/webpack.js");
+var SearchIndexPlugin = class _SearchIndexPlugin {
+  constructor(options) {
+    this.options = options;
+  }
+  apply(compiler) {
+    const {
+      rootContentDir,
+      productionOnly = true,
+      filter = () => true,
+      getUrl = (file) => {
+        return createGetUrl("/")(getSlugs(parseFilePath(file)));
+      }
+    } = this.options;
+    const logger = compiler.getInfrastructureLogger(_SearchIndexPlugin.name);
+    const isProduction = process.env.NODE_ENV === "production";
+    if (productionOnly && !isProduction)
+      return;
+    compiler.hooks.compilation.tap(_SearchIndexPlugin.name, (compilation) => {
+      if (compilation.name !== "server")
+        return;
+      compilation.hooks.processAssets.tap(
+        {
+          name: _SearchIndexPlugin.name,
+          stage: pkg.webpack.Compilation.PROCESS_ASSETS_STAGE_ADDITIONS
+        },
+        () => {
+          const indexFiles = /* @__PURE__ */ new Map();
+          for (const m of compilation.modules.values()) {
+            if (!m.buildInfo || !("__fumadocs" in m.buildInfo))
+              continue;
+            const info = m.buildInfo.__fumadocs;
+            const relativePath = path.relative(rootContentDir, info.path);
+            if (!filter(relativePath))
+              continue;
+            indexFiles.set(info.path, {
+              id: info.path,
+              structuredData: info.data.structuredData,
+              title: info.data.frontmatter.title,
+              description: info.data.frontmatter.description,
+              url: getUrl(relativePath)
+            });
+          }
+          compilation.emitAsset(
+            "fumadocs_search.json",
+            new pkg.sources.RawSource(
+              JSON.stringify(Array.from(indexFiles.values()))
+            )
+          );
+          logger.info("Generated Search Indexes");
+        }
+      );
+    });
+  }
+};
+
 // src/config.ts
 function pluginOption(def, options = []) {
   const list = def(Array.isArray(options) ? options : []);
@@ -94,16 +149,12 @@ function pluginOption(def, options = []) {
   }
   return list;
 }
-function getMDXLoaderOptions(_a) {
-  var _b = _a, {
-    valueToExport = [],
-    rehypeCodeOptions,
-    remarkImageOptions
-  } = _b, mdxOptions = __objRest(_b, [
-    "valueToExport",
-    "rehypeCodeOptions",
-    "remarkImageOptions"
-  ]);
+function getMDXLoaderOptions({
+  valueToExport = [],
+  rehypeCodeOptions,
+  remarkImageOptions,
+  ...mdxOptions
+}) {
   const mdxExports = [
     "structuredData",
     "toc",
@@ -129,61 +180,76 @@ function getMDXLoaderOptions(_a) {
     ],
     mdxOptions.rehypePlugins
   );
-  return __spreadProps(__spreadValues({
-    providerImportSource: "next-mdx-import-source-file"
-  }, mdxOptions), {
+  return {
+    providerImportSource: "next-mdx-import-source-file",
+    ...mdxOptions,
     remarkPlugins,
     rehypePlugins
-  });
+  };
 }
 var createMDX = ({
   mdxOptions = {},
   cwd = process.cwd(),
   rootMapPath = "./.map.ts",
-  rootContentPath = "./content"
+  rootContentPath = "./content",
+  buildSearchIndex = false
 } = {}) => (nextConfig = {}) => {
-  const _mapPath = path.resolve(cwd, rootMapPath);
+  const rootMapFile = path2.resolve(cwd, rootMapPath);
+  const rootContentDir = path2.resolve(cwd, rootContentPath);
   const mdxLoaderOptions = getMDXLoaderOptions(mdxOptions);
-  return __spreadValues(__spreadValues({}, nextConfig), {
-    webpack: (config, options) => {
-      var _a, _b, _c;
-      config.resolve || (config.resolve = {});
-      const alias = config.resolve.alias;
-      alias["next-mdx-import-source-file"] = [
-        "private-next-root-dir/src/mdx-components",
-        "private-next-root-dir/mdx-components",
-        "@mdx-js/react"
-      ];
-      config.module || (config.module = {});
-      (_a = config.module).rules || (_a.rules = []);
-      config.module.rules.push(
-        {
-          test: /\.mdx?$/,
-          use: [
-            options.defaultLoaders.babel,
-            {
-              loader: "fumadocs-mdx/loader-mdx",
-              options: mdxLoaderOptions
-            }
-          ]
-        },
-        {
-          test: _mapPath,
-          use: {
-            loader: "fumadocs-mdx/loader",
-            options: {
-              cwd,
-              rootContentPath,
-              mapPath: _mapPath
+  return {
+    ...nextConfig,
+    ...{
+      webpack: (config, options) => {
+        config.resolve ||= {};
+        const alias = config.resolve.alias;
+        alias["next-mdx-import-source-file"] = [
+          "private-next-root-dir/src/mdx-components",
+          "private-next-root-dir/mdx-components",
+          "@mdx-js/react"
+        ];
+        config.module ||= {};
+        config.module.rules ||= [];
+        config.module.rules.push(
+          {
+            test: /\.mdx?$/,
+            use: [
+              options.defaultLoaders.babel,
+              {
+                loader: "fumadocs-mdx/loader-mdx",
+                options: mdxLoaderOptions
+              }
+            ]
+          },
+          {
+            test: rootMapFile,
+            use: {
+              loader: "fumadocs-mdx/loader",
+              options: {
+                rootContentDir,
+                rootMapFile
+              }
             }
           }
-        }
-      );
-      config.plugins || (config.plugins = []);
-      config.plugins.push(new MapWebpackPlugin({ rootMapFile: _mapPath }));
-      return (_c = (_b = nextConfig.webpack) == null ? void 0 : _b.call(nextConfig, config, options)) != null ? _c : config;
+        );
+        config.plugins ||= [];
+        config.plugins.push(
+          new MapWebpackPlugin({
+            rootMapFile
+          })
+        );
+        if (buildSearchIndex !== false)
+          config.plugins.push(
+            new SearchIndexPlugin({
+              rootContentDir,
+              rootMapFile,
+              ...buildSearchIndex
+            })
+          );
+        return nextConfig.webpack?.(config, options) ?? config;
+      }
     }
-  });
+  };
 };
 export {
   createMDX as default

package/dist/index.d.mts

@@ -3,6 +3,7 @@ import { z } from 'zod';
 import { MDXProps } from 'mdx/types';
 import { StructuredData } from 'fumadocs-core/mdx-plugins';
 import { TableOfContents } from 'fumadocs-core/server';
+export { S as SearchIndex } from './search-index-plugin-qbqv40V1.mjs';
 
 declare const defaultSchemas: {
     frontmatter: z.ZodObject<{

package/dist/index.mjs

@@ -1,11 +1,5 @@
-import {
-  __objRest,
-  __spreadProps,
-  __spreadValues
-} from "./chunk-P26LYDRL.mjs";
-
 // src/resolve-files.ts
-import path from "path";
+import path from "node:path";
 
 // src/utils/schema.ts
 import { z } from "zod";
@@ -41,7 +35,6 @@ function resolveFiles({
   rootDir = "",
   schema = {}
 }) {
-  var _a, _c;
   const outputs = [];
   for (const [file, value] of Object.entries(map)) {
     if (!file.startsWith(rootDir))
@@ -51,23 +44,24 @@ function resolveFiles({
       outputs.push({
         type: "meta",
         path: file,
-        data: parse((_a = schema.meta) != null ? _a : defaultSchemas.meta, value, file)
+        data: parse(schema.meta ?? defaultSchemas.meta, value, file)
       });
       continue;
     }
     if (pageTypes.includes(parsed.ext)) {
-      const _b = value, { frontmatter } = _b, data = __objRest(_b, ["frontmatter"]);
+      const { frontmatter, ...data } = value;
       const parsedFrontmatter = parse(
-        (_c = schema.frontmatter) != null ? _c : defaultSchemas.frontmatter,
+        schema.frontmatter ?? defaultSchemas.frontmatter,
         frontmatter,
         file
       );
       outputs.push({
         type: "page",
         path: file,
-        data: __spreadProps(__spreadValues({}, parsedFrontmatter), {
+        data: {
+          ...parsedFrontmatter,
           exports: data
-        })
+        }
       });
       continue;
     }
@@ -79,13 +73,14 @@ function resolveFiles({
 // src/create.ts
 function createMDXSource(map, options) {
   return {
-    files: (rootDir) => loadMDXSource(map, __spreadProps(__spreadValues({}, options), { rootDir }))
+    files: (rootDir) => loadMDXSource(map, { ...options, rootDir })
   };
 }
 function loadMDXSource(map, options) {
-  return resolveFiles(__spreadValues({
-    map
-  }, options));
+  return resolveFiles({
+    map,
+    ...options
+  });
 }
 export {
   createMDXSource,

package/dist/loader-mdx.d.mts

@@ -8,6 +8,15 @@ interface Options extends ProcessorOptions {
      */
     lastModifiedTime?: 'git' | 'none';
 }
+interface InternalBuildInfo {
+    __fumadocs?: {
+        path: string;
+        /**
+         * `vfile.data` parsed from file
+         */
+        data: unknown;
+    };
+}
 /**
  * Load MDX/markdown files
  *
@@ -15,4 +24,4 @@ interface Options extends ProcessorOptions {
  */
 declare function loader(this: LoaderContext<Options>, source: string, callback: LoaderContext<Options>['callback']): Promise<void>;
 
-export { type Options, loader as default };
+export { type InternalBuildInfo, type Options, loader as default };

package/dist/loader-mdx.mjs

@@ -1,18 +1,11 @@
-import {
-  __async,
-  __objRest,
-  __spreadProps,
-  __spreadValues
-} from "./chunk-P26LYDRL.mjs";
-
 // src/loader-mdx.ts
-import path2 from "path";
+import path2 from "node:path";
 import { createProcessor } from "@mdx-js/mdx";
 import grayMatter from "gray-matter";
 
 // src/utils/git-timestamp.ts
-import path from "path";
-import fs from "fs";
+import path from "node:path";
+import fs from "node:fs";
 import { spawn } from "cross-spawn";
 var cache = /* @__PURE__ */ new Map();
 function getGitTimestamp(file) {
@@ -42,51 +35,48 @@ function getGitTimestamp(file) {
 
 // src/loader-mdx.ts
 var cache2 = /* @__PURE__ */ new Map();
-function loader(source, callback) {
-  return __async(this, null, function* () {
-    var _b, _c;
-    this.cacheable(true);
-    const context = this.context;
-    const filePath = this.resourcePath;
-    const _a = this.getOptions(), { lastModifiedTime } = _a, options = __objRest(_a, ["lastModifiedTime"]);
-    const { content, data: frontmatter } = grayMatter(source);
-    const detectedFormat = filePath.endsWith(".mdx") ? "mdx" : "md";
-    const format = (_b = options.format) != null ? _b : detectedFormat;
-    let timestamp;
-    let processor = cache2.get(format);
-    if (processor === void 0) {
-      processor = createProcessor(__spreadProps(__spreadValues({}, options), {
-        development: this.mode === "development",
-        format
-      }));
-      cache2.set(format, processor);
+async function loader(source, callback) {
+  this.cacheable(true);
+  const context = this.context;
+  const filePath = this.resourcePath;
+  const { lastModifiedTime, ...options } = this.getOptions();
+  const { content, data: frontmatter } = grayMatter(source);
+  const detectedFormat = filePath.endsWith(".mdx") ? "mdx" : "md";
+  const format = options.format ?? detectedFormat;
+  let timestamp;
+  let processor = cache2.get(format);
+  if (processor === void 0) {
+    processor = createProcessor({
+      ...options,
+      development: this.mode === "development",
+      format
+    });
+    cache2.set(format, processor);
+  }
+  if (lastModifiedTime === "git")
+    timestamp = (await getGitTimestamp(filePath))?.getTime();
+  processor.process({
+    value: content,
+    path: filePath,
+    data: {
+      lastModified: timestamp,
+      frontmatter
     }
-    if (lastModifiedTime === "git")
-      timestamp = (_c = yield getGitTimestamp(filePath)) == null ? void 0 : _c.getTime();
-    processor.process({
-      value: content,
-      path: filePath,
-      data: {
-        lastModified: timestamp,
-        frontmatter
-      }
-    }).then(
-      (file) => {
-        var _a2;
-        const info = (_a2 = this._module) == null ? void 0 : _a2.buildInfo;
-        info.__next_docs = {
-          path: filePath,
-          data: file.data
-        };
-        callback(void 0, String(file.value), file.map || void 0);
-      },
-      (error) => {
-        const fpath = path2.relative(context, filePath);
-        error.message = `${fpath}:${error.name}: ${error.message}`;
-        callback(error);
-      }
-    );
-  });
+  }).then(
+    (file) => {
+      const info = this._module?.buildInfo;
+      info.__fumadocs = {
+        path: filePath,
+        data: file.data
+      };
+      callback(void 0, String(file.value), file.map ?? void 0);
+    },
+    (error) => {
+      const fpath = path2.relative(context, filePath);
+      error.message = `${fpath}:${error.name}: ${error.message}`;
+      callback(error);
+    }
+  );
 }
 export {
   loader as default

package/dist/loader.d.mts

@@ -1,9 +1,8 @@
 import { LoaderContext } from 'webpack';
 
 interface LoaderOptions {
-    rootContentPath: string;
-    mapPath: string;
-    cwd: string;
+    rootContentDir: string;
+    rootMapFile: string;
 }
 /**
  * Load the root `.map.ts` file

package/dist/loader.mjs

@@ -1,24 +1,21 @@
-import "./chunk-P26LYDRL.mjs";
-
 // src/loader.ts
-import path from "path";
+import path from "node:path";
 import fg from "fast-glob";
 function loader(_source, callback) {
   const options = this.getOptions();
   this.cacheable(true);
-  this.addContextDependency(path.resolve(options.cwd, options.rootContentPath));
+  this.addContextDependency(options.rootContentDir);
   callback(null, buildMap(options));
 }
-function buildMap({ cwd, rootContentPath, mapPath }) {
-  const mapDir = path.dirname(mapPath);
-  const absoluteContentPath = path.resolve(cwd, rootContentPath);
+function buildMap({ rootContentDir, rootMapFile }) {
+  const mapDir = path.dirname(rootMapFile);
   const files = fg.sync("./**/*.{md,mdx,json}", {
-    cwd: absoluteContentPath
+    cwd: rootContentDir
   });
   const imports = [];
   const entries = [];
   files.forEach((file, i) => {
-    let importPath = path.relative(mapDir, path.join(absoluteContentPath, file)).replaceAll(path.sep, "/");
+    let importPath = path.relative(mapDir, path.join(rootContentDir, file)).replaceAll(path.sep, "/");
     if (!importPath.startsWith(".")) {
       importPath = `./${importPath}`;
     }

package/dist/search-index-plugin-qbqv40V1.d.mts

@@ -0,0 +1,34 @@
+import { StructuredData } from 'fumadocs-core/mdx-plugins';
+
+interface SearchIndex {
+    id: string;
+    title: string;
+    description?: string;
+    url: string;
+    structuredData: StructuredData;
+}
+interface Options {
+    /**
+     * Only enable at production builds, default: `true`
+     */
+    productionOnly?: boolean;
+    /**
+     * Absolute path of root content directory
+     */
+    rootContentDir: string;
+    rootMapFile: string;
+    /**
+     * @param path - MDX file path relative to root content dir
+     * @returns page URL
+     */
+    getUrl?: (path: string) => string;
+    /**
+     * Filter MDX files with specific path
+     *
+     * @param path - MDX file path relative to root content dir
+     * @returns whether should include this item in search indexes
+     */
+    filter?: (path: string) => boolean;
+}
+
+export type { Options as O, SearchIndex as S };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-mdx",
-  "version": "8.1.1",
+  "version": "8.2.0",
   "description": "The built-in source for Fumadocs",
   "keywords": [
     "NextJs",
@@ -37,27 +37,27 @@
     "loader.js"
   ],
   "dependencies": {
-    "@mdx-js/mdx": "^3.0.0",
+    "@mdx-js/mdx": "^3.0.1",
     "cross-spawn": "^7.0.3",
     "estree-util-value-to-estree": "^3.0.1",
     "fast-glob": "^3.3.1",
     "gray-matter": "^4.0.3",
     "zod": "^3.22.4",
-    "fumadocs-core": "10.0.0"
+    "fumadocs-core": "10.0.1"
   },
   "devDependencies": {
-    "@types/cross-spawn": "^6.0.4",
+    "@types/cross-spawn": "^6.0.6",
     "@types/mdast": "^4.0.3",
-    "@types/mdx": "^2.0.8",
-    "@types/react": "18.2.0",
-    "next": "14.1.1",
+    "@types/mdx": "^2.0.11",
+    "@types/react": "^18.2.0",
+    "next": "^14.1.2",
     "unified": "^11.0.4",
-    "webpack": "^5.89.0",
+    "webpack": "^5.90.3",
     "eslint-config-custom": "0.0.0",
     "tsconfig": "0.0.0"
   },
   "peerDependencies": {
-    "next": ">= 13.4"
+    "next": ">= 14.1.0"
   },
   "publishConfig": {
     "access": "public"

package/dist/chunk-P26LYDRL.mjs

@@ -1,58 +0,0 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __objRest = (source, exclude) => {
-  var target = {};
-  for (var prop in source)
-    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
-      target[prop] = source[prop];
-  if (source != null && __getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(source)) {
-      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
-        target[prop] = source[prop];
-    }
-  return target;
-};
-var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
-    var fulfilled = (value) => {
-      try {
-        step(generator.next(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var rejected = (value) => {
-      try {
-        step(generator.throw(value));
-      } catch (e) {
-        reject(e);
-      }
-    };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
-    step((generator = generator.apply(__this, __arguments)).next());
-  });
-};
-
-export {
-  __spreadValues,
-  __spreadProps,
-  __objRest,
-  __async
-};