@hanzo/docs-core 16.5.0 → 16.5.3

package/dist/source/plugins/lucide-icons.d.ts

@@ -1,5 +1,7 @@
-import "../../definitions-DuxDer_c.js";
-import { s as LoaderPlugin } from "../../index-2U6Tl4--.js";
+import "../../definitions-DSNTbAwC.js";
+import "../../utils-IgHyYnrz.js";
+import { s as LoaderPlugin } from "../../path-B77y3W0_.js";
+import "../index.js";
 import { icons } from "lucide-react";
 
 //#region src/source/plugins/lucide-icons.d.ts
@@ -10,5 +12,4 @@ declare function lucideIconsPlugin(options?: {
   defaultIcon?: keyof typeof icons;
 }): LoaderPlugin;
 //#endregion
-export { lucideIconsPlugin };
-//# sourceMappingURL=lucide-icons.d.ts.map
+export { lucideIconsPlugin };

package/dist/source/plugins/lucide-icons.js

@@ -1,4 +1,4 @@
-import { t as iconPlugin } from "../../icon-BWwSDabM.js";
+import { t as iconPlugin } from "../../icon-OtPFhyk1.js";
 import { createElement } from "react";
 import { icons } from "lucide-react";
 
@@ -20,5 +20,4 @@ function lucideIconsPlugin(options = {}) {
 }
 
 //#endregion
-export { lucideIconsPlugin };
-//# sourceMappingURL=lucide-icons.js.map
+export { lucideIconsPlugin };

package/dist/source/plugins/slugs.d.ts

@@ -1,3 +1,25 @@
-import "../../definitions-DuxDer_c.js";
-import { _ as slugsPlugin, g as slugsFromData, h as getSlugs, m as SlugFn } from "../../index-2U6Tl4--.js";
+import "../../definitions-DSNTbAwC.js";
+import "../../utils-IgHyYnrz.js";
+import { i as LoaderConfig, s as LoaderPlugin, x as ContentStoragePageFile } from "../../path-B77y3W0_.js";
+
+//#region src/source/plugins/slugs.d.ts
+/**
+ * a function to generate slugs, return `undefined` to fallback to default generation.
+ */
+type SlugFn<Config extends LoaderConfig = LoaderConfig> = (file: ContentStoragePageFile<Config['source']>) => string[] | undefined;
+/**
+ * Generate slugs for pages if missing
+ */
+declare function slugsPlugin<Config extends LoaderConfig = LoaderConfig>(slugFn?: SlugFn<Config>): LoaderPlugin<Config>;
+/**
+ * Generate slugs from file data (e.g. frontmatter).
+ *
+ * @param key - the property name in file data to generate slugs, default to `slug`.
+ */
+declare function slugsFromData<Config extends LoaderConfig = LoaderConfig>(key?: string): SlugFn<Config>;
+/**
+ * Convert file path into slugs, also encode non-ASCII characters, so they can work in pathname
+ */
+declare function getSlugs(file: string): string[];
+//#endregion
 export { SlugFn, getSlugs, slugsFromData, slugsPlugin };

package/dist/source/plugins/slugs.js

@@ -1,4 +1,4 @@
-import { n as dirname, r as extname, t as basename } from "../../path-DHIjrDBP.js";
+import { n as dirname, r as extname, t as basename } from "../../path-D0Bwm6Fs.js";
 
 //#region src/source/plugins/slugs.ts
 /**
@@ -61,5 +61,4 @@ function getSlugs(file) {
 }
 
 //#endregion
-export { getSlugs, slugsFromData, slugsPlugin };
-//# sourceMappingURL=slugs.js.map
+export { getSlugs, slugsFromData, slugsPlugin };

package/dist/source/plugins/status-badges.d.ts

@@ -0,0 +1,52 @@
+import { a as Separator$1, n as Item$1, t as Folder$1 } from "../../definitions-DSNTbAwC.js";
+import "../../utils-IgHyYnrz.js";
+import { s as LoaderPlugin } from "../../path-B77y3W0_.js";
+import { ReactNode } from "react";
+
+//#region src/source/plugins/status-badges.d.ts
+interface Item extends Item$1 {
+  /**
+   * Status badge to display in the sidebar (e.g., "new", "beta", "deprecated", "experimental").
+   */
+  status?: string;
+}
+interface Folder extends Omit<Folder$1, 'children' | 'index'> {
+  index?: Item;
+  children: Node[];
+}
+type Separator = Separator$1;
+type Node = Item | Folder | Separator;
+/**
+ * Plugin to add status badges to pages in the sidebar.
+ *
+ * This reads the `status` field from page frontmatter and adds it to the page tree item.
+ * Define the `renderBadge` option to render it.
+ *
+ * @example
+ * ```tsx
+ * import { loader } from '@hanzo/docs-core/source';
+ * import { statusBadgesPlugin } from '@hanzo/docs-core/source/status-badges';
+ *
+ * export const source = loader({
+ *   plugins: [
+ *     statusBadgesPlugin({
+ *       renderBadge: (status) => <span>{status}</span>,
+ *     }),
+ *   ],
+ *   // ...
+ * });
+ * ```
+ *
+ * Then in your frontmatter:
+ * ```yaml
+ * ---
+ * title: My Page
+ * status: new
+ * ---
+ * ```
+ */
+declare function statusBadgesPlugin(options?: {
+  renderBadge?: (status: string) => ReactNode;
+}): LoaderPlugin;
+//#endregion
+export { Folder, Item, Node, Separator, statusBadgesPlugin };

