fumadocs-core 16.4.0 → 16.4.2

package/dist/search/algolia.d.ts

@@ -1,69 +1,3 @@
-import { Algoliasearch } from 'algoliasearch';
-import { StructuredData } from '../mdx-plugins/remark-structure.js';
-import 'mdast';
-import 'unified';
-import 'mdast-util-mdx-jsx';
-
-interface DocumentRecord {
-    /**
-     * The ID of document, must be unique
-     */
-    _id: string;
-    title: string;
-    description?: string;
-    breadcrumbs?: string[];
-    /**
-     * URL to the page
-     */
-    url: string;
-    structured: StructuredData;
-    /**
-     * Tag to filter results
-     */
-    tag?: string;
-    /**
-     * Data to be added to each section index
-     */
-    extra_data?: object;
-}
-interface SyncOptions {
-    /**
-     * Index Name for documents.
-     */
-    indexName?: string;
-    /**
-     * Search indexes
-     */
-    documents: DocumentRecord[];
-}
-/**
- * Update index settings and replace all objects
- *
- * @param client - Algolia Admin Client
- * @param options - Index Options
- */
-declare function sync(client: Algoliasearch, options: SyncOptions): Promise<void>;
-declare function setIndexSettings(client: Algoliasearch, indexName: string): Promise<void>;
-declare function updateDocuments(client: Algoliasearch, indexName: string, documents: DocumentRecord[]): Promise<void>;
-interface BaseIndex {
-    objectID: string;
-    title: string;
-    url: string;
-    tag?: string;
-    /**
-     * The id of page, used for distinct
-     */
-    page_id: string;
-    /**
-     * Heading content
-     */
-    section?: string;
-    /**
-     * Heading (anchor) id
-     */
-    section_id?: string;
-    breadcrumbs?: string[];
-    content: string;
-}
-
-export { type BaseIndex, type DocumentRecord, type SyncOptions, setIndexSettings, sync, updateDocuments };
+import "../remark-structure-RZD2gGKp.js";
+import { a as sync, i as setIndexSettings, n as DocumentRecord, o as updateDocuments, r as SyncOptions, t as BaseIndex } from "../algolia-CBBN8R6-.js";
+export { BaseIndex, DocumentRecord, SyncOptions, setIndexSettings, sync, updateDocuments };

package/dist/search/algolia.js

@@ -1,71 +1,77 @@
-import "../chunk-U67V476Y.js";
-
-// src/search/algolia.ts
+//#region src/search/algolia.ts
+/**
+* Update index settings and replace all objects
+*
+* @param client - Algolia Admin Client
+* @param options - Index Options
+*/
 async function sync(client, options) {
-  const { indexName = "document", documents } = options;
-  await setIndexSettings(client, indexName);
-  await updateDocuments(client, indexName, documents);
+	const { indexName = "document", documents } = options;
+	await setIndexSettings(client, indexName);
+	await updateDocuments(client, indexName, documents);
 }
 async function setIndexSettings(client, indexName) {
-  await client.setSettings({
-    indexName,
-    indexSettings: {
-      attributeForDistinct: "page_id",
-      attributesToRetrieve: [
-        "title",
-        "section",
-        "content",
-        "url",
-        "section_id",
-        "breadcrumbs"
-      ],
-      searchableAttributes: ["title", "section", "content"],
-      attributesToSnippet: [],
-      attributesForFaceting: ["tag"]
-    }
-  });
+	await client.setSettings({
+		indexName,
+		indexSettings: {
+			attributeForDistinct: "page_id",
+			attributesToRetrieve: [
+				"title",
+				"section",
+				"content",
+				"url",
+				"section_id",
+				"breadcrumbs"
+			],
+			searchableAttributes: [
+				"title",
+				"section",
+				"content"
+			],
+			attributesToSnippet: [],
+			attributesForFaceting: ["tag"]
+		}
+	});
 }
 function toIndex(page) {
-  let id = 0;
-  const indexes = [];
-  const scannedHeadings = /* @__PURE__ */ new Set();
-  function createIndex(section, sectionId, content) {
-    return {
-      objectID: `${page._id}-${(id++).toString()}`,
-      breadcrumbs: page.breadcrumbs,
-      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));
-  const { headings, contents } = page.structured;
-  for (const p of contents) {
-    const heading = p.heading ? 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);
-      indexes.push(createIndex(heading.content, heading.id, heading.content));
-    }
-    indexes.push(index);
-  }
-  return indexes;
+	let id = 0;
+	const indexes = [];
+	const scannedHeadings = /* @__PURE__ */ new Set();
+	function createIndex(section, sectionId, content) {
+		return {
+			objectID: `${page._id}-${(id++).toString()}`,
+			breadcrumbs: page.breadcrumbs,
+			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));
+	const { headings, contents } = page.structured;
+	for (const p of contents) {
+		const heading = p.heading ? 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);
+			indexes.push(createIndex(heading.content, heading.id, heading.content));
+		}
+		indexes.push(index);
+	}
+	return indexes;
 }
 async function updateDocuments(client, indexName, documents) {
-  const objects = documents.flatMap(toIndex);
-  await client.replaceAllObjects({
-    indexName,
-    objects
-  });
+	const objects = documents.flatMap(toIndex);
+	await client.replaceAllObjects({
+		indexName,
+		objects
+	});
 }
