@farming-labs/theme 0.2.24 → 0.2.25

package/dist/docs-api.d.mts

@@ -1,4 +1,4 @@
-import { ChangelogConfig, DocsAnalyticsConfig, DocsAskAIMcpConfig, DocsConfig, DocsI18nConfig, DocsMcpConfig, DocsObservabilityConfig, DocsRobotsConfig, DocsSearchConfig, DocsSitemapConfig, FeedbackConfig, LlmsTxtConfig, OrderingItem } from "@farming-labs/docs";
+import { ChangelogConfig, DocsAnalyticsConfig, DocsAskAIMcpConfig, DocsConfig, DocsI18nConfig, DocsMcpConfig, DocsObservabilityConfig, DocsRobotsConfig, DocsSearchConfig, DocsSitemapConfig, DocsTelemetryConfig, FeedbackConfig, LlmsTxtConfig, OrderingItem } from "@farming-labs/docs";
 
 //#region src/docs-api.d.ts
 interface AIProviderConfig {
@@ -54,6 +54,8 @@ interface DocsAPIOptions {
   search?: boolean | DocsSearchConfig;
   /** Analytics configuration */
   analytics?: boolean | DocsAnalyticsConfig;
+  /** Farming Labs maintainer telemetry configuration. */
+  telemetry?: boolean | DocsTelemetryConfig;
   /** Observability configuration for logs, traces, and metrics callbacks. */
   observability?: boolean | DocsObservabilityConfig;
   /** Feedback configuration */
@@ -82,6 +84,7 @@ interface DocsMCPAPIOptions {
   mcp?: boolean | DocsMcpConfig;
   search?: boolean | DocsSearchConfig;
   analytics?: boolean | DocsAnalyticsConfig;
+  telemetry?: boolean | DocsTelemetryConfig;
   observability?: boolean | DocsObservabilityConfig;
 }
 type LlmsTxtOptions = LlmsTxtConfig;

package/dist/docs-api.mjs

@@ -3,7 +3,7 @@ import { getNextAppDir } from "./get-app-dir.mjs";
 import fs from "node:fs";
 import path from "node:path";
 import matter from "gray-matter";
-import { DEFAULT_SITEMAP_MD_DOCS_ROUTE, buildDocsAskAIContext, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsRobotsResponse, createDocsSitemapResponse, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownVaryHeader, hasDocsMarkdownSignatureAgent, normalizeDocsRelated, performDocsSearch, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsI18n, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownRecovery, resolveDocsMetadataBaseUrl, resolveDocsSitemapConfig, resolvePageSidebarFolderIndexBehavior, resolveSearchRequestConfig, selectDocsLlmsTxtContent } from "@farming-labs/docs";
+import { DEFAULT_SITEMAP_MD_DOCS_ROUTE, buildDocsAskAIContext, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsRobotsResponse, createDocsSitemapResponse, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownVaryHeader, hasDocsMarkdownSignatureAgent, inferDocsTelemetryAgentSurface, normalizeDocsRelated, performDocsSearch, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsI18n, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownRecovery, resolveDocsMetadataBaseUrl, resolveDocsSitemapConfig, resolvePageSidebarFolderIndexBehavior, resolveSearchRequestConfig, selectDocsLlmsTxtContent } from "@farming-labs/docs";
 import { buildApiReferenceOpenApiDocumentAsync, createDocsMcpHttpHandler, createFilesystemDocsMcpSource, readDocsSitemapManifest, resolveApiReferenceConfig, resolveDocsMcpConfig } from "@farming-labs/docs/server";
 
 //#region src/docs-api.ts
@@ -2368,7 +2368,8 @@ function createDocsAPI(options) {
 	const contentDir = options?.contentDir ?? path.join(appDir, entry);
 	const changelogConfig = resolveChangelogConfig(options?.changelog);
 	const agentFeedbackConfig = resolveAgentFeedbackConfig(options?.feedback);
-	const i18n = resolveDocsI18n(options?.i18n ?? readI18nConfig(root));
+	const i18nConfig = options?.i18n ?? readI18nConfig(root);
+	const i18n = resolveDocsI18n(i18nConfig);
 	const aiConfig = options?.ai ?? readAIConfig(root);
 	const cloudConfig = options?.cloud ?? readCloudConfig(root);
 	const searchConfig = options?.search;
@@ -2390,7 +2391,42 @@ function createDocsAPI(options) {
 		apiReference: apiReferenceConfig
 	};
 	const openapiDiscovery = resolveApiReferenceOpenApiDiscovery(apiReferenceConfig);
-	const mcpConfig = resolveDocsMcpConfig(options?.mcp ?? readMcpConfig(root), { defaultName: llmsConfig.siteTitle ?? "Documentation" });
+	const rawMcpConfig = options?.mcp ?? readMcpConfig(root);
+	const mcpConfig = resolveDocsMcpConfig(rawMcpConfig, { defaultName: llmsConfig.siteTitle ?? "Documentation" });
+	const telemetryConfig = {
+		entry,
+		docsPath,
+		contentDir,
+		telemetry: options?.telemetry,
+		search: searchConfig,
+		ai: aiConfig,
+		cloud: cloudConfig,
+		i18n: i18nConfig ?? void 0,
+		feedback: options?.feedback,
+		mcp: rawMcpConfig,
+		llmsTxt: llmsConfig,
+		sitemap: sitemapConfig,
+		robots: robotsConfig,
+		apiReference: apiReferenceConfig,
+		metadata: options?.metadata
+	};
+	function trackTelemetryRequest(request) {
+		emitDocsTelemetryProjectEvent(telemetryConfig, {
+			framework: "next",
+			request
+		});
+		const surface = inferDocsTelemetryAgentSurface(request, {
+			entry,
+			llmsTxt: llmsConfig,
+			feedback: options?.feedback
+		});
+		if (!surface) return;
+		emitDocsTelemetryAgentSurfaceEvent(telemetryConfig, {
+			framework: "next",
+			request,
+			surface
+		});
+	}
 	function resolveDocsDirCandidates(locale) {
 		const relativeCandidates = /* @__PURE__ */ new Set();
 		if (path.isAbsolute(contentDir)) return [locale ? path.join(contentDir, locale) : contentDir];
@@ -2533,6 +2569,7 @@ function createDocsAPI(options) {
 	}
 	return {
 		async GET(request) {
+			trackTelemetryRequest(request);
 			const ctx = resolveContextFromRequest(request);
 			const url = new URL(request.url);
 			const requestAnalyticsProperties = getRequestAnalyticsProperties(request);
@@ -2857,6 +2894,7 @@ function createDocsAPI(options) {
 			return new Response(JSON.stringify(results), { headers: { "Content-Type": "application/json" } });
 		},
 		async POST(request) {
+			trackTelemetryRequest(request);
 			const url = new URL(request.url);
 			const requestAnalyticsProperties = getRequestAnalyticsProperties(request);
 			const agentFeedbackRequest = resolveAgentFeedbackRequest(url, agentFeedbackConfig);
@@ -2981,6 +3019,8 @@ function createDocsMCPAPI(options = {}) {
 		mcp: options.mcp ?? readMcpConfig(rootDir),
 		search: options.search,
 		analytics: options.analytics,
+		telemetry: options.telemetry,
+		telemetryFramework: "next",
 		observability: options.observability,
 		defaultName: navTitle
 	});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/theme",
-  "version": "0.2.24",
+  "version": "0.2.25",
   "description": "Theme package for @farming-labs/docs — layout, provider, MDX components, and styles",
   "keywords": [
     "docs",
@@ -146,7 +146,7 @@
     "tsdown": "^0.20.3",
     "typescript": "^5.9.3",
     "vitest": "^4.1.8",
-    "@farming-labs/docs": "0.2.24"
+    "@farming-labs/docs": "0.2.25"
   },
   "peerDependencies": {
     "@farming-labs/docs": ">=0.0.1",