dsh-plugin-dev-kb 1.8.0 → 1.8.1

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 (229) hide show
  1. package/CHANGELOG.md +186 -178
  2. package/README.en.md +172 -172
  3. package/README.md +183 -183
  4. package/kb/INDEX.md +236 -234
  5. package/kb/README.md +88 -88
  6. package/kb/extra/AGENTS.md +77 -77
  7. package/kb/extra/deepseek-llm-api-wire-extensions.md +162 -162
  8. package/kb/extra/deepseek-llm-api-wire-extensions.zh.md +162 -162
  9. package/kb/extra/defensive-patterns/package-surface.md +233 -232
  10. package/kb/extra/defensive-patterns/package-surface.zh.md +233 -232
  11. package/kb/extra/defensive-patterns/remote-and-api.md +117 -117
  12. package/kb/extra/defensive-patterns/remote-and-api.zh.md +117 -117
  13. package/kb/extra/development.md +221 -221
  14. package/kb/extra/development.zh.md +228 -228
  15. package/kb/extra/event-producer-consumer.md +133 -123
  16. package/kb/extra/event-producer-consumer.zh.md +135 -125
  17. package/kb/extra/module-graph.md +1961 -1888
  18. package/kb/extra/module-graph.zh.md +1963 -1890
  19. package/kb/extra/persistence-changes/2026-11-05-timeline-priority-notice.md +60 -0
  20. package/kb/extra/persistence-changes/2026-11-05-timeline-priority-notice.zh.md +60 -0
  21. package/kb/extra/persistence-changes/README.md +92 -92
  22. package/kb/extra/persistence-changes/README.zh.md +92 -92
  23. package/kb/extra/persistence-changes/historical-formats/README.md +75 -75
  24. package/kb/extra/persistence-changes/historical-formats/README.zh.md +75 -75
  25. package/kb/extra/persistence-changes/releases/README.md +103 -103
  26. package/kb/extra/persistence-changes/releases/README.zh.md +103 -103
  27. package/kb/extra/rescope.md +55 -55
  28. package/kb/extra/rescope.zh.md +55 -55
  29. package/kb/extra/subsystems/boot.md +631 -621
  30. package/kb/extra/subsystems/boot.zh.md +631 -621
  31. package/kb/extra/subsystems/computer-use.md +179 -137
  32. package/kb/extra/subsystems/computer-use.zh.md +179 -137
  33. package/kb/extra/subsystems/extensions.md +387 -384
  34. package/kb/extra/subsystems/extensions.zh.md +387 -384
  35. package/kb/extra/subsystems/feedback.md +418 -400
  36. package/kb/extra/subsystems/feedback.zh.md +418 -400
  37. package/kb/extra/subsystems/forge.md +2169 -1226
  38. package/kb/extra/subsystems/forge.zh.md +2171 -1226
  39. package/kb/extra/subsystems/liveshare.md +167 -158
  40. package/kb/extra/subsystems/liveshare.zh.md +167 -158
  41. package/kb/extra/subsystems/mcp.md +237 -234
  42. package/kb/extra/subsystems/mcp.zh.md +237 -234
  43. package/kb/extra/subsystems/office-kit.md +122 -0
  44. package/kb/extra/subsystems/office-kit.zh.md +122 -0
  45. package/kb/extra/subsystems/working-directory.md +95 -64
  46. package/kb/extra/subsystems/working-directory.zh.md +95 -64
  47. package/kb/extra/subsystems/worktrees.md +187 -127
  48. package/kb/extra/subsystems/worktrees.zh.md +187 -127
  49. package/kb/extra/upgrade-guide/v0.2.1-alpha.1/python-ptc-sandbox/guide.md +21 -21
  50. package/kb/extra/upgrade-guide/v0.2.1-alpha.1/python-ptc-sandbox/guide.zh.md +21 -21
  51. package/kb/extra/upgrade-guide/v0.2.1-rc.4/sandbox-unsupported-policy-error/guide.md +18 -0
  52. package/kb/extra/upgrade-guide/v0.2.1-rc.4/sandbox-unsupported-policy-error/guide.zh.md +18 -0
  53. package/kb/extra/upgrade-guide/v0.2.2-alpha.2/llm-error-builtin-codes/guide.md +18 -0
  54. package/kb/extra/upgrade-guide/v0.2.2-alpha.2/llm-error-builtin-codes/guide.zh.md +18 -0
  55. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-kit-package/guide.md +34 -0
  56. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-kit-package/guide.zh.md +34 -0
  57. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-operation-tools/guide.md +49 -0
  58. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-operation-tools/guide.zh.md +49 -0
  59. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-skill-resources/guide.md +36 -0
  60. package/kb/extra/upgrade-guide/v0.2.2-alpha.3/office-skill-resources/guide.zh.md +36 -0
  61. package/kb/extra/upgrade-guide/v0.2.2-rc.1/account-notification-fields/guide.md +26 -0
  62. package/kb/extra/upgrade-guide/v0.2.2-rc.1/account-notification-fields/guide.zh.md +26 -0
  63. package/kb/extra/upgrade-guide/v0.2.2-rc.1/account-remote-provider/guide.md +22 -0
  64. package/kb/extra/upgrade-guide/v0.2.2-rc.1/account-remote-provider/guide.zh.md +22 -0
  65. package/kb/extra/upgrade-guide/v0.2.2-rc.1/archive-worktrees/guide.md +21 -0
  66. package/kb/extra/upgrade-guide/v0.2.2-rc.1/archive-worktrees/guide.zh.md +21 -0
  67. package/kb/extra/upgrade-guide/v0.2.2-rc.1/attachment-error-codes/guide.md +23 -0
  68. package/kb/extra/upgrade-guide/v0.2.2-rc.1/attachment-error-codes/guide.zh.md +23 -0
  69. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-ax-read-limits/guide.md +20 -0
  70. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-ax-read-limits/guide.zh.md +20 -0
  71. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-hover-ax-only/guide.md +18 -0
  72. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-hover-ax-only/guide.zh.md +18 -0
  73. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-native-platform/guide.md +23 -0
  74. package/kb/extra/upgrade-guide/v0.2.2-rc.1/cua-native-platform/guide.zh.md +23 -0
  75. package/kb/extra/upgrade-guide/v0.2.2-rc.1/dsh-doc-skill/guide.md +35 -0
  76. package/kb/extra/upgrade-guide/v0.2.2-rc.1/dsh-doc-skill/guide.zh.md +35 -0
  77. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-change-request-overview/guide.md +26 -0
  78. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-change-request-overview/guide.zh.md +26 -0
  79. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-pinned-diff/guide.md +26 -0
  80. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-pinned-diff/guide.zh.md +26 -0
  81. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-review-reads/guide.md +19 -0
  82. package/kb/extra/upgrade-guide/v0.2.2-rc.1/forge-review-reads/guide.zh.md +19 -0
  83. package/kb/extra/upgrade-guide/v0.2.2-rc.1/package-export-cleanup/guide.md +26 -0
  84. package/kb/extra/upgrade-guide/v0.2.2-rc.1/package-export-cleanup/guide.zh.md +26 -0
  85. package/kb/extra/upgrade-guide/v0.2.2-rc.1/plugin-update-method/guide.md +22 -0
  86. package/kb/extra/upgrade-guide/v0.2.2-rc.1/plugin-update-method/guide.zh.md +22 -0
  87. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-bootstrap-protocol/guide.md +25 -0
  88. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-bootstrap-protocol/guide.zh.md +25 -0
  89. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-inspect-output/guide.md +48 -0
  90. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-inspect-output/guide.zh.md +48 -0
  91. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-scoped-repl-default/guide.md +45 -0
  92. package/kb/extra/upgrade-guide/v0.2.2-rc.1/ptc-scoped-repl-default/guide.zh.md +45 -0
  93. package/kb/extra/upgrade-guide/v0.2.2-rc.1/runtime-context-reminders/guide.md +19 -0
  94. package/kb/extra/upgrade-guide/v0.2.2-rc.1/runtime-context-reminders/guide.zh.md +19 -0
  95. package/kb/extra/upgrade-guide/v0.2.2-rc.1/session-append-overloads/guide.md +17 -0
  96. package/kb/extra/upgrade-guide/v0.2.2-rc.1/session-append-overloads/guide.zh.md +17 -0
  97. package/kb/extra/upgrade-guide/v0.2.2-rc.1/subagent-interrupt-default/guide.md +27 -0
  98. package/kb/extra/upgrade-guide/v0.2.2-rc.1/subagent-interrupt-default/guide.zh.md +27 -0
  99. package/kb/extra/upgrade-guide/v0.2.2-rc.1/terminal-backend-cleanup-error/guide.md +20 -0
  100. package/kb/extra/upgrade-guide/v0.2.2-rc.1/terminal-backend-cleanup-error/guide.zh.md +20 -0
  101. package/kb/extra/upgrade-guide/v0.2.2-rc.1/terminal-bundle-sidebar-backend/guide.md +19 -0
  102. package/kb/extra/upgrade-guide/v0.2.2-rc.1/terminal-bundle-sidebar-backend/guide.zh.md +19 -0
  103. package/kb/extra/upgrade-guide/v0.2.2-rc.1/web-fetch-transport-error-codes/guide.md +18 -0
  104. package/kb/extra/upgrade-guide/v0.2.2-rc.1/web-fetch-transport-error-codes/guide.zh.md +18 -0
  105. package/kb/extra/upgrade-guide/v0.2.2-rc.1/web-search-billing/guide.md +41 -0
  106. package/kb/extra/upgrade-guide/v0.2.2-rc.1/web-search-billing/guide.zh.md +41 -0
  107. package/kb/extra/upgrade-guide/v0.2.2-rc.1/window-drag-regions/guide.md +21 -0
  108. package/kb/extra/upgrade-guide/v0.2.2-rc.1/window-drag-regions/guide.zh.md +21 -0
  109. package/kb/extra/upgrade-guide/v0.2.2-rc.2/client-module-metadata/guide.md +29 -0
  110. package/kb/extra/upgrade-guide/v0.2.2-rc.2/client-module-metadata/guide.zh.md +29 -0
  111. package/kb/extra/upgrade-guide/v0.2.2-rc.2/connection-page-peer/guide.md +25 -0
  112. package/kb/extra/upgrade-guide/v0.2.2-rc.2/connection-page-peer/guide.zh.md +25 -0
  113. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cordis-root-and-intercept-metadata/guide.md +31 -0
  114. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cordis-root-and-intercept-metadata/guide.zh.md +31 -0
  115. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-agents-without-preset/guide.md +24 -0
  116. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-agents-without-preset/guide.zh.md +24 -0
  117. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-macos-provider/guide.md +24 -0
  118. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-macos-provider/guide.zh.md +24 -0
  119. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-partial-observations/guide.md +19 -0
  120. package/kb/extra/upgrade-guide/v0.2.2-rc.2/cua-partial-observations/guide.zh.md +19 -0
  121. package/kb/extra/upgrade-guide/v0.2.2-rc.2/deepseek-files-timeout/guide.md +15 -0
  122. package/kb/extra/upgrade-guide/v0.2.2-rc.2/deepseek-files-timeout/guide.zh.md +15 -0
  123. package/kb/extra/upgrade-guide/v0.2.2-rc.2/experimental-tool-error-codes/guide.md +28 -0
  124. package/kb/extra/upgrade-guide/v0.2.2-rc.2/experimental-tool-error-codes/guide.zh.md +28 -0
  125. package/kb/extra/upgrade-guide/v0.2.2-rc.2/package-export-cleanup/guide.md +36 -0
  126. package/kb/extra/upgrade-guide/v0.2.2-rc.2/package-export-cleanup/guide.zh.md +36 -0
  127. package/kb/extra/upgrade-guide/v0.2.2-rc.2/python-ptc-removal/guide.md +22 -0
  128. package/kb/extra/upgrade-guide/v0.2.2-rc.2/python-ptc-removal/guide.zh.md +22 -0
  129. package/kb/extra/upgrade-guide/v0.2.2-rc.2/session-status-package/guide.md +31 -0
  130. package/kb/extra/upgrade-guide/v0.2.2-rc.2/session-status-package/guide.zh.md +31 -0
  131. package/kb/extra/upgrade-guide/v0.2.2-rc.2/shared-search-filter/guide.md +18 -0
  132. package/kb/extra/upgrade-guide/v0.2.2-rc.2/shared-search-filter/guide.zh.md +18 -0
  133. package/kb/extra/upgrade-guide/v0.2.2-rc.2/shell-fs-tool-error-codes/guide.md +30 -0
  134. package/kb/extra/upgrade-guide/v0.2.2-rc.2/shell-fs-tool-error-codes/guide.zh.md +30 -0
  135. package/kb/extra/web-styling.md +57 -57
  136. package/kb/extra/web-styling.zh.md +57 -57
  137. package/kb/meta/search-index.json +4508 -3980
  138. package/kb/meta/source.json +18 -18
  139. package/kb/site/develop/practice/llm-adapter.md +192 -192
  140. package/kb/site/en/develop/practice/llm-adapter.md +192 -192
  141. package/kb/site/en/guide/desktop-uninstall-cleanup.md +63 -0
  142. package/kb/site/en/guide/plugin-market.md +153 -151
  143. package/kb/site/en/guide/providers.md +234 -234
  144. package/kb/site/en/guide/quickstart.md +35 -34
  145. package/kb/site/en/reference/capability-seams.md +789 -767
  146. package/kb/site/en/reference/config-catalog.md +5432 -5128
  147. package/kb/site/en/reference/cookbook/adding-a-package.md +175 -175
  148. package/kb/site/en/reference/cookbook/adding-a-tool.md +105 -104
  149. package/kb/site/en/reference/cookbook/extension-cookbook.md +178 -135
  150. package/kb/site/en/reference/cordis-api/context.md +373 -369
  151. package/kb/site/en/reference/cordis-api/fiber.md +457 -433
  152. package/kb/site/en/reference/cordis-api/inherited.md +44 -44
  153. package/kb/site/en/reference/cordis-api/service.md +118 -107
  154. package/kb/site/en/reference/experimental-persistence-catalog.md +36 -23
  155. package/kb/site/en/reference/index.md +174 -174
  156. package/kb/site/en/reference/persistence-catalog.md +9453 -9432
  157. package/kb/site/en/reference/subsystems/compaction.md +288 -288
  158. package/kb/site/en/reference/subsystems/core.md +1172 -1171
  159. package/kb/site/en/reference/subsystems/credentials.md +526 -497
  160. package/kb/site/en/reference/subsystems/filesystem.md +708 -708
  161. package/kb/site/en/reference/subsystems/index.md +82 -82
  162. package/kb/site/en/reference/subsystems/llm-streaming.md +1290 -1288
  163. package/kb/site/en/reference/subsystems/lsp.md +230 -206
  164. package/kb/site/en/reference/subsystems/persistence.md +451 -432
  165. package/kb/site/en/reference/subsystems/plan.md +91 -91
  166. package/kb/site/en/reference/subsystems/ptc-runtime.md +295 -261
  167. package/kb/site/en/reference/subsystems/sandbox.md +250 -232
  168. package/kb/site/en/reference/subsystems/session-query.md +525 -515
  169. package/kb/site/en/reference/subsystems/session-reference.md +231 -229
  170. package/kb/site/en/reference/subsystems/session.md +1478 -1431
  171. package/kb/site/en/reference/subsystems/sidebar-right.md +165 -165
  172. package/kb/site/en/reference/subsystems/skills.md +356 -356
  173. package/kb/site/en/reference/subsystems/slots.md +235 -231
  174. package/kb/site/en/reference/subsystems/terminal.md +188 -188
  175. package/kb/site/en/reference/subsystems/tools.md +902 -891
  176. package/kb/site/en/reference/subsystems/user-questions.md +330 -327
  177. package/kb/site/en/reference/subsystems/web-client.md +161 -104
  178. package/kb/site/en/reference/subsystems/web-server.md +434 -351
  179. package/kb/site/en/reference/subsystems/web.md +268 -268
  180. package/kb/site/en/reference/subsystems/workflow.md +287 -282
  181. package/kb/site/en/reference/subsystems/workspace.md +743 -651
  182. package/kb/site/en/reference/tool-catalog.md +2867 -2704
  183. package/kb/site/guide/desktop-uninstall-cleanup.md +63 -0
  184. package/kb/site/guide/plugin-market.md +153 -151
  185. package/kb/site/guide/providers.md +234 -234
  186. package/kb/site/guide/quickstart.md +35 -34
  187. package/kb/site/reference/capability-seams.md +789 -767
  188. package/kb/site/reference/config-catalog.md +5432 -5128
  189. package/kb/site/reference/cookbook/adding-a-package.md +175 -175
  190. package/kb/site/reference/cookbook/adding-a-tool.md +107 -106
  191. package/kb/site/reference/cookbook/extension-cookbook.md +182 -139
  192. package/kb/site/reference/cordis-api/context.md +373 -369
  193. package/kb/site/reference/cordis-api/fiber.md +459 -435
  194. package/kb/site/reference/cordis-api/inherited.md +44 -44
  195. package/kb/site/reference/cordis-api/service.md +118 -107
  196. package/kb/site/reference/experimental-persistence-catalog.md +36 -23
  197. package/kb/site/reference/index.md +178 -178
  198. package/kb/site/reference/persistence-catalog.md +9453 -9432
  199. package/kb/site/reference/subsystems/compaction.md +288 -288
  200. package/kb/site/reference/subsystems/core.md +1184 -1183
  201. package/kb/site/reference/subsystems/credentials.md +526 -497
  202. package/kb/site/reference/subsystems/filesystem.md +708 -708
  203. package/kb/site/reference/subsystems/index.md +82 -82
  204. package/kb/site/reference/subsystems/llm-streaming.md +1296 -1294
  205. package/kb/site/reference/subsystems/lsp.md +230 -206
  206. package/kb/site/reference/subsystems/persistence.md +451 -432
  207. package/kb/site/reference/subsystems/plan.md +91 -91
  208. package/kb/site/reference/subsystems/ptc-runtime.md +295 -261
  209. package/kb/site/reference/subsystems/sandbox.md +250 -232
  210. package/kb/site/reference/subsystems/session-query.md +525 -515
  211. package/kb/site/reference/subsystems/session-reference.md +231 -229
  212. package/kb/site/reference/subsystems/session.md +1482 -1435
  213. package/kb/site/reference/subsystems/sidebar-right.md +165 -165
  214. package/kb/site/reference/subsystems/skills.md +356 -356
  215. package/kb/site/reference/subsystems/slots.md +239 -235
  216. package/kb/site/reference/subsystems/terminal.md +188 -188
  217. package/kb/site/reference/subsystems/tools.md +902 -891
  218. package/kb/site/reference/subsystems/user-questions.md +330 -327
  219. package/kb/site/reference/subsystems/web-client.md +161 -104
  220. package/kb/site/reference/subsystems/web-server.md +434 -351
  221. package/kb/site/reference/subsystems/web.md +268 -268
  222. package/kb/site/reference/subsystems/workflow.md +287 -282
  223. package/kb/site/reference/subsystems/workspace.md +743 -651
  224. package/kb/site/reference/tool-catalog.md +2872 -2709
  225. package/lib/index.js +359 -359
  226. package/package.json +68 -68
  227. package/skills/dsh-plugin-dev-kb.md +71 -70
  228. package/kb/extra/subsystems/office-to-pdf.md +0 -87
  229. package/kb/extra/subsystems/office-to-pdf.zh.md +0 -87
