fumadocs-core 10.0.0 → 10.0.2

package/dist/{chunk-GT3Y35O6.js → chunk-M6ZDX3QR.js}

@@ -21,12 +21,12 @@ function remarkHeading() {
     const toc = [];
     slugger.reset();
     visit(node, ["heading"], (heading) => {
-      var _a;
+      var _a, _b;
       heading.data || (heading.data = {});
       (_a = heading.data).hProperties || (_a.hProperties = {});
       const text = flattenNode(heading);
       const properties = heading.data.hProperties;
-      const id = slugger.slug(properties.id || text);
+      const id = slugger.slug((_b = properties.id) != null ? _b : text);
       properties.id = id;
       toc.push({
         title: text,

package/dist/mdx-plugins/index.js

@@ -2,7 +2,7 @@ import {
   flattenNode,
   remarkHeading,
   visit
-} from "../chunk-GT3Y35O6.js";
+} from "../chunk-M6ZDX3QR.js";
 import {
   slash
 } from "../chunk-UWEEHUJV.js";

package/dist/search/client.d.ts

@@ -8,6 +8,11 @@ interface UseDocsSearch {
         keepPreviousData: true;
     }>;
 }
-declare function useDocsSearch(locale?: string, tag?: string): UseDocsSearch;
+/**
+ * @param locale - Filter with locale
+ * @param tag - Filter with specific tag
+ * @param api - The Search API URL
+ */
+declare function useDocsSearch(locale?: string, tag?: string, api?: string): UseDocsSearch;
 
 export { useDocsSearch };

package/dist/search/client.js

@@ -21,14 +21,12 @@ function fetchDocs(api, query, locale, tag) {
     return yield res.json();
   });
 }
-function useDocsSearch(locale, tag) {
+function useDocsSearch(locale, tag, api = "/api/search") {
   const [search, setSearch] = useState("");
   const debouncedValue = useDebounce(search, 100);
   const query = useSWR(
-    ["/api/search", debouncedValue, locale, tag],
-    (_0) => __async(this, [_0], function* ([api, value]) {
-      return fetchDocs(api, value, locale, tag);
-    }),
+    [api, debouncedValue, locale, tag],
+    (args) => fetchDocs(...args),
     {
       keepPreviousData: true
     }

package/dist/search/server.js

@@ -5,7 +5,7 @@ import {
 
 // src/search/server.ts
 import { Document } from "flexsearch";
-import nextLib from "next/server";
+import { NextResponse } from "next/server";
 function createSearchAPI(type, options) {
   if (type === "simple") {
     return initSearchAPI(options);
@@ -32,7 +32,7 @@ function createI18nSearchAPI(type, options) {
         if (handler)
           return handler.GET(request);
       }
-      return nextLib.NextResponse.json([]);
+      return NextResponse.json([]);
     }
   };
 }
@@ -80,20 +80,20 @@ function initSearchAPI({ indexes, language }) {
       const { searchParams } = request.nextUrl;
       const query = searchParams.get("query");
       if (!query)
-        return nextLib.NextResponse.json([]);
+        return NextResponse.json([]);
       const results = index.search(query, 5, {
         enrich: true,
         suggest: true
       });
       if (results.length === 0)
-        return nextLib.NextResponse.json([]);
+        return NextResponse.json([]);
       const pages = results[0].result.map((page) => ({
         type: "page",
         content: page.doc.title,
         id: page.doc.url,
         url: page.doc.url
       }));
-      return nextLib.NextResponse.json(pages);
+      return NextResponse.json(pages);
     }
   };
 }
@@ -158,7 +158,7 @@ function initSearchAPIAdvanced({
       const query = request.nextUrl.searchParams.get("query");
       const paramTag = request.nextUrl.searchParams.get("tag");
       if (!query)
-        return nextLib.NextResponse.json([]);
+        return NextResponse.json([]);
       const results = index.search(query, 5, {
         enrich: true,
         tag: paramTag != null ? paramTag : void 0,
@@ -197,7 +197,7 @@ function initSearchAPIAdvanced({
         });
         sortedResult.push(...items);
       }
-      return nextLib.NextResponse.json(sortedResult);
+      return NextResponse.json(sortedResult);
     }
   };
 }

package/dist/search-algolia/client.js

@@ -49,7 +49,7 @@ function useAlgoliaSearch(index, _a = {}) {
   var _b = _a, { allowEmpty = true } = _b, options = __objRest(_b, ["allowEmpty"]);
   const [search, setSearch] = useState("");
   const query = useSWR(
-    ["/api/search", search, allowEmpty, options],
+    ["algolia-search", search, allowEmpty, options],
     () => __async(this, null, function* () {
       if (allowEmpty && search.length === 0)
         return "empty";

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

@@ -42,4 +42,4 @@ interface BaseIndex {
     content: string;
 }
 
-export { type BaseIndex, setIndexSettings, sync, updateDocuments };
+export { type BaseIndex, type SyncOptions, setIndexSettings, sync, updateDocuments };

package/dist/server/index.js

@@ -1,6 +1,6 @@
 import {
   remarkHeading
-} from "../chunk-GT3Y35O6.js";
+} from "../chunk-M6ZDX3QR.js";
 import {
   __async
 } from "../chunk-WEAGW6MQ.js";

package/dist/source/index.d.ts

@@ -17,6 +17,8 @@ interface FileInfo {
     name: string;
     dirname: string;
 }
+declare function parseFilePath(path: string): FileInfo;
+declare function parseFolderPath(path: string): FileInfo;
 
 interface LoadOptions {
     files: VirtualFile[];
@@ -30,15 +32,11 @@ interface VirtualFile {
     type: 'page' | 'meta';
     data: unknown;
 }
-interface LoadResult {
-    storage: Storage;
-}
 type Transformer = (context: {
     storage: Storage;
     getSlugs: (info: FileInfo) => string[];
     getUrl: (slugs: string[], locale?: string) => string;
 }) => void;
-declare function load(options: LoadOptions): LoadResult;
 
 interface LoaderConfig {
     source: SourceConfig;
@@ -85,6 +83,8 @@ interface LoaderOutput<Config extends LoaderConfig> {
      */
     getPage: (slugs: string[] | undefined, language?: string) => Page<Config['source']['pageData']> | undefined;
 }
+declare function createGetUrl(baseUrl: string): (slugs: string[], locale?: string) => string;
+declare function getSlugs(info: FileInfo): string[];
 type InferSourceConfig<T> = T extends Source<infer Config> ? Config : never;
 declare function loader<Options extends LoaderOptions>(options: Options): LoaderOutput<{
     source: InferSourceConfig<Options['source']>;
@@ -176,4 +176,4 @@ interface CreatePageTreeBuilderOptions {
 }
 declare function createPageTreeBuilder({ storage, resolveIcon, }: CreatePageTreeBuilderOptions): PageTreeBuilder;
 
-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 };
+export { type BuildPageTreeOptionsWithI18n, type CreatePageTreeBuilderOptions, type FileInfo, fileSystem as FileSystem, type InferMetaType, type InferPageType, type LoadOptions, type LoaderConfig, type LoaderOptions, type LoaderOutput, type MetaData, type PageData, type PageTreeBuilder, type Source, type SourceConfig, type Transformer, type VirtualFile, createGetUrl, createPageTreeBuilder, getSlugs, loader, parseFilePath, parseFolderPath };

package/dist/source/index.js

@@ -151,7 +151,7 @@ function buildFolderNode(folder, defaultIsRoot, ctx) {
     });
     children = nodes != null ? nodes : restNodes;
   }
-  return {
+  return removeUndefined({
     type: "folder",
     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),
@@ -159,7 +159,7 @@ function buildFolderNode(folder, defaultIsRoot, ctx) {
     defaultOpen: meta == null ? void 0 : meta.defaultOpen,
     index,
     children
-  };
+  });
 }
 function buildFileNode(page, ctx) {
   let localePage = page;
@@ -170,12 +170,12 @@ function buildFileNode(page, ctx) {
     if (result)
       localePage = result;
   }
-  return {
+  return removeUndefined({
     type: "page",
     name: localePage.data.title,
     icon: ctx.resolveIcon(localePage.data.icon),
     url: localePage.url
-  };
+  });
 }
 function build(ctx) {
   const root = ctx.storage.root();
@@ -217,6 +217,14 @@ function createPageTreeBuilder({
 function pathToName(path2) {
   return path2.slice(0, 1).toUpperCase() + path2.slice(1);
 }
+function removeUndefined(value) {
+  const obj = value;
+  Object.keys(obj).forEach((key) => {
+    if (obj[key] === void 0)
+      delete obj[key];
+  });
+  return value;
+}
 
 // src/source/load.ts
 import * as path from "path";
@@ -411,7 +419,10 @@ function createOutput({
 }
 export {
   file_system_exports as FileSystem,
+  createGetUrl,
   createPageTreeBuilder,
-  load,
-  loader
+  getSlugs,
+  loader,
+  parseFilePath,
+  parseFolderPath
 };

package/dist/toc.d.ts

@@ -1,20 +1,21 @@
 import * as react from 'react';
-import { HTMLAttributes, AnchorHTMLAttributes } from 'react';
-import { T as TableOfContents, a as TOCItemType } from './get-toc-YF_TdazL.js';
+import { HTMLAttributes, RefObject, ReactNode, AnchorHTMLAttributes } from 'react';
+import { T as TableOfContents } from './get-toc-YF_TdazL.js';
 
 declare const useActiveAnchor: (url: string) => boolean;
-declare const TOCProvider: react.ForwardRefExoticComponent<HTMLAttributes<HTMLDivElement> & {
+interface TOCProviderProps extends HTMLAttributes<HTMLDivElement> {
     toc: TableOfContents;
-} & react.RefAttributes<HTMLDivElement>>;
-type TOCItemProps = AnchorHTMLAttributes<HTMLAnchorElement> & {
-    href: string;
-    /** @deprecated You don't need to pass this anymore */
-    item?: TOCItemType;
-};
-declare const TOCItem: react.ForwardRefExoticComponent<AnchorHTMLAttributes<HTMLAnchorElement> & {
+}
+declare const TOCProvider: react.ForwardRefExoticComponent<TOCProviderProps & react.RefAttributes<HTMLDivElement>>;
+interface TOCScrollProvider {
+    containerRef: RefObject<HTMLElement>;
+    toc: TableOfContents;
+    children: ReactNode;
+}
+declare function TOCScrollProvider({ toc, containerRef, children, }: TOCScrollProvider): JSX.Element;
+interface TOCItemProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
     href: string;
-    /** @deprecated You don't need to pass this anymore */
-    item?: TOCItemType | undefined;
-} & react.RefAttributes<HTMLAnchorElement>>;
+}
+declare const TOCItem: react.ForwardRefExoticComponent<TOCItemProps & react.RefAttributes<HTMLAnchorElement>>;
 
-export { TOCItem, type TOCItemProps, TOCProvider, useActiveAnchor };
+export { TOCItem, type TOCItemProps, TOCProvider, type TOCProviderProps, TOCScrollProvider, useActiveAnchor };

package/dist/toc.js

@@ -74,16 +74,23 @@ var useActiveAnchor = (url) => {
 var TOCProvider = forwardRef(
   (_a, ref) => {
     var _b = _a, { toc } = _b, props = __objRest(_b, ["toc"]);
-    const headings = useMemo(() => {
-      return toc.map((item) => item.url.split("#")[1]);
-    }, [toc]);
     const containerRef = useRef(null);
     const mergedRef = mergeRefs(containerRef, ref);
-    const activeAnchor = useAnchorObserver(headings);
-    return /* @__PURE__ */ jsx("div", __spreadProps(__spreadValues({ ref: mergedRef }, props), { children: /* @__PURE__ */ jsx(ActiveAnchorContext.Provider, { value: { containerRef, activeAnchor }, children: props.children }) }));
+    return /* @__PURE__ */ jsx("div", __spreadProps(__spreadValues({ ref: mergedRef }, props), { children: /* @__PURE__ */ jsx(TOCScrollProvider, { toc, containerRef, children: props.children }) }));
   }
 );
 TOCProvider.displayName = "TOCProvider";
+function TOCScrollProvider({
+  toc,
+  containerRef,
+  children
+}) {
+  const headings = useMemo(() => {
+    return toc.map((item) => item.url.split("#")[1]);
+  }, [toc]);
+  const activeAnchor = useAnchorObserver(headings);
+  return /* @__PURE__ */ jsx(ActiveAnchorContext.Provider, { value: { containerRef, activeAnchor }, children });
+}
 var TOCItem = forwardRef(
   (props, ref) => {
     const { containerRef } = useContext(ActiveAnchorContext);
@@ -109,5 +116,6 @@ TOCItem.displayName = "TOCItem";
 export {
   TOCItem,
   TOCProvider,
+  TOCScrollProvider,
   useActiveAnchor
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "10.0.0",
+  "version": "10.0.2",
   "description": "The library for building a documentation website in Next.js",
   "keywords": [
     "NextJs",
@@ -108,40 +108,39 @@
     "dist/*"
   ],
   "dependencies": {
-    "@formatjs/intl-localematcher": "^0.5.0",
-    "@shikijs/rehype": "1.1.7",
-    "@shikijs/transformers": "1.1.7",
-    "flexsearch": "0.7.21",
+    "@formatjs/intl-localematcher": "^0.5.4",
+    "@shikijs/rehype": "^1.1.7",
+    "@shikijs/transformers": "^1.1.7",
+    "flexsearch": "^0.7.43",
     "github-slugger": "^2.0.0",
     "hast-util-to-estree": "^3.1.0",
     "negotiator": "^0.6.3",
-    "react-remove-scroll": "^2.5.6",
+    "react-remove-scroll": "^2.5.7",
     "remark": "^15.0.0",
     "remark-gfm": "^4.0.0",
-    "remark-mdx": "^3.0.0",
+    "remark-mdx": "^3.0.1",
     "scroll-into-view-if-needed": "^3.1.0",
-    "shiki": "1.1.7",
-    "swr": "^2.2.2",
+    "shiki": "^1.1.7",
+    "swr": "^2.2.5",
     "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
-    "@algolia/client-search": "^4.20.0",
-    "@next/eslint-plugin-next": "^14.0.0",
+    "@algolia/client-search": "^4.22.1",
     "@types/flexsearch": "0.7.6",
     "@types/hast": "^3.0.4",
     "@types/mdast": "^4.0.3",
-    "@types/negotiator": "^0.6.1",
+    "@types/negotiator": "^0.6.3",
     "@types/node": "18.17.5",
-    "@types/react": "18.2.0",
-    "@types/react-dom": "18.2.1",
-    "algoliasearch": "^4.20.0",
-    "next": "14.1.1",
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.1",
+    "algoliasearch": "^4.22.1",
+    "next": "^14.1.2",
     "unified": "^11.0.4",
     "eslint-config-custom": "0.0.0",
     "tsconfig": "0.0.0"
   },
   "peerDependencies": {
-    "next": ">= 13.4",
+    "next": ">= 14.1.0",
     "react": ">= 18",
     "react-dom": ">= 18"
   },