@farming-labs/docs 0.1.118 → 0.1.120

package/dist/review-_5fnI667.mjs

@@ -0,0 +1,553 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { dirname, isAbsolute, join, relative } from "node:path";
+
+//#region src/review.ts
+const DEFAULT_DOCS_REVIEW_WORKFLOW_PATH = ".github/workflows/docs-review.yml";
+const DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD = 80;
+const DEFAULT_REVIEW_RULES = {
+	brokenLinks: "error",
+	frontmatter: "error",
+	duplicateSlugs: "error",
+	invalidMdx: "error",
+	configExamples: "warn",
+	codeFenceMetadata: "warn",
+	runnableMetadata: "warn",
+	agentContext: "suggestion"
+};
+const DEFAULT_REVIEW_WEIGHTS = {
+	error: 20,
+	warn: 8,
+	suggestion: 2
+};
+const REVIEW_SEVERITIES = new Set([
+	"off",
+	"suggestion",
+	"warn",
+	"error"
+]);
+const REVIEW_CI_MODES = new Set([
+	"off",
+	"warn",
+	"block"
+]);
+const FILE_EXTS = [
+	"tsx",
+	"ts",
+	"jsx",
+	"js"
+];
+function resolveDocsReviewConfig(review) {
+	if (review === false) return {
+		enabled: false,
+		ci: {
+			enabled: false,
+			mode: "off",
+			annotations: false,
+			comment: false
+		},
+		score: {
+			threshold: DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD,
+			weights: DEFAULT_REVIEW_WEIGHTS
+		},
+		rules: DEFAULT_REVIEW_RULES
+	};
+	const objectConfig = review && typeof review === "object" ? review : {};
+	const ciConfig = objectConfig.ci;
+	const ciObject = ciConfig && typeof ciConfig === "object" ? ciConfig : {};
+	const configuredMode = ciObject.mode;
+	const mode = configuredMode && REVIEW_CI_MODES.has(configuredMode) ? configuredMode : "warn";
+	const enabled = objectConfig.enabled !== false;
+	const ciEnabled = enabled && ciConfig !== false && ciObject.enabled !== false && mode !== "off";
+	return {
+		enabled,
+		ci: {
+			enabled: ciEnabled,
+			mode: ciEnabled ? mode : "off",
+			annotations: ciObject.annotations !== false,
+			comment: ciObject.comment !== false
+		},
+		score: {
+			threshold: clampScoreThreshold(objectConfig.score?.threshold),
+			weights: {
+				error: normalizeWeight(objectConfig.score?.weights?.error, DEFAULT_REVIEW_WEIGHTS.error),
+				warn: normalizeWeight(objectConfig.score?.weights?.warn, DEFAULT_REVIEW_WEIGHTS.warn),
+				suggestion: normalizeWeight(objectConfig.score?.weights?.suggestion, DEFAULT_REVIEW_WEIGHTS.suggestion)
+			}
+		},
+		rules: {
+			...DEFAULT_REVIEW_RULES,
+			...normalizeRules(objectConfig.rules)
+		}
+	};
+}
+function buildDocsReviewWorkflow(options = {}) {
+	const packageManager = options.packageManager ?? "npm";
+	const projectDir = normalizeProjectDir(options.projectDir);
+	const configArg = options.configPath ? ` --config ${shellQuote(options.configPath)}` : "";
+	const reviewCommand = `${options.reviewCommand ?? reviewCommandForPackageManager(packageManager)} review --ci${configArg}`;
+	const filters = normalizePathFilters(options.pathFilters);
+	const installSteps = buildInstallSteps(packageManager);
+	const buildStep = options.buildCommand ? `\n      - name: Build docs CLI\n        run: ${options.buildCommand}\n` : "";
+	const workingDirectoryLine = projectDir === "." ? "" : `\n        working-directory: ${projectDir}`;
+	return `# Generated by @farming-labs/docs. You can edit this file.
+name: Docs Review
+
+on:
+  pull_request:
+    paths:
+${filters.map((filter) => `      - ${JSON.stringify(filter)}`).join("\n")}
+
+permissions:
+  contents: read
+  checks: write
+  pull-requests: write
+
+jobs:
+  docs-review:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+${installSteps}
+${buildStep}
+
+      - name: Review docs
+        run: ${reviewCommand}${workingDirectoryLine}
+`;
+}
+function ensureDocsReviewWorkflow(options) {
+	const rootDir = options.rootDir;
+	const repoRoot = findGitRoot(rootDir) ?? rootDir;
+	const workflowRelativePath = options.workflowPath ?? DEFAULT_DOCS_REVIEW_WORKFLOW_PATH;
+	const workflowPath = isAbsolute(workflowRelativePath) ? workflowRelativePath : join(repoRoot, workflowRelativePath);
+	const resultRelativePath = toPosixPath(relative(repoRoot, workflowPath));
+	const review = resolveDocsReviewConfig(options.config?.review ?? readDocsReviewConfigFromSource(options.configContent ?? readConfig(rootDir)));
+	if (!review.enabled || !review.ci.enabled) return {
+		status: "disabled",
+		path: workflowPath,
+		relativePath: resultRelativePath
+	};
+	if (existsSync(workflowPath)) return {
+		status: "exists",
+		path: workflowPath,
+		relativePath: resultRelativePath
+	};
+	const configPath = options.configPath ?? findDocsConfigPath(rootDir);
+	const configContent = options.configContent ?? readConfig(rootDir, configPath);
+	const projectDir = toPosixPath(relative(repoRoot, rootDir)) || ".";
+	const packageManager = detectPackageManager(repoRoot);
+	const workflow = buildDocsReviewWorkflow({
+		packageManager,
+		projectDir,
+		configPath,
+		buildCommand: detectLocalDocsCliBuildCommand(repoRoot, packageManager),
+		reviewCommand: detectLocalDocsCliReviewCommand(repoRoot, rootDir),
+		pathFilters: buildDocsReviewWorkflowPathFilters({
+			rootDir,
+			repoRoot,
+			config: options.config,
+			configPath,
+			configContent
+		})
+	});
+	mkdirSync(dirname(workflowPath), { recursive: true });
+	writeFileSync(workflowPath, workflow, "utf-8");
+	options.log?.(`[docs] Created ${resultRelativePath} for Docs Review CI.`);
+	return {
+		status: "created",
+		path: workflowPath,
+		relativePath: resultRelativePath
+	};
+}
+function readDocsReviewConfigFromSource(content) {
+	if (!content) return void 0;
+	const rootObject = extractRootObjectLiteral(content) ?? content;
+	const reviewCursor = findTopLevelPropertyValueIndex(rootObject, "review");
+	if (reviewCursor === void 0) return void 0;
+	if (rootObject.startsWith("true", reviewCursor)) return true;
+	if (rootObject.startsWith("false", reviewCursor)) return false;
+	if (rootObject[reviewCursor] !== "{") return void 0;
+	const reviewEnd = findMatchingObjectEnd(rootObject, reviewCursor);
+	if (reviewEnd === void 0) return void 0;
+	const reviewBlock = rootObject.slice(reviewCursor + 1, reviewEnd);
+	const scoreBlock = extractTopLevelObjectLiteral(reviewBlock, "score");
+	const ciCursor = findTopLevelPropertyValueIndex(reviewBlock, "ci");
+	const rulesBlock = extractTopLevelObjectLiteral(reviewBlock, "rules");
+	const ci = ciCursor === void 0 ? void 0 : reviewBlock.startsWith("true", ciCursor) ? true : reviewBlock.startsWith("false", ciCursor) ? false : reviewBlock[ciCursor] === "{" ? readReviewCiObject(reviewBlock, ciCursor) : void 0;
+	return {
+		enabled: readTopLevelBoolean(reviewBlock, "enabled"),
+		score: scoreBlock ? {
+			threshold: readTopLevelNumber(scoreBlock, "threshold"),
+			weights: readReviewWeights(scoreBlock)
+		} : void 0,
+		ci,
+		rules: rulesBlock ? readReviewRules(rulesBlock) : void 0
+	};
+}
+function buildDocsReviewWorkflowPathFilters(options) {
+	const repoRoot = options.repoRoot ?? findGitRoot(options.rootDir) ?? options.rootDir;
+	const configPath = options.configPath ?? findDocsConfigPath(options.rootDir);
+	const configContent = options.configContent ?? readConfig(options.rootDir, configPath);
+	const entry = options.config?.entry ?? readTopLevelString(configContent, "entry") ?? "docs";
+	const contentDir = options.config?.contentDir ?? readTopLevelString(configContent, "contentDir");
+	const projectDir = toPosixPath(relative(repoRoot, options.rootDir));
+	const projectPrefix = projectDir && projectDir !== "." ? `${projectDir}/` : "";
+	const candidates = [
+		prefixPath(projectPrefix, configPath),
+		prefixPath(projectPrefix, `${entry}/**`),
+		prefixPath(projectPrefix, `app/${entry}/**`),
+		prefixPath(projectPrefix, `src/app/${entry}/**`),
+		contentDir ? prefixPath(projectPrefix, `${trimSlashes(contentDir)}/**`) : void 0,
+		prefixPath(projectPrefix, "content/docs/**"),
+		prefixPath(projectPrefix, "src/content/docs/**"),
+		prefixPath(projectPrefix, "src/lib/docs.config.*"),
+		DEFAULT_DOCS_REVIEW_WORKFLOW_PATH
+	];
+	return Array.from(new Set(candidates.filter((candidate) => Boolean(candidate))));
+}
+function normalizeRules(rules) {
+	if (!rules) return {};
+	return Object.fromEntries(Object.entries(rules).filter((entry) => REVIEW_SEVERITIES.has(entry[1])));
+}
+function normalizeWeight(value, fallback) {
+	return typeof value === "number" && Number.isFinite(value) && value >= 0 ? value : fallback;
+}
+function clampScoreThreshold(value) {
+	if (typeof value !== "number" || !Number.isFinite(value)) return DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD;
+	return Math.min(100, Math.max(0, Math.round(value)));
+}
+function readReviewCiObject(source, cursor) {
+	const end = findMatchingObjectEnd(source, cursor);
+	if (end === void 0) return void 0;
+	const block = source.slice(cursor + 1, end);
+	const mode = readTopLevelString(block, "mode");
+	return {
+		enabled: readTopLevelBoolean(block, "enabled"),
+		mode: mode && REVIEW_CI_MODES.has(mode) ? mode : void 0,
+		annotations: readTopLevelBoolean(block, "annotations"),
+		comment: readTopLevelBoolean(block, "comment")
+	};
+}
+function readReviewRules(block) {
+	const rules = {};
+	for (const key of Object.keys(DEFAULT_REVIEW_RULES)) {
+		const value = readTopLevelString(block, key);
+		if (value && REVIEW_SEVERITIES.has(value)) rules[key] = value;
+	}
+	return rules;
+}
+function readReviewWeights(block) {
+	const weightsBlock = extractTopLevelObjectLiteral(block, "weights");
+	if (!weightsBlock) return void 0;
+	return {
+		error: readTopLevelNumber(weightsBlock, "error"),
+		warn: readTopLevelNumber(weightsBlock, "warn"),
+		suggestion: readTopLevelNumber(weightsBlock, "suggestion")
+	};
+}
+function detectPackageManager(rootDir) {
+	if (existsSync(join(rootDir, "pnpm-lock.yaml"))) return "pnpm";
+	if (existsSync(join(rootDir, "yarn.lock"))) return "yarn";
+	if (existsSync(join(rootDir, "bun.lock")) || existsSync(join(rootDir, "bun.lockb"))) return "bun";
+	return "npm";
+}
+function detectLocalDocsCliBuildCommand(repoRoot, packageManager) {
+	if (!hasLocalDocsWorkspacePackage(repoRoot)) return void 0;
+	if (packageManager === "pnpm") return "pnpm --filter @farming-labs/docs run build";
+	if (packageManager === "yarn") return "yarn workspace @farming-labs/docs build";
+	if (packageManager === "bun") return "bun run --filter @farming-labs/docs build";
+	return "npm run build --workspace=@farming-labs/docs";
+}
+function detectLocalDocsCliReviewCommand(repoRoot, rootDir) {
+	if (!hasLocalDocsWorkspacePackage(repoRoot)) return void 0;
+	return `node ${shellQuote(toPosixPath(relative(rootDir, join(repoRoot, "packages", "docs", "dist", "cli", "index.mjs"))) || "./packages/docs/dist/cli/index.mjs")}`;
+}
+function hasLocalDocsWorkspacePackage(repoRoot) {
+	const packageJsonPath = join(repoRoot, "packages", "docs", "package.json");
+	if (!existsSync(packageJsonPath)) return false;
+	try {
+		const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+		return packageJson.name === "@farming-labs/docs" && Boolean(packageJson.scripts?.build);
+	} catch {
+		return false;
+	}
+}
+function buildInstallSteps(packageManager) {
+	if (packageManager === "pnpm") return `      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile`;
+	if (packageManager === "yarn") return `      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: yarn
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Install dependencies
+        run: yarn install --immutable || yarn install --frozen-lockfile`;
+	if (packageManager === "bun") return `      - uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile`;
+	return `      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci`;
+}
+function reviewCommandForPackageManager(packageManager) {
+	if (packageManager === "pnpm") return "pnpm exec docs";
+	if (packageManager === "yarn") return "yarn exec docs";
+	if (packageManager === "bun") return "bunx docs";
+	return "npx --no-install docs";
+}
+function shellQuote(value) {
+	if (/^[A-Za-z0-9_./:-]+$/.test(value)) return value;
+	return `'${value.replaceAll("'", "'\\''")}'`;
+}
+function normalizeProjectDir(value) {
+	if (!value || value === "") return ".";
+	return toPosixPath(value).replace(/\/+$/, "") || ".";
+}
+function normalizePathFilters(filters) {
+	const normalized = (filters && filters.length > 0 ? filters : ["docs.config.*", "app/docs/**"]).map((filter) => toPosixPath(filter).replace(/^\.\/+/, "")).filter(Boolean);
+	return Array.from(new Set(normalized));
+}
+function findGitRoot(start) {
+	let current = start;
+	while (true) {
+		if (existsSync(join(current, ".git"))) return current;
+		const parent = dirname(current);
+		if (parent === current) return void 0;
+		current = parent;
+	}
+}
+function findDocsConfigPath(rootDir) {
+	for (const ext of FILE_EXTS) {
+		const path = `docs.config.${ext}`;
+		if (existsSync(join(rootDir, path))) return path;
+	}
+	return "docs.config.ts";
+}
+function readConfig(rootDir, configPath = findDocsConfigPath(rootDir)) {
+	const fullPath = join(rootDir, configPath);
+	if (!existsSync(fullPath)) return void 0;
+	try {
+		return readFileSync(fullPath, "utf-8");
+	} catch {
+		return;
+	}
+}
+function prefixPath(prefix, value) {
+	return `${prefix}${toPosixPath(value).replace(/^\.\/+/, "")}`;
+}
+function trimSlashes(value) {
+	return toPosixPath(value).replace(/^\/+|\/+$/g, "");
+}
+function toPosixPath(value) {
+	return value.replaceAll("\\", "/");
+}
+function extractRootObjectLiteral(content) {
+	const candidateIndexes = [content.search(/\bdefineDocs\s*\(/), content.search(/\bexport\s+default\b/)].filter((value) => value !== -1);
+	for (const startIndex of candidateIndexes) {
+		const braceStart = content.indexOf("{", startIndex);
+		if (braceStart === -1) continue;
+		const braceEnd = findMatchingObjectEnd(content, braceStart);
+		if (braceEnd !== void 0) return content.slice(braceStart + 1, braceEnd);
+	}
+}
+function extractTopLevelObjectLiteral(content, key) {
+	const cursor = findTopLevelPropertyValueIndex(content, key);
+	if (cursor === void 0 || content[cursor] !== "{") return void 0;
+	const end = findMatchingObjectEnd(content, cursor);
+	return end === void 0 ? void 0 : content.slice(cursor + 1, end);
+}
+function readTopLevelBoolean(content, key) {
+	const cursor = findTopLevelPropertyValueIndex(content, key);
+	if (cursor === void 0) return void 0;
+	if (content.startsWith("true", cursor)) return true;
+	if (content.startsWith("false", cursor)) return false;
+}
+function readTopLevelNumber(content, key) {
+	const cursor = findTopLevelPropertyValueIndex(content, key);
+	if (cursor === void 0) return void 0;
+	const match = content.slice(cursor).match(/^-?\d+(?:\.\d+)?/);
+	if (!match) return void 0;
+	const value = Number(match[0]);
+	return Number.isFinite(value) ? value : void 0;
+}
+function readTopLevelString(content, key) {
+	if (!content) return void 0;
+	const cursor = findTopLevelPropertyValueIndex(content, key);
+	if (cursor === void 0) return void 0;
+	const quote = content[cursor];
+	if (quote !== "\"" && quote !== "'") return void 0;
+	let value = "";
+	for (let index = cursor + 1; index < content.length; index += 1) {
+		const char = content[index];
+		if (char === "\\") {
+			const escaped = content[index + 1];
+			if (escaped) {
+				value += escaped;
+				index += 1;
+			}
+			continue;
+		}
+		if (char === quote) return value;
+		value += char;
+	}
+}
+function findTopLevelPropertyValueIndex(block, key) {
+	let objectDepth = 0;
+	let arrayDepth = 0;
+	let parenDepth = 0;
+	let inString = null;
+	let inLineComment = false;
+	let inBlockComment = false;
+	let escaped = false;
+	for (let index = 0; index < block.length; index += 1) {
+		const char = block[index];
+		const next = block[index + 1];
+		if (inLineComment) {
+			if (char === "\n") inLineComment = false;
+			continue;
+		}
+		if (inBlockComment) {
+			if (char === "*" && next === "/") {
+				inBlockComment = false;
+				index += 1;
+			}
+			continue;
+		}
+		if (inString) {
+			if (escaped) {
+				escaped = false;
+				continue;
+			}
+			if (char === "\\") {
+				escaped = true;
+				continue;
+			}
+			if (char === inString) inString = null;
+			continue;
+		}
+		if (char === "/" && next === "/") {
+			inLineComment = true;
+			index += 1;
+			continue;
+		}
+		if (char === "/" && next === "*") {
+			inBlockComment = true;
+			index += 1;
+			continue;
+		}
+		if (char === "\"" || char === "'" || char === "`") {
+			inString = char;
+			continue;
+		}
+		if (char === "{") {
+			objectDepth += 1;
+			continue;
+		}
+		if (char === "}") {
+			objectDepth = Math.max(0, objectDepth - 1);
+			continue;
+		}
+		if (char === "[") {
+			arrayDepth += 1;
+			continue;
+		}
+		if (char === "]") {
+			arrayDepth = Math.max(0, arrayDepth - 1);
+			continue;
+		}
+		if (char === "(") {
+			parenDepth += 1;
+			continue;
+		}
+		if (char === ")") {
+			parenDepth = Math.max(0, parenDepth - 1);
+			continue;
+		}
+		if (objectDepth !== 0 || arrayDepth !== 0 || parenDepth !== 0) continue;
+		if (!block.startsWith(key, index)) continue;
+		const before = block[index - 1] ?? "";
+		const after = block[index + key.length] ?? "";
+		if (/[A-Za-z0-9_$]/.test(before) || /[A-Za-z0-9_$]/.test(after)) continue;
+		let cursor = index + key.length;
+		while (/\s/.test(block[cursor] ?? "")) cursor += 1;
+		if (block[cursor] !== ":") continue;
+		cursor += 1;
+		while (/\s/.test(block[cursor] ?? "")) cursor += 1;
+		return cursor;
+	}
+}
+function findMatchingObjectEnd(block, start) {
+	let depth = 0;
+	let inString = null;
+	let inLineComment = false;
+	let inBlockComment = false;
+	let escaped = false;
+	for (let index = start; index < block.length; index += 1) {
+		const char = block[index];
+		const next = block[index + 1];
+		if (inLineComment) {
+			if (char === "\n") inLineComment = false;
+			continue;
+		}
+		if (inBlockComment) {
+			if (char === "*" && next === "/") {
+				inBlockComment = false;
+				index += 1;
+			}
+			continue;
+		}
+		if (inString) {
+			if (escaped) {
+				escaped = false;
+				continue;
+			}
+			if (char === "\\") {
+				escaped = true;
+				continue;
+			}
+			if (char === inString) inString = null;
+			continue;
+		}
+		if (char === "/" && next === "/") {
+			inLineComment = true;
+			index += 1;
+			continue;
+		}
+		if (char === "/" && next === "*") {
+			inBlockComment = true;
+			index += 1;
+			continue;
+		}
+		if (char === "\"" || char === "'" || char === "`") {
+			inString = char;
+			continue;
+		}
+		if (char === "{") {
+			depth += 1;
+			continue;
+		}
+		if (char !== "}") continue;
+		depth -= 1;
+		if (depth === 0) return index;
+	}
+}
+
+//#endregion
+export { ensureDocsReviewWorkflow as a, buildDocsReviewWorkflowPathFilters as i, DEFAULT_DOCS_REVIEW_WORKFLOW_PATH as n, readDocsReviewConfigFromSource as o, buildDocsReviewWorkflow as r, resolveDocsReviewConfig as s, DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD as t };

package/dist/{robots-Byj0knC3.mjs → robots-BxZaiGH3.mjs}

@@ -1,7 +1,7 @@
 import "./agent-Dt6kdGqw.mjs";
 import { c as renderDocsRobotsGeneratedBlock, f as upsertDocsRobotsGeneratedBlock, i as DOCS_ROBOTS_GENERATED_BLOCK_START, r as DOCS_ROBOTS_GENERATED_BLOCK_END, u as resolveDocsRobotsConfig } from "./robots-tohhTNbU.mjs";
-import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-Cio3byUJ.mjs";
-import { t as detectFramework } from "./utils-TPe8H1P-.mjs";
+import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, o as readBooleanProperty, t as extractNestedObjectLiteral, u as readStringProperty } from "./config-BHRL4R2v.mjs";
+import { t as detectFramework } from "./utils-x5EtYWjC.mjs";
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import path from "node:path";
 import pc from "picocolors";

