@rspress/plugin-typedoc 1.37.1 → 1.37.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-typedoc",
-  "version": "1.37.1",
+  "version": "1.37.3",
   "description": "A plugin for rspress to integrate typedoc",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -17,7 +17,9 @@
     "node": ">=14.17.6"
   },
   "devDependencies": {
-    "@modern-js/tsconfig": "2.62.0",
+    "@microsoft/api-extractor": "^7.48.0",
+    "@modern-js/tsconfig": "2.63.0",
+    "@rslib/core": "0.1.0",
     "@types/node": "^18.11.17",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
@@ -26,7 +28,7 @@
     "vitest": "2.1.5"
   },
   "peerDependencies": {
-    "rspress": "^1.37.1"
+    "rspress": "^1.37.3"
   },
   "sideEffects": [
     "*.css",
@@ -46,11 +48,11 @@
   "dependencies": {
     "typedoc": "0.24.8",
     "typedoc-plugin-markdown": "3.17.1",
-    "@rspress/shared": "1.37.1"
+    "@rspress/shared": "1.37.3"
   },
   "scripts": {
-    "dev": "modern build -w",
-    "build": "modern build",
+    "dev": "rslib build -w",
+    "build": "rslib build",
     "reset": "rimraf ./**/node_modules",
     "test": "vitest run --passWithNoTests"
   }

package/src/constants.ts

@@ -1,2 +1 @@
 export const API_DIR = 'api';
-export const ROUTE_PREFIX = `/${API_DIR}`;

package/src/index.ts

@@ -1,12 +1,9 @@
 import path from 'node:path';
 import { Application, TSConfigReader } from 'typedoc';
-import type { RspressPlugin } from '@rspress/shared';
+import type { NavItem, RspressPlugin } from '@rspress/shared';
 import { load } from 'typedoc-plugin-markdown';
 import { API_DIR } from './constants';
-import {
-  resolveSidebarForMultiEntry,
-  resolveSidebarForSingleEntry,
-} from './sidebar';
+import { patchGeneratedApiDocs } from './patch';
 
 export interface PluginTypeDocOptions {
   /**
@@ -24,12 +21,13 @@ export interface PluginTypeDocOptions {
 export function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {
   let docRoot: string | undefined;
   const { entryPoints = [], outDir = API_DIR } = options;
+  const apiPageRoute = `/${outDir.replace(/(^\/)|(\/$)/, '')}/`; // e.g: /api/
   return {
     name: '@rspress/plugin-typedoc',
     async addPages() {
       return [
         {
-          routePath: `${outDir.replace(/\/$/, '')}/`,
+          routePath: apiPageRoute,
           filepath: path.join(docRoot!, outDir, 'README.md'),
         },
       ];
@@ -56,41 +54,49 @@ export function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {
       const project = app.convert();
 
       if (project) {
-        // 1. Generate module doc by typedoc
-        const absoluteOutputdir = path.join(docRoot!, outDir);
-        await app.generateDocs(project, absoluteOutputdir);
-        const jsonDir = path.join(absoluteOutputdir, 'documentation.json');
-        await app.generateJson(project, jsonDir);
-        // 2. Generate sidebar
+        // 1. Generate doc/api, doc/api/_meta.json by typedoc
+        const absoluteApiDir = path.join(docRoot!, outDir);
+        await app.generateDocs(project, absoluteApiDir);
+        await patchGeneratedApiDocs(absoluteApiDir);
+
+        // 2. Generate "api" nav bar
         config.themeConfig = config.themeConfig || {};
         config.themeConfig.nav = config.themeConfig.nav || [];
-        const apiIndexLink = `/${outDir.replace(/(^\/)|(\/$)/, '')}/`;
         const { nav } = config.themeConfig;
+
+        // avoid that user config "api" in doc/_meta.json
+        function isApiAlreadyInNav(navList: NavItem[]) {
+          return navList.some(item => {
+            if (
+              'link' in item &&
+              typeof item.link === 'string' &&
+              item.link.startsWith(
+                apiPageRoute.slice(0, apiPageRoute.length - 1), // /api
+              )
+            ) {
+              return true;
+            }
+            return false;
+          });
+        }
+
         // Note: TypeDoc does not support i18n
         if (Array.isArray(nav)) {
-          nav.push({
-            text: 'API',
-            link: apiIndexLink,
-          });
+          if (!isApiAlreadyInNav(nav)) {
+            nav.push({
+              text: 'API',
+              link: apiPageRoute,
+            });
+          }
         } else if ('default' in nav) {
-          nav.default.push({
-            text: 'API',
-            link: apiIndexLink,
-          });
+          if (!isApiAlreadyInNav(nav.default)) {
+            nav.default.push({
+              text: 'API',
+              link: apiPageRoute,
+            });
+          }
         }
-
-        config.themeConfig.sidebar = config.themeConfig.sidebar || {};
-        config.themeConfig.sidebar[apiIndexLink] =
-          entryPoints.length > 1
-            ? await resolveSidebarForMultiEntry(jsonDir)
-            : await resolveSidebarForSingleEntry(jsonDir);
-        config.themeConfig.sidebar[apiIndexLink].unshift({
-          text: 'Overview',
-          link: `${apiIndexLink}README`,
-        });
       }
-      config.route = config.route || {};
-      config.route.exclude = config.route.exclude || [];
       return config;
     },
   };

package/src/patch.ts

@@ -0,0 +1,72 @@
+import fs from '@rspress/shared/fs-extra';
+import path from 'node:path';
+
+async function patchLinks(outputDir: string) {
+  // Patch links in markdown files
+  // Scan all the markdown files in the output directory
+  // replace
+  // 1. [foo](bar) -> [foo](./bar)
+  // 2. [foo](./bar) -> [foo](./bar) no change
+  const normlizeLinksInFile = async (filePath: string) => {
+    const content = await fs.readFile(filePath, 'utf-8');
+    // 1. [foo](bar) -> [foo](./bar)
+    const newContent = content.replace(
+      /\[([^\]]+)\]\(([^)]+)\)/g,
+      (_match, p1, p2) => {
+        // 2. [foo](./bar) -> [foo](./bar) no change
+        if (['/', '.'].includes(p2[0])) {
+          return `[${p1}](${p2})`;
+        }
+        return `[${p1}](./${p2})`;
+      },
+    );
+    await fs.writeFile(filePath, newContent);
+  };
+
+  const traverse = async (dir: string) => {
+    const files = await fs.readdir(dir);
+    const filePaths = files.map(file => path.join(dir, file));
+    const stats = await Promise.all(filePaths.map(fp => fs.stat(fp)));
+
+    await Promise.all(
+      stats.map((stat, index) => {
+        const file = files[index];
+        const filePath = filePaths[index];
+        if (stat.isDirectory()) {
+          return traverse(filePath);
+        }
+        if (stat.isFile() && /\.mdx?/.test(file)) {
+          return normlizeLinksInFile(filePath);
+        }
+      }),
+    );
+  };
+  await traverse(outputDir);
+}
+
+async function generateMetaJson(absoluteApiDir: string) {
+  const metaJsonPath = path.join(absoluteApiDir, '_meta.json');
+
+  const files = await fs.readdir(absoluteApiDir);
+  const filePaths = files.map(file => path.join(absoluteApiDir, file));
+  const stats = await Promise.all(filePaths.map(fp => fs.stat(fp)));
+  const dirs = stats
+    .map((stat, index) => (stat.isDirectory() ? files[index] : null))
+    .filter(Boolean) as string[];
+
+  const meta = dirs.map(dir => ({
+    type: 'dir',
+    label: dir.slice(0, 1).toUpperCase() + dir.slice(1),
+    name: dir,
+  }));
+  await fs.writeFile(metaJsonPath, JSON.stringify(['index', ...meta]));
+}
+
+export async function patchGeneratedApiDocs(absoluteApiDir: string) {
+  await patchLinks(absoluteApiDir);
+  await fs.rename(
+    path.join(absoluteApiDir, 'README.md'),
+    path.join(absoluteApiDir, 'index.md'),
+  );
+  await generateMetaJson(absoluteApiDir);
+}

package/dist/es/index.d.ts

@@ -1,17 +0,0 @@
-import { RspressPlugin } from '@rspress/shared';
-
-interface PluginTypeDocOptions {
-    /**
-     * The entry points of modules.
-     * @default []
-     */
-    entryPoints: string[];
-    /**
-     * The output directory.
-     * @default 'api'
-     */
-    outDir?: string;
-}
-declare function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin;
-
-export { type PluginTypeDocOptions, pluginTypeDoc };

package/dist/es/index.js

@@ -1,253 +0,0 @@
-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());
-  });
-};
-
-// src/index.ts
-import path2 from "path";
-import { Application, TSConfigReader } from "typedoc";
-import { load } from "typedoc-plugin-markdown";
-
-// src/constants.ts
-var API_DIR = "api";
-var ROUTE_PREFIX = `/${API_DIR}`;
-
-// src/sidebar.ts
-import path from "path";
-import fs from "@rspress/shared/fs-extra";
-
-// src/utils.ts
-function transformModuleName(name) {
-  return name.replace(/\//g, "_").replace(/-/g, "_");
-}
-
-// src/sidebar.ts
-function patchLinks(outputDir) {
-  return __async(this, null, function* () {
-    const normlizeLinksInFile = (filePath) => __async(this, null, function* () {
-      const content = yield fs.readFile(filePath, "utf-8");
-      const newContent = content.replace(
-        /\[([^\]]+)\]\(([^)]+)\)/g,
-        (_match, p1, p2) => {
-          return `[${p1}](./${p2})`;
-        }
-      );
-      yield fs.writeFile(filePath, newContent);
-    });
-    const traverse = (dir) => __async(this, null, function* () {
-      const files = yield fs.readdir(dir);
-      for (const file of files) {
-        const filePath = path.join(dir, file);
-        const stat = yield fs.stat(filePath);
-        if (stat.isDirectory()) {
-          yield traverse(filePath);
-        } else if (stat.isFile() && /\.mdx?/.test(file)) {
-          yield normlizeLinksInFile(filePath);
-        }
-      }
-    });
-    yield traverse(outputDir);
-  });
-}
-function resolveSidebarForSingleEntry(jsonFile) {
-  return __async(this, null, function* () {
-    const result = [];
-    const data = JSON.parse(yield fs.readFile(jsonFile, "utf-8"));
-    if (!data.children || data.children.length <= 0) {
-      return [];
-    }
-    const symbolMap = /* @__PURE__ */ new Map();
-    data.groups.forEach((group) => {
-      const groupItem = {
-        text: group.title,
-        items: []
-      };
-      group.children.forEach((id) => {
-        const dataItem = data.children.find((item) => item.id === id);
-        if (dataItem) {
-          let fileName = dataItem.name;
-          if (symbolMap.has(dataItem.name)) {
-            const count = symbolMap.get(dataItem.name) + 1;
-            symbolMap.set(dataItem.name, count);
-            fileName = `${dataItem.name}-${count}`;
-          } else {
-            symbolMap.set(dataItem.name.toLocaleLowerCase(), 0);
-          }
-          groupItem.items.push({
-            text: dataItem.name,
-            link: `${ROUTE_PREFIX}/${group.title.toLocaleLowerCase()}/${fileName}`
-          });
-        }
-      });
-      result.push(groupItem);
-    });
-    yield patchLinks(path.dirname(jsonFile));
-    return result;
-  });
-}
-function resolveSidebarForMultiEntry(jsonFile) {
-  return __async(this, null, function* () {
-    const result = [];
-    const data = JSON.parse(yield fs.readFile(jsonFile, "utf-8"));
-    if (!data.children || data.children.length <= 0) {
-      return result;
-    }
-    function getModulePath(name) {
-      return path.join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`).replace(/\\/g, "/");
-    }
-    function getClassPath(moduleName, className) {
-      return path.join(
-        `${ROUTE_PREFIX}/classes`,
-        `${transformModuleName(moduleName)}.${className}`
-      ).replace(/\\/g, "/");
-    }
-    function getInterfacePath(moduleName, interfaceName) {
-      return path.join(
-        `${ROUTE_PREFIX}/interfaces`,
-        `${transformModuleName(moduleName)}.${interfaceName}`
-      ).replace(/\\/g, "/");
-    }
-    function getFunctionPath(moduleName, functionName) {
-      return path.join(
-        `${ROUTE_PREFIX}/functions`,
-        `${transformModuleName(moduleName)}.${functionName}`
-      ).replace(/\\/g, "/");
-    }
-    data.children.forEach((module) => {
-      const moduleNames = module.name.split("/");
-      const name = moduleNames[moduleNames.length - 1];
-      const moduleConfig = {
-        text: `Module:${name}`,
-        items: [{ text: "Overview", link: getModulePath(module.name) }]
-      };
-      if (!module.children || module.children.length <= 0) {
-        return;
-      }
-      module.children.forEach((sub) => {
-        var _a;
-        const kindString = (_a = module.groups.find((item) => item.children.includes(sub.id))) == null ? void 0 : _a.title.slice(0, -1);
-        if (!kindString) {
-          return;
-        }
-        switch (kindString) {
-          case "Class":
-            moduleConfig.items.push({
-              text: `Class:${sub.name}`,
-              link: getClassPath(module.name, sub.name)
-            });
-            break;
-          case "Interface":
-            moduleConfig.items.push({
-              text: `Interface:${sub.name}`,
-              link: getInterfacePath(module.name, sub.name)
-            });
-            break;
-          case "Function":
-            moduleConfig.items.push({
-              text: `Function:${sub.name}`,
-              link: getFunctionPath(module.name, sub.name)
-            });
-            break;
-          default:
-            break;
-        }
-      });
-      result.push(moduleConfig);
-    });
-    yield patchLinks(path.dirname(jsonFile));
-    return result;
-  });
-}
-
-// src/index.ts
-function pluginTypeDoc(options) {
-  let docRoot;
-  const { entryPoints = [], outDir = API_DIR } = options;
-  return {
-    name: "@rspress/plugin-typedoc",
-    addPages() {
-      return __async(this, null, function* () {
-        return [
-          {
-            routePath: `${outDir.replace(/\/$/, "")}/`,
-            filepath: path2.join(docRoot, outDir, "README.md")
-          }
-        ];
-      });
-    },
-    config(config) {
-      return __async(this, null, function* () {
-        const app = new Application();
-        docRoot = config.root;
-        app.options.addReader(new TSConfigReader());
-        load(app);
-        app.bootstrap({
-          name: config.title,
-          entryPoints,
-          theme: "markdown",
-          disableSources: true,
-          readme: "none",
-          githubPages: false,
-          requiredToBeDocumented: ["Class", "Function", "Interface"],
-          plugin: ["typedoc-plugin-markdown"],
-          // @ts-expect-error MarkdownTheme has no export
-          hideBreadcrumbs: true,
-          hideMembersSymbol: true,
-          allReflectionsHaveOwnDocument: true
-        });
-        const project = app.convert();
-        if (project) {
-          const absoluteOutputdir = path2.join(docRoot, outDir);
-          yield app.generateDocs(project, absoluteOutputdir);
-          const jsonDir = path2.join(absoluteOutputdir, "documentation.json");
-          yield app.generateJson(project, jsonDir);
-          config.themeConfig = config.themeConfig || {};
-          config.themeConfig.nav = config.themeConfig.nav || [];
-          const apiIndexLink = `/${outDir.replace(/(^\/)|(\/$)/, "")}/`;
-          const { nav } = config.themeConfig;
-          if (Array.isArray(nav)) {
-            nav.push({
-              text: "API",
-              link: apiIndexLink
-            });
-          } else if ("default" in nav) {
-            nav.default.push({
-              text: "API",
-              link: apiIndexLink
-            });
-          }
-          config.themeConfig.sidebar = config.themeConfig.sidebar || {};
-          config.themeConfig.sidebar[apiIndexLink] = entryPoints.length > 1 ? yield resolveSidebarForMultiEntry(jsonDir) : yield resolveSidebarForSingleEntry(jsonDir);
-          config.themeConfig.sidebar[apiIndexLink].unshift({
-            text: "Overview",
-            link: `${apiIndexLink}README`
-          });
-        }
-        config.route = config.route || {};
-        config.route.exclude = config.route.exclude || [];
-        return config;
-      });
-    }
-  };
-}
-export {
-  pluginTypeDoc
-};
-
-//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +0,0 @@
-{"version":3,"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,OAAOA,WAAU;AACjB,SAAS,aAAa,sBAAsB;AAE5C,SAAS,YAAY;;;ACHd,IAAM,UAAU;AAChB,IAAM,eAAe,IAAI,OAAO;;;ACDvC,OAAO,UAAU;AACjB,OAAO,QAAQ;;;ACDR,SAAS,oBAAoB,MAAc;AAChD,SAAO,KAAK,QAAQ,OAAO,GAAG,EAAE,QAAQ,MAAM,GAAG;AACnD;;;ADiBA,SAAe,WAAW,WAAmB;AAAA;AAI3C,UAAM,sBAAsB,CAAO,aAAqB;AACtD,YAAM,UAAU,MAAM,GAAG,SAAS,UAAU,OAAO;AAEnD,YAAM,aAAa,QAAQ;AAAA,QACzB;AAAA,QACA,CAAC,QAAQ,IAAI,OAAO;AAClB,iBAAO,IAAI,EAAE,OAAO,EAAE;AAAA,QACxB;AAAA,MACF;AACA,YAAM,GAAG,UAAU,UAAU,UAAU;AAAA,IACzC;AAEA,UAAM,WAAW,CAAO,QAAgB;AACtC,YAAM,QAAQ,MAAM,GAAG,QAAQ,GAAG;AAClC,iBAAW,QAAQ,OAAO;AACxB,cAAM,WAAW,KAAK,KAAK,KAAK,IAAI;AACpC,cAAM,OAAO,MAAM,GAAG,KAAK,QAAQ;AACnC,YAAI,KAAK,YAAY,GAAG;AACtB,gBAAM,SAAS,QAAQ;AAAA,QACzB,WAAW,KAAK,OAAO,KAAK,SAAS,KAAK,IAAI,GAAG;AAC/C,gBAAM,oBAAoB,QAAQ;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AACA,UAAM,SAAS,SAAS;AAAA,EAC1B;AAAA;AAEA,SAAsB,6BACpB,UACyB;AAAA;AACzB,UAAM,SAAyB,CAAC;AAChC,UAAM,OAAO,KAAK,MAAM,MAAM,GAAG,SAAS,UAAU,OAAO,CAAC;AAC5D,QAAI,CAAC,KAAK,YAAY,KAAK,SAAS,UAAU,GAAG;AAC/C,aAAO,CAAC;AAAA,IACV;AACA,UAAM,YAAY,oBAAI,IAAoB;AAC1C,SAAK,OAAO,QAAQ,CAAC,UAAiD;AACpE,YAAM,YAA0B;AAAA,QAC9B,MAAM,MAAM;AAAA,QACZ,OAAO,CAAC;AAAA,MACV;AACA,YAAM,SAAS,QAAQ,CAAC,OAAe;AACrC,cAAM,WAAW,KAAK,SAAS,KAAK,CAAC,SAAqB,KAAK,OAAO,EAAE;AACxE,YAAI,UAAU;AAIZ,cAAI,WAAW,SAAS;AACxB,cAAI,UAAU,IAAI,SAAS,IAAI,GAAG;AAChC,kBAAM,QAAQ,UAAU,IAAI,SAAS,IAAI,IAAK;AAC9C,sBAAU,IAAI,SAAS,MAAM,KAAK;AAClC,uBAAW,GAAG,SAAS,IAAI,IAAI,KAAK;AAAA,UACtC,OAAO;AACL,sBAAU,IAAI,SAAS,KAAK,kBAAkB,GAAG,CAAC;AAAA,UACpD;AACA,oBAAU,MAAM,KAAK;AAAA,YACnB,MAAM,SAAS;AAAA,YACf,MAAM,GAAG,YAAY,IAAI,MAAM,MAAM,kBAAkB,CAAC,IAAI,QAAQ;AAAA,UACtE,CAAC;AAAA,QACH;AAAA,MACF,CAAC;AACD,aAAO,KAAK,SAAS;AAAA,IACvB,CAAC;AAED,UAAM,WAAW,KAAK,QAAQ,QAAQ,CAAC;AAEvC,WAAO;AAAA,EACT;AAAA;AAEA,SAAsB,4BACpB,UACyB;AAAA;AACzB,UAAM,SAAyB,CAAC;AAChC,UAAM,OAAO,KAAK,MAAM,MAAM,GAAG,SAAS,UAAU,OAAO,CAAC;AAC5D,QAAI,CAAC,KAAK,YAAY,KAAK,SAAS,UAAU,GAAG;AAC/C,aAAO;AAAA,IACT;AAEA,aAAS,cAAc,MAAc;AACnC,aAAO,KACJ,KAAK,GAAG,YAAY,YAAY,GAAG,oBAAoB,IAAI,CAAC,EAAE,EAC9D,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,aAAa,YAAoB,WAAmB;AAC3D,aAAO,KACJ;AAAA,QACC,GAAG,YAAY;AAAA,QACf,GAAG,oBAAoB,UAAU,CAAC,IAAI,SAAS;AAAA,MACjD,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,iBAAiB,YAAoB,eAAuB;AACnE,aAAO,KACJ;AAAA,QACC,GAAG,YAAY;AAAA,QACf,GAAG,oBAAoB,UAAU,CAAC,IAAI,aAAa;AAAA,MACrD,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,gBAAgB,YAAoB,cAAsB;AACjE,aAAO,KACJ;AAAA,QACC,GAAG,YAAY;AAAA,QACf,GAAG,oBAAoB,UAAU,CAAC,IAAI,YAAY;AAAA,MACpD,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,SAAK,SAAS,QAAQ,CAAC,WAAuB;AAC5C,YAAM,cAAc,OAAO,KAAK,MAAM,GAAG;AACzC,YAAM,OAAO,YAAY,YAAY,SAAS,CAAC;AAC/C,YAAM,eAAe;AAAA,QACnB,MAAM,UAAU,IAAI;AAAA,QACpB,OAAO,CAAC,EAAE,MAAM,YAAY,MAAM,cAAc,OAAO,IAAI,EAAE,CAAC;AAAA,MAChE;AACA,UAAI,CAAC,OAAO,YAAY,OAAO,SAAS,UAAU,GAAG;AACnD;AAAA,MACF;AACA,aAAO,SAAS,QAAQ,SAAO;AAhJnC;AAiJM,cAAM,cAAa,YAAO,OACvB,KAAK,UAAQ,KAAK,SAAS,SAAS,IAAI,EAAE,CAAC,MAD3B,mBAEf,MAAM,MAAM,GAAG;AACnB,YAAI,CAAC,YAAY;AACf;AAAA,QACF;AACA,gBAAQ,YAAY;AAAA,UAClB,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,SAAS,IAAI,IAAI;AAAA,cACvB,MAAM,aAAa,OAAO,MAAM,IAAI,IAAI;AAAA,YAC1C,CAAC;AACD;AAAA,UACF,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,aAAa,IAAI,IAAI;AAAA,cAC3B,MAAM,iBAAiB,OAAO,MAAM,IAAI,IAAI;AAAA,YAC9C,CAAC;AACD;AAAA,UACF,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,YAAY,IAAI,IAAI;AAAA,cAC1B,MAAM,gBAAgB,OAAO,MAAM,IAAI,IAAI;AAAA,YAC7C,CAAC;AACD;AAAA,UACF;AACE;AAAA,QACJ;AAAA,MACF,CAAC;AACD,aAAO,KAAK,YAAY;AAAA,IAC1B,CAAC;AACD,UAAM,WAAW,KAAK,QAAQ,QAAQ,CAAC;AACvC,WAAO;AAAA,EACT;AAAA;;;AF3JO,SAAS,cAAc,SAA8C;AAC1E,MAAI;AACJ,QAAM,EAAE,cAAc,CAAC,GAAG,SAAS,QAAQ,IAAI;AAC/C,SAAO;AAAA,IACL,MAAM;AAAA,IACA,WAAW;AAAA;AACf,eAAO;AAAA,UACL;AAAA,YACE,WAAW,GAAG,OAAO,QAAQ,OAAO,EAAE,CAAC;AAAA,YACvC,UAAUA,MAAK,KAAK,SAAU,QAAQ,WAAW;AAAA,UACnD;AAAA,QACF;AAAA,MACF;AAAA;AAAA,IACM,OAAO,QAAQ;AAAA;AACnB,cAAM,MAAM,IAAI,YAAY;AAC5B,kBAAU,OAAO;AACjB,YAAI,QAAQ,UAAU,IAAI,eAAe,CAAC;AAC1C,aAAK,GAAG;AACR,YAAI,UAAU;AAAA,UACZ,MAAM,OAAO;AAAA,UACb;AAAA,UACA,OAAO;AAAA,UACP,gBAAgB;AAAA,UAChB,QAAQ;AAAA,UACR,aAAa;AAAA,UACb,wBAAwB,CAAC,SAAS,YAAY,WAAW;AAAA,UACzD,QAAQ,CAAC,yBAAyB;AAAA;AAAA,UAElC,iBAAiB;AAAA,UACjB,mBAAmB;AAAA,UACnB,+BAA+B;AAAA,QACjC,CAAC;AACD,cAAM,UAAU,IAAI,QAAQ;AAE5B,YAAI,SAAS;AAEX,gBAAM,oBAAoBA,MAAK,KAAK,SAAU,MAAM;AACpD,gBAAM,IAAI,aAAa,SAAS,iBAAiB;AACjD,gBAAM,UAAUA,MAAK,KAAK,mBAAmB,oBAAoB;AACjE,gBAAM,IAAI,aAAa,SAAS,OAAO;AAEvC,iBAAO,cAAc,OAAO,eAAe,CAAC;AAC5C,iBAAO,YAAY,MAAM,OAAO,YAAY,OAAO,CAAC;AACpD,gBAAM,eAAe,IAAI,OAAO,QAAQ,eAAe,EAAE,CAAC;AAC1D,gBAAM,EAAE,IAAI,IAAI,OAAO;AAEvB,cAAI,MAAM,QAAQ,GAAG,GAAG;AACtB,gBAAI,KAAK;AAAA,cACP,MAAM;AAAA,cACN,MAAM;AAAA,YACR,CAAC;AAAA,UACH,WAAW,aAAa,KAAK;AAC3B,gBAAI,QAAQ,KAAK;AAAA,cACf,MAAM;AAAA,cACN,MAAM;AAAA,YACR,CAAC;AAAA,UACH;AAEA,iBAAO,YAAY,UAAU,OAAO,YAAY,WAAW,CAAC;AAC5D,iBAAO,YAAY,QAAQ,YAAY,IACrC,YAAY,SAAS,IACjB,MAAM,4BAA4B,OAAO,IACzC,MAAM,6BAA6B,OAAO;AAChD,iBAAO,YAAY,QAAQ,YAAY,EAAE,QAAQ;AAAA,YAC/C,MAAM;AAAA,YACN,MAAM,GAAG,YAAY;AAAA,UACvB,CAAC;AAAA,QACH;AACA,eAAO,QAAQ,OAAO,SAAS,CAAC;AAChC,eAAO,MAAM,UAAU,OAAO,MAAM,WAAW,CAAC;AAChD,eAAO;AAAA,MACT;AAAA;AAAA,EACF;AACF","names":["path"],"ignoreList":[],"sources":["../../src/index.ts","../../src/constants.ts","../../src/sidebar.ts","../../src/utils.ts"],"sourcesContent":["import path from 'node:path';\nimport { Application, TSConfigReader } from 'typedoc';\nimport type { RspressPlugin } from '@rspress/shared';\nimport { load } from 'typedoc-plugin-markdown';\nimport { API_DIR } from './constants';\nimport {\n  resolveSidebarForMultiEntry,\n  resolveSidebarForSingleEntry,\n} from './sidebar';\n\nexport interface PluginTypeDocOptions {\n  /**\n   * The entry points of modules.\n   * @default []\n   */\n  entryPoints: string[];\n  /**\n   * The output directory.\n   * @default 'api'\n   */\n  outDir?: string;\n}\n\nexport function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {\n  let docRoot: string | undefined;\n  const { entryPoints = [], outDir = API_DIR } = options;\n  return {\n    name: '@rspress/plugin-typedoc',\n    async addPages() {\n      return [\n        {\n          routePath: `${outDir.replace(/\\/$/, '')}/`,\n          filepath: path.join(docRoot!, outDir, 'README.md'),\n        },\n      ];\n    },\n    async config(config) {\n      const app = new Application();\n      docRoot = config.root;\n      app.options.addReader(new TSConfigReader());\n      load(app);\n      app.bootstrap({\n        name: config.title,\n        entryPoints,\n        theme: 'markdown',\n        disableSources: true,\n        readme: 'none',\n        githubPages: false,\n        requiredToBeDocumented: ['Class', 'Function', 'Interface'],\n        plugin: ['typedoc-plugin-markdown'],\n        // @ts-expect-error MarkdownTheme has no export\n        hideBreadcrumbs: true,\n        hideMembersSymbol: true,\n        allReflectionsHaveOwnDocument: true,\n      });\n      const project = app.convert();\n\n      if (project) {\n        // 1. Generate module doc by typedoc\n        const absoluteOutputdir = path.join(docRoot!, outDir);\n        await app.generateDocs(project, absoluteOutputdir);\n        const jsonDir = path.join(absoluteOutputdir, 'documentation.json');\n        await app.generateJson(project, jsonDir);\n        // 2. Generate sidebar\n        config.themeConfig = config.themeConfig || {};\n        config.themeConfig.nav = config.themeConfig.nav || [];\n        const apiIndexLink = `/${outDir.replace(/(^\\/)|(\\/$)/, '')}/`;\n        const { nav } = config.themeConfig;\n        // Note: TypeDoc does not support i18n\n        if (Array.isArray(nav)) {\n          nav.push({\n            text: 'API',\n            link: apiIndexLink,\n          });\n        } else if ('default' in nav) {\n          nav.default.push({\n            text: 'API',\n            link: apiIndexLink,\n          });\n        }\n\n        config.themeConfig.sidebar = config.themeConfig.sidebar || {};\n        config.themeConfig.sidebar[apiIndexLink] =\n          entryPoints.length > 1\n            ? await resolveSidebarForMultiEntry(jsonDir)\n            : await resolveSidebarForSingleEntry(jsonDir);\n        config.themeConfig.sidebar[apiIndexLink].unshift({\n          text: 'Overview',\n          link: `${apiIndexLink}README`,\n        });\n      }\n      config.route = config.route || {};\n      config.route.exclude = config.route.exclude || [];\n      return config;\n    },\n  };\n}\n","export const API_DIR = 'api';\nexport const ROUTE_PREFIX = `/${API_DIR}`;\n","import path from 'node:path';\nimport fs from '@rspress/shared/fs-extra';\nimport type { SidebarGroup } from '@rspress/shared';\nimport { transformModuleName } from './utils';\nimport { ROUTE_PREFIX } from './constants';\n\ninterface ModuleItem {\n  id: number;\n  name: string;\n  children: {\n    id: number;\n    name: string;\n  }[];\n  groups: {\n    title: string;\n    children: number[];\n  }[];\n}\n\nasync function patchLinks(outputDir: string) {\n  // Patch links in markdown files\n  // Scan all the markdown files in the output directory\n  // replace [foo](bar) -> [foo](./bar)\n  const normlizeLinksInFile = async (filePath: string) => {\n    const content = await fs.readFile(filePath, 'utf-8');\n    // replace: [foo](bar) -> [foo](./bar)\n    const newContent = content.replace(\n      /\\[([^\\]]+)\\]\\(([^)]+)\\)/g,\n      (_match, p1, p2) => {\n        return `[${p1}](./${p2})`;\n      },\n    );\n    await fs.writeFile(filePath, newContent);\n  };\n\n  const traverse = async (dir: string) => {\n    const files = await fs.readdir(dir);\n    for (const file of files) {\n      const filePath = path.join(dir, file);\n      const stat = await fs.stat(filePath);\n      if (stat.isDirectory()) {\n        await traverse(filePath);\n      } else if (stat.isFile() && /\\.mdx?/.test(file)) {\n        await normlizeLinksInFile(filePath);\n      }\n    }\n  };\n  await traverse(outputDir);\n}\n\nexport async function resolveSidebarForSingleEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return [];\n  }\n  const symbolMap = new Map<string, number>();\n  data.groups.forEach((group: { title: string; children: number[] }) => {\n    const groupItem: SidebarGroup = {\n      text: group.title,\n      items: [],\n    };\n    group.children.forEach((id: number) => {\n      const dataItem = data.children.find((item: ModuleItem) => item.id === id);\n      if (dataItem) {\n        // Note: we should handle the case that classes and interfaces have the same name\n        // Such as class `Env` and variable `env`\n        // The final output file name should be `classes/Env.md` and `variables/env-1.md`\n        let fileName = dataItem.name;\n        if (symbolMap.has(dataItem.name)) {\n          const count = symbolMap.get(dataItem.name)! + 1;\n          symbolMap.set(dataItem.name, count);\n          fileName = `${dataItem.name}-${count}`;\n        } else {\n          symbolMap.set(dataItem.name.toLocaleLowerCase(), 0);\n        }\n        groupItem.items.push({\n          text: dataItem.name,\n          link: `${ROUTE_PREFIX}/${group.title.toLocaleLowerCase()}/${fileName}`,\n        });\n      }\n    });\n    result.push(groupItem);\n  });\n\n  await patchLinks(path.dirname(jsonFile));\n\n  return result;\n}\n\nexport async function resolveSidebarForMultiEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return result;\n  }\n\n  function getModulePath(name: string) {\n    return path\n      .join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`)\n      .replace(/\\\\/g, '/');\n  }\n\n  function getClassPath(moduleName: string, className: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/classes`,\n        `${transformModuleName(moduleName)}.${className}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getInterfacePath(moduleName: string, interfaceName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/interfaces`,\n        `${transformModuleName(moduleName)}.${interfaceName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getFunctionPath(moduleName: string, functionName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/functions`,\n        `${transformModuleName(moduleName)}.${functionName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  data.children.forEach((module: ModuleItem) => {\n    const moduleNames = module.name.split('/');\n    const name = moduleNames[moduleNames.length - 1];\n    const moduleConfig = {\n      text: `Module:${name}`,\n      items: [{ text: 'Overview', link: getModulePath(module.name) }],\n    };\n    if (!module.children || module.children.length <= 0) {\n      return;\n    }\n    module.children.forEach(sub => {\n      const kindString = module.groups\n        .find(item => item.children.includes(sub.id))\n        ?.title.slice(0, -1);\n      if (!kindString) {\n        return;\n      }\n      switch (kindString) {\n        case 'Class':\n          moduleConfig.items.push({\n            text: `Class:${sub.name}`,\n            link: getClassPath(module.name, sub.name),\n          });\n          break;\n        case 'Interface':\n          moduleConfig.items.push({\n            text: `Interface:${sub.name}`,\n            link: getInterfacePath(module.name, sub.name),\n          });\n          break;\n        case 'Function':\n          moduleConfig.items.push({\n            text: `Function:${sub.name}`,\n            link: getFunctionPath(module.name, sub.name),\n          });\n          break;\n        default:\n          break;\n      }\n    });\n    result.push(moduleConfig);\n  });\n  await patchLinks(path.dirname(jsonFile));\n  return result;\n}\n","export function transformModuleName(name: string) {\n  return name.replace(/\\//g, '_').replace(/-/g, '_');\n}\n"]}

package/dist/lib/index.d.ts

@@ -1,17 +0,0 @@
-import { RspressPlugin } from '@rspress/shared';
-
-interface PluginTypeDocOptions {
-    /**
-     * The entry points of modules.
-     * @default []
-     */
-    entryPoints: string[];
-    /**
-     * The output directory.
-     * @default 'api'
-     */
-    outDir?: string;
-}
-declare function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin;
-
-export { type PluginTypeDocOptions, pluginTypeDoc };

package/dist/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,IAAAA,oBAAiB;AACjB,qBAA4C;AAE5C,qCAAqB;;;ACHd,IAAM,UAAU;AAChB,IAAM,eAAe,IAAI,OAAO;;;ACDvC,uBAAiB;AACjB,sBAAe;;;ACDR,SAAS,oBAAoB,MAAc;AAChD,SAAO,KAAK,QAAQ,OAAO,GAAG,EAAE,QAAQ,MAAM,GAAG;AACnD;;;ADiBA,SAAe,WAAW,WAAmB;AAAA;AAI3C,UAAM,sBAAsB,CAAO,aAAqB;AACtD,YAAM,UAAU,MAAM,gBAAAC,QAAG,SAAS,UAAU,OAAO;AAEnD,YAAM,aAAa,QAAQ;AAAA,QACzB;AAAA,QACA,CAAC,QAAQ,IAAI,OAAO;AAClB,iBAAO,IAAI,EAAE,OAAO,EAAE;AAAA,QACxB;AAAA,MACF;AACA,YAAM,gBAAAA,QAAG,UAAU,UAAU,UAAU;AAAA,IACzC;AAEA,UAAM,WAAW,CAAO,QAAgB;AACtC,YAAM,QAAQ,MAAM,gBAAAA,QAAG,QAAQ,GAAG;AAClC,iBAAW,QAAQ,OAAO;AACxB,cAAM,WAAW,iBAAAC,QAAK,KAAK,KAAK,IAAI;AACpC,cAAM,OAAO,MAAM,gBAAAD,QAAG,KAAK,QAAQ;AACnC,YAAI,KAAK,YAAY,GAAG;AACtB,gBAAM,SAAS,QAAQ;AAAA,QACzB,WAAW,KAAK,OAAO,KAAK,SAAS,KAAK,IAAI,GAAG;AAC/C,gBAAM,oBAAoB,QAAQ;AAAA,QACpC;AAAA,MACF;AAAA,IACF;AACA,UAAM,SAAS,SAAS;AAAA,EAC1B;AAAA;AAEA,SAAsB,6BACpB,UACyB;AAAA;AACzB,UAAM,SAAyB,CAAC;AAChC,UAAM,OAAO,KAAK,MAAM,MAAM,gBAAAA,QAAG,SAAS,UAAU,OAAO,CAAC;AAC5D,QAAI,CAAC,KAAK,YAAY,KAAK,SAAS,UAAU,GAAG;AAC/C,aAAO,CAAC;AAAA,IACV;AACA,UAAM,YAAY,oBAAI,IAAoB;AAC1C,SAAK,OAAO,QAAQ,CAAC,UAAiD;AACpE,YAAM,YAA0B;AAAA,QAC9B,MAAM,MAAM;AAAA,QACZ,OAAO,CAAC;AAAA,MACV;AACA,YAAM,SAAS,QAAQ,CAAC,OAAe;AACrC,cAAM,WAAW,KAAK,SAAS,KAAK,CAAC,SAAqB,KAAK,OAAO,EAAE;AACxE,YAAI,UAAU;AAIZ,cAAI,WAAW,SAAS;AACxB,cAAI,UAAU,IAAI,SAAS,IAAI,GAAG;AAChC,kBAAM,QAAQ,UAAU,IAAI,SAAS,IAAI,IAAK;AAC9C,sBAAU,IAAI,SAAS,MAAM,KAAK;AAClC,uBAAW,GAAG,SAAS,IAAI,IAAI,KAAK;AAAA,UACtC,OAAO;AACL,sBAAU,IAAI,SAAS,KAAK,kBAAkB,GAAG,CAAC;AAAA,UACpD;AACA,oBAAU,MAAM,KAAK;AAAA,YACnB,MAAM,SAAS;AAAA,YACf,MAAM,GAAG,YAAY,IAAI,MAAM,MAAM,kBAAkB,CAAC,IAAI,QAAQ;AAAA,UACtE,CAAC;AAAA,QACH;AAAA,MACF,CAAC;AACD,aAAO,KAAK,SAAS;AAAA,IACvB,CAAC;AAED,UAAM,WAAW,iBAAAC,QAAK,QAAQ,QAAQ,CAAC;AAEvC,WAAO;AAAA,EACT;AAAA;AAEA,SAAsB,4BACpB,UACyB;AAAA;AACzB,UAAM,SAAyB,CAAC;AAChC,UAAM,OAAO,KAAK,MAAM,MAAM,gBAAAD,QAAG,SAAS,UAAU,OAAO,CAAC;AAC5D,QAAI,CAAC,KAAK,YAAY,KAAK,SAAS,UAAU,GAAG;AAC/C,aAAO;AAAA,IACT;AAEA,aAAS,cAAc,MAAc;AACnC,aAAO,iBAAAC,QACJ,KAAK,GAAG,YAAY,YAAY,GAAG,oBAAoB,IAAI,CAAC,EAAE,EAC9D,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,aAAa,YAAoB,WAAmB;AAC3D,aAAO,iBAAAA,QACJ;AAAA,QACC,GAAG,YAAY;AAAA,QACf,GAAG,oBAAoB,UAAU,CAAC,IAAI,SAAS;AAAA,MACjD,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,iBAAiB,YAAoB,eAAuB;AACnE,aAAO,iBAAAA,QACJ;AAAA,QACC,GAAG,YAAY;AAAA,QACf,GAAG,oBAAoB,UAAU,CAAC,IAAI,aAAa;AAAA,MACrD,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,aAAS,gBAAgB,YAAoB,cAAsB;AACjE,aAAO,iBAAAA,QACJ;AAAA,QACC,GAAG,YAAY;AAAA,QACf,GAAG,oBAAoB,UAAU,CAAC,IAAI,YAAY;AAAA,MACpD,EACC,QAAQ,OAAO,GAAG;AAAA,IACvB;AAEA,SAAK,SAAS,QAAQ,CAACC,YAAuB;AAC5C,YAAM,cAAcA,QAAO,KAAK,MAAM,GAAG;AACzC,YAAM,OAAO,YAAY,YAAY,SAAS,CAAC;AAC/C,YAAM,eAAe;AAAA,QACnB,MAAM,UAAU,IAAI;AAAA,QACpB,OAAO,CAAC,EAAE,MAAM,YAAY,MAAM,cAAcA,QAAO,IAAI,EAAE,CAAC;AAAA,MAChE;AACA,UAAI,CAACA,QAAO,YAAYA,QAAO,SAAS,UAAU,GAAG;AACnD;AAAA,MACF;AACA,MAAAA,QAAO,SAAS,QAAQ,SAAO;AAhJnC;AAiJM,cAAM,cAAa,KAAAA,QAAO,OACvB,KAAK,UAAQ,KAAK,SAAS,SAAS,IAAI,EAAE,CAAC,MAD3B,mBAEf,MAAM,MAAM,GAAG;AACnB,YAAI,CAAC,YAAY;AACf;AAAA,QACF;AACA,gBAAQ,YAAY;AAAA,UAClB,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,SAAS,IAAI,IAAI;AAAA,cACvB,MAAM,aAAaA,QAAO,MAAM,IAAI,IAAI;AAAA,YAC1C,CAAC;AACD;AAAA,UACF,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,aAAa,IAAI,IAAI;AAAA,cAC3B,MAAM,iBAAiBA,QAAO,MAAM,IAAI,IAAI;AAAA,YAC9C,CAAC;AACD;AAAA,UACF,KAAK;AACH,yBAAa,MAAM,KAAK;AAAA,cACtB,MAAM,YAAY,IAAI,IAAI;AAAA,cAC1B,MAAM,gBAAgBA,QAAO,MAAM,IAAI,IAAI;AAAA,YAC7C,CAAC;AACD;AAAA,UACF;AACE;AAAA,QACJ;AAAA,MACF,CAAC;AACD,aAAO,KAAK,YAAY;AAAA,IAC1B,CAAC;AACD,UAAM,WAAW,iBAAAD,QAAK,QAAQ,QAAQ,CAAC;AACvC,WAAO;AAAA,EACT;AAAA;;;AF3JO,SAAS,cAAc,SAA8C;AAC1E,MAAI;AACJ,QAAM,EAAE,cAAc,CAAC,GAAG,SAAS,QAAQ,IAAI;AAC/C,SAAO;AAAA,IACL,MAAM;AAAA,IACA,WAAW;AAAA;AACf,eAAO;AAAA,UACL;AAAA,YACE,WAAW,GAAG,OAAO,QAAQ,OAAO,EAAE,CAAC;AAAA,YACvC,UAAU,kBAAAA,QAAK,KAAK,SAAU,QAAQ,WAAW;AAAA,UACnD;AAAA,QACF;AAAA,MACF;AAAA;AAAA,IACM,OAAO,QAAQ;AAAA;AACnB,cAAM,MAAM,IAAI,2BAAY;AAC5B,kBAAU,OAAO;AACjB,YAAI,QAAQ,UAAU,IAAI,8BAAe,CAAC;AAC1C,iDAAK,GAAG;AACR,YAAI,UAAU;AAAA,UACZ,MAAM,OAAO;AAAA,UACb;AAAA,UACA,OAAO;AAAA,UACP,gBAAgB;AAAA,UAChB,QAAQ;AAAA,UACR,aAAa;AAAA,UACb,wBAAwB,CAAC,SAAS,YAAY,WAAW;AAAA,UACzD,QAAQ,CAAC,yBAAyB;AAAA;AAAA,UAElC,iBAAiB;AAAA,UACjB,mBAAmB;AAAA,UACnB,+BAA+B;AAAA,QACjC,CAAC;AACD,cAAM,UAAU,IAAI,QAAQ;AAE5B,YAAI,SAAS;AAEX,gBAAM,oBAAoB,kBAAAA,QAAK,KAAK,SAAU,MAAM;AACpD,gBAAM,IAAI,aAAa,SAAS,iBAAiB;AACjD,gBAAM,UAAU,kBAAAA,QAAK,KAAK,mBAAmB,oBAAoB;AACjE,gBAAM,IAAI,aAAa,SAAS,OAAO;AAEvC,iBAAO,cAAc,OAAO,eAAe,CAAC;AAC5C,iBAAO,YAAY,MAAM,OAAO,YAAY,OAAO,CAAC;AACpD,gBAAM,eAAe,IAAI,OAAO,QAAQ,eAAe,EAAE,CAAC;AAC1D,gBAAM,EAAE,IAAI,IAAI,OAAO;AAEvB,cAAI,MAAM,QAAQ,GAAG,GAAG;AACtB,gBAAI,KAAK;AAAA,cACP,MAAM;AAAA,cACN,MAAM;AAAA,YACR,CAAC;AAAA,UACH,WAAW,aAAa,KAAK;AAC3B,gBAAI,QAAQ,KAAK;AAAA,cACf,MAAM;AAAA,cACN,MAAM;AAAA,YACR,CAAC;AAAA,UACH;AAEA,iBAAO,YAAY,UAAU,OAAO,YAAY,WAAW,CAAC;AAC5D,iBAAO,YAAY,QAAQ,YAAY,IACrC,YAAY,SAAS,IACjB,MAAM,4BAA4B,OAAO,IACzC,MAAM,6BAA6B,OAAO;AAChD,iBAAO,YAAY,QAAQ,YAAY,EAAE,QAAQ;AAAA,YAC/C,MAAM;AAAA,YACN,MAAM,GAAG,YAAY;AAAA,UACvB,CAAC;AAAA,QACH;AACA,eAAO,QAAQ,OAAO,SAAS,CAAC;AAChC,eAAO,MAAM,UAAU,OAAO,MAAM,WAAW,CAAC;AAChD,eAAO;AAAA,MACT;AAAA;AAAA,EACF;AACF","names":["import_node_path","fs","path","module"],"ignoreList":[],"sources":["../../src/index.ts","../../src/constants.ts","../../src/sidebar.ts","../../src/utils.ts"],"sourcesContent":["import path from 'node:path';\nimport { Application, TSConfigReader } from 'typedoc';\nimport type { RspressPlugin } from '@rspress/shared';\nimport { load } from 'typedoc-plugin-markdown';\nimport { API_DIR } from './constants';\nimport {\n  resolveSidebarForMultiEntry,\n  resolveSidebarForSingleEntry,\n} from './sidebar';\n\nexport interface PluginTypeDocOptions {\n  /**\n   * The entry points of modules.\n   * @default []\n   */\n  entryPoints: string[];\n  /**\n   * The output directory.\n   * @default 'api'\n   */\n  outDir?: string;\n}\n\nexport function pluginTypeDoc(options: PluginTypeDocOptions): RspressPlugin {\n  let docRoot: string | undefined;\n  const { entryPoints = [], outDir = API_DIR } = options;\n  return {\n    name: '@rspress/plugin-typedoc',\n    async addPages() {\n      return [\n        {\n          routePath: `${outDir.replace(/\\/$/, '')}/`,\n          filepath: path.join(docRoot!, outDir, 'README.md'),\n        },\n      ];\n    },\n    async config(config) {\n      const app = new Application();\n      docRoot = config.root;\n      app.options.addReader(new TSConfigReader());\n      load(app);\n      app.bootstrap({\n        name: config.title,\n        entryPoints,\n        theme: 'markdown',\n        disableSources: true,\n        readme: 'none',\n        githubPages: false,\n        requiredToBeDocumented: ['Class', 'Function', 'Interface'],\n        plugin: ['typedoc-plugin-markdown'],\n        // @ts-expect-error MarkdownTheme has no export\n        hideBreadcrumbs: true,\n        hideMembersSymbol: true,\n        allReflectionsHaveOwnDocument: true,\n      });\n      const project = app.convert();\n\n      if (project) {\n        // 1. Generate module doc by typedoc\n        const absoluteOutputdir = path.join(docRoot!, outDir);\n        await app.generateDocs(project, absoluteOutputdir);\n        const jsonDir = path.join(absoluteOutputdir, 'documentation.json');\n        await app.generateJson(project, jsonDir);\n        // 2. Generate sidebar\n        config.themeConfig = config.themeConfig || {};\n        config.themeConfig.nav = config.themeConfig.nav || [];\n        const apiIndexLink = `/${outDir.replace(/(^\\/)|(\\/$)/, '')}/`;\n        const { nav } = config.themeConfig;\n        // Note: TypeDoc does not support i18n\n        if (Array.isArray(nav)) {\n          nav.push({\n            text: 'API',\n            link: apiIndexLink,\n          });\n        } else if ('default' in nav) {\n          nav.default.push({\n            text: 'API',\n            link: apiIndexLink,\n          });\n        }\n\n        config.themeConfig.sidebar = config.themeConfig.sidebar || {};\n        config.themeConfig.sidebar[apiIndexLink] =\n          entryPoints.length > 1\n            ? await resolveSidebarForMultiEntry(jsonDir)\n            : await resolveSidebarForSingleEntry(jsonDir);\n        config.themeConfig.sidebar[apiIndexLink].unshift({\n          text: 'Overview',\n          link: `${apiIndexLink}README`,\n        });\n      }\n      config.route = config.route || {};\n      config.route.exclude = config.route.exclude || [];\n      return config;\n    },\n  };\n}\n","export const API_DIR = 'api';\nexport const ROUTE_PREFIX = `/${API_DIR}`;\n","import path from 'node:path';\nimport fs from '@rspress/shared/fs-extra';\nimport type { SidebarGroup } from '@rspress/shared';\nimport { transformModuleName } from './utils';\nimport { ROUTE_PREFIX } from './constants';\n\ninterface ModuleItem {\n  id: number;\n  name: string;\n  children: {\n    id: number;\n    name: string;\n  }[];\n  groups: {\n    title: string;\n    children: number[];\n  }[];\n}\n\nasync function patchLinks(outputDir: string) {\n  // Patch links in markdown files\n  // Scan all the markdown files in the output directory\n  // replace [foo](bar) -> [foo](./bar)\n  const normlizeLinksInFile = async (filePath: string) => {\n    const content = await fs.readFile(filePath, 'utf-8');\n    // replace: [foo](bar) -> [foo](./bar)\n    const newContent = content.replace(\n      /\\[([^\\]]+)\\]\\(([^)]+)\\)/g,\n      (_match, p1, p2) => {\n        return `[${p1}](./${p2})`;\n      },\n    );\n    await fs.writeFile(filePath, newContent);\n  };\n\n  const traverse = async (dir: string) => {\n    const files = await fs.readdir(dir);\n    for (const file of files) {\n      const filePath = path.join(dir, file);\n      const stat = await fs.stat(filePath);\n      if (stat.isDirectory()) {\n        await traverse(filePath);\n      } else if (stat.isFile() && /\\.mdx?/.test(file)) {\n        await normlizeLinksInFile(filePath);\n      }\n    }\n  };\n  await traverse(outputDir);\n}\n\nexport async function resolveSidebarForSingleEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return [];\n  }\n  const symbolMap = new Map<string, number>();\n  data.groups.forEach((group: { title: string; children: number[] }) => {\n    const groupItem: SidebarGroup = {\n      text: group.title,\n      items: [],\n    };\n    group.children.forEach((id: number) => {\n      const dataItem = data.children.find((item: ModuleItem) => item.id === id);\n      if (dataItem) {\n        // Note: we should handle the case that classes and interfaces have the same name\n        // Such as class `Env` and variable `env`\n        // The final output file name should be `classes/Env.md` and `variables/env-1.md`\n        let fileName = dataItem.name;\n        if (symbolMap.has(dataItem.name)) {\n          const count = symbolMap.get(dataItem.name)! + 1;\n          symbolMap.set(dataItem.name, count);\n          fileName = `${dataItem.name}-${count}`;\n        } else {\n          symbolMap.set(dataItem.name.toLocaleLowerCase(), 0);\n        }\n        groupItem.items.push({\n          text: dataItem.name,\n          link: `${ROUTE_PREFIX}/${group.title.toLocaleLowerCase()}/${fileName}`,\n        });\n      }\n    });\n    result.push(groupItem);\n  });\n\n  await patchLinks(path.dirname(jsonFile));\n\n  return result;\n}\n\nexport async function resolveSidebarForMultiEntry(\n  jsonFile: string,\n): Promise<SidebarGroup[]> {\n  const result: SidebarGroup[] = [];\n  const data = JSON.parse(await fs.readFile(jsonFile, 'utf-8'));\n  if (!data.children || data.children.length <= 0) {\n    return result;\n  }\n\n  function getModulePath(name: string) {\n    return path\n      .join(`${ROUTE_PREFIX}/modules`, `${transformModuleName(name)}`)\n      .replace(/\\\\/g, '/');\n  }\n\n  function getClassPath(moduleName: string, className: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/classes`,\n        `${transformModuleName(moduleName)}.${className}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getInterfacePath(moduleName: string, interfaceName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/interfaces`,\n        `${transformModuleName(moduleName)}.${interfaceName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  function getFunctionPath(moduleName: string, functionName: string) {\n    return path\n      .join(\n        `${ROUTE_PREFIX}/functions`,\n        `${transformModuleName(moduleName)}.${functionName}`,\n      )\n      .replace(/\\\\/g, '/');\n  }\n\n  data.children.forEach((module: ModuleItem) => {\n    const moduleNames = module.name.split('/');\n    const name = moduleNames[moduleNames.length - 1];\n    const moduleConfig = {\n      text: `Module:${name}`,\n      items: [{ text: 'Overview', link: getModulePath(module.name) }],\n    };\n    if (!module.children || module.children.length <= 0) {\n      return;\n    }\n    module.children.forEach(sub => {\n      const kindString = module.groups\n        .find(item => item.children.includes(sub.id))\n        ?.title.slice(0, -1);\n      if (!kindString) {\n        return;\n      }\n      switch (kindString) {\n        case 'Class':\n          moduleConfig.items.push({\n            text: `Class:${sub.name}`,\n            link: getClassPath(module.name, sub.name),\n          });\n          break;\n        case 'Interface':\n          moduleConfig.items.push({\n            text: `Interface:${sub.name}`,\n            link: getInterfacePath(module.name, sub.name),\n          });\n          break;\n        case 'Function':\n          moduleConfig.items.push({\n            text: `Function:${sub.name}`,\n            link: getFunctionPath(module.name, sub.name),\n          });\n          break;\n        default:\n          break;\n      }\n    });\n    result.push(moduleConfig);\n  });\n  await patchLinks(path.dirname(jsonFile));\n  return result;\n}\n","export function transformModuleName(name: string) {\n  return name.replace(/\\//g, '_').replace(/-/g, '_');\n}\n"]}