-export {
-  setIndexSettings,
-  sync,
-  updateDocuments
-};
+
+//#endregion
+export { setIndexSettings, sync, updateDocuments };
+//# sourceMappingURL=algolia.js.map

package/dist/search/algolia.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"algolia.js","names":["indexes: BaseIndex[]"],"sources":["../../src/search/algolia.ts"],"sourcesContent":["import type { Algoliasearch } from 'algoliasearch';\nimport type { StructuredData } from '@/mdx-plugins/remark-structure';\n\nexport interface DocumentRecord {\n  /**\n   * The ID of document, must be unique\n   */\n  _id: string;\n\n  title: string;\n  description?: string;\n  breadcrumbs?: string[];\n\n  /**\n   * URL to the page\n   */\n  url: string;\n  structured: StructuredData;\n\n  /**\n   * Tag to filter results\n   */\n  tag?: string;\n\n  /**\n   * Data to be added to each section index\n   */\n  extra_data?: object;\n}\n\nexport interface SyncOptions {\n  /**\n   * Index Name for documents.\n   */\n  indexName?: string;\n\n  /**\n   * Search indexes\n   */\n  documents: DocumentRecord[];\n}\n\n/**\n * Update index settings and replace all objects\n *\n * @param client - Algolia Admin Client\n * @param options - Index Options\n */\nexport async function sync(client: Algoliasearch, options: SyncOptions): Promise<void> {\n  const { indexName = 'document', documents } = options;\n  await setIndexSettings(client, indexName);\n  await updateDocuments(client, indexName, documents);\n}\n\nexport async function setIndexSettings(client: Algoliasearch, indexName: string): Promise<void> {\n  await client.setSettings({\n    indexName,\n    indexSettings: {\n      attributeForDistinct: 'page_id',\n      attributesToRetrieve: ['title', 'section', 'content', 'url', 'section_id', 'breadcrumbs'],\n      searchableAttributes: ['title', 'section', 'content'],\n      attributesToSnippet: [],\n      attributesForFaceting: ['tag'],\n    },\n  });\n}\n\nfunction toIndex(page: DocumentRecord): BaseIndex[] {\n  let id = 0;\n  const indexes: BaseIndex[] = [];\n  const scannedHeadings = new Set<string>();\n\n  function createIndex(\n    section: string | undefined,\n    sectionId: string | undefined,\n    content: string,\n  ): BaseIndex {\n    return {\n      objectID: `${page._id}-${(id++).toString()}`,\n      breadcrumbs: page.breadcrumbs,\n      title: page.title,\n      url: page.url,\n      page_id: page._id,\n      tag: page.tag,\n      section,\n      section_id: sectionId,\n      content,\n      ...page.extra_data,\n    };\n  }\n\n  if (page.description) indexes.push(createIndex(undefined, undefined, page.description));\n  const { headings, contents } = page.structured;\n\n  for (const p of contents) {\n    const heading = p.heading ? headings.find((h) => p.heading === h.id) : null;\n\n    const index = createIndex(heading?.content, heading?.id, p.content);\n\n    if (heading && !scannedHeadings.has(heading.id)) {\n      scannedHeadings.add(heading.id);\n\n      indexes.push(createIndex(heading.content, heading.id, heading.content));\n    }\n\n    indexes.push(index);\n  }\n\n  return indexes;\n}\n\nexport async function updateDocuments(\n  client: Algoliasearch,\n  indexName: string,\n  documents: DocumentRecord[],\n): Promise<void> {\n  const objects = documents.flatMap(toIndex);\n\n  await client.replaceAllObjects({\n    indexName,\n    objects: objects as unknown as Record<string, unknown>[],\n  });\n}\n\nexport interface BaseIndex {\n  objectID: string;\n  title: string;\n  url: string;\n  tag?: string;\n\n  /**\n   * The id of page, used for distinct\n   */\n  page_id: string;\n\n  /**\n   * Heading content\n   */\n  section?: string;\n\n  /**\n   * Heading (anchor) id\n   */\n  section_id?: string;\n\n  breadcrumbs?: string[];\n\n  content: string;\n}\n"],"mappings":";;;;;;;AAgDA,eAAsB,KAAK,QAAuB,SAAqC;CACrF,MAAM,EAAE,YAAY,YAAY,cAAc;AAC9C,OAAM,iBAAiB,QAAQ,UAAU;AACzC,OAAM,gBAAgB,QAAQ,WAAW,UAAU;;AAGrD,eAAsB,iBAAiB,QAAuB,WAAkC;AAC9F,OAAM,OAAO,YAAY;EACvB;EACA,eAAe;GACb,sBAAsB;GACtB,sBAAsB;IAAC;IAAS;IAAW;IAAW;IAAO;IAAc;IAAc;GACzF,sBAAsB;IAAC;IAAS;IAAW;IAAU;GACrD,qBAAqB,EAAE;GACvB,uBAAuB,CAAC,MAAM;GAC/B;EACF,CAAC;;AAGJ,SAAS,QAAQ,MAAmC;CAClD,IAAI,KAAK;CACT,MAAMA,UAAuB,EAAE;CAC/B,MAAM,kCAAkB,IAAI,KAAa;CAEzC,SAAS,YACP,SACA,WACA,SACW;AACX,SAAO;GACL,UAAU,GAAG,KAAK,IAAI,IAAI,MAAM,UAAU;GAC1C,aAAa,KAAK;GAClB,OAAO,KAAK;GACZ,KAAK,KAAK;GACV,SAAS,KAAK;GACd,KAAK,KAAK;GACV;GACA,YAAY;GACZ;GACA,GAAG,KAAK;GACT;;AAGH,KAAI,KAAK,YAAa,SAAQ,KAAK,YAAY,QAAW,QAAW,KAAK,YAAY,CAAC;CACvF,MAAM,EAAE,UAAU,aAAa,KAAK;AAEpC,MAAK,MAAM,KAAK,UAAU;EACxB,MAAM,UAAU,EAAE,UAAU,SAAS,MAAM,MAAM,EAAE,YAAY,EAAE,GAAG,GAAG;EAEvE,MAAM,QAAQ,YAAY,SAAS,SAAS,SAAS,IAAI,EAAE,QAAQ;AAEnE,MAAI,WAAW,CAAC,gBAAgB,IAAI,QAAQ,GAAG,EAAE;AAC/C,mBAAgB,IAAI,QAAQ,GAAG;AAE/B,WAAQ,KAAK,YAAY,QAAQ,SAAS,QAAQ,IAAI,QAAQ,QAAQ,CAAC;;AAGzE,UAAQ,KAAK,MAAM;;AAGrB,QAAO;;AAGT,eAAsB,gBACpB,QACA,WACA,WACe;CACf,MAAM,UAAU,UAAU,QAAQ,QAAQ;AAE1C,OAAM,OAAO,kBAAkB;EAC7B;EACS;EACV,CAAC"}

