@hanzo/docs-core 16.5.0 → 16.5.3

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

@@ -0,0 +1,77 @@
+import "../transformer-icon-D7-6aFzt.js";
+import { StructuredData } from "../mdx-plugins/remark-structure.js";
+import "../mdx-plugins/index.js";
+import { CloudManager } from "@oramacloud/client";
+
+//#region src/search/orama-cloud-legacy.d.ts
+interface SyncOptions {
+  /**
+   * Index name to sync
+   */
+  index: string;
+  documents: OramaDocument[];
+  /**
+   * Deploy changes
+   *
+   * @defaultValue true
+   */
+  autoDeploy?: boolean;
+}
+interface I18nSyncOptions extends Omit<SyncOptions, 'index' | 'documents'> {
+  /**
+   * Indexes to sync.
+   *
+   * Pairs of `locale`-`index`.
+   **/
+  indexes: Record<string, string>;
+  documents: {
+    locale: string;
+    items: OramaDocument[];
+  }[];
+}
+interface OramaDocument {
+  /**
+   * The ID of document, must be unique
+   */
+  id: string;
+  title: string;
+  description?: 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;
+  breadcrumbs?: string[];
+}
+interface OramaIndex {
+  id: string;
+  title: string;
+  url: string;
+  tag?: string;
+  /**
+   * The id of page, used for `group by`
+   */
+  page_id: string;
+  /**
+   * Heading content
+   */
+  section?: string;
+  breadcrumbs?: string[];
+  /**
+   * Heading (anchor) id
+   */
+  section_id?: string;
+  content: string;
+}
+declare function sync(cloudManager: CloudManager, options: SyncOptions): Promise<void>;
+declare function syncI18n(cloudManager: CloudManager, options: I18nSyncOptions): Promise<void>;
+//#endregion
+export { I18nSyncOptions, OramaDocument, OramaIndex, SyncOptions, sync, syncI18n };

package/dist/search/orama-cloud-legacy.js

