@openllmsh/sdk 0.0.0-stage → 2.10.12-alpha.0

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 (245) hide show
  1. package/ARCHITECTURE.md +43 -0
  2. package/LICENSE +202 -0
  3. package/README.md +142 -2
  4. package/assets/openllm-light.svg +18 -0
  5. package/assets/openllm.svg +18 -0
  6. package/client/chat.ts +140 -0
  7. package/client/devices.ts +269 -0
  8. package/client/http.ts +72 -0
  9. package/client/index.ts +129 -0
  10. package/client/relay-mux.ts +547 -0
  11. package/client/types.ts +51 -0
  12. package/client/vault.ts +239 -0
  13. package/connect/chat.ts +58 -0
  14. package/connect/client.ts +240 -0
  15. package/connect/config.ts +47 -0
  16. package/connect/errors.ts +121 -0
  17. package/connect/index.ts +23 -0
  18. package/connect/oauth.ts +265 -0
  19. package/connect/routes.ts +234 -0
  20. package/connect/store.ts +107 -0
  21. package/mcp/handle.ts +24 -0
  22. package/mcp/index.ts +76 -0
  23. package/mcp/server.ts +319 -0
  24. package/mcp/tools/marketplace.ts +439 -0
  25. package/mcp/tools/memory-client.ts +297 -0
  26. package/mcp/tools/memory-config.ts +32 -0
  27. package/mcp/tools/memory.ts +369 -0
  28. package/mcp/tools/model-priority.ts +88 -0
  29. package/mcp/tools/openllm.ts +883 -0
  30. package/mcp/types.ts +28 -0
  31. package/openapi/call.ts +90 -0
  32. package/openapi/index.ts +8 -0
  33. package/openapi/openapi.json +80213 -0
  34. package/openapi/operations.ts +2075 -0
  35. package/package.json +39 -4
  36. package/protocol/CONTRIBUTING.md +21 -0
  37. package/protocol/README.md +134 -0
  38. package/protocol/access.ts +186 -0
  39. package/protocol/agent-prompt-text.ts +32 -0
  40. package/protocol/agent.ts +991 -0
  41. package/protocol/api-key-syntax.ts +105 -0
  42. package/protocol/assets/openllm-light.svg +18 -0
  43. package/protocol/assets/openllm.svg +18 -0
  44. package/protocol/audio.ts +29 -0
  45. package/protocol/auth.ts +142 -0
  46. package/protocol/changelog.ts +155 -0
  47. package/protocol/chat.ts +458 -0
  48. package/protocol/client-registry.ts +356 -0
  49. package/protocol/config.ts +345 -0
  50. package/protocol/control-channel.ts +115 -0
  51. package/protocol/cooldown-reason.ts +78 -0
  52. package/protocol/cost.ts +10 -0
  53. package/protocol/daemon-port.ts +31 -0
  54. package/protocol/daemon.ts +1524 -0
  55. package/protocol/default-chains.ts +66 -0
  56. package/protocol/device-state.ts +85 -0
  57. package/protocol/doctor-report-local.ts +443 -0
  58. package/protocol/doctor-report-policy.ts +119 -0
  59. package/protocol/doctor-report.ts +947 -0
  60. package/protocol/errors.ts +14 -0
  61. package/protocol/execution-selection.ts +141 -0
  62. package/protocol/hop-grant.ts +33 -0
  63. package/protocol/image-edit-parse.ts +263 -0
  64. package/protocol/images.ts +298 -0
  65. package/protocol/index.ts +74 -0
  66. package/protocol/inference-headers.ts +3 -0
  67. package/protocol/keepalive.ts +69 -0
  68. package/protocol/local-auth.ts +300 -0
  69. package/protocol/local-device-control.ts +133 -0
  70. package/protocol/local-provider.ts +288 -0
  71. package/protocol/local-session.ts +118 -0
  72. package/protocol/marketplace.ts +187 -0
  73. package/protocol/media-attempt.ts +81 -0
  74. package/protocol/media-bytes.ts +28 -0
  75. package/protocol/media-default.ts +357 -0
  76. package/protocol/media-dimensions.ts +132 -0
  77. package/protocol/media-input.ts +61 -0
  78. package/protocol/media-model.ts +142 -0
  79. package/protocol/media-option-issue.ts +90 -0
  80. package/protocol/media-types.ts +70 -0
  81. package/protocol/model-match.ts +1051 -0
  82. package/protocol/model-settings.ts +327 -0
  83. package/protocol/models.ts +767 -0
  84. package/protocol/mux.ts +722 -0
  85. package/protocol/plan-surface.ts +59 -0
  86. package/protocol/provider-models.ts +16 -0
  87. package/protocol/provider-status.ts +206 -0
  88. package/protocol/provider-tier.ts +67 -0
  89. package/protocol/provider-usage.ts +263 -0
  90. package/protocol/providers.ts +901 -0
  91. package/protocol/public-usage-index.ts +354 -0
  92. package/protocol/realtime-generated.ts +31 -0
  93. package/protocol/realtime.ts +324 -0
  94. package/protocol/registry-pointer.ts +118 -0
  95. package/protocol/relay.ts +702 -0
  96. package/protocol/replay-session.ts +11 -0
  97. package/protocol/responses.ts +280 -0
  98. package/protocol/semver.ts +182 -0
  99. package/protocol/setup-mode.ts +22 -0
  100. package/protocol/sha256-hex.ts +98 -0
  101. package/protocol/stats.ts +406 -0
  102. package/protocol/streaming.ts +19 -0
  103. package/protocol/subscription-daemon-floors.ts +33 -0
  104. package/protocol/subscription-provider-compat.ts +104 -0
  105. package/protocol/subscription-provider.ts +32 -0
  106. package/protocol/team-grant.ts +17 -0
  107. package/protocol/team-shareable.ts +61 -0
  108. package/protocol/transcription-encoding.ts +76 -0
  109. package/protocol/url-locality-dns.ts +37 -0
  110. package/protocol/url-locality.ts +288 -0
  111. package/protocol/usage-snapshots.ts +9 -0
  112. package/protocol/vendor-cli-install.ts +29 -0
  113. package/protocol/video-job-plan.ts +50 -0
  114. package/protocol/videos.ts +227 -0
  115. package/tsconfig.json +14 -0
  116. package/tunnel/ARCHITECTURE.md +111 -0
  117. package/tunnel/LICENSE +33 -0
  118. package/tunnel/README.md +45 -0
  119. package/tunnel/assets/openllm-light.svg +18 -0
  120. package/tunnel/assets/openllm.svg +18 -0
  121. package/tunnel/channel-envelope.ts +139 -0
  122. package/tunnel/codec.ts +191 -0
  123. package/tunnel/device-anchor.ts +229 -0
  124. package/tunnel/device-control.ts +118 -0
  125. package/tunnel/device-grant.ts +173 -0
  126. package/tunnel/fleet.ts +77 -0
  127. package/tunnel/index.ts +22 -0
  128. package/tunnel/mux.ts +580 -0
  129. package/tunnel/peer-link.ts +390 -0
  130. package/tunnel/rtc-auth.ts +415 -0
  131. package/tunnel/rtc-duplex.ts +187 -0
  132. package/tunnel/rtc-ice.ts +136 -0
  133. package/tunnel/secure.ts +1298 -0
  134. package/tunnel/stream-reset-error.ts +14 -0
  135. package/tunnel/streams.ts +1430 -0
  136. package/tunnel/team-grant.ts +302 -0
  137. package/tunnel/wire-bytes.ts +102 -0
  138. package/vault/ARCHITECTURE.md +470 -0
  139. package/vault/LICENSE +33 -0
  140. package/vault/api-key.ts +190 -0
  141. package/vault/argon2.ts +106 -0
  142. package/vault/cli-auth-seal.ts +157 -0
  143. package/vault/cred-seal.ts +146 -0
  144. package/vault/credential.ts +55 -0
  145. package/vault/crypto.ts +210 -0
  146. package/vault/daemon-attest.ts +229 -0
  147. package/vault/derive.ts +113 -0
  148. package/vault/device-access.ts +87 -0
  149. package/vault/device-anchor.ts +185 -0
  150. package/vault/device-control.ts +174 -0
  151. package/vault/handoff.ts +396 -0
  152. package/vault/index.ts +21 -0
  153. package/vault/passkey.ts +243 -0
  154. package/vault/phrase.ts +65 -0
  155. package/vault/pin.ts +153 -0
  156. package/vault/public-key-seal.ts +131 -0
  157. package/vault/seed.ts +272 -0
  158. package/vault/team.ts +355 -0
  159. package/vault/vault-item.ts +131 -0
  160. package/vault/vault-migrate-digest.ts +29 -0
  161. package/vault/wrapped.ts +77 -0
  162. package/wire/ARCHITECTURE.md +90 -0
  163. package/wire/CONTRIBUTING.md +19 -0
  164. package/wire/LICENSE +33 -0
  165. package/wire/README.md +51 -0
  166. package/wire/adapters/messages/anthropic-map.ts +37 -0
  167. package/wire/adapters/messages/index.ts +7 -0
  168. package/wire/adapters/messages/reasoning-from-items.ts +38 -0
  169. package/wire/adapters/messages/reasoning-signature.ts +243 -0
  170. package/wire/adapters/messages/request.ts +574 -0
  171. package/wire/adapters/messages/response.ts +215 -0
  172. package/wire/adapters/messages/streaming.ts +1027 -0
  173. package/wire/adapters/messages/usage.ts +43 -0
  174. package/wire/adapters/responses/index.ts +3 -0
  175. package/wire/adapters/responses/request.ts +395 -0
  176. package/wire/adapters/responses/response.ts +88 -0
  177. package/wire/adapters/responses/streaming.ts +344 -0
  178. package/wire/assets/openllm-light.svg +18 -0
  179. package/wire/assets/openllm.svg +18 -0
  180. package/wire/features/account-rank.ts +166 -0
  181. package/wire/features/compaction/compact-request.ts +862 -0
  182. package/wire/features/compaction/compaction-text.ts +43 -0
  183. package/wire/features/context-demote.ts +47 -0
  184. package/wire/features/context-overflow-strategy.ts +26 -0
  185. package/wire/features/context-skip.ts +170 -0
  186. package/wire/features/conversation-affinity.ts +144 -0
  187. package/wire/features/max-tokens-backfill.ts +141 -0
  188. package/wire/features/model-caps.ts +53 -0
  189. package/wire/features/model-settings.ts +24 -0
  190. package/wire/features/output-limit-clamp.ts +64 -0
  191. package/wire/features/quota-gate.ts +85 -0
  192. package/wire/index.ts +44 -0
  193. package/wire/lib/attempt-outcome.ts +43 -0
  194. package/wire/lib/canonical/content-part.ts +38 -0
  195. package/wire/lib/canonical/count-tokens-capability.ts +138 -0
  196. package/wire/lib/canonical/encoding-select.ts +82 -0
  197. package/wire/lib/canonical/image-signature.ts +202 -0
  198. package/wire/lib/canonical/image-sse.ts +216 -0
  199. package/wire/lib/canonical/message.ts +43 -0
  200. package/wire/lib/canonical/token-estimate.ts +266 -0
  201. package/wire/lib/encrypted-content.ts +66 -0
  202. package/wire/lib/error-class.ts +154 -0
  203. package/wire/lib/error-envelope.ts +56 -0
  204. package/wire/lib/forwarded-headers.ts +180 -0
  205. package/wire/lib/provider-error-rules.ts +48 -0
  206. package/wire/lib/refusal.ts +38 -0
  207. package/wire/lib/responses-apply-patch.ts +104 -0
  208. package/wire/lib/responses-namespace.ts +53 -0
  209. package/wire/lib/secret-scrub.ts +101 -0
  210. package/wire/lib/streaming/accumulate.ts +221 -0
  211. package/wire/lib/streaming/finish-reason.ts +33 -0
  212. package/wire/lib/streaming/peek.ts +154 -0
  213. package/wire/lib/streaming/provider-decode.ts +259 -0
  214. package/wire/lib/streaming/response-stream.ts +71 -0
  215. package/wire/lib/streaming/sse.ts +699 -0
  216. package/wire/lib/streaming/strip-tool-calls.ts +95 -0
  217. package/wire/lib/streaming/upstream-error.ts +58 -0
  218. package/wire/lib/strip-subagent-isolation.ts +284 -0
  219. package/wire/lib/thinking-signature.ts +156 -0
  220. package/wire/lib/token-ruler/bpe-core.ts +426 -0
  221. package/wire/lib/token-ruler/index.ts +2 -0
  222. package/wire/lib/token-ruler/ruler.ts +79 -0
  223. package/wire/lib/token-ruler/vocab/claude-ranks.ts +16 -0
  224. package/wire/lib/token-ruler/vocab/claude.ts +22 -0
  225. package/wire/lib/token-ruler/vocab/o200k-ranks.ts +18 -0
  226. package/wire/lib/token-ruler/vocab/o200k.ts +19 -0
  227. package/wire/lib/tool-name-map.ts +271 -0
  228. package/wire/lib/tool-schema.ts +353 -0
  229. package/wire/lib/usage-observer.ts +125 -0
  230. package/wire/providers/anthropic/adaptive-thinking.ts +291 -0
  231. package/wire/providers/anthropic/beta-headers.ts +165 -0
  232. package/wire/providers/anthropic/index.ts +10 -0
  233. package/wire/providers/anthropic/request.ts +607 -0
  234. package/wire/providers/anthropic/response.ts +155 -0
  235. package/wire/providers/anthropic/streaming.ts +315 -0
  236. package/wire/providers/anthropic/web-search-domains.ts +49 -0
  237. package/wire/providers/chatgpt/common.ts +136 -0
  238. package/wire/providers/chatgpt/index.ts +9 -0
  239. package/wire/providers/chatgpt/request.ts +959 -0
  240. package/wire/providers/chatgpt/streaming.ts +1007 -0
  241. package/wire/providers/chatgpt/web-search.ts +63 -0
  242. package/wire/providers/grok/web-search.ts +87 -0
  243. package/wire/providers/kimi/web-search.ts +145 -0
  244. package/wire/providers/upstream-deny.ts +355 -0
  245. package/wire/providers/upstream-request.ts +619 -0
