@farming-labs/docs 0.1.1-beta.4 → 0.1.1

package/dist/index.d.mts

@@ -0,0 +1,100 @@
+import { A as SidebarConfig, C as OpenGraphImage, D as PageOpenGraph, E as PageFrontmatter, F as ThemeToggleConfig, I as TypographyConfig, L as UIConfig, M as SidebarNode, N as SidebarPageNode, O as PageTwitter, P as SidebarTree, S as OpenDocsProvider, T as PageActionsConfig, _ as GithubConfig, a as CopyMarkdownConfig, b as OGConfig, c as DocsFeedbackValue, d as DocsMcpToolsConfig, f as DocsMetadata, g as FontStyle, h as FeedbackConfig, i as CodeBlockCopyData, j as SidebarFolderNode, k as SidebarComponentProps, l as DocsI18nConfig, m as DocsTheme, n as ApiReferenceConfig, o as DocsConfig, p as DocsNav, r as BreadcrumbConfig, s as DocsFeedbackData, t as AIConfig, u as DocsMcpConfig, v as LastUpdatedConfig, w as OrderingItem, x as OpenDocsConfig, y as LlmsTxtConfig } from "./types-Bd3kyFF1.mjs";
+
+//#region src/define-docs.d.ts
+/**
+ * Define docs configuration. Validates and returns the config.
+ */
+declare function defineDocs(config: DocsConfig): DocsConfig;
+//#endregion
+//#region src/utils.d.ts
+/**
+ * Deep merge utility for theme overrides.
+ * Merges objects recursively; later values override earlier ones.
+ */
+declare function deepMerge<T extends Record<string, unknown>>(target: T, ...sources: Partial<T>[]): T;
+//#endregion
+//#region src/create-theme.d.ts
+/**
+ * Create a theme preset factory.
+ *
+ * Returns a function that accepts optional overrides and deep-merges them
+ * with the base theme defaults. This is the same pattern used by the
+ * built-in `fumadocs()`, `darksharp()`, and `pixelBorder()` presets.
+ *
+ * @param baseTheme - The default theme configuration
+ * @returns A factory function `(overrides?) => DocsTheme`
+ *
+ * @example
+ * ```ts
+ * import { createTheme } from "@farming-labs/docs";
+ *
+ * export const myTheme = createTheme({
+ *   name: "my-theme",
+ *   ui: {
+ *     colors: { primary: "#6366f1" },
+ *     layout: { contentWidth: 800 },
+ *   },
+ * });
+ * ```
+ */
+declare function createTheme(baseTheme: DocsTheme): (overrides?: Partial<DocsTheme>) => DocsTheme;
+/**
+ * Extend an existing theme preset with additional defaults.
+ *
+ * Useful when you want to build on top of an existing theme (e.g. fumadocs)
+ * rather than starting from scratch.
+ *
+ * @example
+ * ```ts
+ * import { extendTheme } from "@farming-labs/docs";
+ * import { fumadocs } from "@farming-labs/theme/default";
+ *
+ * // Start with fumadocs defaults, override some values
+ * export const myTheme = extendTheme(fumadocs(), {
+ *   name: "my-custom-fumadocs",
+ *   ui: { colors: { primary: "#22c55e" } },
+ * });
+ * ```
+ */
+declare function extendTheme(baseTheme: DocsTheme, extensions: Partial<DocsTheme>): DocsTheme;
+//#endregion
+//#region src/i18n.d.ts
+interface ResolvedDocsI18n {
+  locales: string[];
+  defaultLocale: string;
+}
+interface DocsPathMatch {
+  /** Slug path relative to the docs root (no leading slash). */
+  slug: string;
+  /** Entry path used for URLs (no locale segment). */
+  entryPath: string;
+}
+declare function resolveDocsI18n(config?: DocsI18nConfig | null): ResolvedDocsI18n | null;
+declare function resolveDocsLocale(searchParams: URLSearchParams, i18n?: ResolvedDocsI18n | null): string | undefined;
+declare function resolveDocsPath(pathname: string, entry: string): DocsPathMatch;
+//#endregion
+//#region src/metadata.d.ts
+/**
+ * Resolve page title using metadata titleTemplate.
+ * %s is replaced with page title.
+ */
+declare function resolveTitle(pageTitle: string, metadata?: DocsMetadata): string;
+/**
+ * Resolve OG image URL for a page.
+ * Prefers page.openGraph.images[0], then page.ogImage, then config endpoint/default.
+ */
+declare function resolveOGImage(page: PageFrontmatter, ogConfig?: OGConfig, baseUrl?: string): string | undefined;
+/**
+ * Build the Open Graph metadata object for a page.
+ * When the page has openGraph in frontmatter, uses it (with title/description filled from page if omitted).
+ * Otherwise uses ogImage or config (dynamic endpoint / defaultImage).
+ */
+declare function buildPageOpenGraph(page: Pick<PageFrontmatter, "title" | "description" | "ogImage" | "openGraph">, ogConfig?: OGConfig, baseUrl?: string): PageOpenGraph | undefined;
+/**
+ * Build the Twitter card metadata object for a page.
+ * When the page has twitter in frontmatter, uses it.
+ * Otherwise builds from ogImage or config (dynamic endpoint).
+ */
+declare function buildPageTwitter(page: Pick<PageFrontmatter, "title" | "description" | "ogImage" | "openGraph" | "twitter">, ogConfig?: OGConfig, baseUrl?: string): PageTwitter | undefined;
+//#endregion
+export { type AIConfig, type ApiReferenceConfig, type BreadcrumbConfig, type CodeBlockCopyData, type CopyMarkdownConfig, type DocsConfig, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsMcpConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsPathMatch, type DocsTheme, type FeedbackConfig, type FontStyle, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageTwitter, type ResolvedDocsI18n, type SidebarComponentProps, type SidebarConfig, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type ThemeToggleConfig, type TypographyConfig, type UIConfig, buildPageOpenGraph, buildPageTwitter, createTheme, deepMerge, defineDocs, extendTheme, resolveDocsI18n, resolveDocsLocale, resolveDocsPath, resolveOGImage, resolveTitle };