package/dist/search/client.d.ts

@@ -1,121 +1,126 @@
-import { DependencyList } from 'react';
-import { AnyOrama } from '@orama/orama';
-import '../mdx-plugins/remark-structure.js';
-import { BaseIndex } from './algolia.js';
-import { LiteClient, SearchResponse } from 'algoliasearch/lite';
-import { OramaCloud, OramaCloudSearchParams } from '@orama/core';
-import Mixedbread from '@mixedbread/sdk';
-import { SortedResult } from './index.js';
-import 'mdast';
-import 'unified';
-import 'mdast-util-mdx-jsx';
-import 'algoliasearch';
+import "../definitions-DuxDer_c.js";
+import "../remark-structure-RZD2gGKp.js";
+import { t as BaseIndex } from "../algolia-CBBN8R6-.js";
+import { SortedResult } from "./index.js";
+import "../server-CPR_fgkH.js";
+import "../index-2U6Tl4--.js";
+import { DependencyList } from "react";
+import { AnyOrama } from "@orama/orama";
+import { LiteClient, SearchResponse } from "algoliasearch/lite";
+import { OramaCloud, OramaCloudSearchParams } from "@orama/core";
+import Mixedbread from "@mixedbread/sdk";
 
+//#region src/search/client/fetch.d.ts
 interface FetchOptions {
-    /**
-     * API route for search endpoint, support absolute URLs.
-     *
-     * @defaultValue '/api/search'
-     */
-    api?: string;
-    /**
-     * Filter results with specific tag(s).
-     */
-    tag?: string | string[];
-    /**
-     * Filter by locale
-     */
-    locale?: string;
+  /**
+   * API route for search endpoint, support absolute URLs.
+   *
+   * @defaultValue '/api/search'
+   */
+  api?: string;
+  /**
+   * Filter results with specific tag(s).
+   */
+  tag?: string | string[];
+  /**
+   * Filter by locale
+   */
+  locale?: string;
 }
-
+//#endregion
+//#region src/search/client/static.d.ts
 interface StaticOptions {
-    /**
-     * Where to download exported search indexes (URL)
-     *
-     * @defaultValue '/api/search'
-     */
-    from?: string;
-    initOrama?: (locale?: string) => AnyOrama | Promise<AnyOrama>;
-    /**
-     * Filter results with specific tag(s).
-     */
-    tag?: string | string[];
-    /**
-     * Filter by locale (unsupported at the moment)
-     */
-    locale?: string;
+  /**
+   * Where to download exported search indexes (URL)
+   *
+   * @defaultValue '/api/search'
+   */
+  from?: string;
+  initOrama?: (locale?: string) => AnyOrama | Promise<AnyOrama>;
+  /**
+   * Filter results with specific tag(s).
+   */
+  tag?: string | string[];
+  /**
+   * Filter by locale (unsupported at the moment)
+   */
+  locale?: string;
 }
-
+//#endregion
+//#region src/search/client/algolia.d.ts
 interface AlgoliaOptions {
-    indexName: string;
-    client: LiteClient;
-    /**
-     * Filter results with specific tag.
-     */
-    tag?: string;
-    locale?: string;
-    onSearch?: (query: string, tag?: string, locale?: string) => Promise<{
-        results: SearchResponse<BaseIndex>[];
-    }>;
+  indexName: string;
+  client: LiteClient;
+  /**
+   * Filter results with specific tag.
+   */
+  tag?: string;
+  locale?: string;
+  onSearch?: (query: string, tag?: string, locale?: string) => Promise<{
+    results: SearchResponse<BaseIndex>[];
+  }>;
 }
-
+//#endregion
+//#region src/search/client/orama-cloud.d.ts
 interface OramaCloudOptions {
-    client: OramaCloud;
-    /**
-     * The type of your index.
-     *
-     * You can set it to `crawler` if you use crawler instead of the JSON index with schema provided by Fumadocs
-     */
-    index?: 'default' | 'crawler';
-    params?: Partial<OramaCloudSearchParams>;
-    /**
-     * Filter results with specific tag.
-     */
-    tag?: string;
-    /**
-     * Filter by locale (unsupported at the moment)
-     */
-    locale?: string;
+  client: OramaCloud;
+  /**
+   * The type of your index.
+   *
+   * You can set it to `crawler` if you use crawler instead of the JSON index with schema provided by Fumadocs
+   */
+  index?: 'default' | 'crawler';
+  params?: Partial<OramaCloudSearchParams>;
+  /**
+   * Filter results with specific tag.
+   */
+  tag?: string;
+  /**
+   * Filter by locale (unsupported at the moment)
+   */
+  locale?: string;
 }
-
+//#endregion
+//#region src/search/client/mixedbread.d.ts
 interface MixedbreadOptions {
-    /**
-     * The identifier of the store to search in
-     */
-    storeIdentifier: string;
-    /**
-     * The Mixedbread SDK client instance
-     */
-    client: Mixedbread;
-    /**
-     * Filter results with specific tag.
-     */
-    tag?: string;
-    /**
-     * Filter by locale (unsupported at the moment)
-     */
-    locale?: string;
+  /**
+   * The identifier of the store to search in
+   */
+  storeIdentifier: string;
+  /**
+   * The Mixedbread SDK client instance
+   */
+  client: Mixedbread;
+  /**
+   * Filter results with specific tag.
+   */
+  tag?: string;
+  /**
+   * Filter by locale (unsupported at the moment)
+   */
+  locale?: string;
 }
