fumadocs-core 13.0.2 → 13.0.4

package/dist/search/server.d.ts

@@ -41,6 +41,7 @@ declare function createSearchAPI<T extends 'simple' | 'advanced'>(type: T, optio
 declare function createI18nSearchAPI<T extends 'simple' | 'advanced'>(type: T, options: T extends 'simple' ? ToI18n<SimpleOptions> : ToI18n<AdvancedOptions>): SearchAPI;
 interface Index {
     title: string;
+    description?: string;
     content: string;
     url: string;
     keywords?: string;
@@ -49,9 +50,10 @@ declare function initSearchAPI({ indexes, language }: SimpleOptions): SearchAPI;
 interface AdvancedIndex {
     id: string;
     title: string;
+    description?: string;
     keywords?: string;
     /**
-     * Required if `tag` is enabled
+     * Required if tag filter is enabled
      */
     tag?: string;
     /**

package/dist/search/server.js

@@ -63,6 +63,14 @@ function initSearchAPI({ indexes, language }) {
             tokenize: "forward",
             resolution: 9
           },
+          {
+            field: "description",
+            tokenize: "strict",
+            context: {
+              depth: 1,
+              resolution: 9
+            }
+          },
           {
             field: "content",
             tokenize: "strict",
@@ -82,6 +90,7 @@ function initSearchAPI({ indexes, language }) {
     for (const page of items) {
       index.add({
         title: page.title,
+        description: page.description,
         url: page.url,
         content: page.content,
         keywords: page.keywords
@@ -146,6 +155,16 @@ function initSearchAPIAdvanced({
         tag: page.tag,
         url: page.url
       });
+      if (page.description) {
+        index.add({
+          id: page.id + (id++).toString(),
+          page_id: page.id,
+          tag: page.tag,
+          type: "text",
+          url: page.url,
+          content: page.description
+        });
+      }
       for (const heading of data.headings) {
         index.add({
           id: page.id + (id++).toString(),

package/dist/search-algolia/server.d.ts

@@ -9,6 +9,7 @@ interface DocumentRecord {
      */
     _id: string;
     title: string;
+    description?: string;
     /**
      * URL to the page
      */
@@ -41,19 +42,8 @@ interface SyncOptions {
  */
 declare function sync(client: SearchClient, options: SyncOptions): Promise<void>;
 declare function setIndexSettings(index: SearchIndex): Promise<void>;
-interface Section {
-    /**
-     * Heading content
-     */
-    section?: string;
-    /**
-     * The anchor id
-     */
-    section_id?: string;
-    content: string;
-}
 declare function updateDocuments(index: SearchIndex, documents: DocumentRecord[]): Promise<void>;
-interface BaseIndex extends Section {
+interface BaseIndex {
     objectID: string;
     title: string;
     url: string;
@@ -62,6 +52,15 @@ interface BaseIndex extends Section {
      * The id of page, used for distinct
      */
     page_id: string;
+    /**
+     * Heading content
+     */
+    section?: string;
+    /**
+     * Heading (anchor) id
+     */
+    section_id?: string;
+    content: string;
 }
 
 export { type BaseIndex, type SyncOptions, setIndexSettings, sync, updateDocuments };

package/dist/search-algolia/server.js

@@ -16,43 +16,38 @@ async function setIndexSettings(index) {
     attributesForFaceting: ["tag"]
   });
 }
-function getSections(page) {
+function toIndex(page) {
+  let id = 0;
+  const indexes = [];
   const scannedHeadings = /* @__PURE__ */ new Set();
-  return page.structured.contents.flatMap((p) => {
-    const heading = p.heading ? page.structured.headings.find((h) => p.heading === h.id) : null;
-    const section = {
-      section: heading?.content,
-      section_id: heading?.id,
-      content: p.content
+  function createIndex(section, sectionId, content) {
+    return {
+      objectID: `${page._id}-${(id++).toString()}`,
+      title: page.title,
+      url: page.url,
+      page_id: page._id,
+      tag: page.tag,
+      section,
+      section_id: sectionId,
+      content,
+      ...page.extra_data
     };
+  }
+  if (page.description)
+    indexes.push(createIndex(void 0, void 0, page.description));
+  page.structured.contents.forEach((p) => {
+    const heading = p.heading ? page.structured.headings.find((h) => p.heading === h.id) : null;
+    const index = createIndex(heading?.content, heading?.id, p.content);
     if (heading && !scannedHeadings.has(heading.id)) {
       scannedHeadings.add(heading.id);
-      return [
-        {
-          section: heading.content,
-          section_id: heading.id,
-          content: heading.content
-        },
-        section
-      ];
+      indexes.push(createIndex(heading.content, heading.id, heading.content));
     }
-    return section;
+    indexes.push(index);
   });
+  return indexes;
 }
 async function updateDocuments(index, documents) {
-  const objects = documents.flatMap((page) => {
-    return getSections(page).map(
-      (section, idx) => ({
-        objectID: `${page._id}-${idx.toString()}`,
-        title: page.title,
-        url: page.url,
-        page_id: page._id,
-        tag: page.tag,
-        ...section,
-        ...page.extra_data
-      })
-    );
-  });
+  const objects = documents.flatMap(toIndex);
   await index.replaceAllObjects(objects);
 }
 export {

package/dist/source/index.d.ts

@@ -20,45 +20,6 @@ interface FileInfo {
 declare function parseFilePath(path: string): FileInfo;
 declare function parseFolderPath(path: string): FileInfo;
 
-interface File {
-    file: FileInfo;
-    format: 'meta' | 'page';
-    data: Record<string, unknown>;
-}
-interface Folder {
-    file: FileInfo;
-    children: (File | Folder)[];
-}
-/**
- * A virtual file system that solves inconsistent behaviours
- *
- * Some source providers may not provide the full file structure, this will cause inconsistent outputs for page builder and other transformers
- */
-declare class Storage {
-    files: Map<string, File>;
-    folders: Map<string, Folder>;
-    private rootFolder;
-    constructor();
-    /**
-     * @param path - flattened path
-     * @param format - file format
-     */
-    read(path: string, format: string): File | undefined;
-    readDir(path: string): Folder | undefined;
-    root(): Folder;
-    write(path: string, format: 'meta' | 'page', data: Record<string, unknown>): void;
-    list(): File[];
-    makeDir(path: string): void;
-}
-
-type fileSystem_File = File;
-type fileSystem_Folder = Folder;
-type fileSystem_Storage = Storage;
-declare const fileSystem_Storage: typeof Storage;
-declare namespace fileSystem {
-  export { type fileSystem_File as File, type fileSystem_Folder as Folder, fileSystem_Storage as Storage };
-}
-
 interface LoadOptions {
     transformers?: Transformer[];
     rootDir?: string;
@@ -168,18 +129,62 @@ type InferMetaType<Utils extends LoaderOutput<any>> = Utils extends LoaderOutput
  * @internal
  */
 type UrlFn = (slugs: string[], locale?: string) => string;
-/**
- * @internal
- */
-interface FileData {
-    meta: {
+
+interface MetaFile {
+    file: FileInfo;
+    format: 'meta';
+    data: {
         data: MetaData;
     };
-    file: {
+}
+interface PageFile {
+    file: FileInfo;
+    format: 'page';
+    data: {
         slugs: string[];
         data: PageData;
     };
 }
+type File = MetaFile | PageFile;
+interface Folder {
+    file: FileInfo;
+    children: (File | Folder)[];
+}
+/**
+ * A virtual file system that solves inconsistent behaviours
+ *
+ * Some source providers may not provide the full file structure, this will cause inconsistent outputs for page builder and other transformers
+ */
+declare class Storage {
+    files: Map<string, File>;
+    folders: Map<string, Folder>;
+    private rootFolder;
+    constructor();
+    /**
+     * @param path - flattened path
+     * @param format - file format
+     */
+    read<F extends File['format']>(path: string, format: F): Extract<File, {
+        format: F;
+    }> | undefined;
+    readDir(path: string): Folder | undefined;
+    root(): Folder;
+    write<F extends File['format']>(path: string, format: F, data: Extract<File, {
+        format: F;
+    }>['data']): void;
+    list(): File[];
+    makeDir(path: string): void;
+}
+
+type fileSystem_File = File;
+type fileSystem_Folder = Folder;
+type fileSystem_MetaFile = MetaFile;
+type fileSystem_PageFile = PageFile;
+type fileSystem_Storage = Storage;
+declare const fileSystem_Storage: typeof Storage;
+declare namespace fileSystem {
+  export { type fileSystem_File as File, type fileSystem_Folder as Folder, type fileSystem_MetaFile as MetaFile, type fileSystem_PageFile as PageFile, fileSystem_Storage as Storage };
+}
 
 interface BuildPageTreeOptions {
     /**
@@ -188,8 +193,8 @@ interface BuildPageTreeOptions {
      * @defaultValue false
      */
     attachFolderIds?: boolean;
-    attachFile?: (node: Item, file?: File) => Item;
-    attachFolder?: (node: Folder$1, folder: Folder, meta?: File) => Folder$1;
+    attachFile?: (node: Item, file?: PageFile) => Item;
+    attachFolder?: (node: Folder$1, folder: Folder, meta?: MetaFile) => Folder$1;
     attachSeparator?: (node: Separator) => Separator;
     storage: Storage;
     getUrl: UrlFn;
@@ -214,4 +219,4 @@ interface PageTreeBuilder {
 }
 declare function createPageTreeBuilder(): PageTreeBuilder;
 
-export { type BuildPageTreeOptions, type BuildPageTreeOptionsWithI18n, type FileData, type FileInfo, fileSystem as FileSystem, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type Meta, type MetaData, type Page, type PageData, type PageTreeBuilder, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loadFiles, loader, parseFilePath, parseFolderPath };
+export { type BuildPageTreeOptions, type BuildPageTreeOptionsWithI18n, type FileInfo, fileSystem as FileSystem, type InferMetaType, type InferPageType, type LanguageEntry, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type Meta, type MetaData, type Page, type PageData, type PageTreeBuilder, type Source, type SourceConfig, type Transformer, type UrlFn, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loadFiles, loader, parseFilePath, parseFolderPath };

package/dist/source/index.js

@@ -172,12 +172,11 @@ function buildFolderNode(folder, isGlobalRoot, ctx) {
 }
 function buildFileNode(file, ctx) {
   const localized = findLocalizedFile(file.file.flattenedPath, "page", ctx) ?? file;
-  const data = localized.data;
   const item = {
     type: "page",
-    name: data.data.title,
-    icon: ctx.options.resolveIcon?.(data.data.icon),
-    url: ctx.options.getUrl(data.slugs, ctx.lang)
+    name: localized.data.data.title,
+    icon: ctx.options.resolveIcon?.(localized.data.data.icon),
+    url: ctx.options.getUrl(localized.data.slugs, ctx.lang)
   };
   return removeUndefined(ctx.options.attachFile?.(item, file) ?? item);
 }
@@ -418,12 +417,11 @@ function createOutput({
   };
 }
 function fileToPage(file, getUrl, locale) {
-  const data = file.data;
   return {
     file: file.file,
-    url: getUrl(data.slugs, locale),
-    slugs: data.slugs,
-    data: data.data
+    url: getUrl(file.data.slugs, locale),
+    slugs: file.data.slugs,
+    data: file.data.data
   };
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "13.0.2",
+  "version": "13.0.4",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",