@@ -0,0 +1,49 @@
+//#region src/search/orama-cloud-legacy.ts
+async function sync(cloudManager, options) {
+	const { autoDeploy = true } = options;
+	const index = cloudManager.index(options.index);
+	await index.snapshot(options.documents.flatMap(toIndex));
+	if (autoDeploy) await index.deploy();
+}
+async function syncI18n(cloudManager, options) {
+	const { autoDeploy = true } = options;
+	const tasks = options.documents.map(async (document) => {
+		const index = cloudManager.index(options.indexes[document.locale]);
+		await index.snapshot(document.items.flatMap(toIndex));
+		if (autoDeploy) await index.deploy();
+	});
+	await Promise.all(tasks);
+}
+function toIndex(page) {
+	let id = 0;
+	const indexes = [];
+	const scannedHeadings = /* @__PURE__ */ new Set();
+	function createIndex(section, sectionId, content) {
+		return {
+			id: `${page.id}-${(id++).toString()}`,
+			title: page.title,
+			url: page.url,
+			page_id: page.id,
+			tag: page.tag,
+			section,
+			section_id: sectionId,
+			content,
+			breadcrumbs: page.breadcrumbs,
+			...page.extra_data
+		};
+	}
+	if (page.description) indexes.push(createIndex(void 0, void 0, page.description));
+	page.structured.contents.forEach((p) => {
+		const heading = p.heading ? page.structured.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;
+}
+
+//#endregion
+export { sync, syncI18n };

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

@@ -1,8 +1,5 @@
-import "../remark-gfm-CeWpMwyk.js";
-import "../rehype-code-vVWG4-ej.js";
-import { n as StructuredData } from "../remark-structure-DGuWR82i.js";
-import "../remark-heading-CXvCY0go.js";
-import "../remark-code-tab-CXsYlims.js";
+import "../transformer-icon-D7-6aFzt.js";
+import { StructuredData } from "../mdx-plugins/remark-structure.js";
 import "../mdx-plugins/index.js";
 import { OramaCloud } from "@orama/core";
 
@@ -20,7 +17,7 @@ interface SyncOptions {
    */
   autoDeploy?: boolean;
 }
-type I18nSyncOptions = Omit<SyncOptions, 'index' | 'documents'> & {
+interface I18nSyncOptions extends Omit<SyncOptions, 'index' | 'documents'> {
   /**
    * Indexes to sync.
    *
@@ -31,7 +28,7 @@ type I18nSyncOptions = Omit<SyncOptions, 'index' | 'documents'> & {
     locale: string;
     items: OramaDocument[];
   }[];
-};
+}
 interface OramaDocument {
   /**
    * The ID of document, must be unique
@@ -77,5 +74,4 @@ interface OramaIndex {
 declare function sync(orama: OramaCloud, options: SyncOptions): Promise<void>;
 declare function syncI18n(orama: OramaCloud, options: I18nSyncOptions): Promise<void>;
 //#endregion
-export { I18nSyncOptions, OramaDocument, OramaIndex, SyncOptions, sync, syncI18n };
-//# sourceMappingURL=orama-cloud.d.ts.map
+export { I18nSyncOptions, OramaDocument, OramaIndex, SyncOptions, sync, syncI18n };

package/dist/search/orama-cloud.js

@@ -48,5 +48,4 @@ function toIndex(page) {
 }
 
 //#endregion
-export { sync, syncI18n };
-//# sourceMappingURL=orama-cloud.js.map
+export { sync, syncI18n };

package/dist/search/server.d.ts

@@ -1,6 +1,89 @@
-import "../definitions-DuxDer_c.js";
-import "../remark-structure-DGuWR82i.js";
+import "../definitions-DSNTbAwC.js";
+import { StructuredData } from "../mdx-plugins/remark-structure.js";
+import "../utils-IgHyYnrz.js";
 import { HighlightedText, ReactSortedResult, SortedResult, createContentHighlighter } from "./index.js";
-import { a as Index, c as SimpleOptions, d as initSimpleSearch, f as createI18nSearchAPI, i as ExportedData, l as createSearchAPI, n as AdvancedOptions, o as SearchAPI, p as createFromSource, r as Dynamic, s as SearchServer, t as AdvancedIndex, u as initAdvancedSearch } from "../server-DmY4lGBs.js";
-import "../index-2U6Tl4--.js";
+import { a as advancedSchema, i as SimpleDocument, n as createFromSource, o as simpleSchema, r as AdvancedDocument, t as createI18nSearchAPI } from "../create-i18n-Cv3Cocbs.js";
+import "../path-B77y3W0_.js";
+import { Orama, RawData, SearchParams, create } from "@orama/orama";
+
+//#region src/search/server.d.ts
+type SearchType = 'simple' | 'advanced';
+type ExportedData = (RawData & {
+  type: SearchType;
+}) | {
+  type: 'i18n';
+  data: Record<string, RawData & {
+    type: SearchType;
+  }>;
+};
+interface SearchServer {
+  search: (query: string, options?: {
+    locale?: string;
+    tag?: string | string[];
+    mode?: 'vector' | 'full';
+  }) => Promise<SortedResult[]>;
+  /**
+   * Export the database
+   *
+   * You can reference the exported database to implement client-side search
+   */
+  export: () => Promise<ExportedData>;
+}
+interface SearchAPI extends SearchServer {
+  GET: (request: Request) => Promise<Response>;
+  /**
+   * `GET` route handler that exports search indexes for static search.
+   */
+  staticGET: () => Promise<Response>;
+}
+/**
+ * Resolve indexes dynamically
+ */
+type Dynamic<T> = () => T[] | Promise<T[]>;
+type OramaInput = Parameters<typeof create>[0];
+type SharedOptions = Pick<OramaInput, 'sort' | 'components' | 'plugins'> & {
+  language?: string;
+  tokenizer?: Required<OramaInput>['components']['tokenizer'];
+};
+interface SimpleOptions extends SharedOptions {
+  indexes: Index[] | Dynamic<Index>;
+  /**
+   * Customise search options on server
+   */
+  search?: Partial<SearchParams<Orama<typeof simpleSchema>, SimpleDocument>>;
+}
+interface AdvancedOptions extends SharedOptions {
+  indexes: AdvancedIndex[] | Dynamic<AdvancedIndex>;
+  /**
+   * Customise search options on server
+   */
+  search?: Partial<SearchParams<Orama<typeof advancedSchema>, AdvancedDocument>>;
+}
+declare function createSearchAPI<T extends SearchType>(type: T, options: T extends 'simple' ? SimpleOptions : AdvancedOptions): SearchAPI;
+interface Index {
+  title: string;
+  description?: string;
+  breadcrumbs?: string[];
+  content: string;
+  url: string;
+  keywords?: string;
+}
+declare function initSimpleSearch(options: SimpleOptions): SearchServer;
+interface AdvancedIndex {
+  id: string;
+  title: string;
+  description?: string;
+  breadcrumbs?: string[];
+  /**
+   * Required if tag filter is enabled
+   */
+  tag?: string | string[];
+  /**
+   * preprocess mdx content with `structure`
+   */
+  structuredData: StructuredData;
+  url: string;
+}
+declare function initAdvancedSearch(options: AdvancedOptions): SearchServer;
+//#endregion
 export { AdvancedIndex, AdvancedOptions, Dynamic, ExportedData, HighlightedText, Index, ReactSortedResult, SearchAPI, SearchServer, SimpleOptions, SortedResult, createContentHighlighter, createFromSource, createI18nSearchAPI, createSearchAPI, initAdvancedSearch, initSimpleSearch };

package/dist/search/server.js

@@ -1,12 +1,12 @@
-import { r as findPath } from "../utils-DUvi2WkD.js";
-import { t as createContentHighlighter } from "../search-D6ChCLhY.js";
-import { n as searchSimple, t as searchAdvanced } from "../advanced-BRT5Ij43.js";
-import { r as extname, t as basename } from "../path-DHIjrDBP.js";
+import { r as findPath } from "../utils-Bc53B3CJ.js";
+import { createContentHighlighter } from "./index.js";
+import { n as searchSimple, t as searchAdvanced } from "../advanced-BH0syJ-M.js";
+import { r as extname, t as basename } from "../path-D0Bwm6Fs.js";
 import { create, insertMultiple, save } from "@orama/orama";
 
 //#region src/search/orama/create-endpoint.ts
 function createEndpoint(server) {
-	const { search: search$1 } = server;
+	const { search } = server;
 	return {
 		...server,
 		async staticGET() {
@@ -16,7 +16,7 @@ function createEndpoint(server) {
 			const url = new URL(request.url);
 			const query = url.searchParams.get("query");
 			if (!query) return Response.json([]);
-			return Response.json(await search$1(query, {
+			return Response.json(await search(query, {
 				tag: url.searchParams.get("tag")?.split(",") ?? void 0,
 				locale: url.searchParams.get("locale") ?? void 0,
 				mode: url.searchParams.get("mode") === "vector" ? "vector" : "full"
@@ -319,5 +319,4 @@ function initAdvancedSearch(options) {
 }
 
 //#endregion
-export { createContentHighlighter, createFromSource, createI18nSearchAPI, createSearchAPI, initAdvancedSearch, initSimpleSearch };
-//# sourceMappingURL=server.js.map
+export { createContentHighlighter, createFromSource, createI18nSearchAPI, createSearchAPI, initAdvancedSearch, initSimpleSearch };

package/dist/source/client/index.d.ts

@@ -1,18 +1,20 @@
-import { i as Root } from "../../definitions-DuxDer_c.js";
+import { i as Root } from "../../definitions-DSNTbAwC.js";
+import "../../utils-IgHyYnrz.js";
 import "../../page-tree/index.js";
 
 //#region src/source/client/index.d.ts
-declare function deserializePageTree(root: Root): Root;
+interface SerializedPageTree {
+  $hanzo_docs_loader: 'page-tree';
+  data: object;
+}
+type Serialized<Data> = { [K in keyof Data]: Data[K] extends SerializedPageTree ? Root : Data[K] };
+declare function deserializePageTree(serialized: SerializedPageTree): Root;
 /**
- * Deserialize data passed from server-side loader.
+ * Deserialize loader data that is serialized by the server-side Hanzo Docs `loader()`, supported:
+ * - Page Tree
  *
- * It only receives the serialized data from server-side, hence not sharing plugins and some properties.
+ * other unrelated properties are kept in the output.
  */
-declare function useDocsLoader<V extends {
-  pageTree?: object;
-}>(serialized: V): {
-  pageTree: V["pageTree"] extends object ? Root : undefined;
-};
+declare function useHanzoDocsLoader<V>(serialized: V): Serialized<V>;
 //#endregion
-export { deserializePageTree, useDocsLoader };
-//# sourceMappingURL=index.d.ts.map
+export { Serialized, SerializedPageTree, deserializePageTree, useHanzoDocsLoader };

package/dist/source/client/index.js

@@ -1,12 +1,13 @@
-import { c as visit } from "../../utils-DUvi2WkD.js";
+import { c as visit } from "../../utils-Bc53B3CJ.js";
 import { useMemo } from "react";
 import { jsx } from "react/jsx-runtime";
 
 //#region src/source/client/index.tsx
-function deserializePageTree(root) {
-	function deserializeHTML(html) {
-		return /* @__PURE__ */ jsx("span", { dangerouslySetInnerHTML: { __html: html } });
-	}
+function deserializeHTML(html) {
+	return /* @__PURE__ */ jsx("span", { dangerouslySetInnerHTML: { __html: html } });
+}
+function deserializePageTree(serialized) {
+	const root = serialized.data;
 	visit(root, (item) => {
 		if ("icon" in item && typeof item.icon === "string") item.icon = deserializeHTML(item.icon);
 		if (typeof item.name === "string") item.name = deserializeHTML(item.name);
@@ -14,17 +15,25 @@ function deserializePageTree(root) {
 	return root;
 }
 /**
-* Deserialize data passed from server-side loader.
+* Deserialize loader data that is serialized by the server-side Hanzo Docs `loader()`, supported:
+* - Page Tree
 *
-* It only receives the serialized data from server-side, hence not sharing plugins and some properties.
+* other unrelated properties are kept in the output.
 */
-function useDocsLoader(serialized) {
-	const { pageTree } = serialized;
+function useHanzoDocsLoader(serialized) {
 	return useMemo(() => {
-		return { pageTree: pageTree ? deserializePageTree(pageTree) : void 0 };
-	}, [pageTree]);
+		const out = {};
+		for (const k in serialized) {
+			const v = serialized[k];
+			if (isSerializedPageTree(v)) out[k] = deserializePageTree(v);
+			else out[k] = v;
+		}
+		return out;
+	}, [serialized]);
+}
+function isSerializedPageTree(v) {
+	return typeof v === "object" && v !== null && "$hanzo_docs_loader" in v && v.$hanzo_docs_loader === "page-tree";
 }
 
 //#endregion
-export { deserializePageTree, useDocsLoader };
-//# sourceMappingURL=index.js.map
+export { deserializePageTree, useHanzoDocsLoader };

package/dist/source/index.d.ts

@@ -1,3 +1,5 @@
-import "../definitions-DuxDer_c.js";
-import { A as PageData, C as ContentStorage, D as buildContentStorage, E as ContentStoragePageFile, F as multiple, I as source, L as update, M as SourceConfig, N as VirtualFile, O as FileSystem, P as _ConfigUnion_, S as createPageTreeBuilder, T as ContentStorageMetaFile, a as LoaderOptions, b as PageTreeOptions, c as LoaderPluginOption, d as ResolvedLoaderConfig, f as createGetUrl, h as getSlugs, i as LoaderConfig, j as Source, k as MetaData, l as Meta, n as InferMetaType, o as LoaderOutput, p as loader, r as InferPageType, s as LoaderPlugin, t as path_d_exports, u as Page, v as PageTreeBuilder, w as ContentStorageFile, x as PageTreeTransformer, y as PageTreeBuilderContext } from "../index-2U6Tl4--.js";
-export { ContentStorage, ContentStorageFile, ContentStorageMetaFile, ContentStoragePageFile, FileSystem, InferMetaType, InferPageType, LoaderConfig, LoaderOptions, LoaderOutput, LoaderPlugin, LoaderPluginOption, Meta, MetaData, Page, PageData, PageTreeBuilder, PageTreeBuilderContext, PageTreeOptions, PageTreeTransformer, path_d_exports as PathUtils, ResolvedLoaderConfig, Source, SourceConfig, VirtualFile, _ConfigUnion_, buildContentStorage, createGetUrl, createPageTreeBuilder, getSlugs, loader, multiple, source, update };
+import "../definitions-DSNTbAwC.js";
+import "../utils-IgHyYnrz.js";
+import { A as _SourceUpdate_, C as FileSystem, D as SourceConfig, E as Source, M as source, N as update, O as VirtualFile, S as createContentStorageBuilder, T as PageData, _ as PageTreeTransformer, a as LoaderOptions, b as ContentStorageMetaFile, c as LoaderPluginOption, d as ResolvedLoaderConfig, f as createGetUrl, g as PageTreeOptions, h as PageTreeBuilderContext, i as LoaderConfig, j as multiple, k as _ConfigUnion_, l as Meta, m as PageTreeBuilder, n as InferMetaType, o as LoaderOutput, p as loader, r as InferPageType, s as LoaderPlugin, t as path_d_exports, u as Page, v as ContentStorage, w as MetaData, x as ContentStoragePageFile, y as ContentStorageFile } from "../path-B77y3W0_.js";
+import { getSlugs } from "./plugins/slugs.js";
+export { ContentStorage, ContentStorageFile, ContentStorageMetaFile, ContentStoragePageFile, FileSystem, InferMetaType, InferPageType, LoaderConfig, LoaderOptions, LoaderOutput, LoaderPlugin, LoaderPluginOption, Meta, MetaData, Page, PageData, type PageTreeBuilder, type PageTreeBuilderContext, type PageTreeOptions, type PageTreeTransformer, path_d_exports as PathUtils, ResolvedLoaderConfig, Source, SourceConfig, VirtualFile, _ConfigUnion_, _SourceUpdate_, createContentStorageBuilder, createGetUrl, getSlugs, loader, multiple, source, update };