@fluidgrids/workflows 2026.1027.0 → 2026.1028.1

package/schema/workflow-command.schema.json

@@ -0,0 +1,1095 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://docs.fluidgrids.ai/schemas/workflow-command.schema.json",
+  "title": "FluidGrids workflow-task command",
+  "description": "A flat object discriminated by an UPPER_SNAKE type. Commands travel as [JSON!]! (DB4). UPSERT_SEARCH_ATTRIBUTES, ACCEPT_UPDATE, REJECT_UPDATE and COMPLETE_UPDATE are defined but refused in Phase B.",
+  "type": "object",
+  "required": [
+    "type"
+  ],
+  "properties": {
+    "type": {
+      "enum": [
+        "SCHEDULE_ACTIVITY",
+        "REQUEST_CANCEL_ACTIVITY",
+        "START_TIMER",
+        "CANCEL_TIMER",
+        "START_CHILD_RUN",
+        "SIGNAL_RUN",
+        "RECORD_SIDE_EFFECT",
+        "RECORD_MARKER",
+        "COMPLETE_WORKFLOW",
+        "FAIL_WORKFLOW",
+        "CANCEL_WORKFLOW",
+        "UPSERT_CONTEXT",
+        "RECORD_LOCAL_ACTIVITY",
+        "CONTINUE_AS_NEW",
+        "REQUEST_CANCEL_EXTERNAL_RUN",
+        "UPSERT_SEARCH_ATTRIBUTES",
+        "ACCEPT_UPDATE",
+        "REJECT_UPDATE",
+        "COMPLETE_UPDATE"
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "SCHEDULE_ACTIVITY"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_SCHEDULE_ACTIVITY"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "REQUEST_CANCEL_ACTIVITY"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_REQUEST_CANCEL_ACTIVITY"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "START_TIMER"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_START_TIMER"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "CANCEL_TIMER"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_CANCEL_TIMER"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "START_CHILD_RUN"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_START_CHILD_RUN"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "SIGNAL_RUN"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_SIGNAL_RUN"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "RECORD_SIDE_EFFECT"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_RECORD_SIDE_EFFECT"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "RECORD_MARKER"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_RECORD_MARKER"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "COMPLETE_WORKFLOW"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_COMPLETE_WORKFLOW"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "FAIL_WORKFLOW"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_FAIL_WORKFLOW"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "CANCEL_WORKFLOW"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_CANCEL_WORKFLOW"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "UPSERT_CONTEXT"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_UPSERT_CONTEXT"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "RECORD_LOCAL_ACTIVITY"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_RECORD_LOCAL_ACTIVITY"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "CONTINUE_AS_NEW"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_CONTINUE_AS_NEW"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "REQUEST_CANCEL_EXTERNAL_RUN"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_REQUEST_CANCEL_EXTERNAL_RUN"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "UPSERT_SEARCH_ATTRIBUTES"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_UPSERT_SEARCH_ATTRIBUTES"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "ACCEPT_UPDATE"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_ACCEPT_UPDATE"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "REJECT_UPDATE"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_REJECT_UPDATE"
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "type": {
+            "const": "COMPLETE_UPDATE"
+          }
+        },
+        "required": [
+          "type"
+        ]
+      },
+      "then": {
+        "$ref": "#/$defs/command_COMPLETE_UPDATE"
+      }
+    }
+  ],
+  "$defs": {
+    "json": {
+      "description": "Any JSON value."
+    },
+    "failure": {
+      "type": "object",
+      "required": [
+        "errorType",
+        "message"
+      ],
+      "properties": {
+        "errorType": {
+          "enum": [
+            "TIMEOUT",
+            "TRANSIENT",
+            "DEPENDENCY",
+            "AUTHORIZATION",
+            "VALIDATION",
+            "PERMANENT",
+            "UNKNOWN"
+          ]
+        },
+        "message": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "details": {},
+        "nonRetryable": {
+          "type": "boolean"
+        },
+        "nextRetryDelayMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "category": {
+          "const": "BENIGN"
+        },
+        "timeoutType": {
+          "type": "string"
+        },
+        "cause": {
+          "$ref": "#/$defs/failure"
+        },
+        "stackTrace": {
+          "type": "string"
+        },
+        "source": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "retryPolicy": {
+      "type": "object",
+      "required": [
+        "retryDelay"
+      ],
+      "description": "maxRetries absent means unlimited attempts, bounded by scheduleToCloseTimeout.",
+      "properties": {
+        "maxRetries": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "retryDelay": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "backoffMultiplier": {
+          "type": "number",
+          "minimum": 1
+        },
+        "maxDelay": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "retryOnErrorTypes": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "TIMEOUT",
+              "TRANSIENT",
+              "DEPENDENCY",
+              "AUTHORIZATION",
+              "VALIDATION",
+              "PERMANENT",
+              "UNKNOWN"
+            ]
+          }
+        },
+        "nonRetryableErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "runTarget": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "runId"
+          ],
+          "properties": {
+            "runId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "parent"
+          ],
+          "properties": {
+            "parent": {
+              "const": true
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "childId"
+          ],
+          "properties": {
+            "childId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "workflowKey",
+            "workflowId"
+          ],
+          "properties": {
+            "workflowKey": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "workflowId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "childOptions": {
+      "type": "object",
+      "required": [
+        "parentClosePolicy"
+      ],
+      "properties": {
+        "parentClosePolicy": {
+          "enum": [
+            "TERMINATE",
+            "ABANDON",
+            "REQUEST_CANCEL"
+          ]
+        },
+        "cancellationType": {
+          "enum": [
+            "WAIT_CANCELLATION_COMPLETED",
+            "WAIT_CANCELLATION_REQUESTED",
+            "TRY_CANCEL",
+            "ABANDON"
+          ]
+        },
+        "taskQueue": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "workflowId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "priority": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 5
+        },
+        "summary": {
+          "type": "string",
+          "maxLength": 200
+        },
+        "details": {
+          "type": "string"
+        },
+        "context": {
+          "type": "object"
+        },
+        "executionTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "runTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "workflowTaskTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "startDelay": {
+          "type": "integer",
+          "minimum": 0
+        }
+      }
+    },
+    "headers": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "command_SCHEDULE_ACTIVITY": {
+      "type": "object",
+      "required": [
+        "type",
+        "activityId",
+        "kind",
+        "nodeType",
+        "operation",
+        "args",
+        "retry"
+      ],
+      "properties": {
+        "type": {
+          "const": "SCHEDULE_ACTIVITY"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "activityId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "kind": {
+          "const": "node"
+        },
+        "nodeType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "nodeVersion": {
+          "type": "string"
+        },
+        "operation": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "args": {},
+        "connection": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "retry": {
+          "$ref": "#/$defs/retryPolicy"
+        },
+        "startToCloseTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "scheduleToCloseTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "scheduleToStartTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "heartbeatTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "cancellationType": {
+          "enum": [
+            "WAIT_CANCELLATION_COMPLETED",
+            "TRY_CANCEL",
+            "ABANDON"
+          ]
+        },
+        "priority": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 5
+        },
+        "summary": {
+          "type": "string",
+          "maxLength": 200
+        },
+        "runOn": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_REQUEST_CANCEL_ACTIVITY": {
+      "type": "object",
+      "required": [
+        "type",
+        "activityId"
+      ],
+      "properties": {
+        "type": {
+          "const": "REQUEST_CANCEL_ACTIVITY"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "activityId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_START_TIMER": {
+      "type": "object",
+      "required": [
+        "type",
+        "timerId",
+        "durationMs"
+      ],
+      "properties": {
+        "type": {
+          "const": "START_TIMER"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "timerId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "durationMs": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "summary": {
+          "type": "string",
+          "maxLength": 200
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_CANCEL_TIMER": {
+      "type": "object",
+      "required": [
+        "type",
+        "timerId"
+      ],
+      "properties": {
+        "type": {
+          "const": "CANCEL_TIMER"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "timerId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_START_CHILD_RUN": {
+      "type": "object",
+      "required": [
+        "type",
+        "childId",
+        "input",
+        "options"
+      ],
+      "properties": {
+        "type": {
+          "const": "START_CHILD_RUN"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "childId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "workflowKey": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "workflowFn": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "version": {
+          "type": "string",
+          "minLength": 1
+        },
+        "input": {},
+        "options": {
+          "$ref": "#/$defs/childOptions"
+        }
+      },
+      "additionalProperties": false,
+      "oneOf": [
+        {
+          "required": [
+            "workflowKey"
+          ]
+        },
+        {
+          "required": [
+            "workflowFn"
+          ]
+        }
+      ]
+    },
+    "command_SIGNAL_RUN": {
+      "type": "object",
+      "required": [
+        "type",
+        "externalId",
+        "target",
+        "name",
+        "payload"
+      ],
+      "properties": {
+        "type": {
+          "const": "SIGNAL_RUN"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "externalId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "target": {
+          "$ref": "#/$defs/runTarget"
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "payload": {}
+      },
+      "additionalProperties": false
+    },
+    "command_RECORD_SIDE_EFFECT": {
+      "type": "object",
+      "required": [
+        "type",
+        "sideEffectId",
+        "value"
+      ],
+      "properties": {
+        "type": {
+          "const": "RECORD_SIDE_EFFECT"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "sideEffectId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "value": {}
+      },
+      "additionalProperties": false
+    },
+    "command_RECORD_MARKER": {
+      "type": "object",
+      "required": [
+        "type",
+        "markerId",
+        "data"
+      ],
+      "properties": {
+        "type": {
+          "const": "RECORD_MARKER"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "markerId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "data": {}
+      },
+      "additionalProperties": false
+    },
+    "command_COMPLETE_WORKFLOW": {
+      "type": "object",
+      "required": [
+        "type",
+        "output"
+      ],
+      "properties": {
+        "type": {
+          "const": "COMPLETE_WORKFLOW"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "output": {}
+      },
+      "additionalProperties": false
+    },
+    "command_FAIL_WORKFLOW": {
+      "type": "object",
+      "required": [
+        "type",
+        "failure"
+      ],
+      "properties": {
+        "type": {
+          "const": "FAIL_WORKFLOW"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "failure": {
+          "$ref": "#/$defs/failure"
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_CANCEL_WORKFLOW": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "const": "CANCEL_WORKFLOW"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_UPSERT_CONTEXT": {
+      "type": "object",
+      "required": [
+        "type",
+        "entries"
+      ],
+      "properties": {
+        "type": {
+          "const": "UPSERT_CONTEXT"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "entries": {
+          "type": "object"
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_RECORD_LOCAL_ACTIVITY": {
+      "type": "object",
+      "required": [
+        "type",
+        "localActivityId",
+        "attempts"
+      ],
+      "properties": {
+        "type": {
+          "const": "RECORD_LOCAL_ACTIVITY"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "localActivityId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "result": {},
+        "failure": {
+          "$ref": "#/$defs/failure"
+        },
+        "attempts": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": false,
+      "oneOf": [
+        {
+          "required": [
+            "result"
+          ]
+        },
+        {
+          "required": [
+            "failure"
+          ]
+        }
+      ]
+    },
+    "command_CONTINUE_AS_NEW": {
+      "type": "object",
+      "required": [
+        "type",
+        "input",
+        "options"
+      ],
+      "properties": {
+        "type": {
+          "const": "CONTINUE_AS_NEW"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "input": {},
+        "options": {
+          "type": "object"
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_REQUEST_CANCEL_EXTERNAL_RUN": {
+      "type": "object",
+      "required": [
+        "type",
+        "externalId",
+        "target"
+      ],
+      "properties": {
+        "type": {
+          "const": "REQUEST_CANCEL_EXTERNAL_RUN"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "externalId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "target": {
+          "$ref": "#/$defs/runTarget"
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_UPSERT_SEARCH_ATTRIBUTES": {
+      "type": "object",
+      "required": [
+        "type",
+        "attributes"
+      ],
+      "properties": {
+        "type": {
+          "const": "UPSERT_SEARCH_ATTRIBUTES"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "attributes": {
+          "type": "object"
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_ACCEPT_UPDATE": {
+      "type": "object",
+      "required": [
+        "type",
+        "updateId"
+      ],
+      "properties": {
+        "type": {
+          "const": "ACCEPT_UPDATE"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "updateId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_REJECT_UPDATE": {
+      "type": "object",
+      "required": [
+        "type",
+        "updateId",
+        "failure"
+      ],
+      "properties": {
+        "type": {
+          "const": "REJECT_UPDATE"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "updateId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "failure": {
+          "$ref": "#/$defs/failure"
+        }
+      },
+      "additionalProperties": false
+    },
+    "command_COMPLETE_UPDATE": {
+      "type": "object",
+      "required": [
+        "type",
+        "updateId"
+      ],
+      "properties": {
+        "type": {
+          "const": "COMPLETE_UPDATE"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "updateId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "result": {},
+        "failure": {
+          "$ref": "#/$defs/failure"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}