package/dist/index.mjs

@@ -0,0 +1,227 @@
+//#region src/define-docs.ts
+/**
+* Define docs configuration. Validates and returns the config.
+*/
+function defineDocs(config) {
+	return {
+		entry: config.entry ?? "docs",
+		contentDir: config.contentDir,
+		i18n: config.i18n,
+		theme: config.theme,
+		nav: config.nav,
+		github: config.github,
+		themeToggle: config.themeToggle,
+		breadcrumb: config.breadcrumb,
+		sidebar: config.sidebar,
+		components: config.components,
+		onCopyClick: config.onCopyClick,
+		feedback: config.feedback,
+		mcp: config.mcp,
+		icons: config.icons,
+		pageActions: config.pageActions,
+		lastUpdated: config.lastUpdated,
+		llmsTxt: config.llmsTxt,
+		ai: config.ai,
+		ordering: config.ordering,
+		metadata: config.metadata,
+		og: config.og,
+		apiReference: config.apiReference
+	};
+}
+
+//#endregion
+//#region src/utils.ts
+/**
+* Deep merge utility for theme overrides.
+* Merges objects recursively; later values override earlier ones.
+*/
+function deepMerge(target, ...sources) {
+	if (!sources.length) return target;
+	const source = sources.shift();
+	if (!source) return target;
+	const result = { ...target };
+	for (const key of Object.keys(source)) {
+		const sourceVal = source[key];
+		const targetVal = result[key];
+		if (sourceVal && typeof sourceVal === "object" && !Array.isArray(sourceVal) && targetVal && typeof targetVal === "object" && !Array.isArray(targetVal)) result[key] = deepMerge(targetVal, sourceVal);
+		else if (sourceVal !== void 0) result[key] = sourceVal;
+	}
+	if (sources.length) return deepMerge(result, ...sources);
+	return result;
+}
+
+//#endregion
+//#region src/create-theme.ts
+/**
+* Create a theme preset factory.
+*
+* Returns a function that accepts optional overrides and deep-merges them
+* with the base theme defaults. This is the same pattern used by the
+* built-in `fumadocs()`, `darksharp()`, and `pixelBorder()` presets.
+*
+* @param baseTheme - The default theme configuration
+* @returns A factory function `(overrides?) => DocsTheme`
+*
+* @example
+* ```ts
+* import { createTheme } from "@farming-labs/docs";
+*
+* export const myTheme = createTheme({
+*   name: "my-theme",
+*   ui: {
+*     colors: { primary: "#6366f1" },
+*     layout: { contentWidth: 800 },
+*   },
+* });
+* ```
+*/
+function createTheme(baseTheme) {
+	return function themeFactory(overrides = {}) {
+		const merged = deepMerge(baseTheme, overrides);
+		if (overrides.ui?.colors) merged._userColorOverrides = { ...overrides.ui.colors };
+		return merged;
+	};
+}
+/**
+* Extend an existing theme preset with additional defaults.
+*
+* Useful when you want to build on top of an existing theme (e.g. fumadocs)
+* rather than starting from scratch.
+*
+* @example
+* ```ts
+* import { extendTheme } from "@farming-labs/docs";
+* import { fumadocs } from "@farming-labs/theme/default";
+*
+* // Start with fumadocs defaults, override some values
+* export const myTheme = extendTheme(fumadocs(), {
+*   name: "my-custom-fumadocs",
+*   ui: { colors: { primary: "#22c55e" } },
+* });
+* ```
+*/
+function extendTheme(baseTheme, extensions) {
+	return deepMerge(baseTheme, extensions);
+}
+
+//#endregion
+//#region src/i18n.ts
+function normalizeSegment(value) {
+	return value.replace(/^\/+|\/+$/g, "");
+}
+function splitSegments(value) {
+	const cleaned = normalizeSegment(value);
+	return cleaned ? cleaned.split("/").filter(Boolean) : [];
+}
+function resolveDocsI18n(config) {
+	if (!config || !Array.isArray(config.locales)) return null;
+	const locales = Array.from(new Set(config.locales.map((l) => l.trim()).filter(Boolean)));
+	if (locales.length === 0) return null;
+	return {
+		locales,
+		defaultLocale: config.defaultLocale && locales.includes(config.defaultLocale) ? config.defaultLocale : locales[0]
+	};
+}
+function resolveDocsLocale(searchParams, i18n) {
+	if (!i18n) return void 0;
+	const raw = searchParams.get("lang") ?? searchParams.get("locale");
+	if (!raw) return void 0;
+	if (i18n.locales.includes(raw)) return raw;
+	return i18n.defaultLocale;
+}
+function resolveDocsPath(pathname, entry) {
+	const entryBase = normalizeSegment(entry || "docs") || "docs";
+	const entryParts = splitSegments(entryBase);
+	const pathParts = splitSegments(pathname);
+	let rest = pathParts;
+	if (entryParts.length > 0) {
+		if (pathParts.slice(0, entryParts.length).join("/") === entryParts.join("/")) rest = pathParts.slice(entryParts.length);
+	}
+	return {
+		slug: rest.join("/"),
+		entryPath: entryBase
+	};
+}
+
+//#endregion
+//#region src/metadata.ts
+/**
+* Resolve page title using metadata titleTemplate.
+* %s is replaced with page title.
+*/
+function resolveTitle(pageTitle, metadata) {
+	return (metadata?.titleTemplate ?? "%s").replace("%s", pageTitle);
+}
+/**
+* Resolve OG image URL for a page.
+* Prefers page.openGraph.images[0], then page.ogImage, then config endpoint/default.
+*/
+function resolveOGImage(page, ogConfig, baseUrl) {
+	if (page.openGraph?.images?.length) return resolveImageUrl(page.openGraph.images[0].url, baseUrl);
+	if (!ogConfig?.enabled) return void 0;
+	if (page.ogImage) return resolveImageUrl(page.ogImage, baseUrl);
+	if (ogConfig.type === "dynamic" && ogConfig.endpoint) return `${baseUrl ?? ""}${ogConfig.endpoint}`;
+	return ogConfig.defaultImage;
+}
+function resolveImageUrl(url, baseUrl) {
+	if (url.startsWith("/") || url.startsWith("http")) return url;
+	const base = baseUrl ?? "";
+	return `${base}${base.length > 0 && !base.endsWith("/") ? "/" : ""}${url}`;
+}
+/**
+* Build the Open Graph metadata object for a page.
+* When the page has openGraph in frontmatter, uses it (with title/description filled from page if omitted).
+* Otherwise uses ogImage or config (dynamic endpoint / defaultImage).
+*/
+function buildPageOpenGraph(page, ogConfig, baseUrl) {
+	if (page.openGraph) {
+		const images = page.openGraph.images?.length ? page.openGraph.images.map((img) => ({
+			url: resolveImageUrl(img.url, baseUrl),
+			width: img.width ?? 1200,
+			height: img.height ?? 630
+		})) : void 0;
+		return {
+			title: page.openGraph.title ?? page.title,
+			description: page.openGraph.description ?? page.description,
+			...images && { images }
+		};
+	}
+	const url = resolveOGImage(page, ogConfig, baseUrl);
+	if (!url) return void 0;
+	return {
+		title: page.title,
+		...page.description && { description: page.description },
+		images: [{
+			url,
+			width: 1200,
+			height: 630
+		}]
+	};
+}
+/**
+* Build the Twitter card metadata object for a page.
+* When the page has twitter in frontmatter, uses it.
+* Otherwise builds from ogImage or config (dynamic endpoint).
+*/
+function buildPageTwitter(page, ogConfig, baseUrl) {
+	if (page.twitter) {
+		const images = page.twitter.images?.length ? page.twitter.images.map((url) => resolveImageUrl(url, baseUrl)) : void 0;
+		return {
+			...page.twitter.card && { card: page.twitter.card },
+			...page.twitter.title !== void 0 && { title: page.twitter.title },
+			...page.twitter.description !== void 0 && { description: page.twitter.description },
+			...images && { images }
+		};
+	}
+	const url = resolveOGImage(page, ogConfig, baseUrl);
+	if (!url) return void 0;
+	return {
+		card: "summary_large_image",
+		title: page.title,
+		...page.description && { description: page.description },
+		images: [url]
+	};
+}
+
+//#endregion
+export { buildPageOpenGraph, buildPageTwitter, createTheme, deepMerge, defineDocs, extendTheme, resolveDocsI18n, resolveDocsLocale, resolveDocsPath, resolveOGImage, resolveTitle };

package/dist/mcp.d.mts

@@ -0,0 +1,86 @@
+import { u as DocsMcpConfig, w as OrderingItem } from "./types-Bd3kyFF1.mjs";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp";
+
+//#region src/mcp.d.ts
+interface DocsMcpPage {
+  slug: string;
+  url: string;
+  title: string;
+  description?: string;
+  icon?: string;
+  content: string;
+  rawContent?: string;
+}
+interface DocsMcpPageNode {
+  type: "page";
+  name: string;
+  url: string;
+  icon?: string;
+  description?: string;
+}
+interface DocsMcpFolderNode {
+  type: "folder";
+  name: string;
+  icon?: string;
+  index?: DocsMcpPageNode;
+  children: DocsMcpNavigationNode[];
+}
+type DocsMcpNavigationNode = DocsMcpPageNode | DocsMcpFolderNode;
+interface DocsMcpNavigationTree {
+  name: string;
+  children: DocsMcpNavigationNode[];
+}
+interface DocsMcpSource {
+  entry?: string;
+  siteTitle?: string;
+  getPages(locale?: string): DocsMcpPage[] | Promise<DocsMcpPage[]>;
+  getNavigation(locale?: string): DocsMcpNavigationTree | Promise<DocsMcpNavigationTree>;
+}
+interface DocsMcpResolvedConfig {
+  enabled: boolean;
+  route: string;
+  name: string;
+  version: string;
+  tools: {
+    listPages: boolean;
+    readPage: boolean;
+    searchDocs: boolean;
+    getNavigation: boolean;
+  };
+}
+interface DocsMcpHttpHandlers {
+  GET: (context: {
+    request: Request;
+  }) => Promise<Response>;
+  POST: (context: {
+    request: Request;
+  }) => Promise<Response>;
+  DELETE: (context: {
+    request: Request;
+  }) => Promise<Response>;
+}
+interface CreateDocsMcpServerOptions {
+  source: DocsMcpSource;
+  mcp?: boolean | DocsMcpConfig;
+  defaultName?: string;
+  defaultVersion?: string;
+}
+interface CreateFilesystemDocsMcpSourceOptions {
+  rootDir?: string;
+  entry?: string;
+  contentDir?: string;
+  siteTitle?: string;
+  ordering?: "alphabetical" | "numeric" | OrderingItem[];
+}
+declare function normalizeDocsMcpRoute(route?: string): string;
+declare function resolveDocsMcpConfig(mcp?: boolean | DocsMcpConfig, defaults?: {
+  defaultName?: string;
+  defaultVersion?: string;
+  defaultRoute?: string;
+}): DocsMcpResolvedConfig;
+declare function createFilesystemDocsMcpSource(options?: CreateFilesystemDocsMcpSourceOptions): DocsMcpSource;
+declare function createDocsMcpServer(options: CreateDocsMcpServerOptions): Promise<McpServer>;
+declare function createDocsMcpHttpHandler(options: CreateDocsMcpServerOptions): DocsMcpHttpHandlers;
+declare function runDocsMcpStdio(options: CreateDocsMcpServerOptions): Promise<void>;
+//#endregion
+export { DocsMcpFolderNode, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpPageNode, DocsMcpResolvedConfig, DocsMcpSource, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio };