@synadia-ai/agent-fabric 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to `@synadia-ai/agent-fabric` are recorded here. The format
+follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the
+package follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] — unreleased
+
+### Added
+
+- Tracing: `fabricTracing()`, the protocol SDK's three hooks, and `traceHeaders()` for model calls.
+- Durable runs joined to the task that started them: `durableRunId`, `durableTrace`, `durableHeaders` and `withDurableTrace`.
+- The `served` record for a harness plugin's add-on: `buildServedRecord`, `servedPublisher` and `validHarnessThreadId`.
+- The ScratchPad extension for the agent tools, `scratchPadExtension`, with the grant request's two sides, `requestGrant` and `grantRequestEndpoint`.
+- The native ScratchPad client: `nativeScratchPad`, `nativeScratchPadFromEnv` and `scratchPadReader`.
+- The ScratchPad CLI adapter over `sp`: `spCliScratchPad` and `scratchPadFromEnv`.
+- Short artifact references: `sp-r1:` tokens accepted alongside `sp-ref:`.
+- The harness plugins' shared pieces: the extension contract's types, `loopGuard()`, `resolveEdgeSubject()` and ScratchPad's plugin settings.
+
+[0.1.0]: https://github.com/synadia-ai/agent-fabric-sdk/tree/main/typescript

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
+      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 Synadia Communications
+
+   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

@@ -1,3 +1,185 @@
-# Temporary Holding Version
+# @synadia-ai/agent-fabric
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The SDK for agents on the Synadia Agent Fabric, for TypeScript, built on the
+hooks of the Synadia Agent Protocol SDK (`@synadia-ai/agents`,
+`@synadia-ai/agent-service`). The
+[repository](https://github.com/synadia-ai/agent-fabric-sdk#readme) has the
+Python twin, the reference agents and the design notes.
+
+## Install
+
+```sh
+npm install @synadia-ai/agent-fabric
+```
+
+The package needs the protocol SDK's two packages, `@synadia-ai/agents` (the
+client) and `@synadia-ai/agent-service` (the host). They are its dependencies
+and install with it; your agent imports `Agents` and `AgentService` from them.
+Node 20 or later; the native ScratchPad writer needs Node 22.13+.
+
+## What it gives
+
+- **Tracing:** `fabricTracing()` and `traceHeaders()`.
+- **Durable runs** joined to the task that started them:
+  `durableRunId(toolCallId)`, `durableTrace()`, `durableHeaders(trace)` and
+  `withDurableTrace(trace, turnCount, fn)`,
+  with no dependency on a durable-execution library
+  ([`docs/durable.md`](https://github.com/synadia-ai/agent-fabric-sdk/blob/main/docs/durable.md)).
+- **The `served` record**, for a harness plugin's add-on: the plugin's
+  binding of a served thread to the harness's own thread id, two records
+  per prompt (`served.json`). `buildServedRecord(…)` writes one, from the
+  agent, the thread and root, the harness, its thread id, the phase and, on
+  `end`, the status; `servedPublisher({ agents, subject? })` publishes a
+  prompt's pair through the plugin's own client, signed with the record id
+  as nonce, in the order the records were due, counted with the edges:
+  `beginTurn(scope, harness)` when the prompt arrives, then
+  `bind(harnessThreadId)` for `start` and `settle(status, atMs?)` for
+  `end`; `flush()` before stopping. `validHarnessThreadId` is the rule an
+  id must pass. PI writes none: the fabric's headers go on its own calls.
+- **The ScratchPad extension** for the agent tools:
+  `scratchPadExtension({ scratchPad, agents })` in `AgentTools`'
+  `extensions`, with the grant request's two sides, `requestGrant` and
+  `grantRequestEndpoint` (an `AgentService` extra endpoint). The agent
+  brings its ScratchPad client behind the `ScratchPad` port, or takes the
+  ready one below.
+
+## Tracing
+
+`fabricTracing()` returns the three hooks the protocol SDK takes: the prompt
+interceptor for the client, the request interceptor and the heartbeat extras
+for the host. Every served prompt then runs inside a trace scope, every prompt
+the agent sends to another agent becomes a child thread with a signed `edge`
+record on `TRACE.edges`, and `traceHeaders()` gives the two headers the model
+proxy files a model call by.
+
+```ts
+import { Agents } from "@synadia-ai/agents";
+import { AgentService } from "@synadia-ai/agent-service";
+import { fabricTracing, traceHeaders } from "@synadia-ai/agent-fabric";
+
+const tracing = fabricTracing(); // edges to TRACE.edges; { edgeSubject: null } only propagates
+const agents = new Agents({ nc, identity: { signer }, interceptors: [tracing.promptInterceptor] });
+const svc = new AgentService({
+  nc,
+  agent: "triage",
+  owner: "acme",
+  name: "main",
+  interceptors: [tracing.requestInterceptor],
+  heartbeatExtras: tracing.heartbeatExtras,
+});
+svc.onPrompt(async (envelope, response) => {
+  const answer = await callModel(envelope.prompt, { headers: traceHeaders() });
+  const [lookup] = await agents.discover({ filter: { agent: "lookup" } }); // a child thread:
+  for await (const m of await lookup!.prompt(answer, { context: { toolCallId: "toolu_01" } }))
+    if (m.type === "response") await response.send(m.text);
+});
+```
+
+Records are signed, so the agent needs a signed identity; the tool-call ID in
+the prompt's `context` hangs the child thread under the model's tool call.
+
+## Durable runs
+
+A workflow started from a prompt, usually by a tool call of the agent's
+model, belongs to that prompt's task. The helpers make the join one line; none
+of them depends on a durable-execution SDK.
+
+```ts
+import {
+  durableHeaders,
+  durableRunId,
+  durableTrace,
+  withDurableTrace,
+} from "@synadia-ai/agent-fabric";
+
+// In the prompt's handler: the run id names the served thread and the tool call.
+const runId = durableRunId(toolCallId); // "<thread_id>-<tool call id>", undefined outside a traced handler
+const handle = await client.start(workflow, { task, trace: durableTrace() }, { runId });
+
+// Inside a step, on the worker: the trace comes back from the run's input.
+const reply = await model.complete(messages, [], durableHeaders(input.trace));
+const result = await withDurableTrace(input.trace, turnsSoFar, () =>
+  tools.execute(name, args, { toolCallId }),
+);
+```
+
+- `durableRunId(toolCallId)`: `<thread_id>-<tool call id>`, the tool-call id
+  held to `[A-Za-z0-9_-]`; use it as the start's idempotency key too.
+- `durableTrace()`: `{ thread_id, root_id }` of the active trace, for the
+  run's input.
+- `durableHeaders(trace)`: the proxy's two headers from that trace, for a
+  model call inside a step; `{}` for a missing or malformed trace.
+- `withDurableTrace(trace, turnCount, fn)`: binds the trace around code inside
+  a step, so a prompt it sends to another agent is filed under the task.
+
+See [`docs/durable.md`](https://github.com/synadia-ai/agent-fabric-sdk/blob/main/docs/durable.md)
+for the run id's rules, durable agents, and what is exactly-once.
+
+## ScratchPad without writing ScratchPad code
+
+Use the native client for SDK agents without a shell or installed binary:
+
+```ts
+import { nativeScratchPadFromEnv, scratchPadExtension } from "@synadia-ai/agent-fabric";
+
+const scratchPad = await nativeScratchPadFromEnv(process.env, { nc, creator: address });
+const references = scratchPad && scratchPadExtension({ scratchPad, agents });
+```
+
+The writer needs Node 22.13+, a configured `SCRATCHPAD_VOLUME`, and a private,
+persistent `SCRATCHPAD_DIR`. It borrows the agent's authenticated connection.
+Use `nativeScratchPad` for explicit options and `scratchPadReader` for a consumer
+that needs no writer workspace. Native clients need no private ScratchPad source.
+See [the native contract](https://github.com/synadia-ai/agent-fabric-sdk/blob/main/docs/scratchpad-native.md)
+for binary artifacts, streamed transfers, error handling, recovery, and qualification scope.
+
+### CLI adapter
+
+An agent gets ScratchPad by configuration. Two lines: build it from the
+environment, then hand the object to the extension (and the grant request's
+endpoint) and commit and read with it yourself.
+
+```ts
+import { scratchPadFromEnv, scratchPadExtension } from "@synadia-ai/agent-fabric";
+
+const scratchPad = scratchPadFromEnv(process.env, { creator: address }); // undefined: ScratchPad off
+const references = scratchPad && scratchPadExtension({ scratchPad, agents });
+// in the handler: const ref = await scratchPad.commit(answer, `/replies/${threadId}.md`, trace);
+//                 const text = await scratchPad.read(ref, trace);
+```
+
+| Variable                 | Default                                        |                                                                                                                                          |
+| ------------------------ | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| `SCRATCHPAD_VOLUME`      | unset: ScratchPad off                          | the volume the agent commits to, by name: letters and digits only, provisioned for the agent's account and user; created on first commit |
+| `SCRATCHPAD_BIN`         | `sp` on PATH                                   | the `sp` binary                                                                                                                          |
+| `SCRATCHPAD_DIR`         | `scratchpad-<volume>` under the temp directory | a private directory for the CLI's workspace, used by its real path; keep it across restarts                                              |
+| `SCRATCHPAD_GRANT_TTL_S` | `600`                                          | how long a read grant lasts, in seconds; at most ten minutes, and never past the reference                                               |
+
+`sp` connects as the agent does, with `NATS_CREDS` and `NATS_URL` (or pass
+`{ nats }`, the SDK's `NatsConnectionSource`); it reads no NATS context, so a
+`NATS_CONTEXT` without `NATS_CREDS` is refused. The same
+from code: `spCliScratchPad({ volume, nats, bin?, dir?, grantTtlS?, creator? })`,
+both returning a `ScratchPadClient` — the `ScratchPad` port plus
+`commit(text, path, trace)` and `read(reference, trace)`.
+
+The CLI adapter drives the sp v2 command line, `sp`, which must be on the
+machine (the [binary guide](https://github.com/synadia-ai/agent-fabric-sdk/blob/main/docs/scratchpad-binaries.md)
+installs a pinned release) and connects with the agent's own credentials. Each
+commit publishes the reply
+retained for ten minutes, and its reference is valid as long; a grant goes
+only to an agent in the reference's own account, as `sp` refuses any other; ScratchPad must be reachable in the tenant's
+account. Both native and CLI clients implement the existing `ScratchPadClient`
+interface; the Fabric reference policy uses that interface.
+
+## Short artifact references
+
+The client accepts `sp-r1:` short tokens and existing `sp-ref:` tokens.
+Publication uses the short form when the service and the selected client support it.
+Copy the returned token unchanged into prompts and replies.
+The token survives client restarts; each content read still requires current authorization.
+See the [native client contract](https://github.com/synadia-ai/agent-fabric-sdk/blob/main/docs/scratchpad-native.md) for recovery and capability fallback.
+
+## License
+
+Apache-2.0. See [LICENSE](https://github.com/synadia-ai/agent-fabric-sdk/blob/main/typescript/LICENSE)
+and [THIRD_PARTY_NOTICES](https://github.com/synadia-ai/agent-fabric-sdk/blob/main/typescript/THIRD_PARTY_NOTICES).

package/THIRD_PARTY_NOTICES

@@ -0,0 +1,23 @@
+The compiled package includes the Unassigned-category regular expression from
+@unicode/unicode-15.0.0 version 2.0.7 (MIT).
+Source: https://github.com/node-unicode/unicode-15.0.0
+License: https://github.com/node-unicode/node-unicode-data/blob/main/LICENSE-MIT.txt
+
+Copyright Mathias Bynens <https://mathiasbynens.be/>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.