package/dist/source/plugins/status-badges.js

@@ -0,0 +1,54 @@
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+
+//#region src/source/plugins/status-badges.tsx
+/**
+* Plugin to add status badges to pages in the sidebar.
+*
+* This reads the `status` field from page frontmatter and adds it to the page tree item.
+* Define the `renderBadge` option to render it.
+*
+* @example
+* ```tsx
+* import { loader } from '@hanzo/docs-core/source';
+* import { statusBadgesPlugin } from '@hanzo/docs-core/source/status-badges';
+*
+* export const source = loader({
+*   plugins: [
+*     statusBadgesPlugin({
+*       renderBadge: (status) => <span>{status}</span>,
+*     }),
+*   ],
+*   // ...
+* });
+* ```
+*
+* Then in your frontmatter:
+* ```yaml
+* ---
+* title: My Page
+* status: new
+* ---
+* ```
+*/
+function statusBadgesPlugin(options = {}) {
+	const { renderBadge = (status) => /* @__PURE__ */ jsx("span", {
+		"data-status": status,
+		children: status
+	}) } = options;
+	return {
+		name: "hanzo-docs:status-badges",
+		transformPageTree: { file(node, filePath) {
+			if (!filePath) return node;
+			const file = this.storage.read(filePath);
+			if (file?.format === "page" && "status" in file.data && typeof file.data.status === "string") {
+				const status = file.data.status;
+				node.name = /* @__PURE__ */ jsxs(Fragment, { children: [node.name, renderBadge(status)] });
+				node.status = status;
+			}
+			return node;
+		} }
+	};
+}
+
+//#endregion
+export { statusBadgesPlugin };

package/dist/source/schema.d.ts

@@ -1,7 +1,6 @@
 import { z } from "zod";
 
 //#region src/source/schema.d.ts
-
 /**
  * Zod 4 schema
  */
@@ -25,5 +24,4 @@ declare const pageSchema: z.ZodObject<{
   _openapi: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
 }, z.core.$strip>;
 //#endregion
-export { metaSchema, pageSchema };
-//# sourceMappingURL=schema.d.ts.map
+export { metaSchema, pageSchema };

package/dist/source/schema.js

@@ -25,5 +25,4 @@ const pageSchema = z.object({
 });
 
 //#endregion
-export { metaSchema, pageSchema };
-//# sourceMappingURL=schema.js.map
+export { metaSchema, pageSchema };

package/dist/{static-Dq8pA8Ay.js → static-DTxK4eHk.js}

@@ -1,4 +1,4 @@
-import { n as searchSimple, t as searchAdvanced } from "./advanced-BRT5Ij43.js";
+import { n as searchSimple, t as searchAdvanced } from "./advanced-BH0syJ-M.js";
 import { create, load } from "@orama/orama";
 
 //#region src/search/client/static.ts
