@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
|
@@ -1,75 +1,14 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { DocsAccessPrincipal, DocsAgentContentChangesConfig, DocsAgentFeedbackData, DocsConfig, DocsOkfConfig, DocsOkfTrustMetadataInput, DocsPageAccessPolicy, DocsRobotsConfig, DocsSearchConfig, DocsSearchSourcePage, DocsSitemapConfig, FeedbackConfig, LlmsTxtConfig, LlmsTxtMaxCharsConfig, LlmsTxtMaxCharsMode, LlmsTxtSectionConfig, PageAgentFrontmatter, ResolvedDocsRelatedLink } from "./types.mjs";
|
|
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 { 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, DocsLegacySkillsIndex, DocsPublishedAgentSkill, DocsPublishedAgentSkillFile, DocsPublishedAgentSkillOptions, DocsStandardsDiscoveryRequest, DocsStandardsDiscoveryRouteOptions, appendDocsDiscoveryLinkHeader, buildDocsA2AAgentCard, buildDocsAgentSkillsIndex, buildDocsApiCatalog, buildDocsLegacySkillsIndex, createDocsStandardsResponse, getDocsAgentManifestLinkHeader, getDocsDiscoveryLinkHeader, isDocsStandardsDiscoveryRequest, resolveDocsDiscoveryApiRoute, resolveDocsPublishedAgentSkill, resolveDocsStandardsDiscoveryRequest, sha256DocsDiscoveryContent } from "./standards-discovery.mjs";
|
|
4
|
+
import { resolveDocsAudienceExposure } from "./audience-exposure.mjs";
|
|
5
|
+
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";
|
|
6
|
+
import { ResolvedDocsI18n } from "./i18n.mjs";
|
|
7
|
+
import { normalizeDocsUrlPath, toDocsMarkdownUrl } from "./urls.mjs";
|
|
8
|
+
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";
|
|
9
|
+
import { findDocsAudienceMdxIssues, resolveDocsAgentMdxContent, resolveDocsAudienceMdxContent } from "./audience.mjs";
|
|
4
10
|
import { DocsMcpPage, DocsMcpResolvedConfig, DocsMcpResolvedPromptsConfig } from "./mcp.mjs";
|
|
5
11
|
|
|
6
|
-
//#region src/i18n.d.ts
|
|
7
|
-
interface ResolvedDocsI18n {
|
|
8
|
-
locales: string[];
|
|
9
|
-
defaultLocale: string;
|
|
10
|
-
}
|
|
11
|
-
interface DocsPathMatch {
|
|
12
|
-
/** Slug path relative to the docs root (no leading slash). */
|
|
13
|
-
slug: string;
|
|
14
|
-
/** Entry path used for URLs (no locale segment). */
|
|
15
|
-
entryPath: string;
|
|
16
|
-
}
|
|
17
|
-
declare function resolveDocsI18n(config?: DocsI18nConfig | null): ResolvedDocsI18n | null;
|
|
18
|
-
declare function resolveDocsLocale(searchParams: URLSearchParams, i18n?: ResolvedDocsI18n | null): string | undefined;
|
|
19
|
-
declare function resolveDocsPath(pathname: string, entry: string): DocsPathMatch;
|
|
20
|
-
//#endregion
|
|
21
|
-
//#region src/mcp-auth.d.ts
|
|
22
|
-
declare const DEFAULT_MCP_ROUTE = "/api/docs/mcp";
|
|
23
|
-
declare const DEFAULT_MCP_PUBLIC_ROUTE = "/mcp";
|
|
24
|
-
declare const DEFAULT_MCP_WELL_KNOWN_ROUTE = "/.well-known/mcp";
|
|
25
|
-
declare const DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE = "/.well-known/oauth-protected-resource";
|
|
26
|
-
declare function getDocsMcpResourcePaths(route?: string): string[];
|
|
27
|
-
declare function buildDocsMcpProtectedResourceMetadataRoute(resourcePath: string): string;
|
|
28
|
-
declare function getDocsMcpProtectedResourceMetadataRoutes(route?: string): string[];
|
|
29
|
-
declare function hasDocsMcpProtectedResourceConfig(mcp?: boolean | DocsMcpConfig): boolean;
|
|
30
|
-
declare function isDocsMcpRequest(url: URL, mcp?: boolean | DocsMcpConfig): boolean;
|
|
31
|
-
//#endregion
|
|
32
|
-
//#region src/audience.d.ts
|
|
33
|
-
interface DocsMarkdownPromptBlock {
|
|
34
|
-
/** Raw JSX attributes between the Prompt name and opening bracket. */
|
|
35
|
-
attributes: string;
|
|
36
|
-
/** Literal source between the Prompt tags, with enclosing Markdown container prefixes removed. */
|
|
37
|
-
children: string;
|
|
38
|
-
/** Collision-safe placeholder carried through document-level rendering. */
|
|
39
|
-
token: string;
|
|
40
|
-
}
|
|
41
|
-
interface ExtractedDocsMarkdownPromptBlocks {
|
|
42
|
-
blocks: DocsMarkdownPromptBlock[];
|
|
43
|
-
markdown: string;
|
|
44
|
-
}
|
|
45
|
-
interface DocsAudienceMdxIssue {
|
|
46
|
-
code: "missing-only" | "invalid-only" | "dynamic-only" | "ignored-agent-only" | "ignored-human-only";
|
|
47
|
-
index: number;
|
|
48
|
-
message: string;
|
|
49
|
-
}
|
|
50
|
-
/**
|
|
51
|
-
* Extract live MDX Prompt blocks while leaving Markdown literals untouched.
|
|
52
|
-
*
|
|
53
|
-
* Prompt bodies are copyable source, so callers can safely run audience,
|
|
54
|
-
* reference-definition, and heading passes over `markdown`, then restore each
|
|
55
|
-
* block from its token. Fences (including container fences), inline code, links,
|
|
56
|
-
* comments, raw elements, and other literal contexts are never extracted.
|
|
57
|
-
*/
|
|
58
|
-
declare function extractDocsMarkdownPromptBlocks(content: string): ExtractedDocsMarkdownPromptBlocks;
|
|
59
|
-
/** Find audience declarations that cannot be projected consistently at build time. */
|
|
60
|
-
declare function findDocsAudienceMdxIssues(content: string): DocsAudienceMdxIssue[];
|
|
61
|
-
/**
|
|
62
|
-
* Resolve MDX into its human or agent projection.
|
|
63
|
-
*
|
|
64
|
-
* `<Agent>` is shorthand for `<Audience only="agent">`, while `<Human>` is
|
|
65
|
-
* shorthand for `<Audience only="human">`. Unknown `Audience.only` values are
|
|
66
|
-
* treated as shared content so an authoring typo never silently deletes content.
|
|
67
|
-
* These primitives shape content for each surface; they are not an access-control boundary.
|
|
68
|
-
*/
|
|
69
|
-
declare function resolveDocsAudienceMdxContent(content: string, audience: DocsContentAudience): string;
|
|
70
|
-
/** Backwards-compatible name retained for existing integrations. */
|
|
71
|
-
declare function resolveDocsAgentMdxContent(content: string, audience: DocsContentAudience): string;
|
|
72
|
-
//#endregion
|
|
73
12
|
//#region src/agent.d.ts
|
|
74
13
|
declare const DEFAULT_DOCS_API_ROUTE = "/api/docs";
|
|
75
14
|
declare const DEFAULT_DOCS_CONFIG_FORMAT = "docs-config-map.v1";
|
|
@@ -95,9 +34,6 @@ declare const DEFAULT_AGENT_FEEDBACK_ROUTE = "/api/docs/agent/feedback";
|
|
|
95
34
|
declare const DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA: Record<string, unknown>;
|
|
96
35
|
declare const DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER = "Signature-Agent";
|
|
97
36
|
declare const DOCS_MARKDOWN_SECTION_INDEX_FORMAT = "docs-markdown-sections.v2";
|
|
98
|
-
declare const DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN: string;
|
|
99
|
-
declare const DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN: string;
|
|
100
|
-
declare const DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN: string;
|
|
101
37
|
interface DocsMcpEndpointCandidate {
|
|
102
38
|
baseUrl: string;
|
|
103
39
|
route: string;
|
|
@@ -559,7 +495,6 @@ interface DocsMarkdownResponseOptions extends DocsMarkdownNotFoundOptions {
|
|
|
559
495
|
principal?: DocsAccessPrincipal;
|
|
560
496
|
}
|
|
561
497
|
declare function normalizeDocsPathSegment(value: string): string;
|
|
562
|
-
declare function normalizeDocsUrlPath(value: string): string;
|
|
563
498
|
declare function isDocsConfigRequest(url: URL): boolean;
|
|
564
499
|
declare function isDocsDiagnosticsRequest(url: URL): boolean;
|
|
565
500
|
/** Prefer an explicitly configured API route; otherwise infer a query-form route from the request. */
|
|
@@ -579,9 +514,6 @@ declare function parseDocsAgentFeedbackData(request: Request): Promise<{
|
|
|
579
514
|
response: Response;
|
|
580
515
|
}>;
|
|
581
516
|
declare function validateDocsAgentFeedbackPayload(value: unknown, schema: Record<string, unknown>, valuePath?: string): string | undefined;
|
|
582
|
-
declare function toDocsMarkdownUrl(url: string, options?: {
|
|
583
|
-
locale?: string;
|
|
584
|
-
}): string;
|
|
585
517
|
declare function resolveDocsMarkdownCanonicalUrl({
|
|
586
518
|
origin,
|
|
587
519
|
entry,
|
|
@@ -1045,337 +977,4 @@ declare function resolveDocsOpenApiDiscoveryConfig(openapi?: boolean | DocsOpenA
|
|
|
1045
977
|
/** Attach operation totals from the same normalized pages used by search and Markdown. */
|
|
1046
978
|
declare function withDocsOpenApiOperationCounts(openapi: boolean | DocsOpenApiDiscoveryConfig | undefined, operationPages: readonly DocsSearchSourcePage[]): DocsOpenApiResolvedDiscoveryConfig;
|
|
1047
979
|
//#endregion
|
|
1048
|
-
|
|
1049
|
-
interface DocsAskAIContextResult extends DocsSearchResult {
|
|
1050
|
-
title: string;
|
|
1051
|
-
contextContent: string;
|
|
1052
|
-
}
|
|
1053
|
-
interface DocsAskAIContext {
|
|
1054
|
-
context: string;
|
|
1055
|
-
/** Structured production context blocks; avoids reparsing markdown horizontal rules. */
|
|
1056
|
-
blocks: Array<{
|
|
1057
|
-
text: string;
|
|
1058
|
-
result: DocsAskAIContextResult;
|
|
1059
|
-
}>;
|
|
1060
|
-
results: DocsAskAIContextResult[];
|
|
1061
|
-
searchResults: DocsSearchResult[];
|
|
1062
|
-
packageHints: DocsAskAIPackageHints;
|
|
1063
|
-
}
|
|
1064
|
-
interface DocsAskAIPackageHints {
|
|
1065
|
-
packages: string[];
|
|
1066
|
-
imports: string[];
|
|
1067
|
-
installCommands: string[];
|
|
1068
|
-
}
|
|
1069
|
-
/** Normalize scalar or array-valued scope filters for programmatic, HTTP, and MCP callers. */
|
|
1070
|
-
declare function normalizeDocsSearchFilters(input?: DocsSearchFilterInput | DocsSearchFilters): DocsSearchFilters;
|
|
1071
|
-
/** Parse the public search scope parameters from a URL query string. */
|
|
1072
|
-
declare function resolveDocsSearchFilters(searchParams: URLSearchParams): DocsSearchFilters;
|
|
1073
|
-
declare class DocsSearchRequestError extends Error {
|
|
1074
|
-
readonly code = "invalid_search_request";
|
|
1075
|
-
constructor(message: string);
|
|
1076
|
-
}
|
|
1077
|
-
declare function resolveDocsSearchError(error: unknown): {
|
|
1078
|
-
code: "invalid_cursor" | "invalid_search_request";
|
|
1079
|
-
message: string;
|
|
1080
|
-
} | undefined;
|
|
1081
|
-
/** Resolve search filters and the backwards-compatible structured response opt-in. */
|
|
1082
|
-
declare function resolveDocsSearchRequest(searchParams: URLSearchParams): DocsSearchRequest;
|
|
1083
|
-
declare function inferDocsAskAIPackageHints(content: string): DocsAskAIPackageHints;
|
|
1084
|
-
declare function formatDocsAskAIPackageHints(hints: DocsAskAIPackageHints, packageName?: string): string | undefined;
|
|
1085
|
-
/**
|
|
1086
|
-
* Build the exact normalized-input projection represented by a retrieval source digest.
|
|
1087
|
-
* This is public so consumers can independently reproduce `source.digest`.
|
|
1088
|
-
*/
|
|
1089
|
-
declare function buildDocsRetrievalDigestProjection(page: DocsSearchSourcePage, audience?: DocsContentAudience): string;
|
|
1090
|
-
declare function resolveDocsRetrievalLastModified(page: DocsSearchSourcePage, audience: DocsContentAudience): string | undefined;
|
|
1091
|
-
interface BuildDocsContentSnapshotOptions {
|
|
1092
|
-
pages: readonly DocsSearchSourcePage[];
|
|
1093
|
-
search?: boolean | DocsSearchConfig;
|
|
1094
|
-
audience?: DocsContentAudience;
|
|
1095
|
-
locale?: string;
|
|
1096
|
-
baseUrl?: string;
|
|
1097
|
-
/** @internal Precomputed complete-corpus generation for composed callers. */
|
|
1098
|
-
indexGeneration?: string;
|
|
1099
|
-
/** Authenticated identity used to scope protected pages. */
|
|
1100
|
-
principal?: DocsAccessPrincipal;
|
|
1101
|
-
}
|
|
1102
|
-
/**
|
|
1103
|
-
* Build a deterministic, body-free inventory for content-change synchronization.
|
|
1104
|
-
*
|
|
1105
|
-
* Its generation is identical to structured search for the same pages, audience,
|
|
1106
|
-
* locale, base URL, and chunking policy.
|
|
1107
|
-
*/
|
|
1108
|
-
declare function buildDocsContentSnapshot(options: BuildDocsContentSnapshotOptions): Promise<DocsContentSnapshot>;
|
|
1109
|
-
interface EnrichDocsSearchDocumentsWithProvenanceOptions {
|
|
1110
|
-
documents: readonly DocsSearchDocument[];
|
|
1111
|
-
pages: readonly DocsSearchSourcePage[];
|
|
1112
|
-
audience?: DocsContentAudience;
|
|
1113
|
-
chunking?: DocsSearchChunkingConfig;
|
|
1114
|
-
locale?: string;
|
|
1115
|
-
baseUrl?: string;
|
|
1116
|
-
indexGeneration?: string;
|
|
1117
|
-
}
|
|
1118
|
-
/**
|
|
1119
|
-
* Attach the same canonical provenance used by built-in search providers.
|
|
1120
|
-
* Custom adapters can call this before persisting their own hosted records.
|
|
1121
|
-
*/
|
|
1122
|
-
declare function enrichDocsSearchDocumentsWithProvenance(options: EnrichDocsSearchDocumentsWithProvenanceOptions): Promise<DocsSearchDocument[]>;
|
|
1123
|
-
declare function buildDocsSearchDocuments(pages: DocsSearchSourcePage[], chunking?: DocsSearchChunkingConfig, audience?: DocsContentAudience): DocsSearchDocument[];
|
|
1124
|
-
declare function createSimpleSearchAdapter(): DocsSearchAdapter;
|
|
1125
|
-
declare function createTypesenseSearchAdapter(config: TypesenseDocsSearchConfig): DocsSearchAdapter;
|
|
1126
|
-
declare function resolveSearchRequestConfig(search: boolean | DocsSearchConfig | undefined, requestUrl?: string, options?: DocsSearchRequestResolutionOptions): boolean | DocsSearchConfig | undefined;
|
|
1127
|
-
interface DocsLocalMcpSearchRuntimeConfig {
|
|
1128
|
-
enabled?: boolean;
|
|
1129
|
-
route?: string;
|
|
1130
|
-
tools?: {
|
|
1131
|
-
searchDocs?: boolean;
|
|
1132
|
-
};
|
|
1133
|
-
}
|
|
1134
|
-
type DocsLocalMcpSearchRuntimeInput = boolean | DocsLocalMcpSearchRuntimeConfig | null | undefined;
|
|
1135
|
-
interface DocsSearchRequestResolutionOptions {
|
|
1136
|
-
/**
|
|
1137
|
-
* The built-in MCP server colocated with this search handler. When the configured
|
|
1138
|
-
* provider points at one of its local aliases, search runs directly instead of
|
|
1139
|
-
* performing a loopback MCP handshake.
|
|
1140
|
-
*/
|
|
1141
|
-
localMcp?: DocsLocalMcpSearchRuntimeInput;
|
|
1142
|
-
}
|
|
1143
|
-
declare function resolveLocalDocsMcpSearchConfig(search: boolean | DocsSearchConfig | undefined, localMcp: DocsLocalMcpSearchRuntimeInput, requestUrl?: string): boolean | DocsSearchConfig | undefined;
|
|
1144
|
-
/**
|
|
1145
|
-
* Resolve the public search audience without allowing malformed values to opt into agent content.
|
|
1146
|
-
* Human search remains the default for omitted, legacy, and unknown query values.
|
|
1147
|
-
*/
|
|
1148
|
-
declare function resolveDocsSearchAudience(value: string | null | undefined): DocsContentAudience;
|
|
1149
|
-
declare function resolveAskAISearchRequestConfig(options: {
|
|
1150
|
-
search: boolean | DocsSearchConfig | undefined;
|
|
1151
|
-
useMcp?: boolean | DocsAskAIMcpConfig;
|
|
1152
|
-
mcpEndpoint?: string;
|
|
1153
|
-
mcpEnabled?: boolean;
|
|
1154
|
-
mcpSearchEnabled?: boolean;
|
|
1155
|
-
requestUrl?: string;
|
|
1156
|
-
}): boolean | DocsSearchConfig | undefined;
|
|
1157
|
-
declare function createMcpSearchAdapter(config: McpDocsSearchConfig): DocsSearchAdapter;
|
|
1158
|
-
declare function createAlgoliaSearchAdapter(config: AlgoliaDocsSearchConfig): DocsSearchAdapter;
|
|
1159
|
-
interface PerformDocsSearchOptions {
|
|
1160
|
-
pages: DocsSearchSourcePage[];
|
|
1161
|
-
/** Authenticated identity used to scope protected pages before local or hosted indexing. */
|
|
1162
|
-
principal?: DocsAccessPrincipal;
|
|
1163
|
-
/** @internal Complete corpus used for generation when `pages` is pre-scoped by a caller. */
|
|
1164
|
-
generationPages?: DocsSearchSourcePage[];
|
|
1165
|
-
/** @internal Precomputed complete-corpus generation for structured callers. */
|
|
1166
|
-
indexGeneration?: string;
|
|
1167
|
-
query: string;
|
|
1168
|
-
search?: boolean | DocsSearchConfig;
|
|
1169
|
-
/** Selects which audience projection is searchable. Public site search defaults to human. */
|
|
1170
|
-
audience?: DocsContentAudience;
|
|
1171
|
-
locale?: string;
|
|
1172
|
-
pathname?: string;
|
|
1173
|
-
siteTitle?: string;
|
|
1174
|
-
/** Canonical docs URL used to distinguish same-site absolute hits from foreign MCP results. */
|
|
1175
|
-
baseUrl?: string;
|
|
1176
|
-
/**
|
|
1177
|
-
* Canonical origin safe to persist in a hosted index. Pass `null` when `baseUrl`
|
|
1178
|
-
* came from the current request rather than trusted configuration.
|
|
1179
|
-
* @internal
|
|
1180
|
-
*/
|
|
1181
|
-
syncBaseUrl?: string | null;
|
|
1182
|
-
limit?: number;
|
|
1183
|
-
/** Opaque continuation cursor used by structured search responses. */
|
|
1184
|
-
cursor?: string;
|
|
1185
|
-
/** Optional framework, version, package, and tag constraints. */
|
|
1186
|
-
filters?: DocsSearchFilterInput;
|
|
1187
|
-
/** Include bounded explanations for the final ranked results. Defaults to false. */
|
|
1188
|
-
explain?: boolean;
|
|
1189
|
-
/**
|
|
1190
|
-
* Controls provider failures. Runtime search keeps the resilient `fallback` default;
|
|
1191
|
-
* diagnostics can request `throw` so a broken configured provider cannot be scored as
|
|
1192
|
-
* successful simple search.
|
|
1193
|
-
*/
|
|
1194
|
-
failureMode?: "fallback" | "throw";
|
|
1195
|
-
/**
|
|
1196
|
-
* Whether non-simple provider hits are supplemented with exact/local simple results.
|
|
1197
|
-
* Runtime search defaults to true; provider diagnostics can disable supplementation.
|
|
1198
|
-
*/
|
|
1199
|
-
supplementExternalResults?: boolean;
|
|
1200
|
-
/** Keep absolute provider origins distinct when no canonical docs origin is available. */
|
|
1201
|
-
strictExternalOrigins?: boolean;
|
|
1202
|
-
/** Optional cancellation signal forwarded to adapters and their managed requests. */
|
|
1203
|
-
signal?: AbortSignal;
|
|
1204
|
-
}
|
|
1205
|
-
declare function performDocsSearch(options: PerformDocsSearchOptions): Promise<DocsSearchResult[]>;
|
|
1206
|
-
interface BuildDocsSearchFacetsOptions {
|
|
1207
|
-
pages: DocsSearchSourcePage[];
|
|
1208
|
-
search?: boolean | DocsSearchConfig;
|
|
1209
|
-
audience?: DocsContentAudience;
|
|
1210
|
-
locale?: string;
|
|
1211
|
-
baseUrl?: string;
|
|
1212
|
-
filters?: DocsSearchFilterInput;
|
|
1213
|
-
/** Facet field selected for cursor continuation. */
|
|
1214
|
-
facet?: DocsSearchFilterField;
|
|
1215
|
-
/** Opaque `nextCursor` returned for the selected facet. */
|
|
1216
|
-
cursor?: string;
|
|
1217
|
-
/** Maximum facet values returned per page. Defaults to 100. */
|
|
1218
|
-
limit?: number;
|
|
1219
|
-
/** @internal Precomputed complete-corpus generation for composed callers. */
|
|
1220
|
-
indexGeneration?: string;
|
|
1221
|
-
/** Authenticated identity used to scope protected pages. */
|
|
1222
|
-
principal?: DocsAccessPrincipal;
|
|
1223
|
-
}
|
|
1224
|
-
/**
|
|
1225
|
-
* Build a body-free index of valid search filter values and page counts.
|
|
1226
|
-
*
|
|
1227
|
-
* Each facet applies filters from the other fields while ignoring its own selected
|
|
1228
|
-
* values. This is the conventional faceted-search behavior and lets an agent discover
|
|
1229
|
-
* safe alternatives without guessing or fetching document bodies.
|
|
1230
|
-
*/
|
|
1231
|
-
declare function buildDocsSearchFacets(options: BuildDocsSearchFacetsOptions): Promise<DocsSearchFacetsResponse>;
|
|
1232
|
-
declare function performDocsSearchWithMetadata(options: PerformDocsSearchOptions): Promise<DocsPaginatedSearchResponse>;
|
|
1233
|
-
declare function buildDocsAskAIContext(options: {
|
|
1234
|
-
pages: DocsSearchSourcePage[];
|
|
1235
|
-
query: string;
|
|
1236
|
-
search?: boolean | DocsSearchConfig;
|
|
1237
|
-
locale?: string;
|
|
1238
|
-
pathname?: string;
|
|
1239
|
-
siteTitle?: string;
|
|
1240
|
-
baseUrl?: string; /** See `performDocsSearch.syncBaseUrl`. */
|
|
1241
|
-
syncBaseUrl?: string | null;
|
|
1242
|
-
limit?: number;
|
|
1243
|
-
filters?: DocsSearchFilterInput;
|
|
1244
|
-
maxContextChars?: number;
|
|
1245
|
-
maxResultChars?: number; /** See `performDocsSearch.failureMode`. Defaults to resilient runtime fallback. */
|
|
1246
|
-
searchFailureMode?: "fallback" | "throw"; /** See `performDocsSearch.strictExternalOrigins`. */
|
|
1247
|
-
strictExternalOrigins?: boolean; /** Optional cancellation signal forwarded to the configured search provider. */
|
|
1248
|
-
signal?: AbortSignal;
|
|
1249
|
-
}): Promise<DocsAskAIContext>;
|
|
1250
|
-
declare function createCustomSearchAdapter(adapter: DocsSearchAdapter | DocsSearchAdapterFactory, options?: {
|
|
1251
|
-
paginationRevision?: string;
|
|
1252
|
-
}): CustomDocsSearchConfig;
|
|
1253
|
-
//#endregion
|
|
1254
|
-
//#region src/content-changes.d.ts
|
|
1255
|
-
declare const DOCS_CONTENT_CHANGES_FORMAT = "docs-content-changes.v1";
|
|
1256
|
-
declare const DOCS_CONTENT_SNAPSHOT_FORMAT = "docs-content-snapshot.v1";
|
|
1257
|
-
declare const DOCS_CONTENT_CHANGES_RESPONSE_VALUE = "changes";
|
|
1258
|
-
/** Whether a value is a valid content-index generation identifier. */
|
|
1259
|
-
declare function isDocsContentChangeGeneration(value: string): boolean;
|
|
1260
|
-
interface DocsContentChangesRequest {
|
|
1261
|
-
audience: "human" | "agent";
|
|
1262
|
-
since?: string;
|
|
1263
|
-
}
|
|
1264
|
-
interface DocsResolvedContentChangesConfig {
|
|
1265
|
-
enabled: boolean;
|
|
1266
|
-
maxSnapshots: number;
|
|
1267
|
-
loadSnapshot?: DocsAgentContentChangesConfig["loadSnapshot"];
|
|
1268
|
-
saveSnapshot?: DocsAgentContentChangesConfig["saveSnapshot"];
|
|
1269
|
-
}
|
|
1270
|
-
interface ResolveDocsContentChangesOptions extends Omit<BuildDocsContentSnapshotOptions, "pages"> {
|
|
1271
|
-
pages: readonly DocsSearchSourcePage[];
|
|
1272
|
-
since?: string;
|
|
1273
|
-
request?: Request;
|
|
1274
|
-
}
|
|
1275
|
-
interface DocsContentChangeFeed {
|
|
1276
|
-
resolve(options: ResolveDocsContentChangesOptions): Promise<DocsContentChangesResponse>;
|
|
1277
|
-
}
|
|
1278
|
-
declare class DocsContentChangesRequestError extends Error {
|
|
1279
|
-
readonly code = "invalid_content_changes_request";
|
|
1280
|
-
constructor(message: string);
|
|
1281
|
-
}
|
|
1282
|
-
declare function resolveDocsContentChangesConfig(input?: boolean | DocsAgentContentChangesConfig, options?: {
|
|
1283
|
-
staticExport?: boolean;
|
|
1284
|
-
}): DocsResolvedContentChangesConfig;
|
|
1285
|
-
declare function isDocsContentChangesRequest(url: URL): boolean;
|
|
1286
|
-
declare function resolveDocsContentChangesRequest(url: URL): DocsContentChangesRequest;
|
|
1287
|
-
declare function createDocsContentChangeFeed(input?: boolean | DocsAgentContentChangesConfig): DocsContentChangeFeed;
|
|
1288
|
-
declare function createDocsContentChangesHttpResponse(options: {
|
|
1289
|
-
request: Request;
|
|
1290
|
-
feed: DocsContentChangeFeed;
|
|
1291
|
-
pages: readonly DocsSearchSourcePage[];
|
|
1292
|
-
search?: boolean | DocsSearchConfig;
|
|
1293
|
-
locale?: string;
|
|
1294
|
-
baseUrl?: string;
|
|
1295
|
-
}): Promise<Response>;
|
|
1296
|
-
//#endregion
|
|
1297
|
-
//#region src/content-change-hydration.d.ts
|
|
1298
|
-
declare const DOCS_CONTENT_CHANGE_HYDRATION_FORMAT = "docs-content-change-hydration.v1";
|
|
1299
|
-
declare const DEFAULT_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET = 5000;
|
|
1300
|
-
declare const MIN_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET = 4;
|
|
1301
|
-
declare const MAX_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET = 32000;
|
|
1302
|
-
interface DocsContentChangeHydrationSection {
|
|
1303
|
-
id: string;
|
|
1304
|
-
heading: string;
|
|
1305
|
-
level: number;
|
|
1306
|
-
}
|
|
1307
|
-
interface DocsContentChangeHydrationContent {
|
|
1308
|
-
type: "content";
|
|
1309
|
-
change: "added" | "changed";
|
|
1310
|
-
url: string;
|
|
1311
|
-
canonicalUrl: string;
|
|
1312
|
-
/** Digest from the body-free document change feed. */
|
|
1313
|
-
digest: string;
|
|
1314
|
-
previousDigest?: string;
|
|
1315
|
-
lastModified?: string;
|
|
1316
|
-
previousLastModified?: string;
|
|
1317
|
-
section: DocsContentChangeHydrationSection;
|
|
1318
|
-
/** Digest of the complete, non-overlapping section before chunking. */
|
|
1319
|
-
sectionDigest: string;
|
|
1320
|
-
/** Digest of the content bytes returned in this chunk. */
|
|
1321
|
-
chunkDigest: string;
|
|
1322
|
-
chunk: {
|
|
1323
|
-
index: number;
|
|
1324
|
-
count: number;
|
|
1325
|
-
};
|
|
1326
|
-
content: string;
|
|
1327
|
-
utf8Bytes: number;
|
|
1328
|
-
}
|
|
1329
|
-
interface DocsContentChangeHydrationTombstone {
|
|
1330
|
-
type: "tombstone";
|
|
1331
|
-
change: "deleted";
|
|
1332
|
-
url: string;
|
|
1333
|
-
canonicalUrl: string;
|
|
1334
|
-
/** Last known digest for the deleted document. */
|
|
1335
|
-
digest: string;
|
|
1336
|
-
lastModified?: string;
|
|
1337
|
-
}
|
|
1338
|
-
interface DocsContentChangeHydrationBudget {
|
|
1339
|
-
requestedTokens: number;
|
|
1340
|
-
strategy: "utf8-bytes";
|
|
1341
|
-
maxUtf8Bytes: number;
|
|
1342
|
-
usedUtf8Bytes: number;
|
|
1343
|
-
conservativeTokenUpperBound: number;
|
|
1344
|
-
remainingUtf8Bytes: number;
|
|
1345
|
-
}
|
|
1346
|
-
interface DocsContentChangeHydrationResponse {
|
|
1347
|
-
format: typeof DOCS_CONTENT_CHANGE_HYDRATION_FORMAT;
|
|
1348
|
-
audience: "agent";
|
|
1349
|
-
locale?: string;
|
|
1350
|
-
since: string;
|
|
1351
|
-
indexGeneration: string;
|
|
1352
|
-
mode: DocsContentChangesResponse["mode"];
|
|
1353
|
-
resetRequired: boolean;
|
|
1354
|
-
documentCount: number;
|
|
1355
|
-
counts: DocsContentChangesResponse["counts"];
|
|
1356
|
-
budget: DocsContentChangeHydrationBudget;
|
|
1357
|
-
resultCount: number;
|
|
1358
|
-
total: number;
|
|
1359
|
-
hasMore: boolean;
|
|
1360
|
-
nextCursor?: string;
|
|
1361
|
-
content: DocsContentChangeHydrationContent[];
|
|
1362
|
-
tombstones: DocsContentChangeHydrationTombstone[];
|
|
1363
|
-
}
|
|
1364
|
-
interface HydrateDocsContentChangesOptions {
|
|
1365
|
-
changes: DocsContentChangesResponse;
|
|
1366
|
-
pages: readonly DocsSearchSourcePage[];
|
|
1367
|
-
since: string;
|
|
1368
|
-
tokenBudget?: number;
|
|
1369
|
-
cursor?: string;
|
|
1370
|
-
/** Stable MCP server identity mixed into opaque continuation cursors. */
|
|
1371
|
-
cursorScope: string;
|
|
1372
|
-
}
|
|
1373
|
-
/**
|
|
1374
|
-
* Hydrate only the current bodies named by a content-change delta.
|
|
1375
|
-
*
|
|
1376
|
-
* The conservative budget treats one UTF-8 byte as at most one token. Cursors are
|
|
1377
|
-
* bound to the requested generation, current generation, locale, and budget.
|
|
1378
|
-
*/
|
|
1379
|
-
declare function hydrateDocsContentChanges(options: HydrateDocsContentChangesOptions): DocsContentChangeHydrationResponse;
|
|
1380
|
-
//#endregion
|
|
1381
|
-
export { resolveDocsSearchError as $, resolveDocsAgentContractMcpTools as $n, DocsLlmsTxtResolvedSection as $t, DocsSearchRequestError as A, detectDocsMarkdownAgentRequest as An, getDocsMcpProtectedResourceMetadataRoutes as Ar, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN as At, createCustomSearchAdapter as B, isDocsLlmsTxtPublicRequest as Bn, DocsDiagnostics as Bt, isDocsContentChangesRequest as C, buildDocsDiagnostics as Cn, resolveDocsAgentMdxContent as Cr, DEFAULT_OPENAPI_SCHEMA_ROUTE as Ct, BuildDocsSearchFacetsOptions as D, compactDocsAgentDiscoverySpec as Dn, DEFAULT_MCP_ROUTE as Dr, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN as Dt, BuildDocsContentSnapshotOptions as E, collectDocsMarkdownSections as En, DEFAULT_MCP_PUBLIC_ROUTE as Er, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN as Et, buildDocsContentSnapshot as F, hasDocsMarkdownSignatureAgent as Fn, ResolvedDocsI18n as Fr, DocsAgentFeedbackResolvedConfig as Ft, formatDocsAskAIPackageHints as G, normalizeDocsPathSegment as Gn, DocsDiagnosticsStatus as Gt, createSimpleSearchAdapter as H, isDocsPublicGetRequest as Hn, DocsDiagnosticsIssue as Ht, buildDocsRetrievalDigestProjection as I, isDocsAgentDiscoveryRequest as In, resolveDocsI18n as Ir, DocsAgentsDocumentOptions as It, performDocsSearch as J, renderDocsAgentsDocument as Jn, DocsLlmsTxtGeneratedSection as Jt, inferDocsAskAIPackageHints as K, normalizeDocsUrlPath as Kn, DocsLlmsDiscoveryConfig as Kt, buildDocsSearchDocuments as L, isDocsAgentsRequest as Ln, resolveDocsLocale as Lr, DocsConfigMap as Lt, EnrichDocsSearchDocumentsWithProvenanceOptions as M, getDocsLlmsTxtMaxCharsIssue as Mn, hasDocsMcpProtectedResourceConfig as Mr, DocsAgentDiscoverySpecOptions as Mt, PerformDocsSearchOptions as N, getDocsMarkdownCanonicalLinkHeader as Nn, isDocsMcpRequest as Nr, DocsAgentFeedbackDiscoveryConfig as Nt, DocsLocalMcpSearchRuntimeConfig as O, createDocsMarkdownResponse as On, DEFAULT_MCP_WELL_KNOWN_ROUTE as Or, DOCS_MARKDOWN_SECTION_INDEX_FORMAT as Ot, buildDocsAskAIContext as P, getDocsMarkdownVaryHeader as Pn, DocsPathMatch as Pr, DocsAgentFeedbackRequest as Pt, resolveDocsSearchAudience as Q, renderDocsSkillDocument as Qn, DocsLlmsTxtResolvedMaxChars as Qt, buildDocsSearchFacets as R, isDocsConfigRequest as Rn, resolveDocsPath as Rr, DocsConfigMapJsonValue as Rt, isDocsContentChangeGeneration as S, buildDocsConfigMap as Sn, findDocsAudienceMdxIssues as Sr, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE as St, resolveDocsContentChangesRequest as T, buildDocsMcpEndpointCandidates as Tn, DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE as Tr, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE as Tt, createTypesenseSearchAdapter as U, isDocsSkillRequest as Un, DocsDiagnosticsIssueSeverity as Ut, createMcpSearchAdapter as V, isDocsMarkdownSectionIndexRequest as Vn, DocsDiagnosticsFeature as Vt, enrichDocsSearchDocumentsWithProvenance as W, matchesDocsLlmsTxtSection as Wn, DocsDiagnosticsOptions as Wt, resolveAskAISearchRequestConfig as X, renderDocsMarkdownDocument as Xn, DocsLlmsTxtPageInput as Xt, performDocsSearchWithMetadata as Y, renderDocsLlmsTxt as Yn, DocsLlmsTxtMaxCharsIssue as Yt, resolveDocsRetrievalLastModified as Z, renderDocsMarkdownNotFound as Zn, DocsLlmsTxtRequest as Zt, DocsContentChangesRequestError as _, DocsSkillDocumentOptions as _n, withDocsOpenApiOperationCounts as _r, DEFAULT_DOCS_DIAGNOSTICS_ROUTE as _t, DocsContentChangeHydrationResponse as a, DocsMarkdownResponseOptions as an, resolveDocsLlmsTxtSections as ar, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE as at, createDocsContentChangeFeed as b, buildDocsAgentDiscoverySpec as bn, ExtractedDocsMarkdownPromptBlocks as br, DEFAULT_LLMS_TXT_MAX_CHARS as bt, HydrateDocsContentChangesOptions as c, DocsMarkdownSectionIndexOptions as cn, resolveDocsMarkdownRequest as cr, DEFAULT_AGENT_MD_ROUTE as ct, hydrateDocsContentChanges as d, DocsMarkdownSectionResult as dn, resolveDocsRequestApiRoute as dr, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE as dt, DocsLlmsTxtSelectedContent as en, resolveDocsAgentFeedbackConfig as er, resolveDocsSearchFilters as et, DOCS_CONTENT_CHANGES_FORMAT as f, DocsMcpEndpointCandidate as fn, resolveDocsSkillFormat as fr, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE as ft, DocsContentChangesRequest as g, DocsOpenApiVersionDiscoveryConfig as gn, validateDocsAgentFeedbackPayload as gr, DEFAULT_DOCS_DIAGNOSTICS_FORMAT as gt, DocsContentChangeFeed as h, DocsOpenApiResolvedDiscoveryConfig as hn, toDocsMarkdownUrl as hr, DEFAULT_DOCS_CONFIG_ROUTE as ht, DocsContentChangeHydrationContent as i, DocsMarkdownRecoveryResult as in, resolveDocsLlmsTxtRequest as ir, DEFAULT_AGENTS_MD_ROUTE as it, DocsSearchRequestResolutionOptions as j, findDocsMarkdownPage as jn, getDocsMcpResourcePaths as jr, DocsAgentContractMcpTools as jt, DocsLocalMcpSearchRuntimeInput as k, createDocsStandardsDiscoveryResponse as kn, buildDocsMcpProtectedResourceMetadataRoute as kr, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER as kt, MAX_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET as l, DocsMarkdownSectionMetadata as ln, resolveDocsMarkdownSectionRequest as lr, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE as lt, DOCS_CONTENT_SNAPSHOT_FORMAT as m, DocsOpenApiDiscoveryConfig as mn, selectDocsMarkdownSection as mr, DEFAULT_DOCS_CONFIG_FORMAT as mt, DOCS_CONTENT_CHANGE_HYDRATION_FORMAT as n, DocsMarkdownPage as nn, resolveDocsAgentsFormat as nr, resolveLocalDocsMcpSearchConfig as nt, DocsContentChangeHydrationSection as o, DocsMarkdownSection as on, resolveDocsMarkdownCanonicalUrl as or, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA as ot, DOCS_CONTENT_CHANGES_RESPONSE_VALUE as p, DocsMcpEndpointCandidateOptions as pn, selectDocsLlmsTxtContent as pr, DEFAULT_DOCS_API_ROUTE as pt, normalizeDocsSearchFilters as q, parseDocsAgentFeedbackData as qn, DocsLlmsTxtGeneratedContent as qt, DocsContentChangeHydrationBudget as r, DocsMarkdownRecoveryMatch as rn, resolveDocsLlmsTxtFormat as rr, resolveSearchRequestConfig as rt, DocsContentChangeHydrationTombstone as s, DocsMarkdownSectionIndex as sn, resolveDocsMarkdownRecovery as sr, DEFAULT_AGENT_FEEDBACK_ROUTE as st, DEFAULT_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET as t, DocsMarkdownAgentDetection as tn, resolveDocsAgentFeedbackRequest as tr, resolveDocsSearchRequest as tt, MIN_DOCS_CONTENT_CHANGE_HYDRATION_TOKEN_BUDGET as u, DocsMarkdownSectionRequest as un, resolveDocsOpenApiDiscoveryConfig as ur, DEFAULT_AGENT_SPEC_ROUTE as ut, DocsResolvedContentChangesConfig as v, DocsStandardsDiscoveryResponseOptions as vn, DocsAudienceMdxIssue as vr, DEFAULT_LLMS_FULL_TXT_ROUTE as vt, resolveDocsContentChangesConfig as w, buildDocsMarkdownSectionIndex as wn, resolveDocsAudienceMdxContent as wr, DEFAULT_SKILL_MD_ROUTE as wt, createDocsContentChangesHttpResponse as x, buildDocsAgentFeedbackSchema as xn, extractDocsMarkdownPromptBlocks as xr, DEFAULT_LLMS_TXT_ROUTE as xt, ResolveDocsContentChangesOptions as y, acceptsDocsMarkdown as yn, DocsMarkdownPromptBlock as yr, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE as yt, createAlgoliaSearchAdapter as z, isDocsDiagnosticsRequest as zn, DocsConfigMapPointer as zt };
|
|
980
|
+
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_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 };
|