@canonmsg/backend-contracts 1.7.1 → 1.8.0

package/dist/schemas/sse-runtime-updated-payload.schema.json

@@ -0,0 +1,78 @@
+{
+  "$id": "canon:SseRuntimeUpdatedPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "agentId": {
+      "type": "string"
+    },
+    "runtime": {
+      "anyOf": [
+        {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {}
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "runtimeInfo": {
+      "anyOf": [
+        {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {}
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "sessionState": {
+      "anyOf": [
+        {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {}
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "sessionConfig": {
+      "anyOf": [
+        {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {}
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "conversationId",
+    "agentId",
+    "runtime",
+    "runtimeInfo",
+    "sessionState",
+    "sessionConfig"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-self-context.schema.json

@@ -0,0 +1,45 @@
+{
+  "$id": "canon:SseSelfContextSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "const": "cross_session"
+    },
+    "context": {
+      "type": "string"
+    },
+    "createdAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "updatedAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "type",
+    "context",
+    "createdAt",
+    "updatedAt"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-turn-dispatch.schema.json

@@ -0,0 +1,29 @@
+{
+  "$id": "canon:SseTurnDispatchSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "kind": {
+      "type": "string",
+      "enum": [
+        "run_turn",
+        "observe_only"
+      ]
+    },
+    "reason": {
+      "type": "string"
+    },
+    "addressed": {
+      "type": "boolean"
+    },
+    "policyVersion": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "kind",
+    "reason",
+    "addressed"
+  ],
+  "additionalProperties": {}
+}

package/dist/schemas/sse-turn-updated-payload.schema.json

@@ -0,0 +1,33 @@
+{
+  "$id": "canon:SseTurnUpdatedPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "agentId": {
+      "type": "string"
+    },
+    "turn": {
+      "anyOf": [
+        {
+          "type": "object",
+          "propertyNames": {
+            "type": "string"
+          },
+          "additionalProperties": {}
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "conversationId",
+    "agentId",
+    "turn"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-typing-payload.schema.json

@@ -0,0 +1,32 @@
+{
+  "$id": "canon:SseTypingPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "userId": {
+      "type": "string"
+    },
+    "isTyping": {
+      "type": "boolean"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "thinking",
+        "typing"
+      ]
+    },
+    "timestamp": {
+      "type": "number"
+    }
+  },
+  "required": [
+    "conversationId",
+    "userId",
+    "isTyping"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-voice-session-event-payload.schema.json

@@ -0,0 +1,170 @@
+{
+  "$id": "canon:SseVoiceSessionEventPayloadSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "conversationId": {
+      "type": "string"
+    },
+    "session": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "conversationId": {
+          "type": "string"
+        },
+        "roomName": {
+          "type": "string"
+        },
+        "mode": {
+          "type": "string",
+          "enum": [
+            "human",
+            "runtime_voice"
+          ]
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "active",
+            "ended",
+            "error"
+          ]
+        },
+        "createdBy": {
+          "type": "string"
+        },
+        "participantIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "participants": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "userId": {
+                "type": "string"
+              },
+              "userType": {
+                "type": "string",
+                "enum": [
+                  "human",
+                  "ai_agent",
+                  "system"
+                ]
+              },
+              "displayName": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "joinedAt": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "leftAt": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              }
+            },
+            "required": [
+              "userId",
+              "userType",
+              "displayName",
+              "joinedAt",
+              "leftAt"
+            ],
+            "additionalProperties": {}
+          }
+        },
+        "targetAgentId": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "createdAt": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "updatedAt": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "endedAt": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "error": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "id",
+        "conversationId",
+        "roomName",
+        "mode",
+        "status",
+        "createdBy",
+        "participantIds"
+      ],
+      "additionalProperties": {}
+    }
+  },
+  "required": [
+    "conversationId",
+    "session"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/sse-voice-session.schema.json

@@ -0,0 +1,157 @@
+{
+  "$id": "canon:SseVoiceSessionSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "conversationId": {
+      "type": "string"
+    },
+    "roomName": {
+      "type": "string"
+    },
+    "mode": {
+      "type": "string",
+      "enum": [
+        "human",
+        "runtime_voice"
+      ]
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "active",
+        "ended",
+        "error"
+      ]
+    },
+    "createdBy": {
+      "type": "string"
+    },
+    "participantIds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "participants": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "userId": {
+            "type": "string"
+          },
+          "userType": {
+            "type": "string",
+            "enum": [
+              "human",
+              "ai_agent",
+              "system"
+            ]
+          },
+          "displayName": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "joinedAt": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "leftAt": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "userId",
+          "userType",
+          "displayName",
+          "joinedAt",
+          "leftAt"
+        ],
+        "additionalProperties": {}
+      }
+    },
+    "targetAgentId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "createdAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "updatedAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "endedAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "error": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "conversationId",
+    "roomName",
+    "mode",
+    "status",
+    "createdBy",
+    "participantIds"
+  ],
+  "additionalProperties": {}
+}

package/dist/schemas/trigger-decision.schema.json

@@ -0,0 +1,27 @@
+{
+  "$id": "canon:TriggerDecisionSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "allow": {
+      "type": "boolean"
+    },
+    "semantics": {
+      "type": "string",
+      "enum": [
+        "progress",
+        "turn_complete",
+        "control"
+      ]
+    },
+    "reason": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "allow",
+    "semantics",
+    "reason"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/turn-lifecycle-state.schema.json

@@ -0,0 +1,14 @@
+{
+  "$id": "canon:TurnLifecycleStateSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "idle",
+    "thinking",
+    "streaming",
+    "tool",
+    "waiting_input",
+    "completed",
+    "interrupted"
+  ]
+}

package/dist/schemas/turn-message-semantics.schema.json

@@ -0,0 +1,10 @@
+{
+  "$id": "canon:TurnMessageSemanticsSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "progress",
+    "turn_complete",
+    "control"
+  ]
+}

package/dist/schemas/turn-metadata.schema.json

@@ -0,0 +1,56 @@
+{
+  "$id": "canon:TurnMetadataSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "turnId": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "turnSemantics": {
+      "type": "string",
+      "enum": [
+        "progress",
+        "turn_complete",
+        "control"
+      ]
+    },
+    "deliveryIntent": {
+      "type": "string",
+      "enum": [
+        "queue",
+        "interrupt",
+        "interleave",
+        "stop"
+      ]
+    },
+    "replyBehavior": {
+      "type": "string",
+      "enum": [
+        "allow_auto_reply",
+        "suppress_auto_reply"
+      ]
+    },
+    "inboundDisposition": {
+      "type": "string",
+      "enum": [
+        "queued",
+        "accepted_now",
+        "interleaved",
+        "trigger_suppressed",
+        "rejected",
+        "cancelled"
+      ]
+    },
+    "requestedTurnMode": {
+      "type": "string"
+    }
+  },
+  "additionalProperties": false
+}

package/dist/schemas/turn-state-like.schema.json

@@ -0,0 +1,39 @@
+{
+  "$id": "canon:TurnStateLikeSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "state": {
+      "type": "string",
+      "enum": [
+        "idle",
+        "thinking",
+        "streaming",
+        "tool",
+        "waiting_input",
+        "completed",
+        "interrupted"
+      ]
+    },
+    "openedAt": {
+      "type": "number"
+    },
+    "updatedAt": {
+      "type": "number"
+    },
+    "turnUpdatedAt": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "state"
+  ],
+  "additionalProperties": false
+}