fumadocs-typescript 1.0.0 → 1.0.1

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

@@ -21,15 +21,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 +48,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-J5BKKGOH.js}

@@ -99,12 +99,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 +114,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 +141,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-EFDclhRL.js';
+export { b as GenerateDocumentationOptions, c as generate, g as generateDocumentation } from './base-EFDclhRL.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-J5BKKGOH.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-EFDclhRL.js';
 import 'typescript';
 
 /**

package/dist/ui/index.js

@@ -1,6 +1,6 @@
 import {
   generateDocumentation
-} from "../chunk-HQHQFSUJ.js";
+} from "../chunk-J5BKKGOH.js";
 
 // src/ui/auto-type-table.tsx
 import { TypeTable } from "fumadocs-ui/components/type-table";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-typescript",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Typescript Integration for Fumadocs",
   "keywords": [
     "NextJs",
@@ -47,7 +47,7 @@
     "@types/react": "18.2.0",
     "@types/react-dom": "18.2.1",
     "eslint-config-custom": "0.0.0",
-    "fumadocs-ui": "10.0.0",
+    "fumadocs-ui": "10.0.2",
     "tsconfig": "0.0.0"
   },
   "peerDependencies": {