fumadocs-typescript 4.0.2 → 4.0.4

package/dist/{base-ze7ajmJT.d.ts → base-CDpZg096.d.ts}

@@ -6,7 +6,7 @@ interface TypescriptConfig {
     /** A root directory to resolve relative path entries in the config file to. e.g. outDir */
     basePath?: string;
 }
-declare function getProject(options?: TypescriptConfig): Project;
+declare function createProject(options?: TypescriptConfig): Project;
 
 interface BaseTypeTableProps {
     /**
@@ -58,6 +58,7 @@ interface DocEntry {
     type: string;
     tags: Record<string, string>;
     required: boolean;
+    deprecated: boolean;
 }
 interface EntryContext {
     program: Project;
@@ -79,7 +80,16 @@ interface GenerateOptions {
     transform?: Transformer;
 }
 type Generator = ReturnType<typeof createGenerator>;
-declare function createGenerator(config?: TypescriptConfig | Project): {
+interface GeneratorOptions extends TypescriptConfig {
+    /**
+     * cache results, note that some options are not marked as dependency.
+     *
+     * @defaultValue fs
+     */
+    cache?: 'fs' | false;
+    project?: Project;
+}
+declare function createGenerator(config?: GeneratorOptions | Project): {
     generateDocumentation(file: {
         path: string;
         content?: string;
@@ -99,4 +109,4 @@ declare function generateDocumentation(file: string, name: string | undefined, c
     project?: Project;
 }): GeneratedDoc[];
 
-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 };
+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, createProject as d, type GeneratorOptions as e, createGenerator as f, generateDocumentation as g };

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 './base-ze7ajmJT.js';
-export { d as createGenerator, e as generateDocumentation, g as getProject } from './base-ze7ajmJT.js';
+import { G as GenerateOptions, a as GeneratedDoc, D as DocEntry, b as Generator, c as GenerateTypeTableOptions } from './base-CDpZg096.js';
+export { e as GeneratorOptions, f as createGenerator, d as createProject, g as generateDocumentation } from './base-CDpZg096.js';
 import fg from 'fast-glob';
 import { Nodes } from 'hast';
 import { Root } from 'mdast';

package/dist/index.js

@@ -12,9 +12,9 @@ import {
   ts
 } from "ts-morph";
 
-// src/get-project.ts
+// src/create-project.ts
 import { Project } from "ts-morph";
