@whooshbang/contracts 1.0.0-rc.13

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@whooshbang/contracts",
+  "version": "1.0.0-rc.13",
+  "description": "Versioned public contracts for WhooshBang",
+  "private": false,
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "homepage": "https://whooshbang.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flowxo/whooshbang.git",
+    "directory": "packages/contracts"
+  },
+  "keywords": [
+    "whooshbang",
+    "notifications",
+    "telegram",
+    "openapi"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "files": [
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md",
+    "contract-manifest.json",
+    "dist",
+    "examples/python/verify_webhook.py",
+    "fixtures",
+    "openapi",
+    "schemas"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./contract-manifest.json": "./contract-manifest.json",
+    "./contract-manifest.schema.json": "./schemas/contract-manifest.schema.json",
+    "./examples/python/verify_webhook.py": "./examples/python/verify_webhook.py",
+    "./fixtures/*": "./fixtures/*",
+    "./openapi/whooshbang-v1.yaml": "./openapi/whooshbang-v1.yaml",
+    "./openapi/whooshbang-v1.bundle.json": "./openapi/generated/whooshbang-v1.bundle.json",
+    "./schemas/*": "./schemas/*",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsx scripts/clean-dist.ts && tsc -p tsconfig.build.json",
+    "check": "npm run build && tsx scripts/check.ts",
+    "generate": "tsx scripts/generate.ts",
+    "lint": "eslint src scripts test --max-warnings=0",
+    "pack:verified": "npm run check && tsx scripts/pack.ts",
+    "test": "vitest run --no-file-parallelism",
+    "type-check": "tsc --noEmit -p tsconfig.json"
+  },
+  "engines": {
+    "node": ">=22.13.0 <23"
+  }
+}

package/schemas/contract-manifest.schema.json

@@ -0,0 +1,140 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "ContractManifest",
+  "description": "Machine-verifiable index of the public artifacts owned by WhooshBang.",
+  "type": "object",
+  "required": [
+    "schema",
+    "artifact",
+    "version",
+    "openapi",
+    "schemas",
+    "fixture_sets",
+    "generated",
+    "compatibility"
+  ],
+  "properties": {
+    "schema": {
+      "const": "flowxo.contract-manifest.v1"
+    },
+    "artifact": {
+      "const": "@whooshbang/contracts"
+    },
+    "version": {
+      "$ref": "#/$defs/contractVersion"
+    },
+    "openapi": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/artifact"
+      }
+    },
+    "schemas": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/artifact"
+      }
+    },
+    "fixture_sets": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/fixtureSet"
+      }
+    },
+    "generated": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/generatedArtifact"
+      }
+    },
+    "compatibility": {
+      "type": "object",
+      "required": ["api_major", "status"],
+      "properties": {
+        "api_major": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "status": {
+          "enum": ["draft", "release-candidate", "stable", "deprecated"]
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$defs": {
+    "contractVersion": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(?:-(?:draft|rc)\\.[0-9]+)?$"
+    },
+    "artifactId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[a-z0-9][a-z0-9._-]*$"
+    },
+    "relativePath": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 512,
+      "pattern": "^(?!/)(?!.*(?:^|/)\\.\\.(?:/|$))(?!.*\\\\).+$"
+    },
+    "artifact": {
+      "type": "object",
+      "required": ["id", "version", "path"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/artifactId"
+        },
+        "version": {
+          "$ref": "#/$defs/contractVersion"
+        },
+        "path": {
+          "$ref": "#/$defs/relativePath"
+        }
+      },
+      "additionalProperties": false
+    },
+    "fixtureSet": {
+      "type": "object",
+      "required": ["id", "version", "schema", "fixtures"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/artifactId"
+        },
+        "version": {
+          "$ref": "#/$defs/contractVersion"
+        },
+        "schema": {
+          "$ref": "#/$defs/relativePath"
+        },
+        "fixtures": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/$defs/relativePath"
+          },
+          "uniqueItems": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "generatedArtifact": {
+      "type": "object",
+      "required": ["id", "source", "path"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/artifactId"
+        },
+        "source": {
+          "$ref": "#/$defs/relativePath"
+        },
+        "path": {
+          "$ref": "#/$defs/relativePath"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/core-scenario.schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/core-scenario.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "CoreContractScenario",
+  "description": "A deterministic C0-02 semantic, state, idempotency, or isolation scenario.",
+  "type": "object",
+  "required": ["contract_version", "id", "category", "given", "expected"],
+  "properties": {
+    "contract_version": {
+      "const": "1.0.0-rc.13"
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[a-z0-9][a-z0-9._-]*$"
+    },
+    "category": {
+      "type": "string",
+      "enum": [
+        "idempotency",
+        "isolation",
+        "subscription_replay",
+        "message_outcome",
+        "cancellation",
+        "credential_lifecycle"
+      ]
+    },
+    "given": {
+      "type": "object"
+    },
+    "expected": {
+      "type": "object"
+    }
+  },
+  "additionalProperties": false
+}

package/schemas/events/agent-binding-degraded-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/agent-binding-degraded-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "AgentBindingDegradedEventV1",
+  "description": "An agent binding entered a provider-neutral degraded state.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/AgentBindingDegradedEvent"
+}

package/schemas/events/interaction-expired-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/interaction-expired-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "InteractionExpiredEventV1",
+  "description": "An interaction reached its terminal expiry without a valid answer.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/InteractionExpiredEvent"
+}

package/schemas/events/interaction-received-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/interaction-received-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "InteractionReceivedEventV1",
+  "description": "One authenticated, provider-neutral interaction answer was received.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/InteractionReceivedEvent"
+}

package/schemas/events/message-delivered-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/message-delivered-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "MessageDeliveredEventV1",
+  "description": "A provider supplied trustworthy evidence that a message was delivered.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/MessageDeliveredEvent"
+}

package/schemas/events/message-expired-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/message-expired-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "MessageExpiredEventV1",
+  "description": "A message expired before reaching a later delivery state.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/MessageExpiredEvent"
+}

package/schemas/events/message-failed-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/message-failed-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "MessageFailedEventV1",
+  "description": "A message reached a classified terminal failure.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/MessageFailedEvent"
+}

package/schemas/events/message-provider-accepted-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/message-provider-accepted-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "MessageProviderAcceptedEventV1",
+  "description": "The provider accepted a message without implying delivery.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/MessageProviderAcceptedEvent"
+}

package/schemas/events/subscription-activated-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/subscription-activated-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "SubscriptionActivatedEventV1",
+  "description": "A subscription became active with a safe public channel binding.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/SubscriptionActivatedEvent"
+}

package/schemas/events/subscription-revoked-v1.schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/events/subscription-revoked-v1.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "SubscriptionRevokedEventV1",
+  "description": "A subscription and its safe public channel binding were revoked.",
+  "$ref": "whooshbang-event-v1.schema.json#/$defs/SubscriptionRevokedEvent"
+}