Conflict resolution notes: - package.json/run-gates: both sides' new doc-sync gates kept (master's scoped-events/readme gates + this branch's website-api/website-yaml); js-yaml devDeps deduped (master added them independently). - pnpm-workspace/knip: website AND python/sdk-runtime entries kept. - doc-typecheck/verify-type-equiv: master's condensed headers kept, website glob retained in both scan scopes. - vendor/cordis/src/fiber.ts: master's lifecycle-hardening code taken; this branch's richer FiberState JSDoc reapplied on top. vendor/README.md logs both local modifications (hardening = 6, JSDoc enrichment = 7). - pnpm-lock: regenerated from master's side (pnpm install). Post-merge sync the gates forced (the system working as designed): - verify-website-yaml caught 4 stale plugin names from master's package reorg (dsh-stdio-agent -> dsh-stdio-demo, dsh-acp-agent -> dsh-acp-demo); 8 references fixed across guide/ and develop/. - gen-website-api picked up master's 6 new services automatically (ctx.approval/permission/sandbox/sessionQuery/skills/tasks -> 6 new pages + sidebar); api/index.md hub updated to list them. - AGENTS.md budget ceiling 1370 -> 1400: the website rows (layout line + two command lines) and master's own growth collided with the old ceiling; all three website rows are load-bearing (new top-level dir, new CI command).
3.3 KiB
ctx.web
WebService — provided by @deepseek-ai/dsh-web.
The web access service. Registered as ctx.web (one instance per context).
Selection semantics (resolved at execution time, never order-dependent):
- A configured id that is registered and
available()→ that provider. - A configured id not registered →
WEB_PROVIDER_CONFIGURED_MISSING. - A configured id registered but unavailable →
WEB_PROVIDER_CONFIGURED_UNAVAILABLE. - No id configured, exactly one registered usable provider → that provider.
- No id configured, multiple usable providers →
WEB_PROVIDER_AMBIGUOUS. - No id configured, no usable provider →
WEB_PROVIDER_UNAVAILABLE.
ctx.web.registerSearchProvider(provider)
registerSearchProvider(provider: WebSearchProvider): () => void
Register a search provider. Throws WebError WEB_DUPLICATE_PROVIDER if its id is already registered for search. Returns a disposer; disposed with the calling fiber.
provider— the provider; itsidis the registry key.
Returns the disposer that unregisters the provider.
ctx.web.registerFetchProvider(provider)
registerFetchProvider(provider: WebFetchProvider): () => void
Register a fetch provider. Throws WebError WEB_DUPLICATE_PROVIDER if its id is already registered for fetch. Returns a disposer; disposed with the calling fiber.
provider— the provider; itsidis the registry key.
Returns the disposer that unregisters the provider.
ctx.web.search(request, signal?)
async search(request: WebSearchRequest, signal?: AbortSignal): Promise<WebSearchResult>
Run one search through the selected provider. Resolves the provider at call time with the selection rules above; throws WebError when the capability cannot run. The seam enforces request.maxResults on the result: if the provider over-returns, sources[] is truncated and truncated set.
request— the query plus result-shaping options.signal— optional cancellation signal forwarded to the provider.
Returns the provider's results, capped to request.maxResults.
ctx.web.fetch(request, signal?)
async fetch(request: WebFetchRequest, signal?: AbortSignal): Promise<WebFetchResult>
Retrieve one URL through the selected provider. Resolves the provider at call time with the selection rules above; throws WebError when the capability cannot run. A non-2xx response is a result, not a throw.
request— the URL plus retrieval options.signal— optional cancellation signal forwarded to the provider.
Returns the retrieval outcome; non-2xx responses resolve descriptively.