fumadocs-core 9.0.0 → 10.0.0

package/dist/breadcrumb.d.ts

@@ -1,4 +1,4 @@
-import { R as Root } from './page-tree-izSPERQk.js';
+import { R as Root } from './page-tree-mLHMYx2B.js';
 import 'react';
 
 interface BreadcrumbItem {

package/dist/{page-tree-izSPERQk.d.ts → page-tree-mLHMYx2B.d.ts}

@@ -20,6 +20,7 @@ interface Folder {
     type: 'folder';
     name: string;
     root?: boolean;
+    defaultOpen?: boolean;
     index?: Item;
     icon?: ReactElement;
     children: Node[];

package/dist/server/index.d.ts

@@ -1,7 +1,7 @@
 import { T as TableOfContents } from '../get-toc-YF_TdazL.js';
 export { a as TOCItemType, g as getTableOfContents } from '../get-toc-YF_TdazL.js';
-import { N as Node, I as Item, R as Root } from '../page-tree-izSPERQk.js';
-export { p as PageTree } from '../page-tree-izSPERQk.js';
+import { N as Node, I as Item, R as Root } from '../page-tree-mLHMYx2B.js';
+export { p as PageTree } from '../page-tree-mLHMYx2B.js';
 import 'react';
 
 /**

package/dist/source/index.d.ts

@@ -1,5 +1,22 @@
 import { ReactElement } from 'react';
-import { R as Root } from '../page-tree-izSPERQk.js';
+import { R as Root } from '../page-tree-mLHMYx2B.js';
+
+interface FileInfo {
+    locale?: string;
+    /**
+     * Original path of file
+     */
+    path: string;
+    /**
+     * File path without extension
+     */
+    flattenedPath: string;
+    /**
+     * File name without locale and extension
+     */
+    name: string;
+    dirname: string;
+}
 
 interface LoadOptions {
     files: VirtualFile[];
@@ -15,10 +32,12 @@ interface VirtualFile {
 }
 interface LoadResult {
     storage: Storage;
+}
+type Transformer = (context: {
+    storage: Storage;
     getSlugs: (info: FileInfo) => string[];
     getUrl: (slugs: string[], locale?: string) => string;
-    data: Record<string, unknown>;
-}
+}) => void;
 declare function load(options: LoadOptions): LoadResult;
 
 interface LoaderConfig {
@@ -54,7 +73,7 @@ interface Source<Config extends SourceConfig> {
 }
 interface LoaderOutput<Config extends LoaderConfig> {
     pageTree: Config['i18n'] extends true ? Record<string, Root> : Root;
-    files: Node<Config['source']['metaData'], Config['source']['pageData']>[];
+    files: (Meta<Config['source']['metaData']> | Page<Config['source']['pageData']>)[];
     /**
      * Get list of pages from language, empty if language hasn't specified
      *
@@ -72,27 +91,12 @@ declare function loader<Options extends LoaderOptions>(options: Options): Loader
     i18n: Options['languages'] extends string[] ? true : false;
 }>;
 
-interface FileInfo {
-    locale?: string;
-    /**
-     * Original path of file
-     */
-    path: string;
-    /**
-     * File path without extension
-     */
-    flattenedPath: string;
-    /**
-     * File name without locale and extension
-     */
-    name: string;
-    dirname: string;
-}
 interface MetaData {
     icon?: string;
     title?: string;
     root?: boolean;
     pages?: string[];
+    defaultOpen?: boolean;
 }
 interface PageData {
     icon?: string;
@@ -100,7 +104,6 @@ interface PageData {
 }
 type InferPageType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput<infer Config> ? Page<Config['source']['pageData']> : never;
 type InferMetaType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput<infer Config> ? Meta<Config['source']['metaData']> : never;
-type Transformer = (context: LoadResult) => void;
 
 interface Meta<Data extends MetaData = MetaData> {
     type: 'meta';
@@ -117,9 +120,8 @@ interface Page<Data extends PageData = PageData> {
 interface Folder<MD extends MetaData = MetaData, PD extends PageData = PageData> {
     type: 'folder';
     file: FileInfo;
-    children: Node<MD, PD>[];
+    children: (Meta<MD> | Page<PD> | Folder<MD, PD>)[];
 }
-type Node<MD extends MetaData = MetaData, PD extends PageData = PageData> = Meta<MD> | Page<PD> | Folder;
 /**
  * A virtual file system that solves inconsistent behaviours
  *
@@ -131,10 +133,17 @@ declare class Storage {
     private rootFolder;
     constructor();
     /**
-     * Read a file, it doesn't need an extension
      * @param path - flattened path
      */
-    read(path: string): Page | Meta | undefined;
+    private read;
+    /**
+     * @param path - flattened path
+     */
+    readPage(path: string): Page | undefined;
+    /**
+     * @param path - flattened path
+     */
+    readMeta(path: string): Meta | undefined;
     readDir(path: string): Folder | undefined;
     root(): Folder;
     write(path: string, file: Omit<Page, 'file'> | Omit<Meta, 'file'>): void;
@@ -144,12 +153,11 @@ declare class Storage {
 
 type fileSystem_Folder<MD extends MetaData = MetaData, PD extends PageData = PageData> = Folder<MD, PD>;
 type fileSystem_Meta<Data extends MetaData = MetaData> = Meta<Data>;
-type fileSystem_Node<MD extends MetaData = MetaData, PD extends PageData = PageData> = Node<MD, PD>;
 type fileSystem_Page<Data extends PageData = PageData> = Page<Data>;
 type fileSystem_Storage = Storage;
 declare const fileSystem_Storage: typeof Storage;
 declare namespace fileSystem {
-  export { type fileSystem_Folder as Folder, type fileSystem_Meta as Meta, type fileSystem_Node as Node, type fileSystem_Page as Page, fileSystem_Storage as Storage };
+  export { type fileSystem_Folder as Folder, type fileSystem_Meta as Meta, type fileSystem_Page as Page, fileSystem_Storage as Storage };
 }
 
 interface BuildPageTreeOptionsWithI18n {
@@ -168,4 +176,4 @@ interface CreatePageTreeBuilderOptions {
 }
 declare function createPageTreeBuilder({ storage, resolveIcon, }: CreatePageTreeBuilderOptions): PageTreeBuilder;
 
-export { type BuildPageTreeOptionsWithI18n, type CreatePageTreeBuilderOptions, type FileInfo, fileSystem as FileSystem, type InferMetaType, type InferPageType, type LoadOptions, type LoadResult, type LoaderOptions, type LoaderOutput, type MetaData, type PageData, type PageTreeBuilder, type Source, type Transformer, type VirtualFile, createPageTreeBuilder, load, loader };
+export { type BuildPageTreeOptionsWithI18n, type CreatePageTreeBuilderOptions, fileSystem as FileSystem, type InferMetaType, type InferPageType, type LoadOptions, type LoadResult, type LoaderOptions, type LoaderOutput, type MetaData, type PageData, type PageTreeBuilder, type Source, type Transformer, type VirtualFile, createPageTreeBuilder, load, loader };

package/dist/source/index.js

@@ -3,50 +3,41 @@ import {
 } from "../chunk-UWEEHUJV.js";
 import {
   __export,
-  __spreadProps,
   __spreadValues
 } from "../chunk-WEAGW6MQ.js";
 
 // src/source/path.ts
 import { parse } from "path";
-function parseFilePath(path) {
-  const parsed = parse(path);
-  const dir = slash(parsed.dir);
-  const flattenedPath = joinPaths([dir, parsed.name]);
+function parseFilePath(path2) {
+  const slashedPath = slash(path2);
+  const parsed = parse(slashedPath);
+  const flattenedPath = joinPaths([parsed.dir, parsed.name]);
   const [name, locale] = parsed.name.split(".");
   return {
-    dirname: dir,
+    dirname: parsed.dir,
     name,
     flattenedPath,
     locale,
-    path
+    path: slashedPath
   };
 }
-function isRelative(path, root) {
-  return path.startsWith(root);
-}
-function getRelativePath(path, root) {
-  if (!isRelative(path, root))
-    throw new Error("Invalid path");
-  return splitPath(path.substring(root.length)).join("/");
-}
-function parseFolderPath(path) {
-  const parsed = parse(path);
-  const dir = slash(parsed.dir);
+function parseFolderPath(path2) {
+  const slashedPath = slash(path2);
+  const parsed = parse(slashedPath);
   const [name, locale] = parsed.base.split(".");
   return {
-    dirname: dir,
+    dirname: parsed.dir,
     name,
-    flattenedPath: path,
+    flattenedPath: slashedPath,
     locale,
-    path
+    path: slashedPath
   };
 }
-function splitPath(path) {
-  return path.split("/").filter((p) => p.length > 0);
+function splitPath(path2) {
+  return path2.split("/").filter((p) => p.length > 0);
 }
 function joinPaths(paths, slashMode = "none") {
-  const joined = paths.flatMap((path) => splitPath(path)).join("/");
+  const joined = paths.flatMap((path2) => splitPath(path2)).join("/");
   switch (slashMode) {
     case "leading":
       return `/${joined}`;
@@ -58,6 +49,7 @@ function joinPaths(paths, slashMode = "none") {
 }
 
 // src/source/page-tree-builder.ts
+var external = new RegExp("\\[(?<text>.+)\\]\\((?<url>.+)\\)");
 var separator = new RegExp("---(?<name>.*?)---");
 var rest = "...";
 var extractor = new RegExp("\\.\\.\\.(?<name>.+)");
@@ -78,58 +70,73 @@ function buildAll(nodes, ctx, skipIndex) {
       output.push(treeNode);
     }
     if (node.type === "folder") {
-      output.push(buildFolderNode(node, ctx));
+      output.push(buildFolderNode(node, false, ctx));
     }
   }
   return output;
 }
 function getFolderMeta(folder, ctx) {
   var _a;
-  let meta = ctx.storage.read(joinPaths([folder.file.path, "meta"]));
+  let meta = ctx.storage.readMeta(joinPaths([folder.file.path, "meta"]));
   if (ctx.lang) {
-    meta = (_a = ctx.storage.read(joinPaths([folder.file.path, `meta.${ctx.lang}`]))) != null ? _a : meta;
+    meta = (_a = ctx.storage.readMeta(joinPaths([folder.file.path, `meta.${ctx.lang}`]))) != null ? _a : meta;
+  }
+  return meta;
+}
+function resolveFolderItem(folder, item, ctx, addedNodePaths) {
+  var _a, _b, _c;
+  if (item === rest)
+    return "...";
+  const separateResult = separator.exec(item);
+  if (separateResult == null ? void 0 : separateResult.groups) {
+    return [
+      {
+        type: "separator",
+        name: separateResult.groups.name
+      }
+    ];
+  }
+  const externalResult = external.exec(item);
+  if (externalResult == null ? void 0 : externalResult.groups) {
+    return [
+      {
+        type: "page",
+        name: externalResult.groups.text,
+        url: externalResult.groups.url,
+        external: true
+      }
+    ];
+  }
+  const extractResult = extractor.exec(item);
+  const path2 = joinPaths([
+    folder.file.path,
+    (_b = (_a = extractResult == null ? void 0 : extractResult.groups) == null ? void 0 : _a.name) != null ? _b : item
+  ]);
+  const itemNode = (_c = ctx.storage.readDir(path2)) != null ? _c : ctx.storage.readPage(path2);
+  if (!itemNode)
+    return [];
+  addedNodePaths.add(itemNode.file.path);
+  if (itemNode.type === "folder") {
+    const node = buildFolderNode(itemNode, false, ctx);
+    return extractResult ? node.children : [node];
   }
-  if ((meta == null ? void 0 : meta.type) === "meta")
-    return meta;
+  return [buildFileNode(itemNode, ctx)];
 }
-function buildFolderNode(folder, ctx, root = false) {
+function buildFolderNode(folder, defaultIsRoot, ctx) {
   var _a, _b, _c, _d, _e;
-  const indexNode = folder.children.find(
-    (node) => node.type === "page" && node.file.name === "index"
+  const indexFile = ctx.storage.readPage(
+    joinPaths([folder.file.flattenedPath, "index"])
   );
-  const index = indexNode ? buildFileNode(indexNode, ctx) : void 0;
+  const index = indexFile ? buildFileNode(indexFile, ctx) : void 0;
   const meta = (_a = getFolderMeta(folder, ctx)) == null ? void 0 : _a.data;
   let children;
   if (!meta) {
-    children = buildAll(folder.children, ctx, !root);
+    children = buildAll(folder.children, ctx, !defaultIsRoot);
   } else {
-    const isRoot = (_b = meta.root) != null ? _b : root;
+    const isRoot = (_b = meta.root) != null ? _b : defaultIsRoot;
     const addedNodePaths = /* @__PURE__ */ new Set();
     const resolved = (_c = meta.pages) == null ? void 0 : _c.flatMap((item) => {
-      var _a2, _b2, _c2;
-      if (item === rest)
-        return "...";
-      const result = separator.exec(item);
-      if (result == null ? void 0 : result.groups) {
-        return {
-          type: "separator",
-          name: result.groups.name
-        };
-      }
-      const extractResult = extractor.exec(item);
-      const extractName = (_b2 = (_a2 = extractResult == null ? void 0 : extractResult.groups) == null ? void 0 : _a2.name) != null ? _b2 : item;
-      const itemNode = (_c2 = ctx.storage.readDir(joinPaths([folder.file.path, extractName]))) != null ? _c2 : ctx.storage.read(joinPaths([folder.file.path, extractName]));
-      if (!itemNode)
-        return [];
-      addedNodePaths.add(itemNode.file.path);
-      if (itemNode.type === "folder") {
-        const node = buildFolderNode(itemNode, ctx);
-        return (extractResult == null ? void 0 : extractResult.groups) ? node.children : node;
-      }
-      if (itemNode.type === "page") {
-        return buildFileNode(itemNode, ctx);
-      }
-      return [];
+      return resolveFolderItem(folder, item, ctx, addedNodePaths);
     });
     const restNodes = buildAll(
       folder.children.filter((node) => !addedNodePaths.has(node.file.path)),
@@ -149,6 +156,7 @@ function buildFolderNode(folder, ctx, root = false) {
     name: (_e = (_d = meta == null ? void 0 : meta.title) != null ? _d : index == null ? void 0 : index.name) != null ? _e : pathToName(folder.file.name),
     icon: ctx.resolveIcon(meta == null ? void 0 : meta.icon),
     root: meta == null ? void 0 : meta.root,
+    defaultOpen: meta == null ? void 0 : meta.defaultOpen,
     index,
     children
   };
@@ -156,8 +164,10 @@ function buildFolderNode(folder, ctx, root = false) {
 function buildFileNode(page, ctx) {
   let localePage = page;
   if (ctx.lang) {
-    const result = ctx.storage.read(`${page.file.flattenedPath}.${ctx.lang}`);
-    if ((result == null ? void 0 : result.type) === "page")
+    const result = ctx.storage.readPage(
+      `${page.file.flattenedPath}.${ctx.lang}`
+    );
+    if (result)
       localePage = result;
   }
   return {
@@ -169,7 +179,7 @@ function buildFileNode(page, ctx) {
 }
 function build(ctx) {
   const root = ctx.storage.root();
-  const folder = buildFolderNode(root, ctx, true);
+  const folder = buildFolderNode(root, true, ctx);
   return {
     name: folder.name,
     children: folder.children
@@ -179,33 +189,38 @@ function createPageTreeBuilder({
   storage,
   resolveIcon = () => void 0
 }) {
-  const context = {
-    storage,
-    resolveIcon(icon) {
-      if (!icon)
-        return;
-      return resolveIcon(icon);
-    }
-  };
+  function getContext(builder, locale) {
+    return {
+      storage,
+      lang: locale,
+      resolveIcon(icon) {
+        if (!icon)
+          return;
+        return resolveIcon(icon);
+      },
+      builder
+    };
+  }
   return {
     build() {
-      return build(context);
+      return build(getContext(this));
     },
     buildI18n({ languages = [] } = {}) {
       const entries = languages.map((lang) => {
-        const tree = build(__spreadProps(__spreadValues({}, context), {
-          lang
-        }));
+        const tree = build(getContext(this, lang));
         return [lang, tree];
       });
       return Object.fromEntries(entries);
     }
   };
 }
-function pathToName(path) {
-  return path.slice(0, 1).toUpperCase() + path.slice(1);
+function pathToName(path2) {
+  return path2.slice(0, 1).toUpperCase() + path2.slice(1);
 }
 
+// src/source/load.ts
+import * as path from "path";
+
 // src/source/file-system.ts
 var file_system_exports = {};
 __export(file_system_exports, {
@@ -223,33 +238,50 @@ var Storage = class {
     this.folders.set("", this.rootFolder);
   }
   /**
-   * Read a file, it doesn't need an extension
    * @param path - flattened path
    */
-  read(path) {
-    return this.files.get(path);
+  read(path2, type) {
+    return this.files.get(`${path2}.${type}`);
+  }
+  /**
+   * @param path - flattened path
+   */
+  readPage(path2) {
+    const result = this.read(path2, "page");
+    if ((result == null ? void 0 : result.type) !== "page")
+      return;
+    return result;
+  }
+  /**
+   * @param path - flattened path
+   */
+  readMeta(path2) {
+    const result = this.read(path2, "meta");
+    if ((result == null ? void 0 : result.type) !== "meta")
+      return;
+    return result;
   }
-  readDir(path) {
-    return this.folders.get(path);
+  readDir(path2) {
+    return this.folders.get(path2);
   }
   root() {
     return this.rootFolder;
   }
-  write(path, file) {
+  write(path2, file) {
     var _a;
     const node = __spreadValues({
-      file: parseFilePath(path)
+      file: parseFilePath(path2)
     }, file);
     this.makeDir(node.file.dirname);
     (_a = this.readDir(node.file.dirname)) == null ? void 0 : _a.children.push(node);
-    this.files.set(node.file.flattenedPath, node);
+    this.files.set(`${node.file.flattenedPath}.${node.type}`, node);
   }
   list() {
     return [...this.files.values()];
   }
-  makeDir(path) {
+  makeDir(path2) {
     var _a;
-    const segments = splitPath(path);
+    const segments = splitPath(path2);
     for (let i = 0; i < segments.length; i++) {
       const segment = segments.slice(0, i + 1).join("/");
       if (this.folders.has(segment))
@@ -269,27 +301,28 @@ var Storage = class {
 function load(options) {
   const { transformers = [] } = options;
   const storage = buildStorage(options);
-  const ctx = {
-    getSlugs: options.getSlugs,
-    getUrl: options.getUrl,
-    storage,
-    data: {}
-  };
   for (const transformer of transformers) {
-    transformer(ctx);
+    transformer({
+      storage,
+      getUrl: options.getUrl,
+      getSlugs: options.getSlugs
+    });
   }
-  return ctx;
+  return { storage };
 }
 function buildStorage(options) {
   const storage = new Storage();
   for (const file of options.files) {
-    if (!isRelative(file.path, options.rootDir))
+    const relativePath = path.join(
+      path.relative(options.rootDir, path.join("./", path.dirname(file.path))),
+      path.basename(file.path)
+    );
+    if (relativePath.startsWith("..") || path.isAbsolute(relativePath))
       continue;
-    const path = getRelativePath(file.path, options.rootDir);
     if (file.type === "page") {
-      const parsedPath = parseFilePath(path);
+      const parsedPath = parseFilePath(relativePath);
       const slugs = options.getSlugs(parsedPath);
-      storage.write(path, {
+      storage.write(relativePath, {
         slugs,
         url: options.getUrl(slugs, parsedPath.locale),
         type: file.type,
@@ -297,7 +330,7 @@ function buildStorage(options) {
       });
     }
     if (file.type === "meta") {
-      storage.write(path, {
+      storage.write(relativePath, {
         type: file.type,
         data: file.data
       });
@@ -306,26 +339,20 @@ function buildStorage(options) {
   return storage;
 }
 
-// src/source/create.ts
-function groupByLanguages(nodes, languages) {
+// src/source/loader.ts
+function groupByLanguages(storage, languages) {
   var _a, _b, _c;
-  const pageMap = /* @__PURE__ */ new Map();
-  for (const node of nodes) {
-    if (node.type === "page")
-      pageMap.set(node.file.flattenedPath, node);
-  }
   const langMap = /* @__PURE__ */ new Map();
   langMap.set("", []);
-  for (const lang of languages) {
-    langMap.set(lang, []);
-  }
-  for (const [key, node] of pageMap) {
-    if (node.file.locale)
+  for (const node of storage.list()) {
+    if (node.type !== "page" || node.file.locale)
       continue;
     (_a = langMap.get("")) == null ? void 0 : _a.push(node);
     for (const lang of languages) {
-      const v = (_b = pageMap.get(`${key}.${lang}`)) != null ? _b : node;
-      (_c = langMap.get(lang)) == null ? void 0 : _c.push(v);
+      const list = (_b = langMap.get(lang)) != null ? _b : [];
+      const page = (_c = storage.readPage(`${node.file.flattenedPath}.${lang}`)) != null ? _c : node;
+      list.push(page);
+      langMap.set(lang, list);
     }
   }
   return langMap;
@@ -338,6 +365,10 @@ function createGetUrl(baseUrl) {
     return joinPaths(paths, "leading");
   };
 }
+function getSlugs(info) {
+  const result = [...splitPath(info.dirname), info.name];
+  return result[result.length - 1] === "index" ? result.slice(0, -1) : result;
+}
 function loader(options) {
   return createOutput(options);
 }
@@ -348,10 +379,7 @@ function createOutput({
   rootDir = "",
   transformers,
   baseUrl = "/",
-  slugs = (info) => {
-    const result = [...info.dirname.split("/"), info.name].filter(Boolean);
-    return result[result.length - 1] === "index" ? result.slice(0, -1) : result;
-  },
+  slugs = getSlugs,
   url = createGetUrl(baseUrl)
 }) {
   const result = load({
@@ -361,7 +389,7 @@ function createOutput({
     getSlugs: slugs,
     getUrl: url
   });
-  const i18nMap = groupByLanguages(result.storage.list(), languages != null ? languages : []);
+  const i18nMap = groupByLanguages(result.storage, languages != null ? languages : []);
   const builder = createPageTreeBuilder({
     storage: result.storage,
     resolveIcon: icon
@@ -376,8 +404,8 @@ function createOutput({
     },
     getPage(slugs_ = [], language = "") {
       var _a;
-      const path = slugs_.join("/");
-      return (_a = i18nMap.get(language)) == null ? void 0 : _a.find((page) => page.slugs.join("/") === path);
+      const path2 = slugs_.join("/");
+      return (_a = i18nMap.get(language)) == null ? void 0 : _a.find((page) => page.slugs.join("/") === path2);
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "9.0.0",
+  "version": "10.0.0",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -44,10 +44,6 @@
       "import": "./dist/link.js",
       "types": "./dist/link.d.ts"
     },
-    "./typescript": {
-      "import": "./dist/typescript.js",
-      "types": "./dist/typescript.d.ts"
-    },
     "./middleware": {
       "import": "./dist/middleware.js",
       "types": "./dist/middleware.d.ts"
@@ -76,9 +72,6 @@
       "toc": [
         "./dist/toc.d.ts"
       ],
-      "typescript": [
-        "./dist/typescript.d.ts"
-      ],
       "search/client": [
         "./dist/search/client.d.ts"
       ],
@@ -116,8 +109,8 @@
   ],
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.0",
-    "@shikijs/rehype": "1.1.5",
-    "@shikijs/transformers": "1.1.5",
+    "@shikijs/rehype": "1.1.7",
+    "@shikijs/transformers": "1.1.7",
     "flexsearch": "0.7.21",
     "github-slugger": "^2.0.0",
     "hast-util-to-estree": "^3.1.0",
@@ -127,7 +120,7 @@
     "remark-gfm": "^4.0.0",
     "remark-mdx": "^3.0.0",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shiki": "1.1.5",
+    "shiki": "1.1.7",
     "swr": "^2.2.2",
     "unist-util-visit": "^5.0.0"
   },
@@ -142,7 +135,7 @@
     "@types/react": "18.2.0",
     "@types/react-dom": "18.2.1",
     "algoliasearch": "^4.20.0",
-    "next": "14.1.0",
+    "next": "14.1.1",
     "unified": "^11.0.4",
     "eslint-config-custom": "0.0.0",
     "tsconfig": "0.0.0"

package/dist/typescript.d.ts

@@ -1,37 +0,0 @@
-import * as ts from 'typescript';
-
-interface DocEntry {
-    name: string;
-    description: string;
-    type: string;
-    default?: string;
-}
-interface Context {
-    program: ts.Program;
-    checker: ts.TypeChecker;
-    options: Options;
-}
-interface EntryContext extends Context {
-    type: ts.Type;
-    symbol: ts.Symbol;
-}
-interface Options {
-    file: string;
-    name: string;
-    /**
-     * Modify output property entry
-     */
-    transform?: (this: EntryContext, entry: DocEntry, propertyType: ts.Type, propertySymbol: ts.Symbol) => void;
-    options?: Partial<{
-        files: string[];
-        tsconfigPath: string;
-        /** A root directory to resolve relative path entries in the config file to. e.g. outDir */
-        basePath: string;
-    }>;
-}
-/**
- * Generate documentation for properties in an exported type/interface
- */
-declare function generateDocumentation(options: Options): DocEntry[];
-
-export { type DocEntry, type Options, generateDocumentation };

package/dist/typescript.js

@@ -1,90 +0,0 @@
-import {
-  __spreadProps,
-  __spreadValues
-} from "./chunk-WEAGW6MQ.js";
-
-// src/typescript.ts
-import * as ts from "typescript";
-var cache = /* @__PURE__ */ new Map();
-function getProgram(options = {}) {
-  var _a, _b, _c;
-  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)
-  );
-  const parsed = ts.parseJsonSourceFileConfigFileContent(
-    configFile,
-    ts.sys,
-    (_b = options.basePath) != null ? _b : "./"
-  );
-  const program = ts.createProgram({
-    rootNames: (_c = options.files) != null ? _c : parsed.fileNames,
-    options: __spreadProps(__spreadValues({}, parsed.options), {
-      incremental: false
-    })
-  });
-  cache.set(key, program);
-  return program;
-}
-function getExportedSymbol({
-  options: { file, name },
-  checker,
-  program
-}) {
-  const sourceFile = program.getSourceFile(file);
-  if (!sourceFile)
-    return;
-  const fileSymbol = checker.getSymbolAtLocation(sourceFile);
-  if (!fileSymbol)
-    return;
-  const exports = checker.getExportsOfModule(fileSymbol);
-  return exports.find((e) => e.getEscapedName().toString() === name);
-}
-function generateDocumentation(options) {
-  const program = getProgram(options.options);
-  const checker = program.getTypeChecker();
-  const ctx = {
-    checker,
-    program,
-    options
-  };
-  const symbol = getExportedSymbol(ctx);
-  if (!symbol)
-    return [];
-  const type = checker.getDeclaredTypeOfSymbol(symbol);
-  const entryContext = __spreadProps(__spreadValues({}, ctx), {
-    type,
-    symbol
-  });
-  return type.getProperties().map(getDocEntry.bind(entryContext));
-}
-function getDocEntry(prop) {
-  var _a;
-  const subType = this.checker.getTypeOfSymbol(prop);
-  const defaultJsDocTag = prop.getJsDocTags().find((info) => ["default", "defaultValue"].includes(info.name));
-  let typeName = this.checker.typeToString(
-    subType.getNonNullableType(),
-    void 0,
-    ts.TypeFormatFlags.UseAliasDefinedOutsideCurrentScope
-  );
-  if (subType.aliasSymbol && !subType.aliasTypeArguments) {
-    typeName = subType.aliasSymbol.escapedName.toString();
-  }
-  const entry = {
-    name: prop.getName(),
-    description: ts.displayPartsToString(
-      prop.getDocumentationComment(this.checker)
-    ),
-    default: (defaultJsDocTag == null ? void 0 : defaultJsDocTag.text) ? ts.displayPartsToString(defaultJsDocTag.text) : void 0,
-    type: typeName
-  };
-  (_a = this.options.transform) == null ? void 0 : _a.call(this, entry, subType, prop);
-  return entry;
-}
-export {
-  generateDocumentation
-};