package/dist/{search-BQ1cY913.mjs → search-DKpKe0rf.mjs}

@@ -2,7 +2,7 @@ import { n as buildDocsSearchDocuments, r as createAlgoliaSearchAdapter, s as cr
 import "./sitemap-server-DdHzJorR.mjs";
 import { createFilesystemDocsMcpSource } from "./mcp.mjs";
 import "./server.mjs";
-import { a as loadProjectEnv, d as readTopLevelStringProperty, f as resolveDocsConfigPath, p as resolveDocsContentDir } from "./config-Cio3byUJ.mjs";
+import { a as loadProjectEnv, d as readTopLevelStringProperty, f as resolveDocsConfigPath, p as resolveDocsContentDir } from "./config-BHRL4R2v.mjs";
 import { readFileSync } from "node:fs";
 import pc from "picocolors";
 

package/dist/{search-Dqu1Q27e.d.mts → search-Dd0kOr6B.d.mts}

@@ -1,4 +1,4 @@
-import { B as DocsObservabilityEventInput, Et as ResolvedDocsRelatedLink, It as TypesenseDocsSearchConfig, J as DocsSearchConfig, K as DocsSearchAdapterFactory, Q as DocsSearchResult, R as DocsObservabilityConfig, W as DocsSearchAdapter, Y as DocsSearchDocument, _ as DocsAnalyticsConfig, _t as OpenDocsTarget, d as CustomDocsSearchConfig, dt as McpDocsSearchConfig, et as DocsSearchSourcePage, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, mt as OpenDocsProvider, q as DocsSearchChunkingConfig, r as AlgoliaDocsSearchConfig, tt as DocsSitemapConfig, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-Dts3a32G.mjs";
+import { $ as DocsSearchChunkingConfig, B as DocsObservabilityEventInput, Ct as OpenDocsTarget, Ht as TypesenseDocsSearchConfig, Mt as ResolvedDocsRelatedLink, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, X as DocsSearchAdapter, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, bt as OpenDocsProvider, d as CustomDocsSearchConfig, et as DocsSearchConfig, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, r as AlgoliaDocsSearchConfig, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-DtBNjsk2.mjs";
 
 //#region src/cloud-analytics.d.ts
 interface DocsCloudAnalyticsOptions {

package/dist/server.d.mts

@@ -1,5 +1,5 @@
-import { A as DocsConfig, B as DocsObservabilityEventInput, D as DocsAskAIFeedbackMessage, E as DocsAskAIFeedbackData, G as DocsSearchAdapterContext, J as DocsSearchConfig, K as DocsSearchAdapterFactory, O as DocsAskAIFeedbackValue, Q as DocsSearchResult, R as DocsObservabilityConfig, T as DocsAskAIFeedbackConfig, W as DocsSearchAdapter, Y as DocsSearchDocument, Z as DocsSearchQuery, _ as DocsAnalyticsConfig, a as ApiReferenceRenderer, dt as McpDocsSearchConfig, et as DocsSearchSourcePage, g as DocsAgentTraceStatus, h as DocsAgentTraceEventType, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, tt as DocsSitemapConfig, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-Dts3a32G.mjs";
-import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, B as parsePromptStringArray, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, G as serializeOpenDocsProvider, H as sanitizePromptText, I as PromptProviderChoice, J as DocsAgentTraceContext, K as serializeOpenDocsProviders, L as SerializeOpenDocsProviderOptions, M as DEFAULT_OPEN_DOCS_PROVIDER_IDS, N as DEFAULT_OPEN_DOCS_TARGET, O as resolveDocsSitemapPageLastmod, P as DEFAULT_PROMPT_PROVIDER_TEMPLATES, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, U as serializeDocsIcon, V as resolvePromptProviderChoices, W as serializeDocsIconRegistry, X as ResolvedDocsObservabilityConfig, Y as ResolvedDocsAnalyticsConfig, Z as createDocsAgentTraceContext, _ as DocsSitemapFormat, a as createMcpSearchAdapter, at as createDocsCloudAnalytics, b as DocsSitemapPageInput, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAnalyticsEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_XML_ROUTE, h as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, i as createCustomSearchAdapter, it as DocsCloudAnalyticsOptions, j as DEFAULT_OPEN_DOCS_PROMPT, k as resolveDocsSitemapRequest, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_ROUTE, n as buildDocsSearchDocuments, nt as resolveDocsAnalyticsConfig, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as DOCS_AGENT_TRACE_EVENT_TYPES, r as createAlgoliaSearchAdapter, rt as resolveDocsObservabilityConfig, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsObservabilityEvent, u as performDocsSearch, v as DocsSitemapManifest, w as readDocsSitemapManifestFromContentMap, x as DocsSitemapResolvedConfig, y as DocsSitemapManifestPage, z as normalizePromptProviderName } from "./search-Dqu1Q27e.mjs";
+import { A as DocsConfig, B as DocsObservabilityEventInput, D as DocsAskAIFeedbackMessage, E as DocsAskAIFeedbackData, G as DocsReviewRulesConfig, O as DocsAskAIFeedbackValue, Q as DocsSearchAdapterFactory, R as DocsObservabilityConfig, T as DocsAskAIFeedbackConfig, U as DocsReviewCiMode, W as DocsReviewConfig, X as DocsSearchAdapter, Z as DocsSearchAdapterContext, _ as DocsAnalyticsConfig, _t as McpDocsSearchConfig, a as ApiReferenceRenderer, et as DocsSearchConfig, g as DocsAgentTraceStatus, h as DocsAgentTraceEventType, it as DocsSearchResult, k as DocsAskAIMcpConfig, m as DocsAgentTraceEventInput, ot as DocsSearchSourcePage, rt as DocsSearchQuery, st as DocsSitemapConfig, tt as DocsSearchDocument, v as DocsAnalyticsEvent, y as DocsAnalyticsEventInput, z as DocsObservabilityEvent } from "./types-DtBNjsk2.mjs";
+import { $ as emitDocsAgentTraceEvent, A as toDocsSitemapMarkdownUrl, B as parsePromptStringArray, C as createDocsSitemapResponse, D as resolveDocsSitemapConfig, E as renderDocsSitemapXml, F as PromptAction, G as serializeOpenDocsProvider, H as sanitizePromptText, I as PromptProviderChoice, J as DocsAgentTraceContext, K as serializeOpenDocsProviders, L as SerializeOpenDocsProviderOptions, M as DEFAULT_OPEN_DOCS_PROVIDER_IDS, N as DEFAULT_OPEN_DOCS_TARGET, O as resolveDocsSitemapPageLastmod, P as DEFAULT_PROMPT_PROVIDER_TEMPLATES, Q as createDocsAgentTraceId, R as SerializedOpenDocsProvider, S as buildDocsSitemapManifest, T as renderDocsSitemapMarkdown, U as serializeDocsIcon, V as resolvePromptProviderChoices, W as serializeDocsIconRegistry, X as ResolvedDocsObservabilityConfig, Y as ResolvedDocsAnalyticsConfig, Z as createDocsAgentTraceContext, _ as DocsSitemapFormat, a as createMcpSearchAdapter, at as createDocsCloudAnalytics, b as DocsSitemapPageInput, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAnalyticsEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_XML_ROUTE, h as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, i as createCustomSearchAdapter, it as DocsCloudAnalyticsOptions, j as DEFAULT_OPEN_DOCS_PROMPT, k as resolveDocsSitemapRequest, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_ROUTE, n as buildDocsSearchDocuments, nt as resolveDocsAnalyticsConfig, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as DOCS_AGENT_TRACE_EVENT_TYPES, r as createAlgoliaSearchAdapter, rt as resolveDocsObservabilityConfig, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsObservabilityEvent, u as performDocsSearch, v as DocsSitemapManifest, w as readDocsSitemapManifestFromContentMap, x as DocsSitemapResolvedConfig, y as DocsSitemapManifestPage, z as normalizePromptProviderName } from "./search-Dd0kOr6B.mjs";
 import { DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpResolvedConfig, DocsMcpSource, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
 
 //#region src/api-reference.d.ts
@@ -52,7 +52,69 @@ declare function buildApiReferenceOpenApiDocumentAsync(config: DocsConfig, optio
 declare function buildApiReferenceHtmlDocument(config: DocsConfig, options: BuildApiReferenceHtmlOptions): string;
 declare function buildApiReferenceHtmlDocumentAsync(config: DocsConfig, options: BuildApiReferenceHtmlOptions): Promise<string>;
 //#endregion
+//#region src/review.d.ts
+declare const DEFAULT_DOCS_REVIEW_WORKFLOW_PATH = ".github/workflows/docs-review.yml";
+declare const DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD = 80;
+interface ResolvedDocsReviewConfig {
+  enabled: boolean;
+  ci: {
+    enabled: boolean;
+    mode: DocsReviewCiMode;
+    annotations: boolean;
+    comment: boolean;
+  };
+  score: {
+    threshold: number;
+    weights: {
+      error: number;
+      warn: number;
+      suggestion: number;
+    };
+  };
+  rules: Required<DocsReviewRulesConfig>;
+}
+interface DocsReviewWorkflowOptions {
+  packageManager?: "npm" | "pnpm" | "yarn" | "bun";
+  projectDir?: string;
+  configPath?: string;
+  buildCommand?: string;
+  reviewCommand?: string;
+  pathFilters?: string[];
+}
+interface EnsureDocsReviewWorkflowOptions {
+  rootDir: string;
+  config?: DocsConfig;
+  configPath?: string;
+  configContent?: string;
+  workflowPath?: string;
+  log?: (message: string) => void;
+}
+type EnsureDocsReviewWorkflowResult = {
+  status: "created";
+  path: string;
+  relativePath: string;
+} | {
+  status: "exists";
+  path: string;
+  relativePath: string;
+} | {
+  status: "disabled";
+  path: string;
+  relativePath: string;
+};
+declare function resolveDocsReviewConfig(review?: boolean | DocsReviewConfig): ResolvedDocsReviewConfig;
+declare function buildDocsReviewWorkflow(options?: DocsReviewWorkflowOptions): string;
+declare function ensureDocsReviewWorkflow(options: EnsureDocsReviewWorkflowOptions): EnsureDocsReviewWorkflowResult;
+declare function readDocsReviewConfigFromSource(content?: string): boolean | DocsReviewConfig | undefined;
+declare function buildDocsReviewWorkflowPathFilters(options: {
+  rootDir: string;
+  repoRoot?: string;
+  config?: DocsConfig;
+  configPath?: string;
+  configContent?: string;
+}): string[];
+//#endregion
 //#region src/sitemap-server.d.ts
 declare function readDocsSitemapManifest(rootDir: string, sitemap?: boolean | DocsSitemapConfig): DocsSitemapManifest | null;
 //#endregion
-export { type ApiReferenceFramework, type ApiReferenceOpenApiDiscovery, type ApiReferenceRenderer, type ApiReferenceRoute, DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_OPEN_DOCS_PROMPT, DEFAULT_OPEN_DOCS_PROVIDER_IDS, DEFAULT_OPEN_DOCS_TARGET, DEFAULT_PROMPT_PROVIDER_TEMPLATES, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudAnalyticsOptions, type DocsMcpCodeExample, type DocsMcpConfigSchema, type DocsMcpConfigSchemaOption, type DocsMcpDocsList, type DocsMcpDocsPageSummary, type DocsMcpDocsSection, type DocsMcpHttpHandlers, type DocsMcpNavigationNode, type DocsMcpNavigationTree, type DocsMcpPage, type DocsMcpResolvedConfig, type DocsMcpSource, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchQuery, type DocsSearchResult, type DocsSearchSourcePage, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type McpDocsSearchConfig, type PromptAction, type PromptProviderChoice, type ResolvedApiReferenceConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsObservabilityConfig, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };
+export { type ApiReferenceFramework, type ApiReferenceOpenApiDiscovery, type ApiReferenceRenderer, type ApiReferenceRoute, DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD, DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, DEFAULT_OPEN_DOCS_PROMPT, DEFAULT_OPEN_DOCS_PROVIDER_IDS, DEFAULT_OPEN_DOCS_TARGET, DEFAULT_PROMPT_PROVIDER_TEMPLATES, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudAnalyticsOptions, type DocsMcpCodeExample, type DocsMcpConfigSchema, type DocsMcpConfigSchemaOption, type DocsMcpDocsList, type DocsMcpDocsPageSummary, type DocsMcpDocsSection, type DocsMcpHttpHandlers, type DocsMcpNavigationNode, type DocsMcpNavigationTree, type DocsMcpPage, type DocsMcpResolvedConfig, type DocsMcpSource, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchQuery, type DocsSearchResult, type DocsSearchSourcePage, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type McpDocsSearchConfig, type PromptAction, type PromptProviderChoice, type ResolvedApiReferenceConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsObservabilityConfig, type ResolvedDocsReviewConfig, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsReviewWorkflow, buildDocsReviewWorkflowPathFilters, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };