@farming-labs/docs 0.2.77 → 0.2.79
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{agent-DRKj42ht.d.mts → agent-C3Y011P9.d.mts} +282 -15
- package/dist/{agent-D4hNGatV.mjs → agent-DYPnd8-9.mjs} +2 -2
- package/dist/{agent-SRIJ-oF8.mjs → agent-DejGcJfb.mjs} +4286 -334
- package/dist/{agent-evals-DmFoKy_y.mjs → agent-evals-DQbsw5fY.mjs} +1 -1
- package/dist/{agent-export-CM-p9_YD.mjs → agent-export-DyDl_mmh.mjs} +6 -5
- package/dist/agent-provenance-DEyAr22i.mjs +463 -0
- package/dist/agent-skills-bundle.d.mts +1 -1
- package/dist/{agent-skills-server-CJ4D0G9P.d.mts → agent-skills-server-Daq-FOay.d.mts} +2 -2
- package/dist/agent-skills-vite.d.mts +3 -3
- package/dist/{agents-BeLDNCnE.mjs → agents-ktSbqsOA.mjs} +4 -4
- package/dist/cli/index.mjs +14 -14
- package/dist/client/react.d.mts +1 -1
- package/dist/{cloud-ask-ai-BCgHPxew.d.mts → cloud-ask-ai-o41WfOTk.d.mts} +1 -1
- package/dist/docs-cloud-server.d.mts +2 -2
- package/dist/{doctor-DhMVKHjp.mjs → doctor-DPj4Af0T.mjs} +9 -9
- package/dist/{golden-evaluations-VzE6juQl.mjs → golden-evaluations-xjthrnDO.mjs} +7 -2
- package/dist/index.d.mts +5 -5
- package/dist/index.mjs +5 -5
- package/dist/{mcp-CZkQJXtA.mjs → mcp-DOisfwWF.mjs} +5 -4
- package/dist/mcp.d.mts +19 -6
- package/dist/mcp.mjs +482 -40
- package/dist/{prompt-references-B6L3AD98.mjs → prompt-references-DbmH5FA9.mjs} +2 -2
- package/dist/retrieval-digest-DIbiu0TW.d.mts +190 -0
- package/dist/{review-nxoV8jIm.mjs → review-X1qVmw9I.mjs} +4 -4
- package/dist/{robots-CiQT8mX2.mjs → robots-DTo_uqa9.mjs} +2 -2
- package/dist/{robots-CgH6Stqn.mjs → robots-DUdUIBpi.mjs} +1 -1
- package/dist/{search-BTUIkhnT.mjs → search-DMOwAmxo.mjs} +4 -4
- package/dist/server.d.mts +7 -7
- package/dist/server.mjs +6 -6
- package/dist/{sitemap-e0_GeCWJ.mjs → sitemap-5Lajt0xS.mjs} +4 -4
- package/dist/{sitemap-server-DHaxyPAd.mjs → sitemap-server-p4wkFm9-.mjs} +1 -1
- package/dist/{standards-discovery-BbslY4id.d.mts → standards-discovery-C2cUIQzW.d.mts} +1 -1
- package/dist/{types-B-5Kzmkn.d.mts → types-o-ULHPK6.d.mts} +127 -4
- package/package.json +6 -2
- package/dist/retrieval-digest-rponR4jM.d.mts +0 -332
- package/dist/search-Da2AKaFJ.mjs +0 -3992
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { O as DocsA2AAgentCardOptions, R as DocsDiscoveryApiRouteOptions, z as DocsPublishedAgentSkill } from "./standards-discovery-
|
|
1
|
+
import { $n as LlmsTxtMaxCharsMode, At as DocsConfig, Dn as DocsSearchFilterField, En as DocsSearchFacetsResponse, F as DocsAgentContentChangesConfig, Fn as DocsSearchSourcePage, It as DocsContentChangesResponse, K as DocsAgentFeedbackData, Lt as DocsContentSnapshot, Mr as TypesenseDocsSearchConfig, Nn as DocsSearchResult, On as DocsSearchFilterInput, Qn as LlmsTxtMaxCharsConfig, Rn as DocsSitemapConfig, Sn as DocsSearchDocument, Sr as ResolvedDocsRelatedLink, Vt as DocsI18nConfig, Zn as LlmsTxtConfig, bn as DocsSearchChunkingConfig, er as LlmsTxtSectionConfig, f as CustomDocsSearchConfig, gn as DocsSearchAdapter, gt as DocsAskAIMcpConfig, in as DocsPaginatedSearchResponse, jn as DocsSearchRequest, kn as DocsSearchFilters, mn as DocsRobotsConfig, mr as PageAgentFrontmatter, qn as FeedbackConfig, qt as DocsMcpConfig, r as AlgoliaDocsSearchConfig, tr as McpDocsSearchConfig, vn as DocsSearchAdapterFactory, xn as DocsSearchConfig } from "./types-o-ULHPK6.mjs";
|
|
2
|
+
import { O as DocsA2AAgentCardOptions, R as DocsDiscoveryApiRouteOptions, z as DocsPublishedAgentSkill } from "./standards-discovery-C2cUIQzW.mjs";
|
|
3
3
|
import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/i18n.d.ts
|
|
@@ -17,17 +17,6 @@ declare function resolveDocsI18n(config?: DocsI18nConfig | null): ResolvedDocsI1
|
|
|
17
17
|
declare function resolveDocsLocale(searchParams: URLSearchParams, i18n?: ResolvedDocsI18n | null): string | undefined;
|
|
18
18
|
declare function resolveDocsPath(pathname: string, entry: string): DocsPathMatch;
|
|
19
19
|
//#endregion
|
|
20
|
-
//#region src/mcp-auth.d.ts
|
|
21
|
-
declare const DEFAULT_MCP_ROUTE = "/api/docs/mcp";
|
|
22
|
-
declare const DEFAULT_MCP_PUBLIC_ROUTE = "/mcp";
|
|
23
|
-
declare const DEFAULT_MCP_WELL_KNOWN_ROUTE = "/.well-known/mcp";
|
|
24
|
-
declare const DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE = "/.well-known/oauth-protected-resource";
|
|
25
|
-
declare function getDocsMcpResourcePaths(route?: string): string[];
|
|
26
|
-
declare function buildDocsMcpProtectedResourceMetadataRoute(resourcePath: string): string;
|
|
27
|
-
declare function getDocsMcpProtectedResourceMetadataRoutes(route?: string): string[];
|
|
28
|
-
declare function hasDocsMcpProtectedResourceConfig(mcp?: boolean | DocsMcpConfig): boolean;
|
|
29
|
-
declare function isDocsMcpRequest(url: URL, mcp?: boolean | DocsMcpConfig): boolean;
|
|
30
|
-
//#endregion
|
|
31
20
|
//#region src/audience.d.ts
|
|
32
21
|
/** The two content projections emitted by the docs framework. */
|
|
33
22
|
type DocsContentAudience = "human" | "agent";
|
|
@@ -73,6 +62,241 @@ declare function resolveDocsAudienceMdxContent(content: string, audience: DocsCo
|
|
|
73
62
|
/** Backwards-compatible name retained for existing integrations. */
|
|
74
63
|
declare function resolveDocsAgentMdxContent(content: string, audience: DocsContentAudience): string;
|
|
75
64
|
//#endregion
|
|
65
|
+
//#region src/search.d.ts
|
|
66
|
+
interface DocsAskAIContextResult extends DocsSearchResult {
|
|
67
|
+
title: string;
|
|
68
|
+
contextContent: string;
|
|
69
|
+
}
|
|
70
|
+
interface DocsAskAIContext {
|
|
71
|
+
context: string;
|
|
72
|
+
/** Structured production context blocks; avoids reparsing markdown horizontal rules. */
|
|
73
|
+
blocks: Array<{
|
|
74
|
+
text: string;
|
|
75
|
+
result: DocsAskAIContextResult;
|
|
76
|
+
}>;
|
|
77
|
+
results: DocsAskAIContextResult[];
|
|
78
|
+
searchResults: DocsSearchResult[];
|
|
79
|
+
packageHints: DocsAskAIPackageHints;
|
|
80
|
+
}
|
|
81
|
+
interface DocsAskAIPackageHints {
|
|
82
|
+
packages: string[];
|
|
83
|
+
imports: string[];
|
|
84
|
+
installCommands: string[];
|
|
85
|
+
}
|
|
86
|
+
/** Normalize scalar or array-valued scope filters for programmatic, HTTP, and MCP callers. */
|
|
87
|
+
declare function normalizeDocsSearchFilters(input?: DocsSearchFilterInput | DocsSearchFilters): DocsSearchFilters;
|
|
88
|
+
/** Parse the public search scope parameters from a URL query string. */
|
|
89
|
+
declare function resolveDocsSearchFilters(searchParams: URLSearchParams): DocsSearchFilters;
|
|
90
|
+
declare class DocsSearchRequestError extends Error {
|
|
91
|
+
readonly code = "invalid_search_request";
|
|
92
|
+
constructor(message: string);
|
|
93
|
+
}
|
|
94
|
+
declare function resolveDocsSearchError(error: unknown): {
|
|
95
|
+
code: "invalid_cursor" | "invalid_search_request";
|
|
96
|
+
message: string;
|
|
97
|
+
} | undefined;
|
|
98
|
+
/** Resolve search filters and the backwards-compatible structured response opt-in. */
|
|
99
|
+
declare function resolveDocsSearchRequest(searchParams: URLSearchParams): DocsSearchRequest;
|
|
100
|
+
declare function inferDocsAskAIPackageHints(content: string): DocsAskAIPackageHints;
|
|
101
|
+
declare function formatDocsAskAIPackageHints(hints: DocsAskAIPackageHints, packageName?: string): string | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* Build the exact normalized-input projection represented by a retrieval source digest.
|
|
104
|
+
* This is public so consumers can independently reproduce `source.digest`.
|
|
105
|
+
*/
|
|
106
|
+
declare function buildDocsRetrievalDigestProjection(page: DocsSearchSourcePage, audience?: DocsContentAudience): string;
|
|
107
|
+
declare function resolveDocsRetrievalLastModified(page: DocsSearchSourcePage, audience: DocsContentAudience): string | undefined;
|
|
108
|
+
interface BuildDocsContentSnapshotOptions {
|
|
109
|
+
pages: readonly DocsSearchSourcePage[];
|
|
110
|
+
search?: boolean | DocsSearchConfig;
|
|
111
|
+
audience?: DocsContentAudience;
|
|
112
|
+
locale?: string;
|
|
113
|
+
baseUrl?: string;
|
|
114
|
+
/** @internal Precomputed complete-corpus generation for composed callers. */
|
|
115
|
+
indexGeneration?: string;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Build a deterministic, body-free inventory for content-change synchronization.
|
|
119
|
+
*
|
|
120
|
+
* Its generation is identical to structured search for the same pages, audience,
|
|
121
|
+
* locale, base URL, and chunking policy.
|
|
122
|
+
*/
|
|
123
|
+
declare function buildDocsContentSnapshot(options: BuildDocsContentSnapshotOptions): Promise<DocsContentSnapshot>;
|
|
124
|
+
interface EnrichDocsSearchDocumentsWithProvenanceOptions {
|
|
125
|
+
documents: readonly DocsSearchDocument[];
|
|
126
|
+
pages: readonly DocsSearchSourcePage[];
|
|
127
|
+
audience?: DocsContentAudience;
|
|
128
|
+
chunking?: DocsSearchChunkingConfig;
|
|
129
|
+
locale?: string;
|
|
130
|
+
baseUrl?: string;
|
|
131
|
+
indexGeneration?: string;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Attach the same canonical provenance used by built-in search providers.
|
|
135
|
+
* Custom adapters can call this before persisting their own hosted records.
|
|
136
|
+
*/
|
|
137
|
+
declare function enrichDocsSearchDocumentsWithProvenance(options: EnrichDocsSearchDocumentsWithProvenanceOptions): Promise<DocsSearchDocument[]>;
|
|
138
|
+
declare function buildDocsSearchDocuments(pages: DocsSearchSourcePage[], chunking?: DocsSearchChunkingConfig, audience?: DocsContentAudience): DocsSearchDocument[];
|
|
139
|
+
declare function createSimpleSearchAdapter(): DocsSearchAdapter;
|
|
140
|
+
declare function createTypesenseSearchAdapter(config: TypesenseDocsSearchConfig): DocsSearchAdapter;
|
|
141
|
+
declare function resolveSearchRequestConfig(search: boolean | DocsSearchConfig | undefined, requestUrl?: string): boolean | DocsSearchConfig | undefined;
|
|
142
|
+
/**
|
|
143
|
+
* Resolve the public search audience without allowing malformed values to opt into agent content.
|
|
144
|
+
* Human search remains the default for omitted, legacy, and unknown query values.
|
|
145
|
+
*/
|
|
146
|
+
declare function resolveDocsSearchAudience(value: string | null | undefined): DocsContentAudience;
|
|
147
|
+
declare function resolveAskAISearchRequestConfig(options: {
|
|
148
|
+
search: boolean | DocsSearchConfig | undefined;
|
|
149
|
+
useMcp?: boolean | DocsAskAIMcpConfig;
|
|
150
|
+
mcpEndpoint?: string;
|
|
151
|
+
mcpEnabled?: boolean;
|
|
152
|
+
mcpSearchEnabled?: boolean;
|
|
153
|
+
requestUrl?: string;
|
|
154
|
+
}): boolean | DocsSearchConfig | undefined;
|
|
155
|
+
declare function createMcpSearchAdapter(config: McpDocsSearchConfig): DocsSearchAdapter;
|
|
156
|
+
declare function createAlgoliaSearchAdapter(config: AlgoliaDocsSearchConfig): DocsSearchAdapter;
|
|
157
|
+
interface PerformDocsSearchOptions {
|
|
158
|
+
pages: DocsSearchSourcePage[];
|
|
159
|
+
/** @internal Complete corpus used for generation when `pages` is pre-scoped by a caller. */
|
|
160
|
+
generationPages?: DocsSearchSourcePage[];
|
|
161
|
+
/** @internal Precomputed complete-corpus generation for structured callers. */
|
|
162
|
+
indexGeneration?: string;
|
|
163
|
+
query: string;
|
|
164
|
+
search?: boolean | DocsSearchConfig;
|
|
165
|
+
/** Selects which audience projection is searchable. Public site search defaults to human. */
|
|
166
|
+
audience?: DocsContentAudience;
|
|
167
|
+
locale?: string;
|
|
168
|
+
pathname?: string;
|
|
169
|
+
siteTitle?: string;
|
|
170
|
+
/** Canonical docs URL used to distinguish same-site absolute hits from foreign MCP results. */
|
|
171
|
+
baseUrl?: string;
|
|
172
|
+
/**
|
|
173
|
+
* Canonical origin safe to persist in a hosted index. Pass `null` when `baseUrl`
|
|
174
|
+
* came from the current request rather than trusted configuration.
|
|
175
|
+
* @internal
|
|
176
|
+
*/
|
|
177
|
+
syncBaseUrl?: string | null;
|
|
178
|
+
limit?: number;
|
|
179
|
+
/** Opaque continuation cursor used by structured search responses. */
|
|
180
|
+
cursor?: string;
|
|
181
|
+
/** Optional framework, version, package, and tag constraints. */
|
|
182
|
+
filters?: DocsSearchFilterInput;
|
|
183
|
+
/**
|
|
184
|
+
* Controls provider failures. Runtime search keeps the resilient `fallback` default;
|
|
185
|
+
* diagnostics can request `throw` so a broken configured provider cannot be scored as
|
|
186
|
+
* successful simple search.
|
|
187
|
+
*/
|
|
188
|
+
failureMode?: "fallback" | "throw";
|
|
189
|
+
/**
|
|
190
|
+
* Whether non-simple provider hits are supplemented with exact/local simple results.
|
|
191
|
+
* Runtime search defaults to true; provider diagnostics can disable supplementation.
|
|
192
|
+
*/
|
|
193
|
+
supplementExternalResults?: boolean;
|
|
194
|
+
/** Keep absolute provider origins distinct when no canonical docs origin is available. */
|
|
195
|
+
strictExternalOrigins?: boolean;
|
|
196
|
+
/** Optional cancellation signal forwarded to adapters and their managed requests. */
|
|
197
|
+
signal?: AbortSignal;
|
|
198
|
+
}
|
|
199
|
+
declare function performDocsSearch(options: PerformDocsSearchOptions): Promise<DocsSearchResult[]>;
|
|
200
|
+
interface BuildDocsSearchFacetsOptions {
|
|
201
|
+
pages: DocsSearchSourcePage[];
|
|
202
|
+
search?: boolean | DocsSearchConfig;
|
|
203
|
+
audience?: DocsContentAudience;
|
|
204
|
+
locale?: string;
|
|
205
|
+
baseUrl?: string;
|
|
206
|
+
filters?: DocsSearchFilterInput;
|
|
207
|
+
/** Facet field selected for cursor continuation. */
|
|
208
|
+
facet?: DocsSearchFilterField;
|
|
209
|
+
/** Opaque `nextCursor` returned for the selected facet. */
|
|
210
|
+
cursor?: string;
|
|
211
|
+
/** Maximum facet values returned per page. Defaults to 100. */
|
|
212
|
+
limit?: number;
|
|
213
|
+
/** @internal Precomputed complete-corpus generation for composed callers. */
|
|
214
|
+
indexGeneration?: string;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* Build a body-free index of valid search filter values and page counts.
|
|
218
|
+
*
|
|
219
|
+
* Each facet applies filters from the other fields while ignoring its own selected
|
|
220
|
+
* values. This is the conventional faceted-search behavior and lets an agent discover
|
|
221
|
+
* safe alternatives without guessing or fetching document bodies.
|
|
222
|
+
*/
|
|
223
|
+
declare function buildDocsSearchFacets(options: BuildDocsSearchFacetsOptions): Promise<DocsSearchFacetsResponse>;
|
|
224
|
+
declare function performDocsSearchWithMetadata(options: PerformDocsSearchOptions): Promise<DocsPaginatedSearchResponse>;
|
|
225
|
+
declare function buildDocsAskAIContext(options: {
|
|
226
|
+
pages: DocsSearchSourcePage[];
|
|
227
|
+
query: string;
|
|
228
|
+
search?: boolean | DocsSearchConfig;
|
|
229
|
+
locale?: string;
|
|
230
|
+
pathname?: string;
|
|
231
|
+
siteTitle?: string;
|
|
232
|
+
baseUrl?: string; /** See `performDocsSearch.syncBaseUrl`. */
|
|
233
|
+
syncBaseUrl?: string | null;
|
|
234
|
+
limit?: number;
|
|
235
|
+
filters?: DocsSearchFilterInput;
|
|
236
|
+
maxContextChars?: number;
|
|
237
|
+
maxResultChars?: number; /** See `performDocsSearch.failureMode`. Defaults to resilient runtime fallback. */
|
|
238
|
+
searchFailureMode?: "fallback" | "throw"; /** See `performDocsSearch.strictExternalOrigins`. */
|
|
239
|
+
strictExternalOrigins?: boolean; /** Optional cancellation signal forwarded to the configured search provider. */
|
|
240
|
+
signal?: AbortSignal;
|
|
241
|
+
}): Promise<DocsAskAIContext>;
|
|
242
|
+
declare function createCustomSearchAdapter(adapter: DocsSearchAdapter | DocsSearchAdapterFactory, options?: {
|
|
243
|
+
paginationRevision?: string;
|
|
244
|
+
}): CustomDocsSearchConfig;
|
|
245
|
+
//#endregion
|
|
246
|
+
//#region src/content-changes.d.ts
|
|
247
|
+
declare const DOCS_CONTENT_CHANGES_FORMAT = "docs-content-changes.v1";
|
|
248
|
+
declare const DOCS_CONTENT_SNAPSHOT_FORMAT = "docs-content-snapshot.v1";
|
|
249
|
+
declare const DOCS_CONTENT_CHANGES_RESPONSE_VALUE = "changes";
|
|
250
|
+
/** Whether a value is a valid content-index generation identifier. */
|
|
251
|
+
declare function isDocsContentChangeGeneration(value: string): boolean;
|
|
252
|
+
interface DocsContentChangesRequest {
|
|
253
|
+
audience: "human" | "agent";
|
|
254
|
+
since?: string;
|
|
255
|
+
}
|
|
256
|
+
interface DocsResolvedContentChangesConfig {
|
|
257
|
+
enabled: boolean;
|
|
258
|
+
maxSnapshots: number;
|
|
259
|
+
loadSnapshot?: DocsAgentContentChangesConfig["loadSnapshot"];
|
|
260
|
+
saveSnapshot?: DocsAgentContentChangesConfig["saveSnapshot"];
|
|
261
|
+
}
|
|
262
|
+
interface ResolveDocsContentChangesOptions extends Omit<BuildDocsContentSnapshotOptions, "pages"> {
|
|
263
|
+
pages: readonly DocsSearchSourcePage[];
|
|
264
|
+
since?: string;
|
|
265
|
+
request?: Request;
|
|
266
|
+
}
|
|
267
|
+
interface DocsContentChangeFeed {
|
|
268
|
+
resolve(options: ResolveDocsContentChangesOptions): Promise<DocsContentChangesResponse>;
|
|
269
|
+
}
|
|
270
|
+
declare class DocsContentChangesRequestError extends Error {
|
|
271
|
+
readonly code = "invalid_content_changes_request";
|
|
272
|
+
constructor(message: string);
|
|
273
|
+
}
|
|
274
|
+
declare function resolveDocsContentChangesConfig(input?: boolean | DocsAgentContentChangesConfig, options?: {
|
|
275
|
+
staticExport?: boolean;
|
|
276
|
+
}): DocsResolvedContentChangesConfig;
|
|
277
|
+
declare function isDocsContentChangesRequest(url: URL): boolean;
|
|
278
|
+
declare function resolveDocsContentChangesRequest(url: URL): DocsContentChangesRequest;
|
|
279
|
+
declare function createDocsContentChangeFeed(input?: boolean | DocsAgentContentChangesConfig): DocsContentChangeFeed;
|
|
280
|
+
declare function createDocsContentChangesHttpResponse(options: {
|
|
281
|
+
request: Request;
|
|
282
|
+
feed: DocsContentChangeFeed;
|
|
283
|
+
pages: readonly DocsSearchSourcePage[];
|
|
284
|
+
search?: boolean | DocsSearchConfig;
|
|
285
|
+
locale?: string;
|
|
286
|
+
baseUrl?: string;
|
|
287
|
+
}): Promise<Response>;
|
|
288
|
+
//#endregion
|
|
289
|
+
//#region src/mcp-auth.d.ts
|
|
290
|
+
declare const DEFAULT_MCP_ROUTE = "/api/docs/mcp";
|
|
291
|
+
declare const DEFAULT_MCP_PUBLIC_ROUTE = "/mcp";
|
|
292
|
+
declare const DEFAULT_MCP_WELL_KNOWN_ROUTE = "/.well-known/mcp";
|
|
293
|
+
declare const DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE = "/.well-known/oauth-protected-resource";
|
|
294
|
+
declare function getDocsMcpResourcePaths(route?: string): string[];
|
|
295
|
+
declare function buildDocsMcpProtectedResourceMetadataRoute(resourcePath: string): string;
|
|
296
|
+
declare function getDocsMcpProtectedResourceMetadataRoutes(route?: string): string[];
|
|
297
|
+
declare function hasDocsMcpProtectedResourceConfig(mcp?: boolean | DocsMcpConfig): boolean;
|
|
298
|
+
declare function isDocsMcpRequest(url: URL, mcp?: boolean | DocsMcpConfig): boolean;
|
|
299
|
+
//#endregion
|
|
76
300
|
//#region src/agent.d.ts
|
|
77
301
|
declare const DEFAULT_DOCS_API_ROUTE = "/api/docs";
|
|
78
302
|
declare const DEFAULT_DOCS_CONFIG_FORMAT = "docs-config-map.v1";
|
|
@@ -204,6 +428,7 @@ interface DocsDiagnosticsFeature {
|
|
|
204
428
|
routes?: Record<string, string | null>;
|
|
205
429
|
agentEndpoint?: string | null;
|
|
206
430
|
structuredAgentEndpoint?: string | null;
|
|
431
|
+
facetsEndpoint?: string | null;
|
|
207
432
|
audienceParam?: string;
|
|
208
433
|
defaultAudience?: "human" | "agent";
|
|
209
434
|
supportedAudiences?: Array<"human" | "agent">;
|
|
@@ -214,8 +439,17 @@ interface DocsDiagnosticsFeature {
|
|
|
214
439
|
tags: "tags";
|
|
215
440
|
};
|
|
216
441
|
responseFormat?: "docs-search.v1";
|
|
442
|
+
facetsResponseFormat?: "docs-search-facets.v1";
|
|
443
|
+
format?: string;
|
|
444
|
+
sinceParam?: string;
|
|
445
|
+
generationField?: string;
|
|
446
|
+
resetRequiredField?: string;
|
|
217
447
|
warningsField?: "warnings";
|
|
218
|
-
/**
|
|
448
|
+
/** Facet field selected for facet-value continuation. */
|
|
449
|
+
facetParam?: "facet";
|
|
450
|
+
/** Page-size parameter accepted by structured search and facet discovery. */
|
|
451
|
+
limitParam?: "limit";
|
|
452
|
+
/** Opaque continuation token accepted by structured search and facet discovery. */
|
|
219
453
|
cursorParam?: "cursor";
|
|
220
454
|
/** Optional continuation token returned when another result page is available. */
|
|
221
455
|
nextCursorField?: "nextCursor";
|
|
@@ -248,6 +482,7 @@ interface DocsDiagnostics {
|
|
|
248
482
|
skill: string;
|
|
249
483
|
search: string | null;
|
|
250
484
|
agentSearch: string | null;
|
|
485
|
+
contentChanges: string | null;
|
|
251
486
|
askAi: string | null;
|
|
252
487
|
mcp: string | null;
|
|
253
488
|
llmsTxt: string | null;
|
|
@@ -264,6 +499,7 @@ interface DocsDiagnostics {
|
|
|
264
499
|
diagnostics: DocsDiagnosticsFeature;
|
|
265
500
|
apiCatalog: DocsDiagnosticsFeature;
|
|
266
501
|
search: DocsDiagnosticsFeature;
|
|
502
|
+
contentChanges: DocsDiagnosticsFeature;
|
|
267
503
|
ai: DocsDiagnosticsFeature;
|
|
268
504
|
mcp: DocsDiagnosticsFeature;
|
|
269
505
|
feedback: DocsDiagnosticsFeature;
|
|
@@ -348,6 +584,8 @@ interface DocsAgentDiscoverySpecOptions extends DocsDiscoveryApiRouteOptions {
|
|
|
348
584
|
apiCatalog?: boolean;
|
|
349
585
|
i18n?: ResolvedDocsI18n | null;
|
|
350
586
|
search?: boolean | DocsSearchConfig;
|
|
587
|
+
/** Runtime metadata-only document synchronization feed. Defaults to enabled. */
|
|
588
|
+
contentChanges?: boolean | DocsAgentContentChangesConfig;
|
|
351
589
|
mcp: DocsMcpResolvedConfig;
|
|
352
590
|
feedback?: DocsAgentFeedbackDiscoveryConfig;
|
|
353
591
|
llms?: DocsLlmsDiscoveryConfig;
|
|
@@ -372,6 +610,8 @@ interface DocsSkillDocumentOptions extends DocsDiscoveryApiRouteOptions {
|
|
|
372
610
|
/** Whether this deployment actually serves the RFC 9727 API catalog. Defaults to true. */
|
|
373
611
|
apiCatalog?: boolean;
|
|
374
612
|
search?: boolean | DocsSearchConfig;
|
|
613
|
+
/** Runtime metadata-only document synchronization feed. Defaults to enabled. */
|
|
614
|
+
contentChanges?: boolean | DocsAgentContentChangesConfig;
|
|
375
615
|
mcp: DocsMcpResolvedConfig;
|
|
376
616
|
feedback?: DocsAgentFeedbackDiscoveryConfig;
|
|
377
617
|
llms?: DocsLlmsDiscoveryConfig;
|
|
@@ -632,6 +872,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
632
872
|
apiCatalog: explicitApiCatalog,
|
|
633
873
|
i18n,
|
|
634
874
|
search,
|
|
875
|
+
contentChanges,
|
|
635
876
|
mcp,
|
|
636
877
|
feedback,
|
|
637
878
|
llms,
|
|
@@ -673,6 +914,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
673
914
|
agentSkillsDiscovery: boolean;
|
|
674
915
|
mcp: boolean;
|
|
675
916
|
search: boolean;
|
|
917
|
+
contentChanges: boolean;
|
|
676
918
|
sitemap: boolean;
|
|
677
919
|
robots: boolean;
|
|
678
920
|
structuredData: boolean;
|
|
@@ -682,6 +924,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
682
924
|
locales: boolean;
|
|
683
925
|
};
|
|
684
926
|
api: {
|
|
927
|
+
contentChanges?: string | undefined;
|
|
685
928
|
openapi: string;
|
|
686
929
|
agentCard?: string | undefined;
|
|
687
930
|
agentSkillsIndex: string;
|
|
@@ -818,6 +1061,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
818
1061
|
endpoint: string;
|
|
819
1062
|
agentEndpoint: string;
|
|
820
1063
|
structuredAgentEndpoint: string;
|
|
1064
|
+
facetsEndpoint: string;
|
|
821
1065
|
method: string;
|
|
822
1066
|
queryParam: string;
|
|
823
1067
|
localeParam: string;
|
|
@@ -826,7 +1070,9 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
826
1070
|
supportedAudiences: string[];
|
|
827
1071
|
responseParam: string;
|
|
828
1072
|
structuredResponseValue: string;
|
|
1073
|
+
facetsResponseValue: string;
|
|
829
1074
|
responseFormat: string;
|
|
1075
|
+
facetsResponseFormat: string;
|
|
830
1076
|
filterParams: {
|
|
831
1077
|
framework: string;
|
|
832
1078
|
version: string;
|
|
@@ -835,11 +1081,30 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
835
1081
|
};
|
|
836
1082
|
repeatedFilterParams: string[];
|
|
837
1083
|
warningsField: string;
|
|
1084
|
+
facetParam: string;
|
|
1085
|
+
limitParam: string;
|
|
838
1086
|
cursorParam: string;
|
|
839
1087
|
nextCursorField: string;
|
|
840
1088
|
hasMoreField: string;
|
|
841
1089
|
totalField: string;
|
|
842
1090
|
};
|
|
1091
|
+
contentChanges: {
|
|
1092
|
+
enabled: boolean;
|
|
1093
|
+
endpoint: string | null;
|
|
1094
|
+
method: string;
|
|
1095
|
+
audienceParam: string;
|
|
1096
|
+
defaultAudience: string;
|
|
1097
|
+
supportedAudiences: string[];
|
|
1098
|
+
responseParam: string;
|
|
1099
|
+
responseValue: string;
|
|
1100
|
+
sinceParam: string;
|
|
1101
|
+
format: string;
|
|
1102
|
+
generationField: string;
|
|
1103
|
+
resetRequiredField: string;
|
|
1104
|
+
modes: string[];
|
|
1105
|
+
bodyFree: boolean;
|
|
1106
|
+
etag: boolean;
|
|
1107
|
+
};
|
|
843
1108
|
agents: {
|
|
844
1109
|
enabled: boolean;
|
|
845
1110
|
file: string;
|
|
@@ -911,6 +1176,8 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
911
1176
|
listTasks?: boolean;
|
|
912
1177
|
readTask?: boolean;
|
|
913
1178
|
searchDocs: boolean;
|
|
1179
|
+
searchFacets?: boolean;
|
|
1180
|
+
listContentChanges?: boolean;
|
|
914
1181
|
getNavigation: boolean;
|
|
915
1182
|
getCodeExamples: boolean;
|
|
916
1183
|
getConfigSchema: boolean;
|
|
@@ -935,4 +1202,4 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
935
1202
|
declare function acceptsDocsMarkdown(request: Request): boolean;
|
|
936
1203
|
declare function resolveDocsOpenApiDiscoveryConfig(openapi?: boolean | DocsOpenApiDiscoveryConfig): DocsOpenApiResolvedDiscoveryConfig;
|
|
937
1204
|
//#endregion
|
|
938
|
-
export { DocsMarkdownPage as $, resolveDocsLlmsTxtRequest as $t, DocsAgentFeedbackDiscoveryConfig as A,
|
|
1205
|
+
export { DocsMarkdownPage as $, normalizeDocsSearchFilters as $n, resolveDocsLlmsTxtRequest as $t, DocsAgentFeedbackDiscoveryConfig as A, createDocsContentChangesHttpResponse as An, hasDocsMarkdownSignatureAgent as At, DocsDiagnosticsIssueSeverity as B, buildDocsAskAIContext as Bn, normalizeDocsPathSegment as Bt, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN as C, DOCS_CONTENT_SNAPSHOT_FORMAT as Cn, createDocsMarkdownResponse as Ct, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN as D, DocsResolvedContentChangesConfig as Dn, getDocsLlmsTxtMaxCharsIssue as Dt, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER as E, DocsContentChangesRequestError as En, findDocsMarkdownPage as Et, DocsConfigMapJsonValue as F, BuildDocsContentSnapshotOptions as Fn, isDocsLlmsTxtPublicRequest as Ft, DocsLlmsTxtGeneratedSection as G, createAlgoliaSearchAdapter as Gn, renderDocsMarkdownDocument as Gt, DocsDiagnosticsStatus as H, buildDocsRetrievalDigestProjection as Hn, parseDocsAgentFeedbackData as Ht, DocsConfigMapPointer as I, BuildDocsSearchFacetsOptions as In, isDocsMarkdownSectionIndexRequest as It, DocsLlmsTxtRequest as J, createSimpleSearchAdapter as Jn, resolveDocsAgentContractMcpTools as Jt, DocsLlmsTxtMaxCharsIssue as K, createCustomSearchAdapter as Kn, renderDocsMarkdownNotFound as Kt, DocsDiagnostics as L, DocsSearchRequestError as Ln, isDocsPublicGetRequest as Lt, DocsAgentFeedbackResolvedConfig as M, isDocsContentChangesRequest as Mn, isDocsAgentsRequest as Mt, DocsAgentsDocumentOptions as N, resolveDocsContentChangesConfig as Nn, isDocsConfigRequest as Nt, DocsAgentContractMcpTools as O, ResolveDocsContentChangesOptions as On, getDocsMarkdownCanonicalLinkHeader as Ot, DocsConfigMap as P, resolveDocsContentChangesRequest as Pn, isDocsDiagnosticsRequest as Pt, DocsMarkdownAgentDetection as Q, inferDocsAskAIPackageHints as Qn, resolveDocsLlmsTxtFormat as Qt, DocsDiagnosticsFeature as R, EnrichDocsSearchDocumentsWithProvenanceOptions as Rn, isDocsSkillRequest as Rt, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE as S, DOCS_CONTENT_CHANGES_RESPONSE_VALUE as Sn, resolveDocsPath as Sr, collectDocsMarkdownSections as St, DOCS_MARKDOWN_SECTION_INDEX_FORMAT as T, DocsContentChangesRequest as Tn, detectDocsMarkdownAgentRequest as Tt, DocsLlmsDiscoveryConfig as U, buildDocsSearchDocuments as Un, renderDocsAgentsDocument as Ut, DocsDiagnosticsOptions as V, buildDocsContentSnapshot as Vn, normalizeDocsUrlPath as Vt, DocsLlmsTxtGeneratedContent as W, buildDocsSearchFacets as Wn, renderDocsLlmsTxt as Wt, DocsLlmsTxtResolvedSection as X, enrichDocsSearchDocumentsWithProvenance as Xn, resolveDocsAgentFeedbackRequest as Xt, DocsLlmsTxtResolvedMaxChars as Y, createTypesenseSearchAdapter as Yn, resolveDocsAgentFeedbackConfig as Yt, DocsLlmsTxtSelectedContent as Z, formatDocsAskAIPackageHints as Zn, resolveDocsAgentsFormat as Zt, DEFAULT_LLMS_TXT_MAX_CHARS as _, getDocsMcpProtectedResourceMetadataRoutes as _n, resolveDocsAudienceMdxContent as _r, buildDocsAgentFeedbackSchema as _t, DEFAULT_AGENT_MD_ROUTE as a, resolveDocsOpenApiDiscoveryConfig as an, resolveDocsSearchError as ar, DocsMarkdownSectionIndexOptions as at, DEFAULT_OPENAPI_SCHEMA_ROUTE as b, isDocsMcpRequest as bn, resolveDocsI18n as br, buildDocsMarkdownSectionIndex as bt, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE as c, selectDocsLlmsTxtContent as cn, resolveSearchRequestConfig as cr, DocsMarkdownSectionResult as ct, DEFAULT_DOCS_CONFIG_FORMAT as d, validateDocsAgentFeedbackPayload as dn, DocsMarkdownPromptBlock as dr, DocsOpenApiDiscoveryConfig as dt, resolveDocsLlmsTxtSections as en, performDocsSearch as er, DocsMarkdownRecoveryMatch as et, DEFAULT_DOCS_CONFIG_ROUTE as f, DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE as fn, ExtractedDocsMarkdownPromptBlocks as fr, DocsOpenApiResolvedDiscoveryConfig as ft, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE as g, buildDocsMcpProtectedResourceMetadataRoute as gn, resolveDocsAudienceExposure as gr, buildDocsAgentDiscoverySpec as gt, DEFAULT_LLMS_FULL_TXT_ROUTE as h, DEFAULT_MCP_WELL_KNOWN_ROUTE as hn, resolveDocsAgentMdxContent as hr, acceptsDocsMarkdown as ht, DEFAULT_AGENT_FEEDBACK_ROUTE as i, resolveDocsMarkdownSectionRequest as in, resolveDocsSearchAudience as ir, DocsMarkdownSectionIndex as it, DocsAgentFeedbackRequest as j, isDocsContentChangeGeneration as jn, isDocsAgentDiscoveryRequest as jt, DocsAgentDiscoverySpecOptions as k, createDocsContentChangeFeed as kn, getDocsMarkdownVaryHeader as kt, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE as l, selectDocsMarkdownSection as ln, DocsAudienceMdxIssue as lr, DocsMcpEndpointCandidate as lt, DEFAULT_DOCS_DIAGNOSTICS_ROUTE as m, DEFAULT_MCP_ROUTE as mn, findDocsAudienceMdxIssues as mr, DocsStandardsDiscoveryResponseOptions as mt, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE as n, resolveDocsMarkdownRecovery as nn, resolveAskAISearchRequestConfig as nr, DocsMarkdownResponseOptions as nt, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE as o, resolveDocsRequestApiRoute as on, resolveDocsSearchFilters as or, DocsMarkdownSectionMetadata as ot, DEFAULT_DOCS_DIAGNOSTICS_FORMAT as p, DEFAULT_MCP_PUBLIC_ROUTE as pn, extractDocsMarkdownPromptBlocks as pr, DocsSkillDocumentOptions as pt, DocsLlmsTxtPageInput as q, createMcpSearchAdapter as qn, renderDocsSkillDocument as qt, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA as r, resolveDocsMarkdownRequest as rn, resolveDocsRetrievalLastModified as rr, DocsMarkdownSection as rt, DEFAULT_AGENT_SPEC_ROUTE as s, resolveDocsSkillFormat as sn, resolveDocsSearchRequest as sr, DocsMarkdownSectionRequest as st, DEFAULT_AGENTS_MD_ROUTE as t, resolveDocsMarkdownCanonicalUrl as tn, performDocsSearchWithMetadata as tr, DocsMarkdownRecoveryResult as tt, DEFAULT_DOCS_API_ROUTE as u, toDocsMarkdownUrl as un, DocsContentAudience as ur, DocsMcpEndpointCandidateOptions as ut, DEFAULT_LLMS_TXT_ROUTE as v, getDocsMcpResourcePaths as vn, DocsPathMatch as vr, buildDocsConfigMap as vt, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN as w, DocsContentChangeFeed as wn, createDocsStandardsDiscoveryResponse as wt, DEFAULT_SKILL_MD_ROUTE as x, DOCS_CONTENT_CHANGES_FORMAT as xn, resolveDocsLocale as xr, buildDocsMcpEndpointCandidates as xt, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE as y, hasDocsMcpProtectedResourceConfig as yn, ResolvedDocsI18n as yr, buildDocsDiagnostics as yt, DocsDiagnosticsIssue as z, PerformDocsSearchOptions as zn, matchesDocsLlmsTxtSection as zt };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { B as findDocsMarkdownPage, at as renderDocsMarkdownDocument } from "./agent-
|
|
1
|
+
import { B as findDocsMarkdownPage, at as renderDocsMarkdownDocument } from "./agent-DejGcJfb.mjs";
|
|
2
2
|
import { v as normalizePageAgentFrontmatter, x as stripGeneratedPageAgentContractMarkdown } from "./markdown-sections-7OoA7ylx.mjs";
|
|
3
|
-
import {
|
|
3
|
+
import { a as parseGeneratedAgentDocument, n as GENERATED_AGENT_PROVENANCE_VERSION, o as serializeGeneratedAgentDocument, r as hashGeneratedAgentContent } from "./agent-provenance-DEyAr22i.mjs";
|
|
4
4
|
import { createFilesystemDocsMcpSource } from "./mcp.mjs";
|
|
5
5
|
import { _ as resolveDocsContentDir, a as loadDocsConfigModule, c as loadProjectEnv, d as readNavTitle, f as readNumberProperty, g as resolveDocsConfigPath, h as readTopLevelStringProperty, l as readBooleanProperty, p as readStringProperty, t as extractNestedObjectLiteral, u as readEnvReferenceProperty } from "./config-Wcdj-D0a.mjs";
|
|
6
6
|
import { createRequire } from "node:module";
|