@farming-labs/theme 0.1.60 → 0.1.63

package/dist/docs-ai-features.mjs

@@ -1,5 +1,6 @@
 "use client";
 
+import { emitClientAnalyticsEvent } from "./client-analytics.mjs";
 import { useWindowSearchParams } from "./client-location.mjs";
 import { resolveClientLocale, withLangInUrl } from "./i18n.mjs";
 import { AIModalDialog, DocsSearchDialog, FloatingAIChat } from "./ai-search-dialog.mjs";
@@ -21,7 +22,7 @@ import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
 * This component is rendered inside the docs layout so the user's root layout
 * never needs to be modified — AI features work purely from `docs.config.ts`.
 */
-function DocsAIFeatures({ mode, api = "/api/docs", locale, position = "bottom-right", floatingStyle = "panel", triggerComponentHtml, suggestedQuestions, aiLabel, loaderVariant, loadingComponentHtml, models, defaultModelId }) {
+function DocsAIFeatures({ mode, api = "/api/docs", locale, position = "bottom-right", floatingStyle = "panel", triggerComponentHtml, suggestedQuestions, aiLabel, loaderVariant, loadingComponentHtml, models, defaultModelId, analytics = false }) {
 	const localizedApi = withLangInUrl(api, resolveClientLocale(useWindowSearchParams(), locale));
 	if (mode === "search") return /* @__PURE__ */ jsx(SearchModeAI, {
 		api: localizedApi,
@@ -30,7 +31,8 @@ function DocsAIFeatures({ mode, api = "/api/docs", locale, position = "bottom-ri
 		loaderVariant,
 		loadingComponentHtml,
 		models,
-		defaultModelId
+		defaultModelId,
+		analytics
 	});
 	if (mode === "sidebar-icon") return /* @__PURE__ */ jsx(SidebarIconModeAI, {
 		api: localizedApi,
@@ -39,7 +41,8 @@ function DocsAIFeatures({ mode, api = "/api/docs", locale, position = "bottom-ri
 		loaderVariant,
 		loadingComponentHtml,
 		models,
-		defaultModelId
+		defaultModelId,
+		analytics
 	});
 	return /* @__PURE__ */ jsx(FloatingAIChat, {
 		api: localizedApi,
@@ -51,10 +54,11 @@ function DocsAIFeatures({ mode, api = "/api/docs", locale, position = "bottom-ri
 		loaderVariant,
 		loadingComponentHtml,
 		models,
-		defaultModelId
+		defaultModelId,
+		analytics
 	});
 }
-function SearchModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, loadingComponentHtml, models, defaultModelId }) {
+function SearchModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, loadingComponentHtml, models, defaultModelId, analytics }) {
 	const [open, setOpen] = useState(false);
 	useEffect(() => {
 		function handler(e) {
@@ -63,11 +67,18 @@ function SearchModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, loading
 				e.stopPropagation();
 				e.stopImmediatePropagation();
 				setOpen(true);
+				if (analytics) emitClientAnalyticsEvent({
+					type: "search_open",
+					properties: {
+						mode: "ai-search",
+						trigger: "keyboard"
+					}
+				});
 			}
 		}
 		document.addEventListener("keydown", handler, true);
 		return () => document.removeEventListener("keydown", handler, true);
-	}, []);
+	}, [analytics]);
 	useEffect(() => {
 		function handler(e) {
 			const button = e.target.closest("button");
@@ -78,11 +89,18 @@ function SearchModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, loading
 				e.stopPropagation();
 				e.stopImmediatePropagation();
 				setOpen(true);
+				if (analytics) emitClientAnalyticsEvent({
+					type: "search_open",
+					properties: {
+						mode: "ai-search",
+						trigger: "button"
+					}
+				});
 			}
 		}
 		document.addEventListener("click", handler, true);
 		return () => document.removeEventListener("click", handler, true);
-	}, []);
+	}, [analytics]);
 	return /* @__PURE__ */ jsx(DocsSearchDialog, {
 		open,
 		onOpenChange: setOpen,
@@ -92,10 +110,11 @@ function SearchModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, loading
 		loaderVariant,
 		loadingComponentHtml,
 		models,
-		defaultModelId
+		defaultModelId,
+		analytics
 	});
 }
-function SidebarIconModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, loadingComponentHtml, models, defaultModelId }) {
+function SidebarIconModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, loadingComponentHtml, models, defaultModelId, analytics }) {
 	const [searchOpen, setSearchOpen] = useState(false);
 	const [aiOpen, setAiOpen] = useState(false);
 	useEffect(() => {
@@ -113,9 +132,23 @@ function SidebarIconModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, lo
 	useEffect(() => {
 		function onSearch() {
 			setSearchOpen(true);
+			if (analytics) emitClientAnalyticsEvent({
+				type: "search_open",
+				properties: {
+					mode: "sidebar-icon",
+					trigger: "sidebar-search"
+				}
+			});
 		}
 		function onAI() {
 			setAiOpen(true);
+			if (analytics) emitClientAnalyticsEvent({
+				type: "ai_open",
+				properties: {
+					mode: "sidebar-icon",
+					trigger: "sidebar-ai"
+				}
+			});
 		}
 		window.addEventListener("fd-open-search", onSearch);
 		window.addEventListener("fd-open-ai", onAI);
@@ -123,7 +156,7 @@ function SidebarIconModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, lo
 			window.removeEventListener("fd-open-search", onSearch);
 			window.removeEventListener("fd-open-ai", onAI);
 		};
-	}, []);
+	}, [analytics]);
 	return /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx(DocsSearchDialog, {
 		open: searchOpen,
 		onOpenChange: setSearchOpen,
@@ -133,7 +166,8 @@ function SidebarIconModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, lo
 		loaderVariant,
 		loadingComponentHtml,
 		models,
-		defaultModelId
+		defaultModelId,
+		analytics
 	}), /* @__PURE__ */ jsx(AIModalDialog, {
 		open: aiOpen,
 		onOpenChange: setAiOpen,
@@ -143,7 +177,8 @@ function SidebarIconModeAI({ api, suggestedQuestions, aiLabel, loaderVariant, lo
 		loaderVariant,
 		loadingComponentHtml,
 		models,
-		defaultModelId
+		defaultModelId,
+		analytics
 	})] });
 }
 

package/dist/docs-api.d.mts

@@ -1,4 +1,4 @@
-import { ChangelogConfig, DocsI18nConfig, DocsMcpConfig, DocsSearchConfig, FeedbackConfig, OrderingItem } from "@farming-labs/docs";
+import { ChangelogConfig, DocsAnalyticsConfig, DocsI18nConfig, DocsMcpConfig, DocsSearchConfig, FeedbackConfig, OrderingItem } from "@farming-labs/docs";
 
 //#region src/docs-api.d.ts
 interface AIProviderConfig {
@@ -41,6 +41,8 @@ interface DocsAPIOptions {
   i18n?: DocsI18nConfig;
   /** Search configuration */
   search?: boolean | DocsSearchConfig;
+  /** Analytics configuration */
+  analytics?: boolean | DocsAnalyticsConfig;
   /** Feedback configuration */
   feedback?: boolean | FeedbackConfig;
   /** MCP configuration used for the agent discovery spec. */
@@ -56,6 +58,7 @@ interface DocsMCPAPIOptions {
   ordering?: "alphabetical" | "numeric" | OrderingItem[];
   mcp?: boolean | DocsMcpConfig;
   search?: boolean | DocsSearchConfig;
+  analytics?: boolean | DocsAnalyticsConfig;
 }
 /**
  * Create a unified docs API route handler.