flowspec2 1.0.0__py3-none-any.whl

flowspec2/authoring/corpus/await_correction.case.json

@@ -0,0 +1,220 @@
+{
+  "format": "flowspec2/authoring-case@3",
+  "identifier": "await_and_correction",
+  "prompt": "Author the ordered steps collect_request_description, authenticate_requester, confirm_ticket_data, and the open_ticket terminal. Collect required request_description through free-text RequestDescription. Persist brazilian_tax_id internally through the BrazilianTaxId domain. Suspend authenticate_requester with a verbatim cta_url prompt and out-of-band authentication_token field. Use resume contract version 1 with an exact eleven-digit brazilian_tax_id object schema, correlation $token.brazilian_tax_id, duplicate ignore, late reject, and set brazilian_tax_id from $token.brazilian_tax_id. Timeout, abort, and switch return to collect_request_description; resend returns to authenticate_requester. Confirm through ticket_data_confirmed in bool domain YesNo with affirmation and emoji_veto normalization, buttons sourced from YesNo, and allow correction of request_description. Call open_service_request idempotently with request_description as problem and brazilian_tax_id as requester, store result.protocol_id as protocol_id, reset on success and fatal, and preserve state on retryable. Add no other semantic behavior. Flow identity, version, route prose, and non-verbatim path-prompt wording may vary.",
+  "feature_tags": ["await_external", "correction", "terminal"],
+  "required_constructs": [
+    {
+      "identifier": "external-wait-marker",
+      "pointer_pattern": "/path/*/await_external",
+      "expected": true
+    },
+    {
+      "identifier": "external-wait-kind",
+      "pointer_pattern": "/capabilities/await_external/kind",
+      "expected": "cta_url"
+    },
+    {
+      "identifier": "external-wait-step",
+      "pointer_pattern": "/capabilities/await_external/step",
+      "expected": "authenticate_requester"
+    },
+    {
+      "identifier": "external-wait-resume-token",
+      "pointer_pattern": "/capabilities/await_external/resume_on",
+      "expected": "authentication_token"
+    },
+    {
+      "identifier": "external-resume-brazilian_tax_id",
+      "pointer_pattern": "/capabilities/await_external/on_resume/set/brazilian_tax_id",
+      "expected": "$token.brazilian_tax_id"
+    },
+    {
+      "identifier": "correctable-confirmation",
+      "pointer_pattern": "/path/*/correctable",
+      "expected": true
+    },
+    {
+      "identifier": "correction-contract",
+      "pointer_pattern": "/confirm/correctable",
+      "expected": [
+        "request_description"
+      ]
+    },
+    {
+      "identifier": "terminal-marker",
+      "pointer_pattern": "/path/*/terminal",
+      "expected": true
+    },
+    {
+      "identifier": "terminal-tool",
+      "pointer_pattern": "/terminal/tool",
+      "expected": "open_service_request"
+    },
+    {
+      "identifier": "terminal-idempotency",
+      "pointer_pattern": "/terminal/idempotent",
+      "expected": true
+    },
+    {
+      "identifier": "terminal-output",
+      "pointer_pattern": "/terminal/outputs/protocol_id",
+      "expected": "result.protocol_id"
+    }
+  ],
+  "source": {
+    "schema": "flowspec/2",
+    "flow": "authenticated_correctable_request",
+    "version": "1.0.0",
+    "route": {
+      "description": "Authenticate, confirm, and open a correctable municipal request."
+    },
+    "domains": {
+      "RequestDescription": {
+        "type": "free_text"
+      },
+      "BrazilianTaxId": {
+        "type": "brazilian_tax_id"
+      },
+      "YesNo": {
+        "type": "bool",
+        "normalize": {
+          "affirmation": true,
+          "emoji_veto": true
+        }
+      }
+    },
+    "slots": {
+      "request_description": {
+        "domain": "RequestDescription",
+        "required": true
+      },
+      "brazilian_tax_id": {
+        "domain": "BrazilianTaxId",
+        "persist": "internal"
+      },
+      "ticket_data_confirmed": {
+        "domain": "YesNo"
+      }
+    },
+    "path": [
+      {
+        "step": "collect_request_description",
+        "slot": "request_description",
+        "prompt": {
+          "text": "Describe your request."
+        }
+      },
+      {
+        "step": "authenticate_requester",
+        "await_external": true
+      },
+      {
+        "step": "confirm_ticket_data",
+        "confirm": "ticket_data_confirmed",
+        "correctable": true,
+        "prompt": {
+          "text": "Do you confirm the request details?"
+        },
+        "interactive": {
+          "kind": "buttons",
+          "field": "ticket_data_confirmed",
+          "from_domain": "YesNo"
+        }
+      },
+      {
+        "terminal": true
+      }
+    ],
+    "confirm": {
+      "step": "confirm_ticket_data",
+      "slot": "ticket_data_confirmed",
+      "on_confirm": "open_ticket",
+      "correctable": ["request_description"]
+    },
+    "terminal": {
+      "step": "open_ticket",
+      "tool": "open_service_request",
+      "idempotent": true,
+      "input": [
+        {
+          "param": "problem",
+          "slot": "request_description"
+        },
+        {
+          "param": "requester",
+          "slot": "brazilian_tax_id"
+        }
+      ],
+      "outputs": {
+        "protocol_id": "result.protocol_id"
+      },
+      "outcomes": {
+        "success": {
+          "reset_next": true
+        },
+        "retryable": {
+          "preserve_state": true
+        },
+        "fatal": {
+          "reset_next": true
+        }
+      }
+    },
+    "capabilities": {
+      "await_external": {
+        "kind": "cta_url",
+        "step": "authenticate_requester",
+        "resume_on": "authentication_token",
+        "resume": {
+          "version": "1",
+          "schema": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "brazilian_tax_id": {
+                "type": "string",
+                "pattern": "^[0-9]{11}$"
+              }
+            },
+            "required": [
+              "brazilian_tax_id"
+            ]
+          },
+          "correlation": "$token.brazilian_tax_id",
+          "duplicate": "ignore",
+          "late": "reject"
+        },
+        "prompt": {
+          "text": "Authenticate to continue.",
+          "verbatim": true
+        },
+        "interactive": {
+          "kind": "cta_url",
+          "field": "authentication_token",
+          "out_of_band": true,
+          "next_step": "authenticate_requester"
+        },
+        "on_resume": {
+          "set": {
+            "brazilian_tax_id": "$token.brazilian_tax_id"
+          }
+        },
+        "timeout": {
+          "goto": "collect_request_description"
+        },
+        "recovery": {
+          "abort": {
+            "goto": "collect_request_description"
+          },
+          "resend": {
+            "goto": "authenticate_requester"
+          },
+          "switch": {
+            "goto": "collect_request_description"
+          }
+        }
+      }
+    }
+  }
+}