@swarm-agent/sdk 0.1.47

package/APPLICATIONS.md

@@ -0,0 +1,133 @@
+# Application agents
+
+`client.apps` stores named, account-and-user-owned application instructions/context.
+It is **not** a mutable system-agent profile, worker, deployment or new executor.
+Models, tools, permissions and worktree admission still use Swarm's canonical authorities.
+
+Use an authenticated private BFF connection to the daemon local API (Unix socket
+or authenticated loopback). These routes are deliberately **not** allowed on the
+container SDK listener; do not expose the privileged socket or credentials to a browser.
+The routes require `sessions:read` / `sessions:write`, respectively.
+
+## Minimal private-server quickstart
+
+First construct `new SwarmClient()` in your BFF using its private environment/socket
+transport (never in the browser). If Codex is not connected, after explicit user
+consent call `client.auth.codex.start({method: 'device', active: false})`, display
+only the allowlisted HTTPS verification URL/user code, and call
+`client.auth.codex.status(login.session_id)` on user request until `status === 'success'`.
+Bind the login ID to your authenticated app session. Manual sign-in uses
+`start({method: 'manual', active: false})` then `complete(login.session_id, callback)`.
+Completion saves credentials and **can initialize account model defaults**, even
+with `active: false`; disclose this before starting. The current API has no cancel
+endpoint: abandoning a device flow does not revoke authorization already granted.
+These are user-driven calls, not startup hooks. App access tokens and provider
+sign-in are separate. Use the hub's BFF as a redaction/correlation example.
+
+With a saved workspace and configured account model:
+
+```ts
+import { SwarmClient } from '@swarm-agent/sdk';
+const client = new SwarmClient();
+const agent = await client.apps.put('editor', {
+  name: 'Editor', instructions: 'Prepare drafts; do not publish.',
+  context: 'Use our approved style guide.', expected_revision: 0,
+});
+const conversation = await client.apps.createConversation(agent.id, {
+  workspace_id: savedWorkspaceId, revision: agent.revision,
+  client_request_id: 'conversation-opening-1', title: 'Draft review',
+});
+await client.apps.send(agent.id, conversation.id, {
+  content: 'Prepare a launch announcement.', client_request_id: 'event-1',
+});
+// Persist these IDs in the application; reopen after reload or daemon restart.
+const result = await client.apps.conversation(agent.id, conversation.id);
+```
+
+`PUT /v3/application-agents/{id}` creates at expected revision zero or updates at
+an exact revision; an identical immediately retried write returns the same record.
+Stale/different writes return 409. `GET` returns latest context. Each conversation
+pins an immutable revision at creation. Updates affect **new** conversations only;
+they never silently rewrite an existing conversation's instructions. Use the same
+request ID and revision when retrying creation or delivering the same event.
+Instructions reach the V3 provider instruction boundary, not synthetic chat messages.
+Conversation/message/event routes verify both principal and server-stored binding.
+`apps.list({limit, cursor})` discovers persisted agents (limit 1–100). Use the returned
+`next_cursor` unchanged. `apps.conversations(id)` returns a bounded recent view,
+explicitly reporting when its 1,000-session scan limit is reached; retained IDs
+always reopen directly. There is no delete API in this initial contract.
+
+## Task-oriented applications remain independent
+
+No conversation UX is required for the existing project task or worker APIs:
+
+```ts
+const queued = await client.projects.createTask(projectId, {
+  agent: 'swarm', title: 'Prepare release notes', description: 'Summarize approved changes.',
+});
+// Use the returned task ID with the existing approval/reopen lifecycle.
+const result = await client.projects.getTask(projectId, taskId);
+const worker = await client.workers.get(workerId);
+```
+
+Optionally include `project_id` and `worker_ids` in `apps.put`. The server validates
+account ownership and resource-read scopes before persisting these links. These
+links are navigation/execution targets, not context synchronization:
+
+```ts
+await client.apps.createTask(agent.id, { id: durableJobId, agent: 'swarm', title: 'Draft', description: brief });
+const tasks = await client.apps.tasks(agent.id);
+const worker = await client.apps.worker(agent.id, linkedWorkerId);
+const runs = await client.apps.runs(agent.id, linkedWorkerId);
+```
+
+Task creation requires an explicit `agent` or `intent`; `agent: 'swarm'` selects
+ordinary general work, not a model/provider override. The linked project must have
+an authorized repository workspace resolvable by canonical source admission.
+Reuse the same durable task ID and payload on retry. Creation does not request
+auto-approval; retain the existing approval lifecycle.
+
+Projects, tasks and workers retain their own server-side context, revision,
+trigger and result contracts. Task requests go through canonical project admission;
+linked configuration uses `apps.configureAutomation(id, workerId, revision, input, automationId?)`;
+`apps.trigger(id, {worker_id, automation_id, payload, idempotency_key})` preserves delivery identity.
+Unlinked worker IDs are rejected. Canonical worker scopes, revisions and approval gates remain enforced;
+activation, deployment, enable/disable and token minting are deliberately not forwarded.
+The editable `examples/agent-hub` UI demonstrates these calls.
+Task execution may have internal durable sessions without requiring chat in your UX.
+Worker deployment/automation management is an Orchestrator operation. These snippets
+are API usage examples, not a claim of a live deployed or cloud-verified workflow.
+
+## Automatic results without a chat UI
+
+<copy>
+const results = client.apps.watchResults(agent.id, {
+  onChange: ({ tasks, workers }) => renderResults(tasks, workers),
+  onError: () => showReconnectButton(),
+});
+await results.ready;
+// On logout, navigation or component disposal:
+results.dispose();
+await results.done;
+
+const chat = await client.apps.watchConversation(agent.id, conversation.id, {
+  onChange: ({ messages, live }) => renderConversation(messages, live),
+});
+</copy>
+
+Watchers use the existing authenticated V3 socket, opaque snapshot resume cursors,
+authorized resource reads and bounded reconnects. No polling or new execution state
+is introduced. The resource watcher uses the daemon's account-scoped, content-free
+worker invalidation signals; project invalidations are filtered by the linked ID.
+It returns bounded task/run lists, not an unlimited event ledger. Disconnects re-read
+durable state, not transient event payloads. Browser apps should stream these selected
+results through their authenticated BFF; never send daemon credentials to the browser.
+
+Resource-only resume currently has no explicit acceptance/replay-done frame.
+`watchResults.ready` waits for a post-hello resource/watermark/keepalive and a fresh
+authorized snapshot (idle connections can take one 15-second keepalive interval).
+This is a liveness fence, not an atomic snapshot of all resources. Read-time
+invalidations coalesce into another read; reconnect bootstraps again.
+Worker signals currently omit worker IDs, so **every account worker invalidation
+requires refreshing linked workers**; unrelated worker events cannot safely be
+filtered client-side. Per-worker invalidation needs a backend protocol change.

