@farming-labs/docs 0.2.52 → 0.2.54
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/dist/agent-BXvi0uhS.mjs +623 -0
- package/dist/{agent-CaOBIVFy.mjs → agent-DXkXi-pS.mjs} +765 -22
- package/dist/agent-evals-BD17jOqL.mjs +1166 -0
- package/dist/agent-export-n-a0GbeU.mjs +854 -0
- package/dist/agent-scope-B8lptqCd.mjs +283 -0
- package/dist/agent-surface-drift-LS8zQgbq.mjs +1429 -0
- package/dist/{agents-DjhjZaNP.mjs → agents-BJaRQimo.mjs} +7 -5
- package/dist/{analytics-BZEwTK-8.mjs → analytics-Bx44lg6d.mjs} +1 -1
- package/dist/cli/index.mjs +43 -28
- package/dist/client/react.d.mts +1 -1
- package/dist/client/react.mjs +1 -1
- package/dist/{cloud-C_Ok9rC5.mjs → cloud-HWFlbfLJ.mjs} +4 -4
- package/dist/{cloud-ask-ai-Cl-xaV8j.mjs → cloud-ask-ai-1k0q6OAH.mjs} +1 -1
- package/dist/{cloud-ask-ai-DcMe6xOf.d.mts → cloud-ask-ai-466g6uAi.d.mts} +1 -1
- package/dist/code-blocks-C9awWzEQ.mjs +871 -0
- package/dist/codeblocks-BzfkREEC.mjs +250 -0
- package/dist/{config-tiQCZ46q.mjs → config-CydaZ5PB.mjs} +52 -11
- package/dist/{dev-Tm9Ss4D6.mjs → dev-BA2kRuCn.mjs} +3 -3
- package/dist/docs-cloud-server.d.mts +2 -2
- package/dist/docs-cloud-server.mjs +2 -2
- package/dist/{doctor-O9o9kjN8.mjs → doctor-CQpQ2zZm.mjs} +177 -47
- package/dist/{downgrade-CYEaOctn.mjs → downgrade-BStNhyCc.mjs} +2 -2
- package/dist/i18n-CAlj1ADU.mjs +40 -0
- package/dist/index.d.mts +158 -3
- package/dist/index.mjs +7 -6
- package/dist/{init-Ch5On0zm.mjs → init-gnHQ_Pz9.mjs} +3 -3
- package/dist/{mcp-DuCPNHS-.mjs → mcp-DnxZZWpY.mjs} +10 -5
- package/dist/mcp.d.mts +122 -6
- package/dist/mcp.mjs +1943 -86
- package/dist/{package-version-C8PigBZk.mjs → package-version-DRIc08EU.mjs} +1 -1
- package/dist/{reading-time-CPAy1SWO.mjs → reading-time-BrTd3DIh.mjs} +277 -33
- package/dist/{review-lm3dt7yy.mjs → review-B6gyEFkD.mjs} +184 -14
- package/dist/{robots-DV7u4Ire.mjs → robots-4BUJxlvV.mjs} +4 -4
- package/dist/{robots-XVPs9lVz.mjs → robots-DAptQnkx.mjs} +1 -1
- package/dist/{search-BWuU70B0.mjs → search-CJIC1Cqo.mjs} +173 -79
- package/dist/{search-B6nEkx86.mjs → search-CbPm2x5g.mjs} +6 -4
- package/dist/{search-DFEhf9-s.d.mts → search-CfWvmVYA.d.mts} +3 -1
- package/dist/server.d.mts +108 -5
- package/dist/server.mjs +9 -8
- package/dist/{sitemap-BEiKy4Iy.mjs → sitemap-D6nP3J1Q.mjs} +8 -6
- package/dist/{sitemap-server-xEHtDUDB.mjs → sitemap-server-wsNLyVkb.mjs} +1 -1
- package/dist/{templates-uaauJcTO.mjs → templates-1Cod8KrJ.mjs} +11 -5
- package/dist/{types-XqGLsmOD.d.mts → types-BVgucdVm.d.mts} +194 -2
- package/dist/{upgrade-DzQtpgJM.mjs → upgrade-CXYRNV0C.mjs} +2 -2
- package/package.json +1 -1
- package/dist/agent-DXDOMJBw.mjs +0 -9
- package/dist/codeblocks-z9iT794h.mjs +0 -1713
- package/dist/review-B7goPYUb.mjs +0 -541
- /package/dist/{cloud-analytics-Dlk_byos.mjs → cloud-analytics-CSyFE6SS.mjs} +0 -0
- /package/dist/{errors-CW1LnxaQ.mjs → errors-BFUtdZfC.mjs} +0 -0
- /package/dist/{utils-D-xTRNuh.mjs → utils-DBCCkkJS.mjs} +0 -0
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { $ as
|
|
2
|
-
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-
|
|
1
|
+
import { $ as DocsFeedbackValue, $t as McpDocsSearchConfig, A as DocsAnalyticsSource, An as TypesenseDocsSearchConfig, At as DocsSearchDocument, B as DocsCloudFeatureConfig, Bt as DocsTelemetryEventInput, C as DocsAgentTraceEventType, Cn as SidebarFolderIndexBehavior, Ct as DocsRobotsConfig, D as DocsAnalyticsEventInput, Dn as SidebarTree, Dt as DocsSearchAdapterFactory, E as DocsAnalyticsEvent, En as SidebarPageNode, Et as DocsSearchAdapterContext, F as DocsAskAIFeedbackMessage, Ft as DocsSearchSourcePage, G as DocsCodeBlocksPlannerProvider, Gt as FeedbackConfig, H as DocsCloudPublishConfig, Ht as DocsTelemetryFeatures, I as DocsAskAIFeedbackValue, It as DocsSitemapConfig, J as DocsCodeBlocksValidateConfig, Jt as LastUpdatedConfig, K as DocsCodeBlocksRunnerConfig, Kt as FontStyle, L as DocsAskAIMcpConfig, Lt as DocsTelemetryAgentSurface, M as DocsAskAIActionType, Mn as UIConfig, Mt as DocsSearchQuery, N as DocsAskAIFeedbackConfig, Nt as DocsSearchResult, O as DocsAnalyticsEventType, On as SimpleDocsSearchConfig, Ot as DocsSearchChunkingConfig, P as DocsAskAIFeedbackData, Pt as DocsSearchResultType, Q as DocsFeedbackData, Qt as LlmsTxtSectionConfig, R as DocsCloudApiKeyConfig, Rt as DocsTelemetryConfig, S as DocsAgentTraceEventInput, Sn as SidebarConfig, St as DocsReviewSeverity, T as DocsAnalyticsConfig, Tn as SidebarNode, Tt as DocsSearchAdapter, U as DocsCodeBlocksConfig, Ut as DocsTelemetryFramework, V as DocsCloudPreviewConfig, Vt as DocsTelemetryEventType, W as DocsCodeBlocksPlannerConfig, Wt as DocsTheme, X as DocsCodeBlocksValidationPolicy, Xt as LlmsTxtMaxCharsConfig, Y as DocsCodeBlocksValidationMode, Yt as LlmsTxtConfig, Z as DocsConfig, Zt as LlmsTxtMaxCharsMode, _ as DocsAgentFeedbackData, _n as PageTwitter, _t as DocsReviewCiConfig, a as ApiReferenceRenderer, an as OpenDocsTarget, at as DocsMcpAuthenticateResult, b as DocsAgentGoldenTaskExpectation, bn as ResolvedDocsRelatedLink, bt as DocsReviewRulesConfig, c as ChangelogFrontmatter, cn as PageActionsConfig, ct as DocsMcpOriginContext, d as CopyMarkdownFormat, dn as PageAgentFailureMode, dt as DocsMetadata, en as OGConfig, et as DocsI18nConfig, f as CustomDocsSearchConfig, fn as PageAgentFrontmatter, ft as DocsNav, g as DocsAgentFeedbackContext, gn as PageSidebarFrontmatter, gt as DocsRelatedItem, h as DocsAgentEvaluationsConfig, hn as PageOpenGraph, ht as DocsObservabilityEventInput, i as ApiReferenceConfig, in as OpenDocsProviderId, it as DocsMcpAuthenticateContext, j as DocsAskAIActionData, jn as TypographyConfig, jt as DocsSearchEmbeddingsConfig, k as DocsAnalyticsInput, kn as ThemeToggleConfig, kt as DocsSearchConfig, l as CodeBlockCopyData, ln as PageAgentAppliesTo, lt as DocsMcpSecurityConfig, m as DocsAgentConfig, mn as PageFrontmatter, mt as DocsObservabilityEvent, n as AgentFeedbackConfig, nn as OpenDocsProvider, nt as DocsMcpAuthPrincipal, o as BreadcrumbConfig, on as OpenGraphImage, ot as DocsMcpConfig, p as DocsAgentCompactConfig, pn as PageAgentVerification, pt as DocsObservabilityConfig, q as DocsCodeBlocksRunnerProvider, qt as GithubConfig, r as AlgoliaDocsSearchConfig, rn as OpenDocsProviderConfig, rt as DocsMcpAuthenticate, s as ChangelogConfig, sn as OrderingItem, st as DocsMcpCorsConfig, t as AIConfig, tn as OpenDocsConfig, tt as DocsMcpAllowedOrigins, u as CopyMarkdownConfig, un as PageAgentCommand, ut as DocsMcpToolsConfig, v as DocsAgentGoldenExpectedExample, vn as ReadingTimeConfig, vt as DocsReviewCiMode, w as DocsAgentTraceStatus, wn as SidebarFolderNode, wt as DocsRobotsRule, x as DocsAgentGoldenTaskFilters, xn as SidebarComponentProps, xt as DocsReviewScoreConfig, y as DocsAgentGoldenTask, yn as ReadingTimeFormat, yt as DocsReviewConfig, z as DocsCloudConfig, zt as DocsTelemetryEvent } from "./types-BVgucdVm.mjs";
|
|
2
|
+
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-CfWvmVYA.mjs";
|
|
3
3
|
import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/define-docs.d.ts
|
|
@@ -123,6 +123,58 @@ declare function resolveDocsI18n(config?: DocsI18nConfig | null): ResolvedDocsI1
|
|
|
123
123
|
declare function resolveDocsLocale(searchParams: URLSearchParams, i18n?: ResolvedDocsI18n | null): string | undefined;
|
|
124
124
|
declare function resolveDocsPath(pathname: string, entry: string): DocsPathMatch;
|
|
125
125
|
//#endregion
|
|
126
|
+
//#region src/agent-conformance.d.ts
|
|
127
|
+
declare const DOCS_AGENT_CONTRACT_VERSION = "1.0";
|
|
128
|
+
type DocsAgentAdapter = "next" | "tanstack-start" | "sveltekit" | "astro" | "nuxt";
|
|
129
|
+
type DocsAgentContractSurface = "discovery" | "config" | "diagnostics" | "feedback-schema" | "markdown" | "markdown-accept" | "markdown-locale" | "markdown-missing" | "llms" | "llms-full" | "agents" | "skill" | "sitemap-xml" | "sitemap-markdown" | "robots" | "mcp";
|
|
130
|
+
interface DocsAgentContractRequest {
|
|
131
|
+
url: string;
|
|
132
|
+
init?: RequestInit;
|
|
133
|
+
}
|
|
134
|
+
interface DocsAgentContractExpectation {
|
|
135
|
+
statuses: readonly number[];
|
|
136
|
+
contentTypes: readonly string[];
|
|
137
|
+
bodyIncludes?: readonly string[];
|
|
138
|
+
}
|
|
139
|
+
interface DocsAgentContractCase {
|
|
140
|
+
surface: DocsAgentContractSurface;
|
|
141
|
+
request: DocsAgentContractRequest;
|
|
142
|
+
expect: DocsAgentContractExpectation;
|
|
143
|
+
}
|
|
144
|
+
interface DocsAgentConformanceCaseResult {
|
|
145
|
+
surface: DocsAgentContractSurface;
|
|
146
|
+
passed: boolean;
|
|
147
|
+
status?: number;
|
|
148
|
+
contentType?: string;
|
|
149
|
+
issues: string[];
|
|
150
|
+
}
|
|
151
|
+
interface DocsAgentConformanceReport {
|
|
152
|
+
adapter: DocsAgentAdapter;
|
|
153
|
+
contractVersion: typeof DOCS_AGENT_CONTRACT_VERSION;
|
|
154
|
+
passed: boolean;
|
|
155
|
+
cases: DocsAgentConformanceCaseResult[];
|
|
156
|
+
}
|
|
157
|
+
interface RunDocsAgentConformanceOptions {
|
|
158
|
+
adapter: DocsAgentAdapter;
|
|
159
|
+
/** Origin used to construct requests. Defaults to http://localhost. */
|
|
160
|
+
origin?: string;
|
|
161
|
+
/** Public docs entry. Defaults to docs. */
|
|
162
|
+
entry?: string;
|
|
163
|
+
/** Locale fixture expected to render the word "Bonjour". Set false to skip. */
|
|
164
|
+
locale?: string | false;
|
|
165
|
+
handle(request: Request, surface: DocsAgentContractSurface): Response | Promise<Response>;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* The framework-neutral public surface every first-party adapter must implement.
|
|
169
|
+
* Adapter tests consume this list so new routes and invariants are added once.
|
|
170
|
+
*/
|
|
171
|
+
declare function createDocsAgentContractCases(options?: {
|
|
172
|
+
origin?: string;
|
|
173
|
+
entry?: string;
|
|
174
|
+
locale?: string | false;
|
|
175
|
+
}): DocsAgentContractCase[];
|
|
176
|
+
declare function runDocsAgentConformance(options: RunDocsAgentConformanceOptions): Promise<DocsAgentConformanceReport>;
|
|
177
|
+
//#endregion
|
|
126
178
|
//#region src/metadata.d.ts
|
|
127
179
|
interface DocsStructuredDataBreadcrumb {
|
|
128
180
|
name: string;
|
|
@@ -136,6 +188,8 @@ interface DocsPageStructuredDataInput {
|
|
|
136
188
|
entry?: string;
|
|
137
189
|
dateModified?: string;
|
|
138
190
|
breadcrumbs?: DocsStructuredDataBreadcrumb[];
|
|
191
|
+
/** Optional actionable page contract represented as a Schema.org HowTo. */
|
|
192
|
+
agent?: PageAgentFrontmatter;
|
|
139
193
|
}
|
|
140
194
|
/**
|
|
141
195
|
* Resolve page title using metadata titleTemplate.
|
|
@@ -202,6 +256,49 @@ declare function resolveReadingTimeFromSource(source: string, wordsPerMinute?: n
|
|
|
202
256
|
declare function normalizeDocsRelated(value: unknown): ResolvedDocsRelatedLink[];
|
|
203
257
|
declare function renderDocsRelatedMarkdownLines(related: ResolvedDocsRelatedLink[] | undefined): string[];
|
|
204
258
|
//#endregion
|
|
259
|
+
//#region src/agent-contract.d.ts
|
|
260
|
+
interface PageAgentFrontmatterIssue {
|
|
261
|
+
path: string;
|
|
262
|
+
message: string;
|
|
263
|
+
}
|
|
264
|
+
declare const PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS: readonly ["task", "outcome", "appliesTo", "prerequisites", "files", "commands", "sideEffects", "verification", "rollback", "failureModes"];
|
|
265
|
+
declare const PAGE_AGENT_CONTRACT_FIELDS: readonly ["tokenBudget", "task", "outcome", "appliesTo", "prerequisites", "files", "commands", "sideEffects", "verification", "rollback", "failureModes"];
|
|
266
|
+
declare const PAGE_AGENT_CONTRACT_FIELD_SCHEMA: {
|
|
267
|
+
readonly tokenBudget: "number";
|
|
268
|
+
readonly task: "string";
|
|
269
|
+
readonly outcome: "string";
|
|
270
|
+
readonly appliesTo: {
|
|
271
|
+
readonly framework: "string|string[]";
|
|
272
|
+
readonly version: "string|string[]";
|
|
273
|
+
readonly package: "string|string[]";
|
|
274
|
+
};
|
|
275
|
+
readonly prerequisites: "string[]";
|
|
276
|
+
readonly files: "string[]";
|
|
277
|
+
readonly commands: "Array<string|{run,cwd?,description?}>";
|
|
278
|
+
readonly sideEffects: "string[]";
|
|
279
|
+
readonly verification: "Array<string|{description?,run?,expect?}>";
|
|
280
|
+
readonly rollback: "string[]";
|
|
281
|
+
readonly failureModes: "Array<string|{symptom,resolution?}>";
|
|
282
|
+
};
|
|
283
|
+
declare const PAGE_AGENT_CONTRACT_START_MARKER = "<!-- farming-labs:agent-contract:start -->";
|
|
284
|
+
declare const PAGE_AGENT_CONTRACT_END_MARKER = "<!-- farming-labs:agent-contract:end -->";
|
|
285
|
+
/**
|
|
286
|
+
* Normalize untrusted page frontmatter into the stable agent contract shape.
|
|
287
|
+
* Invalid fields are omitted so malformed author input cannot break page delivery.
|
|
288
|
+
*/
|
|
289
|
+
declare function normalizePageAgentFrontmatter(value: unknown): PageAgentFrontmatter | undefined;
|
|
290
|
+
declare function hasStructuredPageAgentContract(value: unknown): boolean;
|
|
291
|
+
/** Return author-facing validation issues without throwing. */
|
|
292
|
+
declare function getPageAgentFrontmatterIssues(value: unknown): PageAgentFrontmatterIssue[];
|
|
293
|
+
/** Render normalized `agent` YAML in a stable field order. */
|
|
294
|
+
declare function renderPageAgentFrontmatterYamlLines(value: unknown, indentation?: number): string[];
|
|
295
|
+
/** Render the structured contract as deterministic, compact machine-readable Markdown. */
|
|
296
|
+
declare function renderPageAgentContractMarkdown(value: unknown): string;
|
|
297
|
+
/** Remove generated contract blocks while preserving handwritten guidance. */
|
|
298
|
+
declare function stripGeneratedPageAgentContractMarkdown(markdown: string): string;
|
|
299
|
+
/** Insert one generated contract unless the document already has handwritten contract guidance. */
|
|
300
|
+
declare function upsertPageAgentContractMarkdown(markdown: string, value: unknown): string;
|
|
301
|
+
//#endregion
|
|
205
302
|
//#region src/sidebar.d.ts
|
|
206
303
|
interface SidebarFolderIndexBehaviorOptions {
|
|
207
304
|
sidebar: boolean | SidebarConfig | undefined;
|
|
@@ -433,6 +530,8 @@ interface DocsLlmsTxtRequest {
|
|
|
433
530
|
}
|
|
434
531
|
interface DocsLlmsTxtPageInput {
|
|
435
532
|
url: string;
|
|
533
|
+
/** Override the Markdown link emitted in llms.txt. */
|
|
534
|
+
markdownUrl?: string;
|
|
436
535
|
title: string;
|
|
437
536
|
description?: string;
|
|
438
537
|
content: string;
|
|
@@ -491,14 +590,21 @@ interface DocsSkillDocumentOptions {
|
|
|
491
590
|
};
|
|
492
591
|
}
|
|
493
592
|
interface DocsAgentsDocumentOptions extends DocsSkillDocumentOptions {}
|
|
593
|
+
interface DocsAgentContractMcpTools {
|
|
594
|
+
list?: "list_tasks";
|
|
595
|
+
read?: "read_task";
|
|
596
|
+
}
|
|
494
597
|
interface DocsMarkdownPage {
|
|
495
598
|
slug?: string;
|
|
496
599
|
url: string;
|
|
497
600
|
title: string;
|
|
498
601
|
description?: string;
|
|
602
|
+
/** Override the public Markdown representation URL when it differs from `${url}.md`. */
|
|
603
|
+
markdownUrl?: string;
|
|
499
604
|
lastModified?: string;
|
|
500
605
|
lastmod?: string;
|
|
501
606
|
related?: ResolvedDocsRelatedLink[];
|
|
607
|
+
agent?: PageAgentFrontmatter;
|
|
502
608
|
content: string;
|
|
503
609
|
rawContent?: string;
|
|
504
610
|
agentContent?: string;
|
|
@@ -535,6 +641,18 @@ interface DocsMarkdownCanonicalUrlOptions {
|
|
|
535
641
|
requestedPath: string;
|
|
536
642
|
locale?: string | null;
|
|
537
643
|
}
|
|
644
|
+
interface DocsMarkdownResponseOptions extends DocsMarkdownNotFoundOptions {
|
|
645
|
+
request: Request;
|
|
646
|
+
document: string | null;
|
|
647
|
+
/** Override the human-readable canonical URL, for example when docsPath differs from entry. */
|
|
648
|
+
canonicalUrl?: string;
|
|
649
|
+
/** Override the selected Markdown representation URL. */
|
|
650
|
+
contentLocation?: string;
|
|
651
|
+
locale?: string | null;
|
|
652
|
+
/** Exact source modification timestamp. Date-only values are intentionally ignored. */
|
|
653
|
+
lastModified?: string | Date | null;
|
|
654
|
+
cacheControl?: string;
|
|
655
|
+
}
|
|
538
656
|
declare function normalizeDocsPathSegment(value: string): string;
|
|
539
657
|
declare function normalizeDocsUrlPath(value: string): string;
|
|
540
658
|
declare function isDocsConfigRequest(url: URL): boolean;
|
|
@@ -609,12 +727,16 @@ declare function renderDocsMarkdownNotFound({
|
|
|
609
727
|
pages,
|
|
610
728
|
sitemap
|
|
611
729
|
}: DocsMarkdownNotFoundOptions): string;
|
|
730
|
+
/** Build one standards-aware Markdown response for every framework adapter. */
|
|
731
|
+
declare function createDocsMarkdownResponse(options: DocsMarkdownResponseOptions): Response;
|
|
612
732
|
declare function findDocsMarkdownPage<T extends DocsMarkdownPage>(entry: string, pages: T[], requestedPath: string): T | null;
|
|
613
733
|
declare function renderDocsMarkdownDocument(page: DocsMcpPage | DocsSearchSourcePage, options?: DocsMarkdownDocumentOptions): string;
|
|
614
734
|
declare function renderDocsMarkdownDocument(page: DocsMarkdownPage, options?: DocsMarkdownDocumentOptions): string;
|
|
615
735
|
declare function renderDocsSkillDocument(options: DocsSkillDocumentOptions): string;
|
|
616
736
|
declare function renderDocsAgentsDocument(options: DocsAgentsDocumentOptions): string;
|
|
617
737
|
declare function resolveDocsAgentMdxContent(content: string, audience: "human" | "agent"): string;
|
|
738
|
+
/** Resolve only the task tools that the advertised MCP endpoint actually exposes. */
|
|
739
|
+
declare function resolveDocsAgentContractMcpTools(mcp: DocsMcpResolvedConfig): DocsAgentContractMcpTools | undefined;
|
|
618
740
|
declare function buildDocsAgentDiscoverySpec({
|
|
619
741
|
origin,
|
|
620
742
|
entry,
|
|
@@ -648,6 +770,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
648
770
|
markdownRoutes: boolean;
|
|
649
771
|
agentMdOverrides: boolean;
|
|
650
772
|
agentBlocks: boolean;
|
|
773
|
+
structuredAgentContracts: boolean;
|
|
651
774
|
agents: boolean;
|
|
652
775
|
llms: boolean;
|
|
653
776
|
skills: boolean;
|
|
@@ -687,6 +810,33 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
687
810
|
apiPattern: string;
|
|
688
811
|
resolutionOrder: string[];
|
|
689
812
|
};
|
|
813
|
+
agentContract: {
|
|
814
|
+
usefulContractFields: string[];
|
|
815
|
+
fields: {
|
|
816
|
+
readonly tokenBudget: "number";
|
|
817
|
+
readonly task: "string";
|
|
818
|
+
readonly outcome: "string";
|
|
819
|
+
readonly appliesTo: {
|
|
820
|
+
readonly framework: "string|string[]";
|
|
821
|
+
readonly version: "string|string[]";
|
|
822
|
+
readonly package: "string|string[]";
|
|
823
|
+
};
|
|
824
|
+
readonly prerequisites: "string[]";
|
|
825
|
+
readonly files: "string[]";
|
|
826
|
+
readonly commands: "Array<string|{run,cwd?,description?}>";
|
|
827
|
+
readonly sideEffects: "string[]";
|
|
828
|
+
readonly verification: "Array<string|{description?,run?,expect?}>";
|
|
829
|
+
readonly rollback: "string[]";
|
|
830
|
+
readonly failureModes: "Array<string|{symptom,resolution?}>";
|
|
831
|
+
};
|
|
832
|
+
mcpTools?: DocsAgentContractMcpTools | undefined;
|
|
833
|
+
enabled: boolean;
|
|
834
|
+
schemaVersion: string;
|
|
835
|
+
source: string;
|
|
836
|
+
frontmatterPath: string;
|
|
837
|
+
markdownSection: string;
|
|
838
|
+
mcpField: string;
|
|
839
|
+
};
|
|
690
840
|
llms: {
|
|
691
841
|
sections?: {
|
|
692
842
|
title: string;
|
|
@@ -736,6 +886,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
736
886
|
fields: string[];
|
|
737
887
|
canonicalUrlField: string;
|
|
738
888
|
breadcrumbType: string;
|
|
889
|
+
agentContractType: string;
|
|
739
890
|
};
|
|
740
891
|
openapi: {
|
|
741
892
|
enabled: boolean;
|
|
@@ -789,10 +940,13 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
789
940
|
listDocs: boolean;
|
|
790
941
|
listPages: boolean;
|
|
791
942
|
readPage: boolean;
|
|
943
|
+
listTasks?: boolean;
|
|
944
|
+
readTask?: boolean;
|
|
792
945
|
searchDocs: boolean;
|
|
793
946
|
getNavigation: boolean;
|
|
794
947
|
getCodeExamples: boolean;
|
|
795
948
|
getConfigSchema: boolean;
|
|
949
|
+
getContext: boolean;
|
|
796
950
|
};
|
|
797
951
|
};
|
|
798
952
|
feedback: {
|
|
@@ -810,6 +964,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
810
964
|
doNotAssumeFeedbackPayloadShape: boolean;
|
|
811
965
|
};
|
|
812
966
|
};
|
|
967
|
+
declare function acceptsDocsMarkdown(request: Request): boolean;
|
|
813
968
|
declare function resolveDocsOpenApiDiscoveryConfig(openapi?: boolean | DocsOpenApiDiscoveryConfig): DocsOpenApiResolvedDiscoveryConfig;
|
|
814
969
|
//#endregion
|
|
815
970
|
//#region src/robots.d.ts
|
|
@@ -855,4 +1010,4 @@ declare function renderDocsRobotsGeneratedBlock(options?: DocsRobotsRenderOption
|
|
|
855
1010
|
declare function upsertDocsRobotsGeneratedBlock(existing: string, block: string): string;
|
|
856
1011
|
declare function analyzeDocsRobotsTxt(content: string, options?: DocsRobotsRenderOptions): DocsRobotsAnalysis;
|
|
857
1012
|
//#endregion
|
|
858
|
-
export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CopyMarkdownFormat, type CustomDocsSearchConfig, 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_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_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_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_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_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 DocsAgentDiscoverySpecOptions, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, 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 DocsDiagnostics, type DocsDiagnosticsFeature, type DocsDiagnosticsIssue, type DocsDiagnosticsIssueSeverity, type DocsDiagnosticsOptions, type DocsDiagnosticsStatus, 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 DocsMcpConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, 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 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, type PageActionsConfig, 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 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, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, hasDocsMarkdownSignatureAgent, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, validateDocsAgentFeedbackPayload };
|
|
1013
|
+
export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CopyMarkdownFormat, type CustomDocsSearchConfig, 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_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_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_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_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 DocsAgentAdapter, type DocsAgentCompactConfig, type DocsAgentConfig, type DocsAgentConformanceCaseResult, type DocsAgentConformanceReport, type DocsAgentContractCase, type DocsAgentContractExpectation, type DocsAgentContractMcpTools, type DocsAgentContractRequest, type DocsAgentContractSurface, type DocsAgentDiscoverySpecOptions, type DocsAgentEvaluationsConfig, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentGoldenExpectedExample, type DocsAgentGoldenTask, type DocsAgentGoldenTaskExpectation, type DocsAgentGoldenTaskFilters, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, 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 DocsDiagnostics, type DocsDiagnosticsFeature, type DocsDiagnosticsIssue, type DocsDiagnosticsIssueSeverity, type DocsDiagnosticsOptions, type DocsDiagnosticsStatus, 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 DocsMcpSecurityConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, 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 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, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, 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, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|
package/dist/index.mjs
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
import { _ as extendTheme, a as resolveReadingTimeOptions, b as defineDocs, c as buildPageTwitter, d as resolveOGImage, f as resolveTitle, g as createTheme, h as
|
|
2
|
-
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-
|
|
3
|
-
import { $ as
|
|
4
|
-
import { A as
|
|
5
|
-
import {
|
|
1
|
+
import { _ as extendTheme, a as resolveReadingTimeOptions, b as defineDocs, c as buildPageTwitter, d as resolveOGImage, f as resolveTitle, g as createTheme, h as runDocsAgentConformance, i as resolveReadingTimeFromSource, l as renderDocsPageStructuredDataJson, m as createDocsAgentContractCases, n as resolvePageReadingTime, o as buildDocsPageStructuredData, p as DOCS_AGENT_CONTRACT_VERSION, r as resolveReadingTimeFromContent, s as buildPageOpenGraph, t as estimateReadingTimeMinutes, u as resolveDocsMetadataBaseUrl, v as deepMerge, y as resolveChangelogConfig } from "./reading-time-BrTd3DIh.mjs";
|
|
2
|
+
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";
|
|
3
|
+
import { $ as normalizeDocsPathSegment, A as DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, At as readDocsSitemapManifestFromContentMap, B as getDocsLlmsTxtMaxCharsIssue, Bt as PAGE_AGENT_CONTRACT_FIELDS, C as DEFAULT_OPENAPI_SCHEMA_ROUTE, Ct as DEFAULT_SITEMAP_MANIFEST_PATH, D as DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, Dt as DEFAULT_SITEMAP_XML_ROUTE, E as DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, Et as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, F as buildDocsDiagnostics, Ft as resolveDocsSitemapRequest, G as isDocsAgentsRequest, Gt as hasStructuredPageAgentContract, H as getDocsMarkdownVaryHeader, Ht as PAGE_AGENT_CONTRACT_START_MARKER, I as buildDocsMcpEndpointCandidates, It as toDocsSitemapMarkdownUrl, J as isDocsLlmsTxtPublicRequest, Jt as renderPageAgentFrontmatterYamlLines, K as isDocsConfigRequest, Kt as normalizePageAgentFrontmatter, L as createDocsMarkdownResponse, Lt as normalizeDocsRelated, M as buildDocsAgentDiscoverySpec, Mt as renderDocsSitemapXml, N as buildDocsAgentFeedbackSchema, Nt as resolveDocsSitemapConfig, Ot as buildDocsSitemapManifest, P as buildDocsConfigMap, Pt as resolveDocsSitemapPageLastmod, Q as matchesDocsLlmsTxtSection, R as detectDocsMarkdownAgentRequest, Rt as renderDocsRelatedMarkdownLines, S as DEFAULT_MCP_WELL_KNOWN_ROUTE, St as validateDocsAgentFeedbackPayload, T as DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, Tt as DEFAULT_SITEMAP_MD_ROUTE, U as hasDocsMarkdownSignatureAgent, Ut as PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, V as getDocsMarkdownCanonicalLinkHeader, Vt as PAGE_AGENT_CONTRACT_FIELD_SCHEMA, W as isDocsAgentDiscoveryRequest, Wt as getPageAgentFrontmatterIssues, X as isDocsPublicGetRequest, Xt as upsertPageAgentContractMarkdown, Y as isDocsMcpRequest, Yt as stripGeneratedPageAgentContractMarkdown, Z as isDocsSkillRequest, _ as DEFAULT_LLMS_TXT_MAX_CHARS, _t as resolveDocsMarkdownRequest, a as DEFAULT_AGENT_MD_ROUTE, at as renderDocsMarkdownNotFound, b as DEFAULT_MCP_PUBLIC_ROUTE, bt as selectDocsLlmsTxtContent, c as DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, ct as resolveDocsAgentFeedbackConfig, d as DEFAULT_DOCS_CONFIG_FORMAT, dt as resolveDocsAgentsFormat, et as normalizeDocsUrlPath, f as DEFAULT_DOCS_CONFIG_ROUTE, ft as resolveDocsLlmsTxtFormat, g as DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, gt as resolveDocsMarkdownRecovery, h as DEFAULT_LLMS_FULL_TXT_ROUTE, ht as resolveDocsMarkdownCanonicalUrl, i as DEFAULT_AGENT_FEEDBACK_ROUTE, it as renderDocsMarkdownDocument, j as acceptsDocsMarkdown, jt as renderDocsSitemapMarkdown, k as DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, kt as createDocsSitemapResponse, l as DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, lt as resolveDocsAgentFeedbackRequest, m as DEFAULT_DOCS_DIAGNOSTICS_ROUTE, mt as resolveDocsLlmsTxtSections, n as DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, nt as renderDocsAgentsDocument, o as DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, ot as renderDocsSkillDocument, p as DEFAULT_DOCS_DIAGNOSTICS_FORMAT, pt as resolveDocsLlmsTxtRequest, q as isDocsDiagnosticsRequest, qt as renderPageAgentContractMarkdown, r as DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, rt as renderDocsLlmsTxt, s as DEFAULT_AGENT_SPEC_ROUTE, st as resolveDocsAgentContractMcpTools, t as DEFAULT_AGENTS_MD_ROUTE, tt as parseDocsAgentFeedbackData, u as DEFAULT_DOCS_API_ROUTE, ut as resolveDocsAgentMdxContent, v as DEFAULT_LLMS_TXT_ROUTE, vt as resolveDocsOpenApiDiscoveryConfig, w as DEFAULT_SKILL_MD_ROUTE, wt as DEFAULT_SITEMAP_MD_DOCS_ROUTE, x as DEFAULT_MCP_ROUTE, xt as toDocsMarkdownUrl, y as DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, yt as resolveDocsSkillFormat, z as findDocsMarkdownPage, zt as PAGE_AGENT_CONTRACT_END_MARKER } from "./agent-DXkXi-pS.mjs";
|
|
4
|
+
import { A as getDocsTelemetryFeatures, C as resolvePageSidebarFolderIndexBehavior, D as emitDocsTelemetryEvent, E as emitDocsTelemetryAgentSurfaceEvent, M as resolveDocsTelemetryConfig, O as emitDocsTelemetryMcpToolEvent, S as applySidebarFolderIndexBehavior, T as resolveSidebarFolderIndexBehaviorForPath, _ as hashGeneratedAgentContent, a as createMcpSearchAdapter, b as serializeGeneratedAgentDocument, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, g as GENERATED_AGENT_PROVENANCE_VERSION, h as GENERATED_AGENT_PROVENANCE_MARKER, i as createCustomSearchAdapter, j as inferDocsTelemetryAgentSurface, k as emitDocsTelemetryProjectEvent, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, v as normalizeGeneratedAgentContent, w as resolveSidebarFolderIndexBehavior, x as stripGeneratedAgentProvenance, y as parseGeneratedAgentDocument } from "./search-CJIC1Cqo.mjs";
|
|
5
|
+
import { n as resolveDocsLocale, r as resolveDocsPath, t as resolveDocsI18n } from "./i18n-CAlj1ADU.mjs";
|
|
6
|
+
import { a as analyzeDocsRobotsTxt, c as renderDocsRobotsGeneratedBlock, d as resolveDocsRobotsRequest, f as upsertDocsRobotsGeneratedBlock, i as DOCS_ROBOTS_GENERATED_BLOCK_START, l as renderDocsRobotsTxt, n as DEFAULT_ROBOTS_TXT_ROUTE, o as createDocsRobotsResponse, r as DOCS_ROBOTS_GENERATED_BLOCK_END, s as getDocsRobotsAllowRoutes, t as DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, u as resolveDocsRobotsConfig } from "./robots-DAptQnkx.mjs";
|
|
6
7
|
|
|
7
|
-
export { 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_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_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_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_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_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, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, hasDocsMarkdownSignatureAgent, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, validateDocsAgentFeedbackPayload };
|
|
8
|
+
export { 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_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_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_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_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, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_FIELDS, PAGE_AGENT_CONTRACT_FIELD_SCHEMA, PAGE_AGENT_CONTRACT_START_MARKER, PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, acceptsDocsMarkdown, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, 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, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { a as devInstallCommand, c as fileExists, d as readFileSafe, f as spawnAndWaitFor, i as detectPackageManagerFromProject, l as formatPackageManagerDetection, n as detectGlobalCssFiles, o as exec, p as writeFileSafe, r as detectNextAppDir, t as detectFramework, u as installCommand } from "./utils-
|
|
2
|
-
import { $ as svelteDocsPublicHookTemplate, A as nextConfigMergedTemplate, B as nuxtServerApiDocsRouteTemplate, C as injectRootProviderIntoLayout, D as injectTanstackVitePlugins, E as injectTanstackRootProviderIntoRoute, F as nuxtDocsConfigTemplate, G as quickstartPageTemplate, H as nuxtServerDocsPublicMiddlewareTemplate, I as nuxtDocsPageTemplate, J as svelteDocsApiRouteTemplate, K as rootLayoutTemplate, L as nuxtGlobalCssTemplate, M as nextLocaleDocPageTemplate, N as nextLocalizedPageTemplate, O as installationPageTemplate, P as nuxtConfigTemplate, Q as svelteDocsPageTemplate, R as nuxtInstallationPageTemplate, S as injectNuxtCssImport, T as injectSvelteDocsPublicHook, U as nuxtWelcomePageTemplate, V as nuxtServerApiReferenceRouteTemplate, W as postcssConfigTemplate, X as svelteDocsLayoutServerTemplate, Y as svelteDocsConfigTemplate, Z as svelteDocsLayoutTemplate, _ as getAstroAdapterPkg, _t as tanstackViteConfigTemplate, a as astroDocsIndexTemplate, at as svelteWelcomePageTemplate, b as injectAstroDocsMiddleware, bt as welcomePageTemplate, c as astroDocsServerTemplate, ct as tanstackDocsCatchAllRouteTemplate, d as astroQuickstartPageTemplate, dt as tanstackDocsIndexRouteTemplate, et as svelteDocsServerTemplate, f as astroWelcomePageTemplate, ft as tanstackDocsPublicRouteTemplate, g as docsLayoutTemplate, gt as tanstackRootRouteTemplate, h as docsConfigTemplate, ht as tanstackQuickstartPageTemplate, i as astroDocsConfigTemplate, it as svelteRootLayoutTemplate, j as nextConfigTemplate, k as nextApiReferencePageTemplate, l as astroGlobalCssTemplate, lt as tanstackDocsConfigTemplate, m as customThemeTsTemplate, mt as tanstackInstallationPageTemplate, n as astroApiRouteTemplate, nt as svelteInstallationPageTemplate, o as astroDocsMiddlewareTemplate, ot as tanstackApiDocsRouteTemplate, p as customThemeCssTemplate, pt as tanstackDocsServerTemplate, q as svelteApiReferenceRouteTemplate, r as astroConfigTemplate, rt as svelteQuickstartPageTemplate, s as astroDocsPageTemplate, st as tanstackApiReferenceRouteTemplate, t as astroApiReferenceRouteTemplate, tt as svelteGlobalCssTemplate, u as astroInstallationPageTemplate, ut as tanstackDocsFunctionsTemplate, v as globalCssTemplate, vt as tanstackWelcomePageTemplate, w as injectSvelteCssImport, x as injectCssImport, y as injectAstroCssImport, yt as tsconfigTemplate, z as nuxtQuickstartPageTemplate } from "./templates-
|
|
1
|
+
import { a as devInstallCommand, c as fileExists, d as readFileSafe, f as spawnAndWaitFor, i as detectPackageManagerFromProject, l as formatPackageManagerDetection, n as detectGlobalCssFiles, o as exec, p as writeFileSafe, r as detectNextAppDir, t as detectFramework, u as installCommand } from "./utils-DBCCkkJS.mjs";
|
|
2
|
+
import { $ as svelteDocsPublicHookTemplate, A as nextConfigMergedTemplate, B as nuxtServerApiDocsRouteTemplate, C as injectRootProviderIntoLayout, D as injectTanstackVitePlugins, E as injectTanstackRootProviderIntoRoute, F as nuxtDocsConfigTemplate, G as quickstartPageTemplate, H as nuxtServerDocsPublicMiddlewareTemplate, I as nuxtDocsPageTemplate, J as svelteDocsApiRouteTemplate, K as rootLayoutTemplate, L as nuxtGlobalCssTemplate, M as nextLocaleDocPageTemplate, N as nextLocalizedPageTemplate, O as installationPageTemplate, P as nuxtConfigTemplate, Q as svelteDocsPageTemplate, R as nuxtInstallationPageTemplate, S as injectNuxtCssImport, T as injectSvelteDocsPublicHook, U as nuxtWelcomePageTemplate, V as nuxtServerApiReferenceRouteTemplate, W as postcssConfigTemplate, X as svelteDocsLayoutServerTemplate, Y as svelteDocsConfigTemplate, Z as svelteDocsLayoutTemplate, _ as getAstroAdapterPkg, _t as tanstackViteConfigTemplate, a as astroDocsIndexTemplate, at as svelteWelcomePageTemplate, b as injectAstroDocsMiddleware, bt as welcomePageTemplate, c as astroDocsServerTemplate, ct as tanstackDocsCatchAllRouteTemplate, d as astroQuickstartPageTemplate, dt as tanstackDocsIndexRouteTemplate, et as svelteDocsServerTemplate, f as astroWelcomePageTemplate, ft as tanstackDocsPublicRouteTemplate, g as docsLayoutTemplate, gt as tanstackRootRouteTemplate, h as docsConfigTemplate, ht as tanstackQuickstartPageTemplate, i as astroDocsConfigTemplate, it as svelteRootLayoutTemplate, j as nextConfigTemplate, k as nextApiReferencePageTemplate, l as astroGlobalCssTemplate, lt as tanstackDocsConfigTemplate, m as customThemeTsTemplate, mt as tanstackInstallationPageTemplate, n as astroApiRouteTemplate, nt as svelteInstallationPageTemplate, o as astroDocsMiddlewareTemplate, ot as tanstackApiDocsRouteTemplate, p as customThemeCssTemplate, pt as tanstackDocsServerTemplate, q as svelteApiReferenceRouteTemplate, r as astroConfigTemplate, rt as svelteQuickstartPageTemplate, s as astroDocsPageTemplate, st as tanstackApiReferenceRouteTemplate, t as astroApiReferenceRouteTemplate, tt as svelteGlobalCssTemplate, u as astroInstallationPageTemplate, ut as tanstackDocsFunctionsTemplate, v as globalCssTemplate, vt as tanstackWelcomePageTemplate, w as injectSvelteCssImport, x as injectCssImport, y as injectAstroCssImport, yt as tsconfigTemplate, z as nuxtQuickstartPageTemplate } from "./templates-1Cod8KrJ.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import pc from "picocolors";
|
|
@@ -188,7 +188,7 @@ async function configureDocsCloudOnboarding(options) {
|
|
|
188
188
|
enabled = cloudAnswer;
|
|
189
189
|
}
|
|
190
190
|
if (!enabled) return;
|
|
191
|
-
const { initCloudConfig } = await import("./cloud-
|
|
191
|
+
const { initCloudConfig } = await import("./cloud-HWFlbfLJ.mjs");
|
|
192
192
|
printDocsCloudOnboardingInstructions(await initCloudConfig({
|
|
193
193
|
rootDir: options.rootDir,
|
|
194
194
|
configPath: getDocsCloudConfigPathForFramework(options.framework)
|
|
@@ -1,9 +1,11 @@
|
|
|
1
|
-
import "./agent-
|
|
2
|
-
import "./search-
|
|
3
|
-
import "./sitemap-server-
|
|
1
|
+
import "./agent-DXkXi-pS.mjs";
|
|
2
|
+
import "./search-CJIC1Cqo.mjs";
|
|
3
|
+
import "./sitemap-server-wsNLyVkb.mjs";
|
|
4
|
+
import "./agent-evals-BD17jOqL.mjs";
|
|
4
5
|
import { createFilesystemDocsMcpSource, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
6
|
+
import "./code-blocks-C9awWzEQ.mjs";
|
|
5
7
|
import "./server.mjs";
|
|
6
|
-
import {
|
|
8
|
+
import { d as readStringProperty, h as resolveDocsContentDir, l as readNavTitle, m as resolveDocsConfigPath, n as extractObjectLiteral, s as readBooleanProperty } from "./config-CydaZ5PB.mjs";
|
|
7
9
|
import { readFileSync } from "node:fs";
|
|
8
10
|
import pc from "picocolors";
|
|
9
11
|
|
|
@@ -86,11 +88,14 @@ function readMcpConfig(content) {
|
|
|
86
88
|
tools: {
|
|
87
89
|
listDocs: readBooleanProperty(block, "listDocs"),
|
|
88
90
|
listPages: readBooleanProperty(block, "listPages"),
|
|
91
|
+
listTasks: readBooleanProperty(block, "listTasks"),
|
|
92
|
+
readTask: readBooleanProperty(block, "readTask"),
|
|
89
93
|
readPage: readBooleanProperty(block, "readPage"),
|
|
90
94
|
searchDocs: readBooleanProperty(block, "searchDocs"),
|
|
91
95
|
getNavigation: readBooleanProperty(block, "getNavigation"),
|
|
92
96
|
getCodeExamples: readBooleanProperty(block, "getCodeExamples"),
|
|
93
|
-
getConfigSchema: readBooleanProperty(block, "getConfigSchema")
|
|
97
|
+
getConfigSchema: readBooleanProperty(block, "getConfigSchema"),
|
|
98
|
+
getContext: readBooleanProperty(block, "getContext")
|
|
94
99
|
}
|
|
95
100
|
};
|
|
96
101
|
}
|