@farming-labs/docs 0.2.120 → 0.2.121
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/README.md +8 -0
- package/dist/access.d.mts +13 -0
- package/dist/access.mjs +56 -0
- package/dist/agent-conformance.d.mts +60 -0
- package/dist/agent-conformance.mjs +538 -0
- package/dist/agent-contract.d.mts +47 -0
- package/dist/agent-contract.mjs +645 -0
- package/dist/agent-detection.d.mts +6 -0
- package/dist/agent-detection.mjs +83 -0
- package/dist/agent-evals.d.mts +224 -0
- package/dist/{agent-evals-BLNLvXbG.mjs → agent-evals.mjs} +7 -565
- package/dist/agent-feedback-evaluations-node.mjs +38 -0
- package/dist/agent-feedback-evaluations.d.mts +91 -0
- package/dist/{agent-feedback-evaluations-CcMGlgsO.mjs → agent-feedback-evaluations.mjs} +2 -2
- package/dist/agent-feedback-loop.d.mts +45 -0
- package/dist/{agent-feedback-loop-CcZL_sb1.mjs → agent-feedback-loop.mjs} +1 -1
- package/dist/agent-maintenance.d.mts +71 -0
- package/dist/{agent-maintenance-CuZ7iAKq.mjs → agent-maintenance.mjs} +1 -1
- package/dist/agent-provenance.d.mts +23 -0
- package/dist/agent-provenance.mjs +77 -0
- package/dist/agent-scope.mjs +321 -0
- package/dist/agent-skills-archive.mjs +86 -0
- package/dist/agent-skills-bundle.d.mts +1 -1
- package/dist/{agent-skills-progressive-disclosure-PjPtTYL-.mjs → agent-skills-progressive-disclosure.mjs} +2 -2
- package/dist/{agent-skills-server-D5IuvwM7.d.mts → agent-skills-server.d.mts} +3 -3
- package/dist/{agent-skills-server-BC7md56k.mjs → agent-skills-server.mjs} +2 -2
- package/dist/agent-skills-vite.d.mts +3 -3
- package/dist/agent-skills-vite.mjs +1 -2
- package/dist/agent-surface-drift.mjs +236 -0
- package/dist/{golden-evaluations-CLUViycJ.mjs → agent-usefulness.mjs} +5 -290
- package/dist/{content-change-hydration-wqXIZHp6.d.mts → agent.d.mts} +10 -411
- package/dist/agent.mjs +2729 -0
- package/dist/{analytics-w3FDOksr.d.mts → analytics.d.mts} +2 -2
- package/dist/{analytics-p8Vhhu2P.mjs → analytics.mjs} +2 -2
- package/dist/{sitemap-server-BUdPBcGs.d.mts → api-reference.d.mts} +2 -6
- package/dist/api-reference.mjs +1481 -0
- package/dist/{audience-exposure-DBrFWULA.d.mts → audience-exposure.d.mts} +1 -1
- package/dist/audience-exposure.mjs +8 -0
- package/dist/audience.d.mts +44 -0
- package/dist/audience.mjs +1654 -0
- package/dist/authoring-mcp.d.mts +44 -0
- package/dist/{authoring-mcp-CiCUQe3o.mjs → authoring-mcp.mjs} +3 -3
- package/dist/browser.d.mts +6 -4
- package/dist/browser.mjs +6 -7
- package/dist/build.d.mts +8 -0
- package/dist/build.mjs +8 -0
- package/dist/changelog.d.mts +20 -0
- package/dist/changelog.mjs +39 -0
- package/dist/{agent-export-CA6IUQ7T.mjs → cli/agent-export.mjs} +19 -45
- package/dist/{agent-CYk2DxY7.mjs → cli/agent.mjs} +6 -35
- package/dist/{agents-BUiVmj8i.mjs → cli/agents.mjs} +5 -18
- package/dist/cli/api-doctor.mjs +206 -0
- package/dist/{authoring-C2ymvYWl.mjs → cli/authoring.mjs} +2 -8
- package/dist/{cloud-6eKrlmKd.mjs → cli/cloud.mjs} +3 -3
- package/dist/{codeblocks-CHpgAwY-.mjs → cli/codeblocks.mjs} +2 -2
- package/dist/cli/config.d.mts +11 -0
- package/dist/{config-BZnKAj_Y.mjs → cli/config.mjs} +1 -1
- package/dist/cli/dev-banner.mjs +58 -0
- package/dist/{dev-Bnn-NUNa.mjs → cli/dev.mjs} +3 -57
- package/dist/{doctor-Bfkrkzad.mjs → cli/doctor.mjs} +41 -226
- package/dist/{downgrade-CHMta85e.mjs → cli/downgrade.mjs} +2 -2
- package/dist/cli/errors.d.mts +4 -0
- package/dist/{errors-BtnVLhNF.mjs → cli/errors.mjs} +1 -1
- package/dist/{feedback-evals-DMilg9pY.mjs → cli/feedback-evals.mjs} +3 -36
- package/dist/{feedback-DL4T5oIO.mjs → cli/feedback.mjs} +1 -1
- package/dist/cli/git-dates.mjs +35 -0
- package/dist/cli/golden-evaluations.mjs +52 -0
- package/dist/cli/index.d.mts +2 -3
- package/dist/cli/index.mjs +38 -38
- package/dist/{init-K0LmXDZ5.mjs → cli/init.mjs} +3 -3
- package/dist/{mcp-iLCmnPJI.mjs → cli/mcp.mjs} +7 -19
- package/dist/{openapi-diff-HcpUNjA-.mjs → cli/openapi-diff.mjs} +2 -7
- package/dist/{openapi-sdk-BQKC6H-_.mjs → cli/openapi-sdk.mjs} +2 -7
- package/dist/{openapi-source-DK6ts_Bk.mjs → cli/openapi-source.mjs} +2 -2
- package/dist/{package-version-HJhYeq4M.mjs → cli/package-version.mjs} +2 -2
- package/dist/{propose-JmUv_BTt.mjs → cli/propose.mjs} +1 -1
- package/dist/{review-C6EmbV0l.mjs → cli/review.mjs} +16 -15
- package/dist/{robots-DteZB8vl.mjs → cli/robots.mjs} +3 -7
- package/dist/{search-Bhuv_YsL.mjs → cli/search.mjs} +7 -20
- package/dist/{sitemap-DW5LDKDa.mjs → cli/sitemap.mjs} +7 -42
- package/dist/{skills-BAPQLSCm.mjs → cli/skills.mjs} +5 -19
- package/dist/{templates-BuQ8YsGv.mjs → cli/templates.mjs} +1 -1
- package/dist/{upgrade-DlQMOFV1.mjs → cli/upgrade.mjs} +2 -2
- package/dist/{utils-C7KDrPpA.mjs → cli/utils.mjs} +1 -1
- package/dist/client/react.d.mts +2 -18
- package/dist/client/react.mjs +1 -157
- package/dist/{cloud-analytics-D14HplI7.mjs → cloud-analytics.mjs} +1 -1
- package/dist/{cloud-ask-ai-BrsTXQf6.d.mts → cloud-ask-ai.d.mts} +2 -2
- package/dist/{cloud-ask-ai-BqKhjpS5.mjs → cloud-ask-ai.mjs} +3 -3
- package/dist/code-blocks.d.mts +51 -0
- package/dist/{code-blocks-GYdvS3BH.mjs → code-blocks.mjs} +2 -2
- package/dist/code-group-mdx.d.mts +11 -0
- package/dist/code-group-mdx.mjs +57 -0
- package/dist/content-change-hydration.d.mts +87 -0
- package/dist/{openapi-mcp-BIOTLiA7.mjs → content-change-hydration.mjs} +5 -210
- package/dist/content-changes.d.mts +47 -0
- package/dist/content-changes.mjs +216 -0
- package/dist/create-theme.d.mts +48 -0
- package/dist/create-theme.mjs +57 -0
- package/dist/date.d.mts +5 -0
- package/dist/date.mjs +17 -0
- package/dist/define-docs.d.mts +9 -0
- package/dist/define-docs.mjs +46 -0
- package/dist/docs-cloud-client.d.mts +18 -0
- package/dist/docs-cloud-client.mjs +161 -0
- package/dist/docs-cloud-server.d.mts +2 -2
- package/dist/docs-cloud-server.mjs +2 -3
- package/dist/heading-toc.d.mts +10 -0
- package/dist/heading-toc.mjs +23 -0
- package/dist/http-body.d.mts +14 -0
- package/dist/{http-body-DkAPk6D5.mjs → http-body.mjs} +1 -1
- package/dist/http-cache.d.mts +25 -0
- package/dist/http-cache.mjs +140 -0
- package/dist/http-link.mjs +81 -0
- package/dist/i18n.d.mts +18 -0
- package/dist/{i18n-B1gJ9EW0.mjs → i18n.mjs} +1 -1
- package/dist/index.d.mts +42 -674
- package/dist/index.mjs +40 -14
- package/dist/markdown-rendering.mjs +1 -1
- package/dist/markdown-section-cache.mjs +49 -0
- package/dist/markdown-sections.d.mts +47 -0
- package/dist/{markdown-sections-9Oxr33b-.mjs → markdown-sections.mjs} +29 -703
- package/dist/mcp-auth.d.mts +14 -0
- package/dist/mcp-auth.mjs +99 -0
- package/dist/mcp.d.mts +5 -3
- package/dist/mcp.mjs +21 -9
- package/dist/mdx.d.mts +6 -0
- package/dist/mdx.mjs +7 -0
- package/dist/metadata.d.mts +60 -0
- package/dist/{metadata-BOHn0Y5K.mjs → metadata.mjs} +2 -2
- package/dist/native-api-reference.mjs +968 -0
- package/dist/okf.d.mts +42 -0
- package/dist/okf.mjs +145 -0
- package/dist/openapi-contract.mjs +154 -0
- package/dist/{openapi-mcp-node-C4jUpZG6.mjs → openapi-mcp-node.mjs} +1 -1
- package/dist/openapi-mcp.d.mts +26 -0
- package/dist/openapi-mcp.mjs +132 -0
- package/dist/openapi-operations.d.mts +71 -0
- package/dist/{openapi-operations-DFpaqOqA.mjs → openapi-operations.mjs} +1 -1
- package/dist/openapi-overlays.mjs +221 -0
- package/dist/openapi-references.mjs +233 -0
- package/dist/pagination.d.mts +7 -0
- package/dist/pagination.mjs +100 -0
- package/dist/prompt-references.d.mts +12 -0
- package/dist/prompt-references.mjs +132 -0
- package/dist/prompt-utils.d.mts +36 -0
- package/dist/{prompt-utils-B5g-bv7o.mjs → prompt-utils.mjs} +1 -57
- package/dist/reading-time.d.mts +23 -0
- package/dist/reading-time.mjs +58 -0
- package/dist/related.d.mts +7 -0
- package/dist/related.mjs +50 -0
- package/dist/retrieval-digest.d.mts +16 -0
- package/dist/{retrieval-digest-CT-eIEcp.mjs → retrieval-digest.mjs} +1 -1
- package/dist/review.d.mts +69 -0
- package/dist/review.mjs +562 -0
- package/dist/robots.d.mts +54 -0
- package/dist/{robots-BYJAVeI6.mjs → robots.mjs} +5 -3
- package/dist/runtime.d.mts +3 -3
- package/dist/runtime.mjs +3 -9
- package/dist/search.d.mts +210 -0
- package/dist/search.mjs +3401 -0
- package/dist/server.d.mts +22 -198
- package/dist/server.mjs +21 -19
- package/dist/sidebar.d.mts +15 -0
- package/dist/sidebar.mjs +73 -0
- package/dist/sitemap-server.d.mts +7 -0
- package/dist/{sitemap-server-Lg3YhUx4.mjs → sitemap-server.mjs} +2 -2
- package/dist/{sitemap-Cl8vrixd.d.mts → sitemap.d.mts} +3 -3
- package/dist/sitemap.mjs +254 -0
- package/dist/{standards-discovery-BHPc7YIX.d.mts → standards-discovery.d.mts} +2 -2
- package/dist/{standards-discovery-sSEojU80.mjs → standards-discovery.mjs} +3 -139
- package/dist/telemetry-runtime.d.mts +42 -0
- package/dist/telemetry-runtime.mjs +238 -0
- package/dist/telemetry.d.mts +15 -0
- package/dist/telemetry.mjs +117 -0
- package/dist/{types-BJFeMXWZ.d.mts → types.d.mts} +3 -2
- package/dist/urls.d.mts +7 -0
- package/dist/urls.mjs +21 -0
- package/dist/utils.d.mts +8 -0
- package/dist/utils.mjs +22 -0
- package/package.json +21 -3
- package/dist/agent-DkAidqtV.mjs +0 -9026
- package/dist/api-reference-BYee4zMo.mjs +0 -3046
- package/dist/prompt-references-DMgbu_dz.mjs +0 -1082
- package/dist/retrieval-digest-AOx2-LbC.d.mts +0 -367
- package/dist/sidebar-CFHBj29f.mjs +0 -421
- package/dist/sidebar-CMPbVfGP.d.mts +0 -63
- /package/dist/{openapi-CfCzX_a1.mjs → cli/openapi.mjs} +0 -0
package/dist/index.d.mts
CHANGED
|
@@ -1,676 +1,44 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AIConfig, AgentFeedbackConfig, AlgoliaDocsSearchConfig, ApiReferenceConfig, ApiReferenceRenderer, ApiReferenceRendererConfig, ApiReferenceRendererInput, ApiReferenceVersionConfig, BreadcrumbConfig, ChangelogConfig, ChangelogFrontmatter, CodeBlockCopyData, CopyMarkdownConfig, CopyMarkdownFormat, CustomDocsSearchConfig, DocsAccessClaimValue, DocsAccessPrincipal, DocsAgentA2AApiKeySecurityScheme, DocsAgentA2ACapabilities, DocsAgentA2AConfig, DocsAgentA2AExtension, DocsAgentA2AHttpAuthSecurityScheme, DocsAgentA2AInterfaceConfig, DocsAgentA2AMutualTlsSecurityScheme, DocsAgentA2AOAuth2SecurityScheme, DocsAgentA2AOAuthAuthorizationCodeFlow, DocsAgentA2AOAuthClientCredentialsFlow, DocsAgentA2AOAuthDeviceCodeFlow, DocsAgentA2AOAuthFlows, DocsAgentA2AOAuthImplicitFlow, DocsAgentA2AOAuthPasswordFlow, DocsAgentA2AOpenIdConnectSecurityScheme, DocsAgentA2AProtocolBinding, DocsAgentA2ASecurityRequirement, DocsAgentA2ASecurityScheme, DocsAgentA2ASecurityScopeList, DocsAgentA2ASkill, DocsAgentCompactConfig, DocsAgentConfig, DocsAgentContentChangesConfig, DocsAgentEvaluationAnswerInput, DocsAgentEvaluationAnswerProvider, DocsAgentEvaluationAnswerRequest, DocsAgentEvaluationAnswerResult, DocsAgentEvaluationAnswerRunner, DocsAgentEvaluationSourceReference, DocsAgentEvaluationSurface, DocsAgentEvaluationTaskInput, DocsAgentEvaluationsConfig, DocsAgentFeedbackContext, DocsAgentFeedbackData, DocsAgentGoldenAnswerExpectation, DocsAgentGoldenAuthenticatedContentExpectation, DocsAgentGoldenExampleVerification, DocsAgentGoldenExpectedExample, DocsAgentGoldenFreshnessExpectation, DocsAgentGoldenPromptInjectionExpectation, DocsAgentGoldenQueryVariant, DocsAgentGoldenQueryVariantKind, DocsAgentGoldenSafetyExpectation, DocsAgentGoldenTask, DocsAgentGoldenTaskExpectation, DocsAgentGoldenTaskFilters, DocsAgentSkillsCompatibilityPolicy, DocsAgentSkillsConfig, DocsAgentSkillsInput, DocsAgentSkillsProgressiveDisclosureConfig, DocsAgentTraceEventInput, DocsAgentTraceEventType, DocsAgentTraceStatus, DocsAnalyticsConfig, DocsAnalyticsEvent, DocsAnalyticsEventInput, DocsAnalyticsEventType, DocsAnalyticsInput, DocsAnalyticsSource, DocsAskAIActionData, DocsAskAIActionType, DocsAskAIFeedbackConfig, DocsAskAIFeedbackData, DocsAskAIFeedbackMessage, DocsAskAIFeedbackValue, DocsAskAIMcpConfig, DocsCloudApiKeyConfig, DocsCloudConfig, DocsCloudFeatureConfig, DocsCloudPreviewConfig, DocsCloudPublishConfig, DocsCodeBlocksConfig, DocsCodeBlocksPlannerConfig, DocsCodeBlocksPlannerProvider, DocsCodeBlocksRunnerConfig, DocsCodeBlocksRunnerProvider, DocsCodeBlocksValidateConfig, DocsCodeBlocksValidationMode, DocsCodeBlocksValidationPolicy, DocsConfig, DocsContentChangeDocument, DocsContentChangeSnapshotContext, DocsContentChangeSnapshotLoader, DocsContentChangeSnapshotSaver, DocsContentChangedDocument, DocsContentChangesResponse, DocsContentSnapshot, DocsContentSnapshotDocument, DocsFeedbackData, DocsFeedbackValue, DocsI18nConfig, DocsMcpAllowedOrigins, DocsMcpAuthPrincipal, DocsMcpAuthenticate, DocsMcpAuthenticateContext, DocsMcpAuthenticateResult, DocsMcpConfig, DocsMcpCorsConfig, DocsMcpOriginContext, DocsMcpPromptsConfig, DocsMcpProtectedResourceConfig, DocsMcpSecurityConfig, DocsMcpToolsConfig, DocsMetadata, DocsNav, DocsObservabilityConfig, DocsObservabilityEvent, DocsObservabilityEventInput, DocsOkfActorTimestamp, DocsOkfConfig, DocsOkfSource, DocsOkfStatus, DocsOkfTrustMetadata, DocsOkfTrustMetadataInput, DocsOkfTrustTier, DocsOpenApiMcpConfig, DocsOpenApiMcpCredentialContext, DocsOpenApiMcpHeaders, DocsPageAccessPolicy, DocsPaginatedSearchResponse, DocsRelatedItem, DocsRetrievalSourceProvenance, DocsRetrievalSourceScope, DocsReviewCiConfig, DocsReviewCiMode, DocsReviewConfig, DocsReviewRulesConfig, DocsReviewScoreConfig, DocsReviewSeverity, DocsRobotsConfig, DocsRobotsRule, DocsSearchAdapter, DocsSearchAdapterContext, DocsSearchAdapterFactory, DocsSearchAdapterPage, DocsSearchAmbiguityDecision, DocsSearchAmbiguityDecisionStatus, DocsSearchAmbiguityResolution, DocsSearchChunkingConfig, DocsSearchConfig, DocsSearchDocument, DocsSearchEmbeddingsConfig, DocsSearchExplanation, DocsSearchFacet, DocsSearchFacetValue, DocsSearchFacetsResponse, DocsSearchFilterDecision, DocsSearchFilterDecisionOutcome, DocsSearchFilterField, DocsSearchFilterInput, DocsSearchFilters, DocsSearchMatchField, DocsSearchMatchedTerm, DocsSearchQuery, DocsSearchRankingReason, DocsSearchRankingReasonCode, DocsSearchRankingStrategy, DocsSearchRequest, DocsSearchResponse, DocsSearchResult, DocsSearchResultType, DocsSearchSourcePage, DocsSearchWarning, DocsSearchWarningCode, DocsSitemapConfig, DocsTelemetryAgentSurface, DocsTelemetryConfig, DocsTelemetryEvent, DocsTelemetryEventInput, DocsTelemetryEventType, DocsTelemetryFeatures, DocsTelemetryFramework, DocsTheme, FeedbackConfig, FontStyle, GithubConfig, LastUpdatedConfig, LlmsTxtConfig, LlmsTxtMaxCharsConfig, LlmsTxtMaxCharsMode, LlmsTxtSectionConfig, McpDocsSearchConfig, OGConfig, OpenDocsConfig, OpenDocsProvider, OpenDocsProviderConfig, OpenDocsProviderId, OpenDocsTarget, OpenGraphImage, OrderingItem, PageActionConnectMcpConfig, PageActionInstallSkillsConfig, PageActionMcpProvider, PageActionsConfig, PageAgentAppliesTo, PageAgentCommand, PageAgentFailureMode, PageAgentFrontmatter, PageAgentVerification, PageFrontmatter, PageOpenGraph, PageSidebarFrontmatter, PageTwitter, ReadingTimeConfig, ReadingTimeFormat, ResolvedDocsRelatedLink, SidebarComponentProps, SidebarConfig, SidebarFolderIndexBehavior, SidebarFolderNode, SidebarNode, SidebarPageNode, SidebarTree, SimpleDocsSearchConfig, ThemeToggleConfig, TypesenseDocsSearchConfig, TypographyConfig, UIConfig } from "./types.mjs";
|
|
2
2
|
import { AGENT_SKILL_COMPATIBILITY_MAX_LENGTH, AGENT_SKILL_DESCRIPTION_MAX_LENGTH, AGENT_SKILL_FRONTMATTER_FIELDS, AGENT_SKILL_NAME_MAX_LENGTH, DocsAgentSkillFrontmatter, DocsAgentSkillFrontmatterError, DocsAgentSkillFrontmatterField, DocsAgentSkillFrontmatterIssue, DocsAgentSkillFrontmatterValidation, DocsAgentSkillFrontmatterValidationOptions, isDocsAgentSkillName, parseDocsAgentSkillFrontmatter, validateDocsAgentSkillFrontmatter } from "./agent-skills-spec.mjs";
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
};
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
contentDir: string;
|
|
45
|
-
title: string;
|
|
46
|
-
description?: string;
|
|
47
|
-
search: boolean;
|
|
48
|
-
actionsComponent?: unknown;
|
|
49
|
-
}
|
|
50
|
-
interface ChangelogEntrySummary extends ChangelogFrontmatter {
|
|
51
|
-
slug: string;
|
|
52
|
-
date: string;
|
|
53
|
-
url: string;
|
|
54
|
-
}
|
|
55
|
-
declare function resolveChangelogConfig(value: DocsConfig["changelog"]): ResolvedChangelogConfig;
|
|
56
|
-
//#endregion
|
|
57
|
-
//#region src/date.d.ts
|
|
58
|
-
/** Formats docs timestamps without allowing the deployment timezone to change the calendar day. */
|
|
59
|
-
declare function formatDocsLastModifiedDate(value: string | Date): string | undefined;
|
|
60
|
-
//#endregion
|
|
61
|
-
//#region src/utils.d.ts
|
|
62
|
-
/**
|
|
63
|
-
* Deep merge utility for theme overrides.
|
|
64
|
-
* Merges objects recursively; later values override earlier ones.
|
|
65
|
-
*/
|
|
66
|
-
declare function deepMerge<T extends Record<string, unknown>>(target: T, ...sources: Partial<T>[]): T;
|
|
67
|
-
//#endregion
|
|
68
|
-
//#region src/create-theme.d.ts
|
|
69
|
-
/**
|
|
70
|
-
* Create a theme preset factory.
|
|
71
|
-
*
|
|
72
|
-
* Returns a function that accepts optional overrides and deep-merges them
|
|
73
|
-
* with the base theme defaults. This is the same pattern used by the
|
|
74
|
-
* built-in `fumadocs()`, `darksharp()`, and `pixelBorder()` presets.
|
|
75
|
-
*
|
|
76
|
-
* @param baseTheme - The default theme configuration
|
|
77
|
-
* @returns A factory function `(overrides?) => DocsTheme`
|
|
78
|
-
*
|
|
79
|
-
* @example
|
|
80
|
-
* ```ts
|
|
81
|
-
* import { createTheme } from "@farming-labs/docs";
|
|
82
|
-
*
|
|
83
|
-
* export const myTheme = createTheme({
|
|
84
|
-
* name: "my-theme",
|
|
85
|
-
* ui: {
|
|
86
|
-
* colors: { primary: "#6366f1" },
|
|
87
|
-
* layout: { contentWidth: 800 },
|
|
88
|
-
* },
|
|
89
|
-
* });
|
|
90
|
-
* ```
|
|
91
|
-
*/
|
|
92
|
-
declare function createTheme(baseTheme: DocsTheme): (overrides?: Partial<DocsTheme>) => DocsTheme;
|
|
93
|
-
/**
|
|
94
|
-
* Extend an existing theme preset with additional defaults.
|
|
95
|
-
*
|
|
96
|
-
* Useful when you want to build on top of an existing theme (e.g. fumadocs)
|
|
97
|
-
* rather than starting from scratch.
|
|
98
|
-
*
|
|
99
|
-
* @example
|
|
100
|
-
* ```ts
|
|
101
|
-
* import { extendTheme } from "@farming-labs/docs";
|
|
102
|
-
* import { fumadocs } from "@farming-labs/theme/default";
|
|
103
|
-
*
|
|
104
|
-
* // Start with fumadocs defaults, override some values
|
|
105
|
-
* export const myTheme = extendTheme(fumadocs(), {
|
|
106
|
-
* name: "my-custom-fumadocs",
|
|
107
|
-
* ui: { colors: { primary: "#22c55e" } },
|
|
108
|
-
* });
|
|
109
|
-
* ```
|
|
110
|
-
*/
|
|
111
|
-
declare function extendTheme(baseTheme: DocsTheme, extensions: Partial<DocsTheme>): DocsTheme;
|
|
112
|
-
//#endregion
|
|
113
|
-
//#region src/agent-conformance.d.ts
|
|
114
|
-
declare const DOCS_AGENT_CONTRACT_VERSION = "1.3";
|
|
115
|
-
type DocsAgentAdapter = "next" | "tanstack-start" | "farmjs" | "sveltekit" | "astro" | "nuxt";
|
|
116
|
-
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";
|
|
117
|
-
interface DocsAgentContractRequest {
|
|
118
|
-
url: string;
|
|
119
|
-
init?: RequestInit;
|
|
120
|
-
}
|
|
121
|
-
interface DocsAgentContractExpectation {
|
|
122
|
-
statuses: readonly number[];
|
|
123
|
-
contentTypes: readonly string[];
|
|
124
|
-
bodyIncludes?: readonly string[];
|
|
125
|
-
bodyEmpty?: boolean;
|
|
126
|
-
headerIncludes?: Readonly<Record<string, readonly string[]>>;
|
|
127
|
-
linkRelations?: readonly {
|
|
128
|
-
href: string;
|
|
129
|
-
rel: string;
|
|
130
|
-
type?: string;
|
|
131
|
-
}[];
|
|
132
|
-
}
|
|
133
|
-
interface DocsAgentContractCase {
|
|
134
|
-
surface: DocsAgentContractSurface;
|
|
135
|
-
request: DocsAgentContractRequest;
|
|
136
|
-
expect: DocsAgentContractExpectation;
|
|
137
|
-
}
|
|
138
|
-
interface DocsAgentConformanceCaseResult {
|
|
139
|
-
surface: DocsAgentContractSurface;
|
|
140
|
-
passed: boolean;
|
|
141
|
-
status?: number;
|
|
142
|
-
contentType?: string;
|
|
143
|
-
issues: string[];
|
|
144
|
-
}
|
|
145
|
-
interface DocsAgentConformanceReport {
|
|
146
|
-
adapter: DocsAgentAdapter;
|
|
147
|
-
contractVersion: typeof DOCS_AGENT_CONTRACT_VERSION;
|
|
148
|
-
passed: boolean;
|
|
149
|
-
cases: DocsAgentConformanceCaseResult[];
|
|
150
|
-
}
|
|
151
|
-
interface RunDocsAgentConformanceOptions {
|
|
152
|
-
adapter: DocsAgentAdapter;
|
|
153
|
-
/** Origin used to construct requests. Defaults to http://localhost. */
|
|
154
|
-
origin?: string;
|
|
155
|
-
/** Public docs entry. Defaults to docs. */
|
|
156
|
-
entry?: string;
|
|
157
|
-
/** Locale fixture expected to render the word "Bonjour". Set false to skip. */
|
|
158
|
-
locale?: string | false;
|
|
159
|
-
handle(request: Request, surface: DocsAgentContractSurface): Response | Promise<Response>;
|
|
160
|
-
}
|
|
161
|
-
/**
|
|
162
|
-
* The framework-neutral public surface every first-party adapter must implement.
|
|
163
|
-
* Adapter tests consume this list so new routes and invariants are added once.
|
|
164
|
-
*/
|
|
165
|
-
declare function createDocsAgentContractCases(options?: {
|
|
166
|
-
origin?: string;
|
|
167
|
-
entry?: string;
|
|
168
|
-
locale?: string | false;
|
|
169
|
-
}): DocsAgentContractCase[];
|
|
170
|
-
declare function runDocsAgentConformance(options: RunDocsAgentConformanceOptions): Promise<DocsAgentConformanceReport>;
|
|
171
|
-
//#endregion
|
|
172
|
-
//#region src/metadata.d.ts
|
|
173
|
-
interface DocsStructuredDataBreadcrumb {
|
|
174
|
-
name: string;
|
|
175
|
-
url: string;
|
|
176
|
-
}
|
|
177
|
-
interface DocsPageStructuredDataInput {
|
|
178
|
-
title: string;
|
|
179
|
-
description?: string;
|
|
180
|
-
url: string;
|
|
181
|
-
baseUrl?: string;
|
|
182
|
-
entry?: string;
|
|
183
|
-
dateModified?: string;
|
|
184
|
-
breadcrumbs?: DocsStructuredDataBreadcrumb[];
|
|
185
|
-
/** Optional actionable page contract represented as a Schema.org HowTo. */
|
|
186
|
-
agent?: PageAgentFrontmatter;
|
|
187
|
-
}
|
|
188
|
-
/**
|
|
189
|
-
* Resolve page title using metadata titleTemplate.
|
|
190
|
-
* %s is replaced with page title.
|
|
191
|
-
*/
|
|
192
|
-
declare function resolveTitle(pageTitle: string, metadata?: DocsMetadata): string;
|
|
193
|
-
/**
|
|
194
|
-
* Resolve OG image URL for a page.
|
|
195
|
-
* Prefers page.openGraph.images[0], then page.ogImage, then config endpoint/default.
|
|
196
|
-
*/
|
|
197
|
-
declare function resolveOGImage(page: PageFrontmatter, ogConfig?: OGConfig, baseUrl?: string): string | undefined;
|
|
198
|
-
/**
|
|
199
|
-
* Build the Open Graph metadata object for a page.
|
|
200
|
-
* When the page has openGraph in frontmatter, uses it (with title/description filled from page if omitted).
|
|
201
|
-
* Otherwise uses ogImage or config (dynamic endpoint / defaultImage).
|
|
202
|
-
*/
|
|
203
|
-
declare function buildPageOpenGraph(page: Pick<PageFrontmatter, "title" | "description" | "ogImage" | "openGraph">, ogConfig?: OGConfig, baseUrl?: string): PageOpenGraph | undefined;
|
|
204
|
-
/**
|
|
205
|
-
* Build the Twitter card metadata object for a page.
|
|
206
|
-
* When the page has twitter in frontmatter, uses it.
|
|
207
|
-
* Otherwise builds from ogImage or config (dynamic endpoint).
|
|
208
|
-
*/
|
|
209
|
-
declare function buildPageTwitter(page: Pick<PageFrontmatter, "title" | "description" | "ogImage" | "openGraph" | "twitter">, ogConfig?: OGConfig, baseUrl?: string): PageTwitter | undefined;
|
|
210
|
-
/**
|
|
211
|
-
* Resolve the public docs site URL from existing agent-facing config.
|
|
212
|
-
*
|
|
213
|
-
* The framework intentionally reuses `sitemap.baseUrl`, `llmsTxt.baseUrl`,
|
|
214
|
-
* `robots.baseUrl`, or `ai.docsUrl` instead of requiring another setting.
|
|
215
|
-
*/
|
|
216
|
-
declare function resolveDocsMetadataBaseUrl(config: DocsConfig): string | undefined;
|
|
217
|
-
/**
|
|
218
|
-
* Build Schema.org JSON-LD for a docs page.
|
|
219
|
-
*
|
|
220
|
-
* The shape follows Vercel's agent readability guidance: a `TechArticle`
|
|
221
|
-
* with title, description, canonical URL, freshness, and breadcrumbs.
|
|
222
|
-
*/
|
|
223
|
-
declare function buildDocsPageStructuredData(input: DocsPageStructuredDataInput): Record<string, unknown>;
|
|
224
|
-
/**
|
|
225
|
-
* Serialize Schema.org JSON-LD for safe insertion into a `<script>` tag.
|
|
226
|
-
*/
|
|
227
|
-
declare function renderDocsPageStructuredDataJson(input: DocsPageStructuredDataInput): string;
|
|
228
|
-
//#endregion
|
|
229
|
-
//#region src/reading-time.d.ts
|
|
230
|
-
interface ResolvedReadingTimeOptions {
|
|
231
|
-
enabled: boolean;
|
|
232
|
-
wordsPerMinute?: number;
|
|
233
|
-
format: ReadingTimeFormat;
|
|
234
|
-
includeCode: boolean;
|
|
235
|
-
}
|
|
236
|
-
interface ReadingTimeEstimateOptions {
|
|
237
|
-
includeCode?: boolean;
|
|
238
|
-
}
|
|
239
|
-
declare function estimateReadingTimeMinutes(content: string, wordsPerMinute?: number, options?: ReadingTimeEstimateOptions): number;
|
|
240
|
-
declare function resolveReadingTimeOptions(readingTime: boolean | ReadingTimeConfig | null | undefined): ResolvedReadingTimeOptions;
|
|
241
|
-
declare function resolveReadingTimeFromContent(frontmatter: Partial<PageFrontmatter> | undefined, content: string, wordsPerMinute?: number, options?: ReadingTimeEstimateOptions): number | null;
|
|
242
|
-
declare function resolvePageReadingTime(frontmatter: Partial<PageFrontmatter> | undefined, content: string, options?: {
|
|
243
|
-
enabledByDefault?: boolean;
|
|
244
|
-
wordsPerMinute?: number;
|
|
245
|
-
includeCode?: boolean;
|
|
246
|
-
}): number | null | undefined;
|
|
247
|
-
declare function resolveReadingTimeFromSource(source: string, wordsPerMinute?: number, options?: ReadingTimeEstimateOptions): number | null;
|
|
248
|
-
//#endregion
|
|
249
|
-
//#region src/related.d.ts
|
|
250
|
-
declare function normalizeDocsRelated(value: unknown): ResolvedDocsRelatedLink[];
|
|
251
|
-
declare function renderDocsRelatedMarkdownLines(related: ResolvedDocsRelatedLink[] | undefined): string[];
|
|
252
|
-
//#endregion
|
|
253
|
-
//#region src/agent-contract.d.ts
|
|
254
|
-
interface PageAgentFrontmatterIssue {
|
|
255
|
-
path: string;
|
|
256
|
-
message: string;
|
|
257
|
-
}
|
|
258
|
-
declare const PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS: readonly ["task", "outcome", "appliesTo", "prerequisites", "files", "commands", "sideEffects", "verification", "rollback", "failureModes"];
|
|
259
|
-
declare const PAGE_AGENT_CONTRACT_FIELDS: readonly ["tokenBudget", "access", "task", "outcome", "appliesTo", "prerequisites", "files", "commands", "sideEffects", "verification", "rollback", "failureModes"];
|
|
260
|
-
declare const PAGE_AGENT_CONTRACT_FIELD_SCHEMA: {
|
|
261
|
-
readonly tokenBudget: "number";
|
|
262
|
-
readonly access: "{visibility?,scopes?,claims?}";
|
|
263
|
-
readonly task: "string";
|
|
264
|
-
readonly outcome: "string";
|
|
265
|
-
readonly appliesTo: {
|
|
266
|
-
readonly framework: "string|string[]";
|
|
267
|
-
readonly version: "string|string[]";
|
|
268
|
-
readonly package: "string|string[]";
|
|
269
|
-
};
|
|
270
|
-
readonly prerequisites: "string[]";
|
|
271
|
-
readonly files: "string[]";
|
|
272
|
-
readonly commands: "Array<string|{run,cwd?,description?}>";
|
|
273
|
-
readonly sideEffects: "string[]";
|
|
274
|
-
readonly verification: "Array<string|{description?,run?,expect?}>";
|
|
275
|
-
readonly rollback: "string[]";
|
|
276
|
-
readonly failureModes: "Array<string|{symptom,resolution?}>";
|
|
277
|
-
};
|
|
278
|
-
declare const PAGE_AGENT_CONTRACT_START_MARKER = "<!-- farming-labs:agent-contract:start -->";
|
|
279
|
-
declare const PAGE_AGENT_CONTRACT_END_MARKER = "<!-- farming-labs:agent-contract:end -->";
|
|
280
|
-
/**
|
|
281
|
-
* Normalize untrusted page frontmatter into the stable agent contract shape.
|
|
282
|
-
* Invalid fields are omitted so malformed author input cannot break page delivery.
|
|
283
|
-
*/
|
|
284
|
-
declare function normalizePageAgentFrontmatter(value: unknown): PageAgentFrontmatter | undefined;
|
|
285
|
-
declare function hasStructuredPageAgentContract(value: unknown): boolean;
|
|
286
|
-
/** Return author-facing validation issues without throwing. */
|
|
287
|
-
declare function getPageAgentFrontmatterIssues(value: unknown): PageAgentFrontmatterIssue[];
|
|
288
|
-
/** Render normalized `agent` YAML in a stable field order. */
|
|
289
|
-
declare function renderPageAgentFrontmatterYamlLines(value: unknown, indentation?: number): string[];
|
|
290
|
-
/** Render the structured contract as deterministic, compact machine-readable Markdown. */
|
|
291
|
-
declare function renderPageAgentContractMarkdown(value: unknown): string;
|
|
292
|
-
/** Remove generated contract blocks while preserving handwritten guidance. */
|
|
293
|
-
declare function stripGeneratedPageAgentContractMarkdown(markdown: string): string;
|
|
294
|
-
/** Insert one generated contract unless the document already has handwritten contract guidance. */
|
|
295
|
-
declare function upsertPageAgentContractMarkdown(markdown: string, value: unknown): string;
|
|
296
|
-
//#endregion
|
|
297
|
-
//#region src/agent-feedback-evaluations.d.ts
|
|
298
|
-
declare const DOCS_AGENT_FEEDBACK_EVALUATION_CANDIDATES_FORMAT: "farming-labs-agent-feedback-evaluation-candidates.v1";
|
|
299
|
-
declare const DOCS_AGENT_FEEDBACK_EVALUATION_BASELINE_FORMAT: "farming-labs-agent-feedback-evaluation-baseline.v1";
|
|
300
|
-
declare const DOCS_AGENT_FEEDBACK_EVALUATION_REGRESSION_FORMAT: "farming-labs-agent-feedback-evaluation-regression.v1";
|
|
301
|
-
interface DocsAgentFeedbackEvaluationCandidate {
|
|
302
|
-
id: string;
|
|
303
|
-
fingerprint: string;
|
|
304
|
-
state: "candidate";
|
|
305
|
-
task: DocsAgentGoldenTask;
|
|
306
|
-
evidence: {
|
|
307
|
-
clusterId: string;
|
|
308
|
-
page: string;
|
|
309
|
-
occurrences: number;
|
|
310
|
-
outcomes: string[];
|
|
311
|
-
};
|
|
312
|
-
sanitization: {
|
|
313
|
-
redactionCount: number;
|
|
314
|
-
};
|
|
315
|
-
promotion: {
|
|
316
|
-
target: "agent.evaluations.tasks";
|
|
317
|
-
requiresHumanReview: true;
|
|
318
|
-
};
|
|
319
|
-
}
|
|
320
|
-
interface DocsAgentFeedbackEvaluationDuplicate {
|
|
321
|
-
clusterId: string;
|
|
322
|
-
taskId: string;
|
|
323
|
-
fingerprint: string;
|
|
324
|
-
reason: "existing-id" | "existing-fingerprint" | "duplicate-candidate";
|
|
325
|
-
}
|
|
326
|
-
interface DocsAgentFeedbackEvaluationCandidateRegistry {
|
|
327
|
-
format: typeof DOCS_AGENT_FEEDBACK_EVALUATION_CANDIDATES_FORMAT;
|
|
328
|
-
generatedAt: string;
|
|
329
|
-
sourceFeedbackCount: number;
|
|
330
|
-
sourceClusterCount: number;
|
|
331
|
-
candidateCount: number;
|
|
332
|
-
duplicateCount: number;
|
|
333
|
-
redactionCount: number;
|
|
334
|
-
candidates: DocsAgentFeedbackEvaluationCandidate[];
|
|
335
|
-
duplicates: DocsAgentFeedbackEvaluationDuplicate[];
|
|
336
|
-
promotion: {
|
|
337
|
-
mode: "review-required";
|
|
338
|
-
automaticallyUpdatesConfig: false;
|
|
339
|
-
automaticallyPublishes: false;
|
|
340
|
-
};
|
|
341
|
-
}
|
|
342
|
-
interface BuildDocsAgentFeedbackEvaluationCandidatesOptions {
|
|
343
|
-
generatedAt?: string;
|
|
344
|
-
existingTasks?: readonly DocsAgentGoldenTask[];
|
|
345
|
-
}
|
|
346
|
-
interface DocsAgentFeedbackEvaluationTaskBaseline {
|
|
347
|
-
id: string;
|
|
348
|
-
passed: boolean;
|
|
349
|
-
score: number;
|
|
350
|
-
}
|
|
351
|
-
interface DocsAgentFeedbackEvaluationBaseline {
|
|
352
|
-
format: typeof DOCS_AGENT_FEEDBACK_EVALUATION_BASELINE_FORMAT;
|
|
353
|
-
generatedAt: string;
|
|
354
|
-
score: number;
|
|
355
|
-
taskCount: number;
|
|
356
|
-
passedTaskCount: number;
|
|
357
|
-
tasks: DocsAgentFeedbackEvaluationTaskBaseline[];
|
|
358
|
-
}
|
|
359
|
-
interface DocsAgentFeedbackEvaluationRegression {
|
|
360
|
-
kind: "missing-task" | "new-failure" | "pass-to-fail" | "score-drop" | "suite-score-drop";
|
|
361
|
-
taskId?: string;
|
|
362
|
-
message: string;
|
|
363
|
-
}
|
|
364
|
-
interface DocsAgentFeedbackEvaluationRegressionReport {
|
|
365
|
-
format: typeof DOCS_AGENT_FEEDBACK_EVALUATION_REGRESSION_FORMAT;
|
|
366
|
-
passed: boolean;
|
|
367
|
-
baselineScore: number;
|
|
368
|
-
currentScore: number;
|
|
369
|
-
scoreDelta: number;
|
|
370
|
-
maxScoreDrop: number;
|
|
371
|
-
regressions: DocsAgentFeedbackEvaluationRegression[];
|
|
372
|
-
}
|
|
373
|
-
interface CompareDocsAgentFeedbackEvaluationOptions {
|
|
374
|
-
/** Maximum allowed score decrease for the suite and each task. @default 0 */
|
|
375
|
-
maxScoreDrop?: number;
|
|
376
|
-
/** Treat newly added failing tasks as regressions. @default true */
|
|
377
|
-
failOnNewFailures?: boolean;
|
|
378
|
-
}
|
|
379
|
-
declare function buildDocsAgentFeedbackEvaluationCandidates(report: DocsAgentFeedbackImprovementReport, options?: BuildDocsAgentFeedbackEvaluationCandidatesOptions): DocsAgentFeedbackEvaluationCandidateRegistry;
|
|
380
|
-
declare function createDocsAgentFeedbackEvaluationBaseline(report: DocsGoldenTasksReport, generatedAt?: string): DocsAgentFeedbackEvaluationBaseline;
|
|
381
|
-
declare function compareDocsAgentFeedbackEvaluationBaseline(current: DocsGoldenTasksReport, baseline: DocsAgentFeedbackEvaluationBaseline, options?: CompareDocsAgentFeedbackEvaluationOptions): DocsAgentFeedbackEvaluationRegressionReport;
|
|
382
|
-
//#endregion
|
|
383
|
-
//#region src/agent-maintenance.d.ts
|
|
384
|
-
declare const DOCS_AGENT_MAINTENANCE_PROPOSAL_FORMAT: "farming-labs-agent-maintenance-proposals.v1";
|
|
385
|
-
type DocsAgentMaintenanceSignalSource = "agent-feedback" | "ask-ai" | "git" | "issue" | "mcp" | "search" | "support";
|
|
386
|
-
type DocsAgentMaintenanceSeverity = "info" | "warning" | "error" | "critical";
|
|
387
|
-
interface DocsAgentMaintenanceSignal {
|
|
388
|
-
source: DocsAgentMaintenanceSignalSource;
|
|
389
|
-
/** Untrusted evidence summary. It is never interpreted as an instruction. */
|
|
390
|
-
summary: string;
|
|
391
|
-
/** Stable grouping key shared across signal sources. Defaults to task or summary. */
|
|
392
|
-
topic?: string;
|
|
393
|
-
page?: string;
|
|
394
|
-
task?: string;
|
|
395
|
-
severity?: DocsAgentMaintenanceSeverity;
|
|
396
|
-
/** Aggregated occurrence count represented by this signal. @default 1 */
|
|
397
|
-
count?: number;
|
|
398
|
-
}
|
|
399
|
-
interface DocsAgentMaintenanceIssueDraft {
|
|
400
|
-
title: string;
|
|
401
|
-
body: string;
|
|
402
|
-
labels: string[];
|
|
403
|
-
}
|
|
404
|
-
interface DocsAgentMaintenanceProposal {
|
|
405
|
-
id: string;
|
|
406
|
-
page: string;
|
|
407
|
-
topic: string;
|
|
408
|
-
task?: string;
|
|
409
|
-
impactScore: number;
|
|
410
|
-
occurrenceCount: number;
|
|
411
|
-
severity: DocsAgentMaintenanceSeverity;
|
|
412
|
-
sources: DocsAgentMaintenanceSignalSource[];
|
|
413
|
-
evidence: Array<{
|
|
414
|
-
source: DocsAgentMaintenanceSignalSource;
|
|
415
|
-
summary: string;
|
|
416
|
-
count: number;
|
|
417
|
-
}>;
|
|
418
|
-
recommendedActions: string[];
|
|
419
|
-
acceptanceCriteria: string[];
|
|
420
|
-
goldenTask?: DocsAgentGoldenTask;
|
|
421
|
-
issueDraft: DocsAgentMaintenanceIssueDraft;
|
|
422
|
-
}
|
|
423
|
-
interface DocsAgentMaintenanceProposalReport {
|
|
424
|
-
format: typeof DOCS_AGENT_MAINTENANCE_PROPOSAL_FORMAT;
|
|
425
|
-
generatedAt: string;
|
|
426
|
-
signalCount: number;
|
|
427
|
-
representedOccurrences: number;
|
|
428
|
-
proposalCount: number;
|
|
429
|
-
proposals: DocsAgentMaintenanceProposal[];
|
|
430
|
-
goldenTasks: DocsAgentGoldenTask[];
|
|
431
|
-
issueDrafts: DocsAgentMaintenanceIssueDraft[];
|
|
432
|
-
pullRequestDraft: {
|
|
433
|
-
title: string;
|
|
434
|
-
body: string;
|
|
435
|
-
};
|
|
436
|
-
execution: {
|
|
437
|
-
mode: "draft-only";
|
|
438
|
-
writesDocumentation: false;
|
|
439
|
-
publishesChanges: false;
|
|
440
|
-
requiresHumanReview: true;
|
|
441
|
-
};
|
|
442
|
-
}
|
|
443
|
-
interface AnalyzeDocsAgentMaintenanceSignalsOptions {
|
|
444
|
-
/** Minimum represented occurrences required before a proposal is emitted. @default 2 */
|
|
445
|
-
minOccurrences?: number;
|
|
446
|
-
generatedAt?: string;
|
|
447
|
-
}
|
|
448
|
-
declare function analyzeDocsAgentMaintenanceSignals(signals: readonly DocsAgentMaintenanceSignal[], options?: AnalyzeDocsAgentMaintenanceSignalsOptions): DocsAgentMaintenanceProposalReport;
|
|
449
|
-
declare function parseDocsAgentMaintenanceSignals(content: string): DocsAgentMaintenanceSignal[];
|
|
450
|
-
//#endregion
|
|
451
|
-
//#region src/agent-provenance.d.ts
|
|
452
|
-
declare const GENERATED_AGENT_PROVENANCE_MARKER = "@farming-labs/docs:generated";
|
|
453
|
-
declare const GENERATED_AGENT_PROVENANCE_VERSION = 1;
|
|
454
|
-
type GeneratedAgentSourceKind = "resolved-page" | "agent-md";
|
|
455
|
-
interface GeneratedAgentProvenance {
|
|
456
|
-
version: number;
|
|
457
|
-
sourceKind: GeneratedAgentSourceKind;
|
|
458
|
-
sourceHash: string;
|
|
459
|
-
settingsHash: string;
|
|
460
|
-
outputHash: string;
|
|
461
|
-
generatedAt: string;
|
|
462
|
-
}
|
|
463
|
-
interface ParsedGeneratedAgentDocument {
|
|
464
|
-
provenance?: GeneratedAgentProvenance;
|
|
465
|
-
content: string;
|
|
466
|
-
}
|
|
467
|
-
declare function normalizeGeneratedAgentContent(value: string): string;
|
|
468
|
-
declare function hashGeneratedAgentContent(value: string): string;
|
|
469
|
-
declare function parseGeneratedAgentDocument(raw: string): ParsedGeneratedAgentDocument;
|
|
470
|
-
declare function stripGeneratedAgentProvenance(raw: string): string;
|
|
471
|
-
declare function serializeGeneratedAgentDocument(content: string, provenance: GeneratedAgentProvenance): string;
|
|
472
|
-
//#endregion
|
|
473
|
-
//#region src/markdown-sections.d.ts
|
|
474
|
-
interface DocsMarkdownHeadingAnchor {
|
|
475
|
-
/** Heading source without a trailing Fumadocs custom-id marker. */
|
|
476
|
-
source: string;
|
|
477
|
-
/** Visible heading label with common inline Markdown removed. */
|
|
478
|
-
title: string;
|
|
479
|
-
/** Canonical fragment identifier shared by rendered and agent surfaces. */
|
|
480
|
-
anchor: string;
|
|
481
|
-
/** Whether the anchor came from a trailing `[#custom-id]` marker. */
|
|
482
|
-
explicit: boolean;
|
|
483
|
-
}
|
|
484
|
-
interface DocsRenderedHeadingAnchorOptions {
|
|
485
|
-
/** An author-provided or previously assigned fragment identifier. */
|
|
486
|
-
explicitAnchor?: string;
|
|
487
|
-
}
|
|
488
|
-
interface ApplyDocsMarkdownHeadingAnchorsOptions {
|
|
489
|
-
/** Honor trailing Fumadocs `[#custom-id]` markers. */
|
|
490
|
-
customId?: boolean;
|
|
491
|
-
}
|
|
492
|
-
/**
|
|
493
|
-
* Run a third-party heading visitor without exposing headings inside `<Prompt>`.
|
|
494
|
-
*
|
|
495
|
-
* Prompt children are literal, copyable input rather than rendered page content.
|
|
496
|
-
* The node types are restored synchronously even when the visitor throws.
|
|
497
|
-
*/
|
|
498
|
-
declare function withDocsMarkdownRenderableHeadings<T>(root: unknown, visitor: () => T): T;
|
|
499
|
-
/** Normalize text that has already been flattened from a rendered heading AST. */
|
|
500
|
-
declare function cleanDocsRenderedHeadingLabel(value: string): string;
|
|
501
|
-
/**
|
|
502
|
-
* Create a stateful resolver for text already flattened by an MDX renderer.
|
|
503
|
-
*
|
|
504
|
-
* Unlike the raw-Markdown resolver, this does not reinterpret inline code or a
|
|
505
|
-
* literal `[#id]` as Markdown syntax.
|
|
506
|
-
*/
|
|
507
|
-
declare function createDocsRenderedHeadingAnchorResolver(): (value: string, options?: DocsRenderedHeadingAnchorOptions) => DocsMarkdownHeadingAnchor;
|
|
508
|
-
declare function createDocsMarkdownHeadingAnchorResolver(): (value: string) => DocsMarkdownHeadingAnchor;
|
|
509
|
-
/**
|
|
510
|
-
* Assign canonical IDs to every heading in an MDX syntax tree.
|
|
511
|
-
*
|
|
512
|
-
* Render adapters call this before Fumadocs extracts its TOC, ensuring HTML,
|
|
513
|
-
* Markdown retrieval, search, Ask AI, and MCP all use the same fragments.
|
|
514
|
-
*/
|
|
515
|
-
declare function applyDocsMarkdownHeadingAnchors(root: unknown, options?: ApplyDocsMarkdownHeadingAnchorsOptions): void;
|
|
516
|
-
/** Resolve one heading with the canonical GitHub-style anchor algorithm. */
|
|
517
|
-
declare function slugifyDocsMarkdownHeading(value: string): string;
|
|
518
|
-
//#endregion
|
|
519
|
-
//#region src/heading-toc.d.ts
|
|
520
|
-
/**
|
|
521
|
-
* Encode heading fragments emitted by a renderer's nested table of contents.
|
|
522
|
-
*
|
|
523
|
-
* Fumadocs stores fragment URLs as raw DOM ids. Encoding the fragment after its
|
|
524
|
-
* heading visitor runs keeps links valid without changing path prefixes.
|
|
525
|
-
*/
|
|
526
|
-
declare function encodeDocsHeadingTocUrls(value: unknown): void;
|
|
527
|
-
//#endregion
|
|
528
|
-
//#region src/prompt-references.d.ts
|
|
529
|
-
/**
|
|
530
|
-
* Keep `<Prompt>` children literal before Markdown reference definitions are
|
|
531
|
-
* resolved by the MDX compiler.
|
|
532
|
-
*
|
|
533
|
-
* Definitions inside Prompt are copyable source, not page-level definitions.
|
|
534
|
-
* References inside Prompt always remain source text, while references outside
|
|
535
|
-
* Prompt only remain live when they have a definition outside Prompt.
|
|
536
|
-
*/
|
|
537
|
-
declare function isolateDocsMarkdownPromptReferences(root: unknown, value?: unknown): void;
|
|
538
|
-
//#endregion
|
|
539
|
-
//#region src/robots.d.ts
|
|
540
|
-
declare const DEFAULT_ROBOTS_TXT_ROUTE = "/robots.txt";
|
|
541
|
-
declare const DOCS_ROBOTS_GENERATED_BLOCK_START = "# BEGIN @farming-labs/docs robots";
|
|
542
|
-
declare const DOCS_ROBOTS_GENERATED_BLOCK_END = "# END @farming-labs/docs robots";
|
|
543
|
-
declare const DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS: readonly ["GPTBot", "ChatGPT-User", "OAI-SearchBot", "ClaudeBot", "Claude-User", "anthropic-ai", "CCBot", "Google-Extended"];
|
|
544
|
-
interface DocsRobotsResolvedConfig {
|
|
545
|
-
enabled: boolean;
|
|
546
|
-
path?: string;
|
|
547
|
-
baseUrl?: string;
|
|
548
|
-
ai: "allow" | "disallow";
|
|
549
|
-
userAgents: string[];
|
|
550
|
-
extraRules: DocsRobotsRule[];
|
|
551
|
-
}
|
|
552
|
-
interface DocsRobotsRenderOptions {
|
|
553
|
-
entry?: string;
|
|
554
|
-
/** Include the RFC 9727 catalog route only when the deployment actually serves it. */
|
|
555
|
-
apiCatalog?: boolean;
|
|
556
|
-
/** Include an A2A Agent Card only when a real A2A service is configured. */
|
|
557
|
-
agentCard?: boolean;
|
|
558
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
559
|
-
baseUrl?: string;
|
|
560
|
-
robots?: boolean | DocsRobotsConfig;
|
|
561
|
-
}
|
|
562
|
-
interface DocsRobotsAnalysis {
|
|
563
|
-
blocksAgentRoutes: boolean;
|
|
564
|
-
blocksAiAgents: boolean;
|
|
565
|
-
hasAgentRoutes: boolean;
|
|
566
|
-
hasAiPolicy: boolean;
|
|
567
|
-
missingRoutes: string[];
|
|
568
|
-
}
|
|
569
|
-
interface DocsRobotsAnalysisOptions extends DocsRobotsRenderOptions {
|
|
570
|
-
/** Exact sitemap routes advertised by a fetched discovery manifest. */
|
|
571
|
-
sitemapRoutes?: readonly string[];
|
|
572
|
-
}
|
|
573
|
-
interface CreateDocsRobotsResponseOptions extends DocsRobotsRenderOptions {
|
|
574
|
-
request: Request;
|
|
575
|
-
}
|
|
576
|
-
declare function resolveDocsRobotsConfig(input: boolean | DocsRobotsConfig | undefined, options?: {
|
|
577
|
-
baseUrl?: string;
|
|
578
|
-
}): DocsRobotsResolvedConfig;
|
|
579
|
-
declare function getDocsRobotsAllowRoutes(options?: DocsRobotsRenderOptions): string[];
|
|
580
|
-
declare function renderDocsRobotsTxt(options?: DocsRobotsRenderOptions): string;
|
|
581
|
-
declare function resolveDocsRobotsRequest(url: URL, robots?: boolean | DocsRobotsConfig): "robots" | null;
|
|
582
|
-
declare function createDocsRobotsResponse({
|
|
583
|
-
request,
|
|
584
|
-
...options
|
|
585
|
-
}: CreateDocsRobotsResponseOptions): Response | null;
|
|
586
|
-
declare function renderDocsRobotsGeneratedBlock(options?: DocsRobotsRenderOptions): string;
|
|
587
|
-
declare function upsertDocsRobotsGeneratedBlock(existing: string, block: string): string;
|
|
588
|
-
declare function analyzeDocsRobotsTxt(content: string, options?: DocsRobotsAnalysisOptions): DocsRobotsAnalysis;
|
|
589
|
-
//#endregion
|
|
590
|
-
//#region src/okf.d.ts
|
|
591
|
-
declare const DOCS_OKF_VERSION = "0.2";
|
|
592
|
-
declare const DOCS_OKF_BUNDLE_FORMAT = "open-knowledge-format.v0.2";
|
|
593
|
-
declare const DEFAULT_DOCS_OKF_ROUTE = "/.well-known/okf.json";
|
|
594
|
-
interface DocsOkfPageLike {
|
|
595
|
-
url: string;
|
|
596
|
-
title: string;
|
|
597
|
-
canonicalUrl?: string;
|
|
598
|
-
sourcePath?: string;
|
|
599
|
-
lastModified?: string;
|
|
600
|
-
lastmod?: string;
|
|
601
|
-
okf?: DocsOkfTrustMetadataInput;
|
|
602
|
-
}
|
|
603
|
-
interface DocsOkfResolvedConfig extends DocsOkfTrustMetadataInput {
|
|
604
|
-
enabled: boolean;
|
|
605
|
-
route: string;
|
|
606
|
-
generatedBy: string;
|
|
607
|
-
staleAfterDays?: number;
|
|
608
|
-
}
|
|
609
|
-
interface DocsOkfKnowledgeDocument {
|
|
610
|
-
id: string;
|
|
611
|
-
url: string;
|
|
612
|
-
title: string;
|
|
613
|
-
content?: string;
|
|
614
|
-
trust: DocsOkfTrustMetadata;
|
|
615
|
-
}
|
|
616
|
-
interface DocsOkfBundle {
|
|
617
|
-
format: typeof DOCS_OKF_BUNDLE_FORMAT;
|
|
618
|
-
spec_version: typeof DOCS_OKF_VERSION;
|
|
619
|
-
generated: DocsOkfActorTimestamp;
|
|
620
|
-
documents: DocsOkfKnowledgeDocument[];
|
|
621
|
-
}
|
|
622
|
-
declare function normalizeDocsOkfTrustMetadataInput(value: unknown): DocsOkfTrustMetadataInput | undefined;
|
|
623
|
-
declare function resolveDocsOkfConfig(value?: boolean | DocsOkfConfig): DocsOkfResolvedConfig;
|
|
624
|
-
declare function resolveDocsOkfTrustMetadata(page: DocsOkfPageLike, value?: boolean | DocsOkfConfig, now?: Date): DocsOkfTrustMetadata;
|
|
625
|
-
declare function buildDocsOkfBundle(pages: readonly (DocsOkfPageLike & {
|
|
626
|
-
content?: string;
|
|
627
|
-
})[], value?: boolean | DocsOkfConfig): DocsOkfBundle;
|
|
628
|
-
//#endregion
|
|
629
|
-
//#region src/openapi-mcp.d.ts
|
|
630
|
-
interface DocsOpenApiMcpParameter {
|
|
631
|
-
name: string;
|
|
632
|
-
in: "path" | "query" | "header" | "cookie";
|
|
633
|
-
required: boolean;
|
|
634
|
-
}
|
|
635
|
-
interface DocsOpenApiMcpOperation {
|
|
636
|
-
toolName: string;
|
|
637
|
-
operationId: string;
|
|
638
|
-
method: string;
|
|
639
|
-
path: string;
|
|
640
|
-
title: string;
|
|
641
|
-
description?: string;
|
|
642
|
-
parameters: DocsOpenApiMcpParameter[];
|
|
643
|
-
security: Array<Record<string, string[]>>;
|
|
644
|
-
securitySchemes: Record<string, unknown>;
|
|
645
|
-
readOnly: boolean;
|
|
646
|
-
destructive: boolean;
|
|
647
|
-
idempotent: boolean;
|
|
648
|
-
}
|
|
649
|
-
declare function resolveDocsOpenApiMcpOperations(document: Record<string, unknown>, config?: DocsOpenApiMcpConfig): DocsOpenApiMcpOperation[];
|
|
650
|
-
declare function resolveDocsOpenApiMcpBaseUrl(document: Record<string, unknown>, config: DocsOpenApiMcpConfig): string | undefined;
|
|
651
|
-
//#endregion
|
|
652
|
-
//#region src/http-cache.d.ts
|
|
653
|
-
interface DocsCacheableResponseOptions {
|
|
654
|
-
request: Request;
|
|
655
|
-
content: string | Uint8Array;
|
|
656
|
-
status?: number;
|
|
657
|
-
headers?: HeadersInit;
|
|
658
|
-
/** Stable SHA-256 hex digest when the caller already hashed the exact response bytes. */
|
|
659
|
-
sha256?: string;
|
|
660
|
-
/** Exact representation modification time. Invalid values are omitted. */
|
|
661
|
-
lastModified?: string | Date | null;
|
|
662
|
-
}
|
|
663
|
-
/** Format an RFC 9530 Content-Digest field from a SHA-256 hex digest. */
|
|
664
|
-
declare function formatDocsContentDigest(sha256: string): string;
|
|
665
|
-
/** Normalize an exact source timestamp for Last-Modified. */
|
|
666
|
-
declare function resolveDocsHttpDate(value?: string | Date | null): string | undefined;
|
|
667
|
-
/** Match strong or weak If-None-Match validators for a GET/HEAD representation. */
|
|
668
|
-
declare function requestMatchesDocsEtag(request: Request, etag: string): boolean;
|
|
669
|
-
/** Apply If-Modified-Since only when the stronger If-None-Match validator is absent. */
|
|
670
|
-
declare function requestHasFreshDocsDate(request: Request, lastModified?: string): boolean;
|
|
671
|
-
/**
|
|
672
|
-
* Build a byte-stable GET/HEAD response with HTTP validators and RFC 9530 integrity metadata.
|
|
673
|
-
*/
|
|
674
|
-
declare function createDocsCacheableResponse(options: DocsCacheableResponseOptions): Response;
|
|
675
|
-
//#endregion
|
|
3
|
+
import { AGENT_SKILLS_DISCOVERY_SCHEMA_URI, API_CATALOG_MEDIA_TYPE, API_CATALOG_PROFILE_URI, CreateDocsStandardsResponseOptions, DEFAULT_A2A_AGENT_CARD_FORMAT, DEFAULT_A2A_AGENT_CARD_ROUTE, DEFAULT_A2A_PROTOCOL_BINDING, DEFAULT_A2A_PROTOCOL_VERSION, 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_API_CATALOG_FORMAT, DEFAULT_API_CATALOG_ROUTE, DEFAULT_LEGACY_SKILLS_INDEX_FORMAT, DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX, DOCS_AGENT_MANIFEST_FORMAT, DOCS_AGENT_MANIFEST_SCHEMA_MEDIA_TYPE, DOCS_AGENT_MANIFEST_SCHEMA_URI, DOCS_AGENT_MANIFEST_VERSION, DocsA2AAgentCard, DocsA2AAgentCardOptions, DocsA2AAgentInterface, DocsAgentSkillIndexEntry, DocsAgentSkillsIndex, DocsApiCatalog, DocsApiCatalogApiTarget, DocsApiCatalogLinkContext, DocsApiCatalogLinkTarget, DocsApiCatalogOpenApiDefinition, DocsApiCatalogOptions, DocsDiscoveryApiRouteOptions, DocsPublishedAgentSkill, DocsPublishedAgentSkillFile, DocsPublishedAgentSkillOptions, DocsStandardsDiscoveryRequest, DocsStandardsDiscoveryRouteOptions, appendDocsDiscoveryLinkHeader, buildDocsA2AAgentCard, buildDocsAgentSkillsIndex, buildDocsApiCatalog, buildDocsLegacySkillsIndex, createDocsStandardsResponse, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, isDocsStandardsDiscoveryRequest, resolveDocsDiscoveryApiRoute, resolveDocsPublishedAgentSkill, resolveDocsStandardsDiscoveryRequest, sha256DocsDiscoveryContent } from "./standards-discovery.mjs";
|
|
4
|
+
import { DOCS_AGENT_TRACE_EVENT_TYPES, DocsAgentTraceContext, ResolvedDocsAnalyticsConfig, ResolvedDocsObservabilityConfig, createDocsAgentTraceContext, createDocsAgentTraceId, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, getDocsRequestAnalyticsProperties, resolveDocsAnalyticsConfig, resolveDocsObservabilityConfig } from "./analytics.mjs";
|
|
5
|
+
import { DocsTelemetryAgentSurfaceContext, DocsTelemetryAgentSurfaceRequestOptions, DocsTelemetryContext, DocsTelemetryPageViewContext, ResolvedDocsTelemetryConfig, emitDocsTelemetryEvent, emitDocsTelemetryPageViewEvent, isLocalDocsTelemetryOrigin, normalizeDocsTelemetryOrigin, resolveDocsTelemetryConfig } from "./telemetry-runtime.mjs";
|
|
6
|
+
import { applySidebarFolderIndexBehavior, resolvePageSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath } from "./sidebar.mjs";
|
|
7
|
+
import { DocsPageStructuredDataInput, DocsStructuredDataBreadcrumb, buildDocsPageStructuredData, buildPageOpenGraph, buildPageTwitter, renderDocsPageStructuredDataJson, resolveDocsMetadataBaseUrl, resolveOGImage, resolveTitle } from "./metadata.mjs";
|
|
8
|
+
import { DocsContentAudience, resolveDocsAudienceExposure } from "./audience-exposure.mjs";
|
|
9
|
+
import { DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN } from "./agent-detection.mjs";
|
|
10
|
+
import { DEFAULT_DOCS_JSON_BODY_MAX_BYTES, DocsJsonBodyResult, readDocsJsonBody } from "./http-body.mjs";
|
|
11
|
+
import { filterDocsPagesByAccess, isDocsAgentPageAccessible, isDocsPageAccessAllowed, normalizeDocsPageAccessPolicy } from "./access.mjs";
|
|
12
|
+
import { defineDocs } from "./define-docs.mjs";
|
|
13
|
+
import { emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, getDocsTelemetryFeatures, inferDocsTelemetryAgentSurface } from "./telemetry.mjs";
|
|
14
|
+
import { ChangelogEntrySummary, ResolvedChangelogConfig, resolveChangelogConfig } from "./changelog.mjs";
|
|
15
|
+
import { formatDocsLastModifiedDate } from "./date.mjs";
|
|
16
|
+
import { deepMerge } from "./utils.mjs";
|
|
17
|
+
import { createTheme, extendTheme } from "./create-theme.mjs";
|
|
18
|
+
import { DocsPathMatch, ResolvedDocsI18n, resolveDocsI18n, resolveDocsLocale, resolveDocsPath } from "./i18n.mjs";
|
|
19
|
+
import { DOCS_AGENT_CONTRACT_VERSION, DocsAgentAdapter, DocsAgentConformanceCaseResult, DocsAgentConformanceReport, DocsAgentContractCase, DocsAgentContractExpectation, DocsAgentContractRequest, DocsAgentContractSurface, RunDocsAgentConformanceOptions, createDocsAgentContractCases, runDocsAgentConformance } from "./agent-conformance.mjs";
|
|
20
|
+
import { estimateReadingTimeMinutes, resolvePageReadingTime, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions } from "./reading-time.mjs";
|
|
21
|
+
import { normalizeDocsRelated, renderDocsRelatedMarkdownLines } from "./related.mjs";
|
|
22
|
+
import { PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_FIELDS, PAGE_AGENT_CONTRACT_FIELD_SCHEMA, PAGE_AGENT_CONTRACT_START_MARKER, PAGE_AGENT_STRUCTURED_CONTRACT_FIELDS, PageAgentFrontmatterIssue, getPageAgentFrontmatterIssues, hasStructuredPageAgentContract, normalizePageAgentFrontmatter, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, stripGeneratedPageAgentContractMarkdown, upsertPageAgentContractMarkdown } from "./agent-contract.mjs";
|
|
23
|
+
import { normalizeDocsUrlPath, toDocsMarkdownUrl } from "./urls.mjs";
|
|
24
|
+
import { DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, buildDocsMcpProtectedResourceMetadataRoute, getDocsMcpProtectedResourceMetadataRoutes, getDocsMcpResourcePaths, hasDocsMcpProtectedResourceConfig, isDocsMcpRequest } from "./mcp-auth.mjs";
|
|
25
|
+
import { DocsAudienceMdxIssue, findDocsAudienceMdxIssues, resolveDocsAgentMdxContent, resolveDocsAudienceMdxContent } from "./audience.mjs";
|
|
26
|
+
import { 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_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_OPENAPI_SCHEMA_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_MARKDOWN_SECTION_INDEX_FORMAT, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DocsAgentContractMcpTools, DocsAgentDiscoverySpecOptions, DocsAgentFeedbackDiscoveryConfig, DocsAgentFeedbackRequest, DocsAgentFeedbackResolvedConfig, DocsAgentsDocumentOptions, DocsConfigMap, DocsConfigMapJsonValue, DocsConfigMapPointer, DocsDiagnostics, DocsDiagnosticsFeature, DocsDiagnosticsIssue, DocsDiagnosticsIssueSeverity, DocsDiagnosticsOptions, DocsDiagnosticsStatus, DocsLlmsDiscoveryConfig, DocsLlmsTxtGeneratedContent, DocsLlmsTxtGeneratedSection, DocsLlmsTxtMaxCharsIssue, DocsLlmsTxtPageInput, DocsLlmsTxtRequest, DocsLlmsTxtResolvedMaxChars, DocsLlmsTxtResolvedSection, DocsLlmsTxtSelectedContent, DocsMarkdownAgentDetection, DocsMarkdownPage, DocsMarkdownRecoveryMatch, DocsMarkdownRecoveryResult, DocsMarkdownResponseOptions, DocsMarkdownSection, DocsMarkdownSectionIndex, DocsMarkdownSectionIndexOptions, DocsMarkdownSectionMetadata, DocsMarkdownSectionRequest, DocsMarkdownSectionResult, DocsMcpEndpointCandidate, DocsMcpEndpointCandidateOptions, DocsOpenApiDiscoveryConfig, DocsOpenApiResolvedDiscoveryConfig, DocsOpenApiVersionDiscoveryConfig, DocsSkillDocumentOptions, DocsStandardsDiscoveryResponseOptions, acceptsDocsMarkdown, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMarkdownSectionIndex, buildDocsMcpEndpointCandidates, collectDocsMarkdownSections, compactDocsAgentDiscoverySpec, createDocsMarkdownResponse, createDocsStandardsDiscoveryResponse, detectDocsMarkdownAgentRequest, findDocsMarkdownPage, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, hasDocsMarkdownSignatureAgent, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMarkdownSectionIndexRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, parseDocsAgentFeedbackData, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsSkillDocument, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentsFormat, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMarkdownSectionRequest, resolveDocsOpenApiDiscoveryConfig, resolveDocsRequestApiRoute, resolveDocsSkillFormat, selectDocsLlmsTxtContent, selectDocsMarkdownSection, validateDocsAgentFeedbackPayload, withDocsOpenApiOperationCounts } from "./agent.mjs";
|
|
27
|
+
import { BuildDocsContentSnapshotOptions, BuildDocsSearchFacetsOptions, DocsLocalMcpSearchRuntimeConfig, DocsLocalMcpSearchRuntimeInput, DocsSearchRequestError, DocsSearchRequestResolutionOptions, EnrichDocsSearchDocumentsWithProvenanceOptions, PerformDocsSearchOptions, buildDocsAskAIContext, buildDocsContentSnapshot, buildDocsRetrievalDigestProjection, buildDocsSearchDocuments, buildDocsSearchFacets, createAlgoliaSearchAdapter, createCustomSearchAdapter, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, enrichDocsSearchDocumentsWithProvenance, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, normalizeDocsSearchFilters, performDocsSearch, performDocsSearchWithMetadata, resolveAskAISearchRequestConfig, resolveDocsRetrievalLastModified, resolveDocsSearchAudience, resolveDocsSearchError, resolveDocsSearchFilters, resolveDocsSearchRequest, resolveLocalDocsMcpSearchConfig, resolveSearchRequestConfig } from "./search.mjs";
|
|
28
|
+
import { DOCS_CONTENT_CHANGES_FORMAT, DOCS_CONTENT_CHANGES_RESPONSE_VALUE, DOCS_CONTENT_SNAPSHOT_FORMAT, DocsContentChangeFeed, DocsContentChangesRequest, DocsContentChangesRequestError, DocsResolvedContentChangesConfig, ResolveDocsContentChangesOptions, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, isDocsContentChangeGeneration, isDocsContentChangesRequest, resolveDocsContentChangesConfig, resolveDocsContentChangesRequest } from "./content-changes.mjs";
|
|
29
|
+
import { DEFAULT_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, DOCS_CONTENT_CHANGE_HYDRATION_FORMAT, DocsContentChangeHydrationBudget, DocsContentChangeHydrationContent, DocsContentChangeHydrationResponse, DocsContentChangeHydrationSection, DocsContentChangeHydrationTombstone, HydrateDocsContentChangesOptions, MAX_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, MIN_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, hydrateDocsContentChanges } from "./content-change-hydration.mjs";
|
|
30
|
+
import { BuildDocsAgentFeedbackEvaluationCandidatesOptions, CompareDocsAgentFeedbackEvaluationOptions, DOCS_AGENT_FEEDBACK_EVALUATION_BASELINE_FORMAT, DOCS_AGENT_FEEDBACK_EVALUATION_CANDIDATES_FORMAT, DOCS_AGENT_FEEDBACK_EVALUATION_REGRESSION_FORMAT, DocsAgentFeedbackEvaluationBaseline, DocsAgentFeedbackEvaluationCandidate, DocsAgentFeedbackEvaluationCandidateRegistry, DocsAgentFeedbackEvaluationDuplicate, DocsAgentFeedbackEvaluationRegression, DocsAgentFeedbackEvaluationRegressionReport, DocsAgentFeedbackEvaluationTaskBaseline, buildDocsAgentFeedbackEvaluationCandidates, compareDocsAgentFeedbackEvaluationBaseline, createDocsAgentFeedbackEvaluationBaseline } from "./agent-feedback-evaluations.mjs";
|
|
31
|
+
import { AnalyzeDocsAgentMaintenanceSignalsOptions, DOCS_AGENT_MAINTENANCE_PROPOSAL_FORMAT, DocsAgentMaintenanceIssueDraft, DocsAgentMaintenanceProposal, DocsAgentMaintenanceProposalReport, DocsAgentMaintenanceSeverity, DocsAgentMaintenanceSignal, DocsAgentMaintenanceSignalSource, analyzeDocsAgentMaintenanceSignals, parseDocsAgentMaintenanceSignals } from "./agent-maintenance.mjs";
|
|
32
|
+
import { GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, GeneratedAgentProvenance, GeneratedAgentSourceKind, hashGeneratedAgentContent, normalizeGeneratedAgentContent, parseGeneratedAgentDocument, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance } from "./agent-provenance.mjs";
|
|
33
|
+
import { ApplyDocsMarkdownHeadingAnchorsOptions, DocsMarkdownHeadingAnchor, DocsRenderedHeadingAnchorOptions, applyDocsMarkdownHeadingAnchors, cleanDocsRenderedHeadingLabel, createDocsMarkdownHeadingAnchorResolver, createDocsRenderedHeadingAnchorResolver, slugifyDocsMarkdownHeading, withDocsMarkdownRenderableHeadings } from "./markdown-sections.mjs";
|
|
34
|
+
import { encodeDocsHeadingTocUrls } from "./heading-toc.mjs";
|
|
35
|
+
import { isolateDocsMarkdownPromptReferences } from "./prompt-references.mjs";
|
|
36
|
+
import { PromptAction, PromptProviderChoice, SerializeOpenDocsProviderOptions, SerializedOpenDocsProvider } from "./prompt-utils.mjs";
|
|
37
|
+
import { DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DocsSitemapFormat, DocsSitemapManifest, DocsSitemapManifestPage, DocsSitemapPageInput, DocsSitemapResolvedConfig, buildDocsSitemapManifest, createDocsSitemapResponse, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, toDocsSitemapMarkdownUrl } from "./sitemap.mjs";
|
|
38
|
+
import { DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_ROBOTS_TXT_ROUTE, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DocsRobotsAnalysis, DocsRobotsAnalysisOptions, DocsRobotsRenderOptions, DocsRobotsResolvedConfig, analyzeDocsRobotsTxt, createDocsRobotsResponse, getDocsRobotsAllowRoutes, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, resolveDocsRobotsConfig, resolveDocsRobotsRequest, upsertDocsRobotsGeneratedBlock } from "./robots.mjs";
|
|
39
|
+
import { DocsPaginationCursorError } from "./pagination.mjs";
|
|
40
|
+
import { digestDocsContent, digestDocsRetrievalContent, isDocsRetrievalCanonicalUrl, sha256DocsContent } from "./retrieval-digest.mjs";
|
|
41
|
+
import { DEFAULT_DOCS_OKF_ROUTE, DOCS_OKF_BUNDLE_FORMAT, DOCS_OKF_VERSION, DocsOkfBundle, DocsOkfKnowledgeDocument, DocsOkfPageLike, DocsOkfResolvedConfig, buildDocsOkfBundle, normalizeDocsOkfTrustMetadataInput, resolveDocsOkfConfig, resolveDocsOkfTrustMetadata } from "./okf.mjs";
|
|
42
|
+
import { DocsOpenApiMcpOperation, DocsOpenApiMcpParameter, resolveDocsOpenApiMcpBaseUrl, resolveDocsOpenApiMcpOperations } from "./openapi-mcp.mjs";
|
|
43
|
+
import { DocsCacheableResponseOptions, createDocsCacheableResponse, formatDocsContentDigest, requestHasFreshDocsDate, requestMatchesDocsEtag, resolveDocsHttpDate } from "./http-cache.mjs";
|
|
676
44
|
export { AGENT_SKILLS_DISCOVERY_SCHEMA_URI, AGENT_SKILL_COMPATIBILITY_MAX_LENGTH, AGENT_SKILL_DESCRIPTION_MAX_LENGTH, AGENT_SKILL_FRONTMATTER_FIELDS, AGENT_SKILL_NAME_MAX_LENGTH, type AIConfig, API_CATALOG_MEDIA_TYPE, API_CATALOG_PROFILE_URI, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type AnalyzeDocsAgentMaintenanceSignalsOptions, type ApiReferenceConfig, type ApiReferenceRenderer, type ApiReferenceRendererConfig, type ApiReferenceRendererInput, type ApiReferenceVersionConfig, type ApplyDocsMarkdownHeadingAnchorsOptions, type BreadcrumbConfig, type BuildDocsAgentFeedbackEvaluationCandidatesOptions, type BuildDocsContentSnapshotOptions, type BuildDocsSearchFacetsOptions, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CompareDocsAgentFeedbackEvaluationOptions, type CopyMarkdownConfig, type CopyMarkdownFormat, type CreateDocsStandardsResponseOptions, type CustomDocsSearchConfig, DEFAULT_A2A_AGENT_CARD_FORMAT, DEFAULT_A2A_AGENT_CARD_ROUTE, DEFAULT_A2A_PROTOCOL_BINDING, DEFAULT_A2A_PROTOCOL_VERSION, 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_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_DOCS_JSON_BODY_MAX_BYTES, DEFAULT_DOCS_OKF_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_FEEDBACK_EVALUATION_BASELINE_FORMAT, DOCS_AGENT_FEEDBACK_EVALUATION_CANDIDATES_FORMAT, DOCS_AGENT_FEEDBACK_EVALUATION_REGRESSION_FORMAT, DOCS_AGENT_MAINTENANCE_PROPOSAL_FORMAT, DOCS_AGENT_MANIFEST_FORMAT, DOCS_AGENT_MANIFEST_SCHEMA_MEDIA_TYPE, DOCS_AGENT_MANIFEST_SCHEMA_URI, DOCS_AGENT_MANIFEST_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_CONTENT_CHANGES_FORMAT, DOCS_CONTENT_CHANGES_RESPONSE_VALUE, DOCS_CONTENT_CHANGE_HYDRATION_FORMAT, DOCS_CONTENT_SNAPSHOT_FORMAT, DOCS_MARKDOWN_SECTION_INDEX_FORMAT, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_OKF_BUNDLE_FORMAT, DOCS_OKF_VERSION, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, type DocsA2AAgentCard, type DocsA2AAgentCardOptions, type DocsA2AAgentInterface, type DocsAccessClaimValue, type DocsAccessPrincipal, type DocsAgentA2AApiKeySecurityScheme, type DocsAgentA2ACapabilities, type DocsAgentA2AConfig, type DocsAgentA2AExtension, type DocsAgentA2AHttpAuthSecurityScheme, type DocsAgentA2AInterfaceConfig, type DocsAgentA2AMutualTlsSecurityScheme, type DocsAgentA2AOAuth2SecurityScheme, type DocsAgentA2AOAuthAuthorizationCodeFlow, type DocsAgentA2AOAuthClientCredentialsFlow, type DocsAgentA2AOAuthDeviceCodeFlow, type DocsAgentA2AOAuthFlows, type DocsAgentA2AOAuthImplicitFlow, type DocsAgentA2AOAuthPasswordFlow, type DocsAgentA2AOpenIdConnectSecurityScheme, type DocsAgentA2AProtocolBinding, type DocsAgentA2ASecurityRequirement, type DocsAgentA2ASecurityScheme, type DocsAgentA2ASecurityScopeList, type DocsAgentA2ASkill, type DocsAgentAdapter, type DocsAgentCompactConfig, type DocsAgentConfig, type DocsAgentConformanceCaseResult, type DocsAgentConformanceReport, type DocsAgentContentChangesConfig, 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 DocsAgentFeedbackEvaluationBaseline, type DocsAgentFeedbackEvaluationCandidate, type DocsAgentFeedbackEvaluationCandidateRegistry, type DocsAgentFeedbackEvaluationDuplicate, type DocsAgentFeedbackEvaluationRegression, type DocsAgentFeedbackEvaluationRegressionReport, type DocsAgentFeedbackEvaluationTaskBaseline, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentGoldenAnswerExpectation, type DocsAgentGoldenAuthenticatedContentExpectation, type DocsAgentGoldenExampleVerification, type DocsAgentGoldenExpectedExample, type DocsAgentGoldenFreshnessExpectation, type DocsAgentGoldenPromptInjectionExpectation, type DocsAgentGoldenQueryVariant, type DocsAgentGoldenQueryVariantKind, type DocsAgentGoldenSafetyExpectation, type DocsAgentGoldenTask, type DocsAgentGoldenTaskExpectation, type DocsAgentGoldenTaskFilters, type DocsAgentMaintenanceIssueDraft, type DocsAgentMaintenanceProposal, type DocsAgentMaintenanceProposalReport, type DocsAgentMaintenanceSeverity, type DocsAgentMaintenanceSignal, type DocsAgentMaintenanceSignalSource, type DocsAgentSkillFrontmatter, DocsAgentSkillFrontmatterError, type DocsAgentSkillFrontmatterField, type DocsAgentSkillFrontmatterIssue, type DocsAgentSkillFrontmatterValidation, type DocsAgentSkillFrontmatterValidationOptions, type DocsAgentSkillIndexEntry, type DocsAgentSkillsCompatibilityPolicy, type DocsAgentSkillsConfig, type DocsAgentSkillsIndex, type DocsAgentSkillsInput, type DocsAgentSkillsProgressiveDisclosureConfig, 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 DocsApiCatalogApiTarget, type DocsApiCatalogLinkContext, type DocsApiCatalogLinkTarget, type DocsApiCatalogOpenApiDefinition, type DocsApiCatalogOptions, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsAudienceMdxIssue, type DocsCacheableResponseOptions, 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 DocsContentChangeDocument, type DocsContentChangeFeed, type DocsContentChangeHydrationBudget, type DocsContentChangeHydrationContent, type DocsContentChangeHydrationResponse, type DocsContentChangeHydrationSection, type DocsContentChangeHydrationTombstone, type DocsContentChangeSnapshotContext, type DocsContentChangeSnapshotLoader, type DocsContentChangeSnapshotSaver, type DocsContentChangedDocument, type DocsContentChangesRequest, DocsContentChangesRequestError, type DocsContentChangesResponse, type DocsContentSnapshot, type DocsContentSnapshotDocument, type DocsDiagnostics, type DocsDiagnosticsFeature, type DocsDiagnosticsIssue, type DocsDiagnosticsIssueSeverity, type DocsDiagnosticsOptions, type DocsDiagnosticsStatus, type DocsDiscoveryApiRouteOptions, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsJsonBodyResult, type DocsLlmsDiscoveryConfig, type DocsLlmsTxtGeneratedContent, type DocsLlmsTxtGeneratedSection, type DocsLlmsTxtMaxCharsIssue, type DocsLlmsTxtPageInput, type DocsLlmsTxtRequest, type DocsLlmsTxtResolvedMaxChars, type DocsLlmsTxtResolvedSection, type DocsLlmsTxtSelectedContent, type DocsLocalMcpSearchRuntimeConfig, type DocsLocalMcpSearchRuntimeInput, type DocsMarkdownAgentDetection, type DocsMarkdownHeadingAnchor, type DocsMarkdownPage, type DocsMarkdownRecoveryMatch, type DocsMarkdownRecoveryResult, type DocsMarkdownResponseOptions, type DocsMarkdownSection, type DocsMarkdownSectionIndex, type DocsMarkdownSectionIndexOptions, type DocsMarkdownSectionMetadata, type DocsMarkdownSectionRequest, type DocsMarkdownSectionResult, type DocsMcpAllowedOrigins, type DocsMcpAuthPrincipal, type DocsMcpAuthenticate, type DocsMcpAuthenticateContext, type DocsMcpAuthenticateResult, type DocsMcpConfig, type DocsMcpCorsConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpOriginContext, type DocsMcpPromptsConfig, type DocsMcpProtectedResourceConfig, type DocsMcpSecurityConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOkfActorTimestamp, type DocsOkfBundle, type DocsOkfConfig, type DocsOkfKnowledgeDocument, type DocsOkfPageLike, type DocsOkfResolvedConfig, type DocsOkfSource, type DocsOkfStatus, type DocsOkfTrustMetadata, type DocsOkfTrustMetadataInput, type DocsOkfTrustTier, type DocsOpenApiDiscoveryConfig, type DocsOpenApiMcpConfig, type DocsOpenApiMcpCredentialContext, type DocsOpenApiMcpHeaders, type DocsOpenApiMcpOperation, type DocsOpenApiMcpParameter, type DocsOpenApiResolvedDiscoveryConfig, type DocsOpenApiVersionDiscoveryConfig, type DocsPageAccessPolicy, type DocsPageStructuredDataInput, type DocsPaginatedSearchResponse, DocsPaginationCursorError, type DocsPathMatch, type DocsPublishedAgentSkill, type DocsPublishedAgentSkillFile, type DocsPublishedAgentSkillOptions, type DocsRelatedItem, type DocsRenderedHeadingAnchorOptions, type DocsResolvedContentChangesConfig, type DocsRetrievalSourceProvenance, type DocsRetrievalSourceScope, type DocsReviewCiConfig, type DocsReviewCiMode, type DocsReviewConfig, type DocsReviewRulesConfig, type DocsReviewScoreConfig, type DocsReviewSeverity, type DocsRobotsAnalysis, type DocsRobotsAnalysisOptions, type DocsRobotsConfig, type DocsRobotsRenderOptions, type DocsRobotsResolvedConfig, type DocsRobotsRule, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchAdapterPage, type DocsSearchAmbiguityDecision, type DocsSearchAmbiguityDecisionStatus, type DocsSearchAmbiguityResolution, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchExplanation, type DocsSearchFacet, type DocsSearchFacetValue, type DocsSearchFacetsResponse, type DocsSearchFilterDecision, type DocsSearchFilterDecisionOutcome, type DocsSearchFilterField, type DocsSearchFilterInput, type DocsSearchFilters, type DocsSearchMatchField, type DocsSearchMatchedTerm, type DocsSearchQuery, type DocsSearchRankingReason, type DocsSearchRankingReasonCode, type DocsSearchRankingStrategy, type DocsSearchRequest, DocsSearchRequestError, type DocsSearchRequestResolutionOptions, type DocsSearchResponse, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsSearchWarning, type DocsSearchWarningCode, 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 DocsTelemetryPageViewContext, type DocsTheme, type EnrichDocsSearchDocumentsWithProvenanceOptions, type FeedbackConfig, type FontStyle, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, type GeneratedAgentProvenance, type GeneratedAgentSourceKind, type GithubConfig, type HydrateDocsContentChangesOptions, type LastUpdatedConfig, type LlmsTxtConfig, type LlmsTxtMaxCharsConfig, type LlmsTxtMaxCharsMode, type LlmsTxtSectionConfig, MAX_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, MIN_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET, 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 PageActionConnectMcpConfig, type PageActionInstallSkillsConfig, type PageActionMcpProvider, type PageActionsConfig, type PageAgentAppliesTo, type PageAgentCommand, type PageAgentFailureMode, type PageAgentFrontmatter, type PageAgentFrontmatterIssue, type PageAgentVerification, type PageFrontmatter, type PageOpenGraph, type PageSidebarFrontmatter, type PageTwitter, type PerformDocsSearchOptions, type PromptAction, type PromptProviderChoice, type ReadingTimeConfig, type ReadingTimeFormat, type ResolveDocsContentChangesOptions, 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, analyzeDocsAgentMaintenanceSignals, analyzeDocsRobotsTxt, appendDocsDiscoveryLinkHeader, applyDocsMarkdownHeadingAnchors, applySidebarFolderIndexBehavior, buildDocsA2AAgentCard, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackEvaluationCandidates, buildDocsAgentFeedbackSchema, buildDocsAgentSkillsIndex, buildDocsApiCatalog, buildDocsAskAIContext, buildDocsConfigMap, buildDocsContentSnapshot, buildDocsDiagnostics, buildDocsLegacySkillsIndex, buildDocsMarkdownSectionIndex, buildDocsMcpEndpointCandidates, buildDocsMcpProtectedResourceMetadataRoute, buildDocsOkfBundle, buildDocsPageStructuredData, buildDocsRetrievalDigestProjection, buildDocsSearchDocuments, buildDocsSearchFacets, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, cleanDocsRenderedHeadingLabel, collectDocsMarkdownSections, compactDocsAgentDiscoverySpec, compareDocsAgentFeedbackEvaluationBaseline, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentFeedbackEvaluationBaseline, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCacheableResponse, createDocsContentChangeFeed, createDocsContentChangesHttpResponse, createDocsMarkdownHeadingAnchorResolver, createDocsMarkdownResponse, createDocsRenderedHeadingAnchorResolver, createDocsRobotsResponse, createDocsSitemapResponse, createDocsStandardsDiscoveryResponse, createDocsStandardsResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, digestDocsContent, digestDocsRetrievalContent, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryPageViewEvent, emitDocsTelemetryProjectEvent, encodeDocsHeadingTocUrls, enrichDocsSearchDocumentsWithProvenance, estimateReadingTimeMinutes, extendTheme, filterDocsPagesByAccess, findDocsAudienceMdxIssues, findDocsMarkdownPage, formatDocsAskAIPackageHints, formatDocsContentDigest, formatDocsLastModifiedDate, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsMcpProtectedResourceMetadataRoutes, getDocsMcpResourcePaths, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasDocsMcpProtectedResourceConfig, hasStructuredPageAgentContract, hashGeneratedAgentContent, hydrateDocsContentChanges, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentPageAccessible, isDocsAgentSkillName, isDocsAgentsRequest, isDocsConfigRequest, isDocsContentChangeGeneration, isDocsContentChangesRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMarkdownSectionIndexRequest, isDocsMcpRequest, isDocsPageAccessAllowed, isDocsPublicGetRequest, isDocsRetrievalCanonicalUrl, isDocsSkillRequest, isDocsStandardsDiscoveryRequest, isLocalDocsTelemetryOrigin, isolateDocsMarkdownPromptReferences, matchesDocsLlmsTxtSection, normalizeDocsOkfTrustMetadataInput, normalizeDocsPageAccessPolicy, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsSearchFilters, normalizeDocsTelemetryOrigin, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseDocsAgentMaintenanceSignals, parseDocsAgentSkillFrontmatter, parseGeneratedAgentDocument, performDocsSearch, performDocsSearchWithMetadata, readDocsJsonBody, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, requestHasFreshDocsDate, requestMatchesDocsEtag, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsAudienceExposure, resolveDocsAudienceMdxContent, resolveDocsContentChangesConfig, resolveDocsContentChangesRequest, resolveDocsDiscoveryApiRoute, resolveDocsHttpDate, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMarkdownSectionRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOkfConfig, resolveDocsOkfTrustMetadata, resolveDocsOpenApiDiscoveryConfig, resolveDocsOpenApiMcpBaseUrl, resolveDocsOpenApiMcpOperations, resolveDocsPath, resolveDocsPublishedAgentSkill, resolveDocsRequestApiRoute, resolveDocsRetrievalLastModified, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSearchAudience, resolveDocsSearchError, resolveDocsSearchFilters, resolveDocsSearchRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsStandardsDiscoveryRequest, resolveDocsTelemetryConfig, resolveLocalDocsMcpSearchConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, selectDocsMarkdownSection, serializeGeneratedAgentDocument, sha256DocsContent, sha256DocsDiscoveryContent, slugifyDocsMarkdownHeading, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload, validateDocsAgentSkillFrontmatter, withDocsMarkdownRenderableHeadings, withDocsOpenApiOperationCounts };
|