@m64/nats-pi-bridge 0.0.1

package/DESIGN.md

@@ -0,0 +1,350 @@
+# nats-pi-bridge — Design Document
+
+## Overview
+
+Standalone headless service that spawns and manages PI coding agent sessions on demand via NATS. Callers send structured JSON commands to an **intake endpoint** (control plane) to create, run, and stop sessions. Persistent sessions also expose **per-session endpoints** (data plane) for follow-up prompts using the standard streaming wire protocol.
+
+Part of the Synadia NATS AI Agents ecosystem alongside:
+- `@m64/nats-channel` — OpenClaw channel plugin (loads into OpenClaw)
+- `nats-claude-channel` — Claude Code channel (loads into Claude Code via MCP)
+- `@m64/nats-pi-channel` — PI extension (loads into interactive PI sessions)
+
+This bridge is different: it does NOT load into PI. It embeds PI headlessly via the SDK.
+
+## Architecture
+
+```
+┌──────────────────────────────────────────────────────────────┐
+│  nats-pi-bridge (standalone service)                         │
+│                                                              │
+│  Service: pi-exec                                            │
+│                                                              │
+│  CONTROL PLANE                                               │
+│  ─────────────                                               │
+│  Intake endpoint: agents.pi-exec.<owner>                     │
+│    Structured JSON commands: run, session, stop, list         │
+│                                                              │
+│  DATA PLANE                                                  │
+│  ──────────                                                  │
+│  Per-session endpoints (registered on demand):               │
+│    agents.pi-exec.<owner>.<sessionId>                        │
+│    Wire protocol: plain text or {from,body}, streaming       │
+│    chunks, empty payload = done                              │
+│                                                              │
+│  ┌─────────┐  ┌─────────┐  ┌─────────┐                      │
+│  │ abc123  │  │ def456  │  │ (ephem) │                       │
+│  │ nats-zig│  │ sid-gpt │  │ run cmd │                       │
+│  │ persist │  │ persist │  │ no endpt│                       │
+│  └─────────┘  └─────────┘  └─────────┘                      │
+│                                                              │
+│  sessions: Map<sessionId, ManagedSession>                    │
+└──────────────────────────────────────────────────────────────┘
+```
+
+## Key Design Decisions
+
+### Control plane vs data plane separation
+
+The intake endpoint (`agents.pi-exec.<owner>`) is the **control plane**. It handles session lifecycle: create, stop, list. It accepts structured JSON with a `sessionMode` field.
+
+Per-session endpoints (`agents.pi-exec.<owner>.<sessionId>`) are the **data plane**. They handle prompts using the standard wire protocol shared with all sibling implementations (plain text or `{from, body}` envelope, streaming chunks, empty = done).
+
+**No mixing.** Sending a `sessionMode: "session"` command to the intake for an already-existing session is rejected. Follow-up prompts go to the per-session endpoint. This eliminates ambiguity around field handling (what if `cwd` or `model` differ on reuse?).
+
+### Separate microservice name
+
+The bridge registers as `pi-exec`, not `pi-channel`. This cleanly separates headless/dynamic sessions from interactive PI sessions:
+
+```
+nats micro list
+→ pi-channel    (2 instances)   ← interactive (human at keyboard)
+→ pi-exec       (3 instances)   ← headless (bridge-managed)
+→ claude-channel (1 instance)   ← Claude Code
+```
+
+No namespace collision, no awkward subject prefixes, no cross-service confusion.
+
+### Caller-owned session naming
+
+The caller decides the `sessionId`. UUIDs, hashes, descriptive names — whatever the caller's automation needs. The bridge does not do collision detection on session names. If the sessionId already exists, the intake rejects with the session's endpoint subject so the caller can redirect.
+
+**`sessionId` is required on `session` mode requests.** There is no auto-generation — callers must pick and track their own IDs. The intake rejects missing IDs with `{error:"missing_fields", required:[..., "sessionId"]}`, and rejects IDs that would change under sanitization (`[a-z0-9_-]+`) with `{error:"invalid_sessionId", sessionId, suggested}` so the caller knows exactly what to send next time.
+
+Rationale: the caller addresses the per-session subject by `sessionId`, so it must know the exact value up front — returning a generated ID in the first stream chunk would force every caller to parse a response envelope before the real agent output arrives, which breaks the uniform wire protocol shared with the sibling implementations.
+
+### Subject convention
+
+```
+agents.pi-exec.<owner>                    ← intake (permanent)
+agents.pi-exec.<owner>.<sessionId>         ← per-session (dynamic)
+agents.pi-exec.<owner>.<sessionId>.inspect ← per-session inspect
+```
+
+- `owner`: from `$USER`, sanitized (same as pi-channel / claude-channel)
+- No `org` field for now. Can add later if needed.
+
+## Session Modes
+
+Single field `sessionMode` on the intake request. Four values, no invalid combinations.
+
+### `run` (default, simplest case)
+
+Ephemeral single-shot execution. No endpoint registered, no discoverability, no follow-ups.
+
+```json
+{
+  "sessionMode": "run",
+  "body": "List all TODO comments in the codebase",
+  "cwd": "/home/mario/code/nats-zig",
+  "from": "ci-bot"
+}
+```
+
+Flow:
+1. Create PI session with `SessionManager.inMemory()`
+2. Subscribe to events
+3. Call `session.prompt(body)`
+4. Stream `text_delta` chunks to NATS reply subject
+5. On `agent_end`, publish empty payload (done)
+6. `session.dispose()`
+
+No sessionId needed. No tracking. Fire and forget.
+
+### `session` (persistent, addressable)
+
+Creates a long-lived session with a per-session endpoint for follow-ups.
+
+```json
+{
+  "sessionMode": "session",
+  "body": "Run tests and fix failures",
+  "cwd": "/home/mario/code/nats-zig",
+  "sessionId": "my-worker-1",
+  "from": "orchestrator",
+  "model": "anthropic/claude-sonnet-4-5",
+  "thinkingLevel": "medium",
+  "maxLifetime": 3600
+}
+```
+
+Flow:
+1. Validate required fields (`body`, `cwd`, `sessionId`) and sanitize `sessionId`; reject if any are missing or the ID mutates under sanitization
+2. Check if `sessionId` already exists in sessions Map
+3. If exists → **reject** with error response including the session's endpoint subject
+4. If new → create PI session, register a dedicated `pi-exec` microservice instance for this session, add to Map
+5. Run the initial prompt, stream response on the intake's reply subject
+6. Session stays alive for follow-ups via the per-session endpoint; the per-session service instance is torn down via `service.stop()` on `stop` mode or lifetime expiry
+
+On reuse rejection:
+```json
+{
+  "error": "session_exists",
+  "sessionId": "my-worker-1",
+  "subject": "agents.pi-exec.mario.my-worker-1",
+  "message": "Session already exists. Send follow-up prompts to the session subject."
+}
+```
+
+Fields only used on creation: `cwd`, `model`, `thinkingLevel`, `maxLifetime`.
+
+### `stop`
+
+Disposes a session, removes its endpoint.
+
+```json
+{
+  "sessionMode": "stop",
+  "sessionId": "my-worker-1"
+}
+```
+
+Flow:
+1. Look up `sessionId` in sessions Map
+2. If not found → error response
+3. If found → `session.dispose()`, remove endpoint, remove inspect subscription, delete from Map
+4. Respond with confirmation (non-streaming, single message)
+
+### `list`
+
+Returns all active sessions.
+
+```json
+{
+  "sessionMode": "list"
+}
+```
+
+Response (non-streaming, single JSON message):
+```json
+{
+  "sessions": [
+    {
+      "sessionId": "my-worker-1",
+      "subject": "agents.pi-exec.mario.my-worker-1",
+      "cwd": "/home/mario/code/nats-zig",
+      "createdAt": "2026-04-08T14:30:00Z",
+      "lastActivity": "2026-04-08T14:35:22Z",
+      "maxLifetime": 3600,
+      "remainingLifetime": 3278,
+      "activeRequest": false,
+      "queuedRequests": 0
+    }
+  ]
+}
+```
+
+## Intake protocol summary
+
+| sessionMode | Session exists? | Behavior |
+|---|---|---|
+| `run` | n/a | ephemeral: create, prompt, stream, dispose |
+| `session` | no | create, register endpoint, prompt, stream |
+| `session` | yes | **reject** with session info |
+| `stop` | yes | dispose, confirm |
+| `stop` | no | error: not found |
+| `list` | n/a | return all sessions |
+
+## Per-session endpoint protocol
+
+Identical to the standard wire protocol used by all sibling implementations:
+
+- **Inbound**: plain text or JSON envelope `{"from":"sender","body":"text"}`
+- **Outbound**: streaming text chunks on reply subject
+- **Completion**: empty payload on reply subject
+- **Usage**: `nats req agents.pi-exec.mario.my-worker-1 "Fix the linting errors" --wait-for-empty --timeout 120s`
+
+Requests to per-session endpoints are queued and processed serially (one prompt at a time per session).
+
+## PI SDK integration
+
+Each session is an independent `AgentSession` created via `createAgentSession()`:
+
+```typescript
+const { session } = await createAgentSession({
+  cwd: request.cwd,
+  sessionManager: SessionManager.inMemory(),   // run mode
+  // or: SessionManager.open(sessionFile),      // session mode
+  authStorage,
+  modelRegistry,
+  model: resolvedModel,
+  thinkingLevel: request.thinkingLevel ?? "off",
+});
+```
+
+Streaming via `session.subscribe()`:
+
+```typescript
+session.subscribe((event) => {
+  if (event.type === "message_update" &&
+      event.assistantMessageEvent.type === "text_delta") {
+    nc.publish(replySubject, event.assistantMessageEvent.delta);
+  }
+  if (event.type === "agent_end") {
+    nc.publish(replySubject, "");  // done
+  }
+});
+
+await session.prompt(body);
+```
+
+Multiple sessions in one process is supported — OpenClaw does this in production.
+
+## Session lifecycle & safety
+
+### Max lifetime
+
+Optional `maxLifetime` field in seconds (default: 1800 = 30 minutes). Background interval checks the sessions Map and disposes expired sessions, removes their endpoints. Prevents orphaned sessions if a caller forgets to `stop`.
+
+### Stale request pruning
+
+Same pattern as claude-channel and pi-channel: 60-second interval, prune pending requests older than 30 minutes.
+
+### Graceful shutdown
+
+On process SIGTERM/SIGINT:
+1. Stop accepting new intake requests
+2. For each managed session: `session.dispose()`
+3. For each service endpoint: remove
+4. `service.stop()` → `nc.drain()`
+
+## Internal data structures
+
+```typescript
+type ManagedSession = {
+  session: AgentSession;
+  sessionId: string;
+  cwd: string;
+  createdAt: number;
+  lastActivity: number;
+  maxLifetime: number;          // seconds, 0 = no expiry
+  endpoint: ServiceEndpoint;
+  inspectSub: Subscription;
+  requestQueue: string[];       // queued request IDs
+  activeRequestId: string | null;
+  pendingRequests: Map<string, PendingRequest>;
+};
+
+type PendingRequest = {
+  replySubject: string;
+  from: string;
+  createdAt: number;
+};
+
+const sessions = new Map<string, ManagedSession>();
+```
+
+## Discovery
+
+```bash
+# List all services
+nats micro list
+→ pi-exec (1 instance, N endpoints)
+
+# Detailed info — shows intake + all session endpoints
+nats micro info pi-exec
+→ intake:  agents.pi-exec.mario
+→ session: agents.pi-exec.mario.my-worker-1   │ /home/mario/code/nats-zig
+→ session: agents.pi-exec.mario.sid-gpt-abc   │ /home/mario/code/sid-gpt
+
+# Inspect a specific session
+nats req agents.pi-exec.mario.my-worker-1.inspect "" --timeout 5s
+→ {"name":"my-worker-1","description":"PI agent in /home/mario/code/nats-zig",...}
+```
+
+## Configuration
+
+Config file: `~/.pi-exec/config.json` (separate from pi-channel config)
+
+```json
+{
+  "context": "my-nats-context",
+  "defaultModel": "anthropic/claude-sonnet-4-5",
+  "defaultThinkingLevel": "off",
+  "defaultMaxLifetime": 1800
+}
+```
+
+Environment variable overrides:
+- `NATS_CONTEXT` — NATS CLI context name
+- `PI_EXEC_DEFAULT_MODEL` — default model
+- `PI_EXEC_DEFAULT_MAX_LIFETIME` — default max lifetime in seconds
+
+NATS context loading: same pattern as all sibling implementations — reads from `~/.config/nats/context/<n>.json`.
+
+## What is NOT in v1
+
+- No org namespace support (add later if needed)
+- No encryption / E2E
+- No A2A protocol
+- No session persistence to disk (sessions are in-memory, lost on bridge restart)
+- No authentication on the intake (NATS auth handles access control)
+- No model hot-swap on existing sessions
+- No resource limits (max concurrent sessions, memory caps)
+
+## Future considerations
+
+- **Session persistence**: Use `SessionManager.open(path)` instead of `.inMemory()` so sessions survive bridge restarts
+- **Org support**: Add `org` field to intake, extend subject to `agents.pi-exec.<org>.<owner>.<sessionId>`
+- **Resource limits**: Max sessions per bridge, max concurrent prompts across all sessions
+- **Pub/sub notifications**: Publish session lifecycle events (created, stopped, expired) to a notification subject for monitoring
+- **Multi-bridge coordination**: Multiple bridge instances sharing session state via NATS KV — JetStream as the session registry

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 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 Support. 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 support.
+
+   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 m64
+
+   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.