@farming-labs/docs 0.2.60 → 0.2.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/README.md +1 -1
  2. package/package.json +11 -1
  3. package/dist/agent-BFqyqEnC.mjs +0 -4547
  4. package/dist/agent-DlxriaTs.mjs +0 -624
  5. package/dist/agent-evals-kJs2Y9xR.mjs +0 -2144
  6. package/dist/agent-export-BgUaiW8f.mjs +0 -869
  7. package/dist/agent-scope-CCaIY1aK.mjs +0 -283
  8. package/dist/agents-Djh-HXih.mjs +0 -219
  9. package/dist/analytics-Bx44lg6d.mjs +0 -177
  10. package/dist/cli/index.d.mts +0 -15
  11. package/dist/cli/index.mjs +0 -452
  12. package/dist/client/react.d.mts +0 -45
  13. package/dist/client/react.mjs +0 -223
  14. package/dist/cloud-BH_sHX64.mjs +0 -1615
  15. package/dist/cloud-analytics-CSyFE6SS.mjs +0 -132
  16. package/dist/cloud-ask-ai-B2WnG4fF.d.mts +0 -23
  17. package/dist/cloud-ask-ai-hnJfj8-X.mjs +0 -382
  18. package/dist/code-blocks-qe0T8-xe.mjs +0 -871
  19. package/dist/codeblocks-Bq67u32v.mjs +0 -250
  20. package/dist/config-DASewQ0x.mjs +0 -363
  21. package/dist/dev-DgY5xGl9.mjs +0 -1333
  22. package/dist/docs-cloud-server.d.mts +0 -70
  23. package/dist/docs-cloud-server.mjs +0 -310
  24. package/dist/doctor-CO1VMcF_.mjs +0 -1906
  25. package/dist/downgrade-BZs86NVr.mjs +0 -184
  26. package/dist/errors-CVqZ3kOO.mjs +0 -20
  27. package/dist/golden-evaluations-BN9u2wxw.mjs +0 -1483
  28. package/dist/i18n-CAlj1ADU.mjs +0 -40
  29. package/dist/index.d.mts +0 -1099
  30. package/dist/index.mjs +0 -9
  31. package/dist/init-Bd_k06bR.mjs +0 -1233
  32. package/dist/mcp-B_yXL5G5.mjs +0 -137
  33. package/dist/mcp.d.mts +0 -287
  34. package/dist/mcp.mjs +0 -4135
  35. package/dist/metadata-BDuewuzq.mjs +0 -237
  36. package/dist/package-version-qik_4J6C.mjs +0 -128
  37. package/dist/reading-time-BkEft6SD.mjs +0 -741
  38. package/dist/review-NC-sOdXn.mjs +0 -665
  39. package/dist/robots-DskPvGPw.mjs +0 -178
  40. package/dist/robots-ltltiLJF.mjs +0 -197
  41. package/dist/search-C1JitPwi.d.mts +0 -397
  42. package/dist/search-D57JXQLj.mjs +0 -1758
  43. package/dist/search-o4Ud6OXv.mjs +0 -102
  44. package/dist/server.d.mts +0 -341
  45. package/dist/server.mjs +0 -11
  46. package/dist/sitemap-Cq-Yj_iA.mjs +0 -247
  47. package/dist/sitemap-server-C1ibVKOy.mjs +0 -1137
  48. package/dist/templates-DNw15P-x.mjs +0 -2373
  49. package/dist/types-XHABMh_f.d.mts +0 -3248
  50. package/dist/upgrade-BCJTCW3O.mjs +0 -56
  51. package/dist/utils-6UCLxv4B.mjs +0 -225
@@ -1,102 +0,0 @@
1
- import "./agent-BFqyqEnC.mjs";
2
- import { n as buildDocsSearchDocuments, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter } from "./search-D57JXQLj.mjs";
3
- import "./sitemap-server-C1ibVKOy.mjs";
4
- import "./agent-evals-kJs2Y9xR.mjs";
5
- import { createFilesystemDocsMcpSource } from "./mcp.mjs";
6
- import "./code-blocks-qe0T8-xe.mjs";
7
- import "./server.mjs";
8
- import { h as resolveDocsContentDir, m as resolveDocsConfigPath, o as loadProjectEnv, p as readTopLevelStringProperty } from "./config-DASewQ0x.mjs";
9
- import { readFileSync } from "node:fs";
10
- import pc from "picocolors";
11
-
12
- //#region src/cli/search.ts
13
- function getEnvValue(loadedEnv, key) {
14
- return process.env[key] ?? loadedEnv[key];
15
- }
16
- function resolveSearchSyncProvider(options, loadedEnv) {
17
- if (options.typesense && options.algolia) throw new Error("Use only one provider flag: --typesense or --algolia.");
18
- if (options.typesense) return "typesense";
19
- if (options.algolia) return "algolia";
20
- if (options.provider === "typesense" || options.provider === "algolia") return options.provider;
21
- if (options.provider) throw new Error(`Unsupported search provider: ${options.provider}.`);
22
- if (options.baseUrl || getEnvValue(loadedEnv, "TYPESENSE_URL")) return "typesense";
23
- if (options.appId || getEnvValue(loadedEnv, "ALGOLIA_APP_ID")) return "algolia";
24
- throw new Error("Could not determine a search provider. Use --typesense, --algolia, or --provider <name>.");
25
- }
26
- function resolveTypesenseSyncConfig(options, loadedEnv) {
27
- const baseUrl = options.baseUrl ?? getEnvValue(loadedEnv, "TYPESENSE_URL") ?? getEnvValue(loadedEnv, "TYPESENSE_BASE_URL");
28
- const collection = options.collection ?? getEnvValue(loadedEnv, "TYPESENSE_COLLECTION") ?? "docs";
29
- const apiKey = options.apiKey ?? getEnvValue(loadedEnv, "TYPESENSE_SEARCH_API_KEY") ?? getEnvValue(loadedEnv, "TYPESENSE_API_KEY");
30
- const adminApiKey = options.adminApiKey ?? getEnvValue(loadedEnv, "TYPESENSE_ADMIN_API_KEY") ?? getEnvValue(loadedEnv, "TYPESENSE_API_KEY");
31
- const mode = options.mode === "hybrid" ? "hybrid" : "keyword";
32
- const ollamaModel = options.ollamaModel ?? getEnvValue(loadedEnv, "TYPESENSE_OLLAMA_MODEL");
33
- const ollamaBaseUrl = options.ollamaBaseUrl ?? getEnvValue(loadedEnv, "TYPESENSE_OLLAMA_BASE_URL");
34
- if (!baseUrl) throw new Error("Missing Typesense base URL. Set TYPESENSE_URL or pass --base-url.");
35
- if (!apiKey) throw new Error("Missing Typesense API key. Set TYPESENSE_API_KEY or pass --api-key.");
36
- if (!adminApiKey) throw new Error("Missing Typesense admin-capable key for sync. Set TYPESENSE_ADMIN_API_KEY or pass --admin-api-key.");
37
- return {
38
- provider: "typesense",
39
- baseUrl,
40
- collection,
41
- apiKey,
42
- adminApiKey,
43
- mode,
44
- ...mode === "hybrid" ? ollamaModel ? { embeddings: {
45
- provider: "ollama",
46
- model: ollamaModel,
47
- baseUrl: ollamaBaseUrl
48
- } } : (() => {
49
- throw new Error("Typesense hybrid sync needs an embeddings model. Set TYPESENSE_OLLAMA_MODEL or pass --ollama-model.");
50
- })() : {}
51
- };
52
- }
53
- function resolveAlgoliaSyncConfig(options, loadedEnv) {
54
- const appId = options.appId ?? getEnvValue(loadedEnv, "ALGOLIA_APP_ID");
55
- const indexName = options.indexName ?? getEnvValue(loadedEnv, "ALGOLIA_INDEX_NAME") ?? "docs";
56
- const adminApiKey = options.adminApiKey ?? getEnvValue(loadedEnv, "ALGOLIA_ADMIN_API_KEY");
57
- const searchApiKey = options.searchApiKey ?? getEnvValue(loadedEnv, "ALGOLIA_SEARCH_API_KEY") ?? adminApiKey;
58
- if (!appId) throw new Error("Missing Algolia app id. Set ALGOLIA_APP_ID or pass --app-id.");
59
- if (!adminApiKey) throw new Error("Missing Algolia admin API key for sync. Set ALGOLIA_ADMIN_API_KEY or pass --admin-api-key.");
60
- if (!searchApiKey) throw new Error("Missing Algolia search API key. Set ALGOLIA_SEARCH_API_KEY or pass --search-api-key.");
61
- return {
62
- provider: "algolia",
63
- appId,
64
- indexName,
65
- searchApiKey,
66
- adminApiKey
67
- };
68
- }
69
- async function syncSearch(options = {}) {
70
- const rootDir = process.cwd();
71
- const configContent = readFileSync(resolveDocsConfigPath(rootDir, options.configPath), "utf-8");
72
- const loadedEnv = loadProjectEnv(rootDir);
73
- const provider = resolveSearchSyncProvider(options, loadedEnv);
74
- const entry = readTopLevelStringProperty(configContent, "entry") ?? "docs";
75
- const contentDir = resolveDocsContentDir(rootDir, configContent, entry);
76
- const source = createFilesystemDocsMcpSource({
77
- rootDir,
78
- entry,
79
- contentDir,
80
- siteTitle: "Documentation"
81
- });
82
- const pages = await source.getPages();
83
- const documents = buildDocsSearchDocuments(pages);
84
- const context = {
85
- pages,
86
- documents,
87
- siteTitle: source.siteTitle
88
- };
89
- if (documents.length === 0) throw new Error(`No docs content was found under ${contentDir}.`);
90
- if (provider === "typesense") {
91
- const config = resolveTypesenseSyncConfig(options, loadedEnv);
92
- await createTypesenseSearchAdapter(config).index?.(context);
93
- console.log(pc.green(`Synced ${documents.length} docs search documents to Typesense collection "${config.collection}".`));
94
- return;
95
- }
96
- const config = resolveAlgoliaSyncConfig(options, loadedEnv);
97
- await createAlgoliaSearchAdapter(config).index?.(context);
98
- console.log(pc.green(`Synced ${documents.length} docs search documents to Algolia index "${config.indexName}".`));
99
- }
100
-
101
- //#endregion
102
- export { syncSearch };
package/dist/server.d.mts DELETED
@@ -1,341 +0,0 @@
1
- import { A as DocsAgentGoldenTaskExpectation, At as DocsReviewRulesConfig, Bt as DocsSearchDocument, Ct as DocsObservabilityConfig, D as DocsAgentGoldenExampleVerification, E as DocsAgentGoldenAnswerExpectation, F as DocsAnalyticsConfig, Ft as DocsSearchAdapter, G as DocsAskAIFeedbackMessage, Gt as DocsSearchSourcePage, Ht as DocsSearchQuery, I as DocsAnalyticsEvent, It as DocsSearchAdapterContext, K as DocsAskAIFeedbackValue, Kt as DocsSitemapConfig, L as DocsAnalyticsEventInput, Lt as DocsSearchAdapterFactory, M as DocsAgentTraceEventInput, N as DocsAgentTraceEventType, O as DocsAgentGoldenExpectedExample, Ot as DocsReviewCiMode, P as DocsAgentTraceStatus, S as DocsAgentEvaluationTaskInput, Tt as DocsObservabilityEventInput, U as DocsAskAIFeedbackConfig, Ut as DocsSearchResult, W as DocsAskAIFeedbackData, _ as DocsAgentEvaluationAnswerRequest, a as ApiReferenceRenderer, b as DocsAgentEvaluationSourceReference, g as DocsAgentEvaluationAnswerProvider, h as DocsAgentEvaluationAnswerInput, it as DocsCodeBlocksValidateConfig, j as DocsAgentGoldenTaskFilters, k as DocsAgentGoldenTask, kt as DocsReviewConfig, ln as McpDocsSearchConfig, q as DocsAskAIMcpConfig, st as DocsConfig, tt as DocsCodeBlocksPlannerProvider, v as DocsAgentEvaluationAnswerResult, wt as DocsObservabilityEvent, x as DocsAgentEvaluationSurface, y as DocsAgentEvaluationAnswerRunner, zt as DocsSearchConfig } from "./types-XHABMh_f.mjs";
2
- import { i as isDocsCloudAskAIProvider, n as DocsCloudAskAIResponseOptions, r as createDocsCloudAskAIResponse, t as DocsCloudAskAIConfig } from "./cloud-ask-ai-B2WnG4fF.mjs";
3
- import { DocsCloudAskAIOptions, DocsCloudPublicConfig, DocsCloudRouteHandlerOptions, DocsCloudRouteHandlers, DocsCloudRuntimeEnv, DocsCloudRuntimeValue, DocsCloudServer, DocsCloudServerOptions, DocsCloudTrackEventOptions, createDocsCloudRouteHandler, createDocsCloudServer } from "./docs-cloud-server.mjs";
4
- import { A as resolveDocsSitemapRequest, B as normalizePromptProviderName, Bt as emitDocsObservabilityEvent, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, F as DEFAULT_PROMPT_PROVIDER_TEMPLATES, Ft as ResolvedDocsObservabilityConfig, G as serializeDocsIconRegistry, H as resolvePromptProviderChoices, Ht as resolveDocsAnalyticsConfig, I as PromptAction, It as createDocsAgentTraceContext, K as serializeOpenDocsProvider, L as PromptProviderChoice, Lt as createDocsAgentTraceId, M as DEFAULT_OPEN_DOCS_PROMPT, Mt as DOCS_AGENT_TRACE_EVENT_TYPES, N as DEFAULT_OPEN_DOCS_PROVIDER_IDS, Nt as DocsAgentTraceContext, O as resolveDocsSitemapConfig, P as DEFAULT_OPEN_DOCS_TARGET, Pt as ResolvedDocsAnalyticsConfig, R as SerializeOpenDocsProviderOptions, Rt as emitDocsAgentTraceEvent, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, U as sanitizePromptText, Ut as resolveDocsObservabilityConfig, V as parsePromptStringArray, Vt as getDocsRequestAnalyticsProperties, W as serializeDocsIcon, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, q as serializeOpenDocsProviders, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider, zt as emitDocsAnalyticsEvent } from "./search-C1JitPwi.mjs";
5
- import { CreateDocsMcpServerOptions, DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, DOCS_CONFIG_SCHEMA_OPTIONS, DocsMcpAgentContractSummary, DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpContextResult, DocsMcpContextSource, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpRequestContext, DocsMcpResolvedConfig, DocsMcpResolvedCorsConfig, DocsMcpResolvedSecurityConfig, DocsMcpSource, DocsMcpTaskSummary, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, getDocsConfigSchema, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
6
-
7
- //#region src/code-group-mdx.d.ts
8
- interface MarkdownNode {
9
- type: string;
10
- name?: string;
11
- children?: MarkdownNode[];
12
- lang?: string | null;
13
- meta?: string | null;
14
- }
15
- declare function remarkCodeGroup(): (tree: MarkdownNode) => void;
16
- //#endregion
17
- //#region src/api-reference.d.ts
18
- type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "HEAD";
19
- type ApiReferenceFramework = "next" | "tanstack-start" | "sveltekit" | "astro" | "nuxt";
20
- interface ApiReferenceRoute {
21
- title: string;
22
- summary: string;
23
- description?: string;
24
- routePath: string;
25
- sourceFile: string;
26
- methods: HttpMethod[];
27
- tag: string;
28
- parameters: Array<Record<string, unknown>>;
29
- }
30
- interface ResolvedApiReferenceConfig {
31
- enabled: boolean;
32
- path: string;
33
- specUrl?: string;
34
- renderer?: ApiReferenceRenderer;
35
- routeRoot: string;
36
- exclude: string[];
37
- }
38
- interface ApiReferenceOpenApiDiscovery {
39
- enabled: boolean;
40
- url?: string;
41
- urlSource?: "default" | "configured";
42
- source?: "generated" | "configured";
43
- specUrl?: string;
44
- apiReferencePath?: string;
45
- }
46
- interface BuildApiReferenceOptions {
47
- framework: ApiReferenceFramework;
48
- rootDir?: string;
49
- baseUrl?: string;
50
- }
51
- interface BuildApiReferenceHtmlOptions extends BuildApiReferenceOptions {
52
- title?: string;
53
- }
54
- declare const DEFAULT_API_REFERENCE_OPENAPI_ROUTE = "/api/docs?format=openapi";
55
- declare function resolveApiReferenceConfig(value: DocsConfig["apiReference"]): ResolvedApiReferenceConfig;
56
- declare function resolveApiReferenceRenderer(value: DocsConfig["apiReference"], framework: ApiReferenceFramework): ApiReferenceRenderer;
57
- declare function resolveApiReferenceOpenApiDiscovery(value: DocsConfig["apiReference"], options?: {
58
- route?: string;
59
- }): ApiReferenceOpenApiDiscovery;
60
- declare function isApiReferenceOpenApiRequest(url: URL): boolean;
61
- declare function buildApiReferencePageTitle(config: DocsConfig, title?: string): string;
62
- declare function buildApiReferenceScalarCss(config: DocsConfig): string;
63
- declare function buildApiReferenceOpenApiDocument(config: DocsConfig, options: BuildApiReferenceOptions): Record<string, unknown>;
64
- declare function buildApiReferenceOpenApiDocumentAsync(config: DocsConfig, options: BuildApiReferenceOptions): Promise<Record<string, unknown>>;
65
- declare function buildApiReferenceHtmlDocument(config: DocsConfig, options: BuildApiReferenceHtmlOptions): string;
66
- declare function buildApiReferenceHtmlDocumentAsync(config: DocsConfig, options: BuildApiReferenceHtmlOptions): Promise<string>;
67
- //#endregion
68
- //#region src/review.d.ts
69
- declare const DEFAULT_DOCS_REVIEW_WORKFLOW_PATH = ".github/workflows/docs-review.yml";
70
- declare const DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD = 80;
71
- interface ResolvedDocsReviewConfig {
72
- enabled: boolean;
73
- ci: {
74
- enabled: boolean;
75
- name: string;
76
- mode: DocsReviewCiMode;
77
- annotations: boolean;
78
- comment: boolean;
79
- };
80
- score: {
81
- threshold: number;
82
- weights: {
83
- error: number;
84
- warn: number;
85
- suggestion: number;
86
- };
87
- };
88
- rules: Required<DocsReviewRulesConfig>;
89
- }
90
- interface DocsReviewWorkflowOptions {
91
- packageManager?: "npm" | "pnpm" | "yarn" | "bun";
92
- ciName?: string;
93
- reusableWorkflow?: string;
94
- pnpmVersion?: string;
95
- projectDir?: string;
96
- configPath?: string;
97
- buildCommand?: string;
98
- reviewCommand?: string;
99
- pathFilters?: string[];
100
- }
101
- interface EnsureDocsReviewWorkflowOptions {
102
- rootDir: string;
103
- config?: DocsConfig;
104
- configPath?: string;
105
- configContent?: string;
106
- workflowPath?: string;
107
- log?: (message: string) => void;
108
- }
109
- type EnsureDocsReviewWorkflowResult = {
110
- status: "created";
111
- path: string;
112
- relativePath: string;
113
- } | {
114
- status: "exists";
115
- path: string;
116
- relativePath: string;
117
- } | {
118
- status: "disabled";
119
- path: string;
120
- relativePath: string;
121
- };
122
- declare function resolveDocsReviewConfig(review?: boolean | DocsReviewConfig): ResolvedDocsReviewConfig;
123
- declare function buildDocsReviewWorkflow(options?: DocsReviewWorkflowOptions): string;
124
- declare function ensureDocsReviewWorkflow(options: EnsureDocsReviewWorkflowOptions): EnsureDocsReviewWorkflowResult;
125
- declare function readDocsReviewConfigFromSource(content?: string): boolean | DocsReviewConfig | undefined;
126
- declare function buildDocsReviewWorkflowPathFilters(options: {
127
- rootDir: string;
128
- repoRoot?: string;
129
- config?: DocsConfig;
130
- configPath?: string;
131
- configContent?: string;
132
- }): string[];
133
- //#endregion
134
- //#region src/code-blocks.d.ts
135
- interface DocsCodeBlockTarget {
136
- id: string;
137
- filePath: string;
138
- relativePath: string;
139
- lineStart: number;
140
- lineEnd: number;
141
- language?: string;
142
- title?: string;
143
- framework?: string;
144
- packageManager?: string;
145
- runnable: boolean;
146
- env: string[];
147
- meta: Record<string, string | boolean>;
148
- code: string;
149
- }
150
- interface DocsCodeBlockCommand {
151
- cmd: string;
152
- args: string[];
153
- }
154
- interface DocsCodeBlockExecutionPlan {
155
- id: string;
156
- target: DocsCodeBlockTarget;
157
- action: "execute" | "validate-syntax" | "skip";
158
- template: string;
159
- runtime?: string;
160
- filePath?: string;
161
- command?: DocsCodeBlockCommand;
162
- requiredEnv: string[];
163
- reason?: string;
164
- planner: DocsCodeBlocksPlannerProvider;
165
- }
166
- type DocsCodeBlockValidationStatus = "PLAN" | "PASS" | "SKIP" | "FAIL";
167
- interface DocsCodeBlockValidationResult {
168
- id: string;
169
- target: DocsCodeBlockTarget;
170
- plan: DocsCodeBlockExecutionPlan;
171
- status: DocsCodeBlockValidationStatus;
172
- stdout?: string;
173
- stderr?: string;
174
- exitCode?: number | null;
175
- reason?: string;
176
- }
177
- type OptionalModuleImporter = (specifier: string) => Promise<unknown>;
178
- declare global {
179
- var __DOCS_CODE_BLOCKS_MODULE_IMPORTER__: OptionalModuleImporter | undefined;
180
- }
181
- //#endregion
182
- //#region src/agent-evals.d.ts
183
- type DocsGoldenEvaluationStatus = "unmeasured" | "passed" | "failed";
184
- type DocsGoldenTaskFilters = DocsAgentGoldenTaskFilters;
185
- type DocsGoldenExpectedExample = DocsAgentGoldenExpectedExample;
186
- type DocsGoldenTaskExpectation = DocsAgentGoldenTaskExpectation;
187
- type DocsGoldenTask = DocsAgentGoldenTask;
188
- interface DocsGoldenRetrievedSource {
189
- rank: number;
190
- url: string;
191
- title: string;
192
- framework?: string;
193
- version?: string;
194
- utf8Bytes: number;
195
- relevant: boolean;
196
- truncated: boolean;
197
- }
198
- interface DocsGoldenRetrievalMetrics {
199
- expectedRelevant: number;
200
- retrievedRelevant: number;
201
- recallAtK: number;
202
- firstRelevantRank: number | null;
203
- reciprocalRank: number;
204
- forbiddenSources: string[];
205
- passed: boolean;
206
- }
207
- interface DocsGoldenCitationMetrics {
208
- /** Where the citation evidence came from. Context/results are not model-answer citations. */
209
- evidence: "context" | "results";
210
- expected: string[];
211
- actual: string[];
212
- missing: string[];
213
- unexpected: string[];
214
- precision: number;
215
- recall: number;
216
- /** True when every rendered Source line maps one-to-one to a returned source record. */
217
- integrity: boolean;
218
- passed: boolean;
219
- }
220
- interface DocsGoldenSelectionMetrics {
221
- requestedFramework?: string;
222
- requestedVersion?: string;
223
- requestedLocale?: string;
224
- expectedFramework?: string;
225
- expectedVersion?: string;
226
- expectedLocale?: string;
227
- firstFrameworkMatchRank: number | null;
228
- firstVersionMatchRank: number | null;
229
- firstLocaleMatchRank: number | null;
230
- conflictingSources: string[];
231
- ambiguousSources: string[];
232
- passed: boolean;
233
- }
234
- interface DocsGoldenExampleResult {
235
- expected: DocsGoldenExpectedExample;
236
- matchedId?: string;
237
- source?: string;
238
- verification: "present" | "syntax" | "execute";
239
- status: "passed" | "failed" | "skipped";
240
- reason?: string;
241
- syntaxValid: boolean;
242
- executed: boolean;
243
- executionStatus?: DocsCodeBlockValidationResult["status"];
244
- /** @deprecated Static/planner executability signal retained for report compatibility. */
245
- executable: boolean;
246
- passed: boolean;
247
- }
248
- interface DocsGoldenExampleMetrics {
249
- expected: number;
250
- matched: number;
251
- syntaxValid: number;
252
- executed: number;
253
- /** @deprecated Count of statically/planner-executable examples retained for compatibility. */
254
- executable: number;
255
- results: DocsGoldenExampleResult[];
256
- passed: boolean;
257
- }
258
- interface DocsGoldenUsageMetrics {
259
- budgetUnit: "utf8-bytes";
260
- tokenBudget: number;
261
- usedUtf8Bytes: number;
262
- remainingUtf8Bytes: number;
263
- estimatedTokens: number;
264
- /** Exact conservative upper bound: one token per UTF-8 byte. */
265
- conservativeTokenUpperBound: number;
266
- usefulUtf8Bytes: number;
267
- usefulByteRatio: number;
268
- truncated: boolean;
269
- withinBudget: boolean;
270
- passed: boolean;
271
- }
272
- interface DocsGoldenAnswerMetrics {
273
- evidence: "answer";
274
- expected: boolean;
275
- provided: boolean;
276
- textIncludesMissing: string[];
277
- textExcludesPresent: string[];
278
- citations: string[];
279
- requiredCitations: string[];
280
- missingCitations: string[];
281
- unexpectedCitations: string[];
282
- forbiddenCitations: string[];
283
- passed: boolean;
284
- }
285
- interface DocsGoldenTaskReport {
286
- id: string;
287
- query: string;
288
- surface: DocsAgentEvaluationSurface;
289
- provider: string;
290
- status: "passed" | "failed";
291
- passed: boolean;
292
- score: number;
293
- context: string;
294
- sources: DocsGoldenRetrievedSource[];
295
- retrieval: DocsGoldenRetrievalMetrics;
296
- citations: DocsGoldenCitationMetrics;
297
- answer: DocsGoldenAnswerMetrics;
298
- selection: DocsGoldenSelectionMetrics;
299
- examples: DocsGoldenExampleMetrics;
300
- usage: DocsGoldenUsageMetrics;
301
- issues: string[];
302
- }
303
- interface DocsGoldenTasksReport {
304
- status: DocsGoldenEvaluationStatus;
305
- passed: boolean | null;
306
- score: number | null;
307
- taskCount: number;
308
- passedTaskCount: number;
309
- failedTaskCount: number;
310
- tasks: DocsGoldenTaskReport[];
311
- }
312
- interface RunDocsGoldenTasksOptions {
313
- /** Default evaluation surface. Tasks may override this with `task.surface`. */
314
- surface?: DocsAgentEvaluationSurface;
315
- /** Search configuration used by configured-search and ask-ai-context. */
316
- search?: boolean | DocsSearchConfig;
317
- /** Production-resolved Ask AI retrieval config, including `ai.useMcp`. */
318
- askAISearch?: boolean | DocsSearchConfig;
319
- siteTitle?: string;
320
- baseUrl?: string;
321
- rootDir?: string;
322
- /** Permit external configured search or HTTP answer calls. @default false */
323
- allowNetwork?: boolean;
324
- /** Per-task configured-search/Ask-AI retrieval timeout in milliseconds. @default 30000 */
325
- searchTimeoutMs?: number;
326
- /** Project code-block validation config used only by explicit execute expectations. */
327
- codeBlocksValidate?: boolean | DocsCodeBlocksValidateConfig;
328
- /** Optional actual-answer runner. No model or HTTP request is made when omitted. */
329
- answer?: DocsAgentEvaluationAnswerProvider;
330
- }
331
- /**
332
- * Run offline-by-default golden-task evaluations against MCP-ready docs pages.
333
- * Configured external retrieval, HTTP answers, and runtime execution require explicit opt-in.
334
- * An empty task list is intentionally unmeasured so CI cannot turn absent coverage into a pass.
335
- */
336
- declare function runDocsGoldenTasks(pages: readonly DocsMcpPage[], tasks: readonly DocsGoldenTask[] | undefined, options?: RunDocsGoldenTasksOptions): Promise<DocsGoldenTasksReport>;
337
- //#endregion
338
- //#region src/sitemap-server.d.ts
339
- declare function readDocsSitemapManifest(rootDir: string, sitemap?: boolean | DocsSitemapConfig): DocsSitemapManifest | null;
340
- //#endregion
341
- export { type ApiReferenceFramework, type ApiReferenceOpenApiDiscovery, type ApiReferenceRenderer, type ApiReferenceRoute, type CreateDocsMcpServerOptions, DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, 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_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_CONFIG_SCHEMA_OPTIONS, type DocsAgentEvaluationAnswerInput, type DocsAgentEvaluationAnswerProvider, type DocsAgentEvaluationAnswerRequest, type DocsAgentEvaluationAnswerResult, type DocsAgentEvaluationAnswerRunner, type DocsAgentEvaluationSourceReference, type DocsAgentEvaluationSurface, type DocsAgentEvaluationTaskInput, type DocsAgentGoldenAnswerExpectation, type DocsAgentGoldenExampleVerification, 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 DocsCloudAskAIConfig, type DocsCloudAskAIOptions, type DocsCloudAskAIResponseOptions, type DocsCloudPublicConfig, type DocsCloudRouteHandlerOptions, type DocsCloudRouteHandlers, type DocsCloudRuntimeEnv, type DocsCloudRuntimeValue, type DocsCloudServer, type DocsCloudServerOptions, type DocsCloudTrackEventOptions, type DocsGoldenAnswerMetrics, type DocsGoldenCitationMetrics, type DocsGoldenEvaluationStatus, type DocsGoldenExampleMetrics, type DocsGoldenExampleResult, type DocsGoldenExpectedExample, type DocsGoldenRetrievalMetrics, type DocsGoldenRetrievedSource, type DocsGoldenSelectionMetrics, type DocsGoldenTask, type DocsGoldenTaskExpectation, type DocsGoldenTaskFilters, type DocsGoldenTaskReport, type DocsGoldenTasksReport, type DocsGoldenUsageMetrics, type DocsMcpAgentContractSummary, type DocsMcpCodeExample, type DocsMcpConfigSchema, type DocsMcpConfigSchemaOption, type DocsMcpContextResult, type DocsMcpContextSource, type DocsMcpDocsList, type DocsMcpDocsPageSummary, type DocsMcpDocsSection, type DocsMcpHttpHandlers, type DocsMcpNavigationNode, type DocsMcpNavigationTree, type DocsMcpPage, type DocsMcpRequestContext, type DocsMcpResolvedConfig, type DocsMcpResolvedCorsConfig, type DocsMcpResolvedSecurityConfig, type DocsMcpSource, type DocsMcpTaskSummary, 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 RunDocsGoldenTasksOptions, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsReviewWorkflow, buildDocsReviewWorkflowPathFilters, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAskAIResponse, createDocsCloudRouteHandler, createDocsCloudServer, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, getDocsConfigSchema, getDocsRequestAnalyticsProperties, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, isDocsCloudAskAIProvider, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, remarkCodeGroup, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsGoldenTasks, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };
package/dist/server.mjs DELETED
@@ -1,11 +0,0 @@
1
- import { a as emitDocsAnalyticsEvent, c as resolveDocsAnalyticsConfig, i as emitDocsAgentTraceEvent, l as resolveDocsObservabilityConfig, n as createDocsAgentTraceContext, o as emitDocsObservabilityEvent, r as createDocsAgentTraceId, s as getDocsRequestAnalyticsProperties, t as DOCS_AGENT_TRACE_EVENT_TYPES } from "./analytics-Bx44lg6d.mjs";
2
- import { At as DEFAULT_SITEMAP_MD_DOCS_ROUTE, Bt as resolveDocsSitemapPageLastmod, Ft as createDocsSitemapResponse, Ht as toDocsSitemapMarkdownUrl, It as readDocsSitemapManifestFromContentMap, Lt as renderDocsSitemapMarkdown, Mt as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, Nt as DEFAULT_SITEMAP_XML_ROUTE, Pt as buildDocsSitemapManifest, Rt as renderDocsSitemapXml, Vt as resolveDocsSitemapRequest, jt as DEFAULT_SITEMAP_MD_ROUTE, kt as DEFAULT_SITEMAP_MANIFEST_PATH, zt as resolveDocsSitemapConfig } from "./agent-BFqyqEnC.mjs";
3
- import { a as createMcpSearchAdapter, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, i as createCustomSearchAdapter, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch } from "./search-D57JXQLj.mjs";
4
- import { C as resolveApiReferenceOpenApiDiscovery, S as resolveApiReferenceConfig, T as remarkCodeGroup, _ as buildApiReferenceOpenApiDocument, a as DEFAULT_PROMPT_PROVIDER_TEMPLATES, b as buildApiReferenceScalarCss, c as resolvePromptProviderChoices, d as serializeDocsIconRegistry, f as serializeOpenDocsProvider, g as buildApiReferenceHtmlDocumentAsync, h as buildApiReferenceHtmlDocument, i as DEFAULT_OPEN_DOCS_TARGET, l as sanitizePromptText, m as DEFAULT_API_REFERENCE_OPENAPI_ROUTE, n as DEFAULT_OPEN_DOCS_PROMPT, o as normalizePromptProviderName, p as serializeOpenDocsProviders, r as DEFAULT_OPEN_DOCS_PROVIDER_IDS, s as parsePromptStringArray, t as readDocsSitemapManifest, u as serializeDocsIcon, v as buildApiReferenceOpenApiDocumentAsync, w as resolveApiReferenceRenderer, x as isApiReferenceOpenApiRequest, y as buildApiReferencePageTitle } from "./sitemap-server-C1ibVKOy.mjs";
5
- import { a as buildDocsReviewWorkflowPathFilters, c as resolveDocsReviewConfig, i as buildDocsReviewWorkflow, n as DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD, o as ensureDocsReviewWorkflow, r as DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, s as readDocsReviewConfigFromSource, t as runDocsGoldenTasks } from "./agent-evals-kJs2Y9xR.mjs";
6
- import { DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, DOCS_CONFIG_SCHEMA_OPTIONS, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, getDocsConfigSchema, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
7
- import { n as isDocsCloudAskAIProvider, t as createDocsCloudAskAIResponse } from "./cloud-ask-ai-hnJfj8-X.mjs";
8
- import { createDocsCloudRouteHandler, createDocsCloudServer } from "./docs-cloud-server.mjs";
9
- import "./code-blocks-qe0T8-xe.mjs";
10
-
11
- export { DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, 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_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_CONFIG_SCHEMA_OPTIONS, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsReviewWorkflow, buildDocsReviewWorkflowPathFilters, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAskAIResponse, createDocsCloudRouteHandler, createDocsCloudServer, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, getDocsConfigSchema, getDocsRequestAnalyticsProperties, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, isDocsCloudAskAIProvider, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, remarkCodeGroup, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsGoldenTasks, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };