fumadocs-typescript 1.0.0 → 1.0.2

package/dist/{base-tTG4_ClF.d.ts → base-3iGxlbJG.d.ts}

@@ -5,6 +5,10 @@ interface TypescriptConfig {
     tsconfigPath?: string;
     /** A root directory to resolve relative path entries in the config file to. e.g. outDir */
     basePath?: string;
+    /**
+     * Default lib directory, use `./node_modules/typescript/lib` if not specified
+     */
+    getDefaultLibLocation?: (() => string) | 'default';
 }
 
 interface GeneratedDoc {
@@ -21,15 +25,22 @@ interface DocEntry {
 interface EntryContext {
     program: ts.Program;
     checker: ts.TypeChecker;
-    options: GenerateOptions;
+    transform?: Transformer;
     type: ts.Type;
     symbol: ts.Symbol;
 }
+type Transformer = (this: EntryContext, entry: DocEntry, propertyType: ts.Type, propertySymbol: ts.Symbol) => void;
 interface GenerateOptions {
+    /**
+     * Allow fields with `@internal` tag
+     *
+     * @defaultValue false
+     */
+    allowInternal?: boolean;
     /**
      * Modify output property entry
      */
-    transform?: (this: EntryContext, entry: DocEntry, propertyType: ts.Type, propertySymbol: ts.Symbol) => void;
+    transform?: Transformer;
 }
 interface GenerateDocumentationOptions extends GenerateOptions {
     /**
@@ -41,6 +52,6 @@ interface GenerateDocumentationOptions extends GenerateOptions {
  * Generate documentation for properties in an exported type/interface
  */
 declare function generateDocumentation(file: string, name: string, options?: GenerateDocumentationOptions): GeneratedDoc | undefined;
-declare function generate(program: ts.Program, symbol: ts.Symbol, options: GenerateOptions): GeneratedDoc;
+declare function generate(program: ts.Program, symbol: ts.Symbol, { allowInternal, transform }: GenerateOptions): GeneratedDoc;
 
 export { type DocEntry as D, type GenerateOptions as G, type TypescriptConfig as T, type GeneratedDoc as a, type GenerateDocumentationOptions as b, generate as c, generateDocumentation as g };

package/dist/{chunk-HQHQFSUJ.js → chunk-KXYVJC2E.js}

@@ -1,6 +1,4 @@
 var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __propIsEnum = Object.prototype.propertyIsEnumerable;
@@ -16,7 +14,6 @@ var __spreadValues = (a, b) => {
     }
   return a;
 };
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 var __objRest = (source, exclude) => {
   var target = {};
   for (var prop in source)
@@ -30,7 +27,7 @@ var __objRest = (source, exclude) => {
   return target;
 };
 var __async = (__this, __arguments, generator) => {
-  return new Promise((resolve, reject) => {
+  return new Promise((resolve2, reject) => {
     var fulfilled = (value) => {
       try {
         step(generator.next(value));
@@ -45,7 +42,7 @@ var __async = (__this, __arguments, generator) => {
         reject(e);
       }
     };
-    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    var step = (x) => x.done ? resolve2(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
@@ -54,6 +51,7 @@ var __async = (__this, __arguments, generator) => {
 import ts2 from "typescript";
 
 // src/program.ts
+import * as path from "path";
 import ts from "typescript";
 var cache = /* @__PURE__ */ new Map();
 function getFileSymbol(file, program) {
@@ -64,25 +62,31 @@ function getFileSymbol(file, program) {
   return checker.getSymbolAtLocation(sourceFile);
 }
 function getProgram(options = {}) {
-  var _a, _b, _c;
+  var _a, _b, _c, _d;
   const key = JSON.stringify(options);
   const cached = cache.get(key);
   if (cached)
     return cached;
   const configFile = ts.readJsonConfigFile(
     (_a = options.tsconfigPath) != null ? _a : "./tsconfig.json",
-    (path) => ts.sys.readFile(path)
+    (p) => ts.sys.readFile(p)
   );
   const parsed = ts.parseJsonSourceFileConfigFileContent(
     configFile,
     ts.sys,
     (_b = options.basePath) != null ? _b : "./"
   );
+  parsed.options.incremental = false;
+  const host = ts.createCompilerHost(parsed.options);
+  if (options.getDefaultLibLocation !== "default") {
+    host.getDefaultLibLocation = (_c = options.getDefaultLibLocation) != null ? _c : () => path.resolve("./node_modules/typescript/lib");
+  }
   const program = ts.createProgram({
-    rootNames: (_c = options.files) != null ? _c : parsed.fileNames,
-    options: __spreadProps(__spreadValues({}, parsed.options), {
-      incremental: false
-    })
+    rootNames: (_d = options.files) != null ? _d : parsed.fileNames,
+    host,
+    options: parsed.options,
+    configFileParsingDiagnostics: parsed.errors,
+    projectReferences: parsed.projectReferences
   });
   cache.set(key, program);
   return program;
@@ -99,12 +103,12 @@ function generateDocumentation(file, name, options = {}) {
     return;
   return generate(program, symbol, options);
 }
-function generate(program, symbol, options) {
+function generate(program, symbol, { allowInternal = false, transform }) {
   const checker = program.getTypeChecker();
   const type = checker.getDeclaredTypeOfSymbol(symbol);
   const entryContext = {
     checker,
-    options,
+    transform,
     program,
     type,
     symbol
@@ -114,12 +118,12 @@ function generate(program, symbol, options) {
     description: ts2.displayPartsToString(
       symbol.getDocumentationComment(checker)
     ),
-    entries: type.getProperties().map((prop) => getDocEntry(prop, entryContext))
+    entries: type.getProperties().map((prop) => getDocEntry(prop, entryContext)).filter((entry) => allowInternal || !("internal" in entry.tags))
   };
 }
 function getDocEntry(prop, context) {
-  var _a, _b, _c;
-  const { checker, options } = context;
+  var _a, _b;
+  const { checker, transform } = context;
   const subType = checker.getTypeOfSymbol(prop);
   const tags = Object.fromEntries(
     prop.getJsDocTags().map((tag) => [tag.name, ts2.displayPartsToString(tag.text)])
@@ -141,7 +145,7 @@ function getDocEntry(prop, context) {
     tags,
     type: typeName
   };
-  (_c = options.transform) == null ? void 0 : _c.call(context, entry, subType, prop);
+  transform == null ? void 0 : transform.call(context, entry, subType, prop);
   return entry;
 }
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { G as GenerateOptions, T as TypescriptConfig, a as GeneratedDoc, D as DocEntry } from './base-tTG4_ClF.js';
-export { b as GenerateDocumentationOptions, c as generate, g as generateDocumentation } from './base-tTG4_ClF.js';
+import { G as GenerateOptions, T as TypescriptConfig, a as GeneratedDoc, D as DocEntry } from './base-3iGxlbJG.js';
+export { b as GenerateDocumentationOptions, c as generate, g as generateDocumentation } from './base-3iGxlbJG.js';
 import fg from 'fast-glob';
 import 'typescript';
 

package/dist/index.js

@@ -6,7 +6,7 @@ import {
   generateDocumentation,
   getFileSymbol,
   getProgram
-} from "./chunk-HQHQFSUJ.js";
+} from "./chunk-KXYVJC2E.js";
 
 // src/generate/mdx.ts
 import * as path from "path";

package/dist/ui/index.d.ts

@@ -1,4 +1,4 @@
-import { G as GenerateOptions } from '../base-tTG4_ClF.js';
+import { G as GenerateOptions } from '../base-3iGxlbJG.js';
 import 'typescript';
 
 /**
@@ -10,6 +10,6 @@ declare function AutoTypeTable({ path, name, options, }: {
     path: string;
     name: string;
     options?: GenerateOptions;
-}): JSX.Element;
+}): React.ReactElement;
 
 export { AutoTypeTable };

package/dist/ui/index.js

@@ -1,6 +1,6 @@
 import {
   generateDocumentation
-} from "../chunk-HQHQFSUJ.js";
+} from "../chunk-KXYVJC2E.js";
 
 // src/ui/auto-type-table.tsx
 import { TypeTable } from "fumadocs-ui/components/type-table";
@@ -9,9 +9,7 @@ import { TypeTable } from "fumadocs-ui/components/type-table";
 import { fromMarkdown } from "mdast-util-from-markdown";
 import { gfmFromMarkdown } from "mdast-util-gfm";
 import { toHast } from "mdast-util-to-hast";
-import {
-  toJsxRuntime
-} from "hast-util-to-jsx-runtime";
+import { toJsxRuntime } from "hast-util-to-jsx-runtime";
 import * as runtime from "react/jsx-runtime";
 function renderMarkdown(md) {
   const mdast = fromMarkdown(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-typescript",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Typescript Integration for Fumadocs",
   "keywords": [
     "NextJs",
@@ -44,10 +44,10 @@
   "devDependencies": {
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
-    "@types/react": "18.2.0",
-    "@types/react-dom": "18.2.1",
+    "@types/react": "18.2.67",
+    "@types/react-dom": "18.2.22",
     "eslint-config-custom": "0.0.0",
-    "fumadocs-ui": "10.0.0",
+    "fumadocs-ui": "10.1.0",
     "tsconfig": "0.0.0"
   },
   "peerDependencies": {