@openwop/openwop-conformance 1.72.2 → 1.98.0

package/schemas/run-event.schema.json

@@ -4,7 +4,14 @@
   "title": "RunEventDoc",
   "description": "Persisted event document in the run's append-only event log. Source of truth for run state via projection fold. Canonical OpenWOP v1 event envelope.",
   "type": "object",
-  "required": ["eventId", "runId", "type", "payload", "timestamp", "sequence"],
+  "required": [
+    "eventId",
+    "runId",
+    "type",
+    "payload",
+    "timestamp",
+    "sequence"
+  ],
   "properties": {
     "eventId": {
       "type": "string",
@@ -25,19 +32,28 @@
       "maxLength": 128
     },
     "type": {
-      "description": "Event-type discriminator. RFC 0094 §C: either a protocol-owned type from the authoritative `RunEventType` catalog, or a correctly-prefixed vendor-extension event per `host-extensions.md` §\"Vendor-prefixed namespaces\" (dotted name whose first segment is the vendor's short identifier or reverse-DNS label — e.g. `acme.canvas.published` — and is NOT a protocol-owned/registry-reserved prefix). Aligns the schema with `COMPATIBILITY.md` (\"Clients MUST ignore unknown event types\") and `version-negotiation.md` (readers ignore unknown).",
+      "description": "Event-type discriminator. RFC 0094 \u00a7C: either a protocol-owned type from the authoritative `RunEventType` catalog, or a correctly-prefixed vendor-extension event per `host-extensions.md` \u00a7\"Vendor-prefixed namespaces\" (dotted name whose first segment is the vendor's short identifier or reverse-DNS label \u2014 e.g. `acme.canvas.published` \u2014 and is NOT a protocol-owned/registry-reserved prefix). Aligns the schema with `COMPATIBILITY.md` (\"Clients MUST ignore unknown event types\") and `version-negotiation.md` (readers ignore unknown).",
       "anyOf": [
-        { "$ref": "#/$defs/RunEventType" },
+        {
+          "$ref": "#/$defs/RunEventType"
+        },
         {
           "type": "string",
           "pattern": "^(?!(?:openwop|core|community|vendor|private|local)\\.)[a-z][a-zA-Z0-9_-]*(\\.[a-zA-Z0-9_-]+)+$",
-          "description": "Vendor-extension event type: two or more dot-separated segments; the leading segment is the vendor prefix and MUST NOT be one of the protocol-owned / registry-reserved prefixes (`openwop.*`, `core.*`, `community.*`, `vendor.*`, `private.*`, `local.*`) per `host-extensions.md` §\"Canonical prefixes\"."
+          "description": "Vendor-extension event type: two or more dot-separated segments; the leading segment is the vendor prefix and MUST NOT be one of the protocol-owned / registry-reserved prefixes (`openwop.*`, `core.*`, `community.*`, `vendor.*`, `private.*`, `local.*`) per `host-extensions.md` \u00a7\"Canonical prefixes\"."
         }
       ]
     },
     "payload": {
       "description": "Event-type-specific payload. Servers MAY validate against per-type schemas; this top-level schema accepts any JSON value.",
-      "type": ["object", "array", "string", "number", "boolean", "null"]
+      "type": [
+        "object",
+        "array",
+        "string",
+        "number",
+        "boolean",
+        "null"
+      ]
     },
     "timestamp": {
       "type": "string",
@@ -52,7 +68,7 @@
     "schemaVersion": {
       "type": "integer",
       "minimum": 0,
-      "description": "Per-event schema version. Bumped when an individual event type's payload contract changes. Distinct from per-run eventLogSchemaVersion (which describes the subcollection contract). Reader behavior is tolerant — unknown future versions fold best-effort."
+      "description": "Per-event schema version. Bumped when an individual event type's payload contract changes. Distinct from per-run eventLogSchemaVersion (which describes the subcollection contract). Reader behavior is tolerant \u2014 unknown future versions fold best-effort."
     },
     "engineVersion": {
       "type": "string",
@@ -65,12 +81,12 @@
       "maxLength": 128
     }
   },
-  "$comment": "RFC 0094 §G + COMPATIBILITY.md §\"Schema closure\": RunEventDoc is a SERVER-EMITTED shape, so it is open (`additionalProperties: true`) — v1.x hosts may add optional fields additively without breaking schema-validating clients. Client-submitted shapes stay closed at their outermost composition.",
+  "$comment": "RFC 0094 \u00a7G + COMPATIBILITY.md \u00a7\"Schema closure\": RunEventDoc is a SERVER-EMITTED shape, so it is open (`additionalProperties: true`) \u2014 v1.x hosts may add optional fields additively without breaking schema-validating clients. Client-submitted shapes stay closed at their outermost composition.",
   "additionalProperties": true,
   "$defs": {
     "RunEventType": {
       "type": "string",
-      "description": "Discriminator for event payload shape. Dotted naming convention. New variants extend the union — readers MUST NOT throw on unknown types (forward-compat: fold best-effort, ignore unknowns).",
+      "description": "Discriminator for event payload shape. Dotted naming convention. New variants extend the union \u2014 readers MUST NOT throw on unknown types (forward-compat: fold best-effort, ignore unknowns). RFC 0151 \u00a7D adds the six content-free `compensation.*` events. They are added to this CLOSED enum because without them a conforming host cannot emit them at all: the RFC named the events, the enum did not contain them, and any host following \u00a7D would have produced run events that fail schema validation. Payloads carry opaque node/effect IDs, attempt, ordering model, and closed reason codes \u2014 never provider bodies or credentials (\u00a7D/\u00a7G).",
       "enum": [
         "run.started",
         "run.completed",
@@ -182,7 +198,13 @@
         "voice.turn_commit",
         "voice.synthesis_chunk",
         "voice.barge_in",
-        "voice.cancelled"
+        "voice.cancelled",
+        "compensation.requested",
+        "compensation.started",
+        "compensation.completed",
+        "compensation.failed",
+        "compensation.paused",
+        "compensation.manual_intervention_required"
       ]
     }
   }