@@ -17,11 +17,11 @@ async function loadDB({ from = "/api/search", initOrama = (locale) => create({
 		const dbs = /* @__PURE__ */ new Map();
 		if (data.type === "i18n") {
 			await Promise.all(Object.entries(data.data).map(async ([k, v]) => {
-				const db$1 = await initOrama(k);
-				load(db$1, v);
+				const db = await initOrama(k);
+				load(db, v);
 				dbs.set(k, {
 					type: v.type,
-					db: db$1
+					db
 				});
 			}));
 			return dbs;
@@ -47,5 +47,4 @@ async function search(query, options) {
 }
 
 //#endregion
-export { search };
-//# sourceMappingURL=static-Dq8pA8Ay.js.map
+export { search };

package/dist/toc.d.ts

@@ -52,5 +52,4 @@ declare function TOCItem({
   ...props
 }: TOCItemProps): react_jsx_runtime0.JSX.Element;
 //#endregion
-export { AnchorProvider, AnchorProviderProps, ScrollProvider, ScrollProviderProps, TOCItem, TOCItemProps, TOCItemType, TableOfContents, useActiveAnchor, useActiveAnchors };
-//# sourceMappingURL=toc.d.ts.map
+export { AnchorProvider, AnchorProviderProps, ScrollProvider, ScrollProviderProps, TOCItem, TOCItemProps, TOCItemType, TableOfContents, useActiveAnchor, useActiveAnchors };

package/dist/toc.js

@@ -134,5 +134,4 @@ function useAnchorObserver(watch, single) {
 }
 
 //#endregion
-export { AnchorProvider, ScrollProvider, TOCItem, useActiveAnchor, useActiveAnchors };
-//# sourceMappingURL=toc.js.map
+export { AnchorProvider, ScrollProvider, TOCItem, useActiveAnchor, useActiveAnchors };

package/dist/{rehype-code-sM9Tq-r7.js → transformer-icon-BYedaeE8.js}

@@ -1,9 +1,3 @@
-import { n as getHighlighter, t as defaultThemes } from "./shiki-B5wNmyIZ.js";
-import { parseCodeBlockAttributes } from "./mdx-plugins/codeblock-utils.js";
-import rehypeShikiFromHighlighter from "@shikijs/rehype/core";
-import { transformerNotationDiff, transformerNotationFocus, transformerNotationHighlight, transformerNotationWordHighlight } from "@shikijs/transformers";
-import { bundledLanguages } from "shiki";
-
 //#region src/mdx-plugins/transformer-icon.ts
 const defaultShortcuts = {
 	js: "javascript",
@@ -149,93 +143,4 @@ function transformerIcon(options = {}) {
 }
 
 //#endregion
-//#region src/mdx-plugins/rehype-code.ts
-const rehypeCodeDefaultOptions = {
-	lazy: true,
-	themes: defaultThemes,
-	defaultColor: false,
-	defaultLanguage: "plaintext",
-	engine: "js",
-	transformers: [
-		transformerNotationHighlight({ matchAlgorithm: "v3" }),
-		transformerNotationWordHighlight({ matchAlgorithm: "v3" }),
-		transformerNotationDiff({ matchAlgorithm: "v3" }),
-		transformerNotationFocus({ matchAlgorithm: "v3" })
-	],
-	parseMetaString(meta) {
-		const parsed = parseCodeBlockAttributes(meta, ["title", "tab"]);
-		const data = parsed.attributes;
-		parsed.rest = parseLineNumber(parsed.rest, data);
-		data.__parsed_raw = parsed.rest;
-		return data;
-	}
-};
-function parseLineNumber(str, data) {
-	return str.replace(/lineNumbers=(\d+)|lineNumbers/, (_, ...args) => {
-		data["data-line-numbers"] = true;
-		if (args[0] !== void 0) data["data-line-numbers-start"] = Number(args[0]);
-		return "";
-	});
-}
-/**
-* Handle codeblocks
-*/
-function rehypeCode(_options = {}) {
-	const options = {
-		...rehypeCodeDefaultOptions,
-		..._options
-	};
-	const transformers = [...options.transformers ?? []];
-	transformers.unshift({
-		name: "rehype-code:pre-process",
-		preprocess(code, { meta }) {
-			if (meta && "__parsed_raw" in meta) {
-				meta.__raw = meta.__parsed_raw;
-				delete meta.__parsed_raw;
-			}
-			if (meta && options.filterMetaString) meta.__raw = options.filterMetaString(meta.__raw ?? "");
-			return code.replace(/\n$/, "");
-		}
-	});
-	if (options.icon !== false) transformers.push(transformerIcon(options.icon));
-	if (options.tab !== false) transformers.push(transformerTab());
-	const transformer = getHighlighter(options.engine ?? "js", {
-		themes: "themes" in options ? Object.values(options.themes).filter(Boolean) : [options.theme],
-		langs: options.langs ?? (options.lazy ? ["ts", "tsx"] : Object.keys(bundledLanguages)),
-		langAlias: options.langAlias
-	}).then((loaded) => rehypeShikiFromHighlighter(loaded, {
-		...options,
-		transformers
-	}));
-	return async (tree, file) => {
-		await (await transformer)(tree, file, () => {});
-	};
-}
-function transformerTab() {
-	return {
-		name: "rehype-code:tab",
-		root(root) {
-			const value = this.options.meta?.tab;
-			if (typeof value !== "string") return root;
-			console.warn("[Hanzo Docs] For `tab=\"value\" in codeblocks, please use `remarkCodeTab` plugin instead.");
-			return {
-				type: "root",
-				children: [{
-					type: "mdxJsxFlowElement",
-					name: "Tab",
-					data: { _codeblock: true },
-					attributes: [{
-						type: "mdxJsxAttribute",
-						name: "value",
-						value
-					}],
-					children: root.children
-				}]
-			};
-		}
-	};
-}
-
-//#endregion
-export { transformerIcon as i, rehypeCodeDefaultOptions as n, transformerTab as r, rehypeCode as t };
-//# sourceMappingURL=rehype-code-sM9Tq-r7.js.map
+export { transformerIcon as t };

package/dist/transformer-icon-D7-6aFzt.d.ts

@@ -0,0 +1,18 @@
+import { ShikiTransformer } from "shiki";
+
+//#region src/mdx-plugins/transformer-icon.d.ts
+type CodeBlockIcon = {
+  viewBox: string;
+  fill: string;
+  d: string;
+} | string;
+interface IconOptions {
+  shortcuts?: Record<string, string>;
+  extend?: Record<string, CodeBlockIcon>;
+}
+/**
+ * Inject icons to `icon` property (as HTML)
+ */
+declare function transformerIcon(options?: IconOptions): ShikiTransformer;
+//#endregion
+export { IconOptions as n, transformerIcon as r, CodeBlockIcon as t };

package/dist/types-BSnJn7kF.d.ts

@@ -0,0 +1,6 @@
+//#region src/types.d.ts
+type DistributiveOmit<T, K extends PropertyKey> = T extends unknown ? Omit<T, K> : never;
+type Awaitable<T> = T | PromiseLike<T>;
+type MakeOptional<T, K extends keyof T> = T extends unknown ? Partial<Pick<T, K>> & Omit<T, K> : never;
+//#endregion
+export { DistributiveOmit as n, MakeOptional as r, Awaitable as t };

package/dist/{util-CK2ykiif.d.ts → util-C60LmklF.d.ts}

@@ -4,5 +4,4 @@ import { Pluggable } from "unified";
 type Thenable<T> = T | PromiseLike<T>;
 type ResolvePlugins = Thenable<Pluggable>[] | ((v: Pluggable[]) => Thenable<Pluggable>[]);
 //#endregion
-export { ResolvePlugins as t };
-//# sourceMappingURL=util-CK2ykiif.d.ts.map
+export { ResolvePlugins as t };

package/dist/{util-s9piKHsk.js → util-De0ALHOx.js}

@@ -6,5 +6,4 @@ async function resolvePlugins(def, options = []) {
 }
 
 //#endregion
-export { resolvePlugins as t };
-//# sourceMappingURL=util-s9piKHsk.js.map
+export { resolvePlugins as t };

package/dist/utils/use-media-query.d.ts

@@ -1,5 +1,4 @@
 //#region src/utils/use-media-query.d.ts
 declare function useMediaQuery(query: string, disabled?: boolean): boolean | null;
 //#endregion
-export { useMediaQuery };
-//# sourceMappingURL=use-media-query.d.ts.map
+export { useMediaQuery };

package/dist/utils/use-media-query.js

@@ -19,5 +19,4 @@ function useMediaQuery(query, disabled = false) {
 }
 
 //#endregion
-export { useMediaQuery };
-//# sourceMappingURL=use-media-query.js.map
+export { useMediaQuery };

package/dist/utils/use-on-change.d.ts

@@ -6,5 +6,4 @@
  */
 declare function useOnChange<T>(value: T, onChange: (current: T, previous: T) => void, isUpdated?: (prev: T, current: T) => boolean): void;
 //#endregion
-export { useOnChange };
-//# sourceMappingURL=use-on-change.d.ts.map
+export { useOnChange };

package/dist/utils/use-on-change.js

@@ -19,5 +19,4 @@ function useOnChange(value, onChange, isUpdated = isDifferent) {
 }
 
 //#endregion
-export { useOnChange };
-//# sourceMappingURL=use-on-change.js.map
+export { useOnChange };

package/dist/{utils-DUvi2WkD.js → utils-Bc53B3CJ.js}

@@ -39,7 +39,9 @@ function getPageTreeRoots(pageTree) {
 	return result;
 }
 /**
-* Get other item nodes that lives under the same parent.
+* Get other **page** nodes that lives under the same parent.
+*
+* note: folders & its index nodes are not considered, use `findSiblings()` for more control.
 */
 function getPageTreePeers(treeOrTrees, url) {
 	return findSiblings(treeOrTrees, url).filter((item) => item.type === "page");
@@ -54,8 +56,8 @@ function findSiblings(treeOrTrees, url) {
 		return parent.children.filter((item) => item.type !== "page" || item.url !== url);
 	}
 	for (const lang in treeOrTrees) {
-		const result = getPageTreePeers(treeOrTrees[lang], url);
-		if (result) return result;
+		const result = findSiblings(treeOrTrees[lang], url);
+		if (result.length > 0) return result;
 	}
 	return [];
 }
@@ -76,9 +78,9 @@ function findParent(from, url) {
 */
 function findPath(nodes, matcher, options = {}) {
 	const { includeSeparator = true } = options;
-	function run(nodes$1) {
+	function run(nodes) {
 		let separator;
-		for (const node of nodes$1) {
+		for (const node of nodes) {
 			if (matcher(node)) {
 				const items = [];
 				if (separator) items.push(separator);
@@ -130,5 +132,4 @@ function visit(root, visitor) {
 }
 
 //#endregion
-export { flattenTree as a, visit as c, findSiblings as i, findParent as n, getPageTreePeers as o, findPath as r, getPageTreeRoots as s, findNeighbour as t };
-//# sourceMappingURL=utils-DUvi2WkD.js.map
+export { flattenTree as a, visit as c, findSiblings as i, findParent as n, getPageTreePeers as o, findPath as r, getPageTreeRoots as s, findNeighbour as t };

package/dist/utils-IgHyYnrz.d.ts

@@ -0,0 +1,45 @@
+import { i as Root, n as Item, r as Node, t as Folder } from "./definitions-DSNTbAwC.js";
+
+//#region src/page-tree/utils.d.ts
+/**
+ * Flatten tree to an array of page nodes
+ */
+declare function flattenTree(nodes: Node[]): Item[];
+/**
+ * Get neighbours of a page, useful for implementing "previous & next" buttons
+ */
+declare function findNeighbour(tree: Root, url: string, options?: {
+  separateRoot?: boolean;
+}): {
+  previous?: Item;
+  next?: Item;
+};
+declare function getPageTreeRoots(pageTree: Root | Folder): (Root | Folder)[];
+/**
+ * Get other **page** nodes that lives under the same parent.
+ *
+ * note: folders & its index nodes are not considered, use `findSiblings()` for more control.
+ */
+declare function getPageTreePeers(treeOrTrees: Root | Record<string, Root>, url: string): Item[];
+/**
+ * Get other tree nodes that lives under the same parent.
+ */
+declare function findSiblings(treeOrTrees: Root | Record<string, Root>, url: string): Node[];
+declare function findParent(from: Root | Folder, url: string): Root | Folder | undefined;
+/**
+ * Search the path of a node in the tree matched by the matcher.
+ *
+ * @returns The path to the target node (from starting root), or null if the page doesn't exist
+ */
+declare function findPath(nodes: Node[], matcher: (node: Node) => boolean, options?: {
+  includeSeparator?: boolean;
+}): Node[] | null;
+/**
+ * Perform a depth-first search on page tree visiting every node.
+ *
+ * @param root - the root of page tree to visit.
+ * @param visitor - function to receive nodes, return `skip` to skip the children of current node, `break` to stop the search entirely.
+ */
+declare function visit<Root$1 extends Node | Root>(root: Root$1, visitor: <T extends Node | Root>(node: T, parent?: Root | Folder) => 'skip' | 'break' | T | void): Root$1;
+//#endregion
+export { flattenTree as a, visit as c, findSiblings as i, findParent as n, getPageTreePeers as o, findPath as r, getPageTreeRoots as s, findNeighbour as t };