@canonmsg/backend-contracts 1.7.0 → 1.8.0

package/dist/schemas/resolved-agent-behavior-policy-record.schema.json

@@ -0,0 +1,81 @@
+{
+  "$id": "canon:ResolvedAgentBehaviorPolicyRecordSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "participation": {
+      "type": "object",
+      "properties": {
+        "style": {
+          "type": "string",
+          "enum": [
+            "natural",
+            "collaborative",
+            "mention-first",
+            "approval-gated",
+            "handoff-only",
+            "observer"
+          ]
+        },
+        "allowAgentToAgent": {
+          "type": "boolean"
+        },
+        "allowHumanToAgent": {
+          "type": "boolean"
+        },
+        "allowLongRunningCollaboration": {
+          "type": "boolean"
+        },
+        "requireMentionForGroupReplies": {
+          "type": "boolean"
+        },
+        "maxConsecutiveAgentTurns": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "required": [
+        "style",
+        "allowAgentToAgent",
+        "allowHumanToAgent",
+        "allowLongRunningCollaboration",
+        "requireMentionForGroupReplies"
+      ],
+      "additionalProperties": false
+    },
+    "instructions": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "source": {
+      "type": "object",
+      "properties": {
+        "hasAgentDefault": {
+          "type": "boolean"
+        },
+        "hasConversationOverride": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "hasAgentDefault",
+        "hasConversationOverride"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "participation",
+    "instructions",
+    "source"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/rest-contact.schema.json

@@ -0,0 +1,40 @@
+{
+  "$id": "canon:RestContactSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "source": {
+      "type": "string"
+    },
+    "addedAt": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "displayNameOverride": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    }
+  },
+  "required": [
+    "id",
+    "source",
+    "addedAt",
+    "displayNameOverride"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/rest-conversation.schema.json

@@ -0,0 +1,115 @@
+{
+  "$id": "canon:RestConversationSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "direct",
+        "group"
+      ]
+    },
+    "name": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "topic": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "memberIds": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "isAgentChat": {
+      "type": "boolean"
+    },
+    "behavior": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "hasUnread": {
+      "type": "boolean"
+    },
+    "lastMessage": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "text": {
+              "type": "string"
+            },
+            "messageId": {
+              "type": "string"
+            },
+            "senderId": {
+              "type": "string"
+            },
+            "senderType": {
+              "type": "string",
+              "enum": [
+                "human",
+                "ai_agent"
+              ]
+            },
+            "contentType": {
+              "type": "string",
+              "enum": [
+                "text",
+                "image",
+                "audio",
+                "video",
+                "file",
+                "contact_card"
+              ]
+            },
+            "timestamp": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "text",
+            "senderId",
+            "senderType",
+            "timestamp"
+          ],
+          "additionalProperties": {}
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "createdAt": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "type",
+    "memberIds",
+    "lastMessage"
+  ],
+  "additionalProperties": {}
+}

package/dist/schemas/rest-message.schema.json

@@ -0,0 +1,252 @@
+{
+  "$id": "canon:RestMessageSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "senderId": {
+      "type": "string"
+    },
+    "senderName": {
+      "type": "string"
+    },
+    "senderType": {
+      "type": "string",
+      "enum": [
+        "human",
+        "ai_agent"
+      ]
+    },
+    "isOwner": {
+      "type": "boolean"
+    },
+    "contentType": {
+      "type": "string",
+      "enum": [
+        "text",
+        "image",
+        "audio",
+        "video",
+        "file",
+        "contact_card"
+      ]
+    },
+    "text": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "attachments": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "kind": {
+            "type": "string",
+            "enum": [
+              "image",
+              "audio",
+              "video",
+              "file"
+            ]
+          },
+          "url": {
+            "type": "string"
+          },
+          "mimeType": {
+            "type": "string"
+          },
+          "fileName": {
+            "type": "string"
+          },
+          "sizeBytes": {
+            "type": "number"
+          },
+          "width": {
+            "type": "number"
+          },
+          "height": {
+            "type": "number"
+          },
+          "durationMs": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "kind",
+          "url"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "mentions": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "replyTo": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "replyToPosition": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "forwarded": {
+      "type": "boolean"
+    },
+    "forwardedFrom": {
+      "type": "object",
+      "properties": {
+        "sourceConversationId": {
+          "type": "string"
+        },
+        "messageId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "sourceConversationId",
+        "messageId"
+      ],
+      "additionalProperties": false
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "sent",
+        "read"
+      ]
+    },
+    "createdAt": {
+      "type": "string"
+    },
+    "metadata": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "contactCard": {
+      "type": "object",
+      "properties": {
+        "userId": {
+          "type": "string"
+        },
+        "canonContactId": {
+          "type": "string"
+        },
+        "displayName": {
+          "type": "string"
+        },
+        "avatarUrl": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        },
+        "userType": {
+          "type": "string",
+          "enum": [
+            "human",
+            "ai_agent"
+          ]
+        },
+        "clientType": {
+          "type": "string",
+          "enum": [
+            "claude-code",
+            "openclaw",
+            "codex",
+            "hermes",
+            "generic"
+          ]
+        },
+        "about": {
+          "type": "string"
+        },
+        "isActive": {
+          "type": "boolean"
+        },
+        "ownerId": {
+          "type": "string"
+        },
+        "ownerName": {
+          "type": "string"
+        },
+        "lifecycleState": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "userId",
+        "displayName",
+        "avatarUrl",
+        "userType"
+      ],
+      "additionalProperties": false
+    },
+    "runtimeCard": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {}
+    },
+    "reactions": {
+      "type": "object",
+      "propertyNames": {
+        "type": "string"
+      },
+      "additionalProperties": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "deleted": {
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "id",
+    "senderId",
+    "senderType",
+    "isOwner",
+    "contentType",
+    "text",
+    "attachments",
+    "mentions",
+    "replyTo",
+    "replyToPosition",
+    "status",
+    "createdAt"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/rest-ok-response.schema.json

@@ -0,0 +1,11 @@
+{
+  "$id": "canon:RestOkResponseSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "success": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": {}
+}

package/dist/schemas/rest-session-selection.schema.json

@@ -0,0 +1,40 @@
+{
+  "$id": "canon:RestSessionSelectionSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "anyOf": [
+    {
+      "type": "object",
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": [
+            "new",
+            "continue_latest",
+            "continue_or_create"
+          ]
+        }
+      },
+      "required": [
+        "mode"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "mode": {
+          "type": "string",
+          "const": "specific"
+        },
+        "conversationId": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "mode",
+        "conversationId"
+      ],
+      "additionalProperties": false
+    }
+  ]
+}

package/dist/schemas/runtime-card-field-choice.schema.json

@@ -0,0 +1,23 @@
+{
+  "$id": "canon:RuntimeCardFieldChoiceSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "label": {
+      "type": "string"
+    },
+    "value": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "preview": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "label"
+  ],
+  "additionalProperties": false
+}

package/dist/schemas/runtime-card-field-type.schema.json

@@ -0,0 +1,17 @@
+{
+  "$id": "canon:RuntimeCardFieldTypeSchema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "string",
+  "enum": [
+    "text",
+    "textarea",
+    "select",
+    "multiSelect",
+    "boolean",
+    "date",
+    "number",
+    "currency",
+    "searchSelect",
+    "lineItems"
+  ]
+}