fumadocs-typescript 5.4.0 → 5.5.0

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import { a as GeneratedDoc, c as RawTag, d as TypescriptConfig, f as createProject, g as GenerateTypeTableOptions, h as BaseTypeTableProps, i as GenerateOptions, l as createGenerator, m as generateHash, n as ShikiOptions, o as Generator, p as Cache, r as DocEntry, s as GeneratorOptions, t as MarkdownRenderer, u as Project } from "./markdown-CcCPhMmC.js";
 import { Root } from "mdast";
 import { Transformer } from "unified";
+import { StructuredData } from "fumadocs-core/mdx-plugins/remark-structure";
 //#region src/lib/remark-auto-type-table.d.ts
-interface RemarkAutoTypeTableOptions {
+export interface RemarkAutoTypeTableOptions {
   /**
    * @defaultValue 'auto-type-table'
    */
@@ -27,7 +28,11 @@ interface RemarkAutoTypeTableOptions {
   remarkStringify?: boolean;
   generator?: Generator;
 }
-interface TypeTableProps extends BaseTypeTableProps {
+/** the structured data of a type table, a table row without header for each prop, linked to the prop */
+export declare function typeTableToStructuredData(id: string, entries: DocEntry[]): StructuredData['contents'];
+/** a type table as Markdown: a heading, its description, and a table of its props */
+export declare function typeTableToMarkdown(doc: GeneratedDoc): string;
+export interface TypeTableProps extends BaseTypeTableProps {
   cwd?: true;
 }
 /**
@@ -35,9 +40,9 @@ interface TypeTableProps extends BaseTypeTableProps {
  *
  * MDX is required to use this plugin.
  */
-declare function remarkAutoTypeTable(config?: RemarkAutoTypeTableOptions): Transformer<Root, Root>;
+export declare function remarkAutoTypeTable(config?: RemarkAutoTypeTableOptions): Transformer<Root, Root>;
 //#endregion
 //#region src/cache/fs-cache.d.ts
-declare function createFileSystemGeneratorCache(dir: string): Cache;
+export declare function createFileSystemGeneratorCache(dir: string): Cache;
 //#endregion
-export { Cache, DocEntry, GenerateOptions, GeneratedDoc, Generator, GeneratorOptions, type MarkdownRenderer, type Project, RawTag, RemarkAutoTypeTableOptions, TypeTableProps, type TypescriptConfig, createFileSystemGeneratorCache, createGenerator, createProject, generateHash, remarkAutoTypeTable };
+export { Cache, DocEntry, GenerateOptions, GeneratedDoc, Generator, GeneratorOptions, type MarkdownRenderer, type Project, RawTag, type TypescriptConfig, createGenerator, createProject, generateHash };

package/dist/index.js

@@ -5,8 +5,9 @@ import path from "node:path";
 import { createHash } from "node:crypto";
 import fs$1 from "node:fs";
 import { valueToEstree } from "estree-util-value-to-estree";
-import { visit } from "unist-util-visit";
 import { toEstree } from "hast-util-to-estree";
+import { tableRowToStructuredData } from "fumadocs-core/search";
+import { replaceSource } from "fumadocs-core/mdx-plugins/stringifier";
 //#region src/lib/type-table.ts
 async function getTypeTableOutput(gen, { name, type, ...props }, options) {
 	const file = props.path && options?.basePath ? path.join(options.basePath, props.path) : props.path;
@@ -32,7 +33,7 @@ function generateHash(str) {
 }
 //#endregion
 //#region package.json
-var version = "5.4.0";
+var version = "5.5.0";
 //#endregion
 //#region src/lib/get-simple-form.ts
 function getSimpleForm(type, checker, location, options = {}) {
@@ -357,6 +358,38 @@ async function buildTypeProp(entries, renderer) {
 	for (const node of output) prop.addExpressionNode(node.name, node.node);
 	return prop.build();
 }
+/** the structured data of a type table, a table row without header for each prop, linked to the prop */
+function typeTableToStructuredData(id, entries) {
+	const contents = [];
+	for (const entry of entries) contents.push(tableRowToStructuredData({
+		table: id,
+		heading: `${id}-${entry.name}`,
+		row: typeTableRow(entry)
+	}));
+	return contents;
+}
+/** a type table as Markdown: a heading, its description, and a table of its props */
+function typeTableToMarkdown(doc) {
+	let out = `### ${doc.name}\n\n`;
+	if (doc.description) out += `${doc.description.trim()}\n\n`;
+	out += "| Prop | Type | Description |\n| --- | --- | --- |";
+	for (const entry of doc.entries) {
+		out += "\n|";
+		for (const cell of typeTableRow(entry)) out += ` ${cell.replace(/\s*\n\s*/g, " ").replaceAll("|", "\\|")} |`;
+	}
+	return out;
+}
+function typeTableRow(entry) {
+	const tags = parseTags(entry.tags);
+	let description = entry.description.replace(/{@link (?<link>[^}]*)}/g, "$1").trim();
+	if (tags.default) description += `${description ? " " : ""}Default: \`${tags.default}\``;
+	if (entry.deprecated) description = `**Deprecated.** ${description}`;
+	return [
+		`\`${entry.name}${entry.required ? "" : "?"}\``,
+		`\`${entry.simplifiedType}\``,
+		description
+	];
+}
 /**
 * Compile `auto-type-table` into Fumadocs UI compatible TypeTable
 *
@@ -409,14 +442,18 @@ function remarkAutoTypeTable(config = {}) {
 				},
 				...attributes
 			],
-			children: []
+			children: [],
+			data: { structuredData: { contents: typeTableToStructuredData(`type-table-${doc.id}`, doc.entries) } }
 		});
-		return rendered;
+		return {
+			output,
+			rendered
+		};
 	}
 	return async (tree, file) => {
 		const queue = [];
-		visit(tree, "mdxJsxFlowElement", (node) => {
-			if (node.name !== name) return;
+		walk(tree, (node) => {
+			if (node.type !== "mdxJsxFlowElement" || node.name !== name) return;
 			const props = {};
 			const attributes = [];
 			const onError = (message, cause) => {
@@ -441,10 +478,13 @@ function remarkAutoTypeTable(config = {}) {
 					default: attributes.push(attr);
 				}
 			}
-			queue.push(generate(file, props, attributes).then((children) => {
+			queue.push(generate(file, props, attributes).then(({ output, rendered }) => {
+				let markdown = "";
+				for (const doc of output) markdown += `${markdown ? "\n\n" : ""}${typeTableToMarkdown(doc)}`;
+				replaceSource(file, node, markdown);
 				Object.assign(node, {
 					type: "root",
-					children
+					children: rendered
 				});
 			}).catch((err) => {
 				onError("failed to generate type table", err);
@@ -454,6 +494,11 @@ function remarkAutoTypeTable(config = {}) {
 		await Promise.all(queue);
 	};
 }
+/** visit a tree in document order, returning `skip` skips the children of a node */
+function walk(node, visitor) {
+	if (visitor(node) === "skip" || !("children" in node)) return;
+	for (const child of node.children) walk(child, visitor);
+}
 //#endregion
 //#region src/cache/fs-cache.ts
 function createFileSystemGeneratorCache(dir) {
@@ -474,4 +519,4 @@ function createFileSystemGeneratorCache(dir) {
 	};
 }
 //#endregion
-export { createFileSystemGeneratorCache, createGenerator, createProject, generateHash, remarkAutoTypeTable };
+export { createFileSystemGeneratorCache, createGenerator, createProject, generateHash, remarkAutoTypeTable, typeTableToMarkdown, typeTableToStructuredData };

package/dist/ui/index.d.ts

@@ -2,7 +2,7 @@ import { g as GenerateTypeTableOptions, h as BaseTypeTableProps, n as ShikiOptio
 import * as JsxRuntime from "react/jsx-runtime";
 import { ComponentProps, ReactNode } from "react";
 //#region src/ui/auto-type-table.d.ts
-interface AutoTypeTableProps extends BaseTypeTableProps, ComponentProps<'div'> {
+export interface AutoTypeTableProps extends BaseTypeTableProps, ComponentProps<'div'> {
   generator: Generator;
   /** Shiki configuration when using default `renderMarkdown` & `renderType` */
   shiki?: ShikiOptions;
@@ -10,6 +10,5 @@ interface AutoTypeTableProps extends BaseTypeTableProps, ComponentProps<'div'> {
   renderMarkdown?: (md: string) => Promise<ReactNode>;
   renderType?: (type: string) => Promise<ReactNode>;
 }
-declare function AutoTypeTable({ generator, options, renderType, renderMarkdown, shiki, name, path, type, ...props }: AutoTypeTableProps): Promise<Promise<JsxRuntime.JSX.Element>[]>;
-//#endregion
-export { AutoTypeTable, AutoTypeTableProps };
+export declare function AutoTypeTable({ generator, options, renderType, renderMarkdown, shiki, name, path, type, ...props }: AutoTypeTableProps): Promise<Promise<JsxRuntime.JSX.Element>[]>;
+//#endregion

package/dist/ui/index.js

@@ -47,7 +47,7 @@ function toJsx(hast) {
 		...JsxRuntime,
 		components: {
 			...defaultMdxComponents,
-			img: void 0
+			img: "img"
 		}
 	});
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-typescript",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "description": "Typescript Integration for Fumadocs",
   "keywords": [
     "Docs",
@@ -17,6 +17,7 @@
     "dist"
   ],
   "type": "module",
+  "sideEffects": false,
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -38,32 +39,31 @@
     "hast-util-to-jsx-runtime": "^2.3.6",
     "remark": "^15.0.1",
     "remark-rehype": "^11.1.2",
-    "shiki": "^4.4.3",
+    "shiki": "^4.5.0",
     "typescript": "~7.0.2",
-    "unified": "^11.0.5",
-    "unist-util-visit": "^5.1.0"
+    "unified": "^11.0.5"
   },
   "devDependencies": {
     "@mdx-js/mdx": "^3.1.1",
     "@types/estree": "^1.0.9",
     "@types/hast": "^3.0.5",
     "@types/mdast": "^4.0.4",
-    "@types/node": "26.4.1",
-    "@types/react": "^19.2.18",
-    "@types/react-dom": "^19.2.5",
+    "@types/node": "26.6.4",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "fumadocs-core": "16.17.0",
+    "fumadocs-ui": "npm:@fumadocs/base-ui@16.17.0",
     "mdast-util-mdx": "^3.0.0",
-    "tsdown": "0.22.14",
-    "vfile": "^6.0.3",
-    "fumadocs-core": "16.15.6",
-    "fumadocs-ui": "npm:@fumadocs/base-ui@16.15.6",
-    "tsconfig": "0.0.0"
+    "tsconfig": "0.0.0",
+    "tsdown": "0.23.0",
+    "vfile": "^6.0.3"
   },
   "peerDependencies": {
     "@types/estree": "*",
     "@types/hast": "*",
     "@types/mdast": "*",
     "@types/react": "*",
-    "fumadocs-core": "^16.7.0",
+    "fumadocs-core": "^16.17.0",
     "fumadocs-ui": "^16.7.0",
     "react": "^19.2.0",
     "react-dom": "^19.2.0"