@farming-labs/theme 0.2.33 → 0.2.35

package/dist/docs-api.d.mts

@@ -40,6 +40,8 @@ interface DocsAPIOptions {
   docsPath?: string;
   /** Override the docs content directory when it does not live in app/<entry>. */
   contentDir?: string;
+  /** Set when the docs site is built without runtime API routes. */
+  staticExport?: boolean;
   /** Changelog configuration. */
   changelog?: boolean | ChangelogConfig;
   /** Search language (default: "english") */

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, buildDocsConfigMap, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsRobotsResponse, createDocsSitemapResponse, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownVaryHeader, hasDocsMarkdownSignatureAgent, inferDocsTelemetryAgentSurface, isDocsConfigRequest, 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, buildDocsConfigMap, buildDocsDiagnostics, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsRobotsResponse, createDocsSitemapResponse, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryProjectEvent, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownVaryHeader, hasDocsMarkdownSignatureAgent, inferDocsTelemetryAgentSurface, isDocsConfigRequest, isDocsDiagnosticsRequest, 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
@@ -251,6 +251,7 @@ function buildAgentSpec({ origin, entry, i18n, search, mcp, feedback, llms, site
 		api: {
 			docs: DEFAULT_DOCS_API_ROUTE,
 			config: `${DEFAULT_DOCS_API_ROUTE}?format=config`,
+			diagnostics: `${DEFAULT_DOCS_API_ROUTE}?format=diagnostics`,
 			agentSpec: DEFAULT_AGENT_SPEC_ROUTE,
 			agentSpecDefault: DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE,
 			agentSpecFallback: DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE,
@@ -1355,10 +1356,10 @@ function readRuntimeEnv(name) {
 	return value ? value : void 0;
 }
 function resolveDocsCloudApiBaseUrl() {
-	return (readRuntimeEnv("DOCS_CLOUD_API_URL") ?? readRuntimeEnv("NEXT_PUBLIC_DOCS_CLOUD_URL") ?? DEFAULT_DOCS_CLOUD_API_BASE_URL).replace(/\/+$/, "");
+	return (readRuntimeEnv("DOCS_CLOUD_API_URL") ?? readRuntimeEnv("PUBLIC_DOCS_CLOUD_URL") ?? readRuntimeEnv("NEXT_PUBLIC_DOCS_CLOUD_URL") ?? DEFAULT_DOCS_CLOUD_API_BASE_URL).replace(/\/+$/, "");
 }
 function resolveDocsCloudProjectId() {
-	return readRuntimeEnv("NEXT_PUBLIC_DOCS_CLOUD_PROJECT_ID") ?? readRuntimeEnv("DOCS_CLOUD_PROJECT_ID");
+	return readRuntimeEnv("PUBLIC_DOCS_CLOUD_PROJECT_ID") ?? readRuntimeEnv("NEXT_PUBLIC_DOCS_CLOUD_PROJECT_ID") ?? readRuntimeEnv("DOCS_CLOUD_PROJECT_ID");
 }
 function resolveDocsCloudApiKey(cloudConfig) {
 	const envName = cloudConfig?.apiKey?.env?.trim() || DEFAULT_DOCS_CLOUD_API_KEY_ENV;
@@ -1647,7 +1648,7 @@ async function handleAskAI(request, indexes, aiConfig, cloudConfig, search, anal
 				model,
 				envName: !apiKey ? envName : void 0
 			});
-			return Response.json({ error: !projectId ? "AI provider docs-cloud requires NEXT_PUBLIC_DOCS_CLOUD_PROJECT_ID or DOCS_CLOUD_PROJECT_ID." : `AI provider docs-cloud requires ${envName} to be set on the server.` }, { status: 500 });
+			return Response.json({ error: !projectId ? "AI provider docs-cloud requires PUBLIC_DOCS_CLOUD_PROJECT_ID or DOCS_CLOUD_PROJECT_ID." : `AI provider docs-cloud requires ${envName} to be set on the server.` }, { status: 500 });
 		}
 		await emitDocsAnalyticsEvent(analytics, {
 			type: "api_ai_request",
@@ -2428,6 +2429,16 @@ function createDocsAPI(options) {
 	setConfigMapFallback("i18n", i18nConfig ?? void 0);
 	setConfigMapFallback("mcp", rawMcpConfig);
 	setConfigMapFallback("apiReference", apiReferenceConfig);
+	const docsDiagnosticsInput = {
+		...docsConfigMapInput,
+		docsPath: docsConfigMapInput.docsPath ?? docsPath,
+		contentDir: docsConfigMapInput.contentDir ?? contentDir,
+		feedback: docsConfigMapInput.feedback ?? options?.feedback,
+		llmsTxt: docsConfigMapInput.llmsTxt ?? llmsConfig,
+		sitemap: docsConfigMapInput.sitemap ?? sitemapConfig,
+		robots: docsConfigMapInput.robots ?? robotsConfig,
+		staticExport: docsConfigMapInput.staticExport ?? options?.staticExport
+	};
 	function trackTelemetryRequest(request) {
 		emitDocsTelemetryProjectEvent(telemetryConfig, {
 			framework: "next",
@@ -2595,6 +2606,17 @@ function createDocsAPI(options) {
 				"Cache-Control": "public, max-age=0, s-maxage=3600",
 				"X-Robots-Tag": "noindex"
 			} });
+			if (isDocsDiagnosticsRequest(url)) return Response.json(buildDocsDiagnostics(docsDiagnosticsInput, {
+				adapter: "next",
+				entry,
+				i18n,
+				mcp: mcpConfig,
+				feedback: agentFeedbackConfig,
+				openapi: openapiDiscovery
+			}), { headers: {
+				"Cache-Control": "public, max-age=0, s-maxage=3600",
+				"X-Robots-Tag": "noindex"
+			} });
 			if (resolveAgentSpecRequest(url)) {
 				await emitDocsAnalyticsEvent(analytics, {
 					type: "agent_spec_request",

package/dist/docs-cloud-ai-client.mjs

@@ -1,25 +1,27 @@
 //#region src/docs-cloud-ai-client.ts
 const DEFAULT_DOCS_API_ROUTE = "/api/docs";
 const DEFAULT_DOCS_CLOUD_API_BASE_URL = "https://api.farming-labs.dev";
-const DEFAULT_PUBLIC_DOCS_CLOUD_PROJECT_ID_ENV = "NEXT_PUBLIC_DOCS_CLOUD_PROJECT_ID";
-const DEFAULT_PUBLIC_DOCS_CLOUD_API_KEY_ENV = "NEXT_PUBLIC_DOCS_CLOUD_API_KEY";
+const DEFAULT_PUBLIC_DOCS_CLOUD_PROJECT_ID_ENV = "PUBLIC_DOCS_CLOUD_PROJECT_ID";
+const FALLBACK_PUBLIC_DOCS_CLOUD_PROJECT_ID_ENV = "NEXT_PUBLIC_DOCS_CLOUD_PROJECT_ID";
+const DEFAULT_PUBLIC_DOCS_CLOUD_API_KEY_ENV = "PUBLIC_DOCS_CLOUD_API_KEY";
+const FALLBACK_PUBLIC_DOCS_CLOUD_API_KEY_ENV = "NEXT_PUBLIC_DOCS_CLOUD_API_KEY";
 function readRuntimeEnv(name) {
 	const value = process.env[name]?.trim();
 	return value ? value : void 0;
 }
 function resolveDocsCloudApiBaseUrl() {
-	return (readRuntimeEnv("NEXT_PUBLIC_DOCS_CLOUD_URL") ?? readRuntimeEnv("DOCS_CLOUD_API_URL") ?? DEFAULT_DOCS_CLOUD_API_BASE_URL).replace(/\/+$/, "");
+	return (readRuntimeEnv("PUBLIC_DOCS_CLOUD_URL") ?? readRuntimeEnv("NEXT_PUBLIC_DOCS_CLOUD_URL") ?? readRuntimeEnv("DOCS_CLOUD_API_URL") ?? DEFAULT_DOCS_CLOUD_API_BASE_URL).replace(/\/+$/, "");
 }
 function resolveDocsCloudProjectId() {
-	return readRuntimeEnv(DEFAULT_PUBLIC_DOCS_CLOUD_PROJECT_ID_ENV);
+	return readRuntimeEnv(DEFAULT_PUBLIC_DOCS_CLOUD_PROJECT_ID_ENV) ?? readRuntimeEnv(FALLBACK_PUBLIC_DOCS_CLOUD_PROJECT_ID_ENV);
 }
 function resolveDocsCloudApiKey(config) {
 	const configuredEnv = config.cloud?.apiKey?.env?.trim();
 	if (configuredEnv && isPublicRuntimeEnvName(configuredEnv)) return readRuntimeEnv(configuredEnv);
-	return readRuntimeEnv(DEFAULT_PUBLIC_DOCS_CLOUD_API_KEY_ENV);
+	return readRuntimeEnv(DEFAULT_PUBLIC_DOCS_CLOUD_API_KEY_ENV) ?? readRuntimeEnv(FALLBACK_PUBLIC_DOCS_CLOUD_API_KEY_ENV);
 }
 function isPublicRuntimeEnvName(name) {
-	return name.startsWith("NEXT_PUBLIC_");
+	return name.startsWith("PUBLIC_") || name.startsWith("NEXT_PUBLIC_");
 }
 function resolveDocsCloudAIStream(config) {
 	const aiConfig = config.ai;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/theme",
-  "version": "0.2.33",
+  "version": "0.2.35",
   "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.33"
+    "@farming-labs/docs": "0.2.35"
   },
   "peerDependencies": {
     "@farming-labs/docs": ">=0.0.1",