@@ -0,0 +1,288 @@
1
+ import { Schema as S } from "effect";
2
+
3
+ /**
4
+ * The three daemon-only provider variants. All are served only by a local
5
+ * daemon (never by the hosted gateway); they differ in how the device
6
+ * authenticates and talks upstream:
7
+ * - `oauth` — today's subscription providers (vendor-CLI login)
8
+ * - `local` — loopback model servers (Ollama, LM Studio, …)
9
+ * - `local_key` — subscription plans that issue only a static API key
10
+ * (OpenCode Go, Z.AI GLM Coding Plan, MiniMax Coding Plan). The key is
11
+ * pasted in the browser, sealed to the device and stored only there; the
12
+ * daemon calls the vendor's hosted endpoint directly.
13
+ */
14
+ export const LocalProviderVariant = S.Literals(["oauth", "local", "local_key"]);
15
+ export type TLocalProviderVariant = S.Schema.Type<typeof LocalProviderVariant>;
16
+
17
+ /**
18
+ * Closed set of OAuth / subscription-provider slugs a control command may
19
+ * address — the ONLY values that can ever reach a daemon delegate or the
20
+ * isolated-CLI installer. The daemon's `TCliProvider` derives from this.
21
+ */
22
+ export const OAuthProviderSlug = S.Literals([
23
+ "claude_code",
24
+ "chatgpt",
25
+ "kimi_code",
26
+ // xAI Grok ("Grok Build", x.ai/cli) — SuperGrok / X Premium+ subscription
27
+ // OAuth, delegated to the official `grok` CLI by the daemon.
28
+ "grok",
29
+ // Cursor subscription, delegated to the official `cursor-agent` CLI.
30
+ "cursor",
31
+ // Meta Muse Code subscription — daemon bridge to the official `muse`
32
+ // CLI / SDK only. No direct Meta Model API-key fallback on this slug.
33
+ "muse",
34
+ // Google Antigravity subscription — daemon bridge to Google's official
35
+ // `agy_acp_server` ACP agent and its own Google sign-in. Never a metered
36
+ // Gemini API key; the BYOK `google` provider is a separate slug.
37
+ "antigravity",
38
+ ]);
39
+ export type TOAuthProviderSlug = S.Schema.Type<typeof OAuthProviderSlug>;
40
+
41
+ /** Convenience alias of {@link OAuthProviderSlug.literals} for consumers that
42
+ * only need the slug list (MCP tool copy, UI filters). */
43
+ export const OAUTH_PROVIDER_SLUGS = OAuthProviderSlug.literals;
44
+
45
+ /**
46
+ * Closed set of `local_key` provider slugs: subscription plans whose only
47
+ * credential is an API key. Keys live on the device (multi-account, one slot
48
+ * per key) and are never stored by the cloud.
49
+ */
50
+ export const LocalKeyProviderSlug = S.Literals([
51
+ "opencode_go",
52
+ "zai_coding",
53
+ "minimax_coding",
54
+ ]);
55
+ export type TLocalKeyProviderSlug = S.Schema.Type<typeof LocalKeyProviderSlug>;
56
+
57
+ export type TLocalKeyProviderPreset = {
58
+ readonly slug: TLocalKeyProviderSlug;
59
+ readonly label: string;
60
+ /** OpenAI-compatible base URL (`<base>/chat/completions`). */
61
+ readonly baseUrl: string;
62
+ /** Where the user obtains the key. */
63
+ readonly keyUrl: string;
64
+ /** Placeholder for the paste field. */
65
+ readonly keyHint: string;
66
+ };
67
+
68
+ /** Vendor endpoints for each `local_key` provider. */
69
+ export const LOCAL_KEY_PROVIDER_PRESETS: ReadonlyArray<TLocalKeyProviderPreset> =
70
+ [
71
+ {
72
+ slug: "opencode_go",
73
+ label: "OpenCode Go",
74
+ baseUrl: "https://opencode.ai/zen/go/v1",
75
+ keyUrl: "https://opencode.ai/auth",
76
+ keyHint: "OpenCode API key",
77
+ },
78
+ {
79
+ slug: "zai_coding",
80
+ label: "Z.AI GLM Coding Plan",
81
+ baseUrl: "https://api.z.ai/api/coding/paas/v4",
82
+ keyUrl: "https://z.ai/manage-apikey/apikey-list",
83
+ keyHint: "Z.AI API key",
84
+ },
85
+ {
86
+ slug: "minimax_coding",
87
+ label: "MiniMax Coding Plan",
88
+ baseUrl: "https://api.minimax.io/v1",
89
+ keyUrl:
90
+ "https://platform.minimax.io/user-center/basic-information/interface-key",
91
+ keyHint: "MiniMax Coding Plan key",
92
+ },
93
+ ] as const;
94
+
95
+ export const isLocalKeyProviderSlug = (
96
+ slug: string,
97
+ ): slug is TLocalKeyProviderSlug =>
98
+ (LocalKeyProviderSlug.literals as ReadonlyArray<string>).includes(slug);
99
+
100
+ export const localKeyProviderPreset = (
101
+ slug: string,
102
+ ): TLocalKeyProviderPreset | null =>
103
+ LOCAL_KEY_PROVIDER_PRESETS.find((preset) => preset.slug === slug) ?? null;
104
+
105
+ /** Base URL of a `local_key` provider (every slug has a preset). */
106
+ export const localKeyBaseUrl = (slug: TLocalKeyProviderSlug): string => {
107
+ const preset = localKeyProviderPreset(slug);
108
+ if (preset === null) throw new Error(`no local_key preset for ${slug}`);
109
+ return preset.baseUrl;
110
+ };
111
+
112
+ /** Well-known local model-server preset slugs (`local_<product>`). */
113
+ export const LocalServerPresetSlug = S.Literals([
114
+ "local_ollama",
115
+ "local_lmstudio",
116
+ "local_llamacpp",
117
+ "local_localai",
118
+ "local_vllm",
119
+ "local_jan",
120
+ "local_textgen",
121
+ ]);
122
+ export type TLocalServerPresetSlug = S.Schema.Type<
123
+ typeof LocalServerPresetSlug
124
+ >;
125
+
126
+ export type TLocalServerPreset = {
127
+ readonly slug: TLocalServerPresetSlug;
128
+ readonly label: string;
129
+ /** Vendor-documented default loopback port. */
130
+ readonly defaultPort: number;
131
+ readonly docsUrl: string;
132
+ };
133
+
134
+ /**
135
+ * Popular local OpenAI-compatible servers and their default ports.
136
+ * A port that answers but matches no preset falls back to
137
+ * {@link localPortSlug}.
138
+ */
139
+ export const LOCAL_SERVER_PRESETS: ReadonlyArray<TLocalServerPreset> = [
140
+ {
141
+ slug: "local_ollama",
142
+ label: "Ollama",
143
+ defaultPort: 11434,
144
+ docsUrl: "https://docs.ollama.com",
145
+ },
146
+ {
147
+ slug: "local_lmstudio",
148
+ label: "LM Studio",
149
+ defaultPort: 1234,
150
+ docsUrl: "https://lmstudio.ai/docs/developer/rest/quickstart",
151
+ },
152
+ {
153
+ slug: "local_llamacpp",
154
+ label: "llama.cpp",
155
+ defaultPort: 8080,
156
+ docsUrl: "https://github.com/ggerganov/llama.cpp",
157
+ },
158
+ {
159
+ slug: "local_localai",
160
+ label: "LocalAI",
161
+ defaultPort: 8080,
162
+ docsUrl: "https://localai.io",
163
+ },
164
+ {
165
+ slug: "local_vllm",
166
+ label: "vLLM",
167
+ defaultPort: 8000,
168
+ docsUrl: "https://docs.vllm.ai",
169
+ },
170
+ {
171
+ slug: "local_jan",
172
+ label: "Jan",
173
+ defaultPort: 1337,
174
+ docsUrl: "https://jan.ai/docs/desktop/api-server",
175
+ },
176
+ {
177
+ slug: "local_textgen",
178
+ label: "text-generation-webui",
179
+ defaultPort: 5000,
180
+ docsUrl: "https://github.com/oobabooga/text-generation-webui",
181
+ },
182
+ ] as const;
183
+
184
+ const LOCAL_PORT_SLUG_RE = /^local_port_(\d{1,5})$/;
185
+
186
+ /** Fallback slug for a discovered port that matched no preset. */
187
+ export const localPortSlug = (port: number): string => `local_port_${port}`;
188
+
189
+ /** Parse `local_port_<port>`; returns null when the slug is not that shape. */
190
+ export const parseLocalPortSlug = (slug: string): number | null => {
191
+ const match = LOCAL_PORT_SLUG_RE.exec(slug);
192
+ if (match === null) return null;
193
+ const port = Number(match[1]);
194
+ if (!Number.isInteger(port) || port < 1 || port > 65535) return null;
195
+ return port;
196
+ };
197
+
198
+ export const isLocalPortSlug = (slug: string): boolean =>
199
+ parseLocalPortSlug(slug) !== null;
200
+
201
+ /**
202
+ * Stable overview-group provider for ephemeral `local_port_<n>` rows.
203
+ * Custom-port / test servers each mint a unique slug; collapsing them here
204
+ * lets Recent requests stack as `tiny N×` instead of one row per port.
205
+ */
206
+ export const LOCAL_PORT_GROUP_PROVIDER = "local_port" as const;
207
+
208
+ /** Overview grouping provider: ephemeral ports share {@link LOCAL_PORT_GROUP_PROVIDER}. */
209
+ export const requestGroupProvider = (provider: string): string =>
210
+ isLocalPortSlug(provider) ? LOCAL_PORT_GROUP_PROVIDER : provider;
211
+
212
+ /**
213
+ * Overview grouping model id for a request row. Ephemeral local ports keep the
214
+ * `local_port/<leaf>` shape so `shortName` still shows the leaf model.
215
+ */
216
+ export const requestGroupModel = (
217
+ provider: string,
218
+ model: string | null,
219
+ ): string | null => {
220
+ if (!isLocalPortSlug(provider)) return model;
221
+ if (model === null || model.length === 0) return model;
222
+ const slash = model.lastIndexOf("/");
223
+ const leaf = slash >= 0 ? model.slice(slash + 1) : model;
224
+ if (leaf.length === 0) return model;
225
+ return `${LOCAL_PORT_GROUP_PROVIDER}/${leaf}`;
226
+ };
227
+
228
+ export const isLocalServerPresetSlug = (
229
+ slug: string,
230
+ ): slug is TLocalServerPresetSlug =>
231
+ (LocalServerPresetSlug.literals as ReadonlyArray<string>).includes(slug);
232
+
233
+ /** True for a preset slug or a `local_port_<n>` fallback. */
234
+ export const isLocalServerSlug = (slug: string): boolean =>
235
+ isLocalServerPresetSlug(slug) || isLocalPortSlug(slug);
236
+
237
+ export const isOAuthProviderSlug = (
238
+ provider: string,
239
+ ): provider is TOAuthProviderSlug =>
240
+ (OAuthProviderSlug.literals as ReadonlyArray<string>).includes(provider);
241
+
242
+ /**
243
+ * Providers with device-local account slots, routed BY PROVIDER: oauth (one
244
+ * slot per vendor login) ∪ local_key (one slot per pasted key). A device
245
+ * reports each slot as a `connections` row.
246
+ */
247
+ export const isAccountProviderSlug = (provider: string): boolean =>
248
+ isOAuthProviderSlug(provider) || isLocalKeyProviderSlug(provider);
249
+
250
+ /**
251
+ * Daemon-only providers: OAuth ∪ local_key ∪ local server slugs.
252
+ * Replaces `isSubscriptionProvider` at routing / plan / walker sites that
253
+ * mean "cloud never serves this hop".
254
+ */
255
+ export const isLocalProvider = (slug: string): boolean =>
256
+ isAccountProviderSlug(slug) || isLocalServerSlug(slug);
257
+
258
+ /** Variant for a daemon-only slug, or null when the slug is neither. */
259
+ export const localProviderVariant = (
260
+ slug: string,
261
+ ): TLocalProviderVariant | null => {
262
+ if (isOAuthProviderSlug(slug)) return "oauth";
263
+ if (isLocalServerSlug(slug)) return "local";
264
+ if (isLocalKeyProviderSlug(slug)) return "local_key";
265
+ return null;
266
+ };
267
+
268
+ export const localServerPresetBySlug = (
269
+ slug: string,
270
+ ): TLocalServerPreset | null =>
271
+ LOCAL_SERVER_PRESETS.find((preset) => preset.slug === slug) ?? null;
272
+
273
+ export const localServerPresetByPort = (
274
+ port: number,
275
+ ): TLocalServerPreset | null => {
276
+ const matches = LOCAL_SERVER_PRESETS.filter(
277
+ (preset) => preset.defaultPort === port,
278
+ );
279
+ // Colliding defaults (8080 ×2) are ambiguous — caller fingerprints instead.
280
+ return matches.length === 1 ? (matches[0] ?? null) : null;
281
+ };
282
+
283
+ /** OAuth hop with no online daemon — keep the historical wire string. */
284
+ export const SUBSCRIPTION_REQUIRES_DAEMON_ERROR_CODE =
285
+ "subscription_requires_daemon";
286
+
287
+ /** Local-server hop with no online daemon that lists the model. */
288
+ export const LOCAL_REQUIRES_DAEMON_ERROR_CODE = "local_requires_daemon";
@@ -0,0 +1,118 @@
1
+ /**
2
+ * Local terminal session-host vocabulary.
3
+ *
4
+ * `openllm <client>` / `openllm sessions` attach a REAL terminal on the same
5
+ * machine to the daemon's durable PTY session-host over a local unix socket.
6
+ * That broker keeps the PTY open/control shapes below. They are NOT a mux
7
+ * wire kind any more: remote PTY mirroring was replaced by agent sessions
8
+ * (`./agent`, mux `kind:"agent"`), and a legacy `kind:"session"` mux OPEN is
9
+ * reset by the daemon (docs/plan/2026-10-23-agent-sessions-replace-remote-pty.md).
10
+ */
11
+ import { Schema as S } from "effect";
12
+ import * as Result from "effect/Result";
13
+ import {
14
+ DeviceSessionCli,
15
+ SessionTitleField,
16
+ supportsDangerousSession,
17
+ } from "./daemon";
18
+
19
+ /** Session ids are client-minted url-safe tokens. The url-safe pattern is
20
+ * required because the id is embedded in the session-host pidfile name
21
+ * (`<id>.pid`). */
22
+ export const SESSION_ID_PATTERN = /^[A-Za-z0-9_-]{1,64}$/;
23
+ export const SessionId = S.String.check(S.isPattern(SESSION_ID_PATTERN));
24
+ export type TSessionId = S.Schema.Type<typeof SessionId>;
25
+
26
+ /** Terminal cols/rows on local session open + resize. */
27
+ export const TerminalDimension = S.Number.check(
28
+ S.isInt(),
29
+ S.isBetween({ minimum: 1, maximum: 1024 }),
30
+ );
31
+ export type TTerminalDimension = S.Schema.Type<typeof TerminalDimension>;
32
+
33
+ /** Open request on the local session-host broker. */
34
+ export const LocalSessionOpenPayload = S.Struct({
35
+ kind: S.Literal("session"),
36
+ session_id: SessionId,
37
+ cli: DeviceSessionCli,
38
+ cols: TerminalDimension,
39
+ rows: TerminalDimension,
40
+ mode: S.Literals(["spawn", "attach", "continue"]),
41
+ title: S.optional(SessionTitleField),
42
+ /** When true, launch via `openllm -d <client>` for CLIs that support it. */
43
+ dangerous: S.optional(S.Boolean),
44
+ /** Cold-resume a vendor session by id (`spawn` only). */
45
+ resume_session_id: S.optional(
46
+ S.String.check(S.isMinLength(1), S.isMaxLength(128)),
47
+ ),
48
+ /** Absolute cwd for spawn/continue; omitted → `$HOME` for new sessions. */
49
+ cwd: S.optional(S.String.check(S.isMinLength(1), S.isMaxLength(1024))),
50
+ /**
51
+ * `attach` only: a structured observer (the daemon's agent engine). It reads
52
+ * output and writes input but is not a viewer: it never drives the PTY size
53
+ * and does not count as attached for detach / idle reap.
54
+ */
55
+ observer: S.optional(S.Boolean),
56
+ });
57
+ export type TLocalSessionOpenPayload = S.Schema.Type<
58
+ typeof LocalSessionOpenPayload
59
+ >;
60
+
61
+ /** Control messages on the local session-host broker. */
62
+ export const LocalSessionCtrlPayload = S.Union([
63
+ S.Struct({
64
+ t: S.Literal("open_ack"),
65
+ ok: S.Boolean,
66
+ live: S.optional(S.Boolean),
67
+ generation: S.optional(
68
+ S.Number.check(S.isInt(), S.isGreaterThanOrEqualTo(0)),
69
+ ),
70
+ error: S.optional(S.String.check(S.isMaxLength(64))),
71
+ message: S.optional(S.String.check(S.isMaxLength(256))),
72
+ }),
73
+ S.Struct({
74
+ t: S.Literal("resize"),
75
+ cols: TerminalDimension,
76
+ rows: TerminalDimension,
77
+ }),
78
+ /** Viewer became the active (focused) consumer — bumps primary election. */
79
+ S.Struct({ t: S.Literal("focus") }),
80
+ /** An observer left the browser surface; terminal retakes ad placement. */
81
+ S.Struct({ t: S.Literal("blur") }),
82
+ S.Struct({ t: S.Literal("replay_done") }),
83
+ S.Struct({ t: S.Literal("close"), intent: S.Literals(["detach", "kill"]) }),
84
+ ]);
85
+ export type TLocalSessionCtrlPayload = S.Schema.Type<
86
+ typeof LocalSessionCtrlPayload
87
+ >;
88
+
89
+ const decodeOpen = S.decodeUnknownResult(
90
+ S.revealCodec(LocalSessionOpenPayload),
91
+ );
92
+ const decodeCtrl = S.decodeUnknownResult(
93
+ S.revealCodec(LocalSessionCtrlPayload),
94
+ );
95
+
96
+ /** Decode a local session open, enforcing the cross-field rules, or null. */
97
+ export const parseLocalSessionOpenPayload = (
98
+ value: unknown,
99
+ ): TLocalSessionOpenPayload | null => {
100
+ const result = decodeOpen(value);
101
+ if (Result.isFailure(result)) return null;
102
+ const open = result.success;
103
+ if (open.dangerous === true && !supportsDangerousSession(open.cli))
104
+ return null;
105
+ if (open.cli === "shell" && open.resume_session_id !== undefined) return null;
106
+ if (open.resume_session_id !== undefined && open.mode !== "spawn")
107
+ return null;
108
+ if (open.cwd !== undefined && open.mode === "attach") return null;
109
+ return open;
110
+ };
111
+
112
+ /** Decode a local session control message, or null (unknown tags too). */
113
+ export const parseLocalSessionCtrlPayload = (
114
+ value: unknown,
115
+ ): TLocalSessionCtrlPayload | null => {
116
+ const result = decodeCtrl(value);
117
+ return Result.isSuccess(result) ? result.success : null;
118
+ };
@@ -0,0 +1,187 @@
1
+ import { Effect, Schema as S } from "effect";
2
+ import * as Result from "effect/Result";
3
+
4
+ /**
5
+ * Marketplace entry — one integration a user can enable. Same shape for the
6
+ * verified catalog (JSON in the repo) and, later, private user uploads.
7
+ * See `docs/plan/2026-10-13-marketplace.md` §3.
8
+ *
9
+ * `kind` is transport only:
10
+ * - `remote` — vendor MCP over HTTP (BYOK and/or included host-key proxy)
11
+ * - `hosted` — MCP served by OpenLLM at `/api/marketplace/mcp/<id>`
12
+ * - `package` / `download` — reserved for the daemon pipeline
13
+ */
14
+ export const MarketplaceEntryKind = S.Literals([
15
+ "remote",
16
+ "hosted",
17
+ "package",
18
+ "download",
19
+ ]);
20
+ export type TMarketplaceEntryKind = S.Schema.Type<typeof MarketplaceEntryKind>;
21
+
22
+ /** Where an integration can run. `team` entries appear on `/teams/[id]`. */
23
+ export const MarketplaceScope = S.Literals(["personal", "team"]);
24
+ export type TMarketplaceScope = S.Schema.Type<typeof MarketplaceScope>;
25
+
26
+ /** How access is provided — the pipeline acts on this, never on the vendor. */
27
+ export const MarketplacePolicy = S.Literals(["byok", "oauth", "none"]);
28
+ export type TMarketplacePolicy = S.Schema.Type<typeof MarketplacePolicy>;
29
+
30
+ export const MarketplaceTier = S.Literals(["free", "pro"]);
31
+ export type TMarketplaceTier = S.Schema.Type<typeof MarketplaceTier>;
32
+
33
+ /** A field the UI asks the user for. `secret` fields are vault-encrypted. */
34
+ export const MarketplaceConfigField = S.Struct({
35
+ key: S.String.check(S.isPattern(/^[a-z][a-z0-9_]{0,63}$/)),
36
+ label: S.String,
37
+ secret: S.Boolean,
38
+ required: S.Boolean,
39
+ help_url: S.optional(S.String),
40
+ });
41
+ export type TMarketplaceConfigField = S.Schema.Type<
42
+ typeof MarketplaceConfigField
43
+ >;
44
+
45
+ /**
46
+ * How clients reach the server. String values may hold `{{secret:<key>}}` /
47
+ * `{{config:<key>}}` placeholders, filled at launch.
48
+ */
49
+ export const MarketplaceMcp = S.Struct({
50
+ transport: S.Literals(["http", "sse", "stdio"]),
51
+ url: S.optional(S.String),
52
+ headers: S.optional(S.Record(S.String, S.String)),
53
+ command: S.optional(S.String),
54
+ args: S.optional(S.Array(S.String)),
55
+ env: S.optional(S.Record(S.String, S.String)),
56
+ /**
57
+ * Upstream tool names never exposed to users — account-owner operations
58
+ * (billing, logs, webhooks, account-wide jobs) that a consumer of the
59
+ * integration must not reach. Hidden from `tools/list` by the CLI and
60
+ * refused on `tools/call` by the included-usage proxy.
61
+ */
62
+ blocked_tools: S.optional(S.Array(S.String)),
63
+ /**
64
+ * When set, the ONLY upstream tools users may reach. Prefer it for a vendor
65
+ * whose MCP mixes data tools with account tools: a tool the vendor adds
66
+ * later stays hidden until it is reviewed and listed here, which a
67
+ * blocklist can't do. `blocked_tools` still applies on top.
68
+ */
69
+ allowed_tools: S.optional(S.Array(S.String)),
70
+ });
71
+ export type TMarketplaceMcp = S.Schema.Type<typeof MarketplaceMcp>;
72
+
73
+ /**
74
+ * Host-paid usage OpenLLM includes per plan tier, like the included inference
75
+ * model (`included_usage` on catalog models). Calls go through the gateway's
76
+ * metering proxy on OpenLLM's own vendor key — the key never reaches a client.
77
+ * A user who brings their own key bypasses it entirely.
78
+ */
79
+ export const MarketplaceIncludedUsage = S.Struct({
80
+ /** What one unit is, as shown to users. Each MCP `tools/call` is metered. */
81
+ unit: S.Literals(["tool_calls", "tokens"]),
82
+ free: S.Number,
83
+ trial: S.Number,
84
+ pro: S.Number,
85
+ /** Server env var holding the host key. Stripped from API responses. */
86
+ host_key_env: S.optional(S.String),
87
+ });
88
+ export type TMarketplaceIncludedUsage = S.Schema.Type<
89
+ typeof MarketplaceIncludedUsage
90
+ >;
91
+
92
+ export const MarketplaceEntry = S.Struct({
93
+ /** Becomes the client's MCP server name — must not shadow `openllm`. */
94
+ id: S.String.check(S.isPattern(/^[a-z][a-z0-9-]{1,47}$/)),
95
+ version: S.String,
96
+ name: S.String,
97
+ description: S.String,
98
+ homepage: S.String,
99
+ /** Optional logo URL, shown on the row tile. */
100
+ image: S.optional(S.String),
101
+ kind: MarketplaceEntryKind,
102
+ policy: MarketplacePolicy,
103
+ tier: MarketplaceTier.pipe(
104
+ S.withDecodingDefault(Effect.succeed("free" as const)),
105
+ ),
106
+ included_usage: S.optional(MarketplaceIncludedUsage),
107
+ /**
108
+ * On for every user until they turn it off — no installation row needed.
109
+ * Meaningful for included-usage remotes and for hosted entries that need
110
+ * no user key (e.g. OpenLLM Memory).
111
+ */
112
+ default_enabled: S.optional(S.Boolean),
113
+ /**
114
+ * Scopes this entry can be toggled in. `["personal"]` (default) is the
115
+ * per-user marketplace switch; `["personal","team"]` also appears on a
116
+ * team's Integrations tab (owner-toggled). Schema-decoded; an entry whose
117
+ * scopes lack `"team"` is never offered there and the API rejects it.
118
+ */
119
+ scopes: S.Array(MarketplaceScope).pipe(
120
+ S.optional,
121
+ S.withDecodingDefault(Effect.succeed(["personal"] as const)),
122
+ ),
123
+ /**
124
+ * MCP wiring. `remote` fills `url` / headers (placeholders allowed);
125
+ * `hosted` only needs `transport` — launch points at the gateway MCP
126
+ * path for the entry id.
127
+ */
128
+ mcp: MarketplaceMcp,
129
+ config: S.Array(MarketplaceConfigField).pipe(
130
+ S.optional,
131
+ S.withDecodingDefault(Effect.succeed([])),
132
+ ),
133
+ });
134
+ export type TMarketplaceEntry = S.Schema.Type<typeof MarketplaceEntry>;
135
+
136
+ /**
137
+ * A resolved MCP server for one launch: placeholders filled, secrets
138
+ * decrypted. Returned only to the owning user's own CLI.
139
+ */
140
+ export const MarketplaceLaunchServer = S.Struct({
141
+ id: S.String.check(S.isPattern(/^[a-z][a-z0-9-]{1,47}$/)),
142
+ transport: S.Literals(["http", "sse", "stdio"]),
143
+ url: S.optional(S.String),
144
+ headers: S.optional(S.Record(S.String, S.String)),
145
+ command: S.optional(S.String),
146
+ args: S.optional(S.Array(S.String)),
147
+ env: S.optional(S.Record(S.String, S.String)),
148
+ /** Carried from the entry's `mcp.blocked_tools`; the CLI drops these. */
149
+ blocked_tools: S.optional(S.Array(S.String)),
150
+ /** Carried from the entry's `mcp.allowed_tools`; only these are kept. */
151
+ allowed_tools: S.optional(S.Array(S.String)),
152
+ });
153
+
154
+ /**
155
+ * Whether users may reach upstream tool `name` under an entry's lists: listed
156
+ * in `allowed_tools` (when there is one) and not in `blocked_tools`. The one
157
+ * rule the client filter and the included-usage proxy both apply.
158
+ */
159
+ export const isUpstreamToolExposed = (
160
+ lists: {
161
+ readonly allowed_tools?: readonly string[] | undefined;
162
+ readonly blocked_tools?: readonly string[] | undefined;
163
+ },
164
+ name: string,
165
+ ): boolean =>
166
+ (lists.allowed_tools === undefined || lists.allowed_tools.includes(name)) &&
167
+ !(lists.blocked_tools ?? []).includes(name);
168
+ export type TMarketplaceLaunchServer = S.Schema.Type<
169
+ typeof MarketplaceLaunchServer
170
+ >;
171
+
172
+ /** Fail-open predicate for one `/api/marketplace/launch` server entry. */
173
+ export const isMarketplaceLaunchServer = (
174
+ value: unknown,
175
+ ): value is TMarketplaceLaunchServer => {
176
+ const result = S.decodeUnknownResult(MarketplaceLaunchServer)(value);
177
+ return Result.isSuccess(result);
178
+ };
179
+
180
+ export const MarketplaceLaunchResponse = S.Struct({
181
+ servers: S.Array(MarketplaceLaunchServer),
182
+ /** Read only by binaries up to v2.10.4; current ones use `servers`. */
183
+ builtins: S.optional(S.Array(S.String)),
184
+ });
185
+ export type TMarketplaceLaunchResponse = S.Schema.Type<
186
+ typeof MarketplaceLaunchResponse
187
+ >;
@@ -0,0 +1,81 @@
1
+ /**
2
+ * Media chain advance vs terminal — no chat-style timeout/5xx retry.
3
+ *
4
+ * Cloud and daemon media walks classify each hop with `classifyHopError`
5
+ * and then apply {@link mediaActionFor}, the media overlay on
6
+ * `cooldownPolicyFor` (no re-POST after dispatch, pre-dispatch misses walk).
7
+ */
8
+
9
+ import type { TCooldownPolicy, TCooldownReason } from "./cooldown-reason";
10
+ import { cooldownPolicyFor } from "./cooldown-reason";
11
+
12
+ /**
13
+ * Pre-dispatch media misses that never hit a provider. Walk without
14
+ * cooling; once `dispatched` they surface (a submit may have been accepted).
15
+ */
16
+ export const MEDIA_PRE_DISPATCH_REASONS = [
17
+ "missing_credential",
18
+ "model_unavailable",
19
+ "adapter_input_rejected",
20
+ "adapter_input_unmapped",
21
+ ] as const;
22
+ export type TMediaPreDispatchReason =
23
+ (typeof MEDIA_PRE_DISPATCH_REASONS)[number];
24
+
25
+ export type TMediaActionReason = TCooldownReason | TMediaPreDispatchReason;
26
+
27
+ /**
28
+ * Facts the media overlay needs beyond the shared classifier reason.
29
+ * HTTP status / envelope stay with `classifyHopError`; this only carries
30
+ * the billable-safety bits media owns.
31
+ */
32
+ export type TMediaActionFacts = {
33
+ readonly dispatched: boolean;
34
+ /**
35
+ * A 2xx (binary audio, undecodable body, created video job) or any other
36
+ * accept that must never be re-sent. Surfaces regardless of `reason`.
37
+ */
38
+ readonly accepted?: boolean;
39
+ readonly cancelled?: boolean;
40
+ };
41
+
42
+ const isPreDispatchReason = (
43
+ reason: TMediaActionReason,
44
+ ): reason is TMediaPreDispatchReason =>
45
+ (MEDIA_PRE_DISPATCH_REASONS as ReadonlyArray<string>).includes(reason);
46
+
47
+ const MEDIA_NO_RETRY_REASONS: ReadonlySet<TCooldownReason> = new Set([
48
+ "server_error",
49
+ "timeout",
50
+ "network",
51
+ ]);
52
+
53
+ /**
54
+ * Media overlay on the shared hop classifier.
55
+ *
56
+ * - Dispatched `server_error` / `timeout` / `network` **surface** (chat would
57
+ * `retry_in_place` — a media re-POST can duplicate an image, video job, or
58
+ * audio charge).
59
+ * - `accepted` (2xx / created job) or `cancelled` → surface, never re-sent.
60
+ * - Pre-dispatch misses (`missing_credential`, `model_unavailable`,
61
+ * adapter input rejected/unmapped) → `walk_no_cool` while undispatched;
62
+ * surface once dispatched.
63
+ * - Everything else follows {@link cooldownPolicyFor} unchanged.
64
+ */
65
+ export const mediaActionFor = (
66
+ reason: TMediaActionReason,
67
+ facts: TMediaActionFacts,
68
+ ): TCooldownPolicy => {
69
+ if (facts.cancelled === true || facts.accepted === true) {
70
+ return { action: "surface" };
71
+ }
72
+ if (isPreDispatchReason(reason)) {
73
+ return facts.dispatched
74
+ ? { action: "surface" }
75
+ : { action: "walk_no_cool" };
76
+ }
77
+ if (facts.dispatched && MEDIA_NO_RETRY_REASONS.has(reason)) {
78
+ return { action: "surface" };
79
+ }
80
+ return cooldownPolicyFor(reason);
81
+ };