@farming-labs/docs 0.2.78 → 0.2.80

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.
Files changed (35) hide show
  1. package/dist/{agent-Ba94vwM2.mjs → agent-Cj50nyeV.mjs} +40 -3
  2. package/dist/{agent-CHgWJcK_.d.mts → agent-DGALg9hQ.d.mts} +256 -14
  3. package/dist/{agent-CM-hzhfh.mjs → agent-aWl_O6xn.mjs} +2 -2
  4. package/dist/{agent-evals-C8dkgJMN.mjs → agent-evals-DvQQtN62.mjs} +1 -1
  5. package/dist/{agent-export-DdF-IVfg.mjs → agent-export-BISSb83U.mjs} +5 -5
  6. package/dist/{agent-provenance-D8UBpnMc.mjs → agent-provenance-C_jgqNTW.mjs} +1 -1
  7. package/dist/agent-skills-bundle.d.mts +1 -1
  8. package/dist/{agent-skills-server-zvs0Yknt.d.mts → agent-skills-server-Daq-FOay.d.mts} +2 -2
  9. package/dist/agent-skills-vite.d.mts +3 -3
  10. package/dist/{agents-v0Em2KZo.mjs → agents-DLNUgcgU.mjs} +4 -4
  11. package/dist/cli/index.mjs +14 -14
  12. package/dist/client/react.d.mts +1 -1
  13. package/dist/{cloud-ask-ai-BwsdF7AQ.d.mts → cloud-ask-ai-o41WfOTk.d.mts} +1 -1
  14. package/dist/docs-cloud-server.d.mts +2 -2
  15. package/dist/{doctor-BbrN0rdC.mjs → doctor-BxP-UHaE.mjs} +9 -9
  16. package/dist/{golden-evaluations-Bk9t-HNq.mjs → golden-evaluations-Bk8MBi3Z.mjs} +1 -1
  17. package/dist/index.d.mts +5 -5
  18. package/dist/index.mjs +5 -5
  19. package/dist/{mcp-DT-WNsA-.mjs → mcp-BU63wzaM.mjs} +5 -4
  20. package/dist/mcp.d.mts +18 -6
  21. package/dist/mcp.mjs +292 -56
  22. package/dist/{prompt-references-CoDorsvS.mjs → prompt-references-CMMoF6AY.mjs} +2 -2
  23. package/dist/retrieval-digest-DIbiu0TW.d.mts +190 -0
  24. package/dist/{review-DrCaaT7G.mjs → review-D14mUw5D.mjs} +4 -4
  25. package/dist/{robots-C_v2HK43.mjs → robots-BukukxNm.mjs} +1 -1
  26. package/dist/{robots-izJbM9cv.mjs → robots-DmczzidR.mjs} +2 -2
  27. package/dist/{search-YiZMZDfb.mjs → search-DP96dV3e.mjs} +4 -4
  28. package/dist/server.d.mts +7 -7
  29. package/dist/server.mjs +6 -6
  30. package/dist/{sitemap-NO8UMO6Y.mjs → sitemap-DuosRvmn.mjs} +4 -4
  31. package/dist/{sitemap-server-Dgxs9V6S.mjs → sitemap-server-DzlV1NOB.mjs} +1 -1
  32. package/dist/{standards-discovery-BWyNgZSs.d.mts → standards-discovery-C2cUIQzW.d.mts} +1 -1
  33. package/dist/{types-CpLnwHak.d.mts → types-o-ULHPK6.d.mts} +2 -0
  34. package/package.json +6 -2
  35. package/dist/retrieval-digest-CO3wqeMk.d.mts +0 -413
@@ -1,413 +0,0 @@
1
- import { Dn as DocsSearchFilterField, En as DocsSearchFacetsResponse, F as DocsAgentContentChangesConfig, Fn as DocsSearchSourcePage, It as DocsContentChangesResponse, Lt as DocsContentSnapshot, Mr as TypesenseDocsSearchConfig, Nn as DocsSearchResult, On as DocsSearchFilterInput, Rn as DocsSitemapConfig, Sn as DocsSearchDocument, Sr as ResolvedDocsRelatedLink, at as DocsAnalyticsEvent, bn as DocsSearchChunkingConfig, f as CustomDocsSearchConfig, gn as DocsSearchAdapter, gt as DocsAskAIMcpConfig, in as DocsPaginatedSearchResponse, ir as OpenDocsProvider, it as DocsAnalyticsConfig, jn as DocsSearchRequest, kn as DocsSearchFilters, nn as DocsObservabilityEvent, ot as DocsAnalyticsEventInput, r as AlgoliaDocsSearchConfig, rn as DocsObservabilityEventInput, sr as OpenDocsTarget, tn as DocsObservabilityConfig, tr as McpDocsSearchConfig, tt as DocsAgentTraceEventInput, vn as DocsSearchAdapterFactory, xn as DocsSearchConfig } from "./types-CpLnwHak.mjs";
2
- import { R as DocsDiscoveryApiRouteOptions } from "./standards-discovery-BWyNgZSs.mjs";
3
- import { pn as DocsContentAudience } from "./agent-CHgWJcK_.mjs";
4
-
5
- //#region src/analytics.d.ts
6
- declare const DOCS_AGENT_TRACE_EVENT_TYPES: readonly ["run.start", "run.end", "run.error", "user.input", "prompt.build", "retrieval.query", "retrieval.result", "retrieval.error", "model.call", "model.response", "model.stream", "model.error", "tool.call", "tool.result", "tool.error", "retry", "timeout", "error", "agent.final"];
7
- interface DocsAgentTraceContext {
8
- traceId: string;
9
- name: string;
10
- startedAt: string;
11
- startedMs: number;
12
- }
13
- interface ResolvedDocsAnalyticsConfig {
14
- enabled: boolean;
15
- console: false | "log" | "info" | "debug";
16
- includeInputs: boolean;
17
- onEvent?: (event: DocsAnalyticsEvent) => void | Promise<void>;
18
- }
19
- interface ResolvedDocsObservabilityConfig {
20
- enabled: boolean;
21
- console: false | "log" | "info" | "debug";
22
- includeInputs: boolean;
23
- onEvent?: (event: DocsObservabilityEvent) => void | Promise<void>;
24
- }
25
- declare function createDocsAgentTraceId(prefix?: string): string;
26
- declare function createDocsAgentTraceContext(name?: string): DocsAgentTraceContext;
27
- declare function getDocsRequestAnalyticsProperties(request: Request): Record<string, unknown>;
28
- declare function resolveDocsAnalyticsConfig(analytics?: boolean | DocsAnalyticsConfig): ResolvedDocsAnalyticsConfig;
29
- declare function resolveDocsObservabilityConfig(observability?: boolean | DocsObservabilityConfig): ResolvedDocsObservabilityConfig;
30
- declare function emitDocsAnalyticsEvent(analytics: boolean | DocsAnalyticsConfig | undefined, event: DocsAnalyticsEventInput): Promise<void>;
31
- declare function emitDocsObservabilityEvent(observability: boolean | DocsObservabilityConfig | undefined, event: DocsObservabilityEventInput): Promise<void>;
32
- declare function emitDocsAgentTraceEvent(observability: boolean | DocsObservabilityConfig | undefined, event: DocsAgentTraceEventInput): Promise<void>;
33
- //#endregion
34
- //#region src/prompt-utils.d.ts
35
- type PromptAction = "copy" | "open";
36
- interface SerializedOpenDocsProvider {
37
- name: string;
38
- iconHtml?: string;
39
- urlTemplate: string;
40
- promptUrlTemplate?: string;
41
- target?: OpenDocsTarget;
42
- prompt?: string;
43
- }
44
- interface PromptProviderChoice {
45
- name: string;
46
- iconHtml?: string;
47
- urlTemplate: string;
48
- }
49
- type PromptProviderInput = Pick<SerializedOpenDocsProvider, "name" | "iconHtml"> & Partial<Pick<SerializedOpenDocsProvider, "promptUrlTemplate" | "urlTemplate">>;
50
- interface SerializeOpenDocsProviderOptions {
51
- target?: OpenDocsTarget;
52
- prompt?: string;
53
- }
54
- declare const DEFAULT_PROMPT_PROVIDER_TEMPLATES: Record<string, string>;
55
- declare const DEFAULT_OPEN_DOCS_TARGET: OpenDocsTarget;
56
- declare const DEFAULT_OPEN_DOCS_PROMPT = "Read this documentation: {url}";
57
- declare const DEFAULT_OPEN_DOCS_PROVIDER_IDS: readonly ["chatgpt", "claude"];
58
- declare function normalizePromptProviderName(name: string): string;
59
- declare function serializeDocsIcon(icon: unknown): string | undefined;
60
- declare function serializeDocsIconRegistry(icons?: Record<string, unknown>): Record<string, string> | undefined;
61
- declare function serializeOpenDocsProviders(providers?: OpenDocsProvider[], options?: SerializeOpenDocsProviderOptions): SerializedOpenDocsProvider[] | undefined;
62
- declare function serializeOpenDocsProvider(provider: OpenDocsProvider, options?: SerializeOpenDocsProviderOptions): SerializedOpenDocsProvider | undefined;
63
- declare function parsePromptStringArray(value: unknown): string[] | undefined;
64
- declare function resolvePromptProviderChoices(availableProviders?: PromptProviderInput[], preferredNames?: string[]): PromptProviderChoice[];
65
- declare function sanitizePromptText(text: string): string;
66
- //#endregion
67
- //#region src/sitemap.d.ts
68
- declare const DEFAULT_SITEMAP_XML_ROUTE = "/sitemap.xml";
69
- declare const DEFAULT_SITEMAP_MD_ROUTE = "/sitemap.md";
70
- declare const DEFAULT_SITEMAP_MD_DOCS_ROUTE = "/docs/sitemap.md";
71
- declare const DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE = "/.well-known/sitemap.md";
72
- declare const DEFAULT_SITEMAP_MANIFEST_PATH = ".farming-labs/sitemap-manifest.json";
73
- type DocsSitemapFormat = "xml" | "markdown";
74
- interface DocsSitemapPageInput {
75
- slug?: string;
76
- url: string;
77
- /** Override the public Markdown representation URL when it differs from `${url}.md`. */
78
- markdownUrl?: string;
79
- title: string;
80
- description?: string;
81
- related?: ResolvedDocsRelatedLink[];
82
- sourcePath?: string;
83
- lastmod?: string;
84
- lastModified?: string;
85
- }
86
- interface DocsSitemapManifestPage {
87
- url: string;
88
- absoluteUrl?: string;
89
- markdownUrl: string;
90
- title: string;
91
- description?: string;
92
- sourcePath?: string;
93
- lastmod?: string;
94
- lastmodSource?: "git" | "filesystem" | "frontmatter" | "manifest" | "unknown";
95
- related?: string[];
96
- }
97
- interface DocsSitemapManifest {
98
- version: 1;
99
- generatedAt: string;
100
- baseUrl?: string;
101
- entry: string;
102
- siteTitle?: string;
103
- pages: DocsSitemapManifestPage[];
104
- }
105
- interface DocsSitemapResolvedConfig {
106
- enabled: boolean;
107
- routePrefix: string;
108
- baseUrl?: string;
109
- manifestPath: string;
110
- xml: {
111
- enabled: boolean;
112
- includeLastmod: boolean;
113
- route: string;
114
- };
115
- markdown: {
116
- enabled: boolean;
117
- includeDescriptions: boolean;
118
- includeLastmod: boolean;
119
- linkTarget: "html" | "markdown" | "both";
120
- route: string;
121
- docsRoute?: string;
122
- wellKnownRoute: string;
123
- };
124
- }
125
- interface CreateDocsSitemapResponseOptions extends DocsDiscoveryApiRouteOptions {
126
- request: Request;
127
- sitemap?: boolean | DocsSitemapConfig;
128
- entry?: string;
129
- siteTitle?: string;
130
- baseUrl?: string;
131
- pages: DocsSitemapPageInput[];
132
- manifest?: DocsSitemapManifest | null;
133
- }
134
- declare function resolveDocsSitemapConfig(sitemap?: boolean | DocsSitemapConfig, defaults?: {
135
- baseUrl?: string;
136
- }): DocsSitemapResolvedConfig;
137
- declare function resolveDocsSitemapRequest(url: URL, sitemap?: boolean | DocsSitemapConfig, options?: DocsDiscoveryApiRouteOptions): DocsSitemapFormat | null;
138
- declare function toDocsSitemapMarkdownUrl(url: string): string;
139
- declare function buildDocsSitemapManifest(options: {
140
- pages: DocsSitemapPageInput[];
141
- entry?: string;
142
- siteTitle?: string;
143
- baseUrl?: string;
144
- generatedAt?: string;
145
- resolveLastmod?: (page: DocsSitemapPageInput) => {
146
- lastmod?: string;
147
- lastmodSource?: DocsSitemapManifestPage["lastmodSource"];
148
- } | undefined;
149
- }): DocsSitemapManifest;
150
- declare function renderDocsSitemapXml(manifest: DocsSitemapManifest, options?: {
151
- baseUrl?: string;
152
- includeLastmod?: boolean;
153
- }): string;
154
- declare function renderDocsSitemapMarkdown(manifest: DocsSitemapManifest, options?: {
155
- baseUrl?: string;
156
- includeDescriptions?: boolean;
157
- includeLastmod?: boolean;
158
- linkTarget?: "html" | "markdown" | "both";
159
- }): string;
160
- declare function readDocsSitemapManifestFromContentMap(contentMap?: Record<string, string> | null): DocsSitemapManifest | null;
161
- declare function resolveDocsSitemapPageLastmod(manifest: DocsSitemapManifest | null | undefined, url: string): string | undefined;
162
- declare function createDocsSitemapResponse({
163
- request,
164
- apiRoute,
165
- sitemap,
166
- entry,
167
- siteTitle,
168
- baseUrl,
169
- pages,
170
- manifest
171
- }: CreateDocsSitemapResponseOptions): Response | null;
172
- //#endregion
173
- //#region src/search.d.ts
174
- interface DocsAskAIContextResult extends DocsSearchResult {
175
- title: string;
176
- contextContent: string;
177
- }
178
- interface DocsAskAIContext {
179
- context: string;
180
- /** Structured production context blocks; avoids reparsing markdown horizontal rules. */
181
- blocks: Array<{
182
- text: string;
183
- result: DocsAskAIContextResult;
184
- }>;
185
- results: DocsAskAIContextResult[];
186
- searchResults: DocsSearchResult[];
187
- packageHints: DocsAskAIPackageHints;
188
- }
189
- interface DocsAskAIPackageHints {
190
- packages: string[];
191
- imports: string[];
192
- installCommands: string[];
193
- }
194
- /** Normalize scalar or array-valued scope filters for programmatic, HTTP, and MCP callers. */
195
- declare function normalizeDocsSearchFilters(input?: DocsSearchFilterInput | DocsSearchFilters): DocsSearchFilters;
196
- /** Parse the public search scope parameters from a URL query string. */
197
- declare function resolveDocsSearchFilters(searchParams: URLSearchParams): DocsSearchFilters;
198
- declare class DocsSearchRequestError extends Error {
199
- readonly code = "invalid_search_request";
200
- constructor(message: string);
201
- }
202
- declare function resolveDocsSearchError(error: unknown): {
203
- code: "invalid_cursor" | "invalid_search_request";
204
- message: string;
205
- } | undefined;
206
- /** Resolve search filters and the backwards-compatible structured response opt-in. */
207
- declare function resolveDocsSearchRequest(searchParams: URLSearchParams): DocsSearchRequest;
208
- declare function inferDocsAskAIPackageHints(content: string): DocsAskAIPackageHints;
209
- declare function formatDocsAskAIPackageHints(hints: DocsAskAIPackageHints, packageName?: string): string | undefined;
210
- /**
211
- * Build the exact normalized-input projection represented by a retrieval source digest.
212
- * This is public so consumers can independently reproduce `source.digest`.
213
- */
214
- declare function buildDocsRetrievalDigestProjection(page: DocsSearchSourcePage, audience?: DocsContentAudience): string;
215
- declare function resolveDocsRetrievalLastModified(page: DocsSearchSourcePage, audience: DocsContentAudience): string | undefined;
216
- interface BuildDocsContentSnapshotOptions {
217
- pages: readonly DocsSearchSourcePage[];
218
- search?: boolean | DocsSearchConfig;
219
- audience?: DocsContentAudience;
220
- locale?: string;
221
- baseUrl?: string;
222
- /** @internal Precomputed complete-corpus generation for composed callers. */
223
- indexGeneration?: string;
224
- }
225
- /**
226
- * Build a deterministic, body-free inventory for content-change synchronization.
227
- *
228
- * Its generation is identical to structured search for the same pages, audience,
229
- * locale, base URL, and chunking policy.
230
- */
231
- declare function buildDocsContentSnapshot(options: BuildDocsContentSnapshotOptions): Promise<DocsContentSnapshot>;
232
- interface EnrichDocsSearchDocumentsWithProvenanceOptions {
233
- documents: readonly DocsSearchDocument[];
234
- pages: readonly DocsSearchSourcePage[];
235
- audience?: DocsContentAudience;
236
- chunking?: DocsSearchChunkingConfig;
237
- locale?: string;
238
- baseUrl?: string;
239
- indexGeneration?: string;
240
- }
241
- /**
242
- * Attach the same canonical provenance used by built-in search providers.
243
- * Custom adapters can call this before persisting their own hosted records.
244
- */
245
- declare function enrichDocsSearchDocumentsWithProvenance(options: EnrichDocsSearchDocumentsWithProvenanceOptions): Promise<DocsSearchDocument[]>;
246
- declare function buildDocsSearchDocuments(pages: DocsSearchSourcePage[], chunking?: DocsSearchChunkingConfig, audience?: DocsContentAudience): DocsSearchDocument[];
247
- declare function createSimpleSearchAdapter(): DocsSearchAdapter;
248
- declare function createTypesenseSearchAdapter(config: TypesenseDocsSearchConfig): DocsSearchAdapter;
249
- declare function resolveSearchRequestConfig(search: boolean | DocsSearchConfig | undefined, requestUrl?: string): boolean | DocsSearchConfig | undefined;
250
- /**
251
- * Resolve the public search audience without allowing malformed values to opt into agent content.
252
- * Human search remains the default for omitted, legacy, and unknown query values.
253
- */
254
- declare function resolveDocsSearchAudience(value: string | null | undefined): DocsContentAudience;
255
- declare function resolveAskAISearchRequestConfig(options: {
256
- search: boolean | DocsSearchConfig | undefined;
257
- useMcp?: boolean | DocsAskAIMcpConfig;
258
- mcpEndpoint?: string;
259
- mcpEnabled?: boolean;
260
- mcpSearchEnabled?: boolean;
261
- requestUrl?: string;
262
- }): boolean | DocsSearchConfig | undefined;
263
- declare function createMcpSearchAdapter(config: McpDocsSearchConfig): DocsSearchAdapter;
264
- declare function createAlgoliaSearchAdapter(config: AlgoliaDocsSearchConfig): DocsSearchAdapter;
265
- interface PerformDocsSearchOptions {
266
- pages: DocsSearchSourcePage[];
267
- /** @internal Complete corpus used for generation when `pages` is pre-scoped by a caller. */
268
- generationPages?: DocsSearchSourcePage[];
269
- /** @internal Precomputed complete-corpus generation for structured callers. */
270
- indexGeneration?: string;
271
- query: string;
272
- search?: boolean | DocsSearchConfig;
273
- /** Selects which audience projection is searchable. Public site search defaults to human. */
274
- audience?: DocsContentAudience;
275
- locale?: string;
276
- pathname?: string;
277
- siteTitle?: string;
278
- /** Canonical docs URL used to distinguish same-site absolute hits from foreign MCP results. */
279
- baseUrl?: string;
280
- /**
281
- * Canonical origin safe to persist in a hosted index. Pass `null` when `baseUrl`
282
- * came from the current request rather than trusted configuration.
283
- * @internal
284
- */
285
- syncBaseUrl?: string | null;
286
- limit?: number;
287
- /** Opaque continuation cursor used by structured search responses. */
288
- cursor?: string;
289
- /** Optional framework, version, package, and tag constraints. */
290
- filters?: DocsSearchFilterInput;
291
- /**
292
- * Controls provider failures. Runtime search keeps the resilient `fallback` default;
293
- * diagnostics can request `throw` so a broken configured provider cannot be scored as
294
- * successful simple search.
295
- */
296
- failureMode?: "fallback" | "throw";
297
- /**
298
- * Whether non-simple provider hits are supplemented with exact/local simple results.
299
- * Runtime search defaults to true; provider diagnostics can disable supplementation.
300
- */
301
- supplementExternalResults?: boolean;
302
- /** Keep absolute provider origins distinct when no canonical docs origin is available. */
303
- strictExternalOrigins?: boolean;
304
- /** Optional cancellation signal forwarded to adapters and their managed requests. */
305
- signal?: AbortSignal;
306
- }
307
- declare function performDocsSearch(options: PerformDocsSearchOptions): Promise<DocsSearchResult[]>;
308
- interface BuildDocsSearchFacetsOptions {
309
- pages: DocsSearchSourcePage[];
310
- search?: boolean | DocsSearchConfig;
311
- audience?: DocsContentAudience;
312
- locale?: string;
313
- baseUrl?: string;
314
- filters?: DocsSearchFilterInput;
315
- /** Facet field selected for cursor continuation. */
316
- facet?: DocsSearchFilterField;
317
- /** Opaque `nextCursor` returned for the selected facet. */
318
- cursor?: string;
319
- /** Maximum facet values returned per page. Defaults to 100. */
320
- limit?: number;
321
- /** @internal Precomputed complete-corpus generation for composed callers. */
322
- indexGeneration?: string;
323
- }
324
- /**
325
- * Build a body-free index of valid search filter values and page counts.
326
- *
327
- * Each facet applies filters from the other fields while ignoring its own selected
328
- * values. This is the conventional faceted-search behavior and lets an agent discover
329
- * safe alternatives without guessing or fetching document bodies.
330
- */
331
- declare function buildDocsSearchFacets(options: BuildDocsSearchFacetsOptions): Promise<DocsSearchFacetsResponse>;
332
- declare function performDocsSearchWithMetadata(options: PerformDocsSearchOptions): Promise<DocsPaginatedSearchResponse>;
333
- declare function buildDocsAskAIContext(options: {
334
- pages: DocsSearchSourcePage[];
335
- query: string;
336
- search?: boolean | DocsSearchConfig;
337
- locale?: string;
338
- pathname?: string;
339
- siteTitle?: string;
340
- baseUrl?: string; /** See `performDocsSearch.syncBaseUrl`. */
341
- syncBaseUrl?: string | null;
342
- limit?: number;
343
- filters?: DocsSearchFilterInput;
344
- maxContextChars?: number;
345
- maxResultChars?: number; /** See `performDocsSearch.failureMode`. Defaults to resilient runtime fallback. */
346
- searchFailureMode?: "fallback" | "throw"; /** See `performDocsSearch.strictExternalOrigins`. */
347
- strictExternalOrigins?: boolean; /** Optional cancellation signal forwarded to the configured search provider. */
348
- signal?: AbortSignal;
349
- }): Promise<DocsAskAIContext>;
350
- declare function createCustomSearchAdapter(adapter: DocsSearchAdapter | DocsSearchAdapterFactory, options?: {
351
- paginationRevision?: string;
352
- }): CustomDocsSearchConfig;
353
- //#endregion
354
- //#region src/pagination.d.ts
355
- declare class DocsPaginationCursorError extends Error {
356
- readonly code = "invalid_cursor";
357
- constructor();
358
- }
359
- //#endregion
360
- //#region src/content-changes.d.ts
361
- declare const DOCS_CONTENT_CHANGES_FORMAT = "docs-content-changes.v1";
362
- declare const DOCS_CONTENT_SNAPSHOT_FORMAT = "docs-content-snapshot.v1";
363
- declare const DOCS_CONTENT_CHANGES_RESPONSE_VALUE = "changes";
364
- interface DocsContentChangesRequest {
365
- audience: "human" | "agent";
366
- since?: string;
367
- }
368
- interface DocsResolvedContentChangesConfig {
369
- enabled: boolean;
370
- maxSnapshots: number;
371
- loadSnapshot?: DocsAgentContentChangesConfig["loadSnapshot"];
372
- saveSnapshot?: DocsAgentContentChangesConfig["saveSnapshot"];
373
- }
374
- interface ResolveDocsContentChangesOptions extends Omit<BuildDocsContentSnapshotOptions, "pages"> {
375
- pages: readonly DocsSearchSourcePage[];
376
- since?: string;
377
- request?: Request;
378
- }
379
- interface DocsContentChangeFeed {
380
- resolve(options: ResolveDocsContentChangesOptions): Promise<DocsContentChangesResponse>;
381
- }
382
- declare class DocsContentChangesRequestError extends Error {
383
- readonly code = "invalid_content_changes_request";
384
- constructor(message: string);
385
- }
386
- declare function resolveDocsContentChangesConfig(input?: boolean | DocsAgentContentChangesConfig, options?: {
387
- staticExport?: boolean;
388
- }): DocsResolvedContentChangesConfig;
389
- declare function isDocsContentChangesRequest(url: URL): boolean;
390
- declare function resolveDocsContentChangesRequest(url: URL): DocsContentChangesRequest;
391
- declare function createDocsContentChangeFeed(input?: boolean | DocsAgentContentChangesConfig): DocsContentChangeFeed;
392
- declare function createDocsContentChangesHttpResponse(options: {
393
- request: Request;
394
- feed: DocsContentChangeFeed;
395
- pages: readonly DocsSearchSourcePage[];
396
- search?: boolean | DocsSearchConfig;
397
- locale?: string;
398
- baseUrl?: string;
399
- }): Promise<Response>;
400
- //#endregion
401
- //#region src/retrieval-digest.d.ts
402
- /** Validate the bounded HTTP(S) URL or root-relative URI reference used by provenance. */
403
- declare function isDocsRetrievalCanonicalUrl(value: string): boolean;
404
- /**
405
- * Hash a retrieval source projection with portable SHA-256.
406
- *
407
- * The projection is normalized by removing one leading BOM, converting CRLF/CR
408
- * line endings to LF, and trimming trailing whitespace. The helper is exported so
409
- * agents can independently verify provenance in Node, edge, and browser runtimes.
410
- */
411
- declare function digestDocsRetrievalContent(value: string): `sha256:${string}`;
412
- //#endregion
413
- export { DocsSitemapPageInput as $, createSimpleSearchAdapter as A, createDocsAgentTraceContext as At, resolveDocsSearchAudience as B, buildDocsContentSnapshot as C, serializeDocsIconRegistry as Ct, createAlgoliaSearchAdapter as D, DocsAgentTraceContext as Dt, buildDocsSearchFacets as E, DOCS_AGENT_TRACE_EVENT_TYPES as Et, normalizeDocsSearchFilters as F, getDocsRequestAnalyticsProperties as Ft, DEFAULT_SITEMAP_MANIFEST_PATH as G, resolveDocsSearchFilters as H, performDocsSearch as I, resolveDocsAnalyticsConfig as It, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE as J, DEFAULT_SITEMAP_MD_DOCS_ROUTE as K, performDocsSearchWithMetadata as L, resolveDocsObservabilityConfig as Lt, enrichDocsSearchDocumentsWithProvenance as M, emitDocsAgentTraceEvent as Mt, formatDocsAskAIPackageHints as N, emitDocsAnalyticsEvent as Nt, createCustomSearchAdapter as O, ResolvedDocsAnalyticsConfig as Ot, inferDocsAskAIPackageHints as P, emitDocsObservabilityEvent as Pt, DocsSitemapManifestPage as Q, resolveAskAISearchRequestConfig as R, buildDocsAskAIContext as S, serializeDocsIcon as St, buildDocsSearchDocuments as T, serializeOpenDocsProviders as Tt, resolveDocsSearchRequest as U, resolveDocsSearchError as V, resolveSearchRequestConfig as W, DocsSitemapFormat as X, DEFAULT_SITEMAP_XML_ROUTE as Y, DocsSitemapManifest as Z, BuildDocsContentSnapshotOptions as _, SerializedOpenDocsProvider as _t, DOCS_CONTENT_SNAPSHOT_FORMAT as a, renderDocsSitemapXml as at, EnrichDocsSearchDocumentsWithProvenanceOptions as b, resolvePromptProviderChoices as bt, DocsContentChangesRequestError as c, resolveDocsSitemapRequest as ct, createDocsContentChangeFeed as d, DEFAULT_OPEN_DOCS_PROVIDER_IDS as dt, DocsSitemapResolvedConfig as et, createDocsContentChangesHttpResponse as f, DEFAULT_OPEN_DOCS_TARGET as ft, DocsPaginationCursorError as g, SerializeOpenDocsProviderOptions as gt, resolveDocsContentChangesRequest as h, PromptProviderChoice as ht, DOCS_CONTENT_CHANGES_RESPONSE_VALUE as i, renderDocsSitemapMarkdown as it, createTypesenseSearchAdapter as j, createDocsAgentTraceId as jt, createMcpSearchAdapter as k, ResolvedDocsObservabilityConfig as kt, DocsResolvedContentChangesConfig as l, toDocsSitemapMarkdownUrl as lt, resolveDocsContentChangesConfig as m, PromptAction as mt, isDocsRetrievalCanonicalUrl as n, createDocsSitemapResponse as nt, DocsContentChangeFeed as o, resolveDocsSitemapConfig as ot, isDocsContentChangesRequest as p, DEFAULT_PROMPT_PROVIDER_TEMPLATES as pt, DEFAULT_SITEMAP_MD_ROUTE as q, DOCS_CONTENT_CHANGES_FORMAT as r, readDocsSitemapManifestFromContentMap as rt, DocsContentChangesRequest as s, resolveDocsSitemapPageLastmod as st, digestDocsRetrievalContent as t, buildDocsSitemapManifest as tt, ResolveDocsContentChangesOptions as u, DEFAULT_OPEN_DOCS_PROMPT as ut, BuildDocsSearchFacetsOptions as v, normalizePromptProviderName as vt, buildDocsRetrievalDigestProjection as w, serializeOpenDocsProvider as wt, PerformDocsSearchOptions as x, sanitizePromptText as xt, DocsSearchRequestError as y, parsePromptStringArray as yt, resolveDocsRetrievalLastModified as z };