@whooshbang/contracts 1.0.0-rc.13

package/schemas/events/whooshbang-event-v1.schema.json

@@ -0,0 +1,689 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/whooshbang-event-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "WhooshBangEventV1ContractDocument",
+  "description": "Strict public customer-event envelope and initial WhooshBang event union.",
+  "oneOf": [
+    {
+      "$ref": "#/$defs/SubscriptionActivatedEvent"
+    },
+    {
+      "$ref": "#/$defs/SubscriptionRevokedEvent"
+    },
+    {
+      "$ref": "#/$defs/MessageProviderAcceptedEvent"
+    },
+    {
+      "$ref": "#/$defs/MessageDeliveredEvent"
+    },
+    {
+      "$ref": "#/$defs/MessageFailedEvent"
+    },
+    {
+      "$ref": "#/$defs/MessageExpiredEvent"
+    },
+    {
+      "$ref": "#/$defs/InteractionReceivedEvent"
+    },
+    {
+      "$ref": "#/$defs/InteractionExpiredEvent"
+    },
+    {
+      "$ref": "#/$defs/AgentBindingDegradedEvent"
+    }
+  ],
+  "$defs": {
+    "Environment": {
+      "type": "string",
+      "enum": ["test", "live"],
+      "description": "The environment in which the immutable event occurred."
+    },
+    "Channel": {
+      "type": "string",
+      "enum": ["telegram"],
+      "description": "The initial provider-neutral channel vocabulary."
+    },
+    "OpaqueIdentifier": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[^\\u0000-\\u001F\\u007F]+$",
+      "description": "A stable public resource identifier whose internal encoding is not a public promise."
+    },
+    "EventIdentifier": {
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 128,
+      "pattern": "^evt_[A-Za-z0-9_-]+$",
+      "description": "The stable logical event identifier. Dots and control characters are excluded so it is safe in the Standard Webhooks signing input."
+    },
+    "Timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](?:\\.[0-9]+)?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])$",
+      "description": "An RFC 3339 timestamp with an explicit UTC offset."
+    },
+    "CorrelationId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[^\\u0000-\\u001F\\u007F]+$",
+      "description": "Opaque customer correlation returned as data and never interpreted as authority or an executable command."
+    },
+    "InteractionCorrelationId": {
+      "type": "string",
+      "minLength": 8,
+      "maxLength": 128,
+      "pattern": "^[^\\u0000-\\u001F\\u007F]+$",
+      "description": "The C0-03 bounded opaque interaction correlation returned as data and never interpreted as authority."
+    },
+    "BaseEvent": {
+      "type": "object",
+      "required": [
+        "schema",
+        "id",
+        "type",
+        "created_at",
+        "account_id",
+        "project_id",
+        "environment",
+        "data"
+      ],
+      "properties": {
+        "schema": {
+          "const": "whooshbang.event.v1"
+        },
+        "id": {
+          "$ref": "#/$defs/EventIdentifier"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "subscription.activated",
+            "subscription.revoked",
+            "message.provider_accepted",
+            "message.delivered",
+            "message.failed",
+            "message.expired",
+            "interaction.received",
+            "interaction.expired",
+            "agent_binding.degraded"
+          ]
+        },
+        "created_at": {
+          "$ref": "#/$defs/Timestamp"
+        },
+        "account_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "project_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "environment": {
+          "$ref": "#/$defs/Environment"
+        },
+        "data": {
+          "type": "object"
+        }
+      },
+      "additionalProperties": false
+    },
+    "SubscriptionActivatedData": {
+      "type": "object",
+      "required": [
+        "subscription_link_id",
+        "binding_id",
+        "subscriber_id",
+        "notifier_id",
+        "channel",
+        "state",
+        "activated_at"
+      ],
+      "properties": {
+        "subscription_link_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "binding_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "subscriber_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "notifier_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "channel": {
+          "$ref": "#/$defs/Channel"
+        },
+        "state": {
+          "const": "activated"
+        },
+        "activated_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "additionalProperties": false
+    },
+    "SubscriptionRevokedData": {
+      "type": "object",
+      "required": [
+        "subscription_link_id",
+        "binding_id",
+        "subscriber_id",
+        "notifier_id",
+        "channel",
+        "state",
+        "revoked_at"
+      ],
+      "properties": {
+        "subscription_link_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "binding_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "subscriber_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "notifier_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "channel": {
+          "$ref": "#/$defs/Channel"
+        },
+        "state": {
+          "const": "revoked"
+        },
+        "revoked_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "additionalProperties": false
+    },
+    "MessageProviderAcceptedData": {
+      "type": "object",
+      "required": ["message_id", "state", "accepted_at"],
+      "properties": {
+        "message_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "correlation_id": {
+          "$ref": "#/$defs/CorrelationId"
+        },
+        "state": {
+          "const": "provider_accepted"
+        },
+        "accepted_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "additionalProperties": false
+    },
+    "MessageDeliveredData": {
+      "type": "object",
+      "required": ["message_id", "state", "evidence", "delivered_at"],
+      "properties": {
+        "message_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "correlation_id": {
+          "$ref": "#/$defs/CorrelationId"
+        },
+        "state": {
+          "const": "delivered"
+        },
+        "evidence": {
+          "const": "provider_delivery_receipt",
+          "description": "Delivery is claimed only when the provider supplied trustworthy delivery evidence."
+        },
+        "delivered_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "additionalProperties": false
+    },
+    "MessageFailedData": {
+      "type": "object",
+      "required": [
+        "message_id",
+        "state",
+        "failure_code",
+        "retryable",
+        "failed_at"
+      ],
+      "properties": {
+        "message_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "correlation_id": {
+          "$ref": "#/$defs/CorrelationId"
+        },
+        "state": {
+          "const": "terminal_failed"
+        },
+        "failure_code": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^[a-z0-9][a-z0-9._-]*$",
+          "description": "A provider-neutral, safe public failure classification."
+        },
+        "retryable": {
+          "const": false
+        },
+        "failed_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "additionalProperties": false
+    },
+    "MessageExpiredData": {
+      "type": "object",
+      "required": ["message_id", "state", "expired_at"],
+      "properties": {
+        "message_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "correlation_id": {
+          "$ref": "#/$defs/CorrelationId"
+        },
+        "state": {
+          "const": "expired"
+        },
+        "expired_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "additionalProperties": false
+    },
+    "ConfirmInteractionResponse": {
+      "type": "object",
+      "required": ["type", "value"],
+      "properties": {
+        "type": {
+          "const": "confirm"
+        },
+        "value": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "SelectInteractionResponse": {
+      "type": "object",
+      "required": ["type", "value"],
+      "properties": {
+        "type": {
+          "const": "select"
+        },
+        "value": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "pattern": "^[^\\u0000-\\u001F\\u007F]+$",
+          "description": "Opaque customer data and never an executable command."
+        }
+      },
+      "additionalProperties": false
+    },
+    "InputInteractionResponse": {
+      "type": "object",
+      "required": ["type", "value"],
+      "properties": {
+        "type": {
+          "const": "input"
+        },
+        "value": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 4000,
+          "pattern": "^(?:\\S|\\S[\\s\\S]*\\S)$"
+        }
+      },
+      "additionalProperties": false
+    },
+    "InteractionResponse": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/ConfirmInteractionResponse"
+        },
+        {
+          "$ref": "#/$defs/SelectInteractionResponse"
+        },
+        {
+          "$ref": "#/$defs/InputInteractionResponse"
+        }
+      ]
+    },
+    "InteractionReceivedData": {
+      "type": "object",
+      "required": [
+        "interaction_id",
+        "message_id",
+        "binding_id",
+        "channel",
+        "interaction_type",
+        "response",
+        "occurred_at",
+        "expires_at"
+      ],
+      "properties": {
+        "interaction_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "message_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "binding_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "channel": {
+          "$ref": "#/$defs/Channel"
+        },
+        "correlation_id": {
+          "$ref": "#/$defs/InteractionCorrelationId"
+        },
+        "interaction_type": {
+          "type": "string",
+          "enum": ["confirm", "select", "input"]
+        },
+        "response": {
+          "$ref": "#/$defs/InteractionResponse"
+        },
+        "occurred_at": {
+          "$ref": "#/$defs/Timestamp"
+        },
+        "expires_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "interaction_type": {
+                "const": "confirm"
+              }
+            },
+            "required": ["interaction_type"]
+          },
+          "then": {
+            "type": "object",
+            "properties": {
+              "response": {
+                "$ref": "#/$defs/ConfirmInteractionResponse"
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "interaction_type": {
+                "const": "select"
+              }
+            },
+            "required": ["interaction_type"]
+          },
+          "then": {
+            "type": "object",
+            "properties": {
+              "response": {
+                "$ref": "#/$defs/SelectInteractionResponse"
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "type": "object",
+            "properties": {
+              "interaction_type": {
+                "const": "input"
+              }
+            },
+            "required": ["interaction_type"]
+          },
+          "then": {
+            "type": "object",
+            "properties": {
+              "response": {
+                "$ref": "#/$defs/InputInteractionResponse"
+              }
+            }
+          }
+        }
+      ],
+      "additionalProperties": false
+    },
+    "InteractionExpiredData": {
+      "type": "object",
+      "required": [
+        "interaction_id",
+        "message_id",
+        "interaction_type",
+        "expired_at"
+      ],
+      "properties": {
+        "interaction_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "message_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "correlation_id": {
+          "$ref": "#/$defs/InteractionCorrelationId"
+        },
+        "interaction_type": {
+          "type": "string",
+          "enum": ["confirm", "select", "input"]
+        },
+        "expired_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "additionalProperties": false
+    },
+    "AgentBindingDegradedData": {
+      "type": "object",
+      "required": [
+        "agent_binding_id",
+        "binding_id",
+        "notifier_id",
+        "state",
+        "degradation_code",
+        "degraded_at"
+      ],
+      "properties": {
+        "agent_binding_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "binding_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "notifier_id": {
+          "$ref": "#/$defs/OpaqueIdentifier"
+        },
+        "state": {
+          "const": "degraded"
+        },
+        "degradation_code": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^[a-z0-9][a-z0-9._-]*$",
+          "description": "A safe public classification without provider identity or credentials."
+        },
+        "degraded_at": {
+          "$ref": "#/$defs/Timestamp"
+        }
+      },
+      "additionalProperties": false
+    },
+    "SubscriptionActivatedEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "subscription.activated"
+            },
+            "data": {
+              "$ref": "#/$defs/SubscriptionActivatedData"
+            }
+          }
+        }
+      ]
+    },
+    "SubscriptionRevokedEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "subscription.revoked"
+            },
+            "data": {
+              "$ref": "#/$defs/SubscriptionRevokedData"
+            }
+          }
+        }
+      ]
+    },
+    "MessageProviderAcceptedEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "message.provider_accepted"
+            },
+            "data": {
+              "$ref": "#/$defs/MessageProviderAcceptedData"
+            }
+          }
+        }
+      ]
+    },
+    "MessageDeliveredEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "message.delivered"
+            },
+            "data": {
+              "$ref": "#/$defs/MessageDeliveredData"
+            }
+          }
+        }
+      ]
+    },
+    "MessageFailedEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "message.failed"
+            },
+            "data": {
+              "$ref": "#/$defs/MessageFailedData"
+            }
+          }
+        }
+      ]
+    },
+    "MessageExpiredEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "message.expired"
+            },
+            "data": {
+              "$ref": "#/$defs/MessageExpiredData"
+            }
+          }
+        }
+      ]
+    },
+    "InteractionReceivedEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "interaction.received"
+            },
+            "data": {
+              "$ref": "#/$defs/InteractionReceivedData"
+            }
+          }
+        }
+      ]
+    },
+    "InteractionExpiredEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "interaction.expired"
+            },
+            "data": {
+              "$ref": "#/$defs/InteractionExpiredData"
+            }
+          }
+        }
+      ]
+    },
+    "AgentBindingDegradedEvent": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/BaseEvent"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "const": "agent_binding.degraded"
+            },
+            "data": {
+              "$ref": "#/$defs/AgentBindingDegradedData"
+            }
+          }
+        }
+      ]
+    }
+  }
+}