@executioncontrolprotocol/types 0.10.0

package/dist/schemas/run.request.json

@@ -0,0 +1,485 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/RunRequest",
+  "definitions": {
+    "RunRequest": {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "type": "string",
+          "const": "@executioncontrolprotocol.run.request"
+        },
+        "version": {
+          "$ref": "#/definitions/EcpVersion"
+        },
+        "workflow": {
+          "$ref": "#/definitions/WorkflowManifest"
+        },
+        "input": {
+          "type": "object",
+          "additionalProperties": {}
+        },
+        "actor": {
+          "type": "object",
+          "additionalProperties": {}
+        },
+        "dryRun": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "schema",
+        "version",
+        "workflow"
+      ],
+      "additionalProperties": false,
+      "description": "Run request document.",
+      "category": "Runtime"
+    },
+    "EcpVersion": {
+      "type": "string",
+      "description": "ECP semantic version literal.",
+      "category": "Common"
+    },
+    "WorkflowManifest": {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "type": "string",
+          "const": "@executioncontrolprotocol.workflow"
+        },
+        "version": {
+          "$ref": "#/definitions/EcpVersion"
+        },
+        "workflow": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "label": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "id"
+          ],
+          "additionalProperties": false
+        },
+        "steps": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/WorkflowNode"
+          }
+        }
+      },
+      "required": [
+        "schema",
+        "version",
+        "workflow",
+        "steps"
+      ],
+      "additionalProperties": false,
+      "description": "Portable workflow manifest.",
+      "category": "Workflow"
+    },
+    "WorkflowNode": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/StepNode"
+        },
+        {
+          "$ref": "#/definitions/ParallelNode"
+        },
+        {
+          "$ref": "#/definitions/BranchNode"
+        },
+        {
+          "$ref": "#/definitions/LoopNode"
+        }
+      ],
+      "description": "Workflow graph node union.",
+      "category": "Workflow"
+    },
+    "StepNode": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "step"
+        },
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "uses": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CapabilityId"
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "input": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/InputValue"
+          }
+        },
+        "as": {
+          "type": "string",
+          "description": "State key for committed output (fluent `.as()`)."
+        },
+        "mode": {
+          "$ref": "#/definitions/CommitMode",
+          "description": "Commit mode when `as` is set (fluent `.as(key, { mode })`)."
+        },
+        "when": {
+          "$ref": "#/definitions/ExprValue"
+        }
+      },
+      "required": [
+        "id",
+        "uses"
+      ],
+      "additionalProperties": false,
+      "description": "Single capability step.",
+      "category": "Workflow"
+    },
+    "CapabilityId": {
+      "type": "string",
+      "description": "Capability id (`@namespace/name.capability`).",
+      "category": "Common"
+    },
+    "InputValue": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "number"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        },
+        {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/InputValue"
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/InputValue"
+          }
+        },
+        {
+          "$ref": "#/definitions/RefValue"
+        },
+        {
+          "$ref": "#/definitions/StateValue"
+        },
+        {
+          "$ref": "#/definitions/EnvValue"
+        },
+        {
+          "$ref": "#/definitions/SecretValue"
+        },
+        {
+          "$ref": "#/definitions/BrowserValue"
+        }
+      ],
+      "description": "Input value allowed in step config.",
+      "category": "Workflow"
+    },
+    "RefValue": {
+      "type": "object",
+      "properties": {
+        "$ref": {
+          "type": "string",
+          "description": "State path prefixed with `state.` in manifests."
+        },
+        "optional": {
+          "type": "boolean",
+          "description": "When true, missing state does not fail resolution."
+        },
+        "fallback": {
+          "description": "Fallback when optional ref is missing."
+        }
+      },
+      "required": [
+        "$ref"
+      ],
+      "additionalProperties": false,
+      "description": "Workflow reference to committed state.",
+      "category": "Workflow"
+    },
+    "StateValue": {
+      "type": "object",
+      "properties": {
+        "$state": {
+          "type": "string",
+          "description": "State path for staged mutations."
+        },
+        "optional": {
+          "type": "boolean"
+        },
+        "fallback": {}
+      },
+      "required": [
+        "$state"
+      ],
+      "additionalProperties": false,
+      "description": "Mutable state handle in step input.",
+      "category": "Workflow"
+    },
+    "EnvValue": {
+      "type": "object",
+      "properties": {
+        "$env": {
+          "type": "string"
+        },
+        "optional": {
+          "type": "boolean"
+        },
+        "fallback": {}
+      },
+      "required": [
+        "$env"
+      ],
+      "additionalProperties": false,
+      "description": "Environment config secret reference (not portable in workflows).",
+      "category": "Environment"
+    },
+    "SecretValue": {
+      "type": "object",
+      "properties": {
+        "$secret": {
+          "type": "string",
+          "description": "Logical key in the OS secrets store."
+        },
+        "optional": {
+          "type": "boolean",
+          "description": "When true, missing secret does not fail resolution."
+        },
+        "fallback": {
+          "description": "Fallback when optional secret is missing."
+        }
+      },
+      "required": [
+        "$secret"
+      ],
+      "additionalProperties": false,
+      "description": "OS secrets reference (not portable in workflows).",
+      "category": "Environment"
+    },
+    "BrowserValue": {
+      "type": "object",
+      "properties": {
+        "$browser": {
+          "type": "string",
+          "description": "Logical key in the browser secrets vault."
+        },
+        "optional": {
+          "type": "boolean",
+          "description": "When true, missing secret does not fail resolution."
+        },
+        "fallback": {
+          "description": "Fallback when optional secret is missing."
+        }
+      },
+      "required": [
+        "$browser"
+      ],
+      "additionalProperties": false,
+      "description": "Browser encrypted secrets reference (not portable in workflows).",
+      "category": "Environment"
+    },
+    "CommitMode": {
+      "type": "string",
+      "enum": [
+        "create",
+        "replace",
+        "merge",
+        "append",
+        "version"
+      ],
+      "description": "Commit mode for step output.",
+      "category": "Workflow"
+    },
+    "ExprValue": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "eq": {
+              "type": "array",
+              "minItems": 2,
+              "items": [
+                {
+                  "type": "string"
+                },
+                {}
+              ],
+              "maxItems": 2
+            }
+          },
+          "required": [
+            "eq"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "neq": {
+              "type": "array",
+              "minItems": 2,
+              "items": [
+                {
+                  "type": "string"
+                },
+                {}
+              ],
+              "maxItems": 2
+            }
+          },
+          "required": [
+            "neq"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "additionalProperties": {}
+        }
+      ],
+      "description": "Expression value in workflow conditions.",
+      "category": "Workflow"
+    },
+    "ParallelNode": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "parallel"
+        },
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "branches": {
+          "type": "array",
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/definitions/WorkflowNode"
+            }
+          }
+        }
+      },
+      "required": [
+        "type",
+        "id",
+        "branches"
+      ],
+      "additionalProperties": false,
+      "description": "Parallel branches.",
+      "category": "Workflow"
+    },
+    "BranchNode": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "branch"
+        },
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "branches": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "label": {
+                "type": "string"
+              },
+              "when": {
+                "$ref": "#/definitions/ExprValue"
+              },
+              "steps": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/definitions/WorkflowNode"
+                }
+              }
+            },
+            "required": [
+              "when",
+              "steps"
+            ],
+            "additionalProperties": false
+          }
+        }
+      },
+      "required": [
+        "type",
+        "id",
+        "branches"
+      ],
+      "additionalProperties": false,
+      "description": "Conditional branches.",
+      "category": "Workflow"
+    },
+    "LoopNode": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "const": "loop"
+        },
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "until": {
+          "$ref": "#/definitions/ExprValue"
+        },
+        "maxRounds": {
+          "type": "number"
+        },
+        "steps": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/WorkflowNode"
+          }
+        }
+      },
+      "required": [
+        "type",
+        "id",
+        "steps"
+      ],
+      "additionalProperties": false,
+      "description": "Loop until condition.",
+      "category": "Workflow"
+    }
+  },
+  "$id": "https://ecp.dev/schemas/run.request.json"
+}