-
+//#endregion
+//#region src/search/client.d.ts
 interface UseDocsSearch {
-    search: string;
-    setSearch: (v: string) => void;
-    query: {
-        isLoading: boolean;
-        data?: SortedResult[] | 'empty';
-        error?: Error;
-    };
+  search: string;
+  setSearch: (v: string) => void;
+  query: {
+    isLoading: boolean;
+    data?: SortedResult[] | 'empty';
+    error?: Error;
+  };
 }
 type Client = ({
-    type: 'fetch';
+  type: 'fetch';
 } & FetchOptions) | ({
-    type: 'static';
+  type: 'static';
 } & StaticOptions) | ({
-    type: 'algolia';
+  type: 'algolia';
 } & AlgoliaOptions) | ({
-    type: 'orama-cloud';
+  type: 'orama-cloud';
 } & OramaCloudOptions) | ({
-    type: 'mixedbread';
+  type: 'mixedbread';
 } & MixedbreadOptions);
 /**
  * Provide a hook to query different official search clients.
@@ -123,18 +128,19 @@ type Client = ({
  * Note: it will re-query when its parameters changed, make sure to use `useMemo()` on `clientOptions` or define `deps` array.
  */
 declare function useDocsSearch(clientOptions: Client & {
-    /**
-     * The debounced delay for performing a search (in ms).
-     * .
-     * @defaultValue 100
-     */
-    delayMs?: number;
-    /**
-     * still perform search even if query is empty.
-     *
-     * @defaultValue false
-     */
-    allowEmpty?: boolean;
+  /**
+   * The debounced delay for performing a search (in ms).
+   * .
+   * @defaultValue 100
+   */
+  delayMs?: number;
+  /**
+   * still perform search even if query is empty.
+   *
+   * @defaultValue false
+   */
+  allowEmpty?: boolean;
 }, deps?: DependencyList): UseDocsSearch;
-
-export { type AlgoliaOptions, type Client, type FetchOptions, type OramaCloudOptions, type StaticOptions, useDocsSearch };
+//#endregion
+export { type AlgoliaOptions, Client, type FetchOptions, type OramaCloudOptions, type StaticOptions, useDocsSearch };
+//# sourceMappingURL=client.d.ts.map

package/dist/search/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","names":[],"sources":["../../src/search/client/fetch.ts","../../src/search/client/static.ts","../../src/search/client/algolia.ts","../../src/search/client/orama-cloud.ts","../../src/search/client/mixedbread.ts","../../src/search/client.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;UAEiB,YAAA;;;;;;;;;;;;AAAjB;;;;;;UCIiB,aAAA;;;;;;;mCAQkB,WAAW,QAAQ;;;;;EDZrC;;;;ACIjB;;;UCFiB,cAAA;;UAEP;;;;;;+DAaH;aACM,eAAe;EFlBX,CAAA,CAAA;;;;UGWA,iBAAA;UACP;;;;;;;WAOC,QAAQ;;;AHnBnB;;;;ACIA;EAQmC,MAAA,CAAA,EAAA,MAAA;;;;UGRlB,iBAAA;;;;;;;;UASP;;;AJbV;;;;ACIA;EAQmC,MAAA,CAAA,EAAA,MAAA;;;;UIJzB,aAAA;;;;;WAKC;ILbM,KAAA,CAAA,EKcL,KLdiB;;;KKkBjB,MAAA;EJdK,IAAA,EAAA,OAAA;CAQkB,GIS3B,YJT2B,CAAA,GAAA,CAAA;EAAmB,IAAA,EAAA,QAAA;CAAR,GIYtC,aJZsC,CAAA,GAAA,CAAA;EAAO,IAAA,EAAA,SAAA;IIe7C;;IAGA;EH5BS,IAAA,EAAA,YAAc;CAErB,GG6BF,iBH7BE,CAAA;;;;;;iBG2DM,aAAA,gBACC;;AFrDjB;;;;EAQkB,OAAA,CAAA,EAAA,MAAA;;;;ACflB;;;UC2ES,iBACN"}