package/HEADLESS_UI.md

@@ -0,0 +1,97 @@
+# Build a real headless UI with the SDK
+
+## Trust boundary
+
+Run the administrative Node SDK in your backend-for-frontend **inside the same container as swarmd**, using its configured private Unix socket. Do not mount/export that socket, put daemon credentials in browser code, or forward arbitrary browser-selected daemon paths. Authenticate your app's users, check Origin/CSRF, and allowlist app operations. Never log credential request bodies. The separate `--container-sdk-port` listener remains session-only: it cannot onboard providers, change settings, or create workspaces.
+
+Node 22+ is required. `ws` supplies Unix-socket WebSocket upgrades; HTTP and WebSocket requests use the same SDK credentials/headers. Browser use requires a same-origin authenticated app proxy, no SDK bearer token; otherwise forward watcher updates from your BFF using your app's authenticated SSE/WebSocket transport.
+
+## Discover, authenticate, configure
+
+<copy>
+import { SwarmClient } from '@swarm-agent/sdk';
+const swarm = new SwarmClient({ socketPath: process.env.SWARM_SOCKET_PATH });
+const onboarding = await swarm.onboarding.get();
+const providers = await swarm.settings.providers(); // readiness and supported auth_methods
+const credentials = await swarm.auth.credentials.list(); // redacted status only
+</copy>
+
+Your app must supply its configured socket path and authenticated local identity. This is not a recipe to import host credentials. Complete the daemon's identity/onboarding requirements using `onboarding.update({ username, swarm_name })` when needed.
+
+For an API key collected through your app UI, pass the user-selected provider and its advertised credential type. The first-provider endpoint requires zero existing credentials/agents; use the ordinary save endpoint afterward. Errors are not silently retried on a different route.
+
+<copy>
+await swarm.auth.credentials.save({
+  provider: selectedProvider, type: selectedCredentialType,
+  api_key: submittedKey, label: 'Headless app', active: true,
+});
+const catalog = await swarm.settings.models(selectedProvider);
+const settings = await swarm.settings.agentModels();
+// Display catalog.records and settings.agent_model_settings. Never invent a model fallback.
+// Optional explicit user selection:
+await swarm.settings.setSwarmModel('action', selectedAssignment);
+</copy>
+
+`auth.credentials` also exposes `verify(provider, id)`, `activate(provider, id)`, and `delete(provider, id)`. Verification may call a real provider. First-run OpenAI credentials may be stored active but unverified; inspect `connection` and `auto_defaults.error` rather than treating storage as successful inference.
+
+### Codex sign-in
+
+<copy>
+const login = await swarm.auth.codex.start({ method: 'device', active: true });
+// Display login.verification_url and login.user_code; never display access tokens.
+// On explicit refresh, or a bounded UI login-status loop stopped at expiry/unmount:
+const status = await swarm.auth.codex.status(login.session_id);
+// status.status: waiting / authorizing / success / error
+</copy>
+
+Device login completes asynchronously in the daemon and is the preferred container flow. `manual` returns `auth_url`; submit the user's callback input with `auth.codex.complete(login.session_id, callbackInput)`. `browser` also returns `auth_url`, but its callback listener runs where the daemon runs, not automatically in the host browser's network namespace. Do not claim browser callback reachability without configuring and testing it. Device sessions reject `complete`. Login-status polling is separate from session realtime; chat must not poll.
+
+## Create a workspace and durable session
+
+<copy>
+const folder = await swarm.workspaces.createFolder(configuredWorkspaceParent, 'my-app');
+const repository = await swarm.workspaces.inspectRepository(folder.path);
+if (repository.can_setup) {
+  // Explicit user-approved Git initialization; expected path guards identity changes.
+  await swarm.workspaces.setupRepository(folder.path, repository.path);
+}
+const workspace = await swarm.workspaces.add({ path: folder.path, make_current: false });
+const session = await swarm.sessions.create({
+  workspace_path: workspace.workspace_path, title: 'My app chat', mode: 'auto',
+});
+</copy>
+
+Do not automatically commit existing content. `reviewRepository(path)` returns selectable paths and a review digest; `baselineRepository(...)` requires that digest, exact selected paths and explicit confirmations. `add` may return a repository prerequisite/content-review conflict. Surface it, do not silently set `confirm_committed_only`. Folder creation, Git preparation, registration and session creation are separate operations; failures can leave a created folder without a registered workspace.
+
+## Stream without reverse engineering
+
+<copy>
+const abort = new AbortController();
+const watch = swarm.realtime.watchSession(session.id, {
+  signal: abort.signal,
+  onChange(state) {
+    // Replace the displayed snapshot. Key durable messages by id.
+    // Render state.live separately by [runId, streamId]; it contains full text,
+    // not append-only deltas. Committed streams disappear from this overlay.
+    sendToAuthenticatedAppClient(state);
+  },
+  onError(error) { reportAppError(error.message); },
+});
+await watch.ready; // initial snapshot and scoped replay subscription established
+// Keep the same client_request_id when retrying this submission.
+await swarm.sessions.sendMessage(session.id, { content: userText, client_request_id });
+await watch.done; // rejects on terminal transport/protocol/auth errors
+// On app disconnect: watch.dispose() or abort.abort().
+</copy>
+
+The watcher hydrates one session (including its session view), waits for `hello` (`v3.realtime`, version 1), and resumes from the **snapshot handoff cursor**, not the newer hello head. The server replays to the subscription before delivering live updates. It advertises `live_patch_v1` only when the server offers it. UTF-8 byte offsets and sequence ranges deduplicate live text; durable checkpoints and committed messages remain authoritative. Foreign-session frames never update the view.
+
+Durable events trigger coalesced `/v3/sync/hydrate` reads, not interval polling. Disconnects, cursor errors and slow consumers start fresh scoped hydration/replay with bounded exponential backoff (six retries, 250ms to 8s). Authentication/protocol errors terminate. No cursor is parsed, numerically compared, or persisted across watches/principals. `dispose` cancels HTTP, closes WebSocket, and ends `done`; a disposed-before-ready watcher rejects `ready`.
+
+### Bounded view and raw access
+
+The high-level view is a **200-message / 200-event tail**, not the complete transcript. Inspect `snapshot.pagination`, `omissions`, history manifests and session views before claiming complete history. A mid-stream reconnect whose retained event tail lacks the stream prefix may show no partial draft until a durable complete message arrives; it never guesses missing text. A live offset gap pauses that stream's speculative patches and relies on durable repair. Live overlays are bounded to 64 streams / 4 MiB per stream. Tool, plan, permission and other resources stay in the canonical raw snapshot; the SDK does not invent a second plan authority.
+
+`realtime.bootstrap(request)`, `hydrate(request)` and `replay({...request, endpoint_cursor, limit})` expose typed canonical V3 envelopes for advanced consumers. Keep surface, selector and resources identical when using `/v3/sync/stream` cursors. `realtime.socket(path)` exposes transport only; raw consumers own reducer/replay correctness. The convenience watcher uses fresh durable repair on reconnect rather than retaining a possibly stale speculative cache.
+
+No live daemon/provider or container validation is claimed by this guide. Unit fixtures prove wire/reducer behavior only; the deploying app must verify onboarding, real inference, streamed text, restart recovery and container isolation against its candidate.

package/LICENSE

@@ -0,0 +1,201 @@
+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 Swarm contributors
+
+   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.