package/dist/schemas/run.result.json

@@ -0,0 +1,170 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/RunResult",
+  "definitions": {
+    "RunResult": {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "type": "string",
+          "const": "@executioncontrolprotocol.run.result"
+        },
+        "version": {
+          "$ref": "#/definitions/EcpVersion"
+        },
+        "run": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "status": {
+              "$ref": "#/definitions/RunStatus"
+            }
+          },
+          "required": [
+            "id",
+            "status"
+          ],
+          "additionalProperties": false
+        },
+        "state": {
+          "type": "object",
+          "additionalProperties": {}
+        },
+        "history": {
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/StepRunRecord"
+          }
+        },
+        "usage": {
+          "type": "object",
+          "additionalProperties": {}
+        }
+      },
+      "required": [
+        "schema",
+        "version",
+        "run"
+      ],
+      "additionalProperties": false,
+      "description": "Run result document.",
+      "category": "Runtime"
+    },
+    "EcpVersion": {
+      "type": "string",
+      "description": "ECP semantic version literal.",
+      "category": "Common"
+    },
+    "RunStatus": {
+      "type": "string",
+      "enum": [
+        "created",
+        "started",
+        "completed",
+        "failed",
+        "cancelled",
+        "paused"
+      ],
+      "description": "Run status.",
+      "category": "Runtime"
+    },
+    "StepRunRecord": {
+      "type": "object",
+      "properties": {
+        "status": {
+          "$ref": "#/definitions/RunStatus"
+        },
+        "output": {},
+        "committedAs": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "attempts": {
+          "type": "number"
+        },
+        "usage": {
+          "type": "object",
+          "additionalProperties": {}
+        },
+        "mutations": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/MutationRecord"
+          }
+        }
+      },
+      "required": [
+        "status"
+      ],
+      "additionalProperties": false,
+      "description": "Per-step run history record.",
+      "category": "Runtime"
+    },
+    "MutationRecord": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "op": {
+          "type": "string",
+          "enum": [
+            "set",
+            "replace",
+            "merge",
+            "append"
+          ]
+        },
+        "path": {
+          "type": "string"
+        },
+        "before": {},
+        "after": {},
+        "reason": {
+          "type": "string"
+        },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": {}
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "committed",
+            "denied",
+            "discarded",
+            "failed"
+          ]
+        },
+        "stepId": {
+          "type": "string"
+        },
+        "capability": {
+          "type": "string"
+        },
+        "timestamp": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "id",
+        "op",
+        "path",
+        "before",
+        "after",
+        "status",
+        "stepId",
+        "capability",
+        "timestamp"
+      ],
+      "additionalProperties": false,
+      "description": "Committed or denied mutation record.",
+      "category": "Runtime"
+    }
+  },
+  "$id": "https://ecp.dev/schemas/run.result.json"
+}