@whooshbang/contracts 1.0.0-rc.13

package/schemas/interaction-machine-scenario.schema.json

@@ -0,0 +1,700 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://whooshbang.flowxo.com/schemas/interaction-machine-scenario.schema.json",
+  "x-contract-version": "1.0.0-rc.13",
+  "title": "InteractionMachineScenario",
+  "description": "A deterministic C0-03 interaction, credential, authorization, polling, acknowledgement, or quarantine 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": [
+        "interaction_resolution",
+        "callback_token",
+        "machine_credential",
+        "machine_authorization",
+        "machine_poll",
+        "machine_ack",
+        "quarantine"
+      ]
+    },
+    "given": {
+      "type": "object",
+      "minProperties": 1
+    },
+    "expected": {
+      "type": "object",
+      "minProperties": 1
+    }
+  },
+  "allOf": [
+    {
+      "oneOf": [
+        {
+          "properties": {
+            "category": {
+              "const": "interaction_resolution"
+            },
+            "given": {
+              "$ref": "#/$defs/InteractionResolutionGiven"
+            },
+            "expected": {
+              "$ref": "#/$defs/InteractionResolutionExpected"
+            }
+          },
+          "required": ["category", "given", "expected"]
+        },
+        {
+          "properties": {
+            "category": {
+              "const": "callback_token"
+            },
+            "given": {
+              "$ref": "#/$defs/CallbackTokenGiven"
+            },
+            "expected": {
+              "$ref": "#/$defs/CallbackTokenExpected"
+            }
+          },
+          "required": ["category", "given", "expected"]
+        },
+        {
+          "properties": {
+            "category": {
+              "const": "machine_credential"
+            },
+            "given": {
+              "$ref": "#/$defs/MachineCredentialGiven"
+            },
+            "expected": {
+              "$ref": "#/$defs/MachineCredentialExpected"
+            }
+          },
+          "required": ["category", "given", "expected"]
+        },
+        {
+          "properties": {
+            "category": {
+              "const": "machine_authorization"
+            },
+            "given": {
+              "$ref": "#/$defs/MachineAuthorizationGiven"
+            },
+            "expected": {
+              "$ref": "#/$defs/MachineAuthorizationExpected"
+            }
+          },
+          "required": ["category", "given", "expected"]
+        },
+        {
+          "properties": {
+            "category": {
+              "const": "machine_poll"
+            },
+            "given": {
+              "$ref": "#/$defs/MachinePollGiven"
+            },
+            "expected": {
+              "$ref": "#/$defs/MachinePollExpected"
+            }
+          },
+          "required": ["category", "given", "expected"]
+        },
+        {
+          "properties": {
+            "category": {
+              "const": "machine_ack"
+            },
+            "given": {
+              "$ref": "#/$defs/MachineAckGiven"
+            },
+            "expected": {
+              "$ref": "#/$defs/MachineAckExpected"
+            }
+          },
+          "required": ["category", "given", "expected"]
+        },
+        {
+          "properties": {
+            "category": {
+              "const": "quarantine"
+            },
+            "given": {
+              "$ref": "#/$defs/QuarantineGiven"
+            },
+            "expected": {
+              "$ref": "#/$defs/QuarantineExpected"
+            }
+          },
+          "required": ["category", "given", "expected"]
+        }
+      ]
+    }
+  ],
+  "$defs": {
+    "NullableCursor": {
+      "oneOf": [
+        {
+          "type": "string",
+          "pattern": "^mcur_[A-Za-z0-9_-]+$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "InteractionResolutionGiven": {
+      "type": "object",
+      "minProperties": 1,
+      "properties": {
+        "state": {
+          "enum": ["open", "answered", "expired", "cancelled", "retired"]
+        },
+        "provider_update": {
+          "enum": ["duplicate", "late_answer"]
+        },
+        "expires_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "response_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "provider_binding_matches": {
+          "type": "boolean"
+        },
+        "eligible_open_inputs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "exact_reply_context": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "InteractionResolutionExpected": {
+      "type": "object",
+      "minProperties": 1,
+      "properties": {
+        "state": {
+          "enum": ["open", "answered", "expired", "cancelled", "retired"]
+        },
+        "answers_created": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "events_created": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "outcome": {
+          "enum": [
+            "answered",
+            "duplicate",
+            "expired",
+            "stale",
+            "identity_mismatch",
+            "ambiguous"
+          ]
+        },
+        "safe_diagnostic": {
+          "type": "boolean"
+        },
+        "trusted_provider_identity": {
+          "type": "boolean"
+        },
+        "routed_by_recency": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "CallbackTokenGiven": {
+      "type": "object",
+      "required": ["token", "random_bytes"],
+      "properties": {
+        "token": {
+          "type": "string",
+          "pattern": "^itok_[A-Za-z0-9_-]{21}[AQgw]$"
+        },
+        "random_bytes": {
+          "const": 16
+        }
+      },
+      "additionalProperties": false
+    },
+    "CallbackTokenExpected": {
+      "type": "object",
+      "required": [
+        "opaque",
+        "contains_identity",
+        "contains_answer",
+        "contains_command",
+        "contains_business_parameter"
+      ],
+      "properties": {
+        "opaque": {
+          "const": true
+        },
+        "contains_identity": {
+          "const": false
+        },
+        "contains_answer": {
+          "const": false
+        },
+        "contains_command": {
+          "const": false
+        },
+        "contains_business_parameter": {
+          "const": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "MachineCredentialGiven": {
+      "type": "object",
+      "minProperties": 1,
+      "properties": {
+        "same_credential_id": {
+          "type": "boolean"
+        },
+        "same_digest": {
+          "type": "boolean"
+        },
+        "new_registered": {
+          "type": "boolean"
+        },
+        "new_smoke_tested": {
+          "type": "boolean"
+        },
+        "old_revoked_after_smoke_test": {
+          "type": "boolean"
+        },
+        "registration_response_lost": {
+          "type": "boolean"
+        },
+        "client_state": {
+          "enum": ["provisioning", "active", "revoked"]
+        },
+        "active_credentials": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "registration_accepted": {
+          "type": "boolean"
+        },
+        "credential_status": {
+          "enum": ["active", "revoked"]
+        },
+        "same_revocation_replayed": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "MachineCredentialExpected": {
+      "type": "object",
+      "minProperties": 1,
+      "properties": {
+        "outcome": {
+          "enum": ["existing", "conflict"]
+        },
+        "status": {
+          "type": "integer",
+          "minimum": 100,
+          "maximum": 599
+        },
+        "credentials_created": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "secret_returned": {
+          "const": false
+        },
+        "digest_returned": {
+          "const": false
+        },
+        "valid_credentials": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "machine_locked_out": {
+          "type": "boolean"
+        },
+        "old_credential_authorized": {
+          "type": "boolean"
+        },
+        "client_state": {
+          "enum": ["provisioning", "active", "revoked"]
+        },
+        "active_credentials": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "readable_secret_received": {
+          "const": false
+        },
+        "credential_status": {
+          "enum": ["active", "revoked"]
+        },
+        "authorized": {
+          "const": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "MachineAuthorizationGiven": {
+      "type": "object",
+      "minProperties": 1,
+      "properties": {
+        "authenticated_machine_id": {
+          "type": "string"
+        },
+        "event_machine_id": {
+          "type": "string"
+        },
+        "credential_subscriber_id": {
+          "type": "string"
+        },
+        "request_subscriber_id": {
+          "type": "string"
+        },
+        "credential_notifier_id": {
+          "type": "string"
+        },
+        "request_notifier_id": {
+          "type": "string"
+        },
+        "credential_machine_client_id": {
+          "type": "string"
+        },
+        "message_machine_client_id": {
+          "type": "string"
+        },
+        "credential_kind": {
+          "enum": ["machine", "project"]
+        },
+        "credential_status": {
+          "enum": ["active", "revoked"]
+        },
+        "scope": {
+          "enum": ["machine-messages:write", "machine-messages:read"]
+        },
+        "authenticated_project_id": {
+          "type": "string"
+        },
+        "authenticated_environment": {
+          "enum": ["test", "live"]
+        },
+        "bound_notifier_id": {
+          "type": "string"
+        },
+        "bound_subscriber_id": {
+          "type": "string"
+        },
+        "message_project_id": {
+          "type": "string"
+        },
+        "message_environment": {
+          "enum": ["test", "live"]
+        },
+        "operation_id": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "MachineAuthorizationExpected": {
+      "oneOf": [
+        {
+          "type": "object",
+          "minProperties": 1,
+          "properties": {
+            "status": {
+              "type": "integer",
+              "minimum": 100,
+              "maximum": 599
+            },
+            "existence_disclosed": {
+              "const": false
+            },
+            "ack_recorded": {
+              "const": false
+            },
+            "committed_cursor": {
+              "$ref": "#/$defs/NullableCursor"
+            },
+            "authorized": {
+              "const": false
+            },
+            "provider_called": {
+              "const": false
+            },
+            "required_project_scope": {
+              "enum": ["messages:write", "machine-clients:write"]
+            },
+            "resource_looked_up": {
+              "const": false
+            },
+            "machine_stream_selected": {
+              "const": false
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["authorized", "target_bound", "provider_call_allowed"],
+          "properties": {
+            "authorized": {
+              "const": true
+            },
+            "target_bound": {
+              "const": true
+            },
+            "provider_call_allowed": {
+              "const": true
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": ["authorized", "own_message_only", "message_returned"],
+          "properties": {
+            "authorized": {
+              "const": true
+            },
+            "own_message_only": {
+              "const": true
+            },
+            "message_returned": {
+              "const": true
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "MachinePollGiven": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "committed_cursor",
+            "polled_event_id",
+            "acknowledged",
+            "client_restarted"
+          ],
+          "properties": {
+            "committed_cursor": {
+              "$ref": "#/$defs/NullableCursor"
+            },
+            "polled_event_id": {
+              "type": "string"
+            },
+            "acknowledged": {
+              "type": "boolean"
+            },
+            "client_restarted": {
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "committed_cursor",
+            "supplied_after",
+            "supplied_cursor_issued",
+            "supplied_cursor_committed"
+          ],
+          "properties": {
+            "committed_cursor": {
+              "$ref": "#/$defs/NullableCursor"
+            },
+            "supplied_after": {
+              "type": "string",
+              "pattern": "^mcur_[A-Za-z0-9_-]+$"
+            },
+            "supplied_cursor_issued": {
+              "type": "boolean"
+            },
+            "supplied_cursor_committed": {
+              "type": "boolean"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "MachinePollExpected": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["event_repeated", "event_id", "committed_cursor"],
+          "properties": {
+            "event_repeated": {
+              "type": "boolean"
+            },
+            "event_id": {
+              "type": "string"
+            },
+            "committed_cursor": {
+              "$ref": "#/$defs/NullableCursor"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "outcome",
+            "events_returned",
+            "rewound",
+            "committed_cursor"
+          ],
+          "properties": {
+            "outcome": {
+              "const": "cursor_mismatch"
+            },
+            "events_returned": {
+              "const": 0
+            },
+            "rewound": {
+              "const": false
+            },
+            "committed_cursor": {
+              "$ref": "#/$defs/NullableCursor"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "MachineAckGiven": {
+      "type": "object",
+      "minProperties": 1,
+      "properties": {
+        "earlier_cursor": {
+          "type": "string",
+          "pattern": "^mcur_[A-Za-z0-9_-]+$"
+        },
+        "earlier_acknowledged": {
+          "type": "boolean"
+        },
+        "ack_cursor": {
+          "type": "string",
+          "pattern": "^mcur_[A-Za-z0-9_-]+$"
+        },
+        "event_id": {
+          "type": "string"
+        },
+        "cursor": {
+          "type": "string",
+          "pattern": "^mcur_[A-Za-z0-9_-]+$"
+        },
+        "disposition": {
+          "enum": ["processed", "quarantined"]
+        },
+        "same_ack_replayed": {
+          "type": "boolean"
+        },
+        "recorded_disposition": {
+          "enum": ["processed", "quarantined"]
+        },
+        "replayed_disposition": {
+          "enum": ["processed", "quarantined"]
+        }
+      },
+      "additionalProperties": false
+    },
+    "MachineAckExpected": {
+      "type": "object",
+      "minProperties": 1,
+      "properties": {
+        "ack_recorded": {
+          "type": "boolean"
+        },
+        "committed_cursor": {
+          "$ref": "#/$defs/NullableCursor"
+        },
+        "gap_skipped": {
+          "const": false
+        },
+        "outcome": {
+          "enum": ["existing", "conflict"]
+        },
+        "status": {
+          "type": "integer",
+          "minimum": 100,
+          "maximum": 599
+        },
+        "events_skipped": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "committed_cursor_unchanged": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "QuarantineGiven": {
+      "type": "object",
+      "required": ["schema_valid", "stream_identity_valid", "reason_code"],
+      "properties": {
+        "schema_valid": {
+          "type": "boolean"
+        },
+        "stream_identity_valid": {
+          "type": "boolean"
+        },
+        "durable_reason_recorded": {
+          "type": "boolean"
+        },
+        "signature_valid": {
+          "type": "boolean"
+        },
+        "reason_code": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "pattern": "^[a-z0-9][a-z0-9._-]*$"
+        }
+      },
+      "additionalProperties": false
+    },
+    "QuarantineExpected": {
+      "type": "object",
+      "required": ["outcome", "cursor_may_advance"],
+      "properties": {
+        "outcome": {
+          "enum": ["recorded", "integrity_failure"]
+        },
+        "cursor_may_advance": {
+          "type": "boolean"
+        },
+        "ordinary_quarantine_allowed": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}