@managoat/fountain-sdk 1.25.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Jake Gaylor
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,445 @@
+# @managoat/fountain-sdk
+
+Give an agent a computer, your repos and your credentials — in one call.
+
+```ts
+import { Fountain } from "@managoat/fountain-sdk";
+
+const fountain = new Fountain();
+
+const run = await fountain.run("Upgrade us to Phoenix 1.8 and open a PR", {
+  agent: "reposage",
+  vault: "github-bot",   // the token lands in the sandbox, never in the prompt
+});
+
+console.log(run.text);   // what the agent said
+console.log(run.url);    // where a human can watch it happen
+```
+
+That is the whole thing. The agent ran on a real machine with your repository
+cloned and your GitHub token attached at spawn time, and the machine is still
+there when you want to ask it something else.
+
+## Why not just call a model?
+
+A model API takes a prompt and returns tokens. To make it do work you supply
+the computer, the checkout, the tools and the secrets — and you keep supplying
+them, on every call, because nothing persists between them.
+
+Fountain's unit is not a message. It is **a sandbox with an agent in it**:
+
+| | model API | `fountain.run()` |
+|---|---|---|
+| where it runs | your process | an isolated sandbox, provisioned per run |
+| your repo | you paste it in | already cloned, from the **environment** |
+| your secrets | in the prompt, or in your process | attached at spawn from a **vault**, never in the transcript |
+| the next question | resend the whole context | `resume(id).send("...")` — same machine, same session |
+| watching it | your logs | `run.url`, a live transcript |
+
+`vault` is the argument to look at. Its values are decrypted into the sandbox's
+environment when the sandbox spawns; they are never part of the prompt, never
+in the model's context, and never in the log feed this SDK reads. Swapping
+`vault: "github-bot"` for `vault: "github-readonly"` changes what the agent can
+do without changing a word of the task.
+
+There is a second layer under that, and it is worth knowing about because it
+changes what you can safely let an agent do: Fountain redacts every value of 8
+bytes or more that it placed in the sandbox's environment out of the
+conversation's output, on the single write path every log event goes through.
+An `env`, a `set -x`, a `cat .env`, or an agent simply asked to print its token
+persists as `[REDACTED]`. The secret reaches the process that needs it and not
+the transcript, the database, or this SDK.
+
+## What it replaces
+
+Every integration that ever talked to Fountain wrote the same wrapper first —
+open a conversation, send the prompt, follow the log feed, decide when the turn
+is over, glue the text back together. This is that wrapper, once:
+
+<details>
+<summary>The same run, by hand</summary>
+
+```bash
+# 1. find the agent, the vault, the environment (three listings, by name)
+curl -sH "$AUTH" $BASE/api/agents | jq -r '.data[] | select(.name=="reposage") | .id'
+curl -sH "$AUTH" $BASE/api/vaults | jq -r '.data[] | select(.name=="github-bot") | .id'
+
+# 2. open the conversation
+CONV=$(curl -sH "$AUTH" -H 'Content-Type: application/json' \
+  -d '{"agent_id":"...","vault_id":"...","prompt":"Upgrade us to Phoenix 1.8"}' \
+  $BASE/api/conversations | jq -r .data.id)
+
+# 3. follow the feed — and now the real work starts:
+#    - page /events?blocks=true&after=N until has_more is false
+#    - keep only events whose turn_id is *your* turn's
+#    - keep only `text` blocks; `tool_use` is not the answer, `thinking` is not either
+#    - join acp chunks with nothing, stdout rows with a blank line,
+#      and start a new paragraph after any tool call
+#    - stop on stage/turn/done — or failed, or interrupted
+#    - and when the connection drops mid-turn, resume from the last event id
+#      or you will either miss output or replay it twice
+curl -sH "$AUTH" "$BASE/api/conversations/$CONV/stream?blocks=true" | ...
+```
+
+</details>
+
+Those rules are not incidental complexity you could skip — get the paragraph
+rule wrong and every transcript reads as one run-on sentence; get the cursor
+wrong and a deploy mid-turn silently drops the answer. They are in here, with
+tests.
+
+## Install
+
+```bash
+npm install @managoat/fountain-sdk
+```
+
+Node 20.19+ (native `fetch` and ESM). No runtime dependencies.
+
+## Credentials
+
+`new Fountain()` resolves the same way the `fountain` CLI does, so a script
+inherits whatever already works in your terminal:
+
+```
+apiKey:  option → FOUNTAIN_API_KEY → FOUNTAIN_TOKEN → ~/.fountain/credentials
+baseUrl: option → FOUNTAIN_BASE_URL → ~/.fountain/credentials → hosted
+```
+
+```ts
+new Fountain({ apiKey: process.env.FOUNTAIN_API_KEY, baseUrl: "https://fountain.internal" });
+new Fountain({ profile: "work" });   // a profile from ~/.fountain/credentials
+```
+
+`FOUNTAIN_TOKEN` is what a Fountain sandbox exports for the agent running
+inside it. An agent that imports this SDK therefore delegates with the token it
+already has, and the conversations it starts are recorded as its children — no
+extra configuration to fan work out.
+
+## Waiting, or not
+
+`run()` starts the work and hands back a handle. What you do with the handle
+decides how much of the run you see; there is no second request behind any of
+these.
+
+```ts
+// await it — the finished answer
+const result = await fountain.run(prompt, { agent: "reposage" });
+
+// stream the words
+const run = fountain.run(prompt, { agent: "reposage" });
+for await (const chunk of run.textStream) process.stdout.write(chunk);
+const result = await run;                      // same run, now finished
+
+// or watch everything: tools, thinking, lifecycle
+for await (const event of run) {
+  if (event.type === "tool") console.log("→", event.name);
+  if (event.type === "text") process.stdout.write(event.text);
+}
+
+// or don't wait at all — fan out, collect later
+const runs = agents.map((agent) => fountain.run(prompt, { agent }));
+const results = await Promise.all(runs);
+```
+
+A `RunResult` is:
+
+```ts
+{
+  conversationId: string;   // keep it — the sandbox is still there
+  url: string;              // where a human watches
+  turnNumber: number;
+  text: string;             // the answer, tool noise removed
+  toolsUsed: string[];
+  state: "done" | "failed" | "interrupted" | "timeout";
+  exitCode: number | null;
+  reason: string | null;    // stop_reason, or why it failed
+  status: string | null;    // the conversation's status
+}
+```
+
+A turn that **fails** is a result, not an exception — the agent ran and has
+something to say about it. Check `state`. Only a transport failure, a rejected
+request or a timeout throws.
+
+## When the agent asks first
+
+An agent whose `permission_policy` has an `ask` entry stops before the tool
+call and waits to be told. Nothing else in the turn moves until it is answered,
+and an unanswered request is denied when it expires — so an `ask` agent driven
+by a caller that ignores these finishes having quietly skipped the work.
+
+```ts
+for await (const event of run) {
+  if (event.type !== "permission") continue;
+
+  console.log(event.request.summary);          // "Run rm -rf build"
+  const allow = event.request.options.find((o) => o.kind === "allow_once");
+  await run.answer(event.request.requestId, allow!.optionId);
+}
+```
+
+`options` is whatever the agent offered, in its order; `kind` is the part worth
+branching on (`allow_once`, `allow_always`, `reject_once`, `reject_always`).
+Sending an id the agent did not offer is a `ValidationError`, not a forwarded
+answer. `resume(id).answer(...)` is the same call from a process that is not
+the one following the turn.
+
+The default policy is `auto_allow` and never asks, so this is opt-in per agent.
+`opencode` never asks at all and refuses anything stricter than `auto_allow`.
+
+## Defining what you run
+
+`run()` names an agent; this is where the agent comes from. The whole
+vocabulary fits on one screen:
+
+```ts
+const environment = await fountain.environments.create({
+  name: "fountain-ci",
+  packages: { apt: ["ripgrep"] },
+  env_vars: { MIX_ENV: "test" },
+  repositories: [
+    { url: "https://github.com/managoat/fountain", mount_path: "/work/fountain" },
+  ],
+  setup_script: "cd /work/fountain && mix deps.get",
+  networking_type: "limited",
+  networking_config: { allowed_hosts: ["github.com", "hex.pm", "api.anthropic.com"] },
+});
+
+const vault = await fountain.vaults.create({ name: "github-bot" });
+await fountain.vaults.secrets.set("github-bot", "GITHUB_TOKEN", process.env.GITHUB_TOKEN!);
+
+const agent = await fountain.agents.create({
+  name: "reposage",
+  runtime: "claude",
+  model: "anthropic/claude-sonnet-5",
+  system: "You are a careful reader of other people's code.",
+  environment_id: environment.id,
+  skills: [
+    { source: "obra/superpowers", ref: "v2.1.0" },
+    { name: "house-style", content: "# House style\n\nPrefer small diffs." },
+  ],
+  mcp_servers: { linear: { command: "npx", args: ["-y", "linear-mcp"] } },
+  allowed_vault_ids: [vault.id],   // this agent may attach that vault, and no other
+});
+
+await fountain.run("Find every N+1 query and open a PR", {
+  agent: "reposage",
+  vault: "github-bot",
+});
+```
+
+`agents`, `environments` and `vaults` all have the same five verbs — `list`,
+`get`, `create`, `update`, `delete` — and take a name or an id:
+
+```ts
+await fountain.agents.update("reposage", { model: "anthropic/claude-opus-5" });
+await fountain.environments.secrets.set("fountain-ci", "HEX_API_KEY", "…");
+await fountain.vaults.secrets.list("github-bot");   // keys only — never values
+await fountain.vaults.secrets.delete("github-bot", "GITHUB_USER");
+```
+
+Secret values are write-only. `list` returns keys and nothing else: the SDK can
+put a credential into a sandbox and cannot read it back out.
+
+**Why `environment_id` and not `environmentId`.** Resource payloads use the
+API's own key names, so one definition reads identically in the SDK, in the
+REST API and in a `fountain.yml` manifest. Options that control the SDK's own
+behaviour — `timeoutMs`, `signal` — are camelCase, because those are not data.
+
+## The team
+
+Ten of the eleven applications built on Fountain talk to `/api/team`, and some
+never touch `/api/conversations` at all — a teammate is durable (one agent, one
+long-running sandbox, one thread you keep messaging) where a conversation is
+something you open and close.
+
+```ts
+await fountain.team.add("watchtower", { name: "Watchtower" });
+
+const reply = await fountain.team.message("watchtower", "Any disks over 80%?");
+console.log(reply.text);          // `message()` returns the same Run handle as `run()`
+
+for await (const event of fountain.team.stream({ streams: ["stage"] })) {
+  if (event.stage === "turn" && event.state === "done") refreshRoster();
+}
+```
+
+`list`, `get`, `rename`, `remove`, `history`, `freshConversation`, and
+`team.schedules.*` for cron routines. The stream reconnects from its last event
+id on its own, and carries server-parsed `blocks` like every other feed — the
+runtime is picked per event from the conversation that produced it — so one
+connection is enough to render a thread.
+
+Opening a thread is two calls, and every app wrote both by hand first:
+
+```ts
+const conversation = fountain.resume(id);
+const events = await conversation.history({ streams: ["acp", "stage"] });  // paged to the end
+await conversation.markRead();
+```
+
+## Errors
+
+Branch on `code`, not status — `conversation_busy` is a 400,
+`sandbox_quota_exceeded` a 429, `provisioning` a 503:
+
+```ts
+if (error instanceof ConversationBusyError) …   // the turn in flight must finish
+if (error instanceof QuotaExceededError) …      // error.activeSandboxes / error.limit
+if (error instanceof NotReadyError) …           // error.retryAfter, from the server
+if (error instanceof ValidationError) …         // error.fieldErrors
+```
+
+Every error carries `status`, `code`, `body`, `retryAfter` and `retryable`.
+
+| class | when |
+|---|---|
+| `AuthError` | 401, or no key configured at all |
+| `SubscriptionRequiredError` | 402 — carries `upgradeUrl` |
+| `NotFoundError` | 404 — wrong id, or it belongs to another account |
+| `ValidationError` | 422 — read `fieldErrors` |
+| `RateLimitError` | 429 |
+| `ConversationBusyError` | the agent is still on the previous prompt |
+| `QuotaExceededError` | at the concurrent-sandbox cap — `activeSandboxes` / `limit` |
+| `NotReadyError` | the sandbox is still coming up — retry after `retryAfter` |
+| `TimeoutError` | the SDK stopped waiting — carries `conversationId` and `partialText` |
+| `ResolutionError` | a name matched no agent/vault/environment, or matched several |
+| `ConnectionError` | the request never reached Fountain — in a browser, usually CORS |
+
+A `ResolutionError` names what the account actually has, so a typo is a
+one-line fix rather than a trip to the console.
+
+## In a browser
+
+The default entry imports no Node built-in, so it bundles as-is; the
+credentials-file reader lives behind the `node` export condition.
+
+```ts
+const fountain = new Fountain({ baseUrl, apiKey });   // from your own settings UI
+```
+
+Your origin has to be in the server's `API_CORS_ORIGINS`, or every call fails
+before it starts — `ConnectionError` says so, because "Failed to fetch" has
+sent more than one person hunting through their own code.
+
+## Generated underneath
+
+`src/generated/openapi.ts` is produced from the same OpenAPI document the
+server serves, and CI regenerates it and fails on a diff — so the types cannot
+drift from the API. `import type { components, paths } from "@managoat/fountain-sdk"` for
+the raw shapes. What is hand-written is what a spec cannot express: that many
+log events fold into one turn, and which of 85 paths are worth a verb.
+
+## Follow-ups
+
+```ts
+const first = await fountain.run("Find every N+1 query in this repo", { agent: "reposage" });
+
+const second = await fountain.resume(first.conversationId).send("Fix the worst three.");
+```
+
+The second turn costs one prompt. The sandbox is the same machine, the checkout
+is where the first turn left it, and the agent's session still holds everything
+it learned — this is the part a stateless API cannot do at any price.
+
+## Timeouts and cancellation
+
+By default `run()` waits as long as the turn takes; agent work legitimately
+runs for hours.
+
+```ts
+try {
+  await fountain.run(prompt, { agent: "reposage", timeoutMs: 5 * 60_000 });
+} catch (error) {
+  if (error instanceof TimeoutError) {
+    // The turn did not stop — only the waiting did.
+    console.log(error.partialText);
+    const rest = await fountain.resume(error.conversationId).send("status?");
+  }
+}
+```
+
+- `timeoutMs` — stop waiting, throw `TimeoutError`. The agent keeps working.
+- `signal` — an `AbortSignal` that stops the waiting, same deal.
+- `run.interrupt()` — ask the agent to stop the turn. The sandbox stays up.
+- `run.terminate()` — tear the sandbox down. Nothing resumes after this.
+
+## The rest of the API
+
+The verbs above are the ones worth wrapping. Everything else Fountain exposes —
+61 paths and counting: audit, schedules, the team, API keys, conversation trees
+and images — is one call away, with the same auth and error mapping:
+
+```ts
+await fountain.request("GET", "/api/audit", { query: { limit: 50 } });
+await fountain.request("POST", "/api/vaults", { body: { name: "staging" } });
+```
+
+`GET /api/openapi.json` is the generated, always-current spec for those.
+
+## Names, not ids
+
+`agent`, `vault` and `environment` all take a name or an id. Names resolve
+against the account (exact match first, then a unique prefix) and the listings
+are memoized per client. A UUID in a script tells the next reader nothing;
+`vault: "github-bot"` tells them everything.
+
+## Development
+
+```bash
+npm install
+npm test          # node --test, against an in-process fake Fountain
+npm run typecheck
+npm run build
+```
+
+The tests run a fake Fountain over real HTTP and real SSE, including the parts
+that are easy to get wrong: a connection that dies mid-turn, output belonging
+to another turn, and the two different ways runtimes chunk their text.
+
+`npm test` runs the TypeScript sources directly, which needs Node 22.6+ even
+though the published package only needs 20.19 — the tarball is compiled. CI
+runs on Node 24.
+
+A route added to `test/server.ts` has to answer in the same envelope the real
+one does. Nearly everything is `{data: …}`; the nine that are not are listed at
+the top of that file. A fake that wraps one of those turns a green suite into a
+lie, which is how `me()` shipped returning `null`.
+
+### Releasing
+
+**CI is the only publisher.** `npm publish` from a checkout refuses, and npm is
+configured to accept releases only from this repository's `Publish SDK`
+workflow — so a tarball on the registry always carries provenance tying it to
+a commit and a workflow run.
+
+There is no release command and no tag to push. **Merging a version bump is the
+release.**
+
+```bash
+cd sdk/typescript
+npm version patch          # or minor / major — edits package.json + the lockfile
+```
+
+Then update two things `npm version` does not touch, and open a PR as usual:
+
+- `USER_AGENT` in `src/http.ts`
+- a `## [x.y.z]` section in `CHANGELOG.md`
+
+The `SDK release gate` check on the PR fails if either is missing, if the
+version is already on npm, or if you changed what the package ships without
+bumping at all. When the PR merges, `Publish SDK` sees a version the registry
+does not have, publishes it, and tags the merge commit `sdk-v<version>`.
+
+A PR that touches only tests, examples or the changelog needs no bump; the
+gate stays quiet, and the publish workflow finds nothing to do. To change the
+published surface deliberately without releasing, label the PR
+`sdk-no-release`.
+
+## License
+
+[Apache-2.0](LICENSE). Fountain is not licensed as a single unit: the server is
+AGPL-3.0-or-later, and the clients — this SDK and the CLI — are Apache-2.0 on
+purpose. Talking to the API, or shipping this SDK inside a proprietary
+application, puts no licence obligation on your code.