@@ -1,351 +1,434 @@
1
- ---
2
- editSource: "docs/subsystems/web-server.zh.md"
3
- rawMarkdownPath: "reference/subsystems/web-server.md"
4
- outline: [2,3]
5
- ---
6
-
7
- # HTTP 服务器
8
-
9
- [dsh-host-webserver](https://github.com/deepseek-ai/deepseek-harness/tree/master/packages/host/webserver) 是 GUI Host 的浏览器 HTTP 载体:一个 `node:http` 服务器——配置 `tls` 时改用 `node:https`——提供 `ctx.webServer`、具名路由注册表、可选的 gzip 响应压缩、index.html 转换回调,以及一个可由插件认领的回退(handler 或 resource)。它不属于 agent loop(智能体循环),也不是能力 seam;它唯一涉及的 harness 概念是 index 渲染所代表的 Peer。其他插件负责注册所有功能路由,包括 `/api` 桥接、插件 bundle 和 HMR(热模块替换)事件流([分层说明](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/boot/app-boot/README.zh.md))。该服务器只服务浏览器:Electron 通过 `file://` 加载已构建文件,并经 IPC 桥接发送 fetch 请求,不使用本服务器。
10
-
11
- 源码:[`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
12
-
13
- ## 路由
14
-
15
- ```ts type-equiv
16
- /** Route match kind: 'exact' matches the pathname verbatim; 'prefix' p matches p and p/<anything>. */
17
- type WebRouteKind = 'exact' | 'prefix'
18
- ```
19
-
20
- ```ts type-equiv
21
- /** One named route registration. */
22
- interface WebRoute {
23
- kind: WebRouteKind
24
- /** Absolute pathname, no trailing slash. */
25
- path: string
26
- /** Owns the full response lifecycle (may hold the response open, e.g. SSE). */
27
- handler: (req: IncomingMessage, res: ServerResponse) => void | Promise<void>
28
- }
29
- ```
30
-
31
- ```ts type-equiv
32
- /**
33
- * Answers one GET or HEAD request with a Fetch response. An HTTP request
34
- * arrives without a Peer and carries the client's headers; an in-process
35
- * {@link WebServer.readResource} read passes the Peer its caller admitted.
36
- */
37
- type WebResource = (request: Request, peer?: PeerScope) => Promise<Response>
38
- ```
39
-
40
- ```ts type-equiv
41
- /** One named route answered by a resource instead of a handler. */
42
- interface WebResourceRoute {
43
- kind: WebRouteKind
44
- /** Absolute pathname, no trailing slash. */
45
- path: string
46
- /** Answers HTTP GET and HEAD requests and in-process reads. */
47
- resource: WebResource
48
- }
49
- ```
50
-
51
- 匹配顺序固定:先查 exact 表,再取最长匹配前缀,最后落到已注册的回退。注册顺序不携带任何面向请求的语义:具名路由在组合上互不相交,任何未被具名路由认领的请求都由回退席位应答;席位只有一个所有者,第二次注册会抛出异常。发布的 Web 组合用 [`dsh-host-frontend-static`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/frontend-static/src/index.ts) 认领席位,即遵循固定语义的 SPA dist 服务器:Connection 在读取 dist 根目录和配置 index 的 HTML 前完成认证;非 index 资产保持公开;非 GET/HEAD 返回 405,越出 dist 根目录的遍历返回 403,现有文件直接提供,缺失或不是文件的目标返回空的 404,未知扩展名按 octet-stream 发送。
52
-
53
- 路由或回退可以用 resource——一个把 Fetch `Request` 映射为 `Response` 的函数——代替 handler。HTTP 的 `GET`、`HEAD` 请求不带 Peer 到达它,`readResource(request, peer)` 则在进程内按调用方准入的 Peer 读取它;读取遵循同样的匹配顺序但只到达 resource,因此返回 owner 私有数据或会执行操作的路由即使应答 `GET` 也保持为 handler。
54
-
55
- <a id="config"></a>
56
-
57
- ## 配置
58
-
59
- ```ts type-equiv
60
- /** Web server listen, TLS, and response-compression config. */
61
- interface Config {
62
- /**
63
- * Listen address: a concrete IPv4 or IPv6 literal of one local interface,
64
- * for example the container's own Pod address from `hostname -i`. A loopback
65
- * literal (any address in 127/8, `::1`, or a mapped form of either) keeps the
66
- * server on this machine; any other literal serves the network that address
67
- * belongs to, over plain HTTP unless `tls` is set. The unspecified address —
68
- * IPv4 any, IPv6 any, and the IPv4-mapped forms of IPv4 any — is rejected at
69
- * load: it would expose the port on every interface at once.
70
- */
71
- host: string
72
- /** Listen port; zero requests an OS-assigned port. */
73
- port: number
74
- /**
75
- * Serve HTTPS with this certificate and key instead of plain HTTP. Both files
76
- * are read once, before the listener binds: an unreadable or empty file,
77
- * invalid PEM, or a key that does not match the certificate rejects
78
- * initialization rather than falling back to HTTP. The material is never
79
- * re-read, so replacing a certificate takes a reload. Omitted or null listens
80
- * over plain HTTP.
81
- */
82
- tls?: TlsConfig
83
- /** Response compression for socket-backed HTTP requests. @default 'none' */
84
- compression?: 'none' | 'gzip'
85
- /** Gzip DEFLATE level from 0 through 9. @default 1 */
86
- compressionLevel?: number
87
- /** Minimum known response length eligible for gzip; unknown-length streams are eligible. @default 1024 */
88
- compressionThresholdBytes?: number
89
- }
90
- ```
91
-
92
- ```ts type-equiv
93
- /**
94
- * TLS material for the HTTPS listener: one certificate chain file and the
95
- * private key file it pairs with. Both hold PEM text and both resolve against
96
- * the process working directory.
97
- */
98
- interface TlsConfig {
99
- /** Certificate chain file, leaf certificate first, PEM, no passphrase. */
100
- certFile: string
101
- /** Private key file for the chain's leaf certificate; unencrypted PEM. */
102
- keyFile: string
103
- }
104
- ```
105
-
106
- 没有组合能一次性绑定所有网络接口:未指定地址在加载时即被拒绝。导出的 `isWildcardHost` 与 `isLoopbackHost` 按解析后的地址值分类,IPv6 的 `%zone` 会保留给 `listen`,而分类只读取地址本身。载体不拥有认证或 Origin 策略,并且除非 `tls` 提供证书与密钥,否则以明文 HTTP 提供服务。`compression` 默认为 `none`;随附的 Web 组合选择 gzip level 1 和 1024 字节阈值。随附的 `dsh web` 命令默认选择 loopback 并接受一个具体的 `--host` 地址,非 loopback 绑定以明文 HTTP 提供服务时会在启动时警告;其 Connection 插件为每个 Host API route 与 stream 提供 Host/Origin 校验和浏览器会话认证,绑定地址加 `--trusted-host` 决定接受哪个浏览器 Host;`--public-url` 只改变公告的 URL。其他组合自行拥有绑定与路由认证策略。dist 位置是认领席位的前端插件的组装事实。
107
-
108
- ## 服务
109
-
110
- `WebServer`(`ctx.webServer`)在激活时立即监听;监听失败(EADDRINUSE 等)会使初始化被拒绝,启动进程会报告失败的 fiber。`tls` 证书对在监听器绑定前读取一次;文件不可读、为空或二者不匹配时同样会使初始化被拒绝,而不是回退到 HTTP。`register(route)` 添加一条具名路由并返回其 disposer;重复的 `(kind, path)` 抛出异常,因为路由模式是组合层约定,冲突即配置错误。Gzip 在服务器内部包装符合条件且基于 socket 的响应,因此 handler 继续直接持有 `ServerResponse`,resource 则把 `Response` 交给服务写回。已有内容编码、`Cache-Control: no-transform`、范围响应、SSE、ZIP 与打包后的 `.gz` Worker 镜像均保持 identity 响应。`collectIndexInjections(peer)` 经一次传入页面所代表 Peer 的 `webserver/index-inject` emit 收集结构化 `IndexInjection` 行,`renderIndex(html, peer)` 把它们渲染进成功的根路径和配置 index 响应,随后再按注册顺序应用原始的 `tapIndex(transform)` 逃生口转换;[dsh-client-modules](https://github.com/deepseek-ai/deepseek-harness/tree/master/packages/client/modules) 以启动 manifest(元数据清单)行回应该事件。`port` 读取监听端口,包括 `config.port` 为 0 时操作系统分配的端口,`protocol` 则报告监听器提供的协议(`http:` 或 `https:`)。
111
-
112
- 处理过程中抛出异常的请求(畸形的 % 转义撞上 `decodeURIComponent`、客户端在请求体中途断开)会记录为警告并应答 400(响应头已发出时则销毁 socket),绝不导致进程退出。dispose(资源释放)把 `close()` 与 `closeAllConnections()` 配对使用,因为处理器可能像 SSE(Server-Sent Events)那样保持响应打开,而这类连接永远不会自行结束;没有强制关闭,拆卸就会挂起。TLS socket 只有完成握手后才计入连接,因此服务器会把原始 TLS socket 与升级后的 socket 一并跟踪,并在 dispose 时销毁两者。该包从不打印输出:URL 行归 shell 所有。逐包运维细节(含开发模式的 bundle 监视流水线)留在 [README](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/README.zh.md) 中。
113
-
114
- <!-- BEGIN GENERATED cordis-surface (gen-cordis-catalog.ts) — do not edit between markers -->
115
-
116
- <a id="cordis-surface"></a>
117
-
118
- ## Cordis API
119
-
120
- Generated from source by `scripts/gen-cordis-catalog.ts` (verified fresh by `pnpm run verify-cordis-catalog` in doc-sync; regenerate with `pnpm run gen-cordis-catalog`) — the language sides differ only in locale-specific paired document paths. Signature blocks use a `ts cordis-catalog` fence and keep the original source JSDoc; dispatch modes are defined in the [primer](../cordis-primer.md#dispatch-modes), and the framework-inherited `ctx` API lives in [cordis-api/inherited.md](../cordis-api/inherited.md).
121
-
122
- <a id="ctxconnection--hostconnectionhandle"></a>
123
-
124
- ### `ctx.connection` — `HostConnectionHandle`
125
-
126
- Host `ctx.connection` members consumed by transport-independent adapters.
127
-
128
- ```ts cordis-catalog
129
- /**
130
- * Compose exact Fetch routes and the shared-channel RPC interceptor.
131
- * @param channel - shared channel mounted by Connection.
132
- * @returns Fetch handler for trusted, authenticated requests.
133
- */
134
- createSharedFetchHandler(channel: '/api'): ConnectionFetchHandler
135
-
136
- /**
137
- * Apply Connection's Host/Origin checks and browser authentication to
138
- * another Web route.
139
- * @param request - request headers from the HTTP or upgrade request.
140
- * @returns rejection status, or undefined when the route may accept the request.
141
- */
142
- requestRejection(request: ConnectionTrustRequest): ConnectionRequestRejection
143
-
144
- /**
145
- * Admit an HTTP request against its signed browser or API credential and live Peer.
146
- * @param request - request headers from the HTTP or upgrade request.
147
- * @returns the credential's Peer, or the rejection status.
148
- */
149
- admit(request: ConnectionTrustRequest): PeerAdmission
150
-
151
- /**
152
- * Create an independent in-process Peer, disposed with the Context that read `ctx.connection`.
153
- * @param options - fixed principal and optional interaction participation (default `answer`).
154
- * @returns a new Peer distinct from every other Peer.
155
- */
156
- createPeer(options: { readonly principal: Principal; readonly interactions?: 'answer' | 'none' }): PeerScope
157
-
158
- /**
159
- * Claim a physical socket for an API Peer; browser sockets share their owner Peer.
160
- * @param request - authenticated upgrade request headers.
161
- * @returns the Peer and idempotent release, or 409 for duplicate API ownership.
162
- * The carrier releases on socket termination or failed upgrade; release removes
163
- * API admission synchronously without cancelling independent HTTP calls.
164
- */
165
- admitConnection(request: ConnectionTrustRequest): ConnectionAdmission
166
-
167
- /**
168
- * Authenticate one frontend index request, owning a token redirect or 401.
169
- * The cookie this mints is `Secure` when the mounted Web carrier serves TLS,
170
- * which only that listener's protocol decides.
171
- * @param request - root or configured-index HTTP request.
172
- * @param response - response owned when the result is false.
173
- * @returns true only when the frontend may serve index.html.
174
- */
175
- authorizeIndex(request: ConnectionIndexRequest, response: ConnectionIndexResponse): boolean
176
-
177
- /**
178
- * Add the fresh process token to an ordinary Web application URL.
179
- * @param baseUrl - clean application URL whose authority and mount are preserved.
180
- * @returns tokenized URL for initial login; a mount proxy strips its prefix before {@link authorizeIndex}.
181
- */
182
- authenticatedUrl(baseUrl: string): string
183
- ```
184
-
185
- Types: [Principal](./typert.md)
186
-
187
- Source: [`packages/client/connection/src/rpc.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/client/connection/src/rpc.ts)
188
-
189
- <a id="ctxwebapp--webapp"></a>
190
-
191
- ### `ctx.webApp` — `WebApp`
192
-
193
- The Web GUI this process serves, provided by the `web-runtime` row.
194
-
195
- ```ts cordis-catalog
196
- /**
197
- * The URL this GUI advertises, also used for `DSH_WEB_URL` and the startup URL line.
198
- * @returns the configured `publicUrl`, otherwise the listener origin.
199
- */
200
- getAdvertisedUrl(): string
201
- ```
202
-
203
- Source: [`packages/bundle/web-app/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/bundle/web-app/src/index.ts)
204
-
205
- <a id="ctxwebserver--webserver"></a>
206
-
207
- ### `ctx.webServer` — `WebServer`
208
-
209
- The browser HTTP carrier service. Activation loads any configured TLS material, then listens immediately; a material or listen failure rejects initialization, and the boot process reports the failed fiber. Route registration order does not affect requests because configured named routes must be distinct, and a request no named route matches is answered 404 until the fallback owner registers.
210
-
211
- ```ts cordis-catalog
212
- /**
213
- * The root URL local clients use to reach the bound listener: the protocol,
214
- * the {@link bindUrlHost} form of the bind address, and the listening port.
215
- * @returns the origin, for example `http://127.0.0.1:3080`.
216
- * @throws before `listen` binds a port, or when the bind address has no URL form.
217
- */
218
- getOrigin(): string
219
-
220
- /**
221
- * Register a named route. Duplicate (kind, path) throws — route patterns are
222
- * a composition-level contract, so a collision is a misconfiguration.
223
- * @param route - kind, path, and the owning handler or resource.
224
- * @returns the disposer removing the route.
225
- */
226
- register(route: WebRoute | WebResourceRoute): () => void
227
-
228
- /**
229
- * Register an exact-path HTTP upgrade route. Duplicate paths throw because
230
- * one socket can have only one protocol owner.
231
- * @param route - pathname and handler owning negotiation plus socket use.
232
- * @returns the disposer removing the route.
233
- */
234
- registerUpgrade(route: WebUpgradeRoute): () => void
235
-
236
- /**
237
- * Claim the fallback seat: the handler or resource answering every request
238
- * no named route matches (the SPA dist server in the shipped Web
239
- * composition). One owner only — a second registration throws, because two
240
- * fallbacks cannot compose.
241
- * @param fallback - a handler owning the full response lifecycle of
242
- * unmatched requests, or `{ resource }` answering them.
243
- * @returns the disposer releasing the seat.
244
- */
245
- registerFallback(fallback: WebRoute['handler'] | Pick<WebResourceRoute, 'resource'>): () => void
246
-
247
- /**
248
- * Read the response an HTTP request for the same URL would receive, as the
249
- * resource computes it for `peer`, without an HTTP exchange. The request
250
- * path picks the responder by the HTTP match order — exact, longest prefix,
251
- * then the fallback — and only a resource answers. This method checks no
252
- * cookie, Host, or Origin: the caller admits the reader before reading.
253
- * @param request - the read; its URL path selects the responder.
254
- * @param peer - the Peer the read speaks for, passed to the resource.
255
- * @returns the resource's response, without a body for HEAD as over HTTP;
256
- * 405 with `Allow: GET, HEAD` for any other method, checked before matching,
257
- * where over HTTP a handler route or an unmatched path answers such a
258
- * method itself; 404 when the path matches a handler route, or reaches the
259
- * fallback seat while it is unclaimed or holds a handler. A resource that
260
- * throws rejects the read, where an HTTP request would receive 400.
261
- */
262
- async readResource(request: Request, peer: PeerScope): Promise<Response>
263
-
264
- /**
265
- * Register a raw-HTML index transform, the escape hatch for markup no
266
- * {@link IndexInjection} row expresses: {@link renderIndex} applies taps in
267
- * registration order after rendering the structured rows.
268
- * @param transform - pure html-to-html function.
269
- * @returns the disposer removing the transform.
270
- */
271
- tapIndex(transform: (html: string) => string): () => void
272
-
273
- /**
274
- * Run an index.html body through the registered taps in registration order
275
- * — called by the fallback owner on every index response it renders.
276
- * @param html - the raw index.html body.
277
- * @returns the transformed body.
278
- */
279
- applyIndexTaps(html: string): string
280
-
281
- /**
282
- * Gather the structured injection table for one Peer: one
283
- * `webserver/index-inject` emit, every subscriber pushes its current rows.
284
- * Fresh per call, so subscribers read live state (module graph, theme
285
- * preference, the Peer's access) at emit time.
286
- * @param peer - the Peer the page speaks for.
287
- * @returns rows in subscriber activation order.
288
- */
289
- collectIndexInjections(peer: PeerScope): IndexInjection[]
290
-
291
- /**
292
- * Render one index.html body for one Peer: the structured injection table
293
- * first, then the raw `tapIndex` transforms over the result.
294
- * @param html - the raw index.html body.
295
- * @param peer - the Peer the page speaks for.
296
- * @returns the transformed body.
297
- */
298
- renderIndex(html: string, peer: PeerScope): string
299
- ```
300
-
301
- Source: [`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
302
-
303
- <a id="connection-events"></a>
304
-
305
- ### `connection/*` events
306
-
307
- <a id="connectionrequest--waterfall"></a>
308
-
309
- #### `connection/request` — waterfall
310
-
311
- Admit or wrap an authenticated shared API request, including body transfer. Existing requests continue when a listener refuses subsequent requests.
312
-
313
- ```ts cordis-catalog
314
- /**
315
- * Admit or wrap an authenticated shared API request, including body transfer.
316
- * Existing requests continue when a listener refuses subsequent requests.
317
- * @param request - Authenticated incoming HTTP request.
318
- * @param response - Response owned until the delegated bridge settles.
319
- * @param next - Delegate to the next listener or the shared API bridge.
320
- * @mode waterfall
321
- */
322
- 'connection/request'(request: IncomingMessage, response: ServerResponse, next: () => Promise<void>): Promise<void>
323
- ```
324
-
325
- Source: [`packages/client/connection/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/client/connection/src/index.ts)
326
-
327
- <a id="webserver-events"></a>
328
-
329
- ### `webserver/*` events
330
-
331
- <a id="webserverindex-inject--emit"></a>
332
-
333
- #### `webserver/index-inject` — emit
334
-
335
- Collect the structured index injection table for the page `peer` speaks for. Emitted on every index render and every worker boot-payload request; listeners push their current rows, so a row's data is read fresh at emit time.
336
-
337
- ```ts cordis-catalog
338
- /**
339
- * Collect the structured index injection table for the page `peer` speaks
340
- * for. Emitted on every index render and every worker boot-payload
341
- * request; listeners push their current rows, so a row's data is read
342
- * fresh at emit time.
343
- * @param table - Mutable row table; listeners append in activation order.
344
- * @param peer - The Peer the rendered page speaks for.
345
- * @mode emit
346
- */
347
- 'webserver/index-inject'(table: IndexInjection[], peer: PeerScope): void
348
- ```
349
-
350
- Source: [`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
351
- <!-- END GENERATED cordis-surface -->
1
+ ---
2
+ editSource: "docs/subsystems/web-server.zh.md"
3
+ rawMarkdownPath: "reference/subsystems/web-server.md"
4
+ outline: [2,3]
5
+ ---
6
+
7
+ # HTTP 服务器
8
+
9
+ [dsh-host-webserver](https://github.com/deepseek-ai/deepseek-harness/tree/master/packages/host/webserver) 提供 GUI Host 的 HTTP 或 TLS 监听、路由匹配与准入、可选 gzip、index 渲染及唯一回退。功能插件注册各自路由;Connection 通过 `webserver/authorize` 提供来源与凭据决策。载体直接向 handler 或 resource 传递准入 Peer,不构造请求上下文容器([分层说明](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/boot/app-boot/README.zh.md))。
10
+
11
+ 源码:[`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
12
+
13
+ ## 路由
14
+
15
+ ```ts type-equiv
16
+ /** Route match kind: 'exact' matches the pathname verbatim; 'prefix' p matches p and p/<anything>. */
17
+ type WebRouteKind = 'exact' | 'prefix'
18
+ ```
19
+
20
+ ```ts type-equiv
21
+ /** One named route registration. */
22
+ interface WebRoute {
23
+ kind: WebRouteKind
24
+ /** Absolute pathname, no trailing slash. */
25
+ path: string
26
+ /** Owns the full response lifecycle (may hold the response open, e.g. SSE). */
27
+ handler: (req: IncomingMessage, res: ServerResponse, peer?: PeerScope) => void | Promise<void>
28
+ /** Defaults to required. Anonymous handlers may receive no Peer. */
29
+ auth?: WebAuthenticationRule
30
+ }
31
+ ```
32
+
33
+ ```ts type-equiv
34
+ /**
35
+ * Answers one GET or HEAD request with a Fetch response and its admitted Peer.
36
+ * Anonymous HTTP admission may omit the Peer; an in-process
37
+ * {@link WebServer.readResource} read passes the Peer its caller admitted.
38
+ */
39
+ type WebResource = (request: Request, peer?: PeerScope) => Promise<Response>
40
+ ```
41
+
42
+ ```ts type-equiv
43
+ /** One named route answered by a resource instead of a handler. */
44
+ interface WebResourceRoute {
45
+ kind: WebRouteKind
46
+ /** Absolute pathname, no trailing slash. */
47
+ path: string
48
+ /** Answers HTTP GET and HEAD requests and in-process reads. */
49
+ resource: WebResource
50
+ /** Defaults to required; in-process reads still enforce deny. */
51
+ auth?: WebAuthenticationRule
52
+ }
53
+ ```
54
+
55
+ 所有 `webserver/*` 事件均以对应的 WebServer 为分发 subject,包括 `index-inject` 与 `entry-url`。普通监听器匹配发起者的 `webServer` isolation;显式 `{ global: true }` 监听器跳过该过滤。作为事件数据传入的 Peer 不决定监听器选择。自定义载体和应用发起者必须提供 WebServer subject。
56
+
57
+ 匹配顺序为精确、最长前缀、唯一 owner 的回退;upgrade 精确匹配。匹配后,`auth` 直接或通过同步请求选择器解析为 `anonymous`、`required`(默认)或 `deny`。`deny` 不触发准入事件,直接返回403。其余策略触发同步 `webserver/authorize` 并采用首个决策;无人决策时匿名放行,认证返回503。Connection 对两者均检查来源,仅对认证路由调用 ConnectionAuthentication。因此匿名资源免凭据,但不能免除活动 Connection 的来源策略。
58
+
59
+ handler 通过末尾参数取得准入 Peer,resource 使用已有 `resource(request, peer?)` 参数。认证路由必须取得存活 Peer,匿名路由可省略。准入后 resource 只接受 GET/HEAD。可信 `readResource(request, peer)` 遵循同样的匹配顺序且仅访问 resource,跳过来源与凭据检查,但解析出的 `deny` 仍返回403。[前端回退](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/frontend-static/README.zh.md)选择 index 认证访问与静态资源匿名访问,再为传入 Peer 渲染 index 启动数据。
60
+
61
+ `webserver/request(request, response, next)` 保持为路由选择与准入前的 HTTP waterfall;监听器拥有响应或等待 `next()`。[Token 插件](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/authentication-token/README.zh.md)通过它处理根 Token 交换,并以匿名 auth 注册 `/connect`,在 Connection 来源检查后验证启动 Token。页面 resource 使用准入 Peer,不重复认证。
62
+
63
+ upgrade 准入成功后,`webserver/upgrade(req, socket, head, peer, next)` 在已注册协议 handler 前执行。它携带准入 Peer,匿名访问可为 `undefined`;被拒绝的请求不会进入。监听器自行处理 Socket 或等待 `next()`;waterfall 的末端等待路由 handler,包括其异步完成。中间件或 handler 失败时记录日志并销毁 Socket。在 `/api/remote.mux` 上,Token 仅对自己映射表内的 API Peer 执行单 Socket 所有权与凭据撤销;其他 Provider 委派后续处理,不应用 Token 策略。
64
+
65
+ `webserver/entry-url(baseUrl, entries)` 根据传入的服务器基地址同步收集完整入口 URL,以 `WebEntryUrl` 记录表示,字段为 `label`、完整 `url` 与布尔值 `open`。WebApp 在 Loader 装配结束并完成启动检查后触发,按配置逐行打印,并仅在非 SSH 下打开首个允许自动打开的入口。空列表不产生输出或打开动作。Token 无需读取 WebApp 服务即可贡献签名 URL;公开地址配置仍归 WebApp。
66
+
67
+ <a id="config"></a>
68
+
69
+ ## 配置
70
+
71
+ ```ts type-equiv
72
+ /** Web server listen, TLS, and response-compression config. */
73
+ interface Config {
74
+ /**
75
+ * Listen address: a concrete IPv4 or IPv6 literal of one local interface,
76
+ * for example the container's own Pod address from `hostname -i`. A loopback
77
+ * literal (any address in 127/8, `::1`, or a mapped form of either) keeps the
78
+ * server on this machine; any other literal serves the network that address
79
+ * belongs to, over plain HTTP unless `tls` is set. The unspecified address —
80
+ * IPv4 any, IPv6 any, and the IPv4-mapped forms of IPv4 any — is rejected at
81
+ * load: it would expose the port on every interface at once.
82
+ */
83
+ host: string
84
+ /** Listen port; zero requests an OS-assigned port. */
85
+ port: number
86
+ /**
87
+ * Serve HTTPS with this certificate and key instead of plain HTTP. Both files
88
+ * are read once, before the listener binds: an unreadable or empty file,
89
+ * invalid PEM, or a key that does not match the certificate rejects
90
+ * initialization rather than falling back to HTTP. The material is never
91
+ * re-read, so replacing a certificate takes a reload. Omitted or null listens
92
+ * over plain HTTP.
93
+ */
94
+ tls?: TlsConfig
95
+ /** Response compression for socket-backed HTTP requests. @default 'none' */
96
+ compression?: 'none' | 'gzip'
97
+ /** Gzip DEFLATE level from 0 through 9. @default 1 */
98
+ compressionLevel?: number
99
+ /** Minimum known response length eligible for gzip; unknown-length streams are eligible. @default 1024 */
100
+ compressionThresholdBytes?: number
101
+ }
102
+ ```
103
+
104
+ ```ts type-equiv
105
+ /**
106
+ * TLS material for the HTTPS listener: one certificate chain file and the
107
+ * private key file it pairs with. Both hold PEM text and both resolve against
108
+ * the process working directory.
109
+ */
110
+ interface TlsConfig {
111
+ /** Certificate chain file, leaf certificate first, PEM, no passphrase. */
112
+ certFile: string
113
+ /** Private key file for the chain's leaf certificate; unencrypted PEM. */
114
+ keyFile: string
115
+ }
116
+ ```
117
+
118
+ 没有组合能一次性绑定所有网络接口:未指定地址在加载时即被拒绝。导出的 `isWildcardHost` 与 `isLoopbackHost` 按解析后的地址值分类,IPv6 的 `%zone` 会保留给 `listen`,而分类只读取地址本身。载体执行路由 auth 声明;Connection 拥有来源检查,ConnectionAuthentication 拥有凭据验证;除非 `tls` 提供证书与密钥,否则以明文 HTTP 提供服务。`compression` 默认为 `none`;随附的 Web 组合选择 gzip level 1 和 1024 字节阈值。随附的 `dsh web` 命令默认选择 loopback 并接受一个具体的 `--host` 地址,非 loopback 绑定以明文 HTTP 提供服务时会在启动时警告;其 Connection 插件对匹配的匿名与认证路由检查 Host/Origin,并在要求认证时验证凭据,绑定地址加 `--trusted-host` 决定接受哪个浏览器 Host;`--public-url` 只改变公告的 URL。其他组合自行拥有绑定与路由认证策略。dist 位置是认领席位的前端插件的组装事实。
119
+
120
+ ## 服务
121
+
122
+ 嵌套服务 `connection.authentication` 通过注册的 Provider 选择 Peer;Connection 执行来源策略,WebServer 将选定 Peer 传给各次调用。[Token 插件](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/authentication-token/README.zh.md)贡献签名登录 URL;WebApp 拥有启动打印和浏览器打开行为。[Desktop](https://github.com/deepseek-ai/deepseek-harness/blob/master/apps/desktop/README.zh.md#application-overview)使用父进程与 Host 之间私有 IPC 通道交付的凭据,注册独立 Provider;其 ready 消息携带普通 Host 地址和启动注入。
123
+
124
+ `WebServer`(`ctx.webServer`)在激活时立即监听;监听失败(EADDRINUSE 等)会使初始化被拒绝,启动进程会报告失败的 fiber。`tls` 证书对在监听器绑定前读取一次;文件不可读、为空或二者不匹配时同样会使初始化被拒绝,而不是回退到 HTTP。`register(route)` 添加一条具名路由并返回其 disposer;重复的 `(kind, path)` 抛出异常,因为路由模式是组合层约定,冲突即配置错误。Gzip 在服务器内部包装符合条件且基于 socket 的响应,因此 handler 继续直接持有 `ServerResponse`,resource 则把 `Response` 交给服务写回。已有内容编码、`Cache-Control: no-transform`、范围响应、SSE、ZIP 与打包后的 `.gz` Worker 镜像均保持 identity 响应。`collectIndexInjections(peer)` 经一次传入页面所代表 Peer 的 `webserver/index-inject` emit 收集结构化 `IndexInjection` 行,`renderIndex(html, peer)` 把它们渲染进成功的根路径和配置 index 响应,随后再按注册顺序应用原始的 `tapIndex(transform)` 逃生口转换;[dsh-client-modules](https://github.com/deepseek-ai/deepseek-harness/tree/master/packages/client/modules) 以启动 manifest(元数据清单)行回应该事件。`port` 读取监听端口,包括 `config.port` 为 0 时操作系统分配的端口,`protocol` 则报告监听器提供的协议(`http:` 或 `https:`)。
125
+
126
+ 处理过程中抛出异常的请求(畸形的 % 转义撞上 `decodeURIComponent`、客户端在请求体中途断开)会记录为警告并应答 400(响应头已发出时则销毁 socket),绝不导致进程退出。dispose(资源释放)把 `close()` 与 `closeAllConnections()` 配对使用,因为处理器可能像 SSE(Server-Sent Events)那样保持响应打开,而这类连接永远不会自行结束;没有强制关闭,拆卸就会挂起。TLS socket 只有完成握手后才计入连接,因此服务器会把原始 TLS socket 与升级后的 socket 一并跟踪,并在 dispose 时销毁两者。WebApp 拥有入口 URL 的打印和浏览器打开行为,本服务器负责 HTTP 交付。逐包运维细节(含开发模式的 bundle 监视流水线)留在 [README](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/README.zh.md) 中。
127
+
128
+ <!-- BEGIN GENERATED cordis-surface (gen-cordis-catalog.ts) — do not edit between markers -->
129
+
130
+ <a id="cordis-surface"></a>
131
+
132
+ ## Cordis API
133
+
134
+ Generated from source by `scripts/gen-cordis-catalog.ts` (verified fresh by `pnpm run verify-cordis-catalog` in doc-sync; regenerate with `pnpm run gen-cordis-catalog`) — the language sides differ only in locale-specific paired document paths. Signature blocks use a `ts cordis-catalog` fence and keep the original source JSDoc; dispatch modes are defined in the [primer](../cordis-primer.md#dispatch-modes), and the framework-inherited `ctx` API lives in [cordis-api/inherited.md](../cordis-api/inherited.md).
135
+
136
+ <a id="ctxconnection--hostconnectionhandle"></a>
137
+
138
+ ### `ctx.connection` — `HostConnectionHandle`
139
+
140
+ Host `ctx.connection` members consumed by transport-independent adapters.
141
+
142
+ ```ts cordis-catalog
143
+ /**
144
+ * Compose exact Fetch routes and the shared-channel RPC interceptor.
145
+ * @param channel - shared channel mounted by Connection.
146
+ * @returns Fetch handler for trusted, authenticated requests.
147
+ */
148
+ createSharedFetchHandler(channel: '/api'): ConnectionFetchHandler
149
+
150
+ /**
151
+ * Apply Host/Origin checks and admit the first live Peer returned by a registered credential verifier.
152
+ * @param request - request headers from the HTTP or upgrade request.
153
+ * @returns the credential's Peer, or the rejection status.
154
+ */
155
+ admit(request: ConnectionTrustRequest): PeerAdmission
156
+
157
+ /**
158
+ * Create an independent in-process Peer, disposed with the Context that read `ctx.connection`.
159
+ * @param options - fixed principal and interaction participation (default answer).
160
+ * @returns a new Peer distinct from every other Peer.
161
+ */
162
+ createPeer(options: { readonly principal: Principal; readonly interactions?: 'answer' | 'none' }): PeerScope
163
+ ```
164
+
165
+ Types: [Principal](./typert.md)
166
+
167
+ Source: [`packages/client/connection/src/rpc.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/client/connection/src/rpc.ts)
168
+
169
+ <a id="ctxconnectionauthentication--connectionauthentication"></a>
170
+
171
+ ### `ctx.connection.authentication` — `ConnectionAuthentication`
172
+
173
+ Credential verifier registry whose registrations belong to the calling plugin.
174
+
175
+ ```ts cordis-catalog
176
+ /**
177
+ * Add a credential verifier after the existing registrations.
178
+ * @param provider - verifier owning its credential and Peer selection.
179
+ * @returns disposer withdrawing this registration; the calling scope also withdraws it on unload.
180
+ */
181
+ register(provider: AuthenticationProvider): () => Promise<void>
182
+
183
+ /**
184
+ * Verify credentials without applying an HTTP response or source policy.
185
+ * @param request - current carrier headers and cancellation facts.
186
+ * @returns the first live Peer, 401 if no provider accepts, or 503 when verification failed without success.
187
+ */
188
+ authenticate(request: ConnectionTrustRequest): PeerAdmission
189
+ ```
190
+
191
+ Types: [AuthenticationProvider](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/client/connection/README.zh.md#browser-authentication-and-request-trust)
192
+
193
+ Source: [`packages/client/connection/src/authentication.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/client/connection/src/authentication.ts)
194
+
195
+ <a id="ctxwebapp--webapp"></a>
196
+
197
+ ### `ctx.webApp` — `WebApp`
198
+
199
+ The Web GUI this process serves, provided by the `web-runtime` row.
200
+
201
+ ```ts cordis-catalog
202
+ /**
203
+ * The URL this GUI advertises, also used for `DSH_WEB_URL` and the startup URL line.
204
+ * @returns the configured `publicUrl`, otherwise the listener origin.
205
+ */
206
+ getAdvertisedUrl(): string
207
+ ```
208
+
209
+ Source: [`packages/bundle/web-app/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/bundle/web-app/src/index.ts)
210
+
211
+ <a id="ctxwebserver--webserver"></a>
212
+
213
+ ### `ctx.webServer` — `WebServer`
214
+
215
+ The browser HTTP carrier service. Activation loads any configured TLS material, then listens immediately; a material or listen failure rejects initialization, and the boot process reports the failed fiber. Route registration order does not affect requests because configured named routes must be distinct, and a request no named route matches is answered 404 until the fallback owner registers. HTTP and upgrade admission refusals carry `Cache-Control: no-store`.
216
+
217
+ ```ts cordis-catalog
218
+ /**
219
+ * The root URL local clients use to reach the bound listener: the protocol,
220
+ * the {@link bindUrlHost} form of the bind address, and the listening port.
221
+ * @returns the origin, for example `http://127.0.0.1:3080`.
222
+ * @throws before `listen` binds a port, or when the bind address has no URL form.
223
+ */
224
+ getOrigin(): string
225
+
226
+ /**
227
+ * Register a named route. Duplicate (kind, path) throws — route patterns are
228
+ * a composition-level contract, so a collision is a misconfiguration.
229
+ * @param route - kind, path, and the owning handler or resource.
230
+ * @returns the disposer removing the route.
231
+ */
232
+ register(route: WebRoute | WebResourceRoute): () => void
233
+
234
+ /**
235
+ * Register an exact-path HTTP upgrade route. Duplicate paths throw because
236
+ * one socket can have only one protocol owner.
237
+ * @param route - pathname and handler owning negotiation plus socket use.
238
+ * @returns the disposer removing the route.
239
+ */
240
+ registerUpgrade(route: WebUpgradeRoute): () => void
241
+
242
+ /**
243
+ * Claim the fallback seat: the handler or resource answering every request
244
+ * no named route matches (the SPA dist server in the shipped Web
245
+ * composition). One owner only — a second registration throws, because two
246
+ * fallbacks cannot compose.
247
+ * @param fallback - a handler owning the full response lifecycle of
248
+ * unmatched requests, or an object declaring `handler` or `resource` and auth.
249
+ * @returns the disposer releasing the seat.
250
+ */
251
+ registerFallback(fallback: WebRoute['handler'] | WebFallback): () => void
252
+
253
+ /**
254
+ * Read the response an HTTP request for the same URL would receive, as the
255
+ * resource computes it for `peer`, without an HTTP exchange. The request
256
+ * path picks the responder by the HTTP match order — exact, longest prefix,
257
+ * then the fallback — and only a resource answers. This method checks no
258
+ * cookie, Host, or Origin: the caller admits the reader before reading.
259
+ * A resolved deny policy returns 403 even for an explicitly admitted Peer.
260
+ * @param request - the read; its URL path selects the responder.
261
+ * @param peer - the Peer the read speaks for, passed to the resource.
262
+ * @returns the resource's response, without a body for HEAD as over HTTP;
263
+ * 405 with `Allow: GET, HEAD` for any other method, checked before matching,
264
+ * where over HTTP a handler route or an unmatched path answers such a
265
+ * method itself; 404 when the path matches a handler route, or reaches the
266
+ * fallback seat while it is unclaimed or holds a handler. A resource that
267
+ * throws rejects the read, where an HTTP request would receive 400.
268
+ */
269
+ async readResource(request: Request, peer: PeerScope): Promise<Response>
270
+
271
+ /**
272
+ * Register a raw-HTML index transform, the escape hatch for markup no
273
+ * {@link IndexInjection} row expresses: {@link renderIndex} applies taps in
274
+ * registration order after rendering the structured rows.
275
+ * @param transform - pure html-to-html function.
276
+ * @returns the disposer removing the transform.
277
+ */
278
+ tapIndex(transform: (html: string) => string): () => void
279
+
280
+ /**
281
+ * Run an index.html body through the registered taps in registration order
282
+ * — called by the fallback owner on every index response it renders.
283
+ * @param html - the raw index.html body.
284
+ * @returns the transformed body.
285
+ */
286
+ applyIndexTaps(html: string): string
287
+
288
+ /**
289
+ * Gather the structured injection table for one Peer: one
290
+ * `webserver/index-inject` emit, every subscriber pushes its current rows.
291
+ * Fresh per call, so subscribers read live state (module graph, theme
292
+ * preference, the Peer's access) at emit time.
293
+ * @param peer - the Peer the page speaks for.
294
+ * @returns rows in subscriber activation order.
295
+ */
296
+ collectIndexInjections(peer: PeerScope): IndexInjection[]
297
+
298
+ /**
299
+ * Render one index.html body for one Peer: the structured injection table
300
+ * first, then the raw `tapIndex` transforms over the result.
301
+ * @param html - the raw index.html body.
302
+ * @param peer - the Peer the page speaks for.
303
+ * @returns the transformed body.
304
+ */
305
+ renderIndex(html: string, peer: PeerScope): string
306
+ ```
307
+
308
+ Source: [`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
309
+
310
+ <a id="connection-events"></a>
311
+
312
+ ### `connection/*` events
313
+
314
+ <a id="connectionrequest--waterfall"></a>
315
+
316
+ #### `connection/request` — waterfall
317
+
318
+ Admit or wrap an authenticated shared API request, including body transfer. Existing requests continue when a listener refuses subsequent requests.
319
+
320
+ ```ts cordis-catalog
321
+ /**
322
+ * Admit or wrap an authenticated shared API request, including body transfer.
323
+ * Existing requests continue when a listener refuses subsequent requests.
324
+ * @param request - Authenticated incoming HTTP request.
325
+ * @param response - Response owned until the delegated bridge settles.
326
+ * @param next - Delegate to the next listener or the shared API bridge.
327
+ * @mode waterfall
328
+ */
329
+ 'connection/request'(request: IncomingMessage, response: ServerResponse, next: () => Promise<void>): Promise<void>
330
+ ```
331
+
332
+ Source: [`packages/client/connection/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/client/connection/src/index.ts)
333
+
334
+ <a id="webserver-events"></a>
335
+
336
+ ### `webserver/*` events
337
+
338
+ <a id="webserverauthorize--bail"></a>
339
+
340
+ #### `webserver/authorize` — bail
341
+
342
+ Admit a matched request synchronously; the first decision wins.
343
+
344
+ ```ts cordis-catalog
345
+ /**
346
+ * Admit a matched request synchronously; the first decision wins.
347
+ * @param request - headers, target, transport, and available cancellation state.
348
+ * @param policy - resolved route policy; deny never emits this event.
349
+ * @mode bail
350
+ */
351
+ 'webserver/authorize'(request: WebAuthRequest, policy: WebAuthPolicy): WebAdmission | undefined
352
+ ```
353
+
354
+ Source: [`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
355
+
356
+ <a id="webserverentry-url--emit"></a>
357
+
358
+ #### `webserver/entry-url` — emit
359
+
360
+ Collect complete entry URLs for an advertised server address.
361
+
362
+ ```ts cordis-catalog
363
+ /**
364
+ * Collect complete entry URLs for an advertised server address.
365
+ * @param baseUrl - advertised server base URL without provider credentials.
366
+ * @param entries - entries appended synchronously in listener order.
367
+ * @mode emit
368
+ */
369
+ 'webserver/entry-url'(baseUrl: string, entries: WebEntryUrl[]): void
370
+ ```
371
+
372
+ Source: [`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
373
+
374
+ <a id="webserverindex-inject--emit"></a>
375
+
376
+ #### `webserver/index-inject` — emit
377
+
378
+ Collect the structured index injection table for the page `peer` speaks for. Emitted on every index render and every worker boot-payload request; listeners push their current rows, so a row's data is read fresh at emit time.
379
+
380
+ ```ts cordis-catalog
381
+ /**
382
+ * Collect the structured index injection table for the page `peer` speaks
383
+ * for. Emitted on every index render and every worker boot-payload
384
+ * request; listeners push their current rows, so a row's data is read
385
+ * fresh at emit time.
386
+ * @param table - Mutable row table; listeners append in activation order.
387
+ * @param peer - The Peer the rendered page speaks for.
388
+ * @mode emit
389
+ */
390
+ 'webserver/index-inject'(table: IndexInjection[], peer: PeerScope): void
391
+ ```
392
+
393
+ Source: [`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
394
+
395
+ <a id="webserverrequest--waterfall"></a>
396
+
397
+ #### `webserver/request` — waterfall
398
+
399
+ Handle an HTTP request before named-route and fallback dispatch.
400
+
401
+ ```ts cordis-catalog
402
+ /**
403
+ * Handle an HTTP request before named-route and fallback dispatch.
404
+ * @param request - original incoming HTTP request.
405
+ * @param response - response owned by the listener or its delegated handler.
406
+ * @param next - dispatch to the next listener or the matching route.
407
+ * @mode waterfall
408
+ */
409
+ 'webserver/request'(request: IncomingMessage, response: ServerResponse, next: () => Promise<void>): Promise<void>
410
+ ```
411
+
412
+ Source: [`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
413
+
414
+ <a id="webserverupgrade--waterfall"></a>
415
+
416
+ #### `webserver/upgrade` — waterfall
417
+
418
+ Handle an admitted upgrade before its registered protocol handler.
419
+
420
+ ```ts cordis-catalog
421
+ /**
422
+ * Handle an admitted upgrade before its registered protocol handler.
423
+ * @param request - original upgrade request.
424
+ * @param socket - transport owned by the upgrade.
425
+ * @param head - bytes received after the HTTP headers.
426
+ * @param peer - authenticated identity, absent for anonymous admission.
427
+ * @param next - delegate to the next listener or protocol handler.
428
+ * @mode waterfall
429
+ */
430
+ 'webserver/upgrade'( request: IncomingMessage, socket: Duplex, head: Buffer, peer: PeerScope | undefined, next: () => Promise<void>, ): Promise<void>
431
+ ```
432
+
433
+ Source: [`packages/host/webserver/src/index.ts`](https://github.com/deepseek-ai/deepseek-harness/blob/master/packages/host/webserver/src/index.ts)
434
+ <!-- END GENERATED cordis-surface -->