@rspress/plugin-api-docgen 1.41.3 → 1.42.1-canary-20240226

package/dist/index.js

@@ -101,7 +101,7 @@ var __webpack_exports__ = {};
             overview: 'Overview'
         }
     };
-    const isToolEntries = (obj)=>obj.documentation || obj["react-docgen-typescript"];
+    const isToolEntries = (obj)=>!!obj.documentation || !!obj["react-docgen-typescript"];
     const docgen = async ({ entries, languages, apiParseTool, appDir, parseToolOptions, isProd })=>{
         const watchFileMap = {};
         const genApiDoc = async (entry, tool)=>{

package/index.d.ts

@@ -0,0 +1,7 @@
+declare module '@rspress/shared' {
+  interface PageIndexInfo {
+    apiDocMap?: Record<string, string>;
+  }
+}
+
+export * from './dist'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-api-docgen",
-  "version": "1.41.3",
+  "version": "1.42.1-canary-20240226",
   "description": "A plugin for rspress to generate api doc.",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -10,10 +10,11 @@
   },
   "license": "MIT",
   "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "types": "./index.d.ts",
   "files": [
     "dist",
     "static",
+    "index.d.ts",
     "mdx-meta-loader.cjs"
   ],
   "dependencies": {
@@ -22,11 +23,11 @@
     "react-docgen-typescript": "2.2.2",
     "react-markdown": "8.0.7",
     "remark-gfm": "3.0.1",
-    "@rspress/shared": "1.41.3"
+    "@rspress/shared": "1.42.1-canary-20240226"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.49.2",
-    "@rslib/core": "0.4.1",
+    "@rslib/core": "0.5.2",
     "@types/mdast": "^3.0.15",
     "@types/node": "^18.11.17",
     "@types/react": "^18.3.18",
@@ -39,7 +40,7 @@
     "unist-util-visit": "^4.1.2"
   },
   "peerDependencies": {
-    "@rspress/core": "^1.41.3",
+    "@rspress/core": "^1.42.0",
     "react": ">=17.0.0",
     "react-router-dom": "^6.8.1",
     "typescript": "^5.5.3"
@@ -57,7 +58,6 @@
     "provenance": true,
     "registry": "https://registry.npmjs.org/"
   },
-  "jsnext:source": "./src/index.ts",
   "scripts": {
     "build": "rslib build",
     "dev": "rslib build -w",

package/static/global-components/API.tsx

@@ -1,3 +1,5 @@
+/// <reference path="../../index.d.ts" />
+
 import { useLang, usePageData } from '@rspress/core/runtime';
 import { getCustomMDXComponent } from '@rspress/core/theme';
 import ReactMarkdown from 'react-markdown';
@@ -9,10 +11,10 @@ export default (props: { moduleName: string }) => {
   const { page } = usePageData();
   const { moduleName } = props;
   // some api doc have two languages.
-  const apiDocMap = page.apiDocMap as Record<string, string>;
+  const apiDocMap = page.apiDocMap;
   // avoid error when no page data
   const apiDoc =
-    apiDocMap?.[moduleName] || apiDocMap?.[`${moduleName}-${lang}`];
+    apiDocMap?.[moduleName] || apiDocMap?.[`${moduleName}-${lang}`] || '';
   return (
     <ReactMarkdown
       remarkPlugins={[[remarkGfm]]}