@trigguard/protocol 0.1.2 → 0.1.3

package/README.md

@@ -1,26 +1,45 @@
-# TrigGuard Protocol
+# `@trigguard/protocol` (TypeScript SDK)
 
 [![npm version](https://img.shields.io/npm/v/@trigguard/protocol)](https://www.npmjs.com/package/@trigguard/protocol)
 
-Canonical protocol definitions for TrigGuard governance decisions: vocabulary (`PERMIT`, `DENY`, `SILENCE`), enforcement semantics, and the `DecisionRecord` shape used across products and tooling.
+**Reference implementation** for the TrigGuard protocol in TypeScript: vocabulary (`PERMIT`, `DENY`, `SILENCE`), enforcement semantics, and the `DecisionRecord` shape, plus JSON snapshots aligned with [`core/contracts/decision_contract.json`](../../core/contracts/decision_contract.json).
 
-**Package name:** `@trigguard/protocol` — types and contract snapshots; runtime evaluation and policy engines live in other packages and services. Integrations **conform** to this contract.
+**Language-agnostic specification:** [`spec/TG_PROTOCOL.md`](../../spec/TG_PROTOCOL.md) — this npm package is an SDK, not the full protocol.
 
-## Install
+**Runtime evaluation and policy engines** live in other packages and services; integrations **conform** to the spec.
+
+## Quick start
 
 ```bash
 npm install @trigguard/protocol
 ```
 
+```typescript
+import { DECISION, ENFORCEMENT, type DecisionRecord } from "@trigguard/protocol";
+
+const record: DecisionRecord = {
+  decision: DECISION.PERMIT,
+  enforcement: ENFORCEMENT.EXECUTED,
+  reason_code: "NO_POLICY_VIOLATION",
+  timestamp: new Date().toISOString(),
+};
+```
+
+There is **no** `evaluate()` or `validateDecision()` in this package — only **types and canonical constants** so your code matches [`spec/TG_PROTOCOL.md`](../../spec/TG_PROTOCOL.md). For JSON Schema and contract JSON via subpaths, see [Subpath exports](#subpath-exports-json).
+
+## Install and paths
+
 Published on the public registry under the `@trigguard` scope. For release process, see `docs/release/PROTOCOL_RELEASE.md` in the monorepo.
 
 **Develop inside the repo** (no registry), use a path or workspace:
 
 ```json
-"@trigguard/protocol": "file:../packages/protocol"
+"@trigguard/protocol": "file:implementations/typescript"
 ```
 
-or install from a Git URL / workspace as documented in the main [TrigGuard repository](https://github.com/TrigGuard-AI/TrigGuard).
+(From a package at the repository root. From `packages/*`, use `file:../../implementations/typescript`.)
+
+Or install from a Git URL / workspace as documented in the main [TrigGuard repository](https://github.com/TrigGuard-AI/TrigGuard).
 
 ## Decision model
 
@@ -32,27 +51,7 @@ or install from a Git URL / workspace as documented in the main [TrigGuard repos
 
 Policy-only layers may restrict emitted decisions to **PERMIT** / **DENY**; full protocol surfaces also use **SILENCE** where applicable.
 
-## Example import (TypeScript)
-
-```typescript
-import {
-  type Decision,
-  type DecisionRecord,
-  DECISION,
-  DECISIONS,
-  SILENCE_DEFINITION,
-} from "@trigguard/protocol";
-
-const d: Decision = "PERMIT";
-const record: DecisionRecord = {
-  decision: DECISION.PERMIT,
-  enforcement: "EXECUTED",
-  reason_code: "NO_POLICY_VIOLATION",
-  timestamp: new Date().toISOString(),
-};
-```
-
-There is **no** `evaluate()` in this package — evaluation lives in TrigGuard services and kernels. This package supplies **types and canonical constants** so callers and SDKs share one contract.
+Other useful exports: `type Decision`, `DECISIONS`, `SILENCE_DEFINITION`, `REASON_CODES`, `decisionContract`.
 
 ## Subpath exports (JSON)
 
@@ -65,7 +64,7 @@ const contract = require("@trigguard/protocol/contract");
 
 ## Build (maintainers / CI)
 
-From `packages/protocol`:
+From `implementations/typescript`:
 
 ```bash
 npm install
@@ -76,7 +75,7 @@ npm run build
 
 ## Repository
 
-Canonical source: [github.com/TrigGuard-AI/TrigGuard](https://github.com/TrigGuard-AI/TrigGuard) — `packages/protocol/`.
+Canonical source: [github.com/TrigGuard-AI/TrigGuard](https://github.com/TrigGuard-AI/TrigGuard) — `implementations/typescript/` (spec: [`spec/`](../spec/)).
 
 For installation paths and release tagging, see:
 

package/dist/schema.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "TrigGuardCanonicalDecisionRecord",
-  "description": "Authoritative shape for protocol decision records. reason_code values align with core/contracts/decision_contract.json reasonCode registry.",
+  "description": "Authoritative shape for protocol decision records. reason_code values align with core/contracts/decision_contract.json reasonCode registry. Keep spec/decision_contract.schema.json and implementations/typescript/src/schema.json byte-identical (CI: scripts/check_protocol_sync.sh).",
   "type": "object",
   "required": ["decision", "enforcement", "reason_code", "timestamp"],
   "properties": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@trigguard/protocol",
-  "version": "0.1.2",
-  "description": "Shared TypeScript types and JSON contract snapshots for TrigGuard authorization decisions and records.",
+  "version": "0.1.3",
+  "description": "TypeScript SDK: types and JSON snapshots for the TrigGuard protocol (see repository spec/).",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {