fumadocs-core 16.4.1 → 16.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/advanced-DSlc7qa9.js +80 -0
- package/dist/advanced-DSlc7qa9.js.map +1 -0
- package/dist/algolia-BGWM-DkQ.js +49 -0
- package/dist/algolia-BGWM-DkQ.js.map +1 -0
- package/dist/algolia-FqjcaTcD.d.ts +68 -0
- package/dist/algolia-FqjcaTcD.d.ts.map +1 -0
- package/dist/breadcrumb.d.ts +29 -27
- package/dist/breadcrumb.d.ts.map +1 -0
- package/dist/breadcrumb.js +55 -72
- package/dist/breadcrumb.js.map +1 -0
- package/dist/chunk-C1JLJEPO.js +42 -0
- package/dist/codeblock-utils-Dh1w8ICD.d.ts +37 -0
- package/dist/codeblock-utils-Dh1w8ICD.d.ts.map +1 -0
- package/dist/content/github.d.ts +43 -32
- package/dist/content/github.d.ts.map +1 -0
- package/dist/content/github.js +29 -43
- package/dist/content/github.js.map +1 -0
- package/dist/content/index.d.ts +20 -13
- package/dist/content/index.d.ts.map +1 -0
- package/dist/content/index.js +17 -23
- package/dist/content/index.js.map +1 -0
- package/dist/content/mdx/preset-bundler.d.ts +22 -24
- package/dist/content/mdx/preset-bundler.d.ts.map +1 -0
- package/dist/content/mdx/preset-bundler.js +38 -69
- package/dist/content/mdx/preset-bundler.js.map +1 -0
- package/dist/content/mdx/preset-runtime.d.ts +22 -24
- package/dist/content/mdx/preset-runtime.d.ts.map +1 -0
- package/dist/content/mdx/preset-runtime.js +36 -68
- package/dist/content/mdx/preset-runtime.js.map +1 -0
- package/dist/content/toc.d.ts +7 -6
- package/dist/content/toc.d.ts.map +1 -0
- package/dist/content/toc.js +15 -19
- package/dist/content/toc.js.map +1 -0
- package/dist/definitions-DJAPG-2U.d.ts +62 -0
- package/dist/definitions-DJAPG-2U.d.ts.map +1 -0
- package/dist/dynamic-link.d.ts +7 -5
- package/dist/dynamic-link.d.ts.map +1 -0
- package/dist/dynamic-link.js +29 -27
- package/dist/dynamic-link.js.map +1 -0
- package/dist/fetch-B1nmMSyw.js +20 -0
- package/dist/fetch-B1nmMSyw.js.map +1 -0
- package/dist/framework/index.d.ts +38 -29
- package/dist/framework/index.d.ts.map +1 -0
- package/dist/framework/index.js +68 -17
- package/dist/framework/index.js.map +1 -0
- package/dist/framework/next.d.ts +15 -10
- package/dist/framework/next.d.ts.map +1 -0
- package/dist/framework/next.js +18 -26
- package/dist/framework/next.js.map +1 -0
- package/dist/framework/react-router.d.ts +15 -10
- package/dist/framework/react-router.d.ts.map +1 -0
- package/dist/framework/react-router.js +42 -55
- package/dist/framework/react-router.js.map +1 -0
- package/dist/framework/tanstack.d.ts +15 -10
- package/dist/framework/tanstack.d.ts.map +1 -0
- package/dist/framework/tanstack.js +54 -69
- package/dist/framework/tanstack.js.map +1 -0
- package/dist/framework/waku.d.ts +15 -10
- package/dist/framework/waku.d.ts.map +1 -0
- package/dist/framework/waku.js +47 -58
- package/dist/framework/waku.js.map +1 -0
- package/dist/highlight/client.d.ts +6 -7
- package/dist/highlight/client.d.ts.map +1 -0
- package/dist/highlight/client.js +22 -14
- package/dist/highlight/client.js.map +1 -0
- package/dist/highlight/index.d.ts +2 -30
- package/dist/highlight/index.js +3 -13
- package/dist/i18n/index.d.ts +2 -39
- package/dist/i18n/index.js +6 -7
- package/dist/i18n/index.js.map +1 -0
- package/dist/i18n/middleware.d.ts +36 -28
- package/dist/i18n/middleware.d.ts.map +1 -0
- package/dist/i18n/middleware.js +55 -73
- package/dist/i18n/middleware.js.map +1 -0
- package/dist/icon-5lVe3l-0.js +19 -0
- package/dist/icon-5lVe3l-0.js.map +1 -0
- package/dist/index-BhVrX5J1.d.ts +41 -0
- package/dist/index-BhVrX5J1.d.ts.map +1 -0
- package/dist/index-Co_C8NEi.d.ts +380 -0
- package/dist/index-Co_C8NEi.d.ts.map +1 -0
- package/dist/link.d.ts +17 -15
- package/dist/link.d.ts.map +1 -0
- package/dist/link.js +29 -9
- package/dist/link.js.map +1 -0
- package/dist/mdast-utils-ix4DsXJP.js +40 -0
- package/dist/mdast-utils-ix4DsXJP.js.map +1 -0
- package/dist/mdx-plugins/codeblock-utils.d.ts +2 -29
- package/dist/mdx-plugins/codeblock-utils.js +71 -9
- package/dist/mdx-plugins/codeblock-utils.js.map +1 -0
- package/dist/mdx-plugins/index.d.ts +15 -20
- package/dist/mdx-plugins/index.js +18 -73
- package/dist/mdx-plugins/rehype-code.d.ts +2 -55
- package/dist/mdx-plugins/rehype-code.js +5 -15
- package/dist/mdx-plugins/rehype-toc.d.ts +2 -14
- package/dist/mdx-plugins/rehype-toc.js +3 -7
- package/dist/mdx-plugins/remark-admonition.d.ts +2 -20
- package/dist/mdx-plugins/remark-admonition.js +74 -8
- package/dist/mdx-plugins/remark-admonition.js.map +1 -0
- package/dist/mdx-plugins/remark-code-tab.d.ts +2 -30
- package/dist/mdx-plugins/remark-code-tab.js +183 -7
- package/dist/mdx-plugins/remark-code-tab.js.map +1 -0
- package/dist/mdx-plugins/remark-directive-admonition.d.ts +2 -27
- package/dist/mdx-plugins/remark-directive-admonition.js +60 -7
- package/dist/mdx-plugins/remark-directive-admonition.js.map +1 -0
- package/dist/mdx-plugins/remark-gfm.d.ts +2 -1
- package/dist/mdx-plugins/remark-gfm.js +3 -7
- package/dist/mdx-plugins/remark-heading.d.ts +2 -31
- package/dist/mdx-plugins/remark-heading.js +45 -8
- package/dist/mdx-plugins/remark-heading.js.map +1 -0
- package/dist/mdx-plugins/remark-image.d.ts +2 -57
- package/dist/mdx-plugins/remark-image.js +192 -7
- package/dist/mdx-plugins/remark-image.js.map +1 -0
- package/dist/mdx-plugins/remark-mdx-files.d.ts +2 -40
- package/dist/mdx-plugins/remark-mdx-files.js +187 -7
- package/dist/mdx-plugins/remark-mdx-files.js.map +1 -0
- package/dist/mdx-plugins/remark-mdx-mermaid.d.ts +2 -15
- package/dist/mdx-plugins/remark-mdx-mermaid.js +31 -7
- package/dist/mdx-plugins/remark-mdx-mermaid.js.map +1 -0
- package/dist/mdx-plugins/remark-npm.d.ts +2 -31
- package/dist/mdx-plugins/remark-npm.js +68 -8
- package/dist/mdx-plugins/remark-npm.js.map +1 -0
- package/dist/mdx-plugins/remark-steps.d.ts +2 -23
- package/dist/mdx-plugins/remark-steps.js +77 -7
- package/dist/mdx-plugins/remark-steps.js.map +1 -0
- package/dist/mdx-plugins/remark-structure.d.ts +2 -71
- package/dist/mdx-plugins/remark-structure.js +105 -11
- package/dist/mdx-plugins/remark-structure.js.map +1 -0
- package/dist/mixedbread-DSiQfUnN.js +88 -0
- package/dist/mixedbread-DSiQfUnN.js.map +1 -0
- package/dist/negotiation/index.d.ts +6 -4
- package/dist/negotiation/index.d.ts.map +1 -0
- package/dist/negotiation/index.js +41 -11
- package/dist/negotiation/index.js.map +1 -0
- package/dist/normalize-url-3WQZ_H_j.js +16 -0
- package/dist/normalize-url-3WQZ_H_j.js.map +1 -0
- package/dist/orama-cloud-BMDBfk05.js +84 -0
- package/dist/orama-cloud-BMDBfk05.js.map +1 -0
- package/dist/orama-cloud-legacy-CRZzZXWn.js +82 -0
- package/dist/orama-cloud-legacy-CRZzZXWn.js.map +1 -0
- package/dist/page-tree/index.d.ts +23 -11
- package/dist/page-tree/index.d.ts.map +1 -0
- package/dist/page-tree/index.js +3 -17
- package/dist/path-D6M0ZQvO.js +60 -0
- package/dist/path-D6M0ZQvO.js.map +1 -0
- package/dist/rehype-code-Bd52chOe.d.ts +58 -0
- package/dist/rehype-code-Bd52chOe.d.ts.map +1 -0
- package/dist/rehype-code-Dr35mETC.js +241 -0
- package/dist/rehype-code-Dr35mETC.js.map +1 -0
- package/dist/rehype-toc-BJVsblvp.d.ts +18 -0
- package/dist/rehype-toc-BJVsblvp.d.ts.map +1 -0
- package/dist/rehype-toc-Dqgey2tW.js +143 -0
- package/dist/rehype-toc-Dqgey2tW.js.map +1 -0
- package/dist/remark-admonition-Chku_iWO.d.ts +22 -0
- package/dist/remark-admonition-Chku_iWO.d.ts.map +1 -0
- package/dist/remark-code-tab-C0f6BPcw.d.ts +32 -0
- package/dist/remark-code-tab-C0f6BPcw.d.ts.map +1 -0
- package/dist/remark-directive-admonition-CBwJdh9z.d.ts +36 -0
- package/dist/remark-directive-admonition-CBwJdh9z.d.ts.map +1 -0
- package/dist/remark-gfm-B2aZXutO.d.ts +2 -0
- package/dist/remark-heading-CUAe4zIu.d.ts +37 -0
- package/dist/remark-heading-CUAe4zIu.d.ts.map +1 -0
- package/dist/remark-image-DMRnxsRO.d.ts +65 -0
- package/dist/remark-image-DMRnxsRO.d.ts.map +1 -0
- package/dist/remark-mdx-files-B5KMXnfh.d.ts +56 -0
- package/dist/remark-mdx-files-B5KMXnfh.d.ts.map +1 -0
- package/dist/remark-mdx-mermaid-C_4W5gfj.d.ts +17 -0
- package/dist/remark-mdx-mermaid-C_4W5gfj.d.ts.map +1 -0
- package/dist/remark-npm-CykFgJn2.d.ts +36 -0
- package/dist/remark-npm-CykFgJn2.d.ts.map +1 -0
- package/dist/remark-steps-5-DmLVv3.d.ts +28 -0
- package/dist/remark-steps-5-DmLVv3.d.ts.map +1 -0
- package/dist/remark-structure-CszwnaMR.d.ts +77 -0
- package/dist/remark-structure-CszwnaMR.d.ts.map +1 -0
- package/dist/remove-undefined-B7zJF-YS.js +19 -0
- package/dist/remove-undefined-B7zJF-YS.js.map +1 -0
- package/dist/search/algolia.d.ts +3 -69
- package/dist/search/algolia.js +69 -63
- package/dist/search/algolia.js.map +1 -0
- package/dist/search/client.d.ts +143 -114
- package/dist/search/client.d.ts.map +1 -0
- package/dist/search/client.js +98 -91
- package/dist/search/client.js.map +1 -0
- package/dist/search/index.d.ts +20 -18
- package/dist/search/index.d.ts.map +1 -0
- package/dist/search/index.js +3 -7
- package/dist/search/orama-cloud-legacy.d.ts +81 -0
- package/dist/search/orama-cloud-legacy.d.ts.map +1 -0
- package/dist/search/orama-cloud-legacy.js +50 -0
- package/dist/search/orama-cloud-legacy.js.map +1 -0
- package/dist/search/orama-cloud.d.ts +72 -70
- package/dist/search/orama-cloud.d.ts.map +1 -0
- package/dist/search/orama-cloud.js +46 -54
- package/dist/search/orama-cloud.js.map +1 -0
- package/dist/search/server.d.ts +6 -136
- package/dist/search/server.js +292 -369
- package/dist/search/server.js.map +1 -0
- package/dist/search-DcH54N2x.js +44 -0
- package/dist/search-DcH54N2x.js.map +1 -0
- package/dist/server-BzFuYBxW.d.ts +133 -0
- package/dist/server-BzFuYBxW.d.ts.map +1 -0
- package/dist/shiki-Bdk0JGsB.d.ts +33 -0
- package/dist/shiki-Bdk0JGsB.d.ts.map +1 -0
- package/dist/shiki-DoHr6fEj.js +80 -0
- package/dist/shiki-DoHr6fEj.js.map +1 -0
- package/dist/source/client/index.d.ts +7 -5
- package/dist/source/client/index.d.ts.map +1 -0
- package/dist/source/client/index.js +24 -35
- package/dist/source/client/index.js.map +1 -0
- package/dist/source/index.d.ts +3 -42
- package/dist/source/index.js +599 -752
- package/dist/source/index.js.map +1 -0
- package/dist/source/plugins/lucide-icons.d.ts +7 -7
- package/dist/source/plugins/lucide-icons.d.ts.map +1 -0
- package/dist/source/plugins/lucide-icons.js +21 -20
- package/dist/source/plugins/lucide-icons.js.map +1 -0
- package/dist/source/plugins/slugs.d.ts +3 -0
- package/dist/source/plugins/slugs.js +65 -0
- package/dist/source/plugins/slugs.js.map +1 -0
- package/dist/source/schema.d.ts +17 -14
- package/dist/source/schema.d.ts.map +1 -0
- package/dist/source/schema.js +26 -22
- package/dist/source/schema.js.map +1 -0
- package/dist/static-DAjBQpus.js +51 -0
- package/dist/static-DAjBQpus.js.map +1 -0
- package/dist/toc.d.ts +38 -25
- package/dist/toc.d.ts.map +1 -0
- package/dist/toc.js +123 -136
- package/dist/toc.js.map +1 -0
- package/dist/util-92szu3Vf.js +10 -0
- package/dist/util-92szu3Vf.js.map +1 -0
- package/dist/util-ofJFdM-e.d.ts +8 -0
- package/dist/util-ofJFdM-e.d.ts.map +1 -0
- package/dist/utils/use-effect-event.d.ts +3 -1
- package/dist/utils/use-effect-event.d.ts.map +1 -0
- package/dist/utils/use-effect-event.js +16 -13
- package/dist/utils/use-effect-event.js.map +1 -0
- package/dist/utils/use-media-query.d.ts +3 -1
- package/dist/utils/use-media-query.d.ts.map +1 -0
- package/dist/utils/use-media-query.js +20 -20
- package/dist/utils/use-media-query.js.map +1 -0
- package/dist/utils/use-on-change.d.ts +3 -1
- package/dist/utils/use-on-change.d.ts.map +1 -0
- package/dist/utils/use-on-change.js +23 -7
- package/dist/utils/use-on-change.js.map +1 -0
- package/dist/utils-bAoAH1Rh.js +134 -0
- package/dist/utils-bAoAH1Rh.js.map +1 -0
- package/package.json +72 -65
- package/dist/algolia-IZEDLPHE.js +0 -58
- package/dist/chunk-5PMI7QDD.js +0 -220
- package/dist/chunk-ADBHPKXG.js +0 -78
- package/dist/chunk-APKPSBSB.js +0 -74
- package/dist/chunk-CH7YHH7V.js +0 -222
- package/dist/chunk-EFVXL2PP.js +0 -144
- package/dist/chunk-EMWGTXSW.js +0 -19
- package/dist/chunk-FAEPKD7U.js +0 -20
- package/dist/chunk-FUUVPEA5.js +0 -29
- package/dist/chunk-GINBKBVQ.js +0 -12
- package/dist/chunk-GLRQBLGN.js +0 -59
- package/dist/chunk-JUF4WZ6G.js +0 -117
- package/dist/chunk-K4WNLOVQ.js +0 -75
- package/dist/chunk-L4JKQWCM.js +0 -131
- package/dist/chunk-MA6O2UUE.js +0 -50
- package/dist/chunk-ONG4RVCR.js +0 -8
- package/dist/chunk-OTD7MV33.js +0 -53
- package/dist/chunk-PFNP6PEB.js +0 -11
- package/dist/chunk-SH7BNTG7.js +0 -38
- package/dist/chunk-TWIDBWFG.js +0 -84
- package/dist/chunk-U67V476Y.js +0 -35
- package/dist/chunk-VLSDGCJE.js +0 -47
- package/dist/chunk-W6WTLKRA.js +0 -73
- package/dist/chunk-X2HFD5QJ.js +0 -275
- package/dist/chunk-XJ6ZQNEX.js +0 -91
- package/dist/chunk-XN2LKXFZ.js +0 -101
- package/dist/chunk-XOFXGHS4.js +0 -93
- package/dist/chunk-XZSI7AHE.js +0 -67
- package/dist/chunk-YVVDKJ2H.js +0 -34
- package/dist/chunk-ZMWYLUDP.js +0 -21
- package/dist/definitions-pJ7PybYY.d.ts +0 -60
- package/dist/fetch-IBTWQCJR.js +0 -22
- package/dist/loader-_E2HOdV0.d.ts +0 -333
- package/dist/mixedbread-A3WLENES.js +0 -117
- package/dist/orama-cloud-UZAPMPFV.js +0 -93
- package/dist/static-A2YJ5TXV.js +0 -62
- package/dist/util-bZU2QeJ2.d.ts +0 -6
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { PluggableList, Transformer } from "unified";
|
|
2
|
+
import { Nodes, Root } from "mdast";
|
|
3
|
+
import { MdxJsxAttribute, MdxJsxExpressionAttribute, MdxJsxFlowElement } from "mdast-util-mdx-jsx";
|
|
4
|
+
|
|
5
|
+
//#region src/mdx-plugins/remark-structure.d.ts
|
|
6
|
+
interface Heading$1 {
|
|
7
|
+
id: string;
|
|
8
|
+
content: string;
|
|
9
|
+
}
|
|
10
|
+
interface Content {
|
|
11
|
+
heading: string | undefined;
|
|
12
|
+
content: string;
|
|
13
|
+
}
|
|
14
|
+
interface StructuredData {
|
|
15
|
+
headings: Heading$1[];
|
|
16
|
+
/**
|
|
17
|
+
* Refer to paragraphs, a heading may contain multiple contents as well
|
|
18
|
+
*/
|
|
19
|
+
contents: Content[];
|
|
20
|
+
}
|
|
21
|
+
interface StructureOptions {
|
|
22
|
+
/**
|
|
23
|
+
* Types to be scanned as content.
|
|
24
|
+
*
|
|
25
|
+
* @defaultValue ['heading', 'paragraph', 'blockquote', 'tableCell', 'mdxJsxFlowElement']
|
|
26
|
+
*/
|
|
27
|
+
types?: string[] | ((node: Nodes) => boolean);
|
|
28
|
+
/**
|
|
29
|
+
* A list of indexable MDX attributes, either:
|
|
30
|
+
*
|
|
31
|
+
* - an array of attribute names.
|
|
32
|
+
* - a function that determines if attribute should be indexed.
|
|
33
|
+
*/
|
|
34
|
+
allowedMdxAttributes?: string[] | ((node: MdxJsxFlowElement, attribute: MdxJsxAttribute | MdxJsxExpressionAttribute) => boolean);
|
|
35
|
+
/**
|
|
36
|
+
* export as `structuredData` or specified variable name.
|
|
37
|
+
*/
|
|
38
|
+
exportAs?: string | boolean;
|
|
39
|
+
}
|
|
40
|
+
declare module 'mdast' {
|
|
41
|
+
interface Data {
|
|
42
|
+
/**
|
|
43
|
+
* [Fumadocs] Get content of unserializable element, `remarkStructure` uses it to generate search index.
|
|
44
|
+
*/
|
|
45
|
+
_string?: string[];
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
declare module 'vfile' {
|
|
49
|
+
interface DataMap {
|
|
50
|
+
/**
|
|
51
|
+
* [Fumadocs] injected by `remarkStructure`
|
|
52
|
+
*/
|
|
53
|
+
structuredData: StructuredData;
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
declare const remarkStructureDefaultOptions: {
|
|
57
|
+
types: string[];
|
|
58
|
+
allowedMdxAttributes: (node: MdxJsxFlowElement) => boolean;
|
|
59
|
+
exportAs: false;
|
|
60
|
+
};
|
|
61
|
+
/**
|
|
62
|
+
* Extract content into structured data.
|
|
63
|
+
*
|
|
64
|
+
* By default, the output is stored into VFile (`vfile.data.structuredData`), you can specify `exportAs` to export it.
|
|
65
|
+
*/
|
|
66
|
+
declare function remarkStructure({
|
|
67
|
+
types,
|
|
68
|
+
allowedMdxAttributes,
|
|
69
|
+
exportAs
|
|
70
|
+
}?: StructureOptions): Transformer<Root, Root>;
|
|
71
|
+
/**
|
|
72
|
+
* Extract data from markdown/mdx content
|
|
73
|
+
*/
|
|
74
|
+
declare function structure(content: string, remarkPlugins?: PluggableList, options?: StructureOptions): StructuredData;
|
|
75
|
+
//#endregion
|
|
76
|
+
export { structure as a, remarkStructureDefaultOptions as i, StructuredData as n, remarkStructure as r, StructureOptions as t };
|
|
77
|
+
//# sourceMappingURL=remark-structure-CszwnaMR.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"remark-structure-CszwnaMR.d.ts","names":[],"sources":["../src/mdx-plugins/remark-structure.ts"],"sourcesContent":[],"mappings":";;;;;UAaU,SAAA;;EAAA,OAAA,EAAA,MAAO;AAAA;AAUjB,UALU,OAAA,CAKO;EAQA,OAAA,EAAA,MAAA,GAAA,SAAgB;EAMJ,OAAA,EAAA,MAAA;;AAYV,UA1BF,cAAA,CA0BE;EAAkB,QAAA,EAzBzB,SAyByB,EAAA;EAAyB;AAO7D;;UAAA,EA5BW,OA4BX,EAAA;;AAAA,UAzBgB,gBAAA,CAyBhB;EAAA;;;;;EAoBY,KAAA,CAAA,EAAA,MAAA,EAAA,GAAA,CAAA,CAAA,IAAA,EAvCgB,KA+CS,EAAA,GAAA,OAAA,CAAA;EAOtB;;;;;;EAI6B,oBAAA,CAAA,EAAA,MAAA,EAAA,GAAA,CAAA,CAAA,IAAA,EA/C/B,iBA+C+B,EAAA,SAAA,EA9C1B,eA8C0B,GA9CR,yBA8CQ,EAAA,GAAA,OAAA,CAAA;EAAlB;;AAwG3B;EAEiB,QAAA,CAAA,EAAA,MAAA,GAAA,OAAA;;eAEd,OAAA,CAAA;EAAc,UAAA,IAAA,CAAA;;;;;;;;;;;;oBAnIG;;;cAIP;;+BAQyB;;;;;;;;iBAOtB,eAAA;;;;IAIb,mBAAwB,YAAY,MAAM;;;;iBAwG7B,SAAA,kCAEC,yBACN,mBACR"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
//#region src/utils/remove-undefined.ts
|
|
2
|
+
function removeUndefined(value, deep = false) {
|
|
3
|
+
const obj = value;
|
|
4
|
+
for (const key in obj) {
|
|
5
|
+
if (obj[key] === void 0) delete obj[key];
|
|
6
|
+
if (!deep) continue;
|
|
7
|
+
const entry = obj[key];
|
|
8
|
+
if (typeof entry === "object" && entry !== null) {
|
|
9
|
+
removeUndefined(entry, deep);
|
|
10
|
+
continue;
|
|
11
|
+
}
|
|
12
|
+
if (Array.isArray(entry)) for (const item of entry) removeUndefined(item, deep);
|
|
13
|
+
}
|
|
14
|
+
return value;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
//#endregion
|
|
18
|
+
export { removeUndefined as t };
|
|
19
|
+
//# sourceMappingURL=remove-undefined-B7zJF-YS.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"remove-undefined-B7zJF-YS.js","names":[],"sources":["../src/utils/remove-undefined.ts"],"sourcesContent":["export function removeUndefined<T extends object>(value: T, deep = false): T {\n const obj = value as Record<string, unknown>;\n\n for (const key in obj) {\n if (obj[key] === undefined) delete obj[key];\n if (!deep) continue;\n\n const entry = obj[key];\n\n if (typeof entry === 'object' && entry !== null) {\n removeUndefined(entry, deep);\n continue;\n }\n\n if (Array.isArray(entry)) {\n for (const item of entry) removeUndefined(item, deep);\n }\n }\n\n return value;\n}\n"],"mappings":";AAAA,SAAgB,gBAAkC,OAAU,OAAO,OAAU;CAC3E,MAAM,MAAM;AAEZ,MAAK,MAAM,OAAO,KAAK;AACrB,MAAI,IAAI,SAAS,OAAW,QAAO,IAAI;AACvC,MAAI,CAAC,KAAM;EAEX,MAAM,QAAQ,IAAI;AAElB,MAAI,OAAO,UAAU,YAAY,UAAU,MAAM;AAC/C,mBAAgB,OAAO,KAAK;AAC5B;;AAGF,MAAI,MAAM,QAAQ,MAAM,CACtB,MAAK,MAAM,QAAQ,MAAO,iBAAgB,MAAM,KAAK;;AAIzD,QAAO"}
|
package/dist/search/algolia.d.ts
CHANGED
|
@@ -1,69 +1,3 @@
|
|
|
1
|
-
import
|
|
2
|
-
import {
|
|
3
|
-
|
|
4
|
-
import 'unified';
|
|
5
|
-
import 'mdast-util-mdx-jsx';
|
|
6
|
-
|
|
7
|
-
interface DocumentRecord {
|
|
8
|
-
/**
|
|
9
|
-
* The ID of document, must be unique
|
|
10
|
-
*/
|
|
11
|
-
_id: string;
|
|
12
|
-
title: string;
|
|
13
|
-
description?: string;
|
|
14
|
-
breadcrumbs?: string[];
|
|
15
|
-
/**
|
|
16
|
-
* URL to the page
|
|
17
|
-
*/
|
|
18
|
-
url: string;
|
|
19
|
-
structured: StructuredData;
|
|
20
|
-
/**
|
|
21
|
-
* Tag to filter results
|
|
22
|
-
*/
|
|
23
|
-
tag?: string;
|
|
24
|
-
/**
|
|
25
|
-
* Data to be added to each section index
|
|
26
|
-
*/
|
|
27
|
-
extra_data?: object;
|
|
28
|
-
}
|
|
29
|
-
interface SyncOptions {
|
|
30
|
-
/**
|
|
31
|
-
* Index Name for documents.
|
|
32
|
-
*/
|
|
33
|
-
indexName?: string;
|
|
34
|
-
/**
|
|
35
|
-
* Search indexes
|
|
36
|
-
*/
|
|
37
|
-
documents: DocumentRecord[];
|
|
38
|
-
}
|
|
39
|
-
/**
|
|
40
|
-
* Update index settings and replace all objects
|
|
41
|
-
*
|
|
42
|
-
* @param client - Algolia Admin Client
|
|
43
|
-
* @param options - Index Options
|
|
44
|
-
*/
|
|
45
|
-
declare function sync(client: Algoliasearch, options: SyncOptions): Promise<void>;
|
|
46
|
-
declare function setIndexSettings(client: Algoliasearch, indexName: string): Promise<void>;
|
|
47
|
-
declare function updateDocuments(client: Algoliasearch, indexName: string, documents: DocumentRecord[]): Promise<void>;
|
|
48
|
-
interface BaseIndex {
|
|
49
|
-
objectID: string;
|
|
50
|
-
title: string;
|
|
51
|
-
url: string;
|
|
52
|
-
tag?: string;
|
|
53
|
-
/**
|
|
54
|
-
* The id of page, used for distinct
|
|
55
|
-
*/
|
|
56
|
-
page_id: string;
|
|
57
|
-
/**
|
|
58
|
-
* Heading content
|
|
59
|
-
*/
|
|
60
|
-
section?: string;
|
|
61
|
-
/**
|
|
62
|
-
* Heading (anchor) id
|
|
63
|
-
*/
|
|
64
|
-
section_id?: string;
|
|
65
|
-
breadcrumbs?: string[];
|
|
66
|
-
content: string;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
export { type BaseIndex, type DocumentRecord, type SyncOptions, setIndexSettings, sync, updateDocuments };
|
|
1
|
+
import "../remark-structure-CszwnaMR.js";
|
|
2
|
+
import { a as sync, i as setIndexSettings, n as DocumentRecord, o as updateDocuments, r as SyncOptions, t as BaseIndex } from "../algolia-FqjcaTcD.js";
|
|
3
|
+
export { BaseIndex, DocumentRecord, SyncOptions, setIndexSettings, sync, updateDocuments };
|
package/dist/search/algolia.js
CHANGED
|
@@ -1,71 +1,77 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
//#region src/search/algolia.ts
|
|
2
|
+
/**
|
|
3
|
+
* Update index settings and replace all objects
|
|
4
|
+
*
|
|
5
|
+
* @param client - Algolia Admin Client
|
|
6
|
+
* @param options - Index Options
|
|
7
|
+
*/
|
|
4
8
|
async function sync(client, options) {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
9
|
+
const { indexName = "document", documents } = options;
|
|
10
|
+
await setIndexSettings(client, indexName);
|
|
11
|
+
await updateDocuments(client, indexName, documents);
|
|
8
12
|
}
|
|
9
13
|
async function setIndexSettings(client, indexName) {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
14
|
+
await client.setSettings({
|
|
15
|
+
indexName,
|
|
16
|
+
indexSettings: {
|
|
17
|
+
attributeForDistinct: "page_id",
|
|
18
|
+
attributesToRetrieve: [
|
|
19
|
+
"title",
|
|
20
|
+
"section",
|
|
21
|
+
"content",
|
|
22
|
+
"url",
|
|
23
|
+
"section_id",
|
|
24
|
+
"breadcrumbs"
|
|
25
|
+
],
|
|
26
|
+
searchableAttributes: [
|
|
27
|
+
"title",
|
|
28
|
+
"section",
|
|
29
|
+
"content"
|
|
30
|
+
],
|
|
31
|
+
attributesToSnippet: [],
|
|
32
|
+
attributesForFaceting: ["tag"]
|
|
33
|
+
}
|
|
34
|
+
});
|
|
27
35
|
}
|
|
28
36
|
function toIndex(page) {
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
return indexes;
|
|
37
|
+
let id = 0;
|
|
38
|
+
const indexes = [];
|
|
39
|
+
const scannedHeadings = /* @__PURE__ */ new Set();
|
|
40
|
+
function createIndex(section, sectionId, content) {
|
|
41
|
+
return {
|
|
42
|
+
objectID: `${page._id}-${(id++).toString()}`,
|
|
43
|
+
breadcrumbs: page.breadcrumbs,
|
|
44
|
+
title: page.title,
|
|
45
|
+
url: page.url,
|
|
46
|
+
page_id: page._id,
|
|
47
|
+
tag: page.tag,
|
|
48
|
+
section,
|
|
49
|
+
section_id: sectionId,
|
|
50
|
+
content,
|
|
51
|
+
...page.extra_data
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
if (page.description) indexes.push(createIndex(void 0, void 0, page.description));
|
|
55
|
+
const { headings, contents } = page.structured;
|
|
56
|
+
for (const p of contents) {
|
|
57
|
+
const heading = p.heading ? headings.find((h) => p.heading === h.id) : null;
|
|
58
|
+
const index = createIndex(heading?.content, heading?.id, p.content);
|
|
59
|
+
if (heading && !scannedHeadings.has(heading.id)) {
|
|
60
|
+
scannedHeadings.add(heading.id);
|
|
61
|
+
indexes.push(createIndex(heading.content, heading.id, heading.content));
|
|
62
|
+
}
|
|
63
|
+
indexes.push(index);
|
|
64
|
+
}
|
|
65
|
+
return indexes;
|
|
59
66
|
}
|
|
60
67
|
async function updateDocuments(client, indexName, documents) {
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
68
|
+
const objects = documents.flatMap(toIndex);
|
|
69
|
+
await client.replaceAllObjects({
|
|
70
|
+
indexName,
|
|
71
|
+
objects
|
|
72
|
+
});
|
|
66
73
|
}
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
};
|
|
74
|
+
|
|
75
|
+
//#endregion
|
|
76
|
+
export { setIndexSettings, sync, updateDocuments };
|
|
77
|
+
//# sourceMappingURL=algolia.js.map
|
|
@@ -0,0 +1 @@
|
|
|
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
CHANGED
|
@@ -1,121 +1,149 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import {
|
|
5
|
-
import
|
|
6
|
-
import
|
|
7
|
-
import
|
|
8
|
-
import {
|
|
9
|
-
import
|
|
10
|
-
import
|
|
11
|
-
import
|
|
12
|
-
import
|
|
1
|
+
import "../definitions-DJAPG-2U.js";
|
|
2
|
+
import "../remark-structure-CszwnaMR.js";
|
|
3
|
+
import { t as BaseIndex } from "../algolia-FqjcaTcD.js";
|
|
4
|
+
import { SortedResult } from "./index.js";
|
|
5
|
+
import "../server-BzFuYBxW.js";
|
|
6
|
+
import "../index-Co_C8NEi.js";
|
|
7
|
+
import { DependencyList } from "react";
|
|
8
|
+
import { AnyOrama } from "@orama/orama";
|
|
9
|
+
import { LiteClient, SearchResponse } from "algoliasearch/lite";
|
|
10
|
+
import { OramaCloud, OramaCloudSearchParams } from "@orama/core";
|
|
11
|
+
import { ClientSearchParams, OramaClient } from "@oramacloud/client";
|
|
12
|
+
import Mixedbread from "@mixedbread/sdk";
|
|
13
13
|
|
|
14
|
+
//#region src/search/client/fetch.d.ts
|
|
14
15
|
interface FetchOptions {
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
16
|
+
/**
|
|
17
|
+
* API route for search endpoint, support absolute URLs.
|
|
18
|
+
*
|
|
19
|
+
* @defaultValue '/api/search'
|
|
20
|
+
*/
|
|
21
|
+
api?: string;
|
|
22
|
+
/**
|
|
23
|
+
* Filter results with specific tag(s).
|
|
24
|
+
*/
|
|
25
|
+
tag?: string | string[];
|
|
26
|
+
/**
|
|
27
|
+
* Filter by locale
|
|
28
|
+
*/
|
|
29
|
+
locale?: string;
|
|
29
30
|
}
|
|
30
|
-
|
|
31
|
+
//#endregion
|
|
32
|
+
//#region src/search/client/static.d.ts
|
|
31
33
|
interface StaticOptions {
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
34
|
+
/**
|
|
35
|
+
* Where to download exported search indexes (URL)
|
|
36
|
+
*
|
|
37
|
+
* @defaultValue '/api/search'
|
|
38
|
+
*/
|
|
39
|
+
from?: string;
|
|
40
|
+
initOrama?: (locale?: string) => AnyOrama | Promise<AnyOrama>;
|
|
41
|
+
/**
|
|
42
|
+
* Filter results with specific tag(s).
|
|
43
|
+
*/
|
|
44
|
+
tag?: string | string[];
|
|
45
|
+
/**
|
|
46
|
+
* Filter by locale (unsupported at the moment)
|
|
47
|
+
*/
|
|
48
|
+
locale?: string;
|
|
47
49
|
}
|
|
48
|
-
|
|
50
|
+
//#endregion
|
|
51
|
+
//#region src/search/client/algolia.d.ts
|
|
49
52
|
interface AlgoliaOptions {
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
53
|
+
indexName: string;
|
|
54
|
+
client: LiteClient;
|
|
55
|
+
/**
|
|
56
|
+
* Filter results with specific tag.
|
|
57
|
+
*/
|
|
58
|
+
tag?: string;
|
|
59
|
+
locale?: string;
|
|
60
|
+
onSearch?: (query: string, tag?: string, locale?: string) => Promise<{
|
|
61
|
+
results: SearchResponse<BaseIndex>[];
|
|
62
|
+
}>;
|
|
60
63
|
}
|
|
61
|
-
|
|
64
|
+
//#endregion
|
|
65
|
+
//#region src/search/client/orama-cloud.d.ts
|
|
62
66
|
interface OramaCloudOptions {
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
67
|
+
client: OramaCloud;
|
|
68
|
+
/**
|
|
69
|
+
* The type of your index.
|
|
70
|
+
*
|
|
71
|
+
* You can set it to `crawler` if you use crawler instead of the JSON index with schema provided by Fumadocs
|
|
72
|
+
*/
|
|
73
|
+
index?: 'default' | 'crawler';
|
|
74
|
+
params?: Partial<OramaCloudSearchParams>;
|
|
75
|
+
/**
|
|
76
|
+
* Filter results with specific tag.
|
|
77
|
+
*/
|
|
78
|
+
tag?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Filter by locale (unsupported at the moment)
|
|
81
|
+
*/
|
|
82
|
+
locale?: string;
|
|
79
83
|
}
|
|
80
|
-
|
|
84
|
+
//#endregion
|
|
85
|
+
//#region src/search/client/orama-cloud-legacy.d.ts
|
|
86
|
+
interface OramaCloudLegacyOptions {
|
|
87
|
+
client: OramaClient;
|
|
88
|
+
/**
|
|
89
|
+
* The type of your index.
|
|
90
|
+
*
|
|
91
|
+
* You can set it to `crawler` if you use crawler instead of the JSON index with schema provided by Fumadocs
|
|
92
|
+
*/
|
|
93
|
+
index?: 'default' | 'crawler';
|
|
94
|
+
params?: ClientSearchParams;
|
|
95
|
+
/**
|
|
96
|
+
* Filter results with specific tag.
|
|
97
|
+
*/
|
|
98
|
+
tag?: string;
|
|
99
|
+
/**
|
|
100
|
+
* Filter by locale (unsupported at the moment)
|
|
101
|
+
*/
|
|
102
|
+
locale?: string;
|
|
103
|
+
}
|
|
104
|
+
//#endregion
|
|
105
|
+
//#region src/search/client/mixedbread.d.ts
|
|
81
106
|
interface MixedbreadOptions {
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
107
|
+
/**
|
|
108
|
+
* The identifier of the store to search in
|
|
109
|
+
*/
|
|
110
|
+
storeIdentifier: string;
|
|
111
|
+
/**
|
|
112
|
+
* The Mixedbread SDK client instance
|
|
113
|
+
*/
|
|
114
|
+
client: Mixedbread;
|
|
115
|
+
/**
|
|
116
|
+
* Filter results with specific tag.
|
|
117
|
+
*/
|
|
118
|
+
tag?: string;
|
|
119
|
+
/**
|
|
120
|
+
* Filter by locale (unsupported at the moment)
|
|
121
|
+
*/
|
|
122
|
+
locale?: string;
|
|
98
123
|
}
|
|
99
|
-
|
|
124
|
+
//#endregion
|
|
125
|
+
//#region src/search/client.d.ts
|
|
100
126
|
interface UseDocsSearch {
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
127
|
+
search: string;
|
|
128
|
+
setSearch: (v: string) => void;
|
|
129
|
+
query: {
|
|
130
|
+
isLoading: boolean;
|
|
131
|
+
data?: SortedResult[] | 'empty';
|
|
132
|
+
error?: Error;
|
|
133
|
+
};
|
|
108
134
|
}
|
|
109
135
|
type Client = ({
|
|
110
|
-
|
|
136
|
+
type: 'fetch';
|
|
111
137
|
} & FetchOptions) | ({
|
|
112
|
-
|
|
138
|
+
type: 'static';
|
|
113
139
|
} & StaticOptions) | ({
|
|
114
|
-
|
|
140
|
+
type: 'algolia';
|
|
115
141
|
} & AlgoliaOptions) | ({
|
|
116
|
-
|
|
142
|
+
type: 'orama-cloud';
|
|
117
143
|
} & OramaCloudOptions) | ({
|
|
118
|
-
|
|
144
|
+
type: 'orama-cloud-legacy';
|
|
145
|
+
} & OramaCloudLegacyOptions) | ({
|
|
146
|
+
type: 'mixedbread';
|
|
119
147
|
} & MixedbreadOptions);
|
|
120
148
|
/**
|
|
121
149
|
* Provide a hook to query different official search clients.
|
|
@@ -123,18 +151,19 @@ type Client = ({
|
|
|
123
151
|
* Note: it will re-query when its parameters changed, make sure to use `useMemo()` on `clientOptions` or define `deps` array.
|
|
124
152
|
*/
|
|
125
153
|
declare function useDocsSearch(clientOptions: Client & {
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
154
|
+
/**
|
|
155
|
+
* The debounced delay for performing a search (in ms).
|
|
156
|
+
* .
|
|
157
|
+
* @defaultValue 100
|
|
158
|
+
*/
|
|
159
|
+
delayMs?: number;
|
|
160
|
+
/**
|
|
161
|
+
* still perform search even if query is empty.
|
|
162
|
+
*
|
|
163
|
+
* @defaultValue false
|
|
164
|
+
*/
|
|
165
|
+
allowEmpty?: boolean;
|
|
138
166
|
}, deps?: DependencyList): UseDocsSearch;
|
|
139
|
-
|
|
140
|
-
export { type AlgoliaOptions,
|
|
167
|
+
//#endregion
|
|
168
|
+
export { type AlgoliaOptions, Client, type FetchOptions, type OramaCloudOptions, type StaticOptions, useDocsSearch };
|
|
169
|
+
//# sourceMappingURL=client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
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/orama-cloud-legacy.ts","../../src/search/client/mixedbread.ts","../../src/search/client.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;;;;;UAEiB,YAAA;;;;;;;;;;;;;AAAjB;;;;;UCIiB,aAAA;;;;;;;mCAQkB,WAAW,QAAQ;;;;;;ADZtD;;;;;;UEEiB,cAAA;;UAEP;;;;;;+DAaH;aACM,eAAe;;AFlB5B;;;UGWiB,iBAAA;UACP;;;;;;;WAOC,QAAQ;;;;EHnBF,GAAA,CAAA,EAAA,MAAA;;;;ECIA,MAAA,CAAA,EAAA,MAAA;;;;UGOA,uBAAA;UACP;;;;;;;WAOC;;;;EJnBM,GAAA,CAAA,EAAA,MAAA;;;;ECIA,MAAA,CAAA,EAAA,MAAA;;;;UIAA,iBAAA;;;;;;;;UASP;;;;ELbO,GAAA,CAAA,EAAA,MAAA;;;;ECIA,MAAA,CAAA,EAAA,MAAA;;;;UKKP,aAAA;;;;;WAKC;INdM,KAAA,CAAA,EMeL,KNfiB;;;KMmBjB,MAAA;ELfK,IAAA,EAAA,OAAA;CAQkB,GKU3B,YLV2B,CAAA,GAAA,CAAA;EAAmB,IAAA,EAAA,QAAA;CAAR,GKatC,aLbsC,CAAA,GAAA,CAAA;EAAO,IAAA,EAAA,SAAA;IKgB7C;;IAGA;EJ7BS,IAAA,EAAA,oBAAc;CAErB,GI8BF,uBJ9BE,CAAA,GAAA,CAAA;EAckB,IAAA,EAAA,YAAA;CAAf,GImBL,iBJnBK,CAAA;;;;;;ACPI,iBGwDD,aAAA,CHxDkB,aAAA,EGyDjB,MHzDiB,GAAA;EACxB;;;;;;;ACDV;;;;ECPiB,UAAA,CAAA,EAAA,OAAiB;UC+EzB,iBACN"}
|