fumadocs-core 9.1.0 → 10.0.0

package/dist/source/index.d.ts

@@ -1,6 +1,23 @@
 import { ReactElement } from 'react';
 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[];
     transformers?: Transformer[];
@@ -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,22 +91,6 @@ 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;
@@ -101,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';
@@ -118,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<MD, PD>;
 /**
  * A virtual file system that solves inconsistent behaviours
  *
@@ -152,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 {
@@ -176,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

@@ -49,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>.+)");
@@ -95,6 +96,17 @@ function resolveFolderItem(folder, item, ctx, addedNodePaths) {
       }
     ];
   }
+  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,
@@ -106,7 +118,7 @@ function resolveFolderItem(folder, item, ctx, addedNodePaths) {
   addedNodePaths.add(itemNode.file.path);
   if (itemNode.type === "folder") {
     const node = buildFolderNode(itemNode, false, ctx);
-    return (extractResult == null ? void 0 : extractResult.groups) ? node.children : [node];
+    return extractResult ? node.children : [node];
   }
   return [buildFileNode(itemNode, ctx)];
 }
@@ -289,16 +301,14 @@ 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();
@@ -307,8 +317,7 @@ function buildStorage(options) {
       path.relative(options.rootDir, path.join("./", path.dirname(file.path))),
       path.basename(file.path)
     );
-    const isRelative = !relativePath.startsWith("..") && !path.isAbsolute(relativePath);
-    if (!isRelative)
+    if (relativePath.startsWith("..") || path.isAbsolute(relativePath))
       continue;
     if (file.type === "page") {
       const parsedPath = parseFilePath(relativePath);
@@ -330,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;
@@ -386,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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "9.1.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"
       ],
@@ -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
-};