-function getProject(options = {}) {
+function createProject(options = {}) {
   var _a;
   return new Project({
     tsConfigFilePath: (_a = options.tsconfigPath) != null ? _a : "./tsconfig.json",
@@ -23,7 +23,7 @@ function getProject(options = {}) {
 }
 
 // src/lib/base.ts
-import fs2 from "node:fs";
+import fs3 from "node:fs";
 
 // src/lib/type-table.ts
 import * as fs from "node:fs/promises";
@@ -56,19 +56,61 @@ export type ${typeName} = ${type}`;
   });
 }
 
+// src/lib/cache.ts
+import fs2 from "node:fs";
+import { createHash } from "node:crypto";
+import path from "node:path";
+function createCache() {
+  const dir = path.join(process.cwd(), ".next/fumadocs-typescript");
+  try {
+    fs2.mkdirSync(dir, { recursive: true });
+  } catch (e) {
+  }
+  return {
+    write(input, data) {
+      const hash = createHash("SHA256").update(input).digest("hex").slice(0, 12);
+      fs2.writeFileSync(path.join(dir, `${hash}.json`), JSON.stringify(data));
+    },
+    read(input) {
+      const hash = createHash("SHA256").update(input).digest("hex").slice(0, 12);
+      try {
+        return JSON.parse(
+          fs2.readFileSync(path.join(dir, `${hash}.json`)).toString()
+        );
+      } catch (e) {
+        return;
+      }
+    }
+  };
+}
+
 // src/lib/base.ts
+import path2 from "node:path";
 function createGenerator(config) {
-  const project = config instanceof Project2 ? config : getProject(config);
+  var _a;
+  const options = config instanceof Project2 ? {
+    project: config
+  } : config;
+  const cacheType = (_a = options == null ? void 0 : options.cache) != null ? _a : "fs";
+  const cache = cacheType === "fs" ? createCache() : null;
+  let instance;
+  function getProject() {
+    var _a2;
+    instance != null ? instance : instance = (_a2 = options == null ? void 0 : options.project) != null ? _a2 : createProject(options);
+    return instance;
+  }
   return {
-    generateDocumentation(file, name, options = {}) {
-      var _a;
-      const sourceFile = project.createSourceFile(
-        file.path,
-        (_a = file.content) != null ? _a : fs2.readFileSync(file.path).toString(),
-        {
-          overwrite: true
-        }
-      );
+    generateDocumentation(file, name, options2) {
+      var _a2;
+      const content = (_a2 = file.content) != null ? _a2 : fs3.readFileSync(path2.resolve(file.path)).toString();
+      const cacheKey = `${file.path}:${name}:${content}`;
+      if (cache) {
+        const cached = cache.read(cacheKey);
+        if (cached) return cached;
+      }
+      const sourceFile = getProject().createSourceFile(file.path, content, {
+        overwrite: true
+      });
       const out = [];
       for (const [k, d] of sourceFile.getExportedDeclarations()) {
         if (name && name !== k) continue;
@@ -76,12 +118,13 @@ function createGenerator(config) {
           console.warn(
             `export ${k} should not have more than one type declaration.`
           );
-        out.push(generate(project, k, d[0], options));
+        out.push(generate(getProject(), k, d[0], options2));
       }
+      cache == null ? void 0 : cache.write(cacheKey, out);
       return out;
     },
-    generateTypeTable(props, options) {
-      return getTypeTableOutput(this, props, options);
+    generateTypeTable(props, options2) {
+      return getTypeTableOutput(this, props, options2);
     }
   };
 }
@@ -90,7 +133,7 @@ function generateDocumentation(file, name, content, options = {}) {
   const gen = createGenerator((_a = options.project) != null ? _a : options.config);
   return gen.generateDocumentation({ path: file, content }, name, options);
 }
-function generate(program, name, declaration, { allowInternal = false, transform }) {
+function generate(program, name, declaration, { allowInternal = false, transform } = {}) {
   var _a;
   const entryContext = {
     transform,
@@ -141,14 +184,15 @@ function getDocEntry(prop, context) {
     ),
     tags,
     type: typeName,
-    required: !prop.isOptional()
+    required: !prop.isOptional(),
+    deprecated: prop.getJsDocTags().some((tag) => tag.getName() === "deprecated")
   };
   transform == null ? void 0 : transform.call(context, entry, subType, prop);
   return entry;
 }
 
 // src/lib/mdx.ts
-import * as path from "node:path";
+import * as path3 from "node:path";
 var regex = new RegExp("^---type-table---\\r?\\n(?<file>.+?)(?:#(?<name>.+))?\\r?\\n---end---$", "gm");
 var defaultTemplates = {
   block: (doc, c) => `### ${doc.name}
@@ -175,7 +219,7 @@ function generateMDX(generator, source, _a = {}) {
   const templates = __spreadValues(__spreadValues({}, defaultTemplates), overrides);
   return source.replace(regex, (...args) => {
     const groups = args[args.length - 1];
-    const file = path.resolve(basePath, groups.file);
+    const file = path3.resolve(basePath, groups.file);
     const docs = generator.generateDocumentation(
       { path: file },
       groups.name,
@@ -191,21 +235,21 @@ function replaceJsDocLinks(md) {
 }
 
 // src/lib/file.ts
-import * as path2 from "node:path";
+import * as path4 from "node:path";
 import { mkdir, writeFile, readFile as readFile2 } from "node:fs/promises";
 import fg from "fast-glob";
 function generateFiles(generator, options) {
   return __async(this, null, function* () {
     const files = yield fg(options.input, options.globOptions);
-    const produce = files.map((file) => __async(this, null, function* () {
-      const absolutePath = path2.resolve(file);
-      const outputPath = typeof options.output === "function" ? options.output(file) : path2.resolve(
+    const produce = files.map((file) => __async(null, null, function* () {
+      const absolutePath = path4.resolve(file);
+      const outputPath = typeof options.output === "function" ? options.output(file) : path4.resolve(
         options.output,
-        `${path2.basename(file, path2.extname(file))}.mdx`
+        `${path4.basename(file, path4.extname(file))}.mdx`
       );
       const content = (yield readFile2(absolutePath)).toString();
       let result = generateMDX(generator, content, __spreadValues({
-        basePath: path2.dirname(absolutePath)
+        basePath: path4.dirname(absolutePath)
       }, options.options));
       if (options.transformOutput) {
         result = options.transformOutput(outputPath, result);
@@ -218,7 +262,7 @@ function generateFiles(generator, options) {
 }
 function write(file, content) {
   return __async(this, null, function* () {
-    yield mkdir(path2.dirname(file), { recursive: true });
+    yield mkdir(path4.dirname(file), { recursive: true });
     yield writeFile(file, content);
   });
 }
@@ -258,8 +302,8 @@ function mapProperty(entry, renderMarkdown) {
       shorthand: false,
       computed: false,
       key: {
-        type: "Identifier",
-        name: entry.name
+        type: "Literal",
+        value: entry.name
       },
       kind: "init",
       value
@@ -274,7 +318,7 @@ function remarkAutoTypeTable({
   remarkStringify = true,
   generator = createGenerator()
 } = {}) {
-  return (tree, file) => __async(this, null, function* () {
+  return (tree, file) => __async(null, null, function* () {
     const queue = [];
     let basePath = options == null ? void 0 : options.basePath;
     if (!basePath && file.path) basePath = dirname2(file.path);
@@ -296,7 +340,7 @@ function remarkAutoTypeTable({
               basePath
             })
           );
-          const rendered = output.map((doc) => __async(this, null, function* () {
+          const rendered = output.map((doc) => __async(null, null, function* () {
             const properties = yield Promise.all(
               doc.entries.map((entry) => mapProperty(entry, renderMarkdown))
             );
@@ -346,10 +390,10 @@ function remarkAutoTypeTable({
 }
 export {
   createGenerator,
+  createProject,
   generateDocumentation,
   generateFiles,
   generateMDX,
-  getProject,
   remarkAutoTypeTable,
   renderMarkdownToHast
 };

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 '../base-ze7ajmJT.js';
+import { B as BaseTypeTableProps, b as Generator, c as GenerateTypeTableOptions } from '../base-CDpZg096.js';
 import 'ts-morph';
 
 type AutoTypeTableProps = BaseTypeTableProps;

package/dist/ui/index.js

@@ -25,16 +25,17 @@ function AutoTypeTable(_a) {
       "renderMarkdown"
     ]);
     const output = yield generator.generateTypeTable(props, options);
-    return output.map((item) => __async(this, null, function* () {
+    return output.map((item) => __async(null, null, function* () {
       const entries = item.entries.map(
-        (entry) => __async(this, null, function* () {
+        (entry) => __async(null, null, function* () {
           return [
             entry.name,
             {
               type: entry.type,
               description: yield renderMarkdown(entry.description),
               default: entry.tags.default || entry.tags.defaultValue,
-              required: entry.required
+              required: entry.required,
+              deprecated: entry.deprecated
             }
           ];
         })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-typescript",
-  "version": "4.0.2",
+  "version": "4.0.4",
   "description": "Typescript Integration for Fumadocs",
   "keywords": [
     "NextJs",
@@ -28,13 +28,13 @@
     "dist/*"
   ],
   "dependencies": {
-    "estree-util-value-to-estree": "^3.3.2",
+    "estree-util-value-to-estree": "^3.3.3",
     "fast-glob": "^3.3.3",
     "hast-util-to-estree": "^3.1.3",
     "hast-util-to-jsx-runtime": "^2.3.6",
     "remark": "^15.0.1",
     "remark-rehype": "^11.1.2",
-    "shiki": "^3.2.1",
+    "shiki": "^3.4.0",
     "ts-morph": "^25.0.1",
     "unist-util-visit": "^5.0.0"
   },
@@ -43,14 +43,14 @@
     "@types/estree": "^1.0.7",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
-    "@types/node": "22.14.0",
-    "@types/react": "19.1.0",
-    "@types/react-dom": "19.1.1",
-    "typescript": "^5.8.2",
+    "@types/node": "22.15.12",
+    "@types/react": "19.1.3",
+    "@types/react-dom": "19.1.3",
+    "typescript": "^5.8.3",
     "unified": "^11.0.5",
     "eslint-config-custom": "0.0.0",
-    "fumadocs-core": "15.2.2",
-    "fumadocs-ui": "15.2.2",
+    "fumadocs-core": "15.3.1",
+    "fumadocs-ui": "15.3.1",
     "tsconfig": "0.0.0"
   },
   "peerDependencies": {