fumadocs-typescript 4.0.0 → 4.0.2

package/dist/{type-table-Duzly_SK.d.ts → base-ze7ajmJT.d.ts}

@@ -8,6 +8,45 @@ interface TypescriptConfig {
 }
 declare function getProject(options?: TypescriptConfig): Project;
 
+interface BaseTypeTableProps {
+    /**
+     * The path to source TypeScript file.
+     */
+    path?: string;
+    /**
+     * Exported type name to generate from.
+     */
+    name?: string;
+    /**
+     * Set the type to generate from.
+     *
+     * When used with `name`, it generates the type with `name` as export name.
+     *
+     * ```ts
+     * export const myName = MyType;
+     * ```
+     *
+     * When `type` contains multiple lines, `export const` is not added.
+     * You need to export it manually, and specify the type name with `name`.
+     *
+     * ```tsx
+     * <AutoTypeTable
+     *   path="./file.ts"
+     *   type={`import { ReactNode } from "react"
+     *   export const MyName = ReactNode`}
+     *   name="MyName"
+     * />
+     * ```
+     */
+    type?: string;
+}
+interface GenerateTypeTableOptions extends GenerateOptions {
+    /**
+     * base path to resolve `path` prop
+     */
+    basePath?: string;
+}
+
 interface GeneratedDoc {
     name: string;
     description: string;
@@ -45,6 +84,7 @@ declare function createGenerator(config?: TypescriptConfig | Project): {
         path: string;
         content?: string;
     }, name: string | undefined, options?: GenerateOptions): GeneratedDoc[];
+    generateTypeTable(props: BaseTypeTableProps, options?: GenerateTypeTableOptions): Promise<GeneratedDoc[]>;
 };
 /**
  * Generate documentation for properties in an exported type/interface
@@ -59,43 +99,4 @@ declare function generateDocumentation(file: string, name: string | undefined, c
     project?: Project;
 }): GeneratedDoc[];
 
-interface BaseTypeTableProps {
-    /**
-     * The path to source TypeScript file.
-     */
-    path?: string;
-    /**
-     * Exported type name to generate from.
-     */
-    name?: string;
-    /**
-     * Set the type to generate from.
-     *
-     * When used with `name`, it generates the type with `name` as export name.
-     *
-     * ```ts
-     * export const myName = MyType;
-     * ```
-     *
-     * When `type` contains multiple lines, `export const` is not added.
-     * You need to export it manually, and specify the type name with `name`.
-     *
-     * ```tsx
-     * <AutoTypeTable
-     *   path="./file.ts"
-     *   type={`import { ReactNode } from "react"
-     *   export const MyName = ReactNode`}
-     *   name="MyName"
-     * />
-     * ```
-     */
-    type?: string;
-}
-interface GenerateTypeTableOptions extends GenerateOptions {
-    /**
-     * base path to resolve `path` prop
-     */
-    basePath?: string;
-}
-
 export { type BaseTypeTableProps as B, type DocEntry as D, type GenerateOptions as G, type GeneratedDoc as a, type Generator as b, type GenerateTypeTableOptions as c, createGenerator as d, generateDocumentation as e, getProject as g };

package/dist/{chunk-2WGVCLFC.js → chunk-B4VUDCYC.js}

@@ -77,42 +77,10 @@ function renderMarkdownToHast(md) {
   });
 }
 
-// src/utils/type-table.ts
-import * as fs from "node:fs/promises";
-import { join } from "node:path";
-function getTypeTableOutput(gen, _a, options) {
-  return __async(this, null, function* () {
-    var _b = _a, { name, type } = _b, props = __objRest(_b, ["name", "type"]);
-    const file = props.path && (options == null ? void 0 : options.basePath) ? join(options.basePath, props.path) : props.path;
-    let typeName = name;
-    let content = "";
-    if (file) {
-      content = (yield fs.readFile(file)).toString();
-    }
-    if (type && type.split("\n").length > 1) {
-      content += `
-${type}`;
-    } else if (type) {
-      typeName != null ? typeName : typeName = "$Fumadocs";
-      content += `
-export type ${typeName} = ${type}`;
-    }
-    const output = gen.generateDocumentation(
-      { path: file != null ? file : "temp.ts", content },
-      typeName,
-      options
-    );
-    if (name && output.length === 0)
-      throw new Error(`${name} in ${file != null ? file : "empty file"} doesn't exist`);
-    return output;
-  });
-}
-
 export {
   __spreadValues,
   __spreadProps,
   __objRest,
   __async,
-  renderMarkdownToHast,
-  getTypeTableOutput
+  renderMarkdownToHast
 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { G as GenerateOptions, a as GeneratedDoc, D as DocEntry, b as Generator, c as GenerateTypeTableOptions } from './type-table-Duzly_SK.js';
-export { d as createGenerator, e as generateDocumentation, g as getProject } from './type-table-Duzly_SK.js';
+import { G as GenerateOptions, a as GeneratedDoc, D as DocEntry, b as Generator, c as GenerateTypeTableOptions } from './base-ze7ajmJT.js';
+export { d as createGenerator, e as generateDocumentation, g as getProject } from './base-ze7ajmJT.js';
 import fg from 'fast-glob';
 import { Nodes } from 'hast';
 import { Root } from 'mdast';

package/dist/index.js

@@ -3,9 +3,8 @@ import {
   __objRest,
   __spreadProps,
   __spreadValues,
-  getTypeTableOutput,
   renderMarkdownToHast
-} from "./chunk-2WGVCLFC.js";
+} from "./chunk-B4VUDCYC.js";
 
 // src/lib/base.ts
 import {
@@ -24,7 +23,40 @@ function getProject(options = {}) {
 }
 
 // src/lib/base.ts
-import fs from "node:fs";
+import fs2 from "node:fs";
+
+// src/lib/type-table.ts
+import * as fs from "node:fs/promises";
+import { join } from "node:path";
+function getTypeTableOutput(gen, _a, options) {
+  return __async(this, null, function* () {
+    var _b = _a, { name, type } = _b, props = __objRest(_b, ["name", "type"]);
+    const file = props.path && (options == null ? void 0 : options.basePath) ? join(options.basePath, props.path) : props.path;
+    let typeName = name;
+    let content = "";
+    if (file) {
+      content = (yield fs.readFile(file)).toString();
+    }
+    if (type && type.split("\n").length > 1) {
+      content += `
+${type}`;
+    } else if (type) {
+      typeName != null ? typeName : typeName = "$Fumadocs";
+      content += `
+export type ${typeName} = ${type}`;
+    }
+    const output = gen.generateDocumentation(
+      { path: file != null ? file : "temp.ts", content },
+      typeName,
+      options
+    );
+    if (name && output.length === 0)
+      throw new Error(`${name} in ${file != null ? file : "empty file"} doesn't exist`);
+    return output;
+  });
+}
+
+// src/lib/base.ts
 function createGenerator(config) {
   const project = config instanceof Project2 ? config : getProject(config);
   return {
@@ -32,7 +64,7 @@ function createGenerator(config) {
       var _a;
       const sourceFile = project.createSourceFile(
         file.path,
-        (_a = file.content) != null ? _a : fs.readFileSync(file.path).toString(),
+        (_a = file.content) != null ? _a : fs2.readFileSync(file.path).toString(),
         {
           overwrite: true
         }
@@ -47,6 +79,9 @@ function createGenerator(config) {
         out.push(generate(project, k, d[0], options));
       }
       return out;
+    },
+    generateTypeTable(props, options) {
+      return getTypeTableOutput(this, props, options);
     }
   };
 }
@@ -84,10 +119,16 @@ function getDocEntry(prop, context) {
   const tags = Object.fromEntries(
     prop.getJsDocTags().map((tag) => [tag.getName(), ts.displayPartsToString(tag.getText())])
   );
-  let typeName = subType.getNonNullableType().getText(void 0, ts.TypeFormatFlags.UseAliasDefinedOutsideCurrentScope);
+  let typeName = subType.getText(
+    void 0,
+    ts.TypeFormatFlags.UseAliasDefinedOutsideCurrentScope
+  );
   if (subType.getAliasSymbol() && subType.getAliasTypeArguments().length === 0) {
     typeName = (_b = (_a = subType.getAliasSymbol()) == null ? void 0 : _a.getEscapedName()) != null ? _b : typeName;
   }
+  if (prop.isOptional() && typeName.endsWith("| undefined")) {
+    typeName = typeName.slice(0, typeName.length - "| undefined".length).trimEnd();
+  }
   if ("remarks" in tags) {
     typeName = (_d = (_c = new RegExp("^`(?<name>.+)`").exec(tags.remarks)) == null ? void 0 : _c[1]) != null ? _d : typeName;
   }
@@ -151,7 +192,7 @@ function replaceJsDocLinks(md) {
 
 // src/lib/file.ts
 import * as path2 from "node:path";
-import { mkdir, writeFile, readFile } from "node:fs/promises";
+import { mkdir, writeFile, readFile as readFile2 } from "node:fs/promises";
 import fg from "fast-glob";
 function generateFiles(generator, options) {
   return __async(this, null, function* () {
@@ -162,7 +203,7 @@ function generateFiles(generator, options) {
         options.output,
         `${path2.basename(file, path2.extname(file))}.mdx`
       );
-      const content = (yield readFile(absolutePath)).toString();
+      const content = (yield readFile2(absolutePath)).toString();
       let result = generateMDX(generator, content, __spreadValues({
         basePath: path2.dirname(absolutePath)
       }, options.options));
@@ -191,7 +232,8 @@ function mapProperty(entry, renderMarkdown) {
   return __async(this, null, function* () {
     const value = valueToEstree({
       type: entry.type,
-      default: entry.tags.default || entry.tags.defaultValue
+      default: entry.tags.default || entry.tags.defaultValue,
+      required: entry.required
     });
     if (entry.description) {
       const hast = toEstree(yield renderMarkdown(entry.description), {
@@ -248,8 +290,7 @@ function remarkAutoTypeTable({
       }
       function run() {
         return __async(this, null, function* () {
-          const output = yield getTypeTableOutput(
-            generator,
+          const output = yield generator.generateTypeTable(
             props,
             __spreadProps(__spreadValues({}, options), {
               basePath

package/dist/ui/index.d.ts

@@ -1,6 +1,6 @@
 import * as runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
-import { B as BaseTypeTableProps, b as Generator, c as GenerateTypeTableOptions } from '../type-table-Duzly_SK.js';
+import { B as BaseTypeTableProps, b as Generator, c as GenerateTypeTableOptions } from '../base-ze7ajmJT.js';
 import 'ts-morph';
 
 type AutoTypeTableProps = BaseTypeTableProps;

package/dist/ui/index.js

@@ -3,9 +3,8 @@ import {
   __objRest,
   __spreadProps,
   __spreadValues,
-  getTypeTableOutput,
   renderMarkdownToHast
-} from "../chunk-2WGVCLFC.js";
+} from "../chunk-B4VUDCYC.js";
 
 // src/ui/auto-type-table.tsx
 import { TypeTable } from "fumadocs-ui/components/type-table";
@@ -25,7 +24,7 @@ function AutoTypeTable(_a) {
       "options",
       "renderMarkdown"
     ]);
-    const output = yield getTypeTableOutput(generator, props, options);
+    const output = yield generator.generateTypeTable(props, options);
     return output.map((item) => __async(this, null, function* () {
       const entries = item.entries.map(
         (entry) => __async(this, null, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-typescript",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Typescript Integration for Fumadocs",
   "keywords": [
     "NextJs",
@@ -33,24 +33,24 @@
     "hast-util-to-estree": "^3.1.3",
     "hast-util-to-jsx-runtime": "^2.3.6",
     "remark": "^15.0.1",
-    "remark-rehype": "^11.1.1",
+    "remark-rehype": "^11.1.2",
     "shiki": "^3.2.1",
     "ts-morph": "^25.0.1",
     "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
     "@mdx-js/mdx": "^3.1.0",
-    "@types/estree": "^1.0.6",
+    "@types/estree": "^1.0.7",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
-    "@types/node": "22.13.11",
-    "@types/react": "19.0.12",
-    "@types/react-dom": "19.0.4",
+    "@types/node": "22.14.0",
+    "@types/react": "19.1.0",
+    "@types/react-dom": "19.1.1",
     "typescript": "^5.8.2",
     "unified": "^11.0.5",
     "eslint-config-custom": "0.0.0",
-    "fumadocs-core": "15.1.3",
-    "fumadocs-ui": "15.1.3",
+    "fumadocs-core": "15.2.2",
+    "fumadocs-ui": "15.2.2",
     "tsconfig": "0.0.0"
   },
   "peerDependencies": {