@farming-labs/docs 0.2.61 → 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.
- package/package.json +1 -1
- package/dist/agent-DFHlw_JC.mjs +0 -624
- package/dist/agent-Fl0pjVNF.mjs +0 -4352
- package/dist/agent-evals-f4_OL10T.mjs +0 -2144
- package/dist/agent-export-D0zQhasD.mjs +0 -910
- package/dist/agent-scope-C_U--OZ7.mjs +0 -283
- package/dist/agent-skills-bundle.d.mts +0 -13
- package/dist/agent-skills-bundle.mjs +0 -12
- package/dist/agent-skills-server-CIeBszxp.mjs +0 -263
- package/dist/agent-skills-server-CKq3_jMj.d.mts +0 -12
- package/dist/agent-skills-vite.d.mts +0 -31
- package/dist/agent-skills-vite.mjs +0 -70
- package/dist/agents-ibnXrWyp.mjs +0 -221
- package/dist/analytics-Bx44lg6d.mjs +0 -177
- package/dist/cli/index.d.mts +0 -15
- package/dist/cli/index.mjs +0 -452
- package/dist/client/react.d.mts +0 -45
- package/dist/client/react.mjs +0 -223
- package/dist/cloud-analytics-CSyFE6SS.mjs +0 -132
- package/dist/cloud-ask-ai-D7ZgF47y.d.mts +0 -23
- package/dist/cloud-ask-ai-sbpjOR2K.mjs +0 -382
- package/dist/cloud-pdNC-tyj.mjs +0 -1615
- package/dist/code-blocks-DnNVNK2M.mjs +0 -871
- package/dist/codeblocks-CFuurVIH.mjs +0 -250
- package/dist/config-Wcdj-D0a.mjs +0 -369
- package/dist/dev-Cmy6DtdF.mjs +0 -1333
- package/dist/docs-cloud-server.d.mts +0 -70
- package/dist/docs-cloud-server.mjs +0 -310
- package/dist/doctor-CXostbsI.mjs +0 -2036
- package/dist/downgrade-w7e6Se0L.mjs +0 -184
- package/dist/errors-DbOhkE1h.mjs +0 -20
- package/dist/golden-evaluations-CBZ_JZjf.mjs +0 -1498
- package/dist/i18n-CCaFUnAN.mjs +0 -40
- package/dist/index.d.mts +0 -1141
- package/dist/index.mjs +0 -10
- package/dist/init-CQY0Woe3.mjs +0 -1264
- package/dist/mcp-DyPcoLwm.mjs +0 -156
- package/dist/mcp.d.mts +0 -298
- package/dist/mcp.mjs +0 -4426
- package/dist/metadata-Dv1ah0Aj.mjs +0 -237
- package/dist/package-version-n5AFur8a.mjs +0 -128
- package/dist/reading-time-C-SAhQT9.mjs +0 -742
- package/dist/review-D2UBrxFq.mjs +0 -673
- package/dist/robots-5Yqz9mz7.mjs +0 -179
- package/dist/robots-C08kDLsz.mjs +0 -201
- package/dist/search-9OnMGMvt.mjs +0 -1758
- package/dist/search-C6heDO8h.d.mts +0 -274
- package/dist/search-CNsRpz90.mjs +0 -104
- package/dist/server.d.mts +0 -342
- package/dist/server.mjs +0 -13
- package/dist/sitemap-BpYnSsfJ.mjs +0 -249
- package/dist/sitemap-server-D_0Kzanj.mjs +0 -1137
- package/dist/standards-discovery-C4HUqMd2.d.mts +0 -227
- package/dist/standards-discovery-C54V_aJH.mjs +0 -510
- package/dist/templates-Bq_P7ctv.mjs +0 -2465
- package/dist/types-EhFhYGfr.d.mts +0 -3305
- package/dist/upgrade-oz-GChgt.mjs +0 -56
- package/dist/utils-DpiIioYb.mjs +0 -225
package/dist/index.d.mts
DELETED
|
@@ -1,1141 +0,0 @@
|
|
|
1
|
-
import { A as DocsPublishedAgentSkill, B as createDocsStandardsResponse, C as DocsAgentSkillIndexEntry, D as DocsApiCatalogLinkTarget, E as DocsApiCatalogLinkContext, F as appendDocsDiscoveryLinkHeader, G as resolveDocsStandardsDiscoveryRequest, H as isDocsStandardsDiscoveryRequest, I as buildDocsA2AAgentCard, K as sha256DocsDiscoveryContent, L as buildDocsAgentSkillsIndex, M as DocsPublishedAgentSkillOptions, N as DocsStandardsDiscoveryRequest, O as DocsApiCatalogOptions, P as DocsStandardsDiscoveryRouteOptions, R as buildDocsApiCatalog, S as DocsA2AAgentCardOptions, T as DocsApiCatalog, U as resolveDocsDiscoveryApiRoute, V as getDocsDiscoveryLinkHeader, W as resolveDocsPublishedAgentSkill, _ as DEFAULT_API_CATALOG_ROUTE, a as DEFAULT_A2A_AGENT_CARD_FORMAT, b as DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX, c as DEFAULT_AGENT_SKILLS_INDEX_FORMAT, d as DEFAULT_AGENT_SKILLS_ROUTE_PREFIX, f as DEFAULT_AGENT_SKILL_ARCHIVE_FORMAT, g as DEFAULT_API_CATALOG_FORMAT, h as DEFAULT_AGENT_SKILL_RESOURCE_FORMAT, i as CreateDocsStandardsResponseOptions, j as DocsPublishedAgentSkillFile, k as DocsDiscoveryApiRouteOptions, l as DEFAULT_AGENT_SKILLS_INDEX_ROUTE, m as DEFAULT_AGENT_SKILL_FORMAT, n as API_CATALOG_MEDIA_TYPE, o as DEFAULT_A2A_AGENT_CARD_ROUTE, p as DEFAULT_AGENT_SKILL_FILE_FORMAT, r as API_CATALOG_PROFILE_URI, s as DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN, t as AGENT_SKILLS_DISCOVERY_SCHEMA_URI, u as DEFAULT_AGENT_SKILLS_ROUTE_PATTERN, v as DEFAULT_LEGACY_SKILLS_INDEX_FORMAT, w as DocsAgentSkillsIndex, x as DocsA2AAgentCard, y as DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, z as buildDocsLegacySkillsIndex } from "./standards-discovery-C4HUqMd2.mjs";
|
|
2
|
-
import { $ as DocsCloudFeatureConfig, $t as DocsTelemetryEvent, A as DocsAgentGoldenTask, An as PageSidebarFrontmatter, At as DocsRelatedItem, B as DocsAnalyticsEventInput, Bn as SidebarPageNode, Bt as DocsSearchAdapterContext, C as DocsAgentEvaluationTaskInput, Cn as PageAgentAppliesTo, Ct as DocsMcpSecurityConfig, D as DocsAgentGoldenAnswerExpectation, Dn as PageAgentVerification, Dt as DocsObservabilityConfig, E as DocsAgentFeedbackData, En as PageAgentFrontmatter, Et as DocsNav, F as DocsAgentTraceEventInput, Fn as SidebarComponentProps, Ft as DocsReviewScoreConfig, G as DocsAskAIActionType, Gn as TypographyConfig, Gt as DocsSearchEmbeddingsConfig, H as DocsAnalyticsInput, Hn as SimpleDocsSearchConfig, Ht as DocsSearchChunkingConfig, I as DocsAgentTraceEventType, In as SidebarConfig, It as DocsReviewSeverity, J as DocsAskAIFeedbackMessage, Jt as DocsSearchResultType, K as DocsAskAIFeedbackConfig, Kn as UIConfig, Kt as DocsSearchQuery, L as DocsAgentTraceStatus, Ln as SidebarFolderIndexBehavior, Lt as DocsRobotsConfig, M as DocsAgentGoldenTaskFilters, Mn as ReadingTimeConfig, Mt as DocsReviewCiMode, N as DocsAgentSkillsConfig, Nn as ReadingTimeFormat, Nt as DocsReviewConfig, O as DocsAgentGoldenExampleVerification, On as PageFrontmatter, Ot as DocsObservabilityEvent, P as DocsAgentSkillsInput, Pn as ResolvedDocsRelatedLink, Pt as DocsReviewRulesConfig, Q as DocsCloudConfig, Qt as DocsTelemetryConfig, R as DocsAnalyticsConfig, Rn as SidebarFolderNode, Rt as DocsRobotsRule, S as DocsAgentEvaluationSurface, Sn as PageActionsConfig, St as DocsMcpProtectedResourceConfig, T as DocsAgentFeedbackContext, Tn as PageAgentFailureMode, Tt as DocsMetadata, U as DocsAnalyticsSource, Un as ThemeToggleConfig, Ut as DocsSearchConfig, V as DocsAnalyticsEventType, Vn as SidebarTree, Vt as DocsSearchAdapterFactory, W as DocsAskAIActionData, Wn as TypesenseDocsSearchConfig, Wt as DocsSearchDocument, X as DocsAskAIMcpConfig, Xt as DocsSitemapConfig, Y as DocsAskAIFeedbackValue, Yt as DocsSearchSourcePage, Z as DocsCloudApiKeyConfig, Zt as DocsTelemetryAgentSurface, _ as DocsAgentEvaluationAnswerProvider, _n as OpenDocsProviderConfig, _t as DocsMcpAuthenticateContext, a as ApiReferenceRenderer, an as FeedbackConfig, at as DocsCodeBlocksRunnerConfig, b as DocsAgentEvaluationAnswerRunner, bn as OpenGraphImage, bt as DocsMcpCorsConfig, c as ChangelogFrontmatter, cn as LastUpdatedConfig, ct as DocsCodeBlocksValidationMode, d as CopyMarkdownFormat, dn as LlmsTxtMaxCharsMode, dt as DocsFeedbackData, en as DocsTelemetryEventInput, et as DocsCloudPreviewConfig, f as CustomDocsSearchConfig, fn as LlmsTxtSectionConfig, ft as DocsFeedbackValue, g as DocsAgentEvaluationAnswerInput, gn as OpenDocsProvider, gt as DocsMcpAuthenticate, h as DocsAgentConfig, hn as OpenDocsConfig, ht as DocsMcpAuthPrincipal, i as ApiReferenceConfig, in as DocsTheme, it as DocsCodeBlocksPlannerProvider, j as DocsAgentGoldenTaskExpectation, jn as PageTwitter, jt as DocsReviewCiConfig, k as DocsAgentGoldenExpectedExample, kn as PageOpenGraph, kt as DocsObservabilityEventInput, l as CodeBlockCopyData, ln as LlmsTxtConfig, lt as DocsCodeBlocksValidationPolicy, m as DocsAgentCompactConfig, mn as OGConfig, mt as DocsMcpAllowedOrigins, n as AgentFeedbackConfig, nn as DocsTelemetryFeatures, nt as DocsCodeBlocksConfig, o as BreadcrumbConfig, on as FontStyle, ot as DocsCodeBlocksRunnerProvider, p as DocsAgentA2AConfig, pn as McpDocsSearchConfig, pt as DocsI18nConfig, q as DocsAskAIFeedbackData, qt as DocsSearchResult, r as AlgoliaDocsSearchConfig, rn as DocsTelemetryFramework, rt as DocsCodeBlocksPlannerConfig, s as ChangelogConfig, sn as GithubConfig, st as DocsCodeBlocksValidateConfig, t as AIConfig, tn as DocsTelemetryEventType, tt as DocsCloudPublishConfig, u as CopyMarkdownConfig, un as LlmsTxtMaxCharsConfig, ut as DocsConfig, v as DocsAgentEvaluationAnswerRequest, vn as OpenDocsProviderId, vt as DocsMcpAuthenticateResult, w as DocsAgentEvaluationsConfig, wn as PageAgentCommand, wt as DocsMcpToolsConfig, x as DocsAgentEvaluationSourceReference, xn as OrderingItem, xt as DocsMcpOriginContext, y as DocsAgentEvaluationAnswerResult, yn as OpenDocsTarget, yt as DocsMcpConfig, z as DocsAnalyticsEvent, zn as SidebarNode, zt as DocsSearchAdapter } from "./types-EhFhYGfr.mjs";
|
|
3
|
-
import { $ as resolveDocsAudienceMdxContent, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DocsAudienceMdxIssue, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as resolveDocsAudienceExposure, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as findDocsAudienceMdxIssues, Y as DocsContentAudience, Z as resolveDocsAgentMdxContent, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as createDocsAgentTraceId, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, ct as emitDocsObservabilityEvent, d as resolveAskAISearchRequestConfig, dt as resolveDocsObservabilityConfig, et as DOCS_AGENT_TRACE_EVENT_TYPES, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as createDocsAgentTraceContext, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, lt as getDocsRequestAnalyticsProperties, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as ResolvedDocsAnalyticsConfig, o as createSimpleSearchAdapter, ot as emitDocsAgentTraceEvent, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as ResolvedDocsObservabilityConfig, s as createTypesenseSearchAdapter, st as emitDocsAnalyticsEvent, t as buildDocsAskAIContext, tt as DocsAgentTraceContext, u as performDocsSearch, ut as resolveDocsAnalyticsConfig, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-C6heDO8h.mjs";
|
|
4
|
-
import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
|
|
5
|
-
|
|
6
|
-
//#region src/define-docs.d.ts
|
|
7
|
-
/**
|
|
8
|
-
* Define docs configuration. Validates and returns the config.
|
|
9
|
-
*/
|
|
10
|
-
declare function defineDocs(config: DocsConfig): DocsConfig;
|
|
11
|
-
//#endregion
|
|
12
|
-
//#region src/telemetry.d.ts
|
|
13
|
-
interface ResolvedDocsTelemetryConfig {
|
|
14
|
-
enabled: boolean;
|
|
15
|
-
endpoint?: string;
|
|
16
|
-
}
|
|
17
|
-
interface DocsTelemetryContext {
|
|
18
|
-
framework?: DocsTelemetryFramework;
|
|
19
|
-
request?: Request;
|
|
20
|
-
siteOrigin?: string;
|
|
21
|
-
properties?: Record<string, unknown>;
|
|
22
|
-
}
|
|
23
|
-
interface DocsTelemetryAgentSurfaceContext extends DocsTelemetryContext {
|
|
24
|
-
surface: DocsTelemetryAgentSurface;
|
|
25
|
-
}
|
|
26
|
-
interface DocsTelemetryAgentSurfaceRequestOptions {
|
|
27
|
-
entry: string;
|
|
28
|
-
llmsTxt?: DocsConfig["llmsTxt"];
|
|
29
|
-
feedback?: DocsConfig["feedback"];
|
|
30
|
-
}
|
|
31
|
-
declare function resolveDocsTelemetryConfig(telemetry?: boolean | DocsTelemetryConfig): ResolvedDocsTelemetryConfig;
|
|
32
|
-
/** Normalize an HTTP(S) telemetry site value to its origin. */
|
|
33
|
-
declare function normalizeDocsTelemetryOrigin(candidate: string | undefined): string | undefined;
|
|
34
|
-
/** Return whether a telemetry origin points at a local development server. */
|
|
35
|
-
declare function isLocalDocsTelemetryOrigin(candidate: string | undefined): boolean;
|
|
36
|
-
declare function getDocsTelemetryFeatures(config: Partial<DocsConfig>): DocsTelemetryFeatures;
|
|
37
|
-
declare function emitDocsTelemetryEvent(telemetry: boolean | DocsTelemetryConfig | undefined, event: DocsTelemetryEvent): Promise<void>;
|
|
38
|
-
declare function emitDocsTelemetryProjectEvent(config: Partial<DocsConfig>, context?: DocsTelemetryContext): void;
|
|
39
|
-
declare function emitDocsTelemetryAgentSurfaceEvent(config: Partial<DocsConfig>, context: DocsTelemetryAgentSurfaceContext): void;
|
|
40
|
-
declare function emitDocsTelemetryMcpToolEvent(config: Partial<DocsConfig>, context: DocsTelemetryContext & {
|
|
41
|
-
tool: string;
|
|
42
|
-
locale?: string;
|
|
43
|
-
resultCount?: number;
|
|
44
|
-
}): void;
|
|
45
|
-
declare function inferDocsTelemetryAgentSurface(request: Request, options: DocsTelemetryAgentSurfaceRequestOptions): DocsTelemetryAgentSurface | undefined;
|
|
46
|
-
//#endregion
|
|
47
|
-
//#region src/changelog.d.ts
|
|
48
|
-
interface ResolvedChangelogConfig {
|
|
49
|
-
enabled: boolean;
|
|
50
|
-
path: string;
|
|
51
|
-
contentDir: string;
|
|
52
|
-
title: string;
|
|
53
|
-
description?: string;
|
|
54
|
-
search: boolean;
|
|
55
|
-
actionsComponent?: unknown;
|
|
56
|
-
}
|
|
57
|
-
interface ChangelogEntrySummary extends ChangelogFrontmatter {
|
|
58
|
-
slug: string;
|
|
59
|
-
date: string;
|
|
60
|
-
url: string;
|
|
61
|
-
}
|
|
62
|
-
declare function resolveChangelogConfig(value: DocsConfig["changelog"]): ResolvedChangelogConfig;
|
|
63
|
-
//#endregion
|
|
64
|
-
//#region src/utils.d.ts
|
|
65
|
-
/**
|
|
66
|
-
* Deep merge utility for theme overrides.
|
|
67
|
-
* Merges objects recursively; later values override earlier ones.
|
|
68
|
-
*/
|
|
69
|
-
declare function deepMerge<T extends Record<string, unknown>>(target: T, ...sources: Partial<T>[]): T;
|
|
70
|
-
//#endregion
|
|
71
|
-
//#region src/create-theme.d.ts
|
|
72
|
-
/**
|
|
73
|
-
* Create a theme preset factory.
|
|
74
|
-
*
|
|
75
|
-
* Returns a function that accepts optional overrides and deep-merges them
|
|
76
|
-
* with the base theme defaults. This is the same pattern used by the
|
|
77
|
-
* built-in `fumadocs()`, `darksharp()`, and `pixelBorder()` presets.
|
|
78
|
-
*
|
|
79
|
-
* @param baseTheme - The default theme configuration
|
|
80
|
-
* @returns A factory function `(overrides?) => DocsTheme`
|
|
81
|
-
*
|
|
82
|
-
* @example
|
|
83
|
-
* ```ts
|
|
84
|
-
* import { createTheme } from "@farming-labs/docs";
|
|
85
|
-
*
|
|
86
|
-
* export const myTheme = createTheme({
|
|
87
|
-
* name: "my-theme",
|
|
88
|
-
* ui: {
|
|
89
|
-
* colors: { primary: "#6366f1" },
|
|
90
|
-
* layout: { contentWidth: 800 },
|
|
91
|
-
* },
|
|
92
|
-
* });
|
|
93
|
-
* ```
|
|
94
|
-
*/
|
|
95
|
-
declare function createTheme(baseTheme: DocsTheme): (overrides?: Partial<DocsTheme>) => DocsTheme;
|
|
96
|
-
/**
|
|
97
|
-
* Extend an existing theme preset with additional defaults.
|
|
98
|
-
*
|
|
99
|
-
* Useful when you want to build on top of an existing theme (e.g. fumadocs)
|
|
100
|
-
* rather than starting from scratch.
|
|
101
|
-
*
|
|
102
|
-
* @example
|
|
103
|
-
* ```ts
|
|
104
|
-
* import { extendTheme } from "@farming-labs/docs";
|
|
105
|
-
* import { fumadocs } from "@farming-labs/theme/default";
|
|
106
|
-
*
|
|
107
|
-
* // Start with fumadocs defaults, override some values
|
|
108
|
-
* export const myTheme = extendTheme(fumadocs(), {
|
|
109
|
-
* name: "my-custom-fumadocs",
|
|
110
|
-
* ui: { colors: { primary: "#22c55e" } },
|
|
111
|
-
* });
|
|
112
|
-
* ```
|
|
113
|
-
*/
|
|
114
|
-
declare function extendTheme(baseTheme: DocsTheme, extensions: Partial<DocsTheme>): DocsTheme;
|
|
115
|
-
//#endregion
|
|
116
|
-
//#region src/i18n.d.ts
|
|
117
|
-
interface ResolvedDocsI18n {
|
|
118
|
-
locales: string[];
|
|
119
|
-
defaultLocale: string;
|
|
120
|
-
}
|
|
121
|
-
interface DocsPathMatch {
|
|
122
|
-
/** Slug path relative to the docs root (no leading slash). */
|
|
123
|
-
slug: string;
|
|
124
|
-
/** Entry path used for URLs (no locale segment). */
|
|
125
|
-
entryPath: string;
|
|
126
|
-
}
|
|
127
|
-
declare function resolveDocsI18n(config?: DocsI18nConfig | null): ResolvedDocsI18n | null;
|
|
128
|
-
declare function resolveDocsLocale(searchParams: URLSearchParams, i18n?: ResolvedDocsI18n | null): string | undefined;
|
|
129
|
-
declare function resolveDocsPath(pathname: string, entry: string): DocsPathMatch;
|
|
130
|
-
//#endregion
|
|
131
|
-
//#region src/agent-conformance.d.ts
|
|
132
|
-
declare const DOCS_AGENT_CONTRACT_VERSION = "1.1";
|
|
133
|
-
type DocsAgentAdapter = "next" | "tanstack-start" | "sveltekit" | "astro" | "nuxt";
|
|
134
|
-
type DocsAgentContractSurface = "discovery" | "api-catalog" | "api-catalog-head" | "agent-skills-index" | "agent-skills-index-head" | "agent-skill" | "agent-skill-head" | "config" | "diagnostics" | "feedback-schema" | "markdown" | "markdown-accept" | "markdown-locale" | "markdown-missing" | "llms" | "llms-full" | "agents" | "skill" | "sitemap-xml" | "sitemap-markdown" | "robots" | "mcp";
|
|
135
|
-
interface DocsAgentContractRequest {
|
|
136
|
-
url: string;
|
|
137
|
-
init?: RequestInit;
|
|
138
|
-
}
|
|
139
|
-
interface DocsAgentContractExpectation {
|
|
140
|
-
statuses: readonly number[];
|
|
141
|
-
contentTypes: readonly string[];
|
|
142
|
-
bodyIncludes?: readonly string[];
|
|
143
|
-
bodyEmpty?: boolean;
|
|
144
|
-
headerIncludes?: Readonly<Record<string, readonly string[]>>;
|
|
145
|
-
linkRelations?: readonly {
|
|
146
|
-
href: string;
|
|
147
|
-
rel: string;
|
|
148
|
-
}[];
|
|
149
|
-
}
|
|
150
|
-
interface DocsAgentContractCase {
|
|
151
|
-
surface: DocsAgentContractSurface;
|
|
152
|
-
request: DocsAgentContractRequest;
|
|
153
|
-
expect: DocsAgentContractExpectation;
|
|
154
|
-
}
|
|
155
|
-
interface DocsAgentConformanceCaseResult {
|
|
156
|
-
surface: DocsAgentContractSurface;
|
|
157
|
-
passed: boolean;
|
|
158
|
-
status?: number;
|
|
159
|
-
contentType?: string;
|
|
160
|
-
issues: string[];
|
|
161
|
-
}
|
|
162
|
-
interface DocsAgentConformanceReport {
|
|
163
|
-
adapter: DocsAgentAdapter;
|
|
164
|
-
contractVersion: typeof DOCS_AGENT_CONTRACT_VERSION;
|
|
165
|
-
passed: boolean;
|
|
166
|
-
cases: DocsAgentConformanceCaseResult[];
|
|
167
|
-
}
|
|
168
|
-
interface RunDocsAgentConformanceOptions {
|
|
169
|
-
adapter: DocsAgentAdapter;
|
|
170
|
-
/** Origin used to construct requests. Defaults to http://localhost. */
|
|
171
|
-
origin?: string;
|
|
172
|
-
/** Public docs entry. Defaults to docs. */
|
|
173
|
-
entry?: string;
|
|
174
|
-
/** Locale fixture expected to render the word "Bonjour". Set false to skip. */
|
|
175
|
-
locale?: string | false;
|
|
176
|
-
handle(request: Request, surface: DocsAgentContractSurface): Response | Promise<Response>;
|
|
177
|
-
}
|
|
178
|
-
/**
|
|
179
|
-
* The framework-neutral public surface every first-party adapter must implement.
|
|
180
|
-
* Adapter tests consume this list so new routes and invariants are added once.
|
|
181
|
-
*/
|
|
182
|
-
declare function createDocsAgentContractCases(options?: {
|
|
183
|
-
origin?: string;
|
|
184
|
-
entry?: string;
|
|
185
|
-
locale?: string | false;
|
|
186
|
-
}): DocsAgentContractCase[];
|
|
187
|
-
declare function runDocsAgentConformance(options: RunDocsAgentConformanceOptions): Promise<DocsAgentConformanceReport>;
|
|
188
|
-
//#endregion
|
|
189
|
-
//#region src/metadata.d.ts
|
|
190
|
-
interface DocsStructuredDataBreadcrumb {
|
|
191
|
-
name: string;
|
|
192
|
-
url: string;
|
|
193
|
-
}
|
|
194
|
-
interface DocsPageStructuredDataInput {
|
|
195
|
-
title: string;
|
|
196
|
-
description?: string;
|
|
197
|
-
url: string;
|
|
198
|
-
baseUrl?: string;
|
|
199
|
-
entry?: string;
|
|
200
|
-
dateModified?: string;
|
|
201
|
-
breadcrumbs?: DocsStructuredDataBreadcrumb[];
|
|
202
|
-
/** Optional actionable page contract represented as a Schema.org HowTo. */
|
|
203
|
-
agent?: PageAgentFrontmatter;
|
|
204
|
-
}
|
|
205
|
-
/**
|
|
206
|
-
* Resolve page title using metadata titleTemplate.
|
|
207
|
-
* %s is replaced with page title.
|
|
208
|
-
*/
|
|
209
|
-
declare function resolveTitle(pageTitle: string, metadata?: DocsMetadata): string;
|
|
210
|
-
/**
|
|
211
|
-
* Resolve OG image URL for a page.
|
|
212
|
-
* Prefers page.openGraph.images[0], then page.ogImage, then config endpoint/default.
|
|
213
|
-
*/
|
|
214
|
-
declare function resolveOGImage(page: PageFrontmatter, ogConfig?: OGConfig, baseUrl?: string): string | undefined;
|
|
215
|
-
/**
|
|
216
|
-
* Build the Open Graph metadata object for a page.
|
|
217
|
-
* When the page has openGraph in frontmatter, uses it (with title/description filled from page if omitted).
|
|
218
|
-
* Otherwise uses ogImage or config (dynamic endpoint / defaultImage).
|
|
219
|
-
*/
|
|
220
|
-
declare function buildPageOpenGraph(page: Pick<PageFrontmatter, "title" | "description" | "ogImage" | "openGraph">, ogConfig?: OGConfig, baseUrl?: string): PageOpenGraph | undefined;
|
|
221
|
-
/**
|
|
222
|
-
* Build the Twitter card metadata object for a page.
|
|
223
|
-
* When the page has twitter in frontmatter, uses it.
|
|
224
|
-
* Otherwise builds from ogImage or config (dynamic endpoint).
|
|
225
|
-
*/
|
|
226
|
-
declare function buildPageTwitter(page: Pick<PageFrontmatter, "title" | "description" | "ogImage" | "openGraph" | "twitter">, ogConfig?: OGConfig, baseUrl?: string): PageTwitter | undefined;
|
|
227
|
-
/**
|
|
228
|
-
* Resolve the public docs site URL from existing agent-facing config.
|
|
229
|
-
*
|
|
230
|
-
* The framework intentionally reuses `sitemap.baseUrl`, `llmsTxt.baseUrl`,
|
|
231
|
-
* `robots.baseUrl`, or `ai.docsUrl` instead of requiring another setting.
|
|
232
|
-
*/
|
|
233
|
-
declare function resolveDocsMetadataBaseUrl(config: DocsConfig): string | undefined;
|
|
234
|
-
/**
|
|
235
|
-
* Build Schema.org JSON-LD for a docs page.
|
|
236
|
-
*
|
|
237
|
-
* The shape follows Vercel's agent readability guidance: a `TechArticle`
|
|
238
|
-
* with title, description, canonical URL, freshness, and breadcrumbs.
|
|
239
|
-
*/
|
|
240
|
-
declare function buildDocsPageStructuredData(input: DocsPageStructuredDataInput): Record<string, unknown>;
|
|
241
|
-
/**
|
|
242
|
-
* Serialize Schema.org JSON-LD for safe insertion into a `<script>` tag.
|
|
243
|
-
*/
|
|
244
|
-
declare function renderDocsPageStructuredDataJson(input: DocsPageStructuredDataInput): string;
|
|
245
|
-
//#endregion
|
|
246
|
-
//#region src/reading-time.d.ts
|
|
247
|
-
interface ResolvedReadingTimeOptions {
|
|
248
|
-
enabled: boolean;
|
|
249
|
-
wordsPerMinute?: number;
|
|
250
|
-
format: ReadingTimeFormat;
|
|
251
|
-
includeCode: boolean;
|
|
252
|
-
}
|
|
253
|
-
interface ReadingTimeEstimateOptions {
|
|
254
|
-
includeCode?: boolean;
|
|
255
|
-
}
|
|
256
|
-
declare function estimateReadingTimeMinutes(content: string, wordsPerMinute?: number, options?: ReadingTimeEstimateOptions): number;
|
|
257
|
-
declare function resolveReadingTimeOptions(readingTime: boolean | ReadingTimeConfig | null | undefined): ResolvedReadingTimeOptions;
|
|
258
|
-
declare function resolveReadingTimeFromContent(frontmatter: Partial<PageFrontmatter> | undefined, content: string, wordsPerMinute?: number, options?: ReadingTimeEstimateOptions): number | null;
|
|
259
|
-
declare function resolvePageReadingTime(frontmatter: Partial<PageFrontmatter> | undefined, content: string, options?: {
|
|
260
|
-
enabledByDefault?: boolean;
|
|
261
|
-
wordsPerMinute?: number;
|
|
262
|
-
includeCode?: boolean;
|
|
263
|
-
}): number | null | undefined;
|
|
264
|
-
declare function resolveReadingTimeFromSource(source: string, wordsPerMinute?: number, options?: ReadingTimeEstimateOptions): number | null;
|
|
265
|
-
//#endregion
|
|
266
|
-
//#region src/related.d.ts
|
|
267
|
-
declare function normalizeDocsRelated(value: unknown): ResolvedDocsRelatedLink[];
|
|
268
|
-
declare function renderDocsRelatedMarkdownLines(related: ResolvedDocsRelatedLink[] | undefined): string[];
|
|
269
|
-
//#endregion
|
|
270
|
-
//#region src/agent-contract.d.ts
|
|
271
|
-
interface PageAgentFrontmatterIssue {
|
|
272
|
-
path: string;
|
|
273
|
-
message: string;
|
|
274
|
-
}
|
|
275
|
-
declare const PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS: readonly ["task", "outcome", "appliesTo", "prerequisites", "files", "commands", "sideEffects", "verification", "rollback", "failureModes"];
|
|
276
|
-
declare const PAGE_AGENT_CONTRACT_FIELDS: readonly ["tokenBudget", "task", "outcome", "appliesTo", "prerequisites", "files", "commands", "sideEffects", "verification", "rollback", "failureModes"];
|
|
277
|
-
declare const PAGE_AGENT_CONTRACT_FIELD_SCHEMA: {
|
|
278
|
-
readonly tokenBudget: "number";
|
|
279
|
-
readonly task: "string";
|
|
280
|
-
readonly outcome: "string";
|
|
281
|
-
readonly appliesTo: {
|
|
282
|
-
readonly framework: "string|string[]";
|
|
283
|
-
readonly version: "string|string[]";
|
|
284
|
-
readonly package: "string|string[]";
|
|
285
|
-
};
|
|
286
|
-
readonly prerequisites: "string[]";
|
|
287
|
-
readonly files: "string[]";
|
|
288
|
-
readonly commands: "Array<string|{run,cwd?,description?}>";
|
|
289
|
-
readonly sideEffects: "string[]";
|
|
290
|
-
readonly verification: "Array<string|{description?,run?,expect?}>";
|
|
291
|
-
readonly rollback: "string[]";
|
|
292
|
-
readonly failureModes: "Array<string|{symptom,resolution?}>";
|
|
293
|
-
};
|
|
294
|
-
declare const PAGE_AGENT_CONTRACT_START_MARKER = "<!-- farming-labs:agent-contract:start -->";
|
|
295
|
-
declare const PAGE_AGENT_CONTRACT_END_MARKER = "<!-- farming-labs:agent-contract:end -->";
|
|
296
|
-
/**
|
|
297
|
-
* Normalize untrusted page frontmatter into the stable agent contract shape.
|
|
298
|
-
* Invalid fields are omitted so malformed author input cannot break page delivery.
|
|
299
|
-
*/
|
|
300
|
-
declare function normalizePageAgentFrontmatter(value: unknown): PageAgentFrontmatter | undefined;
|
|
301
|
-
declare function hasStructuredPageAgentContract(value: unknown): boolean;
|
|
302
|
-
/** Return author-facing validation issues without throwing. */
|
|
303
|
-
declare function getPageAgentFrontmatterIssues(value: unknown): PageAgentFrontmatterIssue[];
|
|
304
|
-
/** Render normalized `agent` YAML in a stable field order. */
|
|
305
|
-
declare function renderPageAgentFrontmatterYamlLines(value: unknown, indentation?: number): string[];
|
|
306
|
-
/** Render the structured contract as deterministic, compact machine-readable Markdown. */
|
|
307
|
-
declare function renderPageAgentContractMarkdown(value: unknown): string;
|
|
308
|
-
/** Remove generated contract blocks while preserving handwritten guidance. */
|
|
309
|
-
declare function stripGeneratedPageAgentContractMarkdown(markdown: string): string;
|
|
310
|
-
/** Insert one generated contract unless the document already has handwritten contract guidance. */
|
|
311
|
-
declare function upsertPageAgentContractMarkdown(markdown: string, value: unknown): string;
|
|
312
|
-
//#endregion
|
|
313
|
-
//#region src/sidebar.d.ts
|
|
314
|
-
interface SidebarFolderIndexBehaviorOptions {
|
|
315
|
-
sidebar: boolean | SidebarConfig | undefined;
|
|
316
|
-
defaultBehavior?: SidebarFolderIndexBehavior;
|
|
317
|
-
}
|
|
318
|
-
declare function resolvePageSidebarFolderIndexBehavior(sidebar: unknown): SidebarFolderIndexBehavior | undefined;
|
|
319
|
-
declare function resolveSidebarFolderIndexBehavior(sidebar: boolean | SidebarConfig | undefined, defaultBehavior?: SidebarFolderIndexBehavior): SidebarFolderIndexBehavior;
|
|
320
|
-
declare function resolveSidebarFolderIndexBehaviorForPath(sidebar: boolean | SidebarConfig | undefined, folderPath: string | undefined, defaultBehavior?: SidebarFolderIndexBehavior): SidebarFolderIndexBehavior;
|
|
321
|
-
declare function applySidebarFolderIndexBehavior<TTree extends {
|
|
322
|
-
children: unknown[];
|
|
323
|
-
}>(tree: TTree, behaviorOrOptions: SidebarFolderIndexBehavior | SidebarFolderIndexBehaviorOptions): TTree;
|
|
324
|
-
//#endregion
|
|
325
|
-
//#region src/agent-provenance.d.ts
|
|
326
|
-
declare const GENERATED_AGENT_PROVENANCE_MARKER = "@farming-labs/docs:generated";
|
|
327
|
-
declare const GENERATED_AGENT_PROVENANCE_VERSION = 1;
|
|
328
|
-
type GeneratedAgentSourceKind = "resolved-page" | "agent-md";
|
|
329
|
-
interface GeneratedAgentProvenance {
|
|
330
|
-
version: number;
|
|
331
|
-
sourceKind: GeneratedAgentSourceKind;
|
|
332
|
-
sourceHash: string;
|
|
333
|
-
settingsHash: string;
|
|
334
|
-
outputHash: string;
|
|
335
|
-
generatedAt: string;
|
|
336
|
-
}
|
|
337
|
-
interface ParsedGeneratedAgentDocument {
|
|
338
|
-
provenance?: GeneratedAgentProvenance;
|
|
339
|
-
content: string;
|
|
340
|
-
}
|
|
341
|
-
declare function normalizeGeneratedAgentContent(value: string): string;
|
|
342
|
-
declare function hashGeneratedAgentContent(value: string): string;
|
|
343
|
-
declare function parseGeneratedAgentDocument(raw: string): ParsedGeneratedAgentDocument;
|
|
344
|
-
declare function stripGeneratedAgentProvenance(raw: string): string;
|
|
345
|
-
declare function serializeGeneratedAgentDocument(content: string, provenance: GeneratedAgentProvenance): string;
|
|
346
|
-
//#endregion
|
|
347
|
-
//#region src/mcp-auth.d.ts
|
|
348
|
-
declare const DEFAULT_MCP_ROUTE = "/api/docs/mcp";
|
|
349
|
-
declare const DEFAULT_MCP_PUBLIC_ROUTE = "/mcp";
|
|
350
|
-
declare const DEFAULT_MCP_WELL_KNOWN_ROUTE = "/.well-known/mcp";
|
|
351
|
-
declare const DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE = "/.well-known/oauth-protected-resource";
|
|
352
|
-
declare function getDocsMcpResourcePaths(route?: string): string[];
|
|
353
|
-
declare function buildDocsMcpProtectedResourceMetadataRoute(resourcePath: string): string;
|
|
354
|
-
declare function getDocsMcpProtectedResourceMetadataRoutes(route?: string): string[];
|
|
355
|
-
declare function hasDocsMcpProtectedResourceConfig(mcp?: boolean | DocsMcpConfig): boolean;
|
|
356
|
-
declare function isDocsMcpRequest(url: URL, mcp?: boolean | DocsMcpConfig): boolean;
|
|
357
|
-
//#endregion
|
|
358
|
-
//#region src/agent.d.ts
|
|
359
|
-
declare const DEFAULT_DOCS_API_ROUTE = "/api/docs";
|
|
360
|
-
declare const DEFAULT_DOCS_CONFIG_FORMAT = "docs-config-map.v1";
|
|
361
|
-
declare const DEFAULT_DOCS_CONFIG_ROUTE = "/api/docs?format=config";
|
|
362
|
-
declare const DEFAULT_DOCS_DIAGNOSTICS_FORMAT = "docs-diagnostics.v1";
|
|
363
|
-
declare const DEFAULT_DOCS_DIAGNOSTICS_ROUTE = "/api/docs?format=diagnostics";
|
|
364
|
-
declare const DEFAULT_OPENAPI_SCHEMA_ROUTE = "/api/docs?format=openapi";
|
|
365
|
-
declare const DEFAULT_AGENT_SPEC_ROUTE = "/api/docs/agent/spec";
|
|
366
|
-
declare const DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE = "/.well-known/agent";
|
|
367
|
-
declare const DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE = "/.well-known/agent.json";
|
|
368
|
-
declare const DEFAULT_LLMS_TXT_ROUTE = "/llms.txt";
|
|
369
|
-
declare const DEFAULT_LLMS_FULL_TXT_ROUTE = "/llms-full.txt";
|
|
370
|
-
declare const DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE = "/.well-known/llms.txt";
|
|
371
|
-
declare const DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE = "/.well-known/llms-full.txt";
|
|
372
|
-
declare const DEFAULT_LLMS_TXT_MAX_CHARS = 50000;
|
|
373
|
-
declare const DEFAULT_SKILL_MD_ROUTE = "/skill.md";
|
|
374
|
-
declare const DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE = "/.well-known/skill.md";
|
|
375
|
-
declare const DEFAULT_AGENTS_MD_ROUTE = "/AGENTS.md";
|
|
376
|
-
declare const DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE = "/.well-known/AGENTS.md";
|
|
377
|
-
declare const DEFAULT_AGENT_MD_ROUTE = "/AGENT.md";
|
|
378
|
-
declare const DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE = "/.well-known/AGENT.md";
|
|
379
|
-
declare const DEFAULT_AGENT_FEEDBACK_ROUTE = "/api/docs/agent/feedback";
|
|
380
|
-
declare const DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA: Record<string, unknown>;
|
|
381
|
-
declare const DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER = "Signature-Agent";
|
|
382
|
-
declare const DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN: string;
|
|
383
|
-
declare const DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN: string;
|
|
384
|
-
declare const DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN: string;
|
|
385
|
-
interface DocsMcpEndpointCandidate {
|
|
386
|
-
baseUrl: string;
|
|
387
|
-
route: string;
|
|
388
|
-
url: string;
|
|
389
|
-
label: string;
|
|
390
|
-
}
|
|
391
|
-
interface DocsMcpEndpointCandidateOptions {
|
|
392
|
-
includeOriginFallback?: boolean;
|
|
393
|
-
includeRootDomainFallback?: boolean;
|
|
394
|
-
includeMcpSubdomainFallback?: boolean;
|
|
395
|
-
}
|
|
396
|
-
interface DocsAgentFeedbackResolvedConfig {
|
|
397
|
-
enabled: boolean;
|
|
398
|
-
route: string;
|
|
399
|
-
schemaRoute: string;
|
|
400
|
-
payloadSchema: Record<string, unknown>;
|
|
401
|
-
schema: Record<string, unknown>;
|
|
402
|
-
onFeedback?: (data: DocsAgentFeedbackData) => void | Promise<void>;
|
|
403
|
-
}
|
|
404
|
-
interface DocsAgentFeedbackRequest {
|
|
405
|
-
kind: "schema" | "submit";
|
|
406
|
-
}
|
|
407
|
-
interface DocsAgentFeedbackDiscoveryConfig {
|
|
408
|
-
enabled?: boolean;
|
|
409
|
-
route?: string;
|
|
410
|
-
schemaRoute?: string;
|
|
411
|
-
}
|
|
412
|
-
interface DocsLlmsDiscoveryConfig extends DocsDiscoveryApiRouteOptions {
|
|
413
|
-
enabled?: boolean;
|
|
414
|
-
/** Whether this deployment actually serves the RFC 9727 API catalog. Defaults to true. */
|
|
415
|
-
apiCatalog?: boolean;
|
|
416
|
-
baseUrl?: string;
|
|
417
|
-
siteTitle?: string;
|
|
418
|
-
siteDescription?: string;
|
|
419
|
-
maxChars?: LlmsTxtMaxCharsConfig;
|
|
420
|
-
sections?: LlmsTxtSectionConfig[];
|
|
421
|
-
openapi?: boolean | DocsOpenApiDiscoveryConfig;
|
|
422
|
-
}
|
|
423
|
-
interface DocsOpenApiDiscoveryConfig {
|
|
424
|
-
enabled?: boolean;
|
|
425
|
-
url?: string;
|
|
426
|
-
/** Whether `url` came from the framework default or explicit configuration. */
|
|
427
|
-
urlSource?: "default" | "configured";
|
|
428
|
-
source?: "generated" | "configured";
|
|
429
|
-
specUrl?: string;
|
|
430
|
-
apiReferencePath?: string;
|
|
431
|
-
}
|
|
432
|
-
interface DocsOpenApiResolvedDiscoveryConfig {
|
|
433
|
-
enabled: boolean;
|
|
434
|
-
url?: string;
|
|
435
|
-
/** Whether `url` came from the framework default or explicit configuration. */
|
|
436
|
-
urlSource?: "default" | "configured";
|
|
437
|
-
source?: "generated" | "configured";
|
|
438
|
-
specUrl?: string;
|
|
439
|
-
apiReferencePath?: string;
|
|
440
|
-
}
|
|
441
|
-
type DocsConfigMapJsonPrimitive = string | number | boolean | null;
|
|
442
|
-
type DocsConfigMapJsonValue = DocsConfigMapJsonPrimitive | DocsConfigMapJsonValue[] | {
|
|
443
|
-
[key: string]: DocsConfigMapJsonValue;
|
|
444
|
-
};
|
|
445
|
-
interface DocsConfigMapPointer {
|
|
446
|
-
/** Dot-path form for humans and TypeScript users, e.g. `mcp.tools.readPage`. */
|
|
447
|
-
path: string;
|
|
448
|
-
/** Coarse value kind at this pointer. */
|
|
449
|
-
kind: string;
|
|
450
|
-
}
|
|
451
|
-
interface DocsConfigMap {
|
|
452
|
-
schemaVersion: 1;
|
|
453
|
-
format: typeof DEFAULT_DOCS_CONFIG_FORMAT;
|
|
454
|
-
source: {
|
|
455
|
-
/** Best-effort source label; adapters only receive the runtime config object. */file: string; /** Best-effort language hint based on serializing the runtime config object. */
|
|
456
|
-
language: "ts" | "tsx";
|
|
457
|
-
};
|
|
458
|
-
serialization: {
|
|
459
|
-
mode: "json-safe";
|
|
460
|
-
redacted: string;
|
|
461
|
-
nonSerializable: "described";
|
|
462
|
-
};
|
|
463
|
-
values: {
|
|
464
|
-
[key: string]: DocsConfigMapJsonValue;
|
|
465
|
-
};
|
|
466
|
-
/** RFC 6901 JSON Pointer index for mapping response values back to docs.config paths. */
|
|
467
|
-
pointers: Record<string, DocsConfigMapPointer>;
|
|
468
|
-
}
|
|
469
|
-
type DocsDiagnosticsStatus = "enabled" | "disabled";
|
|
470
|
-
type DocsDiagnosticsIssueSeverity = "warning" | "error";
|
|
471
|
-
interface DocsDiagnosticsIssue {
|
|
472
|
-
severity: DocsDiagnosticsIssueSeverity;
|
|
473
|
-
code: string;
|
|
474
|
-
path?: string;
|
|
475
|
-
message: string;
|
|
476
|
-
}
|
|
477
|
-
interface DocsDiagnosticsFeature {
|
|
478
|
-
status: DocsDiagnosticsStatus;
|
|
479
|
-
reason?: string;
|
|
480
|
-
route?: string | null;
|
|
481
|
-
routes?: Record<string, string | null>;
|
|
482
|
-
provider?: string;
|
|
483
|
-
mode?: string;
|
|
484
|
-
transport?: "GET" | "POST" | "GET/HEAD" | "GET/POST";
|
|
485
|
-
tools?: Record<string, boolean>;
|
|
486
|
-
human?: boolean;
|
|
487
|
-
agent?: boolean;
|
|
488
|
-
}
|
|
489
|
-
interface DocsDiagnostics {
|
|
490
|
-
schemaVersion: 1;
|
|
491
|
-
format: typeof DEFAULT_DOCS_DIAGNOSTICS_FORMAT;
|
|
492
|
-
ok: boolean;
|
|
493
|
-
adapter: string | null;
|
|
494
|
-
routes: {
|
|
495
|
-
docs: string;
|
|
496
|
-
api: string;
|
|
497
|
-
config: string;
|
|
498
|
-
diagnostics: string;
|
|
499
|
-
agentSpec: string;
|
|
500
|
-
apiCatalog: string | null;
|
|
501
|
-
agentSkillsIndex: string;
|
|
502
|
-
agentSkillsArtifact: string;
|
|
503
|
-
agents: string;
|
|
504
|
-
skill: string;
|
|
505
|
-
search: string | null;
|
|
506
|
-
askAi: string | null;
|
|
507
|
-
mcp: string | null;
|
|
508
|
-
llmsTxt: string | null;
|
|
509
|
-
llmsFullTxt: string | null;
|
|
510
|
-
sitemapXml: string | null;
|
|
511
|
-
sitemapMarkdown: string | null;
|
|
512
|
-
robots: string | null;
|
|
513
|
-
openapi: string | null;
|
|
514
|
-
apiReference: string | null;
|
|
515
|
-
};
|
|
516
|
-
features: {
|
|
517
|
-
staticExport: DocsDiagnosticsFeature;
|
|
518
|
-
config: DocsDiagnosticsFeature;
|
|
519
|
-
diagnostics: DocsDiagnosticsFeature;
|
|
520
|
-
apiCatalog: DocsDiagnosticsFeature;
|
|
521
|
-
search: DocsDiagnosticsFeature;
|
|
522
|
-
ai: DocsDiagnosticsFeature;
|
|
523
|
-
mcp: DocsDiagnosticsFeature;
|
|
524
|
-
feedback: DocsDiagnosticsFeature;
|
|
525
|
-
llmsTxt: DocsDiagnosticsFeature;
|
|
526
|
-
sitemap: DocsDiagnosticsFeature;
|
|
527
|
-
robots: DocsDiagnosticsFeature;
|
|
528
|
-
apiReference: DocsDiagnosticsFeature;
|
|
529
|
-
agents: DocsDiagnosticsFeature;
|
|
530
|
-
skills: DocsDiagnosticsFeature;
|
|
531
|
-
locales: DocsDiagnosticsFeature;
|
|
532
|
-
};
|
|
533
|
-
warnings: DocsDiagnosticsIssue[];
|
|
534
|
-
errors: DocsDiagnosticsIssue[];
|
|
535
|
-
}
|
|
536
|
-
interface DocsDiagnosticsOptions extends DocsDiscoveryApiRouteOptions {
|
|
537
|
-
adapter?: string;
|
|
538
|
-
/** Effective RFC 9727 catalog availability after runtime overrides are applied. */
|
|
539
|
-
apiCatalog?: boolean;
|
|
540
|
-
entry?: string;
|
|
541
|
-
i18n?: ResolvedDocsI18n | null;
|
|
542
|
-
mcp?: DocsMcpResolvedConfig;
|
|
543
|
-
feedback?: DocsAgentFeedbackDiscoveryConfig;
|
|
544
|
-
openapi?: boolean | DocsOpenApiDiscoveryConfig;
|
|
545
|
-
}
|
|
546
|
-
interface DocsLlmsTxtResolvedMaxChars {
|
|
547
|
-
mode: LlmsTxtMaxCharsMode;
|
|
548
|
-
chars: number;
|
|
549
|
-
}
|
|
550
|
-
interface DocsLlmsTxtResolvedSection {
|
|
551
|
-
title: string;
|
|
552
|
-
description?: string;
|
|
553
|
-
match: string[];
|
|
554
|
-
route: string;
|
|
555
|
-
fullRoute: string;
|
|
556
|
-
maxChars: DocsLlmsTxtResolvedMaxChars;
|
|
557
|
-
}
|
|
558
|
-
interface DocsLlmsTxtRequest {
|
|
559
|
-
format: "llms" | "llms-full";
|
|
560
|
-
section?: DocsLlmsTxtResolvedSection;
|
|
561
|
-
}
|
|
562
|
-
interface DocsLlmsTxtPageInput {
|
|
563
|
-
url: string;
|
|
564
|
-
/** Override the Markdown link emitted in llms.txt. */
|
|
565
|
-
markdownUrl?: string;
|
|
566
|
-
title: string;
|
|
567
|
-
description?: string;
|
|
568
|
-
content: string;
|
|
569
|
-
rawContent?: string;
|
|
570
|
-
agentContent?: string;
|
|
571
|
-
agentRawContent?: string;
|
|
572
|
-
agentFallbackContent?: string;
|
|
573
|
-
agentFallbackRawContent?: string;
|
|
574
|
-
}
|
|
575
|
-
interface DocsLlmsTxtGeneratedSection extends DocsLlmsTxtResolvedSection {
|
|
576
|
-
llmsTxt: string;
|
|
577
|
-
llmsFullTxt: string;
|
|
578
|
-
}
|
|
579
|
-
interface DocsLlmsTxtGeneratedContent {
|
|
580
|
-
llmsTxt: string;
|
|
581
|
-
llmsFullTxt: string;
|
|
582
|
-
maxChars: DocsLlmsTxtResolvedMaxChars;
|
|
583
|
-
sections: DocsLlmsTxtGeneratedSection[];
|
|
584
|
-
}
|
|
585
|
-
interface DocsLlmsTxtSelectedContent {
|
|
586
|
-
content: string;
|
|
587
|
-
label: string;
|
|
588
|
-
maxChars: DocsLlmsTxtResolvedMaxChars;
|
|
589
|
-
}
|
|
590
|
-
interface DocsLlmsTxtMaxCharsIssue {
|
|
591
|
-
mode: Exclude<LlmsTxtMaxCharsMode, "off">;
|
|
592
|
-
chars: number;
|
|
593
|
-
actual: number;
|
|
594
|
-
label: string;
|
|
595
|
-
message: string;
|
|
596
|
-
}
|
|
597
|
-
interface DocsAgentDiscoverySpecOptions extends DocsDiscoveryApiRouteOptions {
|
|
598
|
-
origin: string;
|
|
599
|
-
entry?: string;
|
|
600
|
-
/** Public rendered docs path when it differs from `entry`. */
|
|
601
|
-
docsPath?: string;
|
|
602
|
-
/** Whether this deployment actually serves the RFC 9727 API catalog. Defaults to true. */
|
|
603
|
-
apiCatalog?: boolean;
|
|
604
|
-
i18n?: ResolvedDocsI18n | null;
|
|
605
|
-
search?: boolean | DocsSearchConfig;
|
|
606
|
-
mcp: DocsMcpResolvedConfig;
|
|
607
|
-
feedback?: DocsAgentFeedbackDiscoveryConfig;
|
|
608
|
-
llms?: DocsLlmsDiscoveryConfig;
|
|
609
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
610
|
-
robots?: boolean | DocsRobotsConfig;
|
|
611
|
-
openapi?: boolean | DocsOpenApiDiscoveryConfig;
|
|
612
|
-
markdown?: {
|
|
613
|
-
acceptHeader?: boolean;
|
|
614
|
-
signatureAgentHeader?: boolean;
|
|
615
|
-
};
|
|
616
|
-
/** Additional validated project skills to cross-list in custom discovery. */
|
|
617
|
-
publishedSkills?: readonly DocsPublishedAgentSkill[];
|
|
618
|
-
/** Explicit metadata for a real A2A service; omitted sites do not publish an Agent Card. */
|
|
619
|
-
agentCard?: DocsA2AAgentCardOptions;
|
|
620
|
-
}
|
|
621
|
-
interface DocsSkillDocumentOptions extends DocsDiscoveryApiRouteOptions {
|
|
622
|
-
origin: string;
|
|
623
|
-
entry?: string;
|
|
624
|
-
/** Public rendered docs path when it differs from `entry`. */
|
|
625
|
-
docsPath?: string;
|
|
626
|
-
/** Whether this deployment actually serves the RFC 9727 API catalog. Defaults to true. */
|
|
627
|
-
apiCatalog?: boolean;
|
|
628
|
-
search?: boolean | DocsSearchConfig;
|
|
629
|
-
mcp: DocsMcpResolvedConfig;
|
|
630
|
-
feedback?: DocsAgentFeedbackDiscoveryConfig;
|
|
631
|
-
llms?: DocsLlmsDiscoveryConfig;
|
|
632
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
633
|
-
robots?: boolean | DocsRobotsConfig;
|
|
634
|
-
openapi?: boolean | DocsOpenApiDiscoveryConfig;
|
|
635
|
-
markdown?: {
|
|
636
|
-
acceptHeader?: boolean;
|
|
637
|
-
signatureAgentHeader?: boolean;
|
|
638
|
-
};
|
|
639
|
-
}
|
|
640
|
-
interface DocsAgentsDocumentOptions extends DocsSkillDocumentOptions {}
|
|
641
|
-
interface DocsStandardsDiscoveryResponseOptions extends DocsAgentDiscoverySpecOptions {
|
|
642
|
-
request: Request;
|
|
643
|
-
preferredSkillDocument?: string | null;
|
|
644
|
-
fallbackSkillDocument: string;
|
|
645
|
-
}
|
|
646
|
-
interface DocsAgentContractMcpTools {
|
|
647
|
-
list?: "list_tasks";
|
|
648
|
-
read?: "read_task";
|
|
649
|
-
}
|
|
650
|
-
interface DocsMarkdownPage {
|
|
651
|
-
slug?: string;
|
|
652
|
-
url: string;
|
|
653
|
-
title: string;
|
|
654
|
-
description?: string;
|
|
655
|
-
/** Override the public Markdown representation URL when it differs from `${url}.md`. */
|
|
656
|
-
markdownUrl?: string;
|
|
657
|
-
lastModified?: string;
|
|
658
|
-
lastmod?: string;
|
|
659
|
-
related?: ResolvedDocsRelatedLink[];
|
|
660
|
-
agent?: PageAgentFrontmatter;
|
|
661
|
-
content: string;
|
|
662
|
-
rawContent?: string;
|
|
663
|
-
agentContent?: string;
|
|
664
|
-
agentRawContent?: string;
|
|
665
|
-
agentFallbackContent?: string;
|
|
666
|
-
agentFallbackRawContent?: string;
|
|
667
|
-
}
|
|
668
|
-
interface DocsMarkdownDocumentOptions {
|
|
669
|
-
llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig;
|
|
670
|
-
origin?: string;
|
|
671
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
672
|
-
}
|
|
673
|
-
interface DocsMarkdownNotFoundOptions extends DocsDiscoveryApiRouteOptions {
|
|
674
|
-
entry?: string;
|
|
675
|
-
requestedPath: string;
|
|
676
|
-
origin?: string;
|
|
677
|
-
pages?: DocsMarkdownPage[];
|
|
678
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
679
|
-
}
|
|
680
|
-
interface DocsMarkdownRecoveryMatch {
|
|
681
|
-
title: string;
|
|
682
|
-
url: string;
|
|
683
|
-
markdownUrl: string;
|
|
684
|
-
description?: string;
|
|
685
|
-
confidence: number;
|
|
686
|
-
}
|
|
687
|
-
interface DocsMarkdownRecoveryResult {
|
|
688
|
-
matches: DocsMarkdownRecoveryMatch[];
|
|
689
|
-
redirect?: DocsMarkdownRecoveryMatch;
|
|
690
|
-
}
|
|
691
|
-
interface DocsMarkdownCanonicalUrlOptions {
|
|
692
|
-
origin: string;
|
|
693
|
-
entry?: string;
|
|
694
|
-
requestedPath: string;
|
|
695
|
-
locale?: string | null;
|
|
696
|
-
}
|
|
697
|
-
interface DocsMarkdownResponseOptions extends DocsMarkdownNotFoundOptions {
|
|
698
|
-
request: Request;
|
|
699
|
-
document: string | null;
|
|
700
|
-
/** Override the human-readable canonical URL, for example when docsPath differs from entry. */
|
|
701
|
-
canonicalUrl?: string;
|
|
702
|
-
/** Override the selected Markdown representation URL. */
|
|
703
|
-
contentLocation?: string;
|
|
704
|
-
locale?: string | null;
|
|
705
|
-
/** Exact source modification timestamp. Date-only values are intentionally ignored. */
|
|
706
|
-
lastModified?: string | Date | null;
|
|
707
|
-
cacheControl?: string;
|
|
708
|
-
}
|
|
709
|
-
declare function normalizeDocsPathSegment(value: string): string;
|
|
710
|
-
declare function normalizeDocsUrlPath(value: string): string;
|
|
711
|
-
declare function isDocsConfigRequest(url: URL): boolean;
|
|
712
|
-
declare function isDocsDiagnosticsRequest(url: URL): boolean;
|
|
713
|
-
/** Prefer an explicitly configured API route; otherwise infer a query-form route from the request. */
|
|
714
|
-
declare function resolveDocsRequestApiRoute(url: URL, configuredApiRoute?: string): string;
|
|
715
|
-
declare function buildDocsConfigMap(config: DocsConfig | Record<string, unknown>, options?: {
|
|
716
|
-
file?: string;
|
|
717
|
-
}): DocsConfigMap;
|
|
718
|
-
declare function buildDocsDiagnostics(config: DocsConfig | Record<string, unknown>, options?: DocsDiagnosticsOptions): DocsDiagnostics;
|
|
719
|
-
declare function buildDocsAgentFeedbackSchema(payloadSchema: Record<string, unknown>): Record<string, unknown>;
|
|
720
|
-
declare function resolveDocsAgentFeedbackConfig(feedback?: boolean | FeedbackConfig): DocsAgentFeedbackResolvedConfig;
|
|
721
|
-
declare function resolveDocsAgentFeedbackRequest(url: URL, feedback: DocsAgentFeedbackResolvedConfig): DocsAgentFeedbackRequest | null;
|
|
722
|
-
declare function parseDocsAgentFeedbackData(request: Request): Promise<{
|
|
723
|
-
ok: true;
|
|
724
|
-
data: DocsAgentFeedbackData;
|
|
725
|
-
} | {
|
|
726
|
-
ok: false;
|
|
727
|
-
response: Response;
|
|
728
|
-
}>;
|
|
729
|
-
declare function validateDocsAgentFeedbackPayload(value: unknown, schema: Record<string, unknown>, valuePath?: string): string | undefined;
|
|
730
|
-
declare function toDocsMarkdownUrl(url: string, options?: {
|
|
731
|
-
locale?: string;
|
|
732
|
-
}): string;
|
|
733
|
-
declare function resolveDocsMarkdownCanonicalUrl({
|
|
734
|
-
origin,
|
|
735
|
-
entry,
|
|
736
|
-
requestedPath,
|
|
737
|
-
locale
|
|
738
|
-
}: DocsMarkdownCanonicalUrlOptions): string;
|
|
739
|
-
declare function getDocsMarkdownCanonicalLinkHeader(options: DocsMarkdownCanonicalUrlOptions): string;
|
|
740
|
-
declare function resolveDocsLlmsTxtSections(llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig): DocsLlmsTxtResolvedSection[];
|
|
741
|
-
declare function matchesDocsLlmsTxtSection(pageUrl: string, section: DocsLlmsTxtResolvedSection): boolean;
|
|
742
|
-
declare function resolveDocsLlmsTxtRequest(url: URL, llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig, basePath?: string, options?: DocsDiscoveryApiRouteOptions): DocsLlmsTxtRequest | null;
|
|
743
|
-
declare function renderDocsLlmsTxt(pages: DocsLlmsTxtPageInput[], options?: DocsLlmsDiscoveryConfig): DocsLlmsTxtGeneratedContent;
|
|
744
|
-
declare function selectDocsLlmsTxtContent(content: DocsLlmsTxtGeneratedContent, request: DocsLlmsTxtRequest): DocsLlmsTxtSelectedContent | null;
|
|
745
|
-
declare function getDocsLlmsTxtMaxCharsIssue(label: string, content: string, maxChars: DocsLlmsTxtResolvedMaxChars): DocsLlmsTxtMaxCharsIssue | null;
|
|
746
|
-
/** Build and serve standards-based discovery without replacing the custom agent manifest. */
|
|
747
|
-
declare function createDocsStandardsDiscoveryResponse({
|
|
748
|
-
request,
|
|
749
|
-
preferredSkillDocument,
|
|
750
|
-
fallbackSkillDocument,
|
|
751
|
-
origin,
|
|
752
|
-
entry,
|
|
753
|
-
docsPath,
|
|
754
|
-
apiCatalog: explicitApiCatalog,
|
|
755
|
-
apiRoute,
|
|
756
|
-
i18n: _i18n,
|
|
757
|
-
search: _search,
|
|
758
|
-
mcp,
|
|
759
|
-
feedback,
|
|
760
|
-
llms,
|
|
761
|
-
sitemap,
|
|
762
|
-
robots,
|
|
763
|
-
openapi,
|
|
764
|
-
markdown: _markdown,
|
|
765
|
-
publishedSkills,
|
|
766
|
-
agentCard
|
|
767
|
-
}: DocsStandardsDiscoveryResponseOptions): Promise<Response | null>;
|
|
768
|
-
declare function isDocsAgentDiscoveryRequest(url: URL, options?: DocsDiscoveryApiRouteOptions): boolean;
|
|
769
|
-
declare function buildDocsMcpEndpointCandidates(baseUrl: string, routes?: readonly string[], options?: DocsMcpEndpointCandidateOptions): DocsMcpEndpointCandidate[];
|
|
770
|
-
declare function isDocsSkillRequest(url: URL, options?: DocsDiscoveryApiRouteOptions): boolean;
|
|
771
|
-
declare function resolveDocsSkillFormat(url: URL): "skill" | null;
|
|
772
|
-
declare function isDocsAgentsRequest(url: URL, options?: DocsDiscoveryApiRouteOptions): boolean;
|
|
773
|
-
declare function resolveDocsAgentsFormat(url: URL): "agents" | null;
|
|
774
|
-
declare function isDocsPublicGetRequest(entry: string, url: URL, request: Request, options?: DocsDiscoveryApiRouteOptions & {
|
|
775
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
776
|
-
llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig;
|
|
777
|
-
robots?: boolean | DocsRobotsConfig;
|
|
778
|
-
}): boolean;
|
|
779
|
-
declare function isDocsLlmsTxtPublicRequest(url: URL, llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig, basePath?: string, options?: DocsDiscoveryApiRouteOptions): boolean;
|
|
780
|
-
declare function resolveDocsLlmsTxtFormat(url: URL, basePath?: string, options?: DocsDiscoveryApiRouteOptions): "llms" | "llms-full" | null;
|
|
781
|
-
declare function resolveDocsMarkdownRequest(entry: string, url: URL, request: Request, options?: DocsDiscoveryApiRouteOptions): {
|
|
782
|
-
requestedPath: string;
|
|
783
|
-
} | null;
|
|
784
|
-
declare function hasDocsMarkdownSignatureAgent(request: Request): boolean;
|
|
785
|
-
type DocsMarkdownAgentDetection = {
|
|
786
|
-
detected: true;
|
|
787
|
-
method: "signature_agent" | "user_agent" | "heuristic";
|
|
788
|
-
} | {
|
|
789
|
-
detected: false;
|
|
790
|
-
method: null;
|
|
791
|
-
};
|
|
792
|
-
declare function detectDocsMarkdownAgentRequest(request: Request): DocsMarkdownAgentDetection;
|
|
793
|
-
declare function getDocsMarkdownVaryHeader(request: Request): string | null;
|
|
794
|
-
declare function resolveDocsMarkdownRecovery({
|
|
795
|
-
entry,
|
|
796
|
-
requestedPath,
|
|
797
|
-
pages
|
|
798
|
-
}: DocsMarkdownNotFoundOptions): DocsMarkdownRecoveryResult;
|
|
799
|
-
declare function renderDocsMarkdownNotFound({
|
|
800
|
-
entry,
|
|
801
|
-
apiRoute,
|
|
802
|
-
requestedPath,
|
|
803
|
-
origin,
|
|
804
|
-
pages,
|
|
805
|
-
sitemap
|
|
806
|
-
}: DocsMarkdownNotFoundOptions): string;
|
|
807
|
-
/** Build one standards-aware Markdown response for every framework adapter. */
|
|
808
|
-
declare function createDocsMarkdownResponse(options: DocsMarkdownResponseOptions): Response;
|
|
809
|
-
declare function findDocsMarkdownPage<T extends DocsMarkdownPage>(entry: string, pages: T[], requestedPath: string): T | null;
|
|
810
|
-
declare function renderDocsMarkdownDocument(page: DocsMcpPage | DocsSearchSourcePage, options?: DocsMarkdownDocumentOptions): string;
|
|
811
|
-
declare function renderDocsMarkdownDocument(page: DocsMarkdownPage, options?: DocsMarkdownDocumentOptions): string;
|
|
812
|
-
declare function renderDocsSkillDocument(options: DocsSkillDocumentOptions): string;
|
|
813
|
-
declare function renderDocsAgentsDocument(options: DocsAgentsDocumentOptions): string;
|
|
814
|
-
/** Resolve only the task tools that the advertised MCP endpoint actually exposes. */
|
|
815
|
-
declare function resolveDocsAgentContractMcpTools(mcp: DocsMcpResolvedConfig): DocsAgentContractMcpTools | undefined;
|
|
816
|
-
declare function buildDocsAgentDiscoverySpec({
|
|
817
|
-
origin,
|
|
818
|
-
entry,
|
|
819
|
-
apiRoute,
|
|
820
|
-
apiCatalog: explicitApiCatalog,
|
|
821
|
-
i18n,
|
|
822
|
-
search,
|
|
823
|
-
mcp,
|
|
824
|
-
feedback,
|
|
825
|
-
llms,
|
|
826
|
-
sitemap,
|
|
827
|
-
robots,
|
|
828
|
-
openapi,
|
|
829
|
-
markdown,
|
|
830
|
-
publishedSkills,
|
|
831
|
-
agentCard
|
|
832
|
-
}: DocsAgentDiscoverySpecOptions): {
|
|
833
|
-
version: string;
|
|
834
|
-
name: string;
|
|
835
|
-
baseUrl: string;
|
|
836
|
-
site: {
|
|
837
|
-
title: string;
|
|
838
|
-
description: string | undefined;
|
|
839
|
-
entry: string;
|
|
840
|
-
baseUrl: string;
|
|
841
|
-
};
|
|
842
|
-
locales: {
|
|
843
|
-
enabled: boolean;
|
|
844
|
-
available: string[];
|
|
845
|
-
default: string | null;
|
|
846
|
-
queryParam: string;
|
|
847
|
-
fallbackQueryParam: string;
|
|
848
|
-
};
|
|
849
|
-
capabilities: {
|
|
850
|
-
markdownRoutes: boolean;
|
|
851
|
-
agentMdOverrides: boolean;
|
|
852
|
-
agentBlocks: boolean;
|
|
853
|
-
structuredAgentContracts: boolean;
|
|
854
|
-
agents: boolean;
|
|
855
|
-
llms: boolean;
|
|
856
|
-
skills: boolean;
|
|
857
|
-
apiCatalog: boolean;
|
|
858
|
-
agentSkillsDiscovery: boolean;
|
|
859
|
-
mcp: boolean;
|
|
860
|
-
search: boolean;
|
|
861
|
-
sitemap: boolean;
|
|
862
|
-
robots: boolean;
|
|
863
|
-
structuredData: boolean;
|
|
864
|
-
apiReference: boolean;
|
|
865
|
-
openapi: boolean;
|
|
866
|
-
agentFeedback: boolean;
|
|
867
|
-
locales: boolean;
|
|
868
|
-
};
|
|
869
|
-
api: {
|
|
870
|
-
openapi: string;
|
|
871
|
-
agentCard?: string | undefined;
|
|
872
|
-
agentSkillsIndex: string;
|
|
873
|
-
legacySkillsIndex: string;
|
|
874
|
-
apiCatalog?: string | undefined;
|
|
875
|
-
apiCatalogQuery?: string | undefined;
|
|
876
|
-
docs: string;
|
|
877
|
-
config: string;
|
|
878
|
-
diagnostics: string;
|
|
879
|
-
agentSpec: string;
|
|
880
|
-
agentSpecDefault: string;
|
|
881
|
-
agentSpecFallback: string;
|
|
882
|
-
agentSpecWellKnown: string;
|
|
883
|
-
agentSpecWellKnownJson: string;
|
|
884
|
-
agentSpecQuery: string;
|
|
885
|
-
agents: string;
|
|
886
|
-
};
|
|
887
|
-
apiCatalog: {
|
|
888
|
-
enabled: boolean;
|
|
889
|
-
route: string | null;
|
|
890
|
-
api: string | null;
|
|
891
|
-
mediaType: string;
|
|
892
|
-
profile: string;
|
|
893
|
-
};
|
|
894
|
-
config: {
|
|
895
|
-
format: string;
|
|
896
|
-
endpoint: string;
|
|
897
|
-
};
|
|
898
|
-
markdown: {
|
|
899
|
-
enabled: boolean;
|
|
900
|
-
acceptHeader: string | null;
|
|
901
|
-
signatureAgentHeader: string | null;
|
|
902
|
-
pagePattern: string;
|
|
903
|
-
rootPage: string;
|
|
904
|
-
apiPattern: string;
|
|
905
|
-
resolutionOrder: string[];
|
|
906
|
-
};
|
|
907
|
-
agentContract: {
|
|
908
|
-
usefulContractFields: string[];
|
|
909
|
-
fields: {
|
|
910
|
-
readonly tokenBudget: "number";
|
|
911
|
-
readonly task: "string";
|
|
912
|
-
readonly outcome: "string";
|
|
913
|
-
readonly appliesTo: {
|
|
914
|
-
readonly framework: "string|string[]";
|
|
915
|
-
readonly version: "string|string[]";
|
|
916
|
-
readonly package: "string|string[]";
|
|
917
|
-
};
|
|
918
|
-
readonly prerequisites: "string[]";
|
|
919
|
-
readonly files: "string[]";
|
|
920
|
-
readonly commands: "Array<string|{run,cwd?,description?}>";
|
|
921
|
-
readonly sideEffects: "string[]";
|
|
922
|
-
readonly verification: "Array<string|{description?,run?,expect?}>";
|
|
923
|
-
readonly rollback: "string[]";
|
|
924
|
-
readonly failureModes: "Array<string|{symptom,resolution?}>";
|
|
925
|
-
};
|
|
926
|
-
mcpTools?: DocsAgentContractMcpTools | undefined;
|
|
927
|
-
enabled: boolean;
|
|
928
|
-
schemaVersion: string;
|
|
929
|
-
source: string;
|
|
930
|
-
frontmatterPath: string;
|
|
931
|
-
markdownSection: string;
|
|
932
|
-
mcpField: string;
|
|
933
|
-
};
|
|
934
|
-
llms: {
|
|
935
|
-
sections?: {
|
|
936
|
-
title: string;
|
|
937
|
-
description: string | undefined;
|
|
938
|
-
match: string[];
|
|
939
|
-
txt: string;
|
|
940
|
-
full: string;
|
|
941
|
-
}[] | undefined;
|
|
942
|
-
enabled: boolean;
|
|
943
|
-
defaultTxt: string;
|
|
944
|
-
defaultFull: string;
|
|
945
|
-
txt: string;
|
|
946
|
-
full: string;
|
|
947
|
-
publicTxt: string;
|
|
948
|
-
publicFull: string;
|
|
949
|
-
wellKnownTxt: string;
|
|
950
|
-
wellKnownFull: string;
|
|
951
|
-
};
|
|
952
|
-
sitemap: {
|
|
953
|
-
enabled: boolean;
|
|
954
|
-
xml: {
|
|
955
|
-
enabled: boolean;
|
|
956
|
-
route: string;
|
|
957
|
-
api: string;
|
|
958
|
-
defaultRoute: string;
|
|
959
|
-
};
|
|
960
|
-
markdown: {
|
|
961
|
-
enabled: boolean;
|
|
962
|
-
route: string;
|
|
963
|
-
docsRoute: string | undefined;
|
|
964
|
-
wellKnownRoute: string;
|
|
965
|
-
api: string;
|
|
966
|
-
defaultRoute: string;
|
|
967
|
-
defaultDocsRoute: string;
|
|
968
|
-
defaultWellKnownRoute: string;
|
|
969
|
-
};
|
|
970
|
-
};
|
|
971
|
-
robots: {
|
|
972
|
-
enabled: boolean;
|
|
973
|
-
route: string;
|
|
974
|
-
defaultRoute: string;
|
|
975
|
-
};
|
|
976
|
-
structuredData: {
|
|
977
|
-
enabled: boolean;
|
|
978
|
-
format: string;
|
|
979
|
-
schema: string;
|
|
980
|
-
fields: string[];
|
|
981
|
-
canonicalUrlField: string;
|
|
982
|
-
breadcrumbType: string;
|
|
983
|
-
agentContractType: string;
|
|
984
|
-
};
|
|
985
|
-
openapi: {
|
|
986
|
-
enabled: boolean;
|
|
987
|
-
url: string | null;
|
|
988
|
-
source: "generated" | "configured" | null;
|
|
989
|
-
specUrl: string | null;
|
|
990
|
-
apiReferencePath: string | null;
|
|
991
|
-
format: string;
|
|
992
|
-
};
|
|
993
|
-
search: {
|
|
994
|
-
enabled: boolean;
|
|
995
|
-
endpoint: string;
|
|
996
|
-
method: string;
|
|
997
|
-
queryParam: string;
|
|
998
|
-
localeParam: string;
|
|
999
|
-
};
|
|
1000
|
-
agents: {
|
|
1001
|
-
enabled: boolean;
|
|
1002
|
-
file: string;
|
|
1003
|
-
route: string;
|
|
1004
|
-
wellKnown: string;
|
|
1005
|
-
api: string;
|
|
1006
|
-
generatedFallback: boolean;
|
|
1007
|
-
aliases: string[];
|
|
1008
|
-
};
|
|
1009
|
-
skills: {
|
|
1010
|
-
enabled: boolean;
|
|
1011
|
-
file: string;
|
|
1012
|
-
route: string;
|
|
1013
|
-
wellKnown: string;
|
|
1014
|
-
api: string;
|
|
1015
|
-
generatedFallback: boolean;
|
|
1016
|
-
registry: string;
|
|
1017
|
-
install: string;
|
|
1018
|
-
discovery: {
|
|
1019
|
-
schema: string;
|
|
1020
|
-
index: string;
|
|
1021
|
-
artifact: string;
|
|
1022
|
-
archive: string;
|
|
1023
|
-
file: string;
|
|
1024
|
-
legacyIndex: string;
|
|
1025
|
-
apiIndex: string;
|
|
1026
|
-
apiArtifact: string;
|
|
1027
|
-
apiFile: string;
|
|
1028
|
-
digest: string;
|
|
1029
|
-
};
|
|
1030
|
-
published: {
|
|
1031
|
-
name: string;
|
|
1032
|
-
description: string;
|
|
1033
|
-
type: "skill-md" | "archive";
|
|
1034
|
-
url: string;
|
|
1035
|
-
digest: `sha256:${string}`;
|
|
1036
|
-
files: {
|
|
1037
|
-
path: string;
|
|
1038
|
-
url: string;
|
|
1039
|
-
digest: `sha256:${string}`;
|
|
1040
|
-
}[];
|
|
1041
|
-
}[];
|
|
1042
|
-
recommended: {
|
|
1043
|
-
name: string;
|
|
1044
|
-
description: string;
|
|
1045
|
-
}[];
|
|
1046
|
-
};
|
|
1047
|
-
mcp: {
|
|
1048
|
-
protectedResource?: {
|
|
1049
|
-
metadataEndpoints: string[];
|
|
1050
|
-
authorizationServers: string[];
|
|
1051
|
-
scopesSupported: string[];
|
|
1052
|
-
requiredScopes: string[];
|
|
1053
|
-
} | undefined;
|
|
1054
|
-
enabled: boolean;
|
|
1055
|
-
endpoint: string;
|
|
1056
|
-
defaultEndpoint: string;
|
|
1057
|
-
publicEndpoint: string;
|
|
1058
|
-
wellKnownEndpoint: string;
|
|
1059
|
-
publicEndpoints: string[];
|
|
1060
|
-
canonicalEndpoint: string;
|
|
1061
|
-
name: string;
|
|
1062
|
-
version: string;
|
|
1063
|
-
tools: {
|
|
1064
|
-
listDocs: boolean;
|
|
1065
|
-
listPages: boolean;
|
|
1066
|
-
readPage: boolean;
|
|
1067
|
-
listTasks?: boolean;
|
|
1068
|
-
readTask?: boolean;
|
|
1069
|
-
searchDocs: boolean;
|
|
1070
|
-
getNavigation: boolean;
|
|
1071
|
-
getCodeExamples: boolean;
|
|
1072
|
-
getConfigSchema: boolean;
|
|
1073
|
-
getContext: boolean;
|
|
1074
|
-
};
|
|
1075
|
-
};
|
|
1076
|
-
feedback: {
|
|
1077
|
-
enabled: boolean;
|
|
1078
|
-
schema: string;
|
|
1079
|
-
submit: string;
|
|
1080
|
-
schemaQuery: string;
|
|
1081
|
-
submitQuery: string;
|
|
1082
|
-
};
|
|
1083
|
-
instructions: {
|
|
1084
|
-
preferMarkdownRoutes: boolean;
|
|
1085
|
-
useMcpWhenAvailable: boolean;
|
|
1086
|
-
useOpenApiWhenAvailable: boolean;
|
|
1087
|
-
readFeedbackSchemaBeforeSubmitting: boolean;
|
|
1088
|
-
doNotAssumeFeedbackPayloadShape: boolean;
|
|
1089
|
-
};
|
|
1090
|
-
};
|
|
1091
|
-
declare function acceptsDocsMarkdown(request: Request): boolean;
|
|
1092
|
-
declare function resolveDocsOpenApiDiscoveryConfig(openapi?: boolean | DocsOpenApiDiscoveryConfig): DocsOpenApiResolvedDiscoveryConfig;
|
|
1093
|
-
//#endregion
|
|
1094
|
-
//#region src/robots.d.ts
|
|
1095
|
-
declare const DEFAULT_ROBOTS_TXT_ROUTE = "/robots.txt";
|
|
1096
|
-
declare const DOCS_ROBOTS_GENERATED_BLOCK_START = "# BEGIN @farming-labs/docs robots";
|
|
1097
|
-
declare const DOCS_ROBOTS_GENERATED_BLOCK_END = "# END @farming-labs/docs robots";
|
|
1098
|
-
declare const DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS: readonly ["GPTBot", "ChatGPT-User", "OAI-SearchBot", "ClaudeBot", "Claude-User", "anthropic-ai", "CCBot", "Google-Extended"];
|
|
1099
|
-
interface DocsRobotsResolvedConfig {
|
|
1100
|
-
enabled: boolean;
|
|
1101
|
-
path?: string;
|
|
1102
|
-
baseUrl?: string;
|
|
1103
|
-
ai: "allow" | "disallow";
|
|
1104
|
-
userAgents: string[];
|
|
1105
|
-
extraRules: DocsRobotsRule[];
|
|
1106
|
-
}
|
|
1107
|
-
interface DocsRobotsRenderOptions {
|
|
1108
|
-
entry?: string;
|
|
1109
|
-
/** Include the RFC 9727 catalog route only when the deployment actually serves it. */
|
|
1110
|
-
apiCatalog?: boolean;
|
|
1111
|
-
/** Include an A2A Agent Card only when a real A2A service is configured. */
|
|
1112
|
-
agentCard?: boolean;
|
|
1113
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
1114
|
-
baseUrl?: string;
|
|
1115
|
-
robots?: boolean | DocsRobotsConfig;
|
|
1116
|
-
}
|
|
1117
|
-
interface DocsRobotsAnalysis {
|
|
1118
|
-
blocksAgentRoutes: boolean;
|
|
1119
|
-
blocksAiAgents: boolean;
|
|
1120
|
-
hasAgentRoutes: boolean;
|
|
1121
|
-
hasAiPolicy: boolean;
|
|
1122
|
-
missingRoutes: string[];
|
|
1123
|
-
}
|
|
1124
|
-
interface CreateDocsRobotsResponseOptions extends DocsRobotsRenderOptions {
|
|
1125
|
-
request: Request;
|
|
1126
|
-
}
|
|
1127
|
-
declare function resolveDocsRobotsConfig(input: boolean | DocsRobotsConfig | undefined, options?: {
|
|
1128
|
-
baseUrl?: string;
|
|
1129
|
-
}): DocsRobotsResolvedConfig;
|
|
1130
|
-
declare function getDocsRobotsAllowRoutes(options?: DocsRobotsRenderOptions): string[];
|
|
1131
|
-
declare function renderDocsRobotsTxt(options?: DocsRobotsRenderOptions): string;
|
|
1132
|
-
declare function resolveDocsRobotsRequest(url: URL, robots?: boolean | DocsRobotsConfig): "robots" | null;
|
|
1133
|
-
declare function createDocsRobotsResponse({
|
|
1134
|
-
request,
|
|
1135
|
-
...options
|
|
1136
|
-
}: CreateDocsRobotsResponseOptions): Response | null;
|
|
1137
|
-
declare function renderDocsRobotsGeneratedBlock(options?: DocsRobotsRenderOptions): string;
|
|
1138
|
-
declare function upsertDocsRobotsGeneratedBlock(existing: string, block: string): string;
|
|
1139
|
-
declare function analyzeDocsRobotsTxt(content: string, options?: DocsRobotsRenderOptions): DocsRobotsAnalysis;
|
|
1140
|
-
//#endregion
|
|
1141
|
-
export { AGENT_SKILLS_DISCOVERY_SCHEMA_URI, type AIConfig, API_CATALOG_MEDIA_TYPE, API_CATALOG_PROFILE_URI, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CopyMarkdownFormat, type CreateDocsStandardsResponseOptions, type CustomDocsSearchConfig, DEFAULT_A2A_AGENT_CARD_FORMAT, DEFAULT_A2A_AGENT_CARD_ROUTE, DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN, DEFAULT_AGENT_SKILLS_INDEX_FORMAT, DEFAULT_AGENT_SKILLS_INDEX_ROUTE, DEFAULT_AGENT_SKILLS_ROUTE_PATTERN, DEFAULT_AGENT_SKILLS_ROUTE_PREFIX, DEFAULT_AGENT_SKILL_ARCHIVE_FORMAT, DEFAULT_AGENT_SKILL_FILE_FORMAT, DEFAULT_AGENT_SKILL_FORMAT, DEFAULT_AGENT_SKILL_RESOURCE_FORMAT, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_API_CATALOG_FORMAT, DEFAULT_API_CATALOG_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LEGACY_SKILLS_INDEX_FORMAT, DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_CONTRACT_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, type DocsA2AAgentCard, type DocsA2AAgentCardOptions, type DocsAgentA2AConfig, type DocsAgentAdapter, type DocsAgentCompactConfig, type DocsAgentConfig, type DocsAgentConformanceCaseResult, type DocsAgentConformanceReport, type DocsAgentContractCase, type DocsAgentContractExpectation, type DocsAgentContractMcpTools, type DocsAgentContractRequest, type DocsAgentContractSurface, type DocsAgentDiscoverySpecOptions, type DocsAgentEvaluationAnswerInput, type DocsAgentEvaluationAnswerProvider, type DocsAgentEvaluationAnswerRequest, type DocsAgentEvaluationAnswerResult, type DocsAgentEvaluationAnswerRunner, type DocsAgentEvaluationSourceReference, type DocsAgentEvaluationSurface, type DocsAgentEvaluationTaskInput, type DocsAgentEvaluationsConfig, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentGoldenAnswerExpectation, type DocsAgentGoldenExampleVerification, type DocsAgentGoldenExpectedExample, type DocsAgentGoldenTask, type DocsAgentGoldenTaskExpectation, type DocsAgentGoldenTaskFilters, type DocsAgentSkillIndexEntry, type DocsAgentSkillsConfig, type DocsAgentSkillsIndex, type DocsAgentSkillsInput, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsApiCatalog, type DocsApiCatalogLinkContext, type DocsApiCatalogLinkTarget, type DocsApiCatalogOptions, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsAudienceMdxIssue, type DocsCloudApiKeyConfig, type DocsCloudConfig, type DocsCloudFeatureConfig, type DocsCloudPreviewConfig, type DocsCloudPublishConfig, type DocsCodeBlocksConfig, type DocsCodeBlocksPlannerConfig, type DocsCodeBlocksPlannerProvider, type DocsCodeBlocksRunnerConfig, type DocsCodeBlocksRunnerProvider, type DocsCodeBlocksValidateConfig, type DocsCodeBlocksValidationMode, type DocsCodeBlocksValidationPolicy, type DocsConfig, type DocsConfigMap, type DocsConfigMapJsonValue, type DocsConfigMapPointer, type DocsContentAudience, type DocsDiagnostics, type DocsDiagnosticsFeature, type DocsDiagnosticsIssue, type DocsDiagnosticsIssueSeverity, type DocsDiagnosticsOptions, type DocsDiagnosticsStatus, type DocsDiscoveryApiRouteOptions, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsLlmsDiscoveryConfig, type DocsLlmsTxtGeneratedContent, type DocsLlmsTxtGeneratedSection, type DocsLlmsTxtMaxCharsIssue, type DocsLlmsTxtPageInput, type DocsLlmsTxtRequest, type DocsLlmsTxtResolvedMaxChars, type DocsLlmsTxtResolvedSection, type DocsLlmsTxtSelectedContent, type DocsMarkdownAgentDetection, type DocsMarkdownPage, type DocsMarkdownRecoveryMatch, type DocsMarkdownRecoveryResult, type DocsMarkdownResponseOptions, type DocsMcpAllowedOrigins, type DocsMcpAuthPrincipal, type DocsMcpAuthenticate, type DocsMcpAuthenticateContext, type DocsMcpAuthenticateResult, type DocsMcpConfig, type DocsMcpCorsConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpOriginContext, type DocsMcpProtectedResourceConfig, type DocsMcpSecurityConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, type DocsPublishedAgentSkill, type DocsPublishedAgentSkillFile, type DocsPublishedAgentSkillOptions, type DocsRelatedItem, type DocsReviewCiConfig, type DocsReviewCiMode, type DocsReviewConfig, type DocsReviewRulesConfig, type DocsReviewScoreConfig, type DocsReviewSeverity, type DocsRobotsConfig, type DocsRobotsRenderOptions, type DocsRobotsResolvedConfig, type DocsRobotsRule, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsSitemapConfig, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type DocsSkillDocumentOptions, type DocsStandardsDiscoveryRequest, type DocsStandardsDiscoveryResponseOptions, type DocsStandardsDiscoveryRouteOptions, type DocsStructuredDataBreadcrumb, type DocsTelemetryAgentSurface, type DocsTelemetryAgentSurfaceContext, type DocsTelemetryAgentSurfaceRequestOptions, type DocsTelemetryConfig, type DocsTelemetryContext, type DocsTelemetryEvent, type DocsTelemetryEventInput, type DocsTelemetryEventType, type DocsTelemetryFeatures, type DocsTelemetryFramework, type DocsTheme, type FeedbackConfig, type FontStyle, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, type GeneratedAgentProvenance, type GeneratedAgentSourceKind, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type LlmsTxtMaxCharsConfig, type LlmsTxtMaxCharsMode, type LlmsTxtSectionConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenDocsProviderConfig, type OpenDocsProviderId, type OpenDocsTarget, type OpenGraphImage, type OrderingItem, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_FIELDS, PAGE_AGENT_CONTRACT_FIELD_SCHEMA, PAGE_AGENT_CONTRACT_START_MARKER, PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, type PageActionsConfig, type PageAgentAppliesTo, type PageAgentCommand, type PageAgentFailureMode, type PageAgentFrontmatter, type PageAgentFrontmatterIssue, type PageAgentVerification, type PageFrontmatter, type PageOpenGraph, type PageSidebarFrontmatter, type PageTwitter, type PromptAction, type PromptProviderChoice, type ReadingTimeConfig, type ReadingTimeFormat, type ResolvedChangelogConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsI18n, type ResolvedDocsObservabilityConfig, type ResolvedDocsRelatedLink, type ResolvedDocsTelemetryConfig, type RunDocsAgentConformanceOptions, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, type SidebarComponentProps, type SidebarConfig, type SidebarFolderIndexBehavior, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, acceptsDocsMarkdown, analyzeDocsRobotsTxt, appendDocsDiscoveryLinkHeader, applySidebarFolderIndexBehavior, buildDocsA2AAgentCard, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAgentSkillsIndex, buildDocsApiCatalog, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsLegacySkillsIndex, buildDocsMcpEndpointCandidates, buildDocsMcpProtectedResourceMetadataRoute, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createDocsStandardsDiscoveryResponse, createDocsStandardsResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsAudienceMdxIssues, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsDiscoveryLinkHeader, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsMcpProtectedResourceMetadataRoutes, getDocsMcpResourcePaths, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasDocsMcpProtectedResourceConfig, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, isDocsStandardsDiscoveryRequest, isLocalDocsTelemetryOrigin, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsTelemetryOrigin, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsAudienceExposure, resolveDocsAudienceMdxContent, resolveDocsDiscoveryApiRoute, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsPublishedAgentSkill, resolveDocsRequestApiRoute, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsStandardsDiscoveryRequest, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, sha256DocsDiscoveryContent, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|