fumadocs-core 16.0.6 → 16.0.7

package/dist/{chunk-QMATWJ5F.js → chunk-JD3M54YF.js}

@@ -2,13 +2,48 @@
 import Slugger from "github-slugger";
 import { visit } from "unist-util-visit";
 
-// src/mdx-plugins/remark-utils.ts
+// src/mdx-plugins/mdast-utils.ts
+import { valueToEstree } from "estree-util-value-to-estree";
 function flattenNode(node) {
   if ("children" in node)
     return node.children.map((child) => flattenNode(child)).join("");
   if ("value" in node) return node.value;
   return "";
 }
+function toMdxExport(name, value) {
+  return {
+    type: "mdxjsEsm",
+    value: "",
+    data: {
+      estree: {
+        type: "Program",
+        sourceType: "module",
+        body: [
+          {
+            type: "ExportNamedDeclaration",
+            attributes: [],
+            specifiers: [],
+            source: null,
+            declaration: {
+              type: "VariableDeclaration",
+              kind: "let",
+              declarations: [
+                {
+                  type: "VariableDeclarator",
+                  id: {
+                    type: "Identifier",
+                    name
+                  },
+                  init: valueToEstree(value)
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  };
+}
 
 // src/mdx-plugins/remark-heading.ts
 var slugger = new Slugger();
@@ -53,5 +88,6 @@ function remarkHeading({
 
 export {
   flattenNode,
+  toMdxExport,
   remarkHeading
 };

package/dist/content/toc.js

@@ -1,6 +1,6 @@
 import {
   remarkHeading
-} from "../chunk-QMATWJ5F.js";
+} from "../chunk-JD3M54YF.js";
 import "../chunk-U67V476Y.js";
 
 // src/content/toc.ts

package/dist/mdx-plugins/index.d.ts

@@ -4,7 +4,7 @@ import { RehypeShikiOptions } from '@shikijs/rehype';
 import { Processor, Transformer } from 'unified';
 import { ShikiTransformer } from 'shiki';
 import { Root as Root$1, BlockContent, Text } from 'mdast';
-export { a as StructureOptions, S as StructuredData, r as remarkStructure, s as structure } from '../remark-structure-DkCXCzpD.js';
+export { a as StructureOptions, S as StructuredData, r as remarkStructure, s as structure } from '../remark-structure-BJxaB5zZ.js';
 export { a as RemarkCodeTabOptions, R as RemarkHeadingOptions, b as remarkCodeTab, r as remarkHeading } from '../remark-code-tab-DmyIyi6m.js';
 import { MdxJsxAttribute, MdxJsxFlowElement } from 'mdast-util-mdx-jsx';
 
@@ -51,6 +51,12 @@ type RehypeCodeOptions = RehypeShikiOptions & {
 declare function rehypeCode(this: Processor, _options?: Partial<RehypeCodeOptions>): Transformer<Root, Root>;
 declare function transformerTab(): ShikiTransformer;
 
+type ExternalImageOptions = {
+    /**
+     * timeout for fetching remote images (in milliseconds)
+     */
+    timeout?: number;
+} | boolean;
 interface RemarkImageOptions {
     /**
      * Directory or base URL to resolve absolute image paths
@@ -91,7 +97,7 @@ interface RemarkImageOptions {
      *
      * @defaultValue true
      */
-    external?: boolean;
+    external?: ExternalImageOptions;
 }
 /**
  * Turn images into Next.js Image compatible usage.

package/dist/mdx-plugins/index.js

@@ -1,11 +1,12 @@
-import {
-  flattenNode,
-  remarkHeading
-} from "../chunk-QMATWJ5F.js";
 import {
   defaultThemes,
   getHighlighter
 } from "../chunk-XN2LKXFZ.js";
+import {
+  flattenNode,
+  remarkHeading,
+  toMdxExport
+} from "../chunk-JD3M54YF.js";
 import "../chunk-U67V476Y.js";
 
 // src/mdx-plugins/index.ts
@@ -426,8 +427,7 @@ function remarkImage({
         }
         return out;
       }
-      if (src.type === "url" && !external) return;
-      const size = await getImageSize(src).catch((e) => {
+      const size = await getImageSize(src, external).catch((e) => {
         throw new Error(
           `[Remark Image] Failed obtain image size for ${node.url} (public directory configured as ${publicDir})`,
           {
@@ -435,6 +435,7 @@ function remarkImage({
           }
         );
       });
+      if (!size) return;
       return {
         type: "mdxJsxFlowElement",
         name: "img",
@@ -550,9 +551,13 @@ function parseSrc(src, publicDir, dir) {
     file: path.join(dir, src)
   };
 }
-async function getImageSize(src) {
+async function getImageSize(src, onExternal) {
   if (src.type === "file") return imageSizeFromFile(src.file);
-  const res = await fetch(src.url);
+  if (onExternal === false) return;
+  const { timeout } = typeof onExternal === "object" ? onExternal : {};
+  const res = await fetch(src.url, {
+    signal: typeof timeout === "number" ? AbortSignal.timeout(timeout) : void 0
+  });
   if (!res.ok) {
     throw new Error(
       `[Remark Image] Failed to fetch ${src.url} (${res.status}): ${await res.text()}`
@@ -577,7 +582,8 @@ function remarkStructure({
   allowedMdxAttributes = (node) => {
     if (!node.name) return false;
     return ["TypeTable", "Callout"].includes(node.name);
-  }
+  },
+  exportAs = false
 } = {}) {
   const slugger = new Slugger();
   if (Array.isArray(allowedMdxAttributes)) {
@@ -588,7 +594,7 @@ function remarkStructure({
     const arr = types;
     types = (node) => arr.includes(node.type);
   }
-  return (node, file) => {
+  return (tree, file) => {
     slugger.reset();
     const data = { contents: [], headings: [] };
     let lastHeading;
@@ -599,9 +605,8 @@ function remarkStructure({
         data.contents.push(...frontmatter._openapi.structuredData.contents);
       }
     }
-    visit2(node, (element) => {
-      if (element.type === "root") return;
-      if (!types(element)) return;
+    visit2(tree, (element) => {
+      if (element.type === "root" || !types(element)) return;
       if (element.type === "heading") {
         element.data ||= {};
         element.data.hProperties ||= {};
@@ -648,6 +653,14 @@ function remarkStructure({
       return "skip";
     });
     file.data.structuredData = data;
+    if (exportAs) {
+      tree.children.unshift(
+        toMdxExport(
+          typeof exportAs === "string" ? exportAs : "structuredData",
+          data
+        )
+      );
+    }
   };
 }
 function structure(content, remarkPlugins = [], options = {}) {

package/dist/{remark-structure-DkCXCzpD.d.ts → remark-structure-BJxaB5zZ.d.ts}

@@ -31,26 +31,31 @@ interface StructureOptions {
      * - a function that determines if attribute should be indexed.
      */
     allowedMdxAttributes?: string[] | ((node: MdxJsxFlowElement, attribute: MdxJsxAttribute | MdxJsxExpressionAttribute) => boolean);
+    /**
+     * export as `structuredData` or specified variable name.
+     */
+    exportAs?: string | boolean;
 }
 declare module 'mdast' {
     interface Data {
         /**
-         * Get content of unserializable element
-         *
-         * Needed for `remarkStructure` to generate search index
+         * [Fumadocs] Get content of unserializable element, `remarkStructure` uses it to generate search index.
          */
         _string?: string[];
     }
 }
 declare module 'vfile' {
     interface DataMap {
+        /**
+         * [Fumadocs] injected by `remarkStructure`
+         */
         structuredData: StructuredData;
     }
 }
 /**
  * Attach structured data to VFile, you can access via `vfile.data.structuredData`.
  */
-declare function remarkStructure({ types, allowedMdxAttributes, }?: StructureOptions): Transformer<Root, Root>;
+declare function remarkStructure({ types, allowedMdxAttributes, exportAs, }?: StructureOptions): Transformer<Root, Root>;
 /**
  * Extract data from markdown/mdx content
  */

package/dist/search/algolia.d.ts

@@ -1,5 +1,5 @@
 import { Algoliasearch } from 'algoliasearch';
-import { S as StructuredData } from '../remark-structure-DkCXCzpD.js';
+import { S as StructuredData } from '../remark-structure-BJxaB5zZ.js';
 import 'mdast';
 import 'unified';
 import 'mdast-util-mdx-jsx';

package/dist/search/client.d.ts

@@ -1,5 +1,5 @@
 import { AnyOrama } from '@orama/orama';
-import '../remark-structure-DkCXCzpD.js';
+import '../remark-structure-BJxaB5zZ.js';
 import { BaseIndex } from './algolia.js';
 import { LiteClient, SearchResponse } from 'algoliasearch/lite';
 import { OramaCloud, OramaCloudSearchParams } from '@orama/core';

package/dist/search/orama-cloud.d.ts

@@ -1,4 +1,4 @@
-import { S as StructuredData } from '../remark-structure-DkCXCzpD.js';
+import { S as StructuredData } from '../remark-structure-BJxaB5zZ.js';
 import '../remark-code-tab-DmyIyi6m.js';
 import { OramaCloud } from '@orama/core';
 import 'mdast';

package/dist/search/server.d.ts

@@ -1,5 +1,5 @@
 import { TypedDocument, Orama, Language, RawData, create, SearchParams } from '@orama/orama';
-import { S as StructuredData } from '../remark-structure-DkCXCzpD.js';
+import { S as StructuredData } from '../remark-structure-BJxaB5zZ.js';
 import { SortedResult } from './index.js';
 export { HighlightedText, ReactSortedResult, createContentHighlighter } from './index.js';
 import { I18nConfig } from '../i18n/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fumadocs-core",
-  "version": "16.0.6",
+  "version": "16.0.7",
   "description": "The library for building a documentation website in any React.js framework",
   "keywords": [
     "Fumadocs",
@@ -105,6 +105,7 @@
     "@orama/orama": "^3.1.16",
     "@shikijs/rehype": "^3.14.0",
     "@shikijs/transformers": "^3.14.0",
+    "estree-util-value-to-estree": "^3.5.0",
     "github-slugger": "^2.0.0",
     "hast-util-to-estree": "^3.1.3",
     "hast-util-to-jsx-runtime": "^2.3.6",