@brightbeamai/chap-coordinator 0.2.8

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 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 The CHAP Authors
+
+   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,271 @@
+# @brightbeamai/chap-coordinator (TypeScript)
+
+TypeScript reference implementation of the Collaborative Human-Agent Protocol (CHAP).
+
+Covers Core plus every profile, 39 method handlers in total. Spec-aligned
+field names, error codes, and response shapes against `profiles/*.md`.
+The Python reference at `packages/coordinator-py/` implements the same
+surface, so the two interoperate on the same JSON-RPC 2.0 wire.
+
+## Install
+
+This package is currently distributed alongside the spec repo rather
+than published to npm. To use it directly from source in another
+TypeScript project:
+
+```bash
+# From the chap repo root
+cd packages/coordinator
+npm pack
+# In your project
+npm install ./brightbeamai-chap-coordinator-*.tgz   # the .tgz that npm pack just produced
+```
+
+Node 18+ required. Zero external runtime dependencies; uses Node's
+built-in `crypto` for Ed25519 and JCS.
+
+## Companion packages
+
+The `@brightbeamai/chap-coordinator` package is the protocol core. Two transport
+adapters ship alongside it for embedding a Coordinator in MCP and
+A2A ecosystems:
+
+- [`@brightbeamai/chap-coordinator-mcp`](https://github.com/BrightbeamAI/chap/tree/main/packages/coordinator-mcp) wraps a Coordinator
+  as an MCP server. Every CHAP method becomes an MCP tool named
+  `chap.<method>`. Reference stdio server at
+  `reference/mcp-server-ts/`. Spec target: MCP 2025-11-25.
+- [`@brightbeamai/chap-coordinator-a2a`](https://github.com/BrightbeamAI/chap/tree/main/packages/coordinator-a2a) wraps a Coordinator
+  as an A2A agent. Every CHAP method becomes an `AgentSkill` on the
+  Agent Card. Reference Express server at `reference/a2a-server-ts/`.
+  Spec target: A2A 0.3.0.
+
+Inward citation helpers (`wrapMcpToolCall`, `wrapA2aMessageExchange`,
+`contentHash`) are exported from `@brightbeamai/chap-coordinator` directly. They
+take a completed external event and emit the matching CHAP audit
+entries with input/output hashes.
+
+## Quick start
+
+```typescript
+import { Coordinator } from "@brightbeamai/chap-coordinator";
+
+const coord = new Coordinator({
+  defaultProfiles: ["core/1.0", "review/1.0", "whisper/1.0"],
+});
+
+coord.dispatch({
+  jsonrpc: "2.0", id: "1",
+  method: "workspace.create",
+  params: { workspace: "wsp_demo" },
+});
+
+coord.dispatch({
+  jsonrpc: "2.0", id: "2",
+  method: "participant.join",
+  params: { workspace: "wsp_demo",
+            from: "human:me@local", type: "human", role: "reviewer" },
+});
+
+coord.dispatch({
+  jsonrpc: "2.0", id: "3",
+  method: "participant.join",
+  params: { workspace: "wsp_demo",
+            from: "agent:bot", type: "agent", role: "drafter" },
+});
+
+const resp = coord.dispatch({
+  jsonrpc: "2.0", id: "4",
+  method: "task.create",
+  params: {
+    workspace: "wsp_demo",
+    from: "human:me@local",
+    kind: "draft_response",
+    input: { ticket_id: "INC-1" },
+    assignee: "agent:bot",
+  },
+});
+
+console.log(resp.result);  // { task_id: "tsk_...", state: "created" }
+```
+
+## What is implemented
+
+| Profile               | Methods (per profile spec)                                                                |
+|-----------------------|-------------------------------------------------------------------------------------------|
+| `core/1.0`            | `workspace.create`, `workspace.describe`, `workspace.set_profiles`, `participant.join`, `participant.leave`, `task.create`, `task.update`, `task.complete`, `audit.read` |
+| `review/1.0`          | `review.request`, `decide.approve`, `decide.reject`, `decide.override`, `abstain.declare`, `escalate.raise` |
+| `whisper/1.0`         | `whisper.ask`, `whisper.answer`; lapse hook via `coord.checkWhisperLapses(workspaceId, now?)` |
+| `deliberation/1.0`    | `deliberate.open`, `deliberate.comment`, `deliberate.vote`, `deliberate.close` |
+| `handoff/1.0`         | `handoff.propose`, `handoff.accept`, `handoff.decline`; multi-task; recipient may be a URI or `group:` |
+| `control/1.0`         | `control.pause`, `control.resume`, `control.cancel`, `control.snapshot`, `control.rollback`, `control.supersede`, `control.set_mode_ceiling`; pause/resume take `scope: task/participant/workspace` |
+| `routing/1.0`         | `task.route`, `review.depth`, `escalate.auto`; each emits a `route_decision` artefact |
+| `modes/1.0`           | Mode handling at `task.create`; `trial` mode forces `review_required`; `control.set_mode_ceiling` shared with control/1.0 |
+| `security-signed/1.0` | `participant.rotate_key`, `participant.revoke_key`; top-level `sig` verified at dispatch when `requireSignatures` is true |
+| `audit-scitt/1.0`     | `audit.submit_to_scitt`, `audit.verify_receipt`, `audit.verify_chain`; SCITT statements assembled and passed to a deployment-supplied submitter; local prev-hash chain linkage retained |
+| `identity-oidc/1.0`   | `participant.join` binding via `verifyOidcToken`; `cnf.jwk` pinning, step-up auth via `enforceStepUp` |
+| `identity-vc/1.0`     | `participant.join` binding via `verifyVc`; holder-key pinning |
+
+**39 method handlers in total**, matching the Python reference exactly.
+
+## Architecture
+
+The coordinator is transport-agnostic, persistence-agnostic, and
+UI-agnostic. The entry point:
+
+```typescript
+const response = coord.dispatch(envelope);
+```
+
+`envelope` is a JSON-RPC 2.0 request; `response` is the JSON-RPC 2.0
+response. State is held in memory; persist by subscribing with
+`coord.onAudit(listener)`.
+
+Reference HTTP bindings:
+- `reference/core/` and `reference/core-plus-review/` (standalone TS
+  servers used by the conformance harness and the demo playground)
+- `reference/python/` (HTTP server using the Python reference)
+
+## Determinism for tests
+
+```typescript
+const coord = new Coordinator({
+  deterministicIds: true,
+  deterministicClock: true,
+});
+```
+
+ULIDs derive from a deterministic counter; the clock advances by a
+fixed step per emission. Useful for golden-file tests.
+
+## Identity binding
+
+```typescript
+const coord = new Coordinator({
+  verifyOidcToken: (token) => {
+    // Validate against your IdP; return claims dict or null.
+    // Include "cnf": { "jwk": {...} } to bind a signing key.
+    return { sub: "...", auth_time: 1234, cnf: { jwk: {...} } };
+  },
+  verifyVc: (vp) => {
+    // Verify the VP; return subject claims or null.
+    // Include "cnf_jwk": {...} to bind a holder key.
+    return { holder: "did:example:alice", cnf_jwk: {...} };
+  },
+  enforceStepUp: true,  // require fresh auth_time for privileged methods
+});
+```
+
+If a `participant.join` envelope includes `oidc_token` or
+`vc_presentation`, the relevant hook is called and the bound key is
+added to the participant's key history.
+
+## Signed envelopes (security-signed/1.0)
+
+```typescript
+const coord = new Coordinator({ requireSignatures: true });
+```
+
+Each participant registers one or more JWKs at `participant.join` via
+`jwks: { keys: [...] }`. Senders sign the JCS canonicalisation of the
+envelope **with the top-level `sig` field removed**, then attach the
+signature as a top-level `sig: "ed25519:<kid>:<base64>"` field. The
+Coordinator looks up the verifying key by `(from, kid, ts)`, so
+historical envelopes verify across key rotation.
+
+Key lifecycle:
+- `participant.rotate_key` is signed with the old key; the Coordinator
+  marks `valid_until` on the old key and `valid_from` on the new one.
+- `participant.revoke_key` is an admin operation; envelopes signed
+  with the revoked key after revocation are rejected.
+
+Helpers exported from `@brightbeamai/chap-coordinator/crypto`:
+
+```typescript
+import {
+  deriveKeypair,         // demo: deterministic keypair from a URI
+  signEnvelope,          // sign canonical bytes -> ed25519:<kid>:<b64>
+  verifyEnvelope,        // verify a sig tag against canonical + pubkey
+  publicKeyFromJwk,      // JWK -> Node KeyObject
+} from "@brightbeamai/chap-coordinator";
+```
+
+## Routing policies (routing/1.0)
+
+A default policy ships out of the box. Override it with operator hooks:
+
+```typescript
+const coord = new Coordinator({
+  routingPolicy: (task, candidates) => ({
+    selected: candidates[0],
+    rationale: {
+      policy_id: "round-robin",
+      summary: "first eligible",
+    },
+  }),
+  reviewDepthPolicy: (task, hints) => ({
+    depth: "spot_check",
+    sampling_probability: 0.05,
+    rationale: { policy_id: "v1", summary: "5% sample" },
+  }),
+  escalationPolicy: (task, hints) => ({
+    escalate: hints.criticality === "critical",
+    to: "group:senior-pool",
+    triggered_rule: { rule_id: "esc-crit", summary: "criticality=critical" },
+  }),
+});
+```
+
+Every call to `task.route`, `review.depth`, and `escalate.auto`
+emits a `route_decision` artefact. `task.route` also updates the
+task's `assignee`.
+
+## Audit and SCITT (audit-scitt/1.0)
+
+Audit entries are hash-linked when the profile is active.
+`audit.verify_chain` replays the chain locally and confirms
+`prev_hash` continuity.
+
+`audit.submit_to_scitt` builds a SCITT-shaped signed statement for
+each audit entry in the requested range and passes it to a
+deployment-supplied submitter:
+
+```typescript
+const coord = new Coordinator({
+  scittSubmitter: (statement) => {
+    // Submit to your SCITT transparency service; return the receipt
+    return { receipt_id: "...", log_root: "..." };
+  },
+});
+```
+
+Without a submitter configured, `audit.submit_to_scitt` returns the
+statements so the caller can submit out-of-band.
+
+## Testing
+
+```bash
+npm test
+```
+
+72 tests as of this release, covering Core, every profile, JCS and
+Ed25519 conformance vectors, signed-envelope verification, OIDC/VC
+binding, the inward wrap helpers, and an end-to-end composition test
+exercising every method handler in one workspace.
+
+## Spec fidelity
+
+This implementation was reviewed against every profile spec under
+`profiles/` and aligned with the documented field names, error codes,
+and response shapes. The full audit notes are in the parent repo's
+[`CHANGELOG.md`](https://github.com/BrightbeamAI/chap/blob/main/CHANGELOG.md), with the 0.2.2 entry covering
+the original TypeScript expansion and 0.2.3 / 0.2.4 covering the MCP
+and A2A transport additions.
+
+## License
+
+Apache 2.0. See the parent repository's [LICENSE](./LICENSE).
+
+## Specification
+
+Tracks the spec at
+[github.com/BrightbeamAI/chap/SPECIFICATION.md](https://github.com/BrightbeamAI/chap/blob/main/